lib/librte_eal/common/eal_common_devargs.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2014 6WIND S.A.
   5  *
   6  *   Redistribution and use in source and binary forms, with or without
   7  *   modification, are permitted provided that the following conditions
   8  *   are met:
   9  *
  10  *     * Redistributions of source code must retain the above copyright
  11  *       notice, this list of conditions and the following disclaimer.
  12  *     * Redistributions in binary form must reproduce the above copyright
  13  *       notice, this list of conditions and the following disclaimer in
  14  *       the documentation and/or other materials provided with the
  15  *       distribution.
  16  *     * Neither the name of 6WIND S.A nor the names of its contributors
  17  *       may be used to endorse or promote products derived from this
  18  *       software without specific prior written permission.
  19  *
  20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 /* This file manages the list of devices and their arguments, as given
  34  * by the user at startup
  35  *
  36  * Code here should not call rte_log since the EAL environment
  37  * may not be initialized.
  38  */
  39
  40 #include <stdio.h>
  41 #include <string.h>
  42
  43 #include <rte_pci.h>
  44 #include <rte_devargs.h>
  45 #include "eal_private.h"
  46
  47 /** Global list of user devices */
  48 struct rte_devargs_list devargs_list =
  49         TAILQ_HEAD_INITIALIZER(devargs_list);
  50
  51 int
  52 rte_eal_parse_devargs_str(const char *devargs_str,
  53                         char **drvname, char **drvargs)
  54 {
  55         char *sep;
  56
  57         if ((devargs_str) == NULL || (drvname) == NULL || (drvargs == NULL))
  58                 return -1;
  59
  60         *drvname = strdup(devargs_str);
  61         if (*drvname == NULL)
  62                 return -1;
  63
  64         /* set the first ',' to '\0' to split name and arguments */
  65         sep = strchr(*drvname, ',');
  66         if (sep != NULL) {
  67                 sep[0] = '\0';
  68                 *drvargs = strdup(sep + 1);
  69         } else {
  70                 *drvargs = strdup("");
  71         }
  72
  73         if (*drvargs == NULL) {
  74                 free(*drvname);
  75                 *drvname = NULL;
  76                 return -1;
  77         }
  78         return 0;
  79 }
  80
  81 static int
  82 bus_name_cmp(const struct rte_bus *bus, const void *name)
  83 {
  84         return strncmp(bus->name, name, strlen(bus->name));
  85 }
  86
  87 /* store a whitelist parameter for later parsing */
  88 int
  89 rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str)
  90 {
  91         struct rte_devargs *devargs = NULL;
  92         struct rte_bus *bus = NULL;
  93         char *dev = NULL;
  94         const char *devname;
  95         int ret;
  96
  97         /* use malloc instead of rte_malloc as it's called early at init */
  98         devargs = malloc(sizeof(*devargs));
  99         if (devargs == NULL)
 100                 goto fail;
 101
 102         memset(devargs, 0, sizeof(*devargs));
 103         devargs->type = devtype;
 104
 105         if (rte_eal_parse_devargs_str(devargs_str, &dev, &devargs->args))
 106                 goto fail;
 107         devname = dev;
 108         do {
 109                 bus = rte_bus_find(bus, bus_name_cmp, dev);
 110                 if (bus == NULL)
 111                         break;
 112                 devname = dev + strlen(bus->name) + 1;
 113                 if (rte_bus_find_by_device_name(devname) == bus)
 114                         break;
 115                 devname = dev;
 116         } while (1);
 117         if (bus == NULL) {
 118                 bus = rte_bus_find_by_device_name(devname);
 119                 if (bus == NULL) {
 120                         fprintf(stderr, "ERROR: failed to parse bus info from device declaration\n");
 121                         goto fail;
 122                 }
 123         }
 124         devargs->bus = bus;
 125
 126         switch (devargs->type) {
 127         case RTE_DEVTYPE_WHITELISTED_PCI:
 128         case RTE_DEVTYPE_BLACKLISTED_PCI:
 129                 /* try to parse pci identifier */
 130                 if (bus->parse(devname, &devargs->pci.addr) != 0)
 131                         goto fail;
 132
 133                 break;
 134         case RTE_DEVTYPE_VIRTUAL:
 135                 /* save driver name */
 136                 ret = snprintf(devargs->virt.drv_name,
 137                                sizeof(devargs->virt.drv_name), "%s", devname);
 138                 if (ret < 0 || ret >= (int)sizeof(devargs->virt.drv_name))
 139                         goto fail;
 140
 141                 break;
 142         }
 143         if (devargs->type == RTE_DEVTYPE_WHITELISTED_PCI) {
 144                 if (bus->conf.scan_mode == RTE_BUS_SCAN_UNDEFINED) {
 145                         bus->conf.scan_mode = RTE_BUS_SCAN_WHITELIST;
 146                 } else if (bus->conf.scan_mode == RTE_BUS_SCAN_BLACKLIST) {
 147                         fprintf(stderr, "ERROR: incompatible device type and bus scan mode\n");
 148                         goto fail;
 149                 }
 150         } else if (devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI) {
 151                 if (bus->conf.scan_mode == RTE_BUS_SCAN_UNDEFINED) {
 152                         bus->conf.scan_mode = RTE_BUS_SCAN_BLACKLIST;
 153                 } else if (bus->conf.scan_mode == RTE_BUS_SCAN_WHITELIST) {
 154                         fprintf(stderr, "ERROR: incompatible device type and bus scan mode\n");
 155                         goto fail;
 156                 }
 157         }
 158
 159         free(dev);
 160         TAILQ_INSERT_TAIL(&devargs_list, devargs, next);
 161         return 0;
 162
 163 fail:
 164         free(dev);
 165         if (devargs) {
 166                 free(devargs->args);
 167                 free(devargs);
 168         }
 169
 170         return -1;
 171 }
 172
 173 /* count the number of devices of a specified type */
 174 unsigned int
 175 rte_eal_devargs_type_count(enum rte_devtype devtype)
 176 {
 177         struct rte_devargs *devargs;
 178         unsigned int count = 0;
 179
 180         TAILQ_FOREACH(devargs, &devargs_list, next) {
 181                 if (devargs->type != devtype)
 182                         continue;
 183                 count++;
 184         }
 185         return count;
 186 }
 187
 188 /* dump the user devices on the console */
 189 void
 190 rte_eal_devargs_dump(FILE *f)
 191 {
 192         struct rte_devargs *devargs;
 193
 194         fprintf(f, "User device white list:\n");
 195         TAILQ_FOREACH(devargs, &devargs_list, next) {
 196                 if (devargs->type == RTE_DEVTYPE_WHITELISTED_PCI)
 197                         fprintf(f, "  PCI whitelist " PCI_PRI_FMT " %s\n",
 198                                devargs->pci.addr.domain,
 199                                devargs->pci.addr.bus,
 200                                devargs->pci.addr.devid,
 201                                devargs->pci.addr.function,
 202                                devargs->args);
 203                 else if (devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI)
 204                         fprintf(f, "  PCI blacklist " PCI_PRI_FMT " %s\n",
 205                                devargs->pci.addr.domain,
 206                                devargs->pci.addr.bus,
 207                                devargs->pci.addr.devid,
 208                                devargs->pci.addr.function,
 209                                devargs->args);
 210                 else if (devargs->type == RTE_DEVTYPE_VIRTUAL)
 211                         fprintf(f, "  VIRTUAL %s %s\n",
 212                                devargs->virt.drv_name,
 213                                devargs->args);
 214                 else
 215                         fprintf(f, "  UNKNOWN %s\n", devargs->args);
 216         }
 217 }