DPDK  16.11.9
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  {
64  char buffer[vsnprintf(NULL, 0, fmt, ap) + 1];
65 
66  va_end(ap);
67 
68  va_start(ap, fmt);
69  vsnprintf(buffer, sizeof(buffer), fmt, ap);
70  va_end(ap);
71 
73  func_name, buffer);
74  }
75 }
76 
77 /*
78  * Enable RTE_PMD_DEBUG_TRACE() when at least one component relying on the
79  * RTE_*_RET() macros defined below is compiled in debug mode.
80  */
81 #if defined(RTE_LIBRTE_ETHDEV_DEBUG) || \
82  defined(RTE_LIBRTE_CRYPTODEV_DEBUG) || \
83  defined(RTE_LIBRTE_EVENTDEV_DEBUG)
84 #define RTE_PMD_DEBUG_TRACE(...) \
85  rte_pmd_debug_trace(__func__, __VA_ARGS__)
86 #else
87 #define RTE_PMD_DEBUG_TRACE(...) (void)0
88 #endif
89 
90 /* Macros for checking for restricting functions to primary instance only */
91 #define RTE_PROC_PRIMARY_OR_ERR_RET(retval) do { \
92  if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
93  RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
94  return retval; \
95  } \
96 } while (0)
97 
98 #define RTE_PROC_PRIMARY_OR_RET() do { \
99  if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
100  RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
101  return; \
102  } \
103 } while (0)
104 
105 /* Macros to check for invalid function pointers */
106 #define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
107  if ((func) == NULL) { \
108  RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
109  return retval; \
110  } \
111 } while (0)
112 
113 #define RTE_FUNC_PTR_OR_RET(func) do { \
114  if ((func) == NULL) { \
115  RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
116  return; \
117  } \
118 } while (0)
119 
124  uint64_t phys_addr;
125  uint64_t len;
126  void *addr;
127 };
128 
130 TAILQ_HEAD(rte_driver_list, rte_driver);
132 TAILQ_HEAD(rte_device_list, rte_device);
133 
134 /* Forward declaration */
135 struct rte_driver;
136 
140 struct rte_device {
141  TAILQ_ENTRY(rte_device) next;
142  struct rte_driver *driver;
143  int numa_node;
145 };
146 
153 void rte_eal_device_insert(struct rte_device *dev);
154 
161 void rte_eal_device_remove(struct rte_device *dev);
162 
166 struct rte_driver {
167  TAILQ_ENTRY(rte_driver) next;
168  const char *name;
169  const char *alias;
170 };
171 
179 void rte_eal_driver_register(struct rte_driver *driver);
180 
188 void rte_eal_driver_unregister(struct rte_driver *driver);
189 
193 int rte_eal_dev_init(void);
194 
205 int rte_eal_vdev_init(const char *name, const char *args);
206 
215 int rte_eal_vdev_uninit(const char *name);
216 
230 int rte_eal_dev_attach(const char *name, const char *devargs);
231 
241 int rte_eal_dev_detach(const char *name);
242 
243 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
244 
245 #define RTE_PMD_EXPORT_NAME(name, idx) \
246 static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
247 __attribute__((used)) = RTE_STR(name)
248 
249 #define DRV_EXP_TAG(name, tag) __##name##_##tag
250 
251 #define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
252 static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
253 RTE_STR(table)
254 
255 #define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
256 static const char DRV_EXP_TAG(name, param_string_export)[] \
257 __attribute__((used)) = str
258 
259 #ifdef __cplusplus
260 }
261 #endif
262 
263 #endif /* _RTE_VDEV_H_ */