blob: 8635417c587b7a5ba89d843a31fc5b58d817f777 [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>
Tejun Heo2eaebdb2013-01-18 14:05:55 -080012
Tejun Heo2eaebdb2013-01-18 14:05:55 -080013struct worker_pool;
14
15/*
16 * The poor guys doing the actual heavy lifting. All on-duty workers are
17 * either serving the manager role, on idle list or on busy hash. For
18 * details on the locking annotation (L, I, X...), refer to workqueue.c.
19 *
20 * Only to be used in workqueue and async.
21 */
22struct worker {
23 /* on idle list while idle, on busy hash table while busy */
24 union {
25 struct list_head entry; /* L: while idle */
26 struct hlist_node hentry; /* L: while busy */
27 };
28
29 struct work_struct *current_work; /* L: work being processed */
30 work_func_t current_func; /* L: current_work's fn */
Tejun Heo112202d2013-02-13 19:29:12 -080031 struct pool_workqueue *current_pwq; /* L: current_work's pwq */
Tejun Heo3d1cb202013-04-30 15:27:22 -070032 bool desc_valid; /* ->desc is valid */
Tejun Heo2eaebdb2013-01-18 14:05:55 -080033 struct list_head scheduled; /* L: scheduled works */
Tejun Heo3d1cb202013-04-30 15:27:22 -070034
35 /* 64 bytes boundary on 64bit, 32 on 32bit */
36
Tejun Heo2eaebdb2013-01-18 14:05:55 -080037 struct task_struct *task; /* I: worker task */
38 struct worker_pool *pool; /* I: the associated pool */
Lai Jiangshanb3104102013-02-19 12:17:02 -080039 /* L: for rescuers */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080040 struct list_head node; /* A: anchored at pool->workers */
41 /* A: runs through worker->node */
Tejun Heo3d1cb202013-04-30 15:27:22 -070042
Tejun Heo2eaebdb2013-01-18 14:05:55 -080043 unsigned long last_active; /* L: last active timestamp */
44 unsigned int flags; /* X: flags */
45 int id; /* I: worker id */
46
Tejun Heo3d1cb202013-04-30 15:27:22 -070047 /*
48 * Opaque string set with work_set_desc(). Printed out with task
49 * dump for debugging - WARN, BUG, panic or sysrq.
50 */
51 char desc[WORKER_DESC_LEN];
52
Tejun Heo2eaebdb2013-01-18 14:05:55 -080053 /* used only by rescuers to point to the target workqueue */
54 struct workqueue_struct *rescue_wq; /* I: the workqueue to rescue */
55};
56
Tejun Heo84b233a2013-01-18 14:05:56 -080057/**
58 * current_wq_worker - return struct worker if %current is a workqueue worker
59 */
60static inline struct worker *current_wq_worker(void)
61{
62 if (current->flags & PF_WQ_WORKER)
63 return kthread_data(current);
64 return NULL;
65}
66
Tejun Heoea138442013-01-18 14:05:55 -080067/*
68 * Scheduler hooks for concurrency managed workqueue. Only to be used from
Viresh Kumar0a0fca92013-06-04 13:10:24 +053069 * sched/core.c and workqueue.c.
Tejun Heoea138442013-01-18 14:05:55 -080070 */
Tejun Heod84ff052013-03-12 11:29:59 -070071void wq_worker_waking_up(struct task_struct *task, int cpu);
Alexander Gordeev9b7f6592016-03-02 12:53:31 +010072struct task_struct *wq_worker_sleeping(struct task_struct *task);
Tejun Heoea138442013-01-18 14:05:55 -080073
74#endif /* _KERNEL_WORKQUEUE_INTERNAL_H */