lib/librte_eal/common/include/rte_devargs.h

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