blob: 13e1adf55c4c7c0ba30d81bbc54abe6d56b93b5e [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>
Linus Torvaldsa08727b2006-12-16 09:53:50 -080012#include <asm/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
14struct workqueue_struct;
15
David Howells65f27f32006-11-22 14:55:48 +000016struct work_struct;
17typedef void (*work_func_t)(struct work_struct *work);
David Howells6bb49e52006-11-22 14:54:45 +000018
Linus Torvaldsa08727b2006-12-16 09:53:50 -080019/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070025struct work_struct {
Linus Torvaldsa08727b2006-12-16 09:53:50 -080026 atomic_long_t data;
David Howells365970a2006-11-22 14:54:49 +000027#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 struct list_head entry;
David Howells6bb49e52006-11-22 14:54:45 +000031 work_func_t func;
Johannes Berg4e6045f2007-10-18 23:39:55 -070032#ifdef CONFIG_LOCKDEP
33 struct lockdep_map lockdep_map;
34#endif
David Howells52bad642006-11-22 14:54:01 +000035};
36
Oleg Nesterov23b2e592007-05-09 02:34:19 -070037#define WORK_DATA_INIT() ATOMIC_LONG_INIT(0)
Linus Torvaldsa08727b2006-12-16 09:53:50 -080038
David Howells52bad642006-11-22 14:54:01 +000039struct delayed_work {
40 struct work_struct work;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 struct timer_list timer;
42};
43
Jean Delvarebf6aede2009-04-02 16:56:54 -070044static inline struct delayed_work *to_delayed_work(struct work_struct *work)
45{
46 return container_of(work, struct delayed_work, work);
47}
48
James Bottomley1fa44ec2006-02-23 12:43:43 -060049struct execute_work {
50 struct work_struct work;
51};
52
Johannes Berg4e6045f2007-10-18 23:39:55 -070053#ifdef CONFIG_LOCKDEP
54/*
55 * NB: because we have to copy the lockdep_map, setting _key
56 * here is required, otherwise it could get initialised to the
57 * copy of the lockdep_map!
58 */
59#define __WORK_INIT_LOCKDEP_MAP(n, k) \
60 .lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k),
61#else
62#define __WORK_INIT_LOCKDEP_MAP(n, k)
63#endif
64
David Howells65f27f32006-11-22 14:55:48 +000065#define __WORK_INITIALIZER(n, f) { \
Oleg Nesterov23b2e592007-05-09 02:34:19 -070066 .data = WORK_DATA_INIT(), \
67 .entry = { &(n).entry, &(n).entry }, \
David Howells65f27f32006-11-22 14:55:48 +000068 .func = (f), \
Johannes Berg4e6045f2007-10-18 23:39:55 -070069 __WORK_INIT_LOCKDEP_MAP(#n, &(n)) \
David Howells65f27f32006-11-22 14:55:48 +000070 }
71
72#define __DELAYED_WORK_INITIALIZER(n, f) { \
73 .work = __WORK_INITIALIZER((n).work, (f)), \
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 .timer = TIMER_INITIALIZER(NULL, 0, 0), \
75 }
76
David Howells65f27f32006-11-22 14:55:48 +000077#define DECLARE_WORK(n, f) \
78 struct work_struct n = __WORK_INITIALIZER(n, f)
79
David Howells65f27f32006-11-22 14:55:48 +000080#define DECLARE_DELAYED_WORK(n, f) \
81 struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f)
82
Linus Torvalds1da177e2005-04-16 15:20:36 -070083/*
David Howells65f27f32006-11-22 14:55:48 +000084 * initialize a work item's function pointer
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 */
David Howells65f27f32006-11-22 14:55:48 +000086#define PREPARE_WORK(_work, _func) \
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 do { \
David Howells52bad642006-11-22 14:54:01 +000088 (_work)->func = (_func); \
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 } while (0)
90
David Howells65f27f32006-11-22 14:55:48 +000091#define PREPARE_DELAYED_WORK(_work, _func) \
92 PREPARE_WORK(&(_work)->work, (_func))
David Howells52bad642006-11-22 14:54:01 +000093
Linus Torvalds1da177e2005-04-16 15:20:36 -070094/*
David Howells52bad642006-11-22 14:54:01 +000095 * initialize all of a work item in one go
Linus Torvaldsa08727b2006-12-16 09:53:50 -080096 *
97 * NOTE! No point in using "atomic_long_set()": useing a direct
98 * assignment of the work data initializer allows the compiler
99 * to generate better code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700101#ifdef CONFIG_LOCKDEP
102#define INIT_WORK(_work, _func) \
103 do { \
104 static struct lock_class_key __key; \
105 \
106 (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
107 lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0);\
108 INIT_LIST_HEAD(&(_work)->entry); \
109 PREPARE_WORK((_work), (_func)); \
110 } while (0)
111#else
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700112#define INIT_WORK(_work, _func) \
David Howells65f27f32006-11-22 14:55:48 +0000113 do { \
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700114 (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
David Howells65f27f32006-11-22 14:55:48 +0000115 INIT_LIST_HEAD(&(_work)->entry); \
116 PREPARE_WORK((_work), (_func)); \
117 } while (0)
Johannes Berg4e6045f2007-10-18 23:39:55 -0700118#endif
David Howells65f27f32006-11-22 14:55:48 +0000119
120#define INIT_DELAYED_WORK(_work, _func) \
David Howells52bad642006-11-22 14:54:01 +0000121 do { \
David Howells65f27f32006-11-22 14:55:48 +0000122 INIT_WORK(&(_work)->work, (_func)); \
123 init_timer(&(_work)->timer); \
124 } while (0)
125
Peter Zijlstra6d612b02009-01-12 12:52:23 +0100126#define INIT_DELAYED_WORK_ON_STACK(_work, _func) \
127 do { \
128 INIT_WORK(&(_work)->work, (_func)); \
129 init_timer_on_stack(&(_work)->timer); \
130 } while (0)
131
Venki Pallipadi28287032007-05-08 00:27:47 -0700132#define INIT_DELAYED_WORK_DEFERRABLE(_work, _func) \
133 do { \
134 INIT_WORK(&(_work)->work, (_func)); \
135 init_timer_deferrable(&(_work)->timer); \
136 } while (0)
137
Thomas Gleixner336f6c32009-01-22 09:50:44 +0100138#define INIT_DELAYED_WORK_ON_STACK(_work, _func) \
139 do { \
140 INIT_WORK(&(_work)->work, (_func)); \
141 init_timer_on_stack(&(_work)->timer); \
142 } while (0)
143
David Howells365970a2006-11-22 14:54:49 +0000144/**
145 * work_pending - Find out whether a work item is currently pending
146 * @work: The work item in question
147 */
148#define work_pending(work) \
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800149 test_bit(WORK_STRUCT_PENDING, work_data_bits(work))
David Howells365970a2006-11-22 14:54:49 +0000150
151/**
152 * delayed_work_pending - Find out whether a delayable work item is currently
153 * pending
154 * @work: The work item in question
155 */
Linus Torvalds02218722006-12-15 14:13:51 -0800156#define delayed_work_pending(w) \
157 work_pending(&(w)->work)
David Howells365970a2006-11-22 14:54:49 +0000158
David Howells65f27f32006-11-22 14:55:48 +0000159/**
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700160 * work_clear_pending - for internal use only, mark a work item as not pending
161 * @work: The work item in question
David Howells65f27f32006-11-22 14:55:48 +0000162 */
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700163#define work_clear_pending(work) \
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800164 clear_bit(WORK_STRUCT_PENDING, work_data_bits(work))
David Howells65f27f32006-11-22 14:55:48 +0000165
David Howells52bad642006-11-22 14:54:01 +0000166
Johannes Berg4e6045f2007-10-18 23:39:55 -0700167extern struct workqueue_struct *
168__create_workqueue_key(const char *name, int singlethread,
Heiko Carstens0d557dc2008-10-13 23:50:09 +0200169 int freezeable, int rt, struct lock_class_key *key,
Johannes Bergeb13ba82008-01-16 09:51:58 +0100170 const char *lock_name);
Johannes Berg4e6045f2007-10-18 23:39:55 -0700171
172#ifdef CONFIG_LOCKDEP
Heiko Carstens0d557dc2008-10-13 23:50:09 +0200173#define __create_workqueue(name, singlethread, freezeable, rt) \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700174({ \
175 static struct lock_class_key __key; \
Johannes Bergeb13ba82008-01-16 09:51:58 +0100176 const char *__lock_name; \
177 \
178 if (__builtin_constant_p(name)) \
179 __lock_name = (name); \
180 else \
181 __lock_name = #name; \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700182 \
183 __create_workqueue_key((name), (singlethread), \
Heiko Carstens0d557dc2008-10-13 23:50:09 +0200184 (freezeable), (rt), &__key, \
Johannes Bergeb13ba82008-01-16 09:51:58 +0100185 __lock_name); \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700186})
187#else
Heiko Carstens0d557dc2008-10-13 23:50:09 +0200188#define __create_workqueue(name, singlethread, freezeable, rt) \
189 __create_workqueue_key((name), (singlethread), (freezeable), (rt), \
190 NULL, NULL)
Johannes Berg4e6045f2007-10-18 23:39:55 -0700191#endif
192
Heiko Carstens0d557dc2008-10-13 23:50:09 +0200193#define create_workqueue(name) __create_workqueue((name), 0, 0, 0)
194#define create_rt_workqueue(name) __create_workqueue((name), 0, 0, 1)
195#define create_freezeable_workqueue(name) __create_workqueue((name), 1, 1, 0)
196#define create_singlethread_workqueue(name) __create_workqueue((name), 1, 0, 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
198extern void destroy_workqueue(struct workqueue_struct *wq);
199
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800200extern int queue_work(struct workqueue_struct *wq, struct work_struct *work);
Zhang Ruic1a220e2008-07-23 21:28:39 -0700201extern int queue_work_on(int cpu, struct workqueue_struct *wq,
202 struct work_struct *work);
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800203extern int queue_delayed_work(struct workqueue_struct *wq,
204 struct delayed_work *work, unsigned long delay);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -0700205extern int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700206 struct delayed_work *work, unsigned long delay);
207
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800208extern void flush_workqueue(struct workqueue_struct *wq);
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700209extern void flush_scheduled_work(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800211extern int schedule_work(struct work_struct *work);
Zhang Ruic1a220e2008-07-23 21:28:39 -0700212extern int schedule_work_on(int cpu, struct work_struct *work);
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800213extern int schedule_delayed_work(struct delayed_work *work, unsigned long delay);
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700214extern int schedule_delayed_work_on(int cpu, struct delayed_work *work,
215 unsigned long delay);
David Howells65f27f32006-11-22 14:55:48 +0000216extern int schedule_on_each_cpu(work_func_t func);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217extern int current_is_keventd(void);
218extern int keventd_up(void);
219
220extern void init_workqueues(void);
David Howells65f27f32006-11-22 14:55:48 +0000221int execute_in_process_context(work_func_t fn, struct execute_work *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Oleg Nesterovdb700892008-07-25 01:47:49 -0700223extern int flush_work(struct work_struct *work);
224
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700225extern int cancel_work_sync(struct work_struct *work);
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227/*
228 * Kill off a pending schedule_delayed_work(). Note that the work callback
Oleg Nesterov071b6382007-04-26 15:45:32 -0700229 * function may still be running on return from cancel_delayed_work(), unless
230 * it returns 1 and the work doesn't re-arm itself. Run flush_workqueue() or
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700231 * cancel_work_sync() to wait on it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 */
David Howells52bad642006-11-22 14:54:01 +0000233static inline int cancel_delayed_work(struct delayed_work *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234{
235 int ret;
236
Oleg Nesterov223a10a2007-05-18 00:36:42 -0700237 ret = del_timer_sync(&work->timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 if (ret)
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700239 work_clear_pending(&work->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 return ret;
241}
242
Oleg Nesterov1f1f6422007-07-15 23:41:44 -0700243extern int cancel_delayed_work_sync(struct delayed_work *work);
Oleg Nesterov1634c482007-05-09 02:34:18 -0700244
Oleg Nesterovf5a421a2007-07-15 23:41:44 -0700245/* Obsolete. use cancel_delayed_work_sync() */
Oleg Nesterov1634c482007-05-09 02:34:18 -0700246static inline
247void cancel_rearming_delayed_workqueue(struct workqueue_struct *wq,
248 struct delayed_work *work)
249{
Oleg Nesterovf5a421a2007-07-15 23:41:44 -0700250 cancel_delayed_work_sync(work);
251}
252
253/* Obsolete. use cancel_delayed_work_sync() */
254static inline
255void cancel_rearming_delayed_work(struct delayed_work *work)
256{
257 cancel_delayed_work_sync(work);
Oleg Nesterov1634c482007-05-09 02:34:18 -0700258}
259
Rusty Russell2d3854a2008-11-05 13:39:10 +1100260#ifndef CONFIG_SMP
261static inline long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
262{
263 return fn(arg);
264}
265#else
266long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg);
267#endif /* CONFIG_SMP */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268#endif