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, qid);
  59
  60   return 0;
  61 }
  62
  63
  64 clib_error_t *
  65 virtio_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 idx, u16 sz)
  66 {
  67   clib_error_t *err = 0;
  68   virtio_vring_t *vring;
  69   struct vhost_vring_state state = { 0 };
  70   struct vhost_vring_addr addr = { 0 };
  71   struct vhost_vring_file file = { 0 };
  72   clib_file_t t = { 0 };
  73   int i;
  74
  75   if (!is_pow2 (sz))
  76     return clib_error_return (0, "ring size must be power of 2");
  77
  78   if (sz > 32768)
  79     return clib_error_return (0, "ring size must be 32768 or lower");
  80
  81   if (sz == 0)
  82     sz = 256;
  83
  84   vec_validate_aligned (vif->vrings, idx, CLIB_CACHE_LINE_BYTES);
  85   vring = vec_elt_at_index (vif->vrings, idx);
  86
  87   i = sizeof (struct vring_desc) * sz;
  88   i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
  89   vring->desc = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
  90   clib_memset (vring->desc, 0, i);
  91
  92   i = sizeof (struct vring_avail) + sz * sizeof (vring->avail->ring[0]);
  93   i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
  94   vring->avail = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
  95   clib_memset (vring->avail, 0, i);
  96   // tell kernel that we don't need interrupt
  97   vring->avail->flags = VIRTIO_RING_FLAG_MASK_INT;
  98
  99   i = sizeof (struct vring_used) + sz * sizeof (struct vring_used_elem);
 100   i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
 101   vring->used = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
 102   clib_memset (vring->used, 0, i);
 103
 104   ASSERT (vring->buffers == 0);
 105   vec_validate_aligned (vring->buffers, sz, CLIB_CACHE_LINE_BYTES);
 106   ASSERT (vring->indirect_buffers == 0);
 107   vec_validate_aligned (vring->indirect_buffers, sz, CLIB_CACHE_LINE_BYTES);
 108   if (idx % 2)
 109     {
 110       u32 n_alloc = 0;
 111       do
 112         {
 113           if (n_alloc < sz)
 114             n_alloc =
 115               vlib_buffer_alloc (vm, vring->indirect_buffers + n_alloc,
 116                                  sz - n_alloc);
 117         }
 118       while (n_alloc != sz);
 119     }
 120
 121   vring->size = sz;
 122   vring->call_fd = eventfd (0, EFD_NONBLOCK | EFD_CLOEXEC);
 123   vring->kick_fd = eventfd (0, EFD_CLOEXEC);
 124
 125   t.read_function = call_read_ready;
 126   t.file_descriptor = vring->call_fd;
 127   t.private_data = vif->dev_instance << 16 | idx;
 128   t.description = format (0, "%U vring %u", format_virtio_device_name,
 129                           vif->dev_instance, idx);
 130   vring->call_file_index = clib_file_add (&file_main, &t);
 131
 132   state.index = idx;
 133   state.num = sz;
 134   _IOCTL (vif->fd, VHOST_SET_VRING_NUM, &state);
 135
 136   addr.index = idx;
 137   addr.flags = 0;
 138   addr.desc_user_addr = pointer_to_uword (vring->desc);
 139   addr.avail_user_addr = pointer_to_uword (vring->avail);
 140   addr.used_user_addr = pointer_to_uword (vring->used);
 141   _IOCTL (vif->fd, VHOST_SET_VRING_ADDR, &addr);
 142
 143   file.index = idx;
 144   file.fd = vring->kick_fd;
 145   _IOCTL (vif->fd, VHOST_SET_VRING_KICK, &file);
 146   file.fd = vring->call_fd;
 147   _IOCTL (vif->fd, VHOST_SET_VRING_CALL, &file);
 148   file.fd = vif->tap_fd;
 149   _IOCTL (vif->fd, VHOST_NET_SET_BACKEND, &file);
 150
 151 error:
 152   return err;
 153 }
 154
 155 inline void
 156 virtio_free_rx_buffers (vlib_main_t * vm, virtio_vring_t * vring)
 157 {
 158   u16 used = vring->desc_in_use;
 159   u16 last = vring->last_used_idx;
 160   u16 mask = vring->size - 1;
 161
 162   while (used)
 163     {
 164       vlib_buffer_free (vm, &vring->buffers[last & mask], 1);
 165       last++;
 166       used--;
 167     }
 168 }
 169
 170 clib_error_t *
 171 virtio_vring_free (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
 172 {
 173   virtio_vring_t *vring = vec_elt_at_index (vif->vrings, idx);
 174
 175   clib_file_del_by_index (&file_main, vring->call_file_index);
 176   close (vring->kick_fd);
 177   close (vring->call_fd);
 178   if (vring->used)
 179     {
 180       if ((idx & 1) == 1)
 181         virtio_free_used_desc (vm, vring);
 182       else
 183         virtio_free_rx_buffers (vm, vring);
 184       clib_mem_free (vring->used);
 185     }
 186   if (vring->desc)
 187     clib_mem_free (vring->desc);
 188   if (vring->avail)
 189     clib_mem_free (vring->avail);
 190   if (vring->queue_id % 2)
 191     {
 192       vlib_buffer_free_no_next (vm, vring->indirect_buffers, vring->size);
 193     }
 194   vec_free (vring->buffers);
 195   vec_free (vring->indirect_buffers);
 196   return 0;
 197 }
 198
 199 inline void
 200 virtio_set_net_hdr_size (virtio_if_t * vif)
 201 {
 202   if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF) ||
 203       vif->features & VIRTIO_FEATURE (VIRTIO_F_VERSION_1))
 204     vif->virtio_net_hdr_sz = sizeof (struct virtio_net_hdr_v1);
 205   else
 206     vif->virtio_net_hdr_sz = sizeof (struct virtio_net_hdr);
 207 }
 208
 209 inline void
 210 virtio_show (vlib_main_t * vm, u32 * hw_if_indices, u8 show_descr, u32 type)
 211 {
 212   u32 i, j, hw_if_index;
 213   virtio_if_t *vif;
 214   vnet_main_t *vnm = &vnet_main;
 215   virtio_main_t *mm = &virtio_main;
 216   virtio_vring_t *vring;
 217   struct feat_struct
 218   {
 219     u8 bit;
 220     char *str;
 221   };
 222   struct feat_struct *feat_entry;
 223
 224   static struct feat_struct feat_array[] = {
 225 #define _(s,b) { .str = #s, .bit = b, },
 226     foreach_virtio_net_features
 227 #undef _
 228     {.str = NULL}
 229   };
 230
 231   struct feat_struct *flag_entry;
 232   static struct feat_struct flags_array[] = {
 233 #define _(b,e,s) { .bit = b, .str = s, },
 234     foreach_virtio_if_flag
 235 #undef _
 236     {.str = NULL}
 237   };
 238
 239   if (!hw_if_indices)
 240     return;
 241
 242   for (hw_if_index = 0; hw_if_index < vec_len (hw_if_indices); hw_if_index++)
 243     {
 244       vnet_hw_interface_t *hi =
 245         vnet_get_hw_interface (vnm, hw_if_indices[hw_if_index]);
 246       vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
 247       if (vif->type != type)
 248         continue;
 249       vlib_cli_output (vm, "Interface: %U (ifindex %d)",
 250                        format_vnet_hw_if_index_name, vnm,
 251                        hw_if_indices[hw_if_index], vif->hw_if_index);
 252       if (type == VIRTIO_IF_TYPE_PCI)
 253         {
 254           vlib_cli_output (vm, "  PCI Address: %U", format_vlib_pci_addr,
 255                            &vif->pci_addr);
 256         }
 257       if (type == VIRTIO_IF_TYPE_TAP)
 258         {
 259           if (vif->host_if_name)
 260             vlib_cli_output (vm, "  name \"%s\"", vif->host_if_name);
 261           if (vif->net_ns)
 262             vlib_cli_output (vm, "  host-ns \"%s\"", vif->net_ns);
 263           vlib_cli_output (vm, "  fd %d", vif->fd);
 264           vlib_cli_output (vm, "  tap-fd %d", vif->tap_fd);
 265         }
 266       vlib_cli_output (vm, "  Mac Address: %U", format_ethernet_address,
 267                        vif->mac_addr);
 268       vlib_cli_output (vm, "  Device instance: %u", vif->dev_instance);
 269       vlib_cli_output (vm, "  flags 0x%x", vif->flags);
 270       flag_entry = (struct feat_struct *) &flags_array;
 271       while (flag_entry->str)
 272         {
 273           if (vif->flags & (1ULL << flag_entry->bit))
 274             vlib_cli_output (vm, "    %s (%d)", flag_entry->str,
 275                              flag_entry->bit);
 276           flag_entry++;
 277         }
 278       if (type == VIRTIO_IF_TYPE_PCI)
 279         {
 280           device_status (vm, vif);
 281         }
 282       vlib_cli_output (vm, "  features 0x%lx", vif->features);
 283       feat_entry = (struct feat_struct *) &feat_array;
 284       while (feat_entry->str)
 285         {
 286           if (vif->features & (1ULL << feat_entry->bit))
 287             vlib_cli_output (vm, "    %s (%d)", feat_entry->str,
 288                              feat_entry->bit);
 289           feat_entry++;
 290         }
 291       vlib_cli_output (vm, "  remote-features 0x%lx", vif->remote_features);
 292       feat_entry = (struct feat_struct *) &feat_array;
 293       while (feat_entry->str)
 294         {
 295           if (vif->remote_features & (1ULL << feat_entry->bit))
 296             vlib_cli_output (vm, "    %s (%d)", feat_entry->str,
 297                              feat_entry->bit);
 298           feat_entry++;
 299         }
 300       vec_foreach_index (i, vif->vrings)
 301       {
 302         // RX = 0, TX = 1
 303         vring = vec_elt_at_index (vif->vrings, i);
 304         vlib_cli_output (vm, "  Virtqueue (%s)", (i & 1) ? "TX" : "RX");
 305         vlib_cli_output (vm,
 306                          "    qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
 307                          vring->size, vring->last_used_idx, vring->desc_next,
 308                          vring->desc_in_use);
 309         vlib_cli_output (vm,
 310                          "    avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
 311                          vring->avail->flags, vring->avail->idx,
 312                          vring->used->flags, vring->used->idx);
 313         if (type == VIRTIO_IF_TYPE_TAP)
 314           {
 315             vlib_cli_output (vm, "    kickfd %d, callfd %d", vring->kick_fd,
 316                              vring->call_fd);
 317           }
 318         if (show_descr)
 319           {
 320             vlib_cli_output (vm, "\n  descriptor table:\n");
 321             vlib_cli_output (vm,
 322                              "   id          addr         len  flags  next      user_addr\n");
 323             vlib_cli_output (vm,
 324                              "  ===== ================== ===== ====== ===== ==================\n");
 325             vring = vif->vrings;
 326             for (j = 0; j < vring->size; j++)
 327               {
 328                 struct vring_desc *desc = &vring->desc[j];
 329                 vlib_cli_output (vm,
 330                                  "  %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
 331                                  j, desc->addr,
 332                                  desc->len,
 333                                  desc->flags, desc->next, desc->addr);
 334               }
 335           }
 336       }
 337     }
 338
 339 }
 340
 341 /*
 342  * fd.io coding-style-patch-verification: ON
 343  *
 344  * Local Variables:
 345  * eval: (c-set-style "gnu")
 346  * End:
 347  */