2 *------------------------------------------------------------------
3 * Copyright (c) 2017 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
18 #include <sys/types.h>
22 #include <linux/if_tun.h>
23 #include <sys/ioctl.h>
24 #include <sys/eventfd.h>
26 #include <vlib/vlib.h>
27 #include <vlib/pci/pci.h>
28 #include <vlib/unix/unix.h>
29 #include <vnet/ethernet/ethernet.h>
30 #include <vnet/ip/ip4_packet.h>
31 #include <vnet/ip/ip6_packet.h>
32 #include <vnet/devices/virtio/virtio.h>
33 #include <vnet/devices/virtio/virtio_inline.h>
34 #include <vnet/devices/virtio/pci.h>
35 #include <vnet/interface/rx_queue_funcs.h>
37 virtio_main_t virtio_main;
39 #define _IOCTL(fd,a,...) \
40 if (ioctl (fd, a, __VA_ARGS__) < 0) \
42 err = clib_error_return_unix (0, "ioctl(" #a ")"); \
47 call_read_ready (clib_file_t * uf)
49 vnet_main_t *vnm = vnet_get_main ();
52 CLIB_UNUSED (ssize_t size) = read (uf->file_descriptor, &b, sizeof (b));
53 vnet_hw_if_rx_queue_set_int_pending (vnm, uf->private_data);
60 virtio_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 idx, u16 sz)
62 virtio_vring_t *vring;
66 return clib_error_return (0, "ring size must be power of 2");
69 return clib_error_return (0, "ring size must be 32768 or lower");
76 vlib_thread_main_t *thm = vlib_get_thread_main ();
77 vec_validate_aligned (vif->txq_vrings, TX_QUEUE_ACCESS (idx),
78 CLIB_CACHE_LINE_BYTES);
79 vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (idx));
80 if (thm->n_vlib_mains > vif->num_txqs)
81 clib_spinlock_init (&vring->lockp);
85 vec_validate_aligned (vif->rxq_vrings, RX_QUEUE_ACCESS (idx),
86 CLIB_CACHE_LINE_BYTES);
87 vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (idx));
89 i = sizeof (vring_desc_t) * sz;
90 i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
91 vring->desc = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
92 clib_memset (vring->desc, 0, i);
94 i = sizeof (vring_avail_t) + sz * sizeof (vring->avail->ring[0]);
95 i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
96 vring->avail = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
97 clib_memset (vring->avail, 0, i);
98 // tell kernel that we don't need interrupt
99 vring->avail->flags = VRING_AVAIL_F_NO_INTERRUPT;
101 i = sizeof (vring_used_t) + sz * sizeof (vring_used_elem_t);
102 i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
103 vring->used = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
104 clib_memset (vring->used, 0, i);
106 vring->queue_id = idx;
107 ASSERT (vring->buffers == 0);
108 vec_validate_aligned (vring->buffers, sz, CLIB_CACHE_LINE_BYTES);
112 clib_memset_u32 (vring->buffers, ~0, sz);
113 // tx path: suppress the interrupts from kernel
117 vring->call_fd = eventfd (0, EFD_NONBLOCK | EFD_CLOEXEC);
120 vring->kick_fd = eventfd (0, EFD_NONBLOCK | EFD_CLOEXEC);
121 virtio_log_debug (vif, "vring %u size %u call_fd %d kick_fd %d", idx,
122 vring->size, vring->call_fd, vring->kick_fd);
128 virtio_free_buffers (vlib_main_t * vm, virtio_vring_t * vring)
130 u16 used = vring->desc_in_use;
131 u16 last = vring->last_used_idx;
132 u16 mask = vring->size - 1;
136 vlib_buffer_free (vm, &vring->buffers[last & mask], 1);
143 virtio_vring_free_rx (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
145 virtio_vring_t *vring =
146 vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (idx));
148 clib_file_del_by_index (&file_main, vring->call_file_index);
149 close (vring->kick_fd);
150 close (vring->call_fd);
153 virtio_free_buffers (vm, vring);
154 clib_mem_free (vring->used);
157 clib_mem_free (vring->desc);
159 clib_mem_free (vring->avail);
160 vec_free (vring->buffers);
165 virtio_vring_free_tx (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
167 virtio_vring_t *vring =
168 vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (idx));
170 close (vring->kick_fd);
173 virtio_free_buffers (vm, vring);
174 clib_mem_free (vring->used);
177 clib_mem_free (vring->desc);
179 clib_mem_free (vring->avail);
180 vec_free (vring->buffers);
181 gro_flow_table_free (vring->flow_table);
182 virtio_vring_buffering_free (vm, vring->buffering);
183 clib_spinlock_free (&vring->lockp);
188 virtio_set_packet_coalesce (virtio_if_t * vif)
190 vnet_main_t *vnm = vnet_get_main ();
191 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
192 virtio_vring_t *vring;
193 vif->packet_coalesce = 1;
194 vec_foreach (vring, vif->txq_vrings)
196 gro_flow_table_init (&vring->flow_table,
197 vif->type & (VIRTIO_IF_TYPE_TAP |
198 VIRTIO_IF_TYPE_PCI), hw->tx_node_index);
203 virtio_set_packet_buffering (virtio_if_t * vif, u16 buffering_size)
205 vnet_main_t *vnm = vnet_get_main ();
206 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
207 virtio_vring_t *vring;
208 clib_error_t *error = 0;
209 vif->packet_buffering = 1;
211 vec_foreach (vring, vif->txq_vrings)
214 virtio_vring_buffering_init (&vring->buffering, hw->tx_node_index,
225 virtio_vring_fill (vlib_main_t *vm, virtio_if_t *vif, virtio_vring_t *vring)
228 virtio_refill_vring_packed (vm, vif, vif->type, vring,
229 vif->virtio_net_hdr_sz,
230 virtio_input_node.index);
232 virtio_refill_vring_split (vm, vif, vif->type, vring,
233 vif->virtio_net_hdr_sz,
234 virtio_input_node.index);
238 virtio_vring_set_rx_queues (vlib_main_t *vm, virtio_if_t *vif)
240 vnet_main_t *vnm = vnet_get_main ();
241 virtio_vring_t *vring;
244 vnet_hw_if_set_input_node (vnm, vif->hw_if_index, virtio_input_node.index);
246 vec_foreach (vring, vif->rxq_vrings)
248 vring->queue_index = vnet_hw_if_register_rx_queue (
249 vnm, vif->hw_if_index, RX_QUEUE_ACCESS (vring->queue_id),
250 VNET_HW_IF_RXQ_THREAD_ANY);
251 vring->buffer_pool_index = vlib_buffer_pool_get_default_for_numa (
252 vm, vnet_hw_if_get_rx_queue_numa_node (vnm, vring->queue_index));
253 if (vif->type == VIRTIO_IF_TYPE_TAP || vif->type == VIRTIO_IF_TYPE_TUN)
257 .read_function = call_read_ready,
258 .flags = UNIX_FILE_EVENT_EDGE_TRIGGERED,
259 .file_descriptor = vring->call_fd,
260 .private_data = vring->queue_index,
261 .description = format (0, "%U vring %u", format_virtio_device_name,
262 vif->dev_instance, vring->queue_id),
265 vring->call_file_index = clib_file_add (&file_main, &f);
266 vnet_hw_if_set_rx_queue_file_index (vnm, vring->queue_index,
267 vring->call_file_index);
269 else if ((vif->type == VIRTIO_IF_TYPE_PCI) && (vif->support_int_mode) &&
270 (vif->msix_enabled == VIRTIO_MSIX_ENABLED))
274 vlib_pci_get_msix_file_index (vm, vif->pci_dev_handle, i + 1);
275 vnet_hw_if_set_rx_queue_file_index (vnm, vring->queue_index,
279 vnet_hw_if_set_rx_queue_mode (vnm, vring->queue_index,
280 VNET_HW_IF_RX_MODE_POLLING);
281 vring->mode = VNET_HW_IF_RX_MODE_POLLING;
282 virtio_vring_fill (vm, vif, vring);
284 vnet_hw_if_update_runtime_data (vnm, vif->hw_if_index);
288 virtio_set_net_hdr_size (virtio_if_t * vif)
290 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF) ||
291 vif->features & VIRTIO_FEATURE (VIRTIO_F_VERSION_1))
292 vif->virtio_net_hdr_sz = sizeof (virtio_net_hdr_v1_t);
294 vif->virtio_net_hdr_sz = sizeof (virtio_net_hdr_t);
298 virtio_show (vlib_main_t *vm, u32 *hw_if_indices, u8 show_descr,
299 virtio_if_type_t type)
301 u32 i, j, hw_if_index;
303 vnet_main_t *vnm = &vnet_main;
304 virtio_main_t *mm = &virtio_main;
305 virtio_vring_t *vring;
311 struct feat_struct *feat_entry;
313 static struct feat_struct feat_array[] = {
314 #define _(s,b) { .str = #s, .bit = b, },
315 foreach_virtio_net_features
320 struct feat_struct *flag_entry;
321 static struct feat_struct flags_array[] = {
322 #define _(b,e,s) { .bit = b, .str = s, },
323 foreach_virtio_if_flag
331 for (hw_if_index = 0; hw_if_index < vec_len (hw_if_indices); hw_if_index++)
333 vnet_hw_interface_t *hi =
334 vnet_get_hw_interface (vnm, hw_if_indices[hw_if_index]);
335 vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
336 if (vif->type != type)
338 vlib_cli_output (vm, "Interface: %U (ifindex %d)",
339 format_vnet_hw_if_index_name, vnm,
340 hw_if_indices[hw_if_index], vif->hw_if_index);
341 if (type == VIRTIO_IF_TYPE_PCI)
343 vlib_cli_output (vm, " PCI Address: %U", format_vlib_pci_addr,
346 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
349 if (vif->host_if_name)
350 vlib_cli_output (vm, " name \"%s\"", vif->host_if_name);
352 vlib_cli_output (vm, " host-ns \"%s\"", vif->net_ns);
353 if (vif->host_mtu_size)
354 vlib_cli_output (vm, " host-mtu-size \"%d\"",
356 if (type == VIRTIO_IF_TYPE_TAP)
357 vlib_cli_output (vm, " host-mac-addr: %U",
358 format_ethernet_address, vif->host_mac_addr);
359 vlib_cli_output (vm, " host-carrier-up: %u", vif->host_carrier_up);
361 vec_foreach_index (i, vif->vhost_fds)
362 str = format (str, " %d", vif->vhost_fds[i]);
363 vlib_cli_output (vm, " vhost-fds%v", str);
365 vec_foreach_index (i, vif->tap_fds)
366 str = format (str, " %d", vif->tap_fds[i]);
367 vlib_cli_output (vm, " tap-fds%v", str);
370 vlib_cli_output (vm, " gso-enabled %d", vif->gso_enabled);
371 vlib_cli_output (vm, " csum-enabled %d", vif->csum_offload_enabled);
372 vlib_cli_output (vm, " packet-coalesce %d", vif->packet_coalesce);
373 vlib_cli_output (vm, " packet-buffering %d", vif->packet_buffering);
374 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_PCI))
375 vlib_cli_output (vm, " Mac Address: %U", format_ethernet_address,
377 vlib_cli_output (vm, " Device instance: %u", vif->dev_instance);
378 vlib_cli_output (vm, " flags 0x%x", vif->flags);
379 flag_entry = (struct feat_struct *) &flags_array;
380 while (flag_entry->str)
382 if (vif->flags & (1ULL << flag_entry->bit))
383 vlib_cli_output (vm, " %s (%d)", flag_entry->str,
387 if (type == VIRTIO_IF_TYPE_PCI)
389 device_status (vm, vif);
391 vlib_cli_output (vm, " features 0x%lx", vif->features);
392 feat_entry = (struct feat_struct *) &feat_array;
393 while (feat_entry->str)
395 if (vif->features & (1ULL << feat_entry->bit))
396 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
400 vlib_cli_output (vm, " remote-features 0x%lx", vif->remote_features);
401 feat_entry = (struct feat_struct *) &feat_array;
402 while (feat_entry->str)
404 if (vif->remote_features & (1ULL << feat_entry->bit))
405 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
409 vlib_cli_output (vm, " Number of RX Virtqueue %u", vif->num_rxqs);
410 vlib_cli_output (vm, " Number of TX Virtqueue %u", vif->num_txqs);
411 if (type == VIRTIO_IF_TYPE_PCI && vif->cxq_vring != NULL &&
412 vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
413 vlib_cli_output (vm, " Number of CTRL Virtqueue 1");
414 vec_foreach_index (i, vif->rxq_vrings)
416 vring = vec_elt_at_index (vif->rxq_vrings, i);
417 vlib_cli_output (vm, " Virtqueue (RX) %d", vring->queue_id);
419 " qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
420 vring->size, vring->last_used_idx, vring->desc_next,
425 " driver_event.flags 0x%x driver_event.off_wrap %d device_event.flags 0x%x device_event.off_wrap %d",
426 vring->driver_event->flags,
427 vring->driver_event->off_wrap,
428 vring->device_event->flags,
429 vring->device_event->off_wrap);
431 " avail wrap counter %d, used wrap counter %d",
432 vring->avail_wrap_counter,
433 vring->used_wrap_counter);
437 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
438 vring->avail->flags, vring->avail->idx,
439 vring->used->flags, vring->used->idx);
440 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
442 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
447 vlib_cli_output (vm, "\n descriptor table:\n");
449 " id addr len flags next/id user_addr\n");
451 " ===== ================== ===== ====== ======= ==================\n");
452 for (j = 0; j < vring->size; j++)
456 vring_packed_desc_t *desc = &vring->packed_desc[j];
458 " %-5d 0x%016lx %-5d 0x%04x %-8d 0x%016lx\n",
461 desc->flags, desc->id, desc->addr);
465 vring_desc_t *desc = &vring->desc[j];
467 " %-5d 0x%016lx %-5d 0x%04x %-8d 0x%016lx\n",
470 desc->flags, desc->next, desc->addr);
475 vec_foreach_index (i, vif->txq_vrings)
477 vring = vec_elt_at_index (vif->txq_vrings, i);
478 vlib_cli_output (vm, " Virtqueue (TX) %d", vring->queue_id);
480 " qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
481 vring->size, vring->last_used_idx, vring->desc_next,
486 " driver_event.flags 0x%x driver_event.off_wrap %d device_event.flags 0x%x device_event.off_wrap %d",
487 vring->driver_event->flags,
488 vring->driver_event->off_wrap,
489 vring->device_event->flags,
490 vring->device_event->off_wrap);
492 " avail wrap counter %d, used wrap counter %d",
493 vring->avail_wrap_counter,
494 vring->used_wrap_counter);
498 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
499 vring->avail->flags, vring->avail->idx,
500 vring->used->flags, vring->used->idx);
501 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
503 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
506 if (vring->flow_table)
508 vlib_cli_output (vm, " %U", gro_flow_table_format,
511 if (vif->packet_buffering)
513 vlib_cli_output (vm, " %U", virtio_vring_buffering_format,
518 vlib_cli_output (vm, "\n descriptor table:\n");
520 " id addr len flags next/id user_addr\n");
522 " ===== ================== ===== ====== ======== ==================\n");
523 for (j = 0; j < vring->size; j++)
527 vring_packed_desc_t *desc = &vring->packed_desc[j];
529 " %-5d 0x%016lx %-5d 0x%04x %-8d 0x%016lx\n",
532 desc->flags, desc->id, desc->addr);
536 vring_desc_t *desc = &vring->desc[j];
538 " %-5d 0x%016lx %-5d 0x%04x %-8d 0x%016lx\n",
541 desc->flags, desc->next, desc->addr);
546 if (type == VIRTIO_IF_TYPE_PCI && vif->cxq_vring != NULL &&
547 vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
549 vring = vif->cxq_vring;
550 vlib_cli_output (vm, " Virtqueue (CTRL) %d", vring->queue_id);
552 " qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
553 vring->size, vring->last_used_idx,
554 vring->desc_next, vring->desc_in_use);
558 " driver_event.flags 0x%x driver_event.off_wrap %d device_event.flags 0x%x device_event.off_wrap %d",
559 vring->driver_event->flags,
560 vring->driver_event->off_wrap,
561 vring->device_event->flags,
562 vring->device_event->off_wrap);
564 " avail wrap counter %d, used wrap counter %d",
565 vring->avail_wrap_counter,
566 vring->used_wrap_counter);
571 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
572 vring->avail->flags, vring->avail->idx,
573 vring->used->flags, vring->used->idx);
575 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
577 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
582 vlib_cli_output (vm, "\n descriptor table:\n");
584 " id addr len flags next/id user_addr\n");
586 " ===== ================== ===== ====== ======== ==================\n");
587 for (j = 0; j < vring->size; j++)
591 vring_packed_desc_t *desc = &vring->packed_desc[j];
593 " %-5d 0x%016lx %-5d 0x%04x %-8d 0x%016lx\n",
596 desc->flags, desc->id, desc->addr);
600 vring_desc_t *desc = &vring->desc[j];
602 " %-5d 0x%016lx %-5d 0x%04x %-8d 0x%016lx\n",
605 desc->flags, desc->next, desc->addr);
615 static clib_error_t *
616 virtio_init (vlib_main_t * vm)
618 virtio_main_t *vim = &virtio_main;
619 clib_error_t *error = 0;
621 vim->log_default = vlib_log_register_class ("virtio", 0);
622 vlib_log_debug (vim->log_default, "initialized");
627 VLIB_INIT_FUNCTION (virtio_init);
630 * fd.io coding-style-patch-verification: ON
633 * eval: (c-set-style "gnu")