rte_eal.h File Reference

#include <stdint.h>
#include <sched.h>
#include <time.h>
#include <rte_config.h>
#include <rte_compat.h>
#include <rte_per_lcore.h>
#include <rte_bus.h>
#include <rte_pci_dev_feature_defs.h>

Go to the source code of this file.

Data Structures
struct	rte_config

Macros
#define	RTE_MAGIC   19820526
#define	RTE_EAL_TAILQ_RWLOCK   (&rte_eal_get_configuration()->mem_config->qlock)
#define	RTE_EAL_MEMPOOL_RWLOCK   (&rte_eal_get_configuration()->mem_config->mplock)

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_lcore_role_t
enum	rte_proc_type_t

Functions
struct rte_config *	rte_eal_get_configuration (void)
enum rte_lcore_role_t	rte_eal_lcore_role (unsigned lcore_id)
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)
int __rte_experimental	rte_mp_action_register (const char *name, rte_mp_t action)
void __rte_experimental	rte_mp_action_unregister (const char *name)
int __rte_experimental	rte_mp_sendmsg (struct rte_mp_msg *msg)
int __rte_experimental	rte_mp_request_sync (struct rte_mp_msg *req, struct rte_mp_reply *reply, const struct timespec *ts)
int __rte_experimental	rte_mp_request_async (struct rte_mp_msg *req, const struct timespec *ts, rte_mp_async_reply_t clb)
int __rte_experimental	rte_mp_reply (struct rte_mp_msg *msg, const char *peer)
int __rte_experimental	rte_mp_dev_hotplug_init (void)
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)
int	rte_sys_gettid (void)
static int	rte_gettid (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)

Detailed Description

EAL Configuration API

Definition in file rte_eal.h.

Macro Definition Documentation

RTE_MAGIC

#define RTE_MAGIC   19820526

Magic number written by the main partition when ready.

Definition at line 29 of file rte_eal.h.

RTE_EAL_TAILQ_RWLOCK

#define RTE_EAL_TAILQ_RWLOCK   (&rte_eal_get_configuration()->mem_config->qlock)

macro to get the lock of tailq in mem_config

Definition at line 455 of file rte_eal.h.

RTE_EAL_MEMPOOL_RWLOCK

#define RTE_EAL_MEMPOOL_RWLOCK   (&rte_eal_get_configuration()->mem_config->mplock)

macro to get the multiple lock of mempool shared by multiple-instance

Definition at line 460 of file rte_eal.h.

Typedef Documentation

rte_mp_t

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.

Note

When handling IPC request callbacks, the reply must be sent even in cases of error handling. Simply returning success or failure will not send a response to the requestor. Implementation of error signalling mechanism is up to the application.

No memory allocations should take place inside the callback.

Definition at line 236 of file rte_eal.h.

rte_mp_async_reply_t

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.

Note

When handling IPC request callbacks, the reply must be sent even in cases of error handling. Simply returning success or failure will not send a response to the requestor. Implementation of error signalling mechanism is up to the application.

No memory allocations should take place inside the callback.

Definition at line 252 of file rte_eal.h.

rte_usage_hook_t

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.

Definition at line 426 of file rte_eal.h.

Enumeration Type Documentation

rte_lcore_role_t

enum rte_lcore_role_t

The lcore role (used in RTE or not).

Definition at line 37 of file rte_eal.h.

rte_proc_type_t

enum rte_proc_type_t

The type of process in a linux, multi-process setup

Definition at line 46 of file rte_eal.h.

Function Documentation

rte_eal_get_configuration()

struct rte_config* rte_eal_get_configuration

(

void

)

Get the global configuration structure.

Returns

A pointer to the global configuration structure.

rte_eal_lcore_role()

enum rte_lcore_role_t rte_eal_lcore_role

(

unsigned

lcore_id

)

Get a lcore's role.

Parameters

lcore_id

The identifier of the lcore.

Returns

The role of the lcore.

rte_eal_process_type()

enum rte_proc_type_t rte_eal_process_type

(

void

)

Get the process type in a multi-process setup

Returns

The process type

Examples

examples/multi_process/simple_mp/main.c, and examples/multi_process/symmetric_mp/main.c.

rte_eal_iopl_init()

int rte_eal_iopl_init

(

void

)

Request iopl privilege for all RPL.

This function should be called by pmds which need access to ioports.

Returns

• On success, returns 0.
• On failure, returns -1.

rte_eal_init()

int rte_eal_init	(	int	argc,
		char **	argv
	)

Initialize the Environment Abstraction Layer (EAL).

This function is to be executed on the MASTER lcore only, as soon as possible in the application's main() function.

The function finishes the initialization process before main() is called. It puts the SLAVE lcores in the WAIT state.

When the multi-partition feature is supported, depending on the configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this function waits to ensure that the magic number is set before returning. See also the rte_eal_get_configuration() function. Note: This behavior may change in the future.

Parameters

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.

Returns

• On success, the number of parsed arguments, which is greater or equal to zero. After the call to rte_eal_init(), all arguments argv[x] with x < ret may have been modified by this function call and should not be further interpreted by the application. The EAL does not take any ownership of the memory used for either the argv array, or its members.
• On failure, -1 and rte_errno is set to a value indicating the cause for failure. In some instances, the application will need to be restarted as part of clearing the issue.

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.

Examples

examples/bbdev_app/main.c, examples/bond/main.c, examples/cmdline/main.c, examples/distributor/main.c, examples/ethtool/ethtool-app/main.c, examples/eventdev_pipeline/main.c, examples/exception_path/main.c, examples/fips_validation/main.c, examples/flow_classify/flow_classify.c, examples/flow_filtering/main.c, examples/helloworld/main.c, examples/ip_fragmentation/main.c, examples/ip_pipeline/main.c, examples/ip_reassembly/main.c, examples/ipsec-secgw/ipsec-secgw.c, examples/ipv4_multicast/main.c, examples/kni/main.c, examples/l2fwd-cat/l2fwd-cat.c, examples/l2fwd-crypto/main.c, examples/l2fwd-jobstats/main.c, examples/l2fwd-keepalive/main.c, examples/l2fwd/main.c, examples/l3fwd-acl/main.c, examples/l3fwd-power/main.c, examples/l3fwd-vf/main.c, examples/l3fwd/main.c, examples/link_status_interrupt/main.c, examples/load_balancer/main.c, examples/multi_process/client_server_mp/mp_client/client.c, examples/multi_process/client_server_mp/mp_server/init.c, examples/multi_process/hotplug_mp/main.c, examples/multi_process/simple_mp/main.c, examples/multi_process/symmetric_mp/main.c, examples/netmap_compat/bridge/bridge.c, examples/packet_ordering/main.c, examples/performance-thread/l3fwd-thread/main.c, examples/performance-thread/pthread_shim/main.c, examples/ptpclient/ptpclient.c, examples/qos_meter/main.c, examples/qos_sched/args.c, examples/quota_watermark/qw/main.c, examples/quota_watermark/qwctl/qwctl.c, examples/rxtx_callbacks/main.c, examples/server_node_efd/node/node.c, examples/server_node_efd/server/init.c, examples/service_cores/main.c, examples/skeleton/basicfwd.c, examples/tep_termination/main.c, examples/timer/main.c, examples/vdpa/main.c, examples/vhost/main.c, examples/vhost_crypto/main.c, examples/vhost_scsi/vhost_scsi.c, examples/vm_power_manager/guest_cli/main.c, examples/vm_power_manager/main.c, examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

rte_eal_cleanup()

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.

Returns

0 Successfully released all internal EAL resources

-EFAULT There was an error in releasing all resources.

Examples

examples/multi_process/hotplug_mp/main.c.

rte_eal_primary_proc_alive()

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.

Parameters

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.

Returns

• If alive, returns 1.
• If dead, returns 0.

rte_mp_action_register()

int __rte_experimental rte_mp_action_register	(	const char *	name,
		rte_mp_t	action
	)

Warning

EXPERIMENTAL: this API may change without prior notice

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.

Note

IPC may be unsupported in certain circumstances, so caller should check for ENOTSUP error.

Parameters

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.

Returns

• 0 on success.
• (<0) on failure.

rte_mp_action_unregister()

void __rte_experimental rte_mp_action_unregister

(

const char *

name

)

Warning

EXPERIMENTAL: this API may change without prior notice

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.

Note

IPC may be unsupported in certain circumstances, so caller should check for ENOTSUP error.

Parameters

name	The name argument plays as the nonredundant key to find the action.

rte_mp_sendmsg()

int __rte_experimental rte_mp_sendmsg

(

struct rte_mp_msg *

msg

)

Warning

EXPERIMENTAL: this API may change without prior notice

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.

Parameters

msg	The msg argument contains the customized message.

Returns

• On success, return 0.
• On failure, return -1, and the reason will be stored in rte_errno.

rte_mp_request_sync()

int __rte_experimental rte_mp_request_sync	(	struct rte_mp_msg *	req,
		struct rte_mp_reply *	reply,
		const struct timespec *	ts
	)

Warning

EXPERIMENTAL: this API may change without prior notice

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.

Note

The caller is responsible to free reply->replies.

This API must not be used inside memory-related or IPC callbacks, and no memory allocations should take place inside such callback.

IPC may be unsupported in certain circumstances, so caller should check for ENOTSUP error.

Parameters

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.

Returns

• On success, return 0.
• On failure, return -1, and the reason will be stored in rte_errno.

rte_mp_request_async()

int __rte_experimental rte_mp_request_async	(	struct rte_mp_msg *	req,
		const struct timespec *	ts,
		rte_mp_async_reply_t	clb
	)

Warning

EXPERIMENTAL: this API may change without prior notice

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.

Note

IPC may be unsupported in certain circumstances, so caller should check for ENOTSUP error.

Parameters

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.

Returns

• On success, return 0.
• On failure, return -1, and the reason will be stored in rte_errno.

rte_mp_reply()

int __rte_experimental rte_mp_reply	(	struct rte_mp_msg *	msg,
		const char *	peer
	)

Warning

EXPERIMENTAL: this API may change without prior notice

Send a reply to the peer process.

This function will send a reply message in response to a request message received previously.

Note

When handling IPC request callbacks, the reply must be sent even in cases of error handling. Simply returning success or failure will not send a response to the requestor. Implementation of error signalling mechanism is up to the application.

Parameters

msg	The msg argument contains the customized message.
peer	The peer argument is the pointer to the peer socket path.

Returns

• On success, return 0.
• On failure, return -1, and the reason will be stored in rte_errno.

rte_mp_dev_hotplug_init()

int __rte_experimental rte_mp_dev_hotplug_init

(

void

)

Register all mp action callbacks for hotplug.

Returns

0 on success, negative on error.

rte_set_application_usage_hook()

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.

Parameters

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.

Returns

• Returns the current value of the rte_application_usage pointer to allow the caller to daisy chain the usage routines if needing more then one.

rte_eal_has_hugepages()

int rte_eal_has_hugepages

(

void

)

Whether EAL is using huge pages (disabled by –no-huge option). The no-huge mode cannot be used with UIO poll-mode drivers like igb/ixgbe. It is useful for NIC drivers (e.g. librte_pmd_mlx4, librte_pmd_vmxnet3) or crypto drivers (e.g. librte_crypto_nitrox) provided by third-parties such as 6WIND.

Returns

Nonzero if hugepages are enabled.

rte_eal_has_pci()

int rte_eal_has_pci

(

void

)

Whether EAL is using PCI bus. Disabled by –no-pci option.

Returns

Nonzero if the PCI bus is enabled.

rte_eal_create_uio_dev()

int rte_eal_create_uio_dev

(

void

)

Whether the EAL was asked to create UIO device.

Returns

Nonzero if true.

rte_eal_vfio_intr_mode()

enum rte_intr_mode rte_eal_vfio_intr_mode

(

void

)

The user-configured vfio interrupt mode.

Returns

Interrupt mode configured with the command line, RTE_INTR_MODE_NONE by default.

rte_sys_gettid()

int rte_sys_gettid

(

void

)

A wrap API for syscall gettid.

Returns

On success, returns the thread ID of calling process. It is always successful.

rte_gettid()

static int rte_gettid ( void  )

inlinestatic

Get system unique thread id.

Returns

On success, returns the thread ID of calling process. It is always successful.

Definition at line 516 of file rte_eal.h.

rte_eal_iova_mode()

enum rte_iova_mode rte_eal_iova_mode

(

void

)

Get the iova mode

Returns

enum rte_iova_mode value.

rte_eal_mbuf_user_pool_ops()

const char* rte_eal_mbuf_user_pool_ops

(

void

)

Get user provided pool ops name for mbuf

Returns

returns user provided pool ops name.

rte_eal_get_runtime_dir()

const char* rte_eal_get_runtime_dir

(

void

)

Get the runtime directory of DPDK

Returns

The runtime directory path of DPDK