DPDK  16.04.0
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 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 #define RTE_MAGIC 19820526
54 /* Maximum thread_name length. */
55 #define RTE_MAX_THREAD_NAME_LEN 16
56 
61  ROLE_RTE,
62  ROLE_OFF,
63 };
64 
69  RTE_PROC_AUTO = -1, /* allow auto-detection of primary/secondary */
70  RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
71  RTE_PROC_SECONDARY,
72 
73  RTE_PROC_INVALID
74 };
75 
79 struct rte_config {
80  uint32_t master_lcore;
81  uint32_t lcore_count;
82  enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE];
86 
92 } __attribute__((__packed__));
93 
101 
110 enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);
111 
112 
120 
130 int rte_eal_iopl_init(void);
131 
158 int rte_eal_init(int argc, char **argv);
159 
175 int rte_eal_primary_proc_alive(const char *config_file_path);
176 
183 typedef void (*rte_usage_hook_t)(const char * prgname);
184 
208 
212 #define RTE_EAL_TAILQ_RWLOCK (&rte_eal_get_configuration()->mem_config->qlock)
213 
217 #define RTE_EAL_MEMPOOL_RWLOCK (&rte_eal_get_configuration()->mem_config->mplock)
218 
229 int rte_eal_has_hugepages(void);
230 
238 int rte_sys_gettid(void);
239 
247 static inline int rte_gettid(void)
248 {
249  static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
250  if (RTE_PER_LCORE(_thread_id) == -1)
251  RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
252  return RTE_PER_LCORE(_thread_id);
253 }
254 
255 #ifdef __cplusplus
256 }
257 #endif
258 
259 #endif /* _RTE_EAL_H_ */