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,
198 virtio_pci_send_ctrl_msg (vlib_main_t * vm, virtio_if_t * vif,
199 virtio_ctrl_msg_t * data, u32 len)
201 virtio_vring_t *vring = vif->cxq_vring;
202 virtio_net_ctrl_ack_t status = VIRTIO_NET_ERR;
203 virtio_ctrl_msg_t result;
206 u16 used, next, avail;
207 u16 sz = vring->size;
210 used = vring->desc_in_use;
211 next = vring->desc_next;
212 avail = vring->avail->idx;
213 vring_desc_t *d = &vring->desc[next];
215 if (vlib_buffer_alloc (vm, &buffer_index, 1))
216 b = vlib_get_buffer (vm, buffer_index);
218 return VIRTIO_NET_ERR;
220 * current_data may not be initialized with 0 and may contain
224 clib_memcpy (vlib_buffer_get_current (b), data, sizeof (virtio_ctrl_msg_t));
225 d->flags = VRING_DESC_F_NEXT;
226 d->addr = vlib_buffer_get_current_pa (vm, b);
227 d->len = sizeof (virtio_net_ctrl_hdr_t);
228 vring->avail->ring[avail & mask] = next;
230 next = (next + 1) & mask;
234 d = &vring->desc[next];
235 d->flags = VRING_DESC_F_NEXT;
236 d->addr = vlib_buffer_get_current_pa (vm, b) +
237 STRUCT_OFFSET_OF (virtio_ctrl_msg_t, data);
239 next = (next + 1) & mask;
243 d = &vring->desc[next];
244 d->flags = VRING_DESC_F_WRITE;
245 d->addr = vlib_buffer_get_current_pa (vm, b) +
246 STRUCT_OFFSET_OF (virtio_ctrl_msg_t, status);
247 d->len = sizeof (data->status);
248 next = (next + 1) & mask;
251 CLIB_MEMORY_STORE_BARRIER ();
252 vring->avail->idx = avail;
253 vring->desc_next = next;
254 vring->desc_in_use = used;
256 if ((vring->used->flags & VIRTIO_RING_FLAG_MASK_INT) == 0)
258 virtio_kick (vm, vring, vif);
261 u16 last = vring->last_used_idx, n_left = 0;
262 n_left = vring->used->idx - last;
266 vring_used_elem_t *e = &vring->used->ring[last & mask];
269 d = &vring->desc[slot];
270 while (d->flags & VRING_DESC_F_NEXT)
274 d = &vring->desc[slot];
280 vring->desc_in_use = used;
281 vring->last_used_idx = last;
283 CLIB_MEMORY_BARRIER ();
284 clib_memcpy (&result, vlib_buffer_get_current (b),
285 sizeof (virtio_ctrl_msg_t));
286 virtio_log_debug (vif, "ctrl-queue: status %u", result.status);
287 status = result.status;
288 vlib_buffer_free (vm, &buffer_index, 1);
293 virtio_pci_disable_offload (vlib_main_t * vm, virtio_if_t * vif)
295 virtio_ctrl_msg_t offload_hdr;
296 virtio_net_ctrl_ack_t status = VIRTIO_NET_ERR;
298 offload_hdr.ctrl.class = VIRTIO_NET_CTRL_GUEST_OFFLOADS;
299 offload_hdr.ctrl.cmd = VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET;
300 offload_hdr.status = VIRTIO_NET_ERR;
302 clib_memcpy (offload_hdr.data, &offloads, sizeof (offloads));
305 virtio_pci_send_ctrl_msg (vm, vif, &offload_hdr, sizeof (offloads));
306 virtio_log_debug (vif, "disable offloads");
307 vif->remote_features = vif->virtio_pci_func->get_device_features (vm, vif);
308 vif->virtio_pci_func->get_driver_features (vm, vif);
313 virtio_pci_enable_checksum_offload (vlib_main_t * vm, virtio_if_t * vif)
315 virtio_ctrl_msg_t csum_offload_hdr;
316 virtio_net_ctrl_ack_t status = VIRTIO_NET_ERR;
318 csum_offload_hdr.ctrl.class = VIRTIO_NET_CTRL_GUEST_OFFLOADS;
319 csum_offload_hdr.ctrl.cmd = VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET;
320 csum_offload_hdr.status = VIRTIO_NET_ERR;
322 offloads |= VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_CSUM);
323 clib_memcpy (csum_offload_hdr.data, &offloads, sizeof (offloads));
326 virtio_pci_send_ctrl_msg (vm, vif, &csum_offload_hdr, sizeof (offloads));
327 virtio_log_debug (vif, "enable checksum offload");
328 vif->remote_features = vif->virtio_pci_func->get_device_features (vm, vif);
329 vif->features = vif->virtio_pci_func->get_driver_features (vm, vif);
334 virtio_pci_enable_gso (vlib_main_t * vm, virtio_if_t * vif)
336 virtio_ctrl_msg_t gso_hdr;
337 virtio_net_ctrl_ack_t status = VIRTIO_NET_ERR;
339 gso_hdr.ctrl.class = VIRTIO_NET_CTRL_GUEST_OFFLOADS;
340 gso_hdr.ctrl.cmd = VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET;
341 gso_hdr.status = VIRTIO_NET_ERR;
342 u64 offloads = VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_CSUM)
343 | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO4)
344 | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO6);
345 clib_memcpy (gso_hdr.data, &offloads, sizeof (offloads));
347 status = virtio_pci_send_ctrl_msg (vm, vif, &gso_hdr, sizeof (offloads));
348 virtio_log_debug (vif, "enable gso");
349 vif->remote_features = vif->virtio_pci_func->get_device_features (vm, vif);
350 vif->virtio_pci_func->get_driver_features (vm, vif);
355 virtio_pci_offloads (vlib_main_t * vm, virtio_if_t * vif, int gso_enabled,
356 int csum_offload_enabled)
358 vnet_main_t *vnm = vnet_get_main ();
359 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
361 if ((vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ)) &&
362 (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_GUEST_OFFLOADS)))
365 && (vif->features & (VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO4) |
366 VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO6))))
368 if (virtio_pci_enable_gso (vm, vif))
370 virtio_log_warning (vif, "gso is not enabled");
374 vif->gso_enabled = 1;
375 vif->csum_offload_enabled = 0;
376 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO |
377 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
380 else if (csum_offload_enabled
381 && (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CSUM)))
383 if (virtio_pci_enable_checksum_offload (vm, vif))
385 virtio_log_warning (vif, "checksum offload is not enabled");
389 vif->csum_offload_enabled = 1;
390 vif->gso_enabled = 0;
391 hw->flags &= ~VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO;
393 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD;
398 if (virtio_pci_disable_offload (vm, vif))
400 virtio_log_warning (vif, "offloads are not disabled");
404 vif->csum_offload_enabled = 0;
405 vif->gso_enabled = 0;
406 hw->flags &= ~(VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO |
407 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD);
416 virtio_pci_enable_multiqueue (vlib_main_t * vm, virtio_if_t * vif,
419 virtio_ctrl_msg_t mq_hdr;
420 virtio_net_ctrl_ack_t status = VIRTIO_NET_ERR;
422 mq_hdr.ctrl.class = VIRTIO_NET_CTRL_MQ;
423 mq_hdr.ctrl.cmd = VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET;
424 mq_hdr.status = VIRTIO_NET_ERR;
425 clib_memcpy (mq_hdr.data, &num_queues, sizeof (num_queues));
427 status = virtio_pci_send_ctrl_msg (vm, vif, &mq_hdr, sizeof (num_queues));
428 virtio_log_debug (vif, "multi-queue enable %u queues", num_queues);
433 virtio_pci_queue_size_valid (u16 qsz)
435 if (qsz < 64 || qsz > 4096)
443 virtio_pci_control_vring_init (vlib_main_t * vm, virtio_if_t * vif,
446 clib_error_t *error = 0;
448 virtio_vring_t *vring;
453 queue_size = vif->virtio_pci_func->get_queue_size (vm, vif, queue_num);
454 if (!virtio_pci_queue_size_valid (queue_size))
455 clib_warning ("queue size is not valid");
457 if (!is_pow2 (queue_size))
458 return clib_error_return (0, "ring size must be power of 2");
460 if (queue_size > 32768)
461 return clib_error_return (0, "ring size must be 32768 or lower");
466 vec_validate_aligned (vif->cxq_vring, 0, CLIB_CACHE_LINE_BYTES);
467 vring = vec_elt_at_index (vif->cxq_vring, 0);
468 i = vring_size (queue_size, VIRTIO_PCI_VRING_ALIGN);
469 i = round_pow2 (i, VIRTIO_PCI_VRING_ALIGN);
471 vlib_physmem_alloc_aligned_on_numa (vm, i, VIRTIO_PCI_VRING_ALIGN,
474 return vlib_physmem_last_error (vm);
475 clib_memset (ptr, 0, i);
476 vring_init (&vr, queue_size, ptr, VIRTIO_PCI_VRING_ALIGN);
477 vring->desc = vr.desc;
478 vring->avail = vr.avail;
479 vring->used = vr.used;
480 vring->queue_id = queue_num;
481 vring->avail->flags = VIRTIO_RING_FLAG_MASK_INT;
483 ASSERT (vring->buffers == 0);
485 vring->size = queue_size;
486 virtio_log_debug (vif, "control-queue: number %u, size %u", queue_num,
488 vif->virtio_pci_func->setup_queue (vm, vif, queue_num, ptr);
489 vring->queue_notify_offset =
490 vif->notify_off_multiplier *
491 vif->virtio_pci_func->get_queue_notify_off (vm, vif, queue_num);
492 virtio_log_debug (vif, "queue-notify-offset: number %u, offset %u",
493 queue_num, vring->queue_notify_offset);
499 virtio_pci_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 queue_num)
501 vlib_thread_main_t *vtm = vlib_get_thread_main ();
502 clib_error_t *error = 0;
504 virtio_vring_t *vring;
509 queue_size = vif->virtio_pci_func->get_queue_size (vm, vif, queue_num);
510 if (!virtio_pci_queue_size_valid (queue_size))
511 clib_warning ("queue size is not valid");
513 if (!is_pow2 (queue_size))
514 return clib_error_return (0, "ring size must be power of 2");
516 if (queue_size > 32768)
517 return clib_error_return (0, "ring size must be 32768 or lower");
524 vec_validate_aligned (vif->txq_vrings, TX_QUEUE_ACCESS (queue_num),
525 CLIB_CACHE_LINE_BYTES);
526 vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (queue_num));
527 if (vif->max_queue_pairs < vtm->n_vlib_mains)
528 clib_spinlock_init (&vring->lockp);
532 vec_validate_aligned (vif->rxq_vrings, RX_QUEUE_ACCESS (queue_num),
533 CLIB_CACHE_LINE_BYTES);
534 vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (queue_num));
536 i = vring_size (queue_size, VIRTIO_PCI_VRING_ALIGN);
537 i = round_pow2 (i, VIRTIO_PCI_VRING_ALIGN);
539 vlib_physmem_alloc_aligned_on_numa (vm, i, VIRTIO_PCI_VRING_ALIGN,
542 return vlib_physmem_last_error (vm);
543 clib_memset (ptr, 0, i);
544 vring_init (&vr, queue_size, ptr, VIRTIO_PCI_VRING_ALIGN);
545 vring->desc = vr.desc;
546 vring->avail = vr.avail;
547 vring->used = vr.used;
548 vring->queue_id = queue_num;
549 vring->avail->flags = VIRTIO_RING_FLAG_MASK_INT;
550 vring->flow_table = 0;
552 ASSERT (vring->buffers == 0);
553 vec_validate_aligned (vring->buffers, queue_size, CLIB_CACHE_LINE_BYTES);
556 virtio_log_debug (vif, "tx-queue: number %u, size %u", queue_num,
558 clib_memset_u32 (vring->buffers, ~0, queue_size);
562 virtio_log_debug (vif, "rx-queue: number %u, size %u", queue_num,
565 vring->size = queue_size;
566 if (vif->virtio_pci_func->setup_queue (vm, vif, queue_num, ptr))
567 return clib_error_return (0, "error in queue address setup");
569 vring->queue_notify_offset =
570 vif->notify_off_multiplier *
571 vif->virtio_pci_func->get_queue_notify_off (vm, vif, queue_num);
572 virtio_log_debug (vif, "queue-notify-offset: number %u, offset %u",
573 queue_num, vring->queue_notify_offset);
578 virtio_negotiate_features (vlib_main_t * vm, virtio_if_t * vif,
582 * if features are not requested
583 * default: all supported features
585 u64 supported_features = VIRTIO_FEATURE (VIRTIO_NET_F_CSUM)
586 | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_CSUM)
587 | VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_GUEST_OFFLOADS)
588 | VIRTIO_FEATURE (VIRTIO_NET_F_MTU)
589 | VIRTIO_FEATURE (VIRTIO_NET_F_MAC)
590 | VIRTIO_FEATURE (VIRTIO_NET_F_GSO)
591 | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO4)
592 | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO6)
593 | VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_UFO)
594 | VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO4)
595 | VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO6)
596 | VIRTIO_FEATURE (VIRTIO_NET_F_HOST_UFO)
597 | VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF)
598 | VIRTIO_FEATURE (VIRTIO_NET_F_STATUS)
599 | VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ)
600 | VIRTIO_FEATURE (VIRTIO_NET_F_MQ)
601 | VIRTIO_FEATURE (VIRTIO_F_NOTIFY_ON_EMPTY)
602 | VIRTIO_FEATURE (VIRTIO_F_ANY_LAYOUT)
603 | VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);
606 supported_features |= VIRTIO_FEATURE (VIRTIO_F_VERSION_1);
608 if (req_features == 0)
610 req_features = supported_features;
613 vif->features = req_features & vif->remote_features & supported_features;
615 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MTU))
618 mtu = vif->virtio_pci_func->get_mtu (vm, vif);
621 vif->features &= ~VIRTIO_FEATURE (VIRTIO_NET_F_MTU);
624 vif->virtio_pci_func->set_driver_features (vm, vif, vif->features);
625 vif->features = vif->virtio_pci_func->get_driver_features (vm, vif);
629 virtio_pci_read_device_feature (vlib_main_t * vm, virtio_if_t * vif)
631 vif->remote_features = vif->virtio_pci_func->get_device_features (vm, vif);
635 virtio_pci_reset_device (vlib_main_t * vm, virtio_if_t * vif)
642 status = vif->virtio_pci_func->device_reset (vm, vif);
645 * Set the Acknowledge status bit
647 vif->virtio_pci_func->set_status (vm, vif, VIRTIO_CONFIG_STATUS_ACK);
650 * Set the Driver status bit
652 vif->virtio_pci_func->set_status (vm, vif, VIRTIO_CONFIG_STATUS_DRIVER);
655 * Read the status and verify it
657 status = vif->virtio_pci_func->get_status (vm, vif);
658 if ((status & VIRTIO_CONFIG_STATUS_ACK)
659 && (status & VIRTIO_CONFIG_STATUS_DRIVER))
660 vif->status = status;
668 virtio_pci_read_caps (vlib_main_t * vm, virtio_if_t * vif, void **bar)
670 clib_error_t *error = 0;
671 virtio_pci_cap_t cap;
672 u8 pos, common_cfg = 0, notify = 0, dev_cfg = 0, isr = 0, pci_cfg = 0;
673 vlib_pci_dev_handle_t h = vif->pci_dev_handle;
675 if ((error = vlib_pci_read_config_u8 (vm, h, PCI_CAPABILITY_LIST, &pos)))
677 virtio_log_error (vif, "error in reading capabilty list position");
678 return clib_error_return (error,
679 "error in reading capabilty list position");
684 vlib_pci_read_write_config (vm, h, VLIB_READ, pos, &cap,
687 virtio_log_error (vif, "%s [%2x]",
688 "error in reading the capability at", pos);
689 return clib_error_return (error,
690 "error in reading the capability at [%2x]",
694 if (cap.cap_vndr == PCI_CAP_ID_MSIX)
696 u16 flags, table_size, table_size_mask = 0x07FF;
699 vlib_pci_read_write_config (vm, h, VLIB_READ, pos + 2, &flags,
701 return clib_error_return (error,
702 "error in reading the capability at [%2x]",
705 table_size = flags & table_size_mask;
706 virtio_log_debug (vif, "flags:0x%x %s 0x%x", flags,
707 "msix interrupt vector table-size", table_size);
709 if (flags & PCI_MSIX_ENABLE)
711 virtio_log_debug (vif, "msix interrupt enabled");
712 vif->msix_enabled = VIRTIO_MSIX_ENABLED;
713 vif->msix_table_size = table_size;
717 virtio_log_debug (vif, "msix interrupt disabled");
718 vif->msix_enabled = VIRTIO_MSIX_DISABLED;
719 vif->msix_table_size = 0;
723 if (cap.cap_vndr != PCI_CAP_ID_VNDR)
725 virtio_log_debug (vif, "[%2x] %s %2x ", pos,
726 "skipping non VNDR cap id:", cap.cap_vndr);
730 virtio_log_debug (vif,
731 "[%4x] cfg type: %u, bar: %u, offset: %04x, len: %u",
732 pos, cap.cfg_type, cap.bar, cap.offset, cap.length);
734 if (cap.bar >= 0 && cap.bar <= 5)
736 vif->bar = bar[cap.bar];
737 vif->bar_id = cap.bar;
740 return clib_error_return (error, "invalid bar %u", cap.bar);
742 switch (cap.cfg_type)
744 case VIRTIO_PCI_CAP_COMMON_CFG:
745 vif->common_offset = cap.offset;
748 case VIRTIO_PCI_CAP_NOTIFY_CFG:
750 vlib_pci_read_write_config (vm, h, VLIB_READ,
752 &vif->notify_off_multiplier,
754 (vif->notify_off_multiplier))))
756 virtio_log_error (vif, "notify off multiplier is not given");
760 virtio_log_debug (vif, "notify off multiplier is %u",
761 vif->notify_off_multiplier);
762 vif->notify_offset = cap.offset;
766 case VIRTIO_PCI_CAP_DEVICE_CFG:
767 vif->device_offset = cap.offset;
770 case VIRTIO_PCI_CAP_ISR_CFG:
771 vif->isr_offset = cap.offset;
774 case VIRTIO_PCI_CAP_PCI_CFG:
783 if (common_cfg == 0 || notify == 0 || dev_cfg == 0 || isr == 0)
785 vif->virtio_pci_func = &virtio_pci_legacy_func;
786 vif->notify_off_multiplier = 0;
787 virtio_log_debug (vif, "legacy virtio pci device found");
792 vif->virtio_pci_func = &virtio_pci_modern_func;
796 virtio_log_debug (vif, "modern virtio pci device found");
800 virtio_log_debug (vif, "transitional virtio pci device found");
806 static clib_error_t *
807 virtio_pci_device_init (vlib_main_t * vm, virtio_if_t * vif,
808 virtio_pci_create_if_args_t * args, void **bar)
810 clib_error_t *error = 0;
811 vlib_thread_main_t *vtm = vlib_get_thread_main ();
814 if ((error = virtio_pci_read_caps (vm, vif, bar)))
816 args->rv = VNET_API_ERROR_UNSUPPORTED;
817 virtio_log_error (vif, "Device is not supported");
818 return clib_error_return (error, "Device is not supported");
821 if (virtio_pci_reset_device (vm, vif) < 0)
823 args->rv = VNET_API_ERROR_INIT_FAILED;
824 virtio_log_error (vif, "Failed to reset the device");
825 return clib_error_return (error, "Failed to reset the device");
828 * read device features and negotiate (user) requested features
830 virtio_pci_read_device_feature (vm, vif);
831 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC)) ==
834 virtio_log_warning (vif, "error encountered: vhost-net backend doesn't "
835 "support VIRTIO_RING_F_INDIRECT_DESC features");
837 if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF)) == 0)
839 virtio_log_warning (vif, "error encountered: vhost-net backend doesn't "
840 "support VIRTIO_NET_F_MRG_RXBUF features");
842 virtio_negotiate_features (vm, vif, args->features);
845 * After FEATURE_OK, driver should not accept new feature bits
847 vif->virtio_pci_func->set_status (vm, vif,
848 VIRTIO_CONFIG_STATUS_FEATURES_OK);
849 status = vif->virtio_pci_func->get_status (vm, vif);
850 if (!(status & VIRTIO_CONFIG_STATUS_FEATURES_OK))
852 args->rv = VNET_API_ERROR_UNSUPPORTED;
853 virtio_log_error (vif,
854 "error encountered: Device doesn't support requested features");
855 return clib_error_return (error,
856 "Device doesn't support requested features");
858 vif->status = status;
861 * get or set the mac address
863 if (virtio_pci_get_mac (vm, vif))
865 f64 now = vlib_time_now (vm);
867 rnd = (u32) (now * 1e6);
868 rnd = random_u32 (&rnd);
870 memcpy (vif->mac_addr + 2, &rnd, sizeof (rnd));
871 vif->mac_addr[0] = 2;
872 vif->mac_addr[1] = 0xfe;
873 virtio_pci_set_mac (vm, vif);
876 virtio_set_net_hdr_size (vif);
879 * Initialize the virtqueues
881 if ((error = virtio_pci_get_max_virtqueue_pairs (vm, vif)))
883 args->rv = VNET_API_ERROR_EXCEEDED_NUMBER_OF_RANGES_CAPACITY;
887 if (vif->msix_enabled == VIRTIO_MSIX_ENABLED)
889 if (vif->msix_table_size <= vif->max_queue_pairs)
891 virtio_log_error (vif,
892 "error MSIX lines (%u) <= Number of RXQs (%u)",
893 vif->msix_table_size, vif->max_queue_pairs);
894 return clib_error_return (error,
895 "error MSIX lines (%u) <= Number of RXQs (%u)",
896 vif->msix_table_size,
897 vif->max_queue_pairs);
901 for (int i = 0; i < vif->max_queue_pairs; i++)
903 if ((error = virtio_pci_vring_init (vm, vif, RX_QUEUE (i))))
905 args->rv = VNET_API_ERROR_INIT_FAILED;
906 virtio_log_error (vif, "%s (%u) %s", "error in rxq-queue",
907 RX_QUEUE (i), "initialization");
909 clib_error_return (error, "%s (%u) %s", "error in rxq-queue",
910 RX_QUEUE (i), "initialization");
918 if (i >= vtm->n_vlib_mains)
921 * There is 1:1 mapping between tx queue and vpp worker thread.
922 * tx queue 0 is bind with thread index 0, tx queue 1 on thread
924 * Multiple worker threads can poll same tx queue when number of
925 * workers are more than tx queues. In this case, 1:N mapping
926 * between tx queue and vpp worker thread.
928 virtio_log_debug (vif, "%s %u, %s", "tx-queue: number",
930 "no VPP worker thread is available");
934 if ((error = virtio_pci_vring_init (vm, vif, TX_QUEUE (i))))
936 args->rv = VNET_API_ERROR_INIT_FAILED;
937 virtio_log_error (vif, "%s (%u) %s", "error in txq-queue",
938 TX_QUEUE (i), "initialization");
940 clib_error_return (error, "%s (%u) %s", "error in txq-queue",
941 TX_QUEUE (i), "initialization");
950 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
953 virtio_pci_control_vring_init (vm, vif, vif->max_queue_pairs * 2)))
955 virtio_log_warning (vif, "%s (%u) %s", "error in control-queue",
956 vif->max_queue_pairs * 2, "initialization");
957 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MQ))
958 vif->features &= ~VIRTIO_FEATURE (VIRTIO_NET_F_MQ);
963 virtio_log_debug (vif, "control queue is not available");
964 vif->cxq_vring = NULL;
968 * set the msix interrupts
970 if (vif->msix_enabled == VIRTIO_MSIX_ENABLED)
973 if (vif->virtio_pci_func->set_config_irq (vm, vif, 0) ==
974 VIRTIO_MSI_NO_VECTOR)
976 virtio_log_warning (vif, "config vector 0 is not set");
980 virtio_log_debug (vif, "config msix vector is set at 0");
982 for (i = 0, j = 1; i < vif->max_queue_pairs; i++, j++)
984 if (vif->virtio_pci_func->set_queue_irq (vm, vif, j,
986 VIRTIO_MSI_NO_VECTOR)
988 virtio_log_warning (vif, "queue (%u) vector is not set at %u",
993 virtio_log_debug (vif, "%s (%u) %s %u", "queue",
994 RX_QUEUE (i), "msix vector is set at", j);
1000 * set the driver status OK
1002 vif->virtio_pci_func->set_status (vm, vif, VIRTIO_CONFIG_STATUS_DRIVER_OK);
1003 vif->status = vif->virtio_pci_func->get_status (vm, vif);
1009 virtio_pci_create_if (vlib_main_t * vm, virtio_pci_create_if_args_t * args)
1011 vnet_main_t *vnm = vnet_get_main ();
1012 virtio_main_t *vim = &virtio_main;
1014 vlib_pci_dev_handle_t h;
1015 clib_error_t *error = 0;
1016 u32 interrupt_count = 0;
1019 pool_foreach (vif, vim->interfaces, ({
1020 if (vif->pci_addr.as_u32 == args->addr)
1022 args->rv = VNET_API_ERROR_ADDRESS_IN_USE;
1024 clib_error_return (error, "PCI address in use");
1025 vlib_log (VLIB_LOG_LEVEL_ERR, vim->log_default, "%U: %s",
1026 format_vlib_pci_addr, &args->addr,
1027 " PCI address in use");
1033 pool_get (vim->interfaces, vif);
1034 vif->dev_instance = vif - vim->interfaces;
1035 vif->per_interface_next_index = ~0;
1036 vif->pci_addr.as_u32 = args->addr;
1039 vlib_pci_device_open (vm, (vlib_pci_addr_t *) & vif->pci_addr,
1040 virtio_pci_device_ids, &h)))
1042 args->rv = VNET_API_ERROR_INVALID_INTERFACE;
1044 clib_error_return (error, "pci-addr %U", format_vlib_pci_addr,
1046 vlib_log (VLIB_LOG_LEVEL_ERR, vim->log_default, "%U: %s",
1047 format_vlib_pci_addr, &vif->pci_addr,
1048 "error encountered on pci device open");
1049 pool_put (vim->interfaces, vif);
1052 vif->pci_dev_handle = h;
1053 vlib_pci_set_private_data (vm, h, vif->dev_instance);
1054 vif->numa_node = vlib_pci_get_numa_node (vm, h);
1055 vif->type = VIRTIO_IF_TYPE_PCI;
1057 if ((error = vlib_pci_bus_master_enable (vm, h)))
1059 virtio_log_error (vif, "error encountered on pci bus master enable");
1064 for (u32 i = 0; i <= 5; i++)
1067 if ((error = vlib_pci_map_region (vm, h, i, &bar[i])))
1069 virtio_log_debug (vif, "no pci map region for bar %u", i);
1073 virtio_log_debug (vif, "pci map region for bar %u at %p", i,
1078 if ((error = vlib_pci_io_region (vm, h, 0)))
1080 virtio_log_error (vif, "error encountered on pci io region");
1084 interrupt_count = vlib_pci_get_num_msix_interrupts (vm, h);
1085 if (interrupt_count > 1)
1087 if ((error = vlib_pci_register_msix_handler (vm, h, 0, 1,
1088 &virtio_pci_irq_config_handler)))
1090 args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
1091 virtio_log_error (vif,
1092 "error encountered on pci register msix handler 0");
1097 vlib_pci_register_msix_handler (vm, h, 1, (interrupt_count - 1),
1098 &virtio_pci_irq_queue_handler)))
1100 args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
1101 virtio_log_error (vif,
1102 "error encountered on pci register msix handler 1");
1106 if ((error = vlib_pci_enable_msix_irq (vm, h, 0, interrupt_count)))
1108 virtio_log_error (vif, "error encountered on pci enable msix irq");
1111 vif->support_int_mode = 1;
1112 virtio_log_debug (vif, "device supports msix interrupts");
1114 else if (interrupt_count == 1)
1117 * if msix table-size is 1, fall back to intX.
1120 vlib_pci_register_intx_handler (vm, h, &virtio_pci_irq_handler)))
1122 virtio_log_error (vif,
1123 "error encountered on pci register interrupt handler");
1126 vif->support_int_mode = 1;
1127 virtio_log_debug (vif, "pci register interrupt handler");
1132 * WARN: intX is showing some weird behaviour.
1133 * Please don't use interrupt mode with UIO driver.
1135 vif->support_int_mode = 0;
1136 virtio_log_debug (vif, "driver is configured in poll mode only");
1139 if ((error = vlib_pci_intr_enable (vm, h)))
1141 virtio_log_error (vif, "error encountered on pci interrupt enable");
1145 if ((error = virtio_pci_device_init (vm, vif, args, bar)))
1147 virtio_log_error (vif, "error encountered on device init");
1151 /* create interface */
1152 error = ethernet_register_interface (vnm, virtio_device_class.index,
1153 vif->dev_instance, vif->mac_addr,
1155 virtio_pci_flag_change);
1159 args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
1160 virtio_log_error (vif,
1161 "error encountered on ethernet register interface");
1165 vnet_sw_interface_t *sw = vnet_get_hw_sw_interface (vnm, vif->hw_if_index);
1166 vif->sw_if_index = sw->sw_if_index;
1167 args->sw_if_index = sw->sw_if_index;
1169 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
1170 hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
1172 if (args->virtio_flags & VIRTIO_FLAG_BUFFERING)
1174 error = virtio_set_packet_buffering (vif, args->buffering_size);
1177 args->rv = VNET_API_ERROR_INIT_FAILED;
1178 virtio_log_error (vif,
1179 "error encountered during packet buffering init");
1184 vnet_hw_interface_set_input_node (vnm, vif->hw_if_index,
1185 virtio_input_node.index);
1187 vec_foreach_index (i, vif->rxq_vrings)
1189 vnet_hw_interface_assign_rx_thread (vnm, vif->hw_if_index, i, ~0);
1190 virtio_vring_set_numa_node (vm, vif, RX_QUEUE (i));
1191 /* Set default rx mode to POLLING */
1192 vnet_hw_interface_set_rx_mode (vnm, vif->hw_if_index, i,
1193 VNET_HW_IF_RX_MODE_POLLING);
1195 if (virtio_pci_is_link_up (vm, vif) & VIRTIO_NET_S_LINK_UP)
1197 vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
1198 vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
1199 VNET_HW_INTERFACE_FLAG_LINK_UP);
1202 vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
1204 virtio_pci_offloads (vm, vif, args->gso_enabled,
1205 args->checksum_offload_enabled);
1207 if ((vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ)) &&
1208 (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MQ)))
1210 if (virtio_pci_enable_multiqueue (vm, vif, vif->max_queue_pairs))
1211 virtio_log_warning (vif, "multiqueue is not set");
1216 virtio_pci_delete_if (vm, vif);
1218 args->rv = VNET_API_ERROR_INVALID_INTERFACE;
1219 args->error = error;
1223 virtio_pci_delete_if (vlib_main_t * vm, virtio_if_t * vif)
1225 vnet_main_t *vnm = vnet_get_main ();
1226 virtio_main_t *vim = &virtio_main;
1229 if (vif->type != VIRTIO_IF_TYPE_PCI)
1230 return VNET_API_ERROR_INVALID_INTERFACE;
1232 vlib_pci_intr_disable (vm, vif->pci_dev_handle);
1234 for (i = 0; i < vif->max_queue_pairs; i++)
1236 vif->virtio_pci_func->del_queue (vm, vif, RX_QUEUE (i));
1237 vif->virtio_pci_func->del_queue (vm, vif, TX_QUEUE (i));
1240 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
1241 vif->virtio_pci_func->del_queue (vm, vif, vif->max_queue_pairs * 2);
1243 if (vif->virtio_pci_func)
1244 vif->virtio_pci_func->device_reset (vm, vif);
1246 if (vif->hw_if_index)
1248 vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
1249 vec_foreach_index (i, vif->rxq_vrings)
1251 vnet_hw_interface_unassign_rx_thread (vnm, vif->hw_if_index, i);
1253 ethernet_delete_interface (vnm, vif->hw_if_index);
1256 vlib_pci_device_close (vm, vif->pci_dev_handle);
1258 vec_foreach_index (i, vif->rxq_vrings)
1260 virtio_vring_t *vring = vec_elt_at_index (vif->rxq_vrings, i);
1263 virtio_free_rx_buffers (vm, vring);
1265 vec_free (vring->buffers);
1266 vlib_physmem_free (vm, vring->desc);
1269 vec_foreach_index (i, vif->txq_vrings)
1271 virtio_vring_t *vring = vec_elt_at_index (vif->txq_vrings, i);
1274 virtio_free_used_desc (vm, vring);
1276 vec_free (vring->buffers);
1277 clib_spinlock_free (&vring->lockp);
1278 vlib_physmem_free (vm, vring->desc);
1281 if (vif->cxq_vring != NULL)
1283 u16 last = vif->cxq_vring->last_used_idx;
1284 u16 n_left = vif->cxq_vring->used->idx - last;
1291 vif->cxq_vring->last_used_idx = last;
1292 vlib_physmem_free (vm, vif->cxq_vring->desc);
1295 vec_free (vif->rxq_vrings);
1296 vec_free (vif->txq_vrings);
1297 vec_free (vif->cxq_vring);
1299 clib_error_free (vif->error);
1300 memset (vif, 0, sizeof (*vif));
1301 pool_put (vim->interfaces, vif);
1307 virtio_pci_enable_disable_offloads (vlib_main_t * vm, virtio_if_t * vif,
1309 int checksum_offload_enabled,
1310 int offloads_disabled)
1312 if (vif->type != VIRTIO_IF_TYPE_PCI)
1313 return VNET_API_ERROR_INVALID_INTERFACE;
1316 virtio_pci_offloads (vm, vif, 1, 0);
1317 else if (checksum_offload_enabled)
1318 virtio_pci_offloads (vm, vif, 0, 1);
1319 else if (offloads_disabled)
1320 virtio_pci_offloads (vm, vif, 0, 0);
1326 * fd.io coding-style-patch-verification: ON
1329 * eval: (c-set-style "gnu")