1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2014 6WIND S.A.
5 /* This file manages the list of devices and their arguments, as given
6 * by the user at startup
14 #include <rte_class.h>
15 #include <rte_compat.h>
17 #include <rte_devargs.h>
18 #include <rte_errno.h>
19 #include <rte_kvargs.h>
21 #include <rte_tailq.h>
22 #include <rte_string_fns.h>
23 #include "eal_private.h"
25 /** user device double-linked queue type definition */
26 TAILQ_HEAD(rte_devargs_list, rte_devargs);
28 /** Global list of user devices */
29 static struct rte_devargs_list devargs_list =
30 TAILQ_HEAD_INITIALIZER(devargs_list);
32 /* Resolve devargs name from bus arguments. */
34 devargs_bus_parse_default(struct rte_devargs *devargs,
35 struct rte_kvargs *bus_args)
39 /* Parse devargs name from bus key-value list. */
40 name = rte_kvargs_get(bus_args, "name");
42 RTE_LOG(DEBUG, EAL, "devargs name not found: %s\n",
46 if (rte_strscpy(devargs->name, name, sizeof(devargs->name)) < 0) {
47 RTE_LOG(ERR, EAL, "devargs name too long: %s\n",
55 rte_devargs_layers_parse(struct rte_devargs *devargs,
61 struct rte_kvargs *kvlist;
63 { RTE_DEVARGS_KEY_BUS "=", NULL, NULL, },
64 { RTE_DEVARGS_KEY_CLASS "=", NULL, NULL, },
65 { RTE_DEVARGS_KEY_DRIVER "=", NULL, NULL, },
67 struct rte_kvargs_pair *kv = NULL;
68 struct rte_kvargs *bus_kvlist = NULL;
73 bool allocated_data = false;
75 /* If the devargs points the devstr
76 * as source data, then it should not allocate
77 * anything and keep referring only to it.
79 if (devargs->data != devstr) {
80 devargs->data = strdup(devstr);
81 if (devargs->data == NULL) {
82 RTE_LOG(ERR, EAL, "OOM\n");
86 allocated_data = true;
91 if (nblayer > RTE_DIM(layers)) {
95 layers[nblayer].str = s;
97 /* Locate next layer starts with valid layer key. */
102 for (i = 0; i < RTE_DIM(layers); i++) {
103 if (strncmp(s + 1, layers[i].key,
104 strlen(layers[i].key)) == 0) {
110 if (i < RTE_DIM(layers))
114 layers[nblayer].kvlist = rte_kvargs_parse
115 (layers[nblayer].str, NULL);
116 if (layers[nblayer].kvlist == NULL) {
124 /* Parse each sub-list. */
125 for (i = 0; i < RTE_DIM(layers); i++) {
126 if (layers[i].kvlist == NULL)
128 kv = &layers[i].kvlist->pairs[0];
131 if (strcmp(kv->key, RTE_DEVARGS_KEY_BUS) == 0) {
132 bus_kvlist = layers[i].kvlist;
133 devargs->bus_str = layers[i].str;
134 devargs->bus = rte_bus_find_by_name(kv->value);
135 if (devargs->bus == NULL) {
136 RTE_LOG(ERR, EAL, "Could not find bus \"%s\"\n",
141 } else if (strcmp(kv->key, RTE_DEVARGS_KEY_CLASS) == 0) {
142 devargs->cls_str = layers[i].str;
143 devargs->cls = rte_class_find_by_name(kv->value);
144 if (devargs->cls == NULL) {
145 RTE_LOG(ERR, EAL, "Could not find class \"%s\"\n",
150 } else if (strcmp(kv->key, RTE_DEVARGS_KEY_DRIVER) == 0) {
151 devargs->drv_str = layers[i].str;
156 /* Resolve devargs name. */
157 if (devargs->bus != NULL && devargs->bus->devargs_parse != NULL)
158 ret = devargs->bus->devargs_parse(devargs);
159 else if (bus_kvlist != NULL)
160 ret = devargs_bus_parse_default(devargs, bus_kvlist);
163 for (i = 0; i < RTE_DIM(layers); i++) {
164 if (layers[i].kvlist)
165 rte_kvargs_free(layers[i].kvlist);
168 if (allocated_data) {
169 /* Free duplicated data. */
171 devargs->data = NULL;
179 bus_name_cmp(const struct rte_bus *bus, const void *name)
181 return strncmp(bus->name, name, strlen(bus->name));
185 rte_devargs_parse(struct rte_devargs *da, const char *dev)
187 struct rte_bus *bus = NULL;
189 const size_t maxlen = sizeof(da->name);
195 /* First parse according global device syntax. */
196 if (rte_devargs_layers_parse(da, dev) == 0) {
197 if (da->bus != NULL || da->cls != NULL)
199 rte_devargs_reset(da);
202 /* Otherwise fallback to legacy syntax: */
204 /* Retrieve eventual bus info */
207 bus = rte_bus_find(bus, bus_name_cmp, dev);
210 devname = dev + strlen(bus->name) + 1;
211 if (rte_bus_find_by_device_name(devname) == bus)
214 /* Store device name */
216 while (devname[i] != '\0' && devname[i] != ',') {
217 da->name[i] = devname[i];
220 RTE_LOG(WARNING, EAL, "Parsing \"%s\": device name should be shorter than %zu\n",
222 da->name[i - 1] = '\0';
228 bus = rte_bus_find_by_device_name(da->name);
230 RTE_LOG(ERR, EAL, "failed to parse device \"%s\"\n",
236 /* Parse eventual device arguments */
237 if (devname[i] == ',')
238 da->data = strdup(&devname[i + 1]);
240 da->data = strdup("");
241 if (da->data == NULL) {
242 RTE_LOG(ERR, EAL, "not enough memory to parse arguments\n");
245 da->drv_str = da->data;
250 rte_devargs_parsef(struct rte_devargs *da, const char *format, ...)
260 va_start(ap, format);
261 len = vsnprintf(NULL, 0, format, ap);
267 dev = calloc(1, (size_t)len);
269 RTE_LOG(ERR, EAL, "not enough memory to parse device\n");
273 va_start(ap, format);
274 vsnprintf(dev, (size_t)len, format, ap);
277 ret = rte_devargs_parse(da, dev);
284 rte_devargs_reset(struct rte_devargs *da)
294 rte_devargs_insert(struct rte_devargs **da)
296 struct rte_devargs *listed_da;
299 if (*da == NULL || (*da)->bus == NULL)
302 RTE_TAILQ_FOREACH_SAFE(listed_da, &devargs_list, next, tmp) {
303 if (listed_da == *da)
304 /* devargs already in the list */
306 if (strcmp(listed_da->bus->name, (*da)->bus->name) == 0 &&
307 strcmp(listed_da->name, (*da)->name) == 0) {
308 /* device already in devargs list, must be updated */
309 (*da)->next = listed_da->next;
310 rte_devargs_reset(listed_da);
312 /* replace provided devargs with found one */
318 /* new device in the list */
319 TAILQ_INSERT_TAIL(&devargs_list, *da, next);
323 /* store in allowed list parameter for later parsing */
325 rte_devargs_add(enum rte_devtype devtype, const char *devargs_str)
327 struct rte_devargs *devargs = NULL;
328 struct rte_bus *bus = NULL;
329 const char *dev = devargs_str;
331 /* use calloc instead of rte_zmalloc as it's called early at init */
332 devargs = calloc(1, sizeof(*devargs));
336 if (rte_devargs_parse(devargs, dev))
338 devargs->type = devtype;
340 if (devargs->type == RTE_DEVTYPE_BLOCKED)
341 devargs->policy = RTE_DEV_BLOCKED;
342 if (bus->conf.scan_mode == RTE_BUS_SCAN_UNDEFINED) {
343 if (devargs->policy == RTE_DEV_ALLOWED)
344 bus->conf.scan_mode = RTE_BUS_SCAN_ALLOWLIST;
345 else if (devargs->policy == RTE_DEV_BLOCKED)
346 bus->conf.scan_mode = RTE_BUS_SCAN_BLOCKLIST;
348 TAILQ_INSERT_TAIL(&devargs_list, devargs, next);
353 rte_devargs_reset(devargs);
361 rte_devargs_remove(struct rte_devargs *devargs)
363 struct rte_devargs *d;
366 if (devargs == NULL || devargs->bus == NULL)
369 RTE_TAILQ_FOREACH_SAFE(d, &devargs_list, next, tmp) {
370 if (strcmp(d->bus->name, devargs->bus->name) == 0 &&
371 strcmp(d->name, devargs->name) == 0) {
372 TAILQ_REMOVE(&devargs_list, d, next);
373 rte_devargs_reset(d);
381 /* count the number of devices of a specified type */
383 rte_devargs_type_count(enum rte_devtype devtype)
385 struct rte_devargs *devargs;
386 unsigned int count = 0;
388 TAILQ_FOREACH(devargs, &devargs_list, next) {
389 if (devargs->type != devtype)
396 /* dump the user devices on the console */
398 rte_devargs_dump(FILE *f)
400 struct rte_devargs *devargs;
402 fprintf(f, "User device list:\n");
403 TAILQ_FOREACH(devargs, &devargs_list, next) {
404 fprintf(f, " [%s]: %s %s\n",
405 (devargs->bus ? devargs->bus->name : "??"),
406 devargs->name, devargs->args);
410 /* bus-aware rte_devargs iterator. */
412 rte_devargs_next(const char *busname, const struct rte_devargs *start)
414 struct rte_devargs *da;
417 da = TAILQ_NEXT(start, next);
419 da = TAILQ_FIRST(&devargs_list);
421 if (busname == NULL ||
422 (strcmp(busname, da->bus->name) == 0))
424 da = TAILQ_NEXT(da, next);