1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
/* SPDX-License-Identifier: BSD-3-Clause
* Copyright 2014 6WIND S.A.
*/
#ifndef _RTE_DEVARGS_H_
#define _RTE_DEVARGS_H_
/**
* @file
*
* RTE devargs: list of devices and their user arguments
*
* This file stores a list of devices and their arguments given by
* the user when a DPDK application is started. These devices can be PCI
* devices or virtual devices. These devices are stored at startup in a
* list of rte_devargs structures.
*/
#ifdef __cplusplus
extern "C" {
#endif
#include <stdio.h>
#include <sys/queue.h>
#include <rte_compat.h>
#include <rte_bus.h>
/**
* Type of generic device
*/
enum rte_devtype {
RTE_DEVTYPE_WHITELISTED_PCI,
RTE_DEVTYPE_BLACKLISTED_PCI,
RTE_DEVTYPE_VIRTUAL,
};
/**
* Structure that stores a device given by the user with its arguments
*
* A user device is a physical or a virtual device given by the user to
* the DPDK application at startup through command line arguments.
*
* The structure stores the configuration of the device, its PCI
* identifier if it's a PCI device or the driver name if it's a virtual
* device.
*/
struct rte_devargs {
/** Next in list. */
TAILQ_ENTRY(rte_devargs) next;
/** Type of device. */
enum rte_devtype type;
/** Device policy. */
enum rte_dev_policy policy;
/** Name of the device. */
char name[RTE_DEV_NAME_MAX_LEN];
RTE_STD_C11
union {
/** Arguments string as given by user or "" for no argument. */
char *args;
const char *drv_str;
};
struct rte_bus *bus; /**< bus handle. */
struct rte_class *cls; /**< class handle. */
const char *bus_str; /**< bus-related part of device string. */
const char *cls_str; /**< class-related part of device string. */
const char *data; /**< Device string storage. */
};
/**
* Parse a device string.
*
* Verify that a bus is capable of handling the device passed
* in argument. Store which bus will handle the device, its name
* and the eventual device parameters.
*
* The syntax is:
*
* bus:device_identifier,arg1=val1,arg2=val2
*
* where "bus:" is the bus name followed by any character separator.
* The bus name is optional. If no bus name is specified, each bus
* will attempt to recognize the device identifier. The first one
* to succeed will be used.
*
* Examples:
*
* pci:0000:05.00.0,arg=val
* 05.00.0,arg=val
* vdev:net_ring0
*
* @param da
* The devargs structure holding the device information.
*
* @param dev
* String describing a device.
*
* @return
* - 0 on success.
* - Negative errno on error.
*/
__rte_experimental
int
rte_devargs_parse(struct rte_devargs *da, const char *dev);
/**
* Parse a device string.
*
* Verify that a bus is capable of handling the device passed
* in argument. Store which bus will handle the device, its name
* and the eventual device parameters.
*
* The device string is built with a printf-like syntax.
*
* The syntax is:
*
* bus:device_identifier,arg1=val1,arg2=val2
*
* where "bus:" is the bus name followed by any character separator.
* The bus name is optional. If no bus name is specified, each bus
* will attempt to recognize the device identifier. The first one
* to succeed will be used.
*
* Examples:
*
* pci:0000:05.00.0,arg=val
* 05.00.0,arg=val
* vdev:net_ring0
*
* @param da
* The devargs structure holding the device information.
* @param format
* Format string describing a device.
*
* @return
* - 0 on success.
* - Negative errno on error.
*/
__rte_experimental
int
rte_devargs_parsef(struct rte_devargs *da,
const char *format, ...)
__attribute__((format(printf, 2, 0)));
/**
* Insert an rte_devargs in the global list.
*
* @param da
* The devargs structure to insert.
*
* @return
* - 0 on success
* - Negative on error.
*/
__rte_experimental
int
rte_devargs_insert(struct rte_devargs *da);
/**
* Add a device to the user device list
* See rte_devargs_parse() for details.
*
* @param devtype
* The type of the device.
* @param devargs_str
* The arguments as given by the user.
*
* @return
* - 0 on success
* - A negative value on error
*/
__rte_experimental
int rte_devargs_add(enum rte_devtype devtype, const char *devargs_str);
/**
* Remove a device from the user device list.
* Its resources are freed.
* If the devargs cannot be found, nothing happens.
*
* @param devargs
* The instance or a copy of devargs to remove.
*
* @return
* 0 on success.
* <0 on error.
* >0 if the devargs was not within the user device list.
*/
__rte_experimental
int rte_devargs_remove(struct rte_devargs *devargs);
/**
* Count the number of user devices of a specified type
*
* @param devtype
* The type of the devices to counted.
*
* @return
* The number of devices.
*/
__rte_experimental
unsigned int
rte_devargs_type_count(enum rte_devtype devtype);
/**
* This function dumps the list of user device and their arguments.
*
* @param f
* A pointer to a file for output
*/
__rte_experimental
void rte_devargs_dump(FILE *f);
/**
* Find next rte_devargs matching the provided bus name.
*
* @param busname
* Limit the iteration to devargs related to buses
* matching this name.
* Will return any next rte_devargs if NULL.
*
* @param start
* Starting iteration point. The iteration will start at
* the first rte_devargs if NULL.
*
* @return
* Next rte_devargs entry matching the requested bus,
* NULL if there is none.
*/
__rte_experimental
struct rte_devargs *
rte_devargs_next(const char *busname, const struct rte_devargs *start);
/**
* Iterate over all rte_devargs for a specific bus.
*/
#define RTE_EAL_DEVARGS_FOREACH(busname, da) \
for (da = rte_devargs_next(busname, NULL); \
da != NULL; \
da = rte_devargs_next(busname, da)) \
#ifdef __cplusplus
}
#endif
#endif /* _RTE_DEVARGS_H_ */
|
