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