RT-Thread workqueue 详解

RT-Thread workqueue 详解

在学习之前可以先去了解一下工作队列的使用场景:工作队列 ( workqueue )

简而言之,工作队列就是将一些工作任务的执行延迟,交由内核线程异步执行。

如何使用

最简单的使用方式就是开启 RT-Thread 的系统工作线程(System workqueue),而我们往系统工作线程里提交工作项(work item)即可。

RT-Thread 其实给我们提供了一个系统工作线程了,但很少有人知道。配置选项路径如下图所示:

image
RT-Thread Components
    ->  Device Drivers
        ->  Using device drivers IPC
            -> Using system default workqueue

依次选中上述这些选项,就能够开启系统工作队列了。而且还可以看到工作队列线程的栈大小默认为 2048,优先级为 23 。

这样系统在初始化的时候就创建了系统工作队列了,名字叫作 sys_work,在终端输入 ps 能够看到该线程。

image

如何向系统工作线程里添加工作项呢?

/**
 * @brief Submit a work to system workqueue.
 * @param work A work item.
 * @param time Action delay time.
 * @return RT_EOK on success, Ohters on fail.
*/
rt_err_t rt_work_submit(struct rt_work *work, rt_tick_t time);
/**
 * @brief Cancel a work in system workqueue.
 * @param work A work item.
 * @return RT_EOK on success, Others on fail.
*/
rt_err_t rt_work_cancel(struct rt_work *work);

rt_work_submit() 用于向系统工作队列添加工作项,rt_work_cancel() 用于从系统工作队列中取消某一个工作项。

当然,在提交工作项时,需要初始化该工作项,绑定相应的回调函数和用户指针,接口如下:

/**
 * @brief Init a work item.
 * @param work_func A callback function.
 * @param work_data User data pass to `work_func`.
 * @return None.
*/
rt_inline void rt_work_init(struct rt_work *work, void (*work_func)(struct rt_work *work, void *work_data), void *work_data)

这样,我们就可以随时随地地提交工作任务执行了,极大地方便了程序的组织。

用一个小例程测试一下:

在 qemu 项目里的 main.c 里输入:

#include <stdio.h>
#include <dlfcn.h>
#include <rtthread.h>
#include <ipc/workqueue.h>


struct rt_work work1;
int work1_data = 1;

struct rt_work work2;
int work2_data = 2;

void work_func(struct rt_work *work, void *work_data)
{
    int data = *(int *)work_data;
    rt_kprintf("recv work data: %d\n", data);
}

int main(void)
{
    printf("hello rt-thread!\n");

    rt_work_init(&work1, work_func, &work1_data);
    rt_work_init(&work2, work_func, &work2_data);

    rt_work_submit(&work1, 2);
    rt_work_submit(&work2, 0);

    return 0;
}

然后执行就能看到下述效果,与工作项绑定的任务被异步执行了,而且工作项 1 延迟了 2 个 tick 才执行。

image

rt_workqueue

rt_workqueue 的接口有很多,我们只需要关注常用的即可。

/**
 * @brief Create a workqueue.
 * @param name Workqueue thread name.
 * @param stack_size Workqueue thread stack size.
 * @param priority Workqueu thread priority.
 * @return Workqueue handle.
*/
struct rt_workqueue *rt_workqueue_create(const char *name, rt_uint16_t stack_size, rt_uint8_t priority);
/**
 * @brief Destory a workqueue.
 * @param queue Workqueue handle.
 * @return RT_EOK on success, Others on fail.
*/
rt_err_t rt_workqueue_destroy(struct rt_workqueue *queue);
/**
 * @brief Submit a work item to workqueue.
 * @param queue Workqueue handle.
 * @param work Work item.
 * @param time Action delay time.
 * @return RT_EOK on success, Others on fail.
 * 
*/
rt_err_t rt_workqueue_submit_work(struct rt_workqueue *queue, struct rt_work *work, rt_tick_t time);
/**
 * @brief Cancel a work item in workqueue.
 * @param queue Workqueue handle.
 * @param work Work item.
 * @return RT_EOK on success, Others on fail.
 * 
*/
rt_err_t rt_workqueue_cancel_work(struct rt_workqueue *queue, struct rt_work *work);

首先使用 rt_workqueue_create() 创建一个工作队列,然后使用 rt_workqueue_submit_work() 提交工作项,使用 rt_workqueue_cancel_work() 取消工作项,当然还可以使用 rt_workqueue_destroy() 销毁一个工作队列。其他的接口有兴趣的可以了解,但常用的就是上面这四种。

这里提交任务与上述使用系统工作队列的唯一不同之处就是我们需要手动指定工作队列,其他的都是一模一样的。

用一个小例程测试一下:

在 qemu 项目里的 main.c 里输入:

#include <stdio.h>
#include <dlfcn.h>
#include <rtthread.h>
#include <ipc/workqueue.h>


struct rt_work work1;
int work1_data = 1;

struct rt_work work2;
int work2_data = 2;

void work_func(struct rt_work *work, void *work_data)
{
    int data = *(int *)work_data;
    rt_kprintf("recv work data: %d\n", data);
}

int main(void)
{
    printf("hello rt-thread!\n");

    struct rt_workqueue *wq = rt_workqueue_create("my_wq", 2048, 20);
    RT_ASSERT(wq);

    rt_work_init(&work1, work_func, &work1_data);
    rt_work_init(&work2, work_func, &work2_data);

    rt_workqueue_submit_work(wq, &work1, 2);
    rt_workqueue_submit_work(wq, &work2, 0);

    return 0;
}

然后执行就能看到下述效果,与工作项绑定的任务被异步执行了,而且工作项 1 延迟了 2 个 tick 才执行。

image

实现

关于实现部分我这里不介绍具体细节,做了一些动画给大家展示一下内部过程

工作队列里面有一个线程(workthread),这个线程的任务就是不断地从挂载链表(worklist)里提取工作项执行,若没有则休眠。

image

然后提交工作项时,若延迟时间 time 大于 0,则启动该工作项的定时器,定时结束后再加入挂载链表(worklist)。

image

若提交工作项时延迟实际等于 0,则直接将该工作项挂加入到挂载链表(worklist)。

image

当然,工作项的定时器超时后,会自动将该工作项加入到挂载链表(worklist)。

image
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,504评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,434评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,089评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,378评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,472评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,506评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,519评论 3 413
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,292评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,738评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,022评论 2 329
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,194评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,873评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,536评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,162评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,413评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,075评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,080评论 2 352

推荐阅读更多精彩内容