/usr/include/dpdk/rte_devargs.h is in libdpdk-dev 17.11.1-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*-
* BSD LICENSE
*
* Copyright 2014 6WIND S.A.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of 6WIND S.A nor the names of its contributors
* may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#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_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;
/** Bus handle for the device. */
struct rte_bus *bus;
/** Name of the device. */
char name[RTE_DEV_NAME_MAX_LEN];
/** Arguments string as given by user or "" for no argument. */
char *args;
};
/** user device double-linked queue type definition */
TAILQ_HEAD(rte_devargs_list, rte_devargs);
/** Global list of user devices */
extern struct rte_devargs_list devargs_list;
/**
* Parse a devargs string.
*
* For PCI devices, the format of arguments string is "PCI_ADDR" or
* "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
* "04:00.0,arg=val".
*
* For virtual devices, the format of arguments string is "DRIVER_NAME*"
* or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
* "net_ring0", "net_pmdAnything,arg=0:arg2=1".
*
* The function parses the arguments string to get driver name and driver
* arguments.
*
* @param devargs_str
* The arguments as given by the user.
* @param drvname
* The pointer to the string to store parsed driver name.
* @param drvargs
* The pointer to the string to store parsed driver arguments.
*
* @return
* - 0 on success
* - A negative value on error
*/
int rte_eal_parse_devargs_str(const char *devargs_str,
char **drvname, char **drvargs);
/**
* 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.
*
* @param dev
* The device declaration string.
* @param da
* The devargs structure holding the device information.
*
* @return
* - 0 on success.
* - Negative errno on error.
*/
int
rte_eal_devargs_parse(const char *dev,
struct rte_devargs *da);
/**
* Insert an rte_devargs in the global list.
*
* @param da
* The devargs structure to insert.
*
* @return
* - 0 on success
* - Negative on error.
*/
int
rte_eal_devargs_insert(struct rte_devargs *da);
/**
* Add a device to the user device list
*
* For PCI devices, the format of arguments string is "PCI_ADDR" or
* "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
* "04:00.0,arg=val".
*
* For virtual devices, the format of arguments string is "DRIVER_NAME*"
* or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
* "net_ring0", "net_pmdAnything,arg=0:arg2=1". The validity of the
* driver name is not checked by this function, it is done when probing
* the drivers.
*
* @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
*/
int rte_eal_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 busname
* bus name of the devargs to remove.
*
* @param devname
* device name of the devargs to remove.
*
* @return
* 0 on success.
* <0 on error.
* >0 if the devargs was not within the user device list.
*/
int rte_eal_devargs_remove(const char *busname, const char *devname);
/**
* Count the number of user devices of a specified type
*
* @param devtype
* The type of the devices to counted.
*
* @return
* The number of devices.
*/
unsigned int
rte_eal_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
*/
void rte_eal_devargs_dump(FILE *f);
#ifdef __cplusplus
}
#endif
#endif /* _RTE_DEVARGS_H_ */
|