workqueue: implement worker_{set|clr}_flags()
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / workqueue.h
CommitLineData
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
15struct workqueue_struct;
16
65f27f38
DH
17struct work_struct;
18typedef 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
26enum {
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
35
73f53c4a
TH
36 WORK_STRUCT_COLOR_BITS = 4,
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,
22df02bb
TH
64};
65
1da177e4 66struct work_struct {
a08727ba 67 atomic_long_t data;
1da177e4 68 struct list_head entry;
6bb49e59 69 work_func_t func;
4e6045f1
JB
70#ifdef CONFIG_LOCKDEP
71 struct lockdep_map lockdep_map;
72#endif
52bad64d
DH
73};
74
7a22ad75
TH
75#define WORK_DATA_INIT() ATOMIC_LONG_INIT(WORK_STRUCT_NO_CPU)
76#define WORK_DATA_STATIC_INIT() \
77 ATOMIC_LONG_INIT(WORK_STRUCT_NO_CPU | WORK_STRUCT_STATIC)
a08727ba 78
52bad64d
DH
79struct delayed_work {
80 struct work_struct work;
1da177e4
LT
81 struct timer_list timer;
82};
83
bf6aede7
JD
84static inline struct delayed_work *to_delayed_work(struct work_struct *work)
85{
86 return container_of(work, struct delayed_work, work);
87}
88
1fa44eca
JB
89struct execute_work {
90 struct work_struct work;
91};
92
4e6045f1
JB
93#ifdef CONFIG_LOCKDEP
94/*
95 * NB: because we have to copy the lockdep_map, setting _key
96 * here is required, otherwise it could get initialised to the
97 * copy of the lockdep_map!
98 */
99#define __WORK_INIT_LOCKDEP_MAP(n, k) \
100 .lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k),
101#else
102#define __WORK_INIT_LOCKDEP_MAP(n, k)
103#endif
104
65f27f38 105#define __WORK_INITIALIZER(n, f) { \
dc186ad7 106 .data = WORK_DATA_STATIC_INIT(), \
23b2e599 107 .entry = { &(n).entry, &(n).entry }, \
65f27f38 108 .func = (f), \
4e6045f1 109 __WORK_INIT_LOCKDEP_MAP(#n, &(n)) \
65f27f38
DH
110 }
111
112#define __DELAYED_WORK_INITIALIZER(n, f) { \
113 .work = __WORK_INITIALIZER((n).work, (f)), \
114 .timer = TIMER_INITIALIZER(NULL, 0, 0), \
115 }
116
65f27f38
DH
117#define DECLARE_WORK(n, f) \
118 struct work_struct n = __WORK_INITIALIZER(n, f)
119
65f27f38
DH
120#define DECLARE_DELAYED_WORK(n, f) \
121 struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f)
122
1da177e4 123/*
65f27f38 124 * initialize a work item's function pointer
1da177e4 125 */
65f27f38 126#define PREPARE_WORK(_work, _func) \
1da177e4 127 do { \
52bad64d 128 (_work)->func = (_func); \
1da177e4
LT
129 } while (0)
130
65f27f38
DH
131#define PREPARE_DELAYED_WORK(_work, _func) \
132 PREPARE_WORK(&(_work)->work, (_func))
52bad64d 133
dc186ad7
TG
134#ifdef CONFIG_DEBUG_OBJECTS_WORK
135extern void __init_work(struct work_struct *work, int onstack);
136extern void destroy_work_on_stack(struct work_struct *work);
4690c4ab
TH
137static inline unsigned int work_static(struct work_struct *work)
138{
22df02bb 139 return *work_data_bits(work) & WORK_STRUCT_STATIC;
4690c4ab 140}
dc186ad7
TG
141#else
142static inline void __init_work(struct work_struct *work, int onstack) { }
143static inline void destroy_work_on_stack(struct work_struct *work) { }
4690c4ab 144static inline unsigned int work_static(struct work_struct *work) { return 0; }
dc186ad7
TG
145#endif
146
1da177e4 147/*
52bad64d 148 * initialize all of a work item in one go
a08727ba 149 *
b9049df5 150 * NOTE! No point in using "atomic_long_set()": using a direct
a08727ba
LT
151 * assignment of the work data initializer allows the compiler
152 * to generate better code.
1da177e4 153 */
4e6045f1 154#ifdef CONFIG_LOCKDEP
dc186ad7 155#define __INIT_WORK(_work, _func, _onstack) \
65f27f38 156 do { \
4e6045f1
JB
157 static struct lock_class_key __key; \
158 \
dc186ad7 159 __init_work((_work), _onstack); \
23b2e599 160 (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
4e6045f1 161 lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0);\
65f27f38
DH
162 INIT_LIST_HEAD(&(_work)->entry); \
163 PREPARE_WORK((_work), (_func)); \
164 } while (0)
4e6045f1 165#else
dc186ad7 166#define __INIT_WORK(_work, _func, _onstack) \
4e6045f1 167 do { \
dc186ad7 168 __init_work((_work), _onstack); \
4e6045f1
JB
169 (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
170 INIT_LIST_HEAD(&(_work)->entry); \
171 PREPARE_WORK((_work), (_func)); \
172 } while (0)
173#endif
65f27f38 174
dc186ad7
TG
175#define INIT_WORK(_work, _func) \
176 do { \
177 __INIT_WORK((_work), (_func), 0); \
178 } while (0)
179
180#define INIT_WORK_ON_STACK(_work, _func) \
181 do { \
182 __INIT_WORK((_work), (_func), 1); \
183 } while (0)
184
65f27f38
DH
185#define INIT_DELAYED_WORK(_work, _func) \
186 do { \
187 INIT_WORK(&(_work)->work, (_func)); \
188 init_timer(&(_work)->timer); \
52bad64d
DH
189 } while (0)
190
6d612b0f
PZ
191#define INIT_DELAYED_WORK_ON_STACK(_work, _func) \
192 do { \
dc186ad7 193 INIT_WORK_ON_STACK(&(_work)->work, (_func)); \
6d612b0f
PZ
194 init_timer_on_stack(&(_work)->timer); \
195 } while (0)
196
dc186ad7 197#define INIT_DELAYED_WORK_DEFERRABLE(_work, _func) \
28287033
VP
198 do { \
199 INIT_WORK(&(_work)->work, (_func)); \
200 init_timer_deferrable(&(_work)->timer); \
201 } while (0)
202
365970a1
DH
203/**
204 * work_pending - Find out whether a work item is currently pending
205 * @work: The work item in question
206 */
207#define work_pending(work) \
22df02bb 208 test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
365970a1
DH
209
210/**
211 * delayed_work_pending - Find out whether a delayable work item is currently
212 * pending
213 * @work: The work item in question
214 */
0221872a
LT
215#define delayed_work_pending(w) \
216 work_pending(&(w)->work)
365970a1 217
65f27f38 218/**
23b2e599
ON
219 * work_clear_pending - for internal use only, mark a work item as not pending
220 * @work: The work item in question
65f27f38 221 */
23b2e599 222#define work_clear_pending(work) \
22df02bb 223 clear_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
65f27f38 224
97e37d7b
TH
225enum {
226 WQ_FREEZEABLE = 1 << 0, /* freeze during suspend */
502ca9d8 227 WQ_SINGLE_CPU = 1 << 1, /* only single cpu at a time */
18aa9eff 228 WQ_NON_REENTRANT = 1 << 2, /* guarantee non-reentrance */
97e37d7b 229};
52bad64d 230
4e6045f1 231extern struct workqueue_struct *
1e19ffc6 232__create_workqueue_key(const char *name, unsigned int flags, int max_active,
c790bce0 233 struct lock_class_key *key, const char *lock_name);
4e6045f1
JB
234
235#ifdef CONFIG_LOCKDEP
1e19ffc6 236#define __create_workqueue(name, flags, max_active) \
4e6045f1
JB
237({ \
238 static struct lock_class_key __key; \
eb13ba87
JB
239 const char *__lock_name; \
240 \
241 if (__builtin_constant_p(name)) \
242 __lock_name = (name); \
243 else \
244 __lock_name = #name; \
4e6045f1 245 \
1e19ffc6
TH
246 __create_workqueue_key((name), (flags), (max_active), \
247 &__key, __lock_name); \
4e6045f1
JB
248})
249#else
1e19ffc6
TH
250#define __create_workqueue(name, flags, max_active) \
251 __create_workqueue_key((name), (flags), (max_active), NULL, NULL)
4e6045f1
JB
252#endif
253
97e37d7b 254#define create_workqueue(name) \
1e19ffc6 255 __create_workqueue((name), 0, 1)
97e37d7b 256#define create_freezeable_workqueue(name) \
502ca9d8 257 __create_workqueue((name), WQ_FREEZEABLE | WQ_SINGLE_CPU, 1)
97e37d7b 258#define create_singlethread_workqueue(name) \
502ca9d8 259 __create_workqueue((name), WQ_SINGLE_CPU, 1)
1da177e4
LT
260
261extern void destroy_workqueue(struct workqueue_struct *wq);
262
b3c97528 263extern int queue_work(struct workqueue_struct *wq, struct work_struct *work);
c1a220e7
ZR
264extern int queue_work_on(int cpu, struct workqueue_struct *wq,
265 struct work_struct *work);
b3c97528
HH
266extern int queue_delayed_work(struct workqueue_struct *wq,
267 struct delayed_work *work, unsigned long delay);
7a6bc1cd 268extern int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
28e53bdd
ON
269 struct delayed_work *work, unsigned long delay);
270
b3c97528 271extern void flush_workqueue(struct workqueue_struct *wq);
28e53bdd 272extern void flush_scheduled_work(void);
43046b60 273extern void flush_delayed_work(struct delayed_work *work);
1da177e4 274
b3c97528 275extern int schedule_work(struct work_struct *work);
c1a220e7 276extern int schedule_work_on(int cpu, struct work_struct *work);
b3c97528 277extern int schedule_delayed_work(struct delayed_work *work, unsigned long delay);
28e53bdd
ON
278extern int schedule_delayed_work_on(int cpu, struct delayed_work *work,
279 unsigned long delay);
65f27f38 280extern int schedule_on_each_cpu(work_func_t func);
1da177e4
LT
281extern int current_is_keventd(void);
282extern int keventd_up(void);
283
284extern void init_workqueues(void);
65f27f38 285int execute_in_process_context(work_func_t fn, struct execute_work *);
1da177e4 286
db700897
ON
287extern int flush_work(struct work_struct *work);
288
1f1f642e 289extern int cancel_work_sync(struct work_struct *work);
28e53bdd 290
1da177e4
LT
291/*
292 * Kill off a pending schedule_delayed_work(). Note that the work callback
071b6386
ON
293 * function may still be running on return from cancel_delayed_work(), unless
294 * it returns 1 and the work doesn't re-arm itself. Run flush_workqueue() or
28e53bdd 295 * cancel_work_sync() to wait on it.
1da177e4 296 */
52bad64d 297static inline int cancel_delayed_work(struct delayed_work *work)
1da177e4
LT
298{
299 int ret;
300
223a10a9 301 ret = del_timer_sync(&work->timer);
1da177e4 302 if (ret)
23b2e599 303 work_clear_pending(&work->work);
1da177e4
LT
304 return ret;
305}
306
4e49627b
ON
307/*
308 * Like above, but uses del_timer() instead of del_timer_sync(). This means,
309 * if it returns 0 the timer function may be running and the queueing is in
310 * progress.
311 */
312static inline int __cancel_delayed_work(struct delayed_work *work)
313{
314 int ret;
315
316 ret = del_timer(&work->timer);
317 if (ret)
318 work_clear_pending(&work->work);
319 return ret;
320}
321
1f1f642e 322extern int cancel_delayed_work_sync(struct delayed_work *work);
1634c48f 323
f5a421a4 324/* Obsolete. use cancel_delayed_work_sync() */
1634c48f
ON
325static inline
326void cancel_rearming_delayed_workqueue(struct workqueue_struct *wq,
327 struct delayed_work *work)
328{
f5a421a4
ON
329 cancel_delayed_work_sync(work);
330}
331
332/* Obsolete. use cancel_delayed_work_sync() */
333static inline
334void cancel_rearming_delayed_work(struct delayed_work *work)
335{
336 cancel_delayed_work_sync(work);
1634c48f
ON
337}
338
2d3854a3
RR
339#ifndef CONFIG_SMP
340static inline long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
341{
342 return fn(arg);
343}
344#else
345long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg);
346#endif /* CONFIG_SMP */
a0a1a5fd
TH
347
348#ifdef CONFIG_FREEZER
349extern void freeze_workqueues_begin(void);
350extern bool freeze_workqueues_busy(void);
351extern void thaw_workqueues(void);
352#endif /* CONFIG_FREEZER */
353
1da177e4 354#endif