wait queue: move docs to README

Do just one example with 2 waits, my readers can handle it :-)
This commit is contained in:
Ciro Santilli
2018-07-08 09:58:05 +01:00
parent f59ca5a214
commit 258add9c9d
3 changed files with 88 additions and 46 deletions

View File

@@ -4124,6 +4124,51 @@ The system also responds if we <<number-of-cores,add another core>>:
./run -c 2 -F 'dmesg -n 1;insmod /schedule.ko schedule=0'
....
==== Wait queues
Wait queues are a way to make a thread sleep until an event happens on the queue:
....
insmod /wait_queue.c
....
Dmesg output:
....
0 0
1 0
2 0
# Wait one second.
0 1
1 1
2 1
# Wait one second.
0 2
1 2
2 2
...
....
Stop the count:
....
rmmod wait_queue
....
Source: link:kernel_module/wait_queue.c[]
This example launches three threads:
* one thread generates events every with link:https://github.com/torvalds/linux/blob/v4.17/include/linux/wait.h#L195[`wake_up`]
* the other two threads wait for that with link:https://github.com/torvalds/linux/blob/v4.17/include/linux/wait.h#L286[`wait_event`], and print a dmesg when it happens.
+
The `wait_event` macro works a bit like:
+
....
while (!cond)
sleep_until_event
....
=== Timers
Count from `0` to `9` infinitely many times in 1 second intervals using timers:

View File

@@ -1,21 +1,4 @@
/*
"wait_event" works a bit like:
while (!cond)
sleep_until_event
Outcome:
1 0
2 0
# Wait one second.
1 1
2 1
# Wait one second.
1 2
2 2
# ...
*/
/* https://github.com/cirosantilli/linux-kernel-module-cheat#wait-queues */
#include <linux/delay.h> /* usleep_range */
#include <linux/kernel.h>
@@ -23,53 +6,69 @@ Outcome:
#include <linux/module.h>
#include <linux/wait.h> /* wait_queue_head_t, wait_event_interruptible, wake_up_interruptible */
static struct task_struct *kthread1, *kthread2;
static struct task_struct *kthread_wake;
static struct task_struct *kthread_sleep1;
static struct task_struct *kthread_sleep2;
static wait_queue_head_t queue;
static atomic_t awake = ATOMIC_INIT(0);
static atomic_t awake1 = ATOMIC_INIT(0);
static atomic_t awake2 = ATOMIC_INIT(0);
static int kthread_func1(void *data)
static int kthread_wake_func(void *data)
{
unsigned int i = 0;
while (!kthread_should_stop()) {
pr_info("1 %u\n", i);
pr_info("0 %u\n", i);
usleep_range(1000000, 1000001);
atomic_set(&awake, 1);
atomic_set(&awake1, 1);
atomic_set(&awake2, 1);
wake_up(&queue);
i++;
}
return 0;
}
static int kthread_func2(void *data)
static int kthread_sleep_func_1(void *data)
{
unsigned int i = 0;
while (!kthread_should_stop()) {
pr_info("2 %u\n", i);
pr_info("1 %u\n", i);
i++;
wait_event(queue, atomic_read(&awake));
atomic_set(&awake, 0);
wait_event(queue, atomic_read(&awake1));
atomic_set(&awake1, 0);
schedule();
}
return 0;
}
static int myinit(void)
static int kthread_sleep_func_2(void *data)
{
init_waitqueue_head(&queue);
kthread1 = kthread_create(kthread_func1, NULL, "mykthread1");
kthread2 = kthread_create(kthread_func2, NULL, "mykthread2");
wake_up_process(kthread1);
wake_up_process(kthread2);
unsigned int i = 0;
while (!kthread_should_stop()) {
pr_info("2 %u\n", i);
i++;
wait_event(queue, atomic_read(&awake2));
atomic_set(&awake2, 0);
schedule();
}
return 0;
}
static void myexit(void)
int init_module(void)
{
/* 2 must be stopped before, or else we can deadlock. */
kthread_stop(kthread2);
kthread_stop(kthread1);
init_waitqueue_head(&queue);
kthread_wake = kthread_create(kthread_wake_func, NULL, "wake");
kthread_sleep1 = kthread_create(kthread_sleep_func_1, NULL, "sleep1");
kthread_sleep2 = kthread_create(kthread_sleep_func_2, NULL, "sleep2");
wake_up_process(kthread_wake);
wake_up_process(kthread_sleep1);
wake_up_process(kthread_sleep2);
return 0;
}
module_init(myinit)
module_exit(myexit)
void cleanup_module(void)
{
kthread_stop(kthread_sleep2);
kthread_stop(kthread_sleep1);
kthread_stop(kthread_wake);
}
MODULE_LICENSE("GPL");

View File

@@ -1,6 +1,4 @@
/*
Two threads waiting on a single event.
*/
/* https://github.com/cirosantilli/linux-kernel-module-cheat#wait-queues */
#include <linux/delay.h> /* usleep_range */
#include <linux/kernel.h>
@@ -29,7 +27,7 @@ static int kthread_wake_func(void *data)
return 0;
}
static int kthread_sleep1_func(void *data)
static int kthread_sleep_func_1(void *data)
{
unsigned int i = 0;
while (!kthread_should_stop()) {
@@ -42,7 +40,7 @@ static int kthread_sleep1_func(void *data)
return 0;
}
static int kthread_sleep2_func(void *data)
static int kthread_sleep_func_2(void *data)
{
unsigned int i = 0;
while (!kthread_should_stop()) {
@@ -59,8 +57,8 @@ int init_module(void)
{
init_waitqueue_head(&queue);
kthread_wake = kthread_create(kthread_wake_func, NULL, "wake");
kthread_sleep1 = kthread_create(kthread_sleep1_func, NULL, "sleep1");
kthread_sleep2 = kthread_create(kthread_sleep2_func, NULL, "sleep2");
kthread_sleep1 = kthread_create(kthread_sleep_func_1, NULL, "sleep1");
kthread_sleep2 = kthread_create(kthread_sleep_func_2, NULL, "sleep2");
wake_up_process(kthread_wake);
wake_up_process(kthread_sleep1);
wake_up_process(kthread_sleep2);