[GitHub/mt8127/android_kernel_alcatel_ttab.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 <asm/atomic.h>

struct workqueue_struct;

struct work_struct;
typedef void (*work_func_t)(struct work_struct *work);

/*
 * 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_LINKED_BIT	= 1,	/* next work is linked to this one */
#ifdef CONFIG_DEBUG_OBJECTS_WORK
	WORK_STRUCT_STATIC_BIT	= 2,	/* static initializer (debugobjects) */
	WORK_STRUCT_COLOR_SHIFT	= 3,	/* color for workqueue flushing */
#else
	WORK_STRUCT_COLOR_SHIFT	= 2,	/* color for workqueue flushing */
#endif

	WORK_STRUCT_COLOR_BITS	= 4,

	WORK_STRUCT_PENDING	= 1 << WORK_STRUCT_PENDING_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,

	/*
	 * Reserve 6 bits off of cwq pointer w/ debugobjects turned
	 * off.  This makes cwqs aligned to 64 bytes which isn't too
	 * excessive while allowing 15 workqueue flush colors.
	 */
	WORK_STRUCT_FLAG_BITS	= WORK_STRUCT_COLOR_SHIFT +
				  WORK_STRUCT_COLOR_BITS,

	WORK_STRUCT_FLAG_MASK	= (1UL << WORK_STRUCT_FLAG_BITS) - 1,
	WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK,
	WORK_STRUCT_NO_CPU	= NR_CPUS << WORK_STRUCT_FLAG_BITS,

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

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) {			\
	.work = __WORK_INITIALIZER((n).work, (f)),		\
	.timer = TIMER_INITIALIZER(NULL, 0, 0),			\
	}

#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)

/*
 * 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_ON_STACK(_work, _func)			\
	do {							\
		__INIT_WORK((_work), (_func), 1);		\
	} while (0)

#define INIT_DELAYED_WORK(_work, _func)				\
	do {							\
		INIT_WORK(&(_work)->work, (_func));		\
		init_timer(&(_work)->timer);			\
	} while (0)

#define INIT_DELAYED_WORK_ON_STACK(_work, _func)		\
	do {							\
		INIT_WORK_ON_STACK(&(_work)->work, (_func));	\
		init_timer_on_stack(&(_work)->timer);		\
	} while (0)

#define INIT_DELAYED_WORK_DEFERRABLE(_work, _func)		\
	do {							\
		INIT_WORK(&(_work)->work, (_func));		\
		init_timer_deferrable(&(_work)->timer);		\
	} while (0)

/**
 * 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))

enum {
	WQ_FREEZEABLE		= 1 << 0, /* freeze during suspend */
	WQ_SINGLE_CPU		= 1 << 1, /* only single cpu at a time */
	WQ_NON_REENTRANT	= 1 << 2, /* guarantee non-reentrance */
	WQ_RESCUER		= 1 << 3, /* has an rescue worker */
	WQ_HIGHPRI		= 1 << 4, /* high priority */
	WQ_CPU_INTENSIVE	= 1 << 5, /* cpu instensive workqueue */

	WQ_MAX_ACTIVE		= 512,	  /* I like 512, better ideas? */
	WQ_DFL_ACTIVE		= WQ_MAX_ACTIVE / 2,
};

/*
 * 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_nrt_wq is non-reentrant and guarantees that any given work
 * item is never executed in parallel by multiple CPUs.  Queue
 * flushing might take relatively long.
 */
extern struct workqueue_struct *system_wq;
extern struct workqueue_struct *system_long_wq;
extern struct workqueue_struct *system_nrt_wq;

extern struct workqueue_struct *
__alloc_workqueue_key(const char *name, unsigned int flags, int max_active,
		      struct lock_class_key *key, const char *lock_name);

#ifdef CONFIG_LOCKDEP
#define alloc_workqueue(name, flags, max_active)		\
({								\
	static struct lock_class_key __key;			\
	const char *__lock_name;				\
								\
	if (__builtin_constant_p(name))				\
		__lock_name = (name);				\
	else							\
		__lock_name = #name;				\
								\
	__alloc_workqueue_key((name), (flags), (max_active),	\
			      &__key, __lock_name);		\
})
#else
#define alloc_workqueue(name, flags, max_active)		\
	__alloc_workqueue_key((name), (flags), (max_active), NULL, NULL)
#endif

#define create_workqueue(name)					\
	alloc_workqueue((name), WQ_RESCUER, 1)
#define create_freezeable_workqueue(name)			\
	alloc_workqueue((name), WQ_FREEZEABLE | WQ_SINGLE_CPU | WQ_RESCUER, 1)
#define create_singlethread_workqueue(name)			\
	alloc_workqueue((name), WQ_SINGLE_CPU | WQ_RESCUER, 1)

extern void destroy_workqueue(struct workqueue_struct *wq);

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

extern void flush_workqueue(struct workqueue_struct *wq);
extern void flush_scheduled_work(void);
extern void flush_delayed_work(struct delayed_work *work);

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

extern void init_workqueues(void);
int execute_in_process_context(work_func_t fn, struct execute_work *);

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

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 int cancel_delayed_work(struct delayed_work *work)
{
	int 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 int __cancel_delayed_work(struct delayed_work *work)
{
	int ret;

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

extern int cancel_delayed_work_sync(struct delayed_work *work);

/* Obsolete. use cancel_delayed_work_sync() */
static inline
void cancel_rearming_delayed_workqueue(struct workqueue_struct *wq,
					struct delayed_work *work)
{
	cancel_delayed_work_sync(work);
}

/* Obsolete. use cancel_delayed_work_sync() */
static inline
void cancel_rearming_delayed_work(struct delayed_work *work)
{
	cancel_delayed_work_sync(work);
}

#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>
a08727ba	13	#include <asm/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);
6bb49e59	19
a08727ba LT	20	/*
	21	* The first word is the work queue pointer and the flags rolled into
	22	* one
	23	*/
	24	#define work_data_bits(work) ((unsigned long *)(&(work)->data))
	25
22df02bb TH	26	enum {
22df02bb TH	27	WORK_STRUCT_PENDING_BIT = 0, /* work item is pending execution */
affee4b2	28	WORK_STRUCT_LINKED_BIT = 1, /* next work is linked to this one */
22df02bb	29	#ifdef CONFIG_DEBUG_OBJECTS_WORK
affee4b2	30	WORK_STRUCT_STATIC_BIT = 2, /* static initializer (debugobjects) */
73f53c4a	31	WORK_STRUCT_COLOR_SHIFT = 3, /* color for workqueue flushing */
0f900049	32	#else
73f53c4a	33	WORK_STRUCT_COLOR_SHIFT = 2, /* color for workqueue flushing */
22df02bb TH	34	#endif
22df02bb TH	35
73f53c4a TH	36	WORK_STRUCT_COLOR_BITS = 4,
73f53c4a TH	37
22df02bb	38	WORK_STRUCT_PENDING = 1 << WORK_STRUCT_PENDING_BIT,
affee4b2	39	WORK_STRUCT_LINKED = 1 << WORK_STRUCT_LINKED_BIT,
22df02bb TH	40	#ifdef CONFIG_DEBUG_OBJECTS_WORK
	41	WORK_STRUCT_STATIC = 1 << WORK_STRUCT_STATIC_BIT,
	42	#else
	43	WORK_STRUCT_STATIC = 0,
	44	#endif
	45
73f53c4a TH	46	/*
	47	* The last color is no color used for works which don't
	48	* participate in workqueue flushing.
	49	*/
	50	WORK_NR_COLORS = (1 << WORK_STRUCT_COLOR_BITS) - 1,
	51	WORK_NO_COLOR = WORK_NR_COLORS,
	52
	53	/*
	54	* Reserve 6 bits off of cwq pointer w/ debugobjects turned
	55	* off. This makes cwqs aligned to 64 bytes which isn't too
	56	* excessive while allowing 15 workqueue flush colors.
	57	*/
	58	WORK_STRUCT_FLAG_BITS = WORK_STRUCT_COLOR_SHIFT +
	59	WORK_STRUCT_COLOR_BITS,
	60
0f900049	61	WORK_STRUCT_FLAG_MASK = (1UL << WORK_STRUCT_FLAG_BITS) - 1,
22df02bb	62	WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK,
7a22ad75	63	WORK_STRUCT_NO_CPU = NR_CPUS << WORK_STRUCT_FLAG_BITS,
dcd989cb TH	64
	65	/* bit mask for work_busy() return values */
	66	WORK_BUSY_PENDING = 1 << 0,
	67	WORK_BUSY_RUNNING = 1 << 1,
22df02bb TH	68	};
22df02bb TH	69
1da177e4	70	struct work_struct {
a08727ba	71	atomic_long_t data;
1da177e4	72	struct list_head entry;
6bb49e59	73	work_func_t func;
4e6045f1 JB	74	#ifdef CONFIG_LOCKDEP
	75	struct lockdep_map lockdep_map;
	76	#endif
52bad64d DH	77	};
52bad64d DH	78
7a22ad75 TH	79	#define WORK_DATA_INIT() ATOMIC_LONG_INIT(WORK_STRUCT_NO_CPU)
	80	#define WORK_DATA_STATIC_INIT() \
	81	ATOMIC_LONG_INIT(WORK_STRUCT_NO_CPU \| WORK_STRUCT_STATIC)
a08727ba	82
52bad64d DH	83	struct delayed_work {
52bad64d DH	84	struct work_struct work;
1da177e4 LT	85	struct timer_list timer;
	86	};
	87
bf6aede7 JD	88	static inline struct delayed_work to_delayed_work(struct work_struct work)
	89	{
	90	return container_of(work, struct delayed_work, work);
	91	}
	92
1fa44eca JB	93	struct execute_work {
	94	struct work_struct work;
	95	};
	96
4e6045f1 JB	97	#ifdef CONFIG_LOCKDEP
	98	/*
	99	* NB: because we have to copy the lockdep_map, setting _key
	100	* here is required, otherwise it could get initialised to the
	101	* copy of the lockdep_map!
	102	*/
	103	#define __WORK_INIT_LOCKDEP_MAP(n, k) \
	104	.lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k),
	105	#else
	106	#define __WORK_INIT_LOCKDEP_MAP(n, k)
	107	#endif
	108
65f27f38	109	#define __WORK_INITIALIZER(n, f) { \
dc186ad7	110	.data = WORK_DATA_STATIC_INIT(), \
23b2e599	111	.entry = { &(n).entry, &(n).entry }, \
65f27f38	112	.func = (f), \
4e6045f1	113	__WORK_INIT_LOCKDEP_MAP(#n, &(n)) \
65f27f38 DH	114	}
	115
	116	#define __DELAYED_WORK_INITIALIZER(n, f) { \
	117	.work = __WORK_INITIALIZER((n).work, (f)), \
	118	.timer = TIMER_INITIALIZER(NULL, 0, 0), \
	119	}
	120
65f27f38 DH	121	#define DECLARE_WORK(n, f) \
	122	struct work_struct n = __WORK_INITIALIZER(n, f)
	123
65f27f38 DH	124	#define DECLARE_DELAYED_WORK(n, f) \
	125	struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f)
	126
1da177e4	127	/*
65f27f38	128	* initialize a work item's function pointer
1da177e4	129	*/
65f27f38	130	#define PREPARE_WORK(_work, _func) \
1da177e4	131	do { \
52bad64d	132	(_work)->func = (_func); \
1da177e4 LT	133	} while (0)
1da177e4 LT	134
65f27f38 DH	135	#define PREPARE_DELAYED_WORK(_work, _func) \
65f27f38 DH	136	PREPARE_WORK(&(_work)->work, (_func))
52bad64d	137
dc186ad7 TG	138	#ifdef CONFIG_DEBUG_OBJECTS_WORK
	139	extern void __init_work(struct work_struct *work, int onstack);
	140	extern void destroy_work_on_stack(struct work_struct *work);
4690c4ab TH	141	static inline unsigned int work_static(struct work_struct *work)
4690c4ab TH	142	{
22df02bb	143	return *work_data_bits(work) & WORK_STRUCT_STATIC;
4690c4ab	144	}
dc186ad7 TG	145	#else
	146	static inline void __init_work(struct work_struct *work, int onstack) { }
	147	static inline void destroy_work_on_stack(struct work_struct *work) { }
4690c4ab	148	static inline unsigned int work_static(struct work_struct *work) { return 0; }
dc186ad7 TG	149	#endif
dc186ad7 TG	150
1da177e4	151	/*
52bad64d	152	* initialize all of a work item in one go
a08727ba	153	*
b9049df5	154	* NOTE! No point in using "atomic_long_set()": using a direct
a08727ba LT	155	* assignment of the work data initializer allows the compiler
a08727ba LT	156	* to generate better code.
1da177e4	157	*/
4e6045f1	158	#ifdef CONFIG_LOCKDEP
dc186ad7	159	#define __INIT_WORK(_work, _func, _onstack) \
65f27f38	160	do { \
4e6045f1 JB	161	static struct lock_class_key __key; \
4e6045f1 JB	162	\
dc186ad7	163	__init_work((_work), _onstack); \
23b2e599	164	(_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
4e6045f1	165	lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0);\
65f27f38 DH	166	INIT_LIST_HEAD(&(_work)->entry); \
	167	PREPARE_WORK((_work), (_func)); \
	168	} while (0)
4e6045f1	169	#else
dc186ad7	170	#define __INIT_WORK(_work, _func, _onstack) \
4e6045f1	171	do { \
dc186ad7	172	__init_work((_work), _onstack); \
4e6045f1 JB	173	(_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
	174	INIT_LIST_HEAD(&(_work)->entry); \
	175	PREPARE_WORK((_work), (_func)); \
	176	} while (0)
	177	#endif
65f27f38	178
dc186ad7 TG	179	#define INIT_WORK(_work, _func) \
	180	do { \
	181	__INIT_WORK((_work), (_func), 0); \
	182	} while (0)
	183
	184	#define INIT_WORK_ON_STACK(_work, _func) \
	185	do { \
	186	__INIT_WORK((_work), (_func), 1); \
	187	} while (0)
	188
65f27f38 DH	189	#define INIT_DELAYED_WORK(_work, _func) \
	190	do { \
	191	INIT_WORK(&(_work)->work, (_func)); \
	192	init_timer(&(_work)->timer); \
52bad64d DH	193	} while (0)
52bad64d DH	194
6d612b0f PZ	195	#define INIT_DELAYED_WORK_ON_STACK(_work, _func) \
6d612b0f PZ	196	do { \
dc186ad7	197	INIT_WORK_ON_STACK(&(_work)->work, (_func)); \
6d612b0f PZ	198	init_timer_on_stack(&(_work)->timer); \
	199	} while (0)
	200
dc186ad7	201	#define INIT_DELAYED_WORK_DEFERRABLE(_work, _func) \
28287033 VP	202	do { \
	203	INIT_WORK(&(_work)->work, (_func)); \
	204	init_timer_deferrable(&(_work)->timer); \
	205	} while (0)
	206
365970a1 DH	207	/**
	208	* work_pending - Find out whether a work item is currently pending
	209	* @work: The work item in question
	210	*/
	211	#define work_pending(work) \
22df02bb	212	test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
365970a1 DH	213
	214	/**
	215	* delayed_work_pending - Find out whether a delayable work item is currently
	216	* pending
	217	* @work: The work item in question
	218	*/
0221872a LT	219	#define delayed_work_pending(w) \
0221872a LT	220	work_pending(&(w)->work)
365970a1	221
65f27f38	222	/**
23b2e599 ON	223	* work_clear_pending - for internal use only, mark a work item as not pending
23b2e599 ON	224	* @work: The work item in question
65f27f38	225	*/
23b2e599	226	#define work_clear_pending(work) \
22df02bb	227	clear_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
65f27f38	228
97e37d7b TH	229	enum {
97e37d7b TH	230	WQ_FREEZEABLE = 1 << 0, /* freeze during suspend */
502ca9d8	231	WQ_SINGLE_CPU = 1 << 1, /* only single cpu at a time */
18aa9eff	232	WQ_NON_REENTRANT = 1 << 2, /* guarantee non-reentrance */
e22bee78	233	WQ_RESCUER = 1 << 3, /* has an rescue worker */
649027d7	234	WQ_HIGHPRI = 1 << 4, /* high priority */
fb0e7beb	235	WQ_CPU_INTENSIVE = 1 << 5, /* cpu instensive workqueue */
b71ab8c2 TH	236
	237	WQ_MAX_ACTIVE = 512, /* I like 512, better ideas? */
	238	WQ_DFL_ACTIVE = WQ_MAX_ACTIVE / 2,
97e37d7b	239	};
52bad64d	240
d320c038 TH	241	/*
	242	* System-wide workqueues which are always present.
	243	*
	244	* system_wq is the one used by schedule[_delayed]_work[_on]().
	245	* Multi-CPU multi-threaded. There are users which expect relatively
	246	* short queue flush time. Don't queue works which can run for too
	247	* long.
	248	*
	249	* system_long_wq is similar to system_wq but may host long running
	250	* works. Queue flushing might take relatively long.
	251	*
	252	* system_nrt_wq is non-reentrant and guarantees that any given work
	253	* item is never executed in parallel by multiple CPUs. Queue
	254	* flushing might take relatively long.
	255	*/
	256	extern struct workqueue_struct *system_wq;
	257	extern struct workqueue_struct *system_long_wq;
	258	extern struct workqueue_struct *system_nrt_wq;
	259
4e6045f1	260	extern struct workqueue_struct *
d320c038 TH	261	__alloc_workqueue_key(const char *name, unsigned int flags, int max_active,
d320c038 TH	262	struct lock_class_key key, const char lock_name);
4e6045f1 JB	263
4e6045f1 JB	264	#ifdef CONFIG_LOCKDEP
d320c038	265	#define alloc_workqueue(name, flags, max_active) \
4e6045f1 JB	266	({ \
4e6045f1 JB	267	static struct lock_class_key __key; \
eb13ba87 JB	268	const char *__lock_name; \
	269	\
	270	if (__builtin_constant_p(name)) \
	271	__lock_name = (name); \
	272	else \
	273	__lock_name = #name; \
4e6045f1	274	\
d320c038 TH	275	__alloc_workqueue_key((name), (flags), (max_active), \
d320c038 TH	276	&__key, __lock_name); \
4e6045f1 JB	277	})
4e6045f1 JB	278	#else
d320c038 TH	279	#define alloc_workqueue(name, flags, max_active) \
d320c038 TH	280	__alloc_workqueue_key((name), (flags), (max_active), NULL, NULL)
4e6045f1 JB	281	#endif
4e6045f1 JB	282
97e37d7b	283	#define create_workqueue(name) \
d320c038	284	alloc_workqueue((name), WQ_RESCUER, 1)
97e37d7b	285	#define create_freezeable_workqueue(name) \
d320c038	286	alloc_workqueue((name), WQ_FREEZEABLE \| WQ_SINGLE_CPU \| WQ_RESCUER, 1)
97e37d7b	287	#define create_singlethread_workqueue(name) \
d320c038	288	alloc_workqueue((name), WQ_SINGLE_CPU \| WQ_RESCUER, 1)
1da177e4 LT	289
	290	extern void destroy_workqueue(struct workqueue_struct *wq);
	291
b3c97528	292	extern int queue_work(struct workqueue_struct wq, struct work_struct work);
c1a220e7 ZR	293	extern int queue_work_on(int cpu, struct workqueue_struct *wq,
c1a220e7 ZR	294	struct work_struct *work);
b3c97528 HH	295	extern int queue_delayed_work(struct workqueue_struct *wq,
b3c97528 HH	296	struct delayed_work *work, unsigned long delay);
7a6bc1cd	297	extern int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
28e53bdd ON	298	struct delayed_work *work, unsigned long delay);
28e53bdd ON	299
b3c97528	300	extern void flush_workqueue(struct workqueue_struct *wq);
28e53bdd	301	extern void flush_scheduled_work(void);
43046b60	302	extern void flush_delayed_work(struct delayed_work *work);
1da177e4	303
b3c97528	304	extern int schedule_work(struct work_struct *work);
c1a220e7	305	extern int schedule_work_on(int cpu, struct work_struct *work);
b3c97528	306	extern int schedule_delayed_work(struct delayed_work *work, unsigned long delay);
28e53bdd ON	307	extern int schedule_delayed_work_on(int cpu, struct delayed_work *work,
28e53bdd ON	308	unsigned long delay);
65f27f38	309	extern int schedule_on_each_cpu(work_func_t func);
1da177e4 LT	310	extern int keventd_up(void);
	311
	312	extern void init_workqueues(void);
65f27f38	313	int execute_in_process_context(work_func_t fn, struct execute_work *);
1da177e4	314
db700897	315	extern int flush_work(struct work_struct *work);
1f1f642e	316	extern int cancel_work_sync(struct work_struct *work);
28e53bdd	317
dcd989cb TH	318	extern void workqueue_set_max_active(struct workqueue_struct *wq,
	319	int max_active);
	320	extern bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq);
	321	extern unsigned int work_cpu(struct work_struct *work);
	322	extern unsigned int work_busy(struct work_struct *work);
	323
1da177e4 LT	324	/*
1da177e4 LT	325	* Kill off a pending schedule_delayed_work(). Note that the work callback
071b6386 ON	326	* function may still be running on return from cancel_delayed_work(), unless
071b6386 ON	327	* it returns 1 and the work doesn't re-arm itself. Run flush_workqueue() or
28e53bdd	328	* cancel_work_sync() to wait on it.
1da177e4	329	*/
52bad64d	330	static inline int cancel_delayed_work(struct delayed_work *work)
1da177e4 LT	331	{
	332	int ret;
	333
223a10a9	334	ret = del_timer_sync(&work->timer);
1da177e4	335	if (ret)
23b2e599	336	work_clear_pending(&work->work);
1da177e4 LT	337	return ret;
	338	}
	339
4e49627b ON	340	/*
	341	* Like above, but uses del_timer() instead of del_timer_sync(). This means,
	342	* if it returns 0 the timer function may be running and the queueing is in
	343	* progress.
	344	*/
	345	static inline int __cancel_delayed_work(struct delayed_work *work)
	346	{
	347	int ret;
	348
	349	ret = del_timer(&work->timer);
	350	if (ret)
	351	work_clear_pending(&work->work);
	352	return ret;
	353	}
	354
1f1f642e	355	extern int cancel_delayed_work_sync(struct delayed_work *work);
1634c48f	356
f5a421a4	357	/* Obsolete. use cancel_delayed_work_sync() */
1634c48f ON	358	static inline
	359	void cancel_rearming_delayed_workqueue(struct workqueue_struct *wq,
	360	struct delayed_work *work)
	361	{
f5a421a4 ON	362	cancel_delayed_work_sync(work);
	363	}
	364
	365	/* Obsolete. use cancel_delayed_work_sync() */
	366	static inline
	367	void cancel_rearming_delayed_work(struct delayed_work *work)
	368	{
	369	cancel_delayed_work_sync(work);
1634c48f ON	370	}
1634c48f ON	371
2d3854a3 RR	372	#ifndef CONFIG_SMP
	373	static inline long work_on_cpu(unsigned int cpu, long (fn)(void ), void *arg)
	374	{
	375	return fn(arg);
	376	}
	377	#else
	378	long work_on_cpu(unsigned int cpu, long (fn)(void ), void *arg);
	379	#endif /* CONFIG_SMP */
a0a1a5fd TH	380
	381	#ifdef CONFIG_FREEZER
	382	extern void freeze_workqueues_begin(void);
	383	extern bool freeze_workqueues_busy(void);
	384	extern void thaw_workqueues(void);
	385	#endif /* CONFIG_FREEZER */
	386
1da177e4	387	#endif