blob: 67ce734747f6979aeeec03587172adbe8416efcb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Johannes Berg4e6045f2007-10-18 23:39:55 -070011#include <linux/lockdep.h>
Tejun Heo7a22ad72010-06-29 10:07:13 +020012#include <linux/threads.h>
Linus Torvaldsa08727b2006-12-16 09:53:50 -080013#include <asm/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
15struct workqueue_struct;
16
David Howells65f27f32006-11-22 14:55:48 +000017struct work_struct;
18typedef void (*work_func_t)(struct work_struct *work);
David Howells6bb49e52006-11-22 14:54:45 +000019
Linus Torvaldsa08727b2006-12-16 09:53:50 -080020/*
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
Tejun Heo22df02b2010-06-29 10:07:10 +020026enum {
27 WORK_STRUCT_PENDING_BIT = 0, /* work item is pending execution */
Tejun Heoaffee4b2010-06-29 10:07:12 +020028 WORK_STRUCT_LINKED_BIT = 1, /* next work is linked to this one */
Tejun Heo22df02b2010-06-29 10:07:10 +020029#ifdef CONFIG_DEBUG_OBJECTS_WORK
Tejun Heoaffee4b2010-06-29 10:07:12 +020030 WORK_STRUCT_STATIC_BIT = 2, /* static initializer (debugobjects) */
Tejun Heo73f53c42010-06-29 10:07:11 +020031 WORK_STRUCT_COLOR_SHIFT = 3, /* color for workqueue flushing */
Tejun Heo0f900042010-06-29 10:07:11 +020032#else
Tejun Heo73f53c42010-06-29 10:07:11 +020033 WORK_STRUCT_COLOR_SHIFT = 2, /* color for workqueue flushing */
Tejun Heo22df02b2010-06-29 10:07:10 +020034#endif
35
Tejun Heo73f53c42010-06-29 10:07:11 +020036 WORK_STRUCT_COLOR_BITS = 4,
37
Tejun Heo22df02b2010-06-29 10:07:10 +020038 WORK_STRUCT_PENDING = 1 << WORK_STRUCT_PENDING_BIT,
Tejun Heoaffee4b2010-06-29 10:07:12 +020039 WORK_STRUCT_LINKED = 1 << WORK_STRUCT_LINKED_BIT,
Tejun Heo22df02b2010-06-29 10:07:10 +020040#ifdef CONFIG_DEBUG_OBJECTS_WORK
41 WORK_STRUCT_STATIC = 1 << WORK_STRUCT_STATIC_BIT,
42#else
43 WORK_STRUCT_STATIC = 0,
44#endif
45
Tejun Heo73f53c42010-06-29 10:07:11 +020046 /*
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
Tejun Heobdbc5dd2010-07-02 10:03:51 +020053 /* special cpu IDs */
Tejun Heof3421792010-07-02 10:03:51 +020054 WORK_CPU_UNBOUND = NR_CPUS,
55 WORK_CPU_NONE = NR_CPUS + 1,
Tejun Heobdbc5dd2010-07-02 10:03:51 +020056 WORK_CPU_LAST = WORK_CPU_NONE,
57
Tejun Heo73f53c42010-06-29 10:07:11 +020058 /*
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
Tejun Heo0f900042010-06-29 10:07:11 +020066 WORK_STRUCT_FLAG_MASK = (1UL << WORK_STRUCT_FLAG_BITS) - 1,
Tejun Heo22df02b2010-06-29 10:07:10 +020067 WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK,
Tejun Heobdbc5dd2010-07-02 10:03:51 +020068 WORK_STRUCT_NO_CPU = WORK_CPU_NONE << WORK_STRUCT_FLAG_BITS,
Tejun Heodcd989c2010-06-29 10:07:14 +020069
70 /* bit mask for work_busy() return values */
71 WORK_BUSY_PENDING = 1 << 0,
72 WORK_BUSY_RUNNING = 1 << 1,
Tejun Heo22df02b2010-06-29 10:07:10 +020073};
74
Linus Torvalds1da177e2005-04-16 15:20:36 -070075struct work_struct {
Linus Torvaldsa08727b2006-12-16 09:53:50 -080076 atomic_long_t data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 struct list_head entry;
David Howells6bb49e52006-11-22 14:54:45 +000078 work_func_t func;
Johannes Berg4e6045f2007-10-18 23:39:55 -070079#ifdef CONFIG_LOCKDEP
80 struct lockdep_map lockdep_map;
81#endif
David Howells52bad642006-11-22 14:54:01 +000082};
83
Tejun Heo7a22ad72010-06-29 10:07:13 +020084#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)
Linus Torvaldsa08727b2006-12-16 09:53:50 -080087
David Howells52bad642006-11-22 14:54:01 +000088struct delayed_work {
89 struct work_struct work;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 struct timer_list timer;
91};
92
Jean Delvarebf6aede2009-04-02 16:56:54 -070093static inline struct delayed_work *to_delayed_work(struct work_struct *work)
94{
95 return container_of(work, struct delayed_work, work);
96}
97
James Bottomley1fa44ec2006-02-23 12:43:43 -060098struct execute_work {
99 struct work_struct work;
100};
101
Johannes Berg4e6045f2007-10-18 23:39:55 -0700102#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
David Howells65f27f32006-11-22 14:55:48 +0000114#define __WORK_INITIALIZER(n, f) { \
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900115 .data = WORK_DATA_STATIC_INIT(), \
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700116 .entry = { &(n).entry, &(n).entry }, \
David Howells65f27f32006-11-22 14:55:48 +0000117 .func = (f), \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700118 __WORK_INIT_LOCKDEP_MAP(#n, &(n)) \
David Howells65f27f32006-11-22 14:55:48 +0000119 }
120
121#define __DELAYED_WORK_INITIALIZER(n, f) { \
122 .work = __WORK_INITIALIZER((n).work, (f)), \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 .timer = TIMER_INITIALIZER(NULL, 0, 0), \
124 }
125
David Howells65f27f32006-11-22 14:55:48 +0000126#define DECLARE_WORK(n, f) \
127 struct work_struct n = __WORK_INITIALIZER(n, f)
128
David Howells65f27f32006-11-22 14:55:48 +0000129#define DECLARE_DELAYED_WORK(n, f) \
130 struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f)
131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132/*
David Howells65f27f32006-11-22 14:55:48 +0000133 * initialize a work item's function pointer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 */
David Howells65f27f32006-11-22 14:55:48 +0000135#define PREPARE_WORK(_work, _func) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 do { \
David Howells52bad642006-11-22 14:54:01 +0000137 (_work)->func = (_func); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 } while (0)
139
David Howells65f27f32006-11-22 14:55:48 +0000140#define PREPARE_DELAYED_WORK(_work, _func) \
141 PREPARE_WORK(&(_work)->work, (_func))
David Howells52bad642006-11-22 14:54:01 +0000142
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900143#ifdef CONFIG_DEBUG_OBJECTS_WORK
144extern void __init_work(struct work_struct *work, int onstack);
145extern void destroy_work_on_stack(struct work_struct *work);
Tejun Heo4690c4a2010-06-29 10:07:10 +0200146static inline unsigned int work_static(struct work_struct *work)
147{
Tejun Heo22df02b2010-06-29 10:07:10 +0200148 return *work_data_bits(work) & WORK_STRUCT_STATIC;
Tejun Heo4690c4a2010-06-29 10:07:10 +0200149}
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900150#else
151static inline void __init_work(struct work_struct *work, int onstack) { }
152static inline void destroy_work_on_stack(struct work_struct *work) { }
Tejun Heo4690c4a2010-06-29 10:07:10 +0200153static inline unsigned int work_static(struct work_struct *work) { return 0; }
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900154#endif
155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156/*
David Howells52bad642006-11-22 14:54:01 +0000157 * initialize all of a work item in one go
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800158 *
Dmitri Vorobievb9049df2009-06-23 12:09:29 +0200159 * NOTE! No point in using "atomic_long_set()": using a direct
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800160 * assignment of the work data initializer allows the compiler
161 * to generate better code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700163#ifdef CONFIG_LOCKDEP
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900164#define __INIT_WORK(_work, _func, _onstack) \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700165 do { \
166 static struct lock_class_key __key; \
167 \
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900168 __init_work((_work), _onstack); \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700169 (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
170 lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0);\
171 INIT_LIST_HEAD(&(_work)->entry); \
172 PREPARE_WORK((_work), (_func)); \
173 } while (0)
174#else
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900175#define __INIT_WORK(_work, _func, _onstack) \
David Howells65f27f32006-11-22 14:55:48 +0000176 do { \
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900177 __init_work((_work), _onstack); \
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700178 (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
David Howells65f27f32006-11-22 14:55:48 +0000179 INIT_LIST_HEAD(&(_work)->entry); \
180 PREPARE_WORK((_work), (_func)); \
181 } while (0)
Johannes Berg4e6045f2007-10-18 23:39:55 -0700182#endif
David Howells65f27f32006-11-22 14:55:48 +0000183
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900184#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
David Howells65f27f32006-11-22 14:55:48 +0000194#define INIT_DELAYED_WORK(_work, _func) \
David Howells52bad642006-11-22 14:54:01 +0000195 do { \
David Howells65f27f32006-11-22 14:55:48 +0000196 INIT_WORK(&(_work)->work, (_func)); \
197 init_timer(&(_work)->timer); \
198 } while (0)
199
Peter Zijlstra6d612b02009-01-12 12:52:23 +0100200#define INIT_DELAYED_WORK_ON_STACK(_work, _func) \
201 do { \
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900202 INIT_WORK_ON_STACK(&(_work)->work, (_func)); \
Peter Zijlstra6d612b02009-01-12 12:52:23 +0100203 init_timer_on_stack(&(_work)->timer); \
204 } while (0)
205
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900206#define INIT_DELAYED_WORK_DEFERRABLE(_work, _func) \
Venki Pallipadi28287032007-05-08 00:27:47 -0700207 do { \
208 INIT_WORK(&(_work)->work, (_func)); \
209 init_timer_deferrable(&(_work)->timer); \
210 } while (0)
211
David Howells365970a2006-11-22 14:54:49 +0000212/**
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) \
Tejun Heo22df02b2010-06-29 10:07:10 +0200217 test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
David Howells365970a2006-11-22 14:54:49 +0000218
219/**
220 * delayed_work_pending - Find out whether a delayable work item is currently
221 * pending
222 * @work: The work item in question
223 */
Linus Torvalds02218722006-12-15 14:13:51 -0800224#define delayed_work_pending(w) \
225 work_pending(&(w)->work)
David Howells365970a2006-11-22 14:54:49 +0000226
David Howells65f27f32006-11-22 14:55:48 +0000227/**
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700228 * work_clear_pending - for internal use only, mark a work item as not pending
229 * @work: The work item in question
David Howells65f27f32006-11-22 14:55:48 +0000230 */
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700231#define work_clear_pending(work) \
Tejun Heo22df02b2010-06-29 10:07:10 +0200232 clear_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
David Howells65f27f32006-11-22 14:55:48 +0000233
Tejun Heo97e37d72010-06-29 10:07:10 +0200234enum {
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200235 WQ_NON_REENTRANT = 1 << 0, /* guarantee non-reentrance */
Tejun Heo502ca9d2010-06-29 10:07:13 +0200236 WQ_SINGLE_CPU = 1 << 1, /* only single cpu at a time */
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200237 WQ_FREEZEABLE = 1 << 2, /* freeze during suspend */
Tejun Heoe22bee72010-06-29 10:07:14 +0200238 WQ_RESCUER = 1 << 3, /* has an rescue worker */
Tejun Heo649027d2010-06-29 10:07:14 +0200239 WQ_HIGHPRI = 1 << 4, /* high priority */
Tejun Heofb0e7be2010-06-29 10:07:15 +0200240 WQ_CPU_INTENSIVE = 1 << 5, /* cpu instensive workqueue */
Tejun Heof3421792010-07-02 10:03:51 +0200241 WQ_UNBOUND = 1 << 6, /* not bound to any cpu */
Tejun Heob71ab8c2010-06-29 10:07:14 +0200242
243 WQ_MAX_ACTIVE = 512, /* I like 512, better ideas? */
Tejun Heof3421792010-07-02 10:03:51 +0200244 WQ_MAX_UNBOUND_PER_CPU = 4, /* 4 * #cpus for unbound wq */
Tejun Heob71ab8c2010-06-29 10:07:14 +0200245 WQ_DFL_ACTIVE = WQ_MAX_ACTIVE / 2,
Tejun Heo97e37d72010-06-29 10:07:10 +0200246};
David Howells52bad642006-11-22 14:54:01 +0000247
Tejun Heof3421792010-07-02 10:03:51 +0200248/* unbound wq's aren't per-cpu, scale max_active according to #cpus */
249#define WQ_UNBOUND_MAX_ACTIVE \
250 max_t(int, WQ_MAX_ACTIVE, num_possible_cpus() * WQ_MAX_UNBOUND_PER_CPU)
251
Tejun Heod320c032010-06-29 10:07:14 +0200252/*
253 * System-wide workqueues which are always present.
254 *
255 * system_wq is the one used by schedule[_delayed]_work[_on]().
256 * Multi-CPU multi-threaded. There are users which expect relatively
257 * short queue flush time. Don't queue works which can run for too
258 * long.
259 *
260 * system_long_wq is similar to system_wq but may host long running
261 * works. Queue flushing might take relatively long.
262 *
263 * system_nrt_wq is non-reentrant and guarantees that any given work
264 * item is never executed in parallel by multiple CPUs. Queue
265 * flushing might take relatively long.
Tejun Heof3421792010-07-02 10:03:51 +0200266 *
267 * system_unbound_wq is unbound workqueue. Workers are not bound to
268 * any specific CPU, not concurrency managed, and all queued works are
269 * executed immediately as long as max_active limit is not reached and
270 * resources are available.
Tejun Heod320c032010-06-29 10:07:14 +0200271 */
272extern struct workqueue_struct *system_wq;
273extern struct workqueue_struct *system_long_wq;
274extern struct workqueue_struct *system_nrt_wq;
Tejun Heof3421792010-07-02 10:03:51 +0200275extern struct workqueue_struct *system_unbound_wq;
Tejun Heod320c032010-06-29 10:07:14 +0200276
Johannes Berg4e6045f2007-10-18 23:39:55 -0700277extern struct workqueue_struct *
Tejun Heod320c032010-06-29 10:07:14 +0200278__alloc_workqueue_key(const char *name, unsigned int flags, int max_active,
279 struct lock_class_key *key, const char *lock_name);
Johannes Berg4e6045f2007-10-18 23:39:55 -0700280
281#ifdef CONFIG_LOCKDEP
Tejun Heod320c032010-06-29 10:07:14 +0200282#define alloc_workqueue(name, flags, max_active) \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700283({ \
284 static struct lock_class_key __key; \
Johannes Bergeb13ba82008-01-16 09:51:58 +0100285 const char *__lock_name; \
286 \
287 if (__builtin_constant_p(name)) \
288 __lock_name = (name); \
289 else \
290 __lock_name = #name; \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700291 \
Tejun Heod320c032010-06-29 10:07:14 +0200292 __alloc_workqueue_key((name), (flags), (max_active), \
293 &__key, __lock_name); \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700294})
295#else
Tejun Heod320c032010-06-29 10:07:14 +0200296#define alloc_workqueue(name, flags, max_active) \
297 __alloc_workqueue_key((name), (flags), (max_active), NULL, NULL)
Johannes Berg4e6045f2007-10-18 23:39:55 -0700298#endif
299
Tejun Heo97e37d72010-06-29 10:07:10 +0200300#define create_workqueue(name) \
Tejun Heod320c032010-06-29 10:07:14 +0200301 alloc_workqueue((name), WQ_RESCUER, 1)
Tejun Heo97e37d72010-06-29 10:07:10 +0200302#define create_freezeable_workqueue(name) \
Tejun Heod320c032010-06-29 10:07:14 +0200303 alloc_workqueue((name), WQ_FREEZEABLE | WQ_SINGLE_CPU | WQ_RESCUER, 1)
Tejun Heo97e37d72010-06-29 10:07:10 +0200304#define create_singlethread_workqueue(name) \
Tejun Heod320c032010-06-29 10:07:14 +0200305 alloc_workqueue((name), WQ_SINGLE_CPU | WQ_RESCUER, 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
307extern void destroy_workqueue(struct workqueue_struct *wq);
308
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800309extern int queue_work(struct workqueue_struct *wq, struct work_struct *work);
Zhang Ruic1a220e2008-07-23 21:28:39 -0700310extern int queue_work_on(int cpu, struct workqueue_struct *wq,
311 struct work_struct *work);
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800312extern int queue_delayed_work(struct workqueue_struct *wq,
313 struct delayed_work *work, unsigned long delay);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700314extern int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700315 struct delayed_work *work, unsigned long delay);
316
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800317extern void flush_workqueue(struct workqueue_struct *wq);
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700318extern void flush_scheduled_work(void);
Linus Torvalds43046b62009-10-14 09:16:42 -0700319extern void flush_delayed_work(struct delayed_work *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800321extern int schedule_work(struct work_struct *work);
Zhang Ruic1a220e2008-07-23 21:28:39 -0700322extern int schedule_work_on(int cpu, struct work_struct *work);
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800323extern int schedule_delayed_work(struct delayed_work *work, unsigned long delay);
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700324extern int schedule_delayed_work_on(int cpu, struct delayed_work *work,
325 unsigned long delay);
David Howells65f27f32006-11-22 14:55:48 +0000326extern int schedule_on_each_cpu(work_func_t func);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327extern int keventd_up(void);
328
329extern void init_workqueues(void);
David Howells65f27f32006-11-22 14:55:48 +0000330int execute_in_process_context(work_func_t fn, struct execute_work *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
Oleg Nesterovdb700892008-07-25 01:47:49 -0700332extern int flush_work(struct work_struct *work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700333extern int cancel_work_sync(struct work_struct *work);
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700334
Tejun Heodcd989c2010-06-29 10:07:14 +0200335extern void workqueue_set_max_active(struct workqueue_struct *wq,
336 int max_active);
337extern bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq);
338extern unsigned int work_cpu(struct work_struct *work);
339extern unsigned int work_busy(struct work_struct *work);
340
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341/*
342 * Kill off a pending schedule_delayed_work(). Note that the work callback
Oleg Nesterov071b6382007-04-26 15:45:32 -0700343 * function may still be running on return from cancel_delayed_work(), unless
344 * it returns 1 and the work doesn't re-arm itself. Run flush_workqueue() or
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700345 * cancel_work_sync() to wait on it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 */
David Howells52bad642006-11-22 14:54:01 +0000347static inline int cancel_delayed_work(struct delayed_work *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348{
349 int ret;
350
Oleg Nesterov223a10a2007-05-18 00:36:42 -0700351 ret = del_timer_sync(&work->timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 if (ret)
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700353 work_clear_pending(&work->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 return ret;
355}
356
Oleg Nesterov4e496272009-09-05 11:17:06 -0700357/*
358 * Like above, but uses del_timer() instead of del_timer_sync(). This means,
359 * if it returns 0 the timer function may be running and the queueing is in
360 * progress.
361 */
362static inline int __cancel_delayed_work(struct delayed_work *work)
363{
364 int ret;
365
366 ret = del_timer(&work->timer);
367 if (ret)
368 work_clear_pending(&work->work);
369 return ret;
370}
371
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700372extern int cancel_delayed_work_sync(struct delayed_work *work);
Oleg Nesterov1634c482007-05-09 02:34:18 -0700373
Oleg Nesterovf5a421a2007-07-15 23:41:44 -0700374/* Obsolete. use cancel_delayed_work_sync() */
Oleg Nesterov1634c482007-05-09 02:34:18 -0700375static inline
376void cancel_rearming_delayed_workqueue(struct workqueue_struct *wq,
377 struct delayed_work *work)
378{
Oleg Nesterovf5a421a2007-07-15 23:41:44 -0700379 cancel_delayed_work_sync(work);
380}
381
382/* Obsolete. use cancel_delayed_work_sync() */
383static inline
384void cancel_rearming_delayed_work(struct delayed_work *work)
385{
386 cancel_delayed_work_sync(work);
Oleg Nesterov1634c482007-05-09 02:34:18 -0700387}
388
Rusty Russell2d3854a2008-11-05 13:39:10 +1100389#ifndef CONFIG_SMP
390static inline long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
391{
392 return fn(arg);
393}
394#else
395long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg);
396#endif /* CONFIG_SMP */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200397
398#ifdef CONFIG_FREEZER
399extern void freeze_workqueues_begin(void);
400extern bool freeze_workqueues_busy(void);
401extern void thaw_workqueues(void);
402#endif /* CONFIG_FREEZER */
403
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404#endif