DPDK常用API合集三

librte_timer

此库为 DPDK 执行单元提供定时器服务，提供异步执行函数的能力。它可以是周期性的函数调用，也可以是一次性调用。它使用环境抽象层（EAL）提供的定时器接口获取精确的时间参考，并可以根据需要以每个核心为基础进行初始化

1.1 rte_timer_subsystem_init

函数是 DPDK 中 librte_timer 模块的初始化函数，用于初始化定时器子系统。

void rte_timer_subsystem_init(void);

该函数没有参数，用于初始化 DPDK 的定时器子系统。
使用场景：

在需要使用 DPDK 定时器功能之前，通常需要先调用该函数进行初始化。
在 DPDK 应用程序的初始化阶段调用该函数。

#include <rte_timer.h>int main(int argc, char *argv[]) {// 初始化 EALint ret = rte_eal_init(argc, argv);if (ret < 0)rte_exit(EXIT_FAILURE, "Error initializing EAL\n");// 初始化定时器子系统rte_timer_subsystem_init();// 其他初始化操作...// 应用程序主逻辑...return 0;
}

1.2 rte_timer_init

该函数用于初始化一个指定的定时器结构体 struct rte_timer

int rte_timer_init(struct rte_timer *tim);

使用场景：

在需要使用定时器功能之前，通常需要先初始化定时器。
在 DPDK 应用程序的初始化阶段调用该函数来初始化定时器

#include <rte_timer.h>int main(int argc, char *argv[]) {// 初始化 EALint ret = rte_eal_init(argc, argv);if (ret < 0)rte_exit(EXIT_FAILURE, "Error initializing EAL\n");// 初始化定时器结构体struct rte_timer my_timer;ret = rte_timer_init(&my_timer);if (ret != 0)rte_exit(EXIT_FAILURE, "Error initializing timer\n");// 其他初始化操作...// 应用程序主逻辑...return 0;
}

1.3 rte_timer_reset

void rte_timer_reset(struct rte_timer *tim, uint64_t ticks, enum rte_timer_type type, uint16_t tim_lcore_id, rte_timer_cb_t fct, void *arg);

该函数用于重置指定的定时器，设置定时器的定时参数和回调函数。

tim: 要重置的定时器结构体指针。
ticks: 定时器的周期，以 CPU 的时钟周期为单位。
type: 定时器的类型，可以是 RTE_TIMER_SINGLE（单次触发）或 RTE_TIMER_PERIODICAL（周期触发）。
tim_lcore_id: 定时器运行的 CPU 核心 ID。
fct: 定时器超时时要调用的回调函数。
arg: 回调函数的参数。
使用场景：
在需要设置定时器的超时事件和回调函数时调用该函数。
可以在程序中多次调用该函数，以便在不同的时间点设置不同的定时器参数和回调函数。

1.4 rte_timer_stop

void rte_timer_stop(struct rte_timer *tim);

该函数用于停止指定的定时器。

tim: 要停止的定时器结构体指针。
使用场景：
在不需要定时器继续工作时调用该函数，停止定时器的计时。
可以在程序中多次调用该函数，以停止不同的定时器。

#include <rte_timer.h>int main(int argc, char *argv[]) {// 初始化 EALint ret = rte_eal_init(argc, argv);if (ret < 0)rte_exit(EXIT_FAILURE, "Error initializing EAL\n");// 初始化定时器结构体struct rte_timer my_timer;ret = rte_timer_init(&my_timer);if (ret != 0)rte_exit(EXIT_FAILURE, "Error initializing timer\n");// 启动定时器rte_timer_reset(&my_timer, 1000000, RTE_TIMER_SINGLE, rte_lcore_id(), NULL, NULL);// 其他操作...// 暂停定时器rte_timer_stop(&my_timer);// 其他操作...return 0;
}

1.5 rte_timer_reset_sync

void rte_timer_reset_sync(struct rte_timer *tim, uint64_t ticks, enum rte_timer_type type, uint16_t tim_lcore_id, rte_timer_cb_t fct, void *arg);

该函数用于同步方式重置指定的定时器，设置定时器的定时参数和回调函数，并等待重置完成。
同步方式重置定时器时，是对一个已经存在的定时器实例进行重置，设置新的定时参数和回调函数

tim: 要重置的定时器结构体指针。
ticks: 定时器的周期，以 CPU 的时钟周期为单位。
type: 定时器的类型，可以是 RTE_TIMER_SINGLE（单次触发）或 RTE_TIMER_PERIODICAL（周期触发）。
tim_lcore_id: 定时器运行的 CPU 核心 ID。
fct: 定时器超时时要调用的回调函数。
arg: 回调函数的参数。
使用场景：
在需要设置定时器的超时事件和回调函数，并且需要等待定时器重置完成后再继续执行后续操作时使用。
通常在初始化阶段调用该函数来初始化定时器，确保定时器的状态已经被完全重置。

#include <rte_timer.h>// 定时器超时时要调用的回调函数
void timer_callback(struct rte_timer *tim, void *arg) {printf("Timer callback function called\n");
}int main(int argc, char *argv[]) {// 初始化 EALint ret = rte_eal_init(argc, argv);if (ret < 0)rte_exit(EXIT_FAILURE, "Error initializing EAL\n");// 初始化定时器结构体struct rte_timer my_timer;ret = rte_timer_init(&my_timer);if (ret != 0)rte_exit(EXIT_FAILURE, "Error initializing timer\n");// 同步方式重置定时器，并等待重置完成rte_timer_reset_sync(&my_timer, 1000000, RTE_TIMER_SINGLE, rte_lcore_id(), timer_callback, NULL);// 其他操作...return 0;
}

1.6 rte_timer_stop_sync

int rte_timer_stop_sync(struct rte_timer *tim);

该函数用于同步方式停止指定的定时器，并等待停止完成。

tim: 要停止的定时器结构体指针。
使用场景：
在需要停止定时器的情况下，可以使用该函数来确保定时器被完全停止后再继续后续操作。
通常在程序的运行时，当不再需要某个定时器时，可以调用该函数来停止定时器的计时

#include <stdio.h>
#include <rte_timer.h>// 定时器超时时要调用的回调函数
void timer_callback(struct rte_timer *tim, void *arg) {printf("Timer callback function called\n");// 执行一些操作...
}int main(int argc, char *argv[]) {// 初始化 EALint ret = rte_eal_init(argc, argv);if (ret < 0)rte_exit(EXIT_FAILURE, "Error initializing EAL\n");// 初始化定时器结构体struct rte_timer my_timer;ret = rte_timer_init(&my_timer);if (ret != 0)rte_exit(EXIT_FAILURE, "Error initializing timer\n");// 启动定时器rte_timer_reset(&my_timer, 1000000, RTE_TIMER_SINGLE, rte_lcore_id(), timer_callback, NULL);// 其他操作...// 暂停定时器，并等待停止完成ret = rte_timer_stop_sync(&my_timer);if (ret != 0)rte_exit(EXIT_FAILURE, "Error stopping timer\n");// 其他操作...return 0;
}

rte_timer_stop_sync 和 rte_timer_stop 是停止定时器的两个不同函数，它们的区别在于：

同步方式停止 vs 异步方式停止：

rte_timer_stop_sync 是同步方式停止定时器，调用该函数会阻塞当前线程，直到定时器被完全停止后才会返回。
rte_timer_stop 是异步方式停止定时器，调用该函数会立即返回，不会等待定时器被停止。

1.7 rte_timer_manage

函数用于管理 DPDK 中的定时器，在主循环中周期性地检查和处理定时器的到期事件

void rte_timer_manage(void);

函数定义： rte_timer_manage 函数没有参数，返回值为 void，用于周期性地检查和处理定时器的到期事件。
用法：在主循环中调用 rte_timer_manage 函数以触发定时器事件的处理。通常在主循环的适当位置调用此函数。

使用场景：

当需要使用定时器功能实现周期性任务或处理延时事件时，可以使用 rte_timer_manage 函数。
适用于需要实现轮询定时器事件并在事件到期时执行相应操作的场景。

#include <rte_timer.h>// 定时器回调函数
static void timer_callback(struct rte_timer *tim, void *arg) {// 处理定时器事件printf("Timer event occurred!\n");
}int main(int argc, char *argv[]) {// 初始化 DPDK 库rte_eal_init(argc, argv);// 创建定时器struct rte_timer timer;rte_timer_init(&timer);// 设置定时器参数rte_timer_reset(&timer, TIMER_INTERVAL, PERIODICAL, rte_lcore_id(), timer_callback, NULL);// 主循环while (1) {// 执行 DPDK 库的主循环任务rte_timer_manage(); // 管理定时器事件// 其他主循环任务}return 0;
}

感觉鸡肋，不如直接rte_eal_alarm_set

1.8 rte_eal_alarm_set

函数用于设置一个在指定时间后触发的定时器，它可以在 DPDK 应用程序中用于执行延时操作

int rte_eal_alarm_set(uint64_t us_delay, rte_eal_alarm_callback cb, void *arg);

函数定义： rte_eal_alarm_set 函数用于设置一个在指定时间后触发的定时器，当定时器到期时，指定的回调函数将被调用。

参数：

us_delay：定时器的延迟时间，以微秒为单位。
cb：定时器到期时调用的回调函数。
arg：传递给回调函数的参数。
返回值：如果设置成功，则返回 0；如果出现错误，则返回负数。

使用场景：

当需要在一定延迟后执行某些操作时，可以使用 rte_eal_alarm_set 函数来设置延时触发的定时器。
适用于需要在延时触发时执行异步操作的场景。

1.9 rte_eal_alarm_cancel

void rte_eal_alarm_cancel(rte_eal_alarm_callback cb, void *arg);

函数定义： rte_eal_alarm_cancel 函数用于取消之前设置的定时器，取消后不再触发定时器到期时的回调函数。

参数：

cb：要取消的定时器的回调函数。
arg：传递给回调函数的参数。
返回值：无。

使用场景：

当不再需要之前设置的定时器时，可以使用 rte_eal_alarm_cancel 函数将其取消，以避免触发不再需要的回调函数。
适用于需要在特定条件下取消定时器的场景