src/vnet/devices/virtio/vhost-user.c

   1 /*
   2  *------------------------------------------------------------------
   3  * vhost.c - vhost-user
   4  *
   5  * Copyright (c) 2014 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/ip/ip.h>
  37
  38 #include <vnet/ethernet/ethernet.h>
  39 #include <vnet/devices/devices.h>
  40 #include <vnet/feature/feature.h>
  41
  42 #include <vnet/devices/virtio/vhost-user.h>
  43
  44 /**
  45  * @file
  46  * @brief vHost User Device Driver.
  47  *
  48  * This file contains the source code for vHost User interface.
  49  */
  50
  51
  52 #define VHOST_DEBUG_VQ 0
  53
  54 #define DBG_SOCK(args...)                       \
  55   {                                             \
  56     vhost_user_main_t *_vum = &vhost_user_main; \
  57     if (_vum->debug)                            \
  58       clib_warning(args);                       \
  59   };
  60
  61 #if VHOST_DEBUG_VQ == 1
  62 #define DBG_VQ(args...) clib_warning(args);
  63 #else
  64 #define DBG_VQ(args...)
  65 #endif
  66
  67 /*
  68  * When an RX queue is down but active, received packets
  69  * must be discarded. This value controls up to how many
  70  * packets will be discarded during each round.
  71  */
  72 #define VHOST_USER_DOWN_DISCARD_COUNT 256
  73
  74 /*
  75  * When the number of available buffers gets under this threshold,
  76  * RX node will start discarding packets.
  77  */
  78 #define VHOST_USER_RX_BUFFER_STARVATION 32
  79
  80 /*
  81  * On the receive side, the host should free descriptors as soon
  82  * as possible in order to avoid TX drop in the VM.
  83  * This value controls the number of copy operations that are stacked
  84  * before copy is done for all and descriptors are given back to
  85  * the guest.
  86  * The value 64 was obtained by testing (48 and 128 were not as good).
  87  */
  88 #define VHOST_USER_RX_COPY_THRESHOLD 64
  89 /*
  90  * On the transmit side, we keep processing the buffers from vlib in the while
  91  * loop and prepare the copy order to be executed later. However, the static
  92  * array which we keep the copy order is limited to VHOST_USER_COPY_ARRAY_N
  93  * entries. In order to not corrupt memory, we have to do the copy when the
  94  * static array reaches the copy threshold. We subtract 40 in case the code
  95  * goes into the inner loop for a maximum of 64k frames which may require
  96  * more array entries.
  97  */
  98 #define VHOST_USER_TX_COPY_THRESHOLD (VHOST_USER_COPY_ARRAY_N - 40)
  99
 100 #define UNIX_GET_FD(unixfd_idx) ({ \
 101     typeof(unixfd_idx) __unixfd_idx = (unixfd_idx); \
 102     (__unixfd_idx != ~0) ? \
 103         pool_elt_at_index (file_main.file_pool, \
 104                            __unixfd_idx)->file_descriptor : -1; })
 105
 106 #define foreach_virtio_trace_flags \
 107   _ (SIMPLE_CHAINED, 0, "Simple descriptor chaining") \
 108   _ (SINGLE_DESC,  1, "Single descriptor packet") \
 109   _ (INDIRECT, 2, "Indirect descriptor") \
 110   _ (MAP_ERROR, 4, "Memory mapping error")
 111
 112 typedef enum
 113 {
 114 #define _(n,i,s) VIRTIO_TRACE_F_##n,
 115   foreach_virtio_trace_flags
 116 #undef _
 117 } virtio_trace_flag_t;
 118
 119 vlib_node_registration_t vhost_user_input_node;
 120
 121 #define foreach_vhost_user_tx_func_error      \
 122   _(NONE, "no error")  \
 123   _(NOT_READY, "vhost vring not ready")  \
 124   _(DOWN, "vhost interface is down")  \
 125   _(PKT_DROP_NOBUF, "tx packet drops (no available descriptors)")  \
 126   _(PKT_DROP_NOMRG, "tx packet drops (cannot merge descriptors)")  \
 127   _(MMAP_FAIL, "mmap failure") \
 128   _(INDIRECT_OVERFLOW, "indirect descriptor table overflow")
 129
 130 typedef enum
 131 {
 132 #define _(f,s) VHOST_USER_TX_FUNC_ERROR_##f,
 133   foreach_vhost_user_tx_func_error
 134 #undef _
 135     VHOST_USER_TX_FUNC_N_ERROR,
 136 } vhost_user_tx_func_error_t;
 137
 138 static char *vhost_user_tx_func_error_strings[] = {
 139 #define _(n,s) s,
 140   foreach_vhost_user_tx_func_error
 141 #undef _
 142 };
 143
 144 #define foreach_vhost_user_input_func_error      \
 145   _(NO_ERROR, "no error")  \
 146   _(NO_BUFFER, "no available buffer")  \
 147   _(MMAP_FAIL, "mmap failure")  \
 148   _(INDIRECT_OVERFLOW, "indirect descriptor overflows table")  \
 149   _(UNDERSIZED_FRAME, "undersized ethernet frame received (< 14 bytes)") \
 150   _(FULL_RX_QUEUE, "full rx queue (possible driver tx drop)")
 151
 152 typedef enum
 153 {
 154 #define _(f,s) VHOST_USER_INPUT_FUNC_ERROR_##f,
 155   foreach_vhost_user_input_func_error
 156 #undef _
 157     VHOST_USER_INPUT_FUNC_N_ERROR,
 158 } vhost_user_input_func_error_t;
 159
 160 static char *vhost_user_input_func_error_strings[] = {
 161 #define _(n,s) s,
 162   foreach_vhost_user_input_func_error
 163 #undef _
 164 };
 165
 166 /* *INDENT-OFF* */
 167 static vhost_user_main_t vhost_user_main = {
 168   .mtu_bytes = 1518,
 169 };
 170
 171 VNET_HW_INTERFACE_CLASS (vhost_interface_class, static) = {
 172   .name = "vhost-user",
 173 };
 174 /* *INDENT-ON* */
 175
 176 static u8 *
 177 format_vhost_user_interface_name (u8 * s, va_list * args)
 178 {
 179   u32 i = va_arg (*args, u32);
 180   u32 show_dev_instance = ~0;
 181   vhost_user_main_t *vum = &vhost_user_main;
 182
 183   if (i < vec_len (vum->show_dev_instance_by_real_dev_instance))
 184     show_dev_instance = vum->show_dev_instance_by_real_dev_instance[i];
 185
 186   if (show_dev_instance != ~0)
 187     i = show_dev_instance;
 188
 189   s = format (s, "VirtualEthernet0/0/%d", i);
 190   return s;
 191 }
 192
 193 static int
 194 vhost_user_name_renumber (vnet_hw_interface_t * hi, u32 new_dev_instance)
 195 {
 196   // FIXME: check if the new dev instance is already used
 197   vhost_user_main_t *vum = &vhost_user_main;
 198   vec_validate_init_empty (vum->show_dev_instance_by_real_dev_instance,
 199                            hi->dev_instance, ~0);
 200
 201   vum->show_dev_instance_by_real_dev_instance[hi->dev_instance] =
 202     new_dev_instance;
 203
 204   DBG_SOCK ("renumbered vhost-user interface dev_instance %d to %d",
 205             hi->dev_instance, new_dev_instance);
 206
 207   return 0;
 208 }
 209
 210 static_always_inline void *
 211 map_guest_mem (vhost_user_intf_t * vui, uword addr, u32 * hint)
 212 {
 213   int i = *hint;
 214   if (PREDICT_TRUE ((vui->regions[i].guest_phys_addr <= addr) &&
 215                     ((vui->regions[i].guest_phys_addr +
 216                       vui->regions[i].memory_size) > addr)))
 217     {
 218       return (void *) (vui->region_mmap_addr[i] + addr -
 219                        vui->regions[i].guest_phys_addr);
 220     }
 221 #if __SSE4_2__
 222   __m128i rl, rh, al, ah, r;
 223   al = _mm_set1_epi64x (addr + 1);
 224   ah = _mm_set1_epi64x (addr);
 225
 226   rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[0]);
 227   rl = _mm_cmpgt_epi64 (al, rl);
 228   rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[0]);
 229   rh = _mm_cmpgt_epi64 (rh, ah);
 230   r = _mm_and_si128 (rl, rh);
 231
 232   rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[2]);
 233   rl = _mm_cmpgt_epi64 (al, rl);
 234   rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[2]);
 235   rh = _mm_cmpgt_epi64 (rh, ah);
 236   r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x22);
 237
 238   rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[4]);
 239   rl = _mm_cmpgt_epi64 (al, rl);
 240   rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[4]);
 241   rh = _mm_cmpgt_epi64 (rh, ah);
 242   r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x44);
 243
 244   rl = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_lo[6]);
 245   rl = _mm_cmpgt_epi64 (al, rl);
 246   rh = _mm_loadu_si128 ((__m128i *) & vui->region_guest_addr_hi[6]);
 247   rh = _mm_cmpgt_epi64 (rh, ah);
 248   r = _mm_blend_epi16 (r, _mm_and_si128 (rl, rh), 0x88);
 249
 250   r = _mm_shuffle_epi8 (r, _mm_set_epi64x (0, 0x0e060c040a020800));
 251   i = __builtin_ctzll (_mm_movemask_epi8 (r) |
 252                        (1 << VHOST_MEMORY_MAX_NREGIONS));
 253
 254   if (i < vui->nregions)
 255     {
 256       *hint = i;
 257       return (void *) (vui->region_mmap_addr[i] + addr -
 258                        vui->regions[i].guest_phys_addr);
 259     }
 260 #elif __aarch64__ && __ARM_NEON
 261   uint64x2_t al, ah, rl, rh, r;
 262   uint32_t u32 = 0;
 263
 264   al = vdupq_n_u64 (addr + 1);
 265   ah = vdupq_n_u64 (addr);
 266
 267   /*First Iteration */
 268   rl = vld1q_u64 (&vui->region_guest_addr_lo[0]);
 269   rl = vcgtq_u64 (al, rl);
 270   rh = vld1q_u64 (&vui->region_guest_addr_hi[0]);
 271   rh = vcgtq_u64 (rh, ah);
 272   r = vandq_u64 (rl, rh);
 273   u32 |= (vgetq_lane_u8 (vreinterpretq_u8_u64 (r), 0) & 0x1);
 274   u32 |= ((vgetq_lane_u8 (vreinterpretq_u8_u64 (r), 8) & 0x1) << 1);
 275
 276   if (u32)
 277     {
 278       i = __builtin_ctzll (u32);
 279       goto vhost_map_guest_mem_done;
 280     }
 281
 282   /*Second Iteration */
 283   rl = vld1q_u64 (&vui->region_guest_addr_lo[2]);
 284   rl = vcgtq_u64 (al, rl);
 285   rh = vld1q_u64 (&vui->region_guest_addr_hi[2]);
 286   rh = vcgtq_u64 (rh, ah);
 287   r = vandq_u64 (rl, rh);
 288   u32 |= ((vgetq_lane_u8 (vreinterpretq_u8_u64 (r), 0) & 0x1) << 2);
 289   u32 |= ((vgetq_lane_u8 (vreinterpretq_u8_u64 (r), 8) & 0x1) << 3);
 290
 291   if (u32)
 292     {
 293       i = __builtin_ctzll (u32);
 294       goto vhost_map_guest_mem_done;
 295     }
 296
 297   /*Third Iteration */
 298   rl = vld1q_u64 (&vui->region_guest_addr_lo[4]);
 299   rl = vcgtq_u64 (al, rl);
 300   rh = vld1q_u64 (&vui->region_guest_addr_hi[4]);
 301   rh = vcgtq_u64 (rh, ah);
 302   r = vandq_u64 (rl, rh);
 303   u32 |= ((vgetq_lane_u8 (vreinterpretq_u8_u64 (r), 0) & 0x1) << 4);
 304   u32 |= ((vgetq_lane_u8 (vreinterpretq_u8_u64 (r), 8) & 0x1) << 5);
 305
 306   if (u32)
 307     {
 308       i = __builtin_ctzll (u32);
 309       goto vhost_map_guest_mem_done;
 310     }
 311
 312   /*Fourth Iteration */
 313   rl = vld1q_u64 (&vui->region_guest_addr_lo[6]);
 314   rl = vcgtq_u64 (al, rl);
 315   rh = vld1q_u64 (&vui->region_guest_addr_hi[6]);
 316   rh = vcgtq_u64 (rh, ah);
 317   r = vandq_u64 (rl, rh);
 318   u32 |= ((vgetq_lane_u8 (vreinterpretq_u8_u64 (r), 0) & 0x1) << 6);
 319   u32 |= ((vgetq_lane_u8 (vreinterpretq_u8_u64 (r), 8) & 0x1) << 7);
 320
 321   i = __builtin_ctzll (u32 | (1 << VHOST_MEMORY_MAX_NREGIONS));
 322
 323 vhost_map_guest_mem_done:
 324   if (i < vui->nregions)
 325     {
 326       *hint = i;
 327       return (void *) (vui->region_mmap_addr[i] + addr -
 328                        vui->regions[i].guest_phys_addr);
 329     }
 330 #else
 331   for (i = 0; i < vui->nregions; i++)
 332     {
 333       if ((vui->regions[i].guest_phys_addr <= addr) &&
 334           ((vui->regions[i].guest_phys_addr + vui->regions[i].memory_size) >
 335            addr))
 336         {
 337           *hint = i;
 338           return (void *) (vui->region_mmap_addr[i] + addr -
 339                            vui->regions[i].guest_phys_addr);
 340         }
 341     }
 342 #endif
 343   DBG_VQ ("failed to map guest mem addr %llx", addr);
 344   *hint = 0;
 345   return 0;
 346 }
 347
 348 static inline void *
 349 map_user_mem (vhost_user_intf_t * vui, uword addr)
 350 {
 351   int i;
 352   for (i = 0; i < vui->nregions; i++)
 353     {
 354       if ((vui->regions[i].userspace_addr <= addr) &&
 355           ((vui->regions[i].userspace_addr + vui->regions[i].memory_size) >
 356            addr))
 357         {
 358           return (void *) (vui->region_mmap_addr[i] + addr -
 359                            vui->regions[i].userspace_addr);
 360         }
 361     }
 362   return 0;
 363 }
 364
 365 static long
 366 get_huge_page_size (int fd)
 367 {
 368   struct statfs s;
 369   fstatfs (fd, &s);
 370   return s.f_bsize;
 371 }
 372
 373 static void
 374 unmap_all_mem_regions (vhost_user_intf_t * vui)
 375 {
 376   int i, r;
 377   for (i = 0; i < vui->nregions; i++)
 378     {
 379       if (vui->region_mmap_addr[i] != MAP_FAILED)
 380         {
 381
 382           long page_sz = get_huge_page_size (vui->region_mmap_fd[i]);
 383
 384           ssize_t map_sz = (vui->regions[i].memory_size +
 385                             vui->regions[i].mmap_offset +
 386                             page_sz - 1) & ~(page_sz - 1);
 387
 388           r =
 389             munmap (vui->region_mmap_addr[i] - vui->regions[i].mmap_offset,
 390                     map_sz);
 391
 392           DBG_SOCK
 393             ("unmap memory region %d addr 0x%lx len 0x%lx page_sz 0x%x", i,
 394              vui->region_mmap_addr[i], map_sz, page_sz);
 395
 396           vui->region_mmap_addr[i] = MAP_FAILED;
 397
 398           if (r == -1)
 399             {
 400               clib_warning ("failed to unmap memory region (errno %d)",
 401                             errno);
 402             }
 403           close (vui->region_mmap_fd[i]);
 404         }
 405     }
 406   vui->nregions = 0;
 407 }
 408
 409 static void
 410 vhost_user_tx_thread_placement (vhost_user_intf_t * vui)
 411 {
 412   //Let's try to assign one queue to each thread
 413   u32 qid = 0;
 414   u32 thread_index = 0;
 415   vui->use_tx_spinlock = 0;
 416   while (1)
 417     {
 418       for (qid = 0; qid < VHOST_VRING_MAX_N / 2; qid++)
 419         {
 420           vhost_user_vring_t *rxvq = &vui->vrings[VHOST_VRING_IDX_RX (qid)];
 421           if (!rxvq->started || !rxvq->enabled)
 422             continue;
 423
 424           vui->per_cpu_tx_qid[thread_index] = qid;
 425           thread_index++;
 426           if (thread_index == vlib_get_thread_main ()->n_vlib_mains)
 427             return;
 428         }
 429       //We need to loop, meaning the spinlock has to be used
 430       vui->use_tx_spinlock = 1;
 431       if (thread_index == 0)
 432         {
 433           //Could not find a single valid one
 434           for (thread_index = 0;
 435                thread_index < vlib_get_thread_main ()->n_vlib_mains;
 436                thread_index++)
 437             {
 438               vui->per_cpu_tx_qid[thread_index] = 0;
 439             }
 440           return;
 441         }
 442     }
 443 }
 444
 445 /**
 446  * @brief Unassign existing interface/queue to thread mappings and re-assign
 447  * new interface/queue to thread mappings
 448  */
 449 static void
 450 vhost_user_rx_thread_placement ()
 451 {
 452   vhost_user_main_t *vum = &vhost_user_main;
 453   vhost_user_intf_t *vui;
 454   vhost_user_vring_t *txvq;
 455   vnet_main_t *vnm = vnet_get_main ();
 456   u32 qid;
 457   int rv;
 458   u16 *queue;
 459
 460   // Scrap all existing mappings for all interfaces/queues
 461   /* *INDENT-OFF* */
 462   pool_foreach (vui, vum->vhost_user_interfaces, {
 463       vec_foreach (queue, vui->rx_queues)
 464         {
 465           rv = vnet_hw_interface_unassign_rx_thread (vnm, vui->hw_if_index,
 466                                                      *queue);
 467           if (rv)
 468             clib_warning ("Warning: unable to unassign interface %d, "
 469                           "queue %d: rc=%d", vui->hw_if_index, *queue, rv);
 470         }
 471       vec_reset_length (vui->rx_queues);
 472   });
 473   /* *INDENT-ON* */
 474
 475   // Create the rx_queues for all interfaces
 476   /* *INDENT-OFF* */
 477   pool_foreach (vui, vum->vhost_user_interfaces, {
 478       for (qid = 0; qid < VHOST_VRING_MAX_N / 2; qid++)
 479         {
 480           txvq = &vui->vrings[VHOST_VRING_IDX_TX (qid)];
 481           if (txvq->started)
 482             {
 483               if (txvq->mode == VNET_HW_INTERFACE_RX_MODE_UNKNOWN)
 484                 /* Set polling as the default */
 485                 txvq->mode = VNET_HW_INTERFACE_RX_MODE_POLLING;
 486               vec_add1 (vui->rx_queues, qid);
 487             }
 488         }
 489   });
 490   /* *INDENT-ON* */
 491
 492   // Assign new mappings for all interfaces/queues
 493   /* *INDENT-OFF* */
 494   pool_foreach (vui, vum->vhost_user_interfaces, {
 495       vnet_hw_interface_set_input_node (vnm, vui->hw_if_index,
 496                                         vhost_user_input_node.index);
 497       vec_foreach (queue, vui->rx_queues)
 498         {
 499           vnet_hw_interface_assign_rx_thread (vnm, vui->hw_if_index, *queue,
 500                                               ~0);
 501           txvq = &vui->vrings[VHOST_VRING_IDX_TX (*queue)];
 502           rv = vnet_hw_interface_set_rx_mode (vnm, vui->hw_if_index, *queue,
 503                                               txvq->mode);
 504           if (rv)
 505             clib_warning ("Warning: unable to set rx mode for interface %d, "
 506                           "queue %d: rc=%d", vui->hw_if_index, *queue, rv);
 507         }
 508   });
 509   /* *INDENT-ON* */
 510 }
 511
 512 /** @brief Returns whether at least one TX and one RX vring are enabled */
 513 int
 514 vhost_user_intf_ready (vhost_user_intf_t * vui)
 515 {
 516   int i, found[2] = { };        //RX + TX
 517
 518   for (i = 0; i < VHOST_VRING_MAX_N; i++)
 519     if (vui->vrings[i].started && vui->vrings[i].enabled)
 520       found[i & 1] = 1;
 521
 522   return found[0] && found[1];
 523 }
 524
 525 static void
 526 vhost_user_update_iface_state (vhost_user_intf_t * vui)
 527 {
 528   /* if we have pointers to descriptor table, go up */
 529   int is_up = vhost_user_intf_ready (vui);
 530   if (is_up != vui->is_up)
 531     {
 532       DBG_SOCK ("interface %d %s", vui->sw_if_index,
 533                 is_up ? "ready" : "down");
 534       vnet_hw_interface_set_flags (vnet_get_main (), vui->hw_if_index,
 535                                    is_up ? VNET_HW_INTERFACE_FLAG_LINK_UP :
 536                                    0);
 537       vui->is_up = is_up;
 538     }
 539   vhost_user_rx_thread_placement ();
 540   vhost_user_tx_thread_placement (vui);
 541 }
 542
 543 static void
 544 vhost_user_set_interrupt_pending (vhost_user_intf_t * vui, u32 ifq)
 545 {
 546   u32 qid;
 547   vnet_main_t *vnm = vnet_get_main ();
 548
 549   qid = ifq & 0xff;
 550   if ((qid & 1) == 0)
 551     /* Only care about the odd number, or TX, virtqueue */
 552     return;
 553
 554   if (vhost_user_intf_ready (vui))
 555     // qid >> 1 is to convert virtqueue number to vring queue index
 556     vnet_device_input_set_interrupt_pending (vnm, vui->hw_if_index, qid >> 1);
 557 }
 558
 559 static clib_error_t *
 560 vhost_user_callfd_read_ready (clib_file_t * uf)
 561 {
 562   __attribute__ ((unused)) int n;
 563   u8 buff[8];
 564
 565   n = read (uf->file_descriptor, ((char *) &buff), 8);
 566
 567   return 0;
 568 }
 569
 570 static clib_error_t *
 571 vhost_user_kickfd_read_ready (clib_file_t * uf)
 572 {
 573   __attribute__ ((unused)) int n;
 574   u8 buff[8];
 575   vhost_user_intf_t *vui =
 576     pool_elt_at_index (vhost_user_main.vhost_user_interfaces,
 577                        uf->private_data >> 8);
 578   u32 qid = uf->private_data & 0xff;
 579
 580   n = read (uf->file_descriptor, ((char *) &buff), 8);
 581   DBG_SOCK ("if %d KICK queue %d", uf->private_data >> 8, qid);
 582   if (!vui->vrings[qid].started ||
 583       (vhost_user_intf_ready (vui) != vui->is_up))
 584     {
 585       vlib_worker_thread_barrier_sync (vlib_get_main ());
 586       vui->vrings[qid].started = 1;
 587       vhost_user_update_iface_state (vui);
 588       vlib_worker_thread_barrier_release (vlib_get_main ());
 589     }
 590
 591   vhost_user_set_interrupt_pending (vui, uf->private_data);
 592   return 0;
 593 }
 594
 595 /**
 596  * @brief Try once to lock the vring
 597  * @return 0 on success, non-zero on failure.
 598  */
 599 static inline int
 600 vhost_user_vring_try_lock (vhost_user_intf_t * vui, u32 qid)
 601 {
 602   return __sync_lock_test_and_set (vui->vring_locks[qid], 1);
 603 }
 604
 605 /**
 606  * @brief Spin until the vring is successfully locked
 607  */
 608 static inline void
 609 vhost_user_vring_lock (vhost_user_intf_t * vui, u32 qid)
 610 {
 611   while (vhost_user_vring_try_lock (vui, qid))
 612     ;
 613 }
 614
 615 /**
 616  * @brief Unlock the vring lock
 617  */
 618 static inline void
 619 vhost_user_vring_unlock (vhost_user_intf_t * vui, u32 qid)
 620 {
 621   *vui->vring_locks[qid] = 0;
 622 }
 623
 624 static inline void
 625 vhost_user_vring_init (vhost_user_intf_t * vui, u32 qid)
 626 {
 627   vhost_user_vring_t *vring = &vui->vrings[qid];
 628   memset (vring, 0, sizeof (*vring));
 629   vring->kickfd_idx = ~0;
 630   vring->callfd_idx = ~0;
 631   vring->errfd = -1;
 632
 633   /*
 634    * We have a bug with some qemu 2.5, and this may be a fix.
 635    * Feel like interpretation holy text, but this is from vhost-user.txt.
 636    * "
 637    * One queue pair is enabled initially. More queues are enabled
 638    * dynamically, by sending message VHOST_USER_SET_VRING_ENABLE.
 639    * "
 640    * Don't know who's right, but this is what DPDK does.
 641    */
 642   if (qid == 0 || qid == 1)
 643     vring->enabled = 1;
 644 }
 645
 646 static inline void
 647 vhost_user_vring_close (vhost_user_intf_t * vui, u32 qid)
 648 {
 649   vhost_user_vring_t *vring = &vui->vrings[qid];
 650   if (vring->kickfd_idx != ~0)
 651     {
 652       clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
 653                                            vring->kickfd_idx);
 654       clib_file_del (&file_main, uf);
 655       vring->kickfd_idx = ~0;
 656     }
 657   if (vring->callfd_idx != ~0)
 658     {
 659       clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
 660                                            vring->callfd_idx);
 661       clib_file_del (&file_main, uf);
 662       vring->callfd_idx = ~0;
 663     }
 664   if (vring->errfd != -1)
 665     {
 666       close (vring->errfd);
 667       vring->errfd = -1;
 668     }
 669   vhost_user_vring_init (vui, qid);
 670 }
 671
 672 static inline void
 673 vhost_user_if_disconnect (vhost_user_intf_t * vui)
 674 {
 675   vnet_main_t *vnm = vnet_get_main ();
 676   int q;
 677
 678   vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
 679
 680   if (vui->clib_file_index != ~0)
 681     {
 682       clib_file_del (&file_main, file_main.file_pool + vui->clib_file_index);
 683       vui->clib_file_index = ~0;
 684     }
 685
 686   vui->is_up = 0;
 687
 688   for (q = 0; q < VHOST_VRING_MAX_N; q++)
 689     vhost_user_vring_close (vui, q);
 690
 691   unmap_all_mem_regions (vui);
 692   DBG_SOCK ("interface ifindex %d disconnected", vui->sw_if_index);
 693 }
 694
 695 #define VHOST_LOG_PAGE 0x1000
 696 static_always_inline void
 697 vhost_user_log_dirty_pages_2 (vhost_user_intf_t * vui,
 698                               u64 addr, u64 len, u8 is_host_address)
 699 {
 700   if (PREDICT_TRUE (vui->log_base_addr == 0
 701                     || !(vui->features & (1 << FEAT_VHOST_F_LOG_ALL))))
 702     {
 703       return;
 704     }
 705   if (is_host_address)
 706     {
 707       addr = pointer_to_uword (map_user_mem (vui, (uword) addr));
 708     }
 709   if (PREDICT_FALSE ((addr + len - 1) / VHOST_LOG_PAGE / 8 >= vui->log_size))
 710     {
 711       DBG_SOCK ("vhost_user_log_dirty_pages(): out of range\n");
 712       return;
 713     }
 714
 715   CLIB_MEMORY_BARRIER ();
 716   u64 page = addr / VHOST_LOG_PAGE;
 717   while (page * VHOST_LOG_PAGE < addr + len)
 718     {
 719       ((u8 *) vui->log_base_addr)[page / 8] |= 1 << page % 8;
 720       page++;
 721     }
 722 }
 723
 724 static_always_inline void
 725 vhost_user_log_dirty_pages (vhost_user_intf_t * vui, u64 addr, u64 len)
 726 {
 727   vhost_user_log_dirty_pages_2 (vui, addr, len, 0);
 728 }
 729
 730 #define vhost_user_log_dirty_ring(vui, vq, member) \
 731   if (PREDICT_FALSE(vq->log_used)) { \
 732     vhost_user_log_dirty_pages(vui, vq->log_guest_addr + STRUCT_OFFSET_OF(vring_used_t, member), \
 733                              sizeof(vq->used->member)); \
 734   }
 735
 736 static clib_error_t *
 737 vhost_user_socket_read (clib_file_t * uf)
 738 {
 739   int n, i;
 740   int fd, number_of_fds = 0;
 741   int fds[VHOST_MEMORY_MAX_NREGIONS];
 742   vhost_user_msg_t msg;
 743   struct msghdr mh;
 744   struct iovec iov[1];
 745   vhost_user_main_t *vum = &vhost_user_main;
 746   vhost_user_intf_t *vui;
 747   struct cmsghdr *cmsg;
 748   u8 q;
 749   clib_file_t template = { 0 };
 750   vnet_main_t *vnm = vnet_get_main ();
 751
 752   vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
 753
 754   char control[CMSG_SPACE (VHOST_MEMORY_MAX_NREGIONS * sizeof (int))];
 755
 756   memset (&mh, 0, sizeof (mh));
 757   memset (control, 0, sizeof (control));
 758
 759   for (i = 0; i < VHOST_MEMORY_MAX_NREGIONS; i++)
 760     fds[i] = -1;
 761
 762   /* set the payload */
 763   iov[0].iov_base = (void *) &msg;
 764   iov[0].iov_len = VHOST_USER_MSG_HDR_SZ;
 765
 766   mh.msg_iov = iov;
 767   mh.msg_iovlen = 1;
 768   mh.msg_control = control;
 769   mh.msg_controllen = sizeof (control);
 770
 771   n = recvmsg (uf->file_descriptor, &mh, 0);
 772
 773   /* Stop workers to avoid end of the world */
 774   vlib_worker_thread_barrier_sync (vlib_get_main ());
 775
 776   if (n != VHOST_USER_MSG_HDR_SZ)
 777     {
 778       if (n == -1)
 779         {
 780           DBG_SOCK ("recvmsg returned error %d %s", errno, strerror (errno));
 781         }
 782       else
 783         {
 784           DBG_SOCK ("n (%d) != VHOST_USER_MSG_HDR_SZ (%d)",
 785                     n, VHOST_USER_MSG_HDR_SZ);
 786         }
 787       goto close_socket;
 788     }
 789
 790   if (mh.msg_flags & MSG_CTRUNC)
 791     {
 792       DBG_SOCK ("MSG_CTRUNC is set");
 793       goto close_socket;
 794     }
 795
 796   cmsg = CMSG_FIRSTHDR (&mh);
 797
 798   if (cmsg && (cmsg->cmsg_len > 0) && (cmsg->cmsg_level == SOL_SOCKET) &&
 799       (cmsg->cmsg_type == SCM_RIGHTS) &&
 800       (cmsg->cmsg_len - CMSG_LEN (0) <=
 801        VHOST_MEMORY_MAX_NREGIONS * sizeof (int)))
 802     {
 803       number_of_fds = (cmsg->cmsg_len - CMSG_LEN (0)) / sizeof (int);
 804       clib_memcpy (fds, CMSG_DATA (cmsg), number_of_fds * sizeof (int));
 805     }
 806
 807   /* version 1, no reply bit set */
 808   if ((msg.flags & 7) != 1)
 809     {
 810       DBG_SOCK ("malformed message received. closing socket");
 811       goto close_socket;
 812     }
 813
 814   {
 815     int rv;
 816     rv =
 817       read (uf->file_descriptor, ((char *) &msg) + VHOST_USER_MSG_HDR_SZ,
 818             msg.size);
 819     if (rv < 0)
 820       {
 821         DBG_SOCK ("read failed %s", strerror (errno));
 822         goto close_socket;
 823       }
 824     else if (rv != msg.size)
 825       {
 826         DBG_SOCK ("message too short (read %dB should be %dB)", rv, msg.size);
 827         goto close_socket;
 828       }
 829   }
 830
 831   switch (msg.request)
 832     {
 833     case VHOST_USER_GET_FEATURES:
 834       msg.flags |= 4;
 835       msg.u64 = (1ULL << FEAT_VIRTIO_NET_F_MRG_RXBUF) |
 836         (1ULL << FEAT_VIRTIO_NET_F_CTRL_VQ) |
 837         (1ULL << FEAT_VIRTIO_F_ANY_LAYOUT) |
 838         (1ULL << FEAT_VIRTIO_F_INDIRECT_DESC) |
 839         (1ULL << FEAT_VHOST_F_LOG_ALL) |
 840         (1ULL << FEAT_VIRTIO_NET_F_GUEST_ANNOUNCE) |
 841         (1ULL << FEAT_VIRTIO_NET_F_MQ) |
 842         (1ULL << FEAT_VHOST_USER_F_PROTOCOL_FEATURES) |
 843         (1ULL << FEAT_VIRTIO_F_VERSION_1);
 844       msg.u64 &= vui->feature_mask;
 845       msg.size = sizeof (msg.u64);
 846       DBG_SOCK ("if %d msg VHOST_USER_GET_FEATURES - reply 0x%016llx",
 847                 vui->hw_if_index, msg.u64);
 848       break;
 849
 850     case VHOST_USER_SET_FEATURES:
 851       DBG_SOCK ("if %d msg VHOST_USER_SET_FEATURES features 0x%016llx",
 852                 vui->hw_if_index, msg.u64);
 853
 854       vui->features = msg.u64;
 855
 856       if (vui->features &
 857           ((1 << FEAT_VIRTIO_NET_F_MRG_RXBUF) |
 858            (1ULL << FEAT_VIRTIO_F_VERSION_1)))
 859         vui->virtio_net_hdr_sz = 12;
 860       else
 861         vui->virtio_net_hdr_sz = 10;
 862
 863       vui->is_any_layout =
 864         (vui->features & (1 << FEAT_VIRTIO_F_ANY_LAYOUT)) ? 1 : 0;
 865
 866       ASSERT (vui->virtio_net_hdr_sz < VLIB_BUFFER_PRE_DATA_SIZE);
 867       vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
 868       vui->is_up = 0;
 869
 870       /*for (q = 0; q < VHOST_VRING_MAX_N; q++)
 871          vhost_user_vring_close(&vui->vrings[q]); */
 872
 873       break;
 874
 875     case VHOST_USER_SET_MEM_TABLE:
 876       DBG_SOCK ("if %d msg VHOST_USER_SET_MEM_TABLE nregions %d",
 877                 vui->hw_if_index, msg.memory.nregions);
 878
 879       if ((msg.memory.nregions < 1) ||
 880           (msg.memory.nregions > VHOST_MEMORY_MAX_NREGIONS))
 881         {
 882
 883           DBG_SOCK ("number of mem regions must be between 1 and %i",
 884                     VHOST_MEMORY_MAX_NREGIONS);
 885
 886           goto close_socket;
 887         }
 888
 889       if (msg.memory.nregions != number_of_fds)
 890         {
 891           DBG_SOCK ("each memory region must have FD");
 892           goto close_socket;
 893         }
 894       unmap_all_mem_regions (vui);
 895       for (i = 0; i < msg.memory.nregions; i++)
 896         {
 897           clib_memcpy (&(vui->regions[i]), &msg.memory.regions[i],
 898                        sizeof (vhost_user_memory_region_t));
 899
 900           long page_sz = get_huge_page_size (fds[i]);
 901
 902           /* align size to page */
 903           ssize_t map_sz = (vui->regions[i].memory_size +
 904                             vui->regions[i].mmap_offset +
 905                             page_sz - 1) & ~(page_sz - 1);
 906
 907           vui->region_mmap_addr[i] = mmap (0, map_sz, PROT_READ | PROT_WRITE,
 908                                            MAP_SHARED, fds[i], 0);
 909           vui->region_guest_addr_lo[i] = vui->regions[i].guest_phys_addr;
 910           vui->region_guest_addr_hi[i] = vui->regions[i].guest_phys_addr +
 911             vui->regions[i].memory_size;
 912
 913           DBG_SOCK
 914             ("map memory region %d addr 0 len 0x%lx fd %d mapped 0x%lx "
 915              "page_sz 0x%x", i, map_sz, fds[i], vui->region_mmap_addr[i],
 916              page_sz);
 917
 918           if (vui->region_mmap_addr[i] == MAP_FAILED)
 919             {
 920               clib_warning ("failed to map memory. errno is %d", errno);
 921               goto close_socket;
 922             }
 923           vui->region_mmap_addr[i] += vui->regions[i].mmap_offset;
 924           vui->region_mmap_fd[i] = fds[i];
 925
 926           vui->nregions++;
 927         }
 928       break;
 929
 930     case VHOST_USER_SET_VRING_NUM:
 931       DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_NUM idx %d num %d",
 932                 vui->hw_if_index, msg.state.index, msg.state.num);
 933
 934       if ((msg.state.num > 32768) ||    /* maximum ring size is 32768 */
 935           (msg.state.num == 0) ||       /* it cannot be zero */
 936           ((msg.state.num - 1) & msg.state.num))        /* must be power of 2 */
 937         goto close_socket;
 938       vui->vrings[msg.state.index].qsz_mask = msg.state.num - 1;
 939       break;
 940
 941     case VHOST_USER_SET_VRING_ADDR:
 942       DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ADDR idx %d",
 943                 vui->hw_if_index, msg.state.index);
 944
 945       if (msg.state.index >= VHOST_VRING_MAX_N)
 946         {
 947           DBG_SOCK ("invalid vring index VHOST_USER_SET_VRING_ADDR:"
 948                     " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
 949           goto close_socket;
 950         }
 951
 952       if (msg.size < sizeof (msg.addr))
 953         {
 954           DBG_SOCK ("vhost message is too short (%d < %d)",
 955                     msg.size, sizeof (msg.addr));
 956           goto close_socket;
 957         }
 958
 959       vui->vrings[msg.state.index].desc = (vring_desc_t *)
 960         map_user_mem (vui, msg.addr.desc_user_addr);
 961       vui->vrings[msg.state.index].used = (vring_used_t *)
 962         map_user_mem (vui, msg.addr.used_user_addr);
 963       vui->vrings[msg.state.index].avail = (vring_avail_t *)
 964         map_user_mem (vui, msg.addr.avail_user_addr);
 965
 966       if ((vui->vrings[msg.state.index].desc == NULL) ||
 967           (vui->vrings[msg.state.index].used == NULL) ||
 968           (vui->vrings[msg.state.index].avail == NULL))
 969         {
 970           DBG_SOCK ("failed to map user memory for hw_if_index %d",
 971                     vui->hw_if_index);
 972           goto close_socket;
 973         }
 974
 975       vui->vrings[msg.state.index].log_guest_addr = msg.addr.log_guest_addr;
 976       vui->vrings[msg.state.index].log_used =
 977         (msg.addr.flags & (1 << VHOST_VRING_F_LOG)) ? 1 : 0;
 978
 979       /* Spec says: If VHOST_USER_F_PROTOCOL_FEATURES has not been negotiated,
 980          the ring is initialized in an enabled state. */
 981       if (!(vui->features & (1 << FEAT_VHOST_USER_F_PROTOCOL_FEATURES)))
 982         {
 983           vui->vrings[msg.state.index].enabled = 1;
 984         }
 985
 986       vui->vrings[msg.state.index].last_used_idx =
 987         vui->vrings[msg.state.index].last_avail_idx =
 988         vui->vrings[msg.state.index].used->idx;
 989
 990       /* tell driver that we don't want interrupts */
 991       vui->vrings[msg.state.index].used->flags = VRING_USED_F_NO_NOTIFY;
 992       break;
 993
 994     case VHOST_USER_SET_OWNER:
 995       DBG_SOCK ("if %d msg VHOST_USER_SET_OWNER", vui->hw_if_index);
 996       break;
 997
 998     case VHOST_USER_RESET_OWNER:
 999       DBG_SOCK ("if %d msg VHOST_USER_RESET_OWNER", vui->hw_if_index);
1000       break;
1001
1002     case VHOST_USER_SET_VRING_CALL:
1003       DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_CALL %d",
1004                 vui->hw_if_index, msg.u64);
1005
1006       q = (u8) (msg.u64 & 0xFF);
1007
1008       /* if there is old fd, delete and close it */
1009       if (vui->vrings[q].callfd_idx != ~0)
1010         {
1011           clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
1012                                                vui->vrings[q].callfd_idx);
1013           clib_file_del (&file_main, uf);
1014           vui->vrings[q].callfd_idx = ~0;
1015         }
1016
1017       if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
1018         {
1019           if (number_of_fds != 1)
1020             {
1021               DBG_SOCK ("More than one fd received !");
1022               goto close_socket;
1023             }
1024
1025           template.read_function = vhost_user_callfd_read_ready;
1026           template.file_descriptor = fds[0];
1027           template.private_data =
1028             ((vui - vhost_user_main.vhost_user_interfaces) << 8) + q;
1029           vui->vrings[q].callfd_idx = clib_file_add (&file_main, &template);
1030         }
1031       else
1032         vui->vrings[q].callfd_idx = ~0;
1033       break;
1034
1035     case VHOST_USER_SET_VRING_KICK:
1036       DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_KICK %d",
1037                 vui->hw_if_index, msg.u64);
1038
1039       q = (u8) (msg.u64 & 0xFF);
1040
1041       if (vui->vrings[q].kickfd_idx != ~0)
1042         {
1043           clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
1044                                                vui->vrings[q].kickfd_idx);
1045           clib_file_del (&file_main, uf);
1046           vui->vrings[q].kickfd_idx = ~0;
1047         }
1048
1049       if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
1050         {
1051           if (number_of_fds != 1)
1052             {
1053               DBG_SOCK ("More than one fd received !");
1054               goto close_socket;
1055             }
1056
1057           template.read_function = vhost_user_kickfd_read_ready;
1058           template.file_descriptor = fds[0];
1059           template.private_data =
1060             (((uword) (vui - vhost_user_main.vhost_user_interfaces)) << 8) +
1061             q;
1062           vui->vrings[q].kickfd_idx = clib_file_add (&file_main, &template);
1063         }
1064       else
1065         {
1066           //When no kickfd is set, the queue is initialized as started
1067           vui->vrings[q].kickfd_idx = ~0;
1068           vui->vrings[q].started = 1;
1069         }
1070
1071       break;
1072
1073     case VHOST_USER_SET_VRING_ERR:
1074       DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_ERR %d",
1075                 vui->hw_if_index, msg.u64);
1076
1077       q = (u8) (msg.u64 & 0xFF);
1078
1079       if (vui->vrings[q].errfd != -1)
1080         close (vui->vrings[q].errfd);
1081
1082       if (!(msg.u64 & VHOST_USER_VRING_NOFD_MASK))
1083         {
1084           if (number_of_fds != 1)
1085             goto close_socket;
1086
1087           vui->vrings[q].errfd = fds[0];
1088         }
1089       else
1090         vui->vrings[q].errfd = -1;
1091
1092       break;
1093
1094     case VHOST_USER_SET_VRING_BASE:
1095       DBG_SOCK ("if %d msg VHOST_USER_SET_VRING_BASE idx %d num %d",
1096                 vui->hw_if_index, msg.state.index, msg.state.num);
1097
1098       vui->vrings[msg.state.index].last_avail_idx = msg.state.num;
1099       break;
1100
1101     case VHOST_USER_GET_VRING_BASE:
1102       if (msg.state.index >= VHOST_VRING_MAX_N)
1103         {
1104           DBG_SOCK ("invalid vring index VHOST_USER_GET_VRING_BASE:"
1105                     " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
1106           goto close_socket;
1107         }
1108
1109       /*
1110        * Copy last_avail_idx from the vring before closing it because
1111        * closing the vring also initializes the vring last_avail_idx
1112        */
1113       msg.state.num = vui->vrings[msg.state.index].last_avail_idx;
1114       msg.flags |= 4;
1115       msg.size = sizeof (msg.state);
1116
1117       /* Spec says: Client must [...] stop ring upon receiving VHOST_USER_GET_VRING_BASE. */
1118       vhost_user_vring_close (vui, msg.state.index);
1119       DBG_SOCK ("if %d msg VHOST_USER_GET_VRING_BASE idx %d num %d",
1120                 vui->hw_if_index, msg.state.index, msg.state.num);
1121       break;
1122
1123     case VHOST_USER_NONE:
1124       DBG_SOCK ("if %d msg VHOST_USER_NONE", vui->hw_if_index);
1125
1126       break;
1127
1128     case VHOST_USER_SET_LOG_BASE:
1129       {
1130         DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_BASE", vui->hw_if_index);
1131
1132         if (msg.size != sizeof (msg.log))
1133           {
1134             DBG_SOCK
1135               ("invalid msg size for VHOST_USER_SET_LOG_BASE: %d instead of %d",
1136                msg.size, sizeof (msg.log));
1137             goto close_socket;
1138           }
1139
1140         if (!
1141             (vui->protocol_features & (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD)))
1142           {
1143             DBG_SOCK
1144               ("VHOST_USER_PROTOCOL_F_LOG_SHMFD not set but VHOST_USER_SET_LOG_BASE received");
1145             goto close_socket;
1146           }
1147
1148         fd = fds[0];
1149         /* align size to page */
1150         long page_sz = get_huge_page_size (fd);
1151         ssize_t map_sz =
1152           (msg.log.size + msg.log.offset + page_sz - 1) & ~(page_sz - 1);
1153
1154         vui->log_base_addr = mmap (0, map_sz, PROT_READ | PROT_WRITE,
1155                                    MAP_SHARED, fd, 0);
1156
1157         DBG_SOCK
1158           ("map log region addr 0 len 0x%lx off 0x%lx fd %d mapped 0x%lx",
1159            map_sz, msg.log.offset, fd, vui->log_base_addr);
1160
1161         if (vui->log_base_addr == MAP_FAILED)
1162           {
1163             clib_warning ("failed to map memory. errno is %d", errno);
1164             goto close_socket;
1165           }
1166
1167         vui->log_base_addr += msg.log.offset;
1168         vui->log_size = msg.log.size;
1169
1170         msg.flags |= 4;
1171         msg.size = sizeof (msg.u64);
1172
1173         break;
1174       }
1175
1176     case VHOST_USER_SET_LOG_FD:
1177       DBG_SOCK ("if %d msg VHOST_USER_SET_LOG_FD", vui->hw_if_index);
1178
1179       break;
1180
1181     case VHOST_USER_GET_PROTOCOL_FEATURES:
1182       msg.flags |= 4;
1183       msg.u64 = (1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |
1184         (1 << VHOST_USER_PROTOCOL_F_MQ);
1185       msg.size = sizeof (msg.u64);
1186       DBG_SOCK
1187         ("if %d msg VHOST_USER_GET_PROTOCOL_FEATURES - reply 0x%016llx",
1188          vui->hw_if_index, msg.u64);
1189       break;
1190
1191     case VHOST_USER_SET_PROTOCOL_FEATURES:
1192       DBG_SOCK
1193         ("if %d msg VHOST_USER_SET_PROTOCOL_FEATURES features 0x%016llx",
1194          vui->hw_if_index, msg.u64);
1195
1196       vui->protocol_features = msg.u64;
1197
1198       break;
1199
1200     case VHOST_USER_GET_QUEUE_NUM:
1201       msg.flags |= 4;
1202       msg.u64 = VHOST_VRING_MAX_N;
1203       msg.size = sizeof (msg.u64);
1204       DBG_SOCK ("if %d msg VHOST_USER_GET_QUEUE_NUM - reply %d",
1205                 vui->hw_if_index, msg.u64);
1206       break;
1207
1208     case VHOST_USER_SET_VRING_ENABLE:
1209       DBG_SOCK ("if %d VHOST_USER_SET_VRING_ENABLE: %s queue %d",
1210                 vui->hw_if_index, msg.state.num ? "enable" : "disable",
1211                 msg.state.index);
1212       if (msg.state.index >= VHOST_VRING_MAX_N)
1213         {
1214           DBG_SOCK ("invalid vring index VHOST_USER_SET_VRING_ENABLE:"
1215                     " %d >= %d", msg.state.index, VHOST_VRING_MAX_N);
1216           goto close_socket;
1217         }
1218
1219       vui->vrings[msg.state.index].enabled = msg.state.num;
1220       break;
1221
1222     default:
1223       DBG_SOCK ("unknown vhost-user message %d received. closing socket",
1224                 msg.request);
1225       goto close_socket;
1226     }
1227
1228   /* if we need to reply */
1229   if (msg.flags & 4)
1230     {
1231       n =
1232         send (uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
1233       if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
1234         {
1235           DBG_SOCK ("could not send message response");
1236           goto close_socket;
1237         }
1238     }
1239
1240   vhost_user_update_iface_state (vui);
1241   vlib_worker_thread_barrier_release (vlib_get_main ());
1242   return 0;
1243
1244 close_socket:
1245   vhost_user_if_disconnect (vui);
1246   vhost_user_update_iface_state (vui);
1247   vlib_worker_thread_barrier_release (vlib_get_main ());
1248   return 0;
1249 }
1250
1251 static clib_error_t *
1252 vhost_user_socket_error (clib_file_t * uf)
1253 {
1254   vlib_main_t *vm = vlib_get_main ();
1255   vhost_user_main_t *vum = &vhost_user_main;
1256   vhost_user_intf_t *vui =
1257     pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1258
1259   DBG_SOCK ("socket error on if %d", vui->sw_if_index);
1260   vlib_worker_thread_barrier_sync (vm);
1261   vhost_user_if_disconnect (vui);
1262   vhost_user_rx_thread_placement ();
1263   vlib_worker_thread_barrier_release (vm);
1264   return 0;
1265 }
1266
1267 static clib_error_t *
1268 vhost_user_socksvr_accept_ready (clib_file_t * uf)
1269 {
1270   int client_fd, client_len;
1271   struct sockaddr_un client;
1272   clib_file_t template = { 0 };
1273   vhost_user_main_t *vum = &vhost_user_main;
1274   vhost_user_intf_t *vui;
1275
1276   vui = pool_elt_at_index (vum->vhost_user_interfaces, uf->private_data);
1277
1278   client_len = sizeof (client);
1279   client_fd = accept (uf->file_descriptor,
1280                       (struct sockaddr *) &client,
1281                       (socklen_t *) & client_len);
1282
1283   if (client_fd < 0)
1284     return clib_error_return_unix (0, "accept");
1285
1286   if (vui->clib_file_index != ~0)
1287     {
1288       DBG_SOCK ("Close client socket for vhost interface %d, fd %d",
1289                 vui->sw_if_index, UNIX_GET_FD (vui->clib_file_index));
1290       clib_file_del (&file_main, file_main.file_pool + vui->clib_file_index);
1291     }
1292
1293   DBG_SOCK ("New client socket for vhost interface %d, fd %d",
1294             vui->sw_if_index, client_fd);
1295   template.read_function = vhost_user_socket_read;
1296   template.error_function = vhost_user_socket_error;
1297   template.file_descriptor = client_fd;
1298   template.private_data = vui - vhost_user_main.vhost_user_interfaces;
1299   vui->clib_file_index = clib_file_add (&file_main, &template);
1300   return 0;
1301 }
1302
1303 static clib_error_t *
1304 vhost_user_init (vlib_main_t * vm)
1305 {
1306   clib_error_t *error;
1307   vhost_user_main_t *vum = &vhost_user_main;
1308   vlib_thread_main_t *tm = vlib_get_thread_main ();
1309
1310   error = vlib_call_init_function (vm, ip4_init);
1311   if (error)
1312     return error;
1313
1314   vum->coalesce_frames = 32;
1315   vum->coalesce_time = 1e-3;
1316
1317   vec_validate (vum->cpus, tm->n_vlib_mains - 1);
1318
1319   vhost_cpu_t *cpu;
1320   vec_foreach (cpu, vum->cpus)
1321   {
1322     /* This is actually not necessary as validate already zeroes it
1323      * Just keeping the loop here for later because I am lazy. */
1324     cpu->rx_buffers_len = 0;
1325   }
1326
1327   vum->random = random_default_seed ();
1328
1329   mhash_init_c_string (&vum->if_index_by_sock_name, sizeof (uword));
1330
1331   return 0;
1332 }
1333
1334 VLIB_INIT_FUNCTION (vhost_user_init);
1335
1336 static u8 *
1337 format_vhost_trace (u8 * s, va_list * va)
1338 {
1339   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
1340   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
1341   CLIB_UNUSED (vnet_main_t * vnm) = vnet_get_main ();
1342   vhost_user_main_t *vum = &vhost_user_main;
1343   vhost_trace_t *t = va_arg (*va, vhost_trace_t *);
1344   vhost_user_intf_t *vui = pool_elt_at_index (vum->vhost_user_interfaces,
1345                                               t->device_index);
1346
1347   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, vui->sw_if_index);
1348
1349   u32 indent = format_get_indent (s);
1350
1351   s = format (s, "%U %U queue %d\n", format_white_space, indent,
1352               format_vnet_sw_interface_name, vnm, sw, t->qid);
1353
1354   s = format (s, "%U virtio flags:\n", format_white_space, indent);
1355 #define _(n,i,st) \
1356           if (t->virtio_ring_flags & (1 << VIRTIO_TRACE_F_##n)) \
1357             s = format (s, "%U  %s %s\n", format_white_space, indent, #n, st);
1358   foreach_virtio_trace_flags
1359 #undef _
1360     s = format (s, "%U virtio_net_hdr first_desc_len %u\n",
1361                 format_white_space, indent, t->first_desc_len);
1362
1363   s = format (s, "%U   flags 0x%02x gso_type %u\n",
1364               format_white_space, indent,
1365               t->hdr.hdr.flags, t->hdr.hdr.gso_type);
1366
1367   if (vui->virtio_net_hdr_sz == 12)
1368     s = format (s, "%U   num_buff %u",
1369                 format_white_space, indent, t->hdr.num_buffers);
1370
1371   return s;
1372 }
1373
1374 void
1375 vhost_user_rx_trace (vhost_trace_t * t,
1376                      vhost_user_intf_t * vui, u16 qid,
1377                      vlib_buffer_t * b, vhost_user_vring_t * txvq)
1378 {
1379   vhost_user_main_t *vum = &vhost_user_main;
1380   u32 last_avail_idx = txvq->last_avail_idx;
1381   u32 desc_current = txvq->avail->ring[last_avail_idx & txvq->qsz_mask];
1382   vring_desc_t *hdr_desc = 0;
1383   virtio_net_hdr_mrg_rxbuf_t *hdr;
1384   u32 hint = 0;
1385
1386   memset (t, 0, sizeof (*t));
1387   t->device_index = vui - vum->vhost_user_interfaces;
1388   t->qid = qid;
1389
1390   hdr_desc = &txvq->desc[desc_current];
1391   if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1392     {
1393       t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_INDIRECT;
1394       /* Header is the first here */
1395       hdr_desc = map_guest_mem (vui, txvq->desc[desc_current].addr, &hint);
1396     }
1397   if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT)
1398     {
1399       t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SIMPLE_CHAINED;
1400     }
1401   if (!(txvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT) &&
1402       !(txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT))
1403     {
1404       t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SINGLE_DESC;
1405     }
1406
1407   t->first_desc_len = hdr_desc ? hdr_desc->len : 0;
1408
1409   if (!hdr_desc || !(hdr = map_guest_mem (vui, hdr_desc->addr, &hint)))
1410     {
1411       t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_MAP_ERROR;
1412     }
1413   else
1414     {
1415       u32 len = vui->virtio_net_hdr_sz;
1416       memcpy (&t->hdr, hdr, len > hdr_desc->len ? hdr_desc->len : len);
1417     }
1418 }
1419
1420 static inline void
1421 vhost_user_send_call (vlib_main_t * vm, vhost_user_vring_t * vq)
1422 {
1423   vhost_user_main_t *vum = &vhost_user_main;
1424   u64 x = 1;
1425   int fd = UNIX_GET_FD (vq->callfd_idx);
1426   int rv;
1427
1428   rv = write (fd, &x, sizeof (x));
1429   if (rv <= 0)
1430     {
1431       clib_unix_warning
1432         ("Error: Could not write to unix socket for callfd %d", fd);
1433       return;
1434     }
1435
1436   vq->n_since_last_int = 0;
1437   vq->int_deadline = vlib_time_now (vm) + vum->coalesce_time;
1438 }
1439
1440 static_always_inline u32
1441 vhost_user_input_copy (vhost_user_intf_t * vui, vhost_copy_t * cpy,
1442                        u16 copy_len, u32 * map_hint)
1443 {
1444   void *src0, *src1, *src2, *src3;
1445   if (PREDICT_TRUE (copy_len >= 4))
1446     {
1447       if (PREDICT_FALSE (!(src2 = map_guest_mem (vui, cpy[0].src, map_hint))))
1448         return 1;
1449       if (PREDICT_FALSE (!(src3 = map_guest_mem (vui, cpy[1].src, map_hint))))
1450         return 1;
1451
1452       while (PREDICT_TRUE (copy_len >= 4))
1453         {
1454           src0 = src2;
1455           src1 = src3;
1456
1457           if (PREDICT_FALSE
1458               (!(src2 = map_guest_mem (vui, cpy[2].src, map_hint))))
1459             return 1;
1460           if (PREDICT_FALSE
1461               (!(src3 = map_guest_mem (vui, cpy[3].src, map_hint))))
1462             return 1;
1463
1464           CLIB_PREFETCH (src2, 64, LOAD);
1465           CLIB_PREFETCH (src3, 64, LOAD);
1466
1467           clib_memcpy ((void *) cpy[0].dst, src0, cpy[0].len);
1468           clib_memcpy ((void *) cpy[1].dst, src1, cpy[1].len);
1469           copy_len -= 2;
1470           cpy += 2;
1471         }
1472     }
1473   while (copy_len)
1474     {
1475       if (PREDICT_FALSE (!(src0 = map_guest_mem (vui, cpy->src, map_hint))))
1476         return 1;
1477       clib_memcpy ((void *) cpy->dst, src0, cpy->len);
1478       copy_len -= 1;
1479       cpy += 1;
1480     }
1481   return 0;
1482 }
1483
1484 /**
1485  * Try to discard packets from the tx ring (VPP RX path).
1486  * Returns the number of discarded packets.
1487  */
1488 u32
1489 vhost_user_rx_discard_packet (vlib_main_t * vm,
1490                               vhost_user_intf_t * vui,
1491                               vhost_user_vring_t * txvq, u32 discard_max)
1492 {
1493   /*
1494    * On the RX side, each packet corresponds to one descriptor
1495    * (it is the same whether it is a shallow descriptor, chained, or indirect).
1496    * Therefore, discarding a packet is like discarding a descriptor.
1497    */
1498   u32 discarded_packets = 0;
1499   u32 avail_idx = txvq->avail->idx;
1500   while (discarded_packets != discard_max)
1501     {
1502       if (avail_idx == txvq->last_avail_idx)
1503         goto out;
1504
1505       u16 desc_chain_head =
1506         txvq->avail->ring[txvq->last_avail_idx & txvq->qsz_mask];
1507       txvq->last_avail_idx++;
1508       txvq->used->ring[txvq->last_used_idx & txvq->qsz_mask].id =
1509         desc_chain_head;
1510       txvq->used->ring[txvq->last_used_idx & txvq->qsz_mask].len = 0;
1511       vhost_user_log_dirty_ring (vui, txvq,
1512                                  ring[txvq->last_used_idx & txvq->qsz_mask]);
1513       txvq->last_used_idx++;
1514       discarded_packets++;
1515     }
1516
1517 out:
1518   CLIB_MEMORY_BARRIER ();
1519   txvq->used->idx = txvq->last_used_idx;
1520   vhost_user_log_dirty_ring (vui, txvq, idx);
1521   return discarded_packets;
1522 }
1523
1524 /*
1525  * In case of overflow, we need to rewind the array of allocated buffers.
1526  */
1527 static void
1528 vhost_user_input_rewind_buffers (vlib_main_t * vm,
1529                                  vhost_cpu_t * cpu, vlib_buffer_t * b_head)
1530 {
1531   u32 bi_current = cpu->rx_buffers[cpu->rx_buffers_len];
1532   vlib_buffer_t *b_current = vlib_get_buffer (vm, bi_current);
1533   b_current->current_length = 0;
1534   b_current->flags = 0;
1535   while (b_current != b_head)
1536     {
1537       cpu->rx_buffers_len++;
1538       bi_current = cpu->rx_buffers[cpu->rx_buffers_len];
1539       b_current = vlib_get_buffer (vm, bi_current);
1540       b_current->current_length = 0;
1541       b_current->flags = 0;
1542     }
1543   cpu->rx_buffers_len++;
1544 }
1545
1546 static u32
1547 vhost_user_if_input (vlib_main_t * vm,
1548                      vhost_user_main_t * vum,
1549                      vhost_user_intf_t * vui,
1550                      u16 qid, vlib_node_runtime_t * node,
1551                      vnet_hw_interface_rx_mode mode)
1552 {
1553   vhost_user_vring_t *txvq = &vui->vrings[VHOST_VRING_IDX_TX (qid)];
1554   u16 n_rx_packets = 0;
1555   u32 n_rx_bytes = 0;
1556   u16 n_left;
1557   u32 n_left_to_next, *to_next;
1558   u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
1559   u32 n_trace = vlib_get_trace_count (vm, node);
1560   u32 map_hint = 0;
1561   u16 thread_index = vlib_get_thread_index ();
1562   u16 copy_len = 0;
1563
1564   {
1565     /* do we have pending interrupts ? */
1566     vhost_user_vring_t *rxvq = &vui->vrings[VHOST_VRING_IDX_RX (qid)];
1567     f64 now = vlib_time_now (vm);
1568
1569     if ((txvq->n_since_last_int) && (txvq->int_deadline < now))
1570       vhost_user_send_call (vm, txvq);
1571
1572     if ((rxvq->n_since_last_int) && (rxvq->int_deadline < now))
1573       vhost_user_send_call (vm, rxvq);
1574   }
1575
1576   /*
1577    * For adaptive mode, it is optimized to reduce interrupts.
1578    * If the scheduler switches the input node to polling due
1579    * to burst of traffic, we tell the driver no interrupt.
1580    * When the traffic subsides, the scheduler switches the node back to
1581    * interrupt mode. We must tell the driver we want interrupt.
1582    */
1583   if (PREDICT_FALSE (mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE))
1584     {
1585       if ((node->flags &
1586            VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE) ||
1587           !(node->flags &
1588             VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1589         /* Tell driver we want notification */
1590         txvq->used->flags = 0;
1591       else
1592         /* Tell driver we don't want notification */
1593         txvq->used->flags = VRING_USED_F_NO_NOTIFY;
1594     }
1595
1596   if (PREDICT_FALSE (txvq->avail->flags & 0xFFFE))
1597     return 0;
1598
1599   n_left = (u16) (txvq->avail->idx - txvq->last_avail_idx);
1600
1601   /* nothing to do */
1602   if (PREDICT_FALSE (n_left == 0))
1603     return 0;
1604
1605   if (PREDICT_FALSE (!vui->admin_up || !(txvq->enabled)))
1606     {
1607       /*
1608        * Discard input packet if interface is admin down or vring is not
1609        * enabled.
1610        * "For example, for a networking device, in the disabled state
1611        * client must not supply any new RX packets, but must process
1612        * and discard any TX packets."
1613        */
1614       vhost_user_rx_discard_packet (vm, vui, txvq,
1615                                     VHOST_USER_DOWN_DISCARD_COUNT);
1616       return 0;
1617     }
1618
1619   if (PREDICT_FALSE (n_left == (txvq->qsz_mask + 1)))
1620     {
1621       /*
1622        * Informational error logging when VPP is not
1623        * receiving packets fast enough.
1624        */
1625       vlib_error_count (vm, node->node_index,
1626                         VHOST_USER_INPUT_FUNC_ERROR_FULL_RX_QUEUE, 1);
1627     }
1628
1629   if (n_left > VLIB_FRAME_SIZE)
1630     n_left = VLIB_FRAME_SIZE;
1631
1632   /*
1633    * For small packets (<2kB), we will not need more than one vlib buffer
1634    * per packet. In case packets are bigger, we will just yeld at some point
1635    * in the loop and come back later. This is not an issue as for big packet,
1636    * processing cost really comes from the memory copy.
1637    * The assumption is that big packets will fit in 40 buffers.
1638    */
1639   if (PREDICT_FALSE (vum->cpus[thread_index].rx_buffers_len < n_left + 1 ||
1640                      vum->cpus[thread_index].rx_buffers_len < 40))
1641     {
1642       u32 curr_len = vum->cpus[thread_index].rx_buffers_len;
1643       vum->cpus[thread_index].rx_buffers_len +=
1644         vlib_buffer_alloc_from_free_list (vm,
1645                                           vum->cpus[thread_index].rx_buffers +
1646                                           curr_len,
1647                                           VHOST_USER_RX_BUFFERS_N - curr_len,
1648                                           VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
1649
1650       if (PREDICT_FALSE
1651           (vum->cpus[thread_index].rx_buffers_len <
1652            VHOST_USER_RX_BUFFER_STARVATION))
1653         {
1654           /* In case of buffer starvation, discard some packets from the queue
1655            * and log the event.
1656            * We keep doing best effort for the remaining packets. */
1657           u32 flush = (n_left + 1 > vum->cpus[thread_index].rx_buffers_len) ?
1658             n_left + 1 - vum->cpus[thread_index].rx_buffers_len : 1;
1659           flush = vhost_user_rx_discard_packet (vm, vui, txvq, flush);
1660
1661           n_left -= flush;
1662           vlib_increment_simple_counter (vnet_main.
1663                                          interface_main.sw_if_counters +
1664                                          VNET_INTERFACE_COUNTER_DROP,
1665                                          vlib_get_thread_index (),
1666                                          vui->sw_if_index, flush);
1667
1668           vlib_error_count (vm, vhost_user_input_node.index,
1669                             VHOST_USER_INPUT_FUNC_ERROR_NO_BUFFER, flush);
1670         }
1671     }
1672
1673   while (n_left > 0)
1674     {
1675       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1676
1677       while (n_left > 0 && n_left_to_next > 0)
1678         {
1679           vlib_buffer_t *b_head, *b_current;
1680           u32 bi_current;
1681           u16 desc_current;
1682           u32 desc_data_offset;
1683           vring_desc_t *desc_table = txvq->desc;
1684
1685           if (PREDICT_FALSE (vum->cpus[thread_index].rx_buffers_len <= 1))
1686             {
1687               /* Not enough rx_buffers
1688                * Note: We yeld on 1 so we don't need to do an additional
1689                * check for the next buffer prefetch.
1690                */
1691               n_left = 0;
1692               break;
1693             }
1694
1695           desc_current =
1696             txvq->avail->ring[txvq->last_avail_idx & txvq->qsz_mask];
1697           vum->cpus[thread_index].rx_buffers_len--;
1698           bi_current = (vum->cpus[thread_index].rx_buffers)
1699             [vum->cpus[thread_index].rx_buffers_len];
1700           b_head = b_current = vlib_get_buffer (vm, bi_current);
1701           to_next[0] = bi_current;      //We do that now so we can forget about bi_current
1702           to_next++;
1703           n_left_to_next--;
1704
1705           vlib_prefetch_buffer_with_index (vm,
1706                                            (vum->
1707                                             cpus[thread_index].rx_buffers)
1708                                            [vum->cpus[thread_index].
1709                                             rx_buffers_len - 1], LOAD);
1710
1711           /* Just preset the used descriptor id and length for later */
1712           txvq->used->ring[txvq->last_used_idx & txvq->qsz_mask].id =
1713             desc_current;
1714           txvq->used->ring[txvq->last_used_idx & txvq->qsz_mask].len = 0;
1715           vhost_user_log_dirty_ring (vui, txvq,
1716                                      ring[txvq->last_used_idx &
1717                                           txvq->qsz_mask]);
1718
1719           /* The buffer should already be initialized */
1720           b_head->total_length_not_including_first_buffer = 0;
1721           b_head->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
1722
1723           if (PREDICT_FALSE (n_trace))
1724             {
1725               //TODO: next_index is not exactly known at that point
1726               vlib_trace_buffer (vm, node, next_index, b_head,
1727                                  /* follow_chain */ 0);
1728               vhost_trace_t *t0 =
1729                 vlib_add_trace (vm, node, b_head, sizeof (t0[0]));
1730               vhost_user_rx_trace (t0, vui, qid, b_head, txvq);
1731               n_trace--;
1732               vlib_set_trace_count (vm, node, n_trace);
1733             }
1734
1735           /* This depends on the setup but is very consistent
1736            * So I think the CPU branch predictor will make a pretty good job
1737            * at optimizing the decision. */
1738           if (txvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1739             {
1740               desc_table = map_guest_mem (vui, txvq->desc[desc_current].addr,
1741                                           &map_hint);
1742               desc_current = 0;
1743               if (PREDICT_FALSE (desc_table == 0))
1744                 {
1745                   vlib_error_count (vm, node->node_index,
1746                                     VHOST_USER_INPUT_FUNC_ERROR_MMAP_FAIL, 1);
1747                   goto out;
1748                 }
1749             }
1750
1751           if (PREDICT_TRUE (vui->is_any_layout) ||
1752               (!(desc_table[desc_current].flags & VIRTQ_DESC_F_NEXT)))
1753             {
1754               /* ANYLAYOUT or single buffer */
1755               desc_data_offset = vui->virtio_net_hdr_sz;
1756             }
1757           else
1758             {
1759               /* CSR case without ANYLAYOUT, skip 1st buffer */
1760               desc_data_offset = desc_table[desc_current].len;
1761             }
1762
1763           while (1)
1764             {
1765               /* Get more input if necessary. Or end of packet. */
1766               if (desc_data_offset == desc_table[desc_current].len)
1767                 {
1768                   if (PREDICT_FALSE (desc_table[desc_current].flags &
1769                                      VIRTQ_DESC_F_NEXT))
1770                     {
1771                       desc_current = desc_table[desc_current].next;
1772                       desc_data_offset = 0;
1773                     }
1774                   else
1775                     {
1776                       goto out;
1777                     }
1778                 }
1779
1780               /* Get more output if necessary. Or end of packet. */
1781               if (PREDICT_FALSE
1782                   (b_current->current_length == VLIB_BUFFER_DATA_SIZE))
1783                 {
1784                   if (PREDICT_FALSE
1785                       (vum->cpus[thread_index].rx_buffers_len == 0))
1786                     {
1787                       /* Cancel speculation */
1788                       to_next--;
1789                       n_left_to_next++;
1790
1791                       /*
1792                        * Checking if there are some left buffers.
1793                        * If not, just rewind the used buffers and stop.
1794                        * Note: Scheduled copies are not cancelled. This is
1795                        * not an issue as they would still be valid. Useless,
1796                        * but valid.
1797                        */
1798                       vhost_user_input_rewind_buffers (vm,
1799                                                        &vum->cpus
1800                                                        [thread_index],
1801                                                        b_head);
1802                       n_left = 0;
1803                       goto stop;
1804                     }
1805
1806                   /* Get next output */
1807                   vum->cpus[thread_index].rx_buffers_len--;
1808                   u32 bi_next =
1809                     (vum->cpus[thread_index].rx_buffers)[vum->cpus
1810                                                          [thread_index].rx_buffers_len];
1811                   b_current->next_buffer = bi_next;
1812                   b_current->flags |= VLIB_BUFFER_NEXT_PRESENT;
1813                   bi_current = bi_next;
1814                   b_current = vlib_get_buffer (vm, bi_current);
1815                 }
1816
1817               /* Prepare a copy order executed later for the data */
1818               vhost_copy_t *cpy = &vum->cpus[thread_index].copy[copy_len];
1819               copy_len++;
1820               u32 desc_data_l =
1821                 desc_table[desc_current].len - desc_data_offset;
1822               cpy->len = VLIB_BUFFER_DATA_SIZE - b_current->current_length;
1823               cpy->len = (cpy->len > desc_data_l) ? desc_data_l : cpy->len;
1824               cpy->dst = (uword) (vlib_buffer_get_current (b_current) +
1825                                   b_current->current_length);
1826               cpy->src = desc_table[desc_current].addr + desc_data_offset;
1827
1828               desc_data_offset += cpy->len;
1829
1830               b_current->current_length += cpy->len;
1831               b_head->total_length_not_including_first_buffer += cpy->len;
1832             }
1833
1834         out:
1835           CLIB_PREFETCH (&n_left, sizeof (n_left), LOAD);
1836
1837           n_rx_bytes += b_head->total_length_not_including_first_buffer;
1838           n_rx_packets++;
1839
1840           b_head->total_length_not_including_first_buffer -=
1841             b_head->current_length;
1842
1843           /* consume the descriptor and return it as used */
1844           txvq->last_avail_idx++;
1845           txvq->last_used_idx++;
1846
1847           VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b_head);
1848
1849           vnet_buffer (b_head)->sw_if_index[VLIB_RX] = vui->sw_if_index;
1850           vnet_buffer (b_head)->sw_if_index[VLIB_TX] = (u32) ~ 0;
1851           b_head->error = 0;
1852
1853           {
1854             u32 next0 = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
1855
1856             /* redirect if feature path enabled */
1857             vnet_feature_start_device_input_x1 (vui->sw_if_index, &next0,
1858                                                 b_head);
1859
1860             u32 bi = to_next[-1];       //Cannot use to_next[-1] in the macro
1861             vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
1862                                              to_next, n_left_to_next,
1863                                              bi, next0);
1864           }
1865
1866           n_left--;
1867
1868           /*
1869            * Although separating memory copies from virtio ring parsing
1870            * is beneficial, we can offer to perform the copies from time
1871            * to time in order to free some space in the ring.
1872            */
1873           if (PREDICT_FALSE (copy_len >= VHOST_USER_RX_COPY_THRESHOLD))
1874             {
1875               if (PREDICT_FALSE
1876                   (vhost_user_input_copy (vui, vum->cpus[thread_index].copy,
1877                                           copy_len, &map_hint)))
1878                 {
1879                   vlib_error_count (vm, node->node_index,
1880                                     VHOST_USER_INPUT_FUNC_ERROR_MMAP_FAIL, 1);
1881                 }
1882               copy_len = 0;
1883
1884               /* give buffers back to driver */
1885               CLIB_MEMORY_BARRIER ();
1886               txvq->used->idx = txvq->last_used_idx;
1887               vhost_user_log_dirty_ring (vui, txvq, idx);
1888             }
1889         }
1890     stop:
1891       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1892     }
1893
1894   /* Do the memory copies */
1895   if (PREDICT_FALSE
1896       (vhost_user_input_copy (vui, vum->cpus[thread_index].copy,
1897                               copy_len, &map_hint)))
1898     {
1899       vlib_error_count (vm, node->node_index,
1900                         VHOST_USER_INPUT_FUNC_ERROR_MMAP_FAIL, 1);
1901     }
1902
1903   /* give buffers back to driver */
1904   CLIB_MEMORY_BARRIER ();
1905   txvq->used->idx = txvq->last_used_idx;
1906   vhost_user_log_dirty_ring (vui, txvq, idx);
1907
1908   /* interrupt (call) handling */
1909   if ((txvq->callfd_idx != ~0) &&
1910       !(txvq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT))
1911     {
1912       txvq->n_since_last_int += n_rx_packets;
1913
1914       if (txvq->n_since_last_int > vum->coalesce_frames)
1915         vhost_user_send_call (vm, txvq);
1916     }
1917
1918   /* increase rx counters */
1919   vlib_increment_combined_counter
1920     (vnet_main.interface_main.combined_sw_if_counters
1921      + VNET_INTERFACE_COUNTER_RX,
1922      vlib_get_thread_index (), vui->sw_if_index, n_rx_packets, n_rx_bytes);
1923
1924   vnet_device_increment_rx_packets (thread_index, n_rx_packets);
1925
1926   return n_rx_packets;
1927 }
1928
1929 static uword
1930 vhost_user_input (vlib_main_t * vm,
1931                   vlib_node_runtime_t * node, vlib_frame_t * f)
1932 {
1933   vhost_user_main_t *vum = &vhost_user_main;
1934   uword n_rx_packets = 0;
1935   vhost_user_intf_t *vui;
1936   vnet_device_input_runtime_t *rt =
1937     (vnet_device_input_runtime_t *) node->runtime_data;
1938   vnet_device_and_queue_t *dq;
1939
1940   vec_foreach (dq, rt->devices_and_queues)
1941   {
1942     if (clib_smp_swap (&dq->interrupt_pending, 0) ||
1943         (node->state == VLIB_NODE_STATE_POLLING))
1944       {
1945         vui =
1946           pool_elt_at_index (vum->vhost_user_interfaces, dq->dev_instance);
1947         n_rx_packets = vhost_user_if_input (vm, vum, vui, dq->queue_id, node,
1948                                             dq->mode);
1949       }
1950   }
1951
1952   return n_rx_packets;
1953 }
1954
1955 /* *INDENT-OFF* */
1956 VLIB_REGISTER_NODE (vhost_user_input_node) = {
1957   .function = vhost_user_input,
1958   .type = VLIB_NODE_TYPE_INPUT,
1959   .name = "vhost-user-input",
1960   .sibling_of = "device-input",
1961
1962   /* Will be enabled if/when hardware is detected. */
1963   .state = VLIB_NODE_STATE_DISABLED,
1964
1965   .format_buffer = format_ethernet_header_with_length,
1966   .format_trace = format_vhost_trace,
1967
1968   .n_errors = VHOST_USER_INPUT_FUNC_N_ERROR,
1969   .error_strings = vhost_user_input_func_error_strings,
1970 };
1971
1972 VLIB_NODE_FUNCTION_MULTIARCH (vhost_user_input_node, vhost_user_input)
1973 /* *INDENT-ON* */
1974
1975
1976 void
1977 vhost_user_tx_trace (vhost_trace_t * t,
1978                      vhost_user_intf_t * vui, u16 qid,
1979                      vlib_buffer_t * b, vhost_user_vring_t * rxvq)
1980 {
1981   vhost_user_main_t *vum = &vhost_user_main;
1982   u32 last_avail_idx = rxvq->last_avail_idx;
1983   u32 desc_current = rxvq->avail->ring[last_avail_idx & rxvq->qsz_mask];
1984   vring_desc_t *hdr_desc = 0;
1985   u32 hint = 0;
1986
1987   memset (t, 0, sizeof (*t));
1988   t->device_index = vui - vum->vhost_user_interfaces;
1989   t->qid = qid;
1990
1991   hdr_desc = &rxvq->desc[desc_current];
1992   if (rxvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
1993     {
1994       t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_INDIRECT;
1995       /* Header is the first here */
1996       hdr_desc = map_guest_mem (vui, rxvq->desc[desc_current].addr, &hint);
1997     }
1998   if (rxvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT)
1999     {
2000       t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SIMPLE_CHAINED;
2001     }
2002   if (!(rxvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT) &&
2003       !(rxvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT))
2004     {
2005       t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SINGLE_DESC;
2006     }
2007
2008   t->first_desc_len = hdr_desc ? hdr_desc->len : 0;
2009 }
2010
2011 static_always_inline u32
2012 vhost_user_tx_copy (vhost_user_intf_t * vui, vhost_copy_t * cpy,
2013                     u16 copy_len, u32 * map_hint)
2014 {
2015   void *dst0, *dst1, *dst2, *dst3;
2016   if (PREDICT_TRUE (copy_len >= 4))
2017     {
2018       if (PREDICT_FALSE (!(dst2 = map_guest_mem (vui, cpy[0].dst, map_hint))))
2019         return 1;
2020       if (PREDICT_FALSE (!(dst3 = map_guest_mem (vui, cpy[1].dst, map_hint))))
2021         return 1;
2022       while (PREDICT_TRUE (copy_len >= 4))
2023         {
2024           dst0 = dst2;
2025           dst1 = dst3;
2026
2027           if (PREDICT_FALSE
2028               (!(dst2 = map_guest_mem (vui, cpy[2].dst, map_hint))))
2029             return 1;
2030           if (PREDICT_FALSE
2031               (!(dst3 = map_guest_mem (vui, cpy[3].dst, map_hint))))
2032             return 1;
2033
2034           CLIB_PREFETCH ((void *) cpy[2].src, 64, LOAD);
2035           CLIB_PREFETCH ((void *) cpy[3].src, 64, LOAD);
2036
2037           clib_memcpy (dst0, (void *) cpy[0].src, cpy[0].len);
2038           clib_memcpy (dst1, (void *) cpy[1].src, cpy[1].len);
2039
2040           vhost_user_log_dirty_pages_2 (vui, cpy[0].dst, cpy[0].len, 1);
2041           vhost_user_log_dirty_pages_2 (vui, cpy[1].dst, cpy[1].len, 1);
2042           copy_len -= 2;
2043           cpy += 2;
2044         }
2045     }
2046   while (copy_len)
2047     {
2048       if (PREDICT_FALSE (!(dst0 = map_guest_mem (vui, cpy->dst, map_hint))))
2049         return 1;
2050       clib_memcpy (dst0, (void *) cpy->src, cpy->len);
2051       vhost_user_log_dirty_pages_2 (vui, cpy->dst, cpy->len, 1);
2052       copy_len -= 1;
2053       cpy += 1;
2054     }
2055   return 0;
2056 }
2057
2058
2059 static uword
2060 vhost_user_tx (vlib_main_t * vm,
2061                vlib_node_runtime_t * node, vlib_frame_t * frame)
2062 {
2063   u32 *buffers = vlib_frame_args (frame);
2064   u32 n_left = frame->n_vectors;
2065   vhost_user_main_t *vum = &vhost_user_main;
2066   vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
2067   vhost_user_intf_t *vui =
2068     pool_elt_at_index (vum->vhost_user_interfaces, rd->dev_instance);
2069   u32 qid = ~0;
2070   vhost_user_vring_t *rxvq;
2071   u8 error;
2072   u32 thread_index = vlib_get_thread_index ();
2073   u32 map_hint = 0;
2074   u8 retry = 8;
2075   u16 copy_len;
2076   u16 tx_headers_len;
2077
2078   if (PREDICT_FALSE (!vui->admin_up))
2079     {
2080       error = VHOST_USER_TX_FUNC_ERROR_DOWN;
2081       goto done3;
2082     }
2083
2084   if (PREDICT_FALSE (!vui->is_up))
2085     {
2086       error = VHOST_USER_TX_FUNC_ERROR_NOT_READY;
2087       goto done3;
2088     }
2089
2090   qid =
2091     VHOST_VRING_IDX_RX (*vec_elt_at_index
2092                         (vui->per_cpu_tx_qid, thread_index));
2093   rxvq = &vui->vrings[qid];
2094   if (PREDICT_FALSE (vui->use_tx_spinlock))
2095     vhost_user_vring_lock (vui, qid);
2096
2097 retry:
2098   error = VHOST_USER_TX_FUNC_ERROR_NONE;
2099   tx_headers_len = 0;
2100   copy_len = 0;
2101   while (n_left > 0)
2102     {
2103       vlib_buffer_t *b0, *current_b0;
2104       u16 desc_head, desc_index, desc_len;
2105       vring_desc_t *desc_table;
2106       uword buffer_map_addr;
2107       u32 buffer_len;
2108       u16 bytes_left;
2109
2110       if (PREDICT_TRUE (n_left > 1))
2111         vlib_prefetch_buffer_with_index (vm, buffers[1], LOAD);
2112
2113       b0 = vlib_get_buffer (vm, buffers[0]);
2114
2115       if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2116         {
2117           vum->cpus[thread_index].current_trace =
2118             vlib_add_trace (vm, node, b0,
2119                             sizeof (*vum->cpus[thread_index].current_trace));
2120           vhost_user_tx_trace (vum->cpus[thread_index].current_trace,
2121                                vui, qid / 2, b0, rxvq);
2122         }
2123
2124       if (PREDICT_FALSE (rxvq->last_avail_idx == rxvq->avail->idx))
2125         {
2126           error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
2127           goto done;
2128         }
2129
2130       desc_table = rxvq->desc;
2131       desc_head = desc_index =
2132         rxvq->avail->ring[rxvq->last_avail_idx & rxvq->qsz_mask];
2133
2134       /* Go deeper in case of indirect descriptor
2135        * I don't know of any driver providing indirect for RX. */
2136       if (PREDICT_FALSE (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT))
2137         {
2138           if (PREDICT_FALSE
2139               (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
2140             {
2141               error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
2142               goto done;
2143             }
2144           if (PREDICT_FALSE
2145               (!(desc_table =
2146                  map_guest_mem (vui, rxvq->desc[desc_index].addr,
2147                                 &map_hint))))
2148             {
2149               error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
2150               goto done;
2151             }
2152           desc_index = 0;
2153         }
2154
2155       desc_len = vui->virtio_net_hdr_sz;
2156       buffer_map_addr = desc_table[desc_index].addr;
2157       buffer_len = desc_table[desc_index].len;
2158
2159       {
2160         // Get a header from the header array
2161         virtio_net_hdr_mrg_rxbuf_t *hdr =
2162           &vum->cpus[thread_index].tx_headers[tx_headers_len];
2163         tx_headers_len++;
2164         hdr->hdr.flags = 0;
2165         hdr->hdr.gso_type = 0;
2166         hdr->num_buffers = 1;   //This is local, no need to check
2167
2168         // Prepare a copy order executed later for the header
2169         vhost_copy_t *cpy = &vum->cpus[thread_index].copy[copy_len];
2170         copy_len++;
2171         cpy->len = vui->virtio_net_hdr_sz;
2172         cpy->dst = buffer_map_addr;
2173         cpy->src = (uword) hdr;
2174       }
2175
2176       buffer_map_addr += vui->virtio_net_hdr_sz;
2177       buffer_len -= vui->virtio_net_hdr_sz;
2178       bytes_left = b0->current_length;
2179       current_b0 = b0;
2180       while (1)
2181         {
2182           if (buffer_len == 0)
2183             {                   //Get new output
2184               if (desc_table[desc_index].flags & VIRTQ_DESC_F_NEXT)
2185                 {
2186                   //Next one is chained
2187                   desc_index = desc_table[desc_index].next;
2188                   buffer_map_addr = desc_table[desc_index].addr;
2189                   buffer_len = desc_table[desc_index].len;
2190                 }
2191               else if (vui->virtio_net_hdr_sz == 12)    //MRG is available
2192                 {
2193                   virtio_net_hdr_mrg_rxbuf_t *hdr =
2194                     &vum->cpus[thread_index].tx_headers[tx_headers_len - 1];
2195
2196                   //Move from available to used buffer
2197                   rxvq->used->ring[rxvq->last_used_idx & rxvq->qsz_mask].id =
2198                     desc_head;
2199                   rxvq->used->ring[rxvq->last_used_idx & rxvq->qsz_mask].len =
2200                     desc_len;
2201                   vhost_user_log_dirty_ring (vui, rxvq,
2202                                              ring[rxvq->last_used_idx &
2203                                                   rxvq->qsz_mask]);
2204
2205                   rxvq->last_avail_idx++;
2206                   rxvq->last_used_idx++;
2207                   hdr->num_buffers++;
2208                   desc_len = 0;
2209
2210                   if (PREDICT_FALSE
2211                       (rxvq->last_avail_idx == rxvq->avail->idx))
2212                     {
2213                       //Dequeue queued descriptors for this packet
2214                       rxvq->last_used_idx -= hdr->num_buffers - 1;
2215                       rxvq->last_avail_idx -= hdr->num_buffers - 1;
2216                       error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
2217                       goto done;
2218                     }
2219
2220                   desc_table = rxvq->desc;
2221                   desc_head = desc_index =
2222                     rxvq->avail->ring[rxvq->last_avail_idx & rxvq->qsz_mask];
2223                   if (PREDICT_FALSE
2224                       (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT))
2225                     {
2226                       //It is seriously unlikely that a driver will put indirect descriptor
2227                       //after non-indirect descriptor.
2228                       if (PREDICT_FALSE
2229                           (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
2230                         {
2231                           error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
2232                           goto done;
2233                         }
2234                       if (PREDICT_FALSE
2235                           (!(desc_table =
2236                              map_guest_mem (vui,
2237                                             rxvq->desc[desc_index].addr,
2238                                             &map_hint))))
2239                         {
2240                           error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
2241                           goto done;
2242                         }
2243                       desc_index = 0;
2244                     }
2245                   buffer_map_addr = desc_table[desc_index].addr;
2246                   buffer_len = desc_table[desc_index].len;
2247                 }
2248               else
2249                 {
2250                   error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOMRG;
2251                   goto done;
2252                 }
2253             }
2254
2255           {
2256             vhost_copy_t *cpy = &vum->cpus[thread_index].copy[copy_len];
2257             copy_len++;
2258             cpy->len = bytes_left;
2259             cpy->len = (cpy->len > buffer_len) ? buffer_len : cpy->len;
2260             cpy->dst = buffer_map_addr;
2261             cpy->src = (uword) vlib_buffer_get_current (current_b0) +
2262               current_b0->current_length - bytes_left;
2263
2264             bytes_left -= cpy->len;
2265             buffer_len -= cpy->len;
2266             buffer_map_addr += cpy->len;
2267             desc_len += cpy->len;
2268
2269             CLIB_PREFETCH (&rxvq->desc, CLIB_CACHE_LINE_BYTES, LOAD);
2270           }
2271
2272           // Check if vlib buffer has more data. If not, get more or break.
2273           if (PREDICT_TRUE (!bytes_left))
2274             {
2275               if (PREDICT_FALSE
2276                   (current_b0->flags & VLIB_BUFFER_NEXT_PRESENT))
2277                 {
2278                   current_b0 = vlib_get_buffer (vm, current_b0->next_buffer);
2279                   bytes_left = current_b0->current_length;
2280                 }
2281               else
2282                 {
2283                   //End of packet
2284                   break;
2285                 }
2286             }
2287         }
2288
2289       //Move from available to used ring
2290       rxvq->used->ring[rxvq->last_used_idx & rxvq->qsz_mask].id = desc_head;
2291       rxvq->used->ring[rxvq->last_used_idx & rxvq->qsz_mask].len = desc_len;
2292       vhost_user_log_dirty_ring (vui, rxvq,
2293                                  ring[rxvq->last_used_idx & rxvq->qsz_mask]);
2294       rxvq->last_avail_idx++;
2295       rxvq->last_used_idx++;
2296
2297       if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2298         {
2299           vum->cpus[thread_index].current_trace->hdr =
2300             vum->cpus[thread_index].tx_headers[tx_headers_len - 1];
2301         }
2302
2303       n_left--;                 //At the end for error counting when 'goto done' is invoked
2304
2305       /*
2306        * Do the copy periodically to prevent
2307        * vum->cpus[thread_index].copy array overflow and corrupt memory
2308        */
2309       if (PREDICT_FALSE (copy_len >= VHOST_USER_TX_COPY_THRESHOLD))
2310         {
2311           if (PREDICT_FALSE
2312               (vhost_user_tx_copy (vui, vum->cpus[thread_index].copy,
2313                                    copy_len, &map_hint)))
2314             {
2315               vlib_error_count (vm, node->node_index,
2316                                 VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL, 1);
2317             }
2318           copy_len = 0;
2319
2320           /* give buffers back to driver */
2321           CLIB_MEMORY_BARRIER ();
2322           rxvq->used->idx = rxvq->last_used_idx;
2323           vhost_user_log_dirty_ring (vui, rxvq, idx);
2324         }
2325       buffers++;
2326     }
2327
2328 done:
2329   //Do the memory copies
2330   if (PREDICT_FALSE
2331       (vhost_user_tx_copy (vui, vum->cpus[thread_index].copy,
2332                            copy_len, &map_hint)))
2333     {
2334       vlib_error_count (vm, node->node_index,
2335                         VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL, 1);
2336     }
2337
2338   CLIB_MEMORY_BARRIER ();
2339   rxvq->used->idx = rxvq->last_used_idx;
2340   vhost_user_log_dirty_ring (vui, rxvq, idx);
2341
2342   /*
2343    * When n_left is set, error is always set to something too.
2344    * In case error is due to lack of remaining buffers, we go back up and
2345    * retry.
2346    * The idea is that it is better to waste some time on packets
2347    * that have been processed already than dropping them and get
2348    * more fresh packets with a good likelyhood that they will be dropped too.
2349    * This technique also gives more time to VM driver to pick-up packets.
2350    * In case the traffic flows from physical to virtual interfaces, this
2351    * technique will end-up leveraging the physical NIC buffer in order to
2352    * absorb the VM's CPU jitter.
2353    */
2354   if (n_left && (error == VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF) && retry)
2355     {
2356       retry--;
2357       goto retry;
2358     }
2359
2360   /* interrupt (call) handling */
2361   if ((rxvq->callfd_idx != ~0) &&
2362       !(rxvq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT))
2363     {
2364       rxvq->n_since_last_int += frame->n_vectors - n_left;
2365
2366       if (rxvq->n_since_last_int > vum->coalesce_frames)
2367         vhost_user_send_call (vm, rxvq);
2368     }
2369
2370   vhost_user_vring_unlock (vui, qid);
2371
2372 done3:
2373   if (PREDICT_FALSE (n_left && error != VHOST_USER_TX_FUNC_ERROR_NONE))
2374     {
2375       vlib_error_count (vm, node->node_index, error, n_left);
2376       vlib_increment_simple_counter
2377         (vnet_main.interface_main.sw_if_counters
2378          + VNET_INTERFACE_COUNTER_DROP,
2379          thread_index, vui->sw_if_index, n_left);
2380     }
2381
2382   vlib_buffer_free (vm, vlib_frame_args (frame), frame->n_vectors);
2383   return frame->n_vectors;
2384 }
2385
2386 static uword
2387 vhost_user_send_interrupt_process (vlib_main_t * vm,
2388                                    vlib_node_runtime_t * rt, vlib_frame_t * f)
2389 {
2390   vhost_user_intf_t *vui;
2391   f64 timeout = 3153600000.0 /* 100 years */ ;
2392   uword event_type, *event_data = 0;
2393   vhost_user_main_t *vum = &vhost_user_main;
2394   u16 *queue;
2395   f64 now, poll_time_remaining;
2396   f64 next_timeout;
2397   u8 stop_timer = 0;
2398
2399   while (1)
2400     {
2401       poll_time_remaining =
2402         vlib_process_wait_for_event_or_clock (vm, timeout);
2403       event_type = vlib_process_get_events (vm, &event_data);
2404       vec_reset_length (event_data);
2405
2406       /*
2407        * Use the remaining timeout if it is less than coalesce time to avoid
2408        * resetting the existing timer in the middle of expiration
2409        */
2410       timeout = poll_time_remaining;
2411       if (vlib_process_suspend_time_is_zero (timeout) ||
2412           (timeout > vum->coalesce_time))
2413         timeout = vum->coalesce_time;
2414
2415       now = vlib_time_now (vm);
2416       switch (event_type)
2417         {
2418         case VHOST_USER_EVENT_STOP_TIMER:
2419           stop_timer = 1;
2420           break;
2421
2422         case VHOST_USER_EVENT_START_TIMER:
2423           stop_timer = 0;
2424           if (!vlib_process_suspend_time_is_zero (poll_time_remaining))
2425             break;
2426           /* fall through */
2427
2428         case ~0:
2429           /* *INDENT-OFF* */
2430           pool_foreach (vui, vum->vhost_user_interfaces, {
2431               next_timeout = timeout;
2432               vec_foreach (queue, vui->rx_queues)
2433                 {
2434                   vhost_user_vring_t *rxvq =
2435                     &vui->vrings[VHOST_VRING_IDX_RX (*queue)];
2436                   vhost_user_vring_t *txvq =
2437                     &vui->vrings[VHOST_VRING_IDX_TX (*queue)];
2438
2439                   if (txvq->n_since_last_int)
2440                     {
2441                       if (now >= txvq->int_deadline)
2442                         vhost_user_send_call (vm, txvq);
2443                       else
2444                         next_timeout = txvq->int_deadline - now;
2445                     }
2446
2447                   if (rxvq->n_since_last_int)
2448                     {
2449                       if (now >= rxvq->int_deadline)
2450                         vhost_user_send_call (vm, rxvq);
2451                       else
2452                         next_timeout = rxvq->int_deadline - now;
2453                     }
2454
2455                   if ((next_timeout < timeout) && (next_timeout > 0.0))
2456                     timeout = next_timeout;
2457                 }
2458           });
2459           /* *INDENT-ON* */
2460           break;
2461
2462         default:
2463           clib_warning ("BUG: unhandled event type %d", event_type);
2464           break;
2465         }
2466       /* No less than 1 millisecond */
2467       if (timeout < 1e-3)
2468         timeout = 1e-3;
2469       if (stop_timer)
2470         timeout = 3153600000.0;
2471     }
2472   return 0;
2473 }
2474
2475 /* *INDENT-OFF* */
2476 VLIB_REGISTER_NODE (vhost_user_send_interrupt_node,static) = {
2477     .function = vhost_user_send_interrupt_process,
2478     .type = VLIB_NODE_TYPE_PROCESS,
2479     .name = "vhost-user-send-interrupt-process",
2480 };
2481 /* *INDENT-ON* */
2482
2483 static clib_error_t *
2484 vhost_user_interface_rx_mode_change (vnet_main_t * vnm, u32 hw_if_index,
2485                                      u32 qid, vnet_hw_interface_rx_mode mode)
2486 {
2487   vlib_main_t *vm = vnm->vlib_main;
2488   vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
2489   vhost_user_main_t *vum = &vhost_user_main;
2490   vhost_user_intf_t *vui =
2491     pool_elt_at_index (vum->vhost_user_interfaces, hif->dev_instance);
2492   vhost_user_vring_t *txvq = &vui->vrings[VHOST_VRING_IDX_TX (qid)];
2493
2494   if ((mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT) ||
2495       (mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE))
2496     {
2497       if (txvq->kickfd_idx == ~0)
2498         {
2499           // We cannot support interrupt mode if the driver opts out
2500           return clib_error_return (0, "Driver does not support interrupt");
2501         }
2502       if (txvq->mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
2503         {
2504           vum->ifq_count++;
2505           // Start the timer if this is the first encounter on interrupt
2506           // interface/queue
2507           if ((vum->ifq_count == 1) &&
2508               (vum->coalesce_time > 0.0) && (vum->coalesce_frames > 0))
2509             vlib_process_signal_event (vm,
2510                                        vhost_user_send_interrupt_node.index,
2511                                        VHOST_USER_EVENT_START_TIMER, 0);
2512         }
2513     }
2514   else if (mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
2515     {
2516       if (((txvq->mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT) ||
2517            (txvq->mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE)) &&
2518           vum->ifq_count)
2519         {
2520           vum->ifq_count--;
2521           // Stop the timer if there is no more interrupt interface/queue
2522           if ((vum->ifq_count == 0) &&
2523               (vum->coalesce_time > 0.0) && (vum->coalesce_frames > 0))
2524             vlib_process_signal_event (vm,
2525                                        vhost_user_send_interrupt_node.index,
2526                                        VHOST_USER_EVENT_STOP_TIMER, 0);
2527         }
2528     }
2529
2530   txvq->mode = mode;
2531   if (mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
2532     txvq->used->flags = VRING_USED_F_NO_NOTIFY;
2533   else if ((mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE) ||
2534            (mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT))
2535     txvq->used->flags = 0;
2536   else
2537     {
2538       clib_warning ("BUG: unhandled mode %d changed for if %d queue %d", mode,
2539                     hw_if_index, qid);
2540       return clib_error_return (0, "unsupported");
2541     }
2542
2543   return 0;
2544 }
2545
2546 static clib_error_t *
2547 vhost_user_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
2548                                     u32 flags)
2549 {
2550   vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
2551   uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
2552   vhost_user_main_t *vum = &vhost_user_main;
2553   vhost_user_intf_t *vui =
2554     pool_elt_at_index (vum->vhost_user_interfaces, hif->dev_instance);
2555
2556   vui->admin_up = is_up;
2557
2558   if (is_up && vui->is_up)
2559     vnet_hw_interface_set_flags (vnm, vui->hw_if_index,
2560                                  VNET_HW_INTERFACE_FLAG_LINK_UP);
2561
2562   return /* no error */ 0;
2563 }
2564
2565 /* *INDENT-OFF* */
2566 VNET_DEVICE_CLASS (vhost_user_dev_class,static) = {
2567   .name = "vhost-user",
2568   .tx_function = vhost_user_tx,
2569   .tx_function_n_errors = VHOST_USER_TX_FUNC_N_ERROR,
2570   .tx_function_error_strings = vhost_user_tx_func_error_strings,
2571   .format_device_name = format_vhost_user_interface_name,
2572   .name_renumber = vhost_user_name_renumber,
2573   .admin_up_down_function = vhost_user_interface_admin_up_down,
2574   .rx_mode_change_function = vhost_user_interface_rx_mode_change,
2575   .format_tx_trace = format_vhost_trace,
2576 };
2577
2578 VLIB_DEVICE_TX_FUNCTION_MULTIARCH (vhost_user_dev_class,
2579                                    vhost_user_tx)
2580 /* *INDENT-ON* */
2581
2582 static uword
2583 vhost_user_process (vlib_main_t * vm,
2584                     vlib_node_runtime_t * rt, vlib_frame_t * f)
2585 {
2586   vhost_user_main_t *vum = &vhost_user_main;
2587   vhost_user_intf_t *vui;
2588   struct sockaddr_un sun;
2589   int sockfd;
2590   clib_file_t template = { 0 };
2591   f64 timeout = 3153600000.0 /* 100 years */ ;
2592   uword *event_data = 0;
2593
2594   sockfd = -1;
2595   sun.sun_family = AF_UNIX;
2596   template.read_function = vhost_user_socket_read;
2597   template.error_function = vhost_user_socket_error;
2598
2599   while (1)
2600     {
2601       vlib_process_wait_for_event_or_clock (vm, timeout);
2602       vlib_process_get_events (vm, &event_data);
2603       vec_reset_length (event_data);
2604
2605       timeout = 3.0;
2606
2607       /* *INDENT-OFF* */
2608       pool_foreach (vui, vum->vhost_user_interfaces, {
2609
2610           if (vui->unix_server_index == ~0) { //Nothing to do for server sockets
2611               if (vui->clib_file_index == ~0)
2612                 {
2613                   if ((sockfd < 0) &&
2614                       ((sockfd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0))
2615                     {
2616                       /*
2617                        * 1st time error or new error for this interface,
2618                        * spit out the message and record the error
2619                        */
2620                       if (!vui->sock_errno || (vui->sock_errno != errno))
2621                         {
2622                           clib_unix_warning
2623                             ("Error: Could not open unix socket for %s",
2624                              vui->sock_filename);
2625                           vui->sock_errno = errno;
2626                         }
2627                       continue;
2628                     }
2629
2630                   /* try to connect */
2631                   strncpy (sun.sun_path, (char *) vui->sock_filename,
2632                            sizeof (sun.sun_path) - 1);
2633
2634                   /* Avoid hanging VPP if the other end does not accept */
2635                   if (fcntl(sockfd, F_SETFL, O_NONBLOCK) < 0)
2636                       clib_unix_warning ("fcntl");
2637
2638                   if (connect (sockfd, (struct sockaddr *) &sun,
2639                                sizeof (struct sockaddr_un)) == 0)
2640                     {
2641                       /* Set the socket to blocking as it was before */
2642                       if (fcntl(sockfd, F_SETFL, 0) < 0)
2643                         clib_unix_warning ("fcntl2");
2644
2645                       vui->sock_errno = 0;
2646                       template.file_descriptor = sockfd;
2647                       template.private_data =
2648                           vui - vhost_user_main.vhost_user_interfaces;
2649                       vui->clib_file_index = clib_file_add (&file_main, &template);
2650
2651                       /* This sockfd is considered consumed */
2652                       sockfd = -1;
2653                     }
2654                   else
2655                     {
2656                       vui->sock_errno = errno;
2657                     }
2658                 }
2659               else
2660                 {
2661                   /* check if socket is alive */
2662                   int error = 0;
2663                   socklen_t len = sizeof (error);
2664                   int fd = UNIX_GET_FD(vui->clib_file_index);
2665                   int retval =
2666                       getsockopt (fd, SOL_SOCKET, SO_ERROR, &error, &len);
2667
2668                   if (retval)
2669                     {
2670                       DBG_SOCK ("getsockopt returned %d", retval);
2671                       vhost_user_if_disconnect (vui);
2672                     }
2673                 }
2674           }
2675       });
2676       /* *INDENT-ON* */
2677     }
2678   return 0;
2679 }
2680
2681 /* *INDENT-OFF* */
2682 VLIB_REGISTER_NODE (vhost_user_process_node,static) = {
2683     .function = vhost_user_process,
2684     .type = VLIB_NODE_TYPE_PROCESS,
2685     .name = "vhost-user-process",
2686 };
2687 /* *INDENT-ON* */
2688
2689 /**
2690  * Disables and reset interface structure.
2691  * It can then be either init again, or removed from used interfaces.
2692  */
2693 static void
2694 vhost_user_term_if (vhost_user_intf_t * vui)
2695 {
2696   int q;
2697   vhost_user_main_t *vum = &vhost_user_main;
2698
2699   // disconnect interface sockets
2700   vhost_user_if_disconnect (vui);
2701   vhost_user_update_iface_state (vui);
2702
2703   for (q = 0; q < VHOST_VRING_MAX_N; q++)
2704     {
2705       clib_mem_free ((void *) vui->vring_locks[q]);
2706     }
2707
2708   if (vui->unix_server_index != ~0)
2709     {
2710       //Close server socket
2711       clib_file_t *uf = pool_elt_at_index (file_main.file_pool,
2712                                            vui->unix_server_index);
2713       clib_file_del (&file_main, uf);
2714       vui->unix_server_index = ~0;
2715       unlink (vui->sock_filename);
2716     }
2717
2718   mhash_unset (&vum->if_index_by_sock_name, vui->sock_filename,
2719                &vui->if_index);
2720 }
2721
2722 int
2723 vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm, u32 sw_if_index)
2724 {
2725   vhost_user_main_t *vum = &vhost_user_main;
2726   vhost_user_intf_t *vui;
2727   int rv = 0;
2728   vnet_hw_interface_t *hwif;
2729   u16 *queue;
2730
2731   if (!(hwif = vnet_get_sup_hw_interface (vnm, sw_if_index)) ||
2732       hwif->dev_class_index != vhost_user_dev_class.index)
2733     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
2734
2735   DBG_SOCK ("Deleting vhost-user interface %s (instance %d)",
2736             hwif->name, hwif->dev_instance);
2737
2738   vui = pool_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
2739
2740   vec_foreach (queue, vui->rx_queues)
2741   {
2742     vhost_user_vring_t *txvq;
2743
2744     txvq = &vui->vrings[VHOST_VRING_IDX_TX (*queue)];
2745     if ((vum->ifq_count > 0) &&
2746         ((txvq->mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT) ||
2747          (txvq->mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE)))
2748       {
2749         vum->ifq_count--;
2750         // Stop the timer if there is no more interrupt interface/queue
2751         if ((vum->ifq_count == 0) &&
2752             (vum->coalesce_time > 0.0) && (vum->coalesce_frames > 0))
2753           {
2754             vlib_process_signal_event (vm,
2755                                        vhost_user_send_interrupt_node.index,
2756                                        VHOST_USER_EVENT_STOP_TIMER, 0);
2757             break;
2758           }
2759       }
2760   }
2761
2762   // Disable and reset interface
2763   vhost_user_term_if (vui);
2764
2765   // Reset renumbered iface
2766   if (hwif->dev_instance <
2767       vec_len (vum->show_dev_instance_by_real_dev_instance))
2768     vum->show_dev_instance_by_real_dev_instance[hwif->dev_instance] = ~0;
2769
2770   // Delete ethernet interface
2771   ethernet_delete_interface (vnm, vui->hw_if_index);
2772
2773   // Back to pool
2774   pool_put (vum->vhost_user_interfaces, vui);
2775
2776   return rv;
2777 }
2778
2779 static clib_error_t *
2780 vhost_user_exit (vlib_main_t * vm)
2781 {
2782   vnet_main_t *vnm = vnet_get_main ();
2783   vhost_user_main_t *vum = &vhost_user_main;
2784   vhost_user_intf_t *vui;
2785
2786   vlib_worker_thread_barrier_sync (vlib_get_main ());
2787   /* *INDENT-OFF* */
2788   pool_foreach (vui, vum->vhost_user_interfaces, {
2789       vhost_user_delete_if (vnm, vm, vui->sw_if_index);
2790   });
2791   /* *INDENT-ON* */
2792   vlib_worker_thread_barrier_release (vlib_get_main ());
2793   return 0;
2794 }
2795
2796 VLIB_MAIN_LOOP_EXIT_FUNCTION (vhost_user_exit);
2797
2798 /**
2799  * Open server unix socket on specified sock_filename.
2800  */
2801 static int
2802 vhost_user_init_server_sock (const char *sock_filename, int *sock_fd)
2803 {
2804   int rv = 0;
2805   struct sockaddr_un un = { };
2806   int fd;
2807   /* create listening socket */
2808   if ((fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
2809     return VNET_API_ERROR_SYSCALL_ERROR_1;
2810
2811   un.sun_family = AF_UNIX;
2812   strncpy ((char *) un.sun_path, (char *) sock_filename,
2813            sizeof (un.sun_path) - 1);
2814
2815   /* remove if exists */
2816   unlink ((char *) sock_filename);
2817
2818   if (bind (fd, (struct sockaddr *) &un, sizeof (un)) == -1)
2819     {
2820       rv = VNET_API_ERROR_SYSCALL_ERROR_2;
2821       goto error;
2822     }
2823
2824   if (listen (fd, 1) == -1)
2825     {
2826       rv = VNET_API_ERROR_SYSCALL_ERROR_3;
2827       goto error;
2828     }
2829
2830   *sock_fd = fd;
2831   return 0;
2832
2833 error:
2834   close (fd);
2835   return rv;
2836 }
2837
2838 /**
2839  * Create ethernet interface for vhost user interface.
2840  */
2841 static void
2842 vhost_user_create_ethernet (vnet_main_t * vnm, vlib_main_t * vm,
2843                             vhost_user_intf_t * vui, u8 * hwaddress)
2844 {
2845   vhost_user_main_t *vum = &vhost_user_main;
2846   u8 hwaddr[6];
2847   clib_error_t *error;
2848
2849   /* create hw and sw interface */
2850   if (hwaddress)
2851     {
2852       clib_memcpy (hwaddr, hwaddress, 6);
2853     }
2854   else
2855     {
2856       random_u32 (&vum->random);
2857       clib_memcpy (hwaddr + 2, &vum->random, sizeof (vum->random));
2858       hwaddr[0] = 2;
2859       hwaddr[1] = 0xfe;
2860     }
2861
2862   error = ethernet_register_interface
2863     (vnm,
2864      vhost_user_dev_class.index,
2865      vui - vum->vhost_user_interfaces /* device instance */ ,
2866      hwaddr /* ethernet address */ ,
2867      &vui->hw_if_index, 0 /* flag change */ );
2868
2869   if (error)
2870     clib_error_report (error);
2871
2872   vnet_sw_interface_t *si = vnet_get_hw_sw_interface (vnm, vui->hw_if_index);
2873   vnet_sw_interface_set_mtu (vnm, si->sw_if_index, 9000);
2874 }
2875
2876 /*
2877  *  Initialize vui with specified attributes
2878  */
2879 static void
2880 vhost_user_vui_init (vnet_main_t * vnm,
2881                      vhost_user_intf_t * vui,
2882                      int server_sock_fd,
2883                      const char *sock_filename,
2884                      u64 feature_mask, u32 * sw_if_index)
2885 {
2886   vnet_sw_interface_t *sw;
2887   int q;
2888   vhost_user_main_t *vum = &vhost_user_main;
2889   vnet_hw_interface_t *hw;
2890
2891   hw = vnet_get_hw_interface (vnm, vui->hw_if_index);
2892   sw = vnet_get_hw_sw_interface (vnm, vui->hw_if_index);
2893   if (server_sock_fd != -1)
2894     {
2895       clib_file_t template = { 0 };
2896       template.read_function = vhost_user_socksvr_accept_ready;
2897       template.file_descriptor = server_sock_fd;
2898       template.private_data = vui - vum->vhost_user_interfaces; //hw index
2899       vui->unix_server_index = clib_file_add (&file_main, &template);
2900     }
2901   else
2902     {
2903       vui->unix_server_index = ~0;
2904     }
2905
2906   vui->sw_if_index = sw->sw_if_index;
2907   strncpy (vui->sock_filename, sock_filename,
2908            ARRAY_LEN (vui->sock_filename) - 1);
2909   vui->sock_errno = 0;
2910   vui->is_up = 0;
2911   vui->feature_mask = feature_mask;
2912   vui->clib_file_index = ~0;
2913   vui->log_base_addr = 0;
2914   vui->if_index = vui - vum->vhost_user_interfaces;
2915   mhash_set_mem (&vum->if_index_by_sock_name, vui->sock_filename,
2916                  &vui->if_index, 0);
2917
2918   for (q = 0; q < VHOST_VRING_MAX_N; q++)
2919     vhost_user_vring_init (vui, q);
2920
2921   hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
2922   vnet_hw_interface_set_flags (vnm, vui->hw_if_index, 0);
2923
2924   if (sw_if_index)
2925     *sw_if_index = vui->sw_if_index;
2926
2927   for (q = 0; q < VHOST_VRING_MAX_N; q++)
2928     {
2929       vui->vring_locks[q] = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
2930                                                     CLIB_CACHE_LINE_BYTES);
2931       memset ((void *) vui->vring_locks[q], 0, CLIB_CACHE_LINE_BYTES);
2932     }
2933
2934   vec_validate (vui->per_cpu_tx_qid,
2935                 vlib_get_thread_main ()->n_vlib_mains - 1);
2936   vhost_user_tx_thread_placement (vui);
2937 }
2938
2939 int
2940 vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
2941                       const char *sock_filename,
2942                       u8 is_server,
2943                       u32 * sw_if_index,
2944                       u64 feature_mask,
2945                       u8 renumber, u32 custom_dev_instance, u8 * hwaddr)
2946 {
2947   vhost_user_intf_t *vui = NULL;
2948   u32 sw_if_idx = ~0;
2949   int rv = 0;
2950   int server_sock_fd = -1;
2951   vhost_user_main_t *vum = &vhost_user_main;
2952   uword *if_index;
2953
2954   if (sock_filename == NULL || !(strlen (sock_filename) > 0))
2955     {
2956       return VNET_API_ERROR_INVALID_ARGUMENT;
2957     }
2958
2959   if_index = mhash_get (&vum->if_index_by_sock_name, (void *) sock_filename);
2960   if (if_index)
2961     {
2962       if (sw_if_index)
2963         {
2964           vui = &vum->vhost_user_interfaces[*if_index];
2965           *sw_if_index = vui->sw_if_index;
2966         }
2967       return VNET_API_ERROR_IF_ALREADY_EXISTS;
2968     }
2969
2970   if (is_server)
2971     {
2972       if ((rv =
2973            vhost_user_init_server_sock (sock_filename, &server_sock_fd)) != 0)
2974         {
2975           return rv;
2976         }
2977     }
2978
2979   pool_get (vhost_user_main.vhost_user_interfaces, vui);
2980
2981   vhost_user_create_ethernet (vnm, vm, vui, hwaddr);
2982   vhost_user_vui_init (vnm, vui, server_sock_fd, sock_filename,
2983                        feature_mask, &sw_if_idx);
2984
2985   if (renumber)
2986     vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
2987
2988   if (sw_if_index)
2989     *sw_if_index = sw_if_idx;
2990
2991   // Process node must connect
2992   vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
2993
2994   return rv;
2995 }
2996
2997 int
2998 vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
2999                       const char *sock_filename,
3000                       u8 is_server,
3001                       u32 sw_if_index,
3002                       u64 feature_mask, u8 renumber, u32 custom_dev_instance)
3003 {
3004   vhost_user_main_t *vum = &vhost_user_main;
3005   vhost_user_intf_t *vui = NULL;
3006   u32 sw_if_idx = ~0;
3007   int server_sock_fd = -1;
3008   int rv = 0;
3009   vnet_hw_interface_t *hwif;
3010   uword *if_index;
3011
3012   if (!(hwif = vnet_get_sup_hw_interface (vnm, sw_if_index)) ||
3013       hwif->dev_class_index != vhost_user_dev_class.index)
3014     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
3015
3016   if (sock_filename == NULL || !(strlen (sock_filename) > 0))
3017     return VNET_API_ERROR_INVALID_ARGUMENT;
3018
3019   vui = vec_elt_at_index (vum->vhost_user_interfaces, hwif->dev_instance);
3020
3021   /*
3022    * Disallow changing the interface to have the same path name
3023    * as other interface
3024    */
3025   if_index = mhash_get (&vum->if_index_by_sock_name, (void *) sock_filename);
3026   if (if_index && (*if_index != vui->if_index))
3027     return VNET_API_ERROR_IF_ALREADY_EXISTS;
3028
3029   // First try to open server socket
3030   if (is_server)
3031     if ((rv = vhost_user_init_server_sock (sock_filename,
3032                                            &server_sock_fd)) != 0)
3033       return rv;
3034
3035   vhost_user_term_if (vui);
3036   vhost_user_vui_init (vnm, vui, server_sock_fd,
3037                        sock_filename, feature_mask, &sw_if_idx);
3038
3039   if (renumber)
3040     vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
3041
3042   // Process node must connect
3043   vlib_process_signal_event (vm, vhost_user_process_node.index, 0, 0);
3044
3045   return rv;
3046 }
3047
3048 clib_error_t *
3049 vhost_user_connect_command_fn (vlib_main_t * vm,
3050                                unformat_input_t * input,
3051                                vlib_cli_command_t * cmd)
3052 {
3053   unformat_input_t _line_input, *line_input = &_line_input;
3054   u8 *sock_filename = NULL;
3055   u32 sw_if_index;
3056   u8 is_server = 0;
3057   u64 feature_mask = (u64) ~ (0ULL);
3058   u8 renumber = 0;
3059   u32 custom_dev_instance = ~0;
3060   u8 hwaddr[6];
3061   u8 *hw = NULL;
3062   clib_error_t *error = NULL;
3063
3064   /* Get a line of input. */
3065   if (!unformat_user (input, unformat_line_input, line_input))
3066     return 0;
3067
3068   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3069     {
3070       if (unformat (line_input, "socket %s", &sock_filename))
3071         ;
3072       else if (unformat (line_input, "server"))
3073         is_server = 1;
3074       else if (unformat (line_input, "feature-mask 0x%llx", &feature_mask))
3075         ;
3076       else
3077         if (unformat
3078             (line_input, "hwaddr %U", unformat_ethernet_address, hwaddr))
3079         hw = hwaddr;
3080       else if (unformat (line_input, "renumber %d", &custom_dev_instance))
3081         {
3082           renumber = 1;
3083         }
3084       else
3085         {
3086           error = clib_error_return (0, "unknown input `%U'",
3087                                      format_unformat_error, line_input);
3088           goto done;
3089         }
3090     }
3091
3092   vnet_main_t *vnm = vnet_get_main ();
3093
3094   int rv;
3095   if ((rv = vhost_user_create_if (vnm, vm, (char *) sock_filename,
3096                                   is_server, &sw_if_index, feature_mask,
3097                                   renumber, custom_dev_instance, hw)))
3098     {
3099       error = clib_error_return (0, "vhost_user_create_if returned %d", rv);
3100       goto done;
3101     }
3102
3103   vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
3104                    sw_if_index);
3105
3106 done:
3107   vec_free (sock_filename);
3108   unformat_free (line_input);
3109
3110   return error;
3111 }
3112
3113 clib_error_t *
3114 vhost_user_delete_command_fn (vlib_main_t * vm,
3115                               unformat_input_t * input,
3116                               vlib_cli_command_t * cmd)
3117 {
3118   unformat_input_t _line_input, *line_input = &_line_input;
3119   u32 sw_if_index = ~0;
3120   vnet_main_t *vnm = vnet_get_main ();
3121   clib_error_t *error = NULL;
3122
3123   /* Get a line of input. */
3124   if (!unformat_user (input, unformat_line_input, line_input))
3125     return 0;
3126
3127   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3128     {
3129       if (unformat (line_input, "sw_if_index %d", &sw_if_index))
3130         ;
3131       else if (unformat
3132                (line_input, "%U", unformat_vnet_sw_interface, vnm,
3133                 &sw_if_index))
3134         {
3135           vnet_hw_interface_t *hwif =
3136             vnet_get_sup_hw_interface (vnm, sw_if_index);
3137           if (hwif == NULL ||
3138               vhost_user_dev_class.index != hwif->dev_class_index)
3139             {
3140               error = clib_error_return (0, "Not a vhost interface");
3141               goto done;
3142             }
3143         }
3144       else
3145         {
3146           error = clib_error_return (0, "unknown input `%U'",
3147                                      format_unformat_error, line_input);
3148           goto done;
3149         }
3150     }
3151
3152   vhost_user_delete_if (vnm, vm, sw_if_index);
3153
3154 done:
3155   unformat_free (line_input);
3156
3157   return error;
3158 }
3159
3160 int
3161 vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
3162                      vhost_user_intf_details_t ** out_vuids)
3163 {
3164   int rv = 0;
3165   vhost_user_main_t *vum = &vhost_user_main;
3166   vhost_user_intf_t *vui;
3167   vhost_user_intf_details_t *r_vuids = NULL;
3168   vhost_user_intf_details_t *vuid = NULL;
3169   u32 *hw_if_indices = 0;
3170   vnet_hw_interface_t *hi;
3171   u8 *s = NULL;
3172   int i;
3173
3174   if (!out_vuids)
3175     return -1;
3176
3177   pool_foreach (vui, vum->vhost_user_interfaces,
3178                 vec_add1 (hw_if_indices, vui->hw_if_index);
3179     );
3180
3181   for (i = 0; i < vec_len (hw_if_indices); i++)
3182     {
3183       hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
3184       vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
3185
3186       vec_add2 (r_vuids, vuid, 1);
3187       vuid->sw_if_index = vui->sw_if_index;
3188       vuid->virtio_net_hdr_sz = vui->virtio_net_hdr_sz;
3189       vuid->features = vui->features;
3190       vuid->num_regions = vui->nregions;
3191       vuid->is_server = vui->unix_server_index != ~0;
3192       vuid->sock_errno = vui->sock_errno;
3193       strncpy ((char *) vuid->sock_filename, (char *) vui->sock_filename,
3194                ARRAY_LEN (vuid->sock_filename) - 1);
3195
3196       s = format (s, "%v%c", hi->name, 0);
3197
3198       strncpy ((char *) vuid->if_name, (char *) s,
3199                ARRAY_LEN (vuid->if_name) - 1);
3200       _vec_len (s) = 0;
3201     }
3202
3203   vec_free (s);
3204   vec_free (hw_if_indices);
3205
3206   *out_vuids = r_vuids;
3207
3208   return rv;
3209 }
3210
3211 clib_error_t *
3212 show_vhost_user_command_fn (vlib_main_t * vm,
3213                             unformat_input_t * input,
3214                             vlib_cli_command_t * cmd)
3215 {
3216   clib_error_t *error = 0;
3217   vnet_main_t *vnm = vnet_get_main ();
3218   vhost_user_main_t *vum = &vhost_user_main;
3219   vhost_user_intf_t *vui;
3220   u32 hw_if_index, *hw_if_indices = 0;
3221   vnet_hw_interface_t *hi;
3222   u16 *queue;
3223   u32 ci;
3224   int i, j, q;
3225   int show_descr = 0;
3226   struct feat_struct
3227   {
3228     u8 bit;
3229     char *str;
3230   };
3231   struct feat_struct *feat_entry;
3232
3233   static struct feat_struct feat_array[] = {
3234 #define _(s,b) { .str = #s, .bit = b, },
3235     foreach_virtio_net_feature
3236 #undef _
3237     {.str = NULL}
3238   };
3239
3240 #define foreach_protocol_feature \
3241   _(VHOST_USER_PROTOCOL_F_MQ) \
3242   _(VHOST_USER_PROTOCOL_F_LOG_SHMFD)
3243
3244   static struct feat_struct proto_feat_array[] = {
3245 #define _(s) { .str = #s, .bit = s},
3246     foreach_protocol_feature
3247 #undef _
3248     {.str = NULL}
3249   };
3250
3251   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3252     {
3253       if (unformat
3254           (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
3255         {
3256           vec_add1 (hw_if_indices, hw_if_index);
3257         }
3258       else if (unformat (input, "descriptors") || unformat (input, "desc"))
3259         show_descr = 1;
3260       else
3261         {
3262           error = clib_error_return (0, "unknown input `%U'",
3263                                      format_unformat_error, input);
3264           goto done;
3265         }
3266     }
3267   if (vec_len (hw_if_indices) == 0)
3268     {
3269       pool_foreach (vui, vum->vhost_user_interfaces,
3270                     vec_add1 (hw_if_indices, vui->hw_if_index);
3271         );
3272     }
3273   vlib_cli_output (vm, "Virtio vhost-user interfaces");
3274   vlib_cli_output (vm, "Global:\n  coalesce frames %d time %e",
3275                    vum->coalesce_frames, vum->coalesce_time);
3276   vlib_cli_output (vm, "  number of rx virtqueues in interrupt mode: %d",
3277                    vum->ifq_count);
3278
3279   for (i = 0; i < vec_len (hw_if_indices); i++)
3280     {
3281       hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
3282       vui = pool_elt_at_index (vum->vhost_user_interfaces, hi->dev_instance);
3283       vlib_cli_output (vm, "Interface: %s (ifindex %d)",
3284                        hi->name, hw_if_indices[i]);
3285
3286       vlib_cli_output (vm, "virtio_net_hdr_sz %d\n"
3287                        " features mask (0x%llx): \n"
3288                        " features (0x%llx): \n",
3289                        vui->virtio_net_hdr_sz, vui->feature_mask,
3290                        vui->features);
3291
3292       feat_entry = (struct feat_struct *) &feat_array;
3293       while (feat_entry->str)
3294         {
3295           if (vui->features & (1ULL << feat_entry->bit))
3296             vlib_cli_output (vm, "   %s (%d)", feat_entry->str,
3297                              feat_entry->bit);
3298           feat_entry++;
3299         }
3300
3301       vlib_cli_output (vm, "  protocol features (0x%llx)",
3302                        vui->protocol_features);
3303       feat_entry = (struct feat_struct *) &proto_feat_array;
3304       while (feat_entry->str)
3305         {
3306           if (vui->protocol_features & (1ULL << feat_entry->bit))
3307             vlib_cli_output (vm, "   %s (%d)", feat_entry->str,
3308                              feat_entry->bit);
3309           feat_entry++;
3310         }
3311
3312       vlib_cli_output (vm, "\n");
3313
3314       vlib_cli_output (vm, " socket filename %s type %s errno \"%s\"\n\n",
3315                        vui->sock_filename,
3316                        (vui->unix_server_index != ~0) ? "server" : "client",
3317                        strerror (vui->sock_errno));
3318
3319       vlib_cli_output (vm, " rx placement: ");
3320
3321       vec_foreach (queue, vui->rx_queues)
3322       {
3323         vnet_main_t *vnm = vnet_get_main ();
3324         uword thread_index;
3325         vnet_hw_interface_rx_mode mode;
3326
3327         thread_index = vnet_get_device_input_thread_index (vnm,
3328                                                            vui->hw_if_index,
3329                                                            *queue);
3330         vnet_hw_interface_get_rx_mode (vnm, vui->hw_if_index, *queue, &mode);
3331         vlib_cli_output (vm, "   thread %d on vring %d, %U\n",
3332                          thread_index, VHOST_VRING_IDX_TX (*queue),
3333                          format_vnet_hw_interface_rx_mode, mode);
3334       }
3335
3336       vlib_cli_output (vm, " tx placement: %s\n",
3337                        vui->use_tx_spinlock ? "spin-lock" : "lock-free");
3338
3339       vec_foreach_index (ci, vui->per_cpu_tx_qid)
3340       {
3341         vlib_cli_output (vm, "   thread %d on vring %d\n", ci,
3342                          VHOST_VRING_IDX_RX (vui->per_cpu_tx_qid[ci]));
3343       }
3344
3345       vlib_cli_output (vm, "\n");
3346
3347       vlib_cli_output (vm, " Memory regions (total %d)\n", vui->nregions);
3348
3349       if (vui->nregions)
3350         {
3351           vlib_cli_output (vm,
3352                            " region fd    guest_phys_addr    memory_size        userspace_addr     mmap_offset        mmap_addr\n");
3353           vlib_cli_output (vm,
3354                            " ====== ===== ================== ================== ================== ================== ==================\n");
3355         }
3356       for (j = 0; j < vui->nregions; j++)
3357         {
3358           vlib_cli_output (vm,
3359                            "  %d     %-5d 0x%016lx 0x%016lx 0x%016lx 0x%016lx 0x%016lx\n",
3360                            j, vui->region_mmap_fd[j],
3361                            vui->regions[j].guest_phys_addr,
3362                            vui->regions[j].memory_size,
3363                            vui->regions[j].userspace_addr,
3364                            vui->regions[j].mmap_offset,
3365                            pointer_to_uword (vui->region_mmap_addr[j]));
3366         }
3367       for (q = 0; q < VHOST_VRING_MAX_N; q++)
3368         {
3369           if (!vui->vrings[q].started)
3370             continue;
3371
3372           vlib_cli_output (vm, "\n Virtqueue %d (%s%s)\n", q,
3373                            (q & 1) ? "RX" : "TX",
3374                            vui->vrings[q].enabled ? "" : " disabled");
3375
3376           vlib_cli_output (vm,
3377                            "  qsz %d last_avail_idx %d last_used_idx %d\n",
3378                            vui->vrings[q].qsz_mask + 1,
3379                            vui->vrings[q].last_avail_idx,
3380                            vui->vrings[q].last_used_idx);
3381
3382           if (vui->vrings[q].avail && vui->vrings[q].used)
3383             vlib_cli_output (vm,
3384                              "  avail.flags %x avail.idx %d used.flags %x used.idx %d\n",
3385                              vui->vrings[q].avail->flags,
3386                              vui->vrings[q].avail->idx,
3387                              vui->vrings[q].used->flags,
3388                              vui->vrings[q].used->idx);
3389
3390           int kickfd = UNIX_GET_FD (vui->vrings[q].kickfd_idx);
3391           int callfd = UNIX_GET_FD (vui->vrings[q].callfd_idx);
3392           vlib_cli_output (vm, "  kickfd %d callfd %d errfd %d\n",
3393                            kickfd, callfd, vui->vrings[q].errfd);
3394
3395           if (show_descr)
3396             {
3397               vlib_cli_output (vm, "\n  descriptor table:\n");
3398               vlib_cli_output (vm,
3399                                "   id          addr         len  flags  next      user_addr\n");
3400               vlib_cli_output (vm,
3401                                "  ===== ================== ===== ====== ===== ==================\n");
3402               for (j = 0; j < vui->vrings[q].qsz_mask + 1; j++)
3403                 {
3404                   u32 mem_hint = 0;
3405                   vlib_cli_output (vm,
3406                                    "  %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
3407                                    j, vui->vrings[q].desc[j].addr,
3408                                    vui->vrings[q].desc[j].len,
3409                                    vui->vrings[q].desc[j].flags,
3410                                    vui->vrings[q].desc[j].next,
3411                                    pointer_to_uword (map_guest_mem
3412                                                      (vui,
3413                                                       vui->vrings[q].desc[j].
3414                                                       addr, &mem_hint)));
3415                 }
3416             }
3417         }
3418       vlib_cli_output (vm, "\n");
3419     }
3420 done:
3421   vec_free (hw_if_indices);
3422   return error;
3423 }
3424
3425 /*
3426  * CLI functions
3427  */
3428
3429 /*?
3430  * Create a vHost User interface. Once created, a new virtual interface
3431  * will exist with the name '<em>VirtualEthernet0/0/x</em>', where '<em>x</em>'
3432  * is the next free index.
3433  *
3434  * There are several parameters associated with a vHost interface:
3435  *
3436  * - <b>socket <socket-filename></b> - Name of the linux socket used by hypervisor
3437  * and VPP to manage the vHost interface. If in '<em>server</em>' mode, VPP will
3438  * create the socket if it does not already exist. If in '<em>client</em>' mode,
3439  * hypervisor will create the socket if it does not already exist. The VPP code
3440  * is indifferent to the file location. However, if SELinux is enabled, then the
3441  * socket needs to be created in '<em>/var/run/vpp/</em>'.
3442  *
3443  * - <b>server</b> - Optional flag to indicate that VPP should be the server for
3444  * the linux socket. If not provided, VPP will be the client. In '<em>server</em>'
3445  *  mode, the VM can be reset without tearing down the vHost Interface. In
3446  * '<em>client</em>' mode, VPP can be reset without bringing down the VM and
3447  * tearing down the vHost Interface.
3448  *
3449  * - <b>feature-mask <hex></b> - Optional virtio/vhost feature set negotiated at
3450  * startup. <b>This is intended for degugging only.</b> It is recommended that this
3451  * parameter not be used except by experienced users. By default, all supported
3452  * features will be advertised. Otherwise, provide the set of features desired.
3453  *   - 0x000008000 (15) - VIRTIO_NET_F_MRG_RXBUF
3454  *   - 0x000020000 (17) - VIRTIO_NET_F_CTRL_VQ
3455  *   - 0x000200000 (21) - VIRTIO_NET_F_GUEST_ANNOUNCE
3456  *   - 0x000400000 (22) - VIRTIO_NET_F_MQ
3457  *   - 0x004000000 (26) - VHOST_F_LOG_ALL
3458  *   - 0x008000000 (27) - VIRTIO_F_ANY_LAYOUT
3459  *   - 0x010000000 (28) - VIRTIO_F_INDIRECT_DESC
3460  *   - 0x040000000 (30) - VHOST_USER_F_PROTOCOL_FEATURES
3461  *   - 0x100000000 (32) - VIRTIO_F_VERSION_1
3462  *
3463  * - <b>hwaddr <mac-addr></b> - Optional ethernet address, can be in either
3464  * X:X:X:X:X:X unix or X.X.X cisco format.
3465  *
3466  * - <b>renumber <dev_instance></b> - Optional parameter which allows the instance
3467  * in the name to be specified. If instance already exists, name will be used
3468  * anyway and multiple instances will have the same name. Use with caution.
3469  *
3470  * @cliexpar
3471  * Example of how to create a vhost interface with VPP as the client and all features enabled:
3472  * @cliexstart{create vhost-user socket /var/run/vpp/vhost1.sock}
3473  * VirtualEthernet0/0/0
3474  * @cliexend
3475  * Example of how to create a vhost interface with VPP as the server and with just
3476  * multiple queues enabled:
3477  * @cliexstart{create vhost-user socket /var/run/vpp/vhost2.sock server feature-mask 0x40400000}
3478  * VirtualEthernet0/0/1
3479  * @cliexend
3480  * Once the vHost interface is created, enable the interface using:
3481  * @cliexcmd{set interface state VirtualEthernet0/0/0 up}
3482 ?*/
3483 /* *INDENT-OFF* */
3484 VLIB_CLI_COMMAND (vhost_user_connect_command, static) = {
3485     .path = "create vhost-user",
3486     .short_help = "create vhost-user socket <socket-filename> [server] "
3487     "[feature-mask <hex>] [hwaddr <mac-addr>] [renumber <dev_instance>] ",
3488     .function = vhost_user_connect_command_fn,
3489 };
3490 /* *INDENT-ON* */
3491
3492 /*?
3493  * Delete a vHost User interface using the interface name or the
3494  * software interface index. Use the '<em>show interface</em>'
3495  * command to determine the software interface index. On deletion,
3496  * the linux socket will not be deleted.
3497  *
3498  * @cliexpar
3499  * Example of how to delete a vhost interface by name:
3500  * @cliexcmd{delete vhost-user VirtualEthernet0/0/1}
3501  * Example of how to delete a vhost interface by software interface index:
3502  * @cliexcmd{delete vhost-user sw_if_index 1}
3503 ?*/
3504 /* *INDENT-OFF* */
3505 VLIB_CLI_COMMAND (vhost_user_delete_command, static) = {
3506     .path = "delete vhost-user",
3507     .short_help = "delete vhost-user {<interface> | sw_if_index <sw_idx>}",
3508     .function = vhost_user_delete_command_fn,
3509 };
3510
3511 /*?
3512  * Display the attributes of a single vHost User interface (provide interface
3513  * name), multiple vHost User interfaces (provide a list of interface names seperated
3514  * by spaces) or all Vhost User interfaces (omit an interface name to display all
3515  * vHost interfaces).
3516  *
3517  * @cliexpar
3518  * @parblock
3519  * Example of how to display a vhost interface:
3520  * @cliexstart{show vhost-user VirtualEthernet0/0/0}
3521  * Virtio vhost-user interfaces
3522  * Global:
3523  *   coalesce frames 32 time 1e-3
3524  * Interface: VirtualEthernet0/0/0 (ifindex 1)
3525  * virtio_net_hdr_sz 12
3526  *  features mask (0xffffffffffffffff):
3527  *  features (0x50408000):
3528  *    VIRTIO_NET_F_MRG_RXBUF (15)
3529  *    VIRTIO_NET_F_MQ (22)
3530  *    VIRTIO_F_INDIRECT_DESC (28)
3531  *    VHOST_USER_F_PROTOCOL_FEATURES (30)
3532  *   protocol features (0x3)
3533  *    VHOST_USER_PROTOCOL_F_MQ (0)
3534  *    VHOST_USER_PROTOCOL_F_LOG_SHMFD (1)
3535  *
3536  *  socket filename /var/run/vpp/vhost1.sock type client errno "Success"
3537  *
3538  * rx placement:
3539  *    thread 1 on vring 1
3540  *    thread 1 on vring 5
3541  *    thread 2 on vring 3
3542  *    thread 2 on vring 7
3543  *  tx placement: spin-lock
3544  *    thread 0 on vring 0
3545  *    thread 1 on vring 2
3546  *    thread 2 on vring 0
3547  *
3548  * Memory regions (total 2)
3549  * region fd    guest_phys_addr    memory_size        userspace_addr     mmap_offset        mmap_addr
3550  * ====== ===== ================== ================== ================== ================== ==================
3551  *   0     60    0x0000000000000000 0x00000000000a0000 0x00002aaaaac00000 0x0000000000000000 0x00002aab2b400000
3552  *   1     61    0x00000000000c0000 0x000000003ff40000 0x00002aaaaacc0000 0x00000000000c0000 0x00002aababcc0000
3553  *
3554  *  Virtqueue 0 (TX)
3555  *   qsz 256 last_avail_idx 0 last_used_idx 0
3556  *   avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3557  *   kickfd 62 callfd 64 errfd -1
3558  *
3559  *  Virtqueue 1 (RX)
3560  *   qsz 256 last_avail_idx 0 last_used_idx 0
3561  *   avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3562  *   kickfd 65 callfd 66 errfd -1
3563  *
3564  *  Virtqueue 2 (TX)
3565  *   qsz 256 last_avail_idx 0 last_used_idx 0
3566  *   avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3567  *   kickfd 63 callfd 70 errfd -1
3568  *
3569  *  Virtqueue 3 (RX)
3570  *   qsz 256 last_avail_idx 0 last_used_idx 0
3571  *   avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3572  *   kickfd 72 callfd 74 errfd -1
3573  *
3574  *  Virtqueue 4 (TX disabled)
3575  *   qsz 256 last_avail_idx 0 last_used_idx 0
3576  *   avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3577  *   kickfd 76 callfd 78 errfd -1
3578  *
3579  *  Virtqueue 5 (RX disabled)
3580  *   qsz 256 last_avail_idx 0 last_used_idx 0
3581  *   avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3582  *   kickfd 80 callfd 82 errfd -1
3583  *
3584  *  Virtqueue 6 (TX disabled)
3585  *   qsz 256 last_avail_idx 0 last_used_idx 0
3586  *  avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3587  *   kickfd 84 callfd 86 errfd -1
3588  *
3589  *  Virtqueue 7 (RX disabled)
3590  *   qsz 256 last_avail_idx 0 last_used_idx 0
3591  *   avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
3592  *   kickfd 88 callfd 90 errfd -1
3593  *
3594  * @cliexend
3595  *
3596  * The optional '<em>descriptors</em>' parameter will display the same output as
3597  * the previous example but will include the descriptor table for each queue.
3598  * The output is truncated below:
3599  * @cliexstart{show vhost-user VirtualEthernet0/0/0 descriptors}
3600  * Virtio vhost-user interfaces
3601  * Global:
3602  *   coalesce frames 32 time 1e-3
3603  * Interface: VirtualEthernet0/0/0 (ifindex 1)
3604  * virtio_net_hdr_sz 12
3605  *  features mask (0xffffffffffffffff):
3606  *  features (0x50408000):
3607  *    VIRTIO_NET_F_MRG_RXBUF (15)
3608  *    VIRTIO_NET_F_MQ (22)
3609  * :
3610  *  Virtqueue 0 (TX)
3611  *   qsz 256 last_avail_idx 0 last_used_idx 0
3612  *   avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
3613  *   kickfd 62 callfd 64 errfd -1
3614  *
3615  *   descriptor table:
3616  *    id          addr         len  flags  next      user_addr
3617  *   ===== ================== ===== ====== ===== ==================
3618  *   0     0x0000000010b6e974 2060  0x0002 1     0x00002aabbc76e974
3619  *   1     0x0000000010b6e034 2060  0x0002 2     0x00002aabbc76e034
3620  *   2     0x0000000010b6d6f4 2060  0x0002 3     0x00002aabbc76d6f4
3621  *   3     0x0000000010b6cdb4 2060  0x0002 4     0x00002aabbc76cdb4
3622  *   4     0x0000000010b6c474 2060  0x0002 5     0x00002aabbc76c474
3623  *   5     0x0000000010b6bb34 2060  0x0002 6     0x00002aabbc76bb34
3624  *   6     0x0000000010b6b1f4 2060  0x0002 7     0x00002aabbc76b1f4
3625  *   7     0x0000000010b6a8b4 2060  0x0002 8     0x00002aabbc76a8b4
3626  *   8     0x0000000010b69f74 2060  0x0002 9     0x00002aabbc769f74
3627  *   9     0x0000000010b69634 2060  0x0002 10    0x00002aabbc769634
3628  *   10    0x0000000010b68cf4 2060  0x0002 11    0x00002aabbc768cf4
3629  * :
3630  *   249   0x0000000000000000 0     0x0000 250   0x00002aab2b400000
3631  *   250   0x0000000000000000 0     0x0000 251   0x00002aab2b400000
3632  *   251   0x0000000000000000 0     0x0000 252   0x00002aab2b400000
3633  *   252   0x0000000000000000 0     0x0000 253   0x00002aab2b400000
3634  *   253   0x0000000000000000 0     0x0000 254   0x00002aab2b400000
3635  *   254   0x0000000000000000 0     0x0000 255   0x00002aab2b400000
3636  *   255   0x0000000000000000 0     0x0000 32768 0x00002aab2b400000
3637  *
3638  *  Virtqueue 1 (RX)
3639  *   qsz 256 last_avail_idx 0 last_used_idx 0
3640  * :
3641  * @cliexend
3642  * @endparblock
3643 ?*/
3644 /* *INDENT-OFF* */
3645 VLIB_CLI_COMMAND (show_vhost_user_command, static) = {
3646     .path = "show vhost-user",
3647     .short_help = "show vhost-user [<interface> [<interface> [..]]] [descriptors]",
3648     .function = show_vhost_user_command_fn,
3649 };
3650 /* *INDENT-ON* */
3651
3652 clib_error_t *
3653 debug_vhost_user_command_fn (vlib_main_t * vm,
3654                              unformat_input_t * input,
3655                              vlib_cli_command_t * cmd)
3656 {
3657   unformat_input_t _line_input, *line_input = &_line_input;
3658   clib_error_t *error = NULL;
3659   vhost_user_main_t *vum = &vhost_user_main;
3660   u8 onoff = 0;
3661   u8 input_found = 0;
3662
3663   /* Get a line of input. */
3664   if (!unformat_user (input, unformat_line_input, line_input))
3665     return clib_error_return (0, "missing argument");
3666
3667   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3668     {
3669       if (input_found)
3670         {
3671           error = clib_error_return (0, "unknown input `%U'",
3672                                      format_unformat_error, line_input);
3673           goto done;
3674         }
3675
3676       if (unformat (line_input, "on"))
3677         {
3678           input_found = 1;
3679           onoff = 1;
3680         }
3681       else if (unformat (line_input, "off"))
3682         {
3683           input_found = 1;
3684           onoff = 0;
3685         }
3686       else
3687         {
3688           error = clib_error_return (0, "unknown input `%U'",
3689                                      format_unformat_error, line_input);
3690           goto done;
3691         }
3692     }
3693
3694   vum->debug = onoff;
3695
3696 done:
3697   unformat_free (line_input);
3698
3699   return error;
3700 }
3701
3702 /* *INDENT-OFF* */
3703 VLIB_CLI_COMMAND (debug_vhost_user_command, static) = {
3704     .path = "debug vhost-user",
3705     .short_help = "debug vhost-user <on | off>",
3706     .function = debug_vhost_user_command_fn,
3707 };
3708 /* *INDENT-ON* */
3709
3710 static clib_error_t *
3711 vhost_user_config (vlib_main_t * vm, unformat_input_t * input)
3712 {
3713   vhost_user_main_t *vum = &vhost_user_main;
3714
3715   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3716     {
3717       if (unformat (input, "coalesce-frames %d", &vum->coalesce_frames))
3718         ;
3719       else if (unformat (input, "coalesce-time %f", &vum->coalesce_time))
3720         ;
3721       else if (unformat (input, "dont-dump-memory"))
3722         vum->dont_dump_vhost_user_memory = 1;
3723       else
3724         return clib_error_return (0, "unknown input `%U'",
3725                                   format_unformat_error, input);
3726     }
3727
3728   return 0;
3729 }
3730
3731 /* vhost-user { ... } configuration. */
3732 VLIB_CONFIG_FUNCTION (vhost_user_config, "vhost-user");
3733
3734 void
3735 vhost_user_unmap_all (void)
3736 {
3737   vhost_user_main_t *vum = &vhost_user_main;
3738   vhost_user_intf_t *vui;
3739
3740   if (vum->dont_dump_vhost_user_memory)
3741     {
3742       pool_foreach (vui, vum->vhost_user_interfaces,
3743                     unmap_all_mem_regions (vui);
3744         );
3745     }
3746 }
3747
3748 /*
3749  * fd.io coding-style-patch-verification: ON
3750  *
3751  * Local Variables:
3752  * eval: (c-set-style "gnu")
3753  * End:
3754  */