DPDK  17.11.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 #include <rte_bus.h>
48 
49 #include <rte_pci_dev_feature_defs.h>
50 
51 #ifdef __cplusplus
52 extern "C" {
53 #endif
54 
55 #define RTE_MAGIC 19820526
57 /* Maximum thread_name length. */
58 #define RTE_MAX_THREAD_NAME_LEN 16
59 
64  ROLE_RTE,
65  ROLE_OFF,
66  ROLE_SERVICE,
67 };
68 
73  RTE_PROC_AUTO = -1, /* allow auto-detection of primary/secondary */
74  RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
75  RTE_PROC_SECONDARY,
76 
77  RTE_PROC_INVALID
78 };
79 
83 struct rte_config {
84  uint32_t master_lcore;
85  uint32_t lcore_count;
87  enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE];
91 
94 
100 } __attribute__((__packed__));
101 
109 
118 enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);
119 
120 
128 
138 int rte_eal_iopl_init(void);
139 
198 int rte_eal_init(int argc, char **argv);
199 
215 int rte_eal_primary_proc_alive(const char *config_file_path);
216 
223 typedef void (*rte_usage_hook_t)(const char * prgname);
224 
248 
252 #define RTE_EAL_TAILQ_RWLOCK (&rte_eal_get_configuration()->mem_config->qlock)
253 
257 #define RTE_EAL_MEMPOOL_RWLOCK (&rte_eal_get_configuration()->mem_config->mplock)
258 
269 int rte_eal_has_hugepages(void);
270 
278 int rte_eal_has_pci(void);
279 
286 int rte_eal_create_uio_dev(void);
287 
295 enum rte_intr_mode rte_eal_vfio_intr_mode(void);
296 
304 int rte_sys_gettid(void);
305 
313 static inline int rte_gettid(void)
314 {
315  static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
316  if (RTE_PER_LCORE(_thread_id) == -1)
317  RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
318  return RTE_PER_LCORE(_thread_id);
319 }
320 
328 
335 const char *
337 
341 void rte_eal_set_socket_permissions(const char *);
342 
343 #ifdef __cplusplus
344 }
345 #endif
346 
347 #endif /* _RTE_EAL_H_ */
uint32_t lcore_count
Definition: rte_eal.h:85
int rte_sys_gettid(void)
enum rte_iova_mode rte_eal_iova_mode(void)
rte_lcore_role_t
Definition: rte_eal.h:63
enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id)
int rte_eal_create_uio_dev(void)
const char * rte_eal_mbuf_default_mempool_ops(void)
int rte_eal_has_hugepages(void)
rte_iova_mode
Definition: rte_bus.h:67
enum rte_intr_mode rte_eal_vfio_intr_mode(void)
void rte_eal_set_socket_permissions(const char *)
enum rte_proc_type_t rte_eal_process_type(void)
uint32_t service_lcore_count
Definition: rte_eal.h:86
#define RTE_DEFINE_PER_LCORE(type, name)
Definition: rte_per_lcore.h:61
enum rte_iova_mode iova_mode
Definition: rte_eal.h:93
struct rte_mem_config * mem_config
Definition: rte_eal.h:99
enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]
Definition: rte_eal.h:87
struct rte_config * rte_eal_get_configuration(void)
void(* rte_usage_hook_t)(const char *prgname)
Definition: rte_eal.h:223
int rte_eal_primary_proc_alive(const char *config_file_path)
uint32_t master_lcore
Definition: rte_eal.h:84
rte_usage_hook_t rte_set_application_usage_hook(rte_usage_hook_t usage_func)
#define RTE_PER_LCORE(name)
Definition: rte_per_lcore.h:73
rte_proc_type_t
Definition: rte_eal.h:72
int rte_eal_init(int argc, char **argv)
int rte_eal_has_pci(void)
enum rte_proc_type_t process_type
Definition: rte_eal.h:90
static int rte_gettid(void)
Definition: rte_eal.h:313
int rte_eal_iopl_init(void)