blob: 99ee9b9392643b7802040dea5f2744aa73ea1d27 [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;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001201 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001202
1203 /*
1204 * While a work item is PENDING && off queue, a task trying to
1205 * steal the PENDING will busy-loop waiting for it to either get
1206 * queued or lose PENDING. Grabbing PENDING and queueing should
1207 * happen with IRQ disabled.
1208 */
1209 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001211 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001212
Tejun Heoc8efcc22010-12-20 19:32:04 +01001213 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02001214 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001215 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001216 return;
1217
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001218 /* determine gcwq to use */
1219 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001220 struct global_cwq *last_gcwq;
1221
Tejun Heo57469822012-08-03 10:30:45 -07001222 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001223 cpu = raw_smp_processor_id();
1224
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001225 /*
1226 * It's multi cpu. If @wq is non-reentrant and @work
1227 * was previously on a different cpu, it might still
1228 * be running there, in which case the work needs to
1229 * be queued on that cpu to guarantee non-reentrance.
1230 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001231 gcwq = get_gcwq(cpu);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001232 if (wq->flags & WQ_NON_REENTRANT &&
1233 (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
1234 struct worker *worker;
1235
Tejun Heo8930cab2012-08-03 10:30:45 -07001236 spin_lock(&last_gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001237
1238 worker = find_worker_executing_work(last_gcwq, work);
1239
1240 if (worker && worker->current_cwq->wq == wq)
1241 gcwq = last_gcwq;
1242 else {
1243 /* meh... not running there, queue here */
Tejun Heo8930cab2012-08-03 10:30:45 -07001244 spin_unlock(&last_gcwq->lock);
1245 spin_lock(&gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001246 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001247 } else {
1248 spin_lock(&gcwq->lock);
1249 }
Tejun Heof3421792010-07-02 10:03:51 +02001250 } else {
1251 gcwq = get_gcwq(WORK_CPU_UNBOUND);
Tejun Heo8930cab2012-08-03 10:30:45 -07001252 spin_lock(&gcwq->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001253 }
1254
1255 /* gcwq determined, get cwq and queue */
1256 cwq = get_cwq(gcwq->cpu, wq);
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001257 trace_workqueue_queue_work(req_cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001258
Dan Carpenterf5b25522012-04-13 22:06:58 +03001259 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo8930cab2012-08-03 10:30:45 -07001260 spin_unlock(&gcwq->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001261 return;
1262 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001263
Tejun Heo73f53c42010-06-29 10:07:11 +02001264 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001265 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001266
1267 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001268 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001269 cwq->nr_active++;
Tejun Heo32704762012-07-13 22:16:45 -07001270 worklist = &cwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001271 } else {
1272 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001273 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001274 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001275
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001276 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001277
Tejun Heo8930cab2012-08-03 10:30:45 -07001278 spin_unlock(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279}
1280
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001281/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001282 * queue_work_on - queue work on specific cpu
1283 * @cpu: CPU number to execute work on
1284 * @wq: workqueue to use
1285 * @work: work to queue
1286 *
Tejun Heod4283e92012-08-03 10:30:44 -07001287 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001288 *
1289 * We queue the work to a specific CPU, the caller must ensure it
1290 * can't go away.
1291 */
Tejun Heod4283e92012-08-03 10:30:44 -07001292bool queue_work_on(int cpu, struct workqueue_struct *wq,
1293 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001294{
Tejun Heod4283e92012-08-03 10:30:44 -07001295 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001296 unsigned long flags;
1297
1298 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001299
Tejun Heo22df02b2010-06-29 10:07:10 +02001300 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001301 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001302 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001303 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001304
1305 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001306 return ret;
1307}
1308EXPORT_SYMBOL_GPL(queue_work_on);
1309
Tejun Heo0a13c002012-08-03 10:30:44 -07001310/**
1311 * queue_work - queue work on a workqueue
1312 * @wq: workqueue to use
1313 * @work: work to queue
1314 *
Tejun Heod4283e92012-08-03 10:30:44 -07001315 * Returns %false if @work was already on a queue, %true otherwise.
Tejun Heo0a13c002012-08-03 10:30:44 -07001316 *
1317 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1318 * it can be processed by another CPU.
1319 */
Tejun Heod4283e92012-08-03 10:30:44 -07001320bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07001321{
Tejun Heo57469822012-08-03 10:30:45 -07001322 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
Tejun Heo0a13c002012-08-03 10:30:44 -07001323}
1324EXPORT_SYMBOL_GPL(queue_work);
1325
Tejun Heod8e794d2012-08-03 10:30:45 -07001326void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327{
David Howells52bad642006-11-22 14:54:01 +00001328 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001329 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330
Tejun Heo8930cab2012-08-03 10:30:45 -07001331 local_irq_disable();
Tejun Heo12650572012-08-08 09:38:42 -07001332 __queue_work(dwork->cpu, cwq->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07001333 local_irq_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334}
Tejun Heod8e794d2012-08-03 10:30:45 -07001335EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001337static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1338 struct delayed_work *dwork, unsigned long delay)
1339{
1340 struct timer_list *timer = &dwork->timer;
1341 struct work_struct *work = &dwork->work;
1342 unsigned int lcpu;
1343
1344 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1345 timer->data != (unsigned long)dwork);
1346 BUG_ON(timer_pending(timer));
1347 BUG_ON(!list_empty(&work->entry));
1348
1349 timer_stats_timer_set_start_info(&dwork->timer);
1350
1351 /*
1352 * This stores cwq for the moment, for the timer_fn. Note that the
1353 * work's gcwq is preserved to allow reentrance detection for
1354 * delayed works.
1355 */
1356 if (!(wq->flags & WQ_UNBOUND)) {
1357 struct global_cwq *gcwq = get_work_gcwq(work);
1358
Joonsoo Kime42986d2012-08-15 23:25:38 +09001359 /*
1360 * If we cannot get the last gcwq from @work directly,
1361 * select the last CPU such that it avoids unnecessarily
1362 * triggering non-reentrancy check in __queue_work().
1363 */
1364 lcpu = cpu;
1365 if (gcwq)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001366 lcpu = gcwq->cpu;
Joonsoo Kime42986d2012-08-15 23:25:38 +09001367 if (lcpu == WORK_CPU_UNBOUND)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001368 lcpu = raw_smp_processor_id();
1369 } else {
1370 lcpu = WORK_CPU_UNBOUND;
1371 }
1372
1373 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1374
Tejun Heo12650572012-08-08 09:38:42 -07001375 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001376 timer->expires = jiffies + delay;
1377
1378 if (unlikely(cpu != WORK_CPU_UNBOUND))
1379 add_timer_on(timer, cpu);
1380 else
1381 add_timer(timer);
1382}
1383
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001384/**
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001385 * queue_delayed_work_on - queue work on specific CPU after delay
1386 * @cpu: CPU number to execute work on
1387 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001388 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001389 * @delay: number of jiffies to wait before queueing
1390 *
Tejun Heo715f1302012-08-03 10:30:46 -07001391 * Returns %false if @work was already on a queue, %true otherwise. If
1392 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1393 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001394 */
Tejun Heod4283e92012-08-03 10:30:44 -07001395bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1396 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001397{
David Howells52bad642006-11-22 14:54:01 +00001398 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001399 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001400 unsigned long flags;
1401
Tejun Heo715f1302012-08-03 10:30:46 -07001402 if (!delay)
1403 return queue_work_on(cpu, wq, &dwork->work);
1404
Tejun Heo8930cab2012-08-03 10:30:45 -07001405 /* read the comment in __queue_work() */
1406 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001407
Tejun Heo22df02b2010-06-29 10:07:10 +02001408 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001409 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001410 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001411 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001412
1413 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001414 return ret;
1415}
Dave Jonesae90dd52006-06-30 01:40:45 -04001416EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417
Tejun Heoc8e55f32010-06-29 10:07:12 +02001418/**
Tejun Heo0a13c002012-08-03 10:30:44 -07001419 * queue_delayed_work - queue work on a workqueue after delay
1420 * @wq: workqueue to use
1421 * @dwork: delayable work to queue
1422 * @delay: number of jiffies to wait before queueing
1423 *
Tejun Heo715f1302012-08-03 10:30:46 -07001424 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
Tejun Heo0a13c002012-08-03 10:30:44 -07001425 */
Tejun Heod4283e92012-08-03 10:30:44 -07001426bool queue_delayed_work(struct workqueue_struct *wq,
Tejun Heo0a13c002012-08-03 10:30:44 -07001427 struct delayed_work *dwork, unsigned long delay)
1428{
Tejun Heo57469822012-08-03 10:30:45 -07001429 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
Tejun Heo0a13c002012-08-03 10:30:44 -07001430}
1431EXPORT_SYMBOL_GPL(queue_delayed_work);
1432
1433/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001434 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1435 * @cpu: CPU number to execute work on
1436 * @wq: workqueue to use
1437 * @dwork: work to queue
1438 * @delay: number of jiffies to wait before queueing
1439 *
1440 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1441 * modify @dwork's timer so that it expires after @delay. If @delay is
1442 * zero, @work is guaranteed to be scheduled immediately regardless of its
1443 * current state.
1444 *
1445 * Returns %false if @dwork was idle and queued, %true if @dwork was
1446 * pending and its timer was modified.
1447 *
1448 * This function is safe to call from any context other than IRQ handler.
1449 * See try_to_grab_pending() for details.
1450 */
1451bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1452 struct delayed_work *dwork, unsigned long delay)
1453{
1454 unsigned long flags;
1455 int ret;
1456
1457 do {
1458 ret = try_to_grab_pending(&dwork->work, true, &flags);
1459 } while (unlikely(ret == -EAGAIN));
1460
1461 if (likely(ret >= 0)) {
1462 __queue_delayed_work(cpu, wq, dwork, delay);
1463 local_irq_restore(flags);
1464 }
1465
1466 /* -ENOENT from try_to_grab_pending() becomes %true */
1467 return ret;
1468}
1469EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1470
1471/**
1472 * mod_delayed_work - modify delay of or queue a delayed work
1473 * @wq: workqueue to use
1474 * @dwork: work to queue
1475 * @delay: number of jiffies to wait before queueing
1476 *
1477 * mod_delayed_work_on() on local CPU.
1478 */
1479bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1480 unsigned long delay)
1481{
1482 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1483}
1484EXPORT_SYMBOL_GPL(mod_delayed_work);
1485
1486/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001487 * worker_enter_idle - enter idle state
1488 * @worker: worker which is entering idle state
1489 *
1490 * @worker is entering idle state. Update stats and idle timer if
1491 * necessary.
1492 *
1493 * LOCKING:
1494 * spin_lock_irq(gcwq->lock).
1495 */
1496static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001498 struct worker_pool *pool = worker->pool;
1499 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500
Tejun Heoc8e55f32010-06-29 10:07:12 +02001501 BUG_ON(worker->flags & WORKER_IDLE);
1502 BUG_ON(!list_empty(&worker->entry) &&
1503 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504
Tejun Heocb444762010-07-02 10:03:50 +02001505 /* can't use worker_set_flags(), also called from start_worker() */
1506 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001507 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001508 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001509
Tejun Heoc8e55f32010-06-29 10:07:12 +02001510 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001511 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001512
Tejun Heo628c78e2012-07-17 12:39:27 -07001513 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1514 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001515
Tejun Heo544ecf32012-05-14 15:04:50 -07001516 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07001517 * Sanity check nr_running. Because gcwq_unbind_fn() releases
1518 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1519 * nr_running, the warning may trigger spuriously. Check iff
1520 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001521 */
Tejun Heo628c78e2012-07-17 12:39:27 -07001522 WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001523 pool->nr_workers == pool->nr_idle &&
Tejun Heo63d95a92012-07-12 14:46:37 -07001524 atomic_read(get_pool_nr_running(pool)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525}
1526
Tejun Heoc8e55f32010-06-29 10:07:12 +02001527/**
1528 * worker_leave_idle - leave idle state
1529 * @worker: worker which is leaving idle state
1530 *
1531 * @worker is leaving idle state. Update stats.
1532 *
1533 * LOCKING:
1534 * spin_lock_irq(gcwq->lock).
1535 */
1536static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001538 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539
Tejun Heoc8e55f32010-06-29 10:07:12 +02001540 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001541 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001542 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001543 list_del_init(&worker->entry);
1544}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545
Tejun Heoe22bee72010-06-29 10:07:14 +02001546/**
1547 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1548 * @worker: self
1549 *
1550 * Works which are scheduled while the cpu is online must at least be
1551 * scheduled to a worker which is bound to the cpu so that if they are
1552 * flushed from cpu callbacks while cpu is going down, they are
1553 * guaranteed to execute on the cpu.
1554 *
1555 * This function is to be used by rogue workers and rescuers to bind
1556 * themselves to the target cpu and may race with cpu going down or
1557 * coming online. kthread_bind() can't be used because it may put the
1558 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1559 * verbatim as it's best effort and blocking and gcwq may be
1560 * [dis]associated in the meantime.
1561 *
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001562 * This function tries set_cpus_allowed() and locks gcwq and verifies the
1563 * binding against %GCWQ_DISASSOCIATED which is set during
1564 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1565 * enters idle state or fetches works without dropping lock, it can
1566 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001567 *
1568 * CONTEXT:
1569 * Might sleep. Called without any lock but returns with gcwq->lock
1570 * held.
1571 *
1572 * RETURNS:
1573 * %true if the associated gcwq is online (@worker is successfully
1574 * bound), %false if offline.
1575 */
1576static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001577__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001578{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001579 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001580 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581
Tejun Heoe22bee72010-06-29 10:07:14 +02001582 while (true) {
1583 /*
1584 * The following call may fail, succeed or succeed
1585 * without actually migrating the task to the cpu if
1586 * it races with cpu hotunplug operation. Verify
1587 * against GCWQ_DISASSOCIATED.
1588 */
Tejun Heof3421792010-07-02 10:03:51 +02001589 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1590 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001591
Tejun Heoe22bee72010-06-29 10:07:14 +02001592 spin_lock_irq(&gcwq->lock);
1593 if (gcwq->flags & GCWQ_DISASSOCIATED)
1594 return false;
1595 if (task_cpu(task) == gcwq->cpu &&
1596 cpumask_equal(&current->cpus_allowed,
1597 get_cpu_mask(gcwq->cpu)))
1598 return true;
1599 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001600
Tejun Heo5035b202011-04-29 18:08:37 +02001601 /*
1602 * We've raced with CPU hot[un]plug. Give it a breather
1603 * and retry migration. cond_resched() is required here;
1604 * otherwise, we might deadlock against cpu_stop trying to
1605 * bring down the CPU on non-preemptive kernel.
1606 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001607 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001608 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001609 }
1610}
1611
Tejun Heo25511a42012-07-17 12:39:27 -07001612struct idle_rebind {
1613 int cnt; /* # workers to be rebound */
1614 struct completion done; /* all workers rebound */
1615};
1616
Tejun Heoe22bee72010-06-29 10:07:14 +02001617/*
Tejun Heo25511a42012-07-17 12:39:27 -07001618 * Rebind an idle @worker to its CPU. During CPU onlining, this has to
1619 * happen synchronously for idle workers. worker_thread() will test
1620 * %WORKER_REBIND before leaving idle and call this function.
1621 */
1622static void idle_worker_rebind(struct worker *worker)
1623{
1624 struct global_cwq *gcwq = worker->pool->gcwq;
1625
1626 /* CPU must be online at this point */
1627 WARN_ON(!worker_maybe_bind_and_lock(worker));
1628 if (!--worker->idle_rebind->cnt)
1629 complete(&worker->idle_rebind->done);
1630 spin_unlock_irq(&worker->pool->gcwq->lock);
1631
1632 /* we did our part, wait for rebind_workers() to finish up */
1633 wait_event(gcwq->rebind_hold, !(worker->flags & WORKER_REBIND));
1634}
1635
1636/*
1637 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001638 * the associated cpu which is coming back online. This is scheduled by
1639 * cpu up but can race with other cpu hotplug operations and may be
1640 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001641 */
Tejun Heo25511a42012-07-17 12:39:27 -07001642static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001643{
1644 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001645 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001646
1647 if (worker_maybe_bind_and_lock(worker))
1648 worker_clr_flags(worker, WORKER_REBIND);
1649
1650 spin_unlock_irq(&gcwq->lock);
1651}
1652
Tejun Heo25511a42012-07-17 12:39:27 -07001653/**
1654 * rebind_workers - rebind all workers of a gcwq to the associated CPU
1655 * @gcwq: gcwq of interest
1656 *
1657 * @gcwq->cpu is coming online. Rebind all workers to the CPU. Rebinding
1658 * is different for idle and busy ones.
1659 *
1660 * The idle ones should be rebound synchronously and idle rebinding should
1661 * be complete before any worker starts executing work items with
1662 * concurrency management enabled; otherwise, scheduler may oops trying to
1663 * wake up non-local idle worker from wq_worker_sleeping().
1664 *
1665 * This is achieved by repeatedly requesting rebinding until all idle
1666 * workers are known to have been rebound under @gcwq->lock and holding all
1667 * idle workers from becoming busy until idle rebinding is complete.
1668 *
1669 * Once idle workers are rebound, busy workers can be rebound as they
1670 * finish executing their current work items. Queueing the rebind work at
1671 * the head of their scheduled lists is enough. Note that nr_running will
1672 * be properbly bumped as busy workers rebind.
1673 *
1674 * On return, all workers are guaranteed to either be bound or have rebind
1675 * work item scheduled.
1676 */
1677static void rebind_workers(struct global_cwq *gcwq)
1678 __releases(&gcwq->lock) __acquires(&gcwq->lock)
1679{
1680 struct idle_rebind idle_rebind;
1681 struct worker_pool *pool;
1682 struct worker *worker;
1683 struct hlist_node *pos;
1684 int i;
1685
1686 lockdep_assert_held(&gcwq->lock);
1687
1688 for_each_worker_pool(pool, gcwq)
1689 lockdep_assert_held(&pool->manager_mutex);
1690
1691 /*
1692 * Rebind idle workers. Interlocked both ways. We wait for
1693 * workers to rebind via @idle_rebind.done. Workers will wait for
1694 * us to finish up by watching %WORKER_REBIND.
1695 */
1696 init_completion(&idle_rebind.done);
1697retry:
1698 idle_rebind.cnt = 1;
1699 INIT_COMPLETION(idle_rebind.done);
1700
1701 /* set REBIND and kick idle ones, we'll wait for these later */
1702 for_each_worker_pool(pool, gcwq) {
1703 list_for_each_entry(worker, &pool->idle_list, entry) {
1704 if (worker->flags & WORKER_REBIND)
1705 continue;
1706
1707 /* morph UNBOUND to REBIND */
1708 worker->flags &= ~WORKER_UNBOUND;
1709 worker->flags |= WORKER_REBIND;
1710
1711 idle_rebind.cnt++;
1712 worker->idle_rebind = &idle_rebind;
1713
1714 /* worker_thread() will call idle_worker_rebind() */
1715 wake_up_process(worker->task);
1716 }
1717 }
1718
1719 if (--idle_rebind.cnt) {
1720 spin_unlock_irq(&gcwq->lock);
1721 wait_for_completion(&idle_rebind.done);
1722 spin_lock_irq(&gcwq->lock);
1723 /* busy ones might have become idle while waiting, retry */
1724 goto retry;
1725 }
1726
1727 /*
1728 * All idle workers are rebound and waiting for %WORKER_REBIND to
1729 * be cleared inside idle_worker_rebind(). Clear and release.
1730 * Clearing %WORKER_REBIND from this foreign context is safe
1731 * because these workers are still guaranteed to be idle.
1732 */
1733 for_each_worker_pool(pool, gcwq)
1734 list_for_each_entry(worker, &pool->idle_list, entry)
1735 worker->flags &= ~WORKER_REBIND;
1736
1737 wake_up_all(&gcwq->rebind_hold);
1738
1739 /* rebind busy workers */
1740 for_each_busy_worker(worker, i, pos, gcwq) {
1741 struct work_struct *rebind_work = &worker->rebind_work;
1742
1743 /* morph UNBOUND to REBIND */
1744 worker->flags &= ~WORKER_UNBOUND;
1745 worker->flags |= WORKER_REBIND;
1746
1747 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1748 work_data_bits(rebind_work)))
1749 continue;
1750
1751 /* wq doesn't matter, use the default one */
1752 debug_work_activate(rebind_work);
1753 insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
1754 worker->scheduled.next,
1755 work_color_to_flags(WORK_NO_COLOR));
1756 }
1757}
1758
Tejun Heoc34056a2010-06-29 10:07:11 +02001759static struct worker *alloc_worker(void)
1760{
1761 struct worker *worker;
1762
1763 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001764 if (worker) {
1765 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001766 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001767 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001768 /* on creation a worker is in !idle && prep state */
1769 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001770 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001771 return worker;
1772}
1773
1774/**
1775 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001776 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001777 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001778 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001779 * can be started by calling start_worker() or destroyed using
1780 * destroy_worker().
1781 *
1782 * CONTEXT:
1783 * Might sleep. Does GFP_KERNEL allocations.
1784 *
1785 * RETURNS:
1786 * Pointer to the newly created worker.
1787 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001788static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001789{
Tejun Heo63d95a92012-07-12 14:46:37 -07001790 struct global_cwq *gcwq = pool->gcwq;
Tejun Heo32704762012-07-13 22:16:45 -07001791 const char *pri = worker_pool_pri(pool) ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001792 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001793 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001794
Tejun Heo8b03ae32010-06-29 10:07:12 +02001795 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001796 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001797 spin_unlock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001798 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001799 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001800 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001801 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001802 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001803
1804 worker = alloc_worker();
1805 if (!worker)
1806 goto fail;
1807
Tejun Heobd7bdd42012-07-12 14:46:37 -07001808 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001809 worker->id = id;
1810
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001811 if (gcwq->cpu != WORK_CPU_UNBOUND)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001812 worker->task = kthread_create_on_node(worker_thread,
Tejun Heo32704762012-07-13 22:16:45 -07001813 worker, cpu_to_node(gcwq->cpu),
1814 "kworker/%u:%d%s", gcwq->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001815 else
1816 worker->task = kthread_create(worker_thread, worker,
Tejun Heo32704762012-07-13 22:16:45 -07001817 "kworker/u:%d%s", id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001818 if (IS_ERR(worker->task))
1819 goto fail;
1820
Tejun Heo32704762012-07-13 22:16:45 -07001821 if (worker_pool_pri(pool))
1822 set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
1823
Tejun Heodb7bccf2010-06-29 10:07:12 +02001824 /*
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001825 * Determine CPU binding of the new worker depending on
1826 * %GCWQ_DISASSOCIATED. The caller is responsible for ensuring the
1827 * flag remains stable across this function. See the comments
1828 * above the flag definition for details.
1829 *
1830 * As an unbound worker may later become a regular one if CPU comes
1831 * online, make sure every worker has %PF_THREAD_BOUND set.
Tejun Heodb7bccf2010-06-29 10:07:12 +02001832 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001833 if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001834 kthread_bind(worker->task, gcwq->cpu);
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001835 } else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001836 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001837 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001839
Tejun Heoc34056a2010-06-29 10:07:11 +02001840 return worker;
1841fail:
1842 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001843 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001844 ida_remove(&pool->worker_ida, id);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001845 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001846 }
1847 kfree(worker);
1848 return NULL;
1849}
1850
1851/**
1852 * start_worker - start a newly created worker
1853 * @worker: worker to start
1854 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001855 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001856 *
1857 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001858 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001859 */
1860static void start_worker(struct worker *worker)
1861{
Tejun Heocb444762010-07-02 10:03:50 +02001862 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001863 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001864 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001865 wake_up_process(worker->task);
1866}
1867
1868/**
1869 * destroy_worker - destroy a workqueue worker
1870 * @worker: worker to be destroyed
1871 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001872 * Destroy @worker and adjust @gcwq stats accordingly.
1873 *
1874 * CONTEXT:
1875 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001876 */
1877static void destroy_worker(struct worker *worker)
1878{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001879 struct worker_pool *pool = worker->pool;
1880 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001881 int id = worker->id;
1882
1883 /* sanity check frenzy */
1884 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001885 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001886
Tejun Heoc8e55f32010-06-29 10:07:12 +02001887 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001888 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001889 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001890 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001891
1892 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001893 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001894
1895 spin_unlock_irq(&gcwq->lock);
1896
Tejun Heoc34056a2010-06-29 10:07:11 +02001897 kthread_stop(worker->task);
1898 kfree(worker);
1899
Tejun Heo8b03ae32010-06-29 10:07:12 +02001900 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001901 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001902}
1903
Tejun Heo63d95a92012-07-12 14:46:37 -07001904static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001905{
Tejun Heo63d95a92012-07-12 14:46:37 -07001906 struct worker_pool *pool = (void *)__pool;
1907 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001908
1909 spin_lock_irq(&gcwq->lock);
1910
Tejun Heo63d95a92012-07-12 14:46:37 -07001911 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001912 struct worker *worker;
1913 unsigned long expires;
1914
1915 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001916 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001917 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1918
1919 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001920 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001921 else {
1922 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001923 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001924 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001925 }
1926 }
1927
1928 spin_unlock_irq(&gcwq->lock);
1929}
1930
1931static bool send_mayday(struct work_struct *work)
1932{
1933 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1934 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001935 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001936
1937 if (!(wq->flags & WQ_RESCUER))
1938 return false;
1939
1940 /* mayday mayday mayday */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001941 cpu = cwq->pool->gcwq->cpu;
Tejun Heof3421792010-07-02 10:03:51 +02001942 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1943 if (cpu == WORK_CPU_UNBOUND)
1944 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001945 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001946 wake_up_process(wq->rescuer->task);
1947 return true;
1948}
1949
Tejun Heo63d95a92012-07-12 14:46:37 -07001950static void gcwq_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001951{
Tejun Heo63d95a92012-07-12 14:46:37 -07001952 struct worker_pool *pool = (void *)__pool;
1953 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001954 struct work_struct *work;
1955
1956 spin_lock_irq(&gcwq->lock);
1957
Tejun Heo63d95a92012-07-12 14:46:37 -07001958 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001959 /*
1960 * We've been trying to create a new worker but
1961 * haven't been successful. We might be hitting an
1962 * allocation deadlock. Send distress signals to
1963 * rescuers.
1964 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001965 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001966 send_mayday(work);
1967 }
1968
1969 spin_unlock_irq(&gcwq->lock);
1970
Tejun Heo63d95a92012-07-12 14:46:37 -07001971 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001972}
1973
1974/**
1975 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001976 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001977 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001978 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001979 * have at least one idle worker on return from this function. If
1980 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001981 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001982 * possible allocation deadlock.
1983 *
1984 * On return, need_to_create_worker() is guaranteed to be false and
1985 * may_start_working() true.
1986 *
1987 * LOCKING:
1988 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1989 * multiple times. Does GFP_KERNEL allocations. Called only from
1990 * manager.
1991 *
1992 * RETURNS:
1993 * false if no action was taken and gcwq->lock stayed locked, true
1994 * otherwise.
1995 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001996static bool maybe_create_worker(struct worker_pool *pool)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001997__releases(&gcwq->lock)
1998__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001999{
Tejun Heo63d95a92012-07-12 14:46:37 -07002000 struct global_cwq *gcwq = pool->gcwq;
2001
2002 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002003 return false;
2004restart:
Tejun Heo9f9c2362010-07-14 11:31:20 +02002005 spin_unlock_irq(&gcwq->lock);
2006
Tejun Heoe22bee72010-06-29 10:07:14 +02002007 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002008 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002009
2010 while (true) {
2011 struct worker *worker;
2012
Tejun Heobc2ae0f2012-07-17 12:39:27 -07002013 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002014 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002015 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002016 spin_lock_irq(&gcwq->lock);
2017 start_worker(worker);
Tejun Heo63d95a92012-07-12 14:46:37 -07002018 BUG_ON(need_to_create_worker(pool));
Tejun Heoe22bee72010-06-29 10:07:14 +02002019 return true;
2020 }
2021
Tejun Heo63d95a92012-07-12 14:46:37 -07002022 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002023 break;
2024
Tejun Heoe22bee72010-06-29 10:07:14 +02002025 __set_current_state(TASK_INTERRUPTIBLE);
2026 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02002027
Tejun Heo63d95a92012-07-12 14:46:37 -07002028 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002029 break;
2030 }
2031
Tejun Heo63d95a92012-07-12 14:46:37 -07002032 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002033 spin_lock_irq(&gcwq->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07002034 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002035 goto restart;
2036 return true;
2037}
2038
2039/**
2040 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07002041 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02002042 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002043 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02002044 * IDLE_WORKER_TIMEOUT.
2045 *
2046 * LOCKING:
2047 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2048 * multiple times. Called only from manager.
2049 *
2050 * RETURNS:
2051 * false if no action was taken and gcwq->lock stayed locked, true
2052 * otherwise.
2053 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002054static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02002055{
2056 bool ret = false;
2057
Tejun Heo63d95a92012-07-12 14:46:37 -07002058 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002059 struct worker *worker;
2060 unsigned long expires;
2061
Tejun Heo63d95a92012-07-12 14:46:37 -07002062 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002063 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2064
2065 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002066 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02002067 break;
2068 }
2069
2070 destroy_worker(worker);
2071 ret = true;
2072 }
2073
2074 return ret;
2075}
2076
2077/**
2078 * manage_workers - manage worker pool
2079 * @worker: self
2080 *
2081 * Assume the manager role and manage gcwq worker pool @worker belongs
2082 * to. At any given time, there can be only zero or one manager per
2083 * gcwq. The exclusion is handled automatically by this function.
2084 *
2085 * The caller can safely start processing works on false return. On
2086 * true return, it's guaranteed that need_to_create_worker() is false
2087 * and may_start_working() is true.
2088 *
2089 * CONTEXT:
2090 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2091 * multiple times. Does GFP_KERNEL allocations.
2092 *
2093 * RETURNS:
2094 * false if no action was taken and gcwq->lock stayed locked, true if
2095 * some action was taken.
2096 */
2097static bool manage_workers(struct worker *worker)
2098{
Tejun Heo63d95a92012-07-12 14:46:37 -07002099 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002100 bool ret = false;
2101
Tejun Heo60373152012-07-17 12:39:27 -07002102 if (!mutex_trylock(&pool->manager_mutex))
Tejun Heoe22bee72010-06-29 10:07:14 +02002103 return ret;
2104
Tejun Heo11ebea52012-07-12 14:46:37 -07002105 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002106
2107 /*
2108 * Destroy and then create so that may_start_working() is true
2109 * on return.
2110 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002111 ret |= maybe_destroy_workers(pool);
2112 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002113
Tejun Heo60373152012-07-17 12:39:27 -07002114 mutex_unlock(&pool->manager_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02002115 return ret;
2116}
2117
Tejun Heoa62428c2010-06-29 10:07:10 +02002118/**
2119 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002120 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002121 * @work: work to process
2122 *
2123 * Process @work. This function contains all the logics necessary to
2124 * process a single work including synchronization against and
2125 * interaction with other workers on the same cpu, queueing and
2126 * flushing. As long as context requirement is met, any worker can
2127 * call this function to process a work.
2128 *
2129 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002130 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002131 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002132static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09002133__releases(&gcwq->lock)
2134__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002135{
Tejun Heo7e116292010-06-29 10:07:13 +02002136 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002137 struct worker_pool *pool = worker->pool;
2138 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002139 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002140 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02002141 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02002142 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002143 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002144#ifdef CONFIG_LOCKDEP
2145 /*
2146 * It is permissible to free the struct work_struct from
2147 * inside the function that is called from it, this we need to
2148 * take into account for lockdep too. To avoid bogus "held
2149 * lock freed" warnings as well as problems when looking into
2150 * work->lockdep_map, make a copy and use that here.
2151 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002152 struct lockdep_map lockdep_map;
2153
2154 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002155#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002156 /*
2157 * Ensure we're on the correct CPU. DISASSOCIATED test is
2158 * necessary to avoid spurious warnings from rescuers servicing the
2159 * unbound or a disassociated gcwq.
2160 */
Tejun Heo25511a42012-07-17 12:39:27 -07002161 WARN_ON_ONCE(!(worker->flags & (WORKER_UNBOUND | WORKER_REBIND)) &&
Tejun Heo6fec10a2012-07-22 10:16:34 -07002162 !(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heo25511a42012-07-17 12:39:27 -07002163 raw_smp_processor_id() != gcwq->cpu);
2164
Tejun Heo7e116292010-06-29 10:07:13 +02002165 /*
2166 * A single work shouldn't be executed concurrently by
2167 * multiple workers on a single cpu. Check whether anyone is
2168 * already processing the work. If so, defer the work to the
2169 * currently executing one.
2170 */
2171 collision = __find_worker_executing_work(gcwq, bwh, work);
2172 if (unlikely(collision)) {
2173 move_linked_works(work, &collision->scheduled, NULL);
2174 return;
2175 }
2176
Tejun Heo8930cab2012-08-03 10:30:45 -07002177 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002178 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002179 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02002180 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002181 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002182 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002183
Tejun Heoa62428c2010-06-29 10:07:10 +02002184 list_del_init(&work->entry);
2185
Tejun Heo649027d2010-06-29 10:07:14 +02002186 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002187 * CPU intensive works don't participate in concurrency
2188 * management. They're the scheduler's responsibility.
2189 */
2190 if (unlikely(cpu_intensive))
2191 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2192
Tejun Heo974271c2012-07-12 14:46:37 -07002193 /*
2194 * Unbound gcwq isn't concurrency managed and work items should be
2195 * executed ASAP. Wake up another worker if necessary.
2196 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002197 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2198 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002199
Tejun Heo8930cab2012-08-03 10:30:45 -07002200 /*
Tejun Heo23657bb2012-08-13 17:08:19 -07002201 * Record the last CPU and clear PENDING which should be the last
2202 * update to @work. Also, do this inside @gcwq->lock so that
2203 * PENDING and queued state changes happen together while IRQ is
2204 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002205 */
Tejun Heo8930cab2012-08-03 10:30:45 -07002206 set_work_cpu_and_clear_pending(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02002207
Tejun Heo8930cab2012-08-03 10:30:45 -07002208 spin_unlock_irq(&gcwq->lock);
Tejun Heo959d1af2012-08-03 10:30:45 -07002209
Tejun Heoe1594892011-01-09 23:32:15 +01002210 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002211 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002212 trace_workqueue_execute_start(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002213 f(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002214 /*
2215 * While we must be careful to not use "work" after this, the trace
2216 * point will only record its address.
2217 */
2218 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002219 lock_map_release(&lockdep_map);
2220 lock_map_release(&cwq->wq->lockdep_map);
2221
2222 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2223 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
2224 "%s/0x%08x/%d\n",
2225 current->comm, preempt_count(), task_pid_nr(current));
2226 printk(KERN_ERR " last function: ");
2227 print_symbol("%s\n", (unsigned long)f);
2228 debug_show_held_locks(current);
2229 dump_stack();
2230 }
2231
Tejun Heo8b03ae32010-06-29 10:07:12 +02002232 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002233
Tejun Heofb0e7be2010-06-29 10:07:15 +02002234 /* clear cpu intensive status */
2235 if (unlikely(cpu_intensive))
2236 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2237
Tejun Heoa62428c2010-06-29 10:07:10 +02002238 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02002239 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002240 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002241 worker->current_cwq = NULL;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02002242 cwq_dec_nr_in_flight(cwq, work_color, false);
Tejun Heoa62428c2010-06-29 10:07:10 +02002243}
2244
Tejun Heoaffee4b2010-06-29 10:07:12 +02002245/**
2246 * process_scheduled_works - process scheduled works
2247 * @worker: self
2248 *
2249 * Process all scheduled works. Please note that the scheduled list
2250 * may change while processing a work, so this function repeatedly
2251 * fetches a work from the top and executes it.
2252 *
2253 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002254 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002255 * multiple times.
2256 */
2257static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002259 while (!list_empty(&worker->scheduled)) {
2260 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002262 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264}
2265
Tejun Heo4690c4a2010-06-29 10:07:10 +02002266/**
2267 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002268 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002269 *
Tejun Heoe22bee72010-06-29 10:07:14 +02002270 * The gcwq worker thread function. There's a single dynamic pool of
2271 * these per each cpu. These workers process all works regardless of
2272 * their specific target workqueue. The only exception is works which
2273 * belong to workqueues with a rescuer which will be explained in
2274 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002275 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002276static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277{
Tejun Heoc34056a2010-06-29 10:07:11 +02002278 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002279 struct worker_pool *pool = worker->pool;
2280 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281
Tejun Heoe22bee72010-06-29 10:07:14 +02002282 /* tell the scheduler that this is a workqueue worker */
2283 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002284woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002285 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286
Tejun Heo25511a42012-07-17 12:39:27 -07002287 /*
2288 * DIE can be set only while idle and REBIND set while busy has
2289 * @worker->rebind_work scheduled. Checking here is enough.
2290 */
2291 if (unlikely(worker->flags & (WORKER_REBIND | WORKER_DIE))) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002292 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002293
2294 if (worker->flags & WORKER_DIE) {
2295 worker->task->flags &= ~PF_WQ_WORKER;
2296 return 0;
2297 }
2298
2299 idle_worker_rebind(worker);
2300 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 }
2302
Tejun Heoc8e55f32010-06-29 10:07:12 +02002303 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002304recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002305 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002306 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002307 goto sleep;
2308
2309 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002310 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002311 goto recheck;
2312
Tejun Heoc8e55f32010-06-29 10:07:12 +02002313 /*
2314 * ->scheduled list can only be filled while a worker is
2315 * preparing to process a work or actually processing it.
2316 * Make sure nobody diddled with it while I was sleeping.
2317 */
2318 BUG_ON(!list_empty(&worker->scheduled));
2319
Tejun Heoe22bee72010-06-29 10:07:14 +02002320 /*
2321 * When control reaches this point, we're guaranteed to have
2322 * at least one idle worker or that someone else has already
2323 * assumed the manager role.
2324 */
2325 worker_clr_flags(worker, WORKER_PREP);
2326
2327 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002328 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002329 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002330 struct work_struct, entry);
2331
2332 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2333 /* optimization path, not strictly necessary */
2334 process_one_work(worker, work);
2335 if (unlikely(!list_empty(&worker->scheduled)))
2336 process_scheduled_works(worker);
2337 } else {
2338 move_linked_works(work, &worker->scheduled, NULL);
2339 process_scheduled_works(worker);
2340 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002341 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002342
Tejun Heoe22bee72010-06-29 10:07:14 +02002343 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002344sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002345 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002346 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002347
Tejun Heoc8e55f32010-06-29 10:07:12 +02002348 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02002349 * gcwq->lock is held and there's no work to process and no
2350 * need to manage, sleep. Workers are woken up only while
2351 * holding gcwq->lock or from local cpu, so setting the
2352 * current state before releasing gcwq->lock is enough to
2353 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002354 */
2355 worker_enter_idle(worker);
2356 __set_current_state(TASK_INTERRUPTIBLE);
2357 spin_unlock_irq(&gcwq->lock);
2358 schedule();
2359 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360}
2361
Tejun Heoe22bee72010-06-29 10:07:14 +02002362/**
2363 * rescuer_thread - the rescuer thread function
2364 * @__wq: the associated workqueue
2365 *
2366 * Workqueue rescuer thread function. There's one rescuer for each
2367 * workqueue which has WQ_RESCUER set.
2368 *
2369 * Regular work processing on a gcwq may block trying to create a new
2370 * worker which uses GFP_KERNEL allocation which has slight chance of
2371 * developing into deadlock if some works currently on the same queue
2372 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2373 * the problem rescuer solves.
2374 *
2375 * When such condition is possible, the gcwq summons rescuers of all
2376 * workqueues which have works queued on the gcwq and let them process
2377 * those works so that forward progress can be guaranteed.
2378 *
2379 * This should happen rarely.
2380 */
2381static int rescuer_thread(void *__wq)
2382{
2383 struct workqueue_struct *wq = __wq;
2384 struct worker *rescuer = wq->rescuer;
2385 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002386 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002387 unsigned int cpu;
2388
2389 set_user_nice(current, RESCUER_NICE_LEVEL);
2390repeat:
2391 set_current_state(TASK_INTERRUPTIBLE);
2392
2393 if (kthread_should_stop())
2394 return 0;
2395
Tejun Heof3421792010-07-02 10:03:51 +02002396 /*
2397 * See whether any cpu is asking for help. Unbounded
2398 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2399 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002400 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002401 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2402 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002403 struct worker_pool *pool = cwq->pool;
2404 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002405 struct work_struct *work, *n;
2406
2407 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002408 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002409
2410 /* migrate to the target cpu if possible */
Tejun Heobd7bdd42012-07-12 14:46:37 -07002411 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002412 worker_maybe_bind_and_lock(rescuer);
2413
2414 /*
2415 * Slurp in all works issued via this workqueue and
2416 * process'em.
2417 */
2418 BUG_ON(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002419 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002420 if (get_work_cwq(work) == cwq)
2421 move_linked_works(work, scheduled, &n);
2422
2423 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002424
2425 /*
2426 * Leave this gcwq. If keep_working() is %true, notify a
2427 * regular worker; otherwise, we end up with 0 concurrency
2428 * and stalling the execution.
2429 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002430 if (keep_working(pool))
2431 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002432
Tejun Heoe22bee72010-06-29 10:07:14 +02002433 spin_unlock_irq(&gcwq->lock);
2434 }
2435
2436 schedule();
2437 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438}
2439
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002440struct wq_barrier {
2441 struct work_struct work;
2442 struct completion done;
2443};
2444
2445static void wq_barrier_func(struct work_struct *work)
2446{
2447 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2448 complete(&barr->done);
2449}
2450
Tejun Heo4690c4a2010-06-29 10:07:10 +02002451/**
2452 * insert_wq_barrier - insert a barrier work
2453 * @cwq: cwq to insert barrier into
2454 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002455 * @target: target work to attach @barr to
2456 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002457 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002458 * @barr is linked to @target such that @barr is completed only after
2459 * @target finishes execution. Please note that the ordering
2460 * guarantee is observed only with respect to @target and on the local
2461 * cpu.
2462 *
2463 * Currently, a queued barrier can't be canceled. This is because
2464 * try_to_grab_pending() can't determine whether the work to be
2465 * grabbed is at the head of the queue and thus can't clear LINKED
2466 * flag of the previous work while there must be a valid next work
2467 * after a work with LINKED flag set.
2468 *
2469 * Note that when @worker is non-NULL, @target may be modified
2470 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002471 *
2472 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002473 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002474 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002475static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002476 struct wq_barrier *barr,
2477 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002478{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002479 struct list_head *head;
2480 unsigned int linked = 0;
2481
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002482 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002483 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002484 * as we know for sure that this will not trigger any of the
2485 * checks and call back into the fixup functions where we
2486 * might deadlock.
2487 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002488 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002489 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002490 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002491
Tejun Heoaffee4b2010-06-29 10:07:12 +02002492 /*
2493 * If @target is currently being executed, schedule the
2494 * barrier to the worker; otherwise, put it after @target.
2495 */
2496 if (worker)
2497 head = worker->scheduled.next;
2498 else {
2499 unsigned long *bits = work_data_bits(target);
2500
2501 head = target->entry.next;
2502 /* there can already be other linked works, inherit and set */
2503 linked = *bits & WORK_STRUCT_LINKED;
2504 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2505 }
2506
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002507 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002508 insert_work(cwq, &barr->work, head,
2509 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002510}
2511
Tejun Heo73f53c42010-06-29 10:07:11 +02002512/**
2513 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2514 * @wq: workqueue being flushed
2515 * @flush_color: new flush color, < 0 for no-op
2516 * @work_color: new work color, < 0 for no-op
2517 *
2518 * Prepare cwqs for workqueue flushing.
2519 *
2520 * If @flush_color is non-negative, flush_color on all cwqs should be
2521 * -1. If no cwq has in-flight commands at the specified color, all
2522 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2523 * has in flight commands, its cwq->flush_color is set to
2524 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2525 * wakeup logic is armed and %true is returned.
2526 *
2527 * The caller should have initialized @wq->first_flusher prior to
2528 * calling this function with non-negative @flush_color. If
2529 * @flush_color is negative, no flush color update is done and %false
2530 * is returned.
2531 *
2532 * If @work_color is non-negative, all cwqs should have the same
2533 * work_color which is previous to @work_color and all will be
2534 * advanced to @work_color.
2535 *
2536 * CONTEXT:
2537 * mutex_lock(wq->flush_mutex).
2538 *
2539 * RETURNS:
2540 * %true if @flush_color >= 0 and there's something to flush. %false
2541 * otherwise.
2542 */
2543static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2544 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545{
Tejun Heo73f53c42010-06-29 10:07:11 +02002546 bool wait = false;
2547 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002548
Tejun Heo73f53c42010-06-29 10:07:11 +02002549 if (flush_color >= 0) {
2550 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2551 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002552 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002553
Tejun Heof3421792010-07-02 10:03:51 +02002554 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002555 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002556 struct global_cwq *gcwq = cwq->pool->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002557
Tejun Heo8b03ae32010-06-29 10:07:12 +02002558 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002559
2560 if (flush_color >= 0) {
2561 BUG_ON(cwq->flush_color != -1);
2562
2563 if (cwq->nr_in_flight[flush_color]) {
2564 cwq->flush_color = flush_color;
2565 atomic_inc(&wq->nr_cwqs_to_flush);
2566 wait = true;
2567 }
2568 }
2569
2570 if (work_color >= 0) {
2571 BUG_ON(work_color != work_next_color(cwq->work_color));
2572 cwq->work_color = work_color;
2573 }
2574
Tejun Heo8b03ae32010-06-29 10:07:12 +02002575 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002576 }
2577
2578 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2579 complete(&wq->first_flusher->done);
2580
2581 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582}
2583
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002584/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002585 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002586 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002587 *
2588 * Forces execution of the workqueue and blocks until its completion.
2589 * This is typically used in driver shutdown handlers.
2590 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002591 * We sleep until all works which were queued on entry have been handled,
2592 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002594void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595{
Tejun Heo73f53c42010-06-29 10:07:11 +02002596 struct wq_flusher this_flusher = {
2597 .list = LIST_HEAD_INIT(this_flusher.list),
2598 .flush_color = -1,
2599 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2600 };
2601 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002602
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002603 lock_map_acquire(&wq->lockdep_map);
2604 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002605
2606 mutex_lock(&wq->flush_mutex);
2607
2608 /*
2609 * Start-to-wait phase
2610 */
2611 next_color = work_next_color(wq->work_color);
2612
2613 if (next_color != wq->flush_color) {
2614 /*
2615 * Color space is not full. The current work_color
2616 * becomes our flush_color and work_color is advanced
2617 * by one.
2618 */
2619 BUG_ON(!list_empty(&wq->flusher_overflow));
2620 this_flusher.flush_color = wq->work_color;
2621 wq->work_color = next_color;
2622
2623 if (!wq->first_flusher) {
2624 /* no flush in progress, become the first flusher */
2625 BUG_ON(wq->flush_color != this_flusher.flush_color);
2626
2627 wq->first_flusher = &this_flusher;
2628
2629 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2630 wq->work_color)) {
2631 /* nothing to flush, done */
2632 wq->flush_color = next_color;
2633 wq->first_flusher = NULL;
2634 goto out_unlock;
2635 }
2636 } else {
2637 /* wait in queue */
2638 BUG_ON(wq->flush_color == this_flusher.flush_color);
2639 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2640 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2641 }
2642 } else {
2643 /*
2644 * Oops, color space is full, wait on overflow queue.
2645 * The next flush completion will assign us
2646 * flush_color and transfer to flusher_queue.
2647 */
2648 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2649 }
2650
2651 mutex_unlock(&wq->flush_mutex);
2652
2653 wait_for_completion(&this_flusher.done);
2654
2655 /*
2656 * Wake-up-and-cascade phase
2657 *
2658 * First flushers are responsible for cascading flushes and
2659 * handling overflow. Non-first flushers can simply return.
2660 */
2661 if (wq->first_flusher != &this_flusher)
2662 return;
2663
2664 mutex_lock(&wq->flush_mutex);
2665
Tejun Heo4ce48b32010-07-02 10:03:51 +02002666 /* we might have raced, check again with mutex held */
2667 if (wq->first_flusher != &this_flusher)
2668 goto out_unlock;
2669
Tejun Heo73f53c42010-06-29 10:07:11 +02002670 wq->first_flusher = NULL;
2671
2672 BUG_ON(!list_empty(&this_flusher.list));
2673 BUG_ON(wq->flush_color != this_flusher.flush_color);
2674
2675 while (true) {
2676 struct wq_flusher *next, *tmp;
2677
2678 /* complete all the flushers sharing the current flush color */
2679 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2680 if (next->flush_color != wq->flush_color)
2681 break;
2682 list_del_init(&next->list);
2683 complete(&next->done);
2684 }
2685
2686 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2687 wq->flush_color != work_next_color(wq->work_color));
2688
2689 /* this flush_color is finished, advance by one */
2690 wq->flush_color = work_next_color(wq->flush_color);
2691
2692 /* one color has been freed, handle overflow queue */
2693 if (!list_empty(&wq->flusher_overflow)) {
2694 /*
2695 * Assign the same color to all overflowed
2696 * flushers, advance work_color and append to
2697 * flusher_queue. This is the start-to-wait
2698 * phase for these overflowed flushers.
2699 */
2700 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2701 tmp->flush_color = wq->work_color;
2702
2703 wq->work_color = work_next_color(wq->work_color);
2704
2705 list_splice_tail_init(&wq->flusher_overflow,
2706 &wq->flusher_queue);
2707 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2708 }
2709
2710 if (list_empty(&wq->flusher_queue)) {
2711 BUG_ON(wq->flush_color != wq->work_color);
2712 break;
2713 }
2714
2715 /*
2716 * Need to flush more colors. Make the next flusher
2717 * the new first flusher and arm cwqs.
2718 */
2719 BUG_ON(wq->flush_color == wq->work_color);
2720 BUG_ON(wq->flush_color != next->flush_color);
2721
2722 list_del_init(&next->list);
2723 wq->first_flusher = next;
2724
2725 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2726 break;
2727
2728 /*
2729 * Meh... this color is already done, clear first
2730 * flusher and repeat cascading.
2731 */
2732 wq->first_flusher = NULL;
2733 }
2734
2735out_unlock:
2736 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002737}
Dave Jonesae90dd52006-06-30 01:40:45 -04002738EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002739
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002740/**
2741 * drain_workqueue - drain a workqueue
2742 * @wq: workqueue to drain
2743 *
2744 * Wait until the workqueue becomes empty. While draining is in progress,
2745 * only chain queueing is allowed. IOW, only currently pending or running
2746 * work items on @wq can queue further work items on it. @wq is flushed
2747 * repeatedly until it becomes empty. The number of flushing is detemined
2748 * by the depth of chaining and should be relatively short. Whine if it
2749 * takes too long.
2750 */
2751void drain_workqueue(struct workqueue_struct *wq)
2752{
2753 unsigned int flush_cnt = 0;
2754 unsigned int cpu;
2755
2756 /*
2757 * __queue_work() needs to test whether there are drainers, is much
2758 * hotter than drain_workqueue() and already looks at @wq->flags.
2759 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2760 */
2761 spin_lock(&workqueue_lock);
2762 if (!wq->nr_drainers++)
2763 wq->flags |= WQ_DRAINING;
2764 spin_unlock(&workqueue_lock);
2765reflush:
2766 flush_workqueue(wq);
2767
2768 for_each_cwq_cpu(cpu, wq) {
2769 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002770 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002771
Tejun Heobd7bdd42012-07-12 14:46:37 -07002772 spin_lock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002773 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002774 spin_unlock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002775
2776 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002777 continue;
2778
2779 if (++flush_cnt == 10 ||
2780 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2781 pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
2782 wq->name, flush_cnt);
2783 goto reflush;
2784 }
2785
2786 spin_lock(&workqueue_lock);
2787 if (!--wq->nr_drainers)
2788 wq->flags &= ~WQ_DRAINING;
2789 spin_unlock(&workqueue_lock);
2790}
2791EXPORT_SYMBOL_GPL(drain_workqueue);
2792
Tejun Heobaf59022010-09-16 10:42:16 +02002793static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2794 bool wait_executing)
2795{
2796 struct worker *worker = NULL;
2797 struct global_cwq *gcwq;
2798 struct cpu_workqueue_struct *cwq;
2799
2800 might_sleep();
2801 gcwq = get_work_gcwq(work);
2802 if (!gcwq)
2803 return false;
2804
2805 spin_lock_irq(&gcwq->lock);
2806 if (!list_empty(&work->entry)) {
2807 /*
2808 * See the comment near try_to_grab_pending()->smp_rmb().
2809 * If it was re-queued to a different gcwq under us, we
2810 * are not going to wait.
2811 */
2812 smp_rmb();
2813 cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002814 if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
Tejun Heobaf59022010-09-16 10:42:16 +02002815 goto already_gone;
2816 } else if (wait_executing) {
2817 worker = find_worker_executing_work(gcwq, work);
2818 if (!worker)
2819 goto already_gone;
2820 cwq = worker->current_cwq;
2821 } else
2822 goto already_gone;
2823
2824 insert_wq_barrier(cwq, barr, work, worker);
2825 spin_unlock_irq(&gcwq->lock);
2826
Tejun Heoe1594892011-01-09 23:32:15 +01002827 /*
2828 * If @max_active is 1 or rescuer is in use, flushing another work
2829 * item on the same workqueue may lead to deadlock. Make sure the
2830 * flusher is not running on the same workqueue by verifying write
2831 * access.
2832 */
2833 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2834 lock_map_acquire(&cwq->wq->lockdep_map);
2835 else
2836 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002837 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002838
Tejun Heobaf59022010-09-16 10:42:16 +02002839 return true;
2840already_gone:
2841 spin_unlock_irq(&gcwq->lock);
2842 return false;
2843}
2844
Oleg Nesterovdb700892008-07-25 01:47:49 -07002845/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002846 * flush_work - wait for a work to finish executing the last queueing instance
2847 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002848 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002849 * Wait until @work has finished execution. This function considers
2850 * only the last queueing instance of @work. If @work has been
2851 * enqueued across different CPUs on a non-reentrant workqueue or on
2852 * multiple workqueues, @work might still be executing on return on
2853 * some of the CPUs from earlier queueing.
Oleg Nesterova67da702008-07-25 01:47:52 -07002854 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002855 * If @work was queued only on a non-reentrant, ordered or unbound
2856 * workqueue, @work is guaranteed to be idle on return if it hasn't
2857 * been requeued since flush started.
2858 *
2859 * RETURNS:
2860 * %true if flush_work() waited for the work to finish execution,
2861 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002862 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002863bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002864{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002865 struct wq_barrier barr;
2866
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002867 lock_map_acquire(&work->lockdep_map);
2868 lock_map_release(&work->lockdep_map);
2869
Tejun Heobaf59022010-09-16 10:42:16 +02002870 if (start_flush_work(work, &barr, true)) {
2871 wait_for_completion(&barr.done);
2872 destroy_work_on_stack(&barr.work);
2873 return true;
2874 } else
2875 return false;
Oleg Nesterovdb700892008-07-25 01:47:49 -07002876}
2877EXPORT_SYMBOL_GPL(flush_work);
2878
Tejun Heo401a8d02010-09-16 10:36:00 +02002879static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2880{
2881 struct wq_barrier barr;
2882 struct worker *worker;
2883
2884 spin_lock_irq(&gcwq->lock);
2885
2886 worker = find_worker_executing_work(gcwq, work);
2887 if (unlikely(worker))
2888 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2889
2890 spin_unlock_irq(&gcwq->lock);
2891
2892 if (unlikely(worker)) {
2893 wait_for_completion(&barr.done);
2894 destroy_work_on_stack(&barr.work);
2895 return true;
2896 } else
2897 return false;
2898}
2899
2900static bool wait_on_work(struct work_struct *work)
2901{
2902 bool ret = false;
2903 int cpu;
2904
2905 might_sleep();
2906
2907 lock_map_acquire(&work->lockdep_map);
2908 lock_map_release(&work->lockdep_map);
2909
2910 for_each_gcwq_cpu(cpu)
2911 ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2912 return ret;
2913}
2914
Tejun Heo09383492010-09-16 10:48:29 +02002915/**
2916 * flush_work_sync - wait until a work has finished execution
2917 * @work: the work to flush
2918 *
2919 * Wait until @work has finished execution. On return, it's
2920 * guaranteed that all queueing instances of @work which happened
2921 * before this function is called are finished. In other words, if
2922 * @work hasn't been requeued since this function was called, @work is
2923 * guaranteed to be idle on return.
2924 *
2925 * RETURNS:
2926 * %true if flush_work_sync() waited for the work to finish execution,
2927 * %false if it was already idle.
2928 */
2929bool flush_work_sync(struct work_struct *work)
2930{
2931 struct wq_barrier barr;
2932 bool pending, waited;
2933
2934 /* we'll wait for executions separately, queue barr only if pending */
2935 pending = start_flush_work(work, &barr, false);
2936
2937 /* wait for executions to finish */
2938 waited = wait_on_work(work);
2939
2940 /* wait for the pending one */
2941 if (pending) {
2942 wait_for_completion(&barr.done);
2943 destroy_work_on_stack(&barr.work);
2944 }
2945
2946 return pending || waited;
2947}
2948EXPORT_SYMBOL_GPL(flush_work_sync);
2949
Tejun Heo36e227d2012-08-03 10:30:46 -07002950static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002951{
Tejun Heobbb68df2012-08-03 10:30:46 -07002952 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002953 int ret;
2954
2955 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002956 ret = try_to_grab_pending(work, is_dwork, &flags);
2957 /*
2958 * If someone else is canceling, wait for the same event it
2959 * would be waiting for before retrying.
2960 */
2961 if (unlikely(ret == -ENOENT))
2962 wait_on_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002963 } while (unlikely(ret < 0));
2964
Tejun Heobbb68df2012-08-03 10:30:46 -07002965 /* tell other tasks trying to grab @work to back off */
2966 mark_work_canceling(work);
2967 local_irq_restore(flags);
2968
2969 wait_on_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002970 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002971 return ret;
2972}
2973
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002974/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002975 * cancel_work_sync - cancel a work and wait for it to finish
2976 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002977 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002978 * Cancel @work and wait for its execution to finish. This function
2979 * can be used even if the work re-queues itself or migrates to
2980 * another workqueue. On return from this function, @work is
2981 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002982 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002983 * cancel_work_sync(&delayed_work->work) must not be used for
2984 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002985 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002986 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002987 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002988 *
2989 * RETURNS:
2990 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002991 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002992bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002993{
Tejun Heo36e227d2012-08-03 10:30:46 -07002994 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002995}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002996EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002997
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002998/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002999 * flush_delayed_work - wait for a dwork to finish executing the last queueing
3000 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003001 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003002 * Delayed timer is cancelled and the pending work is queued for
3003 * immediate execution. Like flush_work(), this function only
3004 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07003005 *
Tejun Heo401a8d02010-09-16 10:36:00 +02003006 * RETURNS:
3007 * %true if flush_work() waited for the work to finish execution,
3008 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003009 */
Tejun Heo401a8d02010-09-16 10:36:00 +02003010bool flush_delayed_work(struct delayed_work *dwork)
3011{
Tejun Heo8930cab2012-08-03 10:30:45 -07003012 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003013 if (del_timer_sync(&dwork->timer))
Tejun Heo12650572012-08-08 09:38:42 -07003014 __queue_work(dwork->cpu,
Tejun Heo401a8d02010-09-16 10:36:00 +02003015 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003016 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02003017 return flush_work(&dwork->work);
3018}
3019EXPORT_SYMBOL(flush_delayed_work);
3020
3021/**
Tejun Heo09383492010-09-16 10:48:29 +02003022 * flush_delayed_work_sync - wait for a dwork to finish
3023 * @dwork: the delayed work to flush
3024 *
3025 * Delayed timer is cancelled and the pending work is queued for
3026 * execution immediately. Other than timer handling, its behavior
3027 * is identical to flush_work_sync().
3028 *
3029 * RETURNS:
3030 * %true if flush_work_sync() waited for the work to finish execution,
3031 * %false if it was already idle.
3032 */
3033bool flush_delayed_work_sync(struct delayed_work *dwork)
3034{
Tejun Heo8930cab2012-08-03 10:30:45 -07003035 local_irq_disable();
Tejun Heo09383492010-09-16 10:48:29 +02003036 if (del_timer_sync(&dwork->timer))
Tejun Heo12650572012-08-08 09:38:42 -07003037 __queue_work(dwork->cpu,
Tejun Heo09383492010-09-16 10:48:29 +02003038 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07003039 local_irq_enable();
Tejun Heo09383492010-09-16 10:48:29 +02003040 return flush_work_sync(&dwork->work);
3041}
3042EXPORT_SYMBOL(flush_delayed_work_sync);
3043
3044/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003045 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3046 * @dwork: the delayed work cancel
3047 *
3048 * This is cancel_work_sync() for delayed works.
3049 *
3050 * RETURNS:
3051 * %true if @dwork was pending, %false otherwise.
3052 */
3053bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003054{
Tejun Heo36e227d2012-08-03 10:30:46 -07003055 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003056}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003057EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003058
Tejun Heod4283e92012-08-03 10:30:44 -07003059/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003060 * schedule_work_on - put work task on a specific cpu
3061 * @cpu: cpu to put the work task on
3062 * @work: job to be done
3063 *
3064 * This puts a job on a specific cpu
3065 */
Tejun Heod4283e92012-08-03 10:30:44 -07003066bool schedule_work_on(int cpu, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07003067{
3068 return queue_work_on(cpu, system_wq, work);
3069}
3070EXPORT_SYMBOL(schedule_work_on);
3071
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003072/**
3073 * schedule_work - put work task in global workqueue
3074 * @work: job to be done
3075 *
Tejun Heod4283e92012-08-03 10:30:44 -07003076 * Returns %false if @work was already on the kernel-global workqueue and
3077 * %true otherwise.
Bart Van Assche5b0f437d2009-07-30 19:00:53 +02003078 *
3079 * This puts a job in the kernel-global workqueue if it was not already
3080 * queued and leaves it in the same position on the kernel-global
3081 * workqueue otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003082 */
Tejun Heod4283e92012-08-03 10:30:44 -07003083bool schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003084{
Tejun Heod320c032010-06-29 10:07:14 +02003085 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003086}
Dave Jonesae90dd52006-06-30 01:40:45 -04003087EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003088
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003089/**
3090 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
3091 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +00003092 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003093 * @delay: number of jiffies to wait
3094 *
3095 * After waiting for a given time this puts a job in the kernel-global
3096 * workqueue on the specified CPU.
3097 */
Tejun Heod4283e92012-08-03 10:30:44 -07003098bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3099 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003100{
Tejun Heod320c032010-06-29 10:07:14 +02003101 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003102}
Dave Jonesae90dd52006-06-30 01:40:45 -04003103EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003104
Andrew Mortonb6136772006-06-25 05:47:49 -07003105/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003106 * schedule_delayed_work - put work task in global workqueue after delay
3107 * @dwork: job to be done
3108 * @delay: number of jiffies to wait or 0 for immediate execution
3109 *
3110 * After waiting for a given time this puts a job in the kernel-global
3111 * workqueue.
3112 */
Tejun Heod4283e92012-08-03 10:30:44 -07003113bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
Tejun Heo0a13c002012-08-03 10:30:44 -07003114{
3115 return queue_delayed_work(system_wq, dwork, delay);
3116}
3117EXPORT_SYMBOL(schedule_delayed_work);
3118
3119/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003120 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003121 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003122 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003123 * schedule_on_each_cpu() executes @func on each online CPU using the
3124 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003125 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003126 *
3127 * RETURNS:
3128 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003129 */
David Howells65f27f32006-11-22 14:55:48 +00003130int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003131{
3132 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003133 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003134
Andrew Mortonb6136772006-06-25 05:47:49 -07003135 works = alloc_percpu(struct work_struct);
3136 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003137 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003138
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003139 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003140
Christoph Lameter15316ba2006-01-08 01:00:43 -08003141 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003142 struct work_struct *work = per_cpu_ptr(works, cpu);
3143
3144 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003145 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003146 }
Tejun Heo93981802009-11-17 14:06:20 -08003147
3148 for_each_online_cpu(cpu)
3149 flush_work(per_cpu_ptr(works, cpu));
3150
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003151 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003152 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003153 return 0;
3154}
3155
Alan Sterneef6a7d2010-02-12 17:39:21 +09003156/**
3157 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3158 *
3159 * Forces execution of the kernel-global workqueue and blocks until its
3160 * completion.
3161 *
3162 * Think twice before calling this function! It's very easy to get into
3163 * trouble if you don't take great care. Either of the following situations
3164 * will lead to deadlock:
3165 *
3166 * One of the work items currently on the workqueue needs to acquire
3167 * a lock held by your code or its caller.
3168 *
3169 * Your code is running in the context of a work routine.
3170 *
3171 * They will be detected by lockdep when they occur, but the first might not
3172 * occur very often. It depends on what work items are on the workqueue and
3173 * what locks they need, which you have no control over.
3174 *
3175 * In most situations flushing the entire workqueue is overkill; you merely
3176 * need to know that a particular work item isn't queued and isn't running.
3177 * In such cases you should use cancel_delayed_work_sync() or
3178 * cancel_work_sync() instead.
3179 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003180void flush_scheduled_work(void)
3181{
Tejun Heod320c032010-06-29 10:07:14 +02003182 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003183}
Dave Jonesae90dd52006-06-30 01:40:45 -04003184EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003185
3186/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003187 * execute_in_process_context - reliably execute the routine with user context
3188 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003189 * @ew: guaranteed storage for the execute work structure (must
3190 * be available when the work executes)
3191 *
3192 * Executes the function immediately if process context is available,
3193 * otherwise schedules the function for delayed execution.
3194 *
3195 * Returns: 0 - function was executed
3196 * 1 - function was scheduled for execution
3197 */
David Howells65f27f32006-11-22 14:55:48 +00003198int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003199{
3200 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003201 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003202 return 0;
3203 }
3204
David Howells65f27f32006-11-22 14:55:48 +00003205 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003206 schedule_work(&ew->work);
3207
3208 return 1;
3209}
3210EXPORT_SYMBOL_GPL(execute_in_process_context);
3211
Linus Torvalds1da177e2005-04-16 15:20:36 -07003212int keventd_up(void)
3213{
Tejun Heod320c032010-06-29 10:07:14 +02003214 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215}
3216
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003217static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003218{
Oleg Nesterov3af244332007-05-09 02:34:09 -07003219 /*
Tejun Heo0f900042010-06-29 10:07:11 +02003220 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
3221 * Make sure that the alignment isn't lower than that of
3222 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07003223 */
Tejun Heo0f900042010-06-29 10:07:11 +02003224 const size_t size = sizeof(struct cpu_workqueue_struct);
3225 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
3226 __alignof__(unsigned long long));
Oleg Nesterov3af244332007-05-09 02:34:09 -07003227
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003228 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003229 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02003230 else {
Tejun Heof3421792010-07-02 10:03:51 +02003231 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003232
Tejun Heof3421792010-07-02 10:03:51 +02003233 /*
3234 * Allocate enough room to align cwq and put an extra
3235 * pointer at the end pointing back to the originally
3236 * allocated pointer which will be used for free.
3237 */
3238 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3239 if (ptr) {
3240 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3241 *(void **)(wq->cpu_wq.single + 1) = ptr;
3242 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003243 }
Tejun Heof3421792010-07-02 10:03:51 +02003244
Tejun Heo0415b00d12011-03-24 18:50:09 +01003245 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003246 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3247 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003248}
3249
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003250static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003251{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003252 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003253 free_percpu(wq->cpu_wq.pcpu);
3254 else if (wq->cpu_wq.single) {
3255 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003256 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003257 }
3258}
3259
Tejun Heof3421792010-07-02 10:03:51 +02003260static int wq_clamp_max_active(int max_active, unsigned int flags,
3261 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003262{
Tejun Heof3421792010-07-02 10:03:51 +02003263 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3264
3265 if (max_active < 1 || max_active > lim)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003266 printk(KERN_WARNING "workqueue: max_active %d requested for %s "
3267 "is out of range, clamping between %d and %d\n",
Tejun Heof3421792010-07-02 10:03:51 +02003268 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003269
Tejun Heof3421792010-07-02 10:03:51 +02003270 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003271}
3272
Tejun Heob196be82012-01-10 15:11:35 -08003273struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003274 unsigned int flags,
3275 int max_active,
3276 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003277 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003278{
Tejun Heob196be82012-01-10 15:11:35 -08003279 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003280 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003281 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08003282 size_t namelen;
3283
3284 /* determine namelen, allocate wq and format name */
3285 va_start(args, lock_name);
3286 va_copy(args1, args);
3287 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3288
3289 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3290 if (!wq)
3291 goto err;
3292
3293 vsnprintf(wq->name, namelen, fmt, args1);
3294 va_end(args);
3295 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003296
Tejun Heof3421792010-07-02 10:03:51 +02003297 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02003298 * Workqueues which may be used during memory reclaim should
3299 * have a rescuer to guarantee forward progress.
3300 */
3301 if (flags & WQ_MEM_RECLAIM)
3302 flags |= WQ_RESCUER;
3303
Tejun Heod320c032010-06-29 10:07:14 +02003304 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003305 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003306
Tejun Heob196be82012-01-10 15:11:35 -08003307 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003308 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003309 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003310 mutex_init(&wq->flush_mutex);
3311 atomic_set(&wq->nr_cwqs_to_flush, 0);
3312 INIT_LIST_HEAD(&wq->flusher_queue);
3313 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003314
Johannes Bergeb13ba82008-01-16 09:51:58 +01003315 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003316 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003317
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003318 if (alloc_cwqs(wq) < 0)
3319 goto err;
3320
Tejun Heof3421792010-07-02 10:03:51 +02003321 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003322 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003323 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo32704762012-07-13 22:16:45 -07003324 int pool_idx = (bool)(flags & WQ_HIGHPRI);
Tejun Heo15376632010-06-29 10:07:11 +02003325
Tejun Heo0f900042010-06-29 10:07:11 +02003326 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo32704762012-07-13 22:16:45 -07003327 cwq->pool = &gcwq->pools[pool_idx];
Tejun Heoc34056a2010-06-29 10:07:11 +02003328 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003329 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003330 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003331 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003332 }
3333
Tejun Heoe22bee72010-06-29 10:07:14 +02003334 if (flags & WQ_RESCUER) {
3335 struct worker *rescuer;
3336
Tejun Heof2e005a2010-07-20 15:59:09 +02003337 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003338 goto err;
3339
3340 wq->rescuer = rescuer = alloc_worker();
3341 if (!rescuer)
3342 goto err;
3343
Tejun Heob196be82012-01-10 15:11:35 -08003344 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3345 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003346 if (IS_ERR(rescuer->task))
3347 goto err;
3348
Tejun Heoe22bee72010-06-29 10:07:14 +02003349 rescuer->task->flags |= PF_THREAD_BOUND;
3350 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003351 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003352
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003353 /*
3354 * workqueue_lock protects global freeze state and workqueues
3355 * list. Grab it, set max_active accordingly and add the new
3356 * workqueue to workqueues list.
3357 */
Tejun Heo15376632010-06-29 10:07:11 +02003358 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003359
Tejun Heo58a69cb2011-02-16 09:25:31 +01003360 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003361 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003362 get_cwq(cpu, wq)->max_active = 0;
3363
Tejun Heo15376632010-06-29 10:07:11 +02003364 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003365
Tejun Heo15376632010-06-29 10:07:11 +02003366 spin_unlock(&workqueue_lock);
3367
Oleg Nesterov3af244332007-05-09 02:34:09 -07003368 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003369err:
3370 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003371 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003372 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003373 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003374 kfree(wq);
3375 }
3376 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003377}
Tejun Heod320c032010-06-29 10:07:14 +02003378EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003379
3380/**
3381 * destroy_workqueue - safely terminate a workqueue
3382 * @wq: target workqueue
3383 *
3384 * Safely destroy a workqueue. All work currently pending will be done first.
3385 */
3386void destroy_workqueue(struct workqueue_struct *wq)
3387{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003388 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003389
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003390 /* drain it before proceeding with destruction */
3391 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003392
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003393 /*
3394 * wq list is used to freeze wq, remove from list after
3395 * flushing is complete in case freeze races us.
3396 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003397 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07003398 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003399 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003400
Tejun Heoe22bee72010-06-29 10:07:14 +02003401 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003402 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003403 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3404 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003405
Tejun Heo73f53c42010-06-29 10:07:11 +02003406 for (i = 0; i < WORK_NR_COLORS; i++)
3407 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003408 BUG_ON(cwq->nr_active);
3409 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003410 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003411
Tejun Heoe22bee72010-06-29 10:07:14 +02003412 if (wq->flags & WQ_RESCUER) {
3413 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003414 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003415 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003416 }
3417
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003418 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003419 kfree(wq);
3420}
3421EXPORT_SYMBOL_GPL(destroy_workqueue);
3422
Tejun Heodcd989c2010-06-29 10:07:14 +02003423/**
3424 * workqueue_set_max_active - adjust max_active of a workqueue
3425 * @wq: target workqueue
3426 * @max_active: new max_active value.
3427 *
3428 * Set max_active of @wq to @max_active.
3429 *
3430 * CONTEXT:
3431 * Don't call from IRQ context.
3432 */
3433void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3434{
3435 unsigned int cpu;
3436
Tejun Heof3421792010-07-02 10:03:51 +02003437 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003438
3439 spin_lock(&workqueue_lock);
3440
3441 wq->saved_max_active = max_active;
3442
Tejun Heof3421792010-07-02 10:03:51 +02003443 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003444 struct global_cwq *gcwq = get_gcwq(cpu);
3445
3446 spin_lock_irq(&gcwq->lock);
3447
Tejun Heo58a69cb2011-02-16 09:25:31 +01003448 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003449 !(gcwq->flags & GCWQ_FREEZING))
3450 get_cwq(gcwq->cpu, wq)->max_active = max_active;
3451
3452 spin_unlock_irq(&gcwq->lock);
3453 }
3454
3455 spin_unlock(&workqueue_lock);
3456}
3457EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3458
3459/**
3460 * workqueue_congested - test whether a workqueue is congested
3461 * @cpu: CPU in question
3462 * @wq: target workqueue
3463 *
3464 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3465 * no synchronization around this function and the test result is
3466 * unreliable and only useful as advisory hints or for debugging.
3467 *
3468 * RETURNS:
3469 * %true if congested, %false otherwise.
3470 */
3471bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3472{
3473 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3474
3475 return !list_empty(&cwq->delayed_works);
3476}
3477EXPORT_SYMBOL_GPL(workqueue_congested);
3478
3479/**
3480 * work_cpu - return the last known associated cpu for @work
3481 * @work: the work of interest
3482 *
3483 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003484 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003485 */
3486unsigned int work_cpu(struct work_struct *work)
3487{
3488 struct global_cwq *gcwq = get_work_gcwq(work);
3489
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003490 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003491}
3492EXPORT_SYMBOL_GPL(work_cpu);
3493
3494/**
3495 * work_busy - test whether a work is currently pending or running
3496 * @work: the work to be tested
3497 *
3498 * Test whether @work is currently pending or running. There is no
3499 * synchronization around this function and the test result is
3500 * unreliable and only useful as advisory hints or for debugging.
3501 * Especially for reentrant wqs, the pending state might hide the
3502 * running state.
3503 *
3504 * RETURNS:
3505 * OR'd bitmask of WORK_BUSY_* bits.
3506 */
3507unsigned int work_busy(struct work_struct *work)
3508{
3509 struct global_cwq *gcwq = get_work_gcwq(work);
3510 unsigned long flags;
3511 unsigned int ret = 0;
3512
3513 if (!gcwq)
3514 return false;
3515
3516 spin_lock_irqsave(&gcwq->lock, flags);
3517
3518 if (work_pending(work))
3519 ret |= WORK_BUSY_PENDING;
3520 if (find_worker_executing_work(gcwq, work))
3521 ret |= WORK_BUSY_RUNNING;
3522
3523 spin_unlock_irqrestore(&gcwq->lock, flags);
3524
3525 return ret;
3526}
3527EXPORT_SYMBOL_GPL(work_busy);
3528
Tejun Heodb7bccf2010-06-29 10:07:12 +02003529/*
3530 * CPU hotplug.
3531 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003532 * There are two challenges in supporting CPU hotplug. Firstly, there
3533 * are a lot of assumptions on strong associations among work, cwq and
3534 * gcwq which make migrating pending and scheduled works very
3535 * difficult to implement without impacting hot paths. Secondly,
3536 * gcwqs serve mix of short, long and very long running works making
3537 * blocked draining impractical.
3538 *
Tejun Heo628c78e2012-07-17 12:39:27 -07003539 * This is solved by allowing a gcwq to be disassociated from the CPU
3540 * running as an unbound one and allowing it to be reattached later if the
3541 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003542 */
3543
Tejun Heo60373152012-07-17 12:39:27 -07003544/* claim manager positions of all pools */
Tejun Heo8db25e72012-07-17 12:39:28 -07003545static void gcwq_claim_management_and_lock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003546{
3547 struct worker_pool *pool;
3548
3549 for_each_worker_pool(pool, gcwq)
3550 mutex_lock_nested(&pool->manager_mutex, pool - gcwq->pools);
Tejun Heo8db25e72012-07-17 12:39:28 -07003551 spin_lock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003552}
3553
3554/* release manager positions */
Tejun Heo8db25e72012-07-17 12:39:28 -07003555static void gcwq_release_management_and_unlock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003556{
3557 struct worker_pool *pool;
3558
Tejun Heo8db25e72012-07-17 12:39:28 -07003559 spin_unlock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003560 for_each_worker_pool(pool, gcwq)
3561 mutex_unlock(&pool->manager_mutex);
3562}
3563
Tejun Heo628c78e2012-07-17 12:39:27 -07003564static void gcwq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003565{
Tejun Heo628c78e2012-07-17 12:39:27 -07003566 struct global_cwq *gcwq = get_gcwq(smp_processor_id());
Tejun Heo4ce62e92012-07-13 22:16:44 -07003567 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003568 struct worker *worker;
3569 struct hlist_node *pos;
3570 int i;
3571
3572 BUG_ON(gcwq->cpu != smp_processor_id());
3573
Tejun Heo8db25e72012-07-17 12:39:28 -07003574 gcwq_claim_management_and_lock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003575
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003576 /*
3577 * We've claimed all manager positions. Make all workers unbound
3578 * and set DISASSOCIATED. Before this, all workers except for the
3579 * ones which are still executing works from before the last CPU
3580 * down must be on the cpu. After this, they may become diasporas.
3581 */
Tejun Heo60373152012-07-17 12:39:27 -07003582 for_each_worker_pool(pool, gcwq)
Tejun Heo4ce62e92012-07-13 22:16:44 -07003583 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07003584 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003585
3586 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo403c8212012-07-17 12:39:27 -07003587 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003588
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003589 gcwq->flags |= GCWQ_DISASSOCIATED;
3590
Tejun Heo8db25e72012-07-17 12:39:28 -07003591 gcwq_release_management_and_unlock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003592
3593 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07003594 * Call schedule() so that we cross rq->lock and thus can guarantee
3595 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3596 * as scheduler callbacks may be invoked from other cpus.
3597 */
3598 schedule();
3599
3600 /*
3601 * Sched callbacks are disabled now. Zap nr_running. After this,
3602 * nr_running stays zero and need_more_worker() and keep_working()
3603 * are always true as long as the worklist is not empty. @gcwq now
3604 * behaves as unbound (in terms of concurrency management) gcwq
3605 * which is served by workers tied to the CPU.
3606 *
3607 * On return from this function, the current worker would trigger
3608 * unbound chain execution of pending work items if other workers
3609 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02003610 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07003611 for_each_worker_pool(pool, gcwq)
3612 atomic_set(get_pool_nr_running(pool), 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003613}
3614
Tejun Heo8db25e72012-07-17 12:39:28 -07003615/*
3616 * Workqueues should be brought up before normal priority CPU notifiers.
3617 * This will be registered high priority CPU notifier.
3618 */
3619static int __devinit workqueue_cpu_up_callback(struct notifier_block *nfb,
3620 unsigned long action,
3621 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003622{
3623 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003624 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003625 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003626
Tejun Heo8db25e72012-07-17 12:39:28 -07003627 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003628 case CPU_UP_PREPARE:
Tejun Heo4ce62e92012-07-13 22:16:44 -07003629 for_each_worker_pool(pool, gcwq) {
Tejun Heo3ce63372012-07-17 12:39:27 -07003630 struct worker *worker;
3631
3632 if (pool->nr_workers)
3633 continue;
3634
3635 worker = create_worker(pool);
3636 if (!worker)
3637 return NOTIFY_BAD;
3638
3639 spin_lock_irq(&gcwq->lock);
3640 start_worker(worker);
3641 spin_unlock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003642 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003643 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003644
Tejun Heo65758202012-07-17 12:39:26 -07003645 case CPU_DOWN_FAILED:
3646 case CPU_ONLINE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003647 gcwq_claim_management_and_lock(gcwq);
3648 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3649 rebind_workers(gcwq);
3650 gcwq_release_management_and_unlock(gcwq);
3651 break;
Tejun Heo65758202012-07-17 12:39:26 -07003652 }
3653 return NOTIFY_OK;
3654}
3655
3656/*
3657 * Workqueues should be brought down after normal priority CPU notifiers.
3658 * This will be registered as low priority CPU notifier.
3659 */
3660static int __devinit workqueue_cpu_down_callback(struct notifier_block *nfb,
3661 unsigned long action,
3662 void *hcpu)
3663{
Tejun Heo8db25e72012-07-17 12:39:28 -07003664 unsigned int cpu = (unsigned long)hcpu;
3665 struct work_struct unbind_work;
3666
Tejun Heo65758202012-07-17 12:39:26 -07003667 switch (action & ~CPU_TASKS_FROZEN) {
3668 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003669 /* unbinding should happen on the local CPU */
3670 INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
3671 schedule_work_on(cpu, &unbind_work);
3672 flush_work(&unbind_work);
3673 break;
Tejun Heo65758202012-07-17 12:39:26 -07003674 }
3675 return NOTIFY_OK;
3676}
3677
Rusty Russell2d3854a2008-11-05 13:39:10 +11003678#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003679
Rusty Russell2d3854a2008-11-05 13:39:10 +11003680struct work_for_cpu {
Andrew Morton6b44003e2009-04-09 09:50:37 -06003681 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003682 long (*fn)(void *);
3683 void *arg;
3684 long ret;
3685};
3686
Andrew Morton6b44003e2009-04-09 09:50:37 -06003687static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003688{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003689 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003690 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b44003e2009-04-09 09:50:37 -06003691 complete(&wfc->completion);
3692 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003693}
3694
3695/**
3696 * work_on_cpu - run a function in user context on a particular cpu
3697 * @cpu: the cpu to run on
3698 * @fn: the function to run
3699 * @arg: the function arg
3700 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003701 * This will return the value @fn returns.
3702 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06003703 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003704 */
3705long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3706{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003707 struct task_struct *sub_thread;
3708 struct work_for_cpu wfc = {
3709 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3710 .fn = fn,
3711 .arg = arg,
3712 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003713
Andrew Morton6b44003e2009-04-09 09:50:37 -06003714 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3715 if (IS_ERR(sub_thread))
3716 return PTR_ERR(sub_thread);
3717 kthread_bind(sub_thread, cpu);
3718 wake_up_process(sub_thread);
3719 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003720 return wfc.ret;
3721}
3722EXPORT_SYMBOL_GPL(work_on_cpu);
3723#endif /* CONFIG_SMP */
3724
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003725#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303726
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003727/**
3728 * freeze_workqueues_begin - begin freezing workqueues
3729 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003730 * Start freezing workqueues. After this function returns, all freezable
3731 * workqueues will queue new works to their frozen_works list instead of
3732 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003733 *
3734 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003735 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003736 */
3737void freeze_workqueues_begin(void)
3738{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003739 unsigned int cpu;
3740
3741 spin_lock(&workqueue_lock);
3742
3743 BUG_ON(workqueue_freezing);
3744 workqueue_freezing = true;
3745
Tejun Heof3421792010-07-02 10:03:51 +02003746 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003747 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003748 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003749
3750 spin_lock_irq(&gcwq->lock);
3751
Tejun Heodb7bccf2010-06-29 10:07:12 +02003752 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3753 gcwq->flags |= GCWQ_FREEZING;
3754
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003755 list_for_each_entry(wq, &workqueues, list) {
3756 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3757
Tejun Heo58a69cb2011-02-16 09:25:31 +01003758 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003759 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003760 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003761
3762 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003763 }
3764
3765 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003766}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003767
3768/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003769 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003770 *
3771 * Check whether freezing is complete. This function must be called
3772 * between freeze_workqueues_begin() and thaw_workqueues().
3773 *
3774 * CONTEXT:
3775 * Grabs and releases workqueue_lock.
3776 *
3777 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003778 * %true if some freezable workqueues are still busy. %false if freezing
3779 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003780 */
3781bool freeze_workqueues_busy(void)
3782{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003783 unsigned int cpu;
3784 bool busy = false;
3785
3786 spin_lock(&workqueue_lock);
3787
3788 BUG_ON(!workqueue_freezing);
3789
Tejun Heof3421792010-07-02 10:03:51 +02003790 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003791 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003792 /*
3793 * nr_active is monotonically decreasing. It's safe
3794 * to peek without lock.
3795 */
3796 list_for_each_entry(wq, &workqueues, list) {
3797 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3798
Tejun Heo58a69cb2011-02-16 09:25:31 +01003799 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003800 continue;
3801
3802 BUG_ON(cwq->nr_active < 0);
3803 if (cwq->nr_active) {
3804 busy = true;
3805 goto out_unlock;
3806 }
3807 }
3808 }
3809out_unlock:
3810 spin_unlock(&workqueue_lock);
3811 return busy;
3812}
3813
3814/**
3815 * thaw_workqueues - thaw workqueues
3816 *
3817 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003818 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003819 *
3820 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003821 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003822 */
3823void thaw_workqueues(void)
3824{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003825 unsigned int cpu;
3826
3827 spin_lock(&workqueue_lock);
3828
3829 if (!workqueue_freezing)
3830 goto out_unlock;
3831
Tejun Heof3421792010-07-02 10:03:51 +02003832 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003833 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003834 struct worker_pool *pool;
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003835 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003836
3837 spin_lock_irq(&gcwq->lock);
3838
Tejun Heodb7bccf2010-06-29 10:07:12 +02003839 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3840 gcwq->flags &= ~GCWQ_FREEZING;
3841
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003842 list_for_each_entry(wq, &workqueues, list) {
3843 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3844
Tejun Heo58a69cb2011-02-16 09:25:31 +01003845 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003846 continue;
3847
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003848 /* restore max_active and repopulate worklist */
3849 cwq->max_active = wq->saved_max_active;
3850
3851 while (!list_empty(&cwq->delayed_works) &&
3852 cwq->nr_active < cwq->max_active)
3853 cwq_activate_first_delayed(cwq);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003854 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003855
Tejun Heo4ce62e92012-07-13 22:16:44 -07003856 for_each_worker_pool(pool, gcwq)
3857 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02003858
Tejun Heo8b03ae32010-06-29 10:07:12 +02003859 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003860 }
3861
3862 workqueue_freezing = false;
3863out_unlock:
3864 spin_unlock(&workqueue_lock);
3865}
3866#endif /* CONFIG_FREEZER */
3867
Suresh Siddha6ee05782010-07-30 14:57:37 -07003868static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003869{
Tejun Heoc34056a2010-06-29 10:07:11 +02003870 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003871 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02003872
Tejun Heob5490072012-08-03 10:30:46 -07003873 /* make sure we have enough bits for OFFQ CPU number */
3874 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3875 WORK_CPU_LAST);
3876
Tejun Heo65758202012-07-17 12:39:26 -07003877 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
3878 cpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003879
3880 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003881 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003882 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003883 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003884
3885 spin_lock_init(&gcwq->lock);
3886 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003887 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003888
Tejun Heoc8e55f32010-06-29 10:07:12 +02003889 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3890 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3891
Tejun Heo4ce62e92012-07-13 22:16:44 -07003892 for_each_worker_pool(pool, gcwq) {
3893 pool->gcwq = gcwq;
3894 INIT_LIST_HEAD(&pool->worklist);
3895 INIT_LIST_HEAD(&pool->idle_list);
Tejun Heoe22bee72010-06-29 10:07:14 +02003896
Tejun Heo4ce62e92012-07-13 22:16:44 -07003897 init_timer_deferrable(&pool->idle_timer);
3898 pool->idle_timer.function = idle_worker_timeout;
3899 pool->idle_timer.data = (unsigned long)pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003900
Tejun Heo4ce62e92012-07-13 22:16:44 -07003901 setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
3902 (unsigned long)pool);
3903
Tejun Heo60373152012-07-17 12:39:27 -07003904 mutex_init(&pool->manager_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003905 ida_init(&pool->worker_ida);
3906 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003907
Tejun Heo25511a42012-07-17 12:39:27 -07003908 init_waitqueue_head(&gcwq->rebind_hold);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003909 }
3910
Tejun Heoe22bee72010-06-29 10:07:14 +02003911 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003912 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003913 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003914 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003915
Tejun Heo477a3c32010-08-31 10:54:35 +02003916 if (cpu != WORK_CPU_UNBOUND)
3917 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003918
3919 for_each_worker_pool(pool, gcwq) {
3920 struct worker *worker;
3921
Tejun Heobc2ae0f2012-07-17 12:39:27 -07003922 worker = create_worker(pool);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003923 BUG_ON(!worker);
3924 spin_lock_irq(&gcwq->lock);
3925 start_worker(worker);
3926 spin_unlock_irq(&gcwq->lock);
3927 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003928 }
3929
Tejun Heod320c032010-06-29 10:07:14 +02003930 system_wq = alloc_workqueue("events", 0, 0);
3931 system_long_wq = alloc_workqueue("events_long", 0, 0);
3932 system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003933 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3934 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003935 system_freezable_wq = alloc_workqueue("events_freezable",
3936 WQ_FREEZABLE, 0);
Alan Stern62d3c542012-03-02 10:51:00 +01003937 system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
3938 WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
Hitoshi Mitakee5cba242010-11-26 12:06:44 +01003939 BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
Alan Stern62d3c542012-03-02 10:51:00 +01003940 !system_unbound_wq || !system_freezable_wq ||
3941 !system_nrt_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003942 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003943}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003944early_initcall(init_workqueues);