DPDK  19.11.10
rte_eal.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2018 Intel Corporation
3  */
4 
5 #ifndef _RTE_EAL_H_
6 #define _RTE_EAL_H_
7 
14 #include <stdint.h>
15 #include <sched.h>
16 #include <time.h>
17 
18 #include <rte_config.h>
19 #include <rte_compat.h>
20 #include <rte_per_lcore.h>
21 #include <rte_bus.h>
22 
23 #include <rte_pci_dev_feature_defs.h>
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
29 #define RTE_MAGIC 19820526
31 /* Maximum thread_name length. */
32 #define RTE_MAX_THREAD_NAME_LEN 16
33 
38  ROLE_RTE,
39  ROLE_OFF,
40  ROLE_SERVICE,
41 };
42 
47  RTE_PROC_AUTO = -1, /* allow auto-detection of primary/secondary */
48  RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
49  RTE_PROC_SECONDARY,
50 
51  RTE_PROC_INVALID
52 };
53 
61 
71 int rte_eal_iopl_init(void);
72 
131 int rte_eal_init(int argc, char **argv);
132 
145 int rte_eal_cleanup(void);
146 
162 int rte_eal_primary_proc_alive(const char *config_file_path);
163 
164 #define RTE_MP_MAX_FD_NUM 8 /* The max amount of fds */
165 #define RTE_MP_MAX_NAME_LEN 64 /* The max length of action name */
166 #define RTE_MP_MAX_PARAM_LEN 256 /* The max length of param */
167 struct rte_mp_msg {
168  char name[RTE_MP_MAX_NAME_LEN];
169  int len_param;
170  int num_fds;
171  uint8_t param[RTE_MP_MAX_PARAM_LEN];
172  int fds[RTE_MP_MAX_FD_NUM];
173 };
174 
175 struct rte_mp_reply {
176  int nb_sent;
177  int nb_received;
178  struct rte_mp_msg *msgs; /* caller to free */
179 };
180 
194 typedef int (*rte_mp_t)(const struct rte_mp_msg *msg, const void *peer);
195 
210 typedef int (*rte_mp_async_reply_t)(const struct rte_mp_msg *request,
211  const struct rte_mp_reply *reply);
212 
236 __rte_experimental
237 int
238 rte_mp_action_register(const char *name, rte_mp_t action);
239 
257 __rte_experimental
258 void
259 rte_mp_action_unregister(const char *name);
260 
277 __rte_experimental
278 int
279 rte_mp_sendmsg(struct rte_mp_msg *msg);
280 
312 __rte_experimental
313 int
314 rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply,
315  const struct timespec *ts);
316 
342 __rte_experimental
343 int
344 rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts,
346 
371 __rte_experimental
372 int
373 rte_mp_reply(struct rte_mp_msg *msg, const char *peer);
374 
381 typedef void (*rte_usage_hook_t)(const char * prgname);
382 
406 
414 int rte_eal_has_hugepages(void);
415 
423 int rte_eal_has_pci(void);
424 
431 int rte_eal_create_uio_dev(void);
432 
440 enum rte_intr_mode rte_eal_vfio_intr_mode(void);
441 
449 int rte_sys_gettid(void);
450 
458 static inline int rte_gettid(void)
459 {
460  static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
461  if (RTE_PER_LCORE(_thread_id) == -1)
462  RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
463  return RTE_PER_LCORE(_thread_id);
464 }
465 
473 
480 const char *
482 
489 const char *
491 
492 #ifdef __cplusplus
493 }
494 #endif
495 
496 #endif /* _RTE_EAL_H_ */
__rte_experimental int rte_mp_action_register(const char *name, rte_mp_t action)
int rte_sys_gettid(void)
enum rte_iova_mode rte_eal_iova_mode(void)
__rte_experimental void rte_mp_action_unregister(const char *name)
rte_lcore_role_t
Definition: rte_eal.h:37
int(* rte_mp_async_reply_t)(const struct rte_mp_msg *request, const struct rte_mp_reply *reply)
Definition: rte_eal.h:210
int rte_eal_create_uio_dev(void)
int rte_eal_has_hugepages(void)
rte_iova_mode
Definition: rte_bus.h:39
__rte_experimental int rte_mp_sendmsg(struct rte_mp_msg *msg)
enum rte_intr_mode rte_eal_vfio_intr_mode(void)
const char * rte_eal_mbuf_user_pool_ops(void)
const char * rte_eal_get_runtime_dir(void)
enum rte_proc_type_t rte_eal_process_type(void)
#define RTE_DEFINE_PER_LCORE(type, name)
Definition: rte_per_lcore.h:32
__rte_experimental int rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply, const struct timespec *ts)
int rte_eal_cleanup(void)
void(* rte_usage_hook_t)(const char *prgname)
Definition: rte_eal.h:381
int rte_eal_primary_proc_alive(const char *config_file_path)
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:44
rte_proc_type_t
Definition: rte_eal.h:46
__rte_experimental int rte_mp_reply(struct rte_mp_msg *msg, const char *peer)
__rte_experimental int rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts, rte_mp_async_reply_t clb)
int rte_eal_init(int argc, char **argv)
int(* rte_mp_t)(const struct rte_mp_msg *msg, const void *peer)
Definition: rte_eal.h:194
int rte_eal_has_pci(void)
static int rte_gettid(void)
Definition: rte_eal.h:458
int rte_eal_iopl_init(void)