blob: 49d8f4a0110d1fe456d5c801254e8aa96162e086 [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 Lameter46934022006-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
Joonsoo Kim330dad52012-08-15 23:25:36 +0900186 struct worker_pool pools[NR_WORKER_POOLS];
187 /* normal and highpri pools */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200188
Tejun Heo25511a42012-07-17 12:39:27 -0700189 wait_queue_head_t rebind_hold; /* rebind hold wait */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200190} ____cacheline_aligned_in_smp;
191
192/*
Tejun Heo502ca9d2010-06-29 10:07:13 +0200193 * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of
Tejun Heo0f900042010-06-29 10:07:11 +0200194 * work_struct->data are used for flags and thus cwqs need to be
195 * aligned at two's power of the number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 */
197struct cpu_workqueue_struct {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700198 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200199 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200200 int work_color; /* L: current color */
201 int flush_color; /* L: flushing color */
202 int nr_in_flight[WORK_NR_COLORS];
203 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200204 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200205 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200206 struct list_head delayed_works; /* L: delayed works */
Tejun Heo0f900042010-06-29 10:07:11 +0200207};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200210 * Structure used to wait for workqueue flush.
211 */
212struct wq_flusher {
213 struct list_head list; /* F: list of flushers */
214 int flush_color; /* F: flush color waiting for */
215 struct completion done; /* flush completion */
216};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
Tejun Heo73f53c42010-06-29 10:07:11 +0200218/*
Tejun Heof2e005a2010-07-20 15:59:09 +0200219 * All cpumasks are assumed to be always set on UP and thus can't be
220 * used to determine whether there's something to be done.
221 */
222#ifdef CONFIG_SMP
223typedef cpumask_var_t mayday_mask_t;
224#define mayday_test_and_set_cpu(cpu, mask) \
225 cpumask_test_and_set_cpu((cpu), (mask))
226#define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask))
227#define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask))
Tejun Heo9c375472010-08-31 11:18:34 +0200228#define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp))
Tejun Heof2e005a2010-07-20 15:59:09 +0200229#define free_mayday_mask(mask) free_cpumask_var((mask))
230#else
231typedef unsigned long mayday_mask_t;
232#define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask))
233#define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask))
234#define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask))
235#define alloc_mayday_mask(maskp, gfp) true
236#define free_mayday_mask(mask) do { } while (0)
237#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
239/*
240 * The externally visible workqueue abstraction is an array of
241 * per-CPU workqueues:
242 */
243struct workqueue_struct {
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200244 unsigned int flags; /* W: WQ_* flags */
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200245 union {
246 struct cpu_workqueue_struct __percpu *pcpu;
247 struct cpu_workqueue_struct *single;
248 unsigned long v;
249 } cpu_wq; /* I: cwq's */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200250 struct list_head list; /* W: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200251
252 struct mutex flush_mutex; /* protects wq flushing */
253 int work_color; /* F: current work color */
254 int flush_color; /* F: current flush color */
255 atomic_t nr_cwqs_to_flush; /* flush in progress */
256 struct wq_flusher *first_flusher; /* F: first flusher */
257 struct list_head flusher_queue; /* F: flush waiters */
258 struct list_head flusher_overflow; /* F: flush overflow list */
259
Tejun Heof2e005a2010-07-20 15:59:09 +0200260 mayday_mask_t mayday_mask; /* cpus requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200261 struct worker *rescuer; /* I: rescue worker */
262
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200263 int nr_drainers; /* W: drain in progress */
Tejun Heodcd989c2010-06-29 10:07:14 +0200264 int saved_max_active; /* W: saved cwq max_active */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700265#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200266 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700267#endif
Tejun Heob196be82012-01-10 15:11:35 -0800268 char name[]; /* I: workqueue name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269};
270
Tejun Heod320c032010-06-29 10:07:14 +0200271struct workqueue_struct *system_wq __read_mostly;
272struct workqueue_struct *system_long_wq __read_mostly;
273struct workqueue_struct *system_nrt_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200274struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100275struct workqueue_struct *system_freezable_wq __read_mostly;
Alan Stern62d3c542012-03-02 10:51:00 +0100276struct workqueue_struct *system_nrt_freezable_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200277EXPORT_SYMBOL_GPL(system_wq);
278EXPORT_SYMBOL_GPL(system_long_wq);
279EXPORT_SYMBOL_GPL(system_nrt_wq);
Tejun Heof3421792010-07-02 10:03:51 +0200280EXPORT_SYMBOL_GPL(system_unbound_wq);
Tejun Heo24d51ad2011-02-21 09:52:50 +0100281EXPORT_SYMBOL_GPL(system_freezable_wq);
Alan Stern62d3c542012-03-02 10:51:00 +0100282EXPORT_SYMBOL_GPL(system_nrt_freezable_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200283
Tejun Heo97bd2342010-10-05 10:41:14 +0200284#define CREATE_TRACE_POINTS
285#include <trace/events/workqueue.h>
286
Tejun Heo4ce62e92012-07-13 22:16:44 -0700287#define for_each_worker_pool(pool, gcwq) \
Tejun Heo32704762012-07-13 22:16:45 -0700288 for ((pool) = &(gcwq)->pools[0]; \
289 (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700290
Tejun Heodb7bccf2010-06-29 10:07:12 +0200291#define for_each_busy_worker(worker, i, pos, gcwq) \
292 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \
293 hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
294
Tejun Heof3421792010-07-02 10:03:51 +0200295static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
296 unsigned int sw)
297{
298 if (cpu < nr_cpu_ids) {
299 if (sw & 1) {
300 cpu = cpumask_next(cpu, mask);
301 if (cpu < nr_cpu_ids)
302 return cpu;
303 }
304 if (sw & 2)
305 return WORK_CPU_UNBOUND;
306 }
307 return WORK_CPU_NONE;
308}
309
310static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
311 struct workqueue_struct *wq)
312{
313 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
314}
315
Tejun Heo09884952010-08-01 11:50:12 +0200316/*
317 * CPU iterators
318 *
319 * An extra gcwq is defined for an invalid cpu number
320 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
321 * specific CPU. The following iterators are similar to
322 * for_each_*_cpu() iterators but also considers the unbound gcwq.
323 *
324 * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
325 * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
326 * for_each_cwq_cpu() : possible CPUs for bound workqueues,
327 * WORK_CPU_UNBOUND for unbound workqueues
328 */
Tejun Heof3421792010-07-02 10:03:51 +0200329#define for_each_gcwq_cpu(cpu) \
330 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
331 (cpu) < WORK_CPU_NONE; \
332 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
333
334#define for_each_online_gcwq_cpu(cpu) \
335 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
336 (cpu) < WORK_CPU_NONE; \
337 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
338
339#define for_each_cwq_cpu(cpu, wq) \
340 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
341 (cpu) < WORK_CPU_NONE; \
342 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
343
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900344#ifdef CONFIG_DEBUG_OBJECTS_WORK
345
346static struct debug_obj_descr work_debug_descr;
347
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100348static void *work_debug_hint(void *addr)
349{
350 return ((struct work_struct *) addr)->func;
351}
352
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900353/*
354 * fixup_init is called when:
355 * - an active object is initialized
356 */
357static int work_fixup_init(void *addr, enum debug_obj_state state)
358{
359 struct work_struct *work = addr;
360
361 switch (state) {
362 case ODEBUG_STATE_ACTIVE:
363 cancel_work_sync(work);
364 debug_object_init(work, &work_debug_descr);
365 return 1;
366 default:
367 return 0;
368 }
369}
370
371/*
372 * fixup_activate is called when:
373 * - an active object is activated
374 * - an unknown object is activated (might be a statically initialized object)
375 */
376static int work_fixup_activate(void *addr, enum debug_obj_state state)
377{
378 struct work_struct *work = addr;
379
380 switch (state) {
381
382 case ODEBUG_STATE_NOTAVAILABLE:
383 /*
384 * This is not really a fixup. The work struct was
385 * statically initialized. We just make sure that it
386 * is tracked in the object tracker.
387 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200388 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900389 debug_object_init(work, &work_debug_descr);
390 debug_object_activate(work, &work_debug_descr);
391 return 0;
392 }
393 WARN_ON_ONCE(1);
394 return 0;
395
396 case ODEBUG_STATE_ACTIVE:
397 WARN_ON(1);
398
399 default:
400 return 0;
401 }
402}
403
404/*
405 * fixup_free is called when:
406 * - an active object is freed
407 */
408static int work_fixup_free(void *addr, enum debug_obj_state state)
409{
410 struct work_struct *work = addr;
411
412 switch (state) {
413 case ODEBUG_STATE_ACTIVE:
414 cancel_work_sync(work);
415 debug_object_free(work, &work_debug_descr);
416 return 1;
417 default:
418 return 0;
419 }
420}
421
422static struct debug_obj_descr work_debug_descr = {
423 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100424 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900425 .fixup_init = work_fixup_init,
426 .fixup_activate = work_fixup_activate,
427 .fixup_free = work_fixup_free,
428};
429
430static inline void debug_work_activate(struct work_struct *work)
431{
432 debug_object_activate(work, &work_debug_descr);
433}
434
435static inline void debug_work_deactivate(struct work_struct *work)
436{
437 debug_object_deactivate(work, &work_debug_descr);
438}
439
440void __init_work(struct work_struct *work, int onstack)
441{
442 if (onstack)
443 debug_object_init_on_stack(work, &work_debug_descr);
444 else
445 debug_object_init(work, &work_debug_descr);
446}
447EXPORT_SYMBOL_GPL(__init_work);
448
449void destroy_work_on_stack(struct work_struct *work)
450{
451 debug_object_free(work, &work_debug_descr);
452}
453EXPORT_SYMBOL_GPL(destroy_work_on_stack);
454
455#else
456static inline void debug_work_activate(struct work_struct *work) { }
457static inline void debug_work_deactivate(struct work_struct *work) { }
458#endif
459
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100460/* Serializes the accesses to the list of workqueues. */
461static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200463static bool workqueue_freezing; /* W: have wqs started freezing? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Oleg Nesterov14441962007-05-23 13:57:57 -0700465/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200466 * The almighty global cpu workqueues. nr_running is the only field
467 * which is expected to be used frequently by other cpus via
468 * try_to_wake_up(). Put it in a separate cacheline.
Oleg Nesterov14441962007-05-23 13:57:57 -0700469 */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200470static DEFINE_PER_CPU(struct global_cwq, global_cwq);
Tejun Heo4ce62e92012-07-13 22:16:44 -0700471static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
Nathan Lynchf756d5e2006-01-08 01:05:12 -0800472
Tejun Heof3421792010-07-02 10:03:51 +0200473/*
474 * Global cpu workqueue and nr_running counter for unbound gcwq. The
475 * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
476 * workers have WORKER_UNBOUND set.
477 */
478static struct global_cwq unbound_global_cwq;
Tejun Heo4ce62e92012-07-13 22:16:44 -0700479static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
480 [0 ... NR_WORKER_POOLS - 1] = ATOMIC_INIT(0), /* always 0 */
481};
Tejun Heof3421792010-07-02 10:03:51 +0200482
Tejun Heoc34056a2010-06-29 10:07:11 +0200483static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484
Tejun Heo32704762012-07-13 22:16:45 -0700485static int worker_pool_pri(struct worker_pool *pool)
486{
487 return pool - pool->gcwq->pools;
488}
489
Tejun Heo8b03ae32010-06-29 10:07:12 +0200490static struct global_cwq *get_gcwq(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491{
Tejun Heof3421792010-07-02 10:03:51 +0200492 if (cpu != WORK_CPU_UNBOUND)
493 return &per_cpu(global_cwq, cpu);
494 else
495 return &unbound_global_cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496}
497
Tejun Heo63d95a92012-07-12 14:46:37 -0700498static atomic_t *get_pool_nr_running(struct worker_pool *pool)
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700499{
Tejun Heo63d95a92012-07-12 14:46:37 -0700500 int cpu = pool->gcwq->cpu;
Tejun Heo32704762012-07-13 22:16:45 -0700501 int idx = worker_pool_pri(pool);
Tejun Heo63d95a92012-07-12 14:46:37 -0700502
Tejun Heof3421792010-07-02 10:03:51 +0200503 if (cpu != WORK_CPU_UNBOUND)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700504 return &per_cpu(pool_nr_running, cpu)[idx];
Tejun Heof3421792010-07-02 10:03:51 +0200505 else
Tejun Heo4ce62e92012-07-13 22:16:44 -0700506 return &unbound_pool_nr_running[idx];
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700507}
508
Tejun Heo4690c4a2010-06-29 10:07:10 +0200509static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
510 struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700511{
Tejun Heof3421792010-07-02 10:03:51 +0200512 if (!(wq->flags & WQ_UNBOUND)) {
Lai Jiangshane06ffa12012-03-09 18:03:20 +0800513 if (likely(cpu < nr_cpu_ids))
Tejun Heof3421792010-07-02 10:03:51 +0200514 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
Tejun Heof3421792010-07-02 10:03:51 +0200515 } else if (likely(cpu == WORK_CPU_UNBOUND))
516 return wq->cpu_wq.single;
517 return NULL;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700518}
519
Tejun Heo73f53c42010-06-29 10:07:11 +0200520static unsigned int work_color_to_flags(int color)
521{
522 return color << WORK_STRUCT_COLOR_SHIFT;
523}
524
525static int get_work_color(struct work_struct *work)
526{
527 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
528 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
529}
530
531static int work_next_color(int color)
532{
533 return (color + 1) % WORK_NR_COLORS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534}
535
David Howells4594bf12006-12-07 11:33:26 +0000536/*
Tejun Heob5490072012-08-03 10:30:46 -0700537 * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
538 * contain the pointer to the queued cwq. Once execution starts, the flag
539 * is cleared and the high bits contain OFFQ flags and CPU number.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200540 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700541 * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
542 * and clear_work_data() can be used to set the cwq, cpu or clear
543 * work->data. These functions should only be called while the work is
544 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200545 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700546 * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
547 * a work. gcwq is available once the work has been queued anywhere after
548 * initialization until it is sync canceled. cwq is available only while
549 * the work item is queued.
550 *
551 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
552 * canceled. While being canceled, a work item may have its PENDING set
553 * but stay off timer and worklist for arbitrarily long and nobody should
554 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000555 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200556static inline void set_work_data(struct work_struct *work, unsigned long data,
557 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000558{
David Howells4594bf12006-12-07 11:33:26 +0000559 BUG_ON(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200560 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000561}
David Howells365970a2006-11-22 14:54:49 +0000562
Tejun Heo7a22ad72010-06-29 10:07:13 +0200563static void set_work_cwq(struct work_struct *work,
564 struct cpu_workqueue_struct *cwq,
565 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200566{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200567 set_work_data(work, (unsigned long)cwq,
Tejun Heoe1201532010-07-22 14:14:25 +0200568 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200569}
570
Tejun Heo8930cab2012-08-03 10:30:45 -0700571static void set_work_cpu_and_clear_pending(struct work_struct *work,
572 unsigned int cpu)
David Howells365970a2006-11-22 14:54:49 +0000573{
Tejun Heo23657bb2012-08-13 17:08:19 -0700574 /*
575 * The following wmb is paired with the implied mb in
576 * test_and_set_bit(PENDING) and ensures all updates to @work made
577 * here are visible to and precede any updates by the next PENDING
578 * owner.
579 */
580 smp_wmb();
Tejun Heob5490072012-08-03 10:30:46 -0700581 set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200582}
583
584static void clear_work_data(struct work_struct *work)
585{
Tejun Heo23657bb2012-08-13 17:08:19 -0700586 smp_wmb(); /* see set_work_cpu_and_clear_pending() */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200587 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
588}
589
Tejun Heo7a22ad72010-06-29 10:07:13 +0200590static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
591{
Tejun Heoe1201532010-07-22 14:14:25 +0200592 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200593
Tejun Heoe1201532010-07-22 14:14:25 +0200594 if (data & WORK_STRUCT_CWQ)
595 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
596 else
597 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200598}
599
600static struct global_cwq *get_work_gcwq(struct work_struct *work)
601{
Tejun Heoe1201532010-07-22 14:14:25 +0200602 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200603 unsigned int cpu;
604
Tejun Heoe1201532010-07-22 14:14:25 +0200605 if (data & WORK_STRUCT_CWQ)
606 return ((struct cpu_workqueue_struct *)
Tejun Heobd7bdd42012-07-12 14:46:37 -0700607 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200608
Tejun Heob5490072012-08-03 10:30:46 -0700609 cpu = data >> WORK_OFFQ_CPU_SHIFT;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200610 if (cpu == WORK_CPU_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200611 return NULL;
612
Tejun Heof3421792010-07-02 10:03:51 +0200613 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200614 return get_gcwq(cpu);
David Howells365970a2006-11-22 14:54:49 +0000615}
616
Tejun Heobbb68df2012-08-03 10:30:46 -0700617static void mark_work_canceling(struct work_struct *work)
618{
619 struct global_cwq *gcwq = get_work_gcwq(work);
620 unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
621
622 set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
623 WORK_STRUCT_PENDING);
624}
625
626static bool work_is_canceling(struct work_struct *work)
627{
628 unsigned long data = atomic_long_read(&work->data);
629
630 return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
631}
632
David Howells365970a2006-11-22 14:54:49 +0000633/*
Tejun Heo32704762012-07-13 22:16:45 -0700634 * Policy functions. These define the policies on how the global worker
635 * pools are managed. Unless noted otherwise, these functions assume that
636 * they're being called with gcwq->lock held.
David Howells365970a2006-11-22 14:54:49 +0000637 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200638
Tejun Heo63d95a92012-07-12 14:46:37 -0700639static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000640{
Tejun Heo32704762012-07-13 22:16:45 -0700641 return !atomic_read(get_pool_nr_running(pool));
David Howells365970a2006-11-22 14:54:49 +0000642}
643
Tejun Heoe22bee72010-06-29 10:07:14 +0200644/*
645 * Need to wake up a worker? Called from anything but currently
646 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700647 *
648 * Note that, because unbound workers never contribute to nr_running, this
649 * function will always return %true for unbound gcwq as long as the
650 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200651 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700652static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000653{
Tejun Heo63d95a92012-07-12 14:46:37 -0700654 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000655}
656
Tejun Heoe22bee72010-06-29 10:07:14 +0200657/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700658static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200659{
Tejun Heo63d95a92012-07-12 14:46:37 -0700660 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200661}
662
663/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700664static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200665{
Tejun Heo63d95a92012-07-12 14:46:37 -0700666 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200667
Tejun Heo32704762012-07-13 22:16:45 -0700668 return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200669}
670
671/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700672static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200673{
Tejun Heo63d95a92012-07-12 14:46:37 -0700674 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200675}
676
677/* Do I need to be the manager? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700678static bool need_to_manage_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200679{
Tejun Heo63d95a92012-07-12 14:46:37 -0700680 return need_to_create_worker(pool) ||
Tejun Heo11ebea52012-07-12 14:46:37 -0700681 (pool->flags & POOL_MANAGE_WORKERS);
Tejun Heoe22bee72010-06-29 10:07:14 +0200682}
683
684/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700685static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200686{
Tejun Heo60373152012-07-17 12:39:27 -0700687 bool managing = mutex_is_locked(&pool->manager_mutex);
Tejun Heo63d95a92012-07-12 14:46:37 -0700688 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
689 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200690
691 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
692}
693
694/*
695 * Wake up functions.
696 */
697
Tejun Heo7e116292010-06-29 10:07:13 +0200698/* Return the first worker. Safe with preemption disabled */
Tejun Heo63d95a92012-07-12 14:46:37 -0700699static struct worker *first_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200700{
Tejun Heo63d95a92012-07-12 14:46:37 -0700701 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200702 return NULL;
703
Tejun Heo63d95a92012-07-12 14:46:37 -0700704 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200705}
706
707/**
708 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700709 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200710 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700711 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200712 *
713 * CONTEXT:
714 * spin_lock_irq(gcwq->lock).
715 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700716static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200717{
Tejun Heo63d95a92012-07-12 14:46:37 -0700718 struct worker *worker = first_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200719
720 if (likely(worker))
721 wake_up_process(worker->task);
722}
723
Tejun Heo4690c4a2010-06-29 10:07:10 +0200724/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200725 * wq_worker_waking_up - a worker is waking up
726 * @task: task waking up
727 * @cpu: CPU @task is waking up to
728 *
729 * This function is called during try_to_wake_up() when a worker is
730 * being awoken.
731 *
732 * CONTEXT:
733 * spin_lock_irq(rq->lock)
734 */
735void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
736{
737 struct worker *worker = kthread_data(task);
738
Steven Rostedt2d646722010-12-03 23:12:33 -0500739 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700740 atomic_inc(get_pool_nr_running(worker->pool));
Tejun Heoe22bee72010-06-29 10:07:14 +0200741}
742
743/**
744 * wq_worker_sleeping - a worker is going to sleep
745 * @task: task going to sleep
746 * @cpu: CPU in question, must be the current CPU number
747 *
748 * This function is called during schedule() when a busy worker is
749 * going to sleep. Worker on the same cpu can be woken up by
750 * returning pointer to its task.
751 *
752 * CONTEXT:
753 * spin_lock_irq(rq->lock)
754 *
755 * RETURNS:
756 * Worker task on @cpu to wake up, %NULL if none.
757 */
758struct task_struct *wq_worker_sleeping(struct task_struct *task,
759 unsigned int cpu)
760{
761 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heobd7bdd42012-07-12 14:46:37 -0700762 struct worker_pool *pool = worker->pool;
Tejun Heo63d95a92012-07-12 14:46:37 -0700763 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200764
Steven Rostedt2d646722010-12-03 23:12:33 -0500765 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200766 return NULL;
767
768 /* this can only happen on the local cpu */
769 BUG_ON(cpu != raw_smp_processor_id());
770
771 /*
772 * The counterpart of the following dec_and_test, implied mb,
773 * worklist not empty test sequence is in insert_work().
774 * Please read comment there.
775 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700776 * NOT_RUNNING is clear. This means that we're bound to and
777 * running on the local cpu w/ rq lock held and preemption
778 * disabled, which in turn means that none else could be
779 * manipulating idle_list, so dereferencing idle_list without gcwq
780 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200781 */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700782 if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700783 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200784 return to_wakeup ? to_wakeup->task : NULL;
785}
786
787/**
788 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200789 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200790 * @flags: flags to set
791 * @wakeup: wakeup an idle worker if necessary
792 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200793 * Set @flags in @worker->flags and adjust nr_running accordingly. If
794 * nr_running becomes zero and @wakeup is %true, an idle worker is
795 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200796 *
Tejun Heocb444762010-07-02 10:03:50 +0200797 * CONTEXT:
798 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200799 */
800static inline void worker_set_flags(struct worker *worker, unsigned int flags,
801 bool wakeup)
802{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700803 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200804
Tejun Heocb444762010-07-02 10:03:50 +0200805 WARN_ON_ONCE(worker->task != current);
806
Tejun Heoe22bee72010-06-29 10:07:14 +0200807 /*
808 * If transitioning into NOT_RUNNING, adjust nr_running and
809 * wake up an idle worker as necessary if requested by
810 * @wakeup.
811 */
812 if ((flags & WORKER_NOT_RUNNING) &&
813 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heo63d95a92012-07-12 14:46:37 -0700814 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200815
816 if (wakeup) {
817 if (atomic_dec_and_test(nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700818 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700819 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200820 } else
821 atomic_dec(nr_running);
822 }
823
Tejun Heod302f012010-06-29 10:07:13 +0200824 worker->flags |= flags;
825}
826
827/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200828 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200829 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200830 * @flags: flags to clear
831 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200832 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200833 *
Tejun Heocb444762010-07-02 10:03:50 +0200834 * CONTEXT:
835 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200836 */
837static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
838{
Tejun Heo63d95a92012-07-12 14:46:37 -0700839 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200840 unsigned int oflags = worker->flags;
841
Tejun Heocb444762010-07-02 10:03:50 +0200842 WARN_ON_ONCE(worker->task != current);
843
Tejun Heod302f012010-06-29 10:07:13 +0200844 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200845
Tejun Heo42c025f2011-01-11 15:58:49 +0100846 /*
847 * If transitioning out of NOT_RUNNING, increment nr_running. Note
848 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
849 * of multiple flags, not a single flag.
850 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200851 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
852 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700853 atomic_inc(get_pool_nr_running(pool));
Tejun Heod302f012010-06-29 10:07:13 +0200854}
855
856/**
Tejun Heoc8e55f32010-06-29 10:07:12 +0200857 * busy_worker_head - return the busy hash head for a work
858 * @gcwq: gcwq of interest
859 * @work: work to be hashed
860 *
861 * Return hash head of @gcwq for @work.
862 *
863 * CONTEXT:
864 * spin_lock_irq(gcwq->lock).
865 *
866 * RETURNS:
867 * Pointer to the hash head.
868 */
869static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
870 struct work_struct *work)
871{
872 const int base_shift = ilog2(sizeof(struct work_struct));
873 unsigned long v = (unsigned long)work;
874
875 /* simple shift and fold hash, do we need something better? */
876 v >>= base_shift;
877 v += v >> BUSY_WORKER_HASH_ORDER;
878 v &= BUSY_WORKER_HASH_MASK;
879
880 return &gcwq->busy_hash[v];
881}
882
883/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200884 * __find_worker_executing_work - find worker which is executing a work
885 * @gcwq: gcwq of interest
886 * @bwh: hash head as returned by busy_worker_head()
887 * @work: work to find worker for
888 *
889 * Find a worker which is executing @work on @gcwq. @bwh should be
890 * the hash head obtained by calling busy_worker_head() with the same
891 * work.
892 *
893 * CONTEXT:
894 * spin_lock_irq(gcwq->lock).
895 *
896 * RETURNS:
897 * Pointer to worker which is executing @work if found, NULL
898 * otherwise.
899 */
900static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
901 struct hlist_head *bwh,
902 struct work_struct *work)
903{
904 struct worker *worker;
905 struct hlist_node *tmp;
906
907 hlist_for_each_entry(worker, tmp, bwh, hentry)
908 if (worker->current_work == work)
909 return worker;
910 return NULL;
911}
912
913/**
914 * find_worker_executing_work - find worker which is executing a work
915 * @gcwq: gcwq of interest
916 * @work: work to find worker for
917 *
918 * Find a worker which is executing @work on @gcwq. This function is
919 * identical to __find_worker_executing_work() except that this
920 * function calculates @bwh itself.
921 *
922 * CONTEXT:
923 * spin_lock_irq(gcwq->lock).
924 *
925 * RETURNS:
926 * Pointer to worker which is executing @work if found, NULL
927 * otherwise.
928 */
929static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
930 struct work_struct *work)
931{
932 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
933 work);
934}
935
936/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700937 * move_linked_works - move linked works to a list
938 * @work: start of series of works to be scheduled
939 * @head: target list to append @work to
940 * @nextp: out paramter for nested worklist walking
941 *
942 * Schedule linked works starting from @work to @head. Work series to
943 * be scheduled starts at @work and includes any consecutive work with
944 * WORK_STRUCT_LINKED set in its predecessor.
945 *
946 * If @nextp is not NULL, it's updated to point to the next work of
947 * the last scheduled work. This allows move_linked_works() to be
948 * nested inside outer list_for_each_entry_safe().
949 *
950 * CONTEXT:
951 * spin_lock_irq(gcwq->lock).
952 */
953static void move_linked_works(struct work_struct *work, struct list_head *head,
954 struct work_struct **nextp)
955{
956 struct work_struct *n;
957
958 /*
959 * Linked worklist will always end before the end of the list,
960 * use NULL for list head.
961 */
962 list_for_each_entry_safe_from(work, n, NULL, entry) {
963 list_move_tail(&work->entry, head);
964 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
965 break;
966 }
967
968 /*
969 * If we're already inside safe list traversal and have moved
970 * multiple works to the scheduled queue, the next position
971 * needs to be updated.
972 */
973 if (nextp)
974 *nextp = n;
975}
976
977static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
978{
979 struct work_struct *work = list_first_entry(&cwq->delayed_works,
980 struct work_struct, entry);
981
982 trace_workqueue_activate_work(work);
983 move_linked_works(work, &cwq->pool->worklist, NULL);
984 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
985 cwq->nr_active++;
986}
987
988/**
989 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
990 * @cwq: cwq of interest
991 * @color: color of work which left the queue
992 * @delayed: for a delayed work
993 *
994 * A work either has completed or is removed from pending queue,
995 * decrement nr_in_flight of its cwq and handle workqueue flushing.
996 *
997 * CONTEXT:
998 * spin_lock_irq(gcwq->lock).
999 */
1000static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
1001 bool delayed)
1002{
1003 /* ignore uncolored works */
1004 if (color == WORK_NO_COLOR)
1005 return;
1006
1007 cwq->nr_in_flight[color]--;
1008
1009 if (!delayed) {
1010 cwq->nr_active--;
1011 if (!list_empty(&cwq->delayed_works)) {
1012 /* one down, submit a delayed one */
1013 if (cwq->nr_active < cwq->max_active)
1014 cwq_activate_first_delayed(cwq);
1015 }
1016 }
1017
1018 /* is flush in progress and are we at the flushing tip? */
1019 if (likely(cwq->flush_color != color))
1020 return;
1021
1022 /* are there still in-flight works? */
1023 if (cwq->nr_in_flight[color])
1024 return;
1025
1026 /* this cwq is done, clear flush_color */
1027 cwq->flush_color = -1;
1028
1029 /*
1030 * If this was the last cwq, wake up the first flusher. It
1031 * will handle the rest.
1032 */
1033 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1034 complete(&cwq->wq->first_flusher->done);
1035}
1036
Tejun Heo36e227d2012-08-03 10:30:46 -07001037/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001038 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001039 * @work: work item to steal
1040 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001041 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001042 *
1043 * Try to grab PENDING bit of @work. This function can handle @work in any
1044 * stable state - idle, on timer or on worklist. Return values are
1045 *
1046 * 1 if @work was pending and we successfully stole PENDING
1047 * 0 if @work was idle and we claimed PENDING
1048 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001049 * -ENOENT if someone else is canceling @work, this state may persist
1050 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001051 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001052 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
1053 * preempted while holding PENDING and @work off queue, preemption must be
1054 * disabled on entry. This ensures that we don't return -EAGAIN while
1055 * another task is preempted in this function.
1056 *
1057 * On successful return, >= 0, irq is disabled and the caller is
1058 * responsible for releasing it using local_irq_restore(*@flags).
1059 *
1060 * This function is safe to call from any context other than IRQ handler.
1061 * An IRQ handler may run on top of delayed_work_timer_fn() which can make
1062 * this function return -EAGAIN perpetually.
Tejun Heobf4ede02012-08-03 10:30:46 -07001063 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001064static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1065 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001066{
1067 struct global_cwq *gcwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001068
Tejun Heobbb68df2012-08-03 10:30:46 -07001069 WARN_ON_ONCE(in_irq());
1070
1071 local_irq_save(*flags);
1072
Tejun Heo36e227d2012-08-03 10:30:46 -07001073 /* try to steal the timer if it exists */
1074 if (is_dwork) {
1075 struct delayed_work *dwork = to_delayed_work(work);
1076
1077 if (likely(del_timer(&dwork->timer)))
1078 return 1;
1079 }
1080
1081 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001082 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1083 return 0;
1084
1085 /*
1086 * The queueing is in progress, or it is already queued. Try to
1087 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1088 */
1089 gcwq = get_work_gcwq(work);
1090 if (!gcwq)
Tejun Heobbb68df2012-08-03 10:30:46 -07001091 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001092
Tejun Heobbb68df2012-08-03 10:30:46 -07001093 spin_lock(&gcwq->lock);
Tejun Heobf4ede02012-08-03 10:30:46 -07001094 if (!list_empty(&work->entry)) {
1095 /*
1096 * This work is queued, but perhaps we locked the wrong gcwq.
1097 * In that case we must see the new value after rmb(), see
1098 * insert_work()->wmb().
1099 */
1100 smp_rmb();
1101 if (gcwq == get_work_gcwq(work)) {
1102 debug_work_deactivate(work);
1103 list_del_init(&work->entry);
1104 cwq_dec_nr_in_flight(get_work_cwq(work),
1105 get_work_color(work),
1106 *work_data_bits(work) & WORK_STRUCT_DELAYED);
Tejun Heo36e227d2012-08-03 10:30:46 -07001107
Tejun Heobbb68df2012-08-03 10:30:46 -07001108 spin_unlock(&gcwq->lock);
Tejun Heo36e227d2012-08-03 10:30:46 -07001109 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001110 }
1111 }
Tejun Heobbb68df2012-08-03 10:30:46 -07001112 spin_unlock(&gcwq->lock);
1113fail:
1114 local_irq_restore(*flags);
1115 if (work_is_canceling(work))
1116 return -ENOENT;
1117 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001118 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001119}
1120
1121/**
Tejun Heo7e116292010-06-29 10:07:13 +02001122 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +02001123 * @cwq: cwq @work belongs to
1124 * @work: work to insert
1125 * @head: insertion point
1126 * @extra_flags: extra WORK_STRUCT_* flags to set
1127 *
Tejun Heo7e116292010-06-29 10:07:13 +02001128 * Insert @work which belongs to @cwq into @gcwq after @head.
1129 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001130 *
1131 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001132 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001133 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001134static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +02001135 struct work_struct *work, struct list_head *head,
1136 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001137{
Tejun Heo63d95a92012-07-12 14:46:37 -07001138 struct worker_pool *pool = cwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001139
Tejun Heo4690c4a2010-06-29 10:07:10 +02001140 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +02001141 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001142
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001143 /*
1144 * Ensure that we get the right work->data if we see the
1145 * result of list_add() below, see try_to_grab_pending().
1146 */
1147 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +02001148
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001149 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +02001150
1151 /*
1152 * Ensure either worker_sched_deactivated() sees the above
1153 * list_add_tail() or we see zero nr_running to avoid workers
1154 * lying around lazily while there are works to be processed.
1155 */
1156 smp_mb();
1157
Tejun Heo63d95a92012-07-12 14:46:37 -07001158 if (__need_more_worker(pool))
1159 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001160}
1161
Tejun Heoc8efcc22010-12-20 19:32:04 +01001162/*
1163 * Test whether @work is being queued from another work executing on the
1164 * same workqueue. This is rather expensive and should only be used from
1165 * cold paths.
1166 */
1167static bool is_chained_work(struct workqueue_struct *wq)
1168{
1169 unsigned long flags;
1170 unsigned int cpu;
1171
1172 for_each_gcwq_cpu(cpu) {
1173 struct global_cwq *gcwq = get_gcwq(cpu);
1174 struct worker *worker;
1175 struct hlist_node *pos;
1176 int i;
1177
1178 spin_lock_irqsave(&gcwq->lock, flags);
1179 for_each_busy_worker(worker, i, pos, gcwq) {
1180 if (worker->task != current)
1181 continue;
1182 spin_unlock_irqrestore(&gcwq->lock, flags);
1183 /*
1184 * I'm @worker, no locking necessary. See if @work
1185 * is headed to the same workqueue.
1186 */
1187 return worker->current_cwq->wq == wq;
1188 }
1189 spin_unlock_irqrestore(&gcwq->lock, flags);
1190 }
1191 return false;
1192}
1193
Tejun Heo4690c4a2010-06-29 10:07:10 +02001194static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 struct work_struct *work)
1196{
Tejun Heo502ca9d2010-06-29 10:07:13 +02001197 struct global_cwq *gcwq;
1198 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001199 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001200 unsigned int work_flags;
Tejun Heo8930cab2012-08-03 10:30:45 -07001201
1202 /*
1203 * While a work item is PENDING && off queue, a task trying to
1204 * steal the PENDING will busy-loop waiting for it to either get
1205 * queued or lose PENDING. Grabbing PENDING and queueing should
1206 * happen with IRQ disabled.
1207 */
1208 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001210 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001211
Tejun Heoc8efcc22010-12-20 19:32:04 +01001212 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02001213 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001214 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001215 return;
1216
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001217 /* determine gcwq to use */
1218 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001219 struct global_cwq *last_gcwq;
1220
Tejun Heo57469822012-08-03 10:30:45 -07001221 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001222 cpu = raw_smp_processor_id();
1223
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001224 /*
1225 * It's multi cpu. If @wq is non-reentrant and @work
1226 * was previously on a different cpu, it might still
1227 * be running there, in which case the work needs to
1228 * be queued on that cpu to guarantee non-reentrance.
1229 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001230 gcwq = get_gcwq(cpu);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001231 if (wq->flags & WQ_NON_REENTRANT &&
1232 (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
1233 struct worker *worker;
1234
Tejun Heo8930cab2012-08-03 10:30:45 -07001235 spin_lock(&last_gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001236
1237 worker = find_worker_executing_work(last_gcwq, work);
1238
1239 if (worker && worker->current_cwq->wq == wq)
1240 gcwq = last_gcwq;
1241 else {
1242 /* meh... not running there, queue here */
Tejun Heo8930cab2012-08-03 10:30:45 -07001243 spin_unlock(&last_gcwq->lock);
1244 spin_lock(&gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001245 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001246 } else {
1247 spin_lock(&gcwq->lock);
1248 }
Tejun Heof3421792010-07-02 10:03:51 +02001249 } else {
1250 gcwq = get_gcwq(WORK_CPU_UNBOUND);
Tejun Heo8930cab2012-08-03 10:30:45 -07001251 spin_lock(&gcwq->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001252 }
1253
1254 /* gcwq determined, get cwq and queue */
1255 cwq = get_cwq(gcwq->cpu, wq);
Tejun Heocdadf002010-10-05 10:49:55 +02001256 trace_workqueue_queue_work(cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001257
Dan Carpenterf5b25522012-04-13 22:06:58 +03001258 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo8930cab2012-08-03 10:30:45 -07001259 spin_unlock(&gcwq->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001260 return;
1261 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001262
Tejun Heo73f53c42010-06-29 10:07:11 +02001263 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001264 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001265
1266 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001267 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001268 cwq->nr_active++;
Tejun Heo32704762012-07-13 22:16:45 -07001269 worklist = &cwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001270 } else {
1271 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001272 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001273 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001274
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001275 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001276
Tejun Heo8930cab2012-08-03 10:30:45 -07001277 spin_unlock(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278}
1279
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001280/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001281 * queue_work_on - queue work on specific cpu
1282 * @cpu: CPU number to execute work on
1283 * @wq: workqueue to use
1284 * @work: work to queue
1285 *
Tejun Heod4283e92012-08-03 10:30:44 -07001286 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001287 *
1288 * We queue the work to a specific CPU, the caller must ensure it
1289 * can't go away.
1290 */
Tejun Heod4283e92012-08-03 10:30:44 -07001291bool queue_work_on(int cpu, struct workqueue_struct *wq,
1292 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001293{
Tejun Heod4283e92012-08-03 10:30:44 -07001294 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001295 unsigned long flags;
1296
1297 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001298
Tejun Heo22df02b2010-06-29 10:07:10 +02001299 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001300 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001301 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001302 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001303
1304 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001305 return ret;
1306}
1307EXPORT_SYMBOL_GPL(queue_work_on);
1308
Tejun Heo0a13c002012-08-03 10:30:44 -07001309/**
1310 * queue_work - queue work on a workqueue
1311 * @wq: workqueue to use
1312 * @work: work to queue
1313 *
Tejun Heod4283e92012-08-03 10:30:44 -07001314 * Returns %false if @work was already on a queue, %true otherwise.
Tejun Heo0a13c002012-08-03 10:30:44 -07001315 *
1316 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1317 * it can be processed by another CPU.
1318 */
Tejun Heod4283e92012-08-03 10:30:44 -07001319bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07001320{
Tejun Heo57469822012-08-03 10:30:45 -07001321 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
Tejun Heo0a13c002012-08-03 10:30:44 -07001322}
1323EXPORT_SYMBOL_GPL(queue_work);
1324
Tejun Heod8e794d2012-08-03 10:30:45 -07001325void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326{
David Howells52bad642006-11-22 14:54:01 +00001327 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001328 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329
Tejun Heo8930cab2012-08-03 10:30:45 -07001330 local_irq_disable();
Tejun Heo12650572012-08-08 09:38:42 -07001331 __queue_work(dwork->cpu, cwq->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07001332 local_irq_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333}
Tejun Heod8e794d2012-08-03 10:30:45 -07001334EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001336static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1337 struct delayed_work *dwork, unsigned long delay)
1338{
1339 struct timer_list *timer = &dwork->timer;
1340 struct work_struct *work = &dwork->work;
1341 unsigned int lcpu;
1342
1343 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1344 timer->data != (unsigned long)dwork);
1345 BUG_ON(timer_pending(timer));
1346 BUG_ON(!list_empty(&work->entry));
1347
1348 timer_stats_timer_set_start_info(&dwork->timer);
1349
1350 /*
1351 * This stores cwq for the moment, for the timer_fn. Note that the
1352 * work's gcwq is preserved to allow reentrance detection for
1353 * delayed works.
1354 */
1355 if (!(wq->flags & WQ_UNBOUND)) {
1356 struct global_cwq *gcwq = get_work_gcwq(work);
1357
1358 if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1359 lcpu = gcwq->cpu;
1360 else
1361 lcpu = raw_smp_processor_id();
1362 } else {
1363 lcpu = WORK_CPU_UNBOUND;
1364 }
1365
1366 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1367
Tejun Heo12650572012-08-08 09:38:42 -07001368 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001369 timer->expires = jiffies + delay;
1370
1371 if (unlikely(cpu != WORK_CPU_UNBOUND))
1372 add_timer_on(timer, cpu);
1373 else
1374 add_timer(timer);
1375}
1376
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001377/**
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001378 * queue_delayed_work_on - queue work on specific CPU after delay
1379 * @cpu: CPU number to execute work on
1380 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001381 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001382 * @delay: number of jiffies to wait before queueing
1383 *
Tejun Heo715f1302012-08-03 10:30:46 -07001384 * Returns %false if @work was already on a queue, %true otherwise. If
1385 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1386 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001387 */
Tejun Heod4283e92012-08-03 10:30:44 -07001388bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1389 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001390{
David Howells52bad642006-11-22 14:54:01 +00001391 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001392 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001393 unsigned long flags;
1394
Tejun Heo715f1302012-08-03 10:30:46 -07001395 if (!delay)
1396 return queue_work_on(cpu, wq, &dwork->work);
1397
Tejun Heo8930cab2012-08-03 10:30:45 -07001398 /* read the comment in __queue_work() */
1399 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001400
Tejun Heo22df02b2010-06-29 10:07:10 +02001401 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001402 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001403 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001404 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001405
1406 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001407 return ret;
1408}
Dave Jonesae90dd52006-06-30 01:40:45 -04001409EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410
Tejun Heoc8e55f32010-06-29 10:07:12 +02001411/**
Tejun Heo0a13c002012-08-03 10:30:44 -07001412 * queue_delayed_work - queue work on a workqueue after delay
1413 * @wq: workqueue to use
1414 * @dwork: delayable work to queue
1415 * @delay: number of jiffies to wait before queueing
1416 *
Tejun Heo715f1302012-08-03 10:30:46 -07001417 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
Tejun Heo0a13c002012-08-03 10:30:44 -07001418 */
Tejun Heod4283e92012-08-03 10:30:44 -07001419bool queue_delayed_work(struct workqueue_struct *wq,
Tejun Heo0a13c002012-08-03 10:30:44 -07001420 struct delayed_work *dwork, unsigned long delay)
1421{
Tejun Heo57469822012-08-03 10:30:45 -07001422 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
Tejun Heo0a13c002012-08-03 10:30:44 -07001423}
1424EXPORT_SYMBOL_GPL(queue_delayed_work);
1425
1426/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001427 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1428 * @cpu: CPU number to execute work on
1429 * @wq: workqueue to use
1430 * @dwork: work to queue
1431 * @delay: number of jiffies to wait before queueing
1432 *
1433 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1434 * modify @dwork's timer so that it expires after @delay. If @delay is
1435 * zero, @work is guaranteed to be scheduled immediately regardless of its
1436 * current state.
1437 *
1438 * Returns %false if @dwork was idle and queued, %true if @dwork was
1439 * pending and its timer was modified.
1440 *
1441 * This function is safe to call from any context other than IRQ handler.
1442 * See try_to_grab_pending() for details.
1443 */
1444bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1445 struct delayed_work *dwork, unsigned long delay)
1446{
1447 unsigned long flags;
1448 int ret;
1449
1450 do {
1451 ret = try_to_grab_pending(&dwork->work, true, &flags);
1452 } while (unlikely(ret == -EAGAIN));
1453
1454 if (likely(ret >= 0)) {
1455 __queue_delayed_work(cpu, wq, dwork, delay);
1456 local_irq_restore(flags);
1457 }
1458
1459 /* -ENOENT from try_to_grab_pending() becomes %true */
1460 return ret;
1461}
1462EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1463
1464/**
1465 * mod_delayed_work - modify delay of or queue a delayed work
1466 * @wq: workqueue to use
1467 * @dwork: work to queue
1468 * @delay: number of jiffies to wait before queueing
1469 *
1470 * mod_delayed_work_on() on local CPU.
1471 */
1472bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1473 unsigned long delay)
1474{
1475 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1476}
1477EXPORT_SYMBOL_GPL(mod_delayed_work);
1478
1479/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001480 * worker_enter_idle - enter idle state
1481 * @worker: worker which is entering idle state
1482 *
1483 * @worker is entering idle state. Update stats and idle timer if
1484 * necessary.
1485 *
1486 * LOCKING:
1487 * spin_lock_irq(gcwq->lock).
1488 */
1489static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001491 struct worker_pool *pool = worker->pool;
1492 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493
Tejun Heoc8e55f32010-06-29 10:07:12 +02001494 BUG_ON(worker->flags & WORKER_IDLE);
1495 BUG_ON(!list_empty(&worker->entry) &&
1496 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497
Tejun Heocb444762010-07-02 10:03:50 +02001498 /* can't use worker_set_flags(), also called from start_worker() */
1499 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001500 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001501 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001502
Tejun Heoc8e55f32010-06-29 10:07:12 +02001503 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001504 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001505
Tejun Heo628c78e2012-07-17 12:39:27 -07001506 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1507 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001508
Tejun Heo544ecf32012-05-14 15:04:50 -07001509 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07001510 * Sanity check nr_running. Because gcwq_unbind_fn() releases
1511 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1512 * nr_running, the warning may trigger spuriously. Check iff
1513 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001514 */
Tejun Heo628c78e2012-07-17 12:39:27 -07001515 WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001516 pool->nr_workers == pool->nr_idle &&
Tejun Heo63d95a92012-07-12 14:46:37 -07001517 atomic_read(get_pool_nr_running(pool)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518}
1519
Tejun Heoc8e55f32010-06-29 10:07:12 +02001520/**
1521 * worker_leave_idle - leave idle state
1522 * @worker: worker which is leaving idle state
1523 *
1524 * @worker is leaving idle state. Update stats.
1525 *
1526 * LOCKING:
1527 * spin_lock_irq(gcwq->lock).
1528 */
1529static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001531 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532
Tejun Heoc8e55f32010-06-29 10:07:12 +02001533 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001534 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001535 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001536 list_del_init(&worker->entry);
1537}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538
Tejun Heoe22bee72010-06-29 10:07:14 +02001539/**
1540 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1541 * @worker: self
1542 *
1543 * Works which are scheduled while the cpu is online must at least be
1544 * scheduled to a worker which is bound to the cpu so that if they are
1545 * flushed from cpu callbacks while cpu is going down, they are
1546 * guaranteed to execute on the cpu.
1547 *
1548 * This function is to be used by rogue workers and rescuers to bind
1549 * themselves to the target cpu and may race with cpu going down or
1550 * coming online. kthread_bind() can't be used because it may put the
1551 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1552 * verbatim as it's best effort and blocking and gcwq may be
1553 * [dis]associated in the meantime.
1554 *
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001555 * This function tries set_cpus_allowed() and locks gcwq and verifies the
1556 * binding against %GCWQ_DISASSOCIATED which is set during
1557 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1558 * enters idle state or fetches works without dropping lock, it can
1559 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001560 *
1561 * CONTEXT:
1562 * Might sleep. Called without any lock but returns with gcwq->lock
1563 * held.
1564 *
1565 * RETURNS:
1566 * %true if the associated gcwq is online (@worker is successfully
1567 * bound), %false if offline.
1568 */
1569static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001570__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001571{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001572 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001573 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
Tejun Heoe22bee72010-06-29 10:07:14 +02001575 while (true) {
1576 /*
1577 * The following call may fail, succeed or succeed
1578 * without actually migrating the task to the cpu if
1579 * it races with cpu hotunplug operation. Verify
1580 * against GCWQ_DISASSOCIATED.
1581 */
Tejun Heof3421792010-07-02 10:03:51 +02001582 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1583 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001584
Tejun Heoe22bee72010-06-29 10:07:14 +02001585 spin_lock_irq(&gcwq->lock);
1586 if (gcwq->flags & GCWQ_DISASSOCIATED)
1587 return false;
1588 if (task_cpu(task) == gcwq->cpu &&
1589 cpumask_equal(&current->cpus_allowed,
1590 get_cpu_mask(gcwq->cpu)))
1591 return true;
1592 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001593
Tejun Heo5035b202011-04-29 18:08:37 +02001594 /*
1595 * We've raced with CPU hot[un]plug. Give it a breather
1596 * and retry migration. cond_resched() is required here;
1597 * otherwise, we might deadlock against cpu_stop trying to
1598 * bring down the CPU on non-preemptive kernel.
1599 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001600 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001601 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001602 }
1603}
1604
Tejun Heo25511a42012-07-17 12:39:27 -07001605struct idle_rebind {
1606 int cnt; /* # workers to be rebound */
1607 struct completion done; /* all workers rebound */
1608};
1609
Tejun Heoe22bee72010-06-29 10:07:14 +02001610/*
Tejun Heo25511a42012-07-17 12:39:27 -07001611 * Rebind an idle @worker to its CPU. During CPU onlining, this has to
1612 * happen synchronously for idle workers. worker_thread() will test
1613 * %WORKER_REBIND before leaving idle and call this function.
1614 */
1615static void idle_worker_rebind(struct worker *worker)
1616{
1617 struct global_cwq *gcwq = worker->pool->gcwq;
1618
1619 /* CPU must be online at this point */
1620 WARN_ON(!worker_maybe_bind_and_lock(worker));
1621 if (!--worker->idle_rebind->cnt)
1622 complete(&worker->idle_rebind->done);
1623 spin_unlock_irq(&worker->pool->gcwq->lock);
1624
1625 /* we did our part, wait for rebind_workers() to finish up */
1626 wait_event(gcwq->rebind_hold, !(worker->flags & WORKER_REBIND));
1627}
1628
1629/*
1630 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001631 * the associated cpu which is coming back online. This is scheduled by
1632 * cpu up but can race with other cpu hotplug operations and may be
1633 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001634 */
Tejun Heo25511a42012-07-17 12:39:27 -07001635static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001636{
1637 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001638 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001639
1640 if (worker_maybe_bind_and_lock(worker))
1641 worker_clr_flags(worker, WORKER_REBIND);
1642
1643 spin_unlock_irq(&gcwq->lock);
1644}
1645
Tejun Heo25511a42012-07-17 12:39:27 -07001646/**
1647 * rebind_workers - rebind all workers of a gcwq to the associated CPU
1648 * @gcwq: gcwq of interest
1649 *
1650 * @gcwq->cpu is coming online. Rebind all workers to the CPU. Rebinding
1651 * is different for idle and busy ones.
1652 *
1653 * The idle ones should be rebound synchronously and idle rebinding should
1654 * be complete before any worker starts executing work items with
1655 * concurrency management enabled; otherwise, scheduler may oops trying to
1656 * wake up non-local idle worker from wq_worker_sleeping().
1657 *
1658 * This is achieved by repeatedly requesting rebinding until all idle
1659 * workers are known to have been rebound under @gcwq->lock and holding all
1660 * idle workers from becoming busy until idle rebinding is complete.
1661 *
1662 * Once idle workers are rebound, busy workers can be rebound as they
1663 * finish executing their current work items. Queueing the rebind work at
1664 * the head of their scheduled lists is enough. Note that nr_running will
1665 * be properbly bumped as busy workers rebind.
1666 *
1667 * On return, all workers are guaranteed to either be bound or have rebind
1668 * work item scheduled.
1669 */
1670static void rebind_workers(struct global_cwq *gcwq)
1671 __releases(&gcwq->lock) __acquires(&gcwq->lock)
1672{
1673 struct idle_rebind idle_rebind;
1674 struct worker_pool *pool;
1675 struct worker *worker;
1676 struct hlist_node *pos;
1677 int i;
1678
1679 lockdep_assert_held(&gcwq->lock);
1680
1681 for_each_worker_pool(pool, gcwq)
1682 lockdep_assert_held(&pool->manager_mutex);
1683
1684 /*
1685 * Rebind idle workers. Interlocked both ways. We wait for
1686 * workers to rebind via @idle_rebind.done. Workers will wait for
1687 * us to finish up by watching %WORKER_REBIND.
1688 */
1689 init_completion(&idle_rebind.done);
1690retry:
1691 idle_rebind.cnt = 1;
1692 INIT_COMPLETION(idle_rebind.done);
1693
1694 /* set REBIND and kick idle ones, we'll wait for these later */
1695 for_each_worker_pool(pool, gcwq) {
1696 list_for_each_entry(worker, &pool->idle_list, entry) {
1697 if (worker->flags & WORKER_REBIND)
1698 continue;
1699
1700 /* morph UNBOUND to REBIND */
1701 worker->flags &= ~WORKER_UNBOUND;
1702 worker->flags |= WORKER_REBIND;
1703
1704 idle_rebind.cnt++;
1705 worker->idle_rebind = &idle_rebind;
1706
1707 /* worker_thread() will call idle_worker_rebind() */
1708 wake_up_process(worker->task);
1709 }
1710 }
1711
1712 if (--idle_rebind.cnt) {
1713 spin_unlock_irq(&gcwq->lock);
1714 wait_for_completion(&idle_rebind.done);
1715 spin_lock_irq(&gcwq->lock);
1716 /* busy ones might have become idle while waiting, retry */
1717 goto retry;
1718 }
1719
1720 /*
1721 * All idle workers are rebound and waiting for %WORKER_REBIND to
1722 * be cleared inside idle_worker_rebind(). Clear and release.
1723 * Clearing %WORKER_REBIND from this foreign context is safe
1724 * because these workers are still guaranteed to be idle.
1725 */
1726 for_each_worker_pool(pool, gcwq)
1727 list_for_each_entry(worker, &pool->idle_list, entry)
1728 worker->flags &= ~WORKER_REBIND;
1729
1730 wake_up_all(&gcwq->rebind_hold);
1731
1732 /* rebind busy workers */
1733 for_each_busy_worker(worker, i, pos, gcwq) {
1734 struct work_struct *rebind_work = &worker->rebind_work;
1735
1736 /* morph UNBOUND to REBIND */
1737 worker->flags &= ~WORKER_UNBOUND;
1738 worker->flags |= WORKER_REBIND;
1739
1740 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1741 work_data_bits(rebind_work)))
1742 continue;
1743
1744 /* wq doesn't matter, use the default one */
1745 debug_work_activate(rebind_work);
1746 insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
1747 worker->scheduled.next,
1748 work_color_to_flags(WORK_NO_COLOR));
1749 }
1750}
1751
Tejun Heoc34056a2010-06-29 10:07:11 +02001752static struct worker *alloc_worker(void)
1753{
1754 struct worker *worker;
1755
1756 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001757 if (worker) {
1758 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001759 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001760 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001761 /* on creation a worker is in !idle && prep state */
1762 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001763 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001764 return worker;
1765}
1766
1767/**
1768 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001769 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001770 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001771 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001772 * can be started by calling start_worker() or destroyed using
1773 * destroy_worker().
1774 *
1775 * CONTEXT:
1776 * Might sleep. Does GFP_KERNEL allocations.
1777 *
1778 * RETURNS:
1779 * Pointer to the newly created worker.
1780 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001781static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001782{
Tejun Heo63d95a92012-07-12 14:46:37 -07001783 struct global_cwq *gcwq = pool->gcwq;
Tejun Heo32704762012-07-13 22:16:45 -07001784 const char *pri = worker_pool_pri(pool) ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001785 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001786 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001787
Tejun Heo8b03ae32010-06-29 10:07:12 +02001788 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001789 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001790 spin_unlock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001791 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001792 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001793 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001794 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001795 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001796
1797 worker = alloc_worker();
1798 if (!worker)
1799 goto fail;
1800
Tejun Heobd7bdd42012-07-12 14:46:37 -07001801 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001802 worker->id = id;
1803
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001804 if (gcwq->cpu != WORK_CPU_UNBOUND)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001805 worker->task = kthread_create_on_node(worker_thread,
Tejun Heo32704762012-07-13 22:16:45 -07001806 worker, cpu_to_node(gcwq->cpu),
1807 "kworker/%u:%d%s", gcwq->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001808 else
1809 worker->task = kthread_create(worker_thread, worker,
Tejun Heo32704762012-07-13 22:16:45 -07001810 "kworker/u:%d%s", id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001811 if (IS_ERR(worker->task))
1812 goto fail;
1813
Tejun Heo32704762012-07-13 22:16:45 -07001814 if (worker_pool_pri(pool))
1815 set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
1816
Tejun Heodb7bccf2010-06-29 10:07:12 +02001817 /*
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001818 * Determine CPU binding of the new worker depending on
1819 * %GCWQ_DISASSOCIATED. The caller is responsible for ensuring the
1820 * flag remains stable across this function. See the comments
1821 * above the flag definition for details.
1822 *
1823 * As an unbound worker may later become a regular one if CPU comes
1824 * online, make sure every worker has %PF_THREAD_BOUND set.
Tejun Heodb7bccf2010-06-29 10:07:12 +02001825 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001826 if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001827 kthread_bind(worker->task, gcwq->cpu);
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001828 } else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001829 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001830 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001832
Tejun Heoc34056a2010-06-29 10:07:11 +02001833 return worker;
1834fail:
1835 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001836 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001837 ida_remove(&pool->worker_ida, id);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001838 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001839 }
1840 kfree(worker);
1841 return NULL;
1842}
1843
1844/**
1845 * start_worker - start a newly created worker
1846 * @worker: worker to start
1847 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001848 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001849 *
1850 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001851 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001852 */
1853static void start_worker(struct worker *worker)
1854{
Tejun Heocb444762010-07-02 10:03:50 +02001855 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001856 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001857 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001858 wake_up_process(worker->task);
1859}
1860
1861/**
1862 * destroy_worker - destroy a workqueue worker
1863 * @worker: worker to be destroyed
1864 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001865 * Destroy @worker and adjust @gcwq stats accordingly.
1866 *
1867 * CONTEXT:
1868 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001869 */
1870static void destroy_worker(struct worker *worker)
1871{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001872 struct worker_pool *pool = worker->pool;
1873 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001874 int id = worker->id;
1875
1876 /* sanity check frenzy */
1877 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001878 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001879
Tejun Heoc8e55f32010-06-29 10:07:12 +02001880 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001881 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001882 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001883 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001884
1885 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001886 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001887
1888 spin_unlock_irq(&gcwq->lock);
1889
Tejun Heoc34056a2010-06-29 10:07:11 +02001890 kthread_stop(worker->task);
1891 kfree(worker);
1892
Tejun Heo8b03ae32010-06-29 10:07:12 +02001893 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001894 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001895}
1896
Tejun Heo63d95a92012-07-12 14:46:37 -07001897static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001898{
Tejun Heo63d95a92012-07-12 14:46:37 -07001899 struct worker_pool *pool = (void *)__pool;
1900 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001901
1902 spin_lock_irq(&gcwq->lock);
1903
Tejun Heo63d95a92012-07-12 14:46:37 -07001904 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001905 struct worker *worker;
1906 unsigned long expires;
1907
1908 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001909 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001910 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1911
1912 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001913 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001914 else {
1915 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001916 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001917 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001918 }
1919 }
1920
1921 spin_unlock_irq(&gcwq->lock);
1922}
1923
1924static bool send_mayday(struct work_struct *work)
1925{
1926 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1927 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001928 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001929
1930 if (!(wq->flags & WQ_RESCUER))
1931 return false;
1932
1933 /* mayday mayday mayday */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001934 cpu = cwq->pool->gcwq->cpu;
Tejun Heof3421792010-07-02 10:03:51 +02001935 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1936 if (cpu == WORK_CPU_UNBOUND)
1937 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001938 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001939 wake_up_process(wq->rescuer->task);
1940 return true;
1941}
1942
Tejun Heo63d95a92012-07-12 14:46:37 -07001943static void gcwq_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001944{
Tejun Heo63d95a92012-07-12 14:46:37 -07001945 struct worker_pool *pool = (void *)__pool;
1946 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001947 struct work_struct *work;
1948
1949 spin_lock_irq(&gcwq->lock);
1950
Tejun Heo63d95a92012-07-12 14:46:37 -07001951 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001952 /*
1953 * We've been trying to create a new worker but
1954 * haven't been successful. We might be hitting an
1955 * allocation deadlock. Send distress signals to
1956 * rescuers.
1957 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001958 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001959 send_mayday(work);
1960 }
1961
1962 spin_unlock_irq(&gcwq->lock);
1963
Tejun Heo63d95a92012-07-12 14:46:37 -07001964 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001965}
1966
1967/**
1968 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001969 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001970 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001971 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001972 * have at least one idle worker on return from this function. If
1973 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001974 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001975 * possible allocation deadlock.
1976 *
1977 * On return, need_to_create_worker() is guaranteed to be false and
1978 * may_start_working() true.
1979 *
1980 * LOCKING:
1981 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1982 * multiple times. Does GFP_KERNEL allocations. Called only from
1983 * manager.
1984 *
1985 * RETURNS:
1986 * false if no action was taken and gcwq->lock stayed locked, true
1987 * otherwise.
1988 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001989static bool maybe_create_worker(struct worker_pool *pool)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001990__releases(&gcwq->lock)
1991__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001992{
Tejun Heo63d95a92012-07-12 14:46:37 -07001993 struct global_cwq *gcwq = pool->gcwq;
1994
1995 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001996 return false;
1997restart:
Tejun Heo9f9c2362010-07-14 11:31:20 +02001998 spin_unlock_irq(&gcwq->lock);
1999
Tejun Heoe22bee72010-06-29 10:07:14 +02002000 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002001 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002002
2003 while (true) {
2004 struct worker *worker;
2005
Tejun Heobc2ae0f2012-07-17 12:39:27 -07002006 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002007 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002008 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002009 spin_lock_irq(&gcwq->lock);
2010 start_worker(worker);
Tejun Heo63d95a92012-07-12 14:46:37 -07002011 BUG_ON(need_to_create_worker(pool));
Tejun Heoe22bee72010-06-29 10:07:14 +02002012 return true;
2013 }
2014
Tejun Heo63d95a92012-07-12 14:46:37 -07002015 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002016 break;
2017
Tejun Heoe22bee72010-06-29 10:07:14 +02002018 __set_current_state(TASK_INTERRUPTIBLE);
2019 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02002020
Tejun Heo63d95a92012-07-12 14:46:37 -07002021 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002022 break;
2023 }
2024
Tejun Heo63d95a92012-07-12 14:46:37 -07002025 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002026 spin_lock_irq(&gcwq->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07002027 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002028 goto restart;
2029 return true;
2030}
2031
2032/**
2033 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07002034 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02002035 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002036 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02002037 * IDLE_WORKER_TIMEOUT.
2038 *
2039 * LOCKING:
2040 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2041 * multiple times. Called only from manager.
2042 *
2043 * RETURNS:
2044 * false if no action was taken and gcwq->lock stayed locked, true
2045 * otherwise.
2046 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002047static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02002048{
2049 bool ret = false;
2050
Tejun Heo63d95a92012-07-12 14:46:37 -07002051 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002052 struct worker *worker;
2053 unsigned long expires;
2054
Tejun Heo63d95a92012-07-12 14:46:37 -07002055 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002056 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2057
2058 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002059 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02002060 break;
2061 }
2062
2063 destroy_worker(worker);
2064 ret = true;
2065 }
2066
2067 return ret;
2068}
2069
2070/**
2071 * manage_workers - manage worker pool
2072 * @worker: self
2073 *
2074 * Assume the manager role and manage gcwq worker pool @worker belongs
2075 * to. At any given time, there can be only zero or one manager per
2076 * gcwq. The exclusion is handled automatically by this function.
2077 *
2078 * The caller can safely start processing works on false return. On
2079 * true return, it's guaranteed that need_to_create_worker() is false
2080 * and may_start_working() is true.
2081 *
2082 * CONTEXT:
2083 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2084 * multiple times. Does GFP_KERNEL allocations.
2085 *
2086 * RETURNS:
2087 * false if no action was taken and gcwq->lock stayed locked, true if
2088 * some action was taken.
2089 */
2090static bool manage_workers(struct worker *worker)
2091{
Tejun Heo63d95a92012-07-12 14:46:37 -07002092 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002093 bool ret = false;
2094
Tejun Heo60373152012-07-17 12:39:27 -07002095 if (!mutex_trylock(&pool->manager_mutex))
Tejun Heoe22bee72010-06-29 10:07:14 +02002096 return ret;
2097
Tejun Heo11ebea52012-07-12 14:46:37 -07002098 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002099
2100 /*
2101 * Destroy and then create so that may_start_working() is true
2102 * on return.
2103 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002104 ret |= maybe_destroy_workers(pool);
2105 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002106
Tejun Heo60373152012-07-17 12:39:27 -07002107 mutex_unlock(&pool->manager_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02002108 return ret;
2109}
2110
Tejun Heoa62428c2010-06-29 10:07:10 +02002111/**
2112 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002113 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002114 * @work: work to process
2115 *
2116 * Process @work. This function contains all the logics necessary to
2117 * process a single work including synchronization against and
2118 * interaction with other workers on the same cpu, queueing and
2119 * flushing. As long as context requirement is met, any worker can
2120 * call this function to process a work.
2121 *
2122 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002123 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002124 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002125static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09002126__releases(&gcwq->lock)
2127__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002128{
Tejun Heo7e116292010-06-29 10:07:13 +02002129 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002130 struct worker_pool *pool = worker->pool;
2131 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002132 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002133 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02002134 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02002135 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002136 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002137#ifdef CONFIG_LOCKDEP
2138 /*
2139 * It is permissible to free the struct work_struct from
2140 * inside the function that is called from it, this we need to
2141 * take into account for lockdep too. To avoid bogus "held
2142 * lock freed" warnings as well as problems when looking into
2143 * work->lockdep_map, make a copy and use that here.
2144 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002145 struct lockdep_map lockdep_map;
2146
2147 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002148#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002149 /*
2150 * Ensure we're on the correct CPU. DISASSOCIATED test is
2151 * necessary to avoid spurious warnings from rescuers servicing the
2152 * unbound or a disassociated gcwq.
2153 */
Tejun Heo25511a42012-07-17 12:39:27 -07002154 WARN_ON_ONCE(!(worker->flags & (WORKER_UNBOUND | WORKER_REBIND)) &&
Tejun Heo6fec10a2012-07-22 10:16:34 -07002155 !(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heo25511a42012-07-17 12:39:27 -07002156 raw_smp_processor_id() != gcwq->cpu);
2157
Tejun Heo7e116292010-06-29 10:07:13 +02002158 /*
2159 * A single work shouldn't be executed concurrently by
2160 * multiple workers on a single cpu. Check whether anyone is
2161 * already processing the work. If so, defer the work to the
2162 * currently executing one.
2163 */
2164 collision = __find_worker_executing_work(gcwq, bwh, work);
2165 if (unlikely(collision)) {
2166 move_linked_works(work, &collision->scheduled, NULL);
2167 return;
2168 }
2169
Tejun Heo8930cab2012-08-03 10:30:45 -07002170 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002171 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002172 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02002173 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002174 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002175 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002176
Tejun Heoa62428c2010-06-29 10:07:10 +02002177 list_del_init(&work->entry);
2178
Tejun Heo649027d2010-06-29 10:07:14 +02002179 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002180 * CPU intensive works don't participate in concurrency
2181 * management. They're the scheduler's responsibility.
2182 */
2183 if (unlikely(cpu_intensive))
2184 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2185
Tejun Heo974271c2012-07-12 14:46:37 -07002186 /*
2187 * Unbound gcwq isn't concurrency managed and work items should be
2188 * executed ASAP. Wake up another worker if necessary.
2189 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002190 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2191 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002192
Tejun Heo8930cab2012-08-03 10:30:45 -07002193 /*
Tejun Heo23657bb2012-08-13 17:08:19 -07002194 * Record the last CPU and clear PENDING which should be the last
2195 * update to @work. Also, do this inside @gcwq->lock so that
2196 * PENDING and queued state changes happen together while IRQ is
2197 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002198 */
Tejun Heo8930cab2012-08-03 10:30:45 -07002199 set_work_cpu_and_clear_pending(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02002200
Tejun Heo8930cab2012-08-03 10:30:45 -07002201 spin_unlock_irq(&gcwq->lock);
Tejun Heo959d1af2012-08-03 10:30:45 -07002202
Tejun Heoe1594892011-01-09 23:32:15 +01002203 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002204 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002205 trace_workqueue_execute_start(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002206 f(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002207 /*
2208 * While we must be careful to not use "work" after this, the trace
2209 * point will only record its address.
2210 */
2211 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002212 lock_map_release(&lockdep_map);
2213 lock_map_release(&cwq->wq->lockdep_map);
2214
2215 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2216 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
2217 "%s/0x%08x/%d\n",
2218 current->comm, preempt_count(), task_pid_nr(current));
2219 printk(KERN_ERR " last function: ");
2220 print_symbol("%s\n", (unsigned long)f);
2221 debug_show_held_locks(current);
2222 dump_stack();
2223 }
2224
Tejun Heo8b03ae32010-06-29 10:07:12 +02002225 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002226
Tejun Heofb0e7be2010-06-29 10:07:15 +02002227 /* clear cpu intensive status */
2228 if (unlikely(cpu_intensive))
2229 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2230
Tejun Heoa62428c2010-06-29 10:07:10 +02002231 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02002232 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002233 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002234 worker->current_cwq = NULL;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02002235 cwq_dec_nr_in_flight(cwq, work_color, false);
Tejun Heoa62428c2010-06-29 10:07:10 +02002236}
2237
Tejun Heoaffee4b2010-06-29 10:07:12 +02002238/**
2239 * process_scheduled_works - process scheduled works
2240 * @worker: self
2241 *
2242 * Process all scheduled works. Please note that the scheduled list
2243 * may change while processing a work, so this function repeatedly
2244 * fetches a work from the top and executes it.
2245 *
2246 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002247 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002248 * multiple times.
2249 */
2250static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002252 while (!list_empty(&worker->scheduled)) {
2253 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002255 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257}
2258
Tejun Heo4690c4a2010-06-29 10:07:10 +02002259/**
2260 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002261 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002262 *
Tejun Heoe22bee72010-06-29 10:07:14 +02002263 * The gcwq worker thread function. There's a single dynamic pool of
2264 * these per each cpu. These workers process all works regardless of
2265 * their specific target workqueue. The only exception is works which
2266 * belong to workqueues with a rescuer which will be explained in
2267 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002268 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002269static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270{
Tejun Heoc34056a2010-06-29 10:07:11 +02002271 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002272 struct worker_pool *pool = worker->pool;
2273 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274
Tejun Heoe22bee72010-06-29 10:07:14 +02002275 /* tell the scheduler that this is a workqueue worker */
2276 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002277woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002278 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279
Tejun Heo25511a42012-07-17 12:39:27 -07002280 /*
2281 * DIE can be set only while idle and REBIND set while busy has
2282 * @worker->rebind_work scheduled. Checking here is enough.
2283 */
2284 if (unlikely(worker->flags & (WORKER_REBIND | WORKER_DIE))) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002285 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002286
2287 if (worker->flags & WORKER_DIE) {
2288 worker->task->flags &= ~PF_WQ_WORKER;
2289 return 0;
2290 }
2291
2292 idle_worker_rebind(worker);
2293 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294 }
2295
Tejun Heoc8e55f32010-06-29 10:07:12 +02002296 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002297recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002298 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002299 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002300 goto sleep;
2301
2302 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002303 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002304 goto recheck;
2305
Tejun Heoc8e55f32010-06-29 10:07:12 +02002306 /*
2307 * ->scheduled list can only be filled while a worker is
2308 * preparing to process a work or actually processing it.
2309 * Make sure nobody diddled with it while I was sleeping.
2310 */
2311 BUG_ON(!list_empty(&worker->scheduled));
2312
Tejun Heoe22bee72010-06-29 10:07:14 +02002313 /*
2314 * When control reaches this point, we're guaranteed to have
2315 * at least one idle worker or that someone else has already
2316 * assumed the manager role.
2317 */
2318 worker_clr_flags(worker, WORKER_PREP);
2319
2320 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002321 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002322 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002323 struct work_struct, entry);
2324
2325 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2326 /* optimization path, not strictly necessary */
2327 process_one_work(worker, work);
2328 if (unlikely(!list_empty(&worker->scheduled)))
2329 process_scheduled_works(worker);
2330 } else {
2331 move_linked_works(work, &worker->scheduled, NULL);
2332 process_scheduled_works(worker);
2333 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002334 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002335
Tejun Heoe22bee72010-06-29 10:07:14 +02002336 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002337sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002338 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002339 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002340
Tejun Heoc8e55f32010-06-29 10:07:12 +02002341 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02002342 * gcwq->lock is held and there's no work to process and no
2343 * need to manage, sleep. Workers are woken up only while
2344 * holding gcwq->lock or from local cpu, so setting the
2345 * current state before releasing gcwq->lock is enough to
2346 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002347 */
2348 worker_enter_idle(worker);
2349 __set_current_state(TASK_INTERRUPTIBLE);
2350 spin_unlock_irq(&gcwq->lock);
2351 schedule();
2352 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353}
2354
Tejun Heoe22bee72010-06-29 10:07:14 +02002355/**
2356 * rescuer_thread - the rescuer thread function
2357 * @__wq: the associated workqueue
2358 *
2359 * Workqueue rescuer thread function. There's one rescuer for each
2360 * workqueue which has WQ_RESCUER set.
2361 *
2362 * Regular work processing on a gcwq may block trying to create a new
2363 * worker which uses GFP_KERNEL allocation which has slight chance of
2364 * developing into deadlock if some works currently on the same queue
2365 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2366 * the problem rescuer solves.
2367 *
2368 * When such condition is possible, the gcwq summons rescuers of all
2369 * workqueues which have works queued on the gcwq and let them process
2370 * those works so that forward progress can be guaranteed.
2371 *
2372 * This should happen rarely.
2373 */
2374static int rescuer_thread(void *__wq)
2375{
2376 struct workqueue_struct *wq = __wq;
2377 struct worker *rescuer = wq->rescuer;
2378 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002379 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002380 unsigned int cpu;
2381
2382 set_user_nice(current, RESCUER_NICE_LEVEL);
2383repeat:
2384 set_current_state(TASK_INTERRUPTIBLE);
2385
2386 if (kthread_should_stop())
2387 return 0;
2388
Tejun Heof3421792010-07-02 10:03:51 +02002389 /*
2390 * See whether any cpu is asking for help. Unbounded
2391 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2392 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002393 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002394 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2395 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002396 struct worker_pool *pool = cwq->pool;
2397 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002398 struct work_struct *work, *n;
2399
2400 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002401 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002402
2403 /* migrate to the target cpu if possible */
Tejun Heobd7bdd42012-07-12 14:46:37 -07002404 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002405 worker_maybe_bind_and_lock(rescuer);
2406
2407 /*
2408 * Slurp in all works issued via this workqueue and
2409 * process'em.
2410 */
2411 BUG_ON(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002412 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002413 if (get_work_cwq(work) == cwq)
2414 move_linked_works(work, scheduled, &n);
2415
2416 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002417
2418 /*
2419 * Leave this gcwq. If keep_working() is %true, notify a
2420 * regular worker; otherwise, we end up with 0 concurrency
2421 * and stalling the execution.
2422 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002423 if (keep_working(pool))
2424 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002425
Tejun Heoe22bee72010-06-29 10:07:14 +02002426 spin_unlock_irq(&gcwq->lock);
2427 }
2428
2429 schedule();
2430 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431}
2432
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002433struct wq_barrier {
2434 struct work_struct work;
2435 struct completion done;
2436};
2437
2438static void wq_barrier_func(struct work_struct *work)
2439{
2440 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2441 complete(&barr->done);
2442}
2443
Tejun Heo4690c4a2010-06-29 10:07:10 +02002444/**
2445 * insert_wq_barrier - insert a barrier work
2446 * @cwq: cwq to insert barrier into
2447 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002448 * @target: target work to attach @barr to
2449 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002450 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002451 * @barr is linked to @target such that @barr is completed only after
2452 * @target finishes execution. Please note that the ordering
2453 * guarantee is observed only with respect to @target and on the local
2454 * cpu.
2455 *
2456 * Currently, a queued barrier can't be canceled. This is because
2457 * try_to_grab_pending() can't determine whether the work to be
2458 * grabbed is at the head of the queue and thus can't clear LINKED
2459 * flag of the previous work while there must be a valid next work
2460 * after a work with LINKED flag set.
2461 *
2462 * Note that when @worker is non-NULL, @target may be modified
2463 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002464 *
2465 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002466 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002467 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002468static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002469 struct wq_barrier *barr,
2470 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002471{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002472 struct list_head *head;
2473 unsigned int linked = 0;
2474
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002475 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002476 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002477 * as we know for sure that this will not trigger any of the
2478 * checks and call back into the fixup functions where we
2479 * might deadlock.
2480 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002481 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002482 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002483 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002484
Tejun Heoaffee4b2010-06-29 10:07:12 +02002485 /*
2486 * If @target is currently being executed, schedule the
2487 * barrier to the worker; otherwise, put it after @target.
2488 */
2489 if (worker)
2490 head = worker->scheduled.next;
2491 else {
2492 unsigned long *bits = work_data_bits(target);
2493
2494 head = target->entry.next;
2495 /* there can already be other linked works, inherit and set */
2496 linked = *bits & WORK_STRUCT_LINKED;
2497 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2498 }
2499
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002500 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002501 insert_work(cwq, &barr->work, head,
2502 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002503}
2504
Tejun Heo73f53c42010-06-29 10:07:11 +02002505/**
2506 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2507 * @wq: workqueue being flushed
2508 * @flush_color: new flush color, < 0 for no-op
2509 * @work_color: new work color, < 0 for no-op
2510 *
2511 * Prepare cwqs for workqueue flushing.
2512 *
2513 * If @flush_color is non-negative, flush_color on all cwqs should be
2514 * -1. If no cwq has in-flight commands at the specified color, all
2515 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2516 * has in flight commands, its cwq->flush_color is set to
2517 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2518 * wakeup logic is armed and %true is returned.
2519 *
2520 * The caller should have initialized @wq->first_flusher prior to
2521 * calling this function with non-negative @flush_color. If
2522 * @flush_color is negative, no flush color update is done and %false
2523 * is returned.
2524 *
2525 * If @work_color is non-negative, all cwqs should have the same
2526 * work_color which is previous to @work_color and all will be
2527 * advanced to @work_color.
2528 *
2529 * CONTEXT:
2530 * mutex_lock(wq->flush_mutex).
2531 *
2532 * RETURNS:
2533 * %true if @flush_color >= 0 and there's something to flush. %false
2534 * otherwise.
2535 */
2536static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2537 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538{
Tejun Heo73f53c42010-06-29 10:07:11 +02002539 bool wait = false;
2540 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002541
Tejun Heo73f53c42010-06-29 10:07:11 +02002542 if (flush_color >= 0) {
2543 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2544 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002545 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002546
Tejun Heof3421792010-07-02 10:03:51 +02002547 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002548 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002549 struct global_cwq *gcwq = cwq->pool->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002550
Tejun Heo8b03ae32010-06-29 10:07:12 +02002551 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002552
2553 if (flush_color >= 0) {
2554 BUG_ON(cwq->flush_color != -1);
2555
2556 if (cwq->nr_in_flight[flush_color]) {
2557 cwq->flush_color = flush_color;
2558 atomic_inc(&wq->nr_cwqs_to_flush);
2559 wait = true;
2560 }
2561 }
2562
2563 if (work_color >= 0) {
2564 BUG_ON(work_color != work_next_color(cwq->work_color));
2565 cwq->work_color = work_color;
2566 }
2567
Tejun Heo8b03ae32010-06-29 10:07:12 +02002568 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002569 }
2570
2571 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2572 complete(&wq->first_flusher->done);
2573
2574 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575}
2576
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002577/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002579 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002580 *
2581 * Forces execution of the workqueue and blocks until its completion.
2582 * This is typically used in driver shutdown handlers.
2583 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002584 * We sleep until all works which were queued on entry have been handled,
2585 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002587void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588{
Tejun Heo73f53c42010-06-29 10:07:11 +02002589 struct wq_flusher this_flusher = {
2590 .list = LIST_HEAD_INIT(this_flusher.list),
2591 .flush_color = -1,
2592 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2593 };
2594 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002595
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002596 lock_map_acquire(&wq->lockdep_map);
2597 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002598
2599 mutex_lock(&wq->flush_mutex);
2600
2601 /*
2602 * Start-to-wait phase
2603 */
2604 next_color = work_next_color(wq->work_color);
2605
2606 if (next_color != wq->flush_color) {
2607 /*
2608 * Color space is not full. The current work_color
2609 * becomes our flush_color and work_color is advanced
2610 * by one.
2611 */
2612 BUG_ON(!list_empty(&wq->flusher_overflow));
2613 this_flusher.flush_color = wq->work_color;
2614 wq->work_color = next_color;
2615
2616 if (!wq->first_flusher) {
2617 /* no flush in progress, become the first flusher */
2618 BUG_ON(wq->flush_color != this_flusher.flush_color);
2619
2620 wq->first_flusher = &this_flusher;
2621
2622 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2623 wq->work_color)) {
2624 /* nothing to flush, done */
2625 wq->flush_color = next_color;
2626 wq->first_flusher = NULL;
2627 goto out_unlock;
2628 }
2629 } else {
2630 /* wait in queue */
2631 BUG_ON(wq->flush_color == this_flusher.flush_color);
2632 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2633 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2634 }
2635 } else {
2636 /*
2637 * Oops, color space is full, wait on overflow queue.
2638 * The next flush completion will assign us
2639 * flush_color and transfer to flusher_queue.
2640 */
2641 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2642 }
2643
2644 mutex_unlock(&wq->flush_mutex);
2645
2646 wait_for_completion(&this_flusher.done);
2647
2648 /*
2649 * Wake-up-and-cascade phase
2650 *
2651 * First flushers are responsible for cascading flushes and
2652 * handling overflow. Non-first flushers can simply return.
2653 */
2654 if (wq->first_flusher != &this_flusher)
2655 return;
2656
2657 mutex_lock(&wq->flush_mutex);
2658
Tejun Heo4ce48b32010-07-02 10:03:51 +02002659 /* we might have raced, check again with mutex held */
2660 if (wq->first_flusher != &this_flusher)
2661 goto out_unlock;
2662
Tejun Heo73f53c42010-06-29 10:07:11 +02002663 wq->first_flusher = NULL;
2664
2665 BUG_ON(!list_empty(&this_flusher.list));
2666 BUG_ON(wq->flush_color != this_flusher.flush_color);
2667
2668 while (true) {
2669 struct wq_flusher *next, *tmp;
2670
2671 /* complete all the flushers sharing the current flush color */
2672 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2673 if (next->flush_color != wq->flush_color)
2674 break;
2675 list_del_init(&next->list);
2676 complete(&next->done);
2677 }
2678
2679 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2680 wq->flush_color != work_next_color(wq->work_color));
2681
2682 /* this flush_color is finished, advance by one */
2683 wq->flush_color = work_next_color(wq->flush_color);
2684
2685 /* one color has been freed, handle overflow queue */
2686 if (!list_empty(&wq->flusher_overflow)) {
2687 /*
2688 * Assign the same color to all overflowed
2689 * flushers, advance work_color and append to
2690 * flusher_queue. This is the start-to-wait
2691 * phase for these overflowed flushers.
2692 */
2693 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2694 tmp->flush_color = wq->work_color;
2695
2696 wq->work_color = work_next_color(wq->work_color);
2697
2698 list_splice_tail_init(&wq->flusher_overflow,
2699 &wq->flusher_queue);
2700 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2701 }
2702
2703 if (list_empty(&wq->flusher_queue)) {
2704 BUG_ON(wq->flush_color != wq->work_color);
2705 break;
2706 }
2707
2708 /*
2709 * Need to flush more colors. Make the next flusher
2710 * the new first flusher and arm cwqs.
2711 */
2712 BUG_ON(wq->flush_color == wq->work_color);
2713 BUG_ON(wq->flush_color != next->flush_color);
2714
2715 list_del_init(&next->list);
2716 wq->first_flusher = next;
2717
2718 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2719 break;
2720
2721 /*
2722 * Meh... this color is already done, clear first
2723 * flusher and repeat cascading.
2724 */
2725 wq->first_flusher = NULL;
2726 }
2727
2728out_unlock:
2729 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730}
Dave Jonesae90dd52006-06-30 01:40:45 -04002731EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002732
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002733/**
2734 * drain_workqueue - drain a workqueue
2735 * @wq: workqueue to drain
2736 *
2737 * Wait until the workqueue becomes empty. While draining is in progress,
2738 * only chain queueing is allowed. IOW, only currently pending or running
2739 * work items on @wq can queue further work items on it. @wq is flushed
2740 * repeatedly until it becomes empty. The number of flushing is detemined
2741 * by the depth of chaining and should be relatively short. Whine if it
2742 * takes too long.
2743 */
2744void drain_workqueue(struct workqueue_struct *wq)
2745{
2746 unsigned int flush_cnt = 0;
2747 unsigned int cpu;
2748
2749 /*
2750 * __queue_work() needs to test whether there are drainers, is much
2751 * hotter than drain_workqueue() and already looks at @wq->flags.
2752 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2753 */
2754 spin_lock(&workqueue_lock);
2755 if (!wq->nr_drainers++)
2756 wq->flags |= WQ_DRAINING;
2757 spin_unlock(&workqueue_lock);
2758reflush:
2759 flush_workqueue(wq);
2760
2761 for_each_cwq_cpu(cpu, wq) {
2762 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002763 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002764
Tejun Heobd7bdd42012-07-12 14:46:37 -07002765 spin_lock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002766 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002767 spin_unlock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002768
2769 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002770 continue;
2771
2772 if (++flush_cnt == 10 ||
2773 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2774 pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
2775 wq->name, flush_cnt);
2776 goto reflush;
2777 }
2778
2779 spin_lock(&workqueue_lock);
2780 if (!--wq->nr_drainers)
2781 wq->flags &= ~WQ_DRAINING;
2782 spin_unlock(&workqueue_lock);
2783}
2784EXPORT_SYMBOL_GPL(drain_workqueue);
2785
Tejun Heobaf59022010-09-16 10:42:16 +02002786static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2787 bool wait_executing)
2788{
2789 struct worker *worker = NULL;
2790 struct global_cwq *gcwq;
2791 struct cpu_workqueue_struct *cwq;
2792
2793 might_sleep();
2794 gcwq = get_work_gcwq(work);
2795 if (!gcwq)
2796 return false;
2797
2798 spin_lock_irq(&gcwq->lock);
2799 if (!list_empty(&work->entry)) {
2800 /*
2801 * See the comment near try_to_grab_pending()->smp_rmb().
2802 * If it was re-queued to a different gcwq under us, we
2803 * are not going to wait.
2804 */
2805 smp_rmb();
2806 cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002807 if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
Tejun Heobaf59022010-09-16 10:42:16 +02002808 goto already_gone;
2809 } else if (wait_executing) {
2810 worker = find_worker_executing_work(gcwq, work);
2811 if (!worker)
2812 goto already_gone;
2813 cwq = worker->current_cwq;
2814 } else
2815 goto already_gone;
2816
2817 insert_wq_barrier(cwq, barr, work, worker);
2818 spin_unlock_irq(&gcwq->lock);
2819
Tejun Heoe1594892011-01-09 23:32:15 +01002820 /*
2821 * If @max_active is 1 or rescuer is in use, flushing another work
2822 * item on the same workqueue may lead to deadlock. Make sure the
2823 * flusher is not running on the same workqueue by verifying write
2824 * access.
2825 */
2826 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2827 lock_map_acquire(&cwq->wq->lockdep_map);
2828 else
2829 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002830 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002831
Tejun Heobaf59022010-09-16 10:42:16 +02002832 return true;
2833already_gone:
2834 spin_unlock_irq(&gcwq->lock);
2835 return false;
2836}
2837
Oleg Nesterovdb700892008-07-25 01:47:49 -07002838/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002839 * flush_work - wait for a work to finish executing the last queueing instance
2840 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002841 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002842 * Wait until @work has finished execution. This function considers
2843 * only the last queueing instance of @work. If @work has been
2844 * enqueued across different CPUs on a non-reentrant workqueue or on
2845 * multiple workqueues, @work might still be executing on return on
2846 * some of the CPUs from earlier queueing.
Oleg Nesterova67da702008-07-25 01:47:52 -07002847 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002848 * If @work was queued only on a non-reentrant, ordered or unbound
2849 * workqueue, @work is guaranteed to be idle on return if it hasn't
2850 * been requeued since flush started.
2851 *
2852 * RETURNS:
2853 * %true if flush_work() waited for the work to finish execution,
2854 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002855 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002856bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002857{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002858 struct wq_barrier barr;
2859
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002860 lock_map_acquire(&work->lockdep_map);
2861 lock_map_release(&work->lockdep_map);
2862
Tejun Heobaf59022010-09-16 10:42:16 +02002863 if (start_flush_work(work, &barr, true)) {
2864 wait_for_completion(&barr.done);
2865 destroy_work_on_stack(&barr.work);
2866 return true;
2867 } else
2868 return false;
Oleg Nesterovdb700892008-07-25 01:47:49 -07002869}
2870EXPORT_SYMBOL_GPL(flush_work);
2871
Tejun Heo401a8d02010-09-16 10:36:00 +02002872static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2873{
2874 struct wq_barrier barr;
2875 struct worker *worker;
2876
2877 spin_lock_irq(&gcwq->lock);
2878
2879 worker = find_worker_executing_work(gcwq, work);
2880 if (unlikely(worker))
2881 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2882
2883 spin_unlock_irq(&gcwq->lock);
2884
2885 if (unlikely(worker)) {
2886 wait_for_completion(&barr.done);
2887 destroy_work_on_stack(&barr.work);
2888 return true;
2889 } else
2890 return false;
2891}
2892
2893static bool wait_on_work(struct work_struct *work)
2894{
2895 bool ret = false;
2896 int cpu;
2897
2898 might_sleep();
2899
2900 lock_map_acquire(&work->lockdep_map);
2901 lock_map_release(&work->lockdep_map);
2902
2903 for_each_gcwq_cpu(cpu)
2904 ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2905 return ret;
2906}
2907
Tejun Heo09383492010-09-16 10:48:29 +02002908/**
2909 * flush_work_sync - wait until a work has finished execution
2910 * @work: the work to flush
2911 *
2912 * Wait until @work has finished execution. On return, it's
2913 * guaranteed that all queueing instances of @work which happened
2914 * before this function is called are finished. In other words, if
2915 * @work hasn't been requeued since this function was called, @work is
2916 * guaranteed to be idle on return.
2917 *
2918 * RETURNS:
2919 * %true if flush_work_sync() waited for the work to finish execution,
2920 * %false if it was already idle.
2921 */
2922bool flush_work_sync(struct work_struct *work)
2923{
2924 struct wq_barrier barr;
2925 bool pending, waited;
2926
2927 /* we'll wait for executions separately, queue barr only if pending */
2928 pending = start_flush_work(work, &barr, false);
2929
2930 /* wait for executions to finish */
2931 waited = wait_on_work(work);
2932
2933 /* wait for the pending one */
2934 if (pending) {
2935 wait_for_completion(&barr.done);
2936 destroy_work_on_stack(&barr.work);
2937 }
2938
2939 return pending || waited;
2940}
2941EXPORT_SYMBOL_GPL(flush_work_sync);
2942
Tejun Heo36e227d2012-08-03 10:30:46 -07002943static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002944{
Tejun Heobbb68df2012-08-03 10:30:46 -07002945 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002946 int ret;
2947
2948 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002949 ret = try_to_grab_pending(work, is_dwork, &flags);
2950 /*
2951 * If someone else is canceling, wait for the same event it
2952 * would be waiting for before retrying.
2953 */
2954 if (unlikely(ret == -ENOENT))
2955 wait_on_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002956 } while (unlikely(ret < 0));
2957
Tejun Heobbb68df2012-08-03 10:30:46 -07002958 /* tell other tasks trying to grab @work to back off */
2959 mark_work_canceling(work);
2960 local_irq_restore(flags);
2961
2962 wait_on_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002963 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002964 return ret;
2965}
2966
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002967/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002968 * cancel_work_sync - cancel a work and wait for it to finish
2969 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002970 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002971 * Cancel @work and wait for its execution to finish. This function
2972 * can be used even if the work re-queues itself or migrates to
2973 * another workqueue. On return from this function, @work is
2974 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002975 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002976 * cancel_work_sync(&delayed_work->work) must not be used for
2977 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002978 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002979 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002980 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002981 *
2982 * RETURNS:
2983 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002984 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002985bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002986{
Tejun Heo36e227d2012-08-03 10:30:46 -07002987 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002988}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002989EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002990
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002991/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002992 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2993 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002994 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002995 * Delayed timer is cancelled and the pending work is queued for
2996 * immediate execution. Like flush_work(), this function only
2997 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002998 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002999 * RETURNS:
3000 * %true if flush_work() waited for the work to finish execution,
3001 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003002 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003003bool flush_delayed_work(struct delayed_work *dwork)
3004{
Tejun Heo8930cab2012-08-03 10:30:45 -07003005 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003006 if (del_timer_sync(&dwork->timer))
Tejun Heo12650572012-08-08 09:38:42 -07003007 __queue_work(dwork->cpu,
Tejun Heo401a8d02010-09-16 10:36:00 +02003008 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003009 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003010 return flush_work(&dwork->work);
3011}
3012EXPORT_SYMBOL(flush_delayed_work);
3013
3014/**
Tejun Heo09383492010-09-16 10:48:29 +02003015 * flush_delayed_work_sync - wait for a dwork to finish
3016 * @dwork: the delayed work to flush
3017 *
3018 * Delayed timer is cancelled and the pending work is queued for
3019 * execution immediately. Other than timer handling, its behavior
3020 * is identical to flush_work_sync().
3021 *
3022 * RETURNS:
3023 * %true if flush_work_sync() waited for the work to finish execution,
3024 * %false if it was already idle.
3025 */
3026bool flush_delayed_work_sync(struct delayed_work *dwork)
3027{
Tejun Heo8930cab2012-08-03 10:30:45 -07003028 local_irq_disable();
Tejun Heo09383492010-09-16 10:48:29 +02003029 if (del_timer_sync(&dwork->timer))
Tejun Heo12650572012-08-08 09:38:42 -07003030 __queue_work(dwork->cpu,
Tejun Heo09383492010-09-16 10:48:29 +02003031 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003032 local_irq_enable();
Tejun Heo09383492010-09-16 10:48:29 +02003033 return flush_work_sync(&dwork->work);
3034}
3035EXPORT_SYMBOL(flush_delayed_work_sync);
3036
3037/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003038 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3039 * @dwork: the delayed work cancel
3040 *
3041 * This is cancel_work_sync() for delayed works.
3042 *
3043 * RETURNS:
3044 * %true if @dwork was pending, %false otherwise.
3045 */
3046bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003047{
Tejun Heo36e227d2012-08-03 10:30:46 -07003048 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003049}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003050EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003051
Tejun Heod4283e92012-08-03 10:30:44 -07003052/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003053 * schedule_work_on - put work task on a specific cpu
3054 * @cpu: cpu to put the work task on
3055 * @work: job to be done
3056 *
3057 * This puts a job on a specific cpu
3058 */
Tejun Heod4283e92012-08-03 10:30:44 -07003059bool schedule_work_on(int cpu, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07003060{
3061 return queue_work_on(cpu, system_wq, work);
3062}
3063EXPORT_SYMBOL(schedule_work_on);
3064
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003065/**
3066 * schedule_work - put work task in global workqueue
3067 * @work: job to be done
3068 *
Tejun Heod4283e92012-08-03 10:30:44 -07003069 * Returns %false if @work was already on the kernel-global workqueue and
3070 * %true otherwise.
Bart Van Assche5b0f437d2009-07-30 19:00:53 +02003071 *
3072 * This puts a job in the kernel-global workqueue if it was not already
3073 * queued and leaves it in the same position on the kernel-global
3074 * workqueue otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003075 */
Tejun Heod4283e92012-08-03 10:30:44 -07003076bool schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003077{
Tejun Heod320c032010-06-29 10:07:14 +02003078 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003079}
Dave Jonesae90dd52006-06-30 01:40:45 -04003080EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003081
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003082/**
3083 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
3084 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +00003085 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003086 * @delay: number of jiffies to wait
3087 *
3088 * After waiting for a given time this puts a job in the kernel-global
3089 * workqueue on the specified CPU.
3090 */
Tejun Heod4283e92012-08-03 10:30:44 -07003091bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3092 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003093{
Tejun Heod320c032010-06-29 10:07:14 +02003094 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003095}
Dave Jonesae90dd52006-06-30 01:40:45 -04003096EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003097
Andrew Mortonb6136772006-06-25 05:47:49 -07003098/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003099 * schedule_delayed_work - put work task in global workqueue after delay
3100 * @dwork: job to be done
3101 * @delay: number of jiffies to wait or 0 for immediate execution
3102 *
3103 * After waiting for a given time this puts a job in the kernel-global
3104 * workqueue.
3105 */
Tejun Heod4283e92012-08-03 10:30:44 -07003106bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
Tejun Heo0a13c002012-08-03 10:30:44 -07003107{
3108 return queue_delayed_work(system_wq, dwork, delay);
3109}
3110EXPORT_SYMBOL(schedule_delayed_work);
3111
3112/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003113 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003114 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003115 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003116 * schedule_on_each_cpu() executes @func on each online CPU using the
3117 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003118 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003119 *
3120 * RETURNS:
3121 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003122 */
David Howells65f27f32006-11-22 14:55:48 +00003123int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003124{
3125 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003126 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003127
Andrew Mortonb6136772006-06-25 05:47:49 -07003128 works = alloc_percpu(struct work_struct);
3129 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003130 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003131
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003132 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003133
Christoph Lameter15316ba2006-01-08 01:00:43 -08003134 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003135 struct work_struct *work = per_cpu_ptr(works, cpu);
3136
3137 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003138 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003139 }
Tejun Heo93981802009-11-17 14:06:20 -08003140
3141 for_each_online_cpu(cpu)
3142 flush_work(per_cpu_ptr(works, cpu));
3143
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003144 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003145 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003146 return 0;
3147}
3148
Alan Sterneef6a7d2010-02-12 17:39:21 +09003149/**
3150 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3151 *
3152 * Forces execution of the kernel-global workqueue and blocks until its
3153 * completion.
3154 *
3155 * Think twice before calling this function! It's very easy to get into
3156 * trouble if you don't take great care. Either of the following situations
3157 * will lead to deadlock:
3158 *
3159 * One of the work items currently on the workqueue needs to acquire
3160 * a lock held by your code or its caller.
3161 *
3162 * Your code is running in the context of a work routine.
3163 *
3164 * They will be detected by lockdep when they occur, but the first might not
3165 * occur very often. It depends on what work items are on the workqueue and
3166 * what locks they need, which you have no control over.
3167 *
3168 * In most situations flushing the entire workqueue is overkill; you merely
3169 * need to know that a particular work item isn't queued and isn't running.
3170 * In such cases you should use cancel_delayed_work_sync() or
3171 * cancel_work_sync() instead.
3172 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003173void flush_scheduled_work(void)
3174{
Tejun Heod320c032010-06-29 10:07:14 +02003175 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003176}
Dave Jonesae90dd52006-06-30 01:40:45 -04003177EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003178
3179/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003180 * execute_in_process_context - reliably execute the routine with user context
3181 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003182 * @ew: guaranteed storage for the execute work structure (must
3183 * be available when the work executes)
3184 *
3185 * Executes the function immediately if process context is available,
3186 * otherwise schedules the function for delayed execution.
3187 *
3188 * Returns: 0 - function was executed
3189 * 1 - function was scheduled for execution
3190 */
David Howells65f27f32006-11-22 14:55:48 +00003191int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003192{
3193 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003194 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003195 return 0;
3196 }
3197
David Howells65f27f32006-11-22 14:55:48 +00003198 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003199 schedule_work(&ew->work);
3200
3201 return 1;
3202}
3203EXPORT_SYMBOL_GPL(execute_in_process_context);
3204
Linus Torvalds1da177e2005-04-16 15:20:36 -07003205int keventd_up(void)
3206{
Tejun Heod320c032010-06-29 10:07:14 +02003207 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003208}
3209
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003210static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003211{
Oleg Nesterov3af244332007-05-09 02:34:09 -07003212 /*
Tejun Heo0f900042010-06-29 10:07:11 +02003213 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
3214 * Make sure that the alignment isn't lower than that of
3215 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07003216 */
Tejun Heo0f900042010-06-29 10:07:11 +02003217 const size_t size = sizeof(struct cpu_workqueue_struct);
3218 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
3219 __alignof__(unsigned long long));
Oleg Nesterov3af244332007-05-09 02:34:09 -07003220
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003221 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003222 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02003223 else {
Tejun Heof3421792010-07-02 10:03:51 +02003224 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003225
Tejun Heof3421792010-07-02 10:03:51 +02003226 /*
3227 * Allocate enough room to align cwq and put an extra
3228 * pointer at the end pointing back to the originally
3229 * allocated pointer which will be used for free.
3230 */
3231 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3232 if (ptr) {
3233 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3234 *(void **)(wq->cpu_wq.single + 1) = ptr;
3235 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003236 }
Tejun Heof3421792010-07-02 10:03:51 +02003237
Tejun Heo0415b00d12011-03-24 18:50:09 +01003238 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003239 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3240 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003241}
3242
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003243static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003244{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003245 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003246 free_percpu(wq->cpu_wq.pcpu);
3247 else if (wq->cpu_wq.single) {
3248 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003249 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003250 }
3251}
3252
Tejun Heof3421792010-07-02 10:03:51 +02003253static int wq_clamp_max_active(int max_active, unsigned int flags,
3254 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003255{
Tejun Heof3421792010-07-02 10:03:51 +02003256 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3257
3258 if (max_active < 1 || max_active > lim)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003259 printk(KERN_WARNING "workqueue: max_active %d requested for %s "
3260 "is out of range, clamping between %d and %d\n",
Tejun Heof3421792010-07-02 10:03:51 +02003261 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003262
Tejun Heof3421792010-07-02 10:03:51 +02003263 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003264}
3265
Tejun Heob196be82012-01-10 15:11:35 -08003266struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003267 unsigned int flags,
3268 int max_active,
3269 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003270 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003271{
Tejun Heob196be82012-01-10 15:11:35 -08003272 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003273 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003274 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08003275 size_t namelen;
3276
3277 /* determine namelen, allocate wq and format name */
3278 va_start(args, lock_name);
3279 va_copy(args1, args);
3280 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3281
3282 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3283 if (!wq)
3284 goto err;
3285
3286 vsnprintf(wq->name, namelen, fmt, args1);
3287 va_end(args);
3288 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003289
Tejun Heof3421792010-07-02 10:03:51 +02003290 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02003291 * Workqueues which may be used during memory reclaim should
3292 * have a rescuer to guarantee forward progress.
3293 */
3294 if (flags & WQ_MEM_RECLAIM)
3295 flags |= WQ_RESCUER;
3296
Tejun Heod320c032010-06-29 10:07:14 +02003297 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003298 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003299
Tejun Heob196be82012-01-10 15:11:35 -08003300 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003301 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003302 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003303 mutex_init(&wq->flush_mutex);
3304 atomic_set(&wq->nr_cwqs_to_flush, 0);
3305 INIT_LIST_HEAD(&wq->flusher_queue);
3306 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003307
Johannes Bergeb13ba82008-01-16 09:51:58 +01003308 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003309 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003310
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003311 if (alloc_cwqs(wq) < 0)
3312 goto err;
3313
Tejun Heof3421792010-07-02 10:03:51 +02003314 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003315 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003316 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo32704762012-07-13 22:16:45 -07003317 int pool_idx = (bool)(flags & WQ_HIGHPRI);
Tejun Heo15376632010-06-29 10:07:11 +02003318
Tejun Heo0f900042010-06-29 10:07:11 +02003319 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo32704762012-07-13 22:16:45 -07003320 cwq->pool = &gcwq->pools[pool_idx];
Tejun Heoc34056a2010-06-29 10:07:11 +02003321 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003322 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003323 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003324 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003325 }
3326
Tejun Heoe22bee72010-06-29 10:07:14 +02003327 if (flags & WQ_RESCUER) {
3328 struct worker *rescuer;
3329
Tejun Heof2e005a2010-07-20 15:59:09 +02003330 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003331 goto err;
3332
3333 wq->rescuer = rescuer = alloc_worker();
3334 if (!rescuer)
3335 goto err;
3336
Tejun Heob196be82012-01-10 15:11:35 -08003337 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3338 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003339 if (IS_ERR(rescuer->task))
3340 goto err;
3341
Tejun Heoe22bee72010-06-29 10:07:14 +02003342 rescuer->task->flags |= PF_THREAD_BOUND;
3343 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003344 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003345
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003346 /*
3347 * workqueue_lock protects global freeze state and workqueues
3348 * list. Grab it, set max_active accordingly and add the new
3349 * workqueue to workqueues list.
3350 */
Tejun Heo15376632010-06-29 10:07:11 +02003351 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003352
Tejun Heo58a69cb2011-02-16 09:25:31 +01003353 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003354 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003355 get_cwq(cpu, wq)->max_active = 0;
3356
Tejun Heo15376632010-06-29 10:07:11 +02003357 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003358
Tejun Heo15376632010-06-29 10:07:11 +02003359 spin_unlock(&workqueue_lock);
3360
Oleg Nesterov3af244332007-05-09 02:34:09 -07003361 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003362err:
3363 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003364 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003365 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003366 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003367 kfree(wq);
3368 }
3369 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003370}
Tejun Heod320c032010-06-29 10:07:14 +02003371EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003372
3373/**
3374 * destroy_workqueue - safely terminate a workqueue
3375 * @wq: target workqueue
3376 *
3377 * Safely destroy a workqueue. All work currently pending will be done first.
3378 */
3379void destroy_workqueue(struct workqueue_struct *wq)
3380{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003381 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003382
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003383 /* drain it before proceeding with destruction */
3384 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003385
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003386 /*
3387 * wq list is used to freeze wq, remove from list after
3388 * flushing is complete in case freeze races us.
3389 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003390 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07003391 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003392 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003393
Tejun Heoe22bee72010-06-29 10:07:14 +02003394 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003395 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003396 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3397 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003398
Tejun Heo73f53c42010-06-29 10:07:11 +02003399 for (i = 0; i < WORK_NR_COLORS; i++)
3400 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003401 BUG_ON(cwq->nr_active);
3402 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003403 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003404
Tejun Heoe22bee72010-06-29 10:07:14 +02003405 if (wq->flags & WQ_RESCUER) {
3406 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003407 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003408 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003409 }
3410
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003411 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003412 kfree(wq);
3413}
3414EXPORT_SYMBOL_GPL(destroy_workqueue);
3415
Tejun Heodcd989c2010-06-29 10:07:14 +02003416/**
3417 * workqueue_set_max_active - adjust max_active of a workqueue
3418 * @wq: target workqueue
3419 * @max_active: new max_active value.
3420 *
3421 * Set max_active of @wq to @max_active.
3422 *
3423 * CONTEXT:
3424 * Don't call from IRQ context.
3425 */
3426void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3427{
3428 unsigned int cpu;
3429
Tejun Heof3421792010-07-02 10:03:51 +02003430 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003431
3432 spin_lock(&workqueue_lock);
3433
3434 wq->saved_max_active = max_active;
3435
Tejun Heof3421792010-07-02 10:03:51 +02003436 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003437 struct global_cwq *gcwq = get_gcwq(cpu);
3438
3439 spin_lock_irq(&gcwq->lock);
3440
Tejun Heo58a69cb2011-02-16 09:25:31 +01003441 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003442 !(gcwq->flags & GCWQ_FREEZING))
3443 get_cwq(gcwq->cpu, wq)->max_active = max_active;
3444
3445 spin_unlock_irq(&gcwq->lock);
3446 }
3447
3448 spin_unlock(&workqueue_lock);
3449}
3450EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3451
3452/**
3453 * workqueue_congested - test whether a workqueue is congested
3454 * @cpu: CPU in question
3455 * @wq: target workqueue
3456 *
3457 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3458 * no synchronization around this function and the test result is
3459 * unreliable and only useful as advisory hints or for debugging.
3460 *
3461 * RETURNS:
3462 * %true if congested, %false otherwise.
3463 */
3464bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3465{
3466 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3467
3468 return !list_empty(&cwq->delayed_works);
3469}
3470EXPORT_SYMBOL_GPL(workqueue_congested);
3471
3472/**
3473 * work_cpu - return the last known associated cpu for @work
3474 * @work: the work of interest
3475 *
3476 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003477 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003478 */
3479unsigned int work_cpu(struct work_struct *work)
3480{
3481 struct global_cwq *gcwq = get_work_gcwq(work);
3482
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003483 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003484}
3485EXPORT_SYMBOL_GPL(work_cpu);
3486
3487/**
3488 * work_busy - test whether a work is currently pending or running
3489 * @work: the work to be tested
3490 *
3491 * Test whether @work is currently pending or running. There is no
3492 * synchronization around this function and the test result is
3493 * unreliable and only useful as advisory hints or for debugging.
3494 * Especially for reentrant wqs, the pending state might hide the
3495 * running state.
3496 *
3497 * RETURNS:
3498 * OR'd bitmask of WORK_BUSY_* bits.
3499 */
3500unsigned int work_busy(struct work_struct *work)
3501{
3502 struct global_cwq *gcwq = get_work_gcwq(work);
3503 unsigned long flags;
3504 unsigned int ret = 0;
3505
3506 if (!gcwq)
3507 return false;
3508
3509 spin_lock_irqsave(&gcwq->lock, flags);
3510
3511 if (work_pending(work))
3512 ret |= WORK_BUSY_PENDING;
3513 if (find_worker_executing_work(gcwq, work))
3514 ret |= WORK_BUSY_RUNNING;
3515
3516 spin_unlock_irqrestore(&gcwq->lock, flags);
3517
3518 return ret;
3519}
3520EXPORT_SYMBOL_GPL(work_busy);
3521
Tejun Heodb7bccf2010-06-29 10:07:12 +02003522/*
3523 * CPU hotplug.
3524 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003525 * There are two challenges in supporting CPU hotplug. Firstly, there
3526 * are a lot of assumptions on strong associations among work, cwq and
3527 * gcwq which make migrating pending and scheduled works very
3528 * difficult to implement without impacting hot paths. Secondly,
3529 * gcwqs serve mix of short, long and very long running works making
3530 * blocked draining impractical.
3531 *
Tejun Heo628c78e2012-07-17 12:39:27 -07003532 * This is solved by allowing a gcwq to be disassociated from the CPU
3533 * running as an unbound one and allowing it to be reattached later if the
3534 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003535 */
3536
Tejun Heo60373152012-07-17 12:39:27 -07003537/* claim manager positions of all pools */
Tejun Heo8db25e72012-07-17 12:39:28 -07003538static void gcwq_claim_management_and_lock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003539{
3540 struct worker_pool *pool;
3541
3542 for_each_worker_pool(pool, gcwq)
3543 mutex_lock_nested(&pool->manager_mutex, pool - gcwq->pools);
Tejun Heo8db25e72012-07-17 12:39:28 -07003544 spin_lock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003545}
3546
3547/* release manager positions */
Tejun Heo8db25e72012-07-17 12:39:28 -07003548static void gcwq_release_management_and_unlock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003549{
3550 struct worker_pool *pool;
3551
Tejun Heo8db25e72012-07-17 12:39:28 -07003552 spin_unlock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003553 for_each_worker_pool(pool, gcwq)
3554 mutex_unlock(&pool->manager_mutex);
3555}
3556
Tejun Heo628c78e2012-07-17 12:39:27 -07003557static void gcwq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003558{
Tejun Heo628c78e2012-07-17 12:39:27 -07003559 struct global_cwq *gcwq = get_gcwq(smp_processor_id());
Tejun Heo4ce62e92012-07-13 22:16:44 -07003560 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003561 struct worker *worker;
3562 struct hlist_node *pos;
3563 int i;
3564
3565 BUG_ON(gcwq->cpu != smp_processor_id());
3566
Tejun Heo8db25e72012-07-17 12:39:28 -07003567 gcwq_claim_management_and_lock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003568
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003569 /*
3570 * We've claimed all manager positions. Make all workers unbound
3571 * and set DISASSOCIATED. Before this, all workers except for the
3572 * ones which are still executing works from before the last CPU
3573 * down must be on the cpu. After this, they may become diasporas.
3574 */
Tejun Heo60373152012-07-17 12:39:27 -07003575 for_each_worker_pool(pool, gcwq)
Tejun Heo4ce62e92012-07-13 22:16:44 -07003576 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07003577 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003578
3579 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo403c8212012-07-17 12:39:27 -07003580 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003581
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003582 gcwq->flags |= GCWQ_DISASSOCIATED;
3583
Tejun Heo8db25e72012-07-17 12:39:28 -07003584 gcwq_release_management_and_unlock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003585
3586 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07003587 * Call schedule() so that we cross rq->lock and thus can guarantee
3588 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3589 * as scheduler callbacks may be invoked from other cpus.
3590 */
3591 schedule();
3592
3593 /*
3594 * Sched callbacks are disabled now. Zap nr_running. After this,
3595 * nr_running stays zero and need_more_worker() and keep_working()
3596 * are always true as long as the worklist is not empty. @gcwq now
3597 * behaves as unbound (in terms of concurrency management) gcwq
3598 * which is served by workers tied to the CPU.
3599 *
3600 * On return from this function, the current worker would trigger
3601 * unbound chain execution of pending work items if other workers
3602 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02003603 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07003604 for_each_worker_pool(pool, gcwq)
3605 atomic_set(get_pool_nr_running(pool), 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003606}
3607
Tejun Heo8db25e72012-07-17 12:39:28 -07003608/*
3609 * Workqueues should be brought up before normal priority CPU notifiers.
3610 * This will be registered high priority CPU notifier.
3611 */
3612static int __devinit workqueue_cpu_up_callback(struct notifier_block *nfb,
3613 unsigned long action,
3614 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003615{
3616 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003617 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003618 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003619
Tejun Heo8db25e72012-07-17 12:39:28 -07003620 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003621 case CPU_UP_PREPARE:
Tejun Heo4ce62e92012-07-13 22:16:44 -07003622 for_each_worker_pool(pool, gcwq) {
Tejun Heo3ce63372012-07-17 12:39:27 -07003623 struct worker *worker;
3624
3625 if (pool->nr_workers)
3626 continue;
3627
3628 worker = create_worker(pool);
3629 if (!worker)
3630 return NOTIFY_BAD;
3631
3632 spin_lock_irq(&gcwq->lock);
3633 start_worker(worker);
3634 spin_unlock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003635 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003636 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003637
Tejun Heo65758202012-07-17 12:39:26 -07003638 case CPU_DOWN_FAILED:
3639 case CPU_ONLINE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003640 gcwq_claim_management_and_lock(gcwq);
3641 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3642 rebind_workers(gcwq);
3643 gcwq_release_management_and_unlock(gcwq);
3644 break;
Tejun Heo65758202012-07-17 12:39:26 -07003645 }
3646 return NOTIFY_OK;
3647}
3648
3649/*
3650 * Workqueues should be brought down after normal priority CPU notifiers.
3651 * This will be registered as low priority CPU notifier.
3652 */
3653static int __devinit workqueue_cpu_down_callback(struct notifier_block *nfb,
3654 unsigned long action,
3655 void *hcpu)
3656{
Tejun Heo8db25e72012-07-17 12:39:28 -07003657 unsigned int cpu = (unsigned long)hcpu;
3658 struct work_struct unbind_work;
3659
Tejun Heo65758202012-07-17 12:39:26 -07003660 switch (action & ~CPU_TASKS_FROZEN) {
3661 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003662 /* unbinding should happen on the local CPU */
3663 INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
3664 schedule_work_on(cpu, &unbind_work);
3665 flush_work(&unbind_work);
3666 break;
Tejun Heo65758202012-07-17 12:39:26 -07003667 }
3668 return NOTIFY_OK;
3669}
3670
Rusty Russell2d3854a2008-11-05 13:39:10 +11003671#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003672
Rusty Russell2d3854a2008-11-05 13:39:10 +11003673struct work_for_cpu {
Andrew Morton6b440032009-04-09 09:50:37 -06003674 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003675 long (*fn)(void *);
3676 void *arg;
3677 long ret;
3678};
3679
Andrew Morton6b440032009-04-09 09:50:37 -06003680static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003681{
Andrew Morton6b440032009-04-09 09:50:37 -06003682 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003683 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b440032009-04-09 09:50:37 -06003684 complete(&wfc->completion);
3685 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003686}
3687
3688/**
3689 * work_on_cpu - run a function in user context on a particular cpu
3690 * @cpu: the cpu to run on
3691 * @fn: the function to run
3692 * @arg: the function arg
3693 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003694 * This will return the value @fn returns.
3695 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06003696 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003697 */
3698long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3699{
Andrew Morton6b440032009-04-09 09:50:37 -06003700 struct task_struct *sub_thread;
3701 struct work_for_cpu wfc = {
3702 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3703 .fn = fn,
3704 .arg = arg,
3705 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003706
Andrew Morton6b440032009-04-09 09:50:37 -06003707 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3708 if (IS_ERR(sub_thread))
3709 return PTR_ERR(sub_thread);
3710 kthread_bind(sub_thread, cpu);
3711 wake_up_process(sub_thread);
3712 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003713 return wfc.ret;
3714}
3715EXPORT_SYMBOL_GPL(work_on_cpu);
3716#endif /* CONFIG_SMP */
3717
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003718#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303719
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003720/**
3721 * freeze_workqueues_begin - begin freezing workqueues
3722 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003723 * Start freezing workqueues. After this function returns, all freezable
3724 * workqueues will queue new works to their frozen_works list instead of
3725 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003726 *
3727 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003728 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003729 */
3730void freeze_workqueues_begin(void)
3731{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003732 unsigned int cpu;
3733
3734 spin_lock(&workqueue_lock);
3735
3736 BUG_ON(workqueue_freezing);
3737 workqueue_freezing = true;
3738
Tejun Heof3421792010-07-02 10:03:51 +02003739 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003740 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003741 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003742
3743 spin_lock_irq(&gcwq->lock);
3744
Tejun Heodb7bccf2010-06-29 10:07:12 +02003745 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3746 gcwq->flags |= GCWQ_FREEZING;
3747
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003748 list_for_each_entry(wq, &workqueues, list) {
3749 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3750
Tejun Heo58a69cb2011-02-16 09:25:31 +01003751 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003752 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003753 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003754
3755 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003756 }
3757
3758 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003759}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003760
3761/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003762 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003763 *
3764 * Check whether freezing is complete. This function must be called
3765 * between freeze_workqueues_begin() and thaw_workqueues().
3766 *
3767 * CONTEXT:
3768 * Grabs and releases workqueue_lock.
3769 *
3770 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003771 * %true if some freezable workqueues are still busy. %false if freezing
3772 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003773 */
3774bool freeze_workqueues_busy(void)
3775{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003776 unsigned int cpu;
3777 bool busy = false;
3778
3779 spin_lock(&workqueue_lock);
3780
3781 BUG_ON(!workqueue_freezing);
3782
Tejun Heof3421792010-07-02 10:03:51 +02003783 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003784 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003785 /*
3786 * nr_active is monotonically decreasing. It's safe
3787 * to peek without lock.
3788 */
3789 list_for_each_entry(wq, &workqueues, list) {
3790 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3791
Tejun Heo58a69cb2011-02-16 09:25:31 +01003792 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003793 continue;
3794
3795 BUG_ON(cwq->nr_active < 0);
3796 if (cwq->nr_active) {
3797 busy = true;
3798 goto out_unlock;
3799 }
3800 }
3801 }
3802out_unlock:
3803 spin_unlock(&workqueue_lock);
3804 return busy;
3805}
3806
3807/**
3808 * thaw_workqueues - thaw workqueues
3809 *
3810 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003811 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003812 *
3813 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003814 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003815 */
3816void thaw_workqueues(void)
3817{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003818 unsigned int cpu;
3819
3820 spin_lock(&workqueue_lock);
3821
3822 if (!workqueue_freezing)
3823 goto out_unlock;
3824
Tejun Heof3421792010-07-02 10:03:51 +02003825 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003826 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003827 struct worker_pool *pool;
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003828 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003829
3830 spin_lock_irq(&gcwq->lock);
3831
Tejun Heodb7bccf2010-06-29 10:07:12 +02003832 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3833 gcwq->flags &= ~GCWQ_FREEZING;
3834
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003835 list_for_each_entry(wq, &workqueues, list) {
3836 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3837
Tejun Heo58a69cb2011-02-16 09:25:31 +01003838 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003839 continue;
3840
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003841 /* restore max_active and repopulate worklist */
3842 cwq->max_active = wq->saved_max_active;
3843
3844 while (!list_empty(&cwq->delayed_works) &&
3845 cwq->nr_active < cwq->max_active)
3846 cwq_activate_first_delayed(cwq);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003847 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003848
Tejun Heo4ce62e92012-07-13 22:16:44 -07003849 for_each_worker_pool(pool, gcwq)
3850 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02003851
Tejun Heo8b03ae32010-06-29 10:07:12 +02003852 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003853 }
3854
3855 workqueue_freezing = false;
3856out_unlock:
3857 spin_unlock(&workqueue_lock);
3858}
3859#endif /* CONFIG_FREEZER */
3860
Suresh Siddha6ee05782010-07-30 14:57:37 -07003861static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003862{
Tejun Heoc34056a2010-06-29 10:07:11 +02003863 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003864 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02003865
Tejun Heob5490072012-08-03 10:30:46 -07003866 /* make sure we have enough bits for OFFQ CPU number */
3867 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3868 WORK_CPU_LAST);
3869
Tejun Heo65758202012-07-17 12:39:26 -07003870 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
3871 cpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003872
3873 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003874 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003875 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003876 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003877
3878 spin_lock_init(&gcwq->lock);
3879 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003880 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003881
Tejun Heoc8e55f32010-06-29 10:07:12 +02003882 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3883 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3884
Tejun Heo4ce62e92012-07-13 22:16:44 -07003885 for_each_worker_pool(pool, gcwq) {
3886 pool->gcwq = gcwq;
3887 INIT_LIST_HEAD(&pool->worklist);
3888 INIT_LIST_HEAD(&pool->idle_list);
Tejun Heoe22bee72010-06-29 10:07:14 +02003889
Tejun Heo4ce62e92012-07-13 22:16:44 -07003890 init_timer_deferrable(&pool->idle_timer);
3891 pool->idle_timer.function = idle_worker_timeout;
3892 pool->idle_timer.data = (unsigned long)pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003893
Tejun Heo4ce62e92012-07-13 22:16:44 -07003894 setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
3895 (unsigned long)pool);
3896
Tejun Heo60373152012-07-17 12:39:27 -07003897 mutex_init(&pool->manager_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003898 ida_init(&pool->worker_ida);
3899 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003900
Tejun Heo25511a42012-07-17 12:39:27 -07003901 init_waitqueue_head(&gcwq->rebind_hold);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003902 }
3903
Tejun Heoe22bee72010-06-29 10:07:14 +02003904 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003905 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003906 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003907 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003908
Tejun Heo477a3c32010-08-31 10:54:35 +02003909 if (cpu != WORK_CPU_UNBOUND)
3910 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003911
3912 for_each_worker_pool(pool, gcwq) {
3913 struct worker *worker;
3914
Tejun Heobc2ae0f2012-07-17 12:39:27 -07003915 worker = create_worker(pool);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003916 BUG_ON(!worker);
3917 spin_lock_irq(&gcwq->lock);
3918 start_worker(worker);
3919 spin_unlock_irq(&gcwq->lock);
3920 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003921 }
3922
Tejun Heod320c032010-06-29 10:07:14 +02003923 system_wq = alloc_workqueue("events", 0, 0);
3924 system_long_wq = alloc_workqueue("events_long", 0, 0);
3925 system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003926 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3927 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003928 system_freezable_wq = alloc_workqueue("events_freezable",
3929 WQ_FREEZABLE, 0);
Alan Stern62d3c542012-03-02 10:51:00 +01003930 system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
3931 WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
Hitoshi Mitakee5cba242010-11-26 12:06:44 +01003932 BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
Alan Stern62d3c542012-03-02 10:51:00 +01003933 !system_unbound_wq || !system_freezable_wq ||
3934 !system_nrt_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003935 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003936}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003937early_initcall(init_workqueues);