xref: /linux-6.15/kernel/workqueue_internal.h (revision 84b233ad)
1 /*
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 
10 #include <linux/workqueue.h>
11 #include <linux/kthread.h>
12 
13 struct global_cwq;
14 struct 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  */
23 struct 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 */
32 	struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
33 	struct list_head	scheduled;	/* L: scheduled works */
34 	struct task_struct	*task;		/* I: worker task */
35 	struct worker_pool	*pool;		/* I: the associated pool */
36 	/* 64 bytes boundary on 64bit, 32 on 32bit */
37 	unsigned long		last_active;	/* L: last active timestamp */
38 	unsigned int		flags;		/* X: flags */
39 	int			id;		/* I: worker id */
40 
41 	/* for rebinding worker to CPU */
42 	struct work_struct	rebind_work;	/* L: for busy worker */
43 
44 	/* used only by rescuers to point to the target workqueue */
45 	struct workqueue_struct	*rescue_wq;	/* I: the workqueue to rescue */
46 };
47 
48 /**
49  * current_wq_worker - return struct worker if %current is a workqueue worker
50  */
51 static inline struct worker *current_wq_worker(void)
52 {
53 	if (current->flags & PF_WQ_WORKER)
54 		return kthread_data(current);
55 	return NULL;
56 }
57 
58 /*
59  * Scheduler hooks for concurrency managed workqueue.  Only to be used from
60  * sched.c and workqueue.c.
61  */
62 void wq_worker_waking_up(struct task_struct *task, unsigned int cpu);
63 struct task_struct *wq_worker_sleeping(struct task_struct *task,
64 				       unsigned int cpu);
65 
66 #endif /* _KERNEL_WORKQUEUE_INTERNAL_H */
67