src/vnet/devices/virtio/vhost_user_output.c

   1 /*
   2  *------------------------------------------------------------------
   3  * vhost-user-output
   4  *
   5  * Copyright (c) 2014-2018 Cisco and/or its affiliates.
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *------------------------------------------------------------------
  18  */
  19
  20 #include <stddef.h>
  21 #include <fcntl.h>              /* for open */
  22 #include <sys/ioctl.h>
  23 #include <sys/socket.h>
  24 #include <sys/un.h>
  25 #include <sys/stat.h>
  26 #include <sys/types.h>
  27 #include <sys/uio.h>            /* for iovec */
  28 #include <netinet/in.h>
  29 #include <sys/vfs.h>
  30
  31 #include <linux/if_arp.h>
  32 #include <linux/if_tun.h>
  33
  34 #include <vlib/vlib.h>
  35 #include <vlib/unix/unix.h>
  36
  37 #include <vnet/ip/ip.h>
  38
  39 #include <vnet/ethernet/ethernet.h>
  40 #include <vnet/devices/devices.h>
  41 #include <vnet/feature/feature.h>
  42
  43 #include <vnet/devices/virtio/virtio.h>
  44 #include <vnet/devices/virtio/vhost_user.h>
  45 #include <vnet/devices/virtio/vhost_user_inline.h>
  46
  47 #include <vnet/gso/gso.h>
  48 /*
  49  * On the transmit side, we keep processing the buffers from vlib in the while
  50  * loop and prepare the copy order to be executed later. However, the static
  51  * array which we keep the copy order is limited to VHOST_USER_COPY_ARRAY_N
  52  * entries. In order to not corrupt memory, we have to do the copy when the
  53  * static array reaches the copy threshold. We subtract 40 in case the code
  54  * goes into the inner loop for a maximum of 64k frames which may require
  55  * more array entries. We subtract 200 because our default buffer size is
  56  * 2048 and the default desc len is likely 1536. While it takes less than 40
  57  * vlib buffers for the jumbo frame, it may take twice as much descriptors
  58  * for the same jumbo frame. Use 200 for the extra head room.
  59  */
  60 #define VHOST_USER_TX_COPY_THRESHOLD (VHOST_USER_COPY_ARRAY_N - 200)
  61
  62 extern vnet_device_class_t vhost_user_device_class;
  63
  64 #define foreach_vhost_user_tx_func_error      \
  65   _(NONE, "no error")  \
  66   _(NOT_READY, "vhost vring not ready")  \
  67   _(DOWN, "vhost interface is down")  \
  68   _(PKT_DROP_NOBUF, "tx packet drops (no available descriptors)")  \
  69   _(PKT_DROP_NOMRG, "tx packet drops (cannot merge descriptors)")  \
  70   _(MMAP_FAIL, "mmap failure") \
  71   _(INDIRECT_OVERFLOW, "indirect descriptor table overflow")
  72
  73 typedef enum
  74 {
  75 #define _(f,s) VHOST_USER_TX_FUNC_ERROR_##f,
  76   foreach_vhost_user_tx_func_error
  77 #undef _
  78     VHOST_USER_TX_FUNC_N_ERROR,
  79 } vhost_user_tx_func_error_t;
  80
  81 static __clib_unused char *vhost_user_tx_func_error_strings[] = {
  82 #define _(n,s) s,
  83   foreach_vhost_user_tx_func_error
  84 #undef _
  85 };
  86
  87 static __clib_unused u8 *
  88 format_vhost_user_interface_name (u8 * s, va_list * args)
  89 {
  90   u32 i = va_arg (*args, u32);
  91   u32 show_dev_instance = ~0;
  92   vhost_user_main_t *vum = &vhost_user_main;
  93
  94   if (i < vec_len (vum->show_dev_instance_by_real_dev_instance))
  95     show_dev_instance = vum->show_dev_instance_by_real_dev_instance[i];
  96
  97   if (show_dev_instance != ~0)
  98     i = show_dev_instance;
  99
 100   s = format (s, "VirtualEthernet0/0/%d", i);
 101   return s;
 102 }
 103
 104 static __clib_unused int
 105 vhost_user_name_renumber (vnet_hw_interface_t * hi, u32 new_dev_instance)
 106 {
 107   // FIXME: check if the new dev instance is already used
 108   vhost_user_main_t *vum = &vhost_user_main;
 109   vhost_user_intf_t *vui = pool_elt_at_index (vum->vhost_user_interfaces,
 110                                               hi->dev_instance);
 111
 112   vec_validate_init_empty (vum->show_dev_instance_by_real_dev_instance,
 113                            hi->dev_instance, ~0);
 114
 115   vum->show_dev_instance_by_real_dev_instance[hi->dev_instance] =
 116     new_dev_instance;
 117
 118   vu_log_debug (vui, "renumbered vhost-user interface dev_instance %d to %d",
 119                 hi->dev_instance, new_dev_instance);
 120
 121   return 0;
 122 }
 123
 124 /**
 125  * @brief Try once to lock the vring
 126  * @return 0 on success, non-zero on failure.
 127  */
 128 static_always_inline int
 129 vhost_user_vring_try_lock (vhost_user_intf_t * vui, u32 qid)
 130 {
 131   return clib_atomic_test_and_set (vui->vring_locks[qid]);
 132 }
 133
 134 /**
 135  * @brief Spin until the vring is successfully locked
 136  */
 137 static_always_inline void
 138 vhost_user_vring_lock (vhost_user_intf_t * vui, u32 qid)
 139 {
 140   while (vhost_user_vring_try_lock (vui, qid))
 141     ;
 142 }
 143
 144 /**
 145  * @brief Unlock the vring lock
 146  */
 147 static_always_inline void
 148 vhost_user_vring_unlock (vhost_user_intf_t * vui, u32 qid)
 149 {
 150   clib_atomic_release (vui->vring_locks[qid]);
 151 }
 152
 153 static_always_inline void
 154 vhost_user_tx_trace (vhost_trace_t * t,
 155                      vhost_user_intf_t * vui, u16 qid,
 156                      vlib_buffer_t * b, vhost_user_vring_t * rxvq)
 157 {
 158   vhost_user_main_t *vum = &vhost_user_main;
 159   u32 last_avail_idx = rxvq->last_avail_idx;
 160   u32 desc_current = rxvq->avail->ring[last_avail_idx & rxvq->qsz_mask];
 161   vring_desc_t *hdr_desc = 0;
 162   u32 hint = 0;
 163
 164   clib_memset (t, 0, sizeof (*t));
 165   t->device_index = vui - vum->vhost_user_interfaces;
 166   t->qid = qid;
 167
 168   hdr_desc = &rxvq->desc[desc_current];
 169   if (rxvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT)
 170     {
 171       t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_INDIRECT;
 172       /* Header is the first here */
 173       hdr_desc = map_guest_mem (vui, rxvq->desc[desc_current].addr, &hint);
 174     }
 175   if (rxvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT)
 176     {
 177       t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SIMPLE_CHAINED;
 178     }
 179   if (!(rxvq->desc[desc_current].flags & VIRTQ_DESC_F_NEXT) &&
 180       !(rxvq->desc[desc_current].flags & VIRTQ_DESC_F_INDIRECT))
 181     {
 182       t->virtio_ring_flags |= 1 << VIRTIO_TRACE_F_SINGLE_DESC;
 183     }
 184
 185   t->first_desc_len = hdr_desc ? hdr_desc->len : 0;
 186 }
 187
 188 static_always_inline u32
 189 vhost_user_tx_copy (vhost_user_intf_t * vui, vhost_copy_t * cpy,
 190                     u16 copy_len, u32 * map_hint)
 191 {
 192   void *dst0, *dst1, *dst2, *dst3;
 193   if (PREDICT_TRUE (copy_len >= 4))
 194     {
 195       if (PREDICT_FALSE (!(dst2 = map_guest_mem (vui, cpy[0].dst, map_hint))))
 196         return 1;
 197       if (PREDICT_FALSE (!(dst3 = map_guest_mem (vui, cpy[1].dst, map_hint))))
 198         return 1;
 199       while (PREDICT_TRUE (copy_len >= 4))
 200         {
 201           dst0 = dst2;
 202           dst1 = dst3;
 203
 204           if (PREDICT_FALSE
 205               (!(dst2 = map_guest_mem (vui, cpy[2].dst, map_hint))))
 206             return 1;
 207           if (PREDICT_FALSE
 208               (!(dst3 = map_guest_mem (vui, cpy[3].dst, map_hint))))
 209             return 1;
 210
 211           CLIB_PREFETCH ((void *) cpy[2].src, 64, LOAD);
 212           CLIB_PREFETCH ((void *) cpy[3].src, 64, LOAD);
 213
 214           clib_memcpy_fast (dst0, (void *) cpy[0].src, cpy[0].len);
 215           clib_memcpy_fast (dst1, (void *) cpy[1].src, cpy[1].len);
 216
 217           vhost_user_log_dirty_pages_2 (vui, cpy[0].dst, cpy[0].len, 1);
 218           vhost_user_log_dirty_pages_2 (vui, cpy[1].dst, cpy[1].len, 1);
 219           copy_len -= 2;
 220           cpy += 2;
 221         }
 222     }
 223   while (copy_len)
 224     {
 225       if (PREDICT_FALSE (!(dst0 = map_guest_mem (vui, cpy->dst, map_hint))))
 226         return 1;
 227       clib_memcpy_fast (dst0, (void *) cpy->src, cpy->len);
 228       vhost_user_log_dirty_pages_2 (vui, cpy->dst, cpy->len, 1);
 229       copy_len -= 1;
 230       cpy += 1;
 231     }
 232   return 0;
 233 }
 234
 235 static_always_inline void
 236 vhost_user_handle_tx_offload (vhost_user_intf_t * vui, vlib_buffer_t * b,
 237                               virtio_net_hdr_t * hdr)
 238 {
 239   gso_header_offset_t gho =
 240     vnet_gso_header_offset_parser (b, b->flags & VNET_BUFFER_F_IS_IP6);
 241   if (b->flags & VNET_BUFFER_F_OFFLOAD_IP_CKSUM)
 242     {
 243       ip4_header_t *ip4;
 244
 245       ip4 =
 246         (ip4_header_t *) (vlib_buffer_get_current (b) + gho.l3_hdr_offset);
 247       ip4->checksum = ip4_header_checksum (ip4);
 248     }
 249
 250   /* checksum offload */
 251   if (b->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM)
 252     {
 253       hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
 254       hdr->csum_start = gho.l4_hdr_offset;
 255       hdr->csum_offset = offsetof (udp_header_t, checksum);
 256     }
 257   else if (b->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM)
 258     {
 259       hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
 260       hdr->csum_start = gho.l4_hdr_offset;
 261       hdr->csum_offset = offsetof (tcp_header_t, checksum);
 262     }
 263
 264   /* GSO offload */
 265   if (b->flags & VNET_BUFFER_F_GSO)
 266     {
 267       if (b->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM)
 268         {
 269           if ((b->flags & VNET_BUFFER_F_IS_IP4) &&
 270               (vui->features & (1ULL << FEAT_VIRTIO_NET_F_GUEST_TSO4)))
 271             {
 272               hdr->gso_size = vnet_buffer2 (b)->gso_size;
 273               hdr->gso_type = VIRTIO_NET_HDR_GSO_TCPV4;
 274             }
 275           else if ((b->flags & VNET_BUFFER_F_IS_IP6) &&
 276                    (vui->features & (1ULL << FEAT_VIRTIO_NET_F_GUEST_TSO6)))
 277             {
 278               hdr->gso_size = vnet_buffer2 (b)->gso_size;
 279               hdr->gso_type = VIRTIO_NET_HDR_GSO_TCPV6;
 280             }
 281         }
 282       else if ((vui->features & (1ULL << FEAT_VIRTIO_NET_F_GUEST_UFO)) &&
 283                (b->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))
 284         {
 285           hdr->gso_size = vnet_buffer2 (b)->gso_size;
 286           hdr->gso_type = VIRTIO_NET_HDR_GSO_UDP;
 287         }
 288     }
 289 }
 290
 291 VNET_DEVICE_CLASS_TX_FN (vhost_user_device_class) (vlib_main_t * vm,
 292                                                    vlib_node_runtime_t *
 293                                                    node, vlib_frame_t * frame)
 294 {
 295   u32 *buffers = vlib_frame_vector_args (frame);
 296   u32 n_left = frame->n_vectors;
 297   vhost_user_main_t *vum = &vhost_user_main;
 298   vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
 299   vhost_user_intf_t *vui =
 300     pool_elt_at_index (vum->vhost_user_interfaces, rd->dev_instance);
 301   u32 qid = ~0;
 302   vhost_user_vring_t *rxvq;
 303   u8 error;
 304   u32 thread_index = vm->thread_index;
 305   vhost_cpu_t *cpu = &vum->cpus[thread_index];
 306   u32 map_hint = 0;
 307   u8 retry = 8;
 308   u16 copy_len;
 309   u16 tx_headers_len;
 310
 311   if (PREDICT_FALSE (!vui->admin_up))
 312     {
 313       error = VHOST_USER_TX_FUNC_ERROR_DOWN;
 314       goto done3;
 315     }
 316
 317   if (PREDICT_FALSE (!vui->is_ready))
 318     {
 319       error = VHOST_USER_TX_FUNC_ERROR_NOT_READY;
 320       goto done3;
 321     }
 322
 323   qid = VHOST_VRING_IDX_RX (*vec_elt_at_index (vui->per_cpu_tx_qid,
 324                                                thread_index));
 325   rxvq = &vui->vrings[qid];
 326   if (PREDICT_FALSE (rxvq->avail == 0))
 327     {
 328       error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
 329       goto done3;
 330     }
 331
 332   if (PREDICT_FALSE (vui->use_tx_spinlock))
 333     vhost_user_vring_lock (vui, qid);
 334
 335 retry:
 336   error = VHOST_USER_TX_FUNC_ERROR_NONE;
 337   tx_headers_len = 0;
 338   copy_len = 0;
 339   while (n_left > 0)
 340     {
 341       vlib_buffer_t *b0, *current_b0;
 342       u16 desc_head, desc_index, desc_len;
 343       vring_desc_t *desc_table;
 344       uword buffer_map_addr;
 345       u32 buffer_len;
 346       u16 bytes_left;
 347
 348       if (PREDICT_TRUE (n_left > 1))
 349         vlib_prefetch_buffer_with_index (vm, buffers[1], LOAD);
 350
 351       b0 = vlib_get_buffer (vm, buffers[0]);
 352
 353       if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
 354         {
 355           cpu->current_trace = vlib_add_trace (vm, node, b0,
 356                                                sizeof (*cpu->current_trace));
 357           vhost_user_tx_trace (cpu->current_trace, vui, qid / 2, b0, rxvq);
 358         }
 359
 360       if (PREDICT_FALSE (rxvq->last_avail_idx == rxvq->avail->idx))
 361         {
 362           error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
 363           goto done;
 364         }
 365
 366       desc_table = rxvq->desc;
 367       desc_head = desc_index =
 368         rxvq->avail->ring[rxvq->last_avail_idx & rxvq->qsz_mask];
 369
 370       /* Go deeper in case of indirect descriptor
 371        * I don't know of any driver providing indirect for RX. */
 372       if (PREDICT_FALSE (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT))
 373         {
 374           if (PREDICT_FALSE
 375               (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
 376             {
 377               error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
 378               goto done;
 379             }
 380           if (PREDICT_FALSE
 381               (!(desc_table =
 382                  map_guest_mem (vui, rxvq->desc[desc_index].addr,
 383                                 &map_hint))))
 384             {
 385               error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
 386               goto done;
 387             }
 388           desc_index = 0;
 389         }
 390
 391       desc_len = vui->virtio_net_hdr_sz;
 392       buffer_map_addr = desc_table[desc_index].addr;
 393       buffer_len = desc_table[desc_index].len;
 394
 395       {
 396         // Get a header from the header array
 397         virtio_net_hdr_mrg_rxbuf_t *hdr = &cpu->tx_headers[tx_headers_len];
 398         tx_headers_len++;
 399         hdr->hdr.flags = 0;
 400         hdr->hdr.gso_type = VIRTIO_NET_HDR_GSO_NONE;
 401         hdr->num_buffers = 1;   //This is local, no need to check
 402
 403         /* Guest supports csum offload? */
 404         if (vui->features & (1ULL << FEAT_VIRTIO_NET_F_GUEST_CSUM))
 405           vhost_user_handle_tx_offload (vui, b0, &hdr->hdr);
 406
 407         // Prepare a copy order executed later for the header
 408         ASSERT (copy_len < VHOST_USER_COPY_ARRAY_N);
 409         vhost_copy_t *cpy = &cpu->copy[copy_len];
 410         copy_len++;
 411         cpy->len = vui->virtio_net_hdr_sz;
 412         cpy->dst = buffer_map_addr;
 413         cpy->src = (uword) hdr;
 414       }
 415
 416       buffer_map_addr += vui->virtio_net_hdr_sz;
 417       buffer_len -= vui->virtio_net_hdr_sz;
 418       bytes_left = b0->current_length;
 419       current_b0 = b0;
 420       while (1)
 421         {
 422           if (buffer_len == 0)
 423             {                   //Get new output
 424               if (desc_table[desc_index].flags & VIRTQ_DESC_F_NEXT)
 425                 {
 426                   //Next one is chained
 427                   desc_index = desc_table[desc_index].next;
 428                   buffer_map_addr = desc_table[desc_index].addr;
 429                   buffer_len = desc_table[desc_index].len;
 430                 }
 431               else if (vui->virtio_net_hdr_sz == 12)    //MRG is available
 432                 {
 433                   virtio_net_hdr_mrg_rxbuf_t *hdr =
 434                     &cpu->tx_headers[tx_headers_len - 1];
 435
 436                   //Move from available to used buffer
 437                   rxvq->used->ring[rxvq->last_used_idx & rxvq->qsz_mask].id =
 438                     desc_head;
 439                   rxvq->used->ring[rxvq->last_used_idx & rxvq->qsz_mask].len =
 440                     desc_len;
 441                   vhost_user_log_dirty_ring (vui, rxvq,
 442                                              ring[rxvq->last_used_idx &
 443                                                   rxvq->qsz_mask]);
 444
 445                   rxvq->last_avail_idx++;
 446                   rxvq->last_used_idx++;
 447                   hdr->num_buffers++;
 448                   desc_len = 0;
 449
 450                   if (PREDICT_FALSE
 451                       (rxvq->last_avail_idx == rxvq->avail->idx))
 452                     {
 453                       //Dequeue queued descriptors for this packet
 454                       rxvq->last_used_idx -= hdr->num_buffers - 1;
 455                       rxvq->last_avail_idx -= hdr->num_buffers - 1;
 456                       error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF;
 457                       goto done;
 458                     }
 459
 460                   desc_table = rxvq->desc;
 461                   desc_head = desc_index =
 462                     rxvq->avail->ring[rxvq->last_avail_idx & rxvq->qsz_mask];
 463                   if (PREDICT_FALSE
 464                       (rxvq->desc[desc_head].flags & VIRTQ_DESC_F_INDIRECT))
 465                     {
 466                       //It is seriously unlikely that a driver will put indirect descriptor
 467                       //after non-indirect descriptor.
 468                       if (PREDICT_FALSE
 469                           (rxvq->desc[desc_head].len < sizeof (vring_desc_t)))
 470                         {
 471                           error = VHOST_USER_TX_FUNC_ERROR_INDIRECT_OVERFLOW;
 472                           goto done;
 473                         }
 474                       if (PREDICT_FALSE
 475                           (!(desc_table =
 476                              map_guest_mem (vui,
 477                                             rxvq->desc[desc_index].addr,
 478                                             &map_hint))))
 479                         {
 480                           error = VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL;
 481                           goto done;
 482                         }
 483                       desc_index = 0;
 484                     }
 485                   buffer_map_addr = desc_table[desc_index].addr;
 486                   buffer_len = desc_table[desc_index].len;
 487                 }
 488               else
 489                 {
 490                   error = VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOMRG;
 491                   goto done;
 492                 }
 493             }
 494
 495           {
 496             ASSERT (copy_len < VHOST_USER_COPY_ARRAY_N);
 497             vhost_copy_t *cpy = &cpu->copy[copy_len];
 498             copy_len++;
 499             cpy->len = bytes_left;
 500             cpy->len = (cpy->len > buffer_len) ? buffer_len : cpy->len;
 501             cpy->dst = buffer_map_addr;
 502             cpy->src = (uword) vlib_buffer_get_current (current_b0) +
 503               current_b0->current_length - bytes_left;
 504
 505             bytes_left -= cpy->len;
 506             buffer_len -= cpy->len;
 507             buffer_map_addr += cpy->len;
 508             desc_len += cpy->len;
 509
 510             CLIB_PREFETCH (&rxvq->desc, CLIB_CACHE_LINE_BYTES, LOAD);
 511           }
 512
 513           // Check if vlib buffer has more data. If not, get more or break.
 514           if (PREDICT_TRUE (!bytes_left))
 515             {
 516               if (PREDICT_FALSE
 517                   (current_b0->flags & VLIB_BUFFER_NEXT_PRESENT))
 518                 {
 519                   current_b0 = vlib_get_buffer (vm, current_b0->next_buffer);
 520                   bytes_left = current_b0->current_length;
 521                 }
 522               else
 523                 {
 524                   //End of packet
 525                   break;
 526                 }
 527             }
 528         }
 529
 530       //Move from available to used ring
 531       rxvq->used->ring[rxvq->last_used_idx & rxvq->qsz_mask].id = desc_head;
 532       rxvq->used->ring[rxvq->last_used_idx & rxvq->qsz_mask].len = desc_len;
 533       vhost_user_log_dirty_ring (vui, rxvq,
 534                                  ring[rxvq->last_used_idx & rxvq->qsz_mask]);
 535       rxvq->last_avail_idx++;
 536       rxvq->last_used_idx++;
 537
 538       if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
 539         {
 540           cpu->current_trace->hdr = cpu->tx_headers[tx_headers_len - 1];
 541         }
 542
 543       n_left--;                 //At the end for error counting when 'goto done' is invoked
 544
 545       /*
 546        * Do the copy periodically to prevent
 547        * cpu->copy array overflow and corrupt memory
 548        */
 549       if (PREDICT_FALSE (copy_len >= VHOST_USER_TX_COPY_THRESHOLD))
 550         {
 551           if (PREDICT_FALSE (vhost_user_tx_copy (vui, cpu->copy, copy_len,
 552                                                  &map_hint)))
 553             {
 554               vlib_error_count (vm, node->node_index,
 555                                 VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL, 1);
 556             }
 557           copy_len = 0;
 558
 559           /* give buffers back to driver */
 560           CLIB_MEMORY_BARRIER ();
 561           rxvq->used->idx = rxvq->last_used_idx;
 562           vhost_user_log_dirty_ring (vui, rxvq, idx);
 563         }
 564       buffers++;
 565     }
 566
 567 done:
 568   //Do the memory copies
 569   if (PREDICT_FALSE (vhost_user_tx_copy (vui, cpu->copy, copy_len,
 570                                          &map_hint)))
 571     {
 572       vlib_error_count (vm, node->node_index,
 573                         VHOST_USER_TX_FUNC_ERROR_MMAP_FAIL, 1);
 574     }
 575
 576   CLIB_MEMORY_BARRIER ();
 577   rxvq->used->idx = rxvq->last_used_idx;
 578   vhost_user_log_dirty_ring (vui, rxvq, idx);
 579
 580   /*
 581    * When n_left is set, error is always set to something too.
 582    * In case error is due to lack of remaining buffers, we go back up and
 583    * retry.
 584    * The idea is that it is better to waste some time on packets
 585    * that have been processed already than dropping them and get
 586    * more fresh packets with a good likelihood that they will be dropped too.
 587    * This technique also gives more time to VM driver to pick-up packets.
 588    * In case the traffic flows from physical to virtual interfaces, this
 589    * technique will end-up leveraging the physical NIC buffer in order to
 590    * absorb the VM's CPU jitter.
 591    */
 592   if (n_left && (error == VHOST_USER_TX_FUNC_ERROR_PKT_DROP_NOBUF) && retry)
 593     {
 594       retry--;
 595       goto retry;
 596     }
 597
 598   /* interrupt (call) handling */
 599   if ((rxvq->callfd_idx != ~0) &&
 600       !(rxvq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT))
 601     {
 602       rxvq->n_since_last_int += frame->n_vectors - n_left;
 603
 604       if (rxvq->n_since_last_int > vum->coalesce_frames)
 605         vhost_user_send_call (vm, rxvq);
 606     }
 607
 608   vhost_user_vring_unlock (vui, qid);
 609
 610 done3:
 611   if (PREDICT_FALSE (n_left && error != VHOST_USER_TX_FUNC_ERROR_NONE))
 612     {
 613       vlib_error_count (vm, node->node_index, error, n_left);
 614       vlib_increment_simple_counter
 615         (vnet_main.interface_main.sw_if_counters
 616          + VNET_INTERFACE_COUNTER_DROP,
 617          thread_index, vui->sw_if_index, n_left);
 618     }
 619
 620   vlib_buffer_free (vm, vlib_frame_vector_args (frame), frame->n_vectors);
 621   return frame->n_vectors;
 622 }
 623
 624 static __clib_unused clib_error_t *
 625 vhost_user_interface_rx_mode_change (vnet_main_t * vnm, u32 hw_if_index,
 626                                      u32 qid, vnet_hw_interface_rx_mode mode)
 627 {
 628   vlib_main_t *vm = vnm->vlib_main;
 629   vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
 630   vhost_user_main_t *vum = &vhost_user_main;
 631   vhost_user_intf_t *vui =
 632     pool_elt_at_index (vum->vhost_user_interfaces, hif->dev_instance);
 633   vhost_user_vring_t *txvq = &vui->vrings[VHOST_VRING_IDX_TX (qid)];
 634
 635   if ((mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT) ||
 636       (mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE))
 637     {
 638       if (txvq->kickfd_idx == ~0)
 639         {
 640           // We cannot support interrupt mode if the driver opts out
 641           return clib_error_return (0, "Driver does not support interrupt");
 642         }
 643       if (txvq->mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
 644         {
 645           vum->ifq_count++;
 646           // Start the timer if this is the first encounter on interrupt
 647           // interface/queue
 648           if ((vum->ifq_count == 1) &&
 649               (vum->coalesce_time > 0.0) && (vum->coalesce_frames > 0))
 650             vlib_process_signal_event (vm,
 651                                        vhost_user_send_interrupt_node.index,
 652                                        VHOST_USER_EVENT_START_TIMER, 0);
 653         }
 654     }
 655   else if (mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
 656     {
 657       if (((txvq->mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT) ||
 658            (txvq->mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE)) &&
 659           vum->ifq_count)
 660         {
 661           vum->ifq_count--;
 662           // Stop the timer if there is no more interrupt interface/queue
 663           if ((vum->ifq_count == 0) &&
 664               (vum->coalesce_time > 0.0) && (vum->coalesce_frames > 0))
 665             vlib_process_signal_event (vm,
 666                                        vhost_user_send_interrupt_node.index,
 667                                        VHOST_USER_EVENT_STOP_TIMER, 0);
 668         }
 669     }
 670
 671   txvq->mode = mode;
 672   if (mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
 673     txvq->used->flags = VRING_USED_F_NO_NOTIFY;
 674   else if ((mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE) ||
 675            (mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT))
 676     txvq->used->flags = 0;
 677   else
 678     {
 679       vu_log_err (vui, "unhandled mode %d changed for if %d queue %d", mode,
 680                   hw_if_index, qid);
 681       return clib_error_return (0, "unsupported");
 682     }
 683
 684   return 0;
 685 }
 686
 687 static __clib_unused clib_error_t *
 688 vhost_user_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
 689                                     u32 flags)
 690 {
 691   vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
 692   vhost_user_main_t *vum = &vhost_user_main;
 693   vhost_user_intf_t *vui =
 694     pool_elt_at_index (vum->vhost_user_interfaces, hif->dev_instance);
 695   u8 link_old, link_new;
 696
 697   link_old = vui_is_link_up (vui);
 698
 699   vui->admin_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
 700
 701   link_new = vui_is_link_up (vui);
 702
 703   if (link_old != link_new)
 704     vnet_hw_interface_set_flags (vnm, vui->hw_if_index, link_new ?
 705                                  VNET_HW_INTERFACE_FLAG_LINK_UP : 0);
 706
 707   return /* no error */ 0;
 708 }
 709
 710 /* *INDENT-OFF* */
 711 VNET_DEVICE_CLASS (vhost_user_device_class) = {
 712   .name = "vhost-user",
 713   .tx_function_n_errors = VHOST_USER_TX_FUNC_N_ERROR,
 714   .tx_function_error_strings = vhost_user_tx_func_error_strings,
 715   .format_device_name = format_vhost_user_interface_name,
 716   .name_renumber = vhost_user_name_renumber,
 717   .admin_up_down_function = vhost_user_interface_admin_up_down,
 718   .rx_mode_change_function = vhost_user_interface_rx_mode_change,
 719   .format_tx_trace = format_vhost_trace,
 720 };
 721
 722 /* *INDENT-ON* */
 723
 724 /*
 725  * fd.io coding-style-patch-verification: ON
 726  *
 727  * Local Variables:
 728  * eval: (c-set-style "gnu")
 729  * End:
 730  */