DPDK  20.11.6
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 #include <rte_uuid.h>
23 
24 #include <rte_pci_dev_feature_defs.h>
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30 #define RTE_MAGIC 19820526
32 /* Maximum thread_name length. */
33 #define RTE_MAX_THREAD_NAME_LEN 16
34 
39  RTE_PROC_AUTO = -1, /* allow auto-detection of primary/secondary */
40  RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
41  RTE_PROC_SECONDARY,
42 
43  RTE_PROC_INVALID
44 };
45 
53 
63 int rte_eal_iopl_init(void);
64 
115 int rte_eal_init(int argc, char **argv);
116 
129 int rte_eal_cleanup(void);
130 
146 int rte_eal_primary_proc_alive(const char *config_file_path);
147 
159 __rte_experimental
160 bool rte_mp_disable(void);
161 
162 #define RTE_MP_MAX_FD_NUM 8 /* The max amount of fds */
163 #define RTE_MP_MAX_NAME_LEN 64 /* The max length of action name */
164 #define RTE_MP_MAX_PARAM_LEN 256 /* The max length of param */
165 struct rte_mp_msg {
166  char name[RTE_MP_MAX_NAME_LEN];
167  int len_param;
168  int num_fds;
169  uint8_t param[RTE_MP_MAX_PARAM_LEN];
170  int fds[RTE_MP_MAX_FD_NUM];
171 };
172 
173 struct rte_mp_reply {
174  int nb_sent;
175  int nb_received;
176  struct rte_mp_msg *msgs; /* caller to free */
177 };
178 
192 typedef int (*rte_mp_t)(const struct rte_mp_msg *msg, const void *peer);
193 
208 typedef int (*rte_mp_async_reply_t)(const struct rte_mp_msg *request,
209  const struct rte_mp_reply *reply);
210 
234 __rte_experimental
235 int
236 rte_mp_action_register(const char *name, rte_mp_t action);
237 
255 __rte_experimental
256 void
257 rte_mp_action_unregister(const char *name);
258 
275 __rte_experimental
276 int
277 rte_mp_sendmsg(struct rte_mp_msg *msg);
278 
310 __rte_experimental
311 int
312 rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply,
313  const struct timespec *ts);
314 
340 __rte_experimental
341 int
342 rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts,
344 
369 __rte_experimental
370 int
371 rte_mp_reply(struct rte_mp_msg *msg, const char *peer);
372 
379 typedef void (*rte_usage_hook_t)(const char * prgname);
380 
404 
412 int rte_eal_has_hugepages(void);
413 
421 int rte_eal_has_pci(void);
422 
429 int rte_eal_create_uio_dev(void);
430 
438 enum rte_intr_mode rte_eal_vfio_intr_mode(void);
439 
450 __rte_experimental
452 
460 int rte_sys_gettid(void);
461 
462 RTE_DECLARE_PER_LCORE(int, _thread_id);
463 
471 static inline int rte_gettid(void)
472 {
473  if (RTE_PER_LCORE(_thread_id) == -1)
474  RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
475  return RTE_PER_LCORE(_thread_id);
476 }
477 
485 
492 const char *
494 
501 const char *
503 
504 #ifdef __cplusplus
505 }
506 #endif
507 
508 #endif /* _RTE_EAL_H_ */
#define RTE_DECLARE_PER_LCORE(type, name)
Definition: rte_per_lcore.h:38
__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)
int(* rte_mp_async_reply_t)(const struct rte_mp_msg *request, const struct rte_mp_reply *reply)
Definition: rte_eal.h:208
int rte_eal_create_uio_dev(void)
int rte_eal_has_hugepages(void)
rte_iova_mode
Definition: rte_bus.h:39
__rte_experimental void rte_eal_vfio_get_vf_token(rte_uuid_t vf_token)
__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)
unsigned char rte_uuid_t[16]
Definition: rte_uuid.h:24
__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:379
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:38
__rte_experimental bool rte_mp_disable(void)
__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:192
int rte_eal_has_pci(void)
static int rte_gettid(void)
Definition: rte_eal.h:471
int rte_eal_iopl_init(void)