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 "eal_private.h"
24 /** user device double-linked queue type definition */
25 TAILQ_HEAD(rte_devargs_list, rte_devargs);
27 /** Global list of user devices */
28 static struct rte_devargs_list devargs_list =
29 TAILQ_HEAD_INITIALIZER(devargs_list);
32 devargs_layer_count(const char *s)
36 while (s != NULL && s[0] != '\0') {
44 rte_devargs_layers_parse(struct rte_devargs *devargs,
50 struct rte_kvargs *kvlist;
52 { RTE_DEVARGS_KEY_BUS "=", NULL, NULL, },
53 { RTE_DEVARGS_KEY_CLASS "=", NULL, NULL, },
54 { RTE_DEVARGS_KEY_DRIVER "=", NULL, NULL, },
56 struct rte_kvargs_pair *kv = NULL;
57 struct rte_class *cls = NULL;
58 struct rte_bus *bus = NULL;
59 const char *s = devstr;
63 bool allocated_data = false;
65 /* Split each sub-lists. */
66 nblayer = devargs_layer_count(devstr);
67 if (nblayer > RTE_DIM(layers)) {
68 RTE_LOG(ERR, EAL, "Invalid format: too many layers (%zu)\n",
74 /* If the devargs points the devstr
75 * as source data, then it should not allocate
76 * anything and keep referring only to it.
78 if (devargs->data != devstr) {
79 devargs->data = strdup(devstr);
80 if (devargs->data == NULL) {
81 RTE_LOG(ERR, EAL, "OOM\n");
85 allocated_data = true;
90 if (i >= RTE_DIM(layers)) {
91 RTE_LOG(ERR, EAL, "Unrecognized layer %s\n", s);
96 * The last layer is free-form.
97 * The "driver" key is not required (but accepted).
99 if (strncmp(layers[i].key, s, strlen(layers[i].key)) &&
100 i != RTE_DIM(layers) - 1)
103 layers[i].kvlist = rte_kvargs_parse_delim(s, NULL, "/");
104 if (layers[i].kvlist == NULL) {
105 RTE_LOG(ERR, EAL, "Could not parse %s\n", s);
116 /* Parse each sub-list. */
117 for (i = 0; i < RTE_DIM(layers); i++) {
118 if (layers[i].kvlist == NULL)
120 kv = &layers[i].kvlist->pairs[0];
121 if (strcmp(kv->key, RTE_DEVARGS_KEY_BUS) == 0) {
122 bus = rte_bus_find_by_name(kv->value);
124 RTE_LOG(ERR, EAL, "Could not find bus \"%s\"\n",
129 } else if (strcmp(kv->key, RTE_DEVARGS_KEY_CLASS) == 0) {
130 cls = rte_class_find_by_name(kv->value);
132 RTE_LOG(ERR, EAL, "Could not find class \"%s\"\n",
137 } else if (strcmp(kv->key, RTE_DEVARGS_KEY_DRIVER) == 0) {
143 /* Fill devargs fields. */
144 devargs->bus_str = layers[0].str;
145 devargs->cls_str = layers[1].str;
146 devargs->drv_str = layers[2].str;
150 /* If we own the data, clean up a bit
151 * the several layers string, to ease
152 * their parsing afterward.
154 if (devargs->data != devstr) {
155 char *s = devargs->data;
157 while ((s = strchr(s, '/'))) {
164 for (i = 0; i < RTE_DIM(layers); i++) {
165 if (layers[i].kvlist)
166 rte_kvargs_free(layers[i].kvlist);
169 if (allocated_data) {
170 /* Free duplicated data. */
172 devargs->data = NULL;
180 bus_name_cmp(const struct rte_bus *bus, const void *name)
182 return strncmp(bus->name, name, strlen(bus->name));
186 rte_devargs_parse(struct rte_devargs *da, const char *dev)
188 struct rte_bus *bus = NULL;
190 const size_t maxlen = sizeof(da->name);
196 /* Retrieve eventual bus info */
199 bus = rte_bus_find(bus, bus_name_cmp, dev);
202 devname = dev + strlen(bus->name) + 1;
203 if (rte_bus_find_by_device_name(devname) == bus)
206 /* Store device name */
208 while (devname[i] != '\0' && devname[i] != ',') {
209 da->name[i] = devname[i];
212 RTE_LOG(WARNING, EAL, "Parsing \"%s\": device name should be shorter than %zu\n",
214 da->name[i - 1] = '\0';
220 bus = rte_bus_find_by_device_name(da->name);
222 RTE_LOG(ERR, EAL, "failed to parse device \"%s\"\n",
228 /* Parse eventual device arguments */
229 if (devname[i] == ',')
230 da->data = strdup(&devname[i + 1]);
232 da->data = strdup("");
233 if (da->data == NULL) {
234 RTE_LOG(ERR, EAL, "not enough memory to parse arguments\n");
237 da->drv_str = da->data;
242 rte_devargs_parsef(struct rte_devargs *da, const char *format, ...)
252 va_start(ap, format);
253 len = vsnprintf(NULL, 0, format, ap);
259 dev = calloc(1, (size_t)len);
261 RTE_LOG(ERR, EAL, "not enough memory to parse device\n");
265 va_start(ap, format);
266 vsnprintf(dev, (size_t)len, format, ap);
269 ret = rte_devargs_parse(da, dev);
276 rte_devargs_reset(struct rte_devargs *da)
286 rte_devargs_insert(struct rte_devargs **da)
288 struct rte_devargs *listed_da;
291 if (*da == NULL || (*da)->bus == NULL)
294 TAILQ_FOREACH_SAFE(listed_da, &devargs_list, next, tmp) {
295 if (listed_da == *da)
296 /* devargs already in the list */
298 if (strcmp(listed_da->bus->name, (*da)->bus->name) == 0 &&
299 strcmp(listed_da->name, (*da)->name) == 0) {
300 /* device already in devargs list, must be updated */
301 (*da)->next = listed_da->next;
302 rte_devargs_reset(listed_da);
304 /* replace provided devargs with found one */
310 /* new device in the list */
311 TAILQ_INSERT_TAIL(&devargs_list, *da, next);
315 /* store in allowed list parameter for later parsing */
317 rte_devargs_add(enum rte_devtype devtype, const char *devargs_str)
319 struct rte_devargs *devargs = NULL;
320 struct rte_bus *bus = NULL;
321 const char *dev = devargs_str;
323 /* use calloc instead of rte_zmalloc as it's called early at init */
324 devargs = calloc(1, sizeof(*devargs));
328 if (rte_devargs_parse(devargs, dev))
330 devargs->type = devtype;
332 if (devargs->type == RTE_DEVTYPE_BLOCKED)
333 devargs->policy = RTE_DEV_BLOCKED;
334 if (bus->conf.scan_mode == RTE_BUS_SCAN_UNDEFINED) {
335 if (devargs->policy == RTE_DEV_ALLOWED)
336 bus->conf.scan_mode = RTE_BUS_SCAN_ALLOWLIST;
337 else if (devargs->policy == RTE_DEV_BLOCKED)
338 bus->conf.scan_mode = RTE_BUS_SCAN_BLOCKLIST;
340 TAILQ_INSERT_TAIL(&devargs_list, devargs, next);
345 rte_devargs_reset(devargs);
353 rte_devargs_remove(struct rte_devargs *devargs)
355 struct rte_devargs *d;
358 if (devargs == NULL || devargs->bus == NULL)
361 TAILQ_FOREACH_SAFE(d, &devargs_list, next, tmp) {
362 if (strcmp(d->bus->name, devargs->bus->name) == 0 &&
363 strcmp(d->name, devargs->name) == 0) {
364 TAILQ_REMOVE(&devargs_list, d, next);
365 rte_devargs_reset(d);
373 /* count the number of devices of a specified type */
375 rte_devargs_type_count(enum rte_devtype devtype)
377 struct rte_devargs *devargs;
378 unsigned int count = 0;
380 TAILQ_FOREACH(devargs, &devargs_list, next) {
381 if (devargs->type != devtype)
388 /* dump the user devices on the console */
390 rte_devargs_dump(FILE *f)
392 struct rte_devargs *devargs;
394 fprintf(f, "User device list:\n");
395 TAILQ_FOREACH(devargs, &devargs_list, next) {
396 fprintf(f, " [%s]: %s %s\n",
397 (devargs->bus ? devargs->bus->name : "??"),
398 devargs->name, devargs->args);
402 /* bus-aware rte_devargs iterator. */
404 rte_devargs_next(const char *busname, const struct rte_devargs *start)
406 struct rte_devargs *da;
409 da = TAILQ_NEXT(start, next);
411 da = TAILQ_FIRST(&devargs_list);
413 if (busname == NULL ||
414 (strcmp(busname, da->bus->name) == 0))
416 da = TAILQ_NEXT(da, next);