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 struct rte_devargs_list devargs_list =
29 TAILQ_HEAD_INITIALIZER(devargs_list);
32 rte_eal_parse_devargs_str(const char *devargs_str,
33 char **drvname, char **drvargs)
37 if ((devargs_str) == NULL || (drvname) == NULL || (drvargs == NULL))
40 *drvname = strdup(devargs_str);
44 /* set the first ',' to '\0' to split name and arguments */
45 sep = strchr(*drvname, ',');
48 *drvargs = strdup(sep + 1);
50 *drvargs = strdup("");
53 if (*drvargs == NULL) {
62 devargs_layer_count(const char *s)
66 while (s != NULL && s[0] != '\0') {
74 rte_devargs_layers_parse(struct rte_devargs *devargs,
80 struct rte_kvargs *kvlist;
82 { "bus=", NULL, NULL, },
83 { "class=", NULL, NULL, },
84 { "driver=", NULL, NULL, },
86 struct rte_kvargs_pair *kv = NULL;
87 struct rte_class *cls = NULL;
88 struct rte_bus *bus = NULL;
89 const char *s = devstr;
94 /* Split each sub-lists. */
95 nblayer = devargs_layer_count(devstr);
96 if (nblayer > RTE_DIM(layers)) {
97 RTE_LOG(ERR, EAL, "Invalid format: too many layers (%zu)\n",
103 /* If the devargs points the devstr
104 * as source data, then it should not allocate
105 * anything and keep referring only to it.
107 if (devargs->data != devstr) {
108 devargs->data = strdup(devstr);
109 if (devargs->data == NULL) {
110 RTE_LOG(ERR, EAL, "OOM\n");
118 if (i >= RTE_DIM(layers)) {
119 RTE_LOG(ERR, EAL, "Unrecognized layer %s\n", s);
124 * The last layer is free-form.
125 * The "driver" key is not required (but accepted).
127 if (strncmp(layers[i].key, s, strlen(layers[i].key)) &&
128 i != RTE_DIM(layers) - 1)
131 layers[i].kvlist = rte_kvargs_parse_delim(s, NULL, "/");
132 if (layers[i].kvlist == NULL) {
133 RTE_LOG(ERR, EAL, "Could not parse %s\n", s);
144 /* Parse each sub-list. */
145 for (i = 0; i < RTE_DIM(layers); i++) {
146 if (layers[i].kvlist == NULL)
148 kv = &layers[i].kvlist->pairs[0];
149 if (strcmp(kv->key, "bus") == 0) {
150 bus = rte_bus_find_by_name(kv->value);
152 RTE_LOG(ERR, EAL, "Could not find bus \"%s\"\n",
157 } else if (strcmp(kv->key, "class") == 0) {
158 cls = rte_class_find_by_name(kv->value);
160 RTE_LOG(ERR, EAL, "Could not find class \"%s\"\n",
165 } else if (strcmp(kv->key, "driver") == 0) {
171 /* Fill devargs fields. */
172 devargs->bus_str = layers[0].str;
173 devargs->cls_str = layers[1].str;
174 devargs->drv_str = layers[2].str;
178 /* If we own the data, clean up a bit
179 * the several layers string, to ease
180 * their parsing afterward.
182 if (devargs->data != devstr) {
183 char *s = (void *)(intptr_t)(devargs->data);
185 while ((s = strchr(s, '/'))) {
192 for (i = 0; i < RTE_DIM(layers); i++) {
193 if (layers[i].kvlist)
194 rte_kvargs_free(layers[i].kvlist);
202 bus_name_cmp(const struct rte_bus *bus, const void *name)
204 return strncmp(bus->name, name, strlen(bus->name));
209 rte_devargs_parse(struct rte_devargs *da, const char *dev)
211 struct rte_bus *bus = NULL;
213 const size_t maxlen = sizeof(da->name);
219 /* Retrieve eventual bus info */
222 bus = rte_bus_find(bus, bus_name_cmp, dev);
225 devname = dev + strlen(bus->name) + 1;
226 if (rte_bus_find_by_device_name(devname) == bus)
229 /* Store device name */
231 while (devname[i] != '\0' && devname[i] != ',') {
232 da->name[i] = devname[i];
235 RTE_LOG(WARNING, EAL, "Parsing \"%s\": device name should be shorter than %zu\n",
237 da->name[i - 1] = '\0';
243 bus = rte_bus_find_by_device_name(da->name);
245 RTE_LOG(ERR, EAL, "failed to parse device \"%s\"\n",
251 /* Parse eventual device arguments */
252 if (devname[i] == ',')
253 da->args = strdup(&devname[i + 1]);
255 da->args = strdup("");
256 if (da->args == NULL) {
257 RTE_LOG(ERR, EAL, "not enough memory to parse arguments\n");
265 rte_devargs_parsef(struct rte_devargs *da, const char *format, ...)
274 va_start(ap, format);
275 len = vsnprintf(NULL, 0, format, ap);
278 dev = calloc(1, len + 1);
280 RTE_LOG(ERR, EAL, "not enough memory to parse device\n");
284 va_start(ap, format);
285 vsnprintf(dev, len + 1, format, ap);
288 return rte_devargs_parse(da, dev);
291 int __rte_experimental
292 rte_devargs_insert(struct rte_devargs *da)
296 ret = rte_devargs_remove(da->bus->name, da->name);
299 TAILQ_INSERT_TAIL(&devargs_list, da, next);
303 /* store a whitelist parameter for later parsing */
306 rte_devargs_add(enum rte_devtype devtype, const char *devargs_str)
308 struct rte_devargs *devargs = NULL;
309 struct rte_bus *bus = NULL;
310 const char *dev = devargs_str;
312 /* use calloc instead of rte_zmalloc as it's called early at init */
313 devargs = calloc(1, sizeof(*devargs));
317 if (rte_devargs_parse(devargs, dev))
319 devargs->type = devtype;
321 if (devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI)
322 devargs->policy = RTE_DEV_BLACKLISTED;
323 if (bus->conf.scan_mode == RTE_BUS_SCAN_UNDEFINED) {
324 if (devargs->policy == RTE_DEV_WHITELISTED)
325 bus->conf.scan_mode = RTE_BUS_SCAN_WHITELIST;
326 else if (devargs->policy == RTE_DEV_BLACKLISTED)
327 bus->conf.scan_mode = RTE_BUS_SCAN_BLACKLIST;
329 TAILQ_INSERT_TAIL(&devargs_list, devargs, next);
341 int __rte_experimental
342 rte_devargs_remove(const char *busname, const char *devname)
344 struct rte_devargs *d;
347 TAILQ_FOREACH_SAFE(d, &devargs_list, next, tmp) {
348 if (strcmp(d->bus->name, busname) == 0 &&
349 strcmp(d->name, devname) == 0) {
350 TAILQ_REMOVE(&devargs_list, d, next);
359 /* count the number of devices of a specified type */
362 rte_devargs_type_count(enum rte_devtype devtype)
364 struct rte_devargs *devargs;
365 unsigned int count = 0;
367 TAILQ_FOREACH(devargs, &devargs_list, next) {
368 if (devargs->type != devtype)
375 /* dump the user devices on the console */
378 rte_devargs_dump(FILE *f)
380 struct rte_devargs *devargs;
382 fprintf(f, "User device list:\n");
383 TAILQ_FOREACH(devargs, &devargs_list, next) {
384 fprintf(f, " [%s]: %s %s\n",
385 (devargs->bus ? devargs->bus->name : "??"),
386 devargs->name, devargs->args);
390 /* bus-aware rte_devargs iterator. */
393 rte_devargs_next(const char *busname, const struct rte_devargs *start)
395 struct rte_devargs *da;
398 da = TAILQ_NEXT(start, next);
400 da = TAILQ_FIRST(&devargs_list);
402 if (busname == NULL ||
403 (strcmp(busname, da->bus->name) == 0))
405 da = TAILQ_NEXT(da, next);