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, qid);
65 virtio_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 idx, u16 sz)
67 virtio_vring_t *vring;
68 clib_file_t t = { 0 };
72 return clib_error_return (0, "ring size must be power of 2");
75 return clib_error_return (0, "ring size must be 32768 or lower");
82 vlib_thread_main_t *thm = vlib_get_thread_main ();
83 vec_validate_aligned (vif->txq_vrings, TX_QUEUE_ACCESS (idx),
84 CLIB_CACHE_LINE_BYTES);
85 vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (idx));
86 if (thm->n_vlib_mains > vif->num_txqs)
87 clib_spinlock_init (&vring->lockp);
91 vec_validate_aligned (vif->rxq_vrings, RX_QUEUE_ACCESS (idx),
92 CLIB_CACHE_LINE_BYTES);
93 vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (idx));
95 i = sizeof (struct vring_desc) * sz;
96 i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
97 vring->desc = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
98 clib_memset (vring->desc, 0, i);
100 i = sizeof (struct vring_avail) + sz * sizeof (vring->avail->ring[0]);
101 i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
102 vring->avail = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
103 clib_memset (vring->avail, 0, i);
104 // tell kernel that we don't need interrupt
105 vring->avail->flags = VIRTIO_RING_FLAG_MASK_INT;
107 i = sizeof (struct vring_used) + sz * sizeof (struct vring_used_elem);
108 i = round_pow2 (i, CLIB_CACHE_LINE_BYTES);
109 vring->used = clib_mem_alloc_aligned (i, CLIB_CACHE_LINE_BYTES);
110 clib_memset (vring->used, 0, i);
112 vring->queue_id = idx;
113 ASSERT (vring->buffers == 0);
114 vec_validate_aligned (vring->buffers, sz, CLIB_CACHE_LINE_BYTES);
117 vring->call_fd = eventfd (0, EFD_NONBLOCK | EFD_CLOEXEC);
118 vring->kick_fd = eventfd (0, EFD_NONBLOCK | EFD_CLOEXEC);
119 virtio_log_debug (vif, "vring %u size %u call_fd %d kick_fd %d", idx,
120 vring->size, vring->call_fd, vring->kick_fd);
122 t.read_function = call_read_ready;
123 t.file_descriptor = vring->call_fd;
124 t.private_data = vif->dev_instance << 16 | idx;
125 t.description = format (0, "%U vring %u", format_virtio_device_name,
126 vif->dev_instance, idx);
127 vring->call_file_index = clib_file_add (&file_main, &t);
133 virtio_free_rx_buffers (vlib_main_t * vm, virtio_vring_t * vring)
135 u16 used = vring->desc_in_use;
136 u16 last = vring->last_used_idx;
137 u16 mask = vring->size - 1;
141 vlib_buffer_free (vm, &vring->buffers[last & mask], 1);
148 virtio_vring_free_rx (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
150 virtio_vring_t *vring =
151 vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (idx));
153 clib_file_del_by_index (&file_main, vring->call_file_index);
154 close (vring->kick_fd);
155 close (vring->call_fd);
158 virtio_free_rx_buffers (vm, vring);
159 clib_mem_free (vring->used);
162 clib_mem_free (vring->desc);
164 clib_mem_free (vring->avail);
165 vec_free (vring->buffers);
170 virtio_free_used_desc (vlib_main_t * vm, virtio_vring_t * vring)
172 u16 used = vring->desc_in_use;
173 u16 sz = vring->size;
175 u16 last = vring->last_used_idx;
176 u16 n_left = vring->used->idx - last;
183 struct vring_used_elem *e = &vring->used->ring[last & mask];
186 vlib_buffer_free (vm, &vring->buffers[slot], 1);
191 vring->desc_in_use = used;
192 vring->last_used_idx = last;
196 virtio_vring_free_tx (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
198 virtio_vring_t *vring =
199 vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS (idx));
201 clib_file_del_by_index (&file_main, vring->call_file_index);
202 close (vring->kick_fd);
203 close (vring->call_fd);
206 virtio_free_used_desc (vm, vring);
207 clib_mem_free (vring->used);
210 clib_mem_free (vring->desc);
212 clib_mem_free (vring->avail);
213 vec_free (vring->buffers);
214 clib_spinlock_free (&vring->lockp);
219 virtio_vring_set_numa_node (vlib_main_t * vm, virtio_if_t * vif, u32 idx)
221 vnet_main_t *vnm = vnet_get_main ();
223 virtio_vring_t *vring =
224 vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS (idx));
226 vnet_get_device_input_thread_index (vnm, vif->hw_if_index,
227 RX_QUEUE_ACCESS (idx));
228 vring->buffer_pool_index =
229 vlib_buffer_pool_get_default_for_numa (vm,
231 [thread_index]->numa_node);
235 virtio_set_net_hdr_size (virtio_if_t * vif)
237 if (vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF) ||
238 vif->features & VIRTIO_FEATURE (VIRTIO_F_VERSION_1))
239 vif->virtio_net_hdr_sz = sizeof (struct virtio_net_hdr_v1);
241 vif->virtio_net_hdr_sz = sizeof (struct virtio_net_hdr);
245 virtio_show (vlib_main_t * vm, u32 * hw_if_indices, u8 show_descr, u32 type)
247 u32 i, j, hw_if_index;
249 vnet_main_t *vnm = &vnet_main;
250 virtio_main_t *mm = &virtio_main;
251 virtio_vring_t *vring;
257 struct feat_struct *feat_entry;
259 static struct feat_struct feat_array[] = {
260 #define _(s,b) { .str = #s, .bit = b, },
261 foreach_virtio_net_features
266 struct feat_struct *flag_entry;
267 static struct feat_struct flags_array[] = {
268 #define _(b,e,s) { .bit = b, .str = s, },
269 foreach_virtio_if_flag
277 for (hw_if_index = 0; hw_if_index < vec_len (hw_if_indices); hw_if_index++)
279 vnet_hw_interface_t *hi =
280 vnet_get_hw_interface (vnm, hw_if_indices[hw_if_index]);
281 vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
282 if (vif->type != type)
284 vlib_cli_output (vm, "Interface: %U (ifindex %d)",
285 format_vnet_hw_if_index_name, vnm,
286 hw_if_indices[hw_if_index], vif->hw_if_index);
287 if (type == VIRTIO_IF_TYPE_PCI)
289 vlib_cli_output (vm, " PCI Address: %U", format_vlib_pci_addr,
292 if (type == VIRTIO_IF_TYPE_TAP)
295 if (vif->host_if_name)
296 vlib_cli_output (vm, " name \"%s\"", vif->host_if_name);
298 vlib_cli_output (vm, " host-ns \"%s\"", vif->net_ns);
299 if (vif->host_mtu_size)
300 vlib_cli_output (vm, " host-mtu-size \"%d\"",
302 vlib_cli_output (vm, " host-mac-addr: %U",
303 format_ethernet_address, vif->host_mac_addr);
305 vec_foreach_index (i, vif->vhost_fds)
306 str = format (str, " %d", vif->vhost_fds[i]);
307 vlib_cli_output (vm, " vhost-fds%v", str);
309 vlib_cli_output (vm, " tap-fd %d", vif->tap_fd);
311 vlib_cli_output (vm, " gso-enabled %d", vif->gso_enabled);
312 vlib_cli_output (vm, " csum-enabled %d", vif->csum_offload_enabled);
313 vlib_cli_output (vm, " Mac Address: %U", format_ethernet_address,
315 vlib_cli_output (vm, " Device instance: %u", vif->dev_instance);
316 vlib_cli_output (vm, " flags 0x%x", vif->flags);
317 flag_entry = (struct feat_struct *) &flags_array;
318 while (flag_entry->str)
320 if (vif->flags & (1ULL << flag_entry->bit))
321 vlib_cli_output (vm, " %s (%d)", flag_entry->str,
325 if (type == VIRTIO_IF_TYPE_PCI)
327 device_status (vm, vif);
329 vlib_cli_output (vm, " features 0x%lx", vif->features);
330 feat_entry = (struct feat_struct *) &feat_array;
331 while (feat_entry->str)
333 if (vif->features & (1ULL << feat_entry->bit))
334 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
338 vlib_cli_output (vm, " remote-features 0x%lx", vif->remote_features);
339 feat_entry = (struct feat_struct *) &feat_array;
340 while (feat_entry->str)
342 if (vif->remote_features & (1ULL << feat_entry->bit))
343 vlib_cli_output (vm, " %s (%d)", feat_entry->str,
347 vlib_cli_output (vm, " Number of RX Virtqueue %u", vif->num_rxqs);
348 vlib_cli_output (vm, " Number of TX Virtqueue %u", vif->num_txqs);
349 if (vif->cxq_vring != NULL
350 && vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
351 vlib_cli_output (vm, " Number of CTRL Virtqueue 1");
352 vec_foreach_index (i, vif->rxq_vrings)
354 vring = vec_elt_at_index (vif->rxq_vrings, i);
355 vlib_cli_output (vm, " Virtqueue (RX) %d", vring->queue_id);
357 " qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
358 vring->size, vring->last_used_idx, vring->desc_next,
361 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
362 vring->avail->flags, vring->avail->idx,
363 vring->used->flags, vring->used->idx);
364 if (type == VIRTIO_IF_TYPE_TAP)
366 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
371 vlib_cli_output (vm, "\n descriptor table:\n");
373 " id addr len flags next user_addr\n");
375 " ===== ================== ===== ====== ===== ==================\n");
376 for (j = 0; j < vring->size; j++)
378 struct vring_desc *desc = &vring->desc[j];
380 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
383 desc->flags, desc->next, desc->addr);
387 vec_foreach_index (i, vif->txq_vrings)
389 vring = vec_elt_at_index (vif->txq_vrings, i);
390 vlib_cli_output (vm, " Virtqueue (TX) %d", vring->queue_id);
392 " qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
393 vring->size, vring->last_used_idx, vring->desc_next,
396 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
397 vring->avail->flags, vring->avail->idx,
398 vring->used->flags, vring->used->idx);
399 if (type == VIRTIO_IF_TYPE_TAP)
401 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
406 vlib_cli_output (vm, "\n descriptor table:\n");
408 " id addr len flags next user_addr\n");
410 " ===== ================== ===== ====== ===== ==================\n");
411 for (j = 0; j < vring->size; j++)
413 struct vring_desc *desc = &vring->desc[j];
415 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
418 desc->flags, desc->next, desc->addr);
422 if (vif->cxq_vring != NULL
423 && vif->features & VIRTIO_FEATURE (VIRTIO_NET_F_CTRL_VQ))
425 vring = vif->cxq_vring;
426 vlib_cli_output (vm, " Virtqueue (CTRL) %d", vring->queue_id);
428 " qsz %d, last_used_idx %d, desc_next %d, desc_in_use %d",
429 vring->size, vring->last_used_idx,
430 vring->desc_next, vring->desc_in_use);
432 " avail.flags 0x%x avail.idx %d used.flags 0x%x used.idx %d",
433 vring->avail->flags, vring->avail->idx,
434 vring->used->flags, vring->used->idx);
435 if (type == VIRTIO_IF_TYPE_TAP)
437 vlib_cli_output (vm, " kickfd %d, callfd %d", vring->kick_fd,
442 vlib_cli_output (vm, "\n descriptor table:\n");
444 " id addr len flags next user_addr\n");
446 " ===== ================== ===== ====== ===== ==================\n");
447 for (j = 0; j < vring->size; j++)
449 struct vring_desc *desc = &vring->desc[j];
451 " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
454 desc->flags, desc->next, desc->addr);
463 static clib_error_t *
464 virtio_init (vlib_main_t * vm)
466 virtio_main_t *vim = &virtio_main;
467 clib_error_t *error = 0;
469 vim->log_default = vlib_log_register_class ("virtio", 0);
470 vlib_log_debug (vim->log_default, "initialized");
475 VLIB_INIT_FUNCTION (virtio_init);
478 * fd.io coding-style-patch-verification: ON
481 * eval: (c-set-style "gnu")