DPDK: Data Plane Development Kit

rte_eal.h File Reference
#include <stdint.h>
#include <sched.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


#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)


typedef void(* rte_usage_hook_t )(const char *prgname)


enum  rte_lcore_role_t
enum  rte_proc_type_t


struct rte_configrte_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_primary_proc_alive (const char *config_file_path)
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_default_mempool_ops (void)

Detailed Description

EAL Configuration API

Definition in file rte_eal.h.

Macro Definition Documentation

#define RTE_MAGIC   19820526

Magic number written by the main partition when ready.

Definition at line 55 of file rte_eal.h.

#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 252 of file rte_eal.h.

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

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

Definition at line 257 of file rte_eal.h.

Typedef Documentation

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 223 of file rte_eal.h.

Enumeration Type Documentation

The lcore role (used in RTE or not).

Definition at line 63 of file rte_eal.h.

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

Definition at line 72 of file rte_eal.h.

Function Documentation

struct rte_config* rte_eal_get_configuration ( void  )

Get the global configuration structure.

A pointer to the global configuration structure.
examples/multi_process/l2fwd_fork/flib.c, examples/multi_process/symmetric_mp/main.c, and examples/qos_sched/args.c.
enum rte_lcore_role_t rte_eal_lcore_role ( unsigned  lcore_id)

Get a lcore's role.

lcore_idThe identifier of the lcore.
The role of the lcore.
enum rte_proc_type_t rte_eal_process_type ( void  )

Get the process type in a multi-process setup

The process type
examples/multi_process/simple_mp/main.c, and examples/multi_process/symmetric_mp/main.c.
int rte_eal_iopl_init ( void  )

Request iopl privilege for all RPL.

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

  • On success, returns 0.
  • On failure, returns -1.
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.

argcA 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.
argvAn 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.
  • 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/bond/main.c, examples/cmdline/main.c, examples/distributor/main.c, examples/ethtool/ethtool-app/main.c, examples/eventdev_pipeline_sw_pmd/main.c, examples/exception_path/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/init.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/l2fwd_fork/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/vhost/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.
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_pathThe 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.
  • If alive, returns 1.
  • If dead, returns 0.
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_funcThe 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 the current value of the rte_application_usage pointer to allow the caller to daisy chain the usage routines if needing more then one.
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.

Nonzero if hugepages are enabled.
int rte_eal_has_pci ( void  )

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

Nonzero if the PCI bus is enabled.
int rte_eal_create_uio_dev ( void  )

Whether the EAL was asked to create UIO device.

Nonzero if true.
enum rte_intr_mode rte_eal_vfio_intr_mode ( void  )

The user-configured vfio interrupt mode.

Interrupt mode configured with the command line, RTE_INTR_MODE_NONE by default.
int rte_sys_gettid ( void  )

A wrap API for syscall gettid.

On success, returns the thread ID of calling process. It is always successful.
static int rte_gettid ( void  )

Get system unique thread id.

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

Definition at line 313 of file rte_eal.h.

enum rte_iova_mode rte_eal_iova_mode ( void  )

Get the iova mode

enum rte_iova_mode value.
const char* rte_eal_mbuf_default_mempool_ops ( void  )

Get default pool ops name for mbuf

returns default pool ops name.