DPDK
22.11.7-rc1
|
#include <stdint.h>
#include <time.h>
#include <rte_config.h>
#include <rte_compat.h>
#include <rte_per_lcore.h>
#include <rte_uuid.h>
#include <rte_pci_dev_feature_defs.h>
Go to the source code of this file.
Macros | |
#define | RTE_MAGIC 19820526 |
Typedefs | |
typedef int(* | rte_mp_t) (const struct rte_mp_msg *msg, const void *peer) |
typedef int(* | rte_mp_async_reply_t) (const struct rte_mp_msg *request, const struct rte_mp_reply *reply) |
typedef void(* | rte_usage_hook_t) (const char *prgname) |
Enumerations | |
enum | rte_proc_type_t |
enum | rte_iova_mode |
Functions | |
enum rte_proc_type_t | rte_eal_process_type (void) |
int | rte_eal_iopl_init (void) |
int | rte_eal_init (int argc, char **argv) |
int | rte_eal_cleanup (void) |
int | rte_eal_primary_proc_alive (const char *config_file_path) |
bool | rte_mp_disable (void) |
int | rte_mp_action_register (const char *name, rte_mp_t action) |
void | rte_mp_action_unregister (const char *name) |
int | rte_mp_sendmsg (struct rte_mp_msg *msg) |
int | rte_mp_request_sync (struct rte_mp_msg *req, struct rte_mp_reply *reply, const struct timespec *ts) |
int | rte_mp_request_async (struct rte_mp_msg *req, const struct timespec *ts, rte_mp_async_reply_t clb) |
int | rte_mp_reply (struct rte_mp_msg *msg, const char *peer) |
rte_usage_hook_t | rte_set_application_usage_hook (rte_usage_hook_t usage_func) |
int | rte_eal_has_hugepages (void) |
int | rte_eal_has_pci (void) |
int | rte_eal_create_uio_dev (void) |
enum rte_intr_mode | rte_eal_vfio_intr_mode (void) |
__rte_experimental void | rte_eal_vfio_get_vf_token (rte_uuid_t vf_token) |
int | rte_sys_gettid (void) |
static int | rte_gettid (void) |
__rte_internal uint64_t | rte_eal_get_baseaddr (void) |
enum rte_iova_mode | rte_eal_iova_mode (void) |
const char * | rte_eal_mbuf_user_pool_ops (void) |
const char * | rte_eal_get_runtime_dir (void) |
__rte_internal int | rte_eal_parse_coremask (const char *coremask, int *cores) |
EAL Configuration API
Definition in file rte_eal.h.
#define RTE_MAGIC 19820526 |
typedef int(* rte_mp_t) (const struct rte_mp_msg *msg, const void *peer) |
Action function typedef used by other components.
As we create socket channel for primary/secondary communication, use this function typedef to register action for coming messages.
typedef int(* rte_mp_async_reply_t) (const struct rte_mp_msg *request, const struct rte_mp_reply *reply) |
Asynchronous reply function typedef used by other components.
As we create socket channel for primary/secondary communication, use this function typedef to register action for coming responses to asynchronous requests.
typedef void(* rte_usage_hook_t) (const char *prgname) |
Usage function typedef used by the application usage function.
Use this function typedef to define and call rte_set_application_usage_hook() routine.
enum rte_proc_type_t |
enum rte_iova_mode |
enum rte_proc_type_t rte_eal_process_type | ( | void | ) |
Get the process type in a multi-process setup
int rte_eal_iopl_init | ( | void | ) |
Request iopl privilege for all RPL.
This function should be called by pmds which need access to ioports.
int rte_eal_init | ( | int | argc, |
char ** | argv | ||
) |
Initialize the Environment Abstraction Layer (EAL).
This function is to be executed on the MAIN lcore only, as soon as possible in the application's main() function. It puts the WORKER lcores in the WAIT state.
argc | A non-negative value. If it is greater than 0, the array members for argv[0] through argv[argc] (non-inclusive) shall contain pointers to strings. |
argv | An array of strings. The contents of the array, as well as the strings which are pointed to by the array, may be modified by this function. |
Error codes returned via rte_errno: EACCES indicates a permissions issue.
EAGAIN indicates either a bus or system resource was not available, setup may be attempted again.
EALREADY indicates that the rte_eal_init function has already been called, and cannot be called again.
EFAULT indicates the tailq configuration name was not found in memory configuration.
EINVAL indicates invalid parameters were passed as argv/argc.
ENOMEM indicates failure likely caused by an out-of-memory condition.
ENODEV indicates memory setup issues.
ENOTSUP indicates that the EAL cannot initialize on this system.
EPROTO indicates that the PCI bus is either not present, or is not readable by the eal.
ENOEXEC indicates that a service core failed to launch successfully.
int rte_eal_cleanup | ( | void | ) |
Clean up the Environment Abstraction Layer (EAL)
This function must be called to release any internal resources that EAL has allocated during rte_eal_init(). After this call, no DPDK function calls may be made. It is expected that common usage of this function is to call it just before terminating the process.
int rte_eal_primary_proc_alive | ( | const char * | config_file_path | ) |
Check if a primary process is currently alive
This function returns true when a primary process is currently active.
config_file_path | The config_file_path argument provided should point at the location that the primary process will create its config file. If NULL, the default config file path is used. |
bool rte_mp_disable | ( | void | ) |
Disable multiprocess.
This function can be called to indicate that multiprocess won't be used for the rest of the application life.
int rte_mp_action_register | ( | const char * | name, |
rte_mp_t | action | ||
) |
Register an action function for primary/secondary communication.
Call this function to register an action, if the calling component wants to response the messages from the corresponding component in its primary process or secondary processes.
name | The name argument plays as the nonredundant key to find the action. |
action | The action argument is the function pointer to the action function. |
void rte_mp_action_unregister | ( | const char * | name | ) |
Unregister an action function for primary/secondary communication.
Call this function to unregister an action if the calling component does not want to response the messages from the corresponding component in its primary process or secondary processes.
name | The name argument plays as the nonredundant key to find the action. |
int rte_mp_sendmsg | ( | struct rte_mp_msg * | msg | ) |
Send a message to the peer process.
This function will send a message which will be responded by the action identified by name in the peer process.
msg | The msg argument contains the customized message. |
int rte_mp_request_sync | ( | struct rte_mp_msg * | req, |
struct rte_mp_reply * | reply, | ||
const struct timespec * | ts | ||
) |
Send a request to the peer process and expect a reply.
This function sends a request message to the peer process, and will block until receiving reply message from the peer process.
req | The req argument contains the customized request message. |
reply | The reply argument will be for storing all the replied messages; the caller is responsible for free reply->msgs. |
ts | The ts argument specifies how long we can wait for the peer(s) to reply. |
int rte_mp_request_async | ( | struct rte_mp_msg * | req, |
const struct timespec * | ts, | ||
rte_mp_async_reply_t | clb | ||
) |
Send a request to the peer process and expect a reply in a separate callback.
This function sends a request message to the peer process, and will not block. Instead, reply will be received in a separate callback.
req | The req argument contains the customized request message. |
ts | The ts argument specifies how long we can wait for the peer(s) to reply. |
clb | The callback to trigger when all responses for this request have arrived. |
int rte_mp_reply | ( | struct rte_mp_msg * | msg, |
const char * | peer | ||
) |
Send a reply to the peer process.
This function will send a reply message in response to a request message received previously.
msg | The msg argument contains the customized message. |
peer | The peer argument is the pointer to the peer socket path. |
rte_usage_hook_t rte_set_application_usage_hook | ( | rte_usage_hook_t | usage_func | ) |
Add application usage routine callout from the eal_usage() routine.
This function allows the application to include its usage message in the EAL system usage message. The routine rte_set_application_usage_hook() needs to be called before the rte_eal_init() routine in the application.
This routine is optional for the application and will behave as if the set routine was never called as the default behavior.
usage_func | The func argument is a function pointer to the application usage routine. Called function is defined using rte_usage_hook_t typedef, which is of the form void rte_usage_func(const char * prgname). |
Calling this routine with a NULL value will reset the usage hook routine and return the current value, which could be NULL.
int rte_eal_has_hugepages | ( | void | ) |
Whether EAL is using huge pages (disabled by –no-huge option). The no-huge mode is not compatible with all drivers or features.
int rte_eal_has_pci | ( | void | ) |
Whether EAL is using PCI bus. Disabled by –no-pci option.
int rte_eal_create_uio_dev | ( | void | ) |
Whether the EAL was asked to create UIO device.
enum rte_intr_mode rte_eal_vfio_intr_mode | ( | void | ) |
The user-configured vfio interrupt mode.
__rte_experimental void rte_eal_vfio_get_vf_token | ( | rte_uuid_t | vf_token | ) |
Copy the user-configured vfio VF token.
vf_token | vfio VF token configured with the command line is copied into this parameter, zero uuid by default. |
int rte_sys_gettid | ( | void | ) |
A wrap API for syscall gettid.
|
inlinestatic |
__rte_internal uint64_t rte_eal_get_baseaddr | ( | void | ) |
Get the OS-specific EAL base address.
enum rte_iova_mode rte_eal_iova_mode | ( | void | ) |
Get the iova mode
const char* rte_eal_mbuf_user_pool_ops | ( | void | ) |
Get user provided pool ops name for mbuf
const char* rte_eal_get_runtime_dir | ( | void | ) |
Get the runtime directory of DPDK
__rte_internal int rte_eal_parse_coremask | ( | const char * | coremask, |
int * | cores | ||
) |
Convert a string describing a mask of core ids into an array of core ids.
On success, the passed array is filled with the orders of the core ids present in the mask (-1 indicating that a core id is absent). For example, passing a 0xa coremask results in cores[1] = 0, cores[3] = 1, and the rest of the array is set to -1.
coremask | A string describing a mask of core ids. |
cores | An array where to store the core ids orders. This array must be at least RTE_MAX_LCORE large. |