diff options
| author | Paul E. McKenney <paulmck@kernel.org> | 2023-04-28 16:47:07 -0700 |
|---|---|---|
| committer | Tejun Heo <tj@kernel.org> | 2023-05-09 05:37:42 -1000 |
| commit | 854f5cc5b7355ceebf2bdfed97ea8f3c5d47a0c3 (patch) | |
| tree | fa9a3b2c95fc28c2a84b743dc450a7ff571fc207 /kernel/workqueue.c | |
| parent | ba0ad6ed89fd5dada3b7b65ef2b08e95d449d4ab (diff) | |
| download | linux-854f5cc5b7355ceebf2bdfed97ea8f3c5d47a0c3.tar.gz | |
Further upgrade queue_work_on() comment
The current queue_work_on() docbook comment says that the caller must
ensure that the specified CPU can't go away, and further says that the
penalty for failing to nail down the specified CPU is that the workqueue
handler might find itself executing on some other CPU. This is true
as far as it goes, but fails to note what happens if the specified CPU
never was online. Therefore, further expand this comment to say that
specifying a CPU that was never online will result in a splat.
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Cc: Lai Jiangshan <jiangshanlai@gmail.com>
Cc: Tejun Heo <tj@kernel.org>
Signed-off-by: Tejun Heo <tj@kernel.org>
Diffstat (limited to 'kernel/workqueue.c')
| -rw-r--r-- | kernel/workqueue.c | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/kernel/workqueue.c b/kernel/workqueue.c index 4666a1a92a31b2..36bccc1285b3f4 100644 --- a/kernel/workqueue.c +++ b/kernel/workqueue.c @@ -1539,6 +1539,8 @@ out: * We queue the work to a specific CPU, the caller must ensure it * can't go away. Callers that fail to ensure that the specified * CPU cannot go away will execute on a randomly chosen CPU. + * But note well that callers specifying a CPU that never has been + * online will get a splat. * * Return: %false if @work was already on a queue, %true otherwise. */ |