2 * workqueue.h --- work queue handling for Linux.
5 #ifndef _LINUX_WORKQUEUE_H
6 #define _LINUX_WORKQUEUE_H
8 #include <linux/timer.h>
9 #include <linux/linkage.h>
10 #include <linux/bitops.h>
11 #include <asm/atomic.h>
13 struct workqueue_struct
;
16 typedef void (*work_func_t
)(struct work_struct
*work
);
19 * The first word is the work queue pointer and the flags rolled into
22 #define work_data_bits(work) ((unsigned long *)(&(work)->data))
26 #define WORK_STRUCT_PENDING 0 /* T if work item pending execution */
27 #define WORK_STRUCT_NOAUTOREL 1 /* F if work item automatically released on exec */
28 #define WORK_STRUCT_FLAG_MASK (3UL)
29 #define WORK_STRUCT_WQ_DATA_MASK (~WORK_STRUCT_FLAG_MASK)
30 struct list_head entry
;
34 #define WORK_DATA_INIT(autorelease) \
35 ATOMIC_LONG_INIT((autorelease) << WORK_STRUCT_NOAUTOREL)
38 struct work_struct work
;
39 struct timer_list timer
;
43 struct work_struct work
;
46 #define __WORK_INITIALIZER(n, f) { \
47 .data = WORK_DATA_INIT(0), \
48 .entry = { &(n).entry, &(n).entry }, \
52 #define __WORK_INITIALIZER_NAR(n, f) { \
53 .data = WORK_DATA_INIT(1), \
54 .entry = { &(n).entry, &(n).entry }, \
58 #define __DELAYED_WORK_INITIALIZER(n, f) { \
59 .work = __WORK_INITIALIZER((n).work, (f)), \
60 .timer = TIMER_INITIALIZER(NULL, 0, 0), \
63 #define __DELAYED_WORK_INITIALIZER_NAR(n, f) { \
64 .work = __WORK_INITIALIZER_NAR((n).work, (f)), \
65 .timer = TIMER_INITIALIZER(NULL, 0, 0), \
68 #define DECLARE_WORK(n, f) \
69 struct work_struct n = __WORK_INITIALIZER(n, f)
71 #define DECLARE_WORK_NAR(n, f) \
72 struct work_struct n = __WORK_INITIALIZER_NAR(n, f)
74 #define DECLARE_DELAYED_WORK(n, f) \
75 struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f)
77 #define DECLARE_DELAYED_WORK_NAR(n, f) \
78 struct dwork_struct n = __DELAYED_WORK_INITIALIZER_NAR(n, f)
81 * initialize a work item's function pointer
83 #define PREPARE_WORK(_work, _func) \
85 (_work)->func = (_func); \
88 #define PREPARE_DELAYED_WORK(_work, _func) \
89 PREPARE_WORK(&(_work)->work, (_func))
92 * initialize all of a work item in one go
94 * NOTE! No point in using "atomic_long_set()": useing a direct
95 * assignment of the work data initializer allows the compiler
96 * to generate better code.
98 #define INIT_WORK(_work, _func) \
100 (_work)->data = (atomic_long_t) WORK_DATA_INIT(0); \
101 INIT_LIST_HEAD(&(_work)->entry); \
102 PREPARE_WORK((_work), (_func)); \
105 #define INIT_WORK_NAR(_work, _func) \
107 (_work)->data = (atomic_long_t) WORK_DATA_INIT(1); \
108 INIT_LIST_HEAD(&(_work)->entry); \
109 PREPARE_WORK((_work), (_func)); \
112 #define INIT_DELAYED_WORK(_work, _func) \
114 INIT_WORK(&(_work)->work, (_func)); \
115 init_timer(&(_work)->timer); \
118 #define INIT_DELAYED_WORK_NAR(_work, _func) \
120 INIT_WORK_NAR(&(_work)->work, (_func)); \
121 init_timer(&(_work)->timer); \
124 #define INIT_DELAYED_WORK_DEFERRABLE(_work, _func) \
126 INIT_WORK(&(_work)->work, (_func)); \
127 init_timer_deferrable(&(_work)->timer); \
131 * work_pending - Find out whether a work item is currently pending
132 * @work: The work item in question
134 #define work_pending(work) \
135 test_bit(WORK_STRUCT_PENDING, work_data_bits(work))
138 * delayed_work_pending - Find out whether a delayable work item is currently
140 * @work: The work item in question
142 #define delayed_work_pending(w) \
143 work_pending(&(w)->work)
146 * work_release - Release a work item under execution
147 * @work: The work item to release
149 * This is used to release a work item that has been initialised with automatic
150 * release mode disabled (WORK_STRUCT_NOAUTOREL is set). This gives the work
151 * function the opportunity to grab auxiliary data from the container of the
152 * work_struct before clearing the pending bit as the work_struct may be
153 * subject to deallocation the moment the pending bit is cleared.
155 * In such a case, this should be called in the work function after it has
156 * fetched any data it may require from the containter of the work_struct.
157 * After this function has been called, the work_struct may be scheduled for
158 * further execution or it may be deallocated unless other precautions are
161 * This should also be used to release a delayed work item.
163 #define work_release(work) \
164 clear_bit(WORK_STRUCT_PENDING, work_data_bits(work))
167 extern struct workqueue_struct
*__create_workqueue(const char *name
,
170 #define create_workqueue(name) __create_workqueue((name), 0, 0)
171 #define create_freezeable_workqueue(name) __create_workqueue((name), 0, 1)
172 #define create_singlethread_workqueue(name) __create_workqueue((name), 1, 0)
174 extern void destroy_workqueue(struct workqueue_struct
*wq
);
176 extern int FASTCALL(queue_work(struct workqueue_struct
*wq
, struct work_struct
*work
));
177 extern int FASTCALL(queue_delayed_work(struct workqueue_struct
*wq
, struct delayed_work
*work
, unsigned long delay
));
178 extern int queue_delayed_work_on(int cpu
, struct workqueue_struct
*wq
,
179 struct delayed_work
*work
, unsigned long delay
);
180 extern void FASTCALL(flush_workqueue(struct workqueue_struct
*wq
));
181 extern void flush_work(struct workqueue_struct
*wq
, struct work_struct
*work
);
182 extern void flush_work_keventd(struct work_struct
*work
);
184 extern int FASTCALL(schedule_work(struct work_struct
*work
));
185 extern int FASTCALL(run_scheduled_work(struct work_struct
*work
));
186 extern int FASTCALL(schedule_delayed_work(struct delayed_work
*work
, unsigned long delay
));
188 extern int schedule_delayed_work_on(int cpu
, struct delayed_work
*work
, unsigned long delay
);
189 extern int schedule_on_each_cpu(work_func_t func
);
190 extern void flush_scheduled_work(void);
191 extern int current_is_keventd(void);
192 extern int keventd_up(void);
194 extern void init_workqueues(void);
195 void cancel_rearming_delayed_work(struct delayed_work
*work
);
196 void cancel_rearming_delayed_workqueue(struct workqueue_struct
*,
197 struct delayed_work
*);
198 int execute_in_process_context(work_func_t fn
, struct execute_work
*);
201 * Kill off a pending schedule_delayed_work(). Note that the work callback
202 * function may still be running on return from cancel_delayed_work(), unless
203 * it returns 1 and the work doesn't re-arm itself. Run flush_workqueue() or
204 * flush_work() or cancel_work_sync() to wait on it.
206 static inline int cancel_delayed_work(struct delayed_work
*work
)
210 ret
= del_timer(&work
->timer
);
212 work_release(&work
->work
);