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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #include <sys/ioctl.h>
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>
28 #define PCI_VENDOR_ID_VIRTIO 0x1af4
29 #define PCI_DEVICE_ID_VIRTIO_NIC 0x1000
30 /* Doesn't support modern device */
31 #define PCI_DEVICE_ID_VIRTIO_NIC_MODERN 0x1041
33 #define PCI_CAPABILITY_LIST 0x34
34 #define PCI_CAP_ID_VNDR 0x09
35 #define PCI_CAP_ID_MSIX 0x11
37 #define PCI_MSIX_ENABLE 0x8000
39 static pci_device_id_t virtio_pci_device_ids[] = {
41 .vendor_id = PCI_VENDOR_ID_VIRTIO,
42 .device_id = PCI_DEVICE_ID_VIRTIO_NIC},
44 .vendor_id = PCI_VENDOR_ID_VIRTIO,
45 .device_id = PCI_DEVICE_ID_VIRTIO_NIC_MODERN},
50 virtio_pci_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hw,
57 virtio_pci_get_max_virtqueue_pairs (vlib_main_t * vm, virtio_if_t * vif)
59 clib_error_t *error = 0;
60 u16 max_queue_pairs = 1;
62 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MQ))
64 max_queue_pairs = vif->virtio_pci_func->get_max_queue_pairs (vm, vif);
67 virtio_log_debug (vif, "max queue pair is %x", max_queue_pairs);
68 if (max_queue_pairs < 1 || max_queue_pairs > 0x8000)
69 return clib_error_return (error, "max queue pair is %x,"
70 " should be in range [1, 0x8000]",
73 vif->max_queue_pairs = max_queue_pairs;
78 virtio_pci_set_mac (vlib_main_t * vm, virtio_if_t * vif)
80 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MAC))
81 vif->virtio_pci_func->set_mac (vm, vif);
85 virtio_pci_get_mac (vlib_main_t * vm, virtio_if_t * vif)
87 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MAC))
89 vif->virtio_pci_func->get_mac (vm, vif);
96 virtio_pci_is_link_up (vlib_main_t * vm, virtio_if_t * vif)
99 * Minimal driver: assumes link is up
102 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_STATUS))
103 status = vif->virtio_pci_func->get_device_status (vm, vif);
108 virtio_pci_irq_queue_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
111 vnet_main_t *vnm = vnet_get_main ();
112 virtio_main_t *vim = &virtio_main;
113 uword pd = vlib_pci_get_private_data (vm, h);
114 virtio_if_t *vif = pool_elt_at_index (vim->interfaces, pd);
118 vnet_device_input_set_interrupt_pending (vnm, vif->hw_if_index, qid);
122 virtio_pci_irq_config_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
125 vnet_main_t *vnm = vnet_get_main ();
126 virtio_main_t *vim = &virtio_main;
127 uword pd = vlib_pci_get_private_data (vm, h);
128 virtio_if_t *vif = pool_elt_at_index (vim->interfaces, pd);
130 if (virtio_pci_is_link_up (vm, vif) & VIRTIO_NET_S_LINK_UP)
132 vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
133 vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
134 VNET_HW_INTERFACE_FLAG_LINK_UP);
138 vif->flags &= ~VIRTIO_IF_FLAG_ADMIN_UP;
139 vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
144 virtio_pci_irq_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h)
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);
152 isr = vif->virtio_pci_func->get_isr (vm, vif);
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.
159 if (isr & VIRTIO_PCI_ISR_INTR)
161 for (; line < vif->num_rxqs; line++)
162 virtio_pci_irq_queue_handler (vm, h, (line + 1));
165 if (isr & VIRTIO_PCI_ISR_CONFIG)
166 virtio_pci_irq_config_handler (vm, h, line);
170 device_status (vlib_main_t * vm, virtio_if_t * vif)
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
185 vlib_cli_output (vm, " status 0x%x", vif->status);
187 status_entry = (struct status_struct *) &status_array;
188 while (status_entry->str)
190 if (vif->status & status_entry->bit)
191 vlib_cli_output (vm, " %s (%x)", status_entry->str,
197 struct virtio_ctrl_msg
199 struct virtio_net_ctrl_hdr ctrl;
200 virtio_net_ctrl_ack status;
205 virtio_pci_send_ctrl_msg (vlib_main_t * vm, virtio_if_t * vif,
206 struct virtio_ctrl_msg *data, u32 len)
208 virtio_vring_t *vring = vif->cxq_vring;
209 virtio_net_ctrl_ack status = VIRTIO_NET_ERR;
210 struct virtio_ctrl_msg result;
213 u16 used, next, avail;
214 u16 sz = vring->size;
217 used = vring->desc_in_use;
218 next = vring->desc_next;
219 avail = vring->avail->idx;
220 struct vring_desc *d = &vring->desc[next];
222 if (vlib_buffer_alloc (vm, &buffer_index, 1))
223 b = vlib_get_buffer (vm, buffer_index);
225 return VIRTIO_NET_ERR;
227 * current_data may not be initialized with 0 and may contain
231 clib_memcpy (vlib_buffer_get_current (b), data,
232 sizeof (struct virtio_ctrl_msg));
233 d->flags = VRING_DESC_F_NEXT;
234 d->addr = vlib_buffer_get_current_pa (vm, b);
235 d->len = sizeof (struct virtio_net_ctrl_hdr);
236 vring->avail->ring[avail & mask] = next;
238 next = (next + 1) & mask;
242 d = &vring->desc[next];
243 d->flags = VRING_DESC_F_NEXT;
244 d->addr = vlib_buffer_get_current_pa (vm, b) +
245 STRUCT_OFFSET_OF (struct virtio_ctrl_msg, data);
247 next = (next + 1) & mask;
251 d = &vring->desc[next];
252 d->flags = VRING_DESC_F_WRITE;
253 d->addr = vlib_buffer_get_current_pa (vm, b) +
254 STRUCT_OFFSET_OF (struct virtio_ctrl_msg, status);
255 d->len = sizeof (data->status);
256 next = (next + 1) & mask;
259 CLIB_MEMORY_STORE_BARRIER ();
260 vring->avail->idx = avail;
261 vring->desc_next = next;
262 vring->desc_in_use = used;
264 if ((vring->used->flags & VIRTIO_RING_FLAG_MASK_INT) == 0)
266 virtio_kick (vm, vring, vif);
269 u16 last = vring->last_used_idx, n_left = 0;
270 n_left = vring->used->idx - last;
274 struct vring_used_elem *e = &vring->used->ring[last & mask];
277 d = &vring->desc[slot];
278 while (d->flags & VRING_DESC_F_NEXT)
282 d = &vring->desc[slot];
288 vring->desc_in_use = used;
289 vring->last_used_idx = last;
291 CLIB_MEMORY_BARRIER ();
292 clib_memcpy (&result, vlib_buffer_get_current (b),
293 sizeof (struct virtio_ctrl_msg));
294 virtio_log_debug (vif, "ctrl-queue: status %u", result.status);
295 status = result.status;
296 vlib_buffer_free (vm, &buffer_index, 1);
301 virtio_pci_disable_offload (vlib_main_t * vm, virtio_if_t * vif)
303 struct virtio_ctrl_msg offload_hdr;
304 virtio_net_ctrl_ack status = VIRTIO_NET_ERR;
306 offload_hdr.ctrl.class = VIRTIO_NET_CTRL_GUEST_OFFLOADS;
307 offload_hdr.ctrl.cmd = VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET;
308 offload_hdr.status = VIRTIO_NET_ERR;
310 clib_memcpy (offload_hdr.data, &offloads, sizeof (offloads));
313 virtio_pci_send_ctrl_msg (vm, vif, &offload_hdr, sizeof (offloads));
314 virtio_log_debug (vif, "disable offloads");
315 vif->remote_features = vif->virtio_pci_func->get_device_features (vm, vif);
316 vif->virtio_pci_func->get_driver_features (vm, vif);
321 virtio_pci_enable_checksum_offload (vlib_main_t * vm, virtio_if_t * vif)
323 struct virtio_ctrl_msg csum_offload_hdr;
324 virtio_net_ctrl_ack status = VIRTIO_NET_ERR;
326 csum_offload_hdr.ctrl.class = VIRTIO_NET_CTRL_GUEST_OFFLOADS;
327 csum_offload_hdr.ctrl.cmd = VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET;
328 csum_offload_hdr.status = VIRTIO_NET_ERR;
330 offloads |= VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_CSUM);
331 clib_memcpy (csum_offload_hdr.data, &offloads, sizeof (offloads));
334 virtio_pci_send_ctrl_msg (vm, vif, &csum_offload_hdr, sizeof (offloads));
335 virtio_log_debug (vif, "enable checksum offload");
336 vif->remote_features = vif->virtio_pci_func->get_device_features (vm, vif);
337 vif->features = vif->virtio_pci_func->get_driver_features (vm, vif);
342 virtio_pci_enable_gso (vlib_main_t * vm, virtio_if_t * vif)
344 struct virtio_ctrl_msg gso_hdr;
345 virtio_net_ctrl_ack status = VIRTIO_NET_ERR;
347 gso_hdr.ctrl.class = VIRTIO_NET_CTRL_GUEST_OFFLOADS;
348 gso_hdr.ctrl.cmd = VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET;
349 gso_hdr.status = VIRTIO_NET_ERR;
350 u64 offloads = VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_CSUM)
351 | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO4)
352 | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO6);
353 clib_memcpy (gso_hdr.data, &offloads, sizeof (offloads));
355 status = virtio_pci_send_ctrl_msg (vm, vif, &gso_hdr, sizeof (offloads));
356 virtio_log_debug (vif, "enable gso");
357 vif->remote_features = vif->virtio_pci_func->get_device_features (vm, vif);
358 vif->virtio_pci_func->get_driver_features (vm, vif);
363 virtio_pci_offloads (vlib_main_t * vm, virtio_if_t * vif, int gso_enabled,
364 int csum_offload_enabled)
366 vnet_main_t *vnm = vnet_get_main ();
367 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
369 if ((vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ)) &&
370 (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_GUEST_OFFLOADS)))
373 && (vif->features & (VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO4) |
374 VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO6))))
376 if (virtio_pci_enable_gso (vm, vif))
378 virtio_log_warning (vif, "gso is not enabled");
382 vif->gso_enabled = 1;
383 vif->csum_offload_enabled = 0;
384 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO |
385 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
388 else if (csum_offload_enabled
389 && (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CSUM)))
391 if (virtio_pci_enable_checksum_offload (vm, vif))
393 virtio_log_warning (vif, "checksum offload is not enabled");
397 vif->csum_offload_enabled = 1;
398 vif->gso_enabled = 0;
399 hw->flags &= ~VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO;
401 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
406 if (virtio_pci_disable_offload (vm, vif))
408 virtio_log_warning (vif, "offloads are not disabled");
412 vif->csum_offload_enabled = 0;
413 vif->gso_enabled = 0;
414 hw->flags &= ~(VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO |
415 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD);
424 virtio_pci_enable_multiqueue (vlib_main_t * vm, virtio_if_t * vif,
427 struct virtio_ctrl_msg mq_hdr;
428 virtio_net_ctrl_ack status = VIRTIO_NET_ERR;
430 mq_hdr.ctrl.class = VIRTIO_NET_CTRL_MQ;
431 mq_hdr.ctrl.cmd = VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET;
432 mq_hdr.status = VIRTIO_NET_ERR;
433 clib_memcpy (mq_hdr.data, &num_queues, sizeof (num_queues));
435 status = virtio_pci_send_ctrl_msg (vm, vif, &mq_hdr, sizeof (num_queues));
436 virtio_log_debug (vif, "multi-queue enable %u queues", num_queues);
441 virtio_pci_queue_size_valid (u16 qsz)
443 if (qsz < 64 || qsz > 4096)
451 virtio_pci_control_vring_init (vlib_main_t * vm, virtio_if_t * vif,
454 clib_error_t *error = 0;
456 virtio_vring_t *vring;
461 queue_size = vif->virtio_pci_func->get_queue_size (vm, vif, queue_num);
462 if (!virtio_pci_queue_size_valid (queue_size))
463 clib_warning ("queue size is not valid");
465 if (!is_pow2 (queue_size))
466 return clib_error_return (0, "ring size must be power of 2");
468 if (queue_size > 32768)
469 return clib_error_return (0, "ring size must be 32768 or lower");
474 vec_validate_aligned (vif->cxq_vring, 0, CLIB_CACHE_LINE_BYTES);
475 vring = vec_elt_at_index (vif->cxq_vring, 0);
476 i = vring_size (queue_size, VIRTIO_PCI_VRING_ALIGN);
477 i = round_pow2 (i, VIRTIO_PCI_VRING_ALIGN);
479 vlib_physmem_alloc_aligned_on_numa (vm, i, VIRTIO_PCI_VRING_ALIGN,
482 return vlib_physmem_last_error (vm);
483 clib_memset (ptr, 0, i);
484 vring_init (&vr, queue_size, ptr, VIRTIO_PCI_VRING_ALIGN);
485 vring->desc = vr.desc;
486 vring->avail = vr.avail;
487 vring->used = vr.used;
488 vring->queue_id = queue_num;
489 vring->avail->flags = VIRTIO_RING_FLAG_MASK_INT;
491 ASSERT (vring->buffers == 0);
493 vring->size = queue_size;
494 virtio_log_debug (vif, "control-queue: number %u, size %u", queue_num,
496 vif->virtio_pci_func->setup_queue (vm, vif, queue_num, ptr);
503 virtio_pci_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 queue_num)
505 clib_error_t *error = 0;
507 virtio_vring_t *vring;
512 queue_size = vif->virtio_pci_func->get_queue_size (vm, vif, queue_num);
513 if (!virtio_pci_queue_size_valid (queue_size))
514 clib_warning ("queue size is not valid");
516 if (!is_pow2 (queue_size))
517 return clib_error_return (0, "ring size must be power of 2");
519 if (queue_size > 32768)
520 return clib_error_return (0, "ring size must be 32768 or lower");
527 vec_validate_aligned (vif->txq_vrings, TX_QUEUE_ACCESS (queue_num),
528 CLIB_CACHE_LINE_BYTES);
529 vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (queue_num));
530 clib_spinlock_init (&vring->lockp);
534 vec_validate_aligned (vif->rxq_vrings, RX_QUEUE_ACCESS (queue_num),
535 CLIB_CACHE_LINE_BYTES);
536 vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (queue_num));
538 i = vring_size (queue_size, VIRTIO_PCI_VRING_ALIGN);
539 i = round_pow2 (i, VIRTIO_PCI_VRING_ALIGN);
541 vlib_physmem_alloc_aligned_on_numa (vm, i, VIRTIO_PCI_VRING_ALIGN,
544 return vlib_physmem_last_error (vm);
545 clib_memset (ptr, 0, i);
546 vring_init (&vr, queue_size, ptr, VIRTIO_PCI_VRING_ALIGN);
547 vring->desc = vr.desc;
548 vring->avail = vr.avail;
549 vring->used = vr.used;
550 vring->queue_id = queue_num;
551 vring->avail->flags = VIRTIO_RING_FLAG_MASK_INT;
552 vring->flow_table = 0;
554 ASSERT (vring->buffers == 0);
555 vec_validate_aligned (vring->buffers, queue_size, CLIB_CACHE_LINE_BYTES);
558 virtio_log_debug (vif, "tx-queue: number %u, size %u", queue_num,
560 clib_memset_u32 (vring->buffers, ~0, queue_size);
564 virtio_log_debug (vif, "rx-queue: number %u, size %u", queue_num,
567 vring->size = queue_size;
568 if (vif->virtio_pci_func->setup_queue (vm, vif, queue_num, ptr))
569 return clib_error_return (0, "error in queue address setup");
576 virtio_negotiate_features (vlib_main_t * vm, virtio_if_t * vif,
580 * if features are not requested
581 * default: all supported features
583 u64 supported_features = VIRTIO_FEATURE (VIRTIO_NET_F_CSUM)
584 | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_CSUM)
585 | VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_GUEST_OFFLOADS)
586 | VIRTIO_FEATURE (VIRTIO_NET_F_MTU)
587 | VIRTIO_FEATURE (VIRTIO_NET_F_MAC)
588 | VIRTIO_FEATURE (VIRTIO_NET_F_GSO)
589 | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO4)
590 | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO6)
591 | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_UFO)
592 | VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO4)
593 | VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO6)
594 | VIRTIO_FEATURE (VIRTIO_NET_F_HOST_UFO)
595 | VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF)
596 | VIRTIO_FEATURE (VIRTIO_NET_F_STATUS)
597 | VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ)
598 | VIRTIO_FEATURE (VIRTIO_NET_F_MQ)
599 | VIRTIO_FEATURE (VIRTIO_F_NOTIFY_ON_EMPTY)
600 | VIRTIO_FEATURE (VIRTIO_F_ANY_LAYOUT)
601 | VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);
603 if (req_features == 0)
605 req_features = supported_features;
608 vif->features = req_features & vif->remote_features & supported_features;
610 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MTU))
613 mtu = vif->virtio_pci_func->get_mtu (vm, vif);
616 vif->features &= ~VIRTIO_FEATURE (VIRTIO_NET_F_MTU);
619 vif->virtio_pci_func->set_driver_features (vm, vif, vif->features);
620 vif->features = vif->virtio_pci_func->get_driver_features (vm, vif);
624 virtio_pci_read_device_feature (vlib_main_t * vm, virtio_if_t * vif)
626 vif->remote_features = vif->virtio_pci_func->get_device_features (vm, vif);
630 virtio_pci_reset_device (vlib_main_t * vm, virtio_if_t * vif)
637 status = vif->virtio_pci_func->device_reset (vm, vif);
640 * Set the Acknowledge status bit
642 vif->virtio_pci_func->set_status (vm, vif, VIRTIO_CONFIG_STATUS_ACK);
645 * Set the Driver status bit
647 vif->virtio_pci_func->set_status (vm, vif, VIRTIO_CONFIG_STATUS_DRIVER);
650 * Read the status and verify it
652 status = vif->virtio_pci_func->get_status (vm, vif);
654 ((status & VIRTIO_CONFIG_STATUS_ACK)
655 && (status & VIRTIO_CONFIG_STATUS_DRIVER)))
657 vif->status = status;
663 virtio_pci_read_caps (vlib_main_t * vm, virtio_if_t * vif)
665 clib_error_t *error = 0;
666 struct virtio_pci_cap cap;
667 u8 pos, common_cfg = 0, notify_base = 0, dev_cfg = 0, isr = 0, pci_cfg = 0;
668 vlib_pci_dev_handle_t h = vif->pci_dev_handle;
670 if ((error = vlib_pci_read_config_u8 (vm, h, PCI_CAPABILITY_LIST, &pos)))
672 virtio_log_error (vif, "error in reading capabilty list position");
673 clib_error_return (error, "error in reading capabilty list position");
678 vlib_pci_read_write_config (vm, h, VLIB_READ, pos, &cap,
681 virtio_log_error (vif, "%s [%2x]",
682 "error in reading the capability at", pos);
683 clib_error_return (error,
684 "error in reading the capability at [%2x]", pos);
687 if (cap.cap_vndr == PCI_CAP_ID_MSIX)
689 u16 flags, table_size, table_size_mask = 0x07FF;
692 vlib_pci_read_write_config (vm, h, VLIB_READ, pos + 2, &flags,
694 clib_error_return (error,
695 "error in reading the capability at [%2x]",
698 table_size = flags & table_size_mask;
699 virtio_log_debug (vif, "flags:0x%x %s 0x%x", flags,
700 "msix interrupt vector table-size", table_size);
702 if (flags & PCI_MSIX_ENABLE)
704 virtio_log_debug (vif, "msix interrupt enabled");
705 vif->msix_enabled = VIRTIO_MSIX_ENABLED;
706 vif->msix_table_size = table_size;
710 virtio_log_debug (vif, "msix interrupt disabled");
711 vif->msix_enabled = VIRTIO_MSIX_DISABLED;
712 vif->msix_table_size = 0;
716 if (cap.cap_vndr != PCI_CAP_ID_VNDR)
718 virtio_log_debug (vif, "[%2x] %s %2x ", pos,
719 "skipping non VNDR cap id:", cap.cap_vndr);
723 virtio_log_debug (vif,
724 "[%4x] cfg type: %u, bar: %u, offset: %04x, len: %u",
725 pos, cap.cfg_type, cap.bar, cap.offset, cap.length);
726 switch (cap.cfg_type)
728 case VIRTIO_PCI_CAP_COMMON_CFG:
731 case VIRTIO_PCI_CAP_NOTIFY_CFG:
734 case VIRTIO_PCI_CAP_DEVICE_CFG:
737 case VIRTIO_PCI_CAP_ISR_CFG:
740 case VIRTIO_PCI_CAP_PCI_CFG:
749 vif->virtio_pci_func = &virtio_pci_legacy_func;
751 if (common_cfg == 0 || notify_base == 0 || dev_cfg == 0 || isr == 0)
753 virtio_log_debug (vif, "legacy virtio pci device found");
758 clib_error_return (error, "modern virtio pci device found");
760 virtio_log_debug (vif, "transitional virtio pci device found");
764 static clib_error_t *
765 virtio_pci_device_init (vlib_main_t * vm, virtio_if_t * vif,
766 virtio_pci_create_if_args_t * args)
768 clib_error_t *error = 0;
769 vlib_thread_main_t *vtm = vlib_get_thread_main ();
772 if ((error = virtio_pci_read_caps (vm, vif)))
774 args->rv = VNET_API_ERROR_UNSUPPORTED;
775 virtio_log_error (vif, "Device is not supported");
776 clib_error_return (error, "Device is not supported");
779 if (virtio_pci_reset_device (vm, vif) < 0)
781 args->rv = VNET_API_ERROR_INIT_FAILED;
782 virtio_log_error (vif, "Failed to reset the device");
783 clib_error_return (error, "Failed to reset the device");
786 * read device features and negotiate (user) requested features
788 virtio_pci_read_device_feature (vm, vif);
789 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC)) ==
792 virtio_log_warning (vif, "error encountered: vhost-net backend doesn't "
793 "support VIRTIO_RING_F_INDIRECT_DESC features");
795 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF)) == 0)
797 virtio_log_warning (vif, "error encountered: vhost-net backend doesn't "
798 "support VIRTIO_NET_F_MRG_RXBUF features");
800 virtio_negotiate_features (vm, vif, args->features);
803 * After FEATURE_OK, driver should not accept new feature bits
805 vif->virtio_pci_func->set_status (vm, vif,
806 VIRTIO_CONFIG_STATUS_FEATURES_OK);
807 status = vif->virtio_pci_func->get_status (vm, vif);
808 if (!(status & VIRTIO_CONFIG_STATUS_FEATURES_OK))
810 args->rv = VNET_API_ERROR_UNSUPPORTED;
811 virtio_log_error (vif,
812 "error encountered: Device doesn't support requested features");
813 clib_error_return (error, "Device doesn't support requested features");
815 vif->status = status;
818 * get or set the mac address
820 if (virtio_pci_get_mac (vm, vif))
822 f64 now = vlib_time_now (vm);
824 rnd = (u32) (now * 1e6);
825 rnd = random_u32 (&rnd);
827 memcpy (vif->mac_addr + 2, &rnd, sizeof (rnd));
828 vif->mac_addr[0] = 2;
829 vif->mac_addr[1] = 0xfe;
830 virtio_pci_set_mac (vm, vif);
833 virtio_set_net_hdr_size (vif);
836 * Initialize the virtqueues
838 if ((error = virtio_pci_get_max_virtqueue_pairs (vm, vif)))
840 args->rv = VNET_API_ERROR_EXCEEDED_NUMBER_OF_RANGES_CAPACITY;
844 if (vif->msix_enabled == VIRTIO_MSIX_ENABLED)
846 if (vif->msix_table_size <= vif->max_queue_pairs)
848 virtio_log_error (vif,
849 "error MSIX lines (%u) <= Number of RXQs (%u)",
850 vif->msix_table_size, vif->max_queue_pairs);
851 return clib_error_return (error,
852 "error MSIX lines (%u) <= Number of RXQs (%u)",
853 vif->msix_table_size,
854 vif->max_queue_pairs);
858 for (int i = 0; i < vif->max_queue_pairs; i++)
860 if ((error = virtio_pci_vring_init (vm, vif, RX_QUEUE (i))))
862 args->rv = VNET_API_ERROR_INIT_FAILED;
863 virtio_log_error (vif, "%s (%u) %s", "error in rxq-queue",
864 RX_QUEUE (i), "initialization");
866 clib_error_return (error, "%s (%u) %s", "error in rxq-queue",
867 RX_QUEUE (i), "initialization");
875 if (i >= vtm->n_vlib_mains)
878 * There is 1:1 mapping between tx queue and vpp worker thread.
879 * tx queue 0 is bind with thread index 0, tx queue 1 on thread
881 * Multiple worker threads can poll same tx queue when number of
882 * workers are more than tx queues. In this case, 1:N mapping
883 * between tx queue and vpp worker thread.
885 virtio_log_debug (vif, "%s %u, %s", "tx-queue: number",
887 "no VPP worker thread is available");
891 if ((error = virtio_pci_vring_init (vm, vif, TX_QUEUE (i))))
893 args->rv = VNET_API_ERROR_INIT_FAILED;
894 virtio_log_error (vif, "%s (%u) %s", "error in txq-queue",
895 TX_QUEUE (i), "initialization");
897 clib_error_return (error, "%s (%u) %s", "error in txq-queue",
898 TX_QUEUE (i), "initialization");
907 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
910 virtio_pci_control_vring_init (vm, vif, vif->max_queue_pairs * 2)))
912 virtio_log_warning (vif, "%s (%u) %s", "error in control-queue",
913 vif->max_queue_pairs * 2, "initialization");
914 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MQ))
915 vif->features &= ~VIRTIO_FEATURE (VIRTIO_NET_F_MQ);
920 virtio_log_debug (vif, "control queue is not available");
921 vif->cxq_vring = NULL;
925 * set the msix interrupts
927 if (vif->msix_enabled == VIRTIO_MSIX_ENABLED)
930 if (vif->virtio_pci_func->set_config_irq (vm, vif, 0) ==
931 VIRTIO_MSI_NO_VECTOR)
933 virtio_log_warning (vif, "config vector 0 is not set");
937 virtio_log_debug (vif, "config msix vector is set at 0");
939 for (i = 0, j = 1; i < vif->max_queue_pairs; i++, j++)
941 if (vif->virtio_pci_func->set_queue_irq (vm, vif, j,
943 VIRTIO_MSI_NO_VECTOR)
945 virtio_log_warning (vif, "queue (%u) vector is not set at %u",
950 virtio_log_debug (vif, "%s (%u) %s %u", "queue",
951 RX_QUEUE (i), "msix vector is set at", j);
957 * set the driver status OK
959 vif->virtio_pci_func->set_status (vm, vif, VIRTIO_CONFIG_STATUS_DRIVER_OK);
960 vif->status = vif->virtio_pci_func->get_status (vm, vif);
966 virtio_pci_create_if (vlib_main_t * vm, virtio_pci_create_if_args_t * args)
968 vnet_main_t *vnm = vnet_get_main ();
969 virtio_main_t *vim = &virtio_main;
971 vlib_pci_dev_handle_t h;
972 clib_error_t *error = 0;
973 u32 interrupt_count = 0;
976 pool_foreach (vif, vim->interfaces, ({
977 if (vif->pci_addr.as_u32 == args->addr)
979 args->rv = VNET_API_ERROR_ADDRESS_IN_USE;
981 clib_error_return (error, "PCI address in use");
982 vlib_log (VLIB_LOG_LEVEL_ERR, vim->log_default, "%U: %s",
983 format_vlib_pci_addr, &args->addr,
984 " PCI address in use");
990 pool_get (vim->interfaces, vif);
991 vif->dev_instance = vif - vim->interfaces;
992 vif->per_interface_next_index = ~0;
993 vif->pci_addr.as_u32 = args->addr;
996 vlib_pci_device_open (vm, (vlib_pci_addr_t *) & vif->pci_addr,
997 virtio_pci_device_ids, &h)))
999 args->rv = VNET_API_ERROR_INVALID_INTERFACE;
1001 clib_error_return (error, "pci-addr %U", format_vlib_pci_addr,
1003 vlib_log (VLIB_LOG_LEVEL_ERR, vim->log_default, "%U: %s",
1004 format_vlib_pci_addr, &vif->pci_addr,
1005 "error encountered on pci device open");
1006 pool_put (vim->interfaces, vif);
1009 vif->pci_dev_handle = h;
1010 vlib_pci_set_private_data (vm, h, vif->dev_instance);
1011 vif->numa_node = vlib_pci_get_numa_node (vm, h);
1012 vif->type = VIRTIO_IF_TYPE_PCI;
1014 if ((error = vlib_pci_bus_master_enable (vm, h)))
1016 virtio_log_error (vif, "error encountered on pci bus master enable");
1020 if ((error = vlib_pci_io_region (vm, h, 0)))
1022 virtio_log_error (vif, "error encountered on pci io region");
1026 interrupt_count = vlib_pci_get_num_msix_interrupts (vm, h);
1027 if (interrupt_count > 1)
1029 if ((error = vlib_pci_register_msix_handler (vm, h, 0, 1,
1030 &virtio_pci_irq_config_handler)))
1032 args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
1033 virtio_log_error (vif,
1034 "error encountered on pci register msix handler 0");
1039 vlib_pci_register_msix_handler (vm, h, 1, (interrupt_count - 1),
1040 &virtio_pci_irq_queue_handler)))
1042 args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
1043 virtio_log_error (vif,
1044 "error encountered on pci register msix handler 1");
1048 if ((error = vlib_pci_enable_msix_irq (vm, h, 0, interrupt_count)))
1050 virtio_log_error (vif, "error encountered on pci enable msix irq");
1053 vif->support_int_mode = 1;
1054 virtio_log_debug (vif, "device supports msix interrupts");
1056 else if (interrupt_count == 1)
1059 * if msix table-size is 1, fall back to intX.
1062 vlib_pci_register_intx_handler (vm, h, &virtio_pci_irq_handler)))
1064 virtio_log_error (vif,
1065 "error encountered on pci register interrupt handler");
1068 vif->support_int_mode = 1;
1069 virtio_log_debug (vif, "pci register interrupt handler");
1074 * WARN: intX is showing some weird behaviour.
1075 * Please don't use interrupt mode with UIO driver.
1077 vif->support_int_mode = 0;
1078 virtio_log_debug (vif, "driver is configured in poll mode only");
1081 if ((error = vlib_pci_intr_enable (vm, h)))
1083 virtio_log_error (vif, "error encountered on pci interrupt enable");
1087 if ((error = virtio_pci_device_init (vm, vif, args)))
1089 virtio_log_error (vif, "error encountered on device init");
1093 /* create interface */
1094 error = ethernet_register_interface (vnm, virtio_device_class.index,
1095 vif->dev_instance, vif->mac_addr,
1097 virtio_pci_flag_change);
1101 args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
1102 virtio_log_error (vif,
1103 "error encountered on ethernet register interface");
1107 vnet_sw_interface_t *sw = vnet_get_hw_sw_interface (vnm, vif->hw_if_index);
1108 vif->sw_if_index = sw->sw_if_index;
1109 args->sw_if_index = sw->sw_if_index;
1111 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
1112 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
1113 vnet_hw_interface_set_input_node (vnm, vif->hw_if_index,
1114 virtio_input_node.index);
1116 vec_foreach_index (i, vif->rxq_vrings)
1118 vnet_hw_interface_assign_rx_thread (vnm, vif->hw_if_index, i, ~0);
1119 virtio_vring_set_numa_node (vm, vif, RX_QUEUE (i));
1120 /* Set default rx mode to POLLING */
1121 vnet_hw_interface_set_rx_mode (vnm, vif->hw_if_index, i,
1122 VNET_HW_INTERFACE_RX_MODE_POLLING);
1124 if (virtio_pci_is_link_up (vm, vif) & VIRTIO_NET_S_LINK_UP)
1126 vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
1127 vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
1128 VNET_HW_INTERFACE_FLAG_LINK_UP);
1131 vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
1133 virtio_pci_offloads (vm, vif, args->gso_enabled,
1134 args->checksum_offload_enabled);
1136 if ((vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ)) &&
1137 (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MQ)))
1139 if (virtio_pci_enable_multiqueue (vm, vif, vif->max_queue_pairs))
1140 virtio_log_warning (vif, "multiqueue is not set");
1145 virtio_pci_delete_if (vm, vif);
1147 args->rv = VNET_API_ERROR_INVALID_INTERFACE;
1148 args->error = error;
1152 virtio_pci_delete_if (vlib_main_t * vm, virtio_if_t * vif)
1154 vnet_main_t *vnm = vnet_get_main ();
1155 virtio_main_t *vim = &virtio_main;
1158 if (vif->type != VIRTIO_IF_TYPE_PCI)
1159 return VNET_API_ERROR_INVALID_INTERFACE;
1161 vlib_pci_intr_disable (vm, vif->pci_dev_handle);
1163 for (i = 0; i < vif->max_queue_pairs; i++)
1165 vif->virtio_pci_func->del_queue (vm, vif, RX_QUEUE (i));
1166 vif->virtio_pci_func->del_queue (vm, vif, TX_QUEUE (i));
1169 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
1170 vif->virtio_pci_func->del_queue (vm, vif, vif->max_queue_pairs * 2);
1172 vif->virtio_pci_func->device_reset (vm, vif);
1174 if (vif->hw_if_index)
1176 vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
1177 vec_foreach_index (i, vif->rxq_vrings)
1179 vnet_hw_interface_unassign_rx_thread (vnm, vif->hw_if_index, i);
1181 ethernet_delete_interface (vnm, vif->hw_if_index);
1184 vlib_pci_device_close (vm, vif->pci_dev_handle);
1186 vec_foreach_index (i, vif->rxq_vrings)
1188 virtio_vring_t *vring = vec_elt_at_index (vif->rxq_vrings, i);
1189 if (vring->kick_fd != -1)
1190 close (vring->kick_fd);
1193 virtio_free_rx_buffers (vm, vring);
1195 vec_free (vring->buffers);
1196 vlib_physmem_free (vm, vring->desc);
1199 vec_foreach_index (i, vif->txq_vrings)
1201 virtio_vring_t *vring = vec_elt_at_index (vif->txq_vrings, i);
1202 if (vring->kick_fd != -1)
1203 close (vring->kick_fd);
1206 virtio_free_used_desc (vm, vring);
1208 vec_free (vring->buffers);
1209 clib_spinlock_free (&vring->lockp);
1210 vlib_physmem_free (vm, vring->desc);
1213 if (vif->cxq_vring != NULL)
1215 u16 last = vif->cxq_vring->last_used_idx;
1216 u16 n_left = vif->cxq_vring->used->idx - last;
1223 vif->cxq_vring->last_used_idx = last;
1224 vlib_physmem_free (vm, vif->cxq_vring->desc);
1227 vec_free (vif->rxq_vrings);
1228 vec_free (vif->txq_vrings);
1229 vec_free (vif->cxq_vring);
1231 clib_error_free (vif->error);
1232 memset (vif, 0, sizeof (*vif));
1233 pool_put (vim->interfaces, vif);
1239 virtio_pci_enable_disable_offloads (vlib_main_t * vm, virtio_if_t * vif,
1241 int checksum_offload_enabled,
1242 int offloads_disabled)
1244 if (vif->type != VIRTIO_IF_TYPE_PCI)
1245 return VNET_API_ERROR_INVALID_INTERFACE;
1248 virtio_pci_offloads (vm, vif, 1, 0);
1249 else if (checksum_offload_enabled)
1250 virtio_pci_offloads (vm, vif, 0, 1);
1251 else if (offloads_disabled)
1252 virtio_pci_offloads (vm, vif, 0, 0);
1258 * fd.io coding-style-patch-verification: ON
1261 * eval: (c-set-style "gnu")