xref: /openbmc/linux/kernel/workqueue_internal.h (revision e3b9f1e8)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * kernel/workqueue_internal.h
4  *
5  * Workqueue internal header file.  Only to be included by workqueue and
6  * core kernel subsystems.
7  */
8 #ifndef _KERNEL_WORKQUEUE_INTERNAL_H
9 #define _KERNEL_WORKQUEUE_INTERNAL_H
10 
11 #include <linux/workqueue.h>
12 #include <linux/kthread.h>
13 #include <linux/preempt.h>
14 
15 struct worker_pool;
16 
17 /*
18  * The poor guys doing the actual heavy lifting.  All on-duty workers are
19  * either serving the manager role, on idle list or on busy hash.  For
20  * details on the locking annotation (L, I, X...), refer to workqueue.c.
21  *
22  * Only to be used in workqueue and async.
23  */
24 struct worker {
25 	/* on idle list while idle, on busy hash table while busy */
26 	union {
27 		struct list_head	entry;	/* L: while idle */
28 		struct hlist_node	hentry;	/* L: while busy */
29 	};
30 
31 	struct work_struct	*current_work;	/* L: work being processed */
32 	work_func_t		current_func;	/* L: current_work's fn */
33 	struct pool_workqueue	*current_pwq; /* L: current_work's pwq */
34 	bool			desc_valid;	/* ->desc is valid */
35 	struct list_head	scheduled;	/* L: scheduled works */
36 
37 	/* 64 bytes boundary on 64bit, 32 on 32bit */
38 
39 	struct task_struct	*task;		/* I: worker task */
40 	struct worker_pool	*pool;		/* I: the associated pool */
41 						/* L: for rescuers */
42 	struct list_head	node;		/* A: anchored at pool->workers */
43 						/* A: runs through worker->node */
44 
45 	unsigned long		last_active;	/* L: last active timestamp */
46 	unsigned int		flags;		/* X: flags */
47 	int			id;		/* I: worker id */
48 
49 	/*
50 	 * Opaque string set with work_set_desc().  Printed out with task
51 	 * dump for debugging - WARN, BUG, panic or sysrq.
52 	 */
53 	char			desc[WORKER_DESC_LEN];
54 
55 	/* used only by rescuers to point to the target workqueue */
56 	struct workqueue_struct	*rescue_wq;	/* I: the workqueue to rescue */
57 };
58 
59 /**
60  * current_wq_worker - return struct worker if %current is a workqueue worker
61  */
62 static inline struct worker *current_wq_worker(void)
63 {
64 	if (in_task() && (current->flags & PF_WQ_WORKER))
65 		return kthread_data(current);
66 	return NULL;
67 }
68 
69 /*
70  * Scheduler hooks for concurrency managed workqueue.  Only to be used from
71  * sched/core.c and workqueue.c.
72  */
73 void wq_worker_waking_up(struct task_struct *task, int cpu);
74 struct task_struct *wq_worker_sleeping(struct task_struct *task);
75 
76 #endif /* _KERNEL_WORKQUEUE_INTERNAL_H */
77