1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2017 Intel Corporation
7 #include <linux/if_ether.h>
8 #include <linux/if_vlan.h>
9 #include <linux/virtio_net.h>
10 #include <linux/virtio_ring.h>
13 #include <sys/eventfd.h>
14 #include <sys/param.h>
17 #include <rte_atomic.h>
18 #include <rte_cycles.h>
19 #include <rte_ethdev.h>
21 #include <rte_string_fns.h>
22 #include <rte_malloc.h>
23 #include <rte_vhost.h>
26 #include <rte_pause.h>
31 #define MAX_QUEUES 128
34 /* the maximum number of external ports supported */
35 #define MAX_SUP_PORTS 1
37 #define MBUF_CACHE_SIZE 128
38 #define MBUF_DATA_SIZE RTE_MBUF_DEFAULT_BUF_SIZE
40 #define BURST_TX_DRAIN_US 100 /* TX drain every ~100us */
42 #define BURST_RX_WAIT_US 15 /* Defines how long we wait between retries on RX */
43 #define BURST_RX_RETRIES 4 /* Number of retries on RX. */
45 #define JUMBO_FRAME_MAX_SIZE 0x2600
47 /* State of virtio device. */
48 #define DEVICE_MAC_LEARNING 0
50 #define DEVICE_SAFE_REMOVE 2
52 /* Configurable number of RX/TX ring descriptors */
53 #define RTE_TEST_RX_DESC_DEFAULT 1024
54 #define RTE_TEST_TX_DESC_DEFAULT 512
56 #define INVALID_PORT_ID 0xFF
58 /* Maximum long option length for option parsing. */
59 #define MAX_LONG_OPT_SZ 64
61 /* mask of enabled ports */
62 static uint32_t enabled_port_mask = 0;
64 /* Promiscuous mode */
65 static uint32_t promiscuous;
67 /* number of devices/queues to support*/
68 static uint32_t num_queues = 0;
69 static uint32_t num_devices;
71 static struct rte_mempool *mbuf_pool;
74 /* Enable VM2VM communications. If this is disabled then the MAC address compare is skipped. */
81 static vm2vm_type vm2vm_mode = VM2VM_SOFTWARE;
84 static uint32_t enable_stats = 0;
85 /* Enable retries on RX. */
86 static uint32_t enable_retry = 1;
88 /* Disable TX checksum offload */
89 static uint32_t enable_tx_csum;
91 /* Disable TSO offload */
92 static uint32_t enable_tso;
94 static int client_mode;
95 static int dequeue_zero_copy;
97 static int builtin_net_driver;
99 /* Specify timeout (in useconds) between retries on RX. */
100 static uint32_t burst_rx_delay_time = BURST_RX_WAIT_US;
101 /* Specify the number of retries on RX. */
102 static uint32_t burst_rx_retry_num = BURST_RX_RETRIES;
104 /* Socket file paths. Can be set by user */
105 static char *socket_files;
106 static int nb_sockets;
108 /* empty vmdq configuration structure. Filled in programatically */
109 static struct rte_eth_conf vmdq_conf_default = {
111 .mq_mode = ETH_MQ_RX_VMDQ_ONLY,
114 * VLAN strip is necessary for 1G NIC such as I350,
115 * this fixes bug of ipv4 forwarding in guest can't
116 * forward pakets from one virtio dev to another virtio dev.
118 .offloads = DEV_RX_OFFLOAD_VLAN_STRIP,
122 .mq_mode = ETH_MQ_TX_NONE,
123 .offloads = (DEV_TX_OFFLOAD_IPV4_CKSUM |
124 DEV_TX_OFFLOAD_TCP_CKSUM |
125 DEV_TX_OFFLOAD_VLAN_INSERT |
126 DEV_TX_OFFLOAD_MULTI_SEGS |
127 DEV_TX_OFFLOAD_TCP_TSO),
131 * should be overridden separately in code with
135 .nb_queue_pools = ETH_8_POOLS,
136 .enable_default_pool = 0,
139 .pool_map = {{0, 0},},
145 static unsigned lcore_ids[RTE_MAX_LCORE];
146 static uint16_t ports[RTE_MAX_ETHPORTS];
147 static unsigned num_ports = 0; /**< The number of ports specified in command line */
148 static uint16_t num_pf_queues, num_vmdq_queues;
149 static uint16_t vmdq_pool_base, vmdq_queue_base;
150 static uint16_t queues_per_pool;
152 const uint16_t vlan_tags[] = {
153 1000, 1001, 1002, 1003, 1004, 1005, 1006, 1007,
154 1008, 1009, 1010, 1011, 1012, 1013, 1014, 1015,
155 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023,
156 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031,
157 1032, 1033, 1034, 1035, 1036, 1037, 1038, 1039,
158 1040, 1041, 1042, 1043, 1044, 1045, 1046, 1047,
159 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055,
160 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063,
163 /* ethernet addresses of ports */
164 static struct rte_ether_addr vmdq_ports_eth_addr[RTE_MAX_ETHPORTS];
166 static struct vhost_dev_tailq_list vhost_dev_list =
167 TAILQ_HEAD_INITIALIZER(vhost_dev_list);
169 static struct lcore_info lcore_info[RTE_MAX_LCORE];
171 /* Used for queueing bursts of TX packets. */
175 struct rte_mbuf *m_table[MAX_PKT_BURST];
178 /* TX queue for each data core. */
179 struct mbuf_table lcore_tx_queue[RTE_MAX_LCORE];
181 #define MBUF_TABLE_DRAIN_TSC ((rte_get_tsc_hz() + US_PER_S - 1) \
182 / US_PER_S * BURST_TX_DRAIN_US)
186 * Builds up the correct configuration for VMDQ VLAN pool map
187 * according to the pool & queue limits.
190 get_eth_conf(struct rte_eth_conf *eth_conf, uint32_t num_devices)
192 struct rte_eth_vmdq_rx_conf conf;
193 struct rte_eth_vmdq_rx_conf *def_conf =
194 &vmdq_conf_default.rx_adv_conf.vmdq_rx_conf;
197 memset(&conf, 0, sizeof(conf));
198 conf.nb_queue_pools = (enum rte_eth_nb_pools)num_devices;
199 conf.nb_pool_maps = num_devices;
200 conf.enable_loop_back = def_conf->enable_loop_back;
201 conf.rx_mode = def_conf->rx_mode;
203 for (i = 0; i < conf.nb_pool_maps; i++) {
204 conf.pool_map[i].vlan_id = vlan_tags[ i ];
205 conf.pool_map[i].pools = (1UL << i);
208 (void)(rte_memcpy(eth_conf, &vmdq_conf_default, sizeof(*eth_conf)));
209 (void)(rte_memcpy(ð_conf->rx_adv_conf.vmdq_rx_conf, &conf,
210 sizeof(eth_conf->rx_adv_conf.vmdq_rx_conf)));
215 * Initialises a given port using global settings and with the rx buffers
216 * coming from the mbuf_pool passed as parameter
219 port_init(uint16_t port)
221 struct rte_eth_dev_info dev_info;
222 struct rte_eth_conf port_conf;
223 struct rte_eth_rxconf *rxconf;
224 struct rte_eth_txconf *txconf;
225 int16_t rx_rings, tx_rings;
226 uint16_t rx_ring_size, tx_ring_size;
230 /* The max pool number from dev_info will be used to validate the pool number specified in cmd line */
231 retval = rte_eth_dev_info_get(port, &dev_info);
233 RTE_LOG(ERR, VHOST_PORT,
234 "Error during getting device (port %u) info: %s\n",
235 port, strerror(-retval));
240 rxconf = &dev_info.default_rxconf;
241 txconf = &dev_info.default_txconf;
242 rxconf->rx_drop_en = 1;
244 /*configure the number of supported virtio devices based on VMDQ limits */
245 num_devices = dev_info.max_vmdq_pools;
247 rx_ring_size = RTE_TEST_RX_DESC_DEFAULT;
248 tx_ring_size = RTE_TEST_TX_DESC_DEFAULT;
251 * When dequeue zero copy is enabled, guest Tx used vring will be
252 * updated only when corresponding mbuf is freed. Thus, the nb_tx_desc
253 * (tx_ring_size here) must be small enough so that the driver will
254 * hit the free threshold easily and free mbufs timely. Otherwise,
255 * guest Tx vring would be starved.
257 if (dequeue_zero_copy)
260 tx_rings = (uint16_t)rte_lcore_count();
262 /* Get port configuration. */
263 retval = get_eth_conf(&port_conf, num_devices);
266 /* NIC queues are divided into pf queues and vmdq queues. */
267 num_pf_queues = dev_info.max_rx_queues - dev_info.vmdq_queue_num;
268 queues_per_pool = dev_info.vmdq_queue_num / dev_info.max_vmdq_pools;
269 num_vmdq_queues = num_devices * queues_per_pool;
270 num_queues = num_pf_queues + num_vmdq_queues;
271 vmdq_queue_base = dev_info.vmdq_queue_base;
272 vmdq_pool_base = dev_info.vmdq_pool_base;
273 printf("pf queue num: %u, configured vmdq pool num: %u, each vmdq pool has %u queues\n",
274 num_pf_queues, num_devices, queues_per_pool);
276 if (!rte_eth_dev_is_valid_port(port))
279 rx_rings = (uint16_t)dev_info.max_rx_queues;
280 if (dev_info.tx_offload_capa & DEV_TX_OFFLOAD_MBUF_FAST_FREE)
281 port_conf.txmode.offloads |=
282 DEV_TX_OFFLOAD_MBUF_FAST_FREE;
283 /* Configure ethernet device. */
284 retval = rte_eth_dev_configure(port, rx_rings, tx_rings, &port_conf);
286 RTE_LOG(ERR, VHOST_PORT, "Failed to configure port %u: %s.\n",
287 port, strerror(-retval));
291 retval = rte_eth_dev_adjust_nb_rx_tx_desc(port, &rx_ring_size,
294 RTE_LOG(ERR, VHOST_PORT, "Failed to adjust number of descriptors "
295 "for port %u: %s.\n", port, strerror(-retval));
298 if (rx_ring_size > RTE_TEST_RX_DESC_DEFAULT) {
299 RTE_LOG(ERR, VHOST_PORT, "Mbuf pool has an insufficient size "
300 "for Rx queues on port %u.\n", port);
304 /* Setup the queues. */
305 rxconf->offloads = port_conf.rxmode.offloads;
306 for (q = 0; q < rx_rings; q ++) {
307 retval = rte_eth_rx_queue_setup(port, q, rx_ring_size,
308 rte_eth_dev_socket_id(port),
312 RTE_LOG(ERR, VHOST_PORT,
313 "Failed to setup rx queue %u of port %u: %s.\n",
314 q, port, strerror(-retval));
318 txconf->offloads = port_conf.txmode.offloads;
319 for (q = 0; q < tx_rings; q ++) {
320 retval = rte_eth_tx_queue_setup(port, q, tx_ring_size,
321 rte_eth_dev_socket_id(port),
324 RTE_LOG(ERR, VHOST_PORT,
325 "Failed to setup tx queue %u of port %u: %s.\n",
326 q, port, strerror(-retval));
331 /* Start the device. */
332 retval = rte_eth_dev_start(port);
334 RTE_LOG(ERR, VHOST_PORT, "Failed to start port %u: %s\n",
335 port, strerror(-retval));
340 retval = rte_eth_promiscuous_enable(port);
342 RTE_LOG(ERR, VHOST_PORT,
343 "Failed to enable promiscuous mode on port %u: %s\n",
344 port, rte_strerror(-retval));
349 retval = rte_eth_macaddr_get(port, &vmdq_ports_eth_addr[port]);
351 RTE_LOG(ERR, VHOST_PORT,
352 "Failed to get MAC address on port %u: %s\n",
353 port, rte_strerror(-retval));
357 RTE_LOG(INFO, VHOST_PORT, "Max virtio devices supported: %u\n", num_devices);
358 RTE_LOG(INFO, VHOST_PORT, "Port %u MAC: %02"PRIx8" %02"PRIx8" %02"PRIx8
359 " %02"PRIx8" %02"PRIx8" %02"PRIx8"\n",
361 vmdq_ports_eth_addr[port].addr_bytes[0],
362 vmdq_ports_eth_addr[port].addr_bytes[1],
363 vmdq_ports_eth_addr[port].addr_bytes[2],
364 vmdq_ports_eth_addr[port].addr_bytes[3],
365 vmdq_ports_eth_addr[port].addr_bytes[4],
366 vmdq_ports_eth_addr[port].addr_bytes[5]);
372 * Set socket file path.
375 us_vhost_parse_socket_path(const char *q_arg)
379 /* parse number string */
380 if (strnlen(q_arg, PATH_MAX) == PATH_MAX)
384 socket_files = realloc(socket_files, PATH_MAX * (nb_sockets + 1));
385 if (socket_files == NULL) {
390 strlcpy(socket_files + nb_sockets * PATH_MAX, q_arg, PATH_MAX);
397 * Parse the portmask provided at run time.
400 parse_portmask(const char *portmask)
407 /* parse hexadecimal string */
408 pm = strtoul(portmask, &end, 16);
409 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0') || (errno != 0))
417 * Parse num options at run time.
420 parse_num_opt(const char *q_arg, uint32_t max_valid_value)
427 /* parse unsigned int string */
428 num = strtoul(q_arg, &end, 10);
429 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0') || (errno != 0))
432 if (num > max_valid_value)
443 us_vhost_usage(const char *prgname)
445 RTE_LOG(INFO, VHOST_CONFIG, "%s [EAL options] -- -p PORTMASK\n"
447 " --rx_retry [0|1] --mergeable [0|1] --stats [0-N]\n"
448 " --socket-file <path>\n"
450 " -p PORTMASK: Set mask for ports to be used by application\n"
451 " --vm2vm [0|1|2]: disable/software(default)/hardware vm2vm comms\n"
452 " --rx-retry [0|1]: disable/enable(default) retries on rx. Enable retry if destintation queue is full\n"
453 " --rx-retry-delay [0-N]: timeout(in usecond) between retries on RX. This makes effect only if retries on rx enabled\n"
454 " --rx-retry-num [0-N]: the number of retries on rx. This makes effect only if retries on rx enabled\n"
455 " --mergeable [0|1]: disable(default)/enable RX mergeable buffers\n"
456 " --stats [0-N]: 0: Disable stats, N: Time in seconds to print stats\n"
457 " --socket-file: The path of the socket file.\n"
458 " --tx-csum [0|1] disable/enable TX checksum offload.\n"
459 " --tso [0|1] disable/enable TCP segment offload.\n"
460 " --client register a vhost-user socket as client mode.\n"
461 " --dequeue-zero-copy enables dequeue zero copy\n",
466 * Parse the arguments given in the command line of the application.
469 us_vhost_parse_args(int argc, char **argv)
474 const char *prgname = argv[0];
475 static struct option long_option[] = {
476 {"vm2vm", required_argument, NULL, 0},
477 {"rx-retry", required_argument, NULL, 0},
478 {"rx-retry-delay", required_argument, NULL, 0},
479 {"rx-retry-num", required_argument, NULL, 0},
480 {"mergeable", required_argument, NULL, 0},
481 {"stats", required_argument, NULL, 0},
482 {"socket-file", required_argument, NULL, 0},
483 {"tx-csum", required_argument, NULL, 0},
484 {"tso", required_argument, NULL, 0},
485 {"client", no_argument, &client_mode, 1},
486 {"dequeue-zero-copy", no_argument, &dequeue_zero_copy, 1},
487 {"builtin-net-driver", no_argument, &builtin_net_driver, 1},
491 /* Parse command line */
492 while ((opt = getopt_long(argc, argv, "p:P",
493 long_option, &option_index)) != EOF) {
497 enabled_port_mask = parse_portmask(optarg);
498 if (enabled_port_mask == 0) {
499 RTE_LOG(INFO, VHOST_CONFIG, "Invalid portmask\n");
500 us_vhost_usage(prgname);
507 vmdq_conf_default.rx_adv_conf.vmdq_rx_conf.rx_mode =
508 ETH_VMDQ_ACCEPT_BROADCAST |
509 ETH_VMDQ_ACCEPT_MULTICAST;
514 /* Enable/disable vm2vm comms. */
515 if (!strncmp(long_option[option_index].name, "vm2vm",
517 ret = parse_num_opt(optarg, (VM2VM_LAST - 1));
519 RTE_LOG(INFO, VHOST_CONFIG,
520 "Invalid argument for "
522 us_vhost_usage(prgname);
525 vm2vm_mode = (vm2vm_type)ret;
529 /* Enable/disable retries on RX. */
530 if (!strncmp(long_option[option_index].name, "rx-retry", MAX_LONG_OPT_SZ)) {
531 ret = parse_num_opt(optarg, 1);
533 RTE_LOG(INFO, VHOST_CONFIG, "Invalid argument for rx-retry [0|1]\n");
534 us_vhost_usage(prgname);
541 /* Enable/disable TX checksum offload. */
542 if (!strncmp(long_option[option_index].name, "tx-csum", MAX_LONG_OPT_SZ)) {
543 ret = parse_num_opt(optarg, 1);
545 RTE_LOG(INFO, VHOST_CONFIG, "Invalid argument for tx-csum [0|1]\n");
546 us_vhost_usage(prgname);
549 enable_tx_csum = ret;
552 /* Enable/disable TSO offload. */
553 if (!strncmp(long_option[option_index].name, "tso", MAX_LONG_OPT_SZ)) {
554 ret = parse_num_opt(optarg, 1);
556 RTE_LOG(INFO, VHOST_CONFIG, "Invalid argument for tso [0|1]\n");
557 us_vhost_usage(prgname);
563 /* Specify the retries delay time (in useconds) on RX. */
564 if (!strncmp(long_option[option_index].name, "rx-retry-delay", MAX_LONG_OPT_SZ)) {
565 ret = parse_num_opt(optarg, INT32_MAX);
567 RTE_LOG(INFO, VHOST_CONFIG, "Invalid argument for rx-retry-delay [0-N]\n");
568 us_vhost_usage(prgname);
571 burst_rx_delay_time = ret;
575 /* Specify the retries number on RX. */
576 if (!strncmp(long_option[option_index].name, "rx-retry-num", MAX_LONG_OPT_SZ)) {
577 ret = parse_num_opt(optarg, INT32_MAX);
579 RTE_LOG(INFO, VHOST_CONFIG, "Invalid argument for rx-retry-num [0-N]\n");
580 us_vhost_usage(prgname);
583 burst_rx_retry_num = ret;
587 /* Enable/disable RX mergeable buffers. */
588 if (!strncmp(long_option[option_index].name, "mergeable", MAX_LONG_OPT_SZ)) {
589 ret = parse_num_opt(optarg, 1);
591 RTE_LOG(INFO, VHOST_CONFIG, "Invalid argument for mergeable [0|1]\n");
592 us_vhost_usage(prgname);
597 vmdq_conf_default.rxmode.offloads |=
598 DEV_RX_OFFLOAD_JUMBO_FRAME;
599 vmdq_conf_default.rxmode.max_rx_pkt_len
600 = JUMBO_FRAME_MAX_SIZE;
605 /* Enable/disable stats. */
606 if (!strncmp(long_option[option_index].name, "stats", MAX_LONG_OPT_SZ)) {
607 ret = parse_num_opt(optarg, INT32_MAX);
609 RTE_LOG(INFO, VHOST_CONFIG,
610 "Invalid argument for stats [0..N]\n");
611 us_vhost_usage(prgname);
618 /* Set socket file path. */
619 if (!strncmp(long_option[option_index].name,
620 "socket-file", MAX_LONG_OPT_SZ)) {
621 if (us_vhost_parse_socket_path(optarg) == -1) {
622 RTE_LOG(INFO, VHOST_CONFIG,
623 "Invalid argument for socket name (Max %d characters)\n",
625 us_vhost_usage(prgname);
632 /* Invalid option - print options. */
634 us_vhost_usage(prgname);
639 for (i = 0; i < RTE_MAX_ETHPORTS; i++) {
640 if (enabled_port_mask & (1 << i))
641 ports[num_ports++] = i;
644 if ((num_ports == 0) || (num_ports > MAX_SUP_PORTS)) {
645 RTE_LOG(INFO, VHOST_PORT, "Current enabled port number is %u,"
646 "but only %u port can be enabled\n",num_ports, MAX_SUP_PORTS);
654 * Update the global var NUM_PORTS and array PORTS according to system ports number
655 * and return valid ports number
657 static unsigned check_ports_num(unsigned nb_ports)
659 unsigned valid_num_ports = num_ports;
662 if (num_ports > nb_ports) {
663 RTE_LOG(INFO, VHOST_PORT, "\nSpecified port number(%u) exceeds total system port number(%u)\n",
664 num_ports, nb_ports);
665 num_ports = nb_ports;
668 for (portid = 0; portid < num_ports; portid ++) {
669 if (!rte_eth_dev_is_valid_port(ports[portid])) {
670 RTE_LOG(INFO, VHOST_PORT,
671 "\nSpecified port ID(%u) is not valid\n",
673 ports[portid] = INVALID_PORT_ID;
677 return valid_num_ports;
680 static __rte_always_inline struct vhost_dev *
681 find_vhost_dev(struct rte_ether_addr *mac)
683 struct vhost_dev *vdev;
685 TAILQ_FOREACH(vdev, &vhost_dev_list, global_vdev_entry) {
686 if (vdev->ready == DEVICE_RX &&
687 rte_is_same_ether_addr(mac, &vdev->mac_address))
695 * This function learns the MAC address of the device and registers this along with a
696 * vlan tag to a VMDQ.
699 link_vmdq(struct vhost_dev *vdev, struct rte_mbuf *m)
701 struct rte_ether_hdr *pkt_hdr;
704 /* Learn MAC address of guest device from packet */
705 pkt_hdr = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
707 if (find_vhost_dev(&pkt_hdr->s_addr)) {
708 RTE_LOG(ERR, VHOST_DATA,
709 "(%d) device is using a registered MAC!\n",
714 for (i = 0; i < RTE_ETHER_ADDR_LEN; i++)
715 vdev->mac_address.addr_bytes[i] = pkt_hdr->s_addr.addr_bytes[i];
717 /* vlan_tag currently uses the device_id. */
718 vdev->vlan_tag = vlan_tags[vdev->vid];
720 /* Print out VMDQ registration info. */
721 RTE_LOG(INFO, VHOST_DATA,
722 "(%d) mac %02x:%02x:%02x:%02x:%02x:%02x and vlan %d registered\n",
724 vdev->mac_address.addr_bytes[0], vdev->mac_address.addr_bytes[1],
725 vdev->mac_address.addr_bytes[2], vdev->mac_address.addr_bytes[3],
726 vdev->mac_address.addr_bytes[4], vdev->mac_address.addr_bytes[5],
729 /* Register the MAC address. */
730 ret = rte_eth_dev_mac_addr_add(ports[0], &vdev->mac_address,
731 (uint32_t)vdev->vid + vmdq_pool_base);
733 RTE_LOG(ERR, VHOST_DATA,
734 "(%d) failed to add device MAC address to VMDQ\n",
737 rte_eth_dev_set_vlan_strip_on_queue(ports[0], vdev->vmdq_rx_q, 1);
739 /* Set device as ready for RX. */
740 vdev->ready = DEVICE_RX;
746 * Removes MAC address and vlan tag from VMDQ. Ensures that nothing is adding buffers to the RX
747 * queue before disabling RX on the device.
750 unlink_vmdq(struct vhost_dev *vdev)
754 struct rte_mbuf *pkts_burst[MAX_PKT_BURST];
756 if (vdev->ready == DEVICE_RX) {
757 /*clear MAC and VLAN settings*/
758 rte_eth_dev_mac_addr_remove(ports[0], &vdev->mac_address);
759 for (i = 0; i < 6; i++)
760 vdev->mac_address.addr_bytes[i] = 0;
764 /*Clear out the receive buffers*/
765 rx_count = rte_eth_rx_burst(ports[0],
766 (uint16_t)vdev->vmdq_rx_q, pkts_burst, MAX_PKT_BURST);
769 for (i = 0; i < rx_count; i++)
770 rte_pktmbuf_free(pkts_burst[i]);
772 rx_count = rte_eth_rx_burst(ports[0],
773 (uint16_t)vdev->vmdq_rx_q, pkts_burst, MAX_PKT_BURST);
776 vdev->ready = DEVICE_MAC_LEARNING;
780 static __rte_always_inline void
781 virtio_xmit(struct vhost_dev *dst_vdev, struct vhost_dev *src_vdev,
786 if (builtin_net_driver) {
787 ret = vs_enqueue_pkts(dst_vdev, VIRTIO_RXQ, &m, 1);
789 ret = rte_vhost_enqueue_burst(dst_vdev->vid, VIRTIO_RXQ, &m, 1);
793 rte_atomic64_inc(&dst_vdev->stats.rx_total_atomic);
794 rte_atomic64_add(&dst_vdev->stats.rx_atomic, ret);
795 src_vdev->stats.tx_total++;
796 src_vdev->stats.tx += ret;
801 * Check if the packet destination MAC address is for a local device. If so then put
802 * the packet on that devices RX queue. If not then return.
804 static __rte_always_inline int
805 virtio_tx_local(struct vhost_dev *vdev, struct rte_mbuf *m)
807 struct rte_ether_hdr *pkt_hdr;
808 struct vhost_dev *dst_vdev;
810 pkt_hdr = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
812 dst_vdev = find_vhost_dev(&pkt_hdr->d_addr);
816 if (vdev->vid == dst_vdev->vid) {
817 RTE_LOG_DP(DEBUG, VHOST_DATA,
818 "(%d) TX: src and dst MAC is same. Dropping packet.\n",
823 RTE_LOG_DP(DEBUG, VHOST_DATA,
824 "(%d) TX: MAC address is local\n", dst_vdev->vid);
826 if (unlikely(dst_vdev->remove)) {
827 RTE_LOG_DP(DEBUG, VHOST_DATA,
828 "(%d) device is marked for removal\n", dst_vdev->vid);
832 virtio_xmit(dst_vdev, vdev, m);
837 * Check if the destination MAC of a packet is one local VM,
838 * and get its vlan tag, and offset if it is.
840 static __rte_always_inline int
841 find_local_dest(struct vhost_dev *vdev, struct rte_mbuf *m,
842 uint32_t *offset, uint16_t *vlan_tag)
844 struct vhost_dev *dst_vdev;
845 struct rte_ether_hdr *pkt_hdr =
846 rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
848 dst_vdev = find_vhost_dev(&pkt_hdr->d_addr);
852 if (vdev->vid == dst_vdev->vid) {
853 RTE_LOG_DP(DEBUG, VHOST_DATA,
854 "(%d) TX: src and dst MAC is same. Dropping packet.\n",
860 * HW vlan strip will reduce the packet length
861 * by minus length of vlan tag, so need restore
862 * the packet length by plus it.
865 *vlan_tag = vlan_tags[vdev->vid];
867 RTE_LOG_DP(DEBUG, VHOST_DATA,
868 "(%d) TX: pkt to local VM device id: (%d), vlan tag: %u.\n",
869 vdev->vid, dst_vdev->vid, *vlan_tag);
875 get_psd_sum(void *l3_hdr, uint64_t ol_flags)
877 if (ol_flags & PKT_TX_IPV4)
878 return rte_ipv4_phdr_cksum(l3_hdr, ol_flags);
879 else /* assume ethertype == RTE_ETHER_TYPE_IPV6 */
880 return rte_ipv6_phdr_cksum(l3_hdr, ol_flags);
883 static void virtio_tx_offload(struct rte_mbuf *m)
886 struct rte_ipv4_hdr *ipv4_hdr = NULL;
887 struct rte_tcp_hdr *tcp_hdr = NULL;
888 struct rte_ether_hdr *eth_hdr =
889 rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
891 l3_hdr = (char *)eth_hdr + m->l2_len;
893 if (m->ol_flags & PKT_TX_IPV4) {
895 ipv4_hdr->hdr_checksum = 0;
896 m->ol_flags |= PKT_TX_IP_CKSUM;
899 tcp_hdr = (struct rte_tcp_hdr *)((char *)l3_hdr + m->l3_len);
900 tcp_hdr->cksum = get_psd_sum(l3_hdr, m->ol_flags);
904 free_pkts(struct rte_mbuf **pkts, uint16_t n)
907 rte_pktmbuf_free(pkts[n]);
910 static __rte_always_inline void
911 do_drain_mbuf_table(struct mbuf_table *tx_q)
915 count = rte_eth_tx_burst(ports[0], tx_q->txq_id,
916 tx_q->m_table, tx_q->len);
917 if (unlikely(count < tx_q->len))
918 free_pkts(&tx_q->m_table[count], tx_q->len - count);
924 * This function routes the TX packet to the correct interface. This
925 * may be a local device or the physical port.
927 static __rte_always_inline void
928 virtio_tx_route(struct vhost_dev *vdev, struct rte_mbuf *m, uint16_t vlan_tag)
930 struct mbuf_table *tx_q;
932 const uint16_t lcore_id = rte_lcore_id();
933 struct rte_ether_hdr *nh;
936 nh = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
937 if (unlikely(rte_is_broadcast_ether_addr(&nh->d_addr))) {
938 struct vhost_dev *vdev2;
940 TAILQ_FOREACH(vdev2, &vhost_dev_list, global_vdev_entry) {
942 virtio_xmit(vdev2, vdev, m);
947 /*check if destination is local VM*/
948 if ((vm2vm_mode == VM2VM_SOFTWARE) && (virtio_tx_local(vdev, m) == 0)) {
953 if (unlikely(vm2vm_mode == VM2VM_HARDWARE)) {
954 if (unlikely(find_local_dest(vdev, m, &offset,
961 RTE_LOG_DP(DEBUG, VHOST_DATA,
962 "(%d) TX: MAC address is external\n", vdev->vid);
966 /*Add packet to the port tx queue*/
967 tx_q = &lcore_tx_queue[lcore_id];
969 nh = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
970 if (unlikely(nh->ether_type == rte_cpu_to_be_16(RTE_ETHER_TYPE_VLAN))) {
971 /* Guest has inserted the vlan tag. */
972 struct rte_vlan_hdr *vh = (struct rte_vlan_hdr *) (nh + 1);
973 uint16_t vlan_tag_be = rte_cpu_to_be_16(vlan_tag);
974 if ((vm2vm_mode == VM2VM_HARDWARE) &&
975 (vh->vlan_tci != vlan_tag_be))
976 vh->vlan_tci = vlan_tag_be;
978 m->ol_flags |= PKT_TX_VLAN_PKT;
981 * Find the right seg to adjust the data len when offset is
982 * bigger than tail room size.
984 if (unlikely(vm2vm_mode == VM2VM_HARDWARE)) {
985 if (likely(offset <= rte_pktmbuf_tailroom(m)))
986 m->data_len += offset;
988 struct rte_mbuf *seg = m;
990 while ((seg->next != NULL) &&
991 (offset > rte_pktmbuf_tailroom(seg)))
994 seg->data_len += offset;
996 m->pkt_len += offset;
999 m->vlan_tci = vlan_tag;
1002 if (m->ol_flags & PKT_TX_TCP_SEG)
1003 virtio_tx_offload(m);
1005 tx_q->m_table[tx_q->len++] = m;
1007 vdev->stats.tx_total++;
1011 if (unlikely(tx_q->len == MAX_PKT_BURST))
1012 do_drain_mbuf_table(tx_q);
1016 static __rte_always_inline void
1017 drain_mbuf_table(struct mbuf_table *tx_q)
1019 static uint64_t prev_tsc;
1025 cur_tsc = rte_rdtsc();
1026 if (unlikely(cur_tsc - prev_tsc > MBUF_TABLE_DRAIN_TSC)) {
1029 RTE_LOG_DP(DEBUG, VHOST_DATA,
1030 "TX queue drained after timeout with burst size %u\n",
1032 do_drain_mbuf_table(tx_q);
1036 static __rte_always_inline void
1037 drain_eth_rx(struct vhost_dev *vdev)
1039 uint16_t rx_count, enqueue_count;
1040 struct rte_mbuf *pkts[MAX_PKT_BURST];
1042 rx_count = rte_eth_rx_burst(ports[0], vdev->vmdq_rx_q,
1043 pkts, MAX_PKT_BURST);
1048 * When "enable_retry" is set, here we wait and retry when there
1049 * is no enough free slots in the queue to hold @rx_count packets,
1050 * to diminish packet loss.
1053 unlikely(rx_count > rte_vhost_avail_entries(vdev->vid,
1057 for (retry = 0; retry < burst_rx_retry_num; retry++) {
1058 rte_delay_us(burst_rx_delay_time);
1059 if (rx_count <= rte_vhost_avail_entries(vdev->vid,
1065 if (builtin_net_driver) {
1066 enqueue_count = vs_enqueue_pkts(vdev, VIRTIO_RXQ,
1069 enqueue_count = rte_vhost_enqueue_burst(vdev->vid, VIRTIO_RXQ,
1073 rte_atomic64_add(&vdev->stats.rx_total_atomic, rx_count);
1074 rte_atomic64_add(&vdev->stats.rx_atomic, enqueue_count);
1077 free_pkts(pkts, rx_count);
1080 static __rte_always_inline void
1081 drain_virtio_tx(struct vhost_dev *vdev)
1083 struct rte_mbuf *pkts[MAX_PKT_BURST];
1087 if (builtin_net_driver) {
1088 count = vs_dequeue_pkts(vdev, VIRTIO_TXQ, mbuf_pool,
1089 pkts, MAX_PKT_BURST);
1091 count = rte_vhost_dequeue_burst(vdev->vid, VIRTIO_TXQ,
1092 mbuf_pool, pkts, MAX_PKT_BURST);
1095 /* setup VMDq for the first packet */
1096 if (unlikely(vdev->ready == DEVICE_MAC_LEARNING) && count) {
1097 if (vdev->remove || link_vmdq(vdev, pkts[0]) == -1)
1098 free_pkts(pkts, count);
1101 for (i = 0; i < count; ++i)
1102 virtio_tx_route(vdev, pkts[i], vlan_tags[vdev->vid]);
1106 * Main function of vhost-switch. It basically does:
1108 * for each vhost device {
1111 * Which drains the host eth Rx queue linked to the vhost device,
1112 * and deliver all of them to guest virito Rx ring associated with
1113 * this vhost device.
1115 * - drain_virtio_tx()
1117 * Which drains the guest virtio Tx queue and deliver all of them
1118 * to the target, which could be another vhost device, or the
1119 * physical eth dev. The route is done in function "virtio_tx_route".
1123 switch_worker(void *arg __rte_unused)
1126 unsigned lcore_id = rte_lcore_id();
1127 struct vhost_dev *vdev;
1128 struct mbuf_table *tx_q;
1130 RTE_LOG(INFO, VHOST_DATA, "Procesing on Core %u started\n", lcore_id);
1132 tx_q = &lcore_tx_queue[lcore_id];
1133 for (i = 0; i < rte_lcore_count(); i++) {
1134 if (lcore_ids[i] == lcore_id) {
1141 drain_mbuf_table(tx_q);
1144 * Inform the configuration core that we have exited the
1145 * linked list and that no devices are in use if requested.
1147 if (lcore_info[lcore_id].dev_removal_flag == REQUEST_DEV_REMOVAL)
1148 lcore_info[lcore_id].dev_removal_flag = ACK_DEV_REMOVAL;
1151 * Process vhost devices
1153 TAILQ_FOREACH(vdev, &lcore_info[lcore_id].vdev_list,
1155 if (unlikely(vdev->remove)) {
1157 vdev->ready = DEVICE_SAFE_REMOVE;
1161 if (likely(vdev->ready == DEVICE_RX))
1164 if (likely(!vdev->remove))
1165 drain_virtio_tx(vdev);
1173 * Remove a device from the specific data core linked list and from the
1174 * main linked list. Synchonization occurs through the use of the
1175 * lcore dev_removal_flag. Device is made volatile here to avoid re-ordering
1176 * of dev->remove=1 which can cause an infinite loop in the rte_pause loop.
1179 destroy_device(int vid)
1181 struct vhost_dev *vdev = NULL;
1184 TAILQ_FOREACH(vdev, &vhost_dev_list, global_vdev_entry) {
1185 if (vdev->vid == vid)
1190 /*set the remove flag. */
1192 while(vdev->ready != DEVICE_SAFE_REMOVE) {
1196 if (builtin_net_driver)
1197 vs_vhost_net_remove(vdev);
1199 TAILQ_REMOVE(&lcore_info[vdev->coreid].vdev_list, vdev,
1201 TAILQ_REMOVE(&vhost_dev_list, vdev, global_vdev_entry);
1204 /* Set the dev_removal_flag on each lcore. */
1205 RTE_LCORE_FOREACH_SLAVE(lcore)
1206 lcore_info[lcore].dev_removal_flag = REQUEST_DEV_REMOVAL;
1209 * Once each core has set the dev_removal_flag to ACK_DEV_REMOVAL
1210 * we can be sure that they can no longer access the device removed
1211 * from the linked lists and that the devices are no longer in use.
1213 RTE_LCORE_FOREACH_SLAVE(lcore) {
1214 while (lcore_info[lcore].dev_removal_flag != ACK_DEV_REMOVAL)
1218 lcore_info[vdev->coreid].device_num--;
1220 RTE_LOG(INFO, VHOST_DATA,
1221 "(%d) device has been removed from data core\n",
1228 * A new device is added to a data core. First the device is added to the main linked list
1229 * and then allocated to a specific data core.
1234 int lcore, core_add = 0;
1235 uint32_t device_num_min = num_devices;
1236 struct vhost_dev *vdev;
1238 vdev = rte_zmalloc("vhost device", sizeof(*vdev), RTE_CACHE_LINE_SIZE);
1240 RTE_LOG(INFO, VHOST_DATA,
1241 "(%d) couldn't allocate memory for vhost dev\n",
1247 if (builtin_net_driver)
1248 vs_vhost_net_setup(vdev);
1250 TAILQ_INSERT_TAIL(&vhost_dev_list, vdev, global_vdev_entry);
1251 vdev->vmdq_rx_q = vid * queues_per_pool + vmdq_queue_base;
1253 /*reset ready flag*/
1254 vdev->ready = DEVICE_MAC_LEARNING;
1257 /* Find a suitable lcore to add the device. */
1258 RTE_LCORE_FOREACH_SLAVE(lcore) {
1259 if (lcore_info[lcore].device_num < device_num_min) {
1260 device_num_min = lcore_info[lcore].device_num;
1264 vdev->coreid = core_add;
1266 TAILQ_INSERT_TAIL(&lcore_info[vdev->coreid].vdev_list, vdev,
1268 lcore_info[vdev->coreid].device_num++;
1270 /* Disable notifications. */
1271 rte_vhost_enable_guest_notification(vid, VIRTIO_RXQ, 0);
1272 rte_vhost_enable_guest_notification(vid, VIRTIO_TXQ, 0);
1274 RTE_LOG(INFO, VHOST_DATA,
1275 "(%d) device has been added to data core %d\n",
1282 * These callback allow devices to be added to the data core when configuration
1283 * has been fully complete.
1285 static const struct vhost_device_ops virtio_net_device_ops =
1287 .new_device = new_device,
1288 .destroy_device = destroy_device,
1292 * This is a thread will wake up after a period to print stats if the user has
1296 print_stats(__rte_unused void *arg)
1298 struct vhost_dev *vdev;
1299 uint64_t tx_dropped, rx_dropped;
1300 uint64_t tx, tx_total, rx, rx_total;
1301 const char clr[] = { 27, '[', '2', 'J', '\0' };
1302 const char top_left[] = { 27, '[', '1', ';', '1', 'H','\0' };
1305 sleep(enable_stats);
1307 /* Clear screen and move to top left */
1308 printf("%s%s\n", clr, top_left);
1309 printf("Device statistics =================================\n");
1311 TAILQ_FOREACH(vdev, &vhost_dev_list, global_vdev_entry) {
1312 tx_total = vdev->stats.tx_total;
1313 tx = vdev->stats.tx;
1314 tx_dropped = tx_total - tx;
1316 rx_total = rte_atomic64_read(&vdev->stats.rx_total_atomic);
1317 rx = rte_atomic64_read(&vdev->stats.rx_atomic);
1318 rx_dropped = rx_total - rx;
1320 printf("Statistics for device %d\n"
1321 "-----------------------\n"
1322 "TX total: %" PRIu64 "\n"
1323 "TX dropped: %" PRIu64 "\n"
1324 "TX successful: %" PRIu64 "\n"
1325 "RX total: %" PRIu64 "\n"
1326 "RX dropped: %" PRIu64 "\n"
1327 "RX successful: %" PRIu64 "\n",
1329 tx_total, tx_dropped, tx,
1330 rx_total, rx_dropped, rx);
1333 printf("===================================================\n");
1342 unregister_drivers(int socket_num)
1346 for (i = 0; i < socket_num; i++) {
1347 ret = rte_vhost_driver_unregister(socket_files + i * PATH_MAX);
1349 RTE_LOG(ERR, VHOST_CONFIG,
1350 "Fail to unregister vhost driver for %s.\n",
1351 socket_files + i * PATH_MAX);
1355 /* When we receive a INT signal, unregister vhost driver */
1357 sigint_handler(__rte_unused int signum)
1359 /* Unregister vhost driver. */
1360 unregister_drivers(nb_sockets);
1366 * While creating an mbuf pool, one key thing is to figure out how
1367 * many mbuf entries is enough for our use. FYI, here are some
1370 * - Each rx queue would reserve @nr_rx_desc mbufs at queue setup stage
1372 * - For each switch core (A CPU core does the packet switch), we need
1373 * also make some reservation for receiving the packets from virtio
1374 * Tx queue. How many is enough depends on the usage. It's normally
1375 * a simple calculation like following:
1377 * MAX_PKT_BURST * max packet size / mbuf size
1379 * So, we definitely need allocate more mbufs when TSO is enabled.
1381 * - Similarly, for each switching core, we should serve @nr_rx_desc
1382 * mbufs for receiving the packets from physical NIC device.
1384 * - We also need make sure, for each switch core, we have allocated
1385 * enough mbufs to fill up the mbuf cache.
1388 create_mbuf_pool(uint16_t nr_port, uint32_t nr_switch_core, uint32_t mbuf_size,
1389 uint32_t nr_queues, uint32_t nr_rx_desc, uint32_t nr_mbuf_cache)
1392 uint32_t nr_mbufs_per_core;
1393 uint32_t mtu = 1500;
1400 nr_mbufs_per_core = (mtu + mbuf_size) * MAX_PKT_BURST /
1401 (mbuf_size - RTE_PKTMBUF_HEADROOM);
1402 nr_mbufs_per_core += nr_rx_desc;
1403 nr_mbufs_per_core = RTE_MAX(nr_mbufs_per_core, nr_mbuf_cache);
1405 nr_mbufs = nr_queues * nr_rx_desc;
1406 nr_mbufs += nr_mbufs_per_core * nr_switch_core;
1407 nr_mbufs *= nr_port;
1409 mbuf_pool = rte_pktmbuf_pool_create("MBUF_POOL", nr_mbufs,
1410 nr_mbuf_cache, 0, mbuf_size,
1412 if (mbuf_pool == NULL)
1413 rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
1417 * Main function, does initialisation and calls the per-lcore functions.
1420 main(int argc, char *argv[])
1422 unsigned lcore_id, core_id = 0;
1423 unsigned nb_ports, valid_num_ports;
1426 static pthread_t tid;
1429 signal(SIGINT, sigint_handler);
1432 ret = rte_eal_init(argc, argv);
1434 rte_exit(EXIT_FAILURE, "Error with EAL initialization\n");
1438 /* parse app arguments */
1439 ret = us_vhost_parse_args(argc, argv);
1441 rte_exit(EXIT_FAILURE, "Invalid argument\n");
1443 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1444 TAILQ_INIT(&lcore_info[lcore_id].vdev_list);
1446 if (rte_lcore_is_enabled(lcore_id))
1447 lcore_ids[core_id++] = lcore_id;
1450 if (rte_lcore_count() > RTE_MAX_LCORE)
1451 rte_exit(EXIT_FAILURE,"Not enough cores\n");
1453 /* Get the number of physical ports. */
1454 nb_ports = rte_eth_dev_count_avail();
1457 * Update the global var NUM_PORTS and global array PORTS
1458 * and get value of var VALID_NUM_PORTS according to system ports number
1460 valid_num_ports = check_ports_num(nb_ports);
1462 if ((valid_num_ports == 0) || (valid_num_ports > MAX_SUP_PORTS)) {
1463 RTE_LOG(INFO, VHOST_PORT, "Current enabled port number is %u,"
1464 "but only %u port can be enabled\n",num_ports, MAX_SUP_PORTS);
1469 * FIXME: here we are trying to allocate mbufs big enough for
1470 * @MAX_QUEUES, but the truth is we're never going to use that
1471 * many queues here. We probably should only do allocation for
1472 * those queues we are going to use.
1474 create_mbuf_pool(valid_num_ports, rte_lcore_count() - 1, MBUF_DATA_SIZE,
1475 MAX_QUEUES, RTE_TEST_RX_DESC_DEFAULT, MBUF_CACHE_SIZE);
1477 if (vm2vm_mode == VM2VM_HARDWARE) {
1478 /* Enable VT loop back to let L2 switch to do it. */
1479 vmdq_conf_default.rx_adv_conf.vmdq_rx_conf.enable_loop_back = 1;
1480 RTE_LOG(DEBUG, VHOST_CONFIG,
1481 "Enable loop back for L2 switch in vmdq.\n");
1484 /* initialize all ports */
1485 RTE_ETH_FOREACH_DEV(portid) {
1486 /* skip ports that are not enabled */
1487 if ((enabled_port_mask & (1 << portid)) == 0) {
1488 RTE_LOG(INFO, VHOST_PORT,
1489 "Skipping disabled port %d\n", portid);
1492 if (port_init(portid) != 0)
1493 rte_exit(EXIT_FAILURE,
1494 "Cannot initialize network ports\n");
1497 /* Enable stats if the user option is set. */
1499 ret = rte_ctrl_thread_create(&tid, "print-stats", NULL,
1502 rte_exit(EXIT_FAILURE,
1503 "Cannot create print-stats thread\n");
1506 /* Launch all data cores. */
1507 RTE_LCORE_FOREACH_SLAVE(lcore_id)
1508 rte_eal_remote_launch(switch_worker, NULL, lcore_id);
1511 flags |= RTE_VHOST_USER_CLIENT;
1513 if (dequeue_zero_copy)
1514 flags |= RTE_VHOST_USER_DEQUEUE_ZERO_COPY;
1516 /* Register vhost user driver to handle vhost messages. */
1517 for (i = 0; i < nb_sockets; i++) {
1518 char *file = socket_files + i * PATH_MAX;
1519 ret = rte_vhost_driver_register(file, flags);
1521 unregister_drivers(i);
1522 rte_exit(EXIT_FAILURE,
1523 "vhost driver register failure.\n");
1526 if (builtin_net_driver)
1527 rte_vhost_driver_set_features(file, VIRTIO_NET_FEATURES);
1529 if (mergeable == 0) {
1530 rte_vhost_driver_disable_features(file,
1531 1ULL << VIRTIO_NET_F_MRG_RXBUF);
1534 if (enable_tx_csum == 0) {
1535 rte_vhost_driver_disable_features(file,
1536 1ULL << VIRTIO_NET_F_CSUM);
1539 if (enable_tso == 0) {
1540 rte_vhost_driver_disable_features(file,
1541 1ULL << VIRTIO_NET_F_HOST_TSO4);
1542 rte_vhost_driver_disable_features(file,
1543 1ULL << VIRTIO_NET_F_HOST_TSO6);
1544 rte_vhost_driver_disable_features(file,
1545 1ULL << VIRTIO_NET_F_GUEST_TSO4);
1546 rte_vhost_driver_disable_features(file,
1547 1ULL << VIRTIO_NET_F_GUEST_TSO6);
1551 rte_vhost_driver_enable_features(file,
1552 1ULL << VIRTIO_NET_F_CTRL_RX);
1555 ret = rte_vhost_driver_callback_register(file,
1556 &virtio_net_device_ops);
1558 rte_exit(EXIT_FAILURE,
1559 "failed to register vhost driver callbacks.\n");
1562 if (rte_vhost_driver_start(file) < 0) {
1563 rte_exit(EXIT_FAILURE,
1564 "failed to start vhost driver.\n");
1568 RTE_LCORE_FOREACH_SLAVE(lcore_id)
1569 rte_eal_wait_lcore(lcore_id);