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