* [PATCH] kernel: workqueue: clarify wq_worker_last_func() caller requirements
@ 2019-02-06 15:05 Johannes Weiner
2019-02-06 16:31 ` Tejun Heo
0 siblings, 1 reply; 2+ messages in thread
From: Johannes Weiner @ 2019-02-06 15:05 UTC (permalink / raw)
To: Tejun Heo
Cc: Andrew Morton, Peter Zijlstra, linux-mm, linux-kernel, kernel-team
This function can only be called safely from very specific scheduler
contexts. Document those.
Suggested-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Johannes Weiner <hannes@cmpxchg.org>
---
kernel/workqueue.c | 10 ++++++++++
1 file changed, 10 insertions(+)
Andrew suggested including the explanations that came up during the
code review in the function doc. As the function has since been
merged, sending as follow-up for 5.1. Thanks!
diff --git a/kernel/workqueue.c b/kernel/workqueue.c
index fc5d23d752a5..23a67b9430da 100644
--- a/kernel/workqueue.c
+++ b/kernel/workqueue.c
@@ -918,6 +918,16 @@ struct task_struct *wq_worker_sleeping(struct task_struct *task)
* CONTEXT:
* spin_lock_irq(rq->lock)
*
+ * This function is called during schedule() when a kworker is going
+ * to sleep. It's used by psi to identify aggregation workers during
+ * dequeuing, to allow periodic aggregation to shut-off when that
+ * worker is the last task in the system or cgroup to go to sleep.
+ *
+ * As this function doesn't involve any workqueue-related locking, it
+ * only returns stable values when called from inside the scheduler's
+ * queuing and dequeuing paths, when @task, which must be a kworker,
+ * is guaranteed to not be processing any works.
+ *
* Return:
* The last work function %current executed as a worker, NULL if it
* hasn't executed any work yet.
--
2.20.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
end of thread, other threads:[~2019-02-06 16:31 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-02-06 15:05 [PATCH] kernel: workqueue: clarify wq_worker_last_func() caller requirements Johannes Weiner
2019-02-06 16:31 ` Tejun Heo
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).