DPDK  16.04.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 /* Macros for checking for restricting functions to primary instance only */
74 #define RTE_PROC_PRIMARY_OR_ERR_RET(retval) do { \
75  if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
76  RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
77  return retval; \
78  } \
79 } while (0)
80 
81 #define RTE_PROC_PRIMARY_OR_RET() do { \
82  if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
83  RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
84  return; \
85  } \
86 } while (0)
87 
88 /* Macros to check for invalid function pointers */
89 #define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
90  if ((func) == NULL) { \
91  RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
92  return retval; \
93  } \
94 } while (0)
95 
96 #define RTE_FUNC_PTR_OR_RET(func) do { \
97  if ((func) == NULL) { \
98  RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
99  return; \
100  } \
101 } while (0)
102 
103 
105 TAILQ_HEAD(rte_driver_list, rte_driver);
106 
110 typedef int (rte_dev_init_t)(const char *name, const char *args);
111 
115 typedef int (rte_dev_uninit_t)(const char *name);
116 
120 enum pmd_type {
121  PMD_VDEV = 0,
122  PMD_PDEV = 1,
123 };
124 
128 struct rte_driver {
129  TAILQ_ENTRY(rte_driver) next;
130  enum pmd_type type;
131  const char *name;
134 };
135 
143 void rte_eal_driver_register(struct rte_driver *driver);
144 
152 void rte_eal_driver_unregister(struct rte_driver *driver);
153 
157 int rte_eal_dev_init(void);
158 
169 int rte_eal_vdev_init(const char *name, const char *args);
170 
179 int rte_eal_vdev_uninit(const char *name);
180 
181 #define PMD_REGISTER_DRIVER(d)\
182 void devinitfn_ ##d(void);\
183 void __attribute__((constructor, used)) devinitfn_ ##d(void)\
184 {\
185  rte_eal_driver_register(&d);\
186 }
187 
188 #ifdef __cplusplus
189 }
190 #endif
191 
192 #endif /* _RTE_VDEV_H_ */