2 * Copyright (c) 2015 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.
16 #include <sys/socket.h>
21 #include <vlib/vlib.h>
22 #include <vlib/unix/unix.h>
24 #include <vnet/vnet.h>
25 #include <vppinfra/vec.h>
26 #include <vppinfra/error.h>
27 #include <vppinfra/format.h>
29 #include <vnet/ethernet/ethernet.h>
30 #include <vnet/devices/dpdk/dpdk.h>
32 #include <vnet/devices/virtio/vhost-user.h>
34 #define VHOST_USER_DEBUG_SOCKET 0
36 #if VHOST_USER_DEBUG_SOCKET == 1
37 #define DBG_SOCK(args...) clib_warning(args);
39 #define DBG_SOCK(args...)
42 static const char *vhost_message_str[] __attribute__((unused)) = {
43 [VHOST_USER_NONE] = "VHOST_USER_NONE",
44 [VHOST_USER_GET_FEATURES] = "VHOST_USER_GET_FEATURES",
45 [VHOST_USER_SET_FEATURES] = "VHOST_USER_SET_FEATURES",
46 [VHOST_USER_SET_OWNER] = "VHOST_USER_SET_OWNER",
47 [VHOST_USER_RESET_OWNER] = "VHOST_USER_RESET_OWNER",
48 [VHOST_USER_SET_MEM_TABLE] = "VHOST_USER_SET_MEM_TABLE",
49 [VHOST_USER_SET_LOG_BASE] = "VHOST_USER_SET_LOG_BASE",
50 [VHOST_USER_SET_LOG_FD] = "VHOST_USER_SET_LOG_FD",
51 [VHOST_USER_SET_VRING_NUM] = "VHOST_USER_SET_VRING_NUM",
52 [VHOST_USER_SET_VRING_ADDR] = "VHOST_USER_SET_VRING_ADDR",
53 [VHOST_USER_SET_VRING_BASE] = "VHOST_USER_SET_VRING_BASE",
54 [VHOST_USER_GET_VRING_BASE] = "VHOST_USER_GET_VRING_BASE",
55 [VHOST_USER_SET_VRING_KICK] = "VHOST_USER_SET_VRING_KICK",
56 [VHOST_USER_SET_VRING_CALL] = "VHOST_USER_SET_VRING_CALL",
57 [VHOST_USER_SET_VRING_ERR] = "VHOST_USER_SET_VRING_ERR",
58 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
59 [VHOST_USER_GET_PROTOCOL_FEATURES] = "VHOST_USER_GET_PROTOCOL_FEATURES",
60 [VHOST_USER_SET_PROTOCOL_FEATURES] = "VHOST_USER_SET_PROTOCOL_FEATURES",
61 [VHOST_USER_GET_QUEUE_NUM] = "VHOST_USER_GET_QUEUE_NUM",
62 [VHOST_USER_SET_VRING_ENABLE] = "VHOST_USER_SET_VRING_ENABLE",
67 * DPDK vhost-user functions
70 /* portions taken from dpdk
73 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
74 * All rights reserved.
76 * Redistribution and use in source and binary forms, with or without
77 * modification, are permitted provided that the following conditions
80 * * Redistributions of source code must retain the above copyright
81 * notice, this list of conditions and the following disclaimer.
82 * * Redistributions in binary form must reproduce the above copyright
83 * notice, this list of conditions and the following disclaimer in
84 * the documentation and/or other materials provided with the
86 * * Neither the name of Intel Corporation nor the names of its
87 * contributors may be used to endorse or promote products derived
88 * from this software without specific prior written permission.
90 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
91 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
92 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
93 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
94 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
95 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
96 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
97 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
98 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
99 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
100 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
105 qva_to_vva(struct virtio_net *dev, uint64_t qemu_va)
107 struct virtio_memory_regions *region;
108 uint64_t vhost_va = 0;
109 uint32_t regionidx = 0;
111 /* Find the region where the address lives. */
112 for (regionidx = 0; regionidx < dev->mem->nregions; regionidx++) {
113 region = &dev->mem->regions[regionidx];
114 if ((qemu_va >= region->userspace_address) &&
115 (qemu_va <= region->userspace_address +
116 region->memory_size)) {
117 vhost_va = qemu_va + region->guest_phys_address +
118 region->address_offset -
119 region->userspace_address;
126 static dpdk_device_t *
127 dpdk_vhost_user_device_from_hw_if_index(u32 hw_if_index)
129 vnet_main_t *vnm = vnet_get_main();
130 dpdk_main_t * dm = &dpdk_main;
131 vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, hw_if_index);
132 dpdk_device_t * xd = vec_elt_at_index (dm->devices, hi->dev_instance);
134 if (xd->dev_type != VNET_DPDK_DEV_VHOST_USER)
140 static dpdk_device_t *
141 dpdk_vhost_user_device_from_sw_if_index(u32 sw_if_index)
143 vnet_main_t *vnm = vnet_get_main();
144 vnet_sw_interface_t * sw = vnet_get_sw_interface (vnm, sw_if_index);
145 ASSERT (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
147 return dpdk_vhost_user_device_from_hw_if_index(sw->hw_if_index);
150 static void stop_processing_packets(u32 hw_if_index, u8 idx)
153 dpdk_vhost_user_device_from_hw_if_index(hw_if_index);
155 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
156 xd->vu_vhost_dev.virtqueue[idx]->enabled = 0;
158 xd->vu_is_running = 0;
162 static void disable_interface(dpdk_device_t * xd)
164 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
166 int numqs = xd->vu_vhost_dev.virt_qp_nb * VIRTIO_QNUM;
167 for (idx = 0; idx < numqs; idx++)
168 xd->vu_vhost_dev.virtqueue[idx]->enabled = 0;
171 xd->vu_is_running = 0;
174 static inline void * map_guest_mem(dpdk_device_t * xd, u64 addr)
176 dpdk_vu_intf_t * vui = xd->vu_intf;
177 struct virtio_memory * mem = xd->vu_vhost_dev.mem;
179 for (i=0; i<mem->nregions; i++) {
180 if ((mem->regions[i].guest_phys_address <= addr) &&
181 ((mem->regions[i].guest_phys_address + mem->regions[i].memory_size) > addr)) {
182 return (void *) (vui->region_addr[i] + addr - mem->regions[i].guest_phys_address);
185 DBG_SOCK("failed to map guest mem addr %lx", addr);
189 static clib_error_t *
190 dpdk_create_vhost_user_if_internal (u32 * hw_if_index, u32 if_id, u8 *hwaddr)
192 dpdk_main_t * dm = &dpdk_main;
193 vlib_main_t * vm = vlib_get_main();
194 vlib_thread_main_t * tm = vlib_get_thread_main();
195 vnet_sw_interface_t * sw;
196 clib_error_t * error;
197 dpdk_device_and_queue_t * dq;
200 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
201 num_qpairs = dm->use_rss < 1 ? 1 : dm->use_rss;
204 dpdk_device_t * xd = NULL;
208 vlib_worker_thread_barrier_sync (vm);
210 int inactive_cnt = vec_len(dm->vu_inactive_interfaces_device_index);
211 // if there are any inactive ifaces
212 if (inactive_cnt > 0) {
214 u32 vui_idx = dm->vu_inactive_interfaces_device_index[inactive_cnt - 1];
215 if (vec_len(dm->devices) > vui_idx) {
216 xd = vec_elt_at_index (dm->devices, vui_idx);
217 if (xd->dev_type == VNET_DPDK_DEV_VHOST_USER) {
218 DBG_SOCK("reusing inactive vhost-user interface sw_if_index %d", xd->vlib_sw_if_index);
220 clib_warning("error: inactive vhost-user interface sw_if_index %d not VHOST_USER type!",
221 xd->vlib_sw_if_index);
222 // reset so new interface is created
226 // "remove" from inactive list
227 _vec_len(dm->vu_inactive_interfaces_device_index) -= 1;
231 // existing interface used - do not overwrite if_id if not needed
232 if (if_id != (u32)~0)
233 xd->vu_if_id = if_id;
236 for (j = 0; j < num_qpairs * VIRTIO_QNUM; j++) {
237 memset(xd->vu_vhost_dev.virtqueue[j], 0, sizeof(struct vhost_virtqueue));
238 xd->vu_vhost_dev.virtqueue[j]->kickfd = -1;
239 xd->vu_vhost_dev.virtqueue[j]->callfd = -1;
240 xd->vu_vhost_dev.virtqueue[j]->backend = -1;
244 dpdk_device_lock_free(xd);
246 if (xd->tx_q_used < tm->n_vlib_mains)
247 dpdk_device_lock_init(xd);
250 for (j = 0; j < tm->n_vlib_mains; j++)
252 vec_validate_ha (xd->tx_vectors[j], DPDK_TX_RING_SIZE,
253 sizeof(tx_ring_hdr_t), CLIB_CACHE_LINE_BYTES);
254 vec_reset_length (xd->tx_vectors[j]);
258 for (j = 0; j < xd->rx_q_used; j++)
260 vec_validate_aligned (xd->rx_vectors[j], VLIB_FRAME_SIZE-1,
261 CLIB_CACHE_LINE_BYTES);
262 vec_reset_length (xd->rx_vectors[j]);
265 // vui was not retrieved from inactive ifaces - create new
266 vec_add2_aligned (dm->devices, xd, 1, CLIB_CACHE_LINE_BYTES);
267 xd->dev_type = VNET_DPDK_DEV_VHOST_USER;
268 xd->rx_q_used = num_qpairs;
269 xd->tx_q_used = num_qpairs;
270 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
271 xd->vu_vhost_dev.virt_qp_nb = num_qpairs;
274 vec_validate_aligned (xd->rx_vectors, xd->rx_q_used, CLIB_CACHE_LINE_BYTES);
276 if (if_id == (u32)~0)
277 xd->vu_if_id = dm->next_vu_if_id++;
279 xd->vu_if_id = if_id;
281 xd->device_index = xd - dm->devices;
282 xd->per_interface_next_index = ~0;
285 xd->vu_vhost_dev.mem = clib_mem_alloc (sizeof(struct virtio_memory) +
286 VHOST_MEMORY_MAX_NREGIONS *
287 sizeof(struct virtio_memory_regions));
289 /* Will be set when guest sends VHOST_USER_SET_MEM_TABLE cmd */
290 xd->vu_vhost_dev.mem->nregions = 0;
293 * New virtqueue structure is an array of VHOST_MAX_QUEUE_PAIRS * 2
294 * We need to allocate numq pairs.
296 for (j = 0; j < num_qpairs * VIRTIO_QNUM; j++) {
297 xd->vu_vhost_dev.virtqueue[j] = clib_mem_alloc (sizeof(struct vhost_virtqueue));
298 memset(xd->vu_vhost_dev.virtqueue[j], 0, sizeof(struct vhost_virtqueue));
299 xd->vu_vhost_dev.virtqueue[j]->kickfd = -1;
300 xd->vu_vhost_dev.virtqueue[j]->callfd = -1;
301 xd->vu_vhost_dev.virtqueue[j]->backend = -1;
304 if (xd->tx_q_used < dm->input_cpu_count)
305 dpdk_device_lock_init(xd);
307 DBG_SOCK("tm->n_vlib_mains: %d. TX %d, RX: %d, num_qpairs: %d, Lock: %p",
308 tm->n_vlib_mains, xd->tx_q_used, xd->rx_q_used, num_qpairs, xd->lockp);
310 vec_validate_aligned (xd->tx_vectors, tm->n_vlib_mains,
311 CLIB_CACHE_LINE_BYTES);
313 for (j = 0; j < tm->n_vlib_mains; j++)
315 vec_validate_ha (xd->tx_vectors[j], DPDK_TX_RING_SIZE,
316 sizeof(tx_ring_hdr_t), CLIB_CACHE_LINE_BYTES);
317 vec_reset_length (xd->tx_vectors[j]);
321 for (j = 0; j < xd->rx_q_used; j++)
323 vec_validate_aligned (xd->rx_vectors[j], VLIB_FRAME_SIZE-1,
324 CLIB_CACHE_LINE_BYTES);
325 vec_reset_length (xd->rx_vectors[j]);
328 vec_validate_aligned (xd->frames, tm->n_vlib_mains,
329 CLIB_CACHE_LINE_BYTES);
333 * Generate random MAC address for the interface
336 memcpy(addr, hwaddr, sizeof(addr));
338 f64 now = vlib_time_now(vm);
340 rnd = (u32) (now * 1e6);
341 rnd = random_u32 (&rnd);
343 memcpy (addr+2, &rnd, sizeof(rnd));
348 error = ethernet_register_interface
350 dpdk_device_class.index,
352 /* ethernet address */ addr,
353 &xd->vlib_hw_if_index,
359 sw = vnet_get_hw_sw_interface (dm->vnet_main, xd->vlib_hw_if_index);
360 xd->vlib_sw_if_index = sw->sw_if_index;
363 xd->vu_intf = clib_mem_alloc (sizeof(*(xd->vu_intf)));
365 *hw_if_index = xd->vlib_hw_if_index;
367 DBG_SOCK("xd->device_index: %d, dm->input_cpu_count: %d, "
368 "dm->input_cpu_first_index: %d\n", xd->device_index,
369 dm->input_cpu_count, dm->input_cpu_first_index);
372 for (q = 0; q < num_qpairs; q++) {
373 int cpu = dm->input_cpu_first_index +
374 (next_cpu % dm->input_cpu_count);
376 unsigned lcore = vlib_worker_threads[cpu].dpdk_lcore_id;
377 vec_validate(xd->cpu_socket_id_by_queue, q);
378 xd->cpu_socket_id_by_queue[q] = rte_lcore_to_socket_id(lcore);
380 vec_add2(dm->devices_by_cpu[cpu], dq, 1);
381 dq->device = xd->device_index;
383 DBG_SOCK("CPU for %d = %d. QID: %d", *hw_if_index, cpu, dq->queue_id);
385 // start polling if it was not started yet (because of no phys ifaces)
386 if (tm->n_vlib_mains == 1 && dpdk_input_node.state != VLIB_NODE_STATE_POLLING)
387 vlib_node_set_state (vm, dpdk_input_node.index, VLIB_NODE_STATE_POLLING);
389 if (tm->n_vlib_mains > 1 && tm->main_thread_is_io_node)
390 vlib_node_set_state (vm, dpdk_io_input_node.index, VLIB_NODE_STATE_POLLING);
392 if (tm->n_vlib_mains > 1 && !tm->main_thread_is_io_node)
393 vlib_node_set_state (vlib_mains[cpu], dpdk_input_node.index,
394 VLIB_NODE_STATE_POLLING);
398 vlib_worker_thread_barrier_release (vm);
402 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
403 static clib_error_t *
404 dpdk_vhost_user_set_protocol_features(u32 hw_if_index, u64 prot_features)
407 xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index);
409 xd->vu_vhost_dev.protocol_features = prot_features;
414 static clib_error_t *
415 dpdk_vhost_user_get_features(u32 hw_if_index, u64 * features)
417 *features = rte_vhost_feature_get();
419 DBG_SOCK("supported features: 0x%lx", *features);
423 static clib_error_t *
424 dpdk_vhost_user_set_features(u32 hw_if_index, u64 features)
427 u16 hdr_len = sizeof(struct virtio_net_hdr);
430 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index))) {
431 clib_warning("not a vhost-user interface");
435 xd->vu_vhost_dev.features = features;
437 if (xd->vu_vhost_dev.features & (1 << VIRTIO_NET_F_MRG_RXBUF))
438 hdr_len = sizeof(struct virtio_net_hdr_mrg_rxbuf);
440 int numqs = VIRTIO_QNUM;
442 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
443 numqs = xd->vu_vhost_dev.virt_qp_nb * VIRTIO_QNUM;
445 for (idx = 0; idx < numqs; idx++)
446 xd->vu_vhost_dev.virtqueue[idx]->vhost_hlen = hdr_len;
451 static clib_error_t *
452 dpdk_vhost_user_set_mem_table(u32 hw_if_index, vhost_user_memory_t * vum, int fd[])
454 struct virtio_memory * mem;
457 dpdk_vu_intf_t * vui;
459 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index))) {
460 clib_warning("not a vhost-user interface");
465 mem = xd->vu_vhost_dev.mem;
467 mem->nregions = vum->nregions;
469 for (i=0; i < mem->nregions; i++) {
470 u64 mapped_size, mapped_address;
472 mem->regions[i].guest_phys_address = vum->regions[i].guest_phys_addr;
473 mem->regions[i].guest_phys_address_end = vum->regions[i].guest_phys_addr +
474 vum->regions[i].memory_size;
475 mem->regions[i].memory_size = vum->regions[i].memory_size;
476 mem->regions[i].userspace_address = vum->regions[i].userspace_addr;
478 mapped_size = mem->regions[i].memory_size + vum->regions[i].mmap_offset;
479 mapped_address = (uint64_t)(uintptr_t)mmap(NULL, mapped_size, PROT_READ | PROT_WRITE, MAP_SHARED, fd[i], 0);
481 if ((void *)mapped_address == MAP_FAILED)
483 clib_warning("mmap error");
487 mapped_address += vum->regions[i].mmap_offset;
488 vui->region_addr[i] = mapped_address;
489 vui->region_fd[i] = fd[i];
490 mem->regions[i].address_offset = mapped_address - mem->regions[i].guest_phys_address;
492 if (vum->regions[i].guest_phys_addr == 0) {
493 mem->base_address = vum->regions[i].userspace_addr;
494 mem->mapped_address = mem->regions[i].address_offset;
498 disable_interface(xd);
502 static clib_error_t *
503 dpdk_vhost_user_set_vring_num(u32 hw_if_index, u8 idx, u32 num)
506 struct vhost_virtqueue *vq;
508 DBG_SOCK("idx %u num %u", idx, num);
510 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index))) {
511 clib_warning("not a vhost-user interface");
514 vq = xd->vu_vhost_dev.virtqueue[idx];
517 stop_processing_packets(hw_if_index, idx);
522 static clib_error_t *
523 dpdk_vhost_user_set_vring_addr(u32 hw_if_index, u8 idx, u64 desc, u64 used, u64 avail)
526 struct vhost_virtqueue *vq;
528 DBG_SOCK("idx %u desc 0x%lx used 0x%lx avail 0x%lx",
529 idx, desc, used, avail);
531 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index))) {
532 clib_warning("not a vhost-user interface");
535 vq = xd->vu_vhost_dev.virtqueue[idx];
537 vq->desc = (struct vring_desc *) qva_to_vva(&xd->vu_vhost_dev, desc);
538 vq->used = (struct vring_used *) qva_to_vva(&xd->vu_vhost_dev, used);
539 vq->avail = (struct vring_avail *) qva_to_vva(&xd->vu_vhost_dev, avail);
541 if (!(vq->desc && vq->used && vq->avail)) {
542 clib_warning("falied to set vring addr");
545 stop_processing_packets(hw_if_index, idx);
550 static clib_error_t *
551 dpdk_vhost_user_get_vring_base(u32 hw_if_index, u8 idx, u32 * num)
554 struct vhost_virtqueue *vq;
556 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index))) {
557 clib_warning("not a vhost-user interface");
561 vq = xd->vu_vhost_dev.virtqueue[idx];
562 *num = vq->last_used_idx;
566 * Client must start ring upon receiving a kick
567 * (that is, detecting that file descriptor is readable)
568 * on the descriptor specified by VHOST_USER_SET_VRING_KICK,
569 * and stop ring upon receiving VHOST_USER_GET_VRING_BASE.
571 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
572 dpdk_vu_intf_t *vui = xd->vu_intf;
574 DBG_SOCK("Stopping vring Q %u of device %d", idx, hw_if_index);
575 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
576 vui->vrings[idx].enabled = 0; /* Reset local copy */
577 vui->vrings[idx].callfd = -1; /* Reset FD */
583 /* Check if all Qs are disabled */
584 int numqs = xd->vu_vhost_dev.virt_qp_nb * VIRTIO_QNUM;
585 for (idx = 0; idx < numqs; idx++) {
586 if (xd->vu_vhost_dev.virtqueue[idx]->enabled)
590 /* If all vrings are disabed then disable device */
592 DBG_SOCK("Device %d disabled", hw_if_index);
593 xd->vu_is_running = 0;
599 xd->vu_is_running = 0;
605 static clib_error_t *
606 dpdk_vhost_user_set_vring_base(u32 hw_if_index, u8 idx, u32 num)
609 struct vhost_virtqueue *vq;
611 DBG_SOCK("idx %u num %u", idx, num);
613 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index))) {
614 clib_warning("not a vhost-user interface");
618 vq = xd->vu_vhost_dev.virtqueue[idx];
619 vq->last_used_idx = num;
620 vq->last_used_idx_res = num;
622 stop_processing_packets(hw_if_index, idx);
627 static clib_error_t *
628 dpdk_vhost_user_set_vring_kick(u32 hw_if_index, u8 idx, int fd)
630 dpdk_main_t * dm = &dpdk_main;
632 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
633 dpdk_vu_vring *vring;
635 struct vhost_virtqueue *vq0, *vq1, *vq;
636 int index, vu_is_running = 0;
638 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index))) {
639 clib_warning("not a vhost-user interface");
643 vq = xd->vu_vhost_dev.virtqueue[idx];
646 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
647 vring = &xd->vu_intf->vrings[idx];
648 vq->enabled = (vq->desc && vq->avail && vq->used && vring->enabled) ? 1 : 0;
652 * Set xd->vu_is_running if at least one pair of
653 * RX/TX queues are enabled.
655 int numqs = VIRTIO_QNUM;
656 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
657 numqs = xd->vu_vhost_dev.virt_qp_nb * VIRTIO_QNUM;
660 for (index = 0; index < numqs; index += 2) {
661 vq0 = xd->vu_vhost_dev.virtqueue[index]; /* RX */
662 vq1 = xd->vu_vhost_dev.virtqueue[index + 1]; /* TX */
663 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
664 if (vq0->enabled && vq1->enabled)
666 if (vq0->desc && vq0->avail && vq0->used &&
667 vq1->desc && vq1->avail && vq1->used)
674 DBG_SOCK("SET_VRING_KICK - idx %d, running %d, fd: %d",
675 idx, vu_is_running, fd);
677 xd->vu_is_running = vu_is_running;
678 if (xd->vu_is_running && xd->admin_up) {
679 vnet_hw_interface_set_flags (dm->vnet_main,
680 xd->vlib_hw_if_index, VNET_HW_INTERFACE_FLAG_LINK_UP |
681 ETH_LINK_FULL_DUPLEX );
687 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
688 int dpdk_vhost_user_set_vring_enable(u32 hw_if_index, u8 idx, int enable)
691 struct vhost_virtqueue *vq;
694 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index))) {
695 clib_warning("not a vhost-user interface");
701 * Guest vhost driver wrongly enables queue before
702 * setting the vring address. Therefore, save a
703 * local copy. Reflect it in vq structure if addresses
704 * are set. If not, vq will be enabled when vring
707 vui->vrings[idx].enabled = enable; /* Save local copy */
709 vq = xd->vu_vhost_dev.virtqueue[idx];
710 if (vq->desc && vq->avail && vq->used)
711 xd->vu_vhost_dev.virtqueue[idx]->enabled = enable;
717 static clib_error_t * dpdk_vhost_user_callfd_read_ready (unix_file_t * uf)
719 __attribute__((unused)) int n;
721 n = read(uf->file_descriptor, ((char*)&buff), 8);
725 static clib_error_t *
726 dpdk_vhost_user_set_vring_call(u32 hw_if_index, u8 idx, int fd)
729 struct vhost_virtqueue *vq;
730 unix_file_t template = {0};
732 DBG_SOCK("SET_VRING_CALL - idx %d, fd %d", idx, fd);
734 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index))) {
735 clib_warning("not a vhost-user interface");
739 dpdk_vu_intf_t *vui = xd->vu_intf;
741 /* if there is old fd, delete it */
742 if (vui->vrings[idx].callfd > 0) {
743 unix_file_t * uf = pool_elt_at_index (unix_main.file_pool,
744 vui->vrings[idx].callfd_idx);
745 unix_file_del (&unix_main, uf);
747 vui->vrings[idx].callfd = fd;
748 template.read_function = dpdk_vhost_user_callfd_read_ready;
749 template.file_descriptor = fd;
750 vui->vrings[idx].callfd_idx = unix_file_add (&unix_main, &template);
752 vq = xd->vu_vhost_dev.virtqueue[idx];
753 vq->callfd = -1; /* We use locally saved vring->callfd; */
759 dpdk_vhost_user_want_interrupt(dpdk_device_t *xd, int idx)
761 dpdk_vu_intf_t *vui = xd->vu_intf;
764 if (PREDICT_FALSE(vui->num_vrings <= 0))
767 dpdk_vu_vring *vring = &(vui->vrings[idx]);
768 struct vhost_virtqueue *vq = xd->vu_vhost_dev.virtqueue[idx];
770 /* return if vm is interested in interrupts */
771 return (vring->callfd > 0) && !(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT);
775 dpdk_vhost_user_send_interrupt(vlib_main_t * vm, dpdk_device_t * xd, int idx)
777 dpdk_main_t * dm = &dpdk_main;
778 dpdk_vu_intf_t *vui = xd->vu_intf;
781 if (PREDICT_FALSE(vui->num_vrings <= 0))
784 dpdk_vu_vring *vring = &(vui->vrings[idx]);
785 struct vhost_virtqueue *vq = xd->vu_vhost_dev.virtqueue[idx];
787 /* if vm is interested in interrupts */
788 if((vring->callfd > 0) && !(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT)) {
789 eventfd_write(vring->callfd, (eventfd_t)1);
790 vring->n_since_last_int = 0;
791 vring->int_deadline = vlib_time_now(vm) + dm->vhost_coalesce_time;
796 * vhost-user interface management functions
799 // initialize vui with specified attributes
801 dpdk_vhost_user_vui_init(vnet_main_t * vnm,
802 dpdk_device_t *xd, int sockfd,
803 const char * sock_filename,
804 u8 is_server, u64 feature_mask,
807 dpdk_vu_intf_t *vui = xd->vu_intf;
808 memset(vui, 0, sizeof(*vui));
810 vui->unix_fd = sockfd;
811 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
812 vui->num_vrings = xd->vu_vhost_dev.virt_qp_nb * VIRTIO_QNUM;
814 vui->num_vrings = VIRTIO_QNUM;
816 DBG_SOCK("dpdk_vhost_user_vui_init VRINGS: %d", vui->num_vrings);
817 vui->sock_is_server = is_server;
818 strncpy(vui->sock_filename, sock_filename, ARRAY_LEN(vui->sock_filename)-1);
821 vui->feature_mask = feature_mask;
823 vui->unix_file_index = ~0;
825 vnet_hw_interface_set_flags (vnm, xd->vlib_hw_if_index, 0);
828 *sw_if_index = xd->vlib_sw_if_index;
831 // register vui and start polling on it
833 dpdk_vhost_user_vui_register(vlib_main_t * vm, dpdk_device_t *xd)
835 dpdk_main_t * dm = &dpdk_main;
836 dpdk_vu_intf_t *vui = xd->vu_intf;
838 hash_set (dm->vu_sw_if_index_by_listener_fd, vui->unix_fd,
839 xd->vlib_sw_if_index);
843 dpdk_vhost_user_if_disconnect(dpdk_device_t * xd)
845 dpdk_vu_intf_t *vui = xd->vu_intf;
846 vnet_main_t * vnm = vnet_get_main();
847 dpdk_main_t * dm = &dpdk_main;
850 vnet_hw_interface_set_flags (vnm, xd->vlib_hw_if_index, 0);
852 if (vui->unix_file_index != ~0) {
853 unix_file_del (&unix_main, unix_main.file_pool + vui->unix_file_index);
854 vui->unix_file_index = ~0;
857 hash_unset(dm->vu_sw_if_index_by_sock_fd, vui->unix_fd);
858 hash_unset(dm->vu_sw_if_index_by_listener_fd, vui->unix_fd);
863 DBG_SOCK("interface ifindex %d disconnected", xd->vlib_sw_if_index);
866 static clib_error_t * dpdk_vhost_user_socket_read (unix_file_t * uf)
869 int fd, number_of_fds = 0;
870 int fds[VHOST_MEMORY_MAX_NREGIONS];
871 vhost_user_msg_t msg;
874 dpdk_main_t * dm = &dpdk_main;
877 struct cmsghdr *cmsg;
880 vnet_main_t * vnm = vnet_get_main();
882 p = hash_get (dm->vu_sw_if_index_by_sock_fd, uf->file_descriptor);
884 DBG_SOCK ("FD %d doesn't belong to any interface",
885 uf->file_descriptor);
889 xd = dpdk_vhost_user_device_from_sw_if_index(p[0]);
894 char control[CMSG_SPACE(VHOST_MEMORY_MAX_NREGIONS * sizeof(int))];
896 memset(&mh, 0, sizeof(mh));
897 memset(control, 0, sizeof(control));
899 /* set the payload */
900 iov[0].iov_base = (void *) &msg;
901 iov[0].iov_len = VHOST_USER_MSG_HDR_SZ;
905 mh.msg_control = control;
906 mh.msg_controllen = sizeof(control);
908 n = recvmsg(uf->file_descriptor, &mh, 0);
910 if (n != VHOST_USER_MSG_HDR_SZ)
913 if (mh.msg_flags & MSG_CTRUNC) {
917 cmsg = CMSG_FIRSTHDR(&mh);
919 if (cmsg && (cmsg->cmsg_len > 0) && (cmsg->cmsg_level == SOL_SOCKET) &&
920 (cmsg->cmsg_type == SCM_RIGHTS) &&
921 (cmsg->cmsg_len - CMSG_LEN(0) <= VHOST_MEMORY_MAX_NREGIONS * sizeof(int))) {
922 number_of_fds = (cmsg->cmsg_len - CMSG_LEN(0)) / sizeof(int);
923 memcpy(fds, CMSG_DATA(cmsg), number_of_fds * sizeof(int));
926 /* version 1, no reply bit set*/
927 if ((msg.flags & 7) != 1) {
928 DBG_SOCK("malformed message received. closing socket");
933 int rv __attribute__((unused));
934 /* $$$$ pay attention to rv */
935 rv = read(uf->file_descriptor, ((char*)&msg) + n, msg.size);
938 DBG_SOCK("VPP VHOST message %s", vhost_message_str[msg.request]);
939 switch (msg.request) {
940 case VHOST_USER_GET_FEATURES:
941 DBG_SOCK("if %d msg VHOST_USER_GET_FEATURES",
942 xd->vlib_hw_if_index);
944 msg.flags |= VHOST_USER_REPLY_MASK;
946 dpdk_vhost_user_get_features(xd->vlib_hw_if_index, &msg.u64);
947 msg.u64 &= vui->feature_mask;
948 msg.size = sizeof(msg.u64);
951 case VHOST_USER_SET_FEATURES:
952 DBG_SOCK("if %d msg VHOST_USER_SET_FEATURES features 0x%016lx",
953 xd->vlib_hw_if_index, msg.u64);
955 dpdk_vhost_user_set_features(xd->vlib_hw_if_index, msg.u64);
958 case VHOST_USER_SET_MEM_TABLE:
959 DBG_SOCK("if %d msg VHOST_USER_SET_MEM_TABLE nregions %d",
960 xd->vlib_hw_if_index, msg.memory.nregions);
962 if ((msg.memory.nregions < 1) ||
963 (msg.memory.nregions > VHOST_MEMORY_MAX_NREGIONS)) {
965 DBG_SOCK("number of mem regions must be between 1 and %i",
966 VHOST_MEMORY_MAX_NREGIONS);
971 if (msg.memory.nregions != number_of_fds) {
972 DBG_SOCK("each memory region must have FD");
976 dpdk_vhost_user_set_mem_table(xd->vlib_hw_if_index, &msg.memory, fds);
979 case VHOST_USER_SET_VRING_NUM:
980 DBG_SOCK("if %d msg VHOST_USER_SET_VRING_NUM idx %d num %d",
981 xd->vlib_hw_if_index, msg.state.index, msg.state.num);
983 if ((msg.state.num > 32768) || /* maximum ring size is 32768 */
984 (msg.state.num == 0) || /* it cannot be zero */
985 (msg.state.num % 2)) /* must be power of 2 */
988 dpdk_vhost_user_set_vring_num(xd->vlib_hw_if_index, msg.state.index, msg.state.num);
991 case VHOST_USER_SET_VRING_ADDR:
992 DBG_SOCK("if %d msg VHOST_USER_SET_VRING_ADDR idx %d",
993 xd->vlib_hw_if_index, msg.state.index);
995 dpdk_vhost_user_set_vring_addr(xd->vlib_hw_if_index, msg.state.index,
996 msg.addr.desc_user_addr,
997 msg.addr.used_user_addr,
998 msg.addr.avail_user_addr);
1001 case VHOST_USER_SET_OWNER:
1002 DBG_SOCK("if %d msg VHOST_USER_SET_OWNER",
1003 xd->vlib_hw_if_index);
1006 case VHOST_USER_RESET_OWNER:
1007 DBG_SOCK("if %d msg VHOST_USER_RESET_OWNER",
1008 xd->vlib_hw_if_index);
1011 case VHOST_USER_SET_VRING_CALL:
1012 q = (u8) (msg.u64 & 0xFF);
1014 DBG_SOCK("if %d msg VHOST_USER_SET_VRING_CALL u64 %lx, idx: %d",
1015 xd->vlib_hw_if_index, msg.u64, q);
1017 if (!(msg.u64 & 0x100))
1019 if (number_of_fds != 1)
1025 dpdk_vhost_user_set_vring_call(xd->vlib_hw_if_index, q, fd);
1029 case VHOST_USER_SET_VRING_KICK:
1031 q = (u8) (msg.u64 & 0xFF);
1033 DBG_SOCK("if %d msg VHOST_USER_SET_VRING_KICK u64 %lx, idx: %d",
1034 xd->vlib_hw_if_index, msg.u64, q);
1036 if (!(msg.u64 & 0x100))
1038 if (number_of_fds != 1)
1041 vui->vrings[q].kickfd = fds[0];
1044 vui->vrings[q].kickfd = -1;
1046 dpdk_vhost_user_set_vring_kick(xd->vlib_hw_if_index, q, vui->vrings[q].kickfd);
1049 case VHOST_USER_SET_VRING_ERR:
1051 q = (u8) (msg.u64 & 0xFF);
1053 DBG_SOCK("if %d msg VHOST_USER_SET_VRING_ERR u64 %lx, idx: %d",
1054 xd->vlib_hw_if_index, msg.u64, q);
1056 if (!(msg.u64 & 0x100))
1058 if (number_of_fds != 1)
1066 vui->vrings[q].errfd = fd;
1069 case VHOST_USER_SET_VRING_BASE:
1070 DBG_SOCK("if %d msg VHOST_USER_SET_VRING_BASE idx %d num %d",
1071 xd->vlib_hw_if_index, msg.state.index, msg.state.num);
1073 dpdk_vhost_user_set_vring_base(xd->vlib_hw_if_index, msg.state.index, msg.state.num);
1076 case VHOST_USER_GET_VRING_BASE:
1077 DBG_SOCK("if %d msg VHOST_USER_GET_VRING_BASE idx %d num %d",
1078 xd->vlib_hw_if_index, msg.state.index, msg.state.num);
1080 msg.flags |= VHOST_USER_REPLY_MASK;
1081 msg.size = sizeof(msg.state);
1083 dpdk_vhost_user_get_vring_base(xd->vlib_hw_if_index, msg.state.index, &msg.state.num);
1086 case VHOST_USER_NONE:
1087 DBG_SOCK("if %d msg VHOST_USER_NONE",
1088 xd->vlib_hw_if_index);
1091 case VHOST_USER_SET_LOG_BASE:
1092 DBG_SOCK("if %d msg VHOST_USER_SET_LOG_BASE",
1093 xd->vlib_hw_if_index);
1096 case VHOST_USER_SET_LOG_FD:
1097 DBG_SOCK("if %d msg VHOST_USER_SET_LOG_FD",
1098 xd->vlib_hw_if_index);
1101 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
1102 case VHOST_USER_GET_PROTOCOL_FEATURES:
1103 DBG_SOCK("if %d msg VHOST_USER_GET_PROTOCOL_FEATURES",
1104 xd->vlib_hw_if_index);
1106 msg.flags |= VHOST_USER_REPLY_MASK;
1107 msg.u64 = VHOST_USER_PROTOCOL_FEATURES;
1108 DBG_SOCK("VHOST_USER_PROTOCOL_FEATURES: %llx", VHOST_USER_PROTOCOL_FEATURES);
1109 msg.size = sizeof(msg.u64);
1112 case VHOST_USER_SET_PROTOCOL_FEATURES:
1113 DBG_SOCK("if %d msg VHOST_USER_SET_PROTOCOL_FEATURES",
1114 xd->vlib_hw_if_index);
1116 DBG_SOCK("VHOST_USER_SET_PROTOCOL_FEATURES: 0x%lx",
1118 dpdk_vhost_user_set_protocol_features(xd->vlib_hw_if_index,
1122 case VHOST_USER_SET_VRING_ENABLE:
1123 DBG_SOCK("%d VPP VHOST_USER_SET_VRING_ENABLE IDX: %d, Enable: %d",
1124 xd->vlib_hw_if_index, msg.state.index, msg.state.num);
1125 dpdk_vhost_user_set_vring_enable
1126 (xd->vlib_hw_if_index, msg.state.index, msg.state.num);
1129 case VHOST_USER_GET_QUEUE_NUM:
1130 DBG_SOCK("if %d msg VHOST_USER_GET_QUEUE_NUM:",
1131 xd->vlib_hw_if_index);
1133 msg.flags |= VHOST_USER_REPLY_MASK;
1134 msg.u64 = xd->vu_vhost_dev.virt_qp_nb;
1135 msg.size = sizeof(msg.u64);
1140 DBG_SOCK("unknown vhost-user message %d received. closing socket",
1145 /* if we have pointers to descriptor table, go up*/
1147 xd->vu_vhost_dev.virtqueue[VHOST_NET_VRING_IDX_TX]->desc &&
1148 xd->vu_vhost_dev.virtqueue[VHOST_NET_VRING_IDX_RX]->desc) {
1150 DBG_SOCK("interface %d connected", xd->vlib_sw_if_index);
1152 vnet_hw_interface_set_flags (vnm, xd->vlib_hw_if_index, VNET_HW_INTERFACE_FLAG_LINK_UP);
1157 /* if we need to reply */
1158 if (msg.flags & VHOST_USER_REPLY_MASK)
1160 n = send(uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
1161 if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
1168 DBG_SOCK("error: close_socket");
1169 dpdk_vhost_user_if_disconnect(xd);
1173 static clib_error_t * dpdk_vhost_user_socket_error (unix_file_t * uf)
1175 dpdk_main_t * dm = &dpdk_main;
1179 p = hash_get (dm->vu_sw_if_index_by_sock_fd, uf->file_descriptor);
1181 DBG_SOCK ("FD %d doesn't belong to any interface",
1182 uf->file_descriptor);
1186 xd = dpdk_vhost_user_device_from_sw_if_index(p[0]);
1188 dpdk_vhost_user_if_disconnect(xd);
1192 static clib_error_t * dpdk_vhost_user_socksvr_accept_ready (unix_file_t * uf)
1194 int client_fd, client_len;
1195 struct sockaddr_un client;
1196 unix_file_t template = {0};
1197 dpdk_main_t * dm = &dpdk_main;
1198 dpdk_device_t * xd = NULL;
1199 dpdk_vu_intf_t * vui;
1202 p = hash_get (dm->vu_sw_if_index_by_listener_fd,
1203 uf->file_descriptor);
1205 DBG_SOCK ("fd %d doesn't belong to any interface",
1206 uf->file_descriptor);
1210 xd = dpdk_vhost_user_device_from_sw_if_index(p[0]);
1214 client_len = sizeof(client);
1215 client_fd = accept (uf->file_descriptor,
1216 (struct sockaddr *)&client,
1217 (socklen_t *)&client_len);
1220 return clib_error_return_unix (0, "accept");
1222 template.read_function = dpdk_vhost_user_socket_read;
1223 template.error_function = dpdk_vhost_user_socket_error;
1224 template.file_descriptor = client_fd;
1225 vui->unix_file_index = unix_file_add (&unix_main, &template);
1227 vui->client_fd = client_fd;
1228 hash_set (dm->vu_sw_if_index_by_sock_fd, vui->client_fd,
1229 xd->vlib_sw_if_index);
1234 // init server socket on specified sock_filename
1235 static int dpdk_vhost_user_init_server_sock(const char * sock_filename, int *sockfd)
1238 struct sockaddr_un un;
1240 /* create listening socket */
1241 fd = socket(AF_UNIX, SOCK_STREAM, 0);
1244 return VNET_API_ERROR_SYSCALL_ERROR_1;
1247 un.sun_family = AF_UNIX;
1248 strcpy((char *) un.sun_path, (char *) sock_filename);
1250 /* remove if exists */
1251 unlink( (char *) sock_filename);
1253 len = strlen((char *) un.sun_path) + strlen((char *) sock_filename);
1255 if (bind(fd, (struct sockaddr *) &un, len) == -1) {
1256 rv = VNET_API_ERROR_SYSCALL_ERROR_2;
1260 if (listen(fd, 1) == -1) {
1261 rv = VNET_API_ERROR_SYSCALL_ERROR_3;
1265 unix_file_t template = {0};
1266 template.read_function = dpdk_vhost_user_socksvr_accept_ready;
1267 template.file_descriptor = fd;
1268 unix_file_add (&unix_main, &template);
1278 * vhost-user interface control functions used from vpe api
1281 int dpdk_vhost_user_create_if(vnet_main_t * vnm, vlib_main_t * vm,
1282 const char * sock_filename,
1286 u8 renumber, u32 custom_dev_instance,
1289 dpdk_main_t * dm = &dpdk_main;
1295 // using virtio vhost user?
1296 if (dm->use_virtio_vhost) {
1297 return vhost_user_create_if(vnm, vm, sock_filename, is_server,
1298 sw_if_index, feature_mask, renumber, custom_dev_instance, hwaddr);
1302 if ((rv = dpdk_vhost_user_init_server_sock (sock_filename, &sockfd)) != 0) {
1308 // set next vhost-user if id if custom one is higher or equal
1309 if (custom_dev_instance >= dm->next_vu_if_id)
1310 dm->next_vu_if_id = custom_dev_instance + 1;
1312 dpdk_create_vhost_user_if_internal(&hw_if_idx, custom_dev_instance, hwaddr);
1314 dpdk_create_vhost_user_if_internal(&hw_if_idx, (u32)~0, hwaddr);
1315 DBG_SOCK("dpdk vhost-user interface created hw_if_index %d", hw_if_idx);
1317 xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_idx);
1320 dpdk_vhost_user_vui_init (vnm, xd, sockfd, sock_filename, is_server,
1321 feature_mask, sw_if_index);
1323 dpdk_vhost_user_vui_register (vm, xd);
1327 int dpdk_vhost_user_modify_if(vnet_main_t * vnm, vlib_main_t * vm,
1328 const char * sock_filename,
1332 u8 renumber, u32 custom_dev_instance)
1334 dpdk_main_t * dm = &dpdk_main;
1336 dpdk_vu_intf_t * vui = NULL;
1341 // using virtio vhost user?
1342 if (dm->use_virtio_vhost) {
1343 return vhost_user_modify_if(vnm, vm, sock_filename, is_server,
1344 sw_if_index, feature_mask, renumber, custom_dev_instance);
1347 xd = dpdk_vhost_user_device_from_sw_if_index(sw_if_index);
1350 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1354 // interface is inactive
1356 // disconnect interface sockets
1357 dpdk_vhost_user_if_disconnect(xd);
1360 if ((rv = dpdk_vhost_user_init_server_sock (sock_filename, &sockfd)) != 0) {
1365 dpdk_vhost_user_vui_init (vnm, xd, sockfd, sock_filename, is_server,
1366 feature_mask, &sw_if_idx);
1369 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
1372 dpdk_vhost_user_vui_register (vm, xd);
1377 int dpdk_vhost_user_delete_if(vnet_main_t * vnm, vlib_main_t * vm,
1380 dpdk_main_t * dm = &dpdk_main;
1381 dpdk_device_t * xd = NULL;
1382 dpdk_vu_intf_t * vui;
1385 // using virtio vhost user?
1386 if (dm->use_virtio_vhost) {
1387 return vhost_user_delete_if(vnm, vm, sw_if_index);
1390 xd = dpdk_vhost_user_device_from_sw_if_index(sw_if_index);
1393 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1397 // interface is inactive
1399 // disconnect interface sockets
1400 dpdk_vhost_user_if_disconnect(xd);
1401 // add to inactive interface list
1402 vec_add1 (dm->vu_inactive_interfaces_device_index, xd->device_index);
1404 ethernet_delete_interface (vnm, xd->vlib_hw_if_index);
1405 DBG_SOCK ("deleted (deactivated) vhost-user interface sw_if_index %d", sw_if_index);
1410 int dpdk_vhost_user_dump_ifs(vnet_main_t * vnm, vlib_main_t * vm, vhost_user_intf_details_t **out_vuids)
1413 dpdk_main_t * dm = &dpdk_main;
1415 dpdk_vu_intf_t * vui;
1416 struct virtio_net * vhost_dev;
1417 vhost_user_intf_details_t * r_vuids = NULL;
1418 vhost_user_intf_details_t * vuid = NULL;
1419 u32 * hw_if_indices = 0;
1420 vnet_hw_interface_t * hi;
1427 // using virtio vhost user?
1428 if (dm->use_virtio_vhost) {
1429 return vhost_user_dump_ifs(vnm, vm, out_vuids);
1432 vec_foreach (xd, dm->devices) {
1433 if (xd->dev_type == VNET_DPDK_DEV_VHOST_USER &&
1434 xd->vu_intf->active)
1435 vec_add1(hw_if_indices, xd->vlib_hw_if_index);
1438 for (i = 0; i < vec_len (hw_if_indices); i++) {
1439 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
1440 xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_indices[i]);
1442 clib_warning("invalid vhost-user interface hw_if_index %d", hw_if_indices[i]);
1447 ASSERT(vui != NULL);
1448 vhost_dev = &xd->vu_vhost_dev;
1449 u32 virtio_net_hdr_sz = (vui->num_vrings > 0 ?
1450 vhost_dev->virtqueue[0]->vhost_hlen : 0);
1452 vec_add2(r_vuids, vuid, 1);
1453 vuid->sw_if_index = xd->vlib_sw_if_index;
1454 vuid->virtio_net_hdr_sz = virtio_net_hdr_sz;
1455 vuid->features = vhost_dev->features;
1456 vuid->is_server = vui->sock_is_server;
1457 vuid->num_regions = (vhost_dev->mem != NULL ? vhost_dev->mem->nregions : 0);
1458 vuid->sock_errno = vui->sock_errno;
1459 strncpy((char *)vuid->sock_filename, (char *)vui->sock_filename,
1460 ARRAY_LEN(vuid->sock_filename)-1);
1462 s = format (s, "%v%c", hi->name, 0);
1464 strncpy((char *)vuid->if_name, (char *)s,
1465 ARRAY_LEN(vuid->if_name)-1);
1470 vec_free (hw_if_indices);
1472 *out_vuids = r_vuids;
1478 * Processing functions called from dpdk process fn
1482 struct sockaddr_un sun;
1484 unix_file_t template;
1486 } dpdk_vu_process_state;
1488 void dpdk_vhost_user_process_init (void **ctx)
1490 dpdk_vu_process_state *state = clib_mem_alloc (sizeof(dpdk_vu_process_state));
1491 memset(state, 0, sizeof(*state));
1492 state->sockfd = socket(AF_UNIX, SOCK_STREAM, 0);
1493 state->sun.sun_family = AF_UNIX;
1494 state->template.read_function = dpdk_vhost_user_socket_read;
1495 state->template.error_function = dpdk_vhost_user_socket_error;
1496 state->event_data = 0;
1500 void dpdk_vhost_user_process_cleanup (void *ctx)
1505 uword dpdk_vhost_user_process_if (vlib_main_t *vm, dpdk_device_t *xd, void *ctx)
1507 dpdk_main_t * dm = &dpdk_main;
1508 dpdk_vu_process_state *state = (dpdk_vu_process_state *)ctx;
1509 dpdk_vu_intf_t *vui = xd->vu_intf;
1511 if (vui->sock_is_server || !vui->active)
1514 if (vui->unix_fd == -1) {
1515 /* try to connect */
1516 strncpy(state->sun.sun_path, (char *) vui->sock_filename, sizeof(state->sun.sun_path) - 1);
1518 if (connect(state->sockfd, (struct sockaddr *) &(state->sun), sizeof(struct sockaddr_un)) == 0) {
1519 vui->sock_errno = 0;
1520 vui->unix_fd = state->sockfd;
1521 state->template.file_descriptor = state->sockfd;
1522 vui->unix_file_index = unix_file_add (&unix_main, &(state->template));
1523 hash_set (dm->vu_sw_if_index_by_sock_fd, state->sockfd, xd->vlib_sw_if_index);
1525 state->sockfd = socket(AF_UNIX, SOCK_STREAM, 0);
1526 if (state->sockfd < 0)
1529 vui->sock_errno = errno;
1532 /* check if socket is alive */
1534 socklen_t len = sizeof (error);
1535 int retval = getsockopt(vui->unix_fd, SOL_SOCKET, SO_ERROR, &error, &len);
1538 dpdk_vhost_user_if_disconnect(xd);
1547 static clib_error_t *
1548 dpdk_vhost_user_connect_command_fn (vlib_main_t * vm,
1549 unformat_input_t * input,
1550 vlib_cli_command_t * cmd)
1552 dpdk_main_t * dm = &dpdk_main;
1553 unformat_input_t _line_input, * line_input = &_line_input;
1554 u8 * sock_filename = NULL;
1557 u64 feature_mask = (u64)~0;
1559 u32 custom_dev_instance = ~0;
1563 if (dm->use_virtio_vhost) {
1564 return vhost_user_connect_command_fn(vm, input, cmd);
1567 /* Get a line of input. */
1568 if (! unformat_user (input, unformat_line_input, line_input))
1571 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
1572 if (unformat (line_input, "socket %s", &sock_filename))
1574 else if (unformat (line_input, "server"))
1576 else if (unformat (line_input, "feature-mask 0x%llx", &feature_mask))
1578 else if (unformat (line_input, "hwaddr %U", unformat_ethernet_address, hwaddr))
1580 else if (unformat (line_input, "renumber %d", &custom_dev_instance)) {
1584 return clib_error_return (0, "unknown input `%U'",
1585 format_unformat_error, input);
1587 unformat_free (line_input);
1589 vnet_main_t *vnm = vnet_get_main();
1590 if (sock_filename == NULL)
1591 return clib_error_return (0, "missing socket file");
1593 dpdk_vhost_user_create_if(vnm, vm, (char *)sock_filename,
1594 is_server, &sw_if_index, feature_mask,
1595 renumber, custom_dev_instance, hw);
1597 vec_free(sock_filename);
1601 VLIB_CLI_COMMAND (dpdk_vhost_user_connect_command, static) = {
1602 .path = "create vhost-user",
1603 .short_help = "create vhost-user socket <socket-filename> [server] [feature-mask <hex>] [renumber <dev_instance>]",
1604 .function = dpdk_vhost_user_connect_command_fn,
1607 static clib_error_t *
1608 dpdk_vhost_user_delete_command_fn (vlib_main_t * vm,
1609 unformat_input_t * input,
1610 vlib_cli_command_t * cmd)
1612 dpdk_main_t * dm = &dpdk_main;
1613 clib_error_t * error = 0;
1614 unformat_input_t _line_input, * line_input = &_line_input;
1615 u32 sw_if_index = ~0;
1617 if (dm->use_virtio_vhost) {
1618 return vhost_user_delete_command_fn(vm, input, cmd);
1621 /* Get a line of input. */
1622 if (! unformat_user (input, unformat_line_input, line_input))
1625 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
1626 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
1629 return clib_error_return (0, "unknown input `%U'",
1630 format_unformat_error, input);
1632 unformat_free (line_input);
1634 if (sw_if_index == ~0) {
1635 error = clib_error_return (0, "invalid sw_if_index",
1636 format_unformat_error, input);
1640 vnet_main_t *vnm = vnet_get_main();
1642 dpdk_vhost_user_delete_if(vnm, vm, sw_if_index);
1647 VLIB_CLI_COMMAND (dpdk_vhost_user_delete_command, static) = {
1648 .path = "delete vhost-user",
1649 .short_help = "delete vhost-user sw_if_index <nn>",
1650 .function = dpdk_vhost_user_delete_command_fn,
1653 #define foreach_dpdk_vhost_feature \
1654 _ (VIRTIO_NET_F_MRG_RXBUF) \
1655 _ (VIRTIO_NET_F_CTRL_VQ) \
1656 _ (VIRTIO_NET_F_CTRL_RX)
1658 static clib_error_t *
1659 show_dpdk_vhost_user_command_fn (vlib_main_t * vm,
1660 unformat_input_t * input,
1661 vlib_cli_command_t * cmd)
1663 clib_error_t * error = 0;
1664 dpdk_main_t * dm = &dpdk_main;
1665 vnet_main_t * vnm = vnet_get_main();
1667 dpdk_vu_intf_t * vui;
1668 struct virtio_net * vhost_dev;
1669 u32 hw_if_index, * hw_if_indices = 0;
1670 vnet_hw_interface_t * hi;
1673 struct virtio_memory * mem;
1674 struct feat_struct { u8 bit; char *str;};
1675 struct feat_struct *feat_entry;
1677 static struct feat_struct feat_array[] = {
1678 #define _(f) { .str = #f, .bit = f, },
1679 foreach_dpdk_vhost_feature
1684 if (dm->use_virtio_vhost) {
1685 return show_vhost_user_command_fn(vm, input, cmd);
1688 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) {
1689 if (unformat (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index)) {
1690 vec_add1 (hw_if_indices, hw_if_index);
1691 vlib_cli_output(vm, "add %d", hw_if_index);
1693 else if (unformat (input, "descriptors") || unformat (input, "desc") )
1696 error = clib_error_return (0, "unknown input `%U'",
1697 format_unformat_error, input);
1701 if (vec_len (hw_if_indices) == 0) {
1702 vec_foreach (xd, dm->devices) {
1703 if (xd->dev_type == VNET_DPDK_DEV_VHOST_USER && xd->vu_intf->active)
1704 vec_add1(hw_if_indices, xd->vlib_hw_if_index);
1708 vlib_cli_output (vm, "DPDK vhost-user interfaces");
1709 vlib_cli_output (vm, "Global:\n coalesce frames %d time %e\n\n",
1710 dm->vhost_coalesce_frames, dm->vhost_coalesce_time);
1712 for (i = 0; i < vec_len (hw_if_indices); i++) {
1713 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
1715 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_indices[i]))) {
1716 error = clib_error_return (0, "not dpdk vhost-user interface: '%s'",
1721 vhost_dev = &xd->vu_vhost_dev;
1722 mem = vhost_dev->mem;
1723 u32 virtio_net_hdr_sz = (vui->num_vrings > 0 ?
1724 vhost_dev->virtqueue[0]->vhost_hlen : 0);
1726 vlib_cli_output (vm, "Interface: %v (ifindex %d)",
1727 hi->name, hw_if_indices[i]);
1729 vlib_cli_output (vm, "virtio_net_hdr_sz %d\n features (0x%llx): \n",
1730 virtio_net_hdr_sz, xd->vu_vhost_dev.features);
1732 feat_entry = (struct feat_struct *) &feat_array;
1733 while(feat_entry->str) {
1734 if (xd->vu_vhost_dev.features & (1 << feat_entry->bit))
1735 vlib_cli_output (vm, " %s (%d)", feat_entry->str, feat_entry->bit);
1739 vlib_cli_output (vm, "\n");
1741 vlib_cli_output (vm, " socket filename %s type %s errno \"%s\"\n\n",
1742 vui->sock_filename, vui->sock_is_server ? "server" : "client",
1743 strerror(vui->sock_errno));
1745 vlib_cli_output (vm, " Memory regions (total %d)\n", mem->nregions);
1748 vlib_cli_output(vm, " region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr\n");
1749 vlib_cli_output(vm, " ====== ===== ================== ================== ================== ================== ==================\n");
1751 for (j = 0; j < mem->nregions; j++) {
1752 vlib_cli_output(vm, " %d %-5d 0x%016lx 0x%016lx 0x%016lx 0x%016lx 0x%016lx\n", j,
1754 mem->regions[j].guest_phys_address,
1755 mem->regions[j].memory_size,
1756 mem->regions[j].userspace_address,
1757 mem->regions[j].address_offset,
1758 vui->region_addr[j]);
1760 for (q = 0; q < vui->num_vrings; q++) {
1761 struct vhost_virtqueue *vq = vhost_dev->virtqueue[q];
1762 const char *qtype = (q & 1) ? "TX" : "RX";
1764 vlib_cli_output(vm, "\n Virtqueue %d (%s)\n", q/2, qtype);
1766 vlib_cli_output(vm, " qsz %d last_used_idx %d last_used_idx_res %d\n",
1767 vq->size, vq->last_used_idx, vq->last_used_idx_res);
1769 if (vq->avail && vq->used)
1770 vlib_cli_output(vm, " avail.flags %x avail.idx %d used.flags %x used.idx %d\n",
1771 vq->avail->flags, vq->avail->idx, vq->used->flags, vq->used->idx);
1773 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
1774 vlib_cli_output(vm, " kickfd %d callfd %d errfd %d enabled %d\n",
1775 vq->kickfd, vq->callfd, vui->vrings[q].errfd, vq->enabled);
1777 if (show_descr && vq->enabled) {
1779 vlib_cli_output(vm, " kickfd %d callfd %d errfd\n",
1780 vq->kickfd, vq->callfd, vui->vrings[q].errfd);
1784 vlib_cli_output(vm, "\n descriptor table:\n");
1785 vlib_cli_output(vm, " id addr len flags next user_addr\n");
1786 vlib_cli_output(vm, " ===== ================== ===== ====== ===== ==================\n");
1787 for(j = 0; j < vq->size; j++) {
1788 vlib_cli_output(vm, " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
1794 (u64) map_guest_mem(xd, vq->desc[j].addr));}
1797 vlib_cli_output (vm, "\n");
1800 vec_free (hw_if_indices);
1804 VLIB_CLI_COMMAND (show_vhost_user_command, static) = {
1805 .path = "show vhost-user",
1806 .short_help = "show vhost-user interface",
1807 .function = show_dpdk_vhost_user_command_fn,