blob: 11723c5b2b2034b2b9fabd87f19238fff432885a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
19 * automatically managed. There is one worker pool for each CPU and
20 * one extra for works which are better served by workers which are
21 * not bound to any specific CPU.
22 *
23 * Please read Documentation/workqueue.txt for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 */
25
Paul Gortmaker9984de12011-05-23 14:51:41 -040026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/kernel.h>
28#include <linux/sched.h>
29#include <linux/init.h>
30#include <linux/signal.h>
31#include <linux/completion.h>
32#include <linux/workqueue.h>
33#include <linux/slab.h>
34#include <linux/cpu.h>
35#include <linux/notifier.h>
36#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060037#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070038#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080039#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080040#include <linux/kallsyms.h>
41#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070042#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020043#include <linux/idr.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020044
45#include "workqueue_sched.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Tejun Heoc8e55f32010-06-29 10:07:12 +020047enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070048 /*
49 * global_cwq flags
50 *
51 * A bound gcwq is either associated or disassociated with its CPU.
52 * While associated (!DISASSOCIATED), all workers are bound to the
53 * CPU and none has %WORKER_UNBOUND set and concurrency management
54 * is in effect.
55 *
56 * While DISASSOCIATED, the cpu may be offline and all workers have
57 * %WORKER_UNBOUND set and concurrency management disabled, and may
58 * be executing on any CPU. The gcwq behaves as an unbound one.
59 *
60 * Note that DISASSOCIATED can be flipped only while holding
61 * managership of all pools on the gcwq to avoid changing binding
62 * state while create_worker() is in progress.
63 */
Tejun Heo11ebea52012-07-12 14:46:37 -070064 GCWQ_DISASSOCIATED = 1 << 0, /* cpu can't serve workers */
65 GCWQ_FREEZING = 1 << 1, /* freeze in progress */
66
67 /* pool flags */
68 POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020069
Tejun Heoc8e55f32010-06-29 10:07:12 +020070 /* worker flags */
71 WORKER_STARTED = 1 << 0, /* started */
72 WORKER_DIE = 1 << 1, /* die die die */
73 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020074 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heoe22bee72010-06-29 10:07:14 +020075 WORKER_REBIND = 1 << 5, /* mom is home, come back */
Tejun Heofb0e7be2010-06-29 10:07:15 +020076 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020077 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoe22bee72010-06-29 10:07:14 +020078
Tejun Heo403c8212012-07-17 12:39:27 -070079 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_REBIND | WORKER_UNBOUND |
80 WORKER_CPU_INTENSIVE,
Tejun Heodb7bccf2010-06-29 10:07:12 +020081
Tejun Heo32704762012-07-13 22:16:45 -070082 NR_WORKER_POOLS = 2, /* # worker pools per gcwq */
Tejun Heo4ce62e92012-07-13 22:16:44 -070083
Tejun Heoc8e55f32010-06-29 10:07:12 +020084 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
85 BUSY_WORKER_HASH_SIZE = 1 << BUSY_WORKER_HASH_ORDER,
86 BUSY_WORKER_HASH_MASK = BUSY_WORKER_HASH_SIZE - 1,
Tejun Heodb7bccf2010-06-29 10:07:12 +020087
Tejun Heoe22bee72010-06-29 10:07:14 +020088 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
89 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
90
Tejun Heo3233cdb2011-02-16 18:10:19 +010091 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
92 /* call for help after 10ms
93 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020094 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
95 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020096
97 /*
98 * Rescue workers are used only on emergencies and shared by
99 * all cpus. Give -20.
100 */
101 RESCUER_NICE_LEVEL = -20,
Tejun Heo32704762012-07-13 22:16:45 -0700102 HIGHPRI_NICE_LEVEL = -20,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200103};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200106 * Structure fields follow one of the following exclusion rules.
107 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200108 * I: Modifiable by initialization/destruction paths and read-only for
109 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200110 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200111 * P: Preemption protected. Disabling preemption is enough and should
112 * only be modified and accessed from the local cpu.
113 *
Tejun Heo8b03ae32010-06-29 10:07:12 +0200114 * L: gcwq->lock protected. Access with gcwq->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200115 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200116 * X: During normal operation, modification requires gcwq->lock and
117 * should be done only from local cpu. Either disabling preemption
118 * on local cpu or grabbing gcwq->lock is enough for read access.
Tejun Heof3421792010-07-02 10:03:51 +0200119 * If GCWQ_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200120 *
Tejun Heo73f53c42010-06-29 10:07:11 +0200121 * F: wq->flush_mutex protected.
122 *
Tejun Heo4690c4a2010-06-29 10:07:10 +0200123 * W: workqueue_lock protected.
124 */
125
Tejun Heo8b03ae32010-06-29 10:07:12 +0200126struct global_cwq;
Tejun Heobd7bdd42012-07-12 14:46:37 -0700127struct worker_pool;
Tejun Heo25511a42012-07-17 12:39:27 -0700128struct idle_rebind;
Tejun Heoc34056a2010-06-29 10:07:11 +0200129
Tejun Heoe22bee72010-06-29 10:07:14 +0200130/*
131 * The poor guys doing the actual heavy lifting. All on-duty workers
132 * are either serving the manager role, on idle list or on busy hash.
133 */
Tejun Heoc34056a2010-06-29 10:07:11 +0200134struct worker {
Tejun Heoc8e55f32010-06-29 10:07:12 +0200135 /* on idle list while idle, on busy hash table while busy */
136 union {
137 struct list_head entry; /* L: while idle */
138 struct hlist_node hentry; /* L: while busy */
139 };
140
Tejun Heoc34056a2010-06-29 10:07:11 +0200141 struct work_struct *current_work; /* L: work being processed */
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200142 struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
Tejun Heoaffee4b2010-06-29 10:07:12 +0200143 struct list_head scheduled; /* L: scheduled works */
Tejun Heoc34056a2010-06-29 10:07:11 +0200144 struct task_struct *task; /* I: worker task */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700145 struct worker_pool *pool; /* I: the associated pool */
Tejun Heoe22bee72010-06-29 10:07:14 +0200146 /* 64 bytes boundary on 64bit, 32 on 32bit */
147 unsigned long last_active; /* L: last active timestamp */
148 unsigned int flags; /* X: flags */
Tejun Heoc34056a2010-06-29 10:07:11 +0200149 int id; /* I: worker id */
Tejun Heo25511a42012-07-17 12:39:27 -0700150
151 /* for rebinding worker to CPU */
152 struct idle_rebind *idle_rebind; /* L: for idle worker */
153 struct work_struct rebind_work; /* L: for busy worker */
Tejun Heoc34056a2010-06-29 10:07:11 +0200154};
155
Tejun Heobd7bdd42012-07-12 14:46:37 -0700156struct worker_pool {
157 struct global_cwq *gcwq; /* I: the owning gcwq */
Tejun Heo11ebea52012-07-12 14:46:37 -0700158 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700159
160 struct list_head worklist; /* L: list of pending works */
161 int nr_workers; /* L: total number of workers */
162 int nr_idle; /* L: currently idle ones */
163
164 struct list_head idle_list; /* X: list of idle workers */
165 struct timer_list idle_timer; /* L: worker idle timeout */
166 struct timer_list mayday_timer; /* L: SOS timer for workers */
167
Tejun Heo60373152012-07-17 12:39:27 -0700168 struct mutex manager_mutex; /* mutex manager should hold */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700169 struct ida worker_ida; /* L: for worker IDs */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700170};
171
Tejun Heo4690c4a2010-06-29 10:07:10 +0200172/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200173 * Global per-cpu workqueue. There's one and only one for each cpu
174 * and all works are queued and processed here regardless of their
175 * target workqueues.
Tejun Heo8b03ae32010-06-29 10:07:12 +0200176 */
177struct global_cwq {
178 spinlock_t lock; /* the gcwq lock */
179 unsigned int cpu; /* I: the associated cpu */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200180 unsigned int flags; /* L: GCWQ_* flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200181
Tejun Heobd7bdd42012-07-12 14:46:37 -0700182 /* workers are chained either in busy_hash or pool idle_list */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200183 struct hlist_head busy_hash[BUSY_WORKER_HASH_SIZE];
184 /* L: hash of busy workers */
185
Tejun Heo32704762012-07-13 22:16:45 -0700186 struct worker_pool pools[2]; /* normal and highpri pools */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200187
Tejun Heo25511a42012-07-17 12:39:27 -0700188 wait_queue_head_t rebind_hold; /* rebind hold wait */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200189} ____cacheline_aligned_in_smp;
190
191/*
Tejun Heo502ca9d2010-06-29 10:07:13 +0200192 * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of
Tejun Heo0f900042010-06-29 10:07:11 +0200193 * work_struct->data are used for flags and thus cwqs need to be
194 * aligned at two's power of the number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 */
196struct cpu_workqueue_struct {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700197 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200198 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200199 int work_color; /* L: current color */
200 int flush_color; /* L: flushing color */
201 int nr_in_flight[WORK_NR_COLORS];
202 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200203 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200204 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200205 struct list_head delayed_works; /* L: delayed works */
Tejun Heo0f900042010-06-29 10:07:11 +0200206};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200209 * Structure used to wait for workqueue flush.
210 */
211struct wq_flusher {
212 struct list_head list; /* F: list of flushers */
213 int flush_color; /* F: flush color waiting for */
214 struct completion done; /* flush completion */
215};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Tejun Heo73f53c42010-06-29 10:07:11 +0200217/*
Tejun Heof2e005a2010-07-20 15:59:09 +0200218 * All cpumasks are assumed to be always set on UP and thus can't be
219 * used to determine whether there's something to be done.
220 */
221#ifdef CONFIG_SMP
222typedef cpumask_var_t mayday_mask_t;
223#define mayday_test_and_set_cpu(cpu, mask) \
224 cpumask_test_and_set_cpu((cpu), (mask))
225#define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask))
226#define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask))
Tejun Heo9c375472010-08-31 11:18:34 +0200227#define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp))
Tejun Heof2e005a2010-07-20 15:59:09 +0200228#define free_mayday_mask(mask) free_cpumask_var((mask))
229#else
230typedef unsigned long mayday_mask_t;
231#define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask))
232#define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask))
233#define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask))
234#define alloc_mayday_mask(maskp, gfp) true
235#define free_mayday_mask(mask) do { } while (0)
236#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
238/*
239 * The externally visible workqueue abstraction is an array of
240 * per-CPU workqueues:
241 */
242struct workqueue_struct {
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200243 unsigned int flags; /* W: WQ_* flags */
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200244 union {
245 struct cpu_workqueue_struct __percpu *pcpu;
246 struct cpu_workqueue_struct *single;
247 unsigned long v;
248 } cpu_wq; /* I: cwq's */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200249 struct list_head list; /* W: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200250
251 struct mutex flush_mutex; /* protects wq flushing */
252 int work_color; /* F: current work color */
253 int flush_color; /* F: current flush color */
254 atomic_t nr_cwqs_to_flush; /* flush in progress */
255 struct wq_flusher *first_flusher; /* F: first flusher */
256 struct list_head flusher_queue; /* F: flush waiters */
257 struct list_head flusher_overflow; /* F: flush overflow list */
258
Tejun Heof2e005a2010-07-20 15:59:09 +0200259 mayday_mask_t mayday_mask; /* cpus requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200260 struct worker *rescuer; /* I: rescue worker */
261
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200262 int nr_drainers; /* W: drain in progress */
Tejun Heodcd989c2010-06-29 10:07:14 +0200263 int saved_max_active; /* W: saved cwq max_active */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700264#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200265 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700266#endif
Tejun Heob196be82012-01-10 15:11:35 -0800267 char name[]; /* I: workqueue name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268};
269
Tejun Heod320c032010-06-29 10:07:14 +0200270struct workqueue_struct *system_wq __read_mostly;
271struct workqueue_struct *system_long_wq __read_mostly;
272struct workqueue_struct *system_nrt_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200273struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100274struct workqueue_struct *system_freezable_wq __read_mostly;
Alan Stern62d3c542012-03-02 10:51:00 +0100275struct workqueue_struct *system_nrt_freezable_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200276EXPORT_SYMBOL_GPL(system_wq);
277EXPORT_SYMBOL_GPL(system_long_wq);
278EXPORT_SYMBOL_GPL(system_nrt_wq);
Tejun Heof3421792010-07-02 10:03:51 +0200279EXPORT_SYMBOL_GPL(system_unbound_wq);
Tejun Heo24d51ad2011-02-21 09:52:50 +0100280EXPORT_SYMBOL_GPL(system_freezable_wq);
Alan Stern62d3c542012-03-02 10:51:00 +0100281EXPORT_SYMBOL_GPL(system_nrt_freezable_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200282
Tejun Heo97bd2342010-10-05 10:41:14 +0200283#define CREATE_TRACE_POINTS
284#include <trace/events/workqueue.h>
285
Tejun Heo4ce62e92012-07-13 22:16:44 -0700286#define for_each_worker_pool(pool, gcwq) \
Tejun Heo32704762012-07-13 22:16:45 -0700287 for ((pool) = &(gcwq)->pools[0]; \
288 (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700289
Tejun Heodb7bccf2010-06-29 10:07:12 +0200290#define for_each_busy_worker(worker, i, pos, gcwq) \
291 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \
292 hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
293
Tejun Heof3421792010-07-02 10:03:51 +0200294static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
295 unsigned int sw)
296{
297 if (cpu < nr_cpu_ids) {
298 if (sw & 1) {
299 cpu = cpumask_next(cpu, mask);
300 if (cpu < nr_cpu_ids)
301 return cpu;
302 }
303 if (sw & 2)
304 return WORK_CPU_UNBOUND;
305 }
306 return WORK_CPU_NONE;
307}
308
309static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
310 struct workqueue_struct *wq)
311{
312 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
313}
314
Tejun Heo09884952010-08-01 11:50:12 +0200315/*
316 * CPU iterators
317 *
318 * An extra gcwq is defined for an invalid cpu number
319 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
320 * specific CPU. The following iterators are similar to
321 * for_each_*_cpu() iterators but also considers the unbound gcwq.
322 *
323 * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
324 * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
325 * for_each_cwq_cpu() : possible CPUs for bound workqueues,
326 * WORK_CPU_UNBOUND for unbound workqueues
327 */
Tejun Heof3421792010-07-02 10:03:51 +0200328#define for_each_gcwq_cpu(cpu) \
329 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
330 (cpu) < WORK_CPU_NONE; \
331 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
332
333#define for_each_online_gcwq_cpu(cpu) \
334 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
335 (cpu) < WORK_CPU_NONE; \
336 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
337
338#define for_each_cwq_cpu(cpu, wq) \
339 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
340 (cpu) < WORK_CPU_NONE; \
341 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
342
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900343#ifdef CONFIG_DEBUG_OBJECTS_WORK
344
345static struct debug_obj_descr work_debug_descr;
346
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100347static void *work_debug_hint(void *addr)
348{
349 return ((struct work_struct *) addr)->func;
350}
351
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900352/*
353 * fixup_init is called when:
354 * - an active object is initialized
355 */
356static int work_fixup_init(void *addr, enum debug_obj_state state)
357{
358 struct work_struct *work = addr;
359
360 switch (state) {
361 case ODEBUG_STATE_ACTIVE:
362 cancel_work_sync(work);
363 debug_object_init(work, &work_debug_descr);
364 return 1;
365 default:
366 return 0;
367 }
368}
369
370/*
371 * fixup_activate is called when:
372 * - an active object is activated
373 * - an unknown object is activated (might be a statically initialized object)
374 */
375static int work_fixup_activate(void *addr, enum debug_obj_state state)
376{
377 struct work_struct *work = addr;
378
379 switch (state) {
380
381 case ODEBUG_STATE_NOTAVAILABLE:
382 /*
383 * This is not really a fixup. The work struct was
384 * statically initialized. We just make sure that it
385 * is tracked in the object tracker.
386 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200387 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900388 debug_object_init(work, &work_debug_descr);
389 debug_object_activate(work, &work_debug_descr);
390 return 0;
391 }
392 WARN_ON_ONCE(1);
393 return 0;
394
395 case ODEBUG_STATE_ACTIVE:
396 WARN_ON(1);
397
398 default:
399 return 0;
400 }
401}
402
403/*
404 * fixup_free is called when:
405 * - an active object is freed
406 */
407static int work_fixup_free(void *addr, enum debug_obj_state state)
408{
409 struct work_struct *work = addr;
410
411 switch (state) {
412 case ODEBUG_STATE_ACTIVE:
413 cancel_work_sync(work);
414 debug_object_free(work, &work_debug_descr);
415 return 1;
416 default:
417 return 0;
418 }
419}
420
421static struct debug_obj_descr work_debug_descr = {
422 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100423 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900424 .fixup_init = work_fixup_init,
425 .fixup_activate = work_fixup_activate,
426 .fixup_free = work_fixup_free,
427};
428
429static inline void debug_work_activate(struct work_struct *work)
430{
431 debug_object_activate(work, &work_debug_descr);
432}
433
434static inline void debug_work_deactivate(struct work_struct *work)
435{
436 debug_object_deactivate(work, &work_debug_descr);
437}
438
439void __init_work(struct work_struct *work, int onstack)
440{
441 if (onstack)
442 debug_object_init_on_stack(work, &work_debug_descr);
443 else
444 debug_object_init(work, &work_debug_descr);
445}
446EXPORT_SYMBOL_GPL(__init_work);
447
448void destroy_work_on_stack(struct work_struct *work)
449{
450 debug_object_free(work, &work_debug_descr);
451}
452EXPORT_SYMBOL_GPL(destroy_work_on_stack);
453
454#else
455static inline void debug_work_activate(struct work_struct *work) { }
456static inline void debug_work_deactivate(struct work_struct *work) { }
457#endif
458
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100459/* Serializes the accesses to the list of workqueues. */
460static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200462static bool workqueue_freezing; /* W: have wqs started freezing? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
Oleg Nesterov14441962007-05-23 13:57:57 -0700464/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200465 * The almighty global cpu workqueues. nr_running is the only field
466 * which is expected to be used frequently by other cpus via
467 * try_to_wake_up(). Put it in a separate cacheline.
Oleg Nesterov14441962007-05-23 13:57:57 -0700468 */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200469static DEFINE_PER_CPU(struct global_cwq, global_cwq);
Tejun Heo4ce62e92012-07-13 22:16:44 -0700470static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
Nathan Lynchf756d5e2006-01-08 01:05:12 -0800471
Tejun Heof3421792010-07-02 10:03:51 +0200472/*
473 * Global cpu workqueue and nr_running counter for unbound gcwq. The
474 * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
475 * workers have WORKER_UNBOUND set.
476 */
477static struct global_cwq unbound_global_cwq;
Tejun Heo4ce62e92012-07-13 22:16:44 -0700478static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
479 [0 ... NR_WORKER_POOLS - 1] = ATOMIC_INIT(0), /* always 0 */
480};
Tejun Heof3421792010-07-02 10:03:51 +0200481
Tejun Heoc34056a2010-06-29 10:07:11 +0200482static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Tejun Heo32704762012-07-13 22:16:45 -0700484static int worker_pool_pri(struct worker_pool *pool)
485{
486 return pool - pool->gcwq->pools;
487}
488
Tejun Heo8b03ae32010-06-29 10:07:12 +0200489static struct global_cwq *get_gcwq(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490{
Tejun Heof3421792010-07-02 10:03:51 +0200491 if (cpu != WORK_CPU_UNBOUND)
492 return &per_cpu(global_cwq, cpu);
493 else
494 return &unbound_global_cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495}
496
Tejun Heo63d95a92012-07-12 14:46:37 -0700497static atomic_t *get_pool_nr_running(struct worker_pool *pool)
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -0700498{
Tejun Heo63d95a92012-07-12 14:46:37 -0700499 int cpu = pool->gcwq->cpu;
Tejun Heo32704762012-07-13 22:16:45 -0700500 int idx = worker_pool_pri(pool);
Tejun Heo63d95a92012-07-12 14:46:37 -0700501
Tejun Heof3421792010-07-02 10:03:51 +0200502 if (cpu != WORK_CPU_UNBOUND)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700503 return &per_cpu(pool_nr_running, cpu)[idx];
Tejun Heof3421792010-07-02 10:03:51 +0200504 else
Tejun Heo4ce62e92012-07-13 22:16:44 -0700505 return &unbound_pool_nr_running[idx];
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -0700506}
507
Tejun Heo4690c4a2010-06-29 10:07:10 +0200508static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
509 struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700510{
Tejun Heof3421792010-07-02 10:03:51 +0200511 if (!(wq->flags & WQ_UNBOUND)) {
Lai Jiangshane06ffa12012-03-09 18:03:20 +0800512 if (likely(cpu < nr_cpu_ids))
Tejun Heof3421792010-07-02 10:03:51 +0200513 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
Tejun Heof3421792010-07-02 10:03:51 +0200514 } else if (likely(cpu == WORK_CPU_UNBOUND))
515 return wq->cpu_wq.single;
516 return NULL;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700517}
518
Tejun Heo73f53c42010-06-29 10:07:11 +0200519static unsigned int work_color_to_flags(int color)
520{
521 return color << WORK_STRUCT_COLOR_SHIFT;
522}
523
524static int get_work_color(struct work_struct *work)
525{
526 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
527 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
528}
529
530static int work_next_color(int color)
531{
532 return (color + 1) % WORK_NR_COLORS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533}
534
David Howells4594bf12006-12-07 11:33:26 +0000535/*
Tejun Heob5490072012-08-03 10:30:46 -0700536 * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
537 * contain the pointer to the queued cwq. Once execution starts, the flag
538 * is cleared and the high bits contain OFFQ flags and CPU number.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200539 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700540 * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
541 * and clear_work_data() can be used to set the cwq, cpu or clear
542 * work->data. These functions should only be called while the work is
543 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200544 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700545 * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
546 * a work. gcwq is available once the work has been queued anywhere after
547 * initialization until it is sync canceled. cwq is available only while
548 * the work item is queued.
549 *
550 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
551 * canceled. While being canceled, a work item may have its PENDING set
552 * but stay off timer and worklist for arbitrarily long and nobody should
553 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000554 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200555static inline void set_work_data(struct work_struct *work, unsigned long data,
556 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000557{
David Howells4594bf12006-12-07 11:33:26 +0000558 BUG_ON(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200559 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000560}
David Howells365970a2006-11-22 14:54:49 +0000561
Tejun Heo7a22ad72010-06-29 10:07:13 +0200562static void set_work_cwq(struct work_struct *work,
563 struct cpu_workqueue_struct *cwq,
564 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200565{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200566 set_work_data(work, (unsigned long)cwq,
Tejun Heoe1201532010-07-22 14:14:25 +0200567 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200568}
569
Tejun Heo8930cab2012-08-03 10:30:45 -0700570static void set_work_cpu_and_clear_pending(struct work_struct *work,
571 unsigned int cpu)
David Howells365970a2006-11-22 14:54:49 +0000572{
Tejun Heob5490072012-08-03 10:30:46 -0700573 set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200574}
575
576static void clear_work_data(struct work_struct *work)
577{
578 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
579}
580
Tejun Heo7a22ad72010-06-29 10:07:13 +0200581static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
582{
Tejun Heoe1201532010-07-22 14:14:25 +0200583 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200584
Tejun Heoe1201532010-07-22 14:14:25 +0200585 if (data & WORK_STRUCT_CWQ)
586 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
587 else
588 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200589}
590
591static struct global_cwq *get_work_gcwq(struct work_struct *work)
592{
Tejun Heoe1201532010-07-22 14:14:25 +0200593 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200594 unsigned int cpu;
595
Tejun Heoe1201532010-07-22 14:14:25 +0200596 if (data & WORK_STRUCT_CWQ)
597 return ((struct cpu_workqueue_struct *)
Tejun Heobd7bdd42012-07-12 14:46:37 -0700598 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200599
Tejun Heob5490072012-08-03 10:30:46 -0700600 cpu = data >> WORK_OFFQ_CPU_SHIFT;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200601 if (cpu == WORK_CPU_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200602 return NULL;
603
Tejun Heof3421792010-07-02 10:03:51 +0200604 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200605 return get_gcwq(cpu);
David Howells365970a2006-11-22 14:54:49 +0000606}
607
Tejun Heobbb68df2012-08-03 10:30:46 -0700608static void mark_work_canceling(struct work_struct *work)
609{
610 struct global_cwq *gcwq = get_work_gcwq(work);
611 unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
612
613 set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
614 WORK_STRUCT_PENDING);
615}
616
617static bool work_is_canceling(struct work_struct *work)
618{
619 unsigned long data = atomic_long_read(&work->data);
620
621 return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
622}
623
David Howells365970a2006-11-22 14:54:49 +0000624/*
Tejun Heo32704762012-07-13 22:16:45 -0700625 * Policy functions. These define the policies on how the global worker
626 * pools are managed. Unless noted otherwise, these functions assume that
627 * they're being called with gcwq->lock held.
David Howells365970a2006-11-22 14:54:49 +0000628 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200629
Tejun Heo63d95a92012-07-12 14:46:37 -0700630static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000631{
Tejun Heo32704762012-07-13 22:16:45 -0700632 return !atomic_read(get_pool_nr_running(pool));
David Howells365970a2006-11-22 14:54:49 +0000633}
634
Tejun Heoe22bee72010-06-29 10:07:14 +0200635/*
636 * Need to wake up a worker? Called from anything but currently
637 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700638 *
639 * Note that, because unbound workers never contribute to nr_running, this
640 * function will always return %true for unbound gcwq as long as the
641 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200642 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700643static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000644{
Tejun Heo63d95a92012-07-12 14:46:37 -0700645 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000646}
647
Tejun Heoe22bee72010-06-29 10:07:14 +0200648/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700649static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200650{
Tejun Heo63d95a92012-07-12 14:46:37 -0700651 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200652}
653
654/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700655static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200656{
Tejun Heo63d95a92012-07-12 14:46:37 -0700657 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200658
Tejun Heo32704762012-07-13 22:16:45 -0700659 return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200660}
661
662/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700663static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200664{
Tejun Heo63d95a92012-07-12 14:46:37 -0700665 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200666}
667
668/* Do I need to be the manager? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700669static bool need_to_manage_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200670{
Tejun Heo63d95a92012-07-12 14:46:37 -0700671 return need_to_create_worker(pool) ||
Tejun Heo11ebea52012-07-12 14:46:37 -0700672 (pool->flags & POOL_MANAGE_WORKERS);
Tejun Heoe22bee72010-06-29 10:07:14 +0200673}
674
675/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700676static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200677{
Tejun Heo60373152012-07-17 12:39:27 -0700678 bool managing = mutex_is_locked(&pool->manager_mutex);
Tejun Heo63d95a92012-07-12 14:46:37 -0700679 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
680 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200681
682 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
683}
684
685/*
686 * Wake up functions.
687 */
688
Tejun Heo7e116292010-06-29 10:07:13 +0200689/* Return the first worker. Safe with preemption disabled */
Tejun Heo63d95a92012-07-12 14:46:37 -0700690static struct worker *first_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200691{
Tejun Heo63d95a92012-07-12 14:46:37 -0700692 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200693 return NULL;
694
Tejun Heo63d95a92012-07-12 14:46:37 -0700695 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200696}
697
698/**
699 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700700 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200701 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700702 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200703 *
704 * CONTEXT:
705 * spin_lock_irq(gcwq->lock).
706 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700707static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200708{
Tejun Heo63d95a92012-07-12 14:46:37 -0700709 struct worker *worker = first_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200710
711 if (likely(worker))
712 wake_up_process(worker->task);
713}
714
Tejun Heo4690c4a2010-06-29 10:07:10 +0200715/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200716 * wq_worker_waking_up - a worker is waking up
717 * @task: task waking up
718 * @cpu: CPU @task is waking up to
719 *
720 * This function is called during try_to_wake_up() when a worker is
721 * being awoken.
722 *
723 * CONTEXT:
724 * spin_lock_irq(rq->lock)
725 */
726void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
727{
728 struct worker *worker = kthread_data(task);
729
Steven Rostedt2d646722010-12-03 23:12:33 -0500730 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700731 atomic_inc(get_pool_nr_running(worker->pool));
Tejun Heoe22bee72010-06-29 10:07:14 +0200732}
733
734/**
735 * wq_worker_sleeping - a worker is going to sleep
736 * @task: task going to sleep
737 * @cpu: CPU in question, must be the current CPU number
738 *
739 * This function is called during schedule() when a busy worker is
740 * going to sleep. Worker on the same cpu can be woken up by
741 * returning pointer to its task.
742 *
743 * CONTEXT:
744 * spin_lock_irq(rq->lock)
745 *
746 * RETURNS:
747 * Worker task on @cpu to wake up, %NULL if none.
748 */
749struct task_struct *wq_worker_sleeping(struct task_struct *task,
750 unsigned int cpu)
751{
752 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heobd7bdd42012-07-12 14:46:37 -0700753 struct worker_pool *pool = worker->pool;
Tejun Heo63d95a92012-07-12 14:46:37 -0700754 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200755
Steven Rostedt2d646722010-12-03 23:12:33 -0500756 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200757 return NULL;
758
759 /* this can only happen on the local cpu */
760 BUG_ON(cpu != raw_smp_processor_id());
761
762 /*
763 * The counterpart of the following dec_and_test, implied mb,
764 * worklist not empty test sequence is in insert_work().
765 * Please read comment there.
766 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700767 * NOT_RUNNING is clear. This means that we're bound to and
768 * running on the local cpu w/ rq lock held and preemption
769 * disabled, which in turn means that none else could be
770 * manipulating idle_list, so dereferencing idle_list without gcwq
771 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200772 */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700773 if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700774 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200775 return to_wakeup ? to_wakeup->task : NULL;
776}
777
778/**
779 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200780 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200781 * @flags: flags to set
782 * @wakeup: wakeup an idle worker if necessary
783 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200784 * Set @flags in @worker->flags and adjust nr_running accordingly. If
785 * nr_running becomes zero and @wakeup is %true, an idle worker is
786 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200787 *
Tejun Heocb444762010-07-02 10:03:50 +0200788 * CONTEXT:
789 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200790 */
791static inline void worker_set_flags(struct worker *worker, unsigned int flags,
792 bool wakeup)
793{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700794 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200795
Tejun Heocb444762010-07-02 10:03:50 +0200796 WARN_ON_ONCE(worker->task != current);
797
Tejun Heoe22bee72010-06-29 10:07:14 +0200798 /*
799 * If transitioning into NOT_RUNNING, adjust nr_running and
800 * wake up an idle worker as necessary if requested by
801 * @wakeup.
802 */
803 if ((flags & WORKER_NOT_RUNNING) &&
804 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heo63d95a92012-07-12 14:46:37 -0700805 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200806
807 if (wakeup) {
808 if (atomic_dec_and_test(nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700809 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700810 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200811 } else
812 atomic_dec(nr_running);
813 }
814
Tejun Heod302f012010-06-29 10:07:13 +0200815 worker->flags |= flags;
816}
817
818/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200819 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200820 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200821 * @flags: flags to clear
822 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200823 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200824 *
Tejun Heocb444762010-07-02 10:03:50 +0200825 * CONTEXT:
826 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200827 */
828static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
829{
Tejun Heo63d95a92012-07-12 14:46:37 -0700830 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200831 unsigned int oflags = worker->flags;
832
Tejun Heocb444762010-07-02 10:03:50 +0200833 WARN_ON_ONCE(worker->task != current);
834
Tejun Heod302f012010-06-29 10:07:13 +0200835 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200836
Tejun Heo42c025f2011-01-11 15:58:49 +0100837 /*
838 * If transitioning out of NOT_RUNNING, increment nr_running. Note
839 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
840 * of multiple flags, not a single flag.
841 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200842 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
843 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700844 atomic_inc(get_pool_nr_running(pool));
Tejun Heod302f012010-06-29 10:07:13 +0200845}
846
847/**
Tejun Heoc8e55f32010-06-29 10:07:12 +0200848 * busy_worker_head - return the busy hash head for a work
849 * @gcwq: gcwq of interest
850 * @work: work to be hashed
851 *
852 * Return hash head of @gcwq for @work.
853 *
854 * CONTEXT:
855 * spin_lock_irq(gcwq->lock).
856 *
857 * RETURNS:
858 * Pointer to the hash head.
859 */
860static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
861 struct work_struct *work)
862{
863 const int base_shift = ilog2(sizeof(struct work_struct));
864 unsigned long v = (unsigned long)work;
865
866 /* simple shift and fold hash, do we need something better? */
867 v >>= base_shift;
868 v += v >> BUSY_WORKER_HASH_ORDER;
869 v &= BUSY_WORKER_HASH_MASK;
870
871 return &gcwq->busy_hash[v];
872}
873
874/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200875 * __find_worker_executing_work - find worker which is executing a work
876 * @gcwq: gcwq of interest
877 * @bwh: hash head as returned by busy_worker_head()
878 * @work: work to find worker for
879 *
880 * Find a worker which is executing @work on @gcwq. @bwh should be
881 * the hash head obtained by calling busy_worker_head() with the same
882 * work.
883 *
884 * CONTEXT:
885 * spin_lock_irq(gcwq->lock).
886 *
887 * RETURNS:
888 * Pointer to worker which is executing @work if found, NULL
889 * otherwise.
890 */
891static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
892 struct hlist_head *bwh,
893 struct work_struct *work)
894{
895 struct worker *worker;
896 struct hlist_node *tmp;
897
898 hlist_for_each_entry(worker, tmp, bwh, hentry)
899 if (worker->current_work == work)
900 return worker;
901 return NULL;
902}
903
904/**
905 * find_worker_executing_work - find worker which is executing a work
906 * @gcwq: gcwq of interest
907 * @work: work to find worker for
908 *
909 * Find a worker which is executing @work on @gcwq. This function is
910 * identical to __find_worker_executing_work() except that this
911 * function calculates @bwh itself.
912 *
913 * CONTEXT:
914 * spin_lock_irq(gcwq->lock).
915 *
916 * RETURNS:
917 * Pointer to worker which is executing @work if found, NULL
918 * otherwise.
919 */
920static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
921 struct work_struct *work)
922{
923 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
924 work);
925}
926
927/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700928 * move_linked_works - move linked works to a list
929 * @work: start of series of works to be scheduled
930 * @head: target list to append @work to
931 * @nextp: out paramter for nested worklist walking
932 *
933 * Schedule linked works starting from @work to @head. Work series to
934 * be scheduled starts at @work and includes any consecutive work with
935 * WORK_STRUCT_LINKED set in its predecessor.
936 *
937 * If @nextp is not NULL, it's updated to point to the next work of
938 * the last scheduled work. This allows move_linked_works() to be
939 * nested inside outer list_for_each_entry_safe().
940 *
941 * CONTEXT:
942 * spin_lock_irq(gcwq->lock).
943 */
944static void move_linked_works(struct work_struct *work, struct list_head *head,
945 struct work_struct **nextp)
946{
947 struct work_struct *n;
948
949 /*
950 * Linked worklist will always end before the end of the list,
951 * use NULL for list head.
952 */
953 list_for_each_entry_safe_from(work, n, NULL, entry) {
954 list_move_tail(&work->entry, head);
955 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
956 break;
957 }
958
959 /*
960 * If we're already inside safe list traversal and have moved
961 * multiple works to the scheduled queue, the next position
962 * needs to be updated.
963 */
964 if (nextp)
965 *nextp = n;
966}
967
968static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
969{
970 struct work_struct *work = list_first_entry(&cwq->delayed_works,
971 struct work_struct, entry);
972
973 trace_workqueue_activate_work(work);
974 move_linked_works(work, &cwq->pool->worklist, NULL);
975 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
976 cwq->nr_active++;
977}
978
979/**
980 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
981 * @cwq: cwq of interest
982 * @color: color of work which left the queue
983 * @delayed: for a delayed work
984 *
985 * A work either has completed or is removed from pending queue,
986 * decrement nr_in_flight of its cwq and handle workqueue flushing.
987 *
988 * CONTEXT:
989 * spin_lock_irq(gcwq->lock).
990 */
991static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
992 bool delayed)
993{
994 /* ignore uncolored works */
995 if (color == WORK_NO_COLOR)
996 return;
997
998 cwq->nr_in_flight[color]--;
999
1000 if (!delayed) {
1001 cwq->nr_active--;
1002 if (!list_empty(&cwq->delayed_works)) {
1003 /* one down, submit a delayed one */
1004 if (cwq->nr_active < cwq->max_active)
1005 cwq_activate_first_delayed(cwq);
1006 }
1007 }
1008
1009 /* is flush in progress and are we at the flushing tip? */
1010 if (likely(cwq->flush_color != color))
1011 return;
1012
1013 /* are there still in-flight works? */
1014 if (cwq->nr_in_flight[color])
1015 return;
1016
1017 /* this cwq is done, clear flush_color */
1018 cwq->flush_color = -1;
1019
1020 /*
1021 * If this was the last cwq, wake up the first flusher. It
1022 * will handle the rest.
1023 */
1024 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1025 complete(&cwq->wq->first_flusher->done);
1026}
1027
Tejun Heo36e227d2012-08-03 10:30:46 -07001028/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001029 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001030 * @work: work item to steal
1031 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001032 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001033 *
1034 * Try to grab PENDING bit of @work. This function can handle @work in any
1035 * stable state - idle, on timer or on worklist. Return values are
1036 *
1037 * 1 if @work was pending and we successfully stole PENDING
1038 * 0 if @work was idle and we claimed PENDING
1039 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001040 * -ENOENT if someone else is canceling @work, this state may persist
1041 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001042 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001043 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
1044 * preempted while holding PENDING and @work off queue, preemption must be
1045 * disabled on entry. This ensures that we don't return -EAGAIN while
1046 * another task is preempted in this function.
1047 *
1048 * On successful return, >= 0, irq is disabled and the caller is
1049 * responsible for releasing it using local_irq_restore(*@flags).
1050 *
1051 * This function is safe to call from any context other than IRQ handler.
1052 * An IRQ handler may run on top of delayed_work_timer_fn() which can make
1053 * this function return -EAGAIN perpetually.
Tejun Heobf4ede02012-08-03 10:30:46 -07001054 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001055static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1056 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001057{
1058 struct global_cwq *gcwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001059
Tejun Heobbb68df2012-08-03 10:30:46 -07001060 WARN_ON_ONCE(in_irq());
1061
1062 local_irq_save(*flags);
1063
Tejun Heo36e227d2012-08-03 10:30:46 -07001064 /* try to steal the timer if it exists */
1065 if (is_dwork) {
1066 struct delayed_work *dwork = to_delayed_work(work);
1067
1068 if (likely(del_timer(&dwork->timer)))
1069 return 1;
1070 }
1071
1072 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001073 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1074 return 0;
1075
1076 /*
1077 * The queueing is in progress, or it is already queued. Try to
1078 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1079 */
1080 gcwq = get_work_gcwq(work);
1081 if (!gcwq)
Tejun Heobbb68df2012-08-03 10:30:46 -07001082 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001083
Tejun Heobbb68df2012-08-03 10:30:46 -07001084 spin_lock(&gcwq->lock);
Tejun Heobf4ede02012-08-03 10:30:46 -07001085 if (!list_empty(&work->entry)) {
1086 /*
1087 * This work is queued, but perhaps we locked the wrong gcwq.
1088 * In that case we must see the new value after rmb(), see
1089 * insert_work()->wmb().
1090 */
1091 smp_rmb();
1092 if (gcwq == get_work_gcwq(work)) {
1093 debug_work_deactivate(work);
1094 list_del_init(&work->entry);
1095 cwq_dec_nr_in_flight(get_work_cwq(work),
1096 get_work_color(work),
1097 *work_data_bits(work) & WORK_STRUCT_DELAYED);
Tejun Heo36e227d2012-08-03 10:30:46 -07001098
Tejun Heobbb68df2012-08-03 10:30:46 -07001099 spin_unlock(&gcwq->lock);
Tejun Heo36e227d2012-08-03 10:30:46 -07001100 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001101 }
1102 }
Tejun Heobbb68df2012-08-03 10:30:46 -07001103 spin_unlock(&gcwq->lock);
1104fail:
1105 local_irq_restore(*flags);
1106 if (work_is_canceling(work))
1107 return -ENOENT;
1108 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001109 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001110}
1111
1112/**
Tejun Heo7e116292010-06-29 10:07:13 +02001113 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +02001114 * @cwq: cwq @work belongs to
1115 * @work: work to insert
1116 * @head: insertion point
1117 * @extra_flags: extra WORK_STRUCT_* flags to set
1118 *
Tejun Heo7e116292010-06-29 10:07:13 +02001119 * Insert @work which belongs to @cwq into @gcwq after @head.
1120 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001121 *
1122 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001123 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001124 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001125static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +02001126 struct work_struct *work, struct list_head *head,
1127 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001128{
Tejun Heo63d95a92012-07-12 14:46:37 -07001129 struct worker_pool *pool = cwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001130
Tejun Heo4690c4a2010-06-29 10:07:10 +02001131 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +02001132 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001133
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001134 /*
1135 * Ensure that we get the right work->data if we see the
1136 * result of list_add() below, see try_to_grab_pending().
1137 */
1138 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +02001139
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001140 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +02001141
1142 /*
1143 * Ensure either worker_sched_deactivated() sees the above
1144 * list_add_tail() or we see zero nr_running to avoid workers
1145 * lying around lazily while there are works to be processed.
1146 */
1147 smp_mb();
1148
Tejun Heo63d95a92012-07-12 14:46:37 -07001149 if (__need_more_worker(pool))
1150 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001151}
1152
Tejun Heoc8efcc22010-12-20 19:32:04 +01001153/*
1154 * Test whether @work is being queued from another work executing on the
1155 * same workqueue. This is rather expensive and should only be used from
1156 * cold paths.
1157 */
1158static bool is_chained_work(struct workqueue_struct *wq)
1159{
1160 unsigned long flags;
1161 unsigned int cpu;
1162
1163 for_each_gcwq_cpu(cpu) {
1164 struct global_cwq *gcwq = get_gcwq(cpu);
1165 struct worker *worker;
1166 struct hlist_node *pos;
1167 int i;
1168
1169 spin_lock_irqsave(&gcwq->lock, flags);
1170 for_each_busy_worker(worker, i, pos, gcwq) {
1171 if (worker->task != current)
1172 continue;
1173 spin_unlock_irqrestore(&gcwq->lock, flags);
1174 /*
1175 * I'm @worker, no locking necessary. See if @work
1176 * is headed to the same workqueue.
1177 */
1178 return worker->current_cwq->wq == wq;
1179 }
1180 spin_unlock_irqrestore(&gcwq->lock, flags);
1181 }
1182 return false;
1183}
1184
Tejun Heo4690c4a2010-06-29 10:07:10 +02001185static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 struct work_struct *work)
1187{
Tejun Heo502ca9d2010-06-29 10:07:13 +02001188 struct global_cwq *gcwq;
1189 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001190 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001191 unsigned int work_flags;
Tejun Heo8930cab2012-08-03 10:30:45 -07001192
1193 /*
1194 * While a work item is PENDING && off queue, a task trying to
1195 * steal the PENDING will busy-loop waiting for it to either get
1196 * queued or lose PENDING. Grabbing PENDING and queueing should
1197 * happen with IRQ disabled.
1198 */
1199 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001201 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001202
Tejun Heoc8efcc22010-12-20 19:32:04 +01001203 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02001204 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001205 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001206 return;
1207
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001208 /* determine gcwq to use */
1209 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001210 struct global_cwq *last_gcwq;
1211
Tejun Heo57469822012-08-03 10:30:45 -07001212 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001213 cpu = raw_smp_processor_id();
1214
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001215 /*
1216 * It's multi cpu. If @wq is non-reentrant and @work
1217 * was previously on a different cpu, it might still
1218 * be running there, in which case the work needs to
1219 * be queued on that cpu to guarantee non-reentrance.
1220 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001221 gcwq = get_gcwq(cpu);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001222 if (wq->flags & WQ_NON_REENTRANT &&
1223 (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
1224 struct worker *worker;
1225
Tejun Heo8930cab2012-08-03 10:30:45 -07001226 spin_lock(&last_gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001227
1228 worker = find_worker_executing_work(last_gcwq, work);
1229
1230 if (worker && worker->current_cwq->wq == wq)
1231 gcwq = last_gcwq;
1232 else {
1233 /* meh... not running there, queue here */
Tejun Heo8930cab2012-08-03 10:30:45 -07001234 spin_unlock(&last_gcwq->lock);
1235 spin_lock(&gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001236 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001237 } else {
1238 spin_lock(&gcwq->lock);
1239 }
Tejun Heof3421792010-07-02 10:03:51 +02001240 } else {
1241 gcwq = get_gcwq(WORK_CPU_UNBOUND);
Tejun Heo8930cab2012-08-03 10:30:45 -07001242 spin_lock(&gcwq->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001243 }
1244
1245 /* gcwq determined, get cwq and queue */
1246 cwq = get_cwq(gcwq->cpu, wq);
Tejun Heocdadf002010-10-05 10:49:55 +02001247 trace_workqueue_queue_work(cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001248
Dan Carpenterf5b25522012-04-13 22:06:58 +03001249 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo8930cab2012-08-03 10:30:45 -07001250 spin_unlock(&gcwq->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001251 return;
1252 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001253
Tejun Heo73f53c42010-06-29 10:07:11 +02001254 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001255 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001256
1257 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001258 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001259 cwq->nr_active++;
Tejun Heo32704762012-07-13 22:16:45 -07001260 worklist = &cwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001261 } else {
1262 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001263 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001264 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001265
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001266 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001267
Tejun Heo8930cab2012-08-03 10:30:45 -07001268 spin_unlock(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269}
1270
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001271/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001272 * queue_work_on - queue work on specific cpu
1273 * @cpu: CPU number to execute work on
1274 * @wq: workqueue to use
1275 * @work: work to queue
1276 *
Tejun Heod4283e92012-08-03 10:30:44 -07001277 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001278 *
1279 * We queue the work to a specific CPU, the caller must ensure it
1280 * can't go away.
1281 */
Tejun Heod4283e92012-08-03 10:30:44 -07001282bool queue_work_on(int cpu, struct workqueue_struct *wq,
1283 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001284{
Tejun Heod4283e92012-08-03 10:30:44 -07001285 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001286 unsigned long flags;
1287
1288 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001289
Tejun Heo22df02b2010-06-29 10:07:10 +02001290 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001291 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001292 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001293 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001294
1295 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001296 return ret;
1297}
1298EXPORT_SYMBOL_GPL(queue_work_on);
1299
Tejun Heo0a13c002012-08-03 10:30:44 -07001300/**
1301 * queue_work - queue work on a workqueue
1302 * @wq: workqueue to use
1303 * @work: work to queue
1304 *
Tejun Heod4283e92012-08-03 10:30:44 -07001305 * Returns %false if @work was already on a queue, %true otherwise.
Tejun Heo0a13c002012-08-03 10:30:44 -07001306 *
1307 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1308 * it can be processed by another CPU.
1309 */
Tejun Heod4283e92012-08-03 10:30:44 -07001310bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07001311{
Tejun Heo57469822012-08-03 10:30:45 -07001312 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
Tejun Heo0a13c002012-08-03 10:30:44 -07001313}
1314EXPORT_SYMBOL_GPL(queue_work);
1315
Tejun Heod8e794d2012-08-03 10:30:45 -07001316void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317{
David Howells52bad642006-11-22 14:54:01 +00001318 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001319 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320
Tejun Heo8930cab2012-08-03 10:30:45 -07001321 local_irq_disable();
Tejun Heo12650572012-08-08 09:38:42 -07001322 __queue_work(dwork->cpu, cwq->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07001323 local_irq_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324}
Tejun Heod8e794d2012-08-03 10:30:45 -07001325EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001327static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1328 struct delayed_work *dwork, unsigned long delay)
1329{
1330 struct timer_list *timer = &dwork->timer;
1331 struct work_struct *work = &dwork->work;
1332 unsigned int lcpu;
1333
1334 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1335 timer->data != (unsigned long)dwork);
1336 BUG_ON(timer_pending(timer));
1337 BUG_ON(!list_empty(&work->entry));
1338
1339 timer_stats_timer_set_start_info(&dwork->timer);
1340
1341 /*
1342 * This stores cwq for the moment, for the timer_fn. Note that the
1343 * work's gcwq is preserved to allow reentrance detection for
1344 * delayed works.
1345 */
1346 if (!(wq->flags & WQ_UNBOUND)) {
1347 struct global_cwq *gcwq = get_work_gcwq(work);
1348
1349 if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1350 lcpu = gcwq->cpu;
1351 else
1352 lcpu = raw_smp_processor_id();
1353 } else {
1354 lcpu = WORK_CPU_UNBOUND;
1355 }
1356
1357 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1358
Tejun Heo12650572012-08-08 09:38:42 -07001359 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001360 timer->expires = jiffies + delay;
1361
1362 if (unlikely(cpu != WORK_CPU_UNBOUND))
1363 add_timer_on(timer, cpu);
1364 else
1365 add_timer(timer);
1366}
1367
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001368/**
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001369 * queue_delayed_work_on - queue work on specific CPU after delay
1370 * @cpu: CPU number to execute work on
1371 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001372 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001373 * @delay: number of jiffies to wait before queueing
1374 *
Tejun Heo715f1302012-08-03 10:30:46 -07001375 * Returns %false if @work was already on a queue, %true otherwise. If
1376 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1377 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001378 */
Tejun Heod4283e92012-08-03 10:30:44 -07001379bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1380 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001381{
David Howells52bad642006-11-22 14:54:01 +00001382 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001383 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001384 unsigned long flags;
1385
Tejun Heo715f1302012-08-03 10:30:46 -07001386 if (!delay)
1387 return queue_work_on(cpu, wq, &dwork->work);
1388
Tejun Heo8930cab2012-08-03 10:30:45 -07001389 /* read the comment in __queue_work() */
1390 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001391
Tejun Heo22df02b2010-06-29 10:07:10 +02001392 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001393 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001394 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001395 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001396
1397 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001398 return ret;
1399}
Dave Jonesae90dd52006-06-30 01:40:45 -04001400EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401
Tejun Heoc8e55f32010-06-29 10:07:12 +02001402/**
Tejun Heo0a13c002012-08-03 10:30:44 -07001403 * queue_delayed_work - queue work on a workqueue after delay
1404 * @wq: workqueue to use
1405 * @dwork: delayable work to queue
1406 * @delay: number of jiffies to wait before queueing
1407 *
Tejun Heo715f1302012-08-03 10:30:46 -07001408 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
Tejun Heo0a13c002012-08-03 10:30:44 -07001409 */
Tejun Heod4283e92012-08-03 10:30:44 -07001410bool queue_delayed_work(struct workqueue_struct *wq,
Tejun Heo0a13c002012-08-03 10:30:44 -07001411 struct delayed_work *dwork, unsigned long delay)
1412{
Tejun Heo57469822012-08-03 10:30:45 -07001413 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
Tejun Heo0a13c002012-08-03 10:30:44 -07001414}
1415EXPORT_SYMBOL_GPL(queue_delayed_work);
1416
1417/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001418 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1419 * @cpu: CPU number to execute work on
1420 * @wq: workqueue to use
1421 * @dwork: work to queue
1422 * @delay: number of jiffies to wait before queueing
1423 *
1424 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1425 * modify @dwork's timer so that it expires after @delay. If @delay is
1426 * zero, @work is guaranteed to be scheduled immediately regardless of its
1427 * current state.
1428 *
1429 * Returns %false if @dwork was idle and queued, %true if @dwork was
1430 * pending and its timer was modified.
1431 *
1432 * This function is safe to call from any context other than IRQ handler.
1433 * See try_to_grab_pending() for details.
1434 */
1435bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1436 struct delayed_work *dwork, unsigned long delay)
1437{
1438 unsigned long flags;
1439 int ret;
1440
1441 do {
1442 ret = try_to_grab_pending(&dwork->work, true, &flags);
1443 } while (unlikely(ret == -EAGAIN));
1444
1445 if (likely(ret >= 0)) {
1446 __queue_delayed_work(cpu, wq, dwork, delay);
1447 local_irq_restore(flags);
1448 }
1449
1450 /* -ENOENT from try_to_grab_pending() becomes %true */
1451 return ret;
1452}
1453EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1454
1455/**
1456 * mod_delayed_work - modify delay of or queue a delayed work
1457 * @wq: workqueue to use
1458 * @dwork: work to queue
1459 * @delay: number of jiffies to wait before queueing
1460 *
1461 * mod_delayed_work_on() on local CPU.
1462 */
1463bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1464 unsigned long delay)
1465{
1466 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1467}
1468EXPORT_SYMBOL_GPL(mod_delayed_work);
1469
1470/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001471 * worker_enter_idle - enter idle state
1472 * @worker: worker which is entering idle state
1473 *
1474 * @worker is entering idle state. Update stats and idle timer if
1475 * necessary.
1476 *
1477 * LOCKING:
1478 * spin_lock_irq(gcwq->lock).
1479 */
1480static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001482 struct worker_pool *pool = worker->pool;
1483 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484
Tejun Heoc8e55f32010-06-29 10:07:12 +02001485 BUG_ON(worker->flags & WORKER_IDLE);
1486 BUG_ON(!list_empty(&worker->entry) &&
1487 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488
Tejun Heocb444762010-07-02 10:03:50 +02001489 /* can't use worker_set_flags(), also called from start_worker() */
1490 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001491 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001492 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001493
Tejun Heoc8e55f32010-06-29 10:07:12 +02001494 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001495 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001496
Tejun Heo628c78e2012-07-17 12:39:27 -07001497 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1498 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001499
Tejun Heo544ecf32012-05-14 15:04:50 -07001500 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07001501 * Sanity check nr_running. Because gcwq_unbind_fn() releases
1502 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1503 * nr_running, the warning may trigger spuriously. Check iff
1504 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001505 */
Tejun Heo628c78e2012-07-17 12:39:27 -07001506 WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001507 pool->nr_workers == pool->nr_idle &&
Tejun Heo63d95a92012-07-12 14:46:37 -07001508 atomic_read(get_pool_nr_running(pool)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509}
1510
Tejun Heoc8e55f32010-06-29 10:07:12 +02001511/**
1512 * worker_leave_idle - leave idle state
1513 * @worker: worker which is leaving idle state
1514 *
1515 * @worker is leaving idle state. Update stats.
1516 *
1517 * LOCKING:
1518 * spin_lock_irq(gcwq->lock).
1519 */
1520static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001522 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523
Tejun Heoc8e55f32010-06-29 10:07:12 +02001524 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001525 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001526 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001527 list_del_init(&worker->entry);
1528}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
Tejun Heoe22bee72010-06-29 10:07:14 +02001530/**
1531 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1532 * @worker: self
1533 *
1534 * Works which are scheduled while the cpu is online must at least be
1535 * scheduled to a worker which is bound to the cpu so that if they are
1536 * flushed from cpu callbacks while cpu is going down, they are
1537 * guaranteed to execute on the cpu.
1538 *
1539 * This function is to be used by rogue workers and rescuers to bind
1540 * themselves to the target cpu and may race with cpu going down or
1541 * coming online. kthread_bind() can't be used because it may put the
1542 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1543 * verbatim as it's best effort and blocking and gcwq may be
1544 * [dis]associated in the meantime.
1545 *
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001546 * This function tries set_cpus_allowed() and locks gcwq and verifies the
1547 * binding against %GCWQ_DISASSOCIATED which is set during
1548 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1549 * enters idle state or fetches works without dropping lock, it can
1550 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001551 *
1552 * CONTEXT:
1553 * Might sleep. Called without any lock but returns with gcwq->lock
1554 * held.
1555 *
1556 * RETURNS:
1557 * %true if the associated gcwq is online (@worker is successfully
1558 * bound), %false if offline.
1559 */
1560static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001561__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001562{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001563 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001564 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565
Tejun Heoe22bee72010-06-29 10:07:14 +02001566 while (true) {
1567 /*
1568 * The following call may fail, succeed or succeed
1569 * without actually migrating the task to the cpu if
1570 * it races with cpu hotunplug operation. Verify
1571 * against GCWQ_DISASSOCIATED.
1572 */
Tejun Heof3421792010-07-02 10:03:51 +02001573 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1574 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001575
Tejun Heoe22bee72010-06-29 10:07:14 +02001576 spin_lock_irq(&gcwq->lock);
1577 if (gcwq->flags & GCWQ_DISASSOCIATED)
1578 return false;
1579 if (task_cpu(task) == gcwq->cpu &&
1580 cpumask_equal(&current->cpus_allowed,
1581 get_cpu_mask(gcwq->cpu)))
1582 return true;
1583 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001584
Tejun Heo5035b202011-04-29 18:08:37 +02001585 /*
1586 * We've raced with CPU hot[un]plug. Give it a breather
1587 * and retry migration. cond_resched() is required here;
1588 * otherwise, we might deadlock against cpu_stop trying to
1589 * bring down the CPU on non-preemptive kernel.
1590 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001591 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001592 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001593 }
1594}
1595
Tejun Heo25511a42012-07-17 12:39:27 -07001596struct idle_rebind {
1597 int cnt; /* # workers to be rebound */
1598 struct completion done; /* all workers rebound */
1599};
1600
Tejun Heoe22bee72010-06-29 10:07:14 +02001601/*
Tejun Heo25511a42012-07-17 12:39:27 -07001602 * Rebind an idle @worker to its CPU. During CPU onlining, this has to
1603 * happen synchronously for idle workers. worker_thread() will test
1604 * %WORKER_REBIND before leaving idle and call this function.
1605 */
1606static void idle_worker_rebind(struct worker *worker)
1607{
1608 struct global_cwq *gcwq = worker->pool->gcwq;
1609
1610 /* CPU must be online at this point */
1611 WARN_ON(!worker_maybe_bind_and_lock(worker));
1612 if (!--worker->idle_rebind->cnt)
1613 complete(&worker->idle_rebind->done);
1614 spin_unlock_irq(&worker->pool->gcwq->lock);
1615
1616 /* we did our part, wait for rebind_workers() to finish up */
1617 wait_event(gcwq->rebind_hold, !(worker->flags & WORKER_REBIND));
1618}
1619
1620/*
1621 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001622 * the associated cpu which is coming back online. This is scheduled by
1623 * cpu up but can race with other cpu hotplug operations and may be
1624 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001625 */
Tejun Heo25511a42012-07-17 12:39:27 -07001626static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001627{
1628 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001629 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001630
1631 if (worker_maybe_bind_and_lock(worker))
1632 worker_clr_flags(worker, WORKER_REBIND);
1633
1634 spin_unlock_irq(&gcwq->lock);
1635}
1636
Tejun Heo25511a42012-07-17 12:39:27 -07001637/**
1638 * rebind_workers - rebind all workers of a gcwq to the associated CPU
1639 * @gcwq: gcwq of interest
1640 *
1641 * @gcwq->cpu is coming online. Rebind all workers to the CPU. Rebinding
1642 * is different for idle and busy ones.
1643 *
1644 * The idle ones should be rebound synchronously and idle rebinding should
1645 * be complete before any worker starts executing work items with
1646 * concurrency management enabled; otherwise, scheduler may oops trying to
1647 * wake up non-local idle worker from wq_worker_sleeping().
1648 *
1649 * This is achieved by repeatedly requesting rebinding until all idle
1650 * workers are known to have been rebound under @gcwq->lock and holding all
1651 * idle workers from becoming busy until idle rebinding is complete.
1652 *
1653 * Once idle workers are rebound, busy workers can be rebound as they
1654 * finish executing their current work items. Queueing the rebind work at
1655 * the head of their scheduled lists is enough. Note that nr_running will
1656 * be properbly bumped as busy workers rebind.
1657 *
1658 * On return, all workers are guaranteed to either be bound or have rebind
1659 * work item scheduled.
1660 */
1661static void rebind_workers(struct global_cwq *gcwq)
1662 __releases(&gcwq->lock) __acquires(&gcwq->lock)
1663{
1664 struct idle_rebind idle_rebind;
1665 struct worker_pool *pool;
1666 struct worker *worker;
1667 struct hlist_node *pos;
1668 int i;
1669
1670 lockdep_assert_held(&gcwq->lock);
1671
1672 for_each_worker_pool(pool, gcwq)
1673 lockdep_assert_held(&pool->manager_mutex);
1674
1675 /*
1676 * Rebind idle workers. Interlocked both ways. We wait for
1677 * workers to rebind via @idle_rebind.done. Workers will wait for
1678 * us to finish up by watching %WORKER_REBIND.
1679 */
1680 init_completion(&idle_rebind.done);
1681retry:
1682 idle_rebind.cnt = 1;
1683 INIT_COMPLETION(idle_rebind.done);
1684
1685 /* set REBIND and kick idle ones, we'll wait for these later */
1686 for_each_worker_pool(pool, gcwq) {
1687 list_for_each_entry(worker, &pool->idle_list, entry) {
1688 if (worker->flags & WORKER_REBIND)
1689 continue;
1690
1691 /* morph UNBOUND to REBIND */
1692 worker->flags &= ~WORKER_UNBOUND;
1693 worker->flags |= WORKER_REBIND;
1694
1695 idle_rebind.cnt++;
1696 worker->idle_rebind = &idle_rebind;
1697
1698 /* worker_thread() will call idle_worker_rebind() */
1699 wake_up_process(worker->task);
1700 }
1701 }
1702
1703 if (--idle_rebind.cnt) {
1704 spin_unlock_irq(&gcwq->lock);
1705 wait_for_completion(&idle_rebind.done);
1706 spin_lock_irq(&gcwq->lock);
1707 /* busy ones might have become idle while waiting, retry */
1708 goto retry;
1709 }
1710
1711 /*
1712 * All idle workers are rebound and waiting for %WORKER_REBIND to
1713 * be cleared inside idle_worker_rebind(). Clear and release.
1714 * Clearing %WORKER_REBIND from this foreign context is safe
1715 * because these workers are still guaranteed to be idle.
1716 */
1717 for_each_worker_pool(pool, gcwq)
1718 list_for_each_entry(worker, &pool->idle_list, entry)
1719 worker->flags &= ~WORKER_REBIND;
1720
1721 wake_up_all(&gcwq->rebind_hold);
1722
1723 /* rebind busy workers */
1724 for_each_busy_worker(worker, i, pos, gcwq) {
1725 struct work_struct *rebind_work = &worker->rebind_work;
1726
1727 /* morph UNBOUND to REBIND */
1728 worker->flags &= ~WORKER_UNBOUND;
1729 worker->flags |= WORKER_REBIND;
1730
1731 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1732 work_data_bits(rebind_work)))
1733 continue;
1734
1735 /* wq doesn't matter, use the default one */
1736 debug_work_activate(rebind_work);
1737 insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
1738 worker->scheduled.next,
1739 work_color_to_flags(WORK_NO_COLOR));
1740 }
1741}
1742
Tejun Heoc34056a2010-06-29 10:07:11 +02001743static struct worker *alloc_worker(void)
1744{
1745 struct worker *worker;
1746
1747 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001748 if (worker) {
1749 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001750 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001751 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001752 /* on creation a worker is in !idle && prep state */
1753 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001754 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001755 return worker;
1756}
1757
1758/**
1759 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001760 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001761 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001762 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001763 * can be started by calling start_worker() or destroyed using
1764 * destroy_worker().
1765 *
1766 * CONTEXT:
1767 * Might sleep. Does GFP_KERNEL allocations.
1768 *
1769 * RETURNS:
1770 * Pointer to the newly created worker.
1771 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001772static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001773{
Tejun Heo63d95a92012-07-12 14:46:37 -07001774 struct global_cwq *gcwq = pool->gcwq;
Tejun Heo32704762012-07-13 22:16:45 -07001775 const char *pri = worker_pool_pri(pool) ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001776 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001777 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001778
Tejun Heo8b03ae32010-06-29 10:07:12 +02001779 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001780 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001781 spin_unlock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001782 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001783 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001784 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001785 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001786 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001787
1788 worker = alloc_worker();
1789 if (!worker)
1790 goto fail;
1791
Tejun Heobd7bdd42012-07-12 14:46:37 -07001792 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001793 worker->id = id;
1794
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001795 if (gcwq->cpu != WORK_CPU_UNBOUND)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001796 worker->task = kthread_create_on_node(worker_thread,
Tejun Heo32704762012-07-13 22:16:45 -07001797 worker, cpu_to_node(gcwq->cpu),
1798 "kworker/%u:%d%s", gcwq->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001799 else
1800 worker->task = kthread_create(worker_thread, worker,
Tejun Heo32704762012-07-13 22:16:45 -07001801 "kworker/u:%d%s", id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001802 if (IS_ERR(worker->task))
1803 goto fail;
1804
Tejun Heo32704762012-07-13 22:16:45 -07001805 if (worker_pool_pri(pool))
1806 set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
1807
Tejun Heodb7bccf2010-06-29 10:07:12 +02001808 /*
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001809 * Determine CPU binding of the new worker depending on
1810 * %GCWQ_DISASSOCIATED. The caller is responsible for ensuring the
1811 * flag remains stable across this function. See the comments
1812 * above the flag definition for details.
1813 *
1814 * As an unbound worker may later become a regular one if CPU comes
1815 * online, make sure every worker has %PF_THREAD_BOUND set.
Tejun Heodb7bccf2010-06-29 10:07:12 +02001816 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001817 if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001818 kthread_bind(worker->task, gcwq->cpu);
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001819 } else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001820 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001821 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001823
Tejun Heoc34056a2010-06-29 10:07:11 +02001824 return worker;
1825fail:
1826 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001827 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001828 ida_remove(&pool->worker_ida, id);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001829 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001830 }
1831 kfree(worker);
1832 return NULL;
1833}
1834
1835/**
1836 * start_worker - start a newly created worker
1837 * @worker: worker to start
1838 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001839 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001840 *
1841 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001842 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001843 */
1844static void start_worker(struct worker *worker)
1845{
Tejun Heocb444762010-07-02 10:03:50 +02001846 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001847 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001848 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001849 wake_up_process(worker->task);
1850}
1851
1852/**
1853 * destroy_worker - destroy a workqueue worker
1854 * @worker: worker to be destroyed
1855 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001856 * Destroy @worker and adjust @gcwq stats accordingly.
1857 *
1858 * CONTEXT:
1859 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001860 */
1861static void destroy_worker(struct worker *worker)
1862{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001863 struct worker_pool *pool = worker->pool;
1864 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001865 int id = worker->id;
1866
1867 /* sanity check frenzy */
1868 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001869 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001870
Tejun Heoc8e55f32010-06-29 10:07:12 +02001871 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001872 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001873 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001874 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001875
1876 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001877 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001878
1879 spin_unlock_irq(&gcwq->lock);
1880
Tejun Heoc34056a2010-06-29 10:07:11 +02001881 kthread_stop(worker->task);
1882 kfree(worker);
1883
Tejun Heo8b03ae32010-06-29 10:07:12 +02001884 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001885 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001886}
1887
Tejun Heo63d95a92012-07-12 14:46:37 -07001888static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001889{
Tejun Heo63d95a92012-07-12 14:46:37 -07001890 struct worker_pool *pool = (void *)__pool;
1891 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001892
1893 spin_lock_irq(&gcwq->lock);
1894
Tejun Heo63d95a92012-07-12 14:46:37 -07001895 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001896 struct worker *worker;
1897 unsigned long expires;
1898
1899 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001900 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001901 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1902
1903 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001904 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001905 else {
1906 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001907 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001908 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001909 }
1910 }
1911
1912 spin_unlock_irq(&gcwq->lock);
1913}
1914
1915static bool send_mayday(struct work_struct *work)
1916{
1917 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1918 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001919 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001920
1921 if (!(wq->flags & WQ_RESCUER))
1922 return false;
1923
1924 /* mayday mayday mayday */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001925 cpu = cwq->pool->gcwq->cpu;
Tejun Heof3421792010-07-02 10:03:51 +02001926 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1927 if (cpu == WORK_CPU_UNBOUND)
1928 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001929 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001930 wake_up_process(wq->rescuer->task);
1931 return true;
1932}
1933
Tejun Heo63d95a92012-07-12 14:46:37 -07001934static void gcwq_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001935{
Tejun Heo63d95a92012-07-12 14:46:37 -07001936 struct worker_pool *pool = (void *)__pool;
1937 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001938 struct work_struct *work;
1939
1940 spin_lock_irq(&gcwq->lock);
1941
Tejun Heo63d95a92012-07-12 14:46:37 -07001942 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001943 /*
1944 * We've been trying to create a new worker but
1945 * haven't been successful. We might be hitting an
1946 * allocation deadlock. Send distress signals to
1947 * rescuers.
1948 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001949 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001950 send_mayday(work);
1951 }
1952
1953 spin_unlock_irq(&gcwq->lock);
1954
Tejun Heo63d95a92012-07-12 14:46:37 -07001955 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001956}
1957
1958/**
1959 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001960 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001961 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001962 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001963 * have at least one idle worker on return from this function. If
1964 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001965 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001966 * possible allocation deadlock.
1967 *
1968 * On return, need_to_create_worker() is guaranteed to be false and
1969 * may_start_working() true.
1970 *
1971 * LOCKING:
1972 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1973 * multiple times. Does GFP_KERNEL allocations. Called only from
1974 * manager.
1975 *
1976 * RETURNS:
1977 * false if no action was taken and gcwq->lock stayed locked, true
1978 * otherwise.
1979 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001980static bool maybe_create_worker(struct worker_pool *pool)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001981__releases(&gcwq->lock)
1982__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001983{
Tejun Heo63d95a92012-07-12 14:46:37 -07001984 struct global_cwq *gcwq = pool->gcwq;
1985
1986 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001987 return false;
1988restart:
Tejun Heo9f9c236442010-07-14 11:31:20 +02001989 spin_unlock_irq(&gcwq->lock);
1990
Tejun Heoe22bee72010-06-29 10:07:14 +02001991 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001992 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001993
1994 while (true) {
1995 struct worker *worker;
1996
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001997 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001998 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001999 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002000 spin_lock_irq(&gcwq->lock);
2001 start_worker(worker);
Tejun Heo63d95a92012-07-12 14:46:37 -07002002 BUG_ON(need_to_create_worker(pool));
Tejun Heoe22bee72010-06-29 10:07:14 +02002003 return true;
2004 }
2005
Tejun Heo63d95a92012-07-12 14:46:37 -07002006 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002007 break;
2008
Tejun Heoe22bee72010-06-29 10:07:14 +02002009 __set_current_state(TASK_INTERRUPTIBLE);
2010 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02002011
Tejun Heo63d95a92012-07-12 14:46:37 -07002012 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002013 break;
2014 }
2015
Tejun Heo63d95a92012-07-12 14:46:37 -07002016 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002017 spin_lock_irq(&gcwq->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07002018 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002019 goto restart;
2020 return true;
2021}
2022
2023/**
2024 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07002025 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02002026 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002027 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02002028 * IDLE_WORKER_TIMEOUT.
2029 *
2030 * LOCKING:
2031 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2032 * multiple times. Called only from manager.
2033 *
2034 * RETURNS:
2035 * false if no action was taken and gcwq->lock stayed locked, true
2036 * otherwise.
2037 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002038static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02002039{
2040 bool ret = false;
2041
Tejun Heo63d95a92012-07-12 14:46:37 -07002042 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002043 struct worker *worker;
2044 unsigned long expires;
2045
Tejun Heo63d95a92012-07-12 14:46:37 -07002046 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002047 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2048
2049 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002050 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02002051 break;
2052 }
2053
2054 destroy_worker(worker);
2055 ret = true;
2056 }
2057
2058 return ret;
2059}
2060
2061/**
2062 * manage_workers - manage worker pool
2063 * @worker: self
2064 *
2065 * Assume the manager role and manage gcwq worker pool @worker belongs
2066 * to. At any given time, there can be only zero or one manager per
2067 * gcwq. The exclusion is handled automatically by this function.
2068 *
2069 * The caller can safely start processing works on false return. On
2070 * true return, it's guaranteed that need_to_create_worker() is false
2071 * and may_start_working() is true.
2072 *
2073 * CONTEXT:
2074 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2075 * multiple times. Does GFP_KERNEL allocations.
2076 *
2077 * RETURNS:
2078 * false if no action was taken and gcwq->lock stayed locked, true if
2079 * some action was taken.
2080 */
2081static bool manage_workers(struct worker *worker)
2082{
Tejun Heo63d95a92012-07-12 14:46:37 -07002083 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002084 bool ret = false;
2085
Tejun Heo60373152012-07-17 12:39:27 -07002086 if (!mutex_trylock(&pool->manager_mutex))
Tejun Heoe22bee72010-06-29 10:07:14 +02002087 return ret;
2088
Tejun Heo11ebea52012-07-12 14:46:37 -07002089 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002090
2091 /*
2092 * Destroy and then create so that may_start_working() is true
2093 * on return.
2094 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002095 ret |= maybe_destroy_workers(pool);
2096 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002097
Tejun Heo60373152012-07-17 12:39:27 -07002098 mutex_unlock(&pool->manager_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02002099 return ret;
2100}
2101
Tejun Heoa62428c2010-06-29 10:07:10 +02002102/**
2103 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002104 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002105 * @work: work to process
2106 *
2107 * Process @work. This function contains all the logics necessary to
2108 * process a single work including synchronization against and
2109 * interaction with other workers on the same cpu, queueing and
2110 * flushing. As long as context requirement is met, any worker can
2111 * call this function to process a work.
2112 *
2113 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002114 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002115 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002116static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09002117__releases(&gcwq->lock)
2118__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002119{
Tejun Heo7e116292010-06-29 10:07:13 +02002120 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002121 struct worker_pool *pool = worker->pool;
2122 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002123 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002124 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02002125 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02002126 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002127 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002128#ifdef CONFIG_LOCKDEP
2129 /*
2130 * It is permissible to free the struct work_struct from
2131 * inside the function that is called from it, this we need to
2132 * take into account for lockdep too. To avoid bogus "held
2133 * lock freed" warnings as well as problems when looking into
2134 * work->lockdep_map, make a copy and use that here.
2135 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002136 struct lockdep_map lockdep_map;
2137
2138 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002139#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002140 /*
2141 * Ensure we're on the correct CPU. DISASSOCIATED test is
2142 * necessary to avoid spurious warnings from rescuers servicing the
2143 * unbound or a disassociated gcwq.
2144 */
Tejun Heo25511a42012-07-17 12:39:27 -07002145 WARN_ON_ONCE(!(worker->flags & (WORKER_UNBOUND | WORKER_REBIND)) &&
Tejun Heo6fec10a2012-07-22 10:16:34 -07002146 !(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heo25511a42012-07-17 12:39:27 -07002147 raw_smp_processor_id() != gcwq->cpu);
2148
Tejun Heo7e116292010-06-29 10:07:13 +02002149 /*
2150 * A single work shouldn't be executed concurrently by
2151 * multiple workers on a single cpu. Check whether anyone is
2152 * already processing the work. If so, defer the work to the
2153 * currently executing one.
2154 */
2155 collision = __find_worker_executing_work(gcwq, bwh, work);
2156 if (unlikely(collision)) {
2157 move_linked_works(work, &collision->scheduled, NULL);
2158 return;
2159 }
2160
Tejun Heo8930cab2012-08-03 10:30:45 -07002161 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002162 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002163 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02002164 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002165 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002166 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002167
Tejun Heoa62428c2010-06-29 10:07:10 +02002168 list_del_init(&work->entry);
2169
Tejun Heo649027d2010-06-29 10:07:14 +02002170 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002171 * CPU intensive works don't participate in concurrency
2172 * management. They're the scheduler's responsibility.
2173 */
2174 if (unlikely(cpu_intensive))
2175 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2176
Tejun Heo974271c2012-07-12 14:46:37 -07002177 /*
2178 * Unbound gcwq isn't concurrency managed and work items should be
2179 * executed ASAP. Wake up another worker if necessary.
2180 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002181 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2182 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002183
Tejun Heo8930cab2012-08-03 10:30:45 -07002184 /*
2185 * Record the last CPU and clear PENDING. The following wmb is
2186 * paired with the implied mb in test_and_set_bit(PENDING) and
2187 * ensures all updates to @work made here are visible to and
2188 * precede any updates by the next PENDING owner. Also, clear
2189 * PENDING inside @gcwq->lock so that PENDING and queued state
2190 * changes happen together while IRQ is disabled.
2191 */
2192 smp_wmb();
2193 set_work_cpu_and_clear_pending(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02002194
Tejun Heo8930cab2012-08-03 10:30:45 -07002195 spin_unlock_irq(&gcwq->lock);
Tejun Heo959d1af2012-08-03 10:30:45 -07002196
Tejun Heoe159489b2011-01-09 23:32:15 +01002197 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002198 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002199 trace_workqueue_execute_start(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002200 f(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002201 /*
2202 * While we must be careful to not use "work" after this, the trace
2203 * point will only record its address.
2204 */
2205 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002206 lock_map_release(&lockdep_map);
2207 lock_map_release(&cwq->wq->lockdep_map);
2208
2209 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2210 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
2211 "%s/0x%08x/%d\n",
2212 current->comm, preempt_count(), task_pid_nr(current));
2213 printk(KERN_ERR " last function: ");
2214 print_symbol("%s\n", (unsigned long)f);
2215 debug_show_held_locks(current);
2216 dump_stack();
2217 }
2218
Tejun Heo8b03ae32010-06-29 10:07:12 +02002219 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002220
Tejun Heofb0e7be2010-06-29 10:07:15 +02002221 /* clear cpu intensive status */
2222 if (unlikely(cpu_intensive))
2223 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2224
Tejun Heoa62428c2010-06-29 10:07:10 +02002225 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02002226 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002227 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002228 worker->current_cwq = NULL;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02002229 cwq_dec_nr_in_flight(cwq, work_color, false);
Tejun Heoa62428c2010-06-29 10:07:10 +02002230}
2231
Tejun Heoaffee4b2010-06-29 10:07:12 +02002232/**
2233 * process_scheduled_works - process scheduled works
2234 * @worker: self
2235 *
2236 * Process all scheduled works. Please note that the scheduled list
2237 * may change while processing a work, so this function repeatedly
2238 * fetches a work from the top and executes it.
2239 *
2240 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002241 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002242 * multiple times.
2243 */
2244static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002246 while (!list_empty(&worker->scheduled)) {
2247 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002249 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251}
2252
Tejun Heo4690c4a2010-06-29 10:07:10 +02002253/**
2254 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002255 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002256 *
Tejun Heoe22bee72010-06-29 10:07:14 +02002257 * The gcwq worker thread function. There's a single dynamic pool of
2258 * these per each cpu. These workers process all works regardless of
2259 * their specific target workqueue. The only exception is works which
2260 * belong to workqueues with a rescuer which will be explained in
2261 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002262 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002263static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264{
Tejun Heoc34056a2010-06-29 10:07:11 +02002265 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002266 struct worker_pool *pool = worker->pool;
2267 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268
Tejun Heoe22bee72010-06-29 10:07:14 +02002269 /* tell the scheduler that this is a workqueue worker */
2270 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002271woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002272 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273
Tejun Heo25511a42012-07-17 12:39:27 -07002274 /*
2275 * DIE can be set only while idle and REBIND set while busy has
2276 * @worker->rebind_work scheduled. Checking here is enough.
2277 */
2278 if (unlikely(worker->flags & (WORKER_REBIND | WORKER_DIE))) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002279 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002280
2281 if (worker->flags & WORKER_DIE) {
2282 worker->task->flags &= ~PF_WQ_WORKER;
2283 return 0;
2284 }
2285
2286 idle_worker_rebind(worker);
2287 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 }
2289
Tejun Heoc8e55f32010-06-29 10:07:12 +02002290 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002291recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002292 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002293 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002294 goto sleep;
2295
2296 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002297 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002298 goto recheck;
2299
Tejun Heoc8e55f32010-06-29 10:07:12 +02002300 /*
2301 * ->scheduled list can only be filled while a worker is
2302 * preparing to process a work or actually processing it.
2303 * Make sure nobody diddled with it while I was sleeping.
2304 */
2305 BUG_ON(!list_empty(&worker->scheduled));
2306
Tejun Heoe22bee72010-06-29 10:07:14 +02002307 /*
2308 * When control reaches this point, we're guaranteed to have
2309 * at least one idle worker or that someone else has already
2310 * assumed the manager role.
2311 */
2312 worker_clr_flags(worker, WORKER_PREP);
2313
2314 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002315 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002316 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002317 struct work_struct, entry);
2318
2319 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2320 /* optimization path, not strictly necessary */
2321 process_one_work(worker, work);
2322 if (unlikely(!list_empty(&worker->scheduled)))
2323 process_scheduled_works(worker);
2324 } else {
2325 move_linked_works(work, &worker->scheduled, NULL);
2326 process_scheduled_works(worker);
2327 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002328 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002329
Tejun Heoe22bee72010-06-29 10:07:14 +02002330 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002331sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002332 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002333 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002334
Tejun Heoc8e55f32010-06-29 10:07:12 +02002335 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02002336 * gcwq->lock is held and there's no work to process and no
2337 * need to manage, sleep. Workers are woken up only while
2338 * holding gcwq->lock or from local cpu, so setting the
2339 * current state before releasing gcwq->lock is enough to
2340 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002341 */
2342 worker_enter_idle(worker);
2343 __set_current_state(TASK_INTERRUPTIBLE);
2344 spin_unlock_irq(&gcwq->lock);
2345 schedule();
2346 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347}
2348
Tejun Heoe22bee72010-06-29 10:07:14 +02002349/**
2350 * rescuer_thread - the rescuer thread function
2351 * @__wq: the associated workqueue
2352 *
2353 * Workqueue rescuer thread function. There's one rescuer for each
2354 * workqueue which has WQ_RESCUER set.
2355 *
2356 * Regular work processing on a gcwq may block trying to create a new
2357 * worker which uses GFP_KERNEL allocation which has slight chance of
2358 * developing into deadlock if some works currently on the same queue
2359 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2360 * the problem rescuer solves.
2361 *
2362 * When such condition is possible, the gcwq summons rescuers of all
2363 * workqueues which have works queued on the gcwq and let them process
2364 * those works so that forward progress can be guaranteed.
2365 *
2366 * This should happen rarely.
2367 */
2368static int rescuer_thread(void *__wq)
2369{
2370 struct workqueue_struct *wq = __wq;
2371 struct worker *rescuer = wq->rescuer;
2372 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002373 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002374 unsigned int cpu;
2375
2376 set_user_nice(current, RESCUER_NICE_LEVEL);
2377repeat:
2378 set_current_state(TASK_INTERRUPTIBLE);
2379
2380 if (kthread_should_stop())
2381 return 0;
2382
Tejun Heof3421792010-07-02 10:03:51 +02002383 /*
2384 * See whether any cpu is asking for help. Unbounded
2385 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2386 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002387 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002388 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2389 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002390 struct worker_pool *pool = cwq->pool;
2391 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002392 struct work_struct *work, *n;
2393
2394 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002395 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002396
2397 /* migrate to the target cpu if possible */
Tejun Heobd7bdd42012-07-12 14:46:37 -07002398 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002399 worker_maybe_bind_and_lock(rescuer);
2400
2401 /*
2402 * Slurp in all works issued via this workqueue and
2403 * process'em.
2404 */
2405 BUG_ON(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002406 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002407 if (get_work_cwq(work) == cwq)
2408 move_linked_works(work, scheduled, &n);
2409
2410 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002411
2412 /*
2413 * Leave this gcwq. If keep_working() is %true, notify a
2414 * regular worker; otherwise, we end up with 0 concurrency
2415 * and stalling the execution.
2416 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002417 if (keep_working(pool))
2418 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002419
Tejun Heoe22bee72010-06-29 10:07:14 +02002420 spin_unlock_irq(&gcwq->lock);
2421 }
2422
2423 schedule();
2424 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425}
2426
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002427struct wq_barrier {
2428 struct work_struct work;
2429 struct completion done;
2430};
2431
2432static void wq_barrier_func(struct work_struct *work)
2433{
2434 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2435 complete(&barr->done);
2436}
2437
Tejun Heo4690c4a2010-06-29 10:07:10 +02002438/**
2439 * insert_wq_barrier - insert a barrier work
2440 * @cwq: cwq to insert barrier into
2441 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002442 * @target: target work to attach @barr to
2443 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002444 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002445 * @barr is linked to @target such that @barr is completed only after
2446 * @target finishes execution. Please note that the ordering
2447 * guarantee is observed only with respect to @target and on the local
2448 * cpu.
2449 *
2450 * Currently, a queued barrier can't be canceled. This is because
2451 * try_to_grab_pending() can't determine whether the work to be
2452 * grabbed is at the head of the queue and thus can't clear LINKED
2453 * flag of the previous work while there must be a valid next work
2454 * after a work with LINKED flag set.
2455 *
2456 * Note that when @worker is non-NULL, @target may be modified
2457 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002458 *
2459 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002460 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002461 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002462static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002463 struct wq_barrier *barr,
2464 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002465{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002466 struct list_head *head;
2467 unsigned int linked = 0;
2468
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002469 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002470 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002471 * as we know for sure that this will not trigger any of the
2472 * checks and call back into the fixup functions where we
2473 * might deadlock.
2474 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002475 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002476 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002477 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002478
Tejun Heoaffee4b2010-06-29 10:07:12 +02002479 /*
2480 * If @target is currently being executed, schedule the
2481 * barrier to the worker; otherwise, put it after @target.
2482 */
2483 if (worker)
2484 head = worker->scheduled.next;
2485 else {
2486 unsigned long *bits = work_data_bits(target);
2487
2488 head = target->entry.next;
2489 /* there can already be other linked works, inherit and set */
2490 linked = *bits & WORK_STRUCT_LINKED;
2491 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2492 }
2493
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002494 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002495 insert_work(cwq, &barr->work, head,
2496 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002497}
2498
Tejun Heo73f53c42010-06-29 10:07:11 +02002499/**
2500 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2501 * @wq: workqueue being flushed
2502 * @flush_color: new flush color, < 0 for no-op
2503 * @work_color: new work color, < 0 for no-op
2504 *
2505 * Prepare cwqs for workqueue flushing.
2506 *
2507 * If @flush_color is non-negative, flush_color on all cwqs should be
2508 * -1. If no cwq has in-flight commands at the specified color, all
2509 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2510 * has in flight commands, its cwq->flush_color is set to
2511 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2512 * wakeup logic is armed and %true is returned.
2513 *
2514 * The caller should have initialized @wq->first_flusher prior to
2515 * calling this function with non-negative @flush_color. If
2516 * @flush_color is negative, no flush color update is done and %false
2517 * is returned.
2518 *
2519 * If @work_color is non-negative, all cwqs should have the same
2520 * work_color which is previous to @work_color and all will be
2521 * advanced to @work_color.
2522 *
2523 * CONTEXT:
2524 * mutex_lock(wq->flush_mutex).
2525 *
2526 * RETURNS:
2527 * %true if @flush_color >= 0 and there's something to flush. %false
2528 * otherwise.
2529 */
2530static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2531 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532{
Tejun Heo73f53c42010-06-29 10:07:11 +02002533 bool wait = false;
2534 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002535
Tejun Heo73f53c42010-06-29 10:07:11 +02002536 if (flush_color >= 0) {
2537 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2538 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002539 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002540
Tejun Heof3421792010-07-02 10:03:51 +02002541 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002542 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002543 struct global_cwq *gcwq = cwq->pool->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002544
Tejun Heo8b03ae32010-06-29 10:07:12 +02002545 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002546
2547 if (flush_color >= 0) {
2548 BUG_ON(cwq->flush_color != -1);
2549
2550 if (cwq->nr_in_flight[flush_color]) {
2551 cwq->flush_color = flush_color;
2552 atomic_inc(&wq->nr_cwqs_to_flush);
2553 wait = true;
2554 }
2555 }
2556
2557 if (work_color >= 0) {
2558 BUG_ON(work_color != work_next_color(cwq->work_color));
2559 cwq->work_color = work_color;
2560 }
2561
Tejun Heo8b03ae32010-06-29 10:07:12 +02002562 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002563 }
2564
2565 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2566 complete(&wq->first_flusher->done);
2567
2568 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569}
2570
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002571/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002573 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574 *
2575 * Forces execution of the workqueue and blocks until its completion.
2576 * This is typically used in driver shutdown handlers.
2577 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002578 * We sleep until all works which were queued on entry have been handled,
2579 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002580 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002581void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582{
Tejun Heo73f53c42010-06-29 10:07:11 +02002583 struct wq_flusher this_flusher = {
2584 .list = LIST_HEAD_INIT(this_flusher.list),
2585 .flush_color = -1,
2586 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2587 };
2588 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002589
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002590 lock_map_acquire(&wq->lockdep_map);
2591 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002592
2593 mutex_lock(&wq->flush_mutex);
2594
2595 /*
2596 * Start-to-wait phase
2597 */
2598 next_color = work_next_color(wq->work_color);
2599
2600 if (next_color != wq->flush_color) {
2601 /*
2602 * Color space is not full. The current work_color
2603 * becomes our flush_color and work_color is advanced
2604 * by one.
2605 */
2606 BUG_ON(!list_empty(&wq->flusher_overflow));
2607 this_flusher.flush_color = wq->work_color;
2608 wq->work_color = next_color;
2609
2610 if (!wq->first_flusher) {
2611 /* no flush in progress, become the first flusher */
2612 BUG_ON(wq->flush_color != this_flusher.flush_color);
2613
2614 wq->first_flusher = &this_flusher;
2615
2616 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2617 wq->work_color)) {
2618 /* nothing to flush, done */
2619 wq->flush_color = next_color;
2620 wq->first_flusher = NULL;
2621 goto out_unlock;
2622 }
2623 } else {
2624 /* wait in queue */
2625 BUG_ON(wq->flush_color == this_flusher.flush_color);
2626 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2627 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2628 }
2629 } else {
2630 /*
2631 * Oops, color space is full, wait on overflow queue.
2632 * The next flush completion will assign us
2633 * flush_color and transfer to flusher_queue.
2634 */
2635 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2636 }
2637
2638 mutex_unlock(&wq->flush_mutex);
2639
2640 wait_for_completion(&this_flusher.done);
2641
2642 /*
2643 * Wake-up-and-cascade phase
2644 *
2645 * First flushers are responsible for cascading flushes and
2646 * handling overflow. Non-first flushers can simply return.
2647 */
2648 if (wq->first_flusher != &this_flusher)
2649 return;
2650
2651 mutex_lock(&wq->flush_mutex);
2652
Tejun Heo4ce48b32010-07-02 10:03:51 +02002653 /* we might have raced, check again with mutex held */
2654 if (wq->first_flusher != &this_flusher)
2655 goto out_unlock;
2656
Tejun Heo73f53c42010-06-29 10:07:11 +02002657 wq->first_flusher = NULL;
2658
2659 BUG_ON(!list_empty(&this_flusher.list));
2660 BUG_ON(wq->flush_color != this_flusher.flush_color);
2661
2662 while (true) {
2663 struct wq_flusher *next, *tmp;
2664
2665 /* complete all the flushers sharing the current flush color */
2666 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2667 if (next->flush_color != wq->flush_color)
2668 break;
2669 list_del_init(&next->list);
2670 complete(&next->done);
2671 }
2672
2673 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2674 wq->flush_color != work_next_color(wq->work_color));
2675
2676 /* this flush_color is finished, advance by one */
2677 wq->flush_color = work_next_color(wq->flush_color);
2678
2679 /* one color has been freed, handle overflow queue */
2680 if (!list_empty(&wq->flusher_overflow)) {
2681 /*
2682 * Assign the same color to all overflowed
2683 * flushers, advance work_color and append to
2684 * flusher_queue. This is the start-to-wait
2685 * phase for these overflowed flushers.
2686 */
2687 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2688 tmp->flush_color = wq->work_color;
2689
2690 wq->work_color = work_next_color(wq->work_color);
2691
2692 list_splice_tail_init(&wq->flusher_overflow,
2693 &wq->flusher_queue);
2694 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2695 }
2696
2697 if (list_empty(&wq->flusher_queue)) {
2698 BUG_ON(wq->flush_color != wq->work_color);
2699 break;
2700 }
2701
2702 /*
2703 * Need to flush more colors. Make the next flusher
2704 * the new first flusher and arm cwqs.
2705 */
2706 BUG_ON(wq->flush_color == wq->work_color);
2707 BUG_ON(wq->flush_color != next->flush_color);
2708
2709 list_del_init(&next->list);
2710 wq->first_flusher = next;
2711
2712 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2713 break;
2714
2715 /*
2716 * Meh... this color is already done, clear first
2717 * flusher and repeat cascading.
2718 */
2719 wq->first_flusher = NULL;
2720 }
2721
2722out_unlock:
2723 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002724}
Dave Jonesae90dd52006-06-30 01:40:45 -04002725EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002727/**
2728 * drain_workqueue - drain a workqueue
2729 * @wq: workqueue to drain
2730 *
2731 * Wait until the workqueue becomes empty. While draining is in progress,
2732 * only chain queueing is allowed. IOW, only currently pending or running
2733 * work items on @wq can queue further work items on it. @wq is flushed
2734 * repeatedly until it becomes empty. The number of flushing is detemined
2735 * by the depth of chaining and should be relatively short. Whine if it
2736 * takes too long.
2737 */
2738void drain_workqueue(struct workqueue_struct *wq)
2739{
2740 unsigned int flush_cnt = 0;
2741 unsigned int cpu;
2742
2743 /*
2744 * __queue_work() needs to test whether there are drainers, is much
2745 * hotter than drain_workqueue() and already looks at @wq->flags.
2746 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2747 */
2748 spin_lock(&workqueue_lock);
2749 if (!wq->nr_drainers++)
2750 wq->flags |= WQ_DRAINING;
2751 spin_unlock(&workqueue_lock);
2752reflush:
2753 flush_workqueue(wq);
2754
2755 for_each_cwq_cpu(cpu, wq) {
2756 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002757 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002758
Tejun Heobd7bdd42012-07-12 14:46:37 -07002759 spin_lock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002760 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002761 spin_unlock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002762
2763 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002764 continue;
2765
2766 if (++flush_cnt == 10 ||
2767 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2768 pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
2769 wq->name, flush_cnt);
2770 goto reflush;
2771 }
2772
2773 spin_lock(&workqueue_lock);
2774 if (!--wq->nr_drainers)
2775 wq->flags &= ~WQ_DRAINING;
2776 spin_unlock(&workqueue_lock);
2777}
2778EXPORT_SYMBOL_GPL(drain_workqueue);
2779
Tejun Heobaf59022010-09-16 10:42:16 +02002780static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2781 bool wait_executing)
2782{
2783 struct worker *worker = NULL;
2784 struct global_cwq *gcwq;
2785 struct cpu_workqueue_struct *cwq;
2786
2787 might_sleep();
2788 gcwq = get_work_gcwq(work);
2789 if (!gcwq)
2790 return false;
2791
2792 spin_lock_irq(&gcwq->lock);
2793 if (!list_empty(&work->entry)) {
2794 /*
2795 * See the comment near try_to_grab_pending()->smp_rmb().
2796 * If it was re-queued to a different gcwq under us, we
2797 * are not going to wait.
2798 */
2799 smp_rmb();
2800 cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002801 if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
Tejun Heobaf59022010-09-16 10:42:16 +02002802 goto already_gone;
2803 } else if (wait_executing) {
2804 worker = find_worker_executing_work(gcwq, work);
2805 if (!worker)
2806 goto already_gone;
2807 cwq = worker->current_cwq;
2808 } else
2809 goto already_gone;
2810
2811 insert_wq_barrier(cwq, barr, work, worker);
2812 spin_unlock_irq(&gcwq->lock);
2813
Tejun Heoe159489b2011-01-09 23:32:15 +01002814 /*
2815 * If @max_active is 1 or rescuer is in use, flushing another work
2816 * item on the same workqueue may lead to deadlock. Make sure the
2817 * flusher is not running on the same workqueue by verifying write
2818 * access.
2819 */
2820 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2821 lock_map_acquire(&cwq->wq->lockdep_map);
2822 else
2823 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002824 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe159489b2011-01-09 23:32:15 +01002825
Tejun Heobaf59022010-09-16 10:42:16 +02002826 return true;
2827already_gone:
2828 spin_unlock_irq(&gcwq->lock);
2829 return false;
2830}
2831
Oleg Nesterovdb700892008-07-25 01:47:49 -07002832/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002833 * flush_work - wait for a work to finish executing the last queueing instance
2834 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002835 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002836 * Wait until @work has finished execution. This function considers
2837 * only the last queueing instance of @work. If @work has been
2838 * enqueued across different CPUs on a non-reentrant workqueue or on
2839 * multiple workqueues, @work might still be executing on return on
2840 * some of the CPUs from earlier queueing.
Oleg Nesterova67da702008-07-25 01:47:52 -07002841 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002842 * If @work was queued only on a non-reentrant, ordered or unbound
2843 * workqueue, @work is guaranteed to be idle on return if it hasn't
2844 * been requeued since flush started.
2845 *
2846 * RETURNS:
2847 * %true if flush_work() waited for the work to finish execution,
2848 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002849 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002850bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002851{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002852 struct wq_barrier barr;
2853
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002854 lock_map_acquire(&work->lockdep_map);
2855 lock_map_release(&work->lockdep_map);
2856
Tejun Heobaf59022010-09-16 10:42:16 +02002857 if (start_flush_work(work, &barr, true)) {
2858 wait_for_completion(&barr.done);
2859 destroy_work_on_stack(&barr.work);
2860 return true;
2861 } else
2862 return false;
Oleg Nesterovdb700892008-07-25 01:47:49 -07002863}
2864EXPORT_SYMBOL_GPL(flush_work);
2865
Tejun Heo401a8d02010-09-16 10:36:00 +02002866static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2867{
2868 struct wq_barrier barr;
2869 struct worker *worker;
2870
2871 spin_lock_irq(&gcwq->lock);
2872
2873 worker = find_worker_executing_work(gcwq, work);
2874 if (unlikely(worker))
2875 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2876
2877 spin_unlock_irq(&gcwq->lock);
2878
2879 if (unlikely(worker)) {
2880 wait_for_completion(&barr.done);
2881 destroy_work_on_stack(&barr.work);
2882 return true;
2883 } else
2884 return false;
2885}
2886
2887static bool wait_on_work(struct work_struct *work)
2888{
2889 bool ret = false;
2890 int cpu;
2891
2892 might_sleep();
2893
2894 lock_map_acquire(&work->lockdep_map);
2895 lock_map_release(&work->lockdep_map);
2896
2897 for_each_gcwq_cpu(cpu)
2898 ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2899 return ret;
2900}
2901
Tejun Heo09383492010-09-16 10:48:29 +02002902/**
2903 * flush_work_sync - wait until a work has finished execution
2904 * @work: the work to flush
2905 *
2906 * Wait until @work has finished execution. On return, it's
2907 * guaranteed that all queueing instances of @work which happened
2908 * before this function is called are finished. In other words, if
2909 * @work hasn't been requeued since this function was called, @work is
2910 * guaranteed to be idle on return.
2911 *
2912 * RETURNS:
2913 * %true if flush_work_sync() waited for the work to finish execution,
2914 * %false if it was already idle.
2915 */
2916bool flush_work_sync(struct work_struct *work)
2917{
2918 struct wq_barrier barr;
2919 bool pending, waited;
2920
2921 /* we'll wait for executions separately, queue barr only if pending */
2922 pending = start_flush_work(work, &barr, false);
2923
2924 /* wait for executions to finish */
2925 waited = wait_on_work(work);
2926
2927 /* wait for the pending one */
2928 if (pending) {
2929 wait_for_completion(&barr.done);
2930 destroy_work_on_stack(&barr.work);
2931 }
2932
2933 return pending || waited;
2934}
2935EXPORT_SYMBOL_GPL(flush_work_sync);
2936
Tejun Heo36e227d2012-08-03 10:30:46 -07002937static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002938{
Tejun Heobbb68df2012-08-03 10:30:46 -07002939 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002940 int ret;
2941
2942 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002943 ret = try_to_grab_pending(work, is_dwork, &flags);
2944 /*
2945 * If someone else is canceling, wait for the same event it
2946 * would be waiting for before retrying.
2947 */
2948 if (unlikely(ret == -ENOENT))
2949 wait_on_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002950 } while (unlikely(ret < 0));
2951
Tejun Heobbb68df2012-08-03 10:30:46 -07002952 /* tell other tasks trying to grab @work to back off */
2953 mark_work_canceling(work);
2954 local_irq_restore(flags);
2955
2956 wait_on_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002957 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002958 return ret;
2959}
2960
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002961/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002962 * cancel_work_sync - cancel a work and wait for it to finish
2963 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002964 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002965 * Cancel @work and wait for its execution to finish. This function
2966 * can be used even if the work re-queues itself or migrates to
2967 * another workqueue. On return from this function, @work is
2968 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002969 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002970 * cancel_work_sync(&delayed_work->work) must not be used for
2971 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002972 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002973 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002974 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002975 *
2976 * RETURNS:
2977 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002978 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002979bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002980{
Tejun Heo36e227d2012-08-03 10:30:46 -07002981 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002982}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002983EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002984
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002985/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002986 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2987 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002988 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002989 * Delayed timer is cancelled and the pending work is queued for
2990 * immediate execution. Like flush_work(), this function only
2991 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002992 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002993 * RETURNS:
2994 * %true if flush_work() waited for the work to finish execution,
2995 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002996 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002997bool flush_delayed_work(struct delayed_work *dwork)
2998{
Tejun Heo8930cab2012-08-03 10:30:45 -07002999 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003000 if (del_timer_sync(&dwork->timer))
Tejun Heo12650572012-08-08 09:38:42 -07003001 __queue_work(dwork->cpu,
Tejun Heo401a8d02010-09-16 10:36:00 +02003002 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003003 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003004 return flush_work(&dwork->work);
3005}
3006EXPORT_SYMBOL(flush_delayed_work);
3007
3008/**
Tejun Heo09383492010-09-16 10:48:29 +02003009 * flush_delayed_work_sync - wait for a dwork to finish
3010 * @dwork: the delayed work to flush
3011 *
3012 * Delayed timer is cancelled and the pending work is queued for
3013 * execution immediately. Other than timer handling, its behavior
3014 * is identical to flush_work_sync().
3015 *
3016 * RETURNS:
3017 * %true if flush_work_sync() waited for the work to finish execution,
3018 * %false if it was already idle.
3019 */
3020bool flush_delayed_work_sync(struct delayed_work *dwork)
3021{
Tejun Heo8930cab2012-08-03 10:30:45 -07003022 local_irq_disable();
Tejun Heo09383492010-09-16 10:48:29 +02003023 if (del_timer_sync(&dwork->timer))
Tejun Heo12650572012-08-08 09:38:42 -07003024 __queue_work(dwork->cpu,
Tejun Heo09383492010-09-16 10:48:29 +02003025 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003026 local_irq_enable();
Tejun Heo09383492010-09-16 10:48:29 +02003027 return flush_work_sync(&dwork->work);
3028}
3029EXPORT_SYMBOL(flush_delayed_work_sync);
3030
3031/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003032 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3033 * @dwork: the delayed work cancel
3034 *
3035 * This is cancel_work_sync() for delayed works.
3036 *
3037 * RETURNS:
3038 * %true if @dwork was pending, %false otherwise.
3039 */
3040bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003041{
Tejun Heo36e227d2012-08-03 10:30:46 -07003042 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003043}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003044EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045
Tejun Heod4283e92012-08-03 10:30:44 -07003046/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003047 * schedule_work_on - put work task on a specific cpu
3048 * @cpu: cpu to put the work task on
3049 * @work: job to be done
3050 *
3051 * This puts a job on a specific cpu
3052 */
Tejun Heod4283e92012-08-03 10:30:44 -07003053bool schedule_work_on(int cpu, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07003054{
3055 return queue_work_on(cpu, system_wq, work);
3056}
3057EXPORT_SYMBOL(schedule_work_on);
3058
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003059/**
3060 * schedule_work - put work task in global workqueue
3061 * @work: job to be done
3062 *
Tejun Heod4283e92012-08-03 10:30:44 -07003063 * Returns %false if @work was already on the kernel-global workqueue and
3064 * %true otherwise.
Bart Van Assche5b0f437d2009-07-30 19:00:53 +02003065 *
3066 * This puts a job in the kernel-global workqueue if it was not already
3067 * queued and leaves it in the same position on the kernel-global
3068 * workqueue otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003069 */
Tejun Heod4283e92012-08-03 10:30:44 -07003070bool schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003071{
Tejun Heod320c032010-06-29 10:07:14 +02003072 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003073}
Dave Jonesae90dd52006-06-30 01:40:45 -04003074EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003075
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003076/**
3077 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
3078 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +00003079 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003080 * @delay: number of jiffies to wait
3081 *
3082 * After waiting for a given time this puts a job in the kernel-global
3083 * workqueue on the specified CPU.
3084 */
Tejun Heod4283e92012-08-03 10:30:44 -07003085bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3086 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003087{
Tejun Heod320c032010-06-29 10:07:14 +02003088 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003089}
Dave Jonesae90dd52006-06-30 01:40:45 -04003090EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003091
Andrew Mortonb6136772006-06-25 05:47:49 -07003092/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003093 * schedule_delayed_work - put work task in global workqueue after delay
3094 * @dwork: job to be done
3095 * @delay: number of jiffies to wait or 0 for immediate execution
3096 *
3097 * After waiting for a given time this puts a job in the kernel-global
3098 * workqueue.
3099 */
Tejun Heod4283e92012-08-03 10:30:44 -07003100bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
Tejun Heo0a13c002012-08-03 10:30:44 -07003101{
3102 return queue_delayed_work(system_wq, dwork, delay);
3103}
3104EXPORT_SYMBOL(schedule_delayed_work);
3105
3106/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003107 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003108 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003109 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003110 * schedule_on_each_cpu() executes @func on each online CPU using the
3111 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003112 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003113 *
3114 * RETURNS:
3115 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003116 */
David Howells65f27f32006-11-22 14:55:48 +00003117int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003118{
3119 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003120 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003121
Andrew Mortonb6136772006-06-25 05:47:49 -07003122 works = alloc_percpu(struct work_struct);
3123 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003124 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003125
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003126 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003127
Christoph Lameter15316ba2006-01-08 01:00:43 -08003128 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003129 struct work_struct *work = per_cpu_ptr(works, cpu);
3130
3131 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003132 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003133 }
Tejun Heo93981802009-11-17 14:06:20 -08003134
3135 for_each_online_cpu(cpu)
3136 flush_work(per_cpu_ptr(works, cpu));
3137
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003138 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003139 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003140 return 0;
3141}
3142
Alan Sterneef6a7d2010-02-12 17:39:21 +09003143/**
3144 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3145 *
3146 * Forces execution of the kernel-global workqueue and blocks until its
3147 * completion.
3148 *
3149 * Think twice before calling this function! It's very easy to get into
3150 * trouble if you don't take great care. Either of the following situations
3151 * will lead to deadlock:
3152 *
3153 * One of the work items currently on the workqueue needs to acquire
3154 * a lock held by your code or its caller.
3155 *
3156 * Your code is running in the context of a work routine.
3157 *
3158 * They will be detected by lockdep when they occur, but the first might not
3159 * occur very often. It depends on what work items are on the workqueue and
3160 * what locks they need, which you have no control over.
3161 *
3162 * In most situations flushing the entire workqueue is overkill; you merely
3163 * need to know that a particular work item isn't queued and isn't running.
3164 * In such cases you should use cancel_delayed_work_sync() or
3165 * cancel_work_sync() instead.
3166 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003167void flush_scheduled_work(void)
3168{
Tejun Heod320c032010-06-29 10:07:14 +02003169 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170}
Dave Jonesae90dd52006-06-30 01:40:45 -04003171EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003172
3173/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003174 * execute_in_process_context - reliably execute the routine with user context
3175 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003176 * @ew: guaranteed storage for the execute work structure (must
3177 * be available when the work executes)
3178 *
3179 * Executes the function immediately if process context is available,
3180 * otherwise schedules the function for delayed execution.
3181 *
3182 * Returns: 0 - function was executed
3183 * 1 - function was scheduled for execution
3184 */
David Howells65f27f32006-11-22 14:55:48 +00003185int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003186{
3187 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003188 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003189 return 0;
3190 }
3191
David Howells65f27f32006-11-22 14:55:48 +00003192 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003193 schedule_work(&ew->work);
3194
3195 return 1;
3196}
3197EXPORT_SYMBOL_GPL(execute_in_process_context);
3198
Linus Torvalds1da177e2005-04-16 15:20:36 -07003199int keventd_up(void)
3200{
Tejun Heod320c032010-06-29 10:07:14 +02003201 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003202}
3203
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003204static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003205{
Oleg Nesterov3af244332007-05-09 02:34:09 -07003206 /*
Tejun Heo0f900042010-06-29 10:07:11 +02003207 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
3208 * Make sure that the alignment isn't lower than that of
3209 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07003210 */
Tejun Heo0f900042010-06-29 10:07:11 +02003211 const size_t size = sizeof(struct cpu_workqueue_struct);
3212 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
3213 __alignof__(unsigned long long));
Oleg Nesterov3af244332007-05-09 02:34:09 -07003214
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003215 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003216 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02003217 else {
Tejun Heof3421792010-07-02 10:03:51 +02003218 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003219
Tejun Heof3421792010-07-02 10:03:51 +02003220 /*
3221 * Allocate enough room to align cwq and put an extra
3222 * pointer at the end pointing back to the originally
3223 * allocated pointer which will be used for free.
3224 */
3225 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3226 if (ptr) {
3227 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3228 *(void **)(wq->cpu_wq.single + 1) = ptr;
3229 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003230 }
Tejun Heof3421792010-07-02 10:03:51 +02003231
Tejun Heo0415b00d12011-03-24 18:50:09 +01003232 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003233 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3234 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003235}
3236
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003237static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003238{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003239 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003240 free_percpu(wq->cpu_wq.pcpu);
3241 else if (wq->cpu_wq.single) {
3242 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003243 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003244 }
3245}
3246
Tejun Heof3421792010-07-02 10:03:51 +02003247static int wq_clamp_max_active(int max_active, unsigned int flags,
3248 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003249{
Tejun Heof3421792010-07-02 10:03:51 +02003250 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3251
3252 if (max_active < 1 || max_active > lim)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003253 printk(KERN_WARNING "workqueue: max_active %d requested for %s "
3254 "is out of range, clamping between %d and %d\n",
Tejun Heof3421792010-07-02 10:03:51 +02003255 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003256
Tejun Heof3421792010-07-02 10:03:51 +02003257 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003258}
3259
Tejun Heob196be82012-01-10 15:11:35 -08003260struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003261 unsigned int flags,
3262 int max_active,
3263 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003264 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003265{
Tejun Heob196be82012-01-10 15:11:35 -08003266 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003267 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003268 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08003269 size_t namelen;
3270
3271 /* determine namelen, allocate wq and format name */
3272 va_start(args, lock_name);
3273 va_copy(args1, args);
3274 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3275
3276 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3277 if (!wq)
3278 goto err;
3279
3280 vsnprintf(wq->name, namelen, fmt, args1);
3281 va_end(args);
3282 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003283
Tejun Heof3421792010-07-02 10:03:51 +02003284 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02003285 * Workqueues which may be used during memory reclaim should
3286 * have a rescuer to guarantee forward progress.
3287 */
3288 if (flags & WQ_MEM_RECLAIM)
3289 flags |= WQ_RESCUER;
3290
Tejun Heod320c032010-06-29 10:07:14 +02003291 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003292 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003293
Tejun Heob196be82012-01-10 15:11:35 -08003294 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003295 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003296 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003297 mutex_init(&wq->flush_mutex);
3298 atomic_set(&wq->nr_cwqs_to_flush, 0);
3299 INIT_LIST_HEAD(&wq->flusher_queue);
3300 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003301
Johannes Bergeb13ba82008-01-16 09:51:58 +01003302 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003303 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003304
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003305 if (alloc_cwqs(wq) < 0)
3306 goto err;
3307
Tejun Heof3421792010-07-02 10:03:51 +02003308 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003309 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003310 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo32704762012-07-13 22:16:45 -07003311 int pool_idx = (bool)(flags & WQ_HIGHPRI);
Tejun Heo15376632010-06-29 10:07:11 +02003312
Tejun Heo0f900042010-06-29 10:07:11 +02003313 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo32704762012-07-13 22:16:45 -07003314 cwq->pool = &gcwq->pools[pool_idx];
Tejun Heoc34056a2010-06-29 10:07:11 +02003315 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003316 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003317 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003318 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003319 }
3320
Tejun Heoe22bee72010-06-29 10:07:14 +02003321 if (flags & WQ_RESCUER) {
3322 struct worker *rescuer;
3323
Tejun Heof2e005a2010-07-20 15:59:09 +02003324 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003325 goto err;
3326
3327 wq->rescuer = rescuer = alloc_worker();
3328 if (!rescuer)
3329 goto err;
3330
Tejun Heob196be82012-01-10 15:11:35 -08003331 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3332 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003333 if (IS_ERR(rescuer->task))
3334 goto err;
3335
Tejun Heoe22bee72010-06-29 10:07:14 +02003336 rescuer->task->flags |= PF_THREAD_BOUND;
3337 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003338 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003339
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003340 /*
3341 * workqueue_lock protects global freeze state and workqueues
3342 * list. Grab it, set max_active accordingly and add the new
3343 * workqueue to workqueues list.
3344 */
Tejun Heo15376632010-06-29 10:07:11 +02003345 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003346
Tejun Heo58a69cb2011-02-16 09:25:31 +01003347 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003348 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003349 get_cwq(cpu, wq)->max_active = 0;
3350
Tejun Heo15376632010-06-29 10:07:11 +02003351 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003352
Tejun Heo15376632010-06-29 10:07:11 +02003353 spin_unlock(&workqueue_lock);
3354
Oleg Nesterov3af244332007-05-09 02:34:09 -07003355 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003356err:
3357 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003358 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003359 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003360 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003361 kfree(wq);
3362 }
3363 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003364}
Tejun Heod320c032010-06-29 10:07:14 +02003365EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003366
3367/**
3368 * destroy_workqueue - safely terminate a workqueue
3369 * @wq: target workqueue
3370 *
3371 * Safely destroy a workqueue. All work currently pending will be done first.
3372 */
3373void destroy_workqueue(struct workqueue_struct *wq)
3374{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003375 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003376
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003377 /* drain it before proceeding with destruction */
3378 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003379
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003380 /*
3381 * wq list is used to freeze wq, remove from list after
3382 * flushing is complete in case freeze races us.
3383 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003384 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07003385 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003386 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003387
Tejun Heoe22bee72010-06-29 10:07:14 +02003388 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003389 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003390 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3391 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003392
Tejun Heo73f53c42010-06-29 10:07:11 +02003393 for (i = 0; i < WORK_NR_COLORS; i++)
3394 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003395 BUG_ON(cwq->nr_active);
3396 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003397 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003398
Tejun Heoe22bee72010-06-29 10:07:14 +02003399 if (wq->flags & WQ_RESCUER) {
3400 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003401 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003402 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003403 }
3404
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003405 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003406 kfree(wq);
3407}
3408EXPORT_SYMBOL_GPL(destroy_workqueue);
3409
Tejun Heodcd989c2010-06-29 10:07:14 +02003410/**
3411 * workqueue_set_max_active - adjust max_active of a workqueue
3412 * @wq: target workqueue
3413 * @max_active: new max_active value.
3414 *
3415 * Set max_active of @wq to @max_active.
3416 *
3417 * CONTEXT:
3418 * Don't call from IRQ context.
3419 */
3420void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3421{
3422 unsigned int cpu;
3423
Tejun Heof3421792010-07-02 10:03:51 +02003424 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003425
3426 spin_lock(&workqueue_lock);
3427
3428 wq->saved_max_active = max_active;
3429
Tejun Heof3421792010-07-02 10:03:51 +02003430 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003431 struct global_cwq *gcwq = get_gcwq(cpu);
3432
3433 spin_lock_irq(&gcwq->lock);
3434
Tejun Heo58a69cb2011-02-16 09:25:31 +01003435 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003436 !(gcwq->flags & GCWQ_FREEZING))
3437 get_cwq(gcwq->cpu, wq)->max_active = max_active;
3438
3439 spin_unlock_irq(&gcwq->lock);
3440 }
3441
3442 spin_unlock(&workqueue_lock);
3443}
3444EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3445
3446/**
3447 * workqueue_congested - test whether a workqueue is congested
3448 * @cpu: CPU in question
3449 * @wq: target workqueue
3450 *
3451 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3452 * no synchronization around this function and the test result is
3453 * unreliable and only useful as advisory hints or for debugging.
3454 *
3455 * RETURNS:
3456 * %true if congested, %false otherwise.
3457 */
3458bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3459{
3460 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3461
3462 return !list_empty(&cwq->delayed_works);
3463}
3464EXPORT_SYMBOL_GPL(workqueue_congested);
3465
3466/**
3467 * work_cpu - return the last known associated cpu for @work
3468 * @work: the work of interest
3469 *
3470 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003471 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003472 */
3473unsigned int work_cpu(struct work_struct *work)
3474{
3475 struct global_cwq *gcwq = get_work_gcwq(work);
3476
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003477 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003478}
3479EXPORT_SYMBOL_GPL(work_cpu);
3480
3481/**
3482 * work_busy - test whether a work is currently pending or running
3483 * @work: the work to be tested
3484 *
3485 * Test whether @work is currently pending or running. There is no
3486 * synchronization around this function and the test result is
3487 * unreliable and only useful as advisory hints or for debugging.
3488 * Especially for reentrant wqs, the pending state might hide the
3489 * running state.
3490 *
3491 * RETURNS:
3492 * OR'd bitmask of WORK_BUSY_* bits.
3493 */
3494unsigned int work_busy(struct work_struct *work)
3495{
3496 struct global_cwq *gcwq = get_work_gcwq(work);
3497 unsigned long flags;
3498 unsigned int ret = 0;
3499
3500 if (!gcwq)
3501 return false;
3502
3503 spin_lock_irqsave(&gcwq->lock, flags);
3504
3505 if (work_pending(work))
3506 ret |= WORK_BUSY_PENDING;
3507 if (find_worker_executing_work(gcwq, work))
3508 ret |= WORK_BUSY_RUNNING;
3509
3510 spin_unlock_irqrestore(&gcwq->lock, flags);
3511
3512 return ret;
3513}
3514EXPORT_SYMBOL_GPL(work_busy);
3515
Tejun Heodb7bccf2010-06-29 10:07:12 +02003516/*
3517 * CPU hotplug.
3518 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003519 * There are two challenges in supporting CPU hotplug. Firstly, there
3520 * are a lot of assumptions on strong associations among work, cwq and
3521 * gcwq which make migrating pending and scheduled works very
3522 * difficult to implement without impacting hot paths. Secondly,
3523 * gcwqs serve mix of short, long and very long running works making
3524 * blocked draining impractical.
3525 *
Tejun Heo628c78e2012-07-17 12:39:27 -07003526 * This is solved by allowing a gcwq to be disassociated from the CPU
3527 * running as an unbound one and allowing it to be reattached later if the
3528 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003529 */
3530
Tejun Heo60373152012-07-17 12:39:27 -07003531/* claim manager positions of all pools */
Tejun Heo8db25e72012-07-17 12:39:28 -07003532static void gcwq_claim_management_and_lock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003533{
3534 struct worker_pool *pool;
3535
3536 for_each_worker_pool(pool, gcwq)
3537 mutex_lock_nested(&pool->manager_mutex, pool - gcwq->pools);
Tejun Heo8db25e72012-07-17 12:39:28 -07003538 spin_lock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003539}
3540
3541/* release manager positions */
Tejun Heo8db25e72012-07-17 12:39:28 -07003542static void gcwq_release_management_and_unlock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003543{
3544 struct worker_pool *pool;
3545
Tejun Heo8db25e72012-07-17 12:39:28 -07003546 spin_unlock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003547 for_each_worker_pool(pool, gcwq)
3548 mutex_unlock(&pool->manager_mutex);
3549}
3550
Tejun Heo628c78e2012-07-17 12:39:27 -07003551static void gcwq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003552{
Tejun Heo628c78e2012-07-17 12:39:27 -07003553 struct global_cwq *gcwq = get_gcwq(smp_processor_id());
Tejun Heo4ce62e92012-07-13 22:16:44 -07003554 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003555 struct worker *worker;
3556 struct hlist_node *pos;
3557 int i;
3558
3559 BUG_ON(gcwq->cpu != smp_processor_id());
3560
Tejun Heo8db25e72012-07-17 12:39:28 -07003561 gcwq_claim_management_and_lock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003562
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003563 /*
3564 * We've claimed all manager positions. Make all workers unbound
3565 * and set DISASSOCIATED. Before this, all workers except for the
3566 * ones which are still executing works from before the last CPU
3567 * down must be on the cpu. After this, they may become diasporas.
3568 */
Tejun Heo60373152012-07-17 12:39:27 -07003569 for_each_worker_pool(pool, gcwq)
Tejun Heo4ce62e92012-07-13 22:16:44 -07003570 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07003571 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003572
3573 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo403c8212012-07-17 12:39:27 -07003574 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003575
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003576 gcwq->flags |= GCWQ_DISASSOCIATED;
3577
Tejun Heo8db25e72012-07-17 12:39:28 -07003578 gcwq_release_management_and_unlock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003579
3580 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07003581 * Call schedule() so that we cross rq->lock and thus can guarantee
3582 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3583 * as scheduler callbacks may be invoked from other cpus.
3584 */
3585 schedule();
3586
3587 /*
3588 * Sched callbacks are disabled now. Zap nr_running. After this,
3589 * nr_running stays zero and need_more_worker() and keep_working()
3590 * are always true as long as the worklist is not empty. @gcwq now
3591 * behaves as unbound (in terms of concurrency management) gcwq
3592 * which is served by workers tied to the CPU.
3593 *
3594 * On return from this function, the current worker would trigger
3595 * unbound chain execution of pending work items if other workers
3596 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02003597 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07003598 for_each_worker_pool(pool, gcwq)
3599 atomic_set(get_pool_nr_running(pool), 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003600}
3601
Tejun Heo8db25e72012-07-17 12:39:28 -07003602/*
3603 * Workqueues should be brought up before normal priority CPU notifiers.
3604 * This will be registered high priority CPU notifier.
3605 */
3606static int __devinit workqueue_cpu_up_callback(struct notifier_block *nfb,
3607 unsigned long action,
3608 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003609{
3610 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003611 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003612 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003613
Tejun Heo8db25e72012-07-17 12:39:28 -07003614 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003615 case CPU_UP_PREPARE:
Tejun Heo4ce62e92012-07-13 22:16:44 -07003616 for_each_worker_pool(pool, gcwq) {
Tejun Heo3ce63372012-07-17 12:39:27 -07003617 struct worker *worker;
3618
3619 if (pool->nr_workers)
3620 continue;
3621
3622 worker = create_worker(pool);
3623 if (!worker)
3624 return NOTIFY_BAD;
3625
3626 spin_lock_irq(&gcwq->lock);
3627 start_worker(worker);
3628 spin_unlock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003629 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003630 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003631
Tejun Heo65758202012-07-17 12:39:26 -07003632 case CPU_DOWN_FAILED:
3633 case CPU_ONLINE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003634 gcwq_claim_management_and_lock(gcwq);
3635 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3636 rebind_workers(gcwq);
3637 gcwq_release_management_and_unlock(gcwq);
3638 break;
Tejun Heo65758202012-07-17 12:39:26 -07003639 }
3640 return NOTIFY_OK;
3641}
3642
3643/*
3644 * Workqueues should be brought down after normal priority CPU notifiers.
3645 * This will be registered as low priority CPU notifier.
3646 */
3647static int __devinit workqueue_cpu_down_callback(struct notifier_block *nfb,
3648 unsigned long action,
3649 void *hcpu)
3650{
Tejun Heo8db25e72012-07-17 12:39:28 -07003651 unsigned int cpu = (unsigned long)hcpu;
3652 struct work_struct unbind_work;
3653
Tejun Heo65758202012-07-17 12:39:26 -07003654 switch (action & ~CPU_TASKS_FROZEN) {
3655 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003656 /* unbinding should happen on the local CPU */
3657 INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
3658 schedule_work_on(cpu, &unbind_work);
3659 flush_work(&unbind_work);
3660 break;
Tejun Heo65758202012-07-17 12:39:26 -07003661 }
3662 return NOTIFY_OK;
3663}
3664
Rusty Russell2d3854a2008-11-05 13:39:10 +11003665#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003666
Rusty Russell2d3854a2008-11-05 13:39:10 +11003667struct work_for_cpu {
Andrew Morton6b44003e2009-04-09 09:50:37 -06003668 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003669 long (*fn)(void *);
3670 void *arg;
3671 long ret;
3672};
3673
Andrew Morton6b44003e2009-04-09 09:50:37 -06003674static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003675{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003676 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003677 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b44003e2009-04-09 09:50:37 -06003678 complete(&wfc->completion);
3679 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003680}
3681
3682/**
3683 * work_on_cpu - run a function in user context on a particular cpu
3684 * @cpu: the cpu to run on
3685 * @fn: the function to run
3686 * @arg: the function arg
3687 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003688 * This will return the value @fn returns.
3689 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06003690 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003691 */
3692long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3693{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003694 struct task_struct *sub_thread;
3695 struct work_for_cpu wfc = {
3696 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3697 .fn = fn,
3698 .arg = arg,
3699 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003700
Andrew Morton6b44003e2009-04-09 09:50:37 -06003701 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3702 if (IS_ERR(sub_thread))
3703 return PTR_ERR(sub_thread);
3704 kthread_bind(sub_thread, cpu);
3705 wake_up_process(sub_thread);
3706 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003707 return wfc.ret;
3708}
3709EXPORT_SYMBOL_GPL(work_on_cpu);
3710#endif /* CONFIG_SMP */
3711
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003712#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303713
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003714/**
3715 * freeze_workqueues_begin - begin freezing workqueues
3716 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003717 * Start freezing workqueues. After this function returns, all freezable
3718 * workqueues will queue new works to their frozen_works list instead of
3719 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003720 *
3721 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003722 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003723 */
3724void freeze_workqueues_begin(void)
3725{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003726 unsigned int cpu;
3727
3728 spin_lock(&workqueue_lock);
3729
3730 BUG_ON(workqueue_freezing);
3731 workqueue_freezing = true;
3732
Tejun Heof3421792010-07-02 10:03:51 +02003733 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003734 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003735 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003736
3737 spin_lock_irq(&gcwq->lock);
3738
Tejun Heodb7bccf2010-06-29 10:07:12 +02003739 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3740 gcwq->flags |= GCWQ_FREEZING;
3741
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003742 list_for_each_entry(wq, &workqueues, list) {
3743 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3744
Tejun Heo58a69cb2011-02-16 09:25:31 +01003745 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003746 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003747 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003748
3749 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003750 }
3751
3752 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003753}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003754
3755/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003756 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003757 *
3758 * Check whether freezing is complete. This function must be called
3759 * between freeze_workqueues_begin() and thaw_workqueues().
3760 *
3761 * CONTEXT:
3762 * Grabs and releases workqueue_lock.
3763 *
3764 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003765 * %true if some freezable workqueues are still busy. %false if freezing
3766 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003767 */
3768bool freeze_workqueues_busy(void)
3769{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003770 unsigned int cpu;
3771 bool busy = false;
3772
3773 spin_lock(&workqueue_lock);
3774
3775 BUG_ON(!workqueue_freezing);
3776
Tejun Heof3421792010-07-02 10:03:51 +02003777 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003778 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003779 /*
3780 * nr_active is monotonically decreasing. It's safe
3781 * to peek without lock.
3782 */
3783 list_for_each_entry(wq, &workqueues, list) {
3784 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3785
Tejun Heo58a69cb2011-02-16 09:25:31 +01003786 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003787 continue;
3788
3789 BUG_ON(cwq->nr_active < 0);
3790 if (cwq->nr_active) {
3791 busy = true;
3792 goto out_unlock;
3793 }
3794 }
3795 }
3796out_unlock:
3797 spin_unlock(&workqueue_lock);
3798 return busy;
3799}
3800
3801/**
3802 * thaw_workqueues - thaw workqueues
3803 *
3804 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003805 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003806 *
3807 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003808 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003809 */
3810void thaw_workqueues(void)
3811{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003812 unsigned int cpu;
3813
3814 spin_lock(&workqueue_lock);
3815
3816 if (!workqueue_freezing)
3817 goto out_unlock;
3818
Tejun Heof3421792010-07-02 10:03:51 +02003819 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003820 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003821 struct worker_pool *pool;
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003822 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003823
3824 spin_lock_irq(&gcwq->lock);
3825
Tejun Heodb7bccf2010-06-29 10:07:12 +02003826 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3827 gcwq->flags &= ~GCWQ_FREEZING;
3828
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003829 list_for_each_entry(wq, &workqueues, list) {
3830 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3831
Tejun Heo58a69cb2011-02-16 09:25:31 +01003832 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003833 continue;
3834
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003835 /* restore max_active and repopulate worklist */
3836 cwq->max_active = wq->saved_max_active;
3837
3838 while (!list_empty(&cwq->delayed_works) &&
3839 cwq->nr_active < cwq->max_active)
3840 cwq_activate_first_delayed(cwq);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003841 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003842
Tejun Heo4ce62e92012-07-13 22:16:44 -07003843 for_each_worker_pool(pool, gcwq)
3844 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02003845
Tejun Heo8b03ae32010-06-29 10:07:12 +02003846 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003847 }
3848
3849 workqueue_freezing = false;
3850out_unlock:
3851 spin_unlock(&workqueue_lock);
3852}
3853#endif /* CONFIG_FREEZER */
3854
Suresh Siddha6ee05782010-07-30 14:57:37 -07003855static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003856{
Tejun Heoc34056a2010-06-29 10:07:11 +02003857 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003858 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02003859
Tejun Heob5490072012-08-03 10:30:46 -07003860 /* make sure we have enough bits for OFFQ CPU number */
3861 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3862 WORK_CPU_LAST);
3863
Tejun Heo65758202012-07-17 12:39:26 -07003864 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
3865 cpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003866
3867 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003868 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003869 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003870 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003871
3872 spin_lock_init(&gcwq->lock);
3873 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003874 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003875
Tejun Heoc8e55f32010-06-29 10:07:12 +02003876 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3877 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3878
Tejun Heo4ce62e92012-07-13 22:16:44 -07003879 for_each_worker_pool(pool, gcwq) {
3880 pool->gcwq = gcwq;
3881 INIT_LIST_HEAD(&pool->worklist);
3882 INIT_LIST_HEAD(&pool->idle_list);
Tejun Heoe22bee72010-06-29 10:07:14 +02003883
Tejun Heo4ce62e92012-07-13 22:16:44 -07003884 init_timer_deferrable(&pool->idle_timer);
3885 pool->idle_timer.function = idle_worker_timeout;
3886 pool->idle_timer.data = (unsigned long)pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003887
Tejun Heo4ce62e92012-07-13 22:16:44 -07003888 setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
3889 (unsigned long)pool);
3890
Tejun Heo60373152012-07-17 12:39:27 -07003891 mutex_init(&pool->manager_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003892 ida_init(&pool->worker_ida);
3893 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003894
Tejun Heo25511a42012-07-17 12:39:27 -07003895 init_waitqueue_head(&gcwq->rebind_hold);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003896 }
3897
Tejun Heoe22bee72010-06-29 10:07:14 +02003898 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003899 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003900 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003901 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003902
Tejun Heo477a3c32010-08-31 10:54:35 +02003903 if (cpu != WORK_CPU_UNBOUND)
3904 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003905
3906 for_each_worker_pool(pool, gcwq) {
3907 struct worker *worker;
3908
Tejun Heobc2ae0f2012-07-17 12:39:27 -07003909 worker = create_worker(pool);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003910 BUG_ON(!worker);
3911 spin_lock_irq(&gcwq->lock);
3912 start_worker(worker);
3913 spin_unlock_irq(&gcwq->lock);
3914 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003915 }
3916
Tejun Heod320c032010-06-29 10:07:14 +02003917 system_wq = alloc_workqueue("events", 0, 0);
3918 system_long_wq = alloc_workqueue("events_long", 0, 0);
3919 system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003920 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3921 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003922 system_freezable_wq = alloc_workqueue("events_freezable",
3923 WQ_FREEZABLE, 0);
Alan Stern62d3c542012-03-02 10:51:00 +01003924 system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
3925 WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
Hitoshi Mitakee5cba242010-11-26 12:06:44 +01003926 BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
Alan Stern62d3c542012-03-02 10:51:00 +01003927 !system_unbound_wq || !system_freezable_wq ||
3928 !system_nrt_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003929 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003930}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003931early_initcall(init_workqueues);