lib/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
   9 #include <stdio.h>
  10 #include <string.h>
  11 #include <stdarg.h>
  12
  13 #include <rte_bus.h>
  14 #include <rte_class.h>
  15 #include <rte_compat.h>
  16 #include <rte_dev.h>
  17 #include <rte_devargs.h>
  18 #include <rte_errno.h>
  19 #include <rte_kvargs.h>
  20 #include <rte_log.h>
  21 #include <rte_tailq.h>
  22 #include <rte_string_fns.h>
  23 #include "eal_private.h"
  24
  25 /** user device double-linked queue type definition */
  26 TAILQ_HEAD(rte_devargs_list, rte_devargs);
  27
  28 /** Global list of user devices */
  29 static struct rte_devargs_list devargs_list =
  30         TAILQ_HEAD_INITIALIZER(devargs_list);
  31
  32 static size_t
  33 devargs_layer_count(const char *s)
  34 {
  35         size_t i = s ? 1 : 0;
  36
  37         while (s != NULL && s[0] != '\0') {
  38                 i += s[0] == '/';
  39                 s++;
  40         }
  41         return i;
  42 }
  43
  44 /* Resolve devargs name from bus arguments. */
  45 static int
  46 devargs_bus_parse_default(struct rte_devargs *devargs,
  47                           struct rte_kvargs *bus_args)
  48 {
  49         const char *name;
  50
  51         /* Parse devargs name from bus key-value list. */
  52         name = rte_kvargs_get(bus_args, "name");
  53         if (name == NULL) {
  54                 RTE_LOG(INFO, EAL, "devargs name not found: %s\n",
  55                         devargs->data);
  56                 return 0;
  57         }
  58         if (rte_strscpy(devargs->name, name, sizeof(devargs->name)) < 0) {
  59                 RTE_LOG(ERR, EAL, "devargs name too long: %s\n",
  60                         devargs->data);
  61                 return -E2BIG;
  62         }
  63         return 0;
  64 }
  65
  66 int
  67 rte_devargs_layers_parse(struct rte_devargs *devargs,
  68                          const char *devstr)
  69 {
  70         struct {
  71                 const char *key;
  72                 const char *str;
  73                 struct rte_kvargs *kvlist;
  74         } layers[] = {
  75                 { RTE_DEVARGS_KEY_BUS "=",    NULL, NULL, },
  76                 { RTE_DEVARGS_KEY_CLASS "=",  NULL, NULL, },
  77                 { RTE_DEVARGS_KEY_DRIVER "=", NULL, NULL, },
  78         };
  79         struct rte_kvargs_pair *kv = NULL;
  80         struct rte_class *cls = NULL;
  81         struct rte_bus *bus = NULL;
  82         const char *s = devstr;
  83         size_t nblayer;
  84         size_t i = 0;
  85         int ret = 0;
  86         bool allocated_data = false;
  87
  88         /* Split each sub-lists. */
  89         nblayer = devargs_layer_count(devstr);
  90         if (nblayer > RTE_DIM(layers)) {
  91                 RTE_LOG(ERR, EAL, "Invalid format: too many layers (%zu)\n",
  92                         nblayer);
  93                 ret = -E2BIG;
  94                 goto get_out;
  95         }
  96
  97         /* If the devargs points the devstr
  98          * as source data, then it should not allocate
  99          * anything and keep referring only to it.
 100          */
 101         if (devargs->data != devstr) {
 102                 devargs->data = strdup(devstr);
 103                 if (devargs->data == NULL) {
 104                         RTE_LOG(ERR, EAL, "OOM\n");
 105                         ret = -ENOMEM;
 106                         goto get_out;
 107                 }
 108                 allocated_data = true;
 109                 s = devargs->data;
 110         }
 111
 112         while (s != NULL) {
 113                 if (i >= RTE_DIM(layers)) {
 114                         RTE_LOG(ERR, EAL, "Unrecognized layer %s\n", s);
 115                         ret = -EINVAL;
 116                         goto get_out;
 117                 }
 118                 /*
 119                  * The last layer is free-form.
 120                  * The "driver" key is not required (but accepted).
 121                  */
 122                 if (strncmp(layers[i].key, s, strlen(layers[i].key)) &&
 123                                 i != RTE_DIM(layers) - 1)
 124                         goto next_layer;
 125                 layers[i].str = s;
 126                 layers[i].kvlist = rte_kvargs_parse_delim(s, NULL, "/");
 127                 if (layers[i].kvlist == NULL) {
 128                         RTE_LOG(ERR, EAL, "Could not parse %s\n", s);
 129                         ret = -EINVAL;
 130                         goto get_out;
 131                 }
 132                 s = strchr(s, '/');
 133                 if (s != NULL)
 134                         s++;
 135 next_layer:
 136                 i++;
 137         }
 138
 139         /* Parse each sub-list. */
 140         for (i = 0; i < RTE_DIM(layers); i++) {
 141                 if (layers[i].kvlist == NULL)
 142                         continue;
 143                 kv = &layers[i].kvlist->pairs[0];
 144                 if (kv->key == NULL)
 145                         continue;
 146                 if (strcmp(kv->key, RTE_DEVARGS_KEY_BUS) == 0) {
 147                         bus = rte_bus_find_by_name(kv->value);
 148                         if (bus == NULL) {
 149                                 RTE_LOG(ERR, EAL, "Could not find bus \"%s\"\n",
 150                                         kv->value);
 151                                 ret = -EFAULT;
 152                                 goto get_out;
 153                         }
 154                 } else if (strcmp(kv->key, RTE_DEVARGS_KEY_CLASS) == 0) {
 155                         cls = rte_class_find_by_name(kv->value);
 156                         if (cls == NULL) {
 157                                 RTE_LOG(ERR, EAL, "Could not find class \"%s\"\n",
 158                                         kv->value);
 159                                 ret = -EFAULT;
 160                                 goto get_out;
 161                         }
 162                 } else if (strcmp(kv->key, RTE_DEVARGS_KEY_DRIVER) == 0) {
 163                         /* Ignore */
 164                         continue;
 165                 }
 166         }
 167
 168         /* Fill devargs fields. */
 169         devargs->bus_str = layers[0].str;
 170         devargs->cls_str = layers[1].str;
 171         devargs->drv_str = layers[2].str;
 172         devargs->bus = bus;
 173         devargs->cls = cls;
 174
 175         /* If we own the data, clean up a bit
 176          * the several layers string, to ease
 177          * their parsing afterward.
 178          */
 179         if (devargs->data != devstr) {
 180                 char *s = devargs->data;
 181
 182                 while ((s = strchr(s, '/'))) {
 183                         *s = '\0';
 184                         s++;
 185                 }
 186         }
 187
 188         /* Resolve devargs name. */
 189         if (bus != NULL && bus->devargs_parse != NULL)
 190                 ret = bus->devargs_parse(devargs);
 191         else if (layers[0].kvlist != NULL)
 192                 ret = devargs_bus_parse_default(devargs, layers[0].kvlist);
 193
 194 get_out:
 195         for (i = 0; i < RTE_DIM(layers); i++) {
 196                 if (layers[i].kvlist)
 197                         rte_kvargs_free(layers[i].kvlist);
 198         }
 199         if (ret != 0) {
 200                 if (allocated_data) {
 201                         /* Free duplicated data. */
 202                         free(devargs->data);
 203                         devargs->data = NULL;
 204                 }
 205                 rte_errno = -ret;
 206         }
 207         return ret;
 208 }
 209
 210 static int
 211 bus_name_cmp(const struct rte_bus *bus, const void *name)
 212 {
 213         return strncmp(bus->name, name, strlen(bus->name));
 214 }
 215
 216 int
 217 rte_devargs_parse(struct rte_devargs *da, const char *dev)
 218 {
 219         struct rte_bus *bus = NULL;
 220         const char *devname;
 221         const size_t maxlen = sizeof(da->name);
 222         size_t i;
 223
 224         if (da == NULL)
 225                 return -EINVAL;
 226
 227         /* Retrieve eventual bus info */
 228         do {
 229                 devname = dev;
 230                 bus = rte_bus_find(bus, bus_name_cmp, dev);
 231                 if (bus == NULL)
 232                         break;
 233                 devname = dev + strlen(bus->name) + 1;
 234                 if (rte_bus_find_by_device_name(devname) == bus)
 235                         break;
 236         } while (1);
 237         /* Store device name */
 238         i = 0;
 239         while (devname[i] != '\0' && devname[i] != ',') {
 240                 da->name[i] = devname[i];
 241                 i++;
 242                 if (i == maxlen) {
 243                         RTE_LOG(WARNING, EAL, "Parsing \"%s\": device name should be shorter than %zu\n",
 244                                 dev, maxlen);
 245                         da->name[i - 1] = '\0';
 246                         return -EINVAL;
 247                 }
 248         }
 249         da->name[i] = '\0';
 250         if (bus == NULL) {
 251                 bus = rte_bus_find_by_device_name(da->name);
 252                 if (bus == NULL) {
 253                         RTE_LOG(ERR, EAL, "failed to parse device \"%s\"\n",
 254                                 da->name);
 255                         return -EFAULT;
 256                 }
 257         }
 258         da->bus = bus;
 259         /* Parse eventual device arguments */
 260         if (devname[i] == ',')
 261                 da->data = strdup(&devname[i + 1]);
 262         else
 263                 da->data = strdup("");
 264         if (da->data == NULL) {
 265                 RTE_LOG(ERR, EAL, "not enough memory to parse arguments\n");
 266                 return -ENOMEM;
 267         }
 268         da->drv_str = da->data;
 269         return 0;
 270 }
 271
 272 int
 273 rte_devargs_parsef(struct rte_devargs *da, const char *format, ...)
 274 {
 275         va_list ap;
 276         int len;
 277         char *dev;
 278         int ret;
 279
 280         if (da == NULL)
 281                 return -EINVAL;
 282
 283         va_start(ap, format);
 284         len = vsnprintf(NULL, 0, format, ap);
 285         va_end(ap);
 286         if (len < 0)
 287                 return -EINVAL;
 288
 289         len += 1;
 290         dev = calloc(1, (size_t)len);
 291         if (dev == NULL) {
 292                 RTE_LOG(ERR, EAL, "not enough memory to parse device\n");
 293                 return -ENOMEM;
 294         }
 295
 296         va_start(ap, format);
 297         vsnprintf(dev, (size_t)len, format, ap);
 298         va_end(ap);
 299
 300         ret = rte_devargs_parse(da, dev);
 301
 302         free(dev);
 303         return ret;
 304 }
 305
 306 void
 307 rte_devargs_reset(struct rte_devargs *da)
 308 {
 309         if (da == NULL)
 310                 return;
 311         if (da->data)
 312                 free(da->data);
 313         da->data = NULL;
 314 }
 315
 316 int
 317 rte_devargs_insert(struct rte_devargs **da)
 318 {
 319         struct rte_devargs *listed_da;
 320         void *tmp;
 321
 322         if (*da == NULL || (*da)->bus == NULL)
 323                 return -1;
 324
 325         TAILQ_FOREACH_SAFE(listed_da, &devargs_list, next, tmp) {
 326                 if (listed_da == *da)
 327                         /* devargs already in the list */
 328                         return 0;
 329                 if (strcmp(listed_da->bus->name, (*da)->bus->name) == 0 &&
 330                                 strcmp(listed_da->name, (*da)->name) == 0) {
 331                         /* device already in devargs list, must be updated */
 332                         (*da)->next = listed_da->next;
 333                         rte_devargs_reset(listed_da);
 334                         *listed_da = **da;
 335                         /* replace provided devargs with found one */
 336                         free(*da);
 337                         *da = listed_da;
 338                         return 0;
 339                 }
 340         }
 341         /* new device in the list */
 342         TAILQ_INSERT_TAIL(&devargs_list, *da, next);
 343         return 0;
 344 }
 345
 346 /* store in allowed list parameter for later parsing */
 347 int
 348 rte_devargs_add(enum rte_devtype devtype, const char *devargs_str)
 349 {
 350         struct rte_devargs *devargs = NULL;
 351         struct rte_bus *bus = NULL;
 352         const char *dev = devargs_str;
 353
 354         /* use calloc instead of rte_zmalloc as it's called early at init */
 355         devargs = calloc(1, sizeof(*devargs));
 356         if (devargs == NULL)
 357                 goto fail;
 358
 359         if (rte_devargs_parse(devargs, dev))
 360                 goto fail;
 361         devargs->type = devtype;
 362         bus = devargs->bus;
 363         if (devargs->type == RTE_DEVTYPE_BLOCKED)
 364                 devargs->policy = RTE_DEV_BLOCKED;
 365         if (bus->conf.scan_mode == RTE_BUS_SCAN_UNDEFINED) {
 366                 if (devargs->policy == RTE_DEV_ALLOWED)
 367                         bus->conf.scan_mode = RTE_BUS_SCAN_ALLOWLIST;
 368                 else if (devargs->policy == RTE_DEV_BLOCKED)
 369                         bus->conf.scan_mode = RTE_BUS_SCAN_BLOCKLIST;
 370         }
 371         TAILQ_INSERT_TAIL(&devargs_list, devargs, next);
 372         return 0;
 373
 374 fail:
 375         if (devargs) {
 376                 rte_devargs_reset(devargs);
 377                 free(devargs);
 378         }
 379
 380         return -1;
 381 }
 382
 383 int
 384 rte_devargs_remove(struct rte_devargs *devargs)
 385 {
 386         struct rte_devargs *d;
 387         void *tmp;
 388
 389         if (devargs == NULL || devargs->bus == NULL)
 390                 return -1;
 391
 392         TAILQ_FOREACH_SAFE(d, &devargs_list, next, tmp) {
 393                 if (strcmp(d->bus->name, devargs->bus->name) == 0 &&
 394                     strcmp(d->name, devargs->name) == 0) {
 395                         TAILQ_REMOVE(&devargs_list, d, next);
 396                         rte_devargs_reset(d);
 397                         free(d);
 398                         return 0;
 399                 }
 400         }
 401         return 1;
 402 }
 403
 404 /* count the number of devices of a specified type */
 405 unsigned int
 406 rte_devargs_type_count(enum rte_devtype devtype)
 407 {
 408         struct rte_devargs *devargs;
 409         unsigned int count = 0;
 410
 411         TAILQ_FOREACH(devargs, &devargs_list, next) {
 412                 if (devargs->type != devtype)
 413                         continue;
 414                 count++;
 415         }
 416         return count;
 417 }
 418
 419 /* dump the user devices on the console */
 420 void
 421 rte_devargs_dump(FILE *f)
 422 {
 423         struct rte_devargs *devargs;
 424
 425         fprintf(f, "User device list:\n");
 426         TAILQ_FOREACH(devargs, &devargs_list, next) {
 427                 fprintf(f, "  [%s]: %s %s\n",
 428                         (devargs->bus ? devargs->bus->name : "??"),
 429                         devargs->name, devargs->args);
 430         }
 431 }
 432
 433 /* bus-aware rte_devargs iterator. */
 434 struct rte_devargs *
 435 rte_devargs_next(const char *busname, const struct rte_devargs *start)
 436 {
 437         struct rte_devargs *da;
 438
 439         if (start != NULL)
 440                 da = TAILQ_NEXT(start, next);
 441         else
 442                 da = TAILQ_FIRST(&devargs_list);
 443         while (da != NULL) {
 444                 if (busname == NULL ||
 445                     (strcmp(busname, da->bus->name) == 0))
 446                         return da;
 447                 da = TAILQ_NEXT(da, next);
 448         }
 449         return NULL;
 450 }