DPDK  17.11.0
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_log.h>
53 
54 __attribute__((format(printf, 2, 0)))
55 static inline void
56 rte_pmd_debug_trace(const char *func_name, const char *fmt, ...)
57 {
58  va_list ap;
59 
60  va_start(ap, fmt);
61 
62  char buffer[vsnprintf(NULL, 0, fmt, ap) + 1];
63 
64  va_end(ap);
65 
66  va_start(ap, fmt);
67  vsnprintf(buffer, sizeof(buffer), fmt, ap);
68  va_end(ap);
69 
70  rte_log(RTE_LOG_ERR, RTE_LOGTYPE_PMD, "%s: %s", func_name, buffer);
71 }
72 
73 /*
74  * Enable RTE_PMD_DEBUG_TRACE() when at least one component relying on the
75  * RTE_*_RET() macros defined below is compiled in debug mode.
76  */
77 #if defined(RTE_LIBRTE_ETHDEV_DEBUG) || \
78  defined(RTE_LIBRTE_CRYPTODEV_DEBUG) || \
79  defined(RTE_LIBRTE_EVENTDEV_DEBUG)
80 #define RTE_PMD_DEBUG_TRACE(...) \
81  rte_pmd_debug_trace(__func__, __VA_ARGS__)
82 #else
83 #define RTE_PMD_DEBUG_TRACE(...) (void)0
84 #endif
85 
86 /* Macros for checking for restricting functions to primary instance only */
87 #define RTE_PROC_PRIMARY_OR_ERR_RET(retval) do { \
88  if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
89  RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
90  return retval; \
91  } \
92 } while (0)
93 
94 #define RTE_PROC_PRIMARY_OR_RET() do { \
95  if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
96  RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
97  return; \
98  } \
99 } while (0)
100 
101 /* Macros to check for invalid function pointers */
102 #define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
103  if ((func) == NULL) { \
104  RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
105  return retval; \
106  } \
107 } while (0)
108 
109 #define RTE_FUNC_PTR_OR_RET(func) do { \
110  if ((func) == NULL) { \
111  RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
112  return; \
113  } \
114 } while (0)
115 
120  RTE_KDRV_UNKNOWN = 0,
121  RTE_KDRV_IGB_UIO,
122  RTE_KDRV_VFIO,
123  RTE_KDRV_UIO_GENERIC,
124  RTE_KDRV_NIC_UIO,
125  RTE_KDRV_NONE,
126 };
127 
132  RTE_DEV_WHITELISTED,
133  RTE_DEV_BLACKLISTED,
134 };
135 
140  uint64_t phys_addr;
141  uint64_t len;
142  void *addr;
143 };
144 
148 struct rte_driver {
149  TAILQ_ENTRY(rte_driver) next;
150  const char *name;
151  const char *alias;
152 };
153 
154 /*
155  * Internal identifier length
156  * Sufficiently large to allow for UUID or PCI address
157  */
158 #define RTE_DEV_NAME_MAX_LEN 64
159 
163 struct rte_device {
164  TAILQ_ENTRY(rte_device) next;
165  const char *name;
166  const struct rte_driver *driver;
167  int numa_node;
169 };
170 
184 int rte_eal_dev_attach(const char *name, const char *devargs);
185 
194 int rte_eal_dev_detach(struct rte_device *dev);
195 
212 int rte_eal_hotplug_add(const char *busname, const char *devname,
213  const char *devargs);
214 
228 int rte_eal_hotplug_remove(const char *busname, const char *devname);
229 
249 typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
250 
251 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
252 
253 #define RTE_PMD_EXPORT_NAME(name, idx) \
254 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
255 __attribute__((used)) = RTE_STR(name)
256 
257 #define DRV_EXP_TAG(name, tag) __##name##_##tag
258 
259 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
260 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
261 RTE_STR(table)
262 
263 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
264 static const char DRV_EXP_TAG(name, param_string_export)[] \
265 __attribute__((used)) = str
266 
288 #define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
289 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
290 __attribute__((used)) = str
291 
292 #ifdef __cplusplus
293 }
294 #endif
295 
296 #endif /* _RTE_DEV_H_ */
#define RTE_LOG_ERR
Definition: rte_log.h:109
uint64_t len
Definition: rte_dev.h:141
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:140
rte_kernel_driver
Definition: rte_dev.h:119
char name[RTE_DEV_NAME_MAX_LEN]
Definition: rte_devargs.h:84
rte_dev_policy
Definition: rte_dev.h:131
struct rte_devargs * devargs
Definition: rte_dev.h:168
int rte_eal_hotplug_remove(const char *busname, const char *devname)
int numa_node
Definition: rte_dev.h:167
#define RTE_LOGTYPE_PMD
Definition: rte_log.h:75
const char * name
Definition: rte_dev.h:150
const char * name
Definition: rte_dev.h:165
const char * alias
Definition: rte_dev.h:151
const struct rte_driver * driver
Definition: rte_dev.h:166
int(* rte_dev_cmp_t)(const struct rte_device *dev, const void *data)
Definition: rte_dev.h:249