DPDK: Data Plane Development Kit

18.02.0-rc0
rte_launch.h File Reference

Go to the source code of this file.

Typedefs

typedef int( lcore_function_t )(void *)

Enumerations

enum  rte_lcore_state_t { WAIT, RUNNING, FINISHED }
enum  rte_rmt_call_master_t { SKIP_MASTER = 0, CALL_MASTER }

Functions

int rte_eal_remote_launch (lcore_function_t *f, void *arg, unsigned slave_id)
int rte_eal_mp_remote_launch (lcore_function_t *f, void *arg, enum rte_rmt_call_master_t call_master)
enum rte_lcore_state_t rte_eal_get_lcore_state (unsigned slave_id)
int rte_eal_wait_lcore (unsigned slave_id)
void rte_eal_mp_wait_lcore (void)

Detailed Description

Launch tasks on other lcores

Definition in file rte_launch.h.

Typedef Documentation

typedef int( lcore_function_t)(void *)

Definition of a remote launch function.

Examples:
examples/bond/main.c, examples/distributor/main.c, examples/multi_process/l2fwd_fork/flib.c, and examples/packet_ordering/main.c.

Definition at line 59 of file rte_launch.h.

Enumeration Type Documentation

State of an lcore.

Enumerator:
WAIT 

waiting a new command

RUNNING 

executing command

FINISHED 

command executed

Definition at line 50 of file rte_launch.h.

This enum indicates whether the master core must execute the handler launched on all logical cores.

Enumerator:
SKIP_MASTER 

lcore handler not executed by master core.

CALL_MASTER 

lcore handler executed by master core.

Definition at line 100 of file rte_launch.h.

Function Documentation

int rte_eal_remote_launch ( lcore_function_t f,
void *  arg,
unsigned  slave_id 
)

Launch a function on another lcore.

To be executed on the MASTER lcore only.

Sends a message to a slave lcore (identified by the slave_id) that is in the WAIT state (this is true after the first call to rte_eal_init()). This can be checked by first calling rte_eal_wait_lcore(slave_id).

When the remote lcore receives the message, it switches to the RUNNING state, then calls the function f with argument arg. Once the execution is done, the remote lcore switches to a FINISHED state and the return value of f is stored in a local variable to be read using rte_eal_wait_lcore().

The MASTER lcore returns as soon as the message is sent and knows nothing about the completion of f.

Note: This function is not designed to offer optimum performance. It is just a practical way to launch a function on another lcore at initialization time.

Parameters
fThe function to be called.
argThe argument for the function.
slave_idThe identifier of the lcore on which the function should be executed.
Returns
  • 0: Success. Execution of function f started on the remote lcore.
  • (-EBUSY): The remote lcore is not in a WAIT state.
Examples:
examples/bond/main.c, examples/distributor/main.c, examples/ethtool/ethtool-app/main.c, examples/eventdev_pipeline_sw_pmd/main.c, examples/helloworld/main.c, examples/l2fwd-keepalive/main.c, examples/multi_process/l2fwd_fork/flib.c, examples/multi_process/simple_mp/main.c, examples/packet_ordering/main.c, examples/quota_watermark/qw/main.c, examples/tep_termination/main.c, examples/timer/main.c, examples/vhost/main.c, examples/vm_power_manager/main.c, and examples/vmdq_dcb/main.c.
int rte_eal_mp_remote_launch ( lcore_function_t f,
void *  arg,
enum rte_rmt_call_master_t  call_master 
)

Launch a function on all lcores.

Check that each SLAVE lcore is in a WAIT state, then call rte_eal_remote_launch() for each lcore.

Parameters
fThe function to be called.
argThe argument for the function.
call_masterIf call_master set to SKIP_MASTER, the MASTER lcore does not call the function. If call_master is set to CALL_MASTER, the function is also called on master before returning. In any case, the master lcore returns as soon as it finished its job and knows nothing about the completion of f on the other lcores.
Returns
  • 0: Success. Execution of function f started on all remote lcores.
  • (-EBUSY): At least one remote lcore is not in a WAIT state. In this case, no message is sent to any of the lcores.
Examples:
examples/exception_path/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-crypto/main.c, examples/l2fwd-jobstats/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_server/main.c, examples/multi_process/l2fwd_fork/flib.c, examples/multi_process/symmetric_mp/main.c, examples/performance-thread/l3fwd-thread/main.c, examples/performance-thread/pthread_shim/main.c, examples/qos_meter/main.c, examples/qos_sched/main.c, examples/server_node_efd/server/main.c, and examples/vmdq/main.c.
enum rte_lcore_state_t rte_eal_get_lcore_state ( unsigned  slave_id)

Get the state of the lcore identified by slave_id.

To be executed on the MASTER lcore only.

Parameters
slave_idThe identifier of the lcore.
Returns
The state of the lcore.
Examples:
examples/l2fwd-keepalive/main.c.
int rte_eal_wait_lcore ( unsigned  slave_id)

Wait until an lcore finishes its job.

To be executed on the MASTER lcore only.

If the slave lcore identified by the slave_id is in a FINISHED state, switch to the WAIT state. If the lcore is in RUNNING state, wait until the lcore finishes its job and moves to the FINISHED state.

Parameters
slave_idThe identifier of the lcore.
Returns
  • 0: If the lcore identified by the slave_id is in a WAIT state.
  • The value that was returned by the previous remote launch function call if the lcore identified by the slave_id was in a FINISHED or RUNNING state. In this case, it changes the state of the lcore to WAIT.
Examples:
examples/bond/main.c, examples/distributor/main.c, examples/ethtool/ethtool-app/main.c, examples/exception_path/main.c, examples/ip_fragmentation/main.c, examples/ip_reassembly/main.c, examples/ipsec-secgw/ipsec-secgw.c, examples/ipv4_multicast/main.c, examples/kni/main.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/l2fwd_fork/flib.c, examples/packet_ordering/main.c, examples/performance-thread/l3fwd-thread/main.c, examples/performance-thread/pthread_shim/main.c, examples/qos_meter/main.c, examples/tep_termination/main.c, examples/vhost/main.c, and examples/vmdq/main.c.
void rte_eal_mp_wait_lcore ( void  )

Wait until all lcores finish their jobs.

To be executed on the MASTER lcore only. Issue an rte_eal_wait_lcore() for every lcore. The return values are ignored.

After a call to rte_eal_mp_wait_lcore(), the caller can assume that all slave lcores are in a WAIT state.

Examples:
examples/eventdev_pipeline_sw_pmd/main.c, examples/helloworld/main.c, examples/multi_process/simple_mp/main.c, and examples/vm_power_manager/main.c.