eal: use SPDX tags in 6WIND copyrighted files
[dpdk.git] / lib / librte_eal / common / eal_common_devargs.c
index 3aace08..810b3e1 100644 (file)
-/*-
- *   BSD LICENSE
- *
- *   Copyright 2014 6WIND S.A.
- *
- *   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 2014 6WIND S.A.
  */
 
 /* This file manages the list of devices and their arguments, as given
- * by the user at startup */
+ * by the user at startup
+ *
+ * Code here should not call rte_log since the EAL environment
+ * may not be initialized.
+ */
 
+#include <stdio.h>
 #include <string.h>
 
-#include <rte_log.h>
-#include <rte_pci.h>
+#include <rte_compat.h>
+#include <rte_dev.h>
 #include <rte_devargs.h>
+#include <rte_tailq.h>
 #include "eal_private.h"
 
 /** Global list of user devices */
 struct rte_devargs_list devargs_list =
        TAILQ_HEAD_INITIALIZER(devargs_list);
 
-/* store a whitelist parameter for later parsing */
 int
-rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str)
+rte_eal_parse_devargs_str(const char *devargs_str,
+                       char **drvname, char **drvargs)
 {
-       struct rte_devargs *devargs = NULL;
-       char *buf = NULL;
        char *sep;
-       int ret;
 
-       /* use malloc instead of rte_malloc as it's called early at init */
-       devargs = malloc(sizeof(*devargs));
-       if (devargs == NULL) {
-               RTE_LOG(ERR, EAL, "cannot allocate devargs\n");
-               goto fail;
-       }
-       memset(devargs, 0, sizeof(*devargs));
-       devargs->type = devtype;
+       if ((devargs_str) == NULL || (drvname) == NULL || (drvargs == NULL))
+               return -1;
 
-       buf = strdup(devargs_str);
-       if (buf == NULL) {
-               RTE_LOG(ERR, EAL, "cannot allocate temp memory for devargs\n");
-               goto fail;
-       }
+       *drvname = strdup(devargs_str);
+       if (*drvname == NULL)
+               return -1;
 
        /* set the first ',' to '\0' to split name and arguments */
-       sep = strchr(buf, ',');
+       sep = strchr(*drvname, ',');
        if (sep != NULL) {
                sep[0] = '\0';
-               devargs->args = strdup(sep + 1);
-               if (devargs->args == NULL) {
-                       RTE_LOG(ERR, EAL, "cannot allocate for devargs args\n");
-                       goto fail;
-               }
+               *drvargs = strdup(sep + 1);
+       } else {
+               *drvargs = strdup("");
        }
 
-       switch (devargs->type) {
-       case RTE_DEVTYPE_WHITELISTED_PCI:
-       case RTE_DEVTYPE_BLACKLISTED_PCI:
-               /* try to parse pci identifier */
-               if (eal_parse_pci_BDF(buf, &devargs->pci.addr) != 0 &&
-                   eal_parse_pci_DomBDF(buf, &devargs->pci.addr) != 0) {
-                       RTE_LOG(ERR, EAL, "invalid PCI identifier <%s>\n", buf);
-                       goto fail;
+       if (*drvargs == NULL) {
+               free(*drvname);
+               *drvname = NULL;
+               return -1;
+       }
+       return 0;
+}
+
+static int
+bus_name_cmp(const struct rte_bus *bus, const void *name)
+{
+       return strncmp(bus->name, name, strlen(bus->name));
+}
+
+int __rte_experimental
+rte_eal_devargs_parse(const char *dev, struct rte_devargs *da)
+{
+       struct rte_bus *bus = NULL;
+       const char *devname;
+       const size_t maxlen = sizeof(da->name);
+       size_t i;
+
+       if (dev == NULL || da == NULL)
+               return -EINVAL;
+       /* Retrieve eventual bus info */
+       do {
+               devname = dev;
+               bus = rte_bus_find(bus, bus_name_cmp, dev);
+               if (bus == NULL)
+                       break;
+               devname = dev + strlen(bus->name) + 1;
+               if (rte_bus_find_by_device_name(devname) == bus)
+                       break;
+       } while (1);
+       /* Store device name */
+       i = 0;
+       while (devname[i] != '\0' && devname[i] != ',') {
+               da->name[i] = devname[i];
+               i++;
+               if (i == maxlen) {
+                       fprintf(stderr, "WARNING: Parsing \"%s\": device name should be shorter than %zu\n",
+                               dev, maxlen);
+                       da->name[i - 1] = '\0';
+                       return -EINVAL;
                }
-               break;
-       case RTE_DEVTYPE_VIRTUAL:
-               /* save driver name */
-               ret = snprintf(devargs->virtual.drv_name,
-                              sizeof(devargs->virtual.drv_name), "%s", buf);
-               if (ret < 0 || ret >= (int)sizeof(devargs->virtual.drv_name)) {
-                       RTE_LOG(ERR, EAL, "driver name too large: <%s>\n", buf);
-                       goto fail;
+       }
+       da->name[i] = '\0';
+       if (bus == NULL) {
+               bus = rte_bus_find_by_device_name(da->name);
+               if (bus == NULL) {
+                       fprintf(stderr, "ERROR: failed to parse device \"%s\"\n",
+                               da->name);
+                       return -EFAULT;
                }
-               break;
        }
+       da->bus = bus;
+       /* Parse eventual device arguments */
+       if (devname[i] == ',')
+               da->args = strdup(&devname[i + 1]);
+       else
+               da->args = strdup("");
+       if (da->args == NULL) {
+               fprintf(stderr, "ERROR: not enough memory to parse arguments\n");
+               return -ENOMEM;
+       }
+       return 0;
+}
+
+int __rte_experimental
+rte_eal_devargs_insert(struct rte_devargs *da)
+{
+       int ret;
+
+       ret = rte_eal_devargs_remove(da->bus->name, da->name);
+       if (ret < 0)
+               return ret;
+       TAILQ_INSERT_TAIL(&devargs_list, da, next);
+       return 0;
+}
+
+/* store a whitelist parameter for later parsing */
+int
+rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str)
+{
+       struct rte_devargs *devargs = NULL;
+       struct rte_bus *bus = NULL;
+       const char *dev = devargs_str;
 
-       free(buf);
+       /* use calloc instead of rte_zmalloc as it's called early at init */
+       devargs = calloc(1, sizeof(*devargs));
+       if (devargs == NULL)
+               goto fail;
+
+       if (rte_eal_devargs_parse(dev, devargs))
+               goto fail;
+       devargs->type = devtype;
+       bus = devargs->bus;
+       if (devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI)
+               devargs->policy = RTE_DEV_BLACKLISTED;
+       if (bus->conf.scan_mode == RTE_BUS_SCAN_UNDEFINED) {
+               if (devargs->policy == RTE_DEV_WHITELISTED)
+                       bus->conf.scan_mode = RTE_BUS_SCAN_WHITELIST;
+               else if (devargs->policy == RTE_DEV_BLACKLISTED)
+                       bus->conf.scan_mode = RTE_BUS_SCAN_BLACKLIST;
+       }
        TAILQ_INSERT_TAIL(&devargs_list, devargs, next);
        return 0;
 
 fail:
-       if (devargs->args)
+       if (devargs) {
                free(devargs->args);
-       if (buf)
-               free(buf);
-       if (devargs)
                free(devargs);
+       }
+
        return -1;
 }
 
+int __rte_experimental
+rte_eal_devargs_remove(const char *busname, const char *devname)
+{
+       struct rte_devargs *d;
+       void *tmp;
+
+       TAILQ_FOREACH_SAFE(d, &devargs_list, next, tmp) {
+               if (strcmp(d->bus->name, busname) == 0 &&
+                   strcmp(d->name, devname) == 0) {
+                       TAILQ_REMOVE(&devargs_list, d, next);
+                       free(d->args);
+                       free(d);
+                       return 0;
+               }
+       }
+       return 1;
+}
+
 /* count the number of devices of a specified type */
 unsigned int
 rte_eal_devargs_type_count(enum rte_devtype devtype)
@@ -135,27 +200,10 @@ rte_eal_devargs_dump(FILE *f)
 {
        struct rte_devargs *devargs;
 
-       fprintf(f, "User device white list:\n");
+       fprintf(f, "User device list:\n");
        TAILQ_FOREACH(devargs, &devargs_list, next) {
-               if (devargs->type == RTE_DEVTYPE_WHITELISTED_PCI)
-                       fprintf(f, "  PCI whitelist " PCI_PRI_FMT " %s\n",
-                              devargs->pci.addr.domain,
-                              devargs->pci.addr.bus,
-                              devargs->pci.addr.devid,
-                              devargs->pci.addr.function,
-                              devargs->args);
-               else if (devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI)
-                       fprintf(f, "  PCI blacklist " PCI_PRI_FMT " %s\n",
-                              devargs->pci.addr.domain,
-                              devargs->pci.addr.bus,
-                              devargs->pci.addr.devid,
-                              devargs->pci.addr.function,
-                              devargs->args);
-               else if (devargs->type == RTE_DEVTYPE_VIRTUAL)
-                       fprintf(f, "  VIRTUAL %s %s\n",
-                              devargs->virtual.drv_name,
-                              devargs->args);
-               else
-                       fprintf(f, "  UNKNOWN %s\n", devargs->args);
+               fprintf(f, "  [%s]: %s %s\n",
+                       (devargs->bus ? devargs->bus->name : "??"),
+                       devargs->name, devargs->args);
        }
 }