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/pci.h>
34 #include <vnet/interface/rx_queue_funcs.h>
36 virtio_main_t virtio_main;
38 #define _IOCTL(fd,a,...) \
39 if (ioctl (fd, a, __VA_ARGS__) < 0) \
41 err = clib_error_return_unix (0, "ioctl(" #a ")"); \
46 call_read_ready (clib_file_t * uf)
48 vnet_main_t *vnm = vnet_get_main ();
51 CLIB_UNUSED (ssize_t size) = read (uf->file_descriptor, &b, sizeof (b));
52 vnet_hw_if_rx_queue_set_int_pending (vnm, uf->private_data);
59 virtio_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 idx, u16 sz)
61 virtio_vring_t *vring;
65 return clib_error_return (0, "ring size must be power of 2");
68 return clib_error_return (0, "ring size must be 32768 or lower");
75 vlib_thread_main_t *thm = vlib_get_thread_main ();
76 vec_validate_aligned (vif->txq_vrings, TX_QUEUE_ACCESS (idx),
77 CLIB_CACHE_LINE_BYTES);
78 vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (idx));
79 if (thm->n_vlib_mains > vif->num_txqs)
80 clib_spinlock_init (&vring->lockp);
84 vec_validate_aligned (vif->rxq_vrings, RX_QUEUE_ACCESS (idx),
85 CLIB_CACHE_LINE_BYTES);
86 vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (idx));
88 i = sizeof (vring_desc_t) * sz;
89 i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
90 vring->desc = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
91 clib_memset (vring->desc, 0, i);
93 i = sizeof (vring_avail_t) + sz * sizeof (vring->avail->ring[0]);
94 i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
95 vring->avail = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
96 clib_memset (vring->avail, 0, i);
97 // tell kernel that we don't need interrupt
98 vring->avail->flags = VRING_AVAIL_F_NO_INTERRUPT;
100 i = sizeof (vring_used_t) + sz * sizeof (vring_used_elem_t);
101 i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
102 vring->used = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
103 clib_memset (vring->used, 0, i);
105 vring->queue_id = idx;
106 ASSERT (vring->buffers == 0);
107 vec_validate_aligned (vring->buffers, sz, CLIB_CACHE_LINE_BYTES);
111 clib_memset_u32 (vring->buffers, ~0, sz);
112 // tx path: suppress the interrupts from kernel
116 vring->call_fd = eventfd (0, EFD_NONBLOCK | EFD_CLOEXEC);
119 vring->kick_fd = eventfd (0, EFD_NONBLOCK | EFD_CLOEXEC);
120 virtio_log_debug (vif, "vring %u size %u call_fd %d kick_fd %d", idx,
121 vring->size, vring->call_fd, vring->kick_fd);
127 virtio_free_buffers (vlib_main_t * vm, virtio_vring_t * vring)
129 u16 used = vring->desc_in_use;
130 u16 last = vring->last_used_idx;
131 u16 mask = vring->size - 1;
135 vlib_buffer_free (vm, &vring->buffers[last & mask], 1);
142 virtio_vring_free_rx (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
144 virtio_vring_t *vring =
145 vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (idx));
147 clib_file_del_by_index (&file_main, vring->call_file_index);
148 close (vring->kick_fd);
149 close (vring->call_fd);
152 virtio_free_buffers (vm, vring);
153 clib_mem_free (vring->used);
156 clib_mem_free (vring->desc);
158 clib_mem_free (vring->avail);
159 vec_free (vring->buffers);
164 virtio_vring_free_tx (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
166 virtio_vring_t *vring =
167 vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (idx));
169 close (vring->kick_fd);
172 virtio_free_buffers (vm, vring);
173 clib_mem_free (vring->used);
176 clib_mem_free (vring->desc);
178 clib_mem_free (vring->avail);
179 vec_free (vring->buffers);
180 gro_flow_table_free (vring->flow_table);
181 virtio_vring_buffering_free (vm, vring->buffering);
182 clib_spinlock_free (&vring->lockp);
187 virtio_set_packet_coalesce (virtio_if_t * vif)
189 vnet_main_t *vnm = vnet_get_main ();
190 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
191 virtio_vring_t *vring;
192 vif->packet_coalesce = 1;
193 vec_foreach (vring, vif->txq_vrings)
195 gro_flow_table_init (&vring->flow_table,
196 vif->type & (VIRTIO_IF_TYPE_TAP |
197 VIRTIO_IF_TYPE_PCI), hw->tx_node_index);
202 virtio_set_packet_buffering (virtio_if_t * vif, u16 buffering_size)
204 vnet_main_t *vnm = vnet_get_main ();
205 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
206 virtio_vring_t *vring;
207 clib_error_t *error = 0;
208 vif->packet_buffering = 1;
210 vec_foreach (vring, vif->txq_vrings)
213 virtio_vring_buffering_init (&vring->buffering, hw->tx_node_index,
224 virtio_vring_set_rx_queues (vlib_main_t *vm, virtio_if_t *vif)
226 vnet_main_t *vnm = vnet_get_main ();
227 virtio_vring_t *vring;
229 vnet_hw_if_set_input_node (vnm, vif->hw_if_index, virtio_input_node.index);
231 vec_foreach (vring, vif->rxq_vrings)
233 vring->queue_index = vnet_hw_if_register_rx_queue (
234 vnm, vif->hw_if_index, RX_QUEUE_ACCESS (vring->queue_id),
235 VNET_HW_IF_RXQ_THREAD_ANY);
236 vring->buffer_pool_index = vlib_buffer_pool_get_default_for_numa (
237 vm, vnet_hw_if_get_rx_queue_numa_node (vnm, vring->queue_index));
238 if (vif->type == VIRTIO_IF_TYPE_TAP || vif->type == VIRTIO_IF_TYPE_TUN)
242 .read_function = call_read_ready,
243 .flags = UNIX_FILE_EVENT_EDGE_TRIGGERED,
244 .file_descriptor = vring->call_fd,
245 .private_data = vring->queue_index,
246 .description = format (0, "%U vring %u", format_virtio_device_name,
247 vif->dev_instance, vring->queue_id),
250 vring->call_file_index = clib_file_add (&file_main, &f);
251 vnet_hw_if_set_rx_queue_file_index (vnm, vring->queue_index,
252 vring->call_file_index);
255 vnet_hw_if_update_runtime_data (vnm, vif->hw_if_index);
259 virtio_set_net_hdr_size (virtio_if_t * vif)
261 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF) ||
262 vif->features & VIRTIO_FEATURE (VIRTIO_F_VERSION_1))
263 vif->virtio_net_hdr_sz = sizeof (virtio_net_hdr_v1_t);
265 vif->virtio_net_hdr_sz = sizeof (virtio_net_hdr_t);
269 virtio_show (vlib_main_t * vm, u32 * hw_if_indices, u8 show_descr, u32 type)
271 u32 i, j, hw_if_index;
273 vnet_main_t *vnm = &vnet_main;
274 virtio_main_t *mm = &virtio_main;
275 virtio_vring_t *vring;
281 struct feat_struct *feat_entry;
283 static struct feat_struct feat_array[] = {
284 #define _(s,b) { .str = #s, .bit = b, },
285 foreach_virtio_net_features
290 struct feat_struct *flag_entry;
291 static struct feat_struct flags_array[] = {
292 #define _(b,e,s) { .bit = b, .str = s, },
293 foreach_virtio_if_flag
301 for (hw_if_index = 0; hw_if_index < vec_len (hw_if_indices); hw_if_index++)
303 vnet_hw_interface_t *hi =
304 vnet_get_hw_interface (vnm, hw_if_indices[hw_if_index]);
305 vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
306 if (vif->type != type)
308 vlib_cli_output (vm, "Interface: %U (ifindex %d)",
309 format_vnet_hw_if_index_name, vnm,
310 hw_if_indices[hw_if_index], vif->hw_if_index);
311 if (type == VIRTIO_IF_TYPE_PCI)
313 vlib_cli_output (vm, " PCI Address: %U", format_vlib_pci_addr,
316 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
319 if (vif->host_if_name)
320 vlib_cli_output (vm, " name \"%s\"", vif->host_if_name);
322 vlib_cli_output (vm, " host-ns \"%s\"", vif->net_ns);
323 if (vif->host_mtu_size)
324 vlib_cli_output (vm, " host-mtu-size \"%d\"",
326 if (type == VIRTIO_IF_TYPE_TAP)
327 vlib_cli_output (vm, " host-mac-addr: %U",
328 format_ethernet_address, vif->host_mac_addr);
329 vlib_cli_output (vm, " host-carrier-up: %u", vif->host_carrier_up);
331 vec_foreach_index (i, vif->vhost_fds)
332 str = format (str, " %d", vif->vhost_fds[i]);
333 vlib_cli_output (vm, " vhost-fds%v", str);
335 vec_foreach_index (i, vif->tap_fds)
336 str = format (str, " %d", vif->tap_fds[i]);
337 vlib_cli_output (vm, " tap-fds%v", str);
340 vlib_cli_output (vm, " gso-enabled %d", vif->gso_enabled);
341 vlib_cli_output (vm, " csum-enabled %d", vif->csum_offload_enabled);
342 vlib_cli_output (vm, " packet-coalesce %d", vif->packet_coalesce);
343 vlib_cli_output (vm, " packet-buffering %d", vif->packet_buffering);
344 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_PCI))
345 vlib_cli_output (vm, " Mac Address: %U", format_ethernet_address,
347 vlib_cli_output (vm, " Device instance: %u", vif->dev_instance);
348 vlib_cli_output (vm, " flags 0x%x", vif->flags);
349 flag_entry = (struct feat_struct *) &flags_array;
350 while (flag_entry->str)
352 if (vif->flags & (1ULL << flag_entry->bit))
353 vlib_cli_output (vm, " %s (%d)", flag_entry->str,
357 if (type == VIRTIO_IF_TYPE_PCI)
359 device_status (vm, vif);
361 vlib_cli_output (vm, " features 0x%lx", vif->features);
362 feat_entry = (struct feat_struct *) &feat_array;
363 while (feat_entry->str)
365 if (vif->features & (1ULL << feat_entry->bit))
366 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
370 vlib_cli_output (vm, " remote-features 0x%lx", vif->remote_features);
371 feat_entry = (struct feat_struct *) &feat_array;
372 while (feat_entry->str)
374 if (vif->remote_features & (1ULL << feat_entry->bit))
375 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
379 vlib_cli_output (vm, " Number of RX Virtqueue %u", vif->num_rxqs);
380 vlib_cli_output (vm, " Number of TX Virtqueue %u", vif->num_txqs);
381 if (vif->cxq_vring != NULL
382 && vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
383 vlib_cli_output (vm, " Number of CTRL Virtqueue 1");
384 vec_foreach_index (i, vif->rxq_vrings)
386 vring = vec_elt_at_index (vif->rxq_vrings, i);
387 vlib_cli_output (vm, " Virtqueue (RX) %d", vring->queue_id);
389 " qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
390 vring->size, vring->last_used_idx, vring->desc_next,
395 " driver_event.flags 0x%x driver_event.off_wrap %d device_event.flags 0x%x device_event.off_wrap %d",
396 vring->driver_event->flags,
397 vring->driver_event->off_wrap,
398 vring->device_event->flags,
399 vring->device_event->off_wrap);
401 " avail wrap counter %d, used wrap counter %d",
402 vring->avail_wrap_counter,
403 vring->used_wrap_counter);
407 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
408 vring->avail->flags, vring->avail->idx,
409 vring->used->flags, vring->used->idx);
410 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
412 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
417 vlib_cli_output (vm, "\n descriptor table:\n");
419 " id addr len flags next/id user_addr\n");
421 " ===== ================== ===== ====== ======= ==================\n");
422 for (j = 0; j < vring->size; j++)
426 vring_packed_desc_t *desc = &vring->packed_desc[j];
428 " %-5d 0x%016lx %-5d 0x%04x %-8d 0x%016lx\n",
431 desc->flags, desc->id, desc->addr);
435 vring_desc_t *desc = &vring->desc[j];
437 " %-5d 0x%016lx %-5d 0x%04x %-8d 0x%016lx\n",
440 desc->flags, desc->next, desc->addr);
445 vec_foreach_index (i, vif->txq_vrings)
447 vring = vec_elt_at_index (vif->txq_vrings, i);
448 vlib_cli_output (vm, " Virtqueue (TX) %d", vring->queue_id);
450 " qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
451 vring->size, vring->last_used_idx, vring->desc_next,
456 " driver_event.flags 0x%x driver_event.off_wrap %d device_event.flags 0x%x device_event.off_wrap %d",
457 vring->driver_event->flags,
458 vring->driver_event->off_wrap,
459 vring->device_event->flags,
460 vring->device_event->off_wrap);
462 " avail wrap counter %d, used wrap counter %d",
463 vring->avail_wrap_counter,
464 vring->used_wrap_counter);
468 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
469 vring->avail->flags, vring->avail->idx,
470 vring->used->flags, vring->used->idx);
471 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
473 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
476 if (vring->flow_table)
478 vlib_cli_output (vm, " %U", gro_flow_table_format,
481 if (vif->packet_buffering)
483 vlib_cli_output (vm, " %U", virtio_vring_buffering_format,
488 vlib_cli_output (vm, "\n descriptor table:\n");
490 " id addr len flags next/id user_addr\n");
492 " ===== ================== ===== ====== ======== ==================\n");
493 for (j = 0; j < vring->size; j++)
497 vring_packed_desc_t *desc = &vring->packed_desc[j];
499 " %-5d 0x%016lx %-5d 0x%04x %-8d 0x%016lx\n",
502 desc->flags, desc->id, desc->addr);
506 vring_desc_t *desc = &vring->desc[j];
508 " %-5d 0x%016lx %-5d 0x%04x %-8d 0x%016lx\n",
511 desc->flags, desc->next, desc->addr);
516 if (vif->cxq_vring != NULL
517 && vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
519 vring = vif->cxq_vring;
520 vlib_cli_output (vm, " Virtqueue (CTRL) %d", vring->queue_id);
522 " qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
523 vring->size, vring->last_used_idx,
524 vring->desc_next, vring->desc_in_use);
528 " driver_event.flags 0x%x driver_event.off_wrap %d device_event.flags 0x%x device_event.off_wrap %d",
529 vring->driver_event->flags,
530 vring->driver_event->off_wrap,
531 vring->device_event->flags,
532 vring->device_event->off_wrap);
534 " avail wrap counter %d, used wrap counter %d",
535 vring->avail_wrap_counter,
536 vring->used_wrap_counter);
541 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
542 vring->avail->flags, vring->avail->idx,
543 vring->used->flags, vring->used->idx);
545 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
547 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
552 vlib_cli_output (vm, "\n descriptor table:\n");
554 " id addr len flags next/id user_addr\n");
556 " ===== ================== ===== ====== ======== ==================\n");
557 for (j = 0; j < vring->size; j++)
561 vring_packed_desc_t *desc = &vring->packed_desc[j];
563 " %-5d 0x%016lx %-5d 0x%04x %-8d 0x%016lx\n",
566 desc->flags, desc->id, desc->addr);
570 vring_desc_t *desc = &vring->desc[j];
572 " %-5d 0x%016lx %-5d 0x%04x %-8d 0x%016lx\n",
575 desc->flags, desc->next, desc->addr);
585 static clib_error_t *
586 virtio_init (vlib_main_t * vm)
588 virtio_main_t *vim = &virtio_main;
589 clib_error_t *error = 0;
591 vim->log_default = vlib_log_register_class ("virtio", 0);
592 vlib_log_debug (vim->log_default, "initialized");
597 VLIB_INIT_FUNCTION (virtio_init);
600 * fd.io coding-style-patch-verification: ON
603 * eval: (c-set-style "gnu")