4 * Copyright 2012 6WIND S.A.
5 * Copyright 2012 Mellanox
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of 6WIND S.A. nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 * mlx4 driver initialization.
48 /* Verbs headers do not support -pedantic. */
50 #pragma GCC diagnostic ignored "-Wpedantic"
52 #include <infiniband/verbs.h>
54 #pragma GCC diagnostic error "-Wpedantic"
57 #include <rte_common.h>
59 #include <rte_errno.h>
60 #include <rte_ethdev_driver.h>
61 #include <rte_ethdev_pci.h>
62 #include <rte_ether.h>
64 #include <rte_interrupts.h>
65 #include <rte_kvargs.h>
66 #include <rte_malloc.h>
70 #include "mlx4_flow.h"
71 #include "mlx4_rxtx.h"
72 #include "mlx4_utils.h"
74 /** Configuration structure for device arguments. */
77 uint32_t present; /**< Bit-field for existing ports. */
78 uint32_t enabled; /**< Bit-field for user-enabled ports. */
82 /* Available parameters list. */
83 const char *pmd_mlx4_init_params[] = {
89 * DPDK callback for Ethernet device configuration.
92 * Pointer to Ethernet device structure.
95 * 0 on success, negative errno value otherwise and rte_errno is set.
98 mlx4_dev_configure(struct rte_eth_dev *dev)
100 struct priv *priv = dev->data->dev_private;
101 struct rte_flow_error error;
104 /* Prepare internal flow rules. */
105 ret = mlx4_flow_sync(priv, &error);
107 ERROR("cannot set up internal flow rules (code %d, \"%s\"),"
108 " flow error type %d, cause %p, message: %s",
109 -ret, strerror(-ret), error.type, error.cause,
110 error.message ? error.message : "(unspecified)");
113 ret = mlx4_intr_install(priv);
115 ERROR("%p: interrupt handler installation failed",
122 * DPDK callback to start the device.
124 * Simulate device start by initializing common RSS resources and attaching
125 * all configured flows.
128 * Pointer to Ethernet device structure.
131 * 0 on success, negative errno value otherwise and rte_errno is set.
134 mlx4_dev_start(struct rte_eth_dev *dev)
136 struct priv *priv = dev->data->dev_private;
137 struct rte_flow_error error;
142 DEBUG("%p: attaching configured flows to all RX queues", (void *)dev);
144 ret = mlx4_rss_init(priv);
146 ERROR("%p: cannot initialize RSS resources: %s",
147 (void *)dev, strerror(-ret));
150 ret = mlx4_rxq_intr_enable(priv);
152 ERROR("%p: interrupt handler installation failed",
156 ret = mlx4_flow_sync(priv, &error);
158 ERROR("%p: cannot attach flow rules (code %d, \"%s\"),"
159 " flow error type %d, cause %p, message: %s",
161 -ret, strerror(-ret), error.type, error.cause,
162 error.message ? error.message : "(unspecified)");
166 dev->tx_pkt_burst = mlx4_tx_burst;
167 dev->rx_pkt_burst = mlx4_rx_burst;
176 * DPDK callback to stop the device.
178 * Simulate device stop by detaching all configured flows.
181 * Pointer to Ethernet device structure.
184 mlx4_dev_stop(struct rte_eth_dev *dev)
186 struct priv *priv = dev->data->dev_private;
190 DEBUG("%p: detaching flows from all RX queues", (void *)dev);
192 dev->tx_pkt_burst = mlx4_tx_burst_removed;
193 dev->rx_pkt_burst = mlx4_rx_burst_removed;
195 mlx4_flow_sync(priv, NULL);
196 mlx4_rxq_intr_disable(priv);
197 mlx4_rss_deinit(priv);
201 * DPDK callback to close the device.
203 * Destroy all queues and objects, free memory.
206 * Pointer to Ethernet device structure.
209 mlx4_dev_close(struct rte_eth_dev *dev)
211 struct priv *priv = dev->data->dev_private;
214 DEBUG("%p: closing device \"%s\"",
216 ((priv->ctx != NULL) ? priv->ctx->device->name : ""));
217 dev->rx_pkt_burst = mlx4_rx_burst_removed;
218 dev->tx_pkt_burst = mlx4_tx_burst_removed;
220 mlx4_flow_clean(priv);
221 for (i = 0; i != dev->data->nb_rx_queues; ++i)
222 mlx4_rx_queue_release(dev->data->rx_queues[i]);
223 for (i = 0; i != dev->data->nb_tx_queues; ++i)
224 mlx4_tx_queue_release(dev->data->tx_queues[i]);
225 if (priv->pd != NULL) {
226 assert(priv->ctx != NULL);
227 claim_zero(ibv_dealloc_pd(priv->pd));
228 claim_zero(ibv_close_device(priv->ctx));
230 assert(priv->ctx == NULL);
231 mlx4_intr_uninstall(priv);
232 memset(priv, 0, sizeof(*priv));
235 static const struct eth_dev_ops mlx4_dev_ops = {
236 .dev_configure = mlx4_dev_configure,
237 .dev_start = mlx4_dev_start,
238 .dev_stop = mlx4_dev_stop,
239 .dev_set_link_down = mlx4_dev_set_link_down,
240 .dev_set_link_up = mlx4_dev_set_link_up,
241 .dev_close = mlx4_dev_close,
242 .link_update = mlx4_link_update,
243 .promiscuous_enable = mlx4_promiscuous_enable,
244 .promiscuous_disable = mlx4_promiscuous_disable,
245 .allmulticast_enable = mlx4_allmulticast_enable,
246 .allmulticast_disable = mlx4_allmulticast_disable,
247 .mac_addr_remove = mlx4_mac_addr_remove,
248 .mac_addr_add = mlx4_mac_addr_add,
249 .mac_addr_set = mlx4_mac_addr_set,
250 .stats_get = mlx4_stats_get,
251 .stats_reset = mlx4_stats_reset,
252 .dev_infos_get = mlx4_dev_infos_get,
253 .dev_supported_ptypes_get = mlx4_dev_supported_ptypes_get,
254 .vlan_filter_set = mlx4_vlan_filter_set,
255 .rx_queue_setup = mlx4_rx_queue_setup,
256 .tx_queue_setup = mlx4_tx_queue_setup,
257 .rx_queue_release = mlx4_rx_queue_release,
258 .tx_queue_release = mlx4_tx_queue_release,
259 .flow_ctrl_get = mlx4_flow_ctrl_get,
260 .flow_ctrl_set = mlx4_flow_ctrl_set,
261 .mtu_set = mlx4_mtu_set,
262 .filter_ctrl = mlx4_filter_ctrl,
263 .rx_queue_intr_enable = mlx4_rx_intr_enable,
264 .rx_queue_intr_disable = mlx4_rx_intr_disable,
265 .is_removed = mlx4_is_removed,
269 * Get PCI information from struct ibv_device.
272 * Pointer to Ethernet device structure.
273 * @param[out] pci_addr
274 * PCI bus address output buffer.
277 * 0 on success, negative errno value otherwise and rte_errno is set.
280 mlx4_ibv_device_to_pci_addr(const struct ibv_device *device,
281 struct rte_pci_addr *pci_addr)
285 MKSTR(path, "%s/device/uevent", device->ibdev_path);
287 file = fopen(path, "rb");
292 while (fgets(line, sizeof(line), file) == line) {
293 size_t len = strlen(line);
296 /* Truncate long lines. */
297 if (len == (sizeof(line) - 1))
298 while (line[(len - 1)] != '\n') {
302 line[(len - 1)] = ret;
304 /* Extract information. */
307 "%" SCNx32 ":%" SCNx8 ":%" SCNx8 ".%" SCNx8 "\n",
311 &pci_addr->function) == 4) {
321 * Verify and store value for device argument.
324 * Key argument to verify.
326 * Value associated with key.
327 * @param[in, out] conf
328 * Shared configuration data.
331 * 0 on success, negative errno value otherwise and rte_errno is set.
334 mlx4_arg_parse(const char *key, const char *val, struct mlx4_conf *conf)
339 tmp = strtoul(val, NULL, 0);
342 WARN("%s: \"%s\" is not a valid integer", key, val);
345 if (strcmp(MLX4_PMD_PORT_KVARG, key) == 0) {
346 uint32_t ports = rte_log2_u32(conf->ports.present + 1);
349 ERROR("port index %lu outside range [0,%" PRIu32 ")",
353 if (!(conf->ports.present & (1 << tmp))) {
355 ERROR("invalid port index %lu", tmp);
358 conf->ports.enabled |= 1 << tmp;
361 WARN("%s: unknown parameter", key);
368 * Parse device parameters.
371 * Device arguments structure.
374 * 0 on success, negative errno value otherwise and rte_errno is set.
377 mlx4_args(struct rte_devargs *devargs, struct mlx4_conf *conf)
379 struct rte_kvargs *kvlist;
380 unsigned int arg_count;
386 kvlist = rte_kvargs_parse(devargs->args, pmd_mlx4_init_params);
387 if (kvlist == NULL) {
389 ERROR("failed to parse kvargs");
392 /* Process parameters. */
393 for (i = 0; pmd_mlx4_init_params[i]; ++i) {
394 arg_count = rte_kvargs_count(kvlist, MLX4_PMD_PORT_KVARG);
395 while (arg_count-- > 0) {
396 ret = rte_kvargs_process(kvlist,
398 (int (*)(const char *,
408 rte_kvargs_free(kvlist);
412 static struct rte_pci_driver mlx4_driver;
415 * DPDK callback to register a PCI device.
417 * This function creates an Ethernet device for each port of a given
421 * PCI driver structure (mlx4_driver).
423 * PCI device information.
426 * 0 on success, negative errno value otherwise and rte_errno is set.
429 mlx4_pci_probe(struct rte_pci_driver *pci_drv, struct rte_pci_device *pci_dev)
431 struct ibv_device **list;
432 struct ibv_device *ibv_dev;
434 struct ibv_context *attr_ctx = NULL;
435 struct ibv_device_attr device_attr;
436 struct ibv_device_attr_ex device_attr_ex;
437 struct mlx4_conf conf = {
444 assert(pci_drv == &mlx4_driver);
445 list = ibv_get_device_list(&i);
449 if (rte_errno == ENOSYS)
450 ERROR("cannot list devices, is ib_uverbs loaded?");
455 * For each listed device, check related sysfs entry against
456 * the provided PCI ID.
459 struct rte_pci_addr pci_addr;
462 DEBUG("checking device \"%s\"", list[i]->name);
463 if (mlx4_ibv_device_to_pci_addr(list[i], &pci_addr))
465 if ((pci_dev->addr.domain != pci_addr.domain) ||
466 (pci_dev->addr.bus != pci_addr.bus) ||
467 (pci_dev->addr.devid != pci_addr.devid) ||
468 (pci_dev->addr.function != pci_addr.function))
470 vf = (pci_dev->id.device_id ==
471 PCI_DEVICE_ID_MELLANOX_CONNECTX3VF);
472 INFO("PCI information matches, using device \"%s\" (VF: %s)",
473 list[i]->name, (vf ? "true" : "false"));
474 attr_ctx = ibv_open_device(list[i]);
478 if (attr_ctx == NULL) {
479 ibv_free_device_list(list);
483 ERROR("cannot access device, is mlx4_ib loaded?");
487 ERROR("cannot use device, are drivers up to date?");
495 DEBUG("device opened");
496 if (ibv_query_device(attr_ctx, &device_attr)) {
500 INFO("%u port(s) detected", device_attr.phys_port_cnt);
501 conf.ports.present |= (UINT64_C(1) << device_attr.phys_port_cnt) - 1;
502 if (mlx4_args(pci_dev->device.devargs, &conf)) {
503 ERROR("failed to process device arguments");
507 /* Use all ports when none are defined */
508 if (!conf.ports.enabled)
509 conf.ports.enabled = conf.ports.present;
510 /* Retrieve extended device attributes. */
511 if (ibv_query_device_ex(attr_ctx, NULL, &device_attr_ex)) {
515 assert(device_attr.max_sge >= MLX4_MAX_SGE);
516 for (i = 0; i < device_attr.phys_port_cnt; i++) {
517 uint32_t port = i + 1; /* ports are indexed from one */
518 struct ibv_context *ctx = NULL;
519 struct ibv_port_attr port_attr;
520 struct ibv_pd *pd = NULL;
521 struct priv *priv = NULL;
522 struct rte_eth_dev *eth_dev = NULL;
523 struct ether_addr mac;
525 /* If port is not enabled, skip. */
526 if (!(conf.ports.enabled & (1 << i)))
528 DEBUG("using port %u", port);
529 ctx = ibv_open_device(ibv_dev);
534 /* Check port status. */
535 err = ibv_query_port(ctx, port, &port_attr);
538 ERROR("port query failed: %s", strerror(rte_errno));
541 if (port_attr.link_layer != IBV_LINK_LAYER_ETHERNET) {
543 ERROR("port %d is not configured in Ethernet mode",
547 if (port_attr.state != IBV_PORT_ACTIVE)
548 DEBUG("port %d is not active: \"%s\" (%d)",
549 port, ibv_port_state_str(port_attr.state),
551 /* Make asynchronous FD non-blocking to handle interrupts. */
552 if (mlx4_fd_set_non_blocking(ctx->async_fd) < 0) {
553 ERROR("cannot make asynchronous FD non-blocking: %s",
554 strerror(rte_errno));
557 /* Allocate protection domain. */
558 pd = ibv_alloc_pd(ctx);
561 ERROR("PD allocation failure");
564 /* from rte_ethdev.c */
565 priv = rte_zmalloc("ethdev private structure",
567 RTE_CACHE_LINE_SIZE);
570 ERROR("priv allocation failure");
574 priv->device_attr = device_attr;
577 priv->mtu = ETHER_MTU;
579 priv->hw_csum = !!(device_attr.device_cap_flags &
580 IBV_DEVICE_RAW_IP_CSUM);
581 DEBUG("checksum offloading is %ssupported",
582 (priv->hw_csum ? "" : "not "));
583 /* Only ConnectX-3 Pro supports tunneling. */
584 priv->hw_csum_l2tun =
586 (device_attr.vendor_part_id ==
587 PCI_DEVICE_ID_MELLANOX_CONNECTX3PRO);
588 DEBUG("L2 tunnel checksum offloads are %ssupported",
589 (priv->hw_csum_l2tun ? "" : "not "));
590 priv->hw_rss_sup = device_attr_ex.rss_caps.rx_hash_fields_mask;
591 if (!priv->hw_rss_sup) {
592 WARN("no RSS capabilities reported; disabling support"
593 " for UDP RSS and inner VXLAN RSS");
594 /* Fake support for all possible RSS hash fields. */
595 priv->hw_rss_sup = ~UINT64_C(0);
596 priv->hw_rss_sup = mlx4_conv_rss_hf(priv, -1);
597 /* Filter out known unsupported fields. */
599 ~(uint64_t)(IBV_RX_HASH_SRC_PORT_UDP |
600 IBV_RX_HASH_DST_PORT_UDP |
603 DEBUG("supported RSS hash fields mask: %016" PRIx64,
605 /* Configure the first MAC address by default. */
606 if (mlx4_get_mac(priv, &mac.addr_bytes)) {
607 ERROR("cannot get MAC address, is mlx4_en loaded?"
608 " (rte_errno: %s)", strerror(rte_errno));
611 INFO("port %u MAC address is %02x:%02x:%02x:%02x:%02x:%02x",
613 mac.addr_bytes[0], mac.addr_bytes[1],
614 mac.addr_bytes[2], mac.addr_bytes[3],
615 mac.addr_bytes[4], mac.addr_bytes[5]);
616 /* Register MAC address. */
620 char ifname[IF_NAMESIZE];
622 if (mlx4_get_ifname(priv, &ifname) == 0)
623 DEBUG("port %u ifname is \"%s\"",
626 DEBUG("port %u ifname is unknown", priv->port);
629 /* Get actual MTU if possible. */
630 mlx4_mtu_get(priv, &priv->mtu);
631 DEBUG("port %u MTU is %u", priv->port, priv->mtu);
632 /* from rte_ethdev.c */
634 char name[RTE_ETH_NAME_MAX_LEN];
636 snprintf(name, sizeof(name), "%s port %u",
637 ibv_get_device_name(ibv_dev), port);
638 eth_dev = rte_eth_dev_allocate(name);
640 if (eth_dev == NULL) {
641 ERROR("can not allocate rte ethdev");
645 eth_dev->data->dev_private = priv;
646 eth_dev->data->mac_addrs = priv->mac;
647 eth_dev->device = &pci_dev->device;
648 rte_eth_copy_pci_info(eth_dev, pci_dev);
649 eth_dev->device->driver = &mlx4_driver.driver;
650 /* Initialize local interrupt handle for current port. */
651 priv->intr_handle = (struct rte_intr_handle){
653 .type = RTE_INTR_HANDLE_EXT,
656 * Override ethdev interrupt handle pointer with private
657 * handle instead of that of the parent PCI device used by
658 * default. This prevents it from being shared between all
659 * ports of the same PCI device since each of them is
660 * associated its own Verbs context.
662 * Rx interrupts in particular require this as the PMD has
663 * no control over the registration of queue interrupts
664 * besides setting up eth_dev->intr_handle, the rest is
665 * handled by rte_intr_rx_ctl().
667 eth_dev->intr_handle = &priv->intr_handle;
669 eth_dev->dev_ops = &mlx4_dev_ops;
670 /* Bring Ethernet device up. */
671 DEBUG("forcing Ethernet interface up");
672 mlx4_dev_set_link_up(priv->dev);
673 /* Update link status once if waiting for LSC. */
674 if (eth_dev->data->dev_flags & RTE_ETH_DEV_INTR_LSC)
675 mlx4_link_update(eth_dev, 0);
680 claim_zero(ibv_dealloc_pd(pd));
682 claim_zero(ibv_close_device(ctx));
684 rte_eth_dev_release_port(eth_dev);
687 if (i == device_attr.phys_port_cnt)
690 * XXX if something went wrong in the loop above, there is a resource
691 * leak (ctx, pd, priv, dpdk ethdev) but we can do nothing about it as
692 * long as the dpdk does not provide a way to deallocate a ethdev and a
693 * way to enumerate the registered ethdevs to free the previous ones.
697 claim_zero(ibv_close_device(attr_ctx));
699 ibv_free_device_list(list);
700 assert(rte_errno >= 0);
704 static const struct rte_pci_id mlx4_pci_id_map[] = {
706 RTE_PCI_DEVICE(PCI_VENDOR_ID_MELLANOX,
707 PCI_DEVICE_ID_MELLANOX_CONNECTX3)
710 RTE_PCI_DEVICE(PCI_VENDOR_ID_MELLANOX,
711 PCI_DEVICE_ID_MELLANOX_CONNECTX3PRO)
714 RTE_PCI_DEVICE(PCI_VENDOR_ID_MELLANOX,
715 PCI_DEVICE_ID_MELLANOX_CONNECTX3VF)
722 static struct rte_pci_driver mlx4_driver = {
724 .name = MLX4_DRIVER_NAME
726 .id_table = mlx4_pci_id_map,
727 .probe = mlx4_pci_probe,
728 .drv_flags = RTE_PCI_DRV_INTR_LSC |
729 RTE_PCI_DRV_INTR_RMV,
733 * Driver initialization routine.
735 RTE_INIT(rte_mlx4_pmd_init);
737 rte_mlx4_pmd_init(void)
740 * MLX4_DEVICE_FATAL_CLEANUP tells ibv_destroy functions we
741 * want to get success errno value in case of calling them
742 * when the device was removed.
744 setenv("MLX4_DEVICE_FATAL_CLEANUP", "1", 1);
746 * RDMAV_HUGEPAGES_SAFE tells ibv_fork_init() we intend to use
747 * huge pages. Calling ibv_fork_init() during init allows
748 * applications to use fork() safely for purposes other than
749 * using this PMD, which is not supported in forked processes.
751 setenv("RDMAV_HUGEPAGES_SAFE", "1", 1);
753 rte_pci_register(&mlx4_driver);
756 RTE_PMD_EXPORT_NAME(net_mlx4, __COUNTER__);
757 RTE_PMD_REGISTER_PCI_TABLE(net_mlx4, mlx4_pci_id_map);
758 RTE_PMD_REGISTER_KMOD_DEP(net_mlx4,
759 "* ib_uverbs & mlx4_en & mlx4_core & mlx4_ib");