[linux.git] / kernel / workqueue_internal.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * kernel/workqueue_internal.h
 *
 * Workqueue internal header file.  Only to be included by workqueue and
 * core kernel subsystems.
 */
#ifndef _KERNEL_WORKQUEUE_INTERNAL_H
#define _KERNEL_WORKQUEUE_INTERNAL_H

#include <linux/workqueue.h>
#include <linux/kthread.h>
#include <linux/preempt.h>

struct worker_pool;

/*
 * The poor guys doing the actual heavy lifting.  All on-duty workers are
 * either serving the manager role, on idle list or on busy hash.  For
 * details on the locking annotation (L, I, X...), refer to workqueue.c.
 *
 * Only to be used in workqueue and async.
 */
struct worker {
	/* on idle list while idle, on busy hash table while busy */
	union {
		struct list_head	entry;	/* L: while idle */
		struct hlist_node	hentry;	/* L: while busy */
	};

	struct work_struct	*current_work;	/* L: work being processed */
	work_func_t		current_func;	/* L: current_work's fn */
	struct pool_workqueue	*current_pwq; /* L: current_work's pwq */
	struct list_head	scheduled;	/* L: scheduled works */

	/* 64 bytes boundary on 64bit, 32 on 32bit */

	struct task_struct	*task;		/* I: worker task */
	struct worker_pool	*pool;		/* A: the associated pool */
						/* L: for rescuers */
	struct list_head	node;		/* A: anchored at pool->workers */
						/* A: runs through worker->node */

	unsigned long		last_active;	/* L: last active timestamp */
	unsigned int		flags;		/* X: flags */
	int			id;		/* I: worker id */
	int			sleeping;	/* None */

	/*
	 * Opaque string set with work_set_desc().  Printed out with task
	 * dump for debugging - WARN, BUG, panic or sysrq.
	 */
	char			desc[WORKER_DESC_LEN];

	/* used only by rescuers to point to the target workqueue */
	struct workqueue_struct	*rescue_wq;	/* I: the workqueue to rescue */

	/* used by the scheduler to determine a worker's last known identity */
	work_func_t		last_func;
};

/**
 * current_wq_worker - return struct worker if %current is a workqueue worker
 */
static inline struct worker *current_wq_worker(void)
{
	if (in_task() && (current->flags & PF_WQ_WORKER))
		return kthread_data(current);
	return NULL;
}

/*
 * Scheduler hooks for concurrency managed workqueue.  Only to be used from
 * sched/ and workqueue.c.
 */
void wq_worker_running(struct task_struct *task);
void wq_worker_sleeping(struct task_struct *task);
work_func_t wq_worker_last_func(struct task_struct *task);

#endif /* _KERNEL_WORKQUEUE_INTERNAL_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
ea138446 TH	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
2eaebdb3	11	#include <linux/workqueue.h>
84b233ad	12	#include <linux/kthread.h>
cef572ad	13	#include <linux/preempt.h>
2eaebdb3	14
2eaebdb3 TH	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 */
112202d9	33	struct pool_workqueue current_pwq; / L: current_work's pwq */
2eaebdb3	34	struct list_head scheduled; /* L: scheduled works */
3d1cb205 TH	35
	36	/* 64 bytes boundary on 64bit, 32 on 32bit */
	37
2eaebdb3	38	struct task_struct task; / I: worker task */
a2d812a2	39	struct worker_pool pool; / A: the associated pool */
b3104104	40	/* L: for rescuers */
92f9c5c4 LJ	41	struct list_head node; /* A: anchored at pool->workers */
92f9c5c4 LJ	42	/* A: runs through worker->node */
3d1cb205	43
2eaebdb3 TH	44	unsigned long last_active; /* L: last active timestamp */
	45	unsigned int flags; /* X: flags */
	46	int id; /* I: worker id */
6d25be57	47	int sleeping; /* None */
2eaebdb3	48
3d1cb205 TH	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
2eaebdb3 TH	55	/* used only by rescuers to point to the target workqueue */
2eaebdb3 TH	56	struct workqueue_struct rescue_wq; / I: the workqueue to rescue */
1b69ac6b JW	57
	58	/* used by the scheduler to determine a worker's last known identity */
	59	work_func_t last_func;
2eaebdb3 TH	60	};
2eaebdb3 TH	61
84b233ad TH	62	/**
	63	* current_wq_worker - return struct worker if %current is a workqueue worker
	64	*/
	65	static inline struct worker *current_wq_worker(void)
	66	{
cef572ad	67	if (in_task() && (current->flags & PF_WQ_WORKER))
84b233ad TH	68	return kthread_data(current);
	69	return NULL;
	70	}
	71
ea138446 TH	72	/*
ea138446 TH	73	* Scheduler hooks for concurrency managed workqueue. Only to be used from
1b69ac6b	74	* sched/ and workqueue.c.
ea138446	75	*/
6d25be57 TG	76	void wq_worker_running(struct task_struct *task);
6d25be57 TG	77	void wq_worker_sleeping(struct task_struct *task);
1b69ac6b	78	work_func_t wq_worker_last_func(struct task_struct *task);
ea138446 TH	79
ea138446 TH	80	#endif /* _KERNEL_WORKQUEUE_INTERNAL_H */