blob: ac14ecec2705539d827dbb875af8f2375203a14b [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>
Arun Sharma600634972011-07-26 16:09:06 -070013#include <linux/atomic.h>
Tejun Heo7a4e3442013-03-12 11:30:00 -070014#include <linux/cpumask.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
16struct workqueue_struct;
17
David Howells65f27f32006-11-22 14:55:48 +000018struct work_struct;
19typedef void (*work_func_t)(struct work_struct *work);
Tejun Heod8e794d2012-08-03 10:30:45 -070020void delayed_work_timer_fn(unsigned long __data);
David Howells6bb49e52006-11-22 14:54:45 +000021
Linus Torvaldsa08727b2006-12-16 09:53:50 -080022/*
23 * The first word is the work queue pointer and the flags rolled into
24 * one
25 */
26#define work_data_bits(work) ((unsigned long *)(&(work)->data))
27
Tejun Heo22df02b2010-06-29 10:07:10 +020028enum {
29 WORK_STRUCT_PENDING_BIT = 0, /* work item is pending execution */
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +020030 WORK_STRUCT_DELAYED_BIT = 1, /* work item is delayed */
Tejun Heo112202d2013-02-13 19:29:12 -080031 WORK_STRUCT_PWQ_BIT = 2, /* data points to pwq */
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +020032 WORK_STRUCT_LINKED_BIT = 3, /* next work is linked to this one */
Tejun Heo22df02b2010-06-29 10:07:10 +020033#ifdef CONFIG_DEBUG_OBJECTS_WORK
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +020034 WORK_STRUCT_STATIC_BIT = 4, /* static initializer (debugobjects) */
35 WORK_STRUCT_COLOR_SHIFT = 5, /* color for workqueue flushing */
Tejun Heo0f900042010-06-29 10:07:11 +020036#else
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +020037 WORK_STRUCT_COLOR_SHIFT = 4, /* color for workqueue flushing */
Tejun Heo22df02b2010-06-29 10:07:10 +020038#endif
39
Tejun Heo73f53c42010-06-29 10:07:11 +020040 WORK_STRUCT_COLOR_BITS = 4,
41
Tejun Heo22df02b2010-06-29 10:07:10 +020042 WORK_STRUCT_PENDING = 1 << WORK_STRUCT_PENDING_BIT,
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +020043 WORK_STRUCT_DELAYED = 1 << WORK_STRUCT_DELAYED_BIT,
Tejun Heo112202d2013-02-13 19:29:12 -080044 WORK_STRUCT_PWQ = 1 << WORK_STRUCT_PWQ_BIT,
Tejun Heoaffee4b2010-06-29 10:07:12 +020045 WORK_STRUCT_LINKED = 1 << WORK_STRUCT_LINKED_BIT,
Tejun Heo22df02b2010-06-29 10:07:10 +020046#ifdef CONFIG_DEBUG_OBJECTS_WORK
47 WORK_STRUCT_STATIC = 1 << WORK_STRUCT_STATIC_BIT,
48#else
49 WORK_STRUCT_STATIC = 0,
50#endif
51
Tejun Heo73f53c42010-06-29 10:07:11 +020052 /*
53 * The last color is no color used for works which don't
54 * participate in workqueue flushing.
55 */
56 WORK_NR_COLORS = (1 << WORK_STRUCT_COLOR_BITS) - 1,
57 WORK_NO_COLOR = WORK_NR_COLORS,
58
Tejun Heobdbc5dd2010-07-02 10:03:51 +020059 /* special cpu IDs */
Tejun Heof3421792010-07-02 10:03:51 +020060 WORK_CPU_UNBOUND = NR_CPUS,
Lai Jiangshan6be19582013-02-06 18:04:53 -080061 WORK_CPU_END = NR_CPUS + 1,
Tejun Heobdbc5dd2010-07-02 10:03:51 +020062
Tejun Heo73f53c42010-06-29 10:07:11 +020063 /*
Tejun Heo112202d2013-02-13 19:29:12 -080064 * Reserve 7 bits off of pwq pointer w/ debugobjects turned off.
65 * This makes pwqs aligned to 256 bytes and allows 15 workqueue
66 * flush colors.
Tejun Heo73f53c42010-06-29 10:07:11 +020067 */
68 WORK_STRUCT_FLAG_BITS = WORK_STRUCT_COLOR_SHIFT +
69 WORK_STRUCT_COLOR_BITS,
70
Tejun Heo112202d2013-02-13 19:29:12 -080071 /* data contains off-queue information when !WORK_STRUCT_PWQ */
Lai Jiangshan45d95502013-02-19 12:17:01 -080072 WORK_OFFQ_FLAG_BASE = WORK_STRUCT_COLOR_SHIFT,
Tejun Heobbb68df2012-08-03 10:30:46 -070073
Tejun Heod8bee0e2015-03-05 08:04:13 -050074 __WORK_OFFQ_CANCELING = WORK_OFFQ_FLAG_BASE,
75 WORK_OFFQ_CANCELING = (1 << __WORK_OFFQ_CANCELING),
Tejun Heobbb68df2012-08-03 10:30:46 -070076
Tejun Heo715b06b2013-01-24 11:01:33 -080077 /*
78 * When a work item is off queue, its high bits point to the last
Tejun Heo7c3eed52013-01-24 11:01:33 -080079 * pool it was on. Cap at 31 bits and use the highest number to
80 * indicate that no pool is associated.
Tejun Heo715b06b2013-01-24 11:01:33 -080081 */
Tejun Heobbb68df2012-08-03 10:30:46 -070082 WORK_OFFQ_FLAG_BITS = 1,
Tejun Heo7c3eed52013-01-24 11:01:33 -080083 WORK_OFFQ_POOL_SHIFT = WORK_OFFQ_FLAG_BASE + WORK_OFFQ_FLAG_BITS,
84 WORK_OFFQ_LEFT = BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT,
85 WORK_OFFQ_POOL_BITS = WORK_OFFQ_LEFT <= 31 ? WORK_OFFQ_LEFT : 31,
86 WORK_OFFQ_POOL_NONE = (1LU << WORK_OFFQ_POOL_BITS) - 1,
Tejun Heob5490072012-08-03 10:30:46 -070087
88 /* convenience constants */
Tejun Heo0f900042010-06-29 10:07:11 +020089 WORK_STRUCT_FLAG_MASK = (1UL << WORK_STRUCT_FLAG_BITS) - 1,
Tejun Heo22df02b2010-06-29 10:07:10 +020090 WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK,
Tejun Heo7c3eed52013-01-24 11:01:33 -080091 WORK_STRUCT_NO_POOL = (unsigned long)WORK_OFFQ_POOL_NONE << WORK_OFFQ_POOL_SHIFT,
Tejun Heodcd989c2010-06-29 10:07:14 +020092
93 /* bit mask for work_busy() return values */
94 WORK_BUSY_PENDING = 1 << 0,
95 WORK_BUSY_RUNNING = 1 << 1,
Tejun Heo3d1cb202013-04-30 15:27:22 -070096
97 /* maximum string length for set_worker_desc() */
98 WORKER_DESC_LEN = 24,
Tejun Heo22df02b2010-06-29 10:07:10 +020099};
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101struct work_struct {
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800102 atomic_long_t data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 struct list_head entry;
David Howells6bb49e52006-11-22 14:54:45 +0000104 work_func_t func;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700105#ifdef CONFIG_LOCKDEP
106 struct lockdep_map lockdep_map;
107#endif
David Howells52bad642006-11-22 14:54:01 +0000108};
109
Tejun Heo7c3eed52013-01-24 11:01:33 -0800110#define WORK_DATA_INIT() ATOMIC_LONG_INIT(WORK_STRUCT_NO_POOL)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200111#define WORK_DATA_STATIC_INIT() \
Tejun Heo7c3eed52013-01-24 11:01:33 -0800112 ATOMIC_LONG_INIT(WORK_STRUCT_NO_POOL | WORK_STRUCT_STATIC)
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800113
David Howells52bad642006-11-22 14:54:01 +0000114struct delayed_work {
115 struct work_struct work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 struct timer_list timer;
Lai Jiangshan60c057b2013-02-06 18:04:53 -0800117
118 /* target workqueue and CPU ->timer uses to queue ->work */
119 struct workqueue_struct *wq;
Tejun Heo12650572012-08-08 09:38:42 -0700120 int cpu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121};
122
Tejun Heo7a4e3442013-03-12 11:30:00 -0700123/*
124 * A struct for workqueue attributes. This can be used to change
125 * attributes of an unbound workqueue.
Tejun Heod55262c2013-04-01 11:23:38 -0700126 *
127 * Unlike other fields, ->no_numa isn't a property of a worker_pool. It
128 * only modifies how apply_workqueue_attrs() select pools and thus doesn't
129 * participate in pool hash calculations or equality comparisons.
Tejun Heo7a4e3442013-03-12 11:30:00 -0700130 */
131struct workqueue_attrs {
132 int nice; /* nice level */
133 cpumask_var_t cpumask; /* allowed CPUs */
Tejun Heod55262c2013-04-01 11:23:38 -0700134 bool no_numa; /* disable NUMA affinity */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700135};
136
Jean Delvarebf6aede2009-04-02 16:56:54 -0700137static inline struct delayed_work *to_delayed_work(struct work_struct *work)
138{
139 return container_of(work, struct delayed_work, work);
140}
141
James Bottomley1fa44ec2006-02-23 12:43:43 -0600142struct execute_work {
143 struct work_struct work;
144};
145
Johannes Berg4e6045f2007-10-18 23:39:55 -0700146#ifdef CONFIG_LOCKDEP
147/*
148 * NB: because we have to copy the lockdep_map, setting _key
149 * here is required, otherwise it could get initialised to the
150 * copy of the lockdep_map!
151 */
152#define __WORK_INIT_LOCKDEP_MAP(n, k) \
153 .lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k),
154#else
155#define __WORK_INIT_LOCKDEP_MAP(n, k)
156#endif
157
Tejun Heoee64e7f2012-08-21 13:18:23 -0700158#define __WORK_INITIALIZER(n, f) { \
159 .data = WORK_DATA_STATIC_INIT(), \
160 .entry = { &(n).entry, &(n).entry }, \
161 .func = (f), \
162 __WORK_INIT_LOCKDEP_MAP(#n, &(n)) \
David Howells65f27f32006-11-22 14:55:48 +0000163 }
164
Tejun Heof991b312012-08-21 13:18:23 -0700165#define __DELAYED_WORK_INITIALIZER(n, f, tflags) { \
Tejun Heoee64e7f2012-08-21 13:18:23 -0700166 .work = __WORK_INITIALIZER((n).work, (f)), \
Tejun Heof991b312012-08-21 13:18:23 -0700167 .timer = __TIMER_INITIALIZER(delayed_work_timer_fn, \
Tejun Heoe0aecdd2012-08-21 13:18:24 -0700168 0, (unsigned long)&(n), \
169 (tflags) | TIMER_IRQSAFE), \
Phil Carmodydd6414b2010-10-20 15:57:33 -0700170 }
171
Tejun Heoee64e7f2012-08-21 13:18:23 -0700172#define DECLARE_WORK(n, f) \
David Howells65f27f32006-11-22 14:55:48 +0000173 struct work_struct n = __WORK_INITIALIZER(n, f)
174
Tejun Heoee64e7f2012-08-21 13:18:23 -0700175#define DECLARE_DELAYED_WORK(n, f) \
Tejun Heof991b312012-08-21 13:18:23 -0700176 struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, 0)
David Howells65f27f32006-11-22 14:55:48 +0000177
Tejun Heo203b42f2012-08-21 13:18:23 -0700178#define DECLARE_DEFERRABLE_WORK(n, f) \
Tejun Heof991b312012-08-21 13:18:23 -0700179 struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, TIMER_DEFERRABLE)
Phil Carmodydd6414b2010-10-20 15:57:33 -0700180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181/*
David Howells65f27f32006-11-22 14:55:48 +0000182 * initialize a work item's function pointer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 */
Tejun Heoee64e7f2012-08-21 13:18:23 -0700184#define PREPARE_WORK(_work, _func) \
185 do { \
186 (_work)->func = (_func); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 } while (0)
188
Tejun Heoee64e7f2012-08-21 13:18:23 -0700189#define PREPARE_DELAYED_WORK(_work, _func) \
David Howells65f27f32006-11-22 14:55:48 +0000190 PREPARE_WORK(&(_work)->work, (_func))
David Howells52bad642006-11-22 14:54:01 +0000191
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900192#ifdef CONFIG_DEBUG_OBJECTS_WORK
193extern void __init_work(struct work_struct *work, int onstack);
194extern void destroy_work_on_stack(struct work_struct *work);
Tejun Heo4690c4a2010-06-29 10:07:10 +0200195static inline unsigned int work_static(struct work_struct *work)
196{
Tejun Heo22df02b2010-06-29 10:07:10 +0200197 return *work_data_bits(work) & WORK_STRUCT_STATIC;
Tejun Heo4690c4a2010-06-29 10:07:10 +0200198}
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900199#else
200static inline void __init_work(struct work_struct *work, int onstack) { }
201static inline void destroy_work_on_stack(struct work_struct *work) { }
Tejun Heo4690c4a2010-06-29 10:07:10 +0200202static inline unsigned int work_static(struct work_struct *work) { return 0; }
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900203#endif
204
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205/*
David Howells52bad642006-11-22 14:54:01 +0000206 * initialize all of a work item in one go
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800207 *
Dmitri Vorobievb9049df2009-06-23 12:09:29 +0200208 * NOTE! No point in using "atomic_long_set()": using a direct
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800209 * assignment of the work data initializer allows the compiler
210 * to generate better code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700212#ifdef CONFIG_LOCKDEP
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900213#define __INIT_WORK(_work, _func, _onstack) \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700214 do { \
215 static struct lock_class_key __key; \
216 \
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900217 __init_work((_work), _onstack); \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700218 (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
Tejun Heoee64e7f2012-08-21 13:18:23 -0700219 lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0); \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700220 INIT_LIST_HEAD(&(_work)->entry); \
221 PREPARE_WORK((_work), (_func)); \
222 } while (0)
223#else
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900224#define __INIT_WORK(_work, _func, _onstack) \
David Howells65f27f32006-11-22 14:55:48 +0000225 do { \
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900226 __init_work((_work), _onstack); \
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700227 (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
David Howells65f27f32006-11-22 14:55:48 +0000228 INIT_LIST_HEAD(&(_work)->entry); \
229 PREPARE_WORK((_work), (_func)); \
230 } while (0)
Johannes Berg4e6045f2007-10-18 23:39:55 -0700231#endif
David Howells65f27f32006-11-22 14:55:48 +0000232
Tejun Heoee64e7f2012-08-21 13:18:23 -0700233#define INIT_WORK(_work, _func) \
234 do { \
235 __INIT_WORK((_work), (_func), 0); \
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900236 } while (0)
237
Tejun Heoee64e7f2012-08-21 13:18:23 -0700238#define INIT_WORK_ONSTACK(_work, _func) \
239 do { \
240 __INIT_WORK((_work), (_func), 1); \
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900241 } while (0)
242
Tejun Heof991b312012-08-21 13:18:23 -0700243#define __INIT_DELAYED_WORK(_work, _func, _tflags) \
Tejun Heoee64e7f2012-08-21 13:18:23 -0700244 do { \
245 INIT_WORK(&(_work)->work, (_func)); \
Tejun Heof991b312012-08-21 13:18:23 -0700246 __setup_timer(&(_work)->timer, delayed_work_timer_fn, \
Tejun Heoe0aecdd2012-08-21 13:18:24 -0700247 (unsigned long)(_work), \
248 (_tflags) | TIMER_IRQSAFE); \
David Howells65f27f32006-11-22 14:55:48 +0000249 } while (0)
250
Tejun Heof991b312012-08-21 13:18:23 -0700251#define __INIT_DELAYED_WORK_ONSTACK(_work, _func, _tflags) \
Tejun Heoee64e7f2012-08-21 13:18:23 -0700252 do { \
253 INIT_WORK_ONSTACK(&(_work)->work, (_func)); \
Tejun Heof991b312012-08-21 13:18:23 -0700254 __setup_timer_on_stack(&(_work)->timer, \
255 delayed_work_timer_fn, \
256 (unsigned long)(_work), \
Tejun Heoe0aecdd2012-08-21 13:18:24 -0700257 (_tflags) | TIMER_IRQSAFE); \
Peter Zijlstra6d612b02009-01-12 12:52:23 +0100258 } while (0)
259
Tejun Heof991b312012-08-21 13:18:23 -0700260#define INIT_DELAYED_WORK(_work, _func) \
261 __INIT_DELAYED_WORK(_work, _func, 0)
262
263#define INIT_DELAYED_WORK_ONSTACK(_work, _func) \
264 __INIT_DELAYED_WORK_ONSTACK(_work, _func, 0)
265
Tejun Heo203b42f2012-08-21 13:18:23 -0700266#define INIT_DEFERRABLE_WORK(_work, _func) \
Tejun Heof991b312012-08-21 13:18:23 -0700267 __INIT_DELAYED_WORK(_work, _func, TIMER_DEFERRABLE)
268
269#define INIT_DEFERRABLE_WORK_ONSTACK(_work, _func) \
270 __INIT_DELAYED_WORK_ONSTACK(_work, _func, TIMER_DEFERRABLE)
Venki Pallipadi28287032007-05-08 00:27:47 -0700271
David Howells365970a2006-11-22 14:54:49 +0000272/**
273 * work_pending - Find out whether a work item is currently pending
274 * @work: The work item in question
275 */
276#define work_pending(work) \
Tejun Heo22df02b2010-06-29 10:07:10 +0200277 test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
David Howells365970a2006-11-22 14:54:49 +0000278
279/**
280 * delayed_work_pending - Find out whether a delayable work item is currently
281 * pending
282 * @work: The work item in question
283 */
Linus Torvalds02218722006-12-15 14:13:51 -0800284#define delayed_work_pending(w) \
285 work_pending(&(w)->work)
David Howells365970a2006-11-22 14:54:49 +0000286
David Howells65f27f32006-11-22 14:55:48 +0000287/**
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700288 * work_clear_pending - for internal use only, mark a work item as not pending
289 * @work: The work item in question
David Howells65f27f32006-11-22 14:55:48 +0000290 */
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700291#define work_clear_pending(work) \
Tejun Heo22df02b2010-06-29 10:07:10 +0200292 clear_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
David Howells65f27f32006-11-22 14:55:48 +0000293
Tejun Heoc54fce62010-09-10 16:51:36 +0200294/*
295 * Workqueue flags and constants. For details, please refer to
296 * Documentation/workqueue.txt.
297 */
Tejun Heo97e37d72010-06-29 10:07:10 +0200298enum {
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200299 WQ_NON_REENTRANT = 1 << 0, /* guarantee non-reentrance */
Tejun Heoc7fc77f2010-07-02 10:03:51 +0200300 WQ_UNBOUND = 1 << 1, /* not bound to any cpu */
Tejun Heo58a69cb2011-02-16 09:25:31 +0100301 WQ_FREEZABLE = 1 << 2, /* freeze during suspend */
Tejun Heo6370a6a2010-10-11 15:12:27 +0200302 WQ_MEM_RECLAIM = 1 << 3, /* may be used for memory reclaim */
Tejun Heo649027d2010-06-29 10:07:14 +0200303 WQ_HIGHPRI = 1 << 4, /* high priority */
Tejun Heofb0e7be2010-06-29 10:07:15 +0200304 WQ_CPU_INTENSIVE = 1 << 5, /* cpu instensive workqueue */
Tejun Heo226223a2013-03-12 11:30:05 -0700305 WQ_SYSFS = 1 << 6, /* visible in sysfs, see wq_sysfs_register() */
Tejun Heob71ab8c2010-06-29 10:07:14 +0200306
Viresh Kumar61a10f92013-04-08 16:45:40 +0530307 /*
308 * Per-cpu workqueues are generally preferred because they tend to
309 * show better performance thanks to cache locality. Per-cpu
310 * workqueues exclude the scheduler from choosing the CPU to
311 * execute the worker threads, which has an unfortunate side effect
312 * of increasing power consumption.
313 *
314 * The scheduler considers a CPU idle if it doesn't have any task
315 * to execute and tries to keep idle cores idle to conserve power;
316 * however, for example, a per-cpu work item scheduled from an
317 * interrupt handler on an idle CPU will force the scheduler to
318 * excute the work item on that CPU breaking the idleness, which in
319 * turn may lead to more scheduling choices which are sub-optimal
320 * in terms of power consumption.
321 *
322 * Workqueues marked with WQ_POWER_EFFICIENT are per-cpu by default
323 * but become unbound if workqueue.power_efficient kernel param is
324 * specified. Per-cpu workqueues which are identified to
325 * contribute significantly to power-consumption are identified and
326 * marked with this flag and enabling the power_efficient mode
327 * leads to noticeable power saving at the cost of small
328 * performance disadvantage.
329 *
330 * http://thread.gmane.org/gmane.linux.kernel/1480396
331 */
332 WQ_POWER_EFFICIENT = 1 << 7,
333
Tejun Heo618b01e2013-03-12 11:30:04 -0700334 __WQ_DRAINING = 1 << 16, /* internal: workqueue is draining */
Tejun Heo8719dce2013-03-12 11:30:04 -0700335 __WQ_ORDERED = 1 << 17, /* internal: workqueue is ordered */
Tejun Heoe41e7042010-08-24 14:22:47 +0200336
Tejun Heob71ab8c2010-06-29 10:07:14 +0200337 WQ_MAX_ACTIVE = 512, /* I like 512, better ideas? */
Tejun Heof3421792010-07-02 10:03:51 +0200338 WQ_MAX_UNBOUND_PER_CPU = 4, /* 4 * #cpus for unbound wq */
Tejun Heob71ab8c2010-06-29 10:07:14 +0200339 WQ_DFL_ACTIVE = WQ_MAX_ACTIVE / 2,
Tejun Heo97e37d72010-06-29 10:07:10 +0200340};
David Howells52bad642006-11-22 14:54:01 +0000341
Tejun Heof3421792010-07-02 10:03:51 +0200342/* unbound wq's aren't per-cpu, scale max_active according to #cpus */
343#define WQ_UNBOUND_MAX_ACTIVE \
344 max_t(int, WQ_MAX_ACTIVE, num_possible_cpus() * WQ_MAX_UNBOUND_PER_CPU)
345
Tejun Heod320c032010-06-29 10:07:14 +0200346/*
347 * System-wide workqueues which are always present.
348 *
349 * system_wq is the one used by schedule[_delayed]_work[_on]().
350 * Multi-CPU multi-threaded. There are users which expect relatively
351 * short queue flush time. Don't queue works which can run for too
352 * long.
353 *
354 * system_long_wq is similar to system_wq but may host long running
355 * works. Queue flushing might take relatively long.
356 *
Tejun Heof3421792010-07-02 10:03:51 +0200357 * system_unbound_wq is unbound workqueue. Workers are not bound to
358 * any specific CPU, not concurrency managed, and all queued works are
359 * executed immediately as long as max_active limit is not reached and
360 * resources are available.
Tejun Heo4149efb2011-02-08 10:39:03 +0100361 *
Tejun Heo24d51ad2011-02-21 09:52:50 +0100362 * system_freezable_wq is equivalent to system_wq except that it's
363 * freezable.
Viresh Kumar7399c442013-04-24 17:12:54 +0530364 *
365 * *_power_efficient_wq are inclined towards saving power and converted
366 * into WQ_UNBOUND variants if 'wq_power_efficient' is enabled; otherwise,
367 * they are same as their non-power-efficient counterparts - e.g.
368 * system_power_efficient_wq is identical to system_wq if
369 * 'wq_power_efficient' is disabled. See WQ_POWER_EFFICIENT for more info.
Tejun Heod320c032010-06-29 10:07:14 +0200370 */
371extern struct workqueue_struct *system_wq;
372extern struct workqueue_struct *system_long_wq;
Tejun Heof3421792010-07-02 10:03:51 +0200373extern struct workqueue_struct *system_unbound_wq;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100374extern struct workqueue_struct *system_freezable_wq;
Viresh Kumar7399c442013-04-24 17:12:54 +0530375extern struct workqueue_struct *system_power_efficient_wq;
376extern struct workqueue_struct *system_freezable_power_efficient_wq;
Tejun Heoae930e02012-08-20 14:51:23 -0700377
Tejun Heo3b07e9c2012-08-20 14:51:24 -0700378static inline struct workqueue_struct * __deprecated __system_nrt_wq(void)
Tejun Heoae930e02012-08-20 14:51:23 -0700379{
380 return system_wq;
381}
382
Tejun Heo3b07e9c2012-08-20 14:51:24 -0700383static inline struct workqueue_struct * __deprecated __system_nrt_freezable_wq(void)
Tejun Heoae930e02012-08-20 14:51:23 -0700384{
385 return system_freezable_wq;
386}
387
388/* equivlalent to system_wq and system_freezable_wq, deprecated */
389#define system_nrt_wq __system_nrt_wq()
390#define system_nrt_freezable_wq __system_nrt_freezable_wq()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
Johannes Berg4e6045f2007-10-18 23:39:55 -0700392extern struct workqueue_struct *
Tejun Heob196be82012-01-10 15:11:35 -0800393__alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active,
394 struct lock_class_key *key, const char *lock_name, ...) __printf(1, 6);
Johannes Berg4e6045f2007-10-18 23:39:55 -0700395
Tejun Heob196be82012-01-10 15:11:35 -0800396/**
397 * alloc_workqueue - allocate a workqueue
398 * @fmt: printf format for the name of the workqueue
399 * @flags: WQ_* flags
400 * @max_active: max in-flight work items, 0 for default
401 * @args: args for @fmt
402 *
403 * Allocate a workqueue with the specified parameters. For detailed
404 * information on WQ_* flags, please refer to Documentation/workqueue.txt.
405 *
406 * The __lock_name macro dance is to guarantee that single lock_class_key
407 * doesn't end up with different namesm, which isn't allowed by lockdep.
408 *
409 * RETURNS:
410 * Pointer to the allocated workqueue on success, %NULL on failure.
411 */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700412#ifdef CONFIG_LOCKDEP
Tejun Heoee64e7f2012-08-21 13:18:23 -0700413#define alloc_workqueue(fmt, flags, max_active, args...) \
414({ \
415 static struct lock_class_key __key; \
416 const char *__lock_name; \
417 \
418 if (__builtin_constant_p(fmt)) \
419 __lock_name = (fmt); \
420 else \
421 __lock_name = #fmt; \
422 \
423 __alloc_workqueue_key((fmt), (flags), (max_active), \
424 &__key, __lock_name, ##args); \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700425})
426#else
Tejun Heoee64e7f2012-08-21 13:18:23 -0700427#define alloc_workqueue(fmt, flags, max_active, args...) \
428 __alloc_workqueue_key((fmt), (flags), (max_active), \
Tejun Heob196be82012-01-10 15:11:35 -0800429 NULL, NULL, ##args)
Johannes Berg4e6045f2007-10-18 23:39:55 -0700430#endif
431
Tejun Heo81dcaf62010-09-16 10:17:35 +0200432/**
433 * alloc_ordered_workqueue - allocate an ordered workqueue
Tejun Heob196be82012-01-10 15:11:35 -0800434 * @fmt: printf format for the name of the workqueue
Tejun Heo58a69cb2011-02-16 09:25:31 +0100435 * @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful)
Tejun Heob196be82012-01-10 15:11:35 -0800436 * @args: args for @fmt
Tejun Heo81dcaf62010-09-16 10:17:35 +0200437 *
438 * Allocate an ordered workqueue. An ordered workqueue executes at
439 * most one work item at any given time in the queued order. They are
440 * implemented as unbound workqueues with @max_active of one.
441 *
442 * RETURNS:
443 * Pointer to the allocated workqueue on success, %NULL on failure.
444 */
Tejun Heoee64e7f2012-08-21 13:18:23 -0700445#define alloc_ordered_workqueue(fmt, flags, args...) \
Tejun Heo8719dce2013-03-12 11:30:04 -0700446 alloc_workqueue(fmt, WQ_UNBOUND | __WQ_ORDERED | (flags), 1, ##args)
Tejun Heo81dcaf62010-09-16 10:17:35 +0200447
Tejun Heoee64e7f2012-08-21 13:18:23 -0700448#define create_workqueue(name) \
Tejun Heo6370a6a2010-10-11 15:12:27 +0200449 alloc_workqueue((name), WQ_MEM_RECLAIM, 1)
Tejun Heoee64e7f2012-08-21 13:18:23 -0700450#define create_freezable_workqueue(name) \
Tejun Heo58a69cb2011-02-16 09:25:31 +0100451 alloc_workqueue((name), WQ_FREEZABLE | WQ_UNBOUND | WQ_MEM_RECLAIM, 1)
Tejun Heoee64e7f2012-08-21 13:18:23 -0700452#define create_singlethread_workqueue(name) \
Tejun Heo54560882014-09-13 04:14:30 +0900453 alloc_ordered_workqueue("%s", WQ_MEM_RECLAIM, name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
455extern void destroy_workqueue(struct workqueue_struct *wq);
456
Tejun Heo7a4e3442013-03-12 11:30:00 -0700457struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask);
458void free_workqueue_attrs(struct workqueue_attrs *attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -0700459int apply_workqueue_attrs(struct workqueue_struct *wq,
460 const struct workqueue_attrs *attrs);
Tejun Heo7a4e3442013-03-12 11:30:00 -0700461
Tejun Heod4283e92012-08-03 10:30:44 -0700462extern bool queue_work_on(int cpu, struct workqueue_struct *wq,
Zhang Ruic1a220e2008-07-23 21:28:39 -0700463 struct work_struct *work);
Tejun Heod4283e92012-08-03 10:30:44 -0700464extern bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700465 struct delayed_work *work, unsigned long delay);
Tejun Heo8376fe22012-08-03 10:30:47 -0700466extern bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
467 struct delayed_work *dwork, unsigned long delay);
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700468
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800469extern void flush_workqueue(struct workqueue_struct *wq);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200470extern void drain_workqueue(struct workqueue_struct *wq);
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700471extern void flush_scheduled_work(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
David Howells65f27f32006-11-22 14:55:48 +0000473extern int schedule_on_each_cpu(work_func_t func);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
David Howells65f27f32006-11-22 14:55:48 +0000475int execute_in_process_context(work_func_t fn, struct execute_work *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476
Tejun Heo401a8d02010-09-16 10:36:00 +0200477extern bool flush_work(struct work_struct *work);
478extern bool cancel_work_sync(struct work_struct *work);
479
480extern bool flush_delayed_work(struct delayed_work *dwork);
Tejun Heo57b30ae2012-08-21 13:18:24 -0700481extern bool cancel_delayed_work(struct delayed_work *dwork);
Tejun Heo401a8d02010-09-16 10:36:00 +0200482extern bool cancel_delayed_work_sync(struct delayed_work *dwork);
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700483
Tejun Heodcd989c2010-06-29 10:07:14 +0200484extern void workqueue_set_max_active(struct workqueue_struct *wq,
485 int max_active);
Tejun Heoe62676162013-03-12 17:41:37 -0700486extern bool current_is_workqueue_rescuer(void);
Tejun Heod84ff052013-03-12 11:29:59 -0700487extern bool workqueue_congested(int cpu, struct workqueue_struct *wq);
Tejun Heodcd989c2010-06-29 10:07:14 +0200488extern unsigned int work_busy(struct work_struct *work);
Tejun Heo3d1cb202013-04-30 15:27:22 -0700489extern __printf(1, 2) void set_worker_desc(const char *fmt, ...);
490extern void print_worker_info(const char *log_lvl, struct task_struct *task);
Tejun Heodcd989c2010-06-29 10:07:14 +0200491
Tejun Heo8425e3d52013-03-13 16:51:36 -0700492/**
493 * queue_work - queue work on a workqueue
494 * @wq: workqueue to use
495 * @work: work to queue
496 *
497 * Returns %false if @work was already on a queue, %true otherwise.
498 *
499 * We queue the work to the CPU on which it was submitted, but if the CPU dies
500 * it can be processed by another CPU.
501 */
502static inline bool queue_work(struct workqueue_struct *wq,
503 struct work_struct *work)
504{
505 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
506}
507
508/**
509 * queue_delayed_work - queue work on a workqueue after delay
510 * @wq: workqueue to use
511 * @dwork: delayable work to queue
512 * @delay: number of jiffies to wait before queueing
513 *
514 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
515 */
516static inline bool queue_delayed_work(struct workqueue_struct *wq,
517 struct delayed_work *dwork,
518 unsigned long delay)
519{
520 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
521}
522
523/**
524 * mod_delayed_work - modify delay of or queue a delayed work
525 * @wq: workqueue to use
526 * @dwork: work to queue
527 * @delay: number of jiffies to wait before queueing
528 *
529 * mod_delayed_work_on() on local CPU.
530 */
531static inline bool mod_delayed_work(struct workqueue_struct *wq,
532 struct delayed_work *dwork,
533 unsigned long delay)
534{
535 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
536}
537
538/**
539 * schedule_work_on - put work task on a specific cpu
540 * @cpu: cpu to put the work task on
541 * @work: job to be done
542 *
543 * This puts a job on a specific cpu
544 */
545static inline bool schedule_work_on(int cpu, struct work_struct *work)
546{
547 return queue_work_on(cpu, system_wq, work);
548}
549
550/**
551 * schedule_work - put work task in global workqueue
552 * @work: job to be done
553 *
554 * Returns %false if @work was already on the kernel-global workqueue and
555 * %true otherwise.
556 *
557 * This puts a job in the kernel-global workqueue if it was not already
558 * queued and leaves it in the same position on the kernel-global
559 * workqueue otherwise.
560 */
561static inline bool schedule_work(struct work_struct *work)
562{
563 return queue_work(system_wq, work);
564}
565
566/**
567 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
568 * @cpu: cpu to use
569 * @dwork: job to be done
570 * @delay: number of jiffies to wait
571 *
572 * After waiting for a given time this puts a job in the kernel-global
573 * workqueue on the specified CPU.
574 */
575static inline bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
576 unsigned long delay)
577{
578 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
579}
580
581/**
582 * schedule_delayed_work - put work task in global workqueue after delay
583 * @dwork: job to be done
584 * @delay: number of jiffies to wait or 0 for immediate execution
585 *
586 * After waiting for a given time this puts a job in the kernel-global
587 * workqueue.
588 */
589static inline bool schedule_delayed_work(struct delayed_work *dwork,
590 unsigned long delay)
591{
592 return queue_delayed_work(system_wq, dwork, delay);
593}
594
595/**
596 * keventd_up - is workqueue initialized yet?
597 */
598static inline bool keventd_up(void)
599{
600 return system_wq != NULL;
601}
602
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603/*
Oleg Nesterov4e496272009-09-05 11:17:06 -0700604 * Like above, but uses del_timer() instead of del_timer_sync(). This means,
605 * if it returns 0 the timer function may be running and the queueing is in
606 * progress.
607 */
Tejun Heo136b5722012-08-21 13:18:24 -0700608static inline bool __deprecated __cancel_delayed_work(struct delayed_work *work)
Oleg Nesterov4e496272009-09-05 11:17:06 -0700609{
Tejun Heo401a8d02010-09-16 10:36:00 +0200610 bool ret;
Oleg Nesterov4e496272009-09-05 11:17:06 -0700611
612 ret = del_timer(&work->timer);
613 if (ret)
614 work_clear_pending(&work->work);
615 return ret;
616}
617
Tejun Heo606a5022012-08-20 14:51:23 -0700618/* used to be different but now identical to flush_work(), deprecated */
Tejun Heo43829732012-08-20 14:51:24 -0700619static inline bool __deprecated flush_work_sync(struct work_struct *work)
Tejun Heo606a5022012-08-20 14:51:23 -0700620{
621 return flush_work(work);
622}
623
624/* used to be different but now identical to flush_delayed_work(), deprecated */
Tejun Heo43829732012-08-20 14:51:24 -0700625static inline bool __deprecated flush_delayed_work_sync(struct delayed_work *dwork)
Tejun Heo606a5022012-08-20 14:51:23 -0700626{
627 return flush_delayed_work(dwork);
628}
629
Rusty Russell2d3854a2008-11-05 13:39:10 +1100630#ifndef CONFIG_SMP
Tejun Heod84ff052013-03-12 11:29:59 -0700631static inline long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +1100632{
633 return fn(arg);
634}
635#else
Tejun Heod84ff052013-03-12 11:29:59 -0700636long work_on_cpu(int cpu, long (*fn)(void *), void *arg);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100637#endif /* CONFIG_SMP */
Paul E. McKenneya25909a2010-05-13 12:32:28 -0700638
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200639#ifdef CONFIG_FREEZER
640extern void freeze_workqueues_begin(void);
641extern bool freeze_workqueues_busy(void);
642extern void thaw_workqueues(void);
643#endif /* CONFIG_FREEZER */
644
Tejun Heo226223a2013-03-12 11:30:05 -0700645#ifdef CONFIG_SYSFS
646int workqueue_sysfs_register(struct workqueue_struct *wq);
647#else /* CONFIG_SYSFS */
648static inline int workqueue_sysfs_register(struct workqueue_struct *wq)
649{ return 0; }
650#endif /* CONFIG_SYSFS */
651
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652#endif