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 <linux/virtio_net.h>
25 #include <linux/vhost.h>
26 #include <sys/eventfd.h>
28 #include <vlib/vlib.h>
29 #include <vlib/pci/pci.h>
30 #include <vlib/unix/unix.h>
31 #include <vnet/ethernet/ethernet.h>
32 #include <vnet/ip/ip4_packet.h>
33 #include <vnet/ip/ip6_packet.h>
34 #include <vnet/devices/virtio/virtio.h>
35 #include <vnet/devices/virtio/pci.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 virtio_main_t *nm = &virtio_main;
50 vnet_main_t *vnm = vnet_get_main ();
51 u16 qid = uf->private_data & 0xFFFF;
53 vec_elt_at_index (nm->interfaces, uf->private_data >> 16);
56 CLIB_UNUSED (ssize_t size) = read (uf->file_descriptor, &b, sizeof (b));
58 vnet_device_input_set_interrupt_pending (vnm, vif->hw_if_index,
59 RX_QUEUE_ACCESS (qid));
66 virtio_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 idx, u16 sz)
68 virtio_vring_t *vring;
69 clib_file_t t = { 0 };
73 return clib_error_return (0, "ring size must be power of 2");
76 return clib_error_return (0, "ring size must be 32768 or lower");
83 vlib_thread_main_t *thm = vlib_get_thread_main ();
84 vec_validate_aligned (vif->txq_vrings, TX_QUEUE_ACCESS (idx),
85 CLIB_CACHE_LINE_BYTES);
86 vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (idx));
87 if (thm->n_vlib_mains > vif->num_txqs)
88 clib_spinlock_init (&vring->lockp);
92 vec_validate_aligned (vif->rxq_vrings, RX_QUEUE_ACCESS (idx),
93 CLIB_CACHE_LINE_BYTES);
94 vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (idx));
96 i = sizeof (struct vring_desc) * sz;
97 i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
98 vring->desc = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
99 clib_memset (vring->desc, 0, i);
101 i = sizeof (struct vring_avail) + sz * sizeof (vring->avail->ring[0]);
102 i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
103 vring->avail = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
104 clib_memset (vring->avail, 0, i);
105 // tell kernel that we don't need interrupt
106 vring->avail->flags = VIRTIO_RING_FLAG_MASK_INT;
108 i = sizeof (struct vring_used) + sz * sizeof (struct vring_used_elem);
109 i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
110 vring->used = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
111 clib_memset (vring->used, 0, i);
113 vring->queue_id = idx;
114 ASSERT (vring->buffers == 0);
115 vec_validate_aligned (vring->buffers, sz, CLIB_CACHE_LINE_BYTES);
119 clib_memset_u32 (vring->buffers, ~0, sz);
123 vring->call_fd = eventfd (0, EFD_NONBLOCK | EFD_CLOEXEC);
124 vring->kick_fd = eventfd (0, EFD_NONBLOCK | EFD_CLOEXEC);
125 virtio_log_debug (vif, "vring %u size %u call_fd %d kick_fd %d", idx,
126 vring->size, vring->call_fd, vring->kick_fd);
128 t.read_function = call_read_ready;
129 t.file_descriptor = vring->call_fd;
130 t.private_data = vif->dev_instance << 16 | idx;
131 t.description = format (0, "%U vring %u", format_virtio_device_name,
132 vif->dev_instance, idx);
133 vring->call_file_index = clib_file_add (&file_main, &t);
139 virtio_free_rx_buffers (vlib_main_t * vm, virtio_vring_t * vring)
141 u16 used = vring->desc_in_use;
142 u16 last = vring->last_used_idx;
143 u16 mask = vring->size - 1;
147 vlib_buffer_free (vm, &vring->buffers[last & mask], 1);
154 virtio_vring_free_rx (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
156 virtio_vring_t *vring =
157 vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (idx));
159 clib_file_del_by_index (&file_main, vring->call_file_index);
160 close (vring->kick_fd);
161 close (vring->call_fd);
164 virtio_free_rx_buffers (vm, vring);
165 clib_mem_free (vring->used);
168 clib_mem_free (vring->desc);
170 clib_mem_free (vring->avail);
171 vec_free (vring->buffers);
176 virtio_free_used_desc (vlib_main_t * vm, virtio_vring_t * vring)
178 u16 used = vring->desc_in_use;
179 u16 sz = vring->size;
181 u16 last = vring->last_used_idx;
182 u16 n_left = vring->used->idx - last;
189 struct vring_used_elem *e = &vring->used->ring[last & mask];
192 vlib_buffer_free (vm, &vring->buffers[slot], 1);
197 vring->desc_in_use = used;
198 vring->last_used_idx = last;
202 virtio_vring_free_tx (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
204 virtio_vring_t *vring =
205 vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (idx));
207 clib_file_del_by_index (&file_main, vring->call_file_index);
208 close (vring->kick_fd);
209 close (vring->call_fd);
212 virtio_free_used_desc (vm, vring);
213 clib_mem_free (vring->used);
216 clib_mem_free (vring->desc);
218 clib_mem_free (vring->avail);
219 vec_free (vring->buffers);
220 gro_flow_table_free (vring->flow_table);
221 clib_spinlock_free (&vring->lockp);
226 virtio_set_packet_coalesce (virtio_if_t * vif)
228 vnet_main_t *vnm = vnet_get_main ();
229 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
230 virtio_vring_t *vring;
231 vec_foreach (vring, vif->txq_vrings)
233 gro_flow_table_init (&vring->flow_table,
234 vif->type & (VIRTIO_IF_TYPE_TAP |
235 VIRTIO_IF_TYPE_PCI), hw->tx_node_index);
240 virtio_vring_set_numa_node (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
242 vnet_main_t *vnm = vnet_get_main ();
244 virtio_vring_t *vring =
245 vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (idx));
247 vnet_get_device_input_thread_index (vnm, vif->hw_if_index,
248 RX_QUEUE_ACCESS (idx));
249 vring->buffer_pool_index =
250 vlib_buffer_pool_get_default_for_numa (vm,
252 [thread_index]->numa_node);
256 virtio_set_net_hdr_size (virtio_if_t * vif)
258 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF) ||
259 vif->features & VIRTIO_FEATURE (VIRTIO_F_VERSION_1))
260 vif->virtio_net_hdr_sz = sizeof (struct virtio_net_hdr_v1);
262 vif->virtio_net_hdr_sz = sizeof (struct virtio_net_hdr);
266 virtio_show (vlib_main_t * vm, u32 * hw_if_indices, u8 show_descr, u32 type)
268 u32 i, j, hw_if_index;
270 vnet_main_t *vnm = &vnet_main;
271 virtio_main_t *mm = &virtio_main;
272 virtio_vring_t *vring;
278 struct feat_struct *feat_entry;
280 static struct feat_struct feat_array[] = {
281 #define _(s,b) { .str = #s, .bit = b, },
282 foreach_virtio_net_features
287 struct feat_struct *flag_entry;
288 static struct feat_struct flags_array[] = {
289 #define _(b,e,s) { .bit = b, .str = s, },
290 foreach_virtio_if_flag
298 for (hw_if_index = 0; hw_if_index < vec_len (hw_if_indices); hw_if_index++)
300 vnet_hw_interface_t *hi =
301 vnet_get_hw_interface (vnm, hw_if_indices[hw_if_index]);
302 vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
303 if (vif->type != type)
305 vlib_cli_output (vm, "Interface: %U (ifindex %d)",
306 format_vnet_hw_if_index_name, vnm,
307 hw_if_indices[hw_if_index], vif->hw_if_index);
308 if (type == VIRTIO_IF_TYPE_PCI)
310 vlib_cli_output (vm, " PCI Address: %U", format_vlib_pci_addr,
313 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
316 if (vif->host_if_name)
317 vlib_cli_output (vm, " name \"%s\"", vif->host_if_name);
319 vlib_cli_output (vm, " host-ns \"%s\"", vif->net_ns);
320 if (vif->host_mtu_size)
321 vlib_cli_output (vm, " host-mtu-size \"%d\"",
323 if (type == VIRTIO_IF_TYPE_TAP)
324 vlib_cli_output (vm, " host-mac-addr: %U",
325 format_ethernet_address, vif->host_mac_addr);
327 vec_foreach_index (i, vif->vhost_fds)
328 str = format (str, " %d", vif->vhost_fds[i]);
329 vlib_cli_output (vm, " vhost-fds%v", str);
331 vec_foreach_index (i, vif->tap_fds)
332 str = format (str, " %d", vif->tap_fds[i]);
333 vlib_cli_output (vm, " tap-fds%v", str);
336 vlib_cli_output (vm, " gso-enabled %d", vif->gso_enabled);
337 vlib_cli_output (vm, " csum-enabled %d", vif->csum_offload_enabled);
338 vlib_cli_output (vm, " packet-coalesce %d", vif->packet_coalesce);
339 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_PCI))
340 vlib_cli_output (vm, " Mac Address: %U", format_ethernet_address,
342 vlib_cli_output (vm, " Device instance: %u", vif->dev_instance);
343 vlib_cli_output (vm, " flags 0x%x", vif->flags);
344 flag_entry = (struct feat_struct *) &flags_array;
345 while (flag_entry->str)
347 if (vif->flags & (1ULL << flag_entry->bit))
348 vlib_cli_output (vm, " %s (%d)", flag_entry->str,
352 if (type == VIRTIO_IF_TYPE_PCI)
354 device_status (vm, vif);
356 vlib_cli_output (vm, " features 0x%lx", vif->features);
357 feat_entry = (struct feat_struct *) &feat_array;
358 while (feat_entry->str)
360 if (vif->features & (1ULL << feat_entry->bit))
361 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
365 vlib_cli_output (vm, " remote-features 0x%lx", vif->remote_features);
366 feat_entry = (struct feat_struct *) &feat_array;
367 while (feat_entry->str)
369 if (vif->remote_features & (1ULL << feat_entry->bit))
370 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
374 vlib_cli_output (vm, " Number of RX Virtqueue %u", vif->num_rxqs);
375 vlib_cli_output (vm, " Number of TX Virtqueue %u", vif->num_txqs);
376 if (vif->cxq_vring != NULL
377 && vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
378 vlib_cli_output (vm, " Number of CTRL Virtqueue 1");
379 vec_foreach_index (i, vif->rxq_vrings)
381 vring = vec_elt_at_index (vif->rxq_vrings, i);
382 vlib_cli_output (vm, " Virtqueue (RX) %d", vring->queue_id);
384 " qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
385 vring->size, vring->last_used_idx, vring->desc_next,
388 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
389 vring->avail->flags, vring->avail->idx,
390 vring->used->flags, vring->used->idx);
391 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
393 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
398 vlib_cli_output (vm, "\n descriptor table:\n");
400 " id addr len flags next user_addr\n");
402 " ===== ================== ===== ====== ===== ==================\n");
403 for (j = 0; j < vring->size; j++)
405 struct vring_desc *desc = &vring->desc[j];
407 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
410 desc->flags, desc->next, desc->addr);
414 vec_foreach_index (i, vif->txq_vrings)
416 vring = vec_elt_at_index (vif->txq_vrings, i);
417 vlib_cli_output (vm, " Virtqueue (TX) %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,
423 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
424 vring->avail->flags, vring->avail->idx,
425 vring->used->flags, vring->used->idx);
426 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
428 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
431 if (vring->flow_table)
433 vlib_cli_output (vm, " %U", gro_flow_table_format,
438 vlib_cli_output (vm, "\n descriptor table:\n");
440 " id addr len flags next user_addr\n");
442 " ===== ================== ===== ====== ===== ==================\n");
443 for (j = 0; j < vring->size; j++)
445 struct vring_desc *desc = &vring->desc[j];
447 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
450 desc->flags, desc->next, desc->addr);
454 if (vif->cxq_vring != NULL
455 && vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
457 vring = vif->cxq_vring;
458 vlib_cli_output (vm, " Virtqueue (CTRL) %d", vring->queue_id);
460 " qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
461 vring->size, vring->last_used_idx,
462 vring->desc_next, vring->desc_in_use);
464 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
465 vring->avail->flags, vring->avail->idx,
466 vring->used->flags, vring->used->idx);
467 if (type & (VIRTIO_IF_TYPE_TAP | VIRTIO_IF_TYPE_TUN))
469 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
474 vlib_cli_output (vm, "\n descriptor table:\n");
476 " id addr len flags next user_addr\n");
478 " ===== ================== ===== ====== ===== ==================\n");
479 for (j = 0; j < vring->size; j++)
481 struct vring_desc *desc = &vring->desc[j];
483 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
486 desc->flags, desc->next, desc->addr);
495 static clib_error_t *
496 virtio_init (vlib_main_t * vm)
498 virtio_main_t *vim = &virtio_main;
499 clib_error_t *error = 0;
501 vim->log_default = vlib_log_register_class ("virtio", 0);
502 vlib_log_debug (vim->log_default, "initialized");
507 VLIB_INIT_FUNCTION (virtio_init);
510 * fd.io coding-style-patch-verification: ON
513 * eval: (c-set-style "gnu")