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