src/vnet/devices/virtio/pci.c

   1 /*
   2  * Copyright (c) 2018 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <fcntl.h>
  17 #include <sys/ioctl.h>
  18
  19 #include <vppinfra/types.h>
  20 #include <vlib/vlib.h>
  21 #include <vlib/pci/pci.h>
  22 #include <vnet/ethernet/ethernet.h>
  23 #include <vnet/ip/ip4_packet.h>
  24 #include <vnet/ip/ip6_packet.h>
  25 #include <vnet/devices/virtio/virtio.h>
  26 #include <vnet/devices/virtio/pci.h>
  27 #include <vnet/interface/rx_queue_funcs.h>
  28
  29 #define PCI_VENDOR_ID_VIRTIO                            0x1af4
  30 #define PCI_DEVICE_ID_VIRTIO_NIC                        0x1000
  31 /* Doesn't support modern device */
  32 #define PCI_DEVICE_ID_VIRTIO_NIC_MODERN                 0x1041
  33
  34 #define PCI_CAPABILITY_LIST     0x34
  35 #define PCI_CAP_ID_VNDR         0x09
  36 #define PCI_CAP_ID_MSIX         0x11
  37
  38 #define PCI_MSIX_ENABLE 0x8000
  39
  40 static pci_device_id_t virtio_pci_device_ids[] = {
  41   {
  42    .vendor_id = PCI_VENDOR_ID_VIRTIO,
  43    .device_id = PCI_DEVICE_ID_VIRTIO_NIC},
  44   {
  45    .vendor_id = PCI_VENDOR_ID_VIRTIO,
  46    .device_id = PCI_DEVICE_ID_VIRTIO_NIC_MODERN},
  47   {0},
  48 };
  49
  50 static u32
  51 virtio_pci_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hw,
  52                         u32 flags)
  53 {
  54   return 0;
  55 }
  56
  57 static clib_error_t *
  58 virtio_pci_get_max_virtqueue_pairs (vlib_main_t * vm, virtio_if_t * vif)
  59 {
  60   clib_error_t *error = 0;
  61   u16 max_queue_pairs = 1;
  62
  63   if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MQ))
  64     {
  65       max_queue_pairs = vif->virtio_pci_func->get_max_queue_pairs (vm, vif);
  66     }
  67
  68   virtio_log_debug (vif, "max queue pair is %x", max_queue_pairs);
  69   if (max_queue_pairs < 1 || max_queue_pairs > 0x8000)
  70     return clib_error_return (error, "max queue pair is %x,"
  71                               " should be in range [1, 0x8000]",
  72                               max_queue_pairs);
  73
  74   vif->max_queue_pairs = max_queue_pairs;
  75   return error;
  76 }
  77
  78 static void
  79 virtio_pci_set_mac (vlib_main_t * vm, virtio_if_t * vif)
  80 {
  81   if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MAC))
  82     vif->virtio_pci_func->set_mac (vm, vif);
  83 }
  84
  85 static u32
  86 virtio_pci_get_mac (vlib_main_t * vm, virtio_if_t * vif)
  87 {
  88   if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MAC))
  89     {
  90       vif->virtio_pci_func->get_mac (vm, vif);
  91       return 0;
  92     }
  93   return 1;
  94 }
  95
  96 static u16
  97 virtio_pci_is_link_up (vlib_main_t * vm, virtio_if_t * vif)
  98 {
  99   /*
 100    * Minimal driver: assumes link is up
 101    */
 102   u16 status = 1;
 103   if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_STATUS))
 104     status = vif->virtio_pci_func->get_device_status (vm, vif);
 105   return status;
 106 }
 107
 108 static void
 109 virtio_pci_irq_queue_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
 110                               u16 line)
 111 {
 112   vnet_main_t *vnm = vnet_get_main ();
 113   virtio_main_t *vim = &virtio_main;
 114   uword pd = vlib_pci_get_private_data (vm, h);
 115   virtio_if_t *vif = pool_elt_at_index (vim->interfaces, pd);
 116   line--;
 117   u16 qid = line;
 118
 119   vnet_virtio_vring_t *vring = vec_elt_at_index (vif->rxq_vrings, qid);
 120   vnet_hw_if_rx_queue_set_int_pending (vnm, vring->queue_index);
 121 }
 122
 123 static void
 124 virtio_pci_irq_config_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
 125                                u16 line)
 126 {
 127   vnet_main_t *vnm = vnet_get_main ();
 128   virtio_main_t *vim = &virtio_main;
 129   uword pd = vlib_pci_get_private_data (vm, h);
 130   virtio_if_t *vif = pool_elt_at_index (vim->interfaces, pd);
 131
 132   if (virtio_pci_is_link_up (vm, vif) & VIRTIO_NET_S_LINK_UP)
 133     {
 134       vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
 135                                    VNET_HW_INTERFACE_FLAG_LINK_UP);
 136     }
 137   else
 138     {
 139       vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
 140     }
 141 }
 142
 143 static void
 144 virtio_pci_irq_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h)
 145 {
 146   virtio_main_t *vim = &virtio_main;
 147   uword pd = vlib_pci_get_private_data (vm, h);
 148   virtio_if_t *vif = pool_elt_at_index (vim->interfaces, pd);
 149   u8 isr = 0;
 150   u16 line = 0;
 151
 152   isr = vif->virtio_pci_func->get_isr (vm, vif);
 153
 154   /*
 155    * If the lower bit is set: look through the used rings of
 156    * all virtqueues for the device, to see if any progress has
 157    * been made by the device which requires servicing.
 158    */
 159   if (isr & VIRTIO_PCI_ISR_INTR)
 160     {
 161       for (; line < vif->num_rxqs; line++)
 162         virtio_pci_irq_queue_handler (vm, h, (line + 1));
 163     }
 164
 165   if (isr & VIRTIO_PCI_ISR_CONFIG)
 166     virtio_pci_irq_config_handler (vm, h, line);
 167 }
 168
 169 inline void
 170 device_status (vlib_main_t * vm, virtio_if_t * vif)
 171 {
 172   struct status_struct
 173   {
 174     u8 bit;
 175     char *str;
 176   };
 177   struct status_struct *status_entry;
 178   static struct status_struct status_array[] = {
 179 #define _(s,b) { .str = #s, .bit = b, },
 180     foreach_virtio_config_status_flags
 181 #undef _
 182     {.str = NULL}
 183   };
 184
 185   vlib_cli_output (vm, "  status 0x%x", vif->status);
 186
 187   status_entry = (struct status_struct *) &status_array;
 188   while (status_entry->str)
 189     {
 190       if (vif->status & status_entry->bit)
 191         vlib_cli_output (vm, "    %s (%x)", status_entry->str,
 192                          status_entry->bit);
 193       status_entry++;
 194     }
 195 }
 196
 197 static int
 198 virtio_pci_send_ctrl_msg_packed (vlib_main_t * vm, virtio_if_t * vif,
 199                                  virtio_ctrl_msg_t * data, u32 len)
 200 {
 201   vnet_virtio_vring_t *vring = vif->cxq_vring;
 202   virtio_net_ctrl_ack_t status = VIRTIO_NET_ERR;
 203   virtio_ctrl_msg_t result;
 204   u32 buffer_index;
 205   vlib_buffer_t *b;
 206   u16 used, next;
 207   u16 sz = vring->queue_size;
 208   u16 flags = 0, first_desc_flags = 0;
 209
 210   used = vring->desc_in_use;
 211   next = vring->desc_next;
 212   vnet_virtio_vring_packed_desc_t *d = &vring->packed_desc[next];
 213
 214   if (vlib_buffer_alloc (vm, &buffer_index, 1))
 215     b = vlib_get_buffer (vm, buffer_index);
 216   else
 217     return VIRTIO_NET_ERR;
 218   /*
 219    * current_data may not be initialized with 0 and may contain
 220    * previous offset.
 221    */
 222   b->current_data = 0;
 223   clib_memcpy (vlib_buffer_get_current (b), data, sizeof (virtio_ctrl_msg_t));
 224
 225   first_desc_flags = VRING_DESC_F_NEXT;
 226   if (vring->avail_wrap_counter)
 227     {
 228       first_desc_flags |= VRING_DESC_F_AVAIL;
 229       first_desc_flags &= ~VRING_DESC_F_USED;
 230     }
 231   else
 232     {
 233       first_desc_flags &= ~VRING_DESC_F_AVAIL;
 234       first_desc_flags |= VRING_DESC_F_USED;
 235     }
 236   d->addr = vlib_buffer_get_current_pa (vm, b);
 237   d->len = sizeof (virtio_net_ctrl_hdr_t);
 238   d->id = next;
 239
 240   next++;
 241   if (next >= sz)
 242     {
 243       next = 0;
 244       vring->avail_wrap_counter ^= 1;
 245     }
 246   used++;
 247
 248   d = &vring->packed_desc[next];
 249   flags = VRING_DESC_F_NEXT;
 250   if (vring->avail_wrap_counter)
 251     {
 252       flags |= VRING_DESC_F_AVAIL;
 253       flags &= ~VRING_DESC_F_USED;
 254     }
 255   else
 256     {
 257       flags &= ~VRING_DESC_F_AVAIL;
 258       flags |= VRING_DESC_F_USED;
 259     }
 260   d->addr = vlib_buffer_get_current_pa (vm, b) +
 261     STRUCT_OFFSET_OF (virtio_ctrl_msg_t, data);
 262   d->len = len;
 263   d->id = next;
 264   d->flags = flags;
 265
 266   next++;
 267   if (next >= sz)
 268     {
 269       next = 0;
 270       vring->avail_wrap_counter ^= 1;
 271     }
 272   used++;
 273
 274   d = &vring->packed_desc[next];
 275   flags = VRING_DESC_F_WRITE;
 276   if (vring->avail_wrap_counter)
 277     {
 278       flags |= VRING_DESC_F_AVAIL;
 279       flags &= ~VRING_DESC_F_USED;
 280     }
 281   else
 282     {
 283       flags &= ~VRING_DESC_F_AVAIL;
 284       flags |= VRING_DESC_F_USED;
 285     }
 286   d->addr = vlib_buffer_get_current_pa (vm, b) +
 287     STRUCT_OFFSET_OF (virtio_ctrl_msg_t, status);
 288   d->len = sizeof (data->status);
 289   d->id = next;
 290   d->flags = flags;
 291
 292   next++;
 293   if (next >= sz)
 294     {
 295       next = 0;
 296       vring->avail_wrap_counter ^= 1;
 297     }
 298   used++;
 299
 300   CLIB_MEMORY_STORE_BARRIER ();
 301   vring->packed_desc[vring->desc_next].flags = first_desc_flags;
 302   vring->desc_next = next;
 303   vring->desc_in_use = used;
 304   CLIB_MEMORY_BARRIER ();
 305   if (vring->device_event->flags != VRING_EVENT_F_DISABLE)
 306     {
 307       virtio_kick (vm, vring, vif);
 308     }
 309
 310   u16 last = vring->last_used_idx;
 311   d = &vring->packed_desc[last];
 312   do
 313     {
 314       flags = d->flags;
 315     }
 316   while ((flags & VRING_DESC_F_AVAIL) != (vring->used_wrap_counter << 7)
 317          || (flags & VRING_DESC_F_USED) != (vring->used_wrap_counter << 15));
 318
 319   last += 3;
 320   if (last >= vring->queue_size)
 321     {
 322       last = last - vring->queue_size;
 323       vring->used_wrap_counter ^= 1;
 324     }
 325   vring->desc_in_use -= 3;
 326   vring->last_used_idx = last;
 327
 328   CLIB_MEMORY_BARRIER ();
 329   clib_memcpy (&result, vlib_buffer_get_current (b),
 330                sizeof (virtio_ctrl_msg_t));
 331   virtio_log_debug (vif, "ctrl-queue: status %u", result.status);
 332   status = result.status;
 333   vlib_buffer_free (vm, &buffer_index, 1);
 334   return status;
 335 }
 336
 337 static int
 338 virtio_pci_send_ctrl_msg_split (vlib_main_t * vm, virtio_if_t * vif,
 339                                 virtio_ctrl_msg_t * data, u32 len)
 340 {
 341   vnet_virtio_vring_t *vring = vif->cxq_vring;
 342   virtio_net_ctrl_ack_t status = VIRTIO_NET_ERR;
 343   virtio_ctrl_msg_t result;
 344   u32 buffer_index;
 345   vlib_buffer_t *b;
 346   u16 used, next, avail;
 347   u16 sz = vring->queue_size;
 348   u16 mask = sz - 1;
 349
 350   used = vring->desc_in_use;
 351   next = vring->desc_next;
 352   avail = vring->avail->idx;
 353   vnet_virtio_vring_desc_t *d = &vring->desc[next];
 354
 355   if (vlib_buffer_alloc (vm, &buffer_index, 1))
 356     b = vlib_get_buffer (vm, buffer_index);
 357   else
 358     return VIRTIO_NET_ERR;
 359   /*
 360    * current_data may not be initialized with 0 and may contain
 361    * previous offset.
 362    */
 363   b->current_data = 0;
 364   clib_memcpy (vlib_buffer_get_current (b), data, sizeof (virtio_ctrl_msg_t));
 365   d->flags = VRING_DESC_F_NEXT;
 366   d->addr = vlib_buffer_get_current_pa (vm, b);
 367   d->len = sizeof (virtio_net_ctrl_hdr_t);
 368   vring->avail->ring[avail & mask] = next;
 369   avail++;
 370   next = (next + 1) & mask;
 371   d->next = next;
 372   used++;
 373
 374   d = &vring->desc[next];
 375   d->flags = VRING_DESC_F_NEXT;
 376   d->addr = vlib_buffer_get_current_pa (vm, b) +
 377     STRUCT_OFFSET_OF (virtio_ctrl_msg_t, data);
 378   d->len = len;
 379   next = (next + 1) & mask;
 380   d->next = next;
 381   used++;
 382
 383   d = &vring->desc[next];
 384   d->flags = VRING_DESC_F_WRITE;
 385   d->addr = vlib_buffer_get_current_pa (vm, b) +
 386     STRUCT_OFFSET_OF (virtio_ctrl_msg_t, status);
 387   d->len = sizeof (data->status);
 388   next = (next + 1) & mask;
 389   used++;
 390
 391   CLIB_MEMORY_STORE_BARRIER ();
 392   vring->avail->idx = avail;
 393   vring->desc_next = next;
 394   vring->desc_in_use = used;
 395
 396   if ((vring->used->flags & VIRTIO_RING_FLAG_MASK_INT) == 0)
 397     {
 398       virtio_kick (vm, vring, vif);
 399     }
 400
 401   u16 last = vring->last_used_idx, n_left = 0;
 402   n_left = vring->used->idx - last;
 403
 404   while (n_left)
 405     {
 406       vnet_virtio_vring_used_elem_t *e = &vring->used->ring[last & mask];
 407       u16 slot = e->id;
 408
 409       d = &vring->desc[slot];
 410       while (d->flags & VRING_DESC_F_NEXT)
 411         {
 412           used--;
 413           slot = d->next;
 414           d = &vring->desc[slot];
 415         }
 416       used--;
 417       last++;
 418       n_left--;
 419     }
 420   vring->desc_in_use = used;
 421   vring->last_used_idx = last;
 422
 423   CLIB_MEMORY_BARRIER ();
 424   clib_memcpy (&result, vlib_buffer_get_current (b),
 425                sizeof (virtio_ctrl_msg_t));
 426   virtio_log_debug (vif, "ctrl-queue: status %u", result.status);
 427   status = result.status;
 428   vlib_buffer_free (vm, &buffer_index, 1);
 429   return status;
 430 }
 431
 432 static int
 433 virtio_pci_send_ctrl_msg (vlib_main_t * vm, virtio_if_t * vif,
 434                           virtio_ctrl_msg_t * data, u32 len)
 435 {
 436   if (vif->is_packed)
 437     return virtio_pci_send_ctrl_msg_packed (vm, vif, data, len);
 438   else
 439     return virtio_pci_send_ctrl_msg_split (vm, vif, data, len);
 440 }
 441
 442 static int
 443 virtio_pci_disable_offload (vlib_main_t * vm, virtio_if_t * vif)
 444 {
 445   virtio_ctrl_msg_t offload_hdr;
 446   virtio_net_ctrl_ack_t status = VIRTIO_NET_ERR;
 447
 448   offload_hdr.ctrl.class = VIRTIO_NET_CTRL_GUEST_OFFLOADS;
 449   offload_hdr.ctrl.cmd = VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET;
 450   offload_hdr.status = VIRTIO_NET_ERR;
 451   u64 offloads = 0ULL;
 452   clib_memcpy (offload_hdr.data, &offloads, sizeof (offloads));
 453
 454   status =
 455     virtio_pci_send_ctrl_msg (vm, vif, &offload_hdr, sizeof (offloads));
 456   virtio_log_debug (vif, "disable offloads");
 457   vif->remote_features = vif->virtio_pci_func->get_device_features (vm, vif);
 458   vif->virtio_pci_func->get_driver_features (vm, vif);
 459   return status;
 460 }
 461
 462 static int
 463 virtio_pci_enable_checksum_offload (vlib_main_t * vm, virtio_if_t * vif)
 464 {
 465   virtio_ctrl_msg_t csum_offload_hdr;
 466   virtio_net_ctrl_ack_t status = VIRTIO_NET_ERR;
 467
 468   csum_offload_hdr.ctrl.class = VIRTIO_NET_CTRL_GUEST_OFFLOADS;
 469   csum_offload_hdr.ctrl.cmd = VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET;
 470   csum_offload_hdr.status = VIRTIO_NET_ERR;
 471   u64 offloads = 0ULL;
 472   offloads |= VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_CSUM);
 473   clib_memcpy (csum_offload_hdr.data, &offloads, sizeof (offloads));
 474
 475   status =
 476     virtio_pci_send_ctrl_msg (vm, vif, &csum_offload_hdr, sizeof (offloads));
 477   virtio_log_debug (vif, "enable checksum offload");
 478   vif->remote_features = vif->virtio_pci_func->get_device_features (vm, vif);
 479   vif->features = vif->virtio_pci_func->get_driver_features (vm, vif);
 480   return status;
 481 }
 482
 483 static int
 484 virtio_pci_enable_gso (vlib_main_t * vm, virtio_if_t * vif)
 485 {
 486   virtio_ctrl_msg_t gso_hdr;
 487   virtio_net_ctrl_ack_t status = VIRTIO_NET_ERR;
 488
 489   gso_hdr.ctrl.class = VIRTIO_NET_CTRL_GUEST_OFFLOADS;
 490   gso_hdr.ctrl.cmd = VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET;
 491   gso_hdr.status = VIRTIO_NET_ERR;
 492   u64 offloads = VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_CSUM)
 493     | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO4)
 494     | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO6);
 495   clib_memcpy (gso_hdr.data, &offloads, sizeof (offloads));
 496
 497   status = virtio_pci_send_ctrl_msg (vm, vif, &gso_hdr, sizeof (offloads));
 498   virtio_log_debug (vif, "enable gso");
 499   vif->remote_features = vif->virtio_pci_func->get_device_features (vm, vif);
 500   vif->virtio_pci_func->get_driver_features (vm, vif);
 501   return status;
 502 }
 503
 504 static int
 505 virtio_pci_offloads (vlib_main_t * vm, virtio_if_t * vif, int gso_enabled,
 506                      int csum_offload_enabled)
 507 {
 508   vnet_main_t *vnm = vnet_get_main ();
 509   vnet_hw_if_caps_change_t cc = {};
 510
 511   if ((vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ)) &&
 512       (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_GUEST_OFFLOADS)))
 513     {
 514       if (gso_enabled
 515           && (vif->features & (VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO4) |
 516                                VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO6))))
 517         {
 518           if (virtio_pci_enable_gso (vm, vif))
 519             {
 520               virtio_log_warning (vif, "gso is not enabled");
 521             }
 522           else
 523             {
 524               vif->gso_enabled = 1;
 525               vif->csum_offload_enabled = 1;
 526               cc.val = cc.mask = VNET_HW_IF_CAP_TCP_GSO |
 527                                  VNET_HW_IF_CAP_TX_TCP_CKSUM |
 528                                  VNET_HW_IF_CAP_TX_UDP_CKSUM;
 529             }
 530         }
 531       else if (csum_offload_enabled
 532                && (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CSUM)))
 533         {
 534           if (virtio_pci_enable_checksum_offload (vm, vif))
 535             {
 536               virtio_log_warning (vif, "checksum offload is not enabled");
 537             }
 538           else
 539             {
 540               vif->csum_offload_enabled = 1;
 541               vif->gso_enabled = 0;
 542               cc.val =
 543                 VNET_HW_IF_CAP_TX_TCP_CKSUM | VNET_HW_IF_CAP_TX_UDP_CKSUM;
 544               cc.mask = VNET_HW_IF_CAP_TCP_GSO | VNET_HW_IF_CAP_TX_TCP_CKSUM |
 545                         VNET_HW_IF_CAP_TX_UDP_CKSUM;
 546             }
 547         }
 548       else
 549         {
 550           if (virtio_pci_disable_offload (vm, vif))
 551             {
 552               virtio_log_warning (vif, "offloads are not disabled");
 553             }
 554           else
 555             {
 556               vif->csum_offload_enabled = 0;
 557               vif->gso_enabled = 0;
 558               cc.val = 0;
 559               cc.mask = VNET_HW_IF_CAP_L4_TX_CKSUM | VNET_HW_IF_CAP_TCP_GSO;
 560             }
 561         }
 562     }
 563
 564   if (cc.mask)
 565     vnet_hw_if_change_caps (vnm, vif->hw_if_index, &cc);
 566
 567   return 0;
 568 }
 569
 570 static int
 571 virtio_pci_enable_multiqueue (vlib_main_t * vm, virtio_if_t * vif,
 572                               u16 num_queues)
 573 {
 574   virtio_ctrl_msg_t mq_hdr;
 575   virtio_net_ctrl_ack_t status = VIRTIO_NET_ERR;
 576
 577   mq_hdr.ctrl.class = VIRTIO_NET_CTRL_MQ;
 578   mq_hdr.ctrl.cmd = VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET;
 579   mq_hdr.status = VIRTIO_NET_ERR;
 580   clib_memcpy (mq_hdr.data, &num_queues, sizeof (num_queues));
 581
 582   status = virtio_pci_send_ctrl_msg (vm, vif, &mq_hdr, sizeof (num_queues));
 583   virtio_log_debug (vif, "multi-queue enable %u queues", num_queues);
 584   return status;
 585 }
 586
 587 static u8
 588 virtio_pci_queue_size_valid (u16 qsz)
 589 {
 590   if (qsz < 64 || qsz > 4096)
 591     return 0;
 592   if ((qsz % 64) != 0)
 593     return 0;
 594   return 1;
 595 }
 596
 597 clib_error_t *
 598 virtio_pci_control_vring_packed_init (vlib_main_t * vm, virtio_if_t * vif,
 599                                       u16 queue_num)
 600 {
 601   clib_error_t *error = 0;
 602   u16 queue_size = 0;
 603   vnet_virtio_vring_t *vring;
 604   u32 i = 0;
 605   void *ptr = NULL;
 606
 607   queue_size = vif->virtio_pci_func->get_queue_size (vm, vif, queue_num);
 608
 609   if (queue_size > 32768)
 610     return clib_error_return (0, "ring size must be 32768 or lower");
 611
 612   if (queue_size == 0)
 613     queue_size = 256;
 614
 615   vec_validate_aligned (vif->cxq_vring, 0, CLIB_CACHE_LINE_BYTES);
 616   vring = vec_elt_at_index (vif->cxq_vring, 0);
 617
 618   i = (((queue_size * sizeof (vnet_virtio_vring_packed_desc_t)) +
 619         sizeof (vnet_virtio_vring_desc_event_t) + VNET_VIRTIO_PCI_VRING_ALIGN -
 620         1) &
 621        ~(VNET_VIRTIO_PCI_VRING_ALIGN - 1)) +
 622       sizeof (vnet_virtio_vring_desc_event_t);
 623
 624   ptr = vlib_physmem_alloc_aligned_on_numa (vm, i, VNET_VIRTIO_PCI_VRING_ALIGN,
 625                                             vif->numa_node);
 626   if (!ptr)
 627     return vlib_physmem_last_error (vm);
 628   clib_memset (ptr, 0, i);
 629
 630   vring->packed_desc = ptr;
 631
 632   vring->driver_event =
 633     ptr + (queue_size * sizeof (vnet_virtio_vring_packed_desc_t));
 634   vring->driver_event->off_wrap = 0;
 635   vring->driver_event->flags = VRING_EVENT_F_DISABLE;
 636
 637   vring->device_event =
 638     ptr + (((queue_size * sizeof (vnet_virtio_vring_packed_desc_t)) +
 639             sizeof (vnet_virtio_vring_desc_event_t) +
 640             VNET_VIRTIO_PCI_VRING_ALIGN - 1) &
 641            ~(VNET_VIRTIO_PCI_VRING_ALIGN - 1));
 642   vring->device_event->off_wrap = 0;
 643   vring->device_event->flags = 0;
 644
 645   vring->queue_id = queue_num;
 646   vring->queue_size = queue_size;
 647   vring->avail_wrap_counter = 1;
 648   vring->used_wrap_counter = 1;
 649
 650   ASSERT (vring->buffers == 0);
 651
 652   virtio_log_debug (vif, "control-queue: number %u, size %u", queue_num,
 653                     queue_size);
 654   vif->virtio_pci_func->setup_queue (vm, vif, queue_num, vring);
 655   vring->queue_notify_offset =
 656     vif->notify_off_multiplier *
 657     vif->virtio_pci_func->get_queue_notify_off (vm, vif, queue_num);
 658   virtio_log_debug (vif, "queue-notify-offset: number %u, offset %u",
 659                     queue_num, vring->queue_notify_offset);
 660   return error;
 661 }
 662
 663 clib_error_t *
 664 virtio_pci_control_vring_split_init (vlib_main_t * vm, virtio_if_t * vif,
 665                                      u16 queue_num)
 666 {
 667   clib_error_t *error = 0;
 668   u16 queue_size = 0;
 669   vnet_virtio_vring_t *vring;
 670   u32 i = 0;
 671   void *ptr = NULL;
 672
 673   queue_size = vif->virtio_pci_func->get_queue_size (vm, vif, queue_num);
 674   if (!virtio_pci_queue_size_valid (queue_size))
 675     clib_warning ("queue size is not valid");
 676
 677   if (!is_pow2 (queue_size))
 678     return clib_error_return (0, "ring size must be power of 2");
 679
 680   if (queue_size > 32768)
 681     return clib_error_return (0, "ring size must be 32768 or lower");
 682
 683   if (queue_size == 0)
 684     queue_size = 256;
 685
 686   vec_validate_aligned (vif->cxq_vring, 0, CLIB_CACHE_LINE_BYTES);
 687   vring = vec_elt_at_index (vif->cxq_vring, 0);
 688   i = vnet_virtio_vring_size (queue_size, VNET_VIRTIO_PCI_VRING_ALIGN);
 689   i = round_pow2 (i, VNET_VIRTIO_PCI_VRING_ALIGN);
 690   ptr = vlib_physmem_alloc_aligned_on_numa (vm, i, VNET_VIRTIO_PCI_VRING_ALIGN,
 691                                             vif->numa_node);
 692   if (!ptr)
 693     return vlib_physmem_last_error (vm);
 694   clib_memset (ptr, 0, i);
 695   vnet_virtio_vring_init (vring, queue_size, ptr, VNET_VIRTIO_PCI_VRING_ALIGN);
 696   vring->queue_id = queue_num;
 697
 698   ASSERT (vring->buffers == 0);
 699   virtio_log_debug (vif, "control-queue: number %u, size %u", queue_num,
 700                     queue_size);
 701   vif->virtio_pci_func->setup_queue (vm, vif, queue_num, vring);
 702   vring->queue_notify_offset =
 703     vif->notify_off_multiplier *
 704     vif->virtio_pci_func->get_queue_notify_off (vm, vif, queue_num);
 705   virtio_log_debug (vif, "queue-notify-offset: number %u, offset %u",
 706                     queue_num, vring->queue_notify_offset);
 707
 708   return error;
 709 }
 710
 711 clib_error_t *
 712 virtio_pci_control_vring_init (vlib_main_t * vm, virtio_if_t * vif,
 713                                u16 queue_num)
 714 {
 715   if (vif->is_packed)
 716     return virtio_pci_control_vring_packed_init (vm, vif, queue_num);
 717   else
 718     return virtio_pci_control_vring_split_init (vm, vif, queue_num);
 719 }
 720
 721 clib_error_t *
 722 virtio_pci_vring_split_init (vlib_main_t * vm, virtio_if_t * vif,
 723                              u16 queue_num)
 724 {
 725   clib_error_t *error = 0;
 726   u16 queue_size = 0;
 727   vnet_virtio_vring_t *vring;
 728   u32 i = 0;
 729   void *ptr = NULL;
 730
 731   queue_size = vif->virtio_pci_func->get_queue_size (vm, vif, queue_num);
 732   if (!virtio_pci_queue_size_valid (queue_size))
 733     clib_warning ("queue size is not valid");
 734
 735   if (!is_pow2 (queue_size))
 736     return clib_error_return (0, "ring size must be power of 2");
 737
 738   if (queue_size > 32768)
 739     return clib_error_return (0, "ring size must be 32768 or lower");
 740
 741   if (queue_size == 0)
 742     queue_size = 256;
 743
 744   if (queue_num % 2)
 745     {
 746       vec_validate_aligned (vif->txq_vrings, TX_QUEUE_ACCESS (queue_num),
 747                             CLIB_CACHE_LINE_BYTES);
 748       vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (queue_num));
 749       clib_spinlock_init (&vring->lockp);
 750     }
 751   else
 752     {
 753       vec_validate_aligned (vif->rxq_vrings, RX_QUEUE_ACCESS (queue_num),
 754                             CLIB_CACHE_LINE_BYTES);
 755       vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (queue_num));
 756     }
 757   i = vnet_virtio_vring_size (queue_size, VNET_VIRTIO_PCI_VRING_ALIGN);
 758   i = round_pow2 (i, VNET_VIRTIO_PCI_VRING_ALIGN);
 759   ptr = vlib_physmem_alloc_aligned_on_numa (vm, i, VNET_VIRTIO_PCI_VRING_ALIGN,
 760                                             vif->numa_node);
 761   if (!ptr)
 762     return vlib_physmem_last_error (vm);
 763   clib_memset (ptr, 0, i);
 764   vnet_virtio_vring_init (vring, queue_size, ptr, VNET_VIRTIO_PCI_VRING_ALIGN);
 765   vring->queue_id = queue_num;
 766   vring->avail->flags = VIRTIO_RING_FLAG_MASK_INT;
 767   vring->flow_table = 0;
 768
 769   ASSERT (vring->buffers == 0);
 770   vec_validate_aligned (vring->buffers, queue_size, CLIB_CACHE_LINE_BYTES);
 771   if (queue_num % 2)
 772     {
 773       virtio_log_debug (vif, "tx-queue: number %u, size %u", queue_num,
 774                         queue_size);
 775       clib_memset_u32 (vring->buffers, ~0, queue_size);
 776     }
 777   else
 778     {
 779       virtio_log_debug (vif, "rx-queue: number %u, size %u", queue_num,
 780                         queue_size);
 781     }
 782   vring->queue_size = queue_size;
 783   if (vif->virtio_pci_func->setup_queue (vm, vif, queue_num, vring))
 784     return clib_error_return (0, "error in queue address setup");
 785
 786   vring->queue_notify_offset =
 787     vif->notify_off_multiplier *
 788     vif->virtio_pci_func->get_queue_notify_off (vm, vif, queue_num);
 789   virtio_log_debug (vif, "queue-notify-offset: number %u, offset %u",
 790                     queue_num, vring->queue_notify_offset);
 791   return error;
 792 }
 793
 794 clib_error_t *
 795 virtio_pci_vring_packed_init (vlib_main_t * vm, virtio_if_t * vif,
 796                               u16 queue_num)
 797 {
 798   clib_error_t *error = 0;
 799   u16 queue_size = 0;
 800   vnet_virtio_vring_t *vring;
 801   u32 i = 0;
 802   void *ptr = NULL;
 803
 804   queue_size = vif->virtio_pci_func->get_queue_size (vm, vif, queue_num);
 805
 806   if (queue_size > 32768)
 807     return clib_error_return (0, "ring size must be 32768 or lower");
 808
 809   if (queue_size == 0)
 810     queue_size = 256;
 811
 812   if (queue_num % 2)
 813     {
 814       vec_validate_aligned (vif->txq_vrings, TX_QUEUE_ACCESS (queue_num),
 815                             CLIB_CACHE_LINE_BYTES);
 816       vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (queue_num));
 817       clib_spinlock_init (&vring->lockp);
 818     }
 819   else
 820     {
 821       vec_validate_aligned (vif->rxq_vrings, RX_QUEUE_ACCESS (queue_num),
 822                             CLIB_CACHE_LINE_BYTES);
 823       vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (queue_num));
 824     }
 825
 826   i = (((queue_size * sizeof (vnet_virtio_vring_packed_desc_t)) +
 827         sizeof (vnet_virtio_vring_desc_event_t) + VNET_VIRTIO_PCI_VRING_ALIGN -
 828         1) &
 829        ~(VNET_VIRTIO_PCI_VRING_ALIGN - 1)) +
 830       sizeof (vnet_virtio_vring_desc_event_t);
 831
 832   ptr = vlib_physmem_alloc_aligned_on_numa (vm, i, VNET_VIRTIO_PCI_VRING_ALIGN,
 833                                             vif->numa_node);
 834   if (!ptr)
 835     return vlib_physmem_last_error (vm);
 836
 837   clib_memset (ptr, 0, i);
 838   vring->packed_desc = ptr;
 839
 840   vring->driver_event =
 841     ptr + (queue_size * sizeof (vnet_virtio_vring_packed_desc_t));
 842   vring->driver_event->off_wrap = 0;
 843   vring->driver_event->flags = VRING_EVENT_F_DISABLE;
 844
 845   vring->device_event =
 846     ptr + (((queue_size * sizeof (vnet_virtio_vring_packed_desc_t)) +
 847             sizeof (vnet_virtio_vring_desc_event_t) +
 848             VNET_VIRTIO_PCI_VRING_ALIGN - 1) &
 849            ~(VNET_VIRTIO_PCI_VRING_ALIGN - 1));
 850   vring->device_event->off_wrap = 0;
 851   vring->device_event->flags = 0;
 852
 853   vring->queue_id = queue_num;
 854
 855   vring->avail_wrap_counter = 1;
 856   vring->used_wrap_counter = 1;
 857
 858   ASSERT (vring->buffers == 0);
 859   vec_validate_aligned (vring->buffers, queue_size, CLIB_CACHE_LINE_BYTES);
 860   if (queue_num % 2)
 861     {
 862       virtio_log_debug (vif, "tx-queue: number %u, size %u", queue_num,
 863                         queue_size);
 864       clib_memset_u32 (vring->buffers, ~0, queue_size);
 865     }
 866   else
 867     {
 868       virtio_log_debug (vif, "rx-queue: number %u, size %u", queue_num,
 869                         queue_size);
 870     }
 871   vring->queue_size = queue_size;
 872   if (vif->virtio_pci_func->setup_queue (vm, vif, queue_num, vring))
 873     return clib_error_return (0, "error in queue address setup");
 874
 875   vring->queue_notify_offset =
 876     vif->notify_off_multiplier *
 877     vif->virtio_pci_func->get_queue_notify_off (vm, vif, queue_num);
 878   virtio_log_debug (vif, "queue-notify-offset: number %u, offset %u",
 879                     queue_num, vring->queue_notify_offset);
 880
 881   return error;
 882 }
 883
 884 clib_error_t *
 885 virtio_pci_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 queue_num)
 886 {
 887   if (vif->is_packed)
 888     return virtio_pci_vring_packed_init (vm, vif, queue_num);
 889   else
 890     return virtio_pci_vring_split_init (vm, vif, queue_num);
 891 }
 892
 893 static void
 894 virtio_negotiate_features (vlib_main_t * vm, virtio_if_t * vif,
 895                            u64 req_features)
 896 {
 897   /*
 898    * if features are not requested
 899    * default: all supported features
 900    */
 901   u64 supported_features = VIRTIO_FEATURE (VIRTIO_NET_F_CSUM)
 902     | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_CSUM)
 903     | VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_GUEST_OFFLOADS)
 904     | VIRTIO_FEATURE (VIRTIO_NET_F_MTU)
 905     | VIRTIO_FEATURE (VIRTIO_NET_F_MAC)
 906     | VIRTIO_FEATURE (VIRTIO_NET_F_GSO)
 907     | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO4)
 908     | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO6)
 909     | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_UFO)
 910     | VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO4)
 911     | VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO6)
 912     | VIRTIO_FEATURE (VIRTIO_NET_F_HOST_UFO)
 913     | VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF)
 914     | VIRTIO_FEATURE (VIRTIO_NET_F_STATUS)
 915     | VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ)
 916     | VIRTIO_FEATURE (VIRTIO_NET_F_MQ)
 917     | VIRTIO_FEATURE (VIRTIO_F_NOTIFY_ON_EMPTY)
 918     | VIRTIO_FEATURE (VIRTIO_F_ANY_LAYOUT)
 919     | VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);
 920
 921   if (vif->is_modern)
 922     supported_features |= VIRTIO_FEATURE (VIRTIO_F_VERSION_1);
 923
 924   if (vif->is_packed)
 925     {
 926       supported_features |=
 927         (VIRTIO_FEATURE (VIRTIO_F_RING_PACKED) |
 928          VIRTIO_FEATURE (VIRTIO_F_IN_ORDER));
 929     }
 930
 931   if (req_features == 0)
 932     {
 933       req_features = supported_features;
 934     }
 935
 936   vif->features = req_features & vif->remote_features & supported_features;
 937
 938   if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MTU))
 939     {
 940       u16 mtu = 0;
 941       mtu = vif->virtio_pci_func->get_mtu (vm, vif);
 942
 943       if (mtu < 64)
 944         vif->features &= ~VIRTIO_FEATURE (VIRTIO_NET_F_MTU);
 945     }
 946
 947   if ((vif->features & (VIRTIO_FEATURE (VIRTIO_F_RING_PACKED))) == 0)
 948     vif->is_packed = 0;
 949
 950   vif->virtio_pci_func->set_driver_features (vm, vif, vif->features);
 951   vif->features = vif->virtio_pci_func->get_driver_features (vm, vif);
 952 }
 953
 954 void
 955 virtio_pci_read_device_feature (vlib_main_t * vm, virtio_if_t * vif)
 956 {
 957   vif->remote_features = vif->virtio_pci_func->get_device_features (vm, vif);
 958 }
 959
 960 int
 961 virtio_pci_reset_device (vlib_main_t * vm, virtio_if_t * vif)
 962 {
 963   u8 status = 0;
 964
 965   /*
 966    * Reset the device
 967    */
 968   status = vif->virtio_pci_func->device_reset (vm, vif);
 969
 970   /*
 971    * Set the Acknowledge status bit
 972    */
 973   vif->virtio_pci_func->set_status (vm, vif, VIRTIO_CONFIG_STATUS_ACK);
 974
 975   /*
 976    * Set the Driver status bit
 977    */
 978   vif->virtio_pci_func->set_status (vm, vif, VIRTIO_CONFIG_STATUS_DRIVER);
 979
 980   /*
 981    * Read the status and verify it
 982    */
 983   status = vif->virtio_pci_func->get_status (vm, vif);
 984   if ((status & VIRTIO_CONFIG_STATUS_ACK)
 985       && (status & VIRTIO_CONFIG_STATUS_DRIVER))
 986     vif->status = status;
 987   else
 988     return -1;
 989
 990   return 0;
 991 }
 992
 993 clib_error_t *
 994 virtio_pci_read_caps (vlib_main_t * vm, virtio_if_t * vif, void **bar)
 995 {
 996   clib_error_t *error = 0;
 997   virtio_pci_cap_t cap;
 998   u8 pos, common_cfg = 0, notify = 0, dev_cfg = 0, isr = 0, pci_cfg = 0;
 999   vlib_pci_dev_handle_t h = vif->pci_dev_handle;
1000
1001   if ((error = vlib_pci_read_config_u8 (vm, h, PCI_CAPABILITY_LIST, &pos)))
1002     {
1003       virtio_log_error (vif, "error in reading capabilty list position");
1004       return clib_error_return (error,
1005                                 "error in reading capabilty list position");
1006     }
1007   while (pos)
1008     {
1009       if ((error =
1010            vlib_pci_read_write_config (vm, h, VLIB_READ, pos, &cap,
1011                                        sizeof (cap))))
1012         {
1013           virtio_log_error (vif, "%s [%2x]",
1014                             "error in reading the capability at", pos);
1015           return clib_error_return (error,
1016                                     "error in reading the capability at [%2x]",
1017                                     pos);
1018         }
1019
1020       if (cap.cap_vndr == PCI_CAP_ID_MSIX)
1021         {
1022           u16 flags, table_size, table_size_mask = 0x07FF;
1023
1024           if ((error =
1025                vlib_pci_read_write_config (vm, h, VLIB_READ, pos + 2, &flags,
1026                                            sizeof (flags))))
1027             return clib_error_return (error,
1028                                       "error in reading the capability at [%2x]",
1029                                       pos + 2);
1030
1031           table_size = flags & table_size_mask;
1032           virtio_log_debug (vif, "flags:0x%x %s 0x%x", flags,
1033                             "msix interrupt vector table-size", table_size);
1034
1035           if (flags & PCI_MSIX_ENABLE)
1036             {
1037               virtio_log_debug (vif, "msix interrupt enabled");
1038               vif->msix_enabled = VIRTIO_MSIX_ENABLED;
1039               vif->msix_table_size = table_size;
1040             }
1041           else
1042             {
1043               virtio_log_debug (vif, "msix interrupt disabled");
1044               vif->msix_enabled = VIRTIO_MSIX_DISABLED;
1045               vif->msix_table_size = 0;
1046             }
1047         }
1048
1049       if (cap.cap_vndr != PCI_CAP_ID_VNDR)
1050         {
1051           virtio_log_debug (vif, "[%2x] %s %2x ", pos,
1052                             "skipping non VNDR cap id:", cap.cap_vndr);
1053           goto next;
1054         }
1055
1056       virtio_log_debug (vif,
1057                         "[%4x] cfg type: %u, bar: %u, offset: %04x, len: %u",
1058                         pos, cap.cfg_type, cap.bar, cap.offset, cap.length);
1059
1060       if (cap.bar >= 0 && cap.bar <= 5)
1061         {
1062           vif->bar = bar[cap.bar];
1063           vif->bar_id = cap.bar;
1064         }
1065       else
1066         return clib_error_return (error, "invalid bar %u", cap.bar);
1067
1068       switch (cap.cfg_type)
1069         {
1070         case VIRTIO_PCI_CAP_COMMON_CFG:
1071           vif->common_offset = cap.offset;
1072           common_cfg = 1;
1073           break;
1074         case VIRTIO_PCI_CAP_NOTIFY_CFG:
1075           if ((error =
1076                vlib_pci_read_write_config (vm, h, VLIB_READ,
1077                                            pos + sizeof (cap),
1078                                            &vif->notify_off_multiplier,
1079                                            sizeof
1080                                            (vif->notify_off_multiplier))))
1081             {
1082               virtio_log_error (vif, "notify off multiplier is not given");
1083             }
1084           else
1085             {
1086               virtio_log_debug (vif, "notify off multiplier is %u",
1087                                 vif->notify_off_multiplier);
1088               vif->notify_offset = cap.offset;
1089               notify = 1;
1090             }
1091           break;
1092         case VIRTIO_PCI_CAP_DEVICE_CFG:
1093           vif->device_offset = cap.offset;
1094           dev_cfg = 1;
1095           break;
1096         case VIRTIO_PCI_CAP_ISR_CFG:
1097           vif->isr_offset = cap.offset;
1098           isr = 1;
1099           break;
1100         case VIRTIO_PCI_CAP_PCI_CFG:
1101           if (cap.bar == 0)
1102             pci_cfg = 1;
1103           break;
1104         }
1105     next:
1106       pos = cap.cap_next;
1107     }
1108
1109   if (common_cfg == 0 || notify == 0 || dev_cfg == 0 || isr == 0)
1110     {
1111       vif->virtio_pci_func = &virtio_pci_legacy_func;
1112       vif->notify_off_multiplier = 0;
1113       virtio_log_debug (vif, "legacy virtio pci device found");
1114       return error;
1115     }
1116
1117   vif->is_modern = 1;
1118   vif->virtio_pci_func = &virtio_pci_modern_func;
1119
1120   if (!pci_cfg)
1121     {
1122       virtio_log_debug (vif, "modern virtio pci device found");
1123     }
1124   else
1125     {
1126       virtio_log_debug (vif, "transitional virtio pci device found");
1127     }
1128
1129   return error;
1130 }
1131
1132 static clib_error_t *
1133 virtio_pci_device_init (vlib_main_t * vm, virtio_if_t * vif,
1134                         virtio_pci_create_if_args_t * args, void **bar)
1135 {
1136   clib_error_t *error = 0;
1137   u8 status = 0;
1138
1139   if ((error = virtio_pci_read_caps (vm, vif, bar)))
1140     {
1141       args->rv = VNET_API_ERROR_UNSUPPORTED;
1142       virtio_log_error (vif, "Device is not supported");
1143       return clib_error_return (error, "Device is not supported");
1144     }
1145
1146   if (virtio_pci_reset_device (vm, vif) < 0)
1147     {
1148       args->rv = VNET_API_ERROR_INIT_FAILED;
1149       virtio_log_error (vif, "Failed to reset the device");
1150       return clib_error_return (error, "Failed to reset the device");
1151     }
1152   /*
1153    * read device features and negotiate (user) requested features
1154    */
1155   virtio_pci_read_device_feature (vm, vif);
1156   if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC)) ==
1157       0)
1158     {
1159       virtio_log_warning (vif, "error encountered: vhost-net backend doesn't "
1160                           "support VIRTIO_RING_F_INDIRECT_DESC features");
1161     }
1162   if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF)) == 0)
1163     {
1164       virtio_log_warning (vif, "error encountered: vhost-net backend doesn't "
1165                           "support VIRTIO_NET_F_MRG_RXBUF features");
1166     }
1167   virtio_negotiate_features (vm, vif, args->features);
1168
1169   /*
1170    * After FEATURE_OK, driver should not accept new feature bits
1171    */
1172   vif->virtio_pci_func->set_status (vm, vif,
1173                                     VIRTIO_CONFIG_STATUS_FEATURES_OK);
1174   status = vif->virtio_pci_func->get_status (vm, vif);
1175   if (!(status & VIRTIO_CONFIG_STATUS_FEATURES_OK))
1176     {
1177       args->rv = VNET_API_ERROR_UNSUPPORTED;
1178       virtio_log_error (vif,
1179                         "error encountered: Device doesn't support requested features");
1180       return clib_error_return (error,
1181                                 "Device doesn't support requested features");
1182     }
1183   vif->status = status;
1184
1185   /*
1186    * get or set the mac address
1187    */
1188   if (virtio_pci_get_mac (vm, vif))
1189     {
1190       f64 now = vlib_time_now (vm);
1191       u32 rnd;
1192       rnd = (u32) (now * 1e6);
1193       rnd = random_u32 (&rnd);
1194
1195       memcpy (vif->mac_addr + 2, &rnd, sizeof (rnd));
1196       vif->mac_addr[0] = 2;
1197       vif->mac_addr[1] = 0xfe;
1198       virtio_pci_set_mac (vm, vif);
1199     }
1200
1201   virtio_set_net_hdr_size (vif);
1202
1203   /*
1204    * Initialize the virtqueues
1205    */
1206   if ((error = virtio_pci_get_max_virtqueue_pairs (vm, vif)))
1207     {
1208       args->rv = VNET_API_ERROR_EXCEEDED_NUMBER_OF_RANGES_CAPACITY;
1209       goto err;
1210     }
1211
1212   if (vif->msix_enabled == VIRTIO_MSIX_ENABLED)
1213     {
1214       if (vif->msix_table_size <= vif->max_queue_pairs)
1215         {
1216           virtio_log_error (vif,
1217                             "error MSIX lines (%u) <= Number of RXQs (%u)",
1218                             vif->msix_table_size, vif->max_queue_pairs);
1219           return clib_error_return (error,
1220                                     "error MSIX lines (%u) <= Number of RXQs (%u)",
1221                                     vif->msix_table_size,
1222                                     vif->max_queue_pairs);
1223         }
1224     }
1225
1226   for (int i = 0; i < vif->max_queue_pairs; i++)
1227     {
1228       if ((error = virtio_pci_vring_init (vm, vif, RX_QUEUE (i))))
1229         {
1230           args->rv = VNET_API_ERROR_INIT_FAILED;
1231           virtio_log_error (vif, "%s (%u) %s", "error in rxq-queue",
1232                             RX_QUEUE (i), "initialization");
1233           error =
1234             clib_error_return (error, "%s (%u) %s", "error in rxq-queue",
1235                                RX_QUEUE (i), "initialization");
1236           goto err;
1237         }
1238       else
1239         {
1240           vif->num_rxqs++;
1241         }
1242
1243       if ((error = virtio_pci_vring_init (vm, vif, TX_QUEUE (i))))
1244         {
1245           args->rv = VNET_API_ERROR_INIT_FAILED;
1246           virtio_log_error (vif, "%s (%u) %s", "error in txq-queue",
1247                             TX_QUEUE (i), "initialization");
1248           error =
1249             clib_error_return (error, "%s (%u) %s", "error in txq-queue",
1250                                TX_QUEUE (i), "initialization");
1251           goto err;
1252         }
1253       else
1254         {
1255           vif->num_txqs++;
1256         }
1257     }
1258
1259   if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
1260     {
1261       if ((error =
1262            virtio_pci_control_vring_init (vm, vif, vif->max_queue_pairs * 2)))
1263         {
1264           virtio_log_warning (vif, "%s (%u) %s", "error in control-queue",
1265                               vif->max_queue_pairs * 2, "initialization");
1266           if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MQ))
1267             vif->features &= ~VIRTIO_FEATURE (VIRTIO_NET_F_MQ);
1268         }
1269     }
1270   else
1271     {
1272       virtio_log_debug (vif, "control queue is not available");
1273       vif->cxq_vring = NULL;
1274     }
1275
1276   /*
1277    * set the msix interrupts
1278    */
1279   if (vif->msix_enabled == VIRTIO_MSIX_ENABLED)
1280     {
1281       int i, j;
1282       if (vif->virtio_pci_func->set_config_irq (vm, vif, 0) ==
1283           VIRTIO_MSI_NO_VECTOR)
1284         {
1285           virtio_log_warning (vif, "config vector 0 is not set");
1286         }
1287       else
1288         {
1289           virtio_log_debug (vif, "config msix vector is set at 0");
1290         }
1291       for (i = 0, j = 1; i < vif->max_queue_pairs; i++, j++)
1292         {
1293           if (vif->virtio_pci_func->set_queue_irq (vm, vif, j,
1294                                                    RX_QUEUE (i)) ==
1295               VIRTIO_MSI_NO_VECTOR)
1296             {
1297               virtio_log_warning (vif, "queue (%u) vector is not set at %u",
1298                                   RX_QUEUE (i), j);
1299             }
1300           else
1301             {
1302               virtio_log_debug (vif, "%s (%u) %s %u", "queue",
1303                                 RX_QUEUE (i), "msix vector is set at", j);
1304             }
1305         }
1306     }
1307
1308   /*
1309    * set the driver status OK
1310    */
1311   vif->virtio_pci_func->set_status (vm, vif, VIRTIO_CONFIG_STATUS_DRIVER_OK);
1312   vif->status = vif->virtio_pci_func->get_status (vm, vif);
1313 err:
1314   return error;
1315 }
1316
1317 void
1318 virtio_pci_create_if (vlib_main_t * vm, virtio_pci_create_if_args_t * args)
1319 {
1320   vnet_main_t *vnm = vnet_get_main ();
1321   virtio_main_t *vim = &virtio_main;
1322   virtio_if_t *vif;
1323   vlib_pci_dev_handle_t h;
1324   clib_error_t *error = 0;
1325   u32 interrupt_count = 0;
1326
1327   /* *INDENT-OFF* */
1328   pool_foreach (vif, vim->interfaces)  {
1329     if (vif->pci_addr.as_u32 == args->addr)
1330       {
1331         args->rv = VNET_API_ERROR_ADDRESS_IN_USE;
1332         args->error =
1333           clib_error_return (error, "PCI address in use");
1334           vlib_log (VLIB_LOG_LEVEL_ERR, vim->log_default, "%U: %s",
1335                 format_vlib_pci_addr, &args->addr,
1336                 " PCI address in use");
1337         return;
1338       }
1339   }
1340   /* *INDENT-ON* */
1341
1342   pool_get (vim->interfaces, vif);
1343   vif->dev_instance = vif - vim->interfaces;
1344   vif->per_interface_next_index = ~0;
1345   vif->pci_addr.as_u32 = args->addr;
1346   if (args->virtio_flags & VIRTIO_FLAG_PACKED)
1347     vif->is_packed = 1;
1348
1349   if ((error =
1350        vlib_pci_device_open (vm, (vlib_pci_addr_t *) & vif->pci_addr,
1351                              virtio_pci_device_ids, &h)))
1352     {
1353       args->rv = VNET_API_ERROR_INVALID_INTERFACE;
1354       args->error =
1355         clib_error_return (error, "pci-addr %U", format_vlib_pci_addr,
1356                            &vif->pci_addr);
1357       vlib_log (VLIB_LOG_LEVEL_ERR, vim->log_default, "%U: %s",
1358                 format_vlib_pci_addr, &vif->pci_addr,
1359                 "error encountered on pci device open");
1360       pool_put (vim->interfaces, vif);
1361       return;
1362     }
1363   vif->pci_dev_handle = h;
1364   vlib_pci_set_private_data (vm, h, vif->dev_instance);
1365   vif->numa_node = vlib_pci_get_numa_node (vm, h);
1366   vif->type = VIRTIO_IF_TYPE_PCI;
1367
1368   if ((error = vlib_pci_bus_master_enable (vm, h)))
1369     {
1370       virtio_log_error (vif, "error encountered on pci bus master enable");
1371       goto error;
1372     }
1373
1374   void *bar[6];
1375   for (u32 i = 0; i <= 5; i++)
1376     {
1377
1378       if ((error = vlib_pci_map_region (vm, h, i, &bar[i])))
1379         {
1380           virtio_log_debug (vif, "no pci map region for bar %u", i);
1381         }
1382       else
1383         {
1384           virtio_log_debug (vif, "pci map region for bar %u at %p", i,
1385                             bar[i]);
1386         }
1387     }
1388
1389   if ((error = vlib_pci_io_region (vm, h, 0)))
1390     {
1391       virtio_log_error (vif, "error encountered on pci io region");
1392       goto error;
1393     }
1394
1395   interrupt_count = vlib_pci_get_num_msix_interrupts (vm, h);
1396   if (interrupt_count > 1)
1397     {
1398       if ((error = vlib_pci_register_msix_handler (vm, h, 0, 1,
1399                                                    &virtio_pci_irq_config_handler)))
1400         {
1401           args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
1402           virtio_log_error (vif,
1403                             "error encountered on pci register msix handler 0");
1404           goto error;
1405         }
1406
1407       if ((error =
1408            vlib_pci_register_msix_handler (vm, h, 1, (interrupt_count - 1),
1409                                            &virtio_pci_irq_queue_handler)))
1410         {
1411           args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
1412           virtio_log_error (vif,
1413                             "error encountered on pci register msix handler 1");
1414           goto error;
1415         }
1416
1417       if ((error = vlib_pci_enable_msix_irq (vm, h, 0, interrupt_count)))
1418         {
1419           virtio_log_error (vif, "error encountered on pci enable msix irq");
1420           goto error;
1421         }
1422       vif->support_int_mode = 1;
1423       virtio_log_debug (vif, "device supports msix interrupts");
1424     }
1425   else
1426     {
1427       /*
1428        * WARN: performance will be sub-optimal.
1429        * Fall back to intX, if msix table-size is 1 or
1430        * if UIO driver is being used.
1431        */
1432       if ((error =
1433            vlib_pci_register_intx_handler (vm, h, &virtio_pci_irq_handler)))
1434         {
1435           virtio_log_error (vif,
1436                             "error encountered on pci register interrupt handler");
1437           goto error;
1438         }
1439       vif->support_int_mode = 1;
1440       virtio_log_debug (vif, "pci register interrupt handler");
1441     }
1442
1443   if ((error = vlib_pci_intr_enable (vm, h)))
1444     {
1445       virtio_log_error (vif, "error encountered on pci interrupt enable");
1446       goto error;
1447     }
1448
1449   if ((error = virtio_pci_device_init (vm, vif, args, bar)))
1450     {
1451       virtio_log_error (vif, "error encountered on device init");
1452       goto error;
1453     }
1454
1455   /* create interface */
1456   vnet_eth_interface_registration_t eir = {};
1457   eir.dev_class_index = virtio_device_class.index;
1458   eir.dev_instance = vif->dev_instance;
1459   eir.address = vif->mac_addr;
1460   eir.cb.flag_change = virtio_pci_flag_change;
1461   vif->hw_if_index = vnet_eth_register_interface (vnm, &eir);
1462
1463   vnet_sw_interface_t *sw = vnet_get_hw_sw_interface (vnm, vif->hw_if_index);
1464   vif->sw_if_index = sw->sw_if_index;
1465   args->sw_if_index = sw->sw_if_index;
1466
1467   vnet_hw_if_set_caps (vnm, vif->hw_if_index, VNET_HW_IF_CAP_INT_MODE);
1468
1469   if (args->virtio_flags & VIRTIO_FLAG_BUFFERING)
1470     {
1471       error = virtio_set_packet_buffering (vif, args->buffering_size);
1472       if (error)
1473         {
1474           args->rv = VNET_API_ERROR_INIT_FAILED;
1475           virtio_log_error (vif,
1476                             "error encountered during packet buffering init");
1477           goto error;
1478         }
1479     }
1480
1481   virtio_pre_input_node_enable (vm, vif);
1482   virtio_vring_set_rx_queues (vm, vif);
1483   virtio_vring_set_tx_queues (vm, vif);
1484
1485   if (virtio_pci_is_link_up (vm, vif) & VIRTIO_NET_S_LINK_UP)
1486     {
1487       vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
1488                                    VNET_HW_INTERFACE_FLAG_LINK_UP);
1489     }
1490   else
1491     vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
1492
1493   virtio_pci_offloads (vm, vif, args->gso_enabled,
1494                        args->checksum_offload_enabled);
1495
1496   if ((vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ)) &&
1497       (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MQ)))
1498     {
1499       if (virtio_pci_enable_multiqueue (vm, vif, vif->max_queue_pairs))
1500         virtio_log_warning (vif, "multiqueue is not set");
1501     }
1502   return;
1503
1504 error:
1505   virtio_pci_delete_if (vm, vif);
1506   if (args->rv == 0)
1507     args->rv = VNET_API_ERROR_INVALID_INTERFACE;
1508   args->error = error;
1509 }
1510
1511 int
1512 virtio_pci_delete_if (vlib_main_t * vm, virtio_if_t * vif)
1513 {
1514   vnet_main_t *vnm = vnet_get_main ();
1515   virtio_main_t *vim = &virtio_main;
1516   u32 i = 0;
1517
1518   if (vif->type != VIRTIO_IF_TYPE_PCI)
1519     return VNET_API_ERROR_INVALID_INTERFACE;
1520
1521   vlib_pci_intr_disable (vm, vif->pci_dev_handle);
1522
1523   for (i = 0; i < vif->max_queue_pairs; i++)
1524     {
1525       vif->virtio_pci_func->del_queue (vm, vif, RX_QUEUE (i));
1526       vif->virtio_pci_func->del_queue (vm, vif, TX_QUEUE (i));
1527     }
1528
1529   if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
1530     vif->virtio_pci_func->del_queue (vm, vif, vif->max_queue_pairs * 2);
1531
1532   if (vif->virtio_pci_func)
1533     vif->virtio_pci_func->device_reset (vm, vif);
1534
1535   if (vif->hw_if_index)
1536     {
1537       vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
1538       ethernet_delete_interface (vnm, vif->hw_if_index);
1539     }
1540
1541   vlib_pci_device_close (vm, vif->pci_dev_handle);
1542
1543   vec_foreach_index (i, vif->rxq_vrings)
1544   {
1545     vnet_virtio_vring_t *vring = vec_elt_at_index (vif->rxq_vrings, i);
1546     if (vring->used)
1547       {
1548         virtio_free_buffers (vm, vring);
1549       }
1550     vec_free (vring->buffers);
1551     vlib_physmem_free (vm, vring->desc);
1552   }
1553
1554   virtio_pre_input_node_disable (vm, vif);
1555
1556   vec_foreach_index (i, vif->txq_vrings)
1557   {
1558     vnet_virtio_vring_t *vring = vec_elt_at_index (vif->txq_vrings, i);
1559     if (vring->used)
1560       {
1561         virtio_free_buffers (vm, vring);
1562       }
1563     vec_free (vring->buffers);
1564     gro_flow_table_free (vring->flow_table);
1565     virtio_vring_buffering_free (vm, vring->buffering);
1566     clib_spinlock_free (&vring->lockp);
1567     vlib_physmem_free (vm, vring->desc);
1568   }
1569
1570   if (vif->cxq_vring != NULL)
1571     {
1572       u16 last = vif->cxq_vring->last_used_idx;
1573       u16 n_left = vif->cxq_vring->used->idx - last;
1574       while (n_left)
1575         {
1576           last++;
1577           n_left--;
1578         }
1579
1580       vif->cxq_vring->last_used_idx = last;
1581       vlib_physmem_free (vm, vif->cxq_vring->desc);
1582     }
1583
1584   vec_free (vif->rxq_vrings);
1585   vec_free (vif->txq_vrings);
1586   vec_free (vif->cxq_vring);
1587
1588   clib_error_free (vif->error);
1589   memset (vif, 0, sizeof (*vif));
1590   pool_put (vim->interfaces, vif);
1591
1592   return 0;
1593 }
1594
1595 int
1596 virtio_pci_enable_disable_offloads (vlib_main_t * vm, virtio_if_t * vif,
1597                                     int gso_enabled,
1598                                     int checksum_offload_enabled,
1599                                     int offloads_disabled)
1600 {
1601   if (vif->type != VIRTIO_IF_TYPE_PCI)
1602     return VNET_API_ERROR_INVALID_INTERFACE;
1603
1604   if (gso_enabled)
1605     virtio_pci_offloads (vm, vif, 1, 0);
1606   else if (checksum_offload_enabled)
1607     virtio_pci_offloads (vm, vif, 0, 1);
1608   else if (offloads_disabled)
1609     virtio_pci_offloads (vm, vif, 0, 0);
1610
1611   return 0;
1612 }
1613
1614 /*
1615  * fd.io coding-style-patch-verification: ON
1616  *
1617  * Local Variables:
1618  * eval: (c-set-style "gnu")
1619  * End:
1620  */