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