DPDK
19.08.0-rc0
|
#include <stdio.h>
#include <stdint.h>
#include <stddef.h>
#include <rte_common.h>
#include <rte_config.h>
#include <rte_spinlock.h>
Go to the source code of this file.
Data Structures | |
union | rte_timer_status |
struct | rte_timer |
Macros | |
#define | RTE_TIMER_STOP 0 |
#define | RTE_TIMER_PENDING 1 |
#define | RTE_TIMER_RUNNING 2 |
#define | RTE_TIMER_CONFIG 3 |
#define | RTE_TIMER_NO_OWNER -2 |
#define | RTE_TIMER_INITIALIZER |
Typedefs | |
typedef void(* | rte_timer_cb_t) (struct rte_timer *, void *) |
typedef void(* | rte_timer_alt_manage_cb_t) (struct rte_timer *tim) |
typedef void(* | rte_timer_stop_all_cb_t) (struct rte_timer *tim, void *arg) |
Enumerations | |
enum | rte_timer_type |
Functions | |
int __rte_experimental | rte_timer_data_alloc (uint32_t *id_ptr) |
int __rte_experimental | rte_timer_data_dealloc (uint32_t id) |
int | rte_timer_subsystem_init (void) |
void __rte_experimental | rte_timer_subsystem_finalize (void) |
void | rte_timer_init (struct rte_timer *tim) |
int | rte_timer_reset (struct rte_timer *tim, uint64_t ticks, enum rte_timer_type type, unsigned tim_lcore, rte_timer_cb_t fct, void *arg) |
void | rte_timer_reset_sync (struct rte_timer *tim, uint64_t ticks, enum rte_timer_type type, unsigned tim_lcore, rte_timer_cb_t fct, void *arg) |
int | rte_timer_stop (struct rte_timer *tim) |
void | rte_timer_stop_sync (struct rte_timer *tim) |
int | rte_timer_pending (struct rte_timer *tim) |
int | rte_timer_manage (void) |
int | rte_timer_dump_stats (FILE *f) |
int __rte_experimental | rte_timer_alt_reset (uint32_t timer_data_id, struct rte_timer *tim, uint64_t ticks, enum rte_timer_type type, unsigned int tim_lcore, rte_timer_cb_t fct, void *arg) |
int __rte_experimental | rte_timer_alt_stop (uint32_t timer_data_id, struct rte_timer *tim) |
int __rte_experimental | rte_timer_alt_manage (uint32_t timer_data_id, unsigned int *poll_lcores, int n_poll_lcores, rte_timer_alt_manage_cb_t f) |
int __rte_experimental | rte_timer_stop_all (uint32_t timer_data_id, unsigned int *walk_lcores, int nb_walk_lcores, rte_timer_stop_all_cb_t f, void *f_arg) |
int __rte_experimental | rte_timer_alt_dump_stats (uint32_t timer_data_id, FILE *f) |
RTE Timer
This library provides a timer service to RTE Data Plane execution units that allows the execution of callback functions asynchronously.
The timer library uses the rte_get_hpet_cycles() function that uses the HPET, when available, to provide a reliable time reference. [HPET routines are provided by EAL, which falls back to using the chip TSC (time- stamp counter) as fallback when HPET is not available]
This library provides an interface to add, delete and restart a timer. The API is based on the BSD callout(9) API with a few differences.
See the RTE architecture documentation for more information about the design of this library.
Definition in file rte_timer.h.
#define RTE_TIMER_STOP 0 |
State: timer is stopped.
Definition at line 48 of file rte_timer.h.
#define RTE_TIMER_PENDING 1 |
State: timer is scheduled.
Definition at line 49 of file rte_timer.h.
#define RTE_TIMER_RUNNING 2 |
State: timer function is running.
Definition at line 50 of file rte_timer.h.
#define RTE_TIMER_CONFIG 3 |
State: timer is being configured.
Definition at line 51 of file rte_timer.h.
#define RTE_TIMER_NO_OWNER -2 |
Timer has no owner.
Definition at line 53 of file rte_timer.h.
#define RTE_TIMER_INITIALIZER |
A static initializer for a timer structure.
Definition at line 127 of file rte_timer.h.
typedef void(* rte_timer_cb_t) (struct rte_timer *, void *) |
Callback function type for timer expiry.
Definition at line 93 of file rte_timer.h.
typedef void(* rte_timer_alt_manage_cb_t) (struct rte_timer *tim) |
Callback function type for rte_timer_alt_manage().
Definition at line 442 of file rte_timer.h.
typedef void(* rte_timer_stop_all_cb_t) (struct rte_timer *tim, void *arg) |
Callback function type for rte_timer_stop_all().
Definition at line 479 of file rte_timer.h.
enum rte_timer_type |
Timer type: Periodic or single (one-shot).
Definition at line 58 of file rte_timer.h.
int __rte_experimental rte_timer_data_alloc | ( | uint32_t * | id_ptr | ) |
Allocate a timer data instance in shared memory to track a set of pending timer lists.
id_ptr | Pointer to variable into which to write the identifier of the allocated timer data instance. |
int __rte_experimental rte_timer_data_dealloc | ( | uint32_t | id | ) |
Deallocate a timer data instance.
id | Identifier of the timer data instance to deallocate. |
int rte_timer_subsystem_init | ( | void | ) |
Initialize the timer library.
Initializes internal variables (list, locks and so on) for the RTE timer library.
void __rte_experimental rte_timer_subsystem_finalize | ( | void | ) |
Free timer subsystem resources.
void rte_timer_init | ( | struct rte_timer * | tim | ) |
Initialize a timer handle.
The rte_timer_init() function initializes the timer handle tim for use. No operations can be performed on a timer before it is initialized.
tim | The timer to initialize. |
int rte_timer_reset | ( | struct rte_timer * | tim, |
uint64_t | ticks, | ||
enum rte_timer_type | type, | ||
unsigned | tim_lcore, | ||
rte_timer_cb_t | fct, | ||
void * | arg | ||
) |
Reset and start the timer associated with the timer handle.
The rte_timer_reset() function resets and starts the timer associated with the timer handle tim. When the timer expires after ticks HPET cycles, the function specified by fct will be called with the argument arg on core tim_lcore.
If the timer associated with the timer handle is already running (in the RUNNING state), the function will fail. The user has to check the return value of the function to see if there is a chance that the timer is in the RUNNING state.
If the timer is being configured on another core (the CONFIG state), it will also fail.
If the timer is pending or stopped, it will be rescheduled with the new parameters.
tim | The timer handle. |
ticks | The number of cycles (see rte_get_hpet_hz()) before the callback function is called. |
type | The type can be either:
|
tim_lcore | The ID of the lcore where the timer callback function has to be executed. If tim_lcore is LCORE_ID_ANY, the timer library will launch it on a different core for each call (round-robin). |
fct | The callback function of the timer. |
arg | The user argument of the callback function. |
void rte_timer_reset_sync | ( | struct rte_timer * | tim, |
uint64_t | ticks, | ||
enum rte_timer_type | type, | ||
unsigned | tim_lcore, | ||
rte_timer_cb_t | fct, | ||
void * | arg | ||
) |
Loop until rte_timer_reset() succeeds.
Reset and start the timer associated with the timer handle. Always succeed. See rte_timer_reset() for details.
tim | The timer handle. |
ticks | The number of cycles (see rte_get_hpet_hz()) before the callback function is called. |
type | The type can be either:
|
tim_lcore | The ID of the lcore where the timer callback function has to be executed. If tim_lcore is LCORE_ID_ANY, the timer library will launch it on a different core for each call (round-robin). |
fct | The callback function of the timer. |
arg | The user argument of the callback function. |
int rte_timer_stop | ( | struct rte_timer * | tim | ) |
Stop a timer.
The rte_timer_stop() function stops the timer associated with the timer handle tim. It may fail if the timer is currently running or being configured.
If the timer is pending or stopped (for instance, already expired), the function will succeed. The timer handle tim must have been initialized using rte_timer_init(), otherwise, undefined behavior will occur.
This function can be called safely from a timer callback. If it succeeds, the timer is not referenced anymore by the timer library and the timer structure can be freed (even in the callback function).
tim | The timer handle. |
void rte_timer_stop_sync | ( | struct rte_timer * | tim | ) |
Loop until rte_timer_stop() succeeds.
After a call to this function, the timer identified by tim is stopped. See rte_timer_stop() for details.
tim | The timer handle. |
int rte_timer_pending | ( | struct rte_timer * | tim | ) |
Test if a timer is pending.
The rte_timer_pending() function tests the PENDING status of the timer handle tim. A PENDING timer is one that has been scheduled and whose function has not yet been called.
tim | The timer handle. |
int rte_timer_manage | ( | void | ) |
Manage the timer list and execute callback functions.
This function must be called periodically from EAL lcores main_loop(). It browses the list of pending timers and runs all timers that are expired.
The precision of the timer depends on the call frequency of this function. However, the more often the function is called, the more CPU resources it will use.
int rte_timer_dump_stats | ( | FILE * | f | ) |
Dump statistics about timers.
f | A pointer to a file for output |
int __rte_experimental rte_timer_alt_reset | ( | uint32_t | timer_data_id, |
struct rte_timer * | tim, | ||
uint64_t | ticks, | ||
enum rte_timer_type | type, | ||
unsigned int | tim_lcore, | ||
rte_timer_cb_t | fct, | ||
void * | arg | ||
) |
This function is the same as rte_timer_reset(), except that it allows a caller to specify the rte_timer_data instance containing the list to which the timer should be added.
timer_data_id | An identifier indicating which instance of timer data should be used for this operation. |
tim | The timer handle. |
ticks | The number of cycles (see rte_get_hpet_hz()) before the callback function is called. |
type | The type can be either:
|
tim_lcore | The ID of the lcore where the timer callback function has to be executed. If tim_lcore is LCORE_ID_ANY, the timer library will launch it on a different core for each call (round-robin). |
fct | The callback function of the timer. This parameter can be NULL if (and only if) rte_timer_alt_manage() will be used to manage this timer. |
arg | The user argument of the callback function. |
int __rte_experimental rte_timer_alt_stop | ( | uint32_t | timer_data_id, |
struct rte_timer * | tim | ||
) |
This function is the same as rte_timer_stop(), except that it allows a caller to specify the rte_timer_data instance containing the list from which this timer should be removed.
timer_data_id | An identifier indicating which instance of timer data should be used for this operation. |
tim | The timer handle. |
int __rte_experimental rte_timer_alt_manage | ( | uint32_t | timer_data_id, |
unsigned int * | poll_lcores, | ||
int | n_poll_lcores, | ||
rte_timer_alt_manage_cb_t | f | ||
) |
Manage a set of timer lists and execute the specified callback function for all expired timers. This function is similar to rte_timer_manage(), except that it allows a caller to specify the timer_data instance that should be operated on, as well as a set of lcore IDs identifying which timer lists should be processed. Callback functions of individual timers are ignored.
timer_data_id | An identifier indicating which instance of timer data should be used for this operation. |
poll_lcores | An array of lcore ids identifying the timer lists that should be processed. NULL is allowed - if NULL, the timer list corresponding to the lcore calling this routine is processed (same as rte_timer_manage()). |
n_poll_lcores | The size of the poll_lcores array. If 'poll_lcores' is NULL, this parameter is ignored. |
f | The callback function which should be called for all expired timers. |
int __rte_experimental rte_timer_stop_all | ( | uint32_t | timer_data_id, |
unsigned int * | walk_lcores, | ||
int | nb_walk_lcores, | ||
rte_timer_stop_all_cb_t | f, | ||
void * | f_arg | ||
) |
Walk the pending timer lists for the specified lcore IDs, and for each timer that is encountered, stop it and call the specified callback function to process it further.
timer_data_id | An identifier indicating which instance of timer data should be used for this operation. |
walk_lcores | An array of lcore ids identifying the timer lists that should be processed. |
nb_walk_lcores | The size of the walk_lcores array. |
f | The callback function which should be called for each timers. Can be NULL. |
f_arg | An arbitrary argument that will be passed to f, if it is called. |
int __rte_experimental rte_timer_alt_dump_stats | ( | uint32_t | timer_data_id, |
FILE * | f | ||
) |
This function is the same as rte_timer_dump_stats(), except that it allows the caller to specify the rte_timer_data instance that should be used.
timer_data_id | An identifier indicating which instance of timer data should be used for this operation. |
f | A pointer to a file for output |