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