DPDK  17.11.1
rte_dev.h
Go to the documentation of this file.
1 /*-
2  * BSD LICENSE
3  *
4  * Copyright(c) 2014 6WIND S.A.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  * * Neither the name of 6WIND S.A. nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef _RTE_DEV_H_
35 #define _RTE_DEV_H_
36 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 #include <stdio.h>
50 #include <sys/queue.h>
51 
52 #include <rte_config.h>
53 #include <rte_log.h>
54 
55 __attribute__((format(printf, 2, 0)))
56 static inline void
57 rte_pmd_debug_trace(const char *func_name, const char *fmt, ...)
58 {
59  va_list ap;
60 
61  va_start(ap, fmt);
62 
63  char buffer[vsnprintf(NULL, 0, fmt, ap) + 1];
64 
65  va_end(ap);
66 
67  va_start(ap, fmt);
68  vsnprintf(buffer, sizeof(buffer), fmt, ap);
69  va_end(ap);
70 
71  rte_log(RTE_LOG_ERR, RTE_LOGTYPE_PMD, "%s: %s", func_name, buffer);
72 }
73 
74 /*
75  * Enable RTE_PMD_DEBUG_TRACE() when at least one component relying on the
76  * RTE_*_RET() macros defined below is compiled in debug mode.
77  */
78 #if defined(RTE_LIBRTE_ETHDEV_DEBUG) || \
79  defined(RTE_LIBRTE_CRYPTODEV_DEBUG) || \
80  defined(RTE_LIBRTE_EVENTDEV_DEBUG)
81 #define RTE_PMD_DEBUG_TRACE(...) \
82  rte_pmd_debug_trace(__func__, __VA_ARGS__)
83 #else
84 #define RTE_PMD_DEBUG_TRACE(...) (void)0
85 #endif
86 
87 /* Macros for checking for restricting functions to primary instance only */
88 #define RTE_PROC_PRIMARY_OR_ERR_RET(retval) do { \
89  if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
90  RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
91  return retval; \
92  } \
93 } while (0)
94 
95 #define RTE_PROC_PRIMARY_OR_RET() do { \
96  if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
97  RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
98  return; \
99  } \
100 } while (0)
101 
102 /* Macros to check for invalid function pointers */
103 #define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
104  if ((func) == NULL) { \
105  RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
106  return retval; \
107  } \
108 } while (0)
109 
110 #define RTE_FUNC_PTR_OR_RET(func) do { \
111  if ((func) == NULL) { \
112  RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
113  return; \
114  } \
115 } while (0)
116 
121  RTE_KDRV_UNKNOWN = 0,
122  RTE_KDRV_IGB_UIO,
123  RTE_KDRV_VFIO,
124  RTE_KDRV_UIO_GENERIC,
125  RTE_KDRV_NIC_UIO,
126  RTE_KDRV_NONE,
127 };
128 
133  RTE_DEV_WHITELISTED,
134  RTE_DEV_BLACKLISTED,
135 };
136 
141  uint64_t phys_addr;
142  uint64_t len;
143  void *addr;
144 };
145 
149 struct rte_driver {
150  TAILQ_ENTRY(rte_driver) next;
151  const char *name;
152  const char *alias;
153 };
154 
155 /*
156  * Internal identifier length
157  * Sufficiently large to allow for UUID or PCI address
158  */
159 #define RTE_DEV_NAME_MAX_LEN 64
160 
164 struct rte_device {
165  TAILQ_ENTRY(rte_device) next;
166  const char *name;
167  const struct rte_driver *driver;
168  int numa_node;
170 };
171 
185 int rte_eal_dev_attach(const char *name, const char *devargs);
186 
195 int rte_eal_dev_detach(struct rte_device *dev);
196 
213 int rte_eal_hotplug_add(const char *busname, const char *devname,
214  const char *devargs);
215 
229 int rte_eal_hotplug_remove(const char *busname, const char *devname);
230 
250 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
251 
252 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
253 
254 #define RTE_PMD_EXPORT_NAME(name, idx) \
255 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
256 __attribute__((used)) = RTE_STR(name)
257 
258 #define DRV_EXP_TAG(name, tag) __##name##_##tag
259 
260 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
261 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
262 RTE_STR(table)
263 
264 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
265 static const char DRV_EXP_TAG(name, param_string_export)[] \
266 __attribute__((used)) = str
267 
289 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
290 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
291 __attribute__((used)) = str
292 
293 #ifdef __cplusplus
294 }
295 #endif
296 
297 #endif /* _RTE_DEV_H_ */
#define RTE_LOG_ERR
Definition: rte_log.h:110
uint64_t len
Definition: rte_dev.h:142
int rte_log(uint32_t level, uint32_t logtype, const char *format,...)
int rte_eal_dev_attach(const char *name, const char *devargs)
int rte_eal_hotplug_add(const char *busname, const char *devname, const char *devargs)
int rte_eal_dev_detach(struct rte_device *dev)
uint64_t phys_addr
Definition: rte_dev.h:141
rte_kernel_driver
Definition: rte_dev.h:120
char name[RTE_DEV_NAME_MAX_LEN]
Definition: rte_devargs.h:84
rte_dev_policy
Definition: rte_dev.h:132
struct rte_devargs * devargs
Definition: rte_dev.h:169
int rte_eal_hotplug_remove(const char *busname, const char *devname)
int numa_node
Definition: rte_dev.h:168
#define RTE_LOGTYPE_PMD
Definition: rte_log.h:76
const char * name
Definition: rte_dev.h:151
const char * name
Definition: rte_dev.h:166
const char * alias
Definition: rte_dev.h:152
const struct rte_driver * driver
Definition: rte_dev.h:167
int(* rte_dev_cmp_t)(const struct rte_device *dev, const void *data)
Definition: rte_dev.h:250