DPDK  16.11.9
rte_eal.h
Go to the documentation of this file.
1 /*-
2  * BSD LICENSE
3  *
4  * Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
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 Intel Corporation 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_EAL_H_
35 #define _RTE_EAL_H_
36 
43 #include <stdint.h>
44 #include <sched.h>
45 
46 #include <rte_per_lcore.h>
47 #include <rte_config.h>
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
53 #define RTE_MAGIC 19820526
55 /* Maximum thread_name length. */
56 #define RTE_MAX_THREAD_NAME_LEN 16
57 
62  ROLE_RTE,
63  ROLE_OFF,
64 };
65 
70  RTE_PROC_AUTO = -1, /* allow auto-detection of primary/secondary */
71  RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
72  RTE_PROC_SECONDARY,
73 
74  RTE_PROC_INVALID
75 };
76 
80 struct rte_config {
81  uint32_t master_lcore;
82  uint32_t lcore_count;
83  enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE];
87 
93 } __attribute__((__packed__));
94 
102 
111 enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);
112 
113 
121 
131 int rte_eal_iopl_init(void);
132 
159 int rte_eal_init(int argc, char **argv);
160 
176 int rte_eal_primary_proc_alive(const char *config_file_path);
177 
184 typedef void (*rte_usage_hook_t)(const char * prgname);
185 
209 
213 #define RTE_EAL_TAILQ_RWLOCK (&rte_eal_get_configuration()->mem_config->qlock)
214 
218 #define RTE_EAL_MEMPOOL_RWLOCK (&rte_eal_get_configuration()->mem_config->mplock)
219 
230 int rte_eal_has_hugepages(void);
231 
239 int rte_sys_gettid(void);
240 
248 static inline int rte_gettid(void)
249 {
250  static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
251  if (RTE_PER_LCORE(_thread_id) == -1)
252  RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
253  return RTE_PER_LCORE(_thread_id);
254 }
255 
256 #define RTE_INIT(func) \
257 static void __attribute__((constructor, used)) func(void)
258 
259 #ifdef __cplusplus
260 }
261 #endif
262 
263 #endif /* _RTE_EAL_H_ */