blob: abdbe5af119d93aa7c9ccab49dc848a29eb84eea [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
74 WORK_OFFQ_CANCELING = (1 << WORK_OFFQ_FLAG_BASE),
75
Tejun Heo715b06b2013-01-24 11:01:33 -080076 /*
77 * When a work item is off queue, its high bits point to the last
Tejun Heo7c3eed52013-01-24 11:01:33 -080078 * pool it was on. Cap at 31 bits and use the highest number to
79 * indicate that no pool is associated.
Tejun Heo715b06b2013-01-24 11:01:33 -080080 */
Tejun Heobbb68df2012-08-03 10:30:46 -070081 WORK_OFFQ_FLAG_BITS = 1,
Tejun Heo7c3eed52013-01-24 11:01:33 -080082 WORK_OFFQ_POOL_SHIFT = WORK_OFFQ_FLAG_BASE + WORK_OFFQ_FLAG_BITS,
83 WORK_OFFQ_LEFT = BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT,
84 WORK_OFFQ_POOL_BITS = WORK_OFFQ_LEFT <= 31 ? WORK_OFFQ_LEFT : 31,
85 WORK_OFFQ_POOL_NONE = (1LU << WORK_OFFQ_POOL_BITS) - 1,
Tejun Heob5490072012-08-03 10:30:46 -070086
87 /* convenience constants */
Tejun Heo0f900042010-06-29 10:07:11 +020088 WORK_STRUCT_FLAG_MASK = (1UL << WORK_STRUCT_FLAG_BITS) - 1,
Tejun Heo22df02b2010-06-29 10:07:10 +020089 WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK,
Tejun Heo7c3eed52013-01-24 11:01:33 -080090 WORK_STRUCT_NO_POOL = (unsigned long)WORK_OFFQ_POOL_NONE << WORK_OFFQ_POOL_SHIFT,
Tejun Heodcd989c2010-06-29 10:07:14 +020091
92 /* bit mask for work_busy() return values */
93 WORK_BUSY_PENDING = 1 << 0,
94 WORK_BUSY_RUNNING = 1 << 1,
Tejun Heo3d1cb202013-04-30 15:27:22 -070095
96 /* maximum string length for set_worker_desc() */
97 WORKER_DESC_LEN = 24,
Tejun Heo22df02b2010-06-29 10:07:10 +020098};
99
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100struct work_struct {
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800101 atomic_long_t data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 struct list_head entry;
David Howells6bb49e52006-11-22 14:54:45 +0000103 work_func_t func;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700104#ifdef CONFIG_LOCKDEP
105 struct lockdep_map lockdep_map;
106#endif
David Howells52bad642006-11-22 14:54:01 +0000107};
108
Tejun Heo7c3eed52013-01-24 11:01:33 -0800109#define WORK_DATA_INIT() ATOMIC_LONG_INIT(WORK_STRUCT_NO_POOL)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200110#define WORK_DATA_STATIC_INIT() \
Tejun Heo7c3eed52013-01-24 11:01:33 -0800111 ATOMIC_LONG_INIT(WORK_STRUCT_NO_POOL | WORK_STRUCT_STATIC)
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800112
David Howells52bad642006-11-22 14:54:01 +0000113struct delayed_work {
114 struct work_struct work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 struct timer_list timer;
Lai Jiangshan60c057b2013-02-06 18:04:53 -0800116
117 /* target workqueue and CPU ->timer uses to queue ->work */
118 struct workqueue_struct *wq;
Tejun Heo12650572012-08-08 09:38:42 -0700119 int cpu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120};
121
Tejun Heo7a4e3442013-03-12 11:30:00 -0700122/*
123 * A struct for workqueue attributes. This can be used to change
124 * attributes of an unbound workqueue.
Tejun Heod55262c2013-04-01 11:23:38 -0700125 *
126 * Unlike other fields, ->no_numa isn't a property of a worker_pool. It
127 * only modifies how apply_workqueue_attrs() select pools and thus doesn't
128 * participate in pool hash calculations or equality comparisons.
Tejun Heo7a4e3442013-03-12 11:30:00 -0700129 */
130struct workqueue_attrs {
131 int nice; /* nice level */
132 cpumask_var_t cpumask; /* allowed CPUs */
Tejun Heod55262c2013-04-01 11:23:38 -0700133 bool no_numa; /* disable NUMA affinity */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700134};
135
Jean Delvarebf6aede2009-04-02 16:56:54 -0700136static inline struct delayed_work *to_delayed_work(struct work_struct *work)
137{
138 return container_of(work, struct delayed_work, work);
139}
140
James Bottomley1fa44ec2006-02-23 12:43:43 -0600141struct execute_work {
142 struct work_struct work;
143};
144
Johannes Berg4e6045f2007-10-18 23:39:55 -0700145#ifdef CONFIG_LOCKDEP
146/*
147 * NB: because we have to copy the lockdep_map, setting _key
148 * here is required, otherwise it could get initialised to the
149 * copy of the lockdep_map!
150 */
151#define __WORK_INIT_LOCKDEP_MAP(n, k) \
152 .lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k),
153#else
154#define __WORK_INIT_LOCKDEP_MAP(n, k)
155#endif
156
Tejun Heoee64e7f2012-08-21 13:18:23 -0700157#define __WORK_INITIALIZER(n, f) { \
158 .data = WORK_DATA_STATIC_INIT(), \
159 .entry = { &(n).entry, &(n).entry }, \
160 .func = (f), \
161 __WORK_INIT_LOCKDEP_MAP(#n, &(n)) \
David Howells65f27f32006-11-22 14:55:48 +0000162 }
163
Tejun Heof991b312012-08-21 13:18:23 -0700164#define __DELAYED_WORK_INITIALIZER(n, f, tflags) { \
Tejun Heoee64e7f2012-08-21 13:18:23 -0700165 .work = __WORK_INITIALIZER((n).work, (f)), \
Tejun Heof991b312012-08-21 13:18:23 -0700166 .timer = __TIMER_INITIALIZER(delayed_work_timer_fn, \
Tejun Heoe0aecdd2012-08-21 13:18:24 -0700167 0, (unsigned long)&(n), \
168 (tflags) | TIMER_IRQSAFE), \
Phil Carmodydd6414b2010-10-20 15:57:33 -0700169 }
170
Tejun Heoee64e7f2012-08-21 13:18:23 -0700171#define DECLARE_WORK(n, f) \
David Howells65f27f32006-11-22 14:55:48 +0000172 struct work_struct n = __WORK_INITIALIZER(n, f)
173
Tejun Heoee64e7f2012-08-21 13:18:23 -0700174#define DECLARE_DELAYED_WORK(n, f) \
Tejun Heof991b312012-08-21 13:18:23 -0700175 struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, 0)
David Howells65f27f32006-11-22 14:55:48 +0000176
Tejun Heo203b42f2012-08-21 13:18:23 -0700177#define DECLARE_DEFERRABLE_WORK(n, f) \
Tejun Heof991b312012-08-21 13:18:23 -0700178 struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, TIMER_DEFERRABLE)
Phil Carmodydd6414b2010-10-20 15:57:33 -0700179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180/*
David Howells65f27f32006-11-22 14:55:48 +0000181 * initialize a work item's function pointer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 */
Tejun Heoee64e7f2012-08-21 13:18:23 -0700183#define PREPARE_WORK(_work, _func) \
184 do { \
185 (_work)->func = (_func); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 } while (0)
187
Tejun Heoee64e7f2012-08-21 13:18:23 -0700188#define PREPARE_DELAYED_WORK(_work, _func) \
David Howells65f27f32006-11-22 14:55:48 +0000189 PREPARE_WORK(&(_work)->work, (_func))
David Howells52bad642006-11-22 14:54:01 +0000190
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900191#ifdef CONFIG_DEBUG_OBJECTS_WORK
192extern void __init_work(struct work_struct *work, int onstack);
193extern void destroy_work_on_stack(struct work_struct *work);
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000194extern void destroy_delayed_work_on_stack(struct delayed_work *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) { }
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000202static inline void destroy_delayed_work_on_stack(struct delayed_work *work) { }
Tejun Heo4690c4a2010-06-29 10:07:10 +0200203static inline unsigned int work_static(struct work_struct *work) { return 0; }
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900204#endif
205
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206/*
David Howells52bad642006-11-22 14:54:01 +0000207 * initialize all of a work item in one go
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800208 *
Dmitri Vorobievb9049df2009-06-23 12:09:29 +0200209 * NOTE! No point in using "atomic_long_set()": using a direct
Linus Torvaldsa08727b2006-12-16 09:53:50 -0800210 * assignment of the work data initializer allows the compiler
211 * to generate better code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700213#ifdef CONFIG_LOCKDEP
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900214#define __INIT_WORK(_work, _func, _onstack) \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700215 do { \
216 static struct lock_class_key __key; \
217 \
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900218 __init_work((_work), _onstack); \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700219 (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
Tejun Heoee64e7f2012-08-21 13:18:23 -0700220 lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0); \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700221 INIT_LIST_HEAD(&(_work)->entry); \
222 PREPARE_WORK((_work), (_func)); \
223 } while (0)
224#else
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900225#define __INIT_WORK(_work, _func, _onstack) \
David Howells65f27f32006-11-22 14:55:48 +0000226 do { \
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900227 __init_work((_work), _onstack); \
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700228 (_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
David Howells65f27f32006-11-22 14:55:48 +0000229 INIT_LIST_HEAD(&(_work)->entry); \
230 PREPARE_WORK((_work), (_func)); \
231 } while (0)
Johannes Berg4e6045f2007-10-18 23:39:55 -0700232#endif
David Howells65f27f32006-11-22 14:55:48 +0000233
Tejun Heoee64e7f2012-08-21 13:18:23 -0700234#define INIT_WORK(_work, _func) \
235 do { \
236 __INIT_WORK((_work), (_func), 0); \
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900237 } while (0)
238
Tejun Heoee64e7f2012-08-21 13:18:23 -0700239#define INIT_WORK_ONSTACK(_work, _func) \
240 do { \
241 __INIT_WORK((_work), (_func), 1); \
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900242 } while (0)
243
Tejun Heof991b312012-08-21 13:18:23 -0700244#define __INIT_DELAYED_WORK(_work, _func, _tflags) \
Tejun Heoee64e7f2012-08-21 13:18:23 -0700245 do { \
246 INIT_WORK(&(_work)->work, (_func)); \
Tejun Heof991b312012-08-21 13:18:23 -0700247 __setup_timer(&(_work)->timer, delayed_work_timer_fn, \
Tejun Heoe0aecdd2012-08-21 13:18:24 -0700248 (unsigned long)(_work), \
249 (_tflags) | TIMER_IRQSAFE); \
David Howells65f27f32006-11-22 14:55:48 +0000250 } while (0)
251
Tejun Heof991b312012-08-21 13:18:23 -0700252#define __INIT_DELAYED_WORK_ONSTACK(_work, _func, _tflags) \
Tejun Heoee64e7f2012-08-21 13:18:23 -0700253 do { \
254 INIT_WORK_ONSTACK(&(_work)->work, (_func)); \
Tejun Heof991b312012-08-21 13:18:23 -0700255 __setup_timer_on_stack(&(_work)->timer, \
256 delayed_work_timer_fn, \
257 (unsigned long)(_work), \
Tejun Heoe0aecdd2012-08-21 13:18:24 -0700258 (_tflags) | TIMER_IRQSAFE); \
Peter Zijlstra6d612b02009-01-12 12:52:23 +0100259 } while (0)
260
Tejun Heof991b312012-08-21 13:18:23 -0700261#define INIT_DELAYED_WORK(_work, _func) \
262 __INIT_DELAYED_WORK(_work, _func, 0)
263
264#define INIT_DELAYED_WORK_ONSTACK(_work, _func) \
265 __INIT_DELAYED_WORK_ONSTACK(_work, _func, 0)
266
Tejun Heo203b42f2012-08-21 13:18:23 -0700267#define INIT_DEFERRABLE_WORK(_work, _func) \
Tejun Heof991b312012-08-21 13:18:23 -0700268 __INIT_DELAYED_WORK(_work, _func, TIMER_DEFERRABLE)
269
270#define INIT_DEFERRABLE_WORK_ONSTACK(_work, _func) \
271 __INIT_DELAYED_WORK_ONSTACK(_work, _func, TIMER_DEFERRABLE)
Venki Pallipadi28287032007-05-08 00:27:47 -0700272
David Howells365970a2006-11-22 14:54:49 +0000273/**
274 * work_pending - Find out whether a work item is currently pending
275 * @work: The work item in question
276 */
277#define work_pending(work) \
Tejun Heo22df02b2010-06-29 10:07:10 +0200278 test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
David Howells365970a2006-11-22 14:54:49 +0000279
280/**
281 * delayed_work_pending - Find out whether a delayable work item is currently
282 * pending
283 * @work: The work item in question
284 */
Linus Torvalds02218722006-12-15 14:13:51 -0800285#define delayed_work_pending(w) \
286 work_pending(&(w)->work)
David Howells365970a2006-11-22 14:54:49 +0000287
David Howells65f27f32006-11-22 14:55:48 +0000288/**
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700289 * work_clear_pending - for internal use only, mark a work item as not pending
290 * @work: The work item in question
David Howells65f27f32006-11-22 14:55:48 +0000291 */
Oleg Nesterov23b2e592007-05-09 02:34:19 -0700292#define work_clear_pending(work) \
Tejun Heo22df02b2010-06-29 10:07:10 +0200293 clear_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
David Howells65f27f32006-11-22 14:55:48 +0000294
Tejun Heoc54fce62010-09-10 16:51:36 +0200295/*
296 * Workqueue flags and constants. For details, please refer to
297 * Documentation/workqueue.txt.
298 */
Tejun Heo97e37d72010-06-29 10:07:10 +0200299enum {
Tejun Heo12076372013-07-30 08:30:16 -0400300 /*
301 * All wqs are now non-reentrant making the following flag
302 * meaningless. Will be removed.
303 */
304 WQ_NON_REENTRANT = 1 << 0, /* DEPRECATED */
305
Tejun Heoc7fc77f2010-07-02 10:03:51 +0200306 WQ_UNBOUND = 1 << 1, /* not bound to any cpu */
Tejun Heo58a69cb2011-02-16 09:25:31 +0100307 WQ_FREEZABLE = 1 << 2, /* freeze during suspend */
Tejun Heo6370a6a2010-10-11 15:12:27 +0200308 WQ_MEM_RECLAIM = 1 << 3, /* may be used for memory reclaim */
Tejun Heo649027d2010-06-29 10:07:14 +0200309 WQ_HIGHPRI = 1 << 4, /* high priority */
Tejun Heofb0e7be2010-06-29 10:07:15 +0200310 WQ_CPU_INTENSIVE = 1 << 5, /* cpu instensive workqueue */
Tejun Heo226223a2013-03-12 11:30:05 -0700311 WQ_SYSFS = 1 << 6, /* visible in sysfs, see wq_sysfs_register() */
Tejun Heob71ab8c2010-06-29 10:07:14 +0200312
Viresh Kumarcee22a12013-04-08 16:45:40 +0530313 /*
314 * Per-cpu workqueues are generally preferred because they tend to
315 * show better performance thanks to cache locality. Per-cpu
316 * workqueues exclude the scheduler from choosing the CPU to
317 * execute the worker threads, which has an unfortunate side effect
318 * of increasing power consumption.
319 *
320 * The scheduler considers a CPU idle if it doesn't have any task
321 * to execute and tries to keep idle cores idle to conserve power;
322 * however, for example, a per-cpu work item scheduled from an
323 * interrupt handler on an idle CPU will force the scheduler to
324 * excute the work item on that CPU breaking the idleness, which in
325 * turn may lead to more scheduling choices which are sub-optimal
326 * in terms of power consumption.
327 *
328 * Workqueues marked with WQ_POWER_EFFICIENT are per-cpu by default
329 * but become unbound if workqueue.power_efficient kernel param is
330 * specified. Per-cpu workqueues which are identified to
331 * contribute significantly to power-consumption are identified and
332 * marked with this flag and enabling the power_efficient mode
333 * leads to noticeable power saving at the cost of small
334 * performance disadvantage.
335 *
336 * http://thread.gmane.org/gmane.linux.kernel/1480396
337 */
338 WQ_POWER_EFFICIENT = 1 << 7,
339
Tejun Heo618b01e2013-03-12 11:30:04 -0700340 __WQ_DRAINING = 1 << 16, /* internal: workqueue is draining */
Tejun Heo8719dce2013-03-12 11:30:04 -0700341 __WQ_ORDERED = 1 << 17, /* internal: workqueue is ordered */
Tejun Heoe41e7042010-08-24 14:22:47 +0200342
Tejun Heob71ab8c2010-06-29 10:07:14 +0200343 WQ_MAX_ACTIVE = 512, /* I like 512, better ideas? */
Tejun Heof3421792010-07-02 10:03:51 +0200344 WQ_MAX_UNBOUND_PER_CPU = 4, /* 4 * #cpus for unbound wq */
Tejun Heob71ab8c2010-06-29 10:07:14 +0200345 WQ_DFL_ACTIVE = WQ_MAX_ACTIVE / 2,
Tejun Heo97e37d72010-06-29 10:07:10 +0200346};
David Howells52bad642006-11-22 14:54:01 +0000347
Tejun Heof3421792010-07-02 10:03:51 +0200348/* unbound wq's aren't per-cpu, scale max_active according to #cpus */
349#define WQ_UNBOUND_MAX_ACTIVE \
350 max_t(int, WQ_MAX_ACTIVE, num_possible_cpus() * WQ_MAX_UNBOUND_PER_CPU)
351
Tejun Heod320c032010-06-29 10:07:14 +0200352/*
353 * System-wide workqueues which are always present.
354 *
355 * system_wq is the one used by schedule[_delayed]_work[_on]().
356 * Multi-CPU multi-threaded. There are users which expect relatively
357 * short queue flush time. Don't queue works which can run for too
358 * long.
359 *
360 * system_long_wq is similar to system_wq but may host long running
361 * works. Queue flushing might take relatively long.
362 *
Tejun Heof3421792010-07-02 10:03:51 +0200363 * system_unbound_wq is unbound workqueue. Workers are not bound to
364 * any specific CPU, not concurrency managed, and all queued works are
365 * executed immediately as long as max_active limit is not reached and
366 * resources are available.
Tejun Heo4149efb2011-02-08 10:39:03 +0100367 *
Tejun Heo24d51ad2011-02-21 09:52:50 +0100368 * system_freezable_wq is equivalent to system_wq except that it's
369 * freezable.
Viresh Kumar06681062013-04-24 17:12:54 +0530370 *
371 * *_power_efficient_wq are inclined towards saving power and converted
372 * into WQ_UNBOUND variants if 'wq_power_efficient' is enabled; otherwise,
373 * they are same as their non-power-efficient counterparts - e.g.
374 * system_power_efficient_wq is identical to system_wq if
375 * 'wq_power_efficient' is disabled. See WQ_POWER_EFFICIENT for more info.
Tejun Heod320c032010-06-29 10:07:14 +0200376 */
377extern struct workqueue_struct *system_wq;
378extern struct workqueue_struct *system_long_wq;
Tejun Heof3421792010-07-02 10:03:51 +0200379extern struct workqueue_struct *system_unbound_wq;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100380extern struct workqueue_struct *system_freezable_wq;
Viresh Kumar06681062013-04-24 17:12:54 +0530381extern struct workqueue_struct *system_power_efficient_wq;
382extern struct workqueue_struct *system_freezable_power_efficient_wq;
Tejun Heoae930e02012-08-20 14:51:23 -0700383
Tejun Heo3b07e9c2012-08-20 14:51:24 -0700384static inline struct workqueue_struct * __deprecated __system_nrt_wq(void)
Tejun Heoae930e02012-08-20 14:51:23 -0700385{
386 return system_wq;
387}
388
Tejun Heo3b07e9c2012-08-20 14:51:24 -0700389static inline struct workqueue_struct * __deprecated __system_nrt_freezable_wq(void)
Tejun Heoae930e02012-08-20 14:51:23 -0700390{
391 return system_freezable_wq;
392}
393
394/* equivlalent to system_wq and system_freezable_wq, deprecated */
395#define system_nrt_wq __system_nrt_wq()
396#define system_nrt_freezable_wq __system_nrt_freezable_wq()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
Johannes Berg4e6045f2007-10-18 23:39:55 -0700398extern struct workqueue_struct *
Tejun Heob196be82012-01-10 15:11:35 -0800399__alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active,
400 struct lock_class_key *key, const char *lock_name, ...) __printf(1, 6);
Johannes Berg4e6045f2007-10-18 23:39:55 -0700401
Tejun Heob196be82012-01-10 15:11:35 -0800402/**
403 * alloc_workqueue - allocate a workqueue
404 * @fmt: printf format for the name of the workqueue
405 * @flags: WQ_* flags
406 * @max_active: max in-flight work items, 0 for default
407 * @args: args for @fmt
408 *
409 * Allocate a workqueue with the specified parameters. For detailed
410 * information on WQ_* flags, please refer to Documentation/workqueue.txt.
411 *
412 * The __lock_name macro dance is to guarantee that single lock_class_key
413 * doesn't end up with different namesm, which isn't allowed by lockdep.
414 *
415 * RETURNS:
416 * Pointer to the allocated workqueue on success, %NULL on failure.
417 */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700418#ifdef CONFIG_LOCKDEP
Tejun Heoee64e7f2012-08-21 13:18:23 -0700419#define alloc_workqueue(fmt, flags, max_active, args...) \
420({ \
421 static struct lock_class_key __key; \
422 const char *__lock_name; \
423 \
424 if (__builtin_constant_p(fmt)) \
425 __lock_name = (fmt); \
426 else \
427 __lock_name = #fmt; \
428 \
429 __alloc_workqueue_key((fmt), (flags), (max_active), \
430 &__key, __lock_name, ##args); \
Johannes Berg4e6045f2007-10-18 23:39:55 -0700431})
432#else
Tejun Heoee64e7f2012-08-21 13:18:23 -0700433#define alloc_workqueue(fmt, flags, max_active, args...) \
434 __alloc_workqueue_key((fmt), (flags), (max_active), \
Tejun Heob196be82012-01-10 15:11:35 -0800435 NULL, NULL, ##args)
Johannes Berg4e6045f2007-10-18 23:39:55 -0700436#endif
437
Tejun Heo81dcaf62010-09-16 10:17:35 +0200438/**
439 * alloc_ordered_workqueue - allocate an ordered workqueue
Tejun Heob196be82012-01-10 15:11:35 -0800440 * @fmt: printf format for the name of the workqueue
Tejun Heo58a69cb2011-02-16 09:25:31 +0100441 * @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful)
Tejun Heob196be82012-01-10 15:11:35 -0800442 * @args: args for @fmt
Tejun Heo81dcaf62010-09-16 10:17:35 +0200443 *
444 * Allocate an ordered workqueue. An ordered workqueue executes at
445 * most one work item at any given time in the queued order. They are
446 * implemented as unbound workqueues with @max_active of one.
447 *
448 * RETURNS:
449 * Pointer to the allocated workqueue on success, %NULL on failure.
450 */
Tejun Heoee64e7f2012-08-21 13:18:23 -0700451#define alloc_ordered_workqueue(fmt, flags, args...) \
Tejun Heo8719dce2013-03-12 11:30:04 -0700452 alloc_workqueue(fmt, WQ_UNBOUND | __WQ_ORDERED | (flags), 1, ##args)
Tejun Heo81dcaf62010-09-16 10:17:35 +0200453
Tejun Heoee64e7f2012-08-21 13:18:23 -0700454#define create_workqueue(name) \
Kees Cookd8537542013-07-03 15:04:57 -0700455 alloc_workqueue("%s", WQ_MEM_RECLAIM, 1, (name))
Tejun Heoee64e7f2012-08-21 13:18:23 -0700456#define create_freezable_workqueue(name) \
Kees Cookd8537542013-07-03 15:04:57 -0700457 alloc_workqueue("%s", WQ_FREEZABLE | WQ_UNBOUND | WQ_MEM_RECLAIM, \
458 1, (name))
Tejun Heoee64e7f2012-08-21 13:18:23 -0700459#define create_singlethread_workqueue(name) \
Kees Cookd8537542013-07-03 15:04:57 -0700460 alloc_workqueue("%s", WQ_UNBOUND | WQ_MEM_RECLAIM, 1, (name))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
462extern void destroy_workqueue(struct workqueue_struct *wq);
463
Tejun Heo7a4e3442013-03-12 11:30:00 -0700464struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask);
465void free_workqueue_attrs(struct workqueue_attrs *attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -0700466int apply_workqueue_attrs(struct workqueue_struct *wq,
467 const struct workqueue_attrs *attrs);
Tejun Heo7a4e3442013-03-12 11:30:00 -0700468
Tejun Heod4283e92012-08-03 10:30:44 -0700469extern bool queue_work_on(int cpu, struct workqueue_struct *wq,
Zhang Ruic1a220e2008-07-23 21:28:39 -0700470 struct work_struct *work);
Tejun Heod4283e92012-08-03 10:30:44 -0700471extern bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700472 struct delayed_work *work, unsigned long delay);
Tejun Heo8376fe22012-08-03 10:30:47 -0700473extern bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
474 struct delayed_work *dwork, unsigned long delay);
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700475
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800476extern void flush_workqueue(struct workqueue_struct *wq);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200477extern void drain_workqueue(struct workqueue_struct *wq);
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700478extern void flush_scheduled_work(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
David Howells65f27f32006-11-22 14:55:48 +0000480extern int schedule_on_each_cpu(work_func_t func);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
David Howells65f27f32006-11-22 14:55:48 +0000482int execute_in_process_context(work_func_t fn, struct execute_work *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Tejun Heo401a8d02010-09-16 10:36:00 +0200484extern bool flush_work(struct work_struct *work);
485extern bool cancel_work_sync(struct work_struct *work);
486
487extern bool flush_delayed_work(struct delayed_work *dwork);
Tejun Heo57b30ae2012-08-21 13:18:24 -0700488extern bool cancel_delayed_work(struct delayed_work *dwork);
Tejun Heo401a8d02010-09-16 10:36:00 +0200489extern bool cancel_delayed_work_sync(struct delayed_work *dwork);
Oleg Nesterov28e53bd2007-05-09 02:34:22 -0700490
Tejun Heodcd989c2010-06-29 10:07:14 +0200491extern void workqueue_set_max_active(struct workqueue_struct *wq,
492 int max_active);
Tejun Heoe62676162013-03-12 17:41:37 -0700493extern bool current_is_workqueue_rescuer(void);
Tejun Heod84ff052013-03-12 11:29:59 -0700494extern bool workqueue_congested(int cpu, struct workqueue_struct *wq);
Tejun Heodcd989c2010-06-29 10:07:14 +0200495extern unsigned int work_busy(struct work_struct *work);
Tejun Heo3d1cb202013-04-30 15:27:22 -0700496extern __printf(1, 2) void set_worker_desc(const char *fmt, ...);
497extern void print_worker_info(const char *log_lvl, struct task_struct *task);
Tejun Heodcd989c2010-06-29 10:07:14 +0200498
Tejun Heo8425e3d52013-03-13 16:51:36 -0700499/**
500 * queue_work - queue work on a workqueue
501 * @wq: workqueue to use
502 * @work: work to queue
503 *
504 * Returns %false if @work was already on a queue, %true otherwise.
505 *
506 * We queue the work to the CPU on which it was submitted, but if the CPU dies
507 * it can be processed by another CPU.
508 */
509static inline bool queue_work(struct workqueue_struct *wq,
510 struct work_struct *work)
511{
512 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
513}
514
515/**
516 * queue_delayed_work - queue work on a workqueue after delay
517 * @wq: workqueue to use
518 * @dwork: delayable work to queue
519 * @delay: number of jiffies to wait before queueing
520 *
521 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
522 */
523static inline bool queue_delayed_work(struct workqueue_struct *wq,
524 struct delayed_work *dwork,
525 unsigned long delay)
526{
527 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
528}
529
530/**
531 * mod_delayed_work - modify delay of or queue a delayed work
532 * @wq: workqueue to use
533 * @dwork: work to queue
534 * @delay: number of jiffies to wait before queueing
535 *
536 * mod_delayed_work_on() on local CPU.
537 */
538static inline bool mod_delayed_work(struct workqueue_struct *wq,
539 struct delayed_work *dwork,
540 unsigned long delay)
541{
542 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
543}
544
545/**
546 * schedule_work_on - put work task on a specific cpu
547 * @cpu: cpu to put the work task on
548 * @work: job to be done
549 *
550 * This puts a job on a specific cpu
551 */
552static inline bool schedule_work_on(int cpu, struct work_struct *work)
553{
554 return queue_work_on(cpu, system_wq, work);
555}
556
557/**
558 * schedule_work - put work task in global workqueue
559 * @work: job to be done
560 *
561 * Returns %false if @work was already on the kernel-global workqueue and
562 * %true otherwise.
563 *
564 * This puts a job in the kernel-global workqueue if it was not already
565 * queued and leaves it in the same position on the kernel-global
566 * workqueue otherwise.
567 */
568static inline bool schedule_work(struct work_struct *work)
569{
570 return queue_work(system_wq, work);
571}
572
573/**
574 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
575 * @cpu: cpu to use
576 * @dwork: job to be done
577 * @delay: number of jiffies to wait
578 *
579 * After waiting for a given time this puts a job in the kernel-global
580 * workqueue on the specified CPU.
581 */
582static inline bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
583 unsigned long delay)
584{
585 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
586}
587
588/**
589 * schedule_delayed_work - put work task in global workqueue after delay
590 * @dwork: job to be done
591 * @delay: number of jiffies to wait or 0 for immediate execution
592 *
593 * After waiting for a given time this puts a job in the kernel-global
594 * workqueue.
595 */
596static inline bool schedule_delayed_work(struct delayed_work *dwork,
597 unsigned long delay)
598{
599 return queue_delayed_work(system_wq, dwork, delay);
600}
601
602/**
603 * keventd_up - is workqueue initialized yet?
604 */
605static inline bool keventd_up(void)
606{
607 return system_wq != NULL;
608}
609
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610/*
Oleg Nesterov4e496272009-09-05 11:17:06 -0700611 * Like above, but uses del_timer() instead of del_timer_sync(). This means,
612 * if it returns 0 the timer function may be running and the queueing is in
613 * progress.
614 */
Tejun Heo136b5722012-08-21 13:18:24 -0700615static inline bool __deprecated __cancel_delayed_work(struct delayed_work *work)
Oleg Nesterov4e496272009-09-05 11:17:06 -0700616{
Tejun Heo401a8d02010-09-16 10:36:00 +0200617 bool ret;
Oleg Nesterov4e496272009-09-05 11:17:06 -0700618
619 ret = del_timer(&work->timer);
620 if (ret)
621 work_clear_pending(&work->work);
622 return ret;
623}
624
Tejun Heo606a5022012-08-20 14:51:23 -0700625/* used to be different but now identical to flush_work(), deprecated */
Tejun Heo43829732012-08-20 14:51:24 -0700626static inline bool __deprecated flush_work_sync(struct work_struct *work)
Tejun Heo606a5022012-08-20 14:51:23 -0700627{
628 return flush_work(work);
629}
630
631/* used to be different but now identical to flush_delayed_work(), deprecated */
Tejun Heo43829732012-08-20 14:51:24 -0700632static inline bool __deprecated flush_delayed_work_sync(struct delayed_work *dwork)
Tejun Heo606a5022012-08-20 14:51:23 -0700633{
634 return flush_delayed_work(dwork);
635}
636
Rusty Russell2d3854a2008-11-05 13:39:10 +1100637#ifndef CONFIG_SMP
Tejun Heod84ff052013-03-12 11:29:59 -0700638static inline long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +1100639{
640 return fn(arg);
641}
642#else
Tejun Heod84ff052013-03-12 11:29:59 -0700643long work_on_cpu(int cpu, long (*fn)(void *), void *arg);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100644#endif /* CONFIG_SMP */
Paul E. McKenneya25909a2010-05-13 12:32:28 -0700645
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200646#ifdef CONFIG_FREEZER
647extern void freeze_workqueues_begin(void);
648extern bool freeze_workqueues_busy(void);
649extern void thaw_workqueues(void);
650#endif /* CONFIG_FREEZER */
651
Tejun Heo226223a2013-03-12 11:30:05 -0700652#ifdef CONFIG_SYSFS
653int workqueue_sysfs_register(struct workqueue_struct *wq);
654#else /* CONFIG_SYSFS */
655static inline int workqueue_sysfs_register(struct workqueue_struct *wq)
656{ return 0; }
657#endif /* CONFIG_SYSFS */
658
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659#endif