[mirror_ubuntu-bionic-kernel.git] / include / linux / workqueue.h

/*
 * workqueue.h --- work queue handling for Linux.
 */

#ifndef _LINUX_WORKQUEUE_H
#define _LINUX_WORKQUEUE_H

#include <linux/timer.h>
#include <linux/linkage.h>
#include <linux/bitops.h>
#include <linux/lockdep.h>
#include <linux/threads.h>
#include <linux/atomic.h>

struct workqueue_struct;

struct work_struct;
typedef void (*work_func_t)(struct work_struct *work);
void delayed_work_timer_fn(unsigned long __data);

/*
 * The first word is the work queue pointer and the flags rolled into
 * one
 */
#define work_data_bits(work) ((unsigned long *)(&(work)->data))

enum {
	WORK_STRUCT_PENDING_BIT	= 0,	/* work item is pending execution */
	WORK_STRUCT_DELAYED_BIT	= 1,	/* work item is delayed */
	WORK_STRUCT_CWQ_BIT	= 2,	/* data points to cwq */
	WORK_STRUCT_LINKED_BIT	= 3,	/* next work is linked to this one */
#ifdef CONFIG_DEBUG_OBJECTS_WORK
	WORK_STRUCT_STATIC_BIT	= 4,	/* static initializer (debugobjects) */
	WORK_STRUCT_COLOR_SHIFT	= 5,	/* color for workqueue flushing */
#else
	WORK_STRUCT_COLOR_SHIFT	= 4,	/* color for workqueue flushing */
#endif

	WORK_STRUCT_COLOR_BITS	= 4,

	WORK_STRUCT_PENDING	= 1 << WORK_STRUCT_PENDING_BIT,
	WORK_STRUCT_DELAYED	= 1 << WORK_STRUCT_DELAYED_BIT,
	WORK_STRUCT_CWQ		= 1 << WORK_STRUCT_CWQ_BIT,
	WORK_STRUCT_LINKED	= 1 << WORK_STRUCT_LINKED_BIT,
#ifdef CONFIG_DEBUG_OBJECTS_WORK
	WORK_STRUCT_STATIC	= 1 << WORK_STRUCT_STATIC_BIT,
#else
	WORK_STRUCT_STATIC	= 0,
#endif

	/*
	 * The last color is no color used for works which don't
	 * participate in workqueue flushing.
	 */
	WORK_NR_COLORS		= (1 << WORK_STRUCT_COLOR_BITS) - 1,
	WORK_NO_COLOR		= WORK_NR_COLORS,

	/* special cpu IDs */
	WORK_CPU_UNBOUND	= NR_CPUS,
	WORK_CPU_NONE		= NR_CPUS + 1,
	WORK_CPU_LAST		= WORK_CPU_NONE,

	/*
	 * Reserve 7 bits off of cwq pointer w/ debugobjects turned
	 * off.  This makes cwqs aligned to 256 bytes and allows 15
	 * workqueue flush colors.
	 */
	WORK_STRUCT_FLAG_BITS	= WORK_STRUCT_COLOR_SHIFT +
				  WORK_STRUCT_COLOR_BITS,

	/* data contains off-queue information when !WORK_STRUCT_CWQ */
	WORK_OFFQ_FLAG_BASE	= WORK_STRUCT_FLAG_BITS,

	WORK_OFFQ_CANCELING	= (1 << WORK_OFFQ_FLAG_BASE),

	WORK_OFFQ_FLAG_BITS	= 1,
	WORK_OFFQ_CPU_SHIFT	= WORK_OFFQ_FLAG_BASE + WORK_OFFQ_FLAG_BITS,

	/* convenience constants */
	WORK_STRUCT_FLAG_MASK	= (1UL << WORK_STRUCT_FLAG_BITS) - 1,
	WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK,
	WORK_STRUCT_NO_CPU	= (unsigned long)WORK_CPU_NONE << WORK_OFFQ_CPU_SHIFT,

	/* bit mask for work_busy() return values */
	WORK_BUSY_PENDING	= 1 << 0,
	WORK_BUSY_RUNNING	= 1 << 1,
};

struct work_struct {
	atomic_long_t data;
	struct list_head entry;
	work_func_t func;
#ifdef CONFIG_LOCKDEP
	struct lockdep_map lockdep_map;
#endif
};

#define WORK_DATA_INIT()	ATOMIC_LONG_INIT(WORK_STRUCT_NO_CPU)
#define WORK_DATA_STATIC_INIT()	\
	ATOMIC_LONG_INIT(WORK_STRUCT_NO_CPU | WORK_STRUCT_STATIC)

struct delayed_work {
	struct work_struct work;
	struct timer_list timer;
	int cpu;
};

static inline struct delayed_work *to_delayed_work(struct work_struct *work)
{
	return container_of(work, struct delayed_work, work);
}

struct execute_work {
	struct work_struct work;
};

#ifdef CONFIG_LOCKDEP
/*
 * NB: because we have to copy the lockdep_map, setting _key
 * here is required, otherwise it could get initialised to the
 * copy of the lockdep_map!
 */
#define __WORK_INIT_LOCKDEP_MAP(n, k) \
	.lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k),
#else
#define __WORK_INIT_LOCKDEP_MAP(n, k)
#endif

#define __WORK_INITIALIZER(n, f) {					\
	.data = WORK_DATA_STATIC_INIT(),				\
	.entry	= { &(n).entry, &(n).entry },				\
	.func = (f),							\
	__WORK_INIT_LOCKDEP_MAP(#n, &(n))				\
	}

#define __DELAYED_WORK_INITIALIZER(n, f, tflags) {			\
	.work = __WORK_INITIALIZER((n).work, (f)),			\
	.timer = __TIMER_INITIALIZER(delayed_work_timer_fn,		\
			0, (unsigned long)&(n), (tflags)),		\
	}

#define DECLARE_WORK(n, f)						\
	struct work_struct n = __WORK_INITIALIZER(n, f)

#define DECLARE_DELAYED_WORK(n, f)					\
	struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, 0)

#define DECLARE_DEFERRABLE_WORK(n, f)					\
	struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, TIMER_DEFERRABLE)

/*
 * initialize a work item's function pointer
 */
#define PREPARE_WORK(_work, _func)					\
	do {								\
		(_work)->func = (_func);				\
	} while (0)

#define PREPARE_DELAYED_WORK(_work, _func)				\
	PREPARE_WORK(&(_work)->work, (_func))

#ifdef CONFIG_DEBUG_OBJECTS_WORK
extern void __init_work(struct work_struct *work, int onstack);
extern void destroy_work_on_stack(struct work_struct *work);
static inline unsigned int work_static(struct work_struct *work)
{
	return *work_data_bits(work) & WORK_STRUCT_STATIC;
}
#else
static inline void __init_work(struct work_struct *work, int onstack) { }
static inline void destroy_work_on_stack(struct work_struct *work) { }
static inline unsigned int work_static(struct work_struct *work) { return 0; }
#endif

/*
 * initialize all of a work item in one go
 *
 * NOTE! No point in using "atomic_long_set()": using a direct
 * assignment of the work data initializer allows the compiler
 * to generate better code.
 */
#ifdef CONFIG_LOCKDEP
#define __INIT_WORK(_work, _func, _onstack)				\
	do {								\
		static struct lock_class_key __key;			\
									\
		__init_work((_work), _onstack);				\
		(_work)->data = (atomic_long_t) WORK_DATA_INIT();	\
		lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0); \
		INIT_LIST_HEAD(&(_work)->entry);			\
		PREPARE_WORK((_work), (_func));				\
	} while (0)
#else
#define __INIT_WORK(_work, _func, _onstack)				\
	do {								\
		__init_work((_work), _onstack);				\
		(_work)->data = (atomic_long_t) WORK_DATA_INIT();	\
		INIT_LIST_HEAD(&(_work)->entry);			\
		PREPARE_WORK((_work), (_func));				\
	} while (0)
#endif

#define INIT_WORK(_work, _func)						\
	do {								\
		__INIT_WORK((_work), (_func), 0);			\
	} while (0)

#define INIT_WORK_ONSTACK(_work, _func)					\
	do {								\
		__INIT_WORK((_work), (_func), 1);			\
	} while (0)

#define __INIT_DELAYED_WORK(_work, _func, _tflags)			\
	do {								\
		INIT_WORK(&(_work)->work, (_func));			\
		__setup_timer(&(_work)->timer, delayed_work_timer_fn,	\
			      (unsigned long)(_work), (_tflags));	\
	} while (0)

#define __INIT_DELAYED_WORK_ONSTACK(_work, _func, _tflags)		\
	do {								\
		INIT_WORK_ONSTACK(&(_work)->work, (_func));		\
		__setup_timer_on_stack(&(_work)->timer,			\
				       delayed_work_timer_fn,		\
				       (unsigned long)(_work),		\
				       (_tflags));			\
	} while (0)

#define INIT_DELAYED_WORK(_work, _func)					\
	__INIT_DELAYED_WORK(_work, _func, 0)

#define INIT_DELAYED_WORK_ONSTACK(_work, _func)				\
	__INIT_DELAYED_WORK_ONSTACK(_work, _func, 0)

#define INIT_DEFERRABLE_WORK(_work, _func)				\
	__INIT_DELAYED_WORK(_work, _func, TIMER_DEFERRABLE)

#define INIT_DEFERRABLE_WORK_ONSTACK(_work, _func)			\
	__INIT_DELAYED_WORK_ONSTACK(_work, _func, TIMER_DEFERRABLE)

/**
 * work_pending - Find out whether a work item is currently pending
 * @work: The work item in question
 */
#define work_pending(work) \
	test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))

/**
 * delayed_work_pending - Find out whether a delayable work item is currently
 * pending
 * @work: The work item in question
 */
#define delayed_work_pending(w) \
	work_pending(&(w)->work)

/**
 * work_clear_pending - for internal use only, mark a work item as not pending
 * @work: The work item in question
 */
#define work_clear_pending(work) \
	clear_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))

/*
 * Workqueue flags and constants.  For details, please refer to
 * Documentation/workqueue.txt.
 */
enum {
	WQ_NON_REENTRANT	= 1 << 0, /* guarantee non-reentrance */
	WQ_UNBOUND		= 1 << 1, /* not bound to any cpu */
	WQ_FREEZABLE		= 1 << 2, /* freeze during suspend */
	WQ_MEM_RECLAIM		= 1 << 3, /* may be used for memory reclaim */
	WQ_HIGHPRI		= 1 << 4, /* high priority */
	WQ_CPU_INTENSIVE	= 1 << 5, /* cpu instensive workqueue */

	WQ_DRAINING		= 1 << 6, /* internal: workqueue is draining */
	WQ_RESCUER		= 1 << 7, /* internal: workqueue has rescuer */

	WQ_MAX_ACTIVE		= 512,	  /* I like 512, better ideas? */
	WQ_MAX_UNBOUND_PER_CPU	= 4,	  /* 4 * #cpus for unbound wq */
	WQ_DFL_ACTIVE		= WQ_MAX_ACTIVE / 2,
};

/* unbound wq's aren't per-cpu, scale max_active according to #cpus */
#define WQ_UNBOUND_MAX_ACTIVE	\
	max_t(int, WQ_MAX_ACTIVE, num_possible_cpus() * WQ_MAX_UNBOUND_PER_CPU)

/*
 * System-wide workqueues which are always present.
 *
 * system_wq is the one used by schedule[_delayed]_work[_on]().
 * Multi-CPU multi-threaded.  There are users which expect relatively
 * short queue flush time.  Don't queue works which can run for too
 * long.
 *
 * system_long_wq is similar to system_wq but may host long running
 * works.  Queue flushing might take relatively long.
 *
 * system_unbound_wq is unbound workqueue.  Workers are not bound to
 * any specific CPU, not concurrency managed, and all queued works are
 * executed immediately as long as max_active limit is not reached and
 * resources are available.
 *
 * system_freezable_wq is equivalent to system_wq except that it's
 * freezable.
 */
extern struct workqueue_struct *system_wq;
extern struct workqueue_struct *system_long_wq;
extern struct workqueue_struct *system_unbound_wq;
extern struct workqueue_struct *system_freezable_wq;

static inline struct workqueue_struct * __deprecated __system_nrt_wq(void)
{
	return system_wq;
}

static inline struct workqueue_struct * __deprecated __system_nrt_freezable_wq(void)
{
	return system_freezable_wq;
}

/* equivlalent to system_wq and system_freezable_wq, deprecated */
#define system_nrt_wq			__system_nrt_wq()
#define system_nrt_freezable_wq		__system_nrt_freezable_wq()

extern struct workqueue_struct *
__alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active,
	struct lock_class_key *key, const char *lock_name, ...) __printf(1, 6);

/**
 * alloc_workqueue - allocate a workqueue
 * @fmt: printf format for the name of the workqueue
 * @flags: WQ_* flags
 * @max_active: max in-flight work items, 0 for default
 * @args: args for @fmt
 *
 * Allocate a workqueue with the specified parameters.  For detailed
 * information on WQ_* flags, please refer to Documentation/workqueue.txt.
 *
 * The __lock_name macro dance is to guarantee that single lock_class_key
 * doesn't end up with different namesm, which isn't allowed by lockdep.
 *
 * RETURNS:
 * Pointer to the allocated workqueue on success, %NULL on failure.
 */
#ifdef CONFIG_LOCKDEP
#define alloc_workqueue(fmt, flags, max_active, args...)		\
({									\
	static struct lock_class_key __key;				\
	const char *__lock_name;					\
									\
	if (__builtin_constant_p(fmt))					\
		__lock_name = (fmt);					\
	else								\
		__lock_name = #fmt;					\
									\
	__alloc_workqueue_key((fmt), (flags), (max_active),		\
			      &__key, __lock_name, ##args);		\
})
#else
#define alloc_workqueue(fmt, flags, max_active, args...)		\
	__alloc_workqueue_key((fmt), (flags), (max_active),		\
			      NULL, NULL, ##args)
#endif

/**
 * alloc_ordered_workqueue - allocate an ordered workqueue
 * @fmt: printf format for the name of the workqueue
 * @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful)
 * @args: args for @fmt
 *
 * Allocate an ordered workqueue.  An ordered workqueue executes at
 * most one work item at any given time in the queued order.  They are
 * implemented as unbound workqueues with @max_active of one.
 *
 * RETURNS:
 * Pointer to the allocated workqueue on success, %NULL on failure.
 */
#define alloc_ordered_workqueue(fmt, flags, args...)			\
	alloc_workqueue(fmt, WQ_UNBOUND | (flags), 1, ##args)

#define create_workqueue(name)						\
	alloc_workqueue((name), WQ_MEM_RECLAIM, 1)
#define create_freezable_workqueue(name)				\
	alloc_workqueue((name), WQ_FREEZABLE | WQ_UNBOUND | WQ_MEM_RECLAIM, 1)
#define create_singlethread_workqueue(name)				\
	alloc_workqueue((name), WQ_UNBOUND | WQ_MEM_RECLAIM, 1)

extern void destroy_workqueue(struct workqueue_struct *wq);

extern bool queue_work_on(int cpu, struct workqueue_struct *wq,
			struct work_struct *work);
extern bool queue_work(struct workqueue_struct *wq, struct work_struct *work);
extern bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
			struct delayed_work *work, unsigned long delay);
extern bool queue_delayed_work(struct workqueue_struct *wq,
			struct delayed_work *work, unsigned long delay);
extern bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
			struct delayed_work *dwork, unsigned long delay);
extern bool mod_delayed_work(struct workqueue_struct *wq,
			struct delayed_work *dwork, unsigned long delay);

extern void flush_workqueue(struct workqueue_struct *wq);
extern void drain_workqueue(struct workqueue_struct *wq);
extern void flush_scheduled_work(void);

extern bool schedule_work_on(int cpu, struct work_struct *work);
extern bool schedule_work(struct work_struct *work);
extern bool schedule_delayed_work_on(int cpu, struct delayed_work *work,
				     unsigned long delay);
extern bool schedule_delayed_work(struct delayed_work *work,
				  unsigned long delay);
extern int schedule_on_each_cpu(work_func_t func);
extern int keventd_up(void);

int execute_in_process_context(work_func_t fn, struct execute_work *);

extern bool flush_work(struct work_struct *work);
extern bool cancel_work_sync(struct work_struct *work);

extern bool flush_delayed_work(struct delayed_work *dwork);
extern bool cancel_delayed_work_sync(struct delayed_work *dwork);

extern void workqueue_set_max_active(struct workqueue_struct *wq,
				     int max_active);
extern bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq);
extern unsigned int work_cpu(struct work_struct *work);
extern unsigned int work_busy(struct work_struct *work);

/*
 * Kill off a pending schedule_delayed_work().  Note that the work callback
 * function may still be running on return from cancel_delayed_work(), unless
 * it returns 1 and the work doesn't re-arm itself. Run flush_workqueue() or
 * cancel_work_sync() to wait on it.
 */
static inline bool cancel_delayed_work(struct delayed_work *work)
{
	bool ret;

	ret = del_timer_sync(&work->timer);
	if (ret)
		work_clear_pending(&work->work);
	return ret;
}

/*
 * Like above, but uses del_timer() instead of del_timer_sync(). This means,
 * if it returns 0 the timer function may be running and the queueing is in
 * progress.
 */
static inline bool __cancel_delayed_work(struct delayed_work *work)
{
	bool ret;

	ret = del_timer(&work->timer);
	if (ret)
		work_clear_pending(&work->work);
	return ret;
}

/* used to be different but now identical to flush_work(), deprecated */
static inline bool __deprecated flush_work_sync(struct work_struct *work)
{
	return flush_work(work);
}

/* used to be different but now identical to flush_delayed_work(), deprecated */
static inline bool __deprecated flush_delayed_work_sync(struct delayed_work *dwork)
{
	return flush_delayed_work(dwork);
}

#ifndef CONFIG_SMP
static inline long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
{
	return fn(arg);
}
#else
long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg);
#endif /* CONFIG_SMP */

#ifdef CONFIG_FREEZER
extern void freeze_workqueues_begin(void);
extern bool freeze_workqueues_busy(void);
extern void thaw_workqueues(void);
#endif /* CONFIG_FREEZER */

#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* workqueue.h --- work queue handling for Linux.
	3	*/
	4
	5	#ifndef _LINUX_WORKQUEUE_H
	6	#define _LINUX_WORKQUEUE_H
	7
	8	#include <linux/timer.h>
	9	#include <linux/linkage.h>
	10	#include <linux/bitops.h>
4e6045f1	11	#include <linux/lockdep.h>
7a22ad75	12	#include <linux/threads.h>
60063497	13	#include <linux/atomic.h>
1da177e4 LT	14
	15	struct workqueue_struct;
	16
65f27f38 DH	17	struct work_struct;
65f27f38 DH	18	typedef void (work_func_t)(struct work_struct work);
d8e794df	19	void delayed_work_timer_fn(unsigned long __data);
6bb49e59	20
a08727ba LT	21	/*
	22	* The first word is the work queue pointer and the flags rolled into
	23	* one
	24	*/
	25	#define work_data_bits(work) ((unsigned long *)(&(work)->data))
	26
22df02bb TH	27	enum {
22df02bb TH	28	WORK_STRUCT_PENDING_BIT = 0, /* work item is pending execution */
8a2e8e5d TH	29	WORK_STRUCT_DELAYED_BIT = 1, /* work item is delayed */
	30	WORK_STRUCT_CWQ_BIT = 2, /* data points to cwq */
	31	WORK_STRUCT_LINKED_BIT = 3, /* next work is linked to this one */
22df02bb	32	#ifdef CONFIG_DEBUG_OBJECTS_WORK
8a2e8e5d TH	33	WORK_STRUCT_STATIC_BIT = 4, /* static initializer (debugobjects) */
8a2e8e5d TH	34	WORK_STRUCT_COLOR_SHIFT = 5, /* color for workqueue flushing */
0f900049	35	#else
8a2e8e5d	36	WORK_STRUCT_COLOR_SHIFT = 4, /* color for workqueue flushing */
22df02bb TH	37	#endif
22df02bb TH	38
73f53c4a TH	39	WORK_STRUCT_COLOR_BITS = 4,
73f53c4a TH	40
22df02bb	41	WORK_STRUCT_PENDING = 1 << WORK_STRUCT_PENDING_BIT,
8a2e8e5d	42	WORK_STRUCT_DELAYED = 1 << WORK_STRUCT_DELAYED_BIT,
e120153d	43	WORK_STRUCT_CWQ = 1 << WORK_STRUCT_CWQ_BIT,
affee4b2	44	WORK_STRUCT_LINKED = 1 << WORK_STRUCT_LINKED_BIT,
22df02bb TH	45	#ifdef CONFIG_DEBUG_OBJECTS_WORK
	46	WORK_STRUCT_STATIC = 1 << WORK_STRUCT_STATIC_BIT,
	47	#else
	48	WORK_STRUCT_STATIC = 0,
	49	#endif
	50
73f53c4a TH	51	/*
	52	* The last color is no color used for works which don't
	53	* participate in workqueue flushing.
	54	*/
	55	WORK_NR_COLORS = (1 << WORK_STRUCT_COLOR_BITS) - 1,
	56	WORK_NO_COLOR = WORK_NR_COLORS,
	57
bdbc5dd7	58	/* special cpu IDs */
f3421797 TH	59	WORK_CPU_UNBOUND = NR_CPUS,
f3421797 TH	60	WORK_CPU_NONE = NR_CPUS + 1,
bdbc5dd7 TH	61	WORK_CPU_LAST = WORK_CPU_NONE,
bdbc5dd7 TH	62
73f53c4a	63	/*
e120153d	64	* Reserve 7 bits off of cwq pointer w/ debugobjects turned
8a2e8e5d TH	65	* off. This makes cwqs aligned to 256 bytes and allows 15
8a2e8e5d TH	66	* workqueue flush colors.
73f53c4a TH	67	*/
	68	WORK_STRUCT_FLAG_BITS = WORK_STRUCT_COLOR_SHIFT +
	69	WORK_STRUCT_COLOR_BITS,
	70
b5490077 TH	71	/* data contains off-queue information when !WORK_STRUCT_CWQ */
b5490077 TH	72	WORK_OFFQ_FLAG_BASE = WORK_STRUCT_FLAG_BITS,
bbb68dfa TH	73
	74	WORK_OFFQ_CANCELING = (1 << WORK_OFFQ_FLAG_BASE),
	75
	76	WORK_OFFQ_FLAG_BITS = 1,
b5490077 TH	77	WORK_OFFQ_CPU_SHIFT = WORK_OFFQ_FLAG_BASE + WORK_OFFQ_FLAG_BITS,
	78
	79	/* convenience constants */
0f900049	80	WORK_STRUCT_FLAG_MASK = (1UL << WORK_STRUCT_FLAG_BITS) - 1,
22df02bb	81	WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK,
b5490077	82	WORK_STRUCT_NO_CPU = (unsigned long)WORK_CPU_NONE << WORK_OFFQ_CPU_SHIFT,
dcd989cb TH	83
	84	/* bit mask for work_busy() return values */
	85	WORK_BUSY_PENDING = 1 << 0,
	86	WORK_BUSY_RUNNING = 1 << 1,
22df02bb TH	87	};
22df02bb TH	88
1da177e4	89	struct work_struct {
a08727ba	90	atomic_long_t data;
1da177e4	91	struct list_head entry;
6bb49e59	92	work_func_t func;
4e6045f1 JB	93	#ifdef CONFIG_LOCKDEP
	94	struct lockdep_map lockdep_map;
	95	#endif
52bad64d DH	96	};
52bad64d DH	97
7a22ad75 TH	98	#define WORK_DATA_INIT() ATOMIC_LONG_INIT(WORK_STRUCT_NO_CPU)
	99	#define WORK_DATA_STATIC_INIT() \
	100	ATOMIC_LONG_INIT(WORK_STRUCT_NO_CPU \| WORK_STRUCT_STATIC)
a08727ba	101
52bad64d DH	102	struct delayed_work {
52bad64d DH	103	struct work_struct work;
1da177e4	104	struct timer_list timer;
1265057f	105	int cpu;
1da177e4 LT	106	};
1da177e4 LT	107
bf6aede7 JD	108	static inline struct delayed_work to_delayed_work(struct work_struct work)
	109	{
	110	return container_of(work, struct delayed_work, work);
	111	}
	112
1fa44eca JB	113	struct execute_work {
	114	struct work_struct work;
	115	};
	116
4e6045f1 JB	117	#ifdef CONFIG_LOCKDEP
	118	/*
	119	* NB: because we have to copy the lockdep_map, setting _key
	120	* here is required, otherwise it could get initialised to the
	121	* copy of the lockdep_map!
	122	*/
	123	#define __WORK_INIT_LOCKDEP_MAP(n, k) \
	124	.lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k),
	125	#else
	126	#define __WORK_INIT_LOCKDEP_MAP(n, k)
	127	#endif
	128
ee64e7f6 TH	129	#define __WORK_INITIALIZER(n, f) { \
	130	.data = WORK_DATA_STATIC_INIT(), \
	131	.entry = { &(n).entry, &(n).entry }, \
	132	.func = (f), \
	133	__WORK_INIT_LOCKDEP_MAP(#n, &(n)) \
65f27f38 DH	134	}
65f27f38 DH	135
f991b318	136	#define __DELAYED_WORK_INITIALIZER(n, f, tflags) { \
ee64e7f6	137	.work = __WORK_INITIALIZER((n).work, (f)), \
f991b318 TH	138	.timer = __TIMER_INITIALIZER(delayed_work_timer_fn, \
f991b318 TH	139	0, (unsigned long)&(n), (tflags)), \
dd6414b5 PC	140	}
dd6414b5 PC	141
ee64e7f6	142	#define DECLARE_WORK(n, f) \
65f27f38 DH	143	struct work_struct n = __WORK_INITIALIZER(n, f)
65f27f38 DH	144
ee64e7f6	145	#define DECLARE_DELAYED_WORK(n, f) \
f991b318	146	struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, 0)
65f27f38	147
203b42f7	148	#define DECLARE_DEFERRABLE_WORK(n, f) \
f991b318	149	struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, TIMER_DEFERRABLE)
dd6414b5	150
1da177e4	151	/*
65f27f38	152	* initialize a work item's function pointer
1da177e4	153	*/
ee64e7f6 TH	154	#define PREPARE_WORK(_work, _func) \
	155	do { \
	156	(_work)->func = (_func); \
1da177e4 LT	157	} while (0)
1da177e4 LT	158
ee64e7f6	159	#define PREPARE_DELAYED_WORK(_work, _func) \
65f27f38	160	PREPARE_WORK(&(_work)->work, (_func))
52bad64d	161
dc186ad7 TG	162	#ifdef CONFIG_DEBUG_OBJECTS_WORK
	163	extern void __init_work(struct work_struct *work, int onstack);
	164	extern void destroy_work_on_stack(struct work_struct *work);
4690c4ab TH	165	static inline unsigned int work_static(struct work_struct *work)
4690c4ab TH	166	{
22df02bb	167	return *work_data_bits(work) & WORK_STRUCT_STATIC;
4690c4ab	168	}
dc186ad7 TG	169	#else
	170	static inline void __init_work(struct work_struct *work, int onstack) { }
	171	static inline void destroy_work_on_stack(struct work_struct *work) { }
4690c4ab	172	static inline unsigned int work_static(struct work_struct *work) { return 0; }
dc186ad7 TG	173	#endif
dc186ad7 TG	174
1da177e4	175	/*
52bad64d	176	* initialize all of a work item in one go
a08727ba	177	*
b9049df5	178	* NOTE! No point in using "atomic_long_set()": using a direct
a08727ba LT	179	* assignment of the work data initializer allows the compiler
a08727ba LT	180	* to generate better code.
1da177e4	181	*/
4e6045f1	182	#ifdef CONFIG_LOCKDEP
dc186ad7	183	#define __INIT_WORK(_work, _func, _onstack) \
65f27f38	184	do { \
4e6045f1 JB	185	static struct lock_class_key __key; \
4e6045f1 JB	186	\
dc186ad7	187	__init_work((_work), _onstack); \
23b2e599	188	(_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
ee64e7f6	189	lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0); \
65f27f38 DH	190	INIT_LIST_HEAD(&(_work)->entry); \
	191	PREPARE_WORK((_work), (_func)); \
	192	} while (0)
4e6045f1	193	#else
dc186ad7	194	#define __INIT_WORK(_work, _func, _onstack) \
4e6045f1	195	do { \
dc186ad7	196	__init_work((_work), _onstack); \
4e6045f1 JB	197	(_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
	198	INIT_LIST_HEAD(&(_work)->entry); \
	199	PREPARE_WORK((_work), (_func)); \
	200	} while (0)
	201	#endif
65f27f38	202
ee64e7f6 TH	203	#define INIT_WORK(_work, _func) \
	204	do { \
	205	__INIT_WORK((_work), (_func), 0); \
dc186ad7 TG	206	} while (0)
dc186ad7 TG	207
ee64e7f6 TH	208	#define INIT_WORK_ONSTACK(_work, _func) \
	209	do { \
	210	__INIT_WORK((_work), (_func), 1); \
dc186ad7 TG	211	} while (0)
dc186ad7 TG	212
f991b318	213	#define __INIT_DELAYED_WORK(_work, _func, _tflags) \
ee64e7f6 TH	214	do { \
ee64e7f6 TH	215	INIT_WORK(&(_work)->work, (_func)); \
f991b318 TH	216	__setup_timer(&(_work)->timer, delayed_work_timer_fn, \
f991b318 TH	217	(unsigned long)(_work), (_tflags)); \
52bad64d DH	218	} while (0)
52bad64d DH	219
f991b318	220	#define __INIT_DELAYED_WORK_ONSTACK(_work, _func, _tflags) \
ee64e7f6 TH	221	do { \
ee64e7f6 TH	222	INIT_WORK_ONSTACK(&(_work)->work, (_func)); \
f991b318 TH	223	__setup_timer_on_stack(&(_work)->timer, \
	224	delayed_work_timer_fn, \
	225	(unsigned long)(_work), \
	226	(_tflags)); \
6d612b0f PZ	227	} while (0)
6d612b0f PZ	228
f991b318 TH	229	#define INIT_DELAYED_WORK(_work, _func) \
	230	__INIT_DELAYED_WORK(_work, _func, 0)
	231
	232	#define INIT_DELAYED_WORK_ONSTACK(_work, _func) \
	233	__INIT_DELAYED_WORK_ONSTACK(_work, _func, 0)
	234
203b42f7	235	#define INIT_DEFERRABLE_WORK(_work, _func) \
f991b318 TH	236	__INIT_DELAYED_WORK(_work, _func, TIMER_DEFERRABLE)
	237
	238	#define INIT_DEFERRABLE_WORK_ONSTACK(_work, _func) \
	239	__INIT_DELAYED_WORK_ONSTACK(_work, _func, TIMER_DEFERRABLE)
28287033	240
365970a1 DH	241	/**
	242	* work_pending - Find out whether a work item is currently pending
	243	* @work: The work item in question
	244	*/
	245	#define work_pending(work) \
22df02bb	246	test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
365970a1 DH	247
	248	/**
	249	* delayed_work_pending - Find out whether a delayable work item is currently
	250	* pending
	251	* @work: The work item in question
	252	*/
0221872a LT	253	#define delayed_work_pending(w) \
0221872a LT	254	work_pending(&(w)->work)
365970a1	255
65f27f38	256	/**
23b2e599 ON	257	* work_clear_pending - for internal use only, mark a work item as not pending
23b2e599 ON	258	* @work: The work item in question
65f27f38	259	*/
23b2e599	260	#define work_clear_pending(work) \
22df02bb	261	clear_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
65f27f38	262
c54fce6e TH	263	/*
	264	* Workqueue flags and constants. For details, please refer to
	265	* Documentation/workqueue.txt.
	266	*/
97e37d7b	267	enum {
bdbc5dd7	268	WQ_NON_REENTRANT = 1 << 0, /* guarantee non-reentrance */
c7fc77f7	269	WQ_UNBOUND = 1 << 1, /* not bound to any cpu */
58a69cb4	270	WQ_FREEZABLE = 1 << 2, /* freeze during suspend */
6370a6ad	271	WQ_MEM_RECLAIM = 1 << 3, /* may be used for memory reclaim */
649027d7	272	WQ_HIGHPRI = 1 << 4, /* high priority */
fb0e7beb	273	WQ_CPU_INTENSIVE = 1 << 5, /* cpu instensive workqueue */
b71ab8c2	274
9c5a2ba7	275	WQ_DRAINING = 1 << 6, /* internal: workqueue is draining */
6370a6ad	276	WQ_RESCUER = 1 << 7, /* internal: workqueue has rescuer */
e41e704b	277
b71ab8c2	278	WQ_MAX_ACTIVE = 512, /* I like 512, better ideas? */
f3421797	279	WQ_MAX_UNBOUND_PER_CPU = 4, /* 4 * #cpus for unbound wq */
b71ab8c2	280	WQ_DFL_ACTIVE = WQ_MAX_ACTIVE / 2,
97e37d7b	281	};
52bad64d	282
f3421797 TH	283	/* unbound wq's aren't per-cpu, scale max_active according to #cpus */
	284	#define WQ_UNBOUND_MAX_ACTIVE \
	285	max_t(int, WQ_MAX_ACTIVE, num_possible_cpus() * WQ_MAX_UNBOUND_PER_CPU)
65f27f38	286
d320c038 TH	287	/*
	288	* System-wide workqueues which are always present.
	289	*
	290	* system_wq is the one used by schedule[_delayed]_work[_on]().
	291	* Multi-CPU multi-threaded. There are users which expect relatively
	292	* short queue flush time. Don't queue works which can run for too
	293	* long.
	294	*
	295	* system_long_wq is similar to system_wq but may host long running
	296	* works. Queue flushing might take relatively long.
	297	*
f3421797 TH	298	* system_unbound_wq is unbound workqueue. Workers are not bound to
	299	* any specific CPU, not concurrency managed, and all queued works are
	300	* executed immediately as long as max_active limit is not reached and
	301	* resources are available.
4149efb2	302	*
24d51add TH	303	* system_freezable_wq is equivalent to system_wq except that it's
24d51add TH	304	* freezable.
d320c038 TH	305	*/
	306	extern struct workqueue_struct *system_wq;
	307	extern struct workqueue_struct *system_long_wq;
f3421797	308	extern struct workqueue_struct *system_unbound_wq;
24d51add	309	extern struct workqueue_struct *system_freezable_wq;
ae930e0f	310
3b07e9ca	311	static inline struct workqueue_struct * __deprecated __system_nrt_wq(void)
ae930e0f TH	312	{
	313	return system_wq;
	314	}
	315
3b07e9ca	316	static inline struct workqueue_struct * __deprecated __system_nrt_freezable_wq(void)
ae930e0f TH	317	{
	318	return system_freezable_wq;
	319	}
	320
	321	/* equivlalent to system_wq and system_freezable_wq, deprecated */
	322	#define system_nrt_wq __system_nrt_wq()
	323	#define system_nrt_freezable_wq __system_nrt_freezable_wq()
52bad64d	324
4e6045f1	325	extern struct workqueue_struct *
b196be89 TH	326	__alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active,
b196be89 TH	327	struct lock_class_key key, const char lock_name, ...) __printf(1, 6);
4e6045f1	328
b196be89 TH	329	/**
	330	* alloc_workqueue - allocate a workqueue
	331	* @fmt: printf format for the name of the workqueue
	332	* @flags: WQ_* flags
	333	* @max_active: max in-flight work items, 0 for default
	334	* @args: args for @fmt
	335	*
	336	* Allocate a workqueue with the specified parameters. For detailed
	337	* information on WQ_* flags, please refer to Documentation/workqueue.txt.
	338	*
	339	* The __lock_name macro dance is to guarantee that single lock_class_key
	340	* doesn't end up with different namesm, which isn't allowed by lockdep.
	341	*
	342	* RETURNS:
	343	* Pointer to the allocated workqueue on success, %NULL on failure.
	344	*/
4e6045f1	345	#ifdef CONFIG_LOCKDEP
ee64e7f6 TH	346	#define alloc_workqueue(fmt, flags, max_active, args...) \
	347	({ \
	348	static struct lock_class_key __key; \
	349	const char *__lock_name; \
	350	\
	351	if (__builtin_constant_p(fmt)) \
	352	__lock_name = (fmt); \
	353	else \
	354	__lock_name = #fmt; \
	355	\
	356	__alloc_workqueue_key((fmt), (flags), (max_active), \
	357	&__key, __lock_name, ##args); \
4e6045f1 JB	358	})
4e6045f1 JB	359	#else
ee64e7f6 TH	360	#define alloc_workqueue(fmt, flags, max_active, args...) \
ee64e7f6 TH	361	__alloc_workqueue_key((fmt), (flags), (max_active), \
b196be89	362	NULL, NULL, ##args)
4e6045f1 JB	363	#endif
4e6045f1 JB	364
81dcaf65 TH	365	/**
81dcaf65 TH	366	* alloc_ordered_workqueue - allocate an ordered workqueue
b196be89	367	* @fmt: printf format for the name of the workqueue
58a69cb4	368	* @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful)
b196be89	369	* @args: args for @fmt
81dcaf65 TH	370	*
	371	* Allocate an ordered workqueue. An ordered workqueue executes at
	372	* most one work item at any given time in the queued order. They are
	373	* implemented as unbound workqueues with @max_active of one.
	374	*
	375	* RETURNS:
	376	* Pointer to the allocated workqueue on success, %NULL on failure.
	377	*/
ee64e7f6	378	#define alloc_ordered_workqueue(fmt, flags, args...) \
b196be89	379	alloc_workqueue(fmt, WQ_UNBOUND \| (flags), 1, ##args)
81dcaf65	380
ee64e7f6	381	#define create_workqueue(name) \
6370a6ad	382	alloc_workqueue((name), WQ_MEM_RECLAIM, 1)
ee64e7f6	383	#define create_freezable_workqueue(name) \
58a69cb4	384	alloc_workqueue((name), WQ_FREEZABLE \| WQ_UNBOUND \| WQ_MEM_RECLAIM, 1)
ee64e7f6	385	#define create_singlethread_workqueue(name) \
6370a6ad	386	alloc_workqueue((name), WQ_UNBOUND \| WQ_MEM_RECLAIM, 1)
1da177e4 LT	387
	388	extern void destroy_workqueue(struct workqueue_struct *wq);
	389
d4283e93	390	extern bool queue_work_on(int cpu, struct workqueue_struct *wq,
c1a220e7	391	struct work_struct *work);
d4283e93 TH	392	extern bool queue_work(struct workqueue_struct wq, struct work_struct work);
d4283e93 TH	393	extern bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
28e53bdd	394	struct delayed_work *work, unsigned long delay);
d4283e93	395	extern bool queue_delayed_work(struct workqueue_struct *wq,
0a13c00e	396	struct delayed_work *work, unsigned long delay);
8376fe22 TH	397	extern bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
	398	struct delayed_work *dwork, unsigned long delay);
	399	extern bool mod_delayed_work(struct workqueue_struct *wq,
	400	struct delayed_work *dwork, unsigned long delay);
28e53bdd	401
b3c97528	402	extern void flush_workqueue(struct workqueue_struct *wq);
9c5a2ba7	403	extern void drain_workqueue(struct workqueue_struct *wq);
28e53bdd	404	extern void flush_scheduled_work(void);
1da177e4	405
d4283e93 TH	406	extern bool schedule_work_on(int cpu, struct work_struct *work);
	407	extern bool schedule_work(struct work_struct *work);
	408	extern bool schedule_delayed_work_on(int cpu, struct delayed_work *work,
	409	unsigned long delay);
	410	extern bool schedule_delayed_work(struct delayed_work *work,
	411	unsigned long delay);
65f27f38	412	extern int schedule_on_each_cpu(work_func_t func);
1da177e4 LT	413	extern int keventd_up(void);
1da177e4 LT	414
65f27f38	415	int execute_in_process_context(work_func_t fn, struct execute_work *);
1da177e4	416
401a8d04 TH	417	extern bool flush_work(struct work_struct *work);
	418	extern bool cancel_work_sync(struct work_struct *work);
	419
	420	extern bool flush_delayed_work(struct delayed_work *dwork);
	421	extern bool cancel_delayed_work_sync(struct delayed_work *dwork);
28e53bdd	422
dcd989cb TH	423	extern void workqueue_set_max_active(struct workqueue_struct *wq,
	424	int max_active);
	425	extern bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq);
	426	extern unsigned int work_cpu(struct work_struct *work);
	427	extern unsigned int work_busy(struct work_struct *work);
	428
1da177e4 LT	429	/*
1da177e4 LT	430	* Kill off a pending schedule_delayed_work(). Note that the work callback
071b6386 ON	431	* function may still be running on return from cancel_delayed_work(), unless
071b6386 ON	432	* it returns 1 and the work doesn't re-arm itself. Run flush_workqueue() or
28e53bdd	433	* cancel_work_sync() to wait on it.
1da177e4	434	*/
401a8d04	435	static inline bool cancel_delayed_work(struct delayed_work *work)
1da177e4	436	{
401a8d04	437	bool ret;
1da177e4	438
223a10a9	439	ret = del_timer_sync(&work->timer);
1da177e4	440	if (ret)
23b2e599	441	work_clear_pending(&work->work);
1da177e4 LT	442	return ret;
	443	}
	444
4e49627b ON	445	/*
	446	* Like above, but uses del_timer() instead of del_timer_sync(). This means,
	447	* if it returns 0 the timer function may be running and the queueing is in
	448	* progress.
	449	*/
401a8d04	450	static inline bool __cancel_delayed_work(struct delayed_work *work)
4e49627b	451	{
401a8d04	452	bool ret;
4e49627b ON	453
	454	ret = del_timer(&work->timer);
	455	if (ret)
	456	work_clear_pending(&work->work);
	457	return ret;
	458	}
	459
606a5020	460	/* used to be different but now identical to flush_work(), deprecated */
43829731	461	static inline bool __deprecated flush_work_sync(struct work_struct *work)
606a5020 TH	462	{
	463	return flush_work(work);
	464	}
	465
	466	/* used to be different but now identical to flush_delayed_work(), deprecated */
43829731	467	static inline bool __deprecated flush_delayed_work_sync(struct delayed_work *dwork)
606a5020 TH	468	{
	469	return flush_delayed_work(dwork);
	470	}
	471
2d3854a3 RR	472	#ifndef CONFIG_SMP
	473	static inline long work_on_cpu(unsigned int cpu, long (fn)(void ), void *arg)
	474	{
	475	return fn(arg);
	476	}
	477	#else
	478	long work_on_cpu(unsigned int cpu, long (fn)(void ), void *arg);
	479	#endif /* CONFIG_SMP */
a25909a4	480
a0a1a5fd TH	481	#ifdef CONFIG_FREEZER
	482	extern void freeze_workqueues_begin(void);
	483	extern bool freeze_workqueues_busy(void);
	484	extern void thaw_workqueues(void);
	485	#endif /* CONFIG_FREEZER */
	486
1da177e4	487	#endif