Commit 443378f0 authored Nov 30, 2021 by Paul E. McKenney Committed by Tejun Heo Dec 01, 2021

workqueue: 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, but does not spell out the
consequences, which turn out to be quite mild.  Therefore expand this
comment to explicitly say that the penalty for failing to nail down the
specified CPU is that the workqueue handler might find itself executing
on some other CPU.

Cc: Tejun Heo <tj@kernel.org>
Cc: Lai Jiangshan <jiangshanlai@gmail.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Signed-off-by: Tejun Heo <tj@kernel.org>

parent 58e1100f

kernel/workqueue.c

+2 −1

Original line number	Diff line number	Diff line
		@@ -1531,7 +1531,8 @@ static void __queue_work(int cpu, struct workqueue_struct *wq,
		* @work: work to queue
		*
		* We queue the work to a specific CPU, the caller must ensure it
		* can't go away.
		* can't go away. Callers that fail to ensure that the specified
		* CPU cannot go away will execute on a randomly chosen CPU.
		*
		* Return: %false if @work was already on a queue, %true otherwise.
		*/