align SPDX Mellanox copyrights
[dpdk.git] / drivers / net / mlx4 / mlx4.c
index 680eca7..f389e66 100644 (file)
@@ -1,34 +1,6 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright 2012 6WIND S.A.
- *   Copyright 2012 Mellanox
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of 6WIND S.A. nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2012 6WIND S.A.
+ * Copyright 2012 Mellanox Technologies, Ltd
  */
 
 /**
@@ -37,6 +9,7 @@
  */
 
 #include <assert.h>
+#include <dlfcn.h>
 #include <errno.h>
 #include <inttypes.h>
 #include <stddef.h>
@@ -44,6 +17,7 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <unistd.h>
 
 /* Verbs headers do not support -pedantic. */
 #ifdef PEDANTIC
@@ -55,6 +29,7 @@
 #endif
 
 #include <rte_common.h>
+#include <rte_config.h>
 #include <rte_dev.h>
 #include <rte_errno.h>
 #include <rte_ethdev_driver.h>
@@ -67,6 +42,7 @@
 #include <rte_mbuf.h>
 
 #include "mlx4.h"
+#include "mlx4_glue.h"
 #include "mlx4_flow.h"
 #include "mlx4_rxtx.h"
 #include "mlx4_utils.h"
@@ -224,8 +200,8 @@ mlx4_dev_close(struct rte_eth_dev *dev)
                mlx4_tx_queue_release(dev->data->tx_queues[i]);
        if (priv->pd != NULL) {
                assert(priv->ctx != NULL);
-               claim_zero(ibv_dealloc_pd(priv->pd));
-               claim_zero(ibv_close_device(priv->ctx));
+               claim_zero(mlx4_glue->dealloc_pd(priv->pd));
+               claim_zero(mlx4_glue->close_device(priv->ctx));
        } else
                assert(priv->ctx == NULL);
        mlx4_intr_uninstall(priv);
@@ -442,7 +418,7 @@ mlx4_pci_probe(struct rte_pci_driver *pci_drv, struct rte_pci_device *pci_dev)
 
        (void)pci_drv;
        assert(pci_drv == &mlx4_driver);
-       list = ibv_get_device_list(&i);
+       list = mlx4_glue->get_device_list(&i);
        if (list == NULL) {
                rte_errno = errno;
                assert(rte_errno);
@@ -471,12 +447,12 @@ mlx4_pci_probe(struct rte_pci_driver *pci_drv, struct rte_pci_device *pci_dev)
                      PCI_DEVICE_ID_MELLANOX_CONNECTX3VF);
                INFO("PCI information matches, using device \"%s\" (VF: %s)",
                     list[i]->name, (vf ? "true" : "false"));
-               attr_ctx = ibv_open_device(list[i]);
+               attr_ctx = mlx4_glue->open_device(list[i]);
                err = errno;
                break;
        }
        if (attr_ctx == NULL) {
-               ibv_free_device_list(list);
+               mlx4_glue->free_device_list(list);
                switch (err) {
                case 0:
                        rte_errno = ENODEV;
@@ -493,7 +469,7 @@ mlx4_pci_probe(struct rte_pci_driver *pci_drv, struct rte_pci_device *pci_dev)
        }
        ibv_dev = list[i];
        DEBUG("device opened");
-       if (ibv_query_device(attr_ctx, &device_attr)) {
+       if (mlx4_glue->query_device(attr_ctx, &device_attr)) {
                rte_errno = ENODEV;
                goto error;
        }
@@ -508,7 +484,7 @@ mlx4_pci_probe(struct rte_pci_driver *pci_drv, struct rte_pci_device *pci_dev)
        if (!conf.ports.enabled)
                conf.ports.enabled = conf.ports.present;
        /* Retrieve extended device attributes. */
-       if (ibv_query_device_ex(attr_ctx, NULL, &device_attr_ex)) {
+       if (mlx4_glue->query_device_ex(attr_ctx, NULL, &device_attr_ex)) {
                rte_errno = ENODEV;
                goto error;
        }
@@ -526,13 +502,13 @@ mlx4_pci_probe(struct rte_pci_driver *pci_drv, struct rte_pci_device *pci_dev)
                if (!(conf.ports.enabled & (1 << i)))
                        continue;
                DEBUG("using port %u", port);
-               ctx = ibv_open_device(ibv_dev);
+               ctx = mlx4_glue->open_device(ibv_dev);
                if (ctx == NULL) {
                        rte_errno = ENODEV;
                        goto port_error;
                }
                /* Check port status. */
-               err = ibv_query_port(ctx, port, &port_attr);
+               err = mlx4_glue->query_port(ctx, port, &port_attr);
                if (err) {
                        rte_errno = err;
                        ERROR("port query failed: %s", strerror(rte_errno));
@@ -546,7 +522,7 @@ mlx4_pci_probe(struct rte_pci_driver *pci_drv, struct rte_pci_device *pci_dev)
                }
                if (port_attr.state != IBV_PORT_ACTIVE)
                        DEBUG("port %d is not active: \"%s\" (%d)",
-                             port, ibv_port_state_str(port_attr.state),
+                             port, mlx4_glue->port_state_str(port_attr.state),
                              port_attr.state);
                /* Make asynchronous FD non-blocking to handle interrupts. */
                if (mlx4_fd_set_non_blocking(ctx->async_fd) < 0) {
@@ -555,7 +531,7 @@ mlx4_pci_probe(struct rte_pci_driver *pci_drv, struct rte_pci_device *pci_dev)
                        goto port_error;
                }
                /* Allocate protection domain. */
-               pd = ibv_alloc_pd(ctx);
+               pd = mlx4_glue->alloc_pd(ctx);
                if (pd == NULL) {
                        rte_errno = ENOMEM;
                        ERROR("PD allocation failure");
@@ -634,7 +610,7 @@ mlx4_pci_probe(struct rte_pci_driver *pci_drv, struct rte_pci_device *pci_dev)
                        char name[RTE_ETH_NAME_MAX_LEN];
 
                        snprintf(name, sizeof(name), "%s port %u",
-                                ibv_get_device_name(ibv_dev), port);
+                                mlx4_glue->get_device_name(ibv_dev), port);
                        eth_dev = rte_eth_dev_allocate(name);
                }
                if (eth_dev == NULL) {
@@ -677,9 +653,9 @@ mlx4_pci_probe(struct rte_pci_driver *pci_drv, struct rte_pci_device *pci_dev)
 port_error:
                rte_free(priv);
                if (pd)
-                       claim_zero(ibv_dealloc_pd(pd));
+                       claim_zero(mlx4_glue->dealloc_pd(pd));
                if (ctx)
-                       claim_zero(ibv_close_device(ctx));
+                       claim_zero(mlx4_glue->close_device(ctx));
                if (eth_dev)
                        rte_eth_dev_release_port(eth_dev);
                break;
@@ -694,9 +670,9 @@ port_error:
         */
 error:
        if (attr_ctx)
-               claim_zero(ibv_close_device(attr_ctx));
+               claim_zero(mlx4_glue->close_device(attr_ctx));
        if (list)
-               ibv_free_device_list(list);
+               mlx4_glue->free_device_list(list);
        assert(rte_errno >= 0);
        return -rte_errno;
 }
@@ -729,6 +705,136 @@ static struct rte_pci_driver mlx4_driver = {
                     RTE_PCI_DRV_INTR_RMV,
 };
 
+#ifdef RTE_LIBRTE_MLX4_DLOPEN_DEPS
+
+/**
+ * Suffix RTE_EAL_PMD_PATH with "-glue".
+ *
+ * This function performs a sanity check on RTE_EAL_PMD_PATH before
+ * suffixing its last component.
+ *
+ * @param buf[out]
+ *   Output buffer, should be large enough otherwise NULL is returned.
+ * @param size
+ *   Size of @p out.
+ *
+ * @return
+ *   Pointer to @p buf or @p NULL in case suffix cannot be appended.
+ */
+static char *
+mlx4_glue_path(char *buf, size_t size)
+{
+       static const char *const bad[] = { "/", ".", "..", NULL };
+       const char *path = RTE_EAL_PMD_PATH;
+       size_t len = strlen(path);
+       size_t off;
+       int i;
+
+       while (len && path[len - 1] == '/')
+               --len;
+       for (off = len; off && path[off - 1] != '/'; --off)
+               ;
+       for (i = 0; bad[i]; ++i)
+               if (!strncmp(path + off, bad[i], (int)(len - off)))
+                       goto error;
+       i = snprintf(buf, size, "%.*s-glue", (int)len, path);
+       if (i == -1 || (size_t)i >= size)
+               goto error;
+       return buf;
+error:
+       ERROR("unable to append \"-glue\" to last component of"
+             " RTE_EAL_PMD_PATH (\"" RTE_EAL_PMD_PATH "\"),"
+             " please re-configure DPDK");
+       return NULL;
+}
+
+/**
+ * Initialization routine for run-time dependency on rdma-core.
+ */
+static int
+mlx4_glue_init(void)
+{
+       char glue_path[sizeof(RTE_EAL_PMD_PATH) - 1 + sizeof("-glue")];
+       const char *path[] = {
+               /*
+                * A basic security check is necessary before trusting
+                * MLX4_GLUE_PATH, which may override RTE_EAL_PMD_PATH.
+                */
+               (geteuid() == getuid() && getegid() == getgid() ?
+                getenv("MLX4_GLUE_PATH") : NULL),
+               /*
+                * When RTE_EAL_PMD_PATH is set, use its glue-suffixed
+                * variant, otherwise let dlopen() look up libraries on its
+                * own.
+                */
+               (*RTE_EAL_PMD_PATH ?
+                mlx4_glue_path(glue_path, sizeof(glue_path)) : ""),
+       };
+       unsigned int i = 0;
+       void *handle = NULL;
+       void **sym;
+       const char *dlmsg;
+
+       while (!handle && i != RTE_DIM(path)) {
+               const char *end;
+               size_t len;
+               int ret;
+
+               if (!path[i]) {
+                       ++i;
+                       continue;
+               }
+               end = strpbrk(path[i], ":;");
+               if (!end)
+                       end = path[i] + strlen(path[i]);
+               len = end - path[i];
+               ret = 0;
+               do {
+                       char name[ret + 1];
+
+                       ret = snprintf(name, sizeof(name), "%.*s%s" MLX4_GLUE,
+                                      (int)len, path[i],
+                                      (!len || *(end - 1) == '/') ? "" : "/");
+                       if (ret == -1)
+                               break;
+                       if (sizeof(name) != (size_t)ret + 1)
+                               continue;
+                       DEBUG("looking for rdma-core glue as \"%s\"", name);
+                       handle = dlopen(name, RTLD_LAZY);
+                       break;
+               } while (1);
+               path[i] = end + 1;
+               if (!*end)
+                       ++i;
+       }
+       if (!handle) {
+               rte_errno = EINVAL;
+               dlmsg = dlerror();
+               if (dlmsg)
+                       WARN("cannot load glue library: %s", dlmsg);
+               goto glue_error;
+       }
+       sym = dlsym(handle, "mlx4_glue");
+       if (!sym || !*sym) {
+               rte_errno = EINVAL;
+               dlmsg = dlerror();
+               if (dlmsg)
+                       ERROR("cannot resolve glue symbol: %s", dlmsg);
+               goto glue_error;
+       }
+       mlx4_glue = *sym;
+       return 0;
+glue_error:
+       if (handle)
+               dlclose(handle);
+       WARN("cannot initialize PMD due to missing run-time"
+            " dependency on rdma-core libraries (libibverbs,"
+            " libmlx4)");
+       return -rte_errno;
+}
+
+#endif
+
 /**
  * Driver initialization routine.
  */
@@ -749,7 +855,26 @@ rte_mlx4_pmd_init(void)
         * using this PMD, which is not supported in forked processes.
         */
        setenv("RDMAV_HUGEPAGES_SAFE", "1", 1);
-       ibv_fork_init();
+#ifdef RTE_LIBRTE_MLX4_DLOPEN_DEPS
+       if (mlx4_glue_init())
+               return;
+       assert(mlx4_glue);
+#endif
+#ifndef NDEBUG
+       /* Glue structure must not contain any NULL pointers. */
+       {
+               unsigned int i;
+
+               for (i = 0; i != sizeof(*mlx4_glue) / sizeof(void *); ++i)
+                       assert(((const void *const *)mlx4_glue)[i]);
+       }
+#endif
+       if (strcmp(mlx4_glue->version, MLX4_GLUE_VERSION)) {
+               ERROR("rdma-core glue \"%s\" mismatch: \"%s\" is required",
+                     mlx4_glue->version, MLX4_GLUE_VERSION);
+               return;
+       }
+       mlx4_glue->fork_init();
        rte_pci_register(&mlx4_driver);
 }