DPDK  22.11.0
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 <time.h>
16 
17 #include <rte_config.h>
18 #include <rte_compat.h>
19 #include <rte_per_lcore.h>
20 #include <rte_uuid.h>
21 
22 #include <rte_pci_dev_feature_defs.h>
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 #define RTE_MAGIC 19820526
30 /* Maximum thread_name length. */
31 #define RTE_MAX_THREAD_NAME_LEN 16
32 
37  RTE_PROC_AUTO = -1, /* allow auto-detection of primary/secondary */
38  RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
39  RTE_PROC_SECONDARY,
40 
41  RTE_PROC_INVALID
42 };
43 
51 
61 int rte_eal_iopl_init(void);
62 
113 int rte_eal_init(int argc, char **argv);
114 
127 int rte_eal_cleanup(void);
128 
144 int rte_eal_primary_proc_alive(const char *config_file_path);
145 
157 bool rte_mp_disable(void);
158 
159 #define RTE_MP_MAX_FD_NUM 8 /* The max amount of fds */
160 #define RTE_MP_MAX_NAME_LEN 64 /* The max length of action name */
161 #define RTE_MP_MAX_PARAM_LEN 256 /* The max length of param */
162 struct rte_mp_msg {
163  char name[RTE_MP_MAX_NAME_LEN];
164  int len_param;
165  int num_fds;
166  uint8_t param[RTE_MP_MAX_PARAM_LEN];
167  int fds[RTE_MP_MAX_FD_NUM];
168 };
169 
170 struct rte_mp_reply {
171  int nb_sent;
172  int nb_received;
173  struct rte_mp_msg *msgs; /* caller to free */
174 };
175 
189 typedef int (*rte_mp_t)(const struct rte_mp_msg *msg, const void *peer);
190 
205 typedef int (*rte_mp_async_reply_t)(const struct rte_mp_msg *request,
206  const struct rte_mp_reply *reply);
207 
228 int
229 rte_mp_action_register(const char *name, rte_mp_t action);
230 
245 void
246 rte_mp_action_unregister(const char *name);
247 
261 int
262 rte_mp_sendmsg(struct rte_mp_msg *msg);
263 
292 int
293 rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply,
294  const struct timespec *ts);
295 
318 int
319 rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts,
321 
343 int
344 rte_mp_reply(struct rte_mp_msg *msg, const char *peer);
345 
352 typedef void (*rte_usage_hook_t)(const char * prgname);
353 
377 
385 int rte_eal_has_hugepages(void);
386 
394 int rte_eal_has_pci(void);
395 
402 int rte_eal_create_uio_dev(void);
403 
411 enum rte_intr_mode rte_eal_vfio_intr_mode(void);
412 
423 __rte_experimental
425 
433 int rte_sys_gettid(void);
434 
435 RTE_DECLARE_PER_LCORE(int, _thread_id);
436 
444 static inline int rte_gettid(void)
445 {
446  if (RTE_PER_LCORE(_thread_id) == -1)
447  RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
448  return RTE_PER_LCORE(_thread_id);
449 }
450 
457 __rte_internal
458 uint64_t rte_eal_get_baseaddr(void);
459 
469  RTE_IOVA_DC = 0, /* Don't care mode */
470  RTE_IOVA_PA = (1 << 0), /* DMA using physical address */
471  RTE_IOVA_VA = (1 << 1) /* DMA using virtual address */
472 };
473 
481 
488 const char *
490 
497 const char *
499 
516 __rte_internal
517 int
518 rte_eal_parse_coremask(const char *coremask, int *cores);
519 
520 #ifdef __cplusplus
521 }
522 #endif
523 
524 #endif /* _RTE_EAL_H_ */
#define RTE_DECLARE_PER_LCORE(type, name)
Definition: rte_per_lcore.h:38
int rte_sys_gettid(void)
enum rte_iova_mode rte_eal_iova_mode(void)
int(* rte_mp_async_reply_t)(const struct rte_mp_msg *request, const struct rte_mp_reply *reply)
Definition: rte_eal.h:205
int rte_eal_create_uio_dev(void)
int rte_mp_reply(struct rte_mp_msg *msg, const char *peer)
int rte_eal_has_hugepages(void)
__rte_experimental void rte_eal_vfio_get_vf_token(rte_uuid_t vf_token)
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)
__rte_internal int rte_eal_parse_coremask(const char *coremask, int *cores)
unsigned char rte_uuid_t[16]
Definition: rte_uuid.h:24
int rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply, const struct timespec *ts)
int rte_eal_cleanup(void)
int rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts, rte_mp_async_reply_t clb)
void(* rte_usage_hook_t)(const char *prgname)
Definition: rte_eal.h:352
rte_iova_mode
Definition: rte_eal.h:468
int rte_eal_primary_proc_alive(const char *config_file_path)
int rte_mp_action_register(const char *name, rte_mp_t action)
int rte_mp_sendmsg(struct rte_mp_msg *msg)
void rte_mp_action_unregister(const char *name)
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:36
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:189
int rte_eal_has_pci(void)
static int rte_gettid(void)
Definition: rte_eal.h:444
__rte_internal uint64_t rte_eal_get_baseaddr(void)
int rte_eal_iopl_init(void)
bool rte_mp_disable(void)