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 dpdk_vu_intf_t *vui = xd->vu_intf;
572 DBG_SOCK("Stopping vring Q %u of device %d", idx, hw_if_index);
573 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
574 vui->vrings[idx].enabled = 0; /* Reset local copy */
575 vui->vrings[idx].callfd = -1; /* Reset FD */
581 /* Check if all Qs are disabled */
582 int numqs = xd->vu_vhost_dev.virt_qp_nb * VIRTIO_QNUM;
583 for (idx = 0; idx < numqs; idx++) {
584 if (xd->vu_vhost_dev.virtqueue[idx]->enabled)
588 /* If all vrings are disabed then disable device */
590 DBG_SOCK("Device %d disabled", hw_if_index);
591 xd->vu_is_running = 0;
597 xd->vu_is_running = 0;
603 static clib_error_t *
604 dpdk_vhost_user_set_vring_base(u32 hw_if_index, u8 idx, u32 num)
607 struct vhost_virtqueue *vq;
609 DBG_SOCK("idx %u num %u", idx, num);
611 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index))) {
612 clib_warning("not a vhost-user interface");
616 vq = xd->vu_vhost_dev.virtqueue[idx];
617 vq->last_used_idx = num;
618 vq->last_used_idx_res = num;
620 stop_processing_packets(hw_if_index, idx);
625 static clib_error_t *
626 dpdk_vhost_user_set_vring_kick(u32 hw_if_index, u8 idx, int fd)
628 dpdk_main_t * dm = &dpdk_main;
630 dpdk_vu_vring *vring;
631 struct vhost_virtqueue *vq0, *vq1, *vq;
632 int index, vu_is_running = 0;
634 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index))) {
635 clib_warning("not a vhost-user interface");
639 vring = &xd->vu_intf->vrings[idx];
640 vq = xd->vu_vhost_dev.virtqueue[idx];
643 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
644 vq->enabled = (vq->desc && vq->avail && vq->used && vring->enabled) ? 1 : 0;
648 * Set xd->vu_is_running if at least one pair of
649 * RX/TX queues are enabled.
651 int numqs = VIRTIO_QNUM;
652 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
653 numqs = xd->vu_vhost_dev.virt_qp_nb * VIRTIO_QNUM;
656 for (index = 0; index < numqs; index += 2) {
657 vq0 = xd->vu_vhost_dev.virtqueue[index]; /* RX */
658 vq1 = xd->vu_vhost_dev.virtqueue[index + 1]; /* TX */
659 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
660 if (vq0->enabled && vq1->enabled)
662 if (vq0->desc && vq0->avail && vq0->used &&
663 vq1->desc && vq1->avail && vq1->used)
670 DBG_SOCK("SET_VRING_KICK - idx %d, running %d, fd: %d",
671 idx, vu_is_running, fd);
673 xd->vu_is_running = vu_is_running;
674 if (xd->vu_is_running && xd->admin_up) {
675 vnet_hw_interface_set_flags (dm->vnet_main,
676 xd->vlib_hw_if_index, VNET_HW_INTERFACE_FLAG_LINK_UP |
677 ETH_LINK_FULL_DUPLEX );
683 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
684 int dpdk_vhost_user_set_vring_enable(u32 hw_if_index, u8 idx, int enable)
687 struct vhost_virtqueue *vq;
690 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index))) {
691 clib_warning("not a vhost-user interface");
697 * Guest vhost driver wrongly enables queue before
698 * setting the vring address. Therefore, save a
699 * local copy. Reflect it in vq structure if addresses
700 * are set. If not, vq will be enabled when vring
703 vui->vrings[idx].enabled = enable; /* Save local copy */
705 vq = xd->vu_vhost_dev.virtqueue[idx];
706 if (vq->desc && vq->avail && vq->used)
707 xd->vu_vhost_dev.virtqueue[idx]->enabled = enable;
713 static clib_error_t * dpdk_vhost_user_callfd_read_ready (unix_file_t * uf)
715 __attribute__((unused)) int n;
717 n = read(uf->file_descriptor, ((char*)&buff), 8);
721 static clib_error_t *
722 dpdk_vhost_user_set_vring_call(u32 hw_if_index, u8 idx, int fd)
725 struct vhost_virtqueue *vq;
726 unix_file_t template = {0};
728 DBG_SOCK("SET_VRING_CALL - idx %d, fd %d", idx, fd);
730 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_index))) {
731 clib_warning("not a vhost-user interface");
735 dpdk_vu_intf_t *vui = xd->vu_intf;
737 /* if there is old fd, delete it */
738 if (vui->vrings[idx].callfd > 0) {
739 unix_file_t * uf = pool_elt_at_index (unix_main.file_pool,
740 vui->vrings[idx].callfd_idx);
741 unix_file_del (&unix_main, uf);
743 vui->vrings[idx].callfd = fd;
744 template.read_function = dpdk_vhost_user_callfd_read_ready;
745 template.file_descriptor = fd;
746 vui->vrings[idx].callfd_idx = unix_file_add (&unix_main, &template);
748 vq = xd->vu_vhost_dev.virtqueue[idx];
749 vq->callfd = -1; /* We use locally saved vring->callfd; */
755 dpdk_vhost_user_want_interrupt(dpdk_device_t *xd, int idx)
757 dpdk_vu_intf_t *vui = xd->vu_intf;
760 if (PREDICT_FALSE(vui->num_vrings <= 0))
763 dpdk_vu_vring *vring = &(vui->vrings[idx]);
764 struct vhost_virtqueue *vq = xd->vu_vhost_dev.virtqueue[idx];
766 /* return if vm is interested in interrupts */
767 return (vring->callfd > 0) && !(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT);
771 dpdk_vhost_user_send_interrupt(vlib_main_t * vm, dpdk_device_t * xd, int idx)
773 dpdk_main_t * dm = &dpdk_main;
774 dpdk_vu_intf_t *vui = xd->vu_intf;
777 if (PREDICT_FALSE(vui->num_vrings <= 0))
780 dpdk_vu_vring *vring = &(vui->vrings[idx]);
781 struct vhost_virtqueue *vq = xd->vu_vhost_dev.virtqueue[idx];
783 /* if vm is interested in interrupts */
784 if((vring->callfd > 0) && !(vq->avail->flags & VRING_AVAIL_F_NO_INTERRUPT)) {
785 eventfd_write(vring->callfd, (eventfd_t)1);
786 vring->n_since_last_int = 0;
787 vring->int_deadline = vlib_time_now(vm) + dm->vhost_coalesce_time;
792 * vhost-user interface management functions
795 // initialize vui with specified attributes
797 dpdk_vhost_user_vui_init(vnet_main_t * vnm,
798 dpdk_device_t *xd, int sockfd,
799 const char * sock_filename,
800 u8 is_server, u64 feature_mask,
803 dpdk_vu_intf_t *vui = xd->vu_intf;
804 memset(vui, 0, sizeof(*vui));
806 vui->unix_fd = sockfd;
807 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
808 vui->num_vrings = xd->vu_vhost_dev.virt_qp_nb * VIRTIO_QNUM;
810 vui->num_vrings = VIRTIO_QNUM;
812 DBG_SOCK("dpdk_vhost_user_vui_init VRINGS: %d", vui->num_vrings);
813 vui->sock_is_server = is_server;
814 strncpy(vui->sock_filename, sock_filename, ARRAY_LEN(vui->sock_filename)-1);
817 vui->feature_mask = feature_mask;
819 vui->unix_file_index = ~0;
821 vnet_hw_interface_set_flags (vnm, xd->vlib_hw_if_index, 0);
824 *sw_if_index = xd->vlib_sw_if_index;
827 // register vui and start polling on it
829 dpdk_vhost_user_vui_register(vlib_main_t * vm, dpdk_device_t *xd)
831 dpdk_main_t * dm = &dpdk_main;
832 dpdk_vu_intf_t *vui = xd->vu_intf;
834 hash_set (dm->vu_sw_if_index_by_listener_fd, vui->unix_fd,
835 xd->vlib_sw_if_index);
839 dpdk_vhost_user_if_disconnect(dpdk_device_t * xd)
841 dpdk_vu_intf_t *vui = xd->vu_intf;
842 vnet_main_t * vnm = vnet_get_main();
843 dpdk_main_t * dm = &dpdk_main;
846 vnet_hw_interface_set_flags (vnm, xd->vlib_hw_if_index, 0);
848 if (vui->unix_file_index != ~0) {
849 unix_file_del (&unix_main, unix_main.file_pool + vui->unix_file_index);
850 vui->unix_file_index = ~0;
853 hash_unset(dm->vu_sw_if_index_by_sock_fd, vui->unix_fd);
854 hash_unset(dm->vu_sw_if_index_by_listener_fd, vui->unix_fd);
859 DBG_SOCK("interface ifindex %d disconnected", xd->vlib_sw_if_index);
862 static clib_error_t * dpdk_vhost_user_socket_read (unix_file_t * uf)
865 int fd, number_of_fds = 0;
866 int fds[VHOST_MEMORY_MAX_NREGIONS];
867 vhost_user_msg_t msg;
870 dpdk_main_t * dm = &dpdk_main;
873 struct cmsghdr *cmsg;
876 vnet_main_t * vnm = vnet_get_main();
878 p = hash_get (dm->vu_sw_if_index_by_sock_fd, uf->file_descriptor);
880 DBG_SOCK ("FD %d doesn't belong to any interface",
881 uf->file_descriptor);
885 xd = dpdk_vhost_user_device_from_sw_if_index(p[0]);
890 char control[CMSG_SPACE(VHOST_MEMORY_MAX_NREGIONS * sizeof(int))];
892 memset(&mh, 0, sizeof(mh));
893 memset(control, 0, sizeof(control));
895 /* set the payload */
896 iov[0].iov_base = (void *) &msg;
897 iov[0].iov_len = VHOST_USER_MSG_HDR_SZ;
901 mh.msg_control = control;
902 mh.msg_controllen = sizeof(control);
904 n = recvmsg(uf->file_descriptor, &mh, 0);
906 if (n != VHOST_USER_MSG_HDR_SZ)
909 if (mh.msg_flags & MSG_CTRUNC) {
913 cmsg = CMSG_FIRSTHDR(&mh);
915 if (cmsg && (cmsg->cmsg_len > 0) && (cmsg->cmsg_level == SOL_SOCKET) &&
916 (cmsg->cmsg_type == SCM_RIGHTS) &&
917 (cmsg->cmsg_len - CMSG_LEN(0) <= VHOST_MEMORY_MAX_NREGIONS * sizeof(int))) {
918 number_of_fds = (cmsg->cmsg_len - CMSG_LEN(0)) / sizeof(int);
919 memcpy(fds, CMSG_DATA(cmsg), number_of_fds * sizeof(int));
922 /* version 1, no reply bit set*/
923 if ((msg.flags & 7) != 1) {
924 DBG_SOCK("malformed message received. closing socket");
929 int rv __attribute__((unused));
930 /* $$$$ pay attention to rv */
931 rv = read(uf->file_descriptor, ((char*)&msg) + n, msg.size);
934 DBG_SOCK("VPP VHOST message %s", vhost_message_str[msg.request]);
935 switch (msg.request) {
936 case VHOST_USER_GET_FEATURES:
937 DBG_SOCK("if %d msg VHOST_USER_GET_FEATURES",
938 xd->vlib_hw_if_index);
940 msg.flags |= VHOST_USER_REPLY_MASK;
942 dpdk_vhost_user_get_features(xd->vlib_hw_if_index, &msg.u64);
943 msg.u64 &= vui->feature_mask;
944 msg.size = sizeof(msg.u64);
947 case VHOST_USER_SET_FEATURES:
948 DBG_SOCK("if %d msg VHOST_USER_SET_FEATURES features 0x%016lx",
949 xd->vlib_hw_if_index, msg.u64);
951 dpdk_vhost_user_set_features(xd->vlib_hw_if_index, msg.u64);
954 case VHOST_USER_SET_MEM_TABLE:
955 DBG_SOCK("if %d msg VHOST_USER_SET_MEM_TABLE nregions %d",
956 xd->vlib_hw_if_index, msg.memory.nregions);
958 if ((msg.memory.nregions < 1) ||
959 (msg.memory.nregions > VHOST_MEMORY_MAX_NREGIONS)) {
961 DBG_SOCK("number of mem regions must be between 1 and %i",
962 VHOST_MEMORY_MAX_NREGIONS);
967 if (msg.memory.nregions != number_of_fds) {
968 DBG_SOCK("each memory region must have FD");
972 dpdk_vhost_user_set_mem_table(xd->vlib_hw_if_index, &msg.memory, fds);
975 case VHOST_USER_SET_VRING_NUM:
976 DBG_SOCK("if %d msg VHOST_USER_SET_VRING_NUM idx %d num %d",
977 xd->vlib_hw_if_index, msg.state.index, msg.state.num);
979 if ((msg.state.num > 32768) || /* maximum ring size is 32768 */
980 (msg.state.num == 0) || /* it cannot be zero */
981 (msg.state.num % 2)) /* must be power of 2 */
984 dpdk_vhost_user_set_vring_num(xd->vlib_hw_if_index, msg.state.index, msg.state.num);
987 case VHOST_USER_SET_VRING_ADDR:
988 DBG_SOCK("if %d msg VHOST_USER_SET_VRING_ADDR idx %d",
989 xd->vlib_hw_if_index, msg.state.index);
991 dpdk_vhost_user_set_vring_addr(xd->vlib_hw_if_index, msg.state.index,
992 msg.addr.desc_user_addr,
993 msg.addr.used_user_addr,
994 msg.addr.avail_user_addr);
997 case VHOST_USER_SET_OWNER:
998 DBG_SOCK("if %d msg VHOST_USER_SET_OWNER",
999 xd->vlib_hw_if_index);
1002 case VHOST_USER_RESET_OWNER:
1003 DBG_SOCK("if %d msg VHOST_USER_RESET_OWNER",
1004 xd->vlib_hw_if_index);
1007 case VHOST_USER_SET_VRING_CALL:
1008 q = (u8) (msg.u64 & 0xFF);
1010 DBG_SOCK("if %d msg VHOST_USER_SET_VRING_CALL u64 %lx, idx: %d",
1011 xd->vlib_hw_if_index, msg.u64, q);
1013 if (!(msg.u64 & 0x100))
1015 if (number_of_fds != 1)
1021 dpdk_vhost_user_set_vring_call(xd->vlib_hw_if_index, q, fd);
1025 case VHOST_USER_SET_VRING_KICK:
1027 q = (u8) (msg.u64 & 0xFF);
1029 DBG_SOCK("if %d msg VHOST_USER_SET_VRING_KICK u64 %lx, idx: %d",
1030 xd->vlib_hw_if_index, msg.u64, q);
1032 if (!(msg.u64 & 0x100))
1034 if (number_of_fds != 1)
1037 vui->vrings[q].kickfd = fds[0];
1040 vui->vrings[q].kickfd = -1;
1042 dpdk_vhost_user_set_vring_kick(xd->vlib_hw_if_index, q, vui->vrings[q].kickfd);
1045 case VHOST_USER_SET_VRING_ERR:
1047 q = (u8) (msg.u64 & 0xFF);
1049 DBG_SOCK("if %d msg VHOST_USER_SET_VRING_ERR u64 %lx, idx: %d",
1050 xd->vlib_hw_if_index, msg.u64, q);
1052 if (!(msg.u64 & 0x100))
1054 if (number_of_fds != 1)
1062 vui->vrings[q].errfd = fd;
1065 case VHOST_USER_SET_VRING_BASE:
1066 DBG_SOCK("if %d msg VHOST_USER_SET_VRING_BASE idx %d num %d",
1067 xd->vlib_hw_if_index, msg.state.index, msg.state.num);
1069 dpdk_vhost_user_set_vring_base(xd->vlib_hw_if_index, msg.state.index, msg.state.num);
1072 case VHOST_USER_GET_VRING_BASE:
1073 DBG_SOCK("if %d msg VHOST_USER_GET_VRING_BASE idx %d num %d",
1074 xd->vlib_hw_if_index, msg.state.index, msg.state.num);
1076 msg.flags |= VHOST_USER_REPLY_MASK;
1077 msg.size = sizeof(msg.state);
1079 dpdk_vhost_user_get_vring_base(xd->vlib_hw_if_index, msg.state.index, &msg.state.num);
1082 case VHOST_USER_NONE:
1083 DBG_SOCK("if %d msg VHOST_USER_NONE",
1084 xd->vlib_hw_if_index);
1087 case VHOST_USER_SET_LOG_BASE:
1088 DBG_SOCK("if %d msg VHOST_USER_SET_LOG_BASE",
1089 xd->vlib_hw_if_index);
1092 case VHOST_USER_SET_LOG_FD:
1093 DBG_SOCK("if %d msg VHOST_USER_SET_LOG_FD",
1094 xd->vlib_hw_if_index);
1097 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
1098 case VHOST_USER_GET_PROTOCOL_FEATURES:
1099 DBG_SOCK("if %d msg VHOST_USER_GET_PROTOCOL_FEATURES",
1100 xd->vlib_hw_if_index);
1102 msg.flags |= VHOST_USER_REPLY_MASK;
1103 msg.u64 = VHOST_USER_PROTOCOL_FEATURES;
1104 DBG_SOCK("VHOST_USER_PROTOCOL_FEATURES: %llx", VHOST_USER_PROTOCOL_FEATURES);
1105 msg.size = sizeof(msg.u64);
1108 case VHOST_USER_SET_PROTOCOL_FEATURES:
1109 DBG_SOCK("if %d msg VHOST_USER_SET_PROTOCOL_FEATURES",
1110 xd->vlib_hw_if_index);
1112 DBG_SOCK("VHOST_USER_SET_PROTOCOL_FEATURES: 0x%lx",
1114 dpdk_vhost_user_set_protocol_features(xd->vlib_hw_if_index,
1118 case VHOST_USER_SET_VRING_ENABLE:
1119 DBG_SOCK("%d VPP VHOST_USER_SET_VRING_ENABLE IDX: %d, Enable: %d",
1120 xd->vlib_hw_if_index, msg.state.index, msg.state.num);
1121 dpdk_vhost_user_set_vring_enable
1122 (xd->vlib_hw_if_index, msg.state.index, msg.state.num);
1125 case VHOST_USER_GET_QUEUE_NUM:
1126 DBG_SOCK("if %d msg VHOST_USER_GET_QUEUE_NUM:",
1127 xd->vlib_hw_if_index);
1129 msg.flags |= VHOST_USER_REPLY_MASK;
1130 msg.u64 = xd->vu_vhost_dev.virt_qp_nb;
1131 msg.size = sizeof(msg.u64);
1136 DBG_SOCK("unknown vhost-user message %d received. closing socket",
1141 /* if we have pointers to descriptor table, go up*/
1143 xd->vu_vhost_dev.virtqueue[VHOST_NET_VRING_IDX_TX]->desc &&
1144 xd->vu_vhost_dev.virtqueue[VHOST_NET_VRING_IDX_RX]->desc) {
1146 DBG_SOCK("interface %d connected", xd->vlib_sw_if_index);
1148 vnet_hw_interface_set_flags (vnm, xd->vlib_hw_if_index, VNET_HW_INTERFACE_FLAG_LINK_UP);
1153 /* if we need to reply */
1154 if (msg.flags & VHOST_USER_REPLY_MASK)
1156 n = send(uf->file_descriptor, &msg, VHOST_USER_MSG_HDR_SZ + msg.size, 0);
1157 if (n != (msg.size + VHOST_USER_MSG_HDR_SZ))
1164 DBG_SOCK("error: close_socket");
1165 dpdk_vhost_user_if_disconnect(xd);
1169 static clib_error_t * dpdk_vhost_user_socket_error (unix_file_t * uf)
1171 dpdk_main_t * dm = &dpdk_main;
1175 p = hash_get (dm->vu_sw_if_index_by_sock_fd, uf->file_descriptor);
1177 DBG_SOCK ("FD %d doesn't belong to any interface",
1178 uf->file_descriptor);
1182 xd = dpdk_vhost_user_device_from_sw_if_index(p[0]);
1184 dpdk_vhost_user_if_disconnect(xd);
1188 static clib_error_t * dpdk_vhost_user_socksvr_accept_ready (unix_file_t * uf)
1190 int client_fd, client_len;
1191 struct sockaddr_un client;
1192 unix_file_t template = {0};
1193 dpdk_main_t * dm = &dpdk_main;
1194 dpdk_device_t * xd = NULL;
1195 dpdk_vu_intf_t * vui;
1198 p = hash_get (dm->vu_sw_if_index_by_listener_fd,
1199 uf->file_descriptor);
1201 DBG_SOCK ("fd %d doesn't belong to any interface",
1202 uf->file_descriptor);
1206 xd = dpdk_vhost_user_device_from_sw_if_index(p[0]);
1210 client_len = sizeof(client);
1211 client_fd = accept (uf->file_descriptor,
1212 (struct sockaddr *)&client,
1213 (socklen_t *)&client_len);
1216 return clib_error_return_unix (0, "accept");
1218 template.read_function = dpdk_vhost_user_socket_read;
1219 template.error_function = dpdk_vhost_user_socket_error;
1220 template.file_descriptor = client_fd;
1221 vui->unix_file_index = unix_file_add (&unix_main, &template);
1223 vui->client_fd = client_fd;
1224 hash_set (dm->vu_sw_if_index_by_sock_fd, vui->client_fd,
1225 xd->vlib_sw_if_index);
1230 // init server socket on specified sock_filename
1231 static int dpdk_vhost_user_init_server_sock(const char * sock_filename, int *sockfd)
1234 struct sockaddr_un un;
1236 /* create listening socket */
1237 fd = socket(AF_UNIX, SOCK_STREAM, 0);
1240 return VNET_API_ERROR_SYSCALL_ERROR_1;
1243 un.sun_family = AF_UNIX;
1244 strcpy((char *) un.sun_path, (char *) sock_filename);
1246 /* remove if exists */
1247 unlink( (char *) sock_filename);
1249 len = strlen((char *) un.sun_path) + strlen((char *) sock_filename);
1251 if (bind(fd, (struct sockaddr *) &un, len) == -1) {
1252 rv = VNET_API_ERROR_SYSCALL_ERROR_2;
1256 if (listen(fd, 1) == -1) {
1257 rv = VNET_API_ERROR_SYSCALL_ERROR_3;
1261 unix_file_t template = {0};
1262 template.read_function = dpdk_vhost_user_socksvr_accept_ready;
1263 template.file_descriptor = fd;
1264 unix_file_add (&unix_main, &template);
1274 * vhost-user interface control functions used from vpe api
1277 int dpdk_vhost_user_create_if(vnet_main_t * vnm, vlib_main_t * vm,
1278 const char * sock_filename,
1282 u8 renumber, u32 custom_dev_instance,
1285 dpdk_main_t * dm = &dpdk_main;
1291 // using virtio vhost user?
1292 if (dm->use_virtio_vhost) {
1293 return vhost_user_create_if(vnm, vm, sock_filename, is_server,
1294 sw_if_index, feature_mask, renumber, custom_dev_instance, hwaddr);
1298 if ((rv = dpdk_vhost_user_init_server_sock (sock_filename, &sockfd)) != 0) {
1304 // set next vhost-user if id if custom one is higher or equal
1305 if (custom_dev_instance >= dm->next_vu_if_id)
1306 dm->next_vu_if_id = custom_dev_instance + 1;
1308 dpdk_create_vhost_user_if_internal(&hw_if_idx, custom_dev_instance, hwaddr);
1310 dpdk_create_vhost_user_if_internal(&hw_if_idx, (u32)~0, hwaddr);
1311 DBG_SOCK("dpdk vhost-user interface created hw_if_index %d", hw_if_idx);
1313 xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_idx);
1316 dpdk_vhost_user_vui_init (vnm, xd, sockfd, sock_filename, is_server,
1317 feature_mask, sw_if_index);
1319 dpdk_vhost_user_vui_register (vm, xd);
1323 int dpdk_vhost_user_modify_if(vnet_main_t * vnm, vlib_main_t * vm,
1324 const char * sock_filename,
1328 u8 renumber, u32 custom_dev_instance)
1330 dpdk_main_t * dm = &dpdk_main;
1332 dpdk_vu_intf_t * vui = NULL;
1337 // using virtio vhost user?
1338 if (dm->use_virtio_vhost) {
1339 return vhost_user_modify_if(vnm, vm, sock_filename, is_server,
1340 sw_if_index, feature_mask, renumber, custom_dev_instance);
1343 xd = dpdk_vhost_user_device_from_sw_if_index(sw_if_index);
1346 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1350 // interface is inactive
1352 // disconnect interface sockets
1353 dpdk_vhost_user_if_disconnect(xd);
1356 if ((rv = dpdk_vhost_user_init_server_sock (sock_filename, &sockfd)) != 0) {
1361 dpdk_vhost_user_vui_init (vnm, xd, sockfd, sock_filename, is_server,
1362 feature_mask, &sw_if_idx);
1365 vnet_interface_name_renumber (sw_if_idx, custom_dev_instance);
1368 dpdk_vhost_user_vui_register (vm, xd);
1373 int dpdk_vhost_user_delete_if(vnet_main_t * vnm, vlib_main_t * vm,
1376 dpdk_main_t * dm = &dpdk_main;
1377 dpdk_device_t * xd = NULL;
1378 dpdk_vu_intf_t * vui;
1381 // using virtio vhost user?
1382 if (dm->use_virtio_vhost) {
1383 return vhost_user_delete_if(vnm, vm, sw_if_index);
1386 xd = dpdk_vhost_user_device_from_sw_if_index(sw_if_index);
1389 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1393 // interface is inactive
1395 // disconnect interface sockets
1396 dpdk_vhost_user_if_disconnect(xd);
1397 // add to inactive interface list
1398 vec_add1 (dm->vu_inactive_interfaces_device_index, xd->device_index);
1400 ethernet_delete_interface (vnm, xd->vlib_hw_if_index);
1401 DBG_SOCK ("deleted (deactivated) vhost-user interface sw_if_index %d", sw_if_index);
1406 int dpdk_vhost_user_dump_ifs(vnet_main_t * vnm, vlib_main_t * vm, vhost_user_intf_details_t **out_vuids)
1409 dpdk_main_t * dm = &dpdk_main;
1411 dpdk_vu_intf_t * vui;
1412 struct virtio_net * vhost_dev;
1413 vhost_user_intf_details_t * r_vuids = NULL;
1414 vhost_user_intf_details_t * vuid = NULL;
1415 u32 * hw_if_indices = 0;
1416 vnet_hw_interface_t * hi;
1423 // using virtio vhost user?
1424 if (dm->use_virtio_vhost) {
1425 return vhost_user_dump_ifs(vnm, vm, out_vuids);
1428 vec_foreach (xd, dm->devices) {
1429 if (xd->dev_type == VNET_DPDK_DEV_VHOST_USER &&
1430 xd->vu_intf->active)
1431 vec_add1(hw_if_indices, xd->vlib_hw_if_index);
1434 for (i = 0; i < vec_len (hw_if_indices); i++) {
1435 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
1436 xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_indices[i]);
1438 clib_warning("invalid vhost-user interface hw_if_index %d", hw_if_indices[i]);
1443 ASSERT(vui != NULL);
1444 vhost_dev = &xd->vu_vhost_dev;
1445 u32 virtio_net_hdr_sz = (vui->num_vrings > 0 ?
1446 vhost_dev->virtqueue[0]->vhost_hlen : 0);
1448 vec_add2(r_vuids, vuid, 1);
1449 vuid->sw_if_index = xd->vlib_sw_if_index;
1450 vuid->virtio_net_hdr_sz = virtio_net_hdr_sz;
1451 vuid->features = vhost_dev->features;
1452 vuid->is_server = vui->sock_is_server;
1453 vuid->num_regions = (vhost_dev->mem != NULL ? vhost_dev->mem->nregions : 0);
1454 vuid->sock_errno = vui->sock_errno;
1455 strncpy((char *)vuid->sock_filename, (char *)vui->sock_filename,
1456 ARRAY_LEN(vuid->sock_filename)-1);
1458 s = format (s, "%v%c", hi->name, 0);
1460 strncpy((char *)vuid->if_name, (char *)s,
1461 ARRAY_LEN(vuid->if_name)-1);
1466 vec_free (hw_if_indices);
1468 *out_vuids = r_vuids;
1474 * Processing functions called from dpdk process fn
1478 struct sockaddr_un sun;
1480 unix_file_t template;
1482 } dpdk_vu_process_state;
1484 void dpdk_vhost_user_process_init (void **ctx)
1486 dpdk_vu_process_state *state = clib_mem_alloc (sizeof(dpdk_vu_process_state));
1487 memset(state, 0, sizeof(*state));
1488 state->sockfd = socket(AF_UNIX, SOCK_STREAM, 0);
1489 state->sun.sun_family = AF_UNIX;
1490 state->template.read_function = dpdk_vhost_user_socket_read;
1491 state->template.error_function = dpdk_vhost_user_socket_error;
1492 state->event_data = 0;
1496 void dpdk_vhost_user_process_cleanup (void *ctx)
1501 uword dpdk_vhost_user_process_if (vlib_main_t *vm, dpdk_device_t *xd, void *ctx)
1503 dpdk_main_t * dm = &dpdk_main;
1504 dpdk_vu_process_state *state = (dpdk_vu_process_state *)ctx;
1505 dpdk_vu_intf_t *vui = xd->vu_intf;
1507 if (vui->sock_is_server || !vui->active)
1510 if (vui->unix_fd == -1) {
1511 /* try to connect */
1512 strncpy(state->sun.sun_path, (char *) vui->sock_filename, sizeof(state->sun.sun_path) - 1);
1514 if (connect(state->sockfd, (struct sockaddr *) &(state->sun), sizeof(struct sockaddr_un)) == 0) {
1515 vui->sock_errno = 0;
1516 vui->unix_fd = state->sockfd;
1517 state->template.file_descriptor = state->sockfd;
1518 vui->unix_file_index = unix_file_add (&unix_main, &(state->template));
1519 hash_set (dm->vu_sw_if_index_by_sock_fd, state->sockfd, xd->vlib_sw_if_index);
1521 state->sockfd = socket(AF_UNIX, SOCK_STREAM, 0);
1522 if (state->sockfd < 0)
1525 vui->sock_errno = errno;
1528 /* check if socket is alive */
1530 socklen_t len = sizeof (error);
1531 int retval = getsockopt(vui->unix_fd, SOL_SOCKET, SO_ERROR, &error, &len);
1534 dpdk_vhost_user_if_disconnect(xd);
1543 static clib_error_t *
1544 dpdk_vhost_user_connect_command_fn (vlib_main_t * vm,
1545 unformat_input_t * input,
1546 vlib_cli_command_t * cmd)
1548 dpdk_main_t * dm = &dpdk_main;
1549 unformat_input_t _line_input, * line_input = &_line_input;
1550 u8 * sock_filename = NULL;
1553 u64 feature_mask = (u64)~0;
1555 u32 custom_dev_instance = ~0;
1559 if (dm->use_virtio_vhost) {
1560 return vhost_user_connect_command_fn(vm, input, cmd);
1563 /* Get a line of input. */
1564 if (! unformat_user (input, unformat_line_input, line_input))
1567 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
1568 if (unformat (line_input, "socket %s", &sock_filename))
1570 else if (unformat (line_input, "server"))
1572 else if (unformat (line_input, "feature-mask 0x%llx", &feature_mask))
1574 else if (unformat (line_input, "hwaddr %U", unformat_ethernet_address, hwaddr))
1576 else if (unformat (line_input, "renumber %d", &custom_dev_instance)) {
1580 return clib_error_return (0, "unknown input `%U'",
1581 format_unformat_error, input);
1583 unformat_free (line_input);
1585 vnet_main_t *vnm = vnet_get_main();
1586 if (sock_filename == NULL)
1587 return clib_error_return (0, "missing socket file");
1589 dpdk_vhost_user_create_if(vnm, vm, (char *)sock_filename,
1590 is_server, &sw_if_index, feature_mask,
1591 renumber, custom_dev_instance, hw);
1593 vec_free(sock_filename);
1597 VLIB_CLI_COMMAND (dpdk_vhost_user_connect_command, static) = {
1598 .path = "create vhost-user",
1599 .short_help = "create vhost-user socket <socket-filename> [server] [feature-mask <hex>] [renumber <dev_instance>]",
1600 .function = dpdk_vhost_user_connect_command_fn,
1603 static clib_error_t *
1604 dpdk_vhost_user_delete_command_fn (vlib_main_t * vm,
1605 unformat_input_t * input,
1606 vlib_cli_command_t * cmd)
1608 dpdk_main_t * dm = &dpdk_main;
1609 clib_error_t * error = 0;
1610 unformat_input_t _line_input, * line_input = &_line_input;
1611 u32 sw_if_index = ~0;
1613 if (dm->use_virtio_vhost) {
1614 return vhost_user_delete_command_fn(vm, input, cmd);
1617 /* Get a line of input. */
1618 if (! unformat_user (input, unformat_line_input, line_input))
1621 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
1622 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
1625 return clib_error_return (0, "unknown input `%U'",
1626 format_unformat_error, input);
1628 unformat_free (line_input);
1630 if (sw_if_index == ~0) {
1631 error = clib_error_return (0, "invalid sw_if_index",
1632 format_unformat_error, input);
1636 vnet_main_t *vnm = vnet_get_main();
1638 dpdk_vhost_user_delete_if(vnm, vm, sw_if_index);
1643 VLIB_CLI_COMMAND (dpdk_vhost_user_delete_command, static) = {
1644 .path = "delete vhost-user",
1645 .short_help = "delete vhost-user sw_if_index <nn>",
1646 .function = dpdk_vhost_user_delete_command_fn,
1649 #define foreach_dpdk_vhost_feature \
1650 _ (VIRTIO_NET_F_MRG_RXBUF) \
1651 _ (VIRTIO_NET_F_CTRL_VQ) \
1652 _ (VIRTIO_NET_F_CTRL_RX)
1654 static clib_error_t *
1655 show_dpdk_vhost_user_command_fn (vlib_main_t * vm,
1656 unformat_input_t * input,
1657 vlib_cli_command_t * cmd)
1659 clib_error_t * error = 0;
1660 dpdk_main_t * dm = &dpdk_main;
1661 vnet_main_t * vnm = vnet_get_main();
1663 dpdk_vu_intf_t * vui;
1664 struct virtio_net * vhost_dev;
1665 u32 hw_if_index, * hw_if_indices = 0;
1666 vnet_hw_interface_t * hi;
1669 struct virtio_memory * mem;
1670 struct feat_struct { u8 bit; char *str;};
1671 struct feat_struct *feat_entry;
1673 static struct feat_struct feat_array[] = {
1674 #define _(f) { .str = #f, .bit = f, },
1675 foreach_dpdk_vhost_feature
1680 if (dm->use_virtio_vhost) {
1681 return show_vhost_user_command_fn(vm, input, cmd);
1684 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) {
1685 if (unformat (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index)) {
1686 vec_add1 (hw_if_indices, hw_if_index);
1687 vlib_cli_output(vm, "add %d", hw_if_index);
1689 else if (unformat (input, "descriptors") || unformat (input, "desc") )
1692 error = clib_error_return (0, "unknown input `%U'",
1693 format_unformat_error, input);
1697 if (vec_len (hw_if_indices) == 0) {
1698 vec_foreach (xd, dm->devices) {
1699 if (xd->dev_type == VNET_DPDK_DEV_VHOST_USER && xd->vu_intf->active)
1700 vec_add1(hw_if_indices, xd->vlib_hw_if_index);
1704 vlib_cli_output (vm, "DPDK vhost-user interfaces");
1705 vlib_cli_output (vm, "Global:\n coalesce frames %d time %e\n\n",
1706 dm->vhost_coalesce_frames, dm->vhost_coalesce_time);
1708 for (i = 0; i < vec_len (hw_if_indices); i++) {
1709 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
1711 if (!(xd = dpdk_vhost_user_device_from_hw_if_index(hw_if_indices[i]))) {
1712 error = clib_error_return (0, "not dpdk vhost-user interface: '%s'",
1717 vhost_dev = &xd->vu_vhost_dev;
1718 mem = vhost_dev->mem;
1719 u32 virtio_net_hdr_sz = (vui->num_vrings > 0 ?
1720 vhost_dev->virtqueue[0]->vhost_hlen : 0);
1722 vlib_cli_output (vm, "Interface: %v (ifindex %d)",
1723 hi->name, hw_if_indices[i]);
1725 vlib_cli_output (vm, "virtio_net_hdr_sz %d\n features (0x%llx): \n",
1726 virtio_net_hdr_sz, xd->vu_vhost_dev.features);
1728 feat_entry = (struct feat_struct *) &feat_array;
1729 while(feat_entry->str) {
1730 if (xd->vu_vhost_dev.features & (1 << feat_entry->bit))
1731 vlib_cli_output (vm, " %s (%d)", feat_entry->str, feat_entry->bit);
1735 vlib_cli_output (vm, "\n");
1737 vlib_cli_output (vm, " socket filename %s type %s errno \"%s\"\n\n",
1738 vui->sock_filename, vui->sock_is_server ? "server" : "client",
1739 strerror(vui->sock_errno));
1741 vlib_cli_output (vm, " Memory regions (total %d)\n", mem->nregions);
1744 vlib_cli_output(vm, " region fd guest_phys_addr memory_size userspace_addr mmap_offset mmap_addr\n");
1745 vlib_cli_output(vm, " ====== ===== ================== ================== ================== ================== ==================\n");
1747 for (j = 0; j < mem->nregions; j++) {
1748 vlib_cli_output(vm, " %d %-5d 0x%016lx 0x%016lx 0x%016lx 0x%016lx 0x%016lx\n", j,
1750 mem->regions[j].guest_phys_address,
1751 mem->regions[j].memory_size,
1752 mem->regions[j].userspace_address,
1753 mem->regions[j].address_offset,
1754 vui->region_addr[j]);
1756 for (q = 0; q < vui->num_vrings; q++) {
1757 struct vhost_virtqueue *vq = vhost_dev->virtqueue[q];
1758 const char *qtype = (q & 1) ? "TX" : "RX";
1760 vlib_cli_output(vm, "\n Virtqueue %d (%s)\n", q/2, qtype);
1762 vlib_cli_output(vm, " qsz %d last_used_idx %d last_used_idx_res %d\n",
1763 vq->size, vq->last_used_idx, vq->last_used_idx_res);
1765 if (vq->avail && vq->used)
1766 vlib_cli_output(vm, " avail.flags %x avail.idx %d used.flags %x used.idx %d\n",
1767 vq->avail->flags, vq->avail->idx, vq->used->flags, vq->used->idx);
1769 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
1770 vlib_cli_output(vm, " kickfd %d callfd %d errfd %d enabled %d\n",
1771 vq->kickfd, vq->callfd, vui->vrings[q].errfd, vq->enabled);
1773 if (show_descr && vq->enabled) {
1775 vlib_cli_output(vm, " kickfd %d callfd %d errfd\n",
1776 vq->kickfd, vq->callfd, vui->vrings[q].errfd);
1780 vlib_cli_output(vm, "\n descriptor table:\n");
1781 vlib_cli_output(vm, " id addr len flags next user_addr\n");
1782 vlib_cli_output(vm, " ===== ================== ===== ====== ===== ==================\n");
1783 for(j = 0; j < vq->size; j++) {
1784 vlib_cli_output(vm, " %-5d 0x%016lx %-5d 0x%04x %-5d 0x%016lx\n",
1790 (u64) map_guest_mem(xd, vq->desc[j].addr));}
1793 vlib_cli_output (vm, "\n");
1796 vec_free (hw_if_indices);
1800 VLIB_CLI_COMMAND (show_vhost_user_command, static) = {
1801 .path = "show vhost-user",
1802 .short_help = "show vhost-user interface",
1803 .function = show_dpdk_vhost_user_command_fn,