sched: Improve documentation for wake_up_bit/wait_on_bit family of functions

Browse source

This patch revises the documention for wake_up_bit(),
clear_and_wake_up_bit(), and all the wait_on_bit() family of functions.

The new documentation places less emphasis on the pool of waitqueues
used (an implementation detail) and focuses instead on details of how
the functions behave.

The barriers included in the wait functions and clear_and_wake_up_bit()
and those required for wake_up_bit() are spelled out more clearly.

The error statuses returned are given explicitly.

The fact that the wait_on_bit_lock() function sets the bit is made more
obvious.

Signed-off-by: NeilBrown <neilb@suse.de>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Link: https://lore.kernel.org/r/20240925053405.3960701-3-neilb@suse.de

...

This commit is contained in:

NeilBrown 2024-09-25 15:31:39 +10:00 • committed by Peter Zijlstra

parent 2382d68d7d

commit 3cdee6b359

2 changed files with 107 additions and 86 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

159

include/linux/wait_bit.h

View file

34

kernel/sched/wait_bit.c

View file