src/vnet/devices/virtio/device.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2016 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
  22 #include <vlib/vlib.h>
  23 #include <vlib/unix/unix.h>
  24 #include <vnet/ethernet/ethernet.h>
  25 #include <vnet/ip/ip4_packet.h>
  26 #include <vnet/ip/ip6_packet.h>
  27 #include <vnet/devices/virtio/virtio.h>
  28
  29 #define foreach_virtio_tx_func_error           \
  30 _(NO_FREE_SLOTS, "no free tx slots")           \
  31 _(TRUNC_PACKET, "packet > buffer size -- truncated in tx ring") \
  32 _(PENDING_MSGS, "pending msgs in tx ring") \
  33 _(NO_TX_QUEUES, "no tx queues")
  34
  35 typedef enum
  36 {
  37 #define _(f,s) VIRTIO_TX_ERROR_##f,
  38   foreach_virtio_tx_func_error
  39 #undef _
  40     VIRTIO_TX_N_ERROR,
  41 } virtio_tx_func_error_t;
  42
  43 static char *virtio_tx_func_error_strings[] = {
  44 #define _(n,s) s,
  45   foreach_virtio_tx_func_error
  46 #undef _
  47 };
  48
  49 u8 *
  50 format_virtio_device_name (u8 * s, va_list * args)
  51 {
  52   u32 dev_instance = va_arg (*args, u32);
  53   virtio_main_t *mm = &virtio_main;
  54   virtio_if_t *vif = pool_elt_at_index (mm->interfaces, dev_instance);
  55
  56   if (vif->type == VIRTIO_IF_TYPE_TAP)
  57     s = format (s, "tap%u", vif->id);
  58   else if (vif->type == VIRTIO_IF_TYPE_PCI)
  59     s = format (s, "virtio-%x/%x/%x/%x", vif->pci_addr.domain,
  60                 vif->pci_addr.bus, vif->pci_addr.slot,
  61                 vif->pci_addr.function);
  62   else
  63     s = format (s, "virtio-%lu", vif->dev_instance);
  64
  65   return s;
  66 }
  67
  68 static u8 *
  69 format_virtio_device (u8 * s, va_list * args)
  70 {
  71   u32 dev_instance = va_arg (*args, u32);
  72   int verbose = va_arg (*args, int);
  73   u32 indent = format_get_indent (s);
  74
  75   s = format (s, "VIRTIO interface");
  76   if (verbose)
  77     {
  78       s = format (s, "\n%U instance %u", format_white_space, indent + 2,
  79                   dev_instance);
  80     }
  81   return s;
  82 }
  83
  84 static u8 *
  85 format_virtio_tx_trace (u8 * s, va_list * args)
  86 {
  87   s = format (s, "Unimplemented...");
  88   return s;
  89 }
  90
  91 inline void
  92 virtio_free_used_desc (vlib_main_t * vm, virtio_vring_t * vring)
  93 {
  94   u16 used = vring->desc_in_use;
  95   u16 sz = vring->size;
  96   u16 mask = sz - 1;
  97   u16 last = vring->last_used_idx;
  98   u16 n_left = vring->used->idx - last;
  99
 100   if (n_left == 0)
 101     return;
 102
 103   while (n_left)
 104     {
 105       struct vring_used_elem *e = &vring->used->ring[last & mask];
 106       u16 slot = e->id;
 107
 108       vlib_buffer_free (vm, &vring->buffers[slot], 1);
 109       used--;
 110       last++;
 111       n_left--;
 112     }
 113   vring->desc_in_use = used;
 114   vring->last_used_idx = last;
 115 }
 116
 117 static_always_inline u16
 118 add_buffer_to_slot (vlib_main_t * vm, virtio_if_t * vif,
 119                     virtio_vring_t * vring, u32 bi, u16 avail, u16 next,
 120                     u16 mask)
 121 {
 122   u16 n_added = 0;
 123   int hdr_sz = vif->virtio_net_hdr_sz;
 124   struct vring_desc *d;
 125   d = &vring->desc[next];
 126   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
 127   struct virtio_net_hdr_v1 *hdr = vlib_buffer_get_current (b) - hdr_sz;
 128
 129   clib_memset (hdr, 0, hdr_sz);
 130
 131   if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
 132     {
 133       d->addr =
 134         ((vif->type == VIRTIO_IF_TYPE_PCI) ? vlib_buffer_get_current_pa (vm,
 135                                                                          b) :
 136          pointer_to_uword (vlib_buffer_get_current (b))) - hdr_sz;
 137       d->len = b->current_length + hdr_sz;
 138       d->flags = 0;
 139     }
 140   else
 141     {
 142       /*
 143        * We are using single vlib_buffer_t for indirect descriptor(s)
 144        * chain. Single descriptor is 16 bytes and vlib_buffer_t
 145        * has 2048 bytes space. So maximum long chain can have 128
 146        * (=2048/16) indirect descriptors.
 147        * It can easily support 65535 bytes of Jumbo frames with
 148        * each data buffer size of 512 bytes minimum.
 149        */
 150       vlib_buffer_t *indirect_desc =
 151         vlib_get_buffer (vm, vring->indirect_buffers[next]);
 152       indirect_desc->current_data = 0;
 153
 154       struct vring_desc *id =
 155         (struct vring_desc *) vlib_buffer_get_current (indirect_desc);
 156       u32 count = 1;
 157       if (vif->type == VIRTIO_IF_TYPE_PCI)
 158         {
 159           d->addr = vlib_physmem_get_pa (vm, id);
 160           id->addr = vlib_buffer_get_current_pa (vm, b) - hdr_sz;
 161
 162           /*
 163            * If VIRTIO_F_ANY_LAYOUT is not negotiated, then virtio_net_hdr
 164            * should be presented in separate descriptor and data will start
 165            * from next descriptor.
 166            */
 167           if (PREDICT_TRUE
 168               (vif->features & VIRTIO_FEATURE (VIRTIO_F_ANY_LAYOUT)))
 169             id->len = b->current_length + hdr_sz;
 170           else
 171             {
 172               id->len = hdr_sz;
 173               id->flags = VRING_DESC_F_NEXT;
 174               id->next = count;
 175               count++;
 176               id++;
 177               id->addr = vlib_buffer_get_current_pa (vm, b);
 178               id->len = b->current_length;
 179             }
 180           while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
 181             {
 182               id->flags = VRING_DESC_F_NEXT;
 183               id->next = count;
 184               count++;
 185               id++;
 186               b = vlib_get_buffer (vm, b->next_buffer);
 187               id->addr = vlib_buffer_get_current_pa (vm, b);
 188               id->len = b->current_length;
 189             }
 190         }
 191       else                      /* VIRTIO_IF_TYPE_TAP */
 192         {
 193           d->addr = pointer_to_uword (id);
 194           /* first buffer in chain */
 195           id->addr = pointer_to_uword (vlib_buffer_get_current (b)) - hdr_sz;
 196           id->len = b->current_length + hdr_sz;
 197
 198           while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
 199             {
 200               id->flags = VRING_DESC_F_NEXT;
 201               id->next = count;
 202               count++;
 203               id++;
 204               b = vlib_get_buffer (vm, b->next_buffer);
 205               id->addr = pointer_to_uword (vlib_buffer_get_current (b));
 206               id->len = b->current_length;
 207             }
 208         }
 209       id->flags = 0;
 210       id->next = 0;
 211       d->len = count * sizeof (struct vring_desc);
 212       d->flags = VRING_DESC_F_INDIRECT;
 213     }
 214   vring->buffers[next] = bi;
 215   vring->avail->ring[avail & mask] = next;
 216   n_added++;
 217   return n_added;
 218 }
 219
 220 static_always_inline uword
 221 virtio_interface_tx_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
 222                             vlib_frame_t * frame, virtio_if_t * vif)
 223 {
 224   u8 qid = 0;
 225   u16 n_left = frame->n_vectors;
 226   virtio_vring_t *vring = vec_elt_at_index (vif->vrings, (qid << 1) + 1);
 227   u16 used, next, avail;
 228   u16 sz = vring->size;
 229   u16 mask = sz - 1;
 230   u32 *buffers = vlib_frame_vector_args (frame);
 231
 232   clib_spinlock_lock_if_init (&vif->lockp);
 233
 234   if ((vring->used->flags & VIRTIO_RING_FLAG_MASK_INT) == 0 &&
 235       (vring->last_kick_avail_idx != vring->avail->idx))
 236     virtio_kick (vm, vring, vif);
 237
 238   /* free consumed buffers */
 239   virtio_free_used_desc (vm, vring);
 240
 241   used = vring->desc_in_use;
 242   next = vring->desc_next;
 243   avail = vring->avail->idx;
 244
 245   while (n_left && used < sz)
 246     {
 247       u16 n_added = 0;
 248       n_added =
 249         add_buffer_to_slot (vm, vif, vring, buffers[0], avail, next, mask);
 250       if (!n_added)
 251         break;
 252       avail += n_added;
 253       next = (next + n_added) & mask;
 254       used += n_added;
 255       buffers++;
 256       n_left--;
 257     }
 258
 259   if (n_left != frame->n_vectors)
 260     {
 261       CLIB_MEMORY_STORE_BARRIER ();
 262       vring->avail->idx = avail;
 263       vring->desc_next = next;
 264       vring->desc_in_use = used;
 265       if ((vring->used->flags & VIRTIO_RING_FLAG_MASK_INT) == 0)
 266         virtio_kick (vm, vring, vif);
 267     }
 268
 269   if (n_left)
 270     {
 271       vlib_error_count (vm, node->node_index, VIRTIO_TX_ERROR_NO_FREE_SLOTS,
 272                         n_left);
 273       vlib_buffer_free (vm, buffers, n_left);
 274     }
 275
 276   clib_spinlock_unlock_if_init (&vif->lockp);
 277
 278   return frame->n_vectors - n_left;
 279 }
 280
 281 static uword
 282 virtio_interface_tx (vlib_main_t * vm,
 283                      vlib_node_runtime_t * node, vlib_frame_t * frame)
 284 {
 285   virtio_main_t *nm = &virtio_main;
 286   vnet_interface_output_runtime_t *rund = (void *) node->runtime_data;
 287   virtio_if_t *vif = pool_elt_at_index (nm->interfaces, rund->dev_instance);
 288
 289   return virtio_interface_tx_inline (vm, node, frame, vif);
 290 }
 291
 292 static void
 293 virtio_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
 294                                 u32 node_index)
 295 {
 296   virtio_main_t *apm = &virtio_main;
 297   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 298   virtio_if_t *vif = pool_elt_at_index (apm->interfaces, hw->dev_instance);
 299
 300   /* Shut off redirection */
 301   if (node_index == ~0)
 302     {
 303       vif->per_interface_next_index = node_index;
 304       return;
 305     }
 306
 307   vif->per_interface_next_index =
 308     vlib_node_add_next (vlib_get_main (), virtio_input_node.index,
 309                         node_index);
 310 }
 311
 312 static void
 313 virtio_clear_hw_interface_counters (u32 instance)
 314 {
 315   /* Nothing for now */
 316 }
 317
 318 static clib_error_t *
 319 virtio_interface_rx_mode_change (vnet_main_t * vnm, u32 hw_if_index, u32 qid,
 320                                  vnet_hw_interface_rx_mode mode)
 321 {
 322   virtio_main_t *mm = &virtio_main;
 323   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 324   virtio_if_t *vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
 325   virtio_vring_t *vring = vec_elt_at_index (vif->vrings, qid);
 326
 327   if (mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
 328     vring->avail->flags |= VIRTIO_RING_FLAG_MASK_INT;
 329   else
 330     vring->avail->flags &= ~VIRTIO_RING_FLAG_MASK_INT;
 331
 332   return 0;
 333 }
 334
 335 static clib_error_t *
 336 virtio_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 337 {
 338   virtio_main_t *mm = &virtio_main;
 339   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 340   virtio_if_t *vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
 341
 342   if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
 343     vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
 344   else
 345     vif->flags &= ~VIRTIO_IF_FLAG_ADMIN_UP;
 346
 347   return 0;
 348 }
 349
 350 static clib_error_t *
 351 virtio_subif_add_del_function (vnet_main_t * vnm,
 352                                u32 hw_if_index,
 353                                struct vnet_sw_interface_t *st, int is_add)
 354 {
 355   /* Nothing for now */
 356   return 0;
 357 }
 358
 359 /* *INDENT-OFF* */
 360 VNET_DEVICE_CLASS (virtio_device_class) = {
 361   .name = "virtio",
 362   .tx_function = virtio_interface_tx,
 363   .format_device_name = format_virtio_device_name,
 364   .format_device = format_virtio_device,
 365   .format_tx_trace = format_virtio_tx_trace,
 366   .tx_function_n_errors = VIRTIO_TX_N_ERROR,
 367   .tx_function_error_strings = virtio_tx_func_error_strings,
 368   .rx_redirect_to_node = virtio_set_interface_next_node,
 369   .clear_counters = virtio_clear_hw_interface_counters,
 370   .admin_up_down_function = virtio_interface_admin_up_down,
 371   .subif_add_del_function = virtio_subif_add_del_function,
 372   .rx_mode_change_function = virtio_interface_rx_mode_change,
 373 };
 374
 375 VLIB_DEVICE_TX_FUNCTION_MULTIARCH(virtio_device_class,
 376                                   virtio_interface_tx)
 377 /* *INDENT-ON* */
 378
 379 /*
 380  * fd.io coding-style-patch-verification: ON
 381  *
 382  * Local Variables:
 383  * eval: (c-set-style "gnu")
 384  * End:
 385  */