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