lib/librte_eal/common/eal_common_devargs.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2014 6WIND S.A.
   3  */
   4
   5 /* This file manages the list of devices and their arguments, as given
   6  * by the user at startup
   7  *
   8  * Code here should not call rte_log since the EAL environment
   9  * may not be initialized.
  10  */
  11
  12 #include <stdio.h>
  13 #include <string.h>
  14 #include <stdarg.h>
  15
  16 #include <rte_compat.h>
  17 #include <rte_dev.h>
  18 #include <rte_devargs.h>
  19 #include <rte_log.h>
  20 #include <rte_tailq.h>
  21 #include "eal_private.h"
  22
  23 /** user device double-linked queue type definition */
  24 TAILQ_HEAD(rte_devargs_list, rte_devargs);
  25
  26 /** Global list of user devices */
  27 struct rte_devargs_list devargs_list =
  28         TAILQ_HEAD_INITIALIZER(devargs_list);
  29
  30 int
  31 rte_eal_parse_devargs_str(const char *devargs_str,
  32                         char **drvname, char **drvargs)
  33 {
  34         char *sep;
  35
  36         if ((devargs_str) == NULL || (drvname) == NULL || (drvargs == NULL))
  37                 return -1;
  38
  39         *drvname = strdup(devargs_str);
  40         if (*drvname == NULL)
  41                 return -1;
  42
  43         /* set the first ',' to '\0' to split name and arguments */
  44         sep = strchr(*drvname, ',');
  45         if (sep != NULL) {
  46                 sep[0] = '\0';
  47                 *drvargs = strdup(sep + 1);
  48         } else {
  49                 *drvargs = strdup("");
  50         }
  51
  52         if (*drvargs == NULL) {
  53                 free(*drvname);
  54                 *drvname = NULL;
  55                 return -1;
  56         }
  57         return 0;
  58 }
  59
  60 static int
  61 bus_name_cmp(const struct rte_bus *bus, const void *name)
  62 {
  63         return strncmp(bus->name, name, strlen(bus->name));
  64 }
  65
  66 int __rte_experimental
  67 rte_devargs_parse(struct rte_devargs *da, const char *format, ...)
  68 {
  69         struct rte_bus *bus = NULL;
  70         va_list ap;
  71         va_start(ap, format);
  72         char dev[vsnprintf(NULL, 0, format, ap) + 1];
  73         const char *devname;
  74         const size_t maxlen = sizeof(da->name);
  75         size_t i;
  76
  77         va_end(ap);
  78         if (da == NULL)
  79                 return -EINVAL;
  80
  81         va_start(ap, format);
  82         vsnprintf(dev, sizeof(dev), format, ap);
  83         va_end(ap);
  84         /* Retrieve eventual bus info */
  85         do {
  86                 devname = dev;
  87                 bus = rte_bus_find(bus, bus_name_cmp, dev);
  88                 if (bus == NULL)
  89                         break;
  90                 devname = dev + strlen(bus->name) + 1;
  91                 if (rte_bus_find_by_device_name(devname) == bus)
  92                         break;
  93         } while (1);
  94         /* Store device name */
  95         i = 0;
  96         while (devname[i] != '\0' && devname[i] != ',') {
  97                 da->name[i] = devname[i];
  98                 i++;
  99                 if (i == maxlen) {
 100                         RTE_LOG(WARNING, EAL, "Parsing \"%s\": device name should be shorter than %zu\n",
 101                                 dev, maxlen);
 102                         da->name[i - 1] = '\0';
 103                         return -EINVAL;
 104                 }
 105         }
 106         da->name[i] = '\0';
 107         if (bus == NULL) {
 108                 bus = rte_bus_find_by_device_name(da->name);
 109                 if (bus == NULL) {
 110                         RTE_LOG(ERR, EAL, "failed to parse device \"%s\"\n",
 111                                 da->name);
 112                         return -EFAULT;
 113                 }
 114         }
 115         da->bus = bus;
 116         /* Parse eventual device arguments */
 117         if (devname[i] == ',')
 118                 da->args = strdup(&devname[i + 1]);
 119         else
 120                 da->args = strdup("");
 121         if (da->args == NULL) {
 122                 RTE_LOG(ERR, EAL, "not enough memory to parse arguments\n");
 123                 return -ENOMEM;
 124         }
 125         return 0;
 126 }
 127
 128 int __rte_experimental
 129 rte_devargs_insert(struct rte_devargs *da)
 130 {
 131         int ret;
 132
 133         ret = rte_devargs_remove(da->bus->name, da->name);
 134         if (ret < 0)
 135                 return ret;
 136         TAILQ_INSERT_TAIL(&devargs_list, da, next);
 137         return 0;
 138 }
 139
 140 /* store a whitelist parameter for later parsing */
 141 __rte_experimental
 142 int
 143 rte_devargs_add(enum rte_devtype devtype, const char *devargs_str)
 144 {
 145         struct rte_devargs *devargs = NULL;
 146         struct rte_bus *bus = NULL;
 147         const char *dev = devargs_str;
 148
 149         /* use calloc instead of rte_zmalloc as it's called early at init */
 150         devargs = calloc(1, sizeof(*devargs));
 151         if (devargs == NULL)
 152                 goto fail;
 153
 154         if (rte_devargs_parse(devargs, "%s", dev))
 155                 goto fail;
 156         devargs->type = devtype;
 157         bus = devargs->bus;
 158         if (devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI)
 159                 devargs->policy = RTE_DEV_BLACKLISTED;
 160         if (bus->conf.scan_mode == RTE_BUS_SCAN_UNDEFINED) {
 161                 if (devargs->policy == RTE_DEV_WHITELISTED)
 162                         bus->conf.scan_mode = RTE_BUS_SCAN_WHITELIST;
 163                 else if (devargs->policy == RTE_DEV_BLACKLISTED)
 164                         bus->conf.scan_mode = RTE_BUS_SCAN_BLACKLIST;
 165         }
 166         TAILQ_INSERT_TAIL(&devargs_list, devargs, next);
 167         return 0;
 168
 169 fail:
 170         if (devargs) {
 171                 free(devargs->args);
 172                 free(devargs);
 173         }
 174
 175         return -1;
 176 }
 177
 178 int __rte_experimental
 179 rte_devargs_remove(const char *busname, const char *devname)
 180 {
 181         struct rte_devargs *d;
 182         void *tmp;
 183
 184         TAILQ_FOREACH_SAFE(d, &devargs_list, next, tmp) {
 185                 if (strcmp(d->bus->name, busname) == 0 &&
 186                     strcmp(d->name, devname) == 0) {
 187                         TAILQ_REMOVE(&devargs_list, d, next);
 188                         free(d->args);
 189                         free(d);
 190                         return 0;
 191                 }
 192         }
 193         return 1;
 194 }
 195
 196 /* count the number of devices of a specified type */
 197 __rte_experimental
 198 unsigned int
 199 rte_devargs_type_count(enum rte_devtype devtype)
 200 {
 201         struct rte_devargs *devargs;
 202         unsigned int count = 0;
 203
 204         TAILQ_FOREACH(devargs, &devargs_list, next) {
 205                 if (devargs->type != devtype)
 206                         continue;
 207                 count++;
 208         }
 209         return count;
 210 }
 211
 212 /* dump the user devices on the console */
 213 __rte_experimental
 214 void
 215 rte_devargs_dump(FILE *f)
 216 {
 217         struct rte_devargs *devargs;
 218
 219         fprintf(f, "User device list:\n");
 220         TAILQ_FOREACH(devargs, &devargs_list, next) {
 221                 fprintf(f, "  [%s]: %s %s\n",
 222                         (devargs->bus ? devargs->bus->name : "??"),
 223                         devargs->name, devargs->args);
 224         }
 225 }
 226
 227 /* bus-aware rte_devargs iterator. */
 228 __rte_experimental
 229 struct rte_devargs *
 230 rte_devargs_next(const char *busname, const struct rte_devargs *start)
 231 {
 232         struct rte_devargs *da;
 233
 234         if (start != NULL)
 235                 da = TAILQ_NEXT(start, next);
 236         else
 237                 da = TAILQ_FIRST(&devargs_list);
 238         while (da != NULL) {
 239                 if (busname == NULL ||
 240                     (strcmp(busname, da->bus->name) == 0))
 241                         return da;
 242                 da = TAILQ_NEXT(da, next);
 243         }
 244         return NULL;
 245 }