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.
15 #include <vnet/vnet.h>
16 #include <vppinfra/vec.h>
17 #include <vppinfra/error.h>
18 #include <vppinfra/format.h>
19 #include <vppinfra/bitmap.h>
20 #include <vppinfra/linux/sysfs.h>
21 #include <vlib/unix/unix.h>
24 #include <vnet/vnet.h>
25 #include <vnet/ethernet/ethernet.h>
26 #include <vnet/interface/rx_queue_funcs.h>
27 #include <dpdk/buffer.h>
28 #include <dpdk/device/dpdk.h>
29 #include <dpdk/cryptodev/cryptodev.h>
30 #include <vlib/pci/pci.h>
31 #include <vlib/vmbus/vmbus.h>
40 #include <sys/mount.h>
45 #include <dpdk/device/dpdk_priv.h>
47 dpdk_main_t dpdk_main;
48 dpdk_config_main_t dpdk_config_main;
50 #define LINK_STATE_ELOGS 0
52 /* dev_info.speed_capa -> interface name mapppings */
57 } if_name_prefixes[] = {
58 /* sorted, higher speed first */
59 { ETH_LINK_SPEED_200G, "TwoHundredGigabitEthernet" },
60 { ETH_LINK_SPEED_100G, "HundredGigabitEthernet" },
61 { ETH_LINK_SPEED_56G, "FiftySixGigabitEthernet" },
62 { ETH_LINK_SPEED_50G, "FiftyGigabitEthernet" },
63 { ETH_LINK_SPEED_40G, "FortyGigabitEthernet" },
64 { ETH_LINK_SPEED_25G, "TwentyFiveGigabitEthernet" },
65 { ETH_LINK_SPEED_20G, "TwentyGigabitEthernet" },
66 { ETH_LINK_SPEED_10G, "TenGigabitEthernet" },
67 { ETH_LINK_SPEED_5G, "FiveGigabitEthernet" },
68 { ETH_LINK_SPEED_2_5G, "TwoDotFiveGigabitEthernet" },
69 { ETH_LINK_SPEED_1G, "GigabitEthernet" },
73 dpdk_set_max_frame_size (vnet_main_t *vnm, vnet_hw_interface_t *hi,
76 dpdk_main_t *dm = &dpdk_main;
77 dpdk_device_t *xd = vec_elt_at_index (dm->devices, hi->dev_instance);
81 mtu = frame_size - xd->driver_frame_overhead;
83 rv = rte_eth_dev_set_mtu (xd->port_id, mtu);
87 dpdk_log_err ("[%u] rte_eth_dev_set_mtu failed (mtu %u, rv %d)",
88 xd->port_id, mtu, rv);
92 return vnet_error (VNET_ERR_UNSUPPORTED,
93 "dpdk driver doesn't support MTU change");
95 return vnet_error (VNET_ERR_BUSY, "port is running");
97 return vnet_error (VNET_ERR_INVALID_VALUE, "invalid MTU");
99 return vnet_error (VNET_ERR_BUG,
100 "unexpected return value %d returned from "
101 "rte_eth_dev_set_mtu(...)",
106 dpdk_log_debug ("[%u] max_frame_size set to %u by setting MTU to %u",
107 xd->port_id, frame_size, mtu);
113 dpdk_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi, u32 flags)
115 dpdk_main_t *dm = &dpdk_main;
116 dpdk_device_t *xd = vec_elt_at_index (dm->devices, hi->dev_instance);
117 u32 old = (xd->flags & DPDK_DEVICE_FLAG_PROMISC) != 0;
121 case ETHERNET_INTERFACE_FLAG_DEFAULT_L3:
122 /* set to L3/non-promisc mode */
123 dpdk_device_flag_set (xd, DPDK_DEVICE_FLAG_PROMISC, 0);
125 case ETHERNET_INTERFACE_FLAG_ACCEPT_ALL:
126 dpdk_device_flag_set (xd, DPDK_DEVICE_FLAG_PROMISC, 1);
132 if (xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP)
134 if (xd->flags & DPDK_DEVICE_FLAG_PROMISC)
135 rte_eth_promiscuous_enable (xd->port_id);
137 rte_eth_promiscuous_disable (xd->port_id);
143 /* The function check_l3cache helps check if Level 3 cache exists or not on current CPUs
144 return value 1: exist.
145 return value 0: not exist.
153 const char *sys_cache_dir = "/sys/devices/system/cpu/cpu0/cache";
154 DIR *dir_cache = opendir (sys_cache_dir);
156 if (dir_cache == NULL)
159 while ((dp = readdir (dir_cache)) != NULL)
161 if (dp->d_type == DT_DIR)
164 int level_cache = -1;
166 p = format (p, "%s/%s/%s%c", sys_cache_dir, dp->d_name, "level", 0);
167 if ((err = clib_sysfs_read ((char *) p, "%d", &level_cache)))
168 clib_error_free (err);
170 if (level_cache == 3)
172 closedir (dir_cache);
178 if (dir_cache != NULL)
179 closedir (dir_cache);
184 static dpdk_device_config_t *
185 dpdk_find_startup_config (struct rte_eth_dev_info *di)
187 dpdk_main_t *dm = &dpdk_main;
188 struct rte_pci_device *pci_dev;
189 struct rte_vmbus_device *vmbus_dev;
190 vlib_pci_addr_t pci_addr;
191 vlib_vmbus_addr_t vmbus_addr;
194 if ((pci_dev = dpdk_get_pci_device (di)))
196 pci_addr.domain = pci_dev->addr.domain;
197 pci_addr.bus = pci_dev->addr.bus;
198 pci_addr.slot = pci_dev->addr.devid;
199 pci_addr.function = pci_dev->addr.function;
201 hash_get (dm->conf->device_config_index_by_pci_addr, pci_addr.as_u32);
204 if ((vmbus_dev = dpdk_get_vmbus_device (di)))
206 unformat_input_t input_vmbus;
207 unformat_init_string (&input_vmbus, di->device->name,
208 strlen (di->device->name));
209 if (unformat (&input_vmbus, "%U", unformat_vlib_vmbus_addr, &vmbus_addr))
210 p = mhash_get (&dm->conf->device_config_index_by_vmbus_addr,
212 unformat_free (&input_vmbus);
216 return pool_elt_at_index (dm->conf->dev_confs, p[0]);
217 return &dm->conf->default_devconf;
220 static clib_error_t *
221 dpdk_lib_init (dpdk_main_t * dm)
223 vnet_main_t *vnm = vnet_get_main ();
225 vlib_thread_main_t *tm = vlib_get_thread_main ();
226 vnet_device_main_t *vdm = &vnet_device_main;
227 vnet_sw_interface_t *sw;
228 vnet_hw_interface_t *hi;
232 /* vlib_buffer_t template */
233 vec_validate_aligned (dm->per_thread_data, tm->n_vlib_mains - 1,
234 CLIB_CACHE_LINE_BYTES);
235 for (int i = 0; i < tm->n_vlib_mains; i++)
237 dpdk_per_thread_data_t *ptd = vec_elt_at_index (dm->per_thread_data, i);
238 clib_memset (&ptd->buffer_template, 0, sizeof (vlib_buffer_t));
239 vnet_buffer (&ptd->buffer_template)->sw_if_index[VLIB_TX] = (u32) ~ 0;
243 dm->conf->interface_name_format_decimal ? "%d/%d/%d" : "%x/%x/%x";
245 /* device config defaults */
246 dm->default_port_conf.n_rx_desc = DPDK_NB_RX_DESC_DEFAULT;
247 dm->default_port_conf.n_tx_desc = DPDK_NB_TX_DESC_DEFAULT;
248 dm->default_port_conf.n_rx_queues = 1;
249 dm->default_port_conf.n_tx_queues = tm->n_vlib_mains;
250 dm->default_port_conf.rss_hf = ETH_RSS_IP | ETH_RSS_UDP | ETH_RSS_TCP;
251 dm->default_port_conf.max_lro_pkt_size = DPDK_MAX_LRO_SIZE_DEFAULT;
253 if ((clib_mem_get_default_hugepage_size () == 2 << 20) &&
254 check_l3cache () == 0)
255 dm->default_port_conf.n_rx_desc = dm->default_port_conf.n_tx_desc = 512;
257 RTE_ETH_FOREACH_DEV (port_id)
261 struct rte_eth_dev_info di;
262 dpdk_device_config_t *devconf = 0;
263 vnet_eth_interface_registration_t eir = {};
266 if (!rte_eth_dev_is_valid_port (port_id))
269 if ((rv = rte_eth_dev_info_get (port_id, &di)) != 0)
271 dpdk_log_warn ("[%u] failed to get device info. skipping device.",
278 dpdk_log_warn ("[%u] missing device info. Skipping '%s' device",
279 port_id, di.driver_name);
283 devconf = dpdk_find_startup_config (&di);
285 /* If device is blacklisted, we should skip it */
286 if (devconf->is_blacklisted)
288 dpdk_log_notice ("[%d] Device %s blacklisted. Skipping...", port_id,
293 vec_add2_aligned (dm->devices, xd, 1, CLIB_CACHE_LINE_BYTES);
294 xd->port_id = port_id;
295 xd->device_index = xd - dm->devices;
296 xd->per_interface_next_index = ~0;
298 clib_memcpy (&xd->conf, &dm->default_port_conf,
299 sizeof (dpdk_port_conf_t));
301 /* find driver datea for this PMD */
302 if ((dr = dpdk_driver_find (di.driver_name, &xd->if_desc)))
305 xd->supported_flow_actions = dr->supported_flow_actions;
306 xd->conf.disable_rss = dr->mq_mode_none;
307 xd->conf.disable_rx_scatter = dr->disable_rx_scatter;
308 if (dr->use_intel_phdr_cksum)
309 dpdk_device_flag_set (xd, DPDK_DEVICE_FLAG_INTEL_PHDR_CKSUM, 1);
310 if (dr->int_unmaskable)
311 dpdk_device_flag_set (xd, DPDK_DEVICE_FLAG_INT_UNMASKABLE, 1);
314 dpdk_log_warn ("[%u] unknown driver '%s'", port_id, di.driver_name);
318 xd->name = devconf->name;
322 struct rte_pci_device *pci_dev;
323 if (dr && dr->interface_name_prefix)
325 /* prefix override by driver */
326 xd->name = format (xd->name, "%s", dr->interface_name_prefix);
330 /* interface name prefix from speed_capa */
331 u64 mask = ~((if_name_prefixes[0].link_speed << 1) - 1);
333 if (di.speed_capa & mask)
334 dpdk_log_warn ("[%u] unknown speed capability 0x%x reported",
335 xd->port_id, di.speed_capa & mask);
337 for (int i = 0; i < ARRAY_LEN (if_name_prefixes); i++)
338 if (if_name_prefixes[i].link_speed & di.speed_capa)
341 format (xd->name, "%s", if_name_prefixes[i].pfx);
345 xd->name = format (xd->name, "Ethernet");
348 if (dr && dr->interface_number_from_port_id)
349 xd->name = format (xd->name, "%u", port_id);
350 else if ((pci_dev = dpdk_get_pci_device (&di)))
351 xd->name = format (xd->name, if_num_fmt, pci_dev->addr.bus,
352 pci_dev->addr.devid, pci_dev->addr.function);
354 xd->name = format (xd->name, "%u", port_id);
357 /* Handle representor devices that share the same PCI ID */
358 if ((di.switch_info.domain_id != RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID) &&
359 (di.switch_info.port_id != (uint16_t) -1))
360 xd->name = format (xd->name, "/%d", di.switch_info.port_id);
362 /* number of RX and TX queues */
363 if (devconf->num_tx_queues > 0)
365 if (di.max_tx_queues < devconf->num_tx_queues)
366 dpdk_log_warn ("[%u] Configured number of TX queues (%u) is "
367 "bigger than maximum supported (%u)",
368 port_id, devconf->num_tx_queues, di.max_tx_queues);
369 xd->conf.n_tx_queues = devconf->num_tx_queues;
372 xd->conf.n_tx_queues = clib_min (di.max_tx_queues, xd->conf.n_tx_queues);
374 if (devconf->num_rx_queues > 1 &&
375 di.max_rx_queues >= devconf->num_rx_queues)
377 xd->conf.n_rx_queues = devconf->num_rx_queues;
380 u64 unsupported_bits;
381 xd->conf.rss_hf = devconf->rss_fn;
382 unsupported_bits = xd->conf.rss_hf;
383 unsupported_bits &= ~di.flow_type_rss_offloads;
384 if (unsupported_bits)
385 dpdk_log_warn ("Unsupported RSS hash functions: %U",
386 format_dpdk_rss_hf_name, unsupported_bits);
388 xd->conf.rss_hf &= di.flow_type_rss_offloads;
389 dpdk_log_debug ("[%u] rss_hf: %U", port_id, format_dpdk_rss_hf_name,
393 #ifndef RTE_VLAN_HLEN
394 #define RTE_VLAN_HLEN 4
396 xd->driver_frame_overhead =
397 RTE_ETHER_HDR_LEN + 2 * RTE_VLAN_HLEN + RTE_ETHER_CRC_LEN;
398 #if RTE_VERSION >= RTE_VERSION_NUM(21, 11, 0, 0)
399 q = di.max_rx_pktlen - di.max_mtu;
401 if (q < xd->driver_frame_overhead && q > 0)
402 xd->driver_frame_overhead = q;
403 dpdk_log_debug ("[%u] min_mtu: %u, max_mtu: %u, min_rx_bufsize: %u, "
404 "max_rx_pktlen: %u, max_lro_pkt_size: %u",
405 xd->port_id, di.min_mtu, di.max_mtu, di.min_rx_bufsize,
406 di.max_rx_pktlen, di.max_lro_pkt_size);
408 dpdk_log_debug ("[%u] driver frame overhead is %u", port_id,
409 xd->driver_frame_overhead);
411 /* number of RX and TX tescriptors */
412 if (devconf->num_rx_desc)
413 xd->conf.n_rx_desc = devconf->num_rx_desc;
414 else if (dr && dr->n_rx_desc)
415 xd->conf.n_rx_desc = dr->n_rx_desc;
417 if (devconf->num_tx_desc)
418 xd->conf.n_tx_desc = devconf->num_tx_desc;
419 else if (dr && dr->n_tx_desc)
420 xd->conf.n_tx_desc = dr->n_tx_desc;
423 "[%u] n_rx_queues: %u n_tx_queues: %u n_rx_desc: %u n_tx_desc: %u",
424 port_id, xd->conf.n_rx_queues, xd->conf.n_tx_queues,
425 xd->conf.n_rx_desc, xd->conf.n_tx_desc);
427 vec_validate_aligned (xd->rx_queues, xd->conf.n_rx_queues - 1,
428 CLIB_CACHE_LINE_BYTES);
430 rte_eth_macaddr_get (port_id, (void *) addr);
432 /* create interface */
433 eir.dev_class_index = dpdk_device_class.index;
434 eir.dev_instance = xd->device_index;
436 eir.cb.flag_change = dpdk_flag_change;
437 eir.cb.set_max_frame_size = dpdk_set_max_frame_size;
438 xd->hw_if_index = vnet_eth_register_interface (vnm, &eir);
439 hi = vnet_get_hw_interface (vnm, xd->hw_if_index);
440 hi->numa_node = xd->cpu_socket = (i8) rte_eth_dev_socket_id (port_id);
441 sw = vnet_get_hw_sw_interface (vnm, xd->hw_if_index);
442 xd->sw_if_index = sw->sw_if_index;
443 dpdk_log_debug ("[%u] interface %s created", port_id, hi->name);
445 ethernet_set_flags (vnm, xd->hw_if_index,
446 ETHERNET_INTERFACE_FLAG_DEFAULT_L3);
448 /* assign worker threads */
449 vnet_hw_if_set_input_node (vnm, xd->hw_if_index, dpdk_input_node.index);
450 if (devconf->workers)
454 clib_bitmap_foreach (j, devconf->workers)
456 dpdk_rx_queue_t *rxq = vec_elt_at_index (xd->rx_queues, q);
457 rxq->queue_index = vnet_hw_if_register_rx_queue (
458 vnm, xd->hw_if_index, q++, vdm->first_worker_thread_index + j);
462 for (q = 0; q < xd->conf.n_rx_queues; q++)
464 dpdk_rx_queue_t *rxq = vec_elt_at_index (xd->rx_queues, q);
465 rxq->queue_index = vnet_hw_if_register_rx_queue (
466 vnm, xd->hw_if_index, q, VNET_HW_IF_RXQ_THREAD_ANY);
469 if (devconf->tso == DPDK_DEVICE_TSO_ON)
471 /*tcp_udp checksum must be enabled*/
472 if (xd->conf.enable_tcp_udp_checksum == 0)
473 dpdk_log_warn ("[%u] TCP/UDP checksum offload must be enabled",
475 else if ((di.tx_offload_capa & DEV_TX_OFFLOAD_TCP_TSO) == 0)
476 dpdk_log_warn ("[%u] TSO not supported by device", xd->port_id);
478 xd->conf.enable_tso = 1;
481 if (devconf->max_lro_pkt_size)
482 xd->conf.max_lro_pkt_size = devconf->max_lro_pkt_size;
484 dpdk_device_setup (xd);
486 /* rss queues should be configured after dpdk_device_setup() */
487 if (devconf->rss_queues)
489 if (vnet_hw_interface_set_rss_queues (vnet_get_main (), hi,
490 devconf->rss_queues))
491 dpdk_log_warn ("[%u] Failed to set rss queues", port_id);
494 if (vec_len (xd->errors))
495 dpdk_log_err ("[%u] setup failed Errors:\n %U", port_id,
496 format_dpdk_device_errors, xd);
499 for (int i = 0; i < vec_len (dm->devices); i++)
500 vnet_hw_if_update_runtime_data (vnm, dm->devices[i].hw_if_index);
506 dpdk_bind_devices_to_uio (dpdk_config_main_t * conf)
508 vlib_main_t *vm = vlib_get_main ();
511 int num_whitelisted = vec_len (conf->dev_confs);
512 vlib_pci_device_info_t *d = 0;
513 vlib_pci_addr_t *addr = 0, *addrs;
516 addrs = vlib_pci_get_all_dev_addrs ();
518 vec_foreach (addr, addrs)
520 dpdk_device_config_t * devconf = 0;
521 vec_reset_length (pci_addr);
522 pci_addr = format (pci_addr, "%U%c", format_vlib_pci_addr, addr, 0);
525 vlib_pci_free_device_info (d);
528 d = vlib_pci_get_device_info (vm, addr, &error);
531 vlib_log_warn (dpdk_main.log_default, "%U", format_clib_error, error);
532 clib_error_free (error);
536 if (d->device_class != PCI_CLASS_NETWORK_ETHERNET && d->device_class != PCI_CLASS_PROCESSOR_CO)
541 uword * p = hash_get (conf->device_config_index_by_pci_addr, addr->as_u32);
549 devconf = pool_elt_at_index (conf->dev_confs, p[0]);
552 /* Enforce Device blacklist by vendor and device */
553 for (i = 0; i < vec_len (conf->blacklist_by_pci_vendor_and_device); i++)
556 vendor = (u16)(conf->blacklist_by_pci_vendor_and_device[i] >> 16);
557 device = (u16)(conf->blacklist_by_pci_vendor_and_device[i] & 0xFFFF);
558 if (d->vendor_id == vendor && d->device_id == device)
561 * Expected case: device isn't whitelisted,
566 /* Device is blacklisted */
567 pool_get (conf->dev_confs, devconf);
568 hash_set (conf->device_config_index_by_pci_addr, addr->as_u32,
569 devconf - conf->dev_confs);
570 devconf->pci_addr.as_u32 = addr->as_u32;
571 devconf->dev_addr_type = VNET_DEV_ADDR_PCI;
572 devconf->is_blacklisted = 1;
575 else /* explicitly whitelisted, ignore the device blacklist */
581 if (d->vendor_id == 0x1af4 &&
582 (d->device_id == VIRTIO_PCI_LEGACY_DEVICEID_NET ||
583 d->device_id == VIRTIO_PCI_MODERN_DEVICEID_NET))
586 else if (d->vendor_id == 0x15ad && d->device_id == 0x07b0)
589 * For vmxnet3 PCI, unless it is explicitly specified in the whitelist,
590 * the default is to put it in the blacklist.
594 pool_get (conf->dev_confs, devconf);
595 hash_set (conf->device_config_index_by_pci_addr, addr->as_u32,
596 devconf - conf->dev_confs);
597 devconf->pci_addr.as_u32 = addr->as_u32;
598 devconf->is_blacklisted = 1;
601 /* all Intel network devices */
602 else if (d->vendor_id == 0x8086 && d->device_class == PCI_CLASS_NETWORK_ETHERNET)
604 /* all Intel QAT devices VFs */
605 else if (d->vendor_id == 0x8086 && d->device_class == PCI_CLASS_PROCESSOR_CO &&
606 (d->device_id == 0x0443 || d->device_id == 0x18a1 || d->device_id == 0x19e3 ||
607 d->device_id == 0x37c9 || d->device_id == 0x6f55))
610 else if (d->vendor_id == 0x1137 &&
611 (d->device_id == 0x0043 || d->device_id == 0x0071))
614 else if (d->vendor_id == 0x1425 && (d->device_id & 0xe000) == 0x4000)
616 /* Amazon Elastic Network Adapter */
617 else if (d->vendor_id == 0x1d0f && d->device_id >= 0xec20 && d->device_id <= 0xec21)
619 /* Cavium Network Adapter */
620 else if (d->vendor_id == 0x177d && d->device_id == 0x9712)
622 /* Cavium FastlinQ QL41000 Series */
623 else if (d->vendor_id == 0x1077 && d->device_id >= 0x8070 && d->device_id <= 0x8090)
625 /* Mellanox CX3, CX3VF */
626 else if (d->vendor_id == 0x15b3 && d->device_id >= 0x1003 && d->device_id <= 0x1004)
630 /* Mellanox CX4, CX4VF, CX4LX, CX4LXVF, CX5, CX5VF, CX5EX, CX5EXVF */
631 else if (d->vendor_id == 0x15b3 && d->device_id >= 0x1013 && d->device_id <= 0x101a)
635 /* Mellanox CX6, CX6VF, CX6DX, CX6DXVF */
636 else if (d->vendor_id == 0x15b3 && d->device_id >= 0x101b && d->device_id <= 0x101e)
640 /* Broadcom NetXtreme S, and E series only */
641 else if (d->vendor_id == 0x14e4 &&
642 ((d->device_id >= 0x16c0 &&
643 d->device_id != 0x16c6 && d->device_id != 0x16c7 &&
644 d->device_id != 0x16dd && d->device_id != 0x16f7 &&
645 d->device_id != 0x16fd && d->device_id != 0x16fe &&
646 d->device_id != 0x170d && d->device_id != 0x170c &&
647 d->device_id != 0x170e && d->device_id != 0x1712 &&
648 d->device_id != 0x1713) ||
649 (d->device_id == 0x1604 || d->device_id == 0x1605 ||
650 d->device_id == 0x1614 || d->device_id == 0x1606 ||
651 d->device_id == 0x1609 || d->device_id == 0x1614)))
655 dpdk_log_warn ("Unsupported PCI device 0x%04x:0x%04x found "
656 "at PCI address %s\n", (u16) d->vendor_id, (u16) d->device_id,
661 error = vlib_pci_bind_to_uio (vm, addr, (char *) conf->uio_driver_name);
667 pool_get (conf->dev_confs, devconf);
668 hash_set (conf->device_config_index_by_pci_addr, addr->as_u32,
669 devconf - conf->dev_confs);
670 devconf->pci_addr.as_u32 = addr->as_u32;
672 devconf->dev_addr_type = VNET_DEV_ADDR_PCI;
673 devconf->is_blacklisted = 1;
674 clib_error_report (error);
679 vlib_pci_free_device_info (d);
683 dpdk_bind_vmbus_devices_to_uio (dpdk_config_main_t * conf)
686 vlib_vmbus_addr_t *addrs, *addr = 0;
687 int num_whitelisted = vec_len (conf->dev_confs);
690 addrs = vlib_vmbus_get_all_dev_addrs ();
693 vec_foreach (addr, addrs)
695 dpdk_device_config_t *devconf = 0;
699 mhash_get (&conf->device_config_index_by_vmbus_addr, addr);
702 /* No devices blacklisted, but have whitelisted. blacklist all
704 pool_get (conf->dev_confs, devconf);
705 mhash_set (&conf->device_config_index_by_vmbus_addr, addr,
706 devconf - conf->dev_confs, 0);
707 devconf->vmbus_addr = *addr;
708 devconf->dev_addr_type = VNET_DEV_ADDR_VMBUS;
709 devconf->is_blacklisted = 1;
714 devconf = pool_elt_at_index (conf->dev_confs, p[0]);
717 /* Enforce Device blacklist by vmbus_addr */
718 for (i = 0; i < vec_len (conf->blacklist_by_vmbus_addr); i++)
720 vlib_vmbus_addr_t *a1 = &conf->blacklist_by_vmbus_addr[i];
721 vlib_vmbus_addr_t *a2 = addr;
722 if (memcmp (a1, a2, sizeof (vlib_vmbus_addr_t)) == 0)
726 /* Device not whitelisted */
727 pool_get (conf->dev_confs, devconf);
728 mhash_set (&conf->device_config_index_by_vmbus_addr, addr,
729 devconf - conf->dev_confs, 0);
730 devconf->vmbus_addr = *addr;
731 devconf->dev_addr_type = VNET_DEV_ADDR_VMBUS;
732 devconf->is_blacklisted = 1;
742 error = vlib_vmbus_bind_to_uio (addr);
747 pool_get (conf->dev_confs, devconf);
748 mhash_set (&conf->device_config_index_by_vmbus_addr, addr,
749 devconf - conf->dev_confs, 0);
750 devconf->vmbus_addr = *addr;
752 devconf->dev_addr_type = VNET_DEV_ADDR_VMBUS;
753 devconf->is_blacklisted = 1;
754 clib_error_report (error);
761 unformat_max_simd_bitwidth (unformat_input_t *input, va_list *va)
763 uword *max_simd_bitwidth = va_arg (*va, uword *);
765 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
767 if (!unformat (input, "%u", max_simd_bitwidth))
770 if (*max_simd_bitwidth != DPDK_MAX_SIMD_BITWIDTH_256 &&
771 *max_simd_bitwidth != DPDK_MAX_SIMD_BITWIDTH_512)
779 static clib_error_t *
780 dpdk_device_config (dpdk_config_main_t *conf, void *addr,
781 dpdk_device_addr_type_t addr_type, unformat_input_t *input,
784 clib_error_t *error = 0;
786 dpdk_device_config_t *devconf = 0;
787 unformat_input_t sub_input;
791 devconf = &conf->default_devconf;
793 else if (addr_type == VNET_DEV_ADDR_PCI)
795 p = hash_get (conf->device_config_index_by_pci_addr,
796 ((vlib_pci_addr_t *) (addr))->as_u32);
800 pool_get (conf->dev_confs, devconf);
801 hash_set (conf->device_config_index_by_pci_addr,
802 ((vlib_pci_addr_t *) (addr))->as_u32,
803 devconf - conf->dev_confs);
806 return clib_error_return (0,
807 "duplicate configuration for PCI address %U",
808 format_vlib_pci_addr, addr);
810 else if (addr_type == VNET_DEV_ADDR_VMBUS)
812 p = mhash_get (&conf->device_config_index_by_vmbus_addr,
813 (vlib_vmbus_addr_t *) (addr));
817 pool_get (conf->dev_confs, devconf);
818 mhash_set (&conf->device_config_index_by_vmbus_addr, addr,
819 devconf - conf->dev_confs, 0);
822 return clib_error_return (
823 0, "duplicate configuration for VMBUS address %U",
824 format_vlib_vmbus_addr, addr);
827 if (addr_type == VNET_DEV_ADDR_PCI)
829 devconf->pci_addr.as_u32 = ((vlib_pci_addr_t *) (addr))->as_u32;
830 devconf->tso = DPDK_DEVICE_TSO_DEFAULT;
831 devconf->dev_addr_type = VNET_DEV_ADDR_PCI;
833 else if (addr_type == VNET_DEV_ADDR_VMBUS)
835 devconf->vmbus_addr = *((vlib_vmbus_addr_t *) (addr));
836 devconf->tso = DPDK_DEVICE_TSO_DEFAULT;
837 devconf->dev_addr_type = VNET_DEV_ADDR_VMBUS;
843 unformat_skip_white_space (input);
844 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
846 if (unformat (input, "num-rx-queues %u", &devconf->num_rx_queues))
848 else if (unformat (input, "num-tx-queues %u", &devconf->num_tx_queues))
850 else if (unformat (input, "num-rx-desc %u", &devconf->num_rx_desc))
852 else if (unformat (input, "num-tx-desc %u", &devconf->num_tx_desc))
854 else if (unformat (input, "name %v", &devconf->name))
856 else if (unformat (input, "workers %U", unformat_bitmap_list,
861 (input, "rss %U", unformat_vlib_cli_sub_input, &sub_input))
863 error = unformat_rss_fn (&sub_input, &devconf->rss_fn);
867 else if (unformat (input, "tso on"))
869 devconf->tso = DPDK_DEVICE_TSO_ON;
871 else if (unformat (input, "tso off"))
873 devconf->tso = DPDK_DEVICE_TSO_OFF;
875 else if (unformat (input, "devargs %s", &devconf->devargs))
877 else if (unformat (input, "rss-queues %U",
878 unformat_bitmap_list, &devconf->rss_queues))
880 else if (unformat (input, "max-lro-pkt-size %u",
881 &devconf->max_lro_pkt_size))
885 error = clib_error_return (0, "unknown input `%U'",
886 format_unformat_error, input);
894 if (devconf->workers && devconf->num_rx_queues == 0)
895 devconf->num_rx_queues = clib_bitmap_count_set_bits (devconf->workers);
896 else if (devconf->workers &&
897 clib_bitmap_count_set_bits (devconf->workers) !=
898 devconf->num_rx_queues)
899 error = clib_error_return (0,
900 "%U: number of worker threads must be "
901 "equal to number of rx queues",
902 format_vlib_pci_addr, addr);
907 static clib_error_t *
908 dpdk_log_read_ready (clib_file_t * uf)
910 unformat_input_t input;
917 uword len = vec_len (s);
918 vec_resize (s, len + n_try);
920 n = read (uf->file_descriptor, s + len, n_try);
921 if (n < 0 && errno != EAGAIN)
922 return clib_error_return_unix (0, "read");
923 _vec_len (s) = len + (n < 0 ? 0 : n);
926 unformat_init_vector (&input, s);
928 while (unformat_user (&input, unformat_line, &line))
933 /* unfortunatelly DPDK polutes log with this error messages
934 * even when we pass --in-memory which means no secondary process */
935 if (strstr ((char *) line, "WARNING! Base virtual address hint"))
937 else if (strstr ((char *) line, "This may cause issues with mapping "
938 "memory into secondary processes"))
942 dpdk_log_notice ("%v", line);
946 unformat_free (&input);
950 static clib_error_t *
951 dpdk_config (vlib_main_t * vm, unformat_input_t * input)
953 dpdk_main_t *dm = &dpdk_main;
954 clib_error_t *error = 0;
955 dpdk_config_main_t *conf = &dpdk_config_main;
956 vlib_thread_main_t *tm = vlib_get_thread_main ();
957 dpdk_device_config_t *devconf;
958 vlib_pci_addr_t pci_addr = { 0 };
959 vlib_vmbus_addr_t vmbus_addr = { 0 };
960 unformat_input_t sub_input;
961 uword default_hugepage_sz, x;
964 int num_whitelisted = 0;
965 int eal_no_hugetlb = 0;
970 u8 *huge_dir_path = 0;
971 u32 vendor, device, domain, bus, func;
974 format (0, "%s/hugepages%c", vlib_unix_get_runtime_dir (), 0);
976 conf->device_config_index_by_pci_addr = hash_create (0, sizeof (uword));
977 mhash_init (&conf->device_config_index_by_vmbus_addr, sizeof (uword),
978 sizeof (vlib_vmbus_addr_t));
980 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
983 if (unformat (input, "no-hugetlb"))
985 vec_add1 (conf->eal_init_args, (u8 *) "--no-huge");
988 else if (unformat (input, "telemetry"))
989 conf->enable_telemetry = 1;
991 else if (unformat (input, "enable-tcp-udp-checksum"))
993 dm->default_port_conf.enable_tcp_udp_checksum = 1;
994 if (unformat (input, "enable-outer-checksum-offload"))
995 dm->default_port_conf.enable_outer_checksum_offload = 1;
997 else if (unformat (input, "no-tx-checksum-offload"))
998 dm->default_port_conf.disable_tx_checksum_offload = 1;
1000 else if (unformat (input, "decimal-interface-names"))
1001 conf->interface_name_format_decimal = 1;
1003 else if (unformat (input, "no-multi-seg"))
1004 dm->default_port_conf.disable_multi_seg = 1;
1005 else if (unformat (input, "enable-lro"))
1006 dm->default_port_conf.enable_lro = 1;
1007 else if (unformat (input, "max-simd-bitwidth %U",
1008 unformat_max_simd_bitwidth, &conf->max_simd_bitwidth))
1010 else if (unformat (input, "dev default %U", unformat_vlib_cli_sub_input,
1014 dpdk_device_config (conf, 0, VNET_DEV_ADDR_ANY, &sub_input, 1);
1021 (input, "dev %U %U", unformat_vlib_pci_addr, &pci_addr,
1022 unformat_vlib_cli_sub_input, &sub_input))
1024 error = dpdk_device_config (conf, &pci_addr, VNET_DEV_ADDR_PCI,
1032 else if (unformat (input, "dev %U", unformat_vlib_pci_addr, &pci_addr))
1035 dpdk_device_config (conf, &pci_addr, VNET_DEV_ADDR_PCI, 0, 0);
1042 else if (unformat (input, "dev %U %U", unformat_vlib_vmbus_addr,
1043 &vmbus_addr, unformat_vlib_cli_sub_input, &sub_input))
1045 error = dpdk_device_config (conf, &vmbus_addr, VNET_DEV_ADDR_VMBUS,
1053 else if (unformat (input, "dev %U", unformat_vlib_vmbus_addr,
1057 dpdk_device_config (conf, &vmbus_addr, VNET_DEV_ADDR_VMBUS, 0, 0);
1064 else if (unformat (input, "uio-driver %s", &conf->uio_driver_name))
1066 else if (unformat (input, "socket-mem %s", &socket_mem))
1068 else if (unformat (input, "no-pci"))
1071 tmp = format (0, "--no-pci%c", 0);
1072 vec_add1 (conf->eal_init_args, tmp);
1074 else if (unformat (input, "blacklist %U", unformat_vlib_vmbus_addr,
1077 vec_add1 (conf->blacklist_by_vmbus_addr, vmbus_addr);
1081 (input, "blacklist %x:%x:%x.%x", &domain, &bus, &device, &func))
1083 tmp = format (0, "-b%c", 0);
1084 vec_add1 (conf->eal_init_args, tmp);
1086 format (0, "%04x:%02x:%02x.%x%c", domain, bus, device, func, 0);
1087 vec_add1 (conf->eal_init_args, tmp);
1089 else if (unformat (input, "blacklist %x:%x", &vendor, &device))
1091 u32 blacklist_entry;
1092 if (vendor > 0xFFFF)
1093 return clib_error_return (0, "blacklist PCI vendor out of range");
1094 if (device > 0xFFFF)
1095 return clib_error_return (0, "blacklist PCI device out of range");
1096 blacklist_entry = (vendor << 16) | (device & 0xffff);
1097 vec_add1 (conf->blacklist_by_pci_vendor_and_device,
1100 else if (unformat (input, "no-vmbus"))
1103 tmp = format (0, "--no-vmbus%c", 0);
1104 vec_add1 (conf->eal_init_args, tmp);
1108 else if (unformat(input, #a)) \
1110 tmp = format (0, "--%s%c", #a, 0); \
1111 vec_add1 (conf->eal_init_args, tmp); \
1113 foreach_eal_double_hyphen_predicate_arg
1116 else if (unformat(input, #a " %s", &s)) \
1118 if (!strncmp(#a, "file-prefix", 11)) \
1120 tmp = format (0, "--%s%c", #a, 0); \
1121 vec_add1 (conf->eal_init_args, tmp); \
1123 if (!strncmp(#a, "vdev", 4)) \
1124 if (strstr((char*)s, "af_packet")) \
1125 clib_warning ("af_packet obsoleted. Use CLI 'create host-interface'."); \
1126 vec_add1 (conf->eal_init_args, s); \
1128 foreach_eal_double_hyphen_arg
1131 else if (unformat(input, #a " %s", &s)) \
1133 tmp = format (0, "-%s%c", #b, 0); \
1134 vec_add1 (conf->eal_init_args, tmp); \
1136 vec_add1 (conf->eal_init_args, s); \
1138 foreach_eal_single_hyphen_arg
1140 else if (unformat (input, "default"))
1143 else if (unformat_skip_white_space (input))
1147 error = clib_error_return (0, "unknown input `%U'",
1148 format_unformat_error, input);
1153 if (!conf->uio_driver_name)
1154 conf->uio_driver_name = format (0, "auto%c", 0);
1156 if (eal_no_hugetlb == 0)
1158 vec_add1 (conf->eal_init_args, (u8 *) "--in-memory");
1160 default_hugepage_sz = clib_mem_get_default_hugepage_size ();
1163 clib_bitmap_foreach (x, tm->cpu_socket_bitmap)
1167 /* preallocate at least 16MB of hugepages per socket,
1168 if more is needed it is up to consumer to preallocate more */
1169 n_pages = round_pow2 ((uword) 16 << 20, default_hugepage_sz);
1170 n_pages /= default_hugepage_sz;
1172 if ((e = clib_sysfs_prealloc_hugepages(x, 0, n_pages)))
1173 clib_error_report (e);
1178 /* on/off dpdk's telemetry thread */
1179 if (conf->enable_telemetry == 0)
1181 vec_add1 (conf->eal_init_args, (u8 *) "--no-telemetry");
1186 tmp = format (0, "--file-prefix%c", 0);
1187 vec_add1 (conf->eal_init_args, tmp);
1188 tmp = format (0, "vpp%c", 0);
1189 vec_add1 (conf->eal_init_args, tmp);
1195 if (no_pci == 0 && geteuid () == 0)
1196 dpdk_bind_devices_to_uio (conf);
1198 if (no_vmbus == 0 && geteuid () == 0)
1199 dpdk_bind_vmbus_devices_to_uio (conf);
1202 if (devconf->x == 0 && conf->default_devconf.x > 0) \
1203 devconf->x = conf->default_devconf.x ;
1205 pool_foreach (devconf, conf->dev_confs) {
1207 /* default per-device config items */
1208 foreach_dpdk_device_config_item
1210 /* copy tso config from default device */
1213 /* copy tso config from default device */
1216 /* copy rss_queues config from default device */
1219 /* add DPDK EAL whitelist/blacklist entry */
1220 if (num_whitelisted > 0 && devconf->is_blacklisted == 0 &&
1221 devconf->dev_addr_type == VNET_DEV_ADDR_PCI)
1223 tmp = format (0, "-a%c", 0);
1224 vec_add1 (conf->eal_init_args, tmp);
1225 if (devconf->devargs)
1227 tmp = format (0, "%U,%s%c", format_vlib_pci_addr,
1228 &devconf->pci_addr, devconf->devargs, 0);
1232 tmp = format (0, "%U%c", format_vlib_pci_addr, &devconf->pci_addr, 0);
1234 vec_add1 (conf->eal_init_args, tmp);
1236 else if (num_whitelisted == 0 && devconf->is_blacklisted != 0 &&
1237 devconf->dev_addr_type == VNET_DEV_ADDR_PCI)
1239 tmp = format (0, "-b%c", 0);
1240 vec_add1 (conf->eal_init_args, tmp);
1241 tmp = format (0, "%U%c", format_vlib_pci_addr, &devconf->pci_addr, 0);
1242 vec_add1 (conf->eal_init_args, tmp);
1249 clib_warning ("socket-mem argument is deprecated");
1251 /* NULL terminate the "argv" vector, in case of stupidity */
1252 vec_add1 (conf->eal_init_args, 0);
1253 _vec_len (conf->eal_init_args) -= 1;
1255 /* Set up DPDK eal and packet mbuf pool early. */
1257 int log_fds[2] = { 0 };
1258 if (pipe (log_fds) == 0)
1260 if (fcntl (log_fds[1], F_SETFL, O_NONBLOCK) == 0)
1262 FILE *f = fdopen (log_fds[1], "a");
1263 if (f && rte_openlog_stream (f) == 0)
1265 clib_file_t t = { 0 };
1266 t.read_function = dpdk_log_read_ready;
1267 t.file_descriptor = log_fds[0];
1268 t.description = format (0, "DPDK logging pipe");
1269 clib_file_add (&file_main, &t);
1279 vm = vlib_get_main ();
1281 /* make copy of args as rte_eal_init tends to mess up with arg array */
1282 for (i = 1; i < vec_len (conf->eal_init_args); i++)
1283 conf->eal_init_args_str = format (conf->eal_init_args_str, "%s ",
1284 conf->eal_init_args[i]);
1286 vec_terminate_c_string (conf->eal_init_args_str);
1288 dpdk_log_notice ("EAL init args: %s", conf->eal_init_args_str);
1289 ret = rte_eal_init (vec_len (conf->eal_init_args),
1290 (char **) conf->eal_init_args);
1292 /* enable the AVX-512 vPMDs in DPDK */
1293 if (clib_cpu_supports_avx512_bitalg () &&
1294 conf->max_simd_bitwidth == DPDK_MAX_SIMD_BITWIDTH_DEFAULT)
1295 rte_vect_set_max_simd_bitwidth (RTE_VECT_SIMD_512);
1296 else if (conf->max_simd_bitwidth != DPDK_MAX_SIMD_BITWIDTH_DEFAULT)
1297 rte_vect_set_max_simd_bitwidth (conf->max_simd_bitwidth ==
1298 DPDK_MAX_SIMD_BITWIDTH_256 ?
1302 /* lazy umount hugepages */
1303 umount2 ((char *) huge_dir_path, MNT_DETACH);
1304 rmdir ((char *) huge_dir_path);
1305 vec_free (huge_dir_path);
1308 return clib_error_return (0, "rte_eal_init returned %d", ret);
1310 /* main thread 1st */
1311 if ((error = dpdk_buffer_pools_create (vm)))
1318 VLIB_CONFIG_FUNCTION (dpdk_config, "dpdk");
1321 dpdk_update_link_state (dpdk_device_t * xd, f64 now)
1323 vnet_main_t *vnm = vnet_get_main ();
1324 struct rte_eth_link prev_link = xd->link;
1326 u8 hw_flags_chg = 0;
1328 xd->time_last_link_update = now ? now : xd->time_last_link_update;
1329 clib_memset (&xd->link, 0, sizeof (xd->link));
1330 rte_eth_link_get_nowait (xd->port_id, &xd->link);
1332 if (LINK_STATE_ELOGS)
1334 ELOG_TYPE_DECLARE (e) =
1337 "update-link-state: sw_if_index %d, admin_up %d,"
1338 "old link_state %d new link_state %d",.format_args = "i4i1i1i1",};
1347 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
1348 ed->sw_if_index = xd->sw_if_index;
1349 ed->admin_up = (xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) != 0;
1350 ed->old_link_state = (u8)
1351 vnet_hw_interface_is_link_up (vnm, xd->hw_if_index);
1352 ed->new_link_state = (u8) xd->link.link_status;
1355 if ((xd->link.link_duplex != prev_link.link_duplex))
1358 switch (xd->link.link_duplex)
1360 case ETH_LINK_HALF_DUPLEX:
1361 hw_flags |= VNET_HW_INTERFACE_FLAG_HALF_DUPLEX;
1363 case ETH_LINK_FULL_DUPLEX:
1364 hw_flags |= VNET_HW_INTERFACE_FLAG_FULL_DUPLEX;
1370 if (xd->link.link_speed != prev_link.link_speed)
1371 vnet_hw_interface_set_link_speed (vnm, xd->hw_if_index,
1372 xd->link.link_speed * 1000);
1374 if (xd->link.link_status != prev_link.link_status)
1378 if (xd->link.link_status)
1379 hw_flags |= VNET_HW_INTERFACE_FLAG_LINK_UP;
1384 if (LINK_STATE_ELOGS)
1386 ELOG_TYPE_DECLARE (e) =
1389 "update-link-state: sw_if_index %d, new flags %d",.format_args
1397 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
1398 ed->sw_if_index = xd->sw_if_index;
1399 ed->flags = hw_flags;
1401 vnet_hw_interface_set_flags (vnm, xd->hw_if_index, hw_flags);
1406 dpdk_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
1408 clib_error_t *error;
1409 dpdk_main_t *dm = &dpdk_main;
1411 vlib_thread_main_t *tm = vlib_get_thread_main ();
1413 error = dpdk_lib_init (dm);
1416 clib_error_report (error);
1418 if (dpdk_cryptodev_init)
1420 error = dpdk_cryptodev_init (vm);
1423 vlib_log_warn (dpdk_main.log_cryptodev, "%U", format_clib_error,
1425 clib_error_free (error);
1429 tm->worker_thread_release = 1;
1431 f64 now = vlib_time_now (vm);
1432 vec_foreach (xd, dm->devices)
1434 dpdk_update_link_state (xd, now);
1440 * check each time through the loop in case intervals are changed
1442 f64 min_wait = dm->link_state_poll_interval < dm->stat_poll_interval ?
1443 dm->link_state_poll_interval : dm->stat_poll_interval;
1445 vlib_process_wait_for_event_or_clock (vm, min_wait);
1447 if (dm->admin_up_down_in_progress)
1448 /* skip the poll if an admin up down is in progress (on any interface) */
1451 vec_foreach (xd, dm->devices)
1453 f64 now = vlib_time_now (vm);
1454 if ((now - xd->time_last_stats_update) >= dm->stat_poll_interval)
1455 dpdk_update_counters (xd, now);
1456 if ((now - xd->time_last_link_update) >= dm->link_state_poll_interval)
1457 dpdk_update_link_state (xd, now);
1466 VLIB_REGISTER_NODE (dpdk_process_node,static) = {
1467 .function = dpdk_process,
1468 .type = VLIB_NODE_TYPE_PROCESS,
1469 .name = "dpdk-process",
1470 .process_log2_n_stack_bytes = 17,
1474 static clib_error_t *
1475 dpdk_init (vlib_main_t * vm)
1477 dpdk_main_t *dm = &dpdk_main;
1478 clib_error_t *error = 0;
1480 /* verify that structs are cacheline aligned */
1481 STATIC_ASSERT (offsetof (dpdk_device_t, cacheline0) == 0,
1482 "Cache line marker must be 1st element in dpdk_device_t");
1483 STATIC_ASSERT (offsetof (dpdk_device_t, cacheline1) ==
1484 CLIB_CACHE_LINE_BYTES,
1485 "Data in cache line 0 is bigger than cache line size");
1486 STATIC_ASSERT (offsetof (frame_queue_trace_t, cacheline0) == 0,
1487 "Cache line marker must be 1st element in frame_queue_trace_t");
1489 dpdk_cli_reference ();
1491 dm->conf = &dpdk_config_main;
1493 vec_add1 (dm->conf->eal_init_args, (u8 *) "vnet");
1495 dm->stat_poll_interval = DPDK_STATS_POLL_INTERVAL;
1496 dm->link_state_poll_interval = DPDK_LINK_POLL_INTERVAL;
1498 dm->log_default = vlib_log_register_class ("dpdk", 0);
1499 dm->log_cryptodev = vlib_log_register_class ("dpdk", "cryptodev");
1504 VLIB_INIT_FUNCTION (dpdk_init);
1506 static clib_error_t *
1507 dpdk_worker_thread_init (vlib_main_t *vm)
1509 if (rte_thread_register () < 0)
1510 clib_panic ("dpdk: cannot register thread %u - %s", vm->thread_index,
1511 rte_strerror (rte_errno));
1515 VLIB_WORKER_INIT_FUNCTION (dpdk_worker_thread_init);