table: remove deprecated variable size key lru hash tables
[dpdk.git] / lib / librte_eal / common / eal_common_devargs.c
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright 2014 6WIND S.A.
5  *
6  *   Redistribution and use in source and binary forms, with or without
7  *   modification, are permitted provided that the following conditions
8  *   are met:
9  *
10  *     * Redistributions of source code must retain the above copyright
11  *       notice, this list of conditions and the following disclaimer.
12  *     * Redistributions in binary form must reproduce the above copyright
13  *       notice, this list of conditions and the following disclaimer in
14  *       the documentation and/or other materials provided with the
15  *       distribution.
16  *     * Neither the name of 6WIND S.A nor the names of its contributors
17  *       may be used to endorse or promote products derived from this
18  *       software without specific prior written permission.
19  *
20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 /* This file manages the list of devices and their arguments, as given
34  * by the user at startup
35  *
36  * Code here should not call rte_log since the EAL environment
37  * may not be initialized.
38  */
39
40 #include <stdio.h>
41 #include <string.h>
42
43 #include <rte_dev.h>
44 #include <rte_devargs.h>
45 #include <rte_tailq.h>
46 #include "eal_private.h"
47
48 /** Global list of user devices */
49 struct rte_devargs_list devargs_list =
50         TAILQ_HEAD_INITIALIZER(devargs_list);
51
52 int
53 rte_eal_parse_devargs_str(const char *devargs_str,
54                         char **drvname, char **drvargs)
55 {
56         char *sep;
57
58         if ((devargs_str) == NULL || (drvname) == NULL || (drvargs == NULL))
59                 return -1;
60
61         *drvname = strdup(devargs_str);
62         if (*drvname == NULL)
63                 return -1;
64
65         /* set the first ',' to '\0' to split name and arguments */
66         sep = strchr(*drvname, ',');
67         if (sep != NULL) {
68                 sep[0] = '\0';
69                 *drvargs = strdup(sep + 1);
70         } else {
71                 *drvargs = strdup("");
72         }
73
74         if (*drvargs == NULL) {
75                 free(*drvname);
76                 *drvname = NULL;
77                 return -1;
78         }
79         return 0;
80 }
81
82 static int
83 bus_name_cmp(const struct rte_bus *bus, const void *name)
84 {
85         return strncmp(bus->name, name, strlen(bus->name));
86 }
87
88 int
89 rte_eal_devargs_parse(const char *dev, struct rte_devargs *da)
90 {
91         struct rte_bus *bus = NULL;
92         const char *devname;
93         const size_t maxlen = sizeof(da->name);
94         size_t i;
95
96         if (dev == NULL || da == NULL)
97                 return -EINVAL;
98         /* Retrieve eventual bus info */
99         do {
100                 devname = dev;
101                 bus = rte_bus_find(bus, bus_name_cmp, dev);
102                 if (bus == NULL)
103                         break;
104                 devname = dev + strlen(bus->name) + 1;
105                 if (rte_bus_find_by_device_name(devname) == bus)
106                         break;
107         } while (1);
108         /* Store device name */
109         i = 0;
110         while (devname[i] != '\0' && devname[i] != ',') {
111                 da->name[i] = devname[i];
112                 i++;
113                 if (i == maxlen) {
114                         fprintf(stderr, "WARNING: Parsing \"%s\": device name should be shorter than %zu\n",
115                                 dev, maxlen);
116                         da->name[i - 1] = '\0';
117                         return -EINVAL;
118                 }
119         }
120         da->name[i] = '\0';
121         if (bus == NULL) {
122                 bus = rte_bus_find_by_device_name(da->name);
123                 if (bus == NULL) {
124                         fprintf(stderr, "ERROR: failed to parse device \"%s\"\n",
125                                 da->name);
126                         return -EFAULT;
127                 }
128         }
129         da->bus = bus;
130         /* Parse eventual device arguments */
131         if (devname[i] == ',')
132                 da->args = strdup(&devname[i + 1]);
133         else
134                 da->args = strdup("");
135         if (da->args == NULL) {
136                 fprintf(stderr, "ERROR: not enough memory to parse arguments\n");
137                 return -ENOMEM;
138         }
139         return 0;
140 }
141
142 int
143 rte_eal_devargs_insert(struct rte_devargs *da)
144 {
145         int ret;
146
147         ret = rte_eal_devargs_remove(da->bus->name, da->name);
148         if (ret < 0)
149                 return ret;
150         TAILQ_INSERT_TAIL(&devargs_list, da, next);
151         return 0;
152 }
153
154 /* store a whitelist parameter for later parsing */
155 int
156 rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str)
157 {
158         struct rte_devargs *devargs = NULL;
159         struct rte_bus *bus = NULL;
160         const char *dev = devargs_str;
161
162         /* use calloc instead of rte_zmalloc as it's called early at init */
163         devargs = calloc(1, sizeof(*devargs));
164         if (devargs == NULL)
165                 goto fail;
166
167         if (rte_eal_devargs_parse(dev, devargs))
168                 goto fail;
169         devargs->type = devtype;
170         bus = devargs->bus;
171         if (devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI)
172                 devargs->policy = RTE_DEV_BLACKLISTED;
173         if (bus->conf.scan_mode == RTE_BUS_SCAN_UNDEFINED) {
174                 if (devargs->policy == RTE_DEV_WHITELISTED)
175                         bus->conf.scan_mode = RTE_BUS_SCAN_WHITELIST;
176                 else if (devargs->policy == RTE_DEV_BLACKLISTED)
177                         bus->conf.scan_mode = RTE_BUS_SCAN_BLACKLIST;
178         }
179         TAILQ_INSERT_TAIL(&devargs_list, devargs, next);
180         return 0;
181
182 fail:
183         if (devargs) {
184                 free(devargs->args);
185                 free(devargs);
186         }
187
188         return -1;
189 }
190
191 int
192 rte_eal_devargs_remove(const char *busname, const char *devname)
193 {
194         struct rte_devargs *d;
195         void *tmp;
196
197         TAILQ_FOREACH_SAFE(d, &devargs_list, next, tmp) {
198                 if (strcmp(d->bus->name, busname) == 0 &&
199                     strcmp(d->name, devname) == 0) {
200                         TAILQ_REMOVE(&devargs_list, d, next);
201                         free(d->args);
202                         free(d);
203                         return 0;
204                 }
205         }
206         return 1;
207 }
208
209 /* count the number of devices of a specified type */
210 unsigned int
211 rte_eal_devargs_type_count(enum rte_devtype devtype)
212 {
213         struct rte_devargs *devargs;
214         unsigned int count = 0;
215
216         TAILQ_FOREACH(devargs, &devargs_list, next) {
217                 if (devargs->type != devtype)
218                         continue;
219                 count++;
220         }
221         return count;
222 }
223
224 /* dump the user devices on the console */
225 void
226 rte_eal_devargs_dump(FILE *f)
227 {
228         struct rte_devargs *devargs;
229
230         fprintf(f, "User device list:\n");
231         TAILQ_FOREACH(devargs, &devargs_list, next) {
232                 fprintf(f, "  [%s]: %s %s\n",
233                         (devargs->bus ? devargs->bus->name : "??"),
234                         devargs->name, devargs->args);
235         }
236 }