blob: c7f7db1f335a38769e03dc5d135a45c17e148ef7 [file] [log] [blame]
Tejun Heoea138442013-01-18 14:05:55 -08001/*
2 * kernel/workqueue_internal.h
3 *
4 * Workqueue internal header file. Only to be included by workqueue and
5 * core kernel subsystems.
6 */
7#ifndef _KERNEL_WORKQUEUE_INTERNAL_H
8#define _KERNEL_WORKQUEUE_INTERNAL_H
9
Tejun Heo2eaebdb2013-01-18 14:05:55 -080010#include <linux/workqueue.h>
Tejun Heo84b233a2013-01-18 14:05:56 -080011#include <linux/kthread.h>
Li Bin46f15502017-10-28 11:07:28 +080012#include <linux/preempt.h>
Tejun Heo2eaebdb2013-01-18 14:05:55 -080013
Tejun Heo2eaebdb2013-01-18 14:05:55 -080014struct worker_pool;
15
16/*
17 * The poor guys doing the actual heavy lifting. All on-duty workers are
18 * either serving the manager role, on idle list or on busy hash. For
19 * details on the locking annotation (L, I, X...), refer to workqueue.c.
20 *
21 * Only to be used in workqueue and async.
22 */
23struct worker {
24 /* on idle list while idle, on busy hash table while busy */
25 union {
26 struct list_head entry; /* L: while idle */
27 struct hlist_node hentry; /* L: while busy */
28 };
29
30 struct work_struct *current_work; /* L: work being processed */
31 work_func_t current_func; /* L: current_work's fn */
Tejun Heo112202d2013-02-13 19:29:12 -080032 struct pool_workqueue *current_pwq; /* L: current_work's pwq */
Tejun Heo3d1cb202013-04-30 15:27:22 -070033 bool desc_valid; /* ->desc is valid */
Tejun Heo2eaebdb2013-01-18 14:05:55 -080034 struct list_head scheduled; /* L: scheduled works */
Tejun Heo3d1cb202013-04-30 15:27:22 -070035
36 /* 64 bytes boundary on 64bit, 32 on 32bit */
37
Tejun Heo2eaebdb2013-01-18 14:05:55 -080038 struct task_struct *task; /* I: worker task */
39 struct worker_pool *pool; /* I: the associated pool */
Lai Jiangshanb3104102013-02-19 12:17:02 -080040 /* L: for rescuers */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080041 struct list_head node; /* A: anchored at pool->workers */
42 /* A: runs through worker->node */
Tejun Heo3d1cb202013-04-30 15:27:22 -070043
Tejun Heo2eaebdb2013-01-18 14:05:55 -080044 unsigned long last_active; /* L: last active timestamp */
45 unsigned int flags; /* X: flags */
46 int id; /* I: worker id */
47
Tejun Heo3d1cb202013-04-30 15:27:22 -070048 /*
49 * Opaque string set with work_set_desc(). Printed out with task
50 * dump for debugging - WARN, BUG, panic or sysrq.
51 */
52 char desc[WORKER_DESC_LEN];
53
Tejun Heo2eaebdb2013-01-18 14:05:55 -080054 /* used only by rescuers to point to the target workqueue */
55 struct workqueue_struct *rescue_wq; /* I: the workqueue to rescue */
Johannes Weinerb7f0f222019-02-01 14:20:42 -080056
57 /* used by the scheduler to determine a worker's last known identity */
58 work_func_t last_func;
Tejun Heo2eaebdb2013-01-18 14:05:55 -080059};
60
Tejun Heo84b233a2013-01-18 14:05:56 -080061/**
62 * current_wq_worker - return struct worker if %current is a workqueue worker
63 */
64static inline struct worker *current_wq_worker(void)
65{
Li Bin46f15502017-10-28 11:07:28 +080066 if (in_task() && (current->flags & PF_WQ_WORKER))
Tejun Heo84b233a2013-01-18 14:05:56 -080067 return kthread_data(current);
68 return NULL;
69}
70
Tejun Heoea138442013-01-18 14:05:55 -080071/*
72 * Scheduler hooks for concurrency managed workqueue. Only to be used from
Johannes Weinerb7f0f222019-02-01 14:20:42 -080073 * sched/ and workqueue.c.
Tejun Heoea138442013-01-18 14:05:55 -080074 */
Tejun Heod84ff052013-03-12 11:29:59 -070075void wq_worker_waking_up(struct task_struct *task, int cpu);
Alexander Gordeev9b7f6592016-03-02 12:53:31 +010076struct task_struct *wq_worker_sleeping(struct task_struct *task);
Johannes Weinerb7f0f222019-02-01 14:20:42 -080077work_func_t wq_worker_last_func(struct task_struct *task);
Tejun Heoea138442013-01-18 14:05:55 -080078
79#endif /* _KERNEL_WORKQUEUE_INTERNAL_H */