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 __rte_experimental
  67 int
  68 rte_devargs_parse(struct rte_devargs *da, const char *dev)
  69 {
  70         struct rte_bus *bus = NULL;
  71         const char *devname;
  72         const size_t maxlen = sizeof(da->name);
  73         size_t i;
  74
  75         if (da == NULL)
  76                 return -EINVAL;
  77
  78         /* Retrieve eventual bus info */
  79         do {
  80                 devname = dev;
  81                 bus = rte_bus_find(bus, bus_name_cmp, dev);
  82                 if (bus == NULL)
  83                         break;
  84                 devname = dev + strlen(bus->name) + 1;
  85                 if (rte_bus_find_by_device_name(devname) == bus)
  86                         break;
  87         } while (1);
  88         /* Store device name */
  89         i = 0;
  90         while (devname[i] != '\0' && devname[i] != ',') {
  91                 da->name[i] = devname[i];
  92                 i++;
  93                 if (i == maxlen) {
  94                         RTE_LOG(WARNING, EAL, "Parsing \"%s\": device name should be shorter than %zu\n",
  95                                 dev, maxlen);
  96                         da->name[i - 1] = '\0';
  97                         return -EINVAL;
  98                 }
  99         }
 100         da->name[i] = '\0';
 101         if (bus == NULL) {
 102                 bus = rte_bus_find_by_device_name(da->name);
 103                 if (bus == NULL) {
 104                         RTE_LOG(ERR, EAL, "failed to parse device \"%s\"\n",
 105                                 da->name);
 106                         return -EFAULT;
 107                 }
 108         }
 109         da->bus = bus;
 110         /* Parse eventual device arguments */
 111         if (devname[i] == ',')
 112                 da->args = strdup(&devname[i + 1]);
 113         else
 114                 da->args = strdup("");
 115         if (da->args == NULL) {
 116                 RTE_LOG(ERR, EAL, "not enough memory to parse arguments\n");
 117                 return -ENOMEM;
 118         }
 119         return 0;
 120 }
 121
 122 __rte_experimental
 123 int
 124 rte_devargs_parsef(struct rte_devargs *da, const char *format, ...)
 125 {
 126         va_list ap;
 127         size_t len;
 128         char *dev;
 129
 130         if (da == NULL)
 131                 return -EINVAL;
 132
 133         va_start(ap, format);
 134         len = vsnprintf(NULL, 0, format, ap);
 135         va_end(ap);
 136
 137         dev = calloc(1, len + 1);
 138         if (dev == NULL) {
 139                 RTE_LOG(ERR, EAL, "not enough memory to parse device\n");
 140                 return -ENOMEM;
 141         }
 142
 143         va_start(ap, format);
 144         vsnprintf(dev, len, format, ap);
 145         va_end(ap);
 146
 147         return rte_devargs_parse(da, dev);
 148 }
 149
 150 int __rte_experimental
 151 rte_devargs_insert(struct rte_devargs *da)
 152 {
 153         int ret;
 154
 155         ret = rte_devargs_remove(da->bus->name, da->name);
 156         if (ret < 0)
 157                 return ret;
 158         TAILQ_INSERT_TAIL(&devargs_list, da, next);
 159         return 0;
 160 }
 161
 162 /* store a whitelist parameter for later parsing */
 163 __rte_experimental
 164 int
 165 rte_devargs_add(enum rte_devtype devtype, const char *devargs_str)
 166 {
 167         struct rte_devargs *devargs = NULL;
 168         struct rte_bus *bus = NULL;
 169         const char *dev = devargs_str;
 170
 171         /* use calloc instead of rte_zmalloc as it's called early at init */
 172         devargs = calloc(1, sizeof(*devargs));
 173         if (devargs == NULL)
 174                 goto fail;
 175
 176         if (rte_devargs_parse(devargs, dev))
 177                 goto fail;
 178         devargs->type = devtype;
 179         bus = devargs->bus;
 180         if (devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI)
 181                 devargs->policy = RTE_DEV_BLACKLISTED;
 182         if (bus->conf.scan_mode == RTE_BUS_SCAN_UNDEFINED) {
 183                 if (devargs->policy == RTE_DEV_WHITELISTED)
 184                         bus->conf.scan_mode = RTE_BUS_SCAN_WHITELIST;
 185                 else if (devargs->policy == RTE_DEV_BLACKLISTED)
 186                         bus->conf.scan_mode = RTE_BUS_SCAN_BLACKLIST;
 187         }
 188         TAILQ_INSERT_TAIL(&devargs_list, devargs, next);
 189         return 0;
 190
 191 fail:
 192         if (devargs) {
 193                 free(devargs->args);
 194                 free(devargs);
 195         }
 196
 197         return -1;
 198 }
 199
 200 int __rte_experimental
 201 rte_devargs_remove(const char *busname, const char *devname)
 202 {
 203         struct rte_devargs *d;
 204         void *tmp;
 205
 206         TAILQ_FOREACH_SAFE(d, &devargs_list, next, tmp) {
 207                 if (strcmp(d->bus->name, busname) == 0 &&
 208                     strcmp(d->name, devname) == 0) {
 209                         TAILQ_REMOVE(&devargs_list, d, next);
 210                         free(d->args);
 211                         free(d);
 212                         return 0;
 213                 }
 214         }
 215         return 1;
 216 }
 217
 218 /* count the number of devices of a specified type */
 219 __rte_experimental
 220 unsigned int
 221 rte_devargs_type_count(enum rte_devtype devtype)
 222 {
 223         struct rte_devargs *devargs;
 224         unsigned int count = 0;
 225
 226         TAILQ_FOREACH(devargs, &devargs_list, next) {
 227                 if (devargs->type != devtype)
 228                         continue;
 229                 count++;
 230         }
 231         return count;
 232 }
 233
 234 /* dump the user devices on the console */
 235 __rte_experimental
 236 void
 237 rte_devargs_dump(FILE *f)
 238 {
 239         struct rte_devargs *devargs;
 240
 241         fprintf(f, "User device list:\n");
 242         TAILQ_FOREACH(devargs, &devargs_list, next) {
 243                 fprintf(f, "  [%s]: %s %s\n",
 244                         (devargs->bus ? devargs->bus->name : "??"),
 245                         devargs->name, devargs->args);
 246         }
 247 }
 248
 249 /* bus-aware rte_devargs iterator. */
 250 __rte_experimental
 251 struct rte_devargs *
 252 rte_devargs_next(const char *busname, const struct rte_devargs *start)
 253 {
 254         struct rte_devargs *da;
 255
 256         if (start != NULL)
 257                 da = TAILQ_NEXT(start, next);
 258         else
 259                 da = TAILQ_FIRST(&devargs_list);
 260         while (da != NULL) {
 261                 if (busname == NULL ||
 262                     (strcmp(busname, da->bus->name) == 0))
 263                         return da;
 264                 da = TAILQ_NEXT(da, next);
 265         }
 266         return NULL;
 267 }