diff mbox series

[workqueues] Further upgrade queue_work_on() comment

Message ID ae548f82-fd4e-490e-889a-3307b9a2c531@paulmck-laptop
State New
Headers
Series [workqueues] Further upgrade queue_work_on() comment |

Commit Message

Paul E. McKenney April 28, 2023, 11:47 p.m. UTC 
  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>

Comments

Tejun Heo May 9, 2023, 3:37 p.m. UTC | #1 
On Fri, Apr 28, 2023 at 04:47:07PM -0700, Paul E. McKenney wrote:
> 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>

Applied to wq/for-6.5.

Thanks.
diff mbox series

Patch

diff --git a/kernel/workqueue.c b/kernel/workqueue.c
index b8b541caed48..2dd3308edc01 100644
--- a/kernel/workqueue.c
+++ b/kernel/workqueue.c
@@ -1537,6 +1537,8 @@  static void __queue_work(int cpu, struct workqueue_struct *wq,
  * 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.
  */