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 | ||
28287033 VP |
121 | #define INIT_DELAYED_WORK_DEFERRABLE(_work, _func) \ |
122 | do { \ | |
123 | INIT_WORK(&(_work)->work, (_func)); \ | |
124 | init_timer_deferrable(&(_work)->timer); \ | |
125 | } while (0) | |
126 | ||
365970a1 DH |
127 | /** |
128 | * work_pending - Find out whether a work item is currently pending | |
129 | * @work: The work item in question | |
130 | */ | |
131 | #define work_pending(work) \ | |
a08727ba | 132 | test_bit(WORK_STRUCT_PENDING, work_data_bits(work)) |
365970a1 DH |
133 | |
134 | /** | |
135 | * delayed_work_pending - Find out whether a delayable work item is currently | |
136 | * pending | |
137 | * @work: The work item in question | |
138 | */ | |
0221872a LT |
139 | #define delayed_work_pending(w) \ |
140 | work_pending(&(w)->work) | |
365970a1 | 141 | |
65f27f38 | 142 | /** |
23b2e599 ON |
143 | * work_clear_pending - for internal use only, mark a work item as not pending |
144 | * @work: The work item in question | |
65f27f38 | 145 | */ |
23b2e599 | 146 | #define work_clear_pending(work) \ |
a08727ba | 147 | clear_bit(WORK_STRUCT_PENDING, work_data_bits(work)) |
65f27f38 | 148 | |
52bad64d | 149 | |
4e6045f1 JB |
150 | extern struct workqueue_struct * |
151 | __create_workqueue_key(const char *name, int singlethread, | |
eb13ba87 JB |
152 | int freezeable, struct lock_class_key *key, |
153 | const char *lock_name); | |
4e6045f1 JB |
154 | |
155 | #ifdef CONFIG_LOCKDEP | |
156 | #define __create_workqueue(name, singlethread, freezeable) \ | |
157 | ({ \ | |
158 | static struct lock_class_key __key; \ | |
eb13ba87 JB |
159 | const char *__lock_name; \ |
160 | \ | |
161 | if (__builtin_constant_p(name)) \ | |
162 | __lock_name = (name); \ | |
163 | else \ | |
164 | __lock_name = #name; \ | |
4e6045f1 JB |
165 | \ |
166 | __create_workqueue_key((name), (singlethread), \ | |
eb13ba87 JB |
167 | (freezeable), &__key, \ |
168 | __lock_name); \ | |
4e6045f1 JB |
169 | }) |
170 | #else | |
171 | #define __create_workqueue(name, singlethread, freezeable) \ | |
eb13ba87 | 172 | __create_workqueue_key((name), (singlethread), (freezeable), NULL, NULL) |
4e6045f1 JB |
173 | #endif |
174 | ||
341a5958 | 175 | #define create_workqueue(name) __create_workqueue((name), 0, 0) |
e3dfd296 | 176 | #define create_freezeable_workqueue(name) __create_workqueue((name), 1, 1) |
341a5958 | 177 | #define create_singlethread_workqueue(name) __create_workqueue((name), 1, 0) |
1da177e4 LT |
178 | |
179 | extern void destroy_workqueue(struct workqueue_struct *wq); | |
180 | ||
b3c97528 | 181 | extern int queue_work(struct workqueue_struct *wq, struct work_struct *work); |
c1a220e7 ZR |
182 | extern int queue_work_on(int cpu, struct workqueue_struct *wq, |
183 | struct work_struct *work); | |
b3c97528 HH |
184 | extern int queue_delayed_work(struct workqueue_struct *wq, |
185 | struct delayed_work *work, unsigned long delay); | |
7a6bc1cd | 186 | extern int queue_delayed_work_on(int cpu, struct workqueue_struct *wq, |
28e53bdd ON |
187 | struct delayed_work *work, unsigned long delay); |
188 | ||
b3c97528 | 189 | extern void flush_workqueue(struct workqueue_struct *wq); |
28e53bdd | 190 | extern void flush_scheduled_work(void); |
1da177e4 | 191 | |
b3c97528 | 192 | extern int schedule_work(struct work_struct *work); |
c1a220e7 | 193 | extern int schedule_work_on(int cpu, struct work_struct *work); |
b3c97528 | 194 | extern int schedule_delayed_work(struct delayed_work *work, unsigned long delay); |
28e53bdd ON |
195 | extern int schedule_delayed_work_on(int cpu, struct delayed_work *work, |
196 | unsigned long delay); | |
65f27f38 | 197 | extern int schedule_on_each_cpu(work_func_t func); |
1da177e4 LT |
198 | extern int current_is_keventd(void); |
199 | extern int keventd_up(void); | |
200 | ||
201 | extern void init_workqueues(void); | |
65f27f38 | 202 | int execute_in_process_context(work_func_t fn, struct execute_work *); |
1da177e4 | 203 | |
db700897 ON |
204 | extern int flush_work(struct work_struct *work); |
205 | ||
1f1f642e | 206 | extern int cancel_work_sync(struct work_struct *work); |
28e53bdd | 207 | |
1da177e4 LT |
208 | /* |
209 | * Kill off a pending schedule_delayed_work(). Note that the work callback | |
071b6386 ON |
210 | * function may still be running on return from cancel_delayed_work(), unless |
211 | * it returns 1 and the work doesn't re-arm itself. Run flush_workqueue() or | |
28e53bdd | 212 | * cancel_work_sync() to wait on it. |
1da177e4 | 213 | */ |
52bad64d | 214 | static inline int cancel_delayed_work(struct delayed_work *work) |
1da177e4 LT |
215 | { |
216 | int ret; | |
217 | ||
223a10a9 | 218 | ret = del_timer_sync(&work->timer); |
1da177e4 | 219 | if (ret) |
23b2e599 | 220 | work_clear_pending(&work->work); |
1da177e4 LT |
221 | return ret; |
222 | } | |
223 | ||
1f1f642e | 224 | extern int cancel_delayed_work_sync(struct delayed_work *work); |
1634c48f | 225 | |
f5a421a4 | 226 | /* Obsolete. use cancel_delayed_work_sync() */ |
1634c48f ON |
227 | static inline |
228 | void cancel_rearming_delayed_workqueue(struct workqueue_struct *wq, | |
229 | struct delayed_work *work) | |
230 | { | |
f5a421a4 ON |
231 | cancel_delayed_work_sync(work); |
232 | } | |
233 | ||
234 | /* Obsolete. use cancel_delayed_work_sync() */ | |
235 | static inline | |
236 | void cancel_rearming_delayed_work(struct delayed_work *work) | |
237 | { | |
238 | cancel_delayed_work_sync(work); | |
1634c48f ON |
239 | } |
240 | ||
1da177e4 | 241 | #endif |