src/vnet/devices/virtio/virtio.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2017 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #include <sys/types.h>
  19 #include <sys/stat.h>
  20 #include <fcntl.h>
  21 #include <net/if.h>
  22 #include <linux/if_tun.h>
  23 #include <sys/ioctl.h>
  24 #include <linux/virtio_net.h>
  25 #include <linux/vhost.h>
  26 #include <sys/eventfd.h>
  27
  28 #include <vlib/vlib.h>
  29 #include <vlib/pci/pci.h>
  30 #include <vlib/unix/unix.h>
  31 #include <vnet/ethernet/ethernet.h>
  32 #include <vnet/ip/ip4_packet.h>
  33 #include <vnet/ip/ip6_packet.h>
  34 #include <vnet/devices/virtio/virtio.h>
  35 #include <vnet/devices/virtio/pci.h>
  36
  37 virtio_main_t virtio_main;
  38
  39 #define _IOCTL(fd,a,...) \
  40   if (ioctl (fd, a, __VA_ARGS__) < 0) \
  41     { \
  42       err = clib_error_return_unix (0, "ioctl(" #a ")"); \
  43       goto error; \
  44     }
  45
  46 static clib_error_t *
  47 call_read_ready (clib_file_t * uf)
  48 {
  49   virtio_main_t *nm = &virtio_main;
  50   vnet_main_t *vnm = vnet_get_main ();
  51   u16 qid = uf->private_data & 0xFFFF;
  52   virtio_if_t *vif =
  53     vec_elt_at_index (nm->interfaces, uf->private_data >> 16);
  54   u64 b;
  55
  56   CLIB_UNUSED (ssize_t size) = read (uf->file_descriptor, &b, sizeof (b));
  57   if ((qid & 1) == 0)
  58     vnet_device_input_set_interrupt_pending (vnm, vif->hw_if_index,
  59                                              RX_QUEUE_ACCESS (qid));
  60
  61   return 0;
  62 }
  63
  64
  65 clib_error_t *
  66 virtio_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 idx, u16 sz)
  67 {
  68   virtio_vring_t *vring;
  69   clib_file_t t = { 0 };
  70   int i;
  71
  72   if (!is_pow2 (sz))
  73     return clib_error_return (0, "ring size must be power of 2");
  74
  75   if (sz > 32768)
  76     return clib_error_return (0, "ring size must be 32768 or lower");
  77
  78   if (sz == 0)
  79     sz = 256;
  80
  81   if (idx % 2)
  82     {
  83       vlib_thread_main_t *thm = vlib_get_thread_main ();
  84       vec_validate_aligned (vif->txq_vrings, TX_QUEUE_ACCESS (idx),
  85                             CLIB_CACHE_LINE_BYTES);
  86       vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (idx));
  87       if (thm->n_vlib_mains > vif->num_txqs)
  88         clib_spinlock_init (&vring->lockp);
  89     }
  90   else
  91     {
  92       vec_validate_aligned (vif->rxq_vrings, RX_QUEUE_ACCESS (idx),
  93                             CLIB_CACHE_LINE_BYTES);
  94       vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (idx));
  95     }
  96   i = sizeof (struct vring_desc) * sz;
  97   i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
  98   vring->desc = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
  99   clib_memset (vring->desc, 0, i);
 100
 101   i = sizeof (struct vring_avail) + sz * sizeof (vring->avail->ring[0]);
 102   i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
 103   vring->avail = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
 104   clib_memset (vring->avail, 0, i);
 105   // tell kernel that we don't need interrupt
 106   vring->avail->flags = VIRTIO_RING_FLAG_MASK_INT;
 107
 108   i = sizeof (struct vring_used) + sz * sizeof (struct vring_used_elem);
 109   i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
 110   vring->used = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
 111   clib_memset (vring->used, 0, i);
 112
 113   vring->queue_id = idx;
 114   ASSERT (vring->buffers == 0);
 115   vec_validate_aligned (vring->buffers, sz, CLIB_CACHE_LINE_BYTES);
 116
 117   if (idx & 1)
 118     {
 119       clib_memset_u32 (vring->buffers, ~0, sz);
 120     }
 121
 122   vring->size = sz;
 123   vring->call_fd = eventfd (0, EFD_NONBLOCK | EFD_CLOEXEC);
 124   vring->kick_fd = eventfd (0, EFD_NONBLOCK | EFD_CLOEXEC);
 125   virtio_log_debug (vif, "vring %u size %u call_fd %d kick_fd %d", idx,
 126                     vring->size, vring->call_fd, vring->kick_fd);
 127
 128   t.read_function = call_read_ready;
 129   t.file_descriptor = vring->call_fd;
 130   t.private_data = vif->dev_instance << 16 | idx;
 131   t.description = format (0, "%U vring %u", format_virtio_device_name,
 132                           vif->dev_instance, idx);
 133   vring->call_file_index = clib_file_add (&file_main, &t);
 134
 135   return 0;
 136 }
 137
 138 inline void
 139 virtio_free_rx_buffers (vlib_main_t * vm, virtio_vring_t * vring)
 140 {
 141   u16 used = vring->desc_in_use;
 142   u16 last = vring->last_used_idx;
 143   u16 mask = vring->size - 1;
 144
 145   while (used)
 146     {
 147       vlib_buffer_free (vm, &vring->buffers[last & mask], 1);
 148       last++;
 149       used--;
 150     }
 151 }
 152
 153 clib_error_t *
 154 virtio_vring_free_rx (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
 155 {
 156   virtio_vring_t *vring =
 157     vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (idx));
 158
 159   clib_file_del_by_index (&file_main, vring->call_file_index);
 160   close (vring->kick_fd);
 161   close (vring->call_fd);
 162   if (vring->used)
 163     {
 164       virtio_free_rx_buffers (vm, vring);
 165       clib_mem_free (vring->used);
 166     }
 167   if (vring->desc)
 168     clib_mem_free (vring->desc);
 169   if (vring->avail)
 170     clib_mem_free (vring->avail);
 171   vec_free (vring->buffers);
 172   return 0;
 173 }
 174
 175 inline void
 176 virtio_free_used_desc (vlib_main_t * vm, virtio_vring_t * vring)
 177 {
 178   u16 used = vring->desc_in_use;
 179   u16 sz = vring->size;
 180   u16 mask = sz - 1;
 181   u16 last = vring->last_used_idx;
 182   u16 n_left = vring->used->idx - last;
 183
 184   if (n_left == 0)
 185     return;
 186
 187   while (n_left)
 188     {
 189       struct vring_used_elem *e = &vring->used->ring[last & mask];
 190       u16 slot = e->id;
 191
 192       vlib_buffer_free (vm, &vring->buffers[slot], 1);
 193       used--;
 194       last++;
 195       n_left--;
 196     }
 197   vring->desc_in_use = used;
 198   vring->last_used_idx = last;
 199 }
 200
 201 clib_error_t *
 202 virtio_vring_free_tx (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
 203 {
 204   virtio_vring_t *vring =
 205     vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (idx));
 206
 207   clib_file_del_by_index (&file_main, vring->call_file_index);
 208   close (vring->kick_fd);
 209   close (vring->call_fd);
 210   if (vring->used)
 211     {
 212       virtio_free_used_desc (vm, vring);
 213       clib_mem_free (vring->used);
 214     }
 215   if (vring->desc)
 216     clib_mem_free (vring->desc);
 217   if (vring->avail)
 218     clib_mem_free (vring->avail);
 219   vec_free (vring->buffers);
 220   clib_spinlock_free (&vring->lockp);
 221   return 0;
 222 }
 223
 224 void
 225 virtio_vring_set_numa_node (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
 226 {
 227   vnet_main_t *vnm = vnet_get_main ();
 228   u32 thread_index;
 229   virtio_vring_t *vring =
 230     vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (idx));
 231   thread_index =
 232     vnet_get_device_input_thread_index (vnm, vif->hw_if_index,
 233                                         RX_QUEUE_ACCESS (idx));
 234   vring->buffer_pool_index =
 235     vlib_buffer_pool_get_default_for_numa (vm,
 236                                            vlib_mains
 237                                            [thread_index]->numa_node);
 238 }
 239
 240 inline void
 241 virtio_set_net_hdr_size (virtio_if_t * vif)
 242 {
 243   if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF) ||
 244       vif->features & VIRTIO_FEATURE (VIRTIO_F_VERSION_1))
 245     vif->virtio_net_hdr_sz = sizeof (struct virtio_net_hdr_v1);
 246   else
 247     vif->virtio_net_hdr_sz = sizeof (struct virtio_net_hdr);
 248 }
 249
 250 inline void
 251 virtio_show (vlib_main_t * vm, u32 * hw_if_indices, u8 show_descr, u32 type)
 252 {
 253   u32 i, j, hw_if_index;
 254   virtio_if_t *vif;
 255   vnet_main_t *vnm = &vnet_main;
 256   virtio_main_t *mm = &virtio_main;
 257   virtio_vring_t *vring;
 258   struct feat_struct
 259   {
 260     u8 bit;
 261     char *str;
 262   };
 263   struct feat_struct *feat_entry;
 264
 265   static struct feat_struct feat_array[] = {
 266 #define _(s,b) { .str = #s, .bit = b, },
 267     foreach_virtio_net_features
 268 #undef _
 269     {.str = NULL}
 270   };
 271
 272   struct feat_struct *flag_entry;
 273   static struct feat_struct flags_array[] = {
 274 #define _(b,e,s) { .bit = b, .str = s, },
 275     foreach_virtio_if_flag
 276 #undef _
 277     {.str = NULL}
 278   };
 279
 280   if (!hw_if_indices)
 281     return;
 282
 283   for (hw_if_index = 0; hw_if_index < vec_len (hw_if_indices); hw_if_index++)
 284     {
 285       vnet_hw_interface_t *hi =
 286         vnet_get_hw_interface (vnm, hw_if_indices[hw_if_index]);
 287       vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
 288       if (vif->type != type)
 289         continue;
 290       vlib_cli_output (vm, "Interface: %U (ifindex %d)",
 291                        format_vnet_hw_if_index_name, vnm,
 292                        hw_if_indices[hw_if_index], vif->hw_if_index);
 293       if (type == VIRTIO_IF_TYPE_PCI)
 294         {
 295           vlib_cli_output (vm, "  PCI Address: %U", format_vlib_pci_addr,
 296                            &vif->pci_addr);
 297         }
 298       if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
 299         {
 300           u8 *str = 0;
 301           if (vif->host_if_name)
 302             vlib_cli_output (vm, "  name \"%s\"", vif->host_if_name);
 303           if (vif->net_ns)
 304             vlib_cli_output (vm, "  host-ns \"%s\"", vif->net_ns);
 305           if (vif->host_mtu_size)
 306             vlib_cli_output (vm, "  host-mtu-size \"%d\"",
 307                              vif->host_mtu_size);
 308           if (type == VIRTIO_IF_TYPE_TAP)
 309             vlib_cli_output (vm, "  host-mac-addr: %U",
 310                              format_ethernet_address, vif->host_mac_addr);
 311
 312           vec_foreach_index (i, vif->vhost_fds)
 313             str = format (str, " %d", vif->vhost_fds[i]);
 314           vlib_cli_output (vm, "  vhost-fds%v", str);
 315           vec_free (str);
 316           vec_foreach_index (i, vif->tap_fds)
 317             str = format (str, " %d", vif->tap_fds[i]);
 318           vlib_cli_output (vm, "  tap-fds%v", str);
 319           vec_free (str);
 320         }
 321       vlib_cli_output (vm, "  gso-enabled %d", vif->gso_enabled);
 322       vlib_cli_output (vm, "  csum-enabled %d", vif->csum_offload_enabled);
 323       if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_PCI))
 324         vlib_cli_output (vm, "  Mac Address: %U", format_ethernet_address,
 325                          vif->mac_addr);
 326       vlib_cli_output (vm, "  Device instance: %u", vif->dev_instance);
 327       vlib_cli_output (vm, "  flags 0x%x", vif->flags);
 328       flag_entry = (struct feat_struct *) &flags_array;
 329       while (flag_entry->str)
 330         {
 331           if (vif->flags & (1ULL << flag_entry->bit))
 332             vlib_cli_output (vm, "    %s (%d)", flag_entry->str,
 333                              flag_entry->bit);
 334           flag_entry++;
 335         }
 336       if (type == VIRTIO_IF_TYPE_PCI)
 337         {
 338           device_status (vm, vif);
 339         }
 340       vlib_cli_output (vm, "  features 0x%lx", vif->features);
 341       feat_entry = (struct feat_struct *) &feat_array;
 342       while (feat_entry->str)
 343         {
 344           if (vif->features & (1ULL << feat_entry->bit))
 345             vlib_cli_output (vm, "    %s (%d)", feat_entry->str,
 346                              feat_entry->bit);
 347           feat_entry++;
 348         }
 349       vlib_cli_output (vm, "  remote-features 0x%lx", vif->remote_features);
 350       feat_entry = (struct feat_struct *) &feat_array;
 351       while (feat_entry->str)
 352         {
 353           if (vif->remote_features & (1ULL << feat_entry->bit))
 354             vlib_cli_output (vm, "    %s (%d)", feat_entry->str,
 355                              feat_entry->bit);
 356           feat_entry++;
 357         }
 358       vlib_cli_output (vm, "  Number of RX Virtqueue  %u", vif->num_rxqs);
 359       vlib_cli_output (vm, "  Number of TX Virtqueue  %u", vif->num_txqs);
 360       if (vif->cxq_vring != NULL
 361           && vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
 362         vlib_cli_output (vm, "  Number of CTRL Virtqueue 1");
 363       vec_foreach_index (i, vif->rxq_vrings)
 364       {
 365         vring = vec_elt_at_index (vif->rxq_vrings, i);
 366         vlib_cli_output (vm, "  Virtqueue (RX) %d", vring->queue_id);
 367         vlib_cli_output (vm,
 368                          "    qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
 369                          vring->size, vring->last_used_idx, vring->desc_next,
 370                          vring->desc_in_use);
 371         vlib_cli_output (vm,
 372                          "    avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
 373                          vring->avail->flags, vring->avail->idx,
 374                          vring->used->flags, vring->used->idx);
 375         if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
 376           {
 377             vlib_cli_output (vm, "    kickfd %d, callfd %d", vring->kick_fd,
 378                              vring->call_fd);
 379           }
 380         if (show_descr)
 381           {
 382             vlib_cli_output (vm, "\n  descriptor table:\n");
 383             vlib_cli_output (vm,
 384                              "   id          addr         len  flags  next      user_addr\n");
 385             vlib_cli_output (vm,
 386                              "  ===== ================== ===== ====== ===== ==================\n");
 387             for (j = 0; j < vring->size; j++)
 388               {
 389                 struct vring_desc *desc = &vring->desc[j];
 390                 vlib_cli_output (vm,
 391                                  "  %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
 392                                  j, desc->addr,
 393                                  desc->len,
 394                                  desc->flags, desc->next, desc->addr);
 395               }
 396           }
 397       }
 398       vec_foreach_index (i, vif->txq_vrings)
 399       {
 400         vring = vec_elt_at_index (vif->txq_vrings, i);
 401         vlib_cli_output (vm, "  Virtqueue (TX) %d", vring->queue_id);
 402         vlib_cli_output (vm,
 403                          "    qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
 404                          vring->size, vring->last_used_idx, vring->desc_next,
 405                          vring->desc_in_use);
 406         vlib_cli_output (vm,
 407                          "    avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
 408                          vring->avail->flags, vring->avail->idx,
 409                          vring->used->flags, vring->used->idx);
 410         if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
 411           {
 412             vlib_cli_output (vm, "    kickfd %d, callfd %d", vring->kick_fd,
 413                              vring->call_fd);
 414           }
 415         if (show_descr)
 416           {
 417             vlib_cli_output (vm, "\n  descriptor table:\n");
 418             vlib_cli_output (vm,
 419                              "   id          addr         len  flags  next      user_addr\n");
 420             vlib_cli_output (vm,
 421                              "  ===== ================== ===== ====== ===== ==================\n");
 422             for (j = 0; j < vring->size; j++)
 423               {
 424                 struct vring_desc *desc = &vring->desc[j];
 425                 vlib_cli_output (vm,
 426                                  "  %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
 427                                  j, desc->addr,
 428                                  desc->len,
 429                                  desc->flags, desc->next, desc->addr);
 430               }
 431           }
 432       }
 433       if (vif->cxq_vring != NULL
 434           && vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
 435         {
 436           vring = vif->cxq_vring;
 437           vlib_cli_output (vm, "  Virtqueue (CTRL) %d", vring->queue_id);
 438           vlib_cli_output (vm,
 439                            "    qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
 440                            vring->size, vring->last_used_idx,
 441                            vring->desc_next, vring->desc_in_use);
 442           vlib_cli_output (vm,
 443                            "    avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
 444                            vring->avail->flags, vring->avail->idx,
 445                            vring->used->flags, vring->used->idx);
 446           if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
 447             {
 448               vlib_cli_output (vm, "    kickfd %d, callfd %d", vring->kick_fd,
 449                                vring->call_fd);
 450             }
 451           if (show_descr)
 452             {
 453               vlib_cli_output (vm, "\n  descriptor table:\n");
 454               vlib_cli_output (vm,
 455                                "   id          addr         len  flags  next      user_addr\n");
 456               vlib_cli_output (vm,
 457                                "  ===== ================== ===== ====== ===== ==================\n");
 458               for (j = 0; j < vring->size; j++)
 459                 {
 460                   struct vring_desc *desc = &vring->desc[j];
 461                   vlib_cli_output (vm,
 462                                    "  %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
 463                                    j, desc->addr,
 464                                    desc->len,
 465                                    desc->flags, desc->next, desc->addr);
 466                 }
 467             }
 468         }
 469
 470     }
 471
 472 }
 473
 474 static clib_error_t *
 475 virtio_init (vlib_main_t * vm)
 476 {
 477   virtio_main_t *vim = &virtio_main;
 478   clib_error_t *error = 0;
 479
 480   vim->log_default = vlib_log_register_class ("virtio", 0);
 481   vlib_log_debug (vim->log_default, "initialized");
 482
 483   return error;
 484 }
 485
 486 VLIB_INIT_FUNCTION (virtio_init);
 487
 488 /*
 489  * fd.io coding-style-patch-verification: ON
 490  *
 491  * Local Variables:
 492  * eval: (c-set-style "gnu")
 493  * End:
 494  */