[linux-2.6-block.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;	/* K: work being processed and its */
	work_func_t		current_func;	/* K: function */
	struct pool_workqueue	*current_pwq;	/* K: pwq */
	u64			current_at;	/* K: runtime at start or last wakeup */
	unsigned int		current_color;	/* K: color */

	int			sleeping;	/* S: is worker sleeping? */

	/* used by the scheduler to determine a worker's last known identity */
	work_func_t		last_func;	/* K: last work's fn */

	struct list_head	scheduled;	/* L: scheduled works */

	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;	/* K: last active timestamp */
	unsigned int		flags;		/* L: flags */
	int			id;		/* I: worker id */

	/*
	 * 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 */
};

/**
 * 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);
void wq_worker_tick(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
bdf8b9bf TH	31	struct work_struct current_work; / K: work being processed and its */
	32	work_func_t current_func; /* K: function */
	33	struct pool_workqueue current_pwq; / K: pwq */
616db877	34	u64 current_at; /* K: runtime at start or last wakeup */
bdf8b9bf TH	35	unsigned int current_color; /* K: color */
	36
	37	int sleeping; /* S: is worker sleeping? */
3a46c983 TH	38
3a46c983 TH	39	/* used by the scheduler to determine a worker's last known identity */
bdf8b9bf	40	work_func_t last_func; /* K: last work's fn */
3d1cb205	41
3a46c983	42	struct list_head scheduled; /* L: scheduled works */
3d1cb205	43
2eaebdb3	44	struct task_struct task; / I: worker task */
a2d812a2	45	struct worker_pool pool; / A: the associated pool */
b3104104	46	/* L: for rescuers */
92f9c5c4 LJ	47	struct list_head node; /* A: anchored at pool->workers */
92f9c5c4 LJ	48	/* A: runs through worker->node */
3d1cb205	49
bdf8b9bf	50	unsigned long last_active; /* K: last active timestamp */
bc8b50c2	51	unsigned int flags; /* L: flags */
2eaebdb3 TH	52	int id; /* I: worker id */
2eaebdb3 TH	53
3d1cb205 TH	54	/*
	55	* Opaque string set with work_set_desc(). Printed out with task
	56	* dump for debugging - WARN, BUG, panic or sysrq.
	57	*/
	58	char desc[WORKER_DESC_LEN];
	59
2eaebdb3 TH	60	/* used only by rescuers to point to the target workqueue */
	61	struct workqueue_struct rescue_wq; / I: the workqueue to rescue */
	62	};
	63
84b233ad TH	64	/**
	65	* current_wq_worker - return struct worker if %current is a workqueue worker
	66	*/
	67	static inline struct worker *current_wq_worker(void)
	68	{
cef572ad	69	if (in_task() && (current->flags & PF_WQ_WORKER))
84b233ad TH	70	return kthread_data(current);
	71	return NULL;
	72	}
	73
ea138446 TH	74	/*
ea138446 TH	75	* Scheduler hooks for concurrency managed workqueue. Only to be used from
1b69ac6b	76	* sched/ and workqueue.c.
ea138446	77	*/
6d25be57 TG	78	void wq_worker_running(struct task_struct *task);
6d25be57 TG	79	void wq_worker_sleeping(struct task_struct *task);
616db877	80	void wq_worker_tick(struct task_struct *task);
1b69ac6b	81	work_func_t wq_worker_last_func(struct task_struct *task);
ea138446 TH	82
ea138446 TH	83	#endif /* _KERNEL_WORKQUEUE_INTERNAL_H */