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