blob: 4790c81e323962eb01a074fb27ec86ff5d36a441 [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 Heodb7bccf2010-06-29 10:07:12 +020048 /* global_cwq flags */
Tejun Heoe22bee72010-06-29 10:07:14 +020049 GCWQ_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
50 GCWQ_MANAGING_WORKERS = 1 << 1, /* managing workers */
51 GCWQ_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020052 GCWQ_FREEZING = 1 << 3, /* freeze in progress */
Tejun Heo649027d2010-06-29 10:07:14 +020053 GCWQ_HIGHPRI_PENDING = 1 << 4, /* highpri works on queue */
Tejun Heodb7bccf2010-06-29 10:07:12 +020054
Tejun Heoc8e55f32010-06-29 10:07:12 +020055 /* worker flags */
56 WORKER_STARTED = 1 << 0, /* started */
57 WORKER_DIE = 1 << 1, /* die die die */
58 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020059 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heodb7bccf2010-06-29 10:07:12 +020060 WORKER_ROGUE = 1 << 4, /* not bound to any cpu */
Tejun Heoe22bee72010-06-29 10:07:14 +020061 WORKER_REBIND = 1 << 5, /* mom is home, come back */
Tejun Heofb0e7be2010-06-29 10:07:15 +020062 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020063 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoe22bee72010-06-29 10:07:14 +020064
Tejun Heofb0e7be2010-06-29 10:07:15 +020065 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_ROGUE | WORKER_REBIND |
Tejun Heof3421792010-07-02 10:03:51 +020066 WORKER_CPU_INTENSIVE | WORKER_UNBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020067
68 /* gcwq->trustee_state */
69 TRUSTEE_START = 0, /* start */
70 TRUSTEE_IN_CHARGE = 1, /* trustee in charge of gcwq */
71 TRUSTEE_BUTCHER = 2, /* butcher workers */
72 TRUSTEE_RELEASE = 3, /* release workers */
73 TRUSTEE_DONE = 4, /* trustee is done */
Tejun Heoc8e55f32010-06-29 10:07:12 +020074
75 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
76 BUSY_WORKER_HASH_SIZE = 1 << BUSY_WORKER_HASH_ORDER,
77 BUSY_WORKER_HASH_MASK = BUSY_WORKER_HASH_SIZE - 1,
Tejun Heodb7bccf2010-06-29 10:07:12 +020078
Tejun Heoe22bee72010-06-29 10:07:14 +020079 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
80 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
81
Tejun Heo3233cdb2011-02-16 18:10:19 +010082 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
83 /* call for help after 10ms
84 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020085 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
86 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heodb7bccf2010-06-29 10:07:12 +020087 TRUSTEE_COOLDOWN = HZ / 10, /* for trustee draining */
Tejun Heoe22bee72010-06-29 10:07:14 +020088
89 /*
90 * Rescue workers are used only on emergencies and shared by
91 * all cpus. Give -20.
92 */
93 RESCUER_NICE_LEVEL = -20,
Tejun Heoc8e55f32010-06-29 10:07:12 +020094};
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
96/*
Tejun Heo4690c4a2010-06-29 10:07:10 +020097 * Structure fields follow one of the following exclusion rules.
98 *
Tejun Heoe41e7042010-08-24 14:22:47 +020099 * I: Modifiable by initialization/destruction paths and read-only for
100 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200101 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200102 * P: Preemption protected. Disabling preemption is enough and should
103 * only be modified and accessed from the local cpu.
104 *
Tejun Heo8b03ae32010-06-29 10:07:12 +0200105 * L: gcwq->lock protected. Access with gcwq->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200106 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200107 * X: During normal operation, modification requires gcwq->lock and
108 * should be done only from local cpu. Either disabling preemption
109 * on local cpu or grabbing gcwq->lock is enough for read access.
Tejun Heof3421792010-07-02 10:03:51 +0200110 * If GCWQ_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200111 *
Tejun Heo73f53c42010-06-29 10:07:11 +0200112 * F: wq->flush_mutex protected.
113 *
Tejun Heo4690c4a2010-06-29 10:07:10 +0200114 * W: workqueue_lock protected.
115 */
116
Tejun Heo8b03ae32010-06-29 10:07:12 +0200117struct global_cwq;
Tejun Heoc34056a2010-06-29 10:07:11 +0200118
Tejun Heoe22bee72010-06-29 10:07:14 +0200119/*
120 * The poor guys doing the actual heavy lifting. All on-duty workers
121 * are either serving the manager role, on idle list or on busy hash.
122 */
Tejun Heoc34056a2010-06-29 10:07:11 +0200123struct worker {
Tejun Heoc8e55f32010-06-29 10:07:12 +0200124 /* on idle list while idle, on busy hash table while busy */
125 union {
126 struct list_head entry; /* L: while idle */
127 struct hlist_node hentry; /* L: while busy */
128 };
129
Tejun Heoc34056a2010-06-29 10:07:11 +0200130 struct work_struct *current_work; /* L: work being processed */
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200131 struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
Tejun Heoaffee4b2010-06-29 10:07:12 +0200132 struct list_head scheduled; /* L: scheduled works */
Tejun Heoc34056a2010-06-29 10:07:11 +0200133 struct task_struct *task; /* I: worker task */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200134 struct global_cwq *gcwq; /* I: the associated gcwq */
Tejun Heoe22bee72010-06-29 10:07:14 +0200135 /* 64 bytes boundary on 64bit, 32 on 32bit */
136 unsigned long last_active; /* L: last active timestamp */
137 unsigned int flags; /* X: flags */
Tejun Heoc34056a2010-06-29 10:07:11 +0200138 int id; /* I: worker id */
Tejun Heoe22bee72010-06-29 10:07:14 +0200139 struct work_struct rebind_work; /* L: rebind worker to cpu */
Tejun Heoc34056a2010-06-29 10:07:11 +0200140};
141
Tejun Heo4690c4a2010-06-29 10:07:10 +0200142/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200143 * Global per-cpu workqueue. There's one and only one for each cpu
144 * and all works are queued and processed here regardless of their
145 * target workqueues.
Tejun Heo8b03ae32010-06-29 10:07:12 +0200146 */
147struct global_cwq {
148 spinlock_t lock; /* the gcwq lock */
Tejun Heo7e116292010-06-29 10:07:13 +0200149 struct list_head worklist; /* L: list of pending works */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200150 unsigned int cpu; /* I: the associated cpu */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200151 unsigned int flags; /* L: GCWQ_* flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200152
153 int nr_workers; /* L: total number of workers */
154 int nr_idle; /* L: currently idle ones */
155
156 /* workers are chained either in the idle_list or busy_hash */
Tejun Heoe22bee72010-06-29 10:07:14 +0200157 struct list_head idle_list; /* X: list of idle workers */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200158 struct hlist_head busy_hash[BUSY_WORKER_HASH_SIZE];
159 /* L: hash of busy workers */
160
Tejun Heoe22bee72010-06-29 10:07:14 +0200161 struct timer_list idle_timer; /* L: worker idle timeout */
162 struct timer_list mayday_timer; /* L: SOS timer for dworkers */
163
Tejun Heo8b03ae32010-06-29 10:07:12 +0200164 struct ida worker_ida; /* L: for worker IDs */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200165
166 struct task_struct *trustee; /* L: for gcwq shutdown */
167 unsigned int trustee_state; /* L: trustee state */
168 wait_queue_head_t trustee_wait; /* trustee wait */
Tejun Heoe22bee72010-06-29 10:07:14 +0200169 struct worker *first_idle; /* L: first idle worker */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200170} ____cacheline_aligned_in_smp;
171
172/*
Tejun Heo502ca9d2010-06-29 10:07:13 +0200173 * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of
Tejun Heo0f900042010-06-29 10:07:11 +0200174 * work_struct->data are used for flags and thus cwqs need to be
175 * aligned at two's power of the number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 */
177struct cpu_workqueue_struct {
Tejun Heo8b03ae32010-06-29 10:07:12 +0200178 struct global_cwq *gcwq; /* I: the associated gcwq */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200179 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200180 int work_color; /* L: current color */
181 int flush_color; /* L: flushing color */
182 int nr_in_flight[WORK_NR_COLORS];
183 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200184 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200185 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200186 struct list_head delayed_works; /* L: delayed works */
Tejun Heo0f900042010-06-29 10:07:11 +0200187};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200190 * Structure used to wait for workqueue flush.
191 */
192struct wq_flusher {
193 struct list_head list; /* F: list of flushers */
194 int flush_color; /* F: flush color waiting for */
195 struct completion done; /* flush completion */
196};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
Tejun Heo73f53c42010-06-29 10:07:11 +0200198/*
Tejun Heof2e005a2010-07-20 15:59:09 +0200199 * All cpumasks are assumed to be always set on UP and thus can't be
200 * used to determine whether there's something to be done.
201 */
202#ifdef CONFIG_SMP
203typedef cpumask_var_t mayday_mask_t;
204#define mayday_test_and_set_cpu(cpu, mask) \
205 cpumask_test_and_set_cpu((cpu), (mask))
206#define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask))
207#define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask))
Tejun Heo9c375472010-08-31 11:18:34 +0200208#define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp))
Tejun Heof2e005a2010-07-20 15:59:09 +0200209#define free_mayday_mask(mask) free_cpumask_var((mask))
210#else
211typedef unsigned long mayday_mask_t;
212#define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask))
213#define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask))
214#define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask))
215#define alloc_mayday_mask(maskp, gfp) true
216#define free_mayday_mask(mask) do { } while (0)
217#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219/*
220 * The externally visible workqueue abstraction is an array of
221 * per-CPU workqueues:
222 */
223struct workqueue_struct {
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200224 unsigned int flags; /* W: WQ_* flags */
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200225 union {
226 struct cpu_workqueue_struct __percpu *pcpu;
227 struct cpu_workqueue_struct *single;
228 unsigned long v;
229 } cpu_wq; /* I: cwq's */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200230 struct list_head list; /* W: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200231
232 struct mutex flush_mutex; /* protects wq flushing */
233 int work_color; /* F: current work color */
234 int flush_color; /* F: current flush color */
235 atomic_t nr_cwqs_to_flush; /* flush in progress */
236 struct wq_flusher *first_flusher; /* F: first flusher */
237 struct list_head flusher_queue; /* F: flush waiters */
238 struct list_head flusher_overflow; /* F: flush overflow list */
239
Tejun Heof2e005a2010-07-20 15:59:09 +0200240 mayday_mask_t mayday_mask; /* cpus requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200241 struct worker *rescuer; /* I: rescue worker */
242
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200243 int nr_drainers; /* W: drain in progress */
Tejun Heodcd989c2010-06-29 10:07:14 +0200244 int saved_max_active; /* W: saved cwq max_active */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700245#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200246 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700247#endif
Tejun Heob196be82012-01-10 15:11:35 -0800248 char name[]; /* I: workqueue name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249};
250
Tejun Heod320c032010-06-29 10:07:14 +0200251struct workqueue_struct *system_wq __read_mostly;
252struct workqueue_struct *system_long_wq __read_mostly;
253struct workqueue_struct *system_nrt_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200254struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100255struct workqueue_struct *system_freezable_wq __read_mostly;
Alan Stern62d3c542012-03-02 10:51:00 +0100256struct workqueue_struct *system_nrt_freezable_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200257EXPORT_SYMBOL_GPL(system_wq);
258EXPORT_SYMBOL_GPL(system_long_wq);
259EXPORT_SYMBOL_GPL(system_nrt_wq);
Tejun Heof3421792010-07-02 10:03:51 +0200260EXPORT_SYMBOL_GPL(system_unbound_wq);
Tejun Heo24d51ad2011-02-21 09:52:50 +0100261EXPORT_SYMBOL_GPL(system_freezable_wq);
Alan Stern62d3c542012-03-02 10:51:00 +0100262EXPORT_SYMBOL_GPL(system_nrt_freezable_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200263
Tejun Heo97bd2342010-10-05 10:41:14 +0200264#define CREATE_TRACE_POINTS
265#include <trace/events/workqueue.h>
266
Tejun Heodb7bccf2010-06-29 10:07:12 +0200267#define for_each_busy_worker(worker, i, pos, gcwq) \
268 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \
269 hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
270
Tejun Heof3421792010-07-02 10:03:51 +0200271static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
272 unsigned int sw)
273{
274 if (cpu < nr_cpu_ids) {
275 if (sw & 1) {
276 cpu = cpumask_next(cpu, mask);
277 if (cpu < nr_cpu_ids)
278 return cpu;
279 }
280 if (sw & 2)
281 return WORK_CPU_UNBOUND;
282 }
283 return WORK_CPU_NONE;
284}
285
286static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
287 struct workqueue_struct *wq)
288{
289 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
290}
291
Tejun Heo09884952010-08-01 11:50:12 +0200292/*
293 * CPU iterators
294 *
295 * An extra gcwq is defined for an invalid cpu number
296 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
297 * specific CPU. The following iterators are similar to
298 * for_each_*_cpu() iterators but also considers the unbound gcwq.
299 *
300 * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
301 * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
302 * for_each_cwq_cpu() : possible CPUs for bound workqueues,
303 * WORK_CPU_UNBOUND for unbound workqueues
304 */
Tejun Heof3421792010-07-02 10:03:51 +0200305#define for_each_gcwq_cpu(cpu) \
306 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
307 (cpu) < WORK_CPU_NONE; \
308 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
309
310#define for_each_online_gcwq_cpu(cpu) \
311 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
312 (cpu) < WORK_CPU_NONE; \
313 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
314
315#define for_each_cwq_cpu(cpu, wq) \
316 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
317 (cpu) < WORK_CPU_NONE; \
318 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
319
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900320#ifdef CONFIG_DEBUG_OBJECTS_WORK
321
322static struct debug_obj_descr work_debug_descr;
323
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100324static void *work_debug_hint(void *addr)
325{
326 return ((struct work_struct *) addr)->func;
327}
328
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900329/*
330 * fixup_init is called when:
331 * - an active object is initialized
332 */
333static int work_fixup_init(void *addr, enum debug_obj_state state)
334{
335 struct work_struct *work = addr;
336
337 switch (state) {
338 case ODEBUG_STATE_ACTIVE:
339 cancel_work_sync(work);
340 debug_object_init(work, &work_debug_descr);
341 return 1;
342 default:
343 return 0;
344 }
345}
346
347/*
348 * fixup_activate is called when:
349 * - an active object is activated
350 * - an unknown object is activated (might be a statically initialized object)
351 */
352static int work_fixup_activate(void *addr, enum debug_obj_state state)
353{
354 struct work_struct *work = addr;
355
356 switch (state) {
357
358 case ODEBUG_STATE_NOTAVAILABLE:
359 /*
360 * This is not really a fixup. The work struct was
361 * statically initialized. We just make sure that it
362 * is tracked in the object tracker.
363 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200364 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900365 debug_object_init(work, &work_debug_descr);
366 debug_object_activate(work, &work_debug_descr);
367 return 0;
368 }
369 WARN_ON_ONCE(1);
370 return 0;
371
372 case ODEBUG_STATE_ACTIVE:
373 WARN_ON(1);
374
375 default:
376 return 0;
377 }
378}
379
380/*
381 * fixup_free is called when:
382 * - an active object is freed
383 */
384static int work_fixup_free(void *addr, enum debug_obj_state state)
385{
386 struct work_struct *work = addr;
387
388 switch (state) {
389 case ODEBUG_STATE_ACTIVE:
390 cancel_work_sync(work);
391 debug_object_free(work, &work_debug_descr);
392 return 1;
393 default:
394 return 0;
395 }
396}
397
398static struct debug_obj_descr work_debug_descr = {
399 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100400 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900401 .fixup_init = work_fixup_init,
402 .fixup_activate = work_fixup_activate,
403 .fixup_free = work_fixup_free,
404};
405
406static inline void debug_work_activate(struct work_struct *work)
407{
408 debug_object_activate(work, &work_debug_descr);
409}
410
411static inline void debug_work_deactivate(struct work_struct *work)
412{
413 debug_object_deactivate(work, &work_debug_descr);
414}
415
416void __init_work(struct work_struct *work, int onstack)
417{
418 if (onstack)
419 debug_object_init_on_stack(work, &work_debug_descr);
420 else
421 debug_object_init(work, &work_debug_descr);
422}
423EXPORT_SYMBOL_GPL(__init_work);
424
425void destroy_work_on_stack(struct work_struct *work)
426{
427 debug_object_free(work, &work_debug_descr);
428}
429EXPORT_SYMBOL_GPL(destroy_work_on_stack);
430
431#else
432static inline void debug_work_activate(struct work_struct *work) { }
433static inline void debug_work_deactivate(struct work_struct *work) { }
434#endif
435
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100436/* Serializes the accesses to the list of workqueues. */
437static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200439static bool workqueue_freezing; /* W: have wqs started freezing? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440
Oleg Nesterov14441962007-05-23 13:57:57 -0700441/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200442 * The almighty global cpu workqueues. nr_running is the only field
443 * which is expected to be used frequently by other cpus via
444 * try_to_wake_up(). Put it in a separate cacheline.
Oleg Nesterov14441962007-05-23 13:57:57 -0700445 */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200446static DEFINE_PER_CPU(struct global_cwq, global_cwq);
Tejun Heoe22bee72010-06-29 10:07:14 +0200447static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, gcwq_nr_running);
Nathan Lynchf756d5e2006-01-08 01:05:12 -0800448
Tejun Heof3421792010-07-02 10:03:51 +0200449/*
450 * Global cpu workqueue and nr_running counter for unbound gcwq. The
451 * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
452 * workers have WORKER_UNBOUND set.
453 */
454static struct global_cwq unbound_global_cwq;
455static atomic_t unbound_gcwq_nr_running = ATOMIC_INIT(0); /* always 0 */
456
Tejun Heoc34056a2010-06-29 10:07:11 +0200457static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
Tejun Heo8b03ae32010-06-29 10:07:12 +0200459static struct global_cwq *get_gcwq(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460{
Tejun Heof3421792010-07-02 10:03:51 +0200461 if (cpu != WORK_CPU_UNBOUND)
462 return &per_cpu(global_cwq, cpu);
463 else
464 return &unbound_global_cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465}
466
Tejun Heoe22bee72010-06-29 10:07:14 +0200467static atomic_t *get_gcwq_nr_running(unsigned int cpu)
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700468{
Tejun Heof3421792010-07-02 10:03:51 +0200469 if (cpu != WORK_CPU_UNBOUND)
470 return &per_cpu(gcwq_nr_running, cpu);
471 else
472 return &unbound_gcwq_nr_running;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700473}
474
Tejun Heo4690c4a2010-06-29 10:07:10 +0200475static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
476 struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700477{
Tejun Heof3421792010-07-02 10:03:51 +0200478 if (!(wq->flags & WQ_UNBOUND)) {
Lai Jiangshane06ffa12012-03-09 18:03:20 +0800479 if (likely(cpu < nr_cpu_ids))
Tejun Heof3421792010-07-02 10:03:51 +0200480 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
Tejun Heof3421792010-07-02 10:03:51 +0200481 } else if (likely(cpu == WORK_CPU_UNBOUND))
482 return wq->cpu_wq.single;
483 return NULL;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700484}
485
Tejun Heo73f53c42010-06-29 10:07:11 +0200486static unsigned int work_color_to_flags(int color)
487{
488 return color << WORK_STRUCT_COLOR_SHIFT;
489}
490
491static int get_work_color(struct work_struct *work)
492{
493 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
494 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
495}
496
497static int work_next_color(int color)
498{
499 return (color + 1) % WORK_NR_COLORS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500}
501
David Howells4594bf12006-12-07 11:33:26 +0000502/*
Tejun Heoe1201532010-07-22 14:14:25 +0200503 * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
504 * work is on queue. Once execution starts, WORK_STRUCT_CWQ is
505 * cleared and the work data contains the cpu number it was last on.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200506 *
507 * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
508 * cwq, cpu or clear work->data. These functions should only be
509 * called while the work is owned - ie. while the PENDING bit is set.
510 *
511 * get_work_[g]cwq() can be used to obtain the gcwq or cwq
512 * corresponding to a work. gcwq is available once the work has been
513 * queued anywhere after initialization. cwq is available only from
514 * queueing until execution starts.
David Howells4594bf12006-12-07 11:33:26 +0000515 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200516static inline void set_work_data(struct work_struct *work, unsigned long data,
517 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000518{
David Howells4594bf12006-12-07 11:33:26 +0000519 BUG_ON(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200520 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000521}
David Howells365970a2006-11-22 14:54:49 +0000522
Tejun Heo7a22ad72010-06-29 10:07:13 +0200523static void set_work_cwq(struct work_struct *work,
524 struct cpu_workqueue_struct *cwq,
525 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200526{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200527 set_work_data(work, (unsigned long)cwq,
Tejun Heoe1201532010-07-22 14:14:25 +0200528 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200529}
530
Tejun Heo7a22ad72010-06-29 10:07:13 +0200531static void set_work_cpu(struct work_struct *work, unsigned int cpu)
David Howells365970a2006-11-22 14:54:49 +0000532{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200533 set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
534}
535
536static void clear_work_data(struct work_struct *work)
537{
538 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
539}
540
Tejun Heo7a22ad72010-06-29 10:07:13 +0200541static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
542{
Tejun Heoe1201532010-07-22 14:14:25 +0200543 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200544
Tejun Heoe1201532010-07-22 14:14:25 +0200545 if (data & WORK_STRUCT_CWQ)
546 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
547 else
Srinivasarao Pb6e586c2013-09-18 14:33:45 +0530548 {
549 WARN_ON_ONCE(1);
Tejun Heoe1201532010-07-22 14:14:25 +0200550 return NULL;
Srinivasarao Pb6e586c2013-09-18 14:33:45 +0530551 }
Tejun Heo7a22ad72010-06-29 10:07:13 +0200552}
553
554static struct global_cwq *get_work_gcwq(struct work_struct *work)
555{
Tejun Heoe1201532010-07-22 14:14:25 +0200556 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200557 unsigned int cpu;
558
Tejun Heoe1201532010-07-22 14:14:25 +0200559 if (data & WORK_STRUCT_CWQ)
560 return ((struct cpu_workqueue_struct *)
561 (data & WORK_STRUCT_WQ_DATA_MASK))->gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200562
563 cpu = data >> WORK_STRUCT_FLAG_BITS;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200564 if (cpu == WORK_CPU_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200565 return NULL;
566
Tejun Heof3421792010-07-02 10:03:51 +0200567 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200568 return get_gcwq(cpu);
David Howells365970a2006-11-22 14:54:49 +0000569}
570
571/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200572 * Policy functions. These define the policies on how the global
573 * worker pool is managed. Unless noted otherwise, these functions
574 * assume that they're being called with gcwq->lock held.
David Howells365970a2006-11-22 14:54:49 +0000575 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200576
Tejun Heo649027d2010-06-29 10:07:14 +0200577static bool __need_more_worker(struct global_cwq *gcwq)
David Howells365970a2006-11-22 14:54:49 +0000578{
Tejun Heo649027d2010-06-29 10:07:14 +0200579 return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) ||
580 gcwq->flags & GCWQ_HIGHPRI_PENDING;
David Howells365970a2006-11-22 14:54:49 +0000581}
582
Tejun Heoe22bee72010-06-29 10:07:14 +0200583/*
584 * Need to wake up a worker? Called from anything but currently
585 * running workers.
586 */
587static bool need_more_worker(struct global_cwq *gcwq)
David Howells365970a2006-11-22 14:54:49 +0000588{
Tejun Heo649027d2010-06-29 10:07:14 +0200589 return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq);
David Howells365970a2006-11-22 14:54:49 +0000590}
591
Tejun Heoe22bee72010-06-29 10:07:14 +0200592/* Can I start working? Called from busy but !running workers. */
593static bool may_start_working(struct global_cwq *gcwq)
594{
595 return gcwq->nr_idle;
596}
597
598/* Do I need to keep working? Called from currently running workers. */
599static bool keep_working(struct global_cwq *gcwq)
600{
601 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
602
Tejun Heo30310042010-10-11 11:51:57 +0200603 return !list_empty(&gcwq->worklist) &&
604 (atomic_read(nr_running) <= 1 ||
605 gcwq->flags & GCWQ_HIGHPRI_PENDING);
Tejun Heoe22bee72010-06-29 10:07:14 +0200606}
607
608/* Do we need a new worker? Called from manager. */
609static bool need_to_create_worker(struct global_cwq *gcwq)
610{
611 return need_more_worker(gcwq) && !may_start_working(gcwq);
612}
613
614/* Do I need to be the manager? */
615static bool need_to_manage_workers(struct global_cwq *gcwq)
616{
617 return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS;
618}
619
620/* Do we have too many workers and should some go away? */
621static bool too_many_workers(struct global_cwq *gcwq)
622{
623 bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS;
624 int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */
625 int nr_busy = gcwq->nr_workers - nr_idle;
626
627 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
628}
629
630/*
631 * Wake up functions.
632 */
633
Tejun Heo7e116292010-06-29 10:07:13 +0200634/* Return the first worker. Safe with preemption disabled */
635static struct worker *first_worker(struct global_cwq *gcwq)
636{
637 if (unlikely(list_empty(&gcwq->idle_list)))
638 return NULL;
639
640 return list_first_entry(&gcwq->idle_list, struct worker, entry);
641}
642
643/**
644 * wake_up_worker - wake up an idle worker
645 * @gcwq: gcwq to wake worker for
646 *
647 * Wake up the first idle worker of @gcwq.
648 *
649 * CONTEXT:
650 * spin_lock_irq(gcwq->lock).
651 */
652static void wake_up_worker(struct global_cwq *gcwq)
653{
654 struct worker *worker = first_worker(gcwq);
655
656 if (likely(worker))
657 wake_up_process(worker->task);
658}
659
Tejun Heo4690c4a2010-06-29 10:07:10 +0200660/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200661 * wq_worker_waking_up - a worker is waking up
662 * @task: task waking up
663 * @cpu: CPU @task is waking up to
664 *
665 * This function is called during try_to_wake_up() when a worker is
666 * being awoken.
667 *
668 * CONTEXT:
669 * spin_lock_irq(rq->lock)
670 */
671void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
672{
673 struct worker *worker = kthread_data(task);
674
Steven Rostedt2d646722010-12-03 23:12:33 -0500675 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe22bee72010-06-29 10:07:14 +0200676 atomic_inc(get_gcwq_nr_running(cpu));
677}
678
679/**
680 * wq_worker_sleeping - a worker is going to sleep
681 * @task: task going to sleep
682 * @cpu: CPU in question, must be the current CPU number
683 *
684 * This function is called during schedule() when a busy worker is
685 * going to sleep. Worker on the same cpu can be woken up by
686 * returning pointer to its task.
687 *
688 * CONTEXT:
689 * spin_lock_irq(rq->lock)
690 *
691 * RETURNS:
692 * Worker task on @cpu to wake up, %NULL if none.
693 */
694struct task_struct *wq_worker_sleeping(struct task_struct *task,
695 unsigned int cpu)
696{
697 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
698 struct global_cwq *gcwq = get_gcwq(cpu);
699 atomic_t *nr_running = get_gcwq_nr_running(cpu);
700
Steven Rostedt2d646722010-12-03 23:12:33 -0500701 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200702 return NULL;
703
704 /* this can only happen on the local cpu */
705 BUG_ON(cpu != raw_smp_processor_id());
706
707 /*
708 * The counterpart of the following dec_and_test, implied mb,
709 * worklist not empty test sequence is in insert_work().
710 * Please read comment there.
711 *
712 * NOT_RUNNING is clear. This means that trustee is not in
713 * charge and we're running on the local cpu w/ rq lock held
714 * and preemption disabled, which in turn means that none else
715 * could be manipulating idle_list, so dereferencing idle_list
716 * without gcwq lock is safe.
717 */
718 if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist))
719 to_wakeup = first_worker(gcwq);
720 return to_wakeup ? to_wakeup->task : NULL;
721}
722
723/**
724 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200725 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200726 * @flags: flags to set
727 * @wakeup: wakeup an idle worker if necessary
728 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200729 * Set @flags in @worker->flags and adjust nr_running accordingly. If
730 * nr_running becomes zero and @wakeup is %true, an idle worker is
731 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200732 *
Tejun Heocb444762010-07-02 10:03:50 +0200733 * CONTEXT:
734 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200735 */
736static inline void worker_set_flags(struct worker *worker, unsigned int flags,
737 bool wakeup)
738{
Tejun Heoe22bee72010-06-29 10:07:14 +0200739 struct global_cwq *gcwq = worker->gcwq;
740
Tejun Heocb444762010-07-02 10:03:50 +0200741 WARN_ON_ONCE(worker->task != current);
742
Tejun Heoe22bee72010-06-29 10:07:14 +0200743 /*
744 * If transitioning into NOT_RUNNING, adjust nr_running and
745 * wake up an idle worker as necessary if requested by
746 * @wakeup.
747 */
748 if ((flags & WORKER_NOT_RUNNING) &&
749 !(worker->flags & WORKER_NOT_RUNNING)) {
750 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
751
752 if (wakeup) {
753 if (atomic_dec_and_test(nr_running) &&
754 !list_empty(&gcwq->worklist))
755 wake_up_worker(gcwq);
756 } else
757 atomic_dec(nr_running);
758 }
759
Tejun Heod302f012010-06-29 10:07:13 +0200760 worker->flags |= flags;
761}
762
763/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200764 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200765 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200766 * @flags: flags to clear
767 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200768 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200769 *
Tejun Heocb444762010-07-02 10:03:50 +0200770 * CONTEXT:
771 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200772 */
773static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
774{
Tejun Heoe22bee72010-06-29 10:07:14 +0200775 struct global_cwq *gcwq = worker->gcwq;
776 unsigned int oflags = worker->flags;
777
Tejun Heocb444762010-07-02 10:03:50 +0200778 WARN_ON_ONCE(worker->task != current);
779
Tejun Heod302f012010-06-29 10:07:13 +0200780 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200781
Tejun Heo42c025f2011-01-11 15:58:49 +0100782 /*
783 * If transitioning out of NOT_RUNNING, increment nr_running. Note
784 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
785 * of multiple flags, not a single flag.
786 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200787 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
788 if (!(worker->flags & WORKER_NOT_RUNNING))
789 atomic_inc(get_gcwq_nr_running(gcwq->cpu));
Tejun Heod302f012010-06-29 10:07:13 +0200790}
791
792/**
Tejun Heoc8e55f32010-06-29 10:07:12 +0200793 * busy_worker_head - return the busy hash head for a work
794 * @gcwq: gcwq of interest
795 * @work: work to be hashed
796 *
797 * Return hash head of @gcwq for @work.
798 *
799 * CONTEXT:
800 * spin_lock_irq(gcwq->lock).
801 *
802 * RETURNS:
803 * Pointer to the hash head.
804 */
805static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
806 struct work_struct *work)
807{
808 const int base_shift = ilog2(sizeof(struct work_struct));
809 unsigned long v = (unsigned long)work;
810
811 /* simple shift and fold hash, do we need something better? */
812 v >>= base_shift;
813 v += v >> BUSY_WORKER_HASH_ORDER;
814 v &= BUSY_WORKER_HASH_MASK;
815
816 return &gcwq->busy_hash[v];
817}
818
819/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200820 * __find_worker_executing_work - find worker which is executing a work
821 * @gcwq: gcwq of interest
822 * @bwh: hash head as returned by busy_worker_head()
823 * @work: work to find worker for
824 *
825 * Find a worker which is executing @work on @gcwq. @bwh should be
826 * the hash head obtained by calling busy_worker_head() with the same
827 * work.
828 *
829 * CONTEXT:
830 * spin_lock_irq(gcwq->lock).
831 *
832 * RETURNS:
833 * Pointer to worker which is executing @work if found, NULL
834 * otherwise.
835 */
836static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
837 struct hlist_head *bwh,
838 struct work_struct *work)
839{
840 struct worker *worker;
841 struct hlist_node *tmp;
842
843 hlist_for_each_entry(worker, tmp, bwh, hentry)
844 if (worker->current_work == work)
845 return worker;
846 return NULL;
847}
848
849/**
850 * find_worker_executing_work - find worker which is executing a work
851 * @gcwq: gcwq of interest
852 * @work: work to find worker for
853 *
854 * Find a worker which is executing @work on @gcwq. This function is
855 * identical to __find_worker_executing_work() except that this
856 * function calculates @bwh itself.
857 *
858 * CONTEXT:
859 * spin_lock_irq(gcwq->lock).
860 *
861 * RETURNS:
862 * Pointer to worker which is executing @work if found, NULL
863 * otherwise.
864 */
865static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
866 struct work_struct *work)
867{
868 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
869 work);
870}
871
872/**
Tejun Heo649027d2010-06-29 10:07:14 +0200873 * gcwq_determine_ins_pos - find insertion position
874 * @gcwq: gcwq of interest
875 * @cwq: cwq a work is being queued for
876 *
877 * A work for @cwq is about to be queued on @gcwq, determine insertion
878 * position for the work. If @cwq is for HIGHPRI wq, the work is
879 * queued at the head of the queue but in FIFO order with respect to
880 * other HIGHPRI works; otherwise, at the end of the queue. This
881 * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that
882 * there are HIGHPRI works pending.
883 *
884 * CONTEXT:
885 * spin_lock_irq(gcwq->lock).
886 *
887 * RETURNS:
888 * Pointer to inserstion position.
889 */
890static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq,
891 struct cpu_workqueue_struct *cwq)
892{
893 struct work_struct *twork;
894
895 if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
896 return &gcwq->worklist;
897
898 list_for_each_entry(twork, &gcwq->worklist, entry) {
899 struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
900
901 if (!(tcwq->wq->flags & WQ_HIGHPRI))
902 break;
903 }
904
905 gcwq->flags |= GCWQ_HIGHPRI_PENDING;
906 return &twork->entry;
907}
908
909/**
Tejun Heo7e116292010-06-29 10:07:13 +0200910 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +0200911 * @cwq: cwq @work belongs to
912 * @work: work to insert
913 * @head: insertion point
914 * @extra_flags: extra WORK_STRUCT_* flags to set
915 *
Tejun Heo7e116292010-06-29 10:07:13 +0200916 * Insert @work which belongs to @cwq into @gcwq after @head.
917 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200918 *
919 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +0200920 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +0200921 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700922static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +0200923 struct work_struct *work, struct list_head *head,
924 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700925{
Tejun Heoe22bee72010-06-29 10:07:14 +0200926 struct global_cwq *gcwq = cwq->gcwq;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +0100927
Tejun Heo4690c4a2010-06-29 10:07:10 +0200928 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200929 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +0200930
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700931 /*
932 * Ensure that we get the right work->data if we see the
933 * result of list_add() below, see try_to_grab_pending().
934 */
935 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +0200936
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -0700937 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +0200938
939 /*
940 * Ensure either worker_sched_deactivated() sees the above
941 * list_add_tail() or we see zero nr_running to avoid workers
942 * lying around lazily while there are works to be processed.
943 */
944 smp_mb();
945
Tejun Heo649027d2010-06-29 10:07:14 +0200946 if (__need_more_worker(gcwq))
Tejun Heoe22bee72010-06-29 10:07:14 +0200947 wake_up_worker(gcwq);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700948}
949
Tejun Heoc8efcc22010-12-20 19:32:04 +0100950/*
951 * Test whether @work is being queued from another work executing on the
952 * same workqueue. This is rather expensive and should only be used from
953 * cold paths.
954 */
955static bool is_chained_work(struct workqueue_struct *wq)
956{
957 unsigned long flags;
958 unsigned int cpu;
959
960 for_each_gcwq_cpu(cpu) {
961 struct global_cwq *gcwq = get_gcwq(cpu);
962 struct worker *worker;
963 struct hlist_node *pos;
964 int i;
965
966 spin_lock_irqsave(&gcwq->lock, flags);
967 for_each_busy_worker(worker, i, pos, gcwq) {
968 if (worker->task != current)
969 continue;
970 spin_unlock_irqrestore(&gcwq->lock, flags);
971 /*
972 * I'm @worker, no locking necessary. See if @work
973 * is headed to the same workqueue.
974 */
975 return worker->current_cwq->wq == wq;
976 }
977 spin_unlock_irqrestore(&gcwq->lock, flags);
978 }
979 return false;
980}
981
Tejun Heo4690c4a2010-06-29 10:07:10 +0200982static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 struct work_struct *work)
984{
Tejun Heo502ca9d2010-06-29 10:07:13 +0200985 struct global_cwq *gcwq;
986 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200987 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +0200988 unsigned int work_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 unsigned long flags;
990
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900991 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200992
Tejun Heoc8efcc22010-12-20 19:32:04 +0100993 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200994 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +0100995 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +0200996 return;
997
Tejun Heoc7fc77f2010-07-02 10:03:51 +0200998 /* determine gcwq to use */
999 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001000 struct global_cwq *last_gcwq;
1001
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001002 if (unlikely(cpu == WORK_CPU_UNBOUND))
1003 cpu = raw_smp_processor_id();
1004
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001005 /*
1006 * It's multi cpu. If @wq is non-reentrant and @work
1007 * was previously on a different cpu, it might still
1008 * be running there, in which case the work needs to
1009 * be queued on that cpu to guarantee non-reentrance.
1010 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001011 gcwq = get_gcwq(cpu);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001012 if (wq->flags & WQ_NON_REENTRANT &&
1013 (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
1014 struct worker *worker;
1015
1016 spin_lock_irqsave(&last_gcwq->lock, flags);
1017
1018 worker = find_worker_executing_work(last_gcwq, work);
1019
1020 if (worker && worker->current_cwq->wq == wq)
1021 gcwq = last_gcwq;
1022 else {
1023 /* meh... not running there, queue here */
1024 spin_unlock_irqrestore(&last_gcwq->lock, flags);
1025 spin_lock_irqsave(&gcwq->lock, flags);
1026 }
1027 } else
1028 spin_lock_irqsave(&gcwq->lock, flags);
Tejun Heof3421792010-07-02 10:03:51 +02001029 } else {
1030 gcwq = get_gcwq(WORK_CPU_UNBOUND);
1031 spin_lock_irqsave(&gcwq->lock, flags);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001032 }
1033
1034 /* gcwq determined, get cwq and queue */
1035 cwq = get_cwq(gcwq->cpu, wq);
Tejun Heocdadf002010-10-05 10:49:55 +02001036 trace_workqueue_queue_work(cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001037
Tejun Heo4690c4a2010-06-29 10:07:10 +02001038 BUG_ON(!list_empty(&work->entry));
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001039
Tejun Heo73f53c42010-06-29 10:07:11 +02001040 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001041 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001042
1043 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001044 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001045 cwq->nr_active++;
Tejun Heo649027d2010-06-29 10:07:14 +02001046 worklist = gcwq_determine_ins_pos(gcwq, cwq);
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001047 } else {
1048 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001049 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001050 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001051
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001052 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001053
Tejun Heo8b03ae32010-06-29 10:07:12 +02001054 spin_unlock_irqrestore(&gcwq->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055}
1056
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001057/**
1058 * queue_work - queue work on a workqueue
1059 * @wq: workqueue to use
1060 * @work: work to queue
1061 *
Alan Stern057647f2006-10-28 10:38:58 -07001062 * Returns 0 if @work was already on a queue, non-zero otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 *
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07001064 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1065 * it can be processed by another CPU.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001067int queue_work(struct workqueue_struct *wq, struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068{
Oleg Nesterovef1ca232008-07-25 01:47:53 -07001069 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070
Oleg Nesterovef1ca232008-07-25 01:47:53 -07001071 ret = queue_work_on(get_cpu(), wq, work);
1072 put_cpu();
1073
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 return ret;
1075}
Dave Jonesae90dd52006-06-30 01:40:45 -04001076EXPORT_SYMBOL_GPL(queue_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077
Zhang Ruic1a220e2008-07-23 21:28:39 -07001078/**
1079 * queue_work_on - queue work on specific cpu
1080 * @cpu: CPU number to execute work on
1081 * @wq: workqueue to use
1082 * @work: work to queue
1083 *
1084 * Returns 0 if @work was already on a queue, non-zero otherwise.
1085 *
1086 * We queue the work to a specific CPU, the caller must ensure it
1087 * can't go away.
1088 */
1089int
1090queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1091{
1092 int ret = 0;
1093
Tejun Heo22df02b2010-06-29 10:07:10 +02001094 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001095 __queue_work(cpu, wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001096 ret = 1;
1097 }
1098 return ret;
1099}
1100EXPORT_SYMBOL_GPL(queue_work_on);
1101
Li Zefan6d141c32008-02-08 04:21:09 -08001102static void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103{
David Howells52bad642006-11-22 14:54:01 +00001104 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001105 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106
Srinivasarao Pb6e586c2013-09-18 14:33:45 +05301107 if (cwq != NULL)
1108 __queue_work(smp_processor_id(), cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109}
1110
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001111/**
1112 * queue_delayed_work - queue work on a workqueue after delay
1113 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001114 * @dwork: delayable work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001115 * @delay: number of jiffies to wait before queueing
1116 *
Alan Stern057647f2006-10-28 10:38:58 -07001117 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001118 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001119int queue_delayed_work(struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +00001120 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121{
David Howells52bad642006-11-22 14:54:01 +00001122 if (delay == 0)
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001123 return queue_work(wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001125 return queue_delayed_work_on(-1, wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126}
Dave Jonesae90dd52006-06-30 01:40:45 -04001127EXPORT_SYMBOL_GPL(queue_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001129/**
1130 * queue_delayed_work_on - queue work on specific CPU after delay
1131 * @cpu: CPU number to execute work on
1132 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001133 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001134 * @delay: number of jiffies to wait before queueing
1135 *
Alan Stern057647f2006-10-28 10:38:58 -07001136 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001137 */
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001138int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +00001139 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001140{
1141 int ret = 0;
David Howells52bad642006-11-22 14:54:01 +00001142 struct timer_list *timer = &dwork->timer;
1143 struct work_struct *work = &dwork->work;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001144
Tejun Heo22df02b2010-06-29 10:07:10 +02001145 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001146 unsigned int lcpu;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001147
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001148 BUG_ON(timer_pending(timer));
1149 BUG_ON(!list_empty(&work->entry));
1150
Andrew Liu8a3e77c2008-05-01 04:35:14 -07001151 timer_stats_timer_set_start_info(&dwork->timer);
1152
Tejun Heo7a22ad72010-06-29 10:07:13 +02001153 /*
1154 * This stores cwq for the moment, for the timer_fn.
1155 * Note that the work's gcwq is preserved to allow
1156 * reentrance detection for delayed works.
1157 */
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001158 if (!(wq->flags & WQ_UNBOUND)) {
1159 struct global_cwq *gcwq = get_work_gcwq(work);
1160
1161 if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1162 lcpu = gcwq->cpu;
1163 else
1164 lcpu = raw_smp_processor_id();
1165 } else
1166 lcpu = WORK_CPU_UNBOUND;
1167
Tejun Heo7a22ad72010-06-29 10:07:13 +02001168 set_work_cwq(work, get_cwq(lcpu, wq), 0);
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001169
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001170 timer->expires = jiffies + delay;
David Howells52bad642006-11-22 14:54:01 +00001171 timer->data = (unsigned long)dwork;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001172 timer->function = delayed_work_timer_fn;
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001173
1174 if (unlikely(cpu >= 0))
1175 add_timer_on(timer, cpu);
1176 else
1177 add_timer(timer);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001178 ret = 1;
1179 }
1180 return ret;
1181}
Dave Jonesae90dd52006-06-30 01:40:45 -04001182EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183
Tejun Heoc8e55f32010-06-29 10:07:12 +02001184/**
1185 * worker_enter_idle - enter idle state
1186 * @worker: worker which is entering idle state
1187 *
1188 * @worker is entering idle state. Update stats and idle timer if
1189 * necessary.
1190 *
1191 * LOCKING:
1192 * spin_lock_irq(gcwq->lock).
1193 */
1194static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195{
Tejun Heoc8e55f32010-06-29 10:07:12 +02001196 struct global_cwq *gcwq = worker->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197
Tejun Heoc8e55f32010-06-29 10:07:12 +02001198 BUG_ON(worker->flags & WORKER_IDLE);
1199 BUG_ON(!list_empty(&worker->entry) &&
1200 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201
Tejun Heocb444762010-07-02 10:03:50 +02001202 /* can't use worker_set_flags(), also called from start_worker() */
1203 worker->flags |= WORKER_IDLE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001204 gcwq->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001205 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001206
Tejun Heoc8e55f32010-06-29 10:07:12 +02001207 /* idle_list is LIFO */
1208 list_add(&worker->entry, &gcwq->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001209
Tejun Heoe22bee72010-06-29 10:07:14 +02001210 if (likely(!(worker->flags & WORKER_ROGUE))) {
1211 if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer))
1212 mod_timer(&gcwq->idle_timer,
1213 jiffies + IDLE_WORKER_TIMEOUT);
1214 } else
Tejun Heodb7bccf2010-06-29 10:07:12 +02001215 wake_up_all(&gcwq->trustee_wait);
Tejun Heocb444762010-07-02 10:03:50 +02001216
Devin Kim82bf5d32012-10-29 15:17:31 -07001217 /*
1218 * Sanity check nr_running. Because trustee releases gcwq->lock
1219 * between setting %WORKER_ROGUE and zapping nr_running, the
1220 * warning may trigger spuriously. Check iff trustee is idle.
1221 */
1222 WARN_ON_ONCE(gcwq->trustee_state == TRUSTEE_DONE &&
1223 gcwq->nr_workers == gcwq->nr_idle &&
Tejun Heocb444762010-07-02 10:03:50 +02001224 atomic_read(get_gcwq_nr_running(gcwq->cpu)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225}
1226
Tejun Heoc8e55f32010-06-29 10:07:12 +02001227/**
1228 * worker_leave_idle - leave idle state
1229 * @worker: worker which is leaving idle state
1230 *
1231 * @worker is leaving idle state. Update stats.
1232 *
1233 * LOCKING:
1234 * spin_lock_irq(gcwq->lock).
1235 */
1236static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237{
Tejun Heoc8e55f32010-06-29 10:07:12 +02001238 struct global_cwq *gcwq = worker->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239
Tejun Heoc8e55f32010-06-29 10:07:12 +02001240 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001241 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001242 gcwq->nr_idle--;
1243 list_del_init(&worker->entry);
1244}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245
Tejun Heoe22bee72010-06-29 10:07:14 +02001246/**
1247 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1248 * @worker: self
1249 *
1250 * Works which are scheduled while the cpu is online must at least be
1251 * scheduled to a worker which is bound to the cpu so that if they are
1252 * flushed from cpu callbacks while cpu is going down, they are
1253 * guaranteed to execute on the cpu.
1254 *
1255 * This function is to be used by rogue workers and rescuers to bind
1256 * themselves to the target cpu and may race with cpu going down or
1257 * coming online. kthread_bind() can't be used because it may put the
1258 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1259 * verbatim as it's best effort and blocking and gcwq may be
1260 * [dis]associated in the meantime.
1261 *
1262 * This function tries set_cpus_allowed() and locks gcwq and verifies
1263 * the binding against GCWQ_DISASSOCIATED which is set during
1264 * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
1265 * idle state or fetches works without dropping lock, it can guarantee
1266 * the scheduling requirement described in the first paragraph.
1267 *
1268 * CONTEXT:
1269 * Might sleep. Called without any lock but returns with gcwq->lock
1270 * held.
1271 *
1272 * RETURNS:
1273 * %true if the associated gcwq is online (@worker is successfully
1274 * bound), %false if offline.
1275 */
1276static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001277__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001278{
1279 struct global_cwq *gcwq = worker->gcwq;
1280 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281
Tejun Heoe22bee72010-06-29 10:07:14 +02001282 while (true) {
1283 /*
1284 * The following call may fail, succeed or succeed
1285 * without actually migrating the task to the cpu if
1286 * it races with cpu hotunplug operation. Verify
1287 * against GCWQ_DISASSOCIATED.
1288 */
Tejun Heof3421792010-07-02 10:03:51 +02001289 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1290 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001291
Tejun Heoe22bee72010-06-29 10:07:14 +02001292 spin_lock_irq(&gcwq->lock);
1293 if (gcwq->flags & GCWQ_DISASSOCIATED)
1294 return false;
1295 if (task_cpu(task) == gcwq->cpu &&
1296 cpumask_equal(&current->cpus_allowed,
1297 get_cpu_mask(gcwq->cpu)))
1298 return true;
1299 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001300
Tejun Heo5035b202011-04-29 18:08:37 +02001301 /*
1302 * We've raced with CPU hot[un]plug. Give it a breather
1303 * and retry migration. cond_resched() is required here;
1304 * otherwise, we might deadlock against cpu_stop trying to
1305 * bring down the CPU on non-preemptive kernel.
1306 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001307 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001308 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001309 }
1310}
1311
1312/*
1313 * Function for worker->rebind_work used to rebind rogue busy workers
1314 * to the associated cpu which is coming back online. This is
1315 * scheduled by cpu up but can race with other cpu hotplug operations
1316 * and may be executed twice without intervening cpu down.
1317 */
1318static void worker_rebind_fn(struct work_struct *work)
1319{
1320 struct worker *worker = container_of(work, struct worker, rebind_work);
1321 struct global_cwq *gcwq = worker->gcwq;
1322
1323 if (worker_maybe_bind_and_lock(worker))
1324 worker_clr_flags(worker, WORKER_REBIND);
1325
1326 spin_unlock_irq(&gcwq->lock);
1327}
1328
Tejun Heoc34056a2010-06-29 10:07:11 +02001329static struct worker *alloc_worker(void)
1330{
1331 struct worker *worker;
1332
1333 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001334 if (worker) {
1335 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001336 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heoe22bee72010-06-29 10:07:14 +02001337 INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1338 /* on creation a worker is in !idle && prep state */
1339 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001340 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001341 return worker;
1342}
1343
1344/**
1345 * create_worker - create a new workqueue worker
Tejun Heo7e116292010-06-29 10:07:13 +02001346 * @gcwq: gcwq the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001347 * @bind: whether to set affinity to @cpu or not
1348 *
Tejun Heo7e116292010-06-29 10:07:13 +02001349 * Create a new worker which is bound to @gcwq. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001350 * can be started by calling start_worker() or destroyed using
1351 * destroy_worker().
1352 *
1353 * CONTEXT:
1354 * Might sleep. Does GFP_KERNEL allocations.
1355 *
1356 * RETURNS:
1357 * Pointer to the newly created worker.
1358 */
Tejun Heo7e116292010-06-29 10:07:13 +02001359static struct worker *create_worker(struct global_cwq *gcwq, bool bind)
Tejun Heoc34056a2010-06-29 10:07:11 +02001360{
Tejun Heof3421792010-07-02 10:03:51 +02001361 bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
Tejun Heoc34056a2010-06-29 10:07:11 +02001362 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001363 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001364
Tejun Heo8b03ae32010-06-29 10:07:12 +02001365 spin_lock_irq(&gcwq->lock);
1366 while (ida_get_new(&gcwq->worker_ida, &id)) {
1367 spin_unlock_irq(&gcwq->lock);
1368 if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001369 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001370 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001371 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001372 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001373
1374 worker = alloc_worker();
1375 if (!worker)
1376 goto fail;
1377
Tejun Heo8b03ae32010-06-29 10:07:12 +02001378 worker->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001379 worker->id = id;
1380
Tejun Heof3421792010-07-02 10:03:51 +02001381 if (!on_unbound_cpu)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001382 worker->task = kthread_create_on_node(worker_thread,
1383 worker,
1384 cpu_to_node(gcwq->cpu),
1385 "kworker/%u:%d", gcwq->cpu, id);
Tejun Heof3421792010-07-02 10:03:51 +02001386 else
1387 worker->task = kthread_create(worker_thread, worker,
1388 "kworker/u:%d", id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001389 if (IS_ERR(worker->task))
1390 goto fail;
1391
Tejun Heodb7bccf2010-06-29 10:07:12 +02001392 /*
1393 * A rogue worker will become a regular one if CPU comes
1394 * online later on. Make sure every worker has
1395 * PF_THREAD_BOUND set.
1396 */
Tejun Heof3421792010-07-02 10:03:51 +02001397 if (bind && !on_unbound_cpu)
Tejun Heo8b03ae32010-06-29 10:07:12 +02001398 kthread_bind(worker->task, gcwq->cpu);
Tejun Heof3421792010-07-02 10:03:51 +02001399 else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001400 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heof3421792010-07-02 10:03:51 +02001401 if (on_unbound_cpu)
1402 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001404
Tejun Heoc34056a2010-06-29 10:07:11 +02001405 return worker;
1406fail:
1407 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001408 spin_lock_irq(&gcwq->lock);
1409 ida_remove(&gcwq->worker_ida, id);
1410 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001411 }
1412 kfree(worker);
1413 return NULL;
1414}
1415
1416/**
1417 * start_worker - start a newly created worker
1418 * @worker: worker to start
1419 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001420 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001421 *
1422 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001423 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001424 */
1425static void start_worker(struct worker *worker)
1426{
Tejun Heocb444762010-07-02 10:03:50 +02001427 worker->flags |= WORKER_STARTED;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001428 worker->gcwq->nr_workers++;
1429 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001430 wake_up_process(worker->task);
1431}
1432
1433/**
1434 * destroy_worker - destroy a workqueue worker
1435 * @worker: worker to be destroyed
1436 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001437 * Destroy @worker and adjust @gcwq stats accordingly.
1438 *
1439 * CONTEXT:
1440 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001441 */
1442static void destroy_worker(struct worker *worker)
1443{
Tejun Heo8b03ae32010-06-29 10:07:12 +02001444 struct global_cwq *gcwq = worker->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001445 int id = worker->id;
1446
1447 /* sanity check frenzy */
1448 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001449 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001450
Tejun Heoc8e55f32010-06-29 10:07:12 +02001451 if (worker->flags & WORKER_STARTED)
1452 gcwq->nr_workers--;
1453 if (worker->flags & WORKER_IDLE)
1454 gcwq->nr_idle--;
1455
1456 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001457 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001458
1459 spin_unlock_irq(&gcwq->lock);
1460
Tejun Heoc34056a2010-06-29 10:07:11 +02001461 kthread_stop(worker->task);
1462 kfree(worker);
1463
Tejun Heo8b03ae32010-06-29 10:07:12 +02001464 spin_lock_irq(&gcwq->lock);
1465 ida_remove(&gcwq->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001466}
1467
Tejun Heoe22bee72010-06-29 10:07:14 +02001468static void idle_worker_timeout(unsigned long __gcwq)
1469{
1470 struct global_cwq *gcwq = (void *)__gcwq;
1471
1472 spin_lock_irq(&gcwq->lock);
1473
1474 if (too_many_workers(gcwq)) {
1475 struct worker *worker;
1476 unsigned long expires;
1477
1478 /* idle_list is kept in LIFO order, check the last one */
1479 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1480 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1481
1482 if (time_before(jiffies, expires))
1483 mod_timer(&gcwq->idle_timer, expires);
1484 else {
1485 /* it's been idle for too long, wake up manager */
1486 gcwq->flags |= GCWQ_MANAGE_WORKERS;
1487 wake_up_worker(gcwq);
1488 }
1489 }
1490
1491 spin_unlock_irq(&gcwq->lock);
1492}
1493
1494static bool send_mayday(struct work_struct *work)
1495{
1496 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1497 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001498 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001499
1500 if (!(wq->flags & WQ_RESCUER))
1501 return false;
1502
1503 /* mayday mayday mayday */
Tejun Heof3421792010-07-02 10:03:51 +02001504 cpu = cwq->gcwq->cpu;
1505 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1506 if (cpu == WORK_CPU_UNBOUND)
1507 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001508 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001509 wake_up_process(wq->rescuer->task);
1510 return true;
1511}
1512
1513static void gcwq_mayday_timeout(unsigned long __gcwq)
1514{
1515 struct global_cwq *gcwq = (void *)__gcwq;
1516 struct work_struct *work;
1517
1518 spin_lock_irq(&gcwq->lock);
1519
1520 if (need_to_create_worker(gcwq)) {
1521 /*
1522 * We've been trying to create a new worker but
1523 * haven't been successful. We might be hitting an
1524 * allocation deadlock. Send distress signals to
1525 * rescuers.
1526 */
1527 list_for_each_entry(work, &gcwq->worklist, entry)
1528 send_mayday(work);
1529 }
1530
1531 spin_unlock_irq(&gcwq->lock);
1532
1533 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL);
1534}
1535
1536/**
1537 * maybe_create_worker - create a new worker if necessary
1538 * @gcwq: gcwq to create a new worker for
1539 *
1540 * Create a new worker for @gcwq if necessary. @gcwq is guaranteed to
1541 * have at least one idle worker on return from this function. If
1542 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1543 * sent to all rescuers with works scheduled on @gcwq to resolve
1544 * possible allocation deadlock.
1545 *
1546 * On return, need_to_create_worker() is guaranteed to be false and
1547 * may_start_working() true.
1548 *
1549 * LOCKING:
1550 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1551 * multiple times. Does GFP_KERNEL allocations. Called only from
1552 * manager.
1553 *
1554 * RETURNS:
1555 * false if no action was taken and gcwq->lock stayed locked, true
1556 * otherwise.
1557 */
1558static bool maybe_create_worker(struct global_cwq *gcwq)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001559__releases(&gcwq->lock)
1560__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001561{
1562 if (!need_to_create_worker(gcwq))
1563 return false;
1564restart:
Tejun Heo9f9c2362010-07-14 11:31:20 +02001565 spin_unlock_irq(&gcwq->lock);
1566
Tejun Heoe22bee72010-06-29 10:07:14 +02001567 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1568 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1569
1570 while (true) {
1571 struct worker *worker;
1572
Tejun Heoe22bee72010-06-29 10:07:14 +02001573 worker = create_worker(gcwq, true);
1574 if (worker) {
1575 del_timer_sync(&gcwq->mayday_timer);
1576 spin_lock_irq(&gcwq->lock);
1577 start_worker(worker);
1578 BUG_ON(need_to_create_worker(gcwq));
1579 return true;
1580 }
1581
1582 if (!need_to_create_worker(gcwq))
1583 break;
1584
Tejun Heoe22bee72010-06-29 10:07:14 +02001585 __set_current_state(TASK_INTERRUPTIBLE);
1586 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001587
Tejun Heoe22bee72010-06-29 10:07:14 +02001588 if (!need_to_create_worker(gcwq))
1589 break;
1590 }
1591
Tejun Heoe22bee72010-06-29 10:07:14 +02001592 del_timer_sync(&gcwq->mayday_timer);
1593 spin_lock_irq(&gcwq->lock);
1594 if (need_to_create_worker(gcwq))
1595 goto restart;
1596 return true;
1597}
1598
1599/**
1600 * maybe_destroy_worker - destroy workers which have been idle for a while
1601 * @gcwq: gcwq to destroy workers for
1602 *
1603 * Destroy @gcwq workers which have been idle for longer than
1604 * IDLE_WORKER_TIMEOUT.
1605 *
1606 * LOCKING:
1607 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1608 * multiple times. Called only from manager.
1609 *
1610 * RETURNS:
1611 * false if no action was taken and gcwq->lock stayed locked, true
1612 * otherwise.
1613 */
1614static bool maybe_destroy_workers(struct global_cwq *gcwq)
1615{
1616 bool ret = false;
1617
1618 while (too_many_workers(gcwq)) {
1619 struct worker *worker;
1620 unsigned long expires;
1621
1622 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1623 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1624
1625 if (time_before(jiffies, expires)) {
1626 mod_timer(&gcwq->idle_timer, expires);
1627 break;
1628 }
1629
1630 destroy_worker(worker);
1631 ret = true;
1632 }
1633
1634 return ret;
1635}
1636
1637/**
1638 * manage_workers - manage worker pool
1639 * @worker: self
1640 *
1641 * Assume the manager role and manage gcwq worker pool @worker belongs
1642 * to. At any given time, there can be only zero or one manager per
1643 * gcwq. The exclusion is handled automatically by this function.
1644 *
1645 * The caller can safely start processing works on false return. On
1646 * true return, it's guaranteed that need_to_create_worker() is false
1647 * and may_start_working() is true.
1648 *
1649 * CONTEXT:
1650 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1651 * multiple times. Does GFP_KERNEL allocations.
1652 *
1653 * RETURNS:
1654 * false if no action was taken and gcwq->lock stayed locked, true if
1655 * some action was taken.
1656 */
1657static bool manage_workers(struct worker *worker)
1658{
1659 struct global_cwq *gcwq = worker->gcwq;
1660 bool ret = false;
1661
1662 if (gcwq->flags & GCWQ_MANAGING_WORKERS)
1663 return ret;
1664
1665 gcwq->flags &= ~GCWQ_MANAGE_WORKERS;
1666 gcwq->flags |= GCWQ_MANAGING_WORKERS;
1667
1668 /*
1669 * Destroy and then create so that may_start_working() is true
1670 * on return.
1671 */
1672 ret |= maybe_destroy_workers(gcwq);
1673 ret |= maybe_create_worker(gcwq);
1674
1675 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
1676
1677 /*
1678 * The trustee might be waiting to take over the manager
1679 * position, tell it we're done.
1680 */
1681 if (unlikely(gcwq->trustee))
1682 wake_up_all(&gcwq->trustee_wait);
1683
1684 return ret;
1685}
1686
Tejun Heoa62428c2010-06-29 10:07:10 +02001687/**
Tejun Heoaffee4b2010-06-29 10:07:12 +02001688 * move_linked_works - move linked works to a list
1689 * @work: start of series of works to be scheduled
1690 * @head: target list to append @work to
1691 * @nextp: out paramter for nested worklist walking
1692 *
1693 * Schedule linked works starting from @work to @head. Work series to
1694 * be scheduled starts at @work and includes any consecutive work with
1695 * WORK_STRUCT_LINKED set in its predecessor.
1696 *
1697 * If @nextp is not NULL, it's updated to point to the next work of
1698 * the last scheduled work. This allows move_linked_works() to be
1699 * nested inside outer list_for_each_entry_safe().
1700 *
1701 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001702 * spin_lock_irq(gcwq->lock).
Tejun Heoaffee4b2010-06-29 10:07:12 +02001703 */
1704static void move_linked_works(struct work_struct *work, struct list_head *head,
1705 struct work_struct **nextp)
1706{
1707 struct work_struct *n;
1708
1709 /*
1710 * Linked worklist will always end before the end of the list,
1711 * use NULL for list head.
1712 */
1713 list_for_each_entry_safe_from(work, n, NULL, entry) {
1714 list_move_tail(&work->entry, head);
1715 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1716 break;
1717 }
1718
1719 /*
1720 * If we're already inside safe list traversal and have moved
1721 * multiple works to the scheduled queue, the next position
1722 * needs to be updated.
1723 */
1724 if (nextp)
1725 *nextp = n;
1726}
1727
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001728static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
1729{
1730 struct work_struct *work = list_first_entry(&cwq->delayed_works,
1731 struct work_struct, entry);
Tejun Heo649027d2010-06-29 10:07:14 +02001732 struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001733
Tejun Heocdadf002010-10-05 10:49:55 +02001734 trace_workqueue_activate_work(work);
Tejun Heo649027d2010-06-29 10:07:14 +02001735 move_linked_works(work, pos, NULL);
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001736 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001737 cwq->nr_active++;
1738}
1739
Tejun Heoaffee4b2010-06-29 10:07:12 +02001740/**
Tejun Heo73f53c42010-06-29 10:07:11 +02001741 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1742 * @cwq: cwq of interest
1743 * @color: color of work which left the queue
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001744 * @delayed: for a delayed work
Tejun Heo73f53c42010-06-29 10:07:11 +02001745 *
1746 * A work either has completed or is removed from pending queue,
1747 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1748 *
1749 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001750 * spin_lock_irq(gcwq->lock).
Tejun Heo73f53c42010-06-29 10:07:11 +02001751 */
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001752static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
1753 bool delayed)
Tejun Heo73f53c42010-06-29 10:07:11 +02001754{
1755 /* ignore uncolored works */
1756 if (color == WORK_NO_COLOR)
1757 return;
1758
1759 cwq->nr_in_flight[color]--;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001760
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001761 if (!delayed) {
1762 cwq->nr_active--;
1763 if (!list_empty(&cwq->delayed_works)) {
1764 /* one down, submit a delayed one */
1765 if (cwq->nr_active < cwq->max_active)
1766 cwq_activate_first_delayed(cwq);
1767 }
Tejun Heo502ca9d2010-06-29 10:07:13 +02001768 }
Tejun Heo73f53c42010-06-29 10:07:11 +02001769
1770 /* is flush in progress and are we at the flushing tip? */
1771 if (likely(cwq->flush_color != color))
1772 return;
1773
1774 /* are there still in-flight works? */
1775 if (cwq->nr_in_flight[color])
1776 return;
1777
1778 /* this cwq is done, clear flush_color */
1779 cwq->flush_color = -1;
1780
1781 /*
1782 * If this was the last cwq, wake up the first flusher. It
1783 * will handle the rest.
1784 */
1785 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1786 complete(&cwq->wq->first_flusher->done);
1787}
1788
1789/**
Tejun Heoa62428c2010-06-29 10:07:10 +02001790 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001791 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001792 * @work: work to process
1793 *
1794 * Process @work. This function contains all the logics necessary to
1795 * process a single work including synchronization against and
1796 * interaction with other workers on the same cpu, queueing and
1797 * flushing. As long as context requirement is met, any worker can
1798 * call this function to process a work.
1799 *
1800 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001801 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02001802 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001803static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001804__releases(&gcwq->lock)
1805__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02001806{
Tejun Heo7e116292010-06-29 10:07:13 +02001807 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001808 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001809 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heofb0e7be2010-06-29 10:07:15 +02001810 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02001811 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02001812 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02001813 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02001814#ifdef CONFIG_LOCKDEP
1815 /*
1816 * It is permissible to free the struct work_struct from
1817 * inside the function that is called from it, this we need to
1818 * take into account for lockdep too. To avoid bogus "held
1819 * lock freed" warnings as well as problems when looking into
1820 * work->lockdep_map, make a copy and use that here.
1821 */
1822 struct lockdep_map lockdep_map = work->lockdep_map;
1823#endif
Tejun Heo7e116292010-06-29 10:07:13 +02001824 /*
1825 * A single work shouldn't be executed concurrently by
1826 * multiple workers on a single cpu. Check whether anyone is
1827 * already processing the work. If so, defer the work to the
1828 * currently executing one.
1829 */
1830 collision = __find_worker_executing_work(gcwq, bwh, work);
1831 if (unlikely(collision)) {
1832 move_linked_works(work, &collision->scheduled, NULL);
1833 return;
1834 }
1835
Tejun Heoa62428c2010-06-29 10:07:10 +02001836 /* claim and process */
Tejun Heoa62428c2010-06-29 10:07:10 +02001837 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001838 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02001839 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001840 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001841 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001842
Tejun Heo7a22ad72010-06-29 10:07:13 +02001843 /* record the current cpu number in the work data and dequeue */
1844 set_work_cpu(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02001845 list_del_init(&work->entry);
1846
Tejun Heo649027d2010-06-29 10:07:14 +02001847 /*
1848 * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
1849 * wake up another worker; otherwise, clear HIGHPRI_PENDING.
1850 */
1851 if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) {
1852 struct work_struct *nwork = list_first_entry(&gcwq->worklist,
1853 struct work_struct, entry);
1854
1855 if (!list_empty(&gcwq->worklist) &&
1856 get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
1857 wake_up_worker(gcwq);
1858 else
1859 gcwq->flags &= ~GCWQ_HIGHPRI_PENDING;
1860 }
1861
Tejun Heofb0e7be2010-06-29 10:07:15 +02001862 /*
1863 * CPU intensive works don't participate in concurrency
1864 * management. They're the scheduler's responsibility.
1865 */
1866 if (unlikely(cpu_intensive))
1867 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1868
Tejun Heo8b03ae32010-06-29 10:07:12 +02001869 spin_unlock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001870
Tejun Heoa62428c2010-06-29 10:07:10 +02001871 work_clear_pending(work);
Tejun Heoe1594892011-01-09 23:32:15 +01001872 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02001873 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07001874 trace_workqueue_execute_start(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02001875 f(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07001876 /*
1877 * While we must be careful to not use "work" after this, the trace
1878 * point will only record its address.
1879 */
1880 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02001881 lock_map_release(&lockdep_map);
1882 lock_map_release(&cwq->wq->lockdep_map);
1883
1884 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1885 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1886 "%s/0x%08x/%d\n",
1887 current->comm, preempt_count(), task_pid_nr(current));
1888 printk(KERN_ERR " last function: ");
1889 print_symbol("%s\n", (unsigned long)f);
1890 debug_show_held_locks(current);
1891 dump_stack();
1892 }
1893
Tejun Heo8b03ae32010-06-29 10:07:12 +02001894 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001895
Tejun Heofb0e7be2010-06-29 10:07:15 +02001896 /* clear cpu intensive status */
1897 if (unlikely(cpu_intensive))
1898 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1899
Tejun Heoa62428c2010-06-29 10:07:10 +02001900 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02001901 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001902 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001903 worker->current_cwq = NULL;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001904 cwq_dec_nr_in_flight(cwq, work_color, false);
Tejun Heoa62428c2010-06-29 10:07:10 +02001905}
1906
Tejun Heoaffee4b2010-06-29 10:07:12 +02001907/**
1908 * process_scheduled_works - process scheduled works
1909 * @worker: self
1910 *
1911 * Process all scheduled works. Please note that the scheduled list
1912 * may change while processing a work, so this function repeatedly
1913 * fetches a work from the top and executes it.
1914 *
1915 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001916 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02001917 * multiple times.
1918 */
1919static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920{
Tejun Heoaffee4b2010-06-29 10:07:12 +02001921 while (!list_empty(&worker->scheduled)) {
1922 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001924 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926}
1927
Tejun Heo4690c4a2010-06-29 10:07:10 +02001928/**
1929 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02001930 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02001931 *
Tejun Heoe22bee72010-06-29 10:07:14 +02001932 * The gcwq worker thread function. There's a single dynamic pool of
1933 * these per each cpu. These workers process all works regardless of
1934 * their specific target workqueue. The only exception is works which
1935 * belong to workqueues with a rescuer which will be explained in
1936 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02001937 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001938static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939{
Tejun Heoc34056a2010-06-29 10:07:11 +02001940 struct worker *worker = __worker;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001941 struct global_cwq *gcwq = worker->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942
Tejun Heoe22bee72010-06-29 10:07:14 +02001943 /* tell the scheduler that this is a workqueue worker */
1944 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001945woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02001946 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947
Tejun Heoc8e55f32010-06-29 10:07:12 +02001948 /* DIE can be set only while we're idle, checking here is enough */
1949 if (worker->flags & WORKER_DIE) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001950 spin_unlock_irq(&gcwq->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001951 worker->task->flags &= ~PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001952 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 }
1954
Tejun Heoc8e55f32010-06-29 10:07:12 +02001955 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001956recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02001957 /* no more worker necessary? */
1958 if (!need_more_worker(gcwq))
1959 goto sleep;
1960
1961 /* do we need to manage? */
1962 if (unlikely(!may_start_working(gcwq)) && manage_workers(worker))
1963 goto recheck;
1964
Tejun Heoc8e55f32010-06-29 10:07:12 +02001965 /*
1966 * ->scheduled list can only be filled while a worker is
1967 * preparing to process a work or actually processing it.
1968 * Make sure nobody diddled with it while I was sleeping.
1969 */
1970 BUG_ON(!list_empty(&worker->scheduled));
1971
Tejun Heoe22bee72010-06-29 10:07:14 +02001972 /*
1973 * When control reaches this point, we're guaranteed to have
1974 * at least one idle worker or that someone else has already
1975 * assumed the manager role.
1976 */
1977 worker_clr_flags(worker, WORKER_PREP);
1978
1979 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02001980 struct work_struct *work =
Tejun Heo7e116292010-06-29 10:07:13 +02001981 list_first_entry(&gcwq->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02001982 struct work_struct, entry);
1983
1984 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1985 /* optimization path, not strictly necessary */
1986 process_one_work(worker, work);
1987 if (unlikely(!list_empty(&worker->scheduled)))
1988 process_scheduled_works(worker);
1989 } else {
1990 move_linked_works(work, &worker->scheduled, NULL);
1991 process_scheduled_works(worker);
1992 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001993 } while (keep_working(gcwq));
Tejun Heoc8e55f32010-06-29 10:07:12 +02001994
Tejun Heoe22bee72010-06-29 10:07:14 +02001995 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02001996sleep:
Tejun Heoe22bee72010-06-29 10:07:14 +02001997 if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker))
1998 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02001999
Tejun Heoc8e55f32010-06-29 10:07:12 +02002000 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02002001 * gcwq->lock is held and there's no work to process and no
2002 * need to manage, sleep. Workers are woken up only while
2003 * holding gcwq->lock or from local cpu, so setting the
2004 * current state before releasing gcwq->lock is enough to
2005 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002006 */
2007 worker_enter_idle(worker);
2008 __set_current_state(TASK_INTERRUPTIBLE);
2009 spin_unlock_irq(&gcwq->lock);
2010 schedule();
2011 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012}
2013
Tejun Heoe22bee72010-06-29 10:07:14 +02002014/**
2015 * rescuer_thread - the rescuer thread function
2016 * @__wq: the associated workqueue
2017 *
2018 * Workqueue rescuer thread function. There's one rescuer for each
2019 * workqueue which has WQ_RESCUER set.
2020 *
2021 * Regular work processing on a gcwq may block trying to create a new
2022 * worker which uses GFP_KERNEL allocation which has slight chance of
2023 * developing into deadlock if some works currently on the same queue
2024 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2025 * the problem rescuer solves.
2026 *
2027 * When such condition is possible, the gcwq summons rescuers of all
2028 * workqueues which have works queued on the gcwq and let them process
2029 * those works so that forward progress can be guaranteed.
2030 *
2031 * This should happen rarely.
2032 */
2033static int rescuer_thread(void *__wq)
2034{
2035 struct workqueue_struct *wq = __wq;
2036 struct worker *rescuer = wq->rescuer;
2037 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002038 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002039 unsigned int cpu;
2040
2041 set_user_nice(current, RESCUER_NICE_LEVEL);
2042repeat:
2043 set_current_state(TASK_INTERRUPTIBLE);
2044
2045 if (kthread_should_stop())
2046 return 0;
2047
Tejun Heof3421792010-07-02 10:03:51 +02002048 /*
2049 * See whether any cpu is asking for help. Unbounded
2050 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2051 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002052 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002053 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2054 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heoe22bee72010-06-29 10:07:14 +02002055 struct global_cwq *gcwq = cwq->gcwq;
2056 struct work_struct *work, *n;
2057
2058 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002059 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002060
2061 /* migrate to the target cpu if possible */
2062 rescuer->gcwq = gcwq;
2063 worker_maybe_bind_and_lock(rescuer);
2064
2065 /*
2066 * Slurp in all works issued via this workqueue and
2067 * process'em.
2068 */
2069 BUG_ON(!list_empty(&rescuer->scheduled));
2070 list_for_each_entry_safe(work, n, &gcwq->worklist, entry)
2071 if (get_work_cwq(work) == cwq)
2072 move_linked_works(work, scheduled, &n);
2073
2074 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002075
2076 /*
2077 * Leave this gcwq. If keep_working() is %true, notify a
2078 * regular worker; otherwise, we end up with 0 concurrency
2079 * and stalling the execution.
2080 */
2081 if (keep_working(gcwq))
2082 wake_up_worker(gcwq);
2083
Tejun Heoe22bee72010-06-29 10:07:14 +02002084 spin_unlock_irq(&gcwq->lock);
2085 }
2086
2087 schedule();
2088 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089}
2090
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002091struct wq_barrier {
2092 struct work_struct work;
2093 struct completion done;
2094};
2095
2096static void wq_barrier_func(struct work_struct *work)
2097{
2098 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2099 complete(&barr->done);
2100}
2101
Tejun Heo4690c4a2010-06-29 10:07:10 +02002102/**
2103 * insert_wq_barrier - insert a barrier work
2104 * @cwq: cwq to insert barrier into
2105 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002106 * @target: target work to attach @barr to
2107 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002108 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002109 * @barr is linked to @target such that @barr is completed only after
2110 * @target finishes execution. Please note that the ordering
2111 * guarantee is observed only with respect to @target and on the local
2112 * cpu.
2113 *
2114 * Currently, a queued barrier can't be canceled. This is because
2115 * try_to_grab_pending() can't determine whether the work to be
2116 * grabbed is at the head of the queue and thus can't clear LINKED
2117 * flag of the previous work while there must be a valid next work
2118 * after a work with LINKED flag set.
2119 *
2120 * Note that when @worker is non-NULL, @target may be modified
2121 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002122 *
2123 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002124 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002125 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002126static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002127 struct wq_barrier *barr,
2128 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002129{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002130 struct list_head *head;
2131 unsigned int linked = 0;
2132
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002133 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002134 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002135 * as we know for sure that this will not trigger any of the
2136 * checks and call back into the fixup functions where we
2137 * might deadlock.
2138 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002139 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002140 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002141 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002142
Tejun Heoaffee4b2010-06-29 10:07:12 +02002143 /*
2144 * If @target is currently being executed, schedule the
2145 * barrier to the worker; otherwise, put it after @target.
2146 */
2147 if (worker)
2148 head = worker->scheduled.next;
2149 else {
2150 unsigned long *bits = work_data_bits(target);
2151
2152 head = target->entry.next;
2153 /* there can already be other linked works, inherit and set */
2154 linked = *bits & WORK_STRUCT_LINKED;
2155 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2156 }
2157
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002158 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002159 insert_work(cwq, &barr->work, head,
2160 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002161}
2162
Tejun Heo73f53c42010-06-29 10:07:11 +02002163/**
2164 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2165 * @wq: workqueue being flushed
2166 * @flush_color: new flush color, < 0 for no-op
2167 * @work_color: new work color, < 0 for no-op
2168 *
2169 * Prepare cwqs for workqueue flushing.
2170 *
2171 * If @flush_color is non-negative, flush_color on all cwqs should be
2172 * -1. If no cwq has in-flight commands at the specified color, all
2173 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2174 * has in flight commands, its cwq->flush_color is set to
2175 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2176 * wakeup logic is armed and %true is returned.
2177 *
2178 * The caller should have initialized @wq->first_flusher prior to
2179 * calling this function with non-negative @flush_color. If
2180 * @flush_color is negative, no flush color update is done and %false
2181 * is returned.
2182 *
2183 * If @work_color is non-negative, all cwqs should have the same
2184 * work_color which is previous to @work_color and all will be
2185 * advanced to @work_color.
2186 *
2187 * CONTEXT:
2188 * mutex_lock(wq->flush_mutex).
2189 *
2190 * RETURNS:
2191 * %true if @flush_color >= 0 and there's something to flush. %false
2192 * otherwise.
2193 */
2194static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2195 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196{
Tejun Heo73f53c42010-06-29 10:07:11 +02002197 bool wait = false;
2198 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002199
Tejun Heo73f53c42010-06-29 10:07:11 +02002200 if (flush_color >= 0) {
2201 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2202 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002203 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002204
Tejun Heof3421792010-07-02 10:03:51 +02002205 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002206 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002207 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002208
Tejun Heo8b03ae32010-06-29 10:07:12 +02002209 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002210
2211 if (flush_color >= 0) {
2212 BUG_ON(cwq->flush_color != -1);
2213
2214 if (cwq->nr_in_flight[flush_color]) {
2215 cwq->flush_color = flush_color;
2216 atomic_inc(&wq->nr_cwqs_to_flush);
2217 wait = true;
2218 }
2219 }
2220
2221 if (work_color >= 0) {
2222 BUG_ON(work_color != work_next_color(cwq->work_color));
2223 cwq->work_color = work_color;
2224 }
2225
Tejun Heo8b03ae32010-06-29 10:07:12 +02002226 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002227 }
2228
2229 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2230 complete(&wq->first_flusher->done);
2231
2232 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233}
2234
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002235/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002237 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238 *
2239 * Forces execution of the workqueue and blocks until its completion.
2240 * This is typically used in driver shutdown handlers.
2241 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002242 * We sleep until all works which were queued on entry have been handled,
2243 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002245void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246{
Tejun Heo73f53c42010-06-29 10:07:11 +02002247 struct wq_flusher this_flusher = {
2248 .list = LIST_HEAD_INIT(this_flusher.list),
2249 .flush_color = -1,
2250 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2251 };
2252 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002253
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002254 lock_map_acquire(&wq->lockdep_map);
2255 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002256
2257 mutex_lock(&wq->flush_mutex);
2258
2259 /*
2260 * Start-to-wait phase
2261 */
2262 next_color = work_next_color(wq->work_color);
2263
2264 if (next_color != wq->flush_color) {
2265 /*
2266 * Color space is not full. The current work_color
2267 * becomes our flush_color and work_color is advanced
2268 * by one.
2269 */
2270 BUG_ON(!list_empty(&wq->flusher_overflow));
2271 this_flusher.flush_color = wq->work_color;
2272 wq->work_color = next_color;
2273
2274 if (!wq->first_flusher) {
2275 /* no flush in progress, become the first flusher */
2276 BUG_ON(wq->flush_color != this_flusher.flush_color);
2277
2278 wq->first_flusher = &this_flusher;
2279
2280 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2281 wq->work_color)) {
2282 /* nothing to flush, done */
2283 wq->flush_color = next_color;
2284 wq->first_flusher = NULL;
2285 goto out_unlock;
2286 }
2287 } else {
2288 /* wait in queue */
2289 BUG_ON(wq->flush_color == this_flusher.flush_color);
2290 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2291 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2292 }
2293 } else {
2294 /*
2295 * Oops, color space is full, wait on overflow queue.
2296 * The next flush completion will assign us
2297 * flush_color and transfer to flusher_queue.
2298 */
2299 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2300 }
2301
2302 mutex_unlock(&wq->flush_mutex);
2303
2304 wait_for_completion(&this_flusher.done);
2305
2306 /*
2307 * Wake-up-and-cascade phase
2308 *
2309 * First flushers are responsible for cascading flushes and
2310 * handling overflow. Non-first flushers can simply return.
2311 */
2312 if (wq->first_flusher != &this_flusher)
2313 return;
2314
2315 mutex_lock(&wq->flush_mutex);
2316
Tejun Heo4ce48b32010-07-02 10:03:51 +02002317 /* we might have raced, check again with mutex held */
2318 if (wq->first_flusher != &this_flusher)
2319 goto out_unlock;
2320
Tejun Heo73f53c42010-06-29 10:07:11 +02002321 wq->first_flusher = NULL;
2322
2323 BUG_ON(!list_empty(&this_flusher.list));
2324 BUG_ON(wq->flush_color != this_flusher.flush_color);
2325
2326 while (true) {
2327 struct wq_flusher *next, *tmp;
2328
2329 /* complete all the flushers sharing the current flush color */
2330 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2331 if (next->flush_color != wq->flush_color)
2332 break;
2333 list_del_init(&next->list);
2334 complete(&next->done);
2335 }
2336
2337 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2338 wq->flush_color != work_next_color(wq->work_color));
2339
2340 /* this flush_color is finished, advance by one */
2341 wq->flush_color = work_next_color(wq->flush_color);
2342
2343 /* one color has been freed, handle overflow queue */
2344 if (!list_empty(&wq->flusher_overflow)) {
2345 /*
2346 * Assign the same color to all overflowed
2347 * flushers, advance work_color and append to
2348 * flusher_queue. This is the start-to-wait
2349 * phase for these overflowed flushers.
2350 */
2351 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2352 tmp->flush_color = wq->work_color;
2353
2354 wq->work_color = work_next_color(wq->work_color);
2355
2356 list_splice_tail_init(&wq->flusher_overflow,
2357 &wq->flusher_queue);
2358 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2359 }
2360
2361 if (list_empty(&wq->flusher_queue)) {
2362 BUG_ON(wq->flush_color != wq->work_color);
2363 break;
2364 }
2365
2366 /*
2367 * Need to flush more colors. Make the next flusher
2368 * the new first flusher and arm cwqs.
2369 */
2370 BUG_ON(wq->flush_color == wq->work_color);
2371 BUG_ON(wq->flush_color != next->flush_color);
2372
2373 list_del_init(&next->list);
2374 wq->first_flusher = next;
2375
2376 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2377 break;
2378
2379 /*
2380 * Meh... this color is already done, clear first
2381 * flusher and repeat cascading.
2382 */
2383 wq->first_flusher = NULL;
2384 }
2385
2386out_unlock:
2387 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388}
Dave Jonesae90dd52006-06-30 01:40:45 -04002389EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002391/**
2392 * drain_workqueue - drain a workqueue
2393 * @wq: workqueue to drain
2394 *
2395 * Wait until the workqueue becomes empty. While draining is in progress,
2396 * only chain queueing is allowed. IOW, only currently pending or running
2397 * work items on @wq can queue further work items on it. @wq is flushed
2398 * repeatedly until it becomes empty. The number of flushing is detemined
2399 * by the depth of chaining and should be relatively short. Whine if it
2400 * takes too long.
2401 */
2402void drain_workqueue(struct workqueue_struct *wq)
2403{
2404 unsigned int flush_cnt = 0;
2405 unsigned int cpu;
2406
2407 /*
2408 * __queue_work() needs to test whether there are drainers, is much
2409 * hotter than drain_workqueue() and already looks at @wq->flags.
2410 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2411 */
2412 spin_lock(&workqueue_lock);
2413 if (!wq->nr_drainers++)
2414 wq->flags |= WQ_DRAINING;
2415 spin_unlock(&workqueue_lock);
2416reflush:
2417 flush_workqueue(wq);
2418
2419 for_each_cwq_cpu(cpu, wq) {
2420 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002421 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002422
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002423 spin_lock_irq(&cwq->gcwq->lock);
2424 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2425 spin_unlock_irq(&cwq->gcwq->lock);
2426
2427 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002428 continue;
2429
2430 if (++flush_cnt == 10 ||
2431 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2432 pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
2433 wq->name, flush_cnt);
2434 goto reflush;
2435 }
2436
2437 spin_lock(&workqueue_lock);
2438 if (!--wq->nr_drainers)
2439 wq->flags &= ~WQ_DRAINING;
2440 spin_unlock(&workqueue_lock);
2441}
2442EXPORT_SYMBOL_GPL(drain_workqueue);
2443
Tejun Heobaf59022010-09-16 10:42:16 +02002444static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2445 bool wait_executing)
2446{
2447 struct worker *worker = NULL;
2448 struct global_cwq *gcwq;
2449 struct cpu_workqueue_struct *cwq;
2450
2451 might_sleep();
2452 gcwq = get_work_gcwq(work);
2453 if (!gcwq)
2454 return false;
2455
2456 spin_lock_irq(&gcwq->lock);
2457 if (!list_empty(&work->entry)) {
2458 /*
2459 * See the comment near try_to_grab_pending()->smp_rmb().
2460 * If it was re-queued to a different gcwq under us, we
2461 * are not going to wait.
2462 */
2463 smp_rmb();
2464 cwq = get_work_cwq(work);
2465 if (unlikely(!cwq || gcwq != cwq->gcwq))
2466 goto already_gone;
2467 } else if (wait_executing) {
2468 worker = find_worker_executing_work(gcwq, work);
2469 if (!worker)
2470 goto already_gone;
2471 cwq = worker->current_cwq;
2472 } else
2473 goto already_gone;
2474
2475 insert_wq_barrier(cwq, barr, work, worker);
2476 spin_unlock_irq(&gcwq->lock);
2477
Tejun Heoe1594892011-01-09 23:32:15 +01002478 /*
2479 * If @max_active is 1 or rescuer is in use, flushing another work
2480 * item on the same workqueue may lead to deadlock. Make sure the
2481 * flusher is not running on the same workqueue by verifying write
2482 * access.
2483 */
2484 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2485 lock_map_acquire(&cwq->wq->lockdep_map);
2486 else
2487 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002488 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002489
Tejun Heobaf59022010-09-16 10:42:16 +02002490 return true;
2491already_gone:
2492 spin_unlock_irq(&gcwq->lock);
2493 return false;
2494}
2495
Oleg Nesterovdb700892008-07-25 01:47:49 -07002496/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002497 * flush_work - wait for a work to finish executing the last queueing instance
2498 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002499 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002500 * Wait until @work has finished execution. This function considers
2501 * only the last queueing instance of @work. If @work has been
2502 * enqueued across different CPUs on a non-reentrant workqueue or on
2503 * multiple workqueues, @work might still be executing on return on
2504 * some of the CPUs from earlier queueing.
Oleg Nesterova67da702008-07-25 01:47:52 -07002505 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002506 * If @work was queued only on a non-reentrant, ordered or unbound
2507 * workqueue, @work is guaranteed to be idle on return if it hasn't
2508 * been requeued since flush started.
2509 *
2510 * RETURNS:
2511 * %true if flush_work() waited for the work to finish execution,
2512 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002513 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002514bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002515{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002516 struct wq_barrier barr;
2517
Tejun Heobaf59022010-09-16 10:42:16 +02002518 if (start_flush_work(work, &barr, true)) {
2519 wait_for_completion(&barr.done);
2520 destroy_work_on_stack(&barr.work);
2521 return true;
2522 } else
2523 return false;
Oleg Nesterovdb700892008-07-25 01:47:49 -07002524}
2525EXPORT_SYMBOL_GPL(flush_work);
2526
Tejun Heo401a8d02010-09-16 10:36:00 +02002527static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2528{
2529 struct wq_barrier barr;
2530 struct worker *worker;
2531
2532 spin_lock_irq(&gcwq->lock);
2533
2534 worker = find_worker_executing_work(gcwq, work);
2535 if (unlikely(worker))
2536 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2537
2538 spin_unlock_irq(&gcwq->lock);
2539
2540 if (unlikely(worker)) {
2541 wait_for_completion(&barr.done);
2542 destroy_work_on_stack(&barr.work);
2543 return true;
2544 } else
2545 return false;
2546}
2547
2548static bool wait_on_work(struct work_struct *work)
2549{
2550 bool ret = false;
2551 int cpu;
2552
2553 might_sleep();
2554
2555 lock_map_acquire(&work->lockdep_map);
2556 lock_map_release(&work->lockdep_map);
2557
2558 for_each_gcwq_cpu(cpu)
2559 ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2560 return ret;
2561}
2562
Tejun Heo09383492010-09-16 10:48:29 +02002563/**
2564 * flush_work_sync - wait until a work has finished execution
2565 * @work: the work to flush
2566 *
2567 * Wait until @work has finished execution. On return, it's
2568 * guaranteed that all queueing instances of @work which happened
2569 * before this function is called are finished. In other words, if
2570 * @work hasn't been requeued since this function was called, @work is
2571 * guaranteed to be idle on return.
2572 *
2573 * RETURNS:
2574 * %true if flush_work_sync() waited for the work to finish execution,
2575 * %false if it was already idle.
2576 */
2577bool flush_work_sync(struct work_struct *work)
2578{
2579 struct wq_barrier barr;
2580 bool pending, waited;
2581
2582 /* we'll wait for executions separately, queue barr only if pending */
2583 pending = start_flush_work(work, &barr, false);
2584
2585 /* wait for executions to finish */
2586 waited = wait_on_work(work);
2587
2588 /* wait for the pending one */
2589 if (pending) {
2590 wait_for_completion(&barr.done);
2591 destroy_work_on_stack(&barr.work);
2592 }
2593
2594 return pending || waited;
2595}
2596EXPORT_SYMBOL_GPL(flush_work_sync);
2597
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002598/*
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002599 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002600 * so this work can't be re-armed in any way.
2601 */
2602static int try_to_grab_pending(struct work_struct *work)
2603{
Tejun Heo8b03ae32010-06-29 10:07:12 +02002604 struct global_cwq *gcwq;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002605 int ret = -1;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002606
Tejun Heo22df02b2010-06-29 10:07:10 +02002607 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002608 return 0;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002609
2610 /*
2611 * The queueing is in progress, or it is already queued. Try to
2612 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
2613 */
Tejun Heo7a22ad72010-06-29 10:07:13 +02002614 gcwq = get_work_gcwq(work);
2615 if (!gcwq)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002616 return ret;
2617
Tejun Heo8b03ae32010-06-29 10:07:12 +02002618 spin_lock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002619 if (!list_empty(&work->entry)) {
2620 /*
Tejun Heo7a22ad72010-06-29 10:07:13 +02002621 * This work is queued, but perhaps we locked the wrong gcwq.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002622 * In that case we must see the new value after rmb(), see
2623 * insert_work()->wmb().
2624 */
2625 smp_rmb();
Tejun Heo7a22ad72010-06-29 10:07:13 +02002626 if (gcwq == get_work_gcwq(work)) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002627 debug_work_deactivate(work);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002628 list_del_init(&work->entry);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002629 cwq_dec_nr_in_flight(get_work_cwq(work),
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02002630 get_work_color(work),
2631 *work_data_bits(work) & WORK_STRUCT_DELAYED);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002632 ret = 1;
2633 }
2634 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02002635 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002636
2637 return ret;
2638}
2639
Tejun Heo401a8d02010-09-16 10:36:00 +02002640static bool __cancel_work_timer(struct work_struct *work,
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002641 struct timer_list* timer)
2642{
2643 int ret;
2644
2645 do {
2646 ret = (timer && likely(del_timer(timer)));
2647 if (!ret)
2648 ret = try_to_grab_pending(work);
2649 wait_on_work(work);
2650 } while (unlikely(ret < 0));
2651
Tejun Heo7a22ad72010-06-29 10:07:13 +02002652 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002653 return ret;
2654}
2655
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002656/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002657 * cancel_work_sync - cancel a work and wait for it to finish
2658 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002659 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002660 * Cancel @work and wait for its execution to finish. This function
2661 * can be used even if the work re-queues itself or migrates to
2662 * another workqueue. On return from this function, @work is
2663 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002664 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002665 * cancel_work_sync(&delayed_work->work) must not be used for
2666 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002667 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002668 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002669 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002670 *
2671 * RETURNS:
2672 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002673 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002674bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002675{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002676 return __cancel_work_timer(work, NULL);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002677}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002678EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002679
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002680/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002681 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2682 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002683 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002684 * Delayed timer is cancelled and the pending work is queued for
2685 * immediate execution. Like flush_work(), this function only
2686 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002687 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002688 * RETURNS:
2689 * %true if flush_work() waited for the work to finish execution,
2690 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002691 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002692bool flush_delayed_work(struct delayed_work *dwork)
2693{
2694 if (del_timer_sync(&dwork->timer))
2695 __queue_work(raw_smp_processor_id(),
2696 get_work_cwq(&dwork->work)->wq, &dwork->work);
2697 return flush_work(&dwork->work);
2698}
2699EXPORT_SYMBOL(flush_delayed_work);
2700
2701/**
Tejun Heo09383492010-09-16 10:48:29 +02002702 * flush_delayed_work_sync - wait for a dwork to finish
2703 * @dwork: the delayed work to flush
2704 *
2705 * Delayed timer is cancelled and the pending work is queued for
2706 * execution immediately. Other than timer handling, its behavior
2707 * is identical to flush_work_sync().
2708 *
2709 * RETURNS:
2710 * %true if flush_work_sync() waited for the work to finish execution,
2711 * %false if it was already idle.
2712 */
2713bool flush_delayed_work_sync(struct delayed_work *dwork)
2714{
2715 if (del_timer_sync(&dwork->timer))
2716 __queue_work(raw_smp_processor_id(),
2717 get_work_cwq(&dwork->work)->wq, &dwork->work);
2718 return flush_work_sync(&dwork->work);
2719}
2720EXPORT_SYMBOL(flush_delayed_work_sync);
2721
2722/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002723 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2724 * @dwork: the delayed work cancel
2725 *
2726 * This is cancel_work_sync() for delayed works.
2727 *
2728 * RETURNS:
2729 * %true if @dwork was pending, %false otherwise.
2730 */
2731bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002732{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002733 return __cancel_work_timer(&dwork->work, &dwork->timer);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002734}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002735EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002736
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002737/**
2738 * schedule_work - put work task in global workqueue
2739 * @work: job to be done
2740 *
Bart Van Assche5b0f437d2009-07-30 19:00:53 +02002741 * Returns zero if @work was already on the kernel-global workqueue and
2742 * non-zero otherwise.
2743 *
2744 * This puts a job in the kernel-global workqueue if it was not already
2745 * queued and leaves it in the same position on the kernel-global
2746 * workqueue otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002747 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002748int schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749{
Tejun Heod320c032010-06-29 10:07:14 +02002750 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002751}
Dave Jonesae90dd52006-06-30 01:40:45 -04002752EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002753
Zhang Ruic1a220e2008-07-23 21:28:39 -07002754/*
2755 * schedule_work_on - put work task on a specific cpu
2756 * @cpu: cpu to put the work task on
2757 * @work: job to be done
2758 *
2759 * This puts a job on a specific cpu
2760 */
2761int schedule_work_on(int cpu, struct work_struct *work)
2762{
Tejun Heod320c032010-06-29 10:07:14 +02002763 return queue_work_on(cpu, system_wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07002764}
2765EXPORT_SYMBOL(schedule_work_on);
2766
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002767/**
2768 * schedule_delayed_work - put work task in global workqueue after delay
David Howells52bad642006-11-22 14:54:01 +00002769 * @dwork: job to be done
2770 * @delay: number of jiffies to wait or 0 for immediate execution
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002771 *
2772 * After waiting for a given time this puts a job in the kernel-global
2773 * workqueue.
2774 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002775int schedule_delayed_work(struct delayed_work *dwork,
Ingo Molnar82f67cd2007-02-16 01:28:13 -08002776 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002777{
Tejun Heod320c032010-06-29 10:07:14 +02002778 return queue_delayed_work(system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779}
Dave Jonesae90dd52006-06-30 01:40:45 -04002780EXPORT_SYMBOL(schedule_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002782/**
2783 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
2784 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +00002785 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002786 * @delay: number of jiffies to wait
2787 *
2788 * After waiting for a given time this puts a job in the kernel-global
2789 * workqueue on the specified CPU.
2790 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002791int schedule_delayed_work_on(int cpu,
David Howells52bad642006-11-22 14:54:01 +00002792 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793{
Tejun Heod320c032010-06-29 10:07:14 +02002794 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795}
Dave Jonesae90dd52006-06-30 01:40:45 -04002796EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002797
Andrew Mortonb6136772006-06-25 05:47:49 -07002798/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002799 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002800 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002801 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002802 * schedule_on_each_cpu() executes @func on each online CPU using the
2803 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002804 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002805 *
2806 * RETURNS:
2807 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002808 */
David Howells65f27f32006-11-22 14:55:48 +00002809int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002810{
2811 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002812 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002813
Andrew Mortonb6136772006-06-25 05:47:49 -07002814 works = alloc_percpu(struct work_struct);
2815 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002816 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002817
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002818 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002819
Christoph Lameter15316ba2006-01-08 01:00:43 -08002820 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002821 struct work_struct *work = per_cpu_ptr(works, cpu);
2822
2823 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002824 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002825 }
Tejun Heo93981802009-11-17 14:06:20 -08002826
2827 for_each_online_cpu(cpu)
2828 flush_work(per_cpu_ptr(works, cpu));
2829
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002830 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002831 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08002832 return 0;
2833}
2834
Alan Sterneef6a7d2010-02-12 17:39:21 +09002835/**
2836 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2837 *
2838 * Forces execution of the kernel-global workqueue and blocks until its
2839 * completion.
2840 *
2841 * Think twice before calling this function! It's very easy to get into
2842 * trouble if you don't take great care. Either of the following situations
2843 * will lead to deadlock:
2844 *
2845 * One of the work items currently on the workqueue needs to acquire
2846 * a lock held by your code or its caller.
2847 *
2848 * Your code is running in the context of a work routine.
2849 *
2850 * They will be detected by lockdep when they occur, but the first might not
2851 * occur very often. It depends on what work items are on the workqueue and
2852 * what locks they need, which you have no control over.
2853 *
2854 * In most situations flushing the entire workqueue is overkill; you merely
2855 * need to know that a particular work item isn't queued and isn't running.
2856 * In such cases you should use cancel_delayed_work_sync() or
2857 * cancel_work_sync() instead.
2858 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002859void flush_scheduled_work(void)
2860{
Tejun Heod320c032010-06-29 10:07:14 +02002861 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002862}
Dave Jonesae90dd52006-06-30 01:40:45 -04002863EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002864
2865/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06002866 * execute_in_process_context - reliably execute the routine with user context
2867 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06002868 * @ew: guaranteed storage for the execute work structure (must
2869 * be available when the work executes)
2870 *
2871 * Executes the function immediately if process context is available,
2872 * otherwise schedules the function for delayed execution.
2873 *
2874 * Returns: 0 - function was executed
2875 * 1 - function was scheduled for execution
2876 */
David Howells65f27f32006-11-22 14:55:48 +00002877int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06002878{
2879 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00002880 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002881 return 0;
2882 }
2883
David Howells65f27f32006-11-22 14:55:48 +00002884 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002885 schedule_work(&ew->work);
2886
2887 return 1;
2888}
2889EXPORT_SYMBOL_GPL(execute_in_process_context);
2890
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891int keventd_up(void)
2892{
Tejun Heod320c032010-06-29 10:07:14 +02002893 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894}
2895
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002896static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002897{
Oleg Nesterov3af244332007-05-09 02:34:09 -07002898 /*
Tejun Heo0f900042010-06-29 10:07:11 +02002899 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
2900 * Make sure that the alignment isn't lower than that of
2901 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07002902 */
Tejun Heo0f900042010-06-29 10:07:11 +02002903 const size_t size = sizeof(struct cpu_workqueue_struct);
2904 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
2905 __alignof__(unsigned long long));
Oleg Nesterov3af244332007-05-09 02:34:09 -07002906
Lai Jiangshane06ffa12012-03-09 18:03:20 +08002907 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02002908 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02002909 else {
Tejun Heof3421792010-07-02 10:03:51 +02002910 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01002911
Tejun Heof3421792010-07-02 10:03:51 +02002912 /*
2913 * Allocate enough room to align cwq and put an extra
2914 * pointer at the end pointing back to the originally
2915 * allocated pointer which will be used for free.
2916 */
2917 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2918 if (ptr) {
2919 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2920 *(void **)(wq->cpu_wq.single + 1) = ptr;
2921 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002922 }
Tejun Heof3421792010-07-02 10:03:51 +02002923
Tejun Heo0415b002011-03-24 18:50:09 +01002924 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002925 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2926 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002927}
2928
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002929static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07002930{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08002931 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02002932 free_percpu(wq->cpu_wq.pcpu);
2933 else if (wq->cpu_wq.single) {
2934 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002935 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07002936 }
2937}
2938
Tejun Heof3421792010-07-02 10:03:51 +02002939static int wq_clamp_max_active(int max_active, unsigned int flags,
2940 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02002941{
Tejun Heof3421792010-07-02 10:03:51 +02002942 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2943
2944 if (max_active < 1 || max_active > lim)
Tejun Heob71ab8c2010-06-29 10:07:14 +02002945 printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2946 "is out of range, clamping between %d and %d\n",
Tejun Heof3421792010-07-02 10:03:51 +02002947 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002948
Tejun Heof3421792010-07-02 10:03:51 +02002949 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002950}
2951
Tejun Heob196be82012-01-10 15:11:35 -08002952struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02002953 unsigned int flags,
2954 int max_active,
2955 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08002956 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07002957{
Tejun Heob196be82012-01-10 15:11:35 -08002958 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002959 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02002960 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08002961 size_t namelen;
2962
2963 /* determine namelen, allocate wq and format name */
2964 va_start(args, lock_name);
2965 va_copy(args1, args);
2966 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
2967
2968 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
2969 if (!wq)
2970 goto err;
2971
2972 vsnprintf(wq->name, namelen, fmt, args1);
2973 va_end(args);
2974 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002975
Tejun Heof3421792010-07-02 10:03:51 +02002976 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02002977 * Workqueues which may be used during memory reclaim should
2978 * have a rescuer to guarantee forward progress.
2979 */
2980 if (flags & WQ_MEM_RECLAIM)
2981 flags |= WQ_RESCUER;
2982
2983 /*
Tejun Heof3421792010-07-02 10:03:51 +02002984 * Unbound workqueues aren't concurrency managed and should be
2985 * dispatched to workers immediately.
2986 */
2987 if (flags & WQ_UNBOUND)
2988 flags |= WQ_HIGHPRI;
2989
Tejun Heod320c032010-06-29 10:07:14 +02002990 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08002991 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002992
Tejun Heob196be82012-01-10 15:11:35 -08002993 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02002994 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002995 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02002996 mutex_init(&wq->flush_mutex);
2997 atomic_set(&wq->nr_cwqs_to_flush, 0);
2998 INIT_LIST_HEAD(&wq->flusher_queue);
2999 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003000
Johannes Bergeb13ba82008-01-16 09:51:58 +01003001 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003002 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003003
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003004 if (alloc_cwqs(wq) < 0)
3005 goto err;
3006
Tejun Heof3421792010-07-02 10:03:51 +02003007 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003008 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003009 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo15376632010-06-29 10:07:11 +02003010
Tejun Heo0f900042010-06-29 10:07:11 +02003011 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003012 cwq->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003013 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003014 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003015 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003016 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003017 }
3018
Tejun Heoe22bee72010-06-29 10:07:14 +02003019 if (flags & WQ_RESCUER) {
3020 struct worker *rescuer;
3021
Tejun Heof2e005a2010-07-20 15:59:09 +02003022 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003023 goto err;
3024
3025 wq->rescuer = rescuer = alloc_worker();
3026 if (!rescuer)
3027 goto err;
3028
Tejun Heob196be82012-01-10 15:11:35 -08003029 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3030 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003031 if (IS_ERR(rescuer->task))
3032 goto err;
3033
Tejun Heoe22bee72010-06-29 10:07:14 +02003034 rescuer->task->flags |= PF_THREAD_BOUND;
3035 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003036 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003037
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003038 /*
3039 * workqueue_lock protects global freeze state and workqueues
3040 * list. Grab it, set max_active accordingly and add the new
3041 * workqueue to workqueues list.
3042 */
Tejun Heo15376632010-06-29 10:07:11 +02003043 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003044
Tejun Heo58a69cb2011-02-16 09:25:31 +01003045 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003046 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003047 get_cwq(cpu, wq)->max_active = 0;
3048
Tejun Heo15376632010-06-29 10:07:11 +02003049 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003050
Tejun Heo15376632010-06-29 10:07:11 +02003051 spin_unlock(&workqueue_lock);
3052
Oleg Nesterov3af244332007-05-09 02:34:09 -07003053 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003054err:
3055 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003056 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003057 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003058 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003059 kfree(wq);
3060 }
3061 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003062}
Tejun Heod320c032010-06-29 10:07:14 +02003063EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003064
3065/**
3066 * destroy_workqueue - safely terminate a workqueue
3067 * @wq: target workqueue
3068 *
3069 * Safely destroy a workqueue. All work currently pending will be done first.
3070 */
3071void destroy_workqueue(struct workqueue_struct *wq)
3072{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003073 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003074
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003075 /* drain it before proceeding with destruction */
3076 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003077
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003078 /*
3079 * wq list is used to freeze wq, remove from list after
3080 * flushing is complete in case freeze races us.
3081 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003082 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07003083 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003084 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003085
Tejun Heoe22bee72010-06-29 10:07:14 +02003086 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003087 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003088 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3089 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003090
Tejun Heo73f53c42010-06-29 10:07:11 +02003091 for (i = 0; i < WORK_NR_COLORS; i++)
3092 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003093 BUG_ON(cwq->nr_active);
3094 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003095 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003096
Tejun Heoe22bee72010-06-29 10:07:14 +02003097 if (wq->flags & WQ_RESCUER) {
3098 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003099 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003100 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003101 }
3102
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003103 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003104 kfree(wq);
3105}
3106EXPORT_SYMBOL_GPL(destroy_workqueue);
3107
Tejun Heodcd989c2010-06-29 10:07:14 +02003108/**
3109 * workqueue_set_max_active - adjust max_active of a workqueue
3110 * @wq: target workqueue
3111 * @max_active: new max_active value.
3112 *
3113 * Set max_active of @wq to @max_active.
3114 *
3115 * CONTEXT:
3116 * Don't call from IRQ context.
3117 */
3118void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3119{
3120 unsigned int cpu;
3121
Tejun Heof3421792010-07-02 10:03:51 +02003122 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003123
3124 spin_lock(&workqueue_lock);
3125
3126 wq->saved_max_active = max_active;
3127
Tejun Heof3421792010-07-02 10:03:51 +02003128 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003129 struct global_cwq *gcwq = get_gcwq(cpu);
3130
3131 spin_lock_irq(&gcwq->lock);
3132
Tejun Heo58a69cb2011-02-16 09:25:31 +01003133 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003134 !(gcwq->flags & GCWQ_FREEZING))
3135 get_cwq(gcwq->cpu, wq)->max_active = max_active;
3136
3137 spin_unlock_irq(&gcwq->lock);
3138 }
3139
3140 spin_unlock(&workqueue_lock);
3141}
3142EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3143
3144/**
3145 * workqueue_congested - test whether a workqueue is congested
3146 * @cpu: CPU in question
3147 * @wq: target workqueue
3148 *
3149 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3150 * no synchronization around this function and the test result is
3151 * unreliable and only useful as advisory hints or for debugging.
3152 *
3153 * RETURNS:
3154 * %true if congested, %false otherwise.
3155 */
3156bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3157{
3158 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3159
3160 return !list_empty(&cwq->delayed_works);
3161}
3162EXPORT_SYMBOL_GPL(workqueue_congested);
3163
3164/**
3165 * work_cpu - return the last known associated cpu for @work
3166 * @work: the work of interest
3167 *
3168 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003169 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003170 */
3171unsigned int work_cpu(struct work_struct *work)
3172{
3173 struct global_cwq *gcwq = get_work_gcwq(work);
3174
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003175 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003176}
3177EXPORT_SYMBOL_GPL(work_cpu);
3178
3179/**
3180 * work_busy - test whether a work is currently pending or running
3181 * @work: the work to be tested
3182 *
3183 * Test whether @work is currently pending or running. There is no
3184 * synchronization around this function and the test result is
3185 * unreliable and only useful as advisory hints or for debugging.
3186 * Especially for reentrant wqs, the pending state might hide the
3187 * running state.
3188 *
3189 * RETURNS:
3190 * OR'd bitmask of WORK_BUSY_* bits.
3191 */
3192unsigned int work_busy(struct work_struct *work)
3193{
3194 struct global_cwq *gcwq = get_work_gcwq(work);
3195 unsigned long flags;
3196 unsigned int ret = 0;
3197
3198 if (!gcwq)
3199 return false;
3200
3201 spin_lock_irqsave(&gcwq->lock, flags);
3202
3203 if (work_pending(work))
3204 ret |= WORK_BUSY_PENDING;
3205 if (find_worker_executing_work(gcwq, work))
3206 ret |= WORK_BUSY_RUNNING;
3207
3208 spin_unlock_irqrestore(&gcwq->lock, flags);
3209
3210 return ret;
3211}
3212EXPORT_SYMBOL_GPL(work_busy);
3213
Tejun Heodb7bccf2010-06-29 10:07:12 +02003214/*
3215 * CPU hotplug.
3216 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003217 * There are two challenges in supporting CPU hotplug. Firstly, there
3218 * are a lot of assumptions on strong associations among work, cwq and
3219 * gcwq which make migrating pending and scheduled works very
3220 * difficult to implement without impacting hot paths. Secondly,
3221 * gcwqs serve mix of short, long and very long running works making
3222 * blocked draining impractical.
3223 *
3224 * This is solved by allowing a gcwq to be detached from CPU, running
3225 * it with unbound (rogue) workers and allowing it to be reattached
3226 * later if the cpu comes back online. A separate thread is created
3227 * to govern a gcwq in such state and is called the trustee of the
3228 * gcwq.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003229 *
3230 * Trustee states and their descriptions.
3231 *
3232 * START Command state used on startup. On CPU_DOWN_PREPARE, a
3233 * new trustee is started with this state.
3234 *
3235 * IN_CHARGE Once started, trustee will enter this state after
Tejun Heoe22bee72010-06-29 10:07:14 +02003236 * assuming the manager role and making all existing
3237 * workers rogue. DOWN_PREPARE waits for trustee to
3238 * enter this state. After reaching IN_CHARGE, trustee
3239 * tries to execute the pending worklist until it's empty
3240 * and the state is set to BUTCHER, or the state is set
3241 * to RELEASE.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003242 *
3243 * BUTCHER Command state which is set by the cpu callback after
3244 * the cpu has went down. Once this state is set trustee
3245 * knows that there will be no new works on the worklist
3246 * and once the worklist is empty it can proceed to
3247 * killing idle workers.
3248 *
3249 * RELEASE Command state which is set by the cpu callback if the
3250 * cpu down has been canceled or it has come online
3251 * again. After recognizing this state, trustee stops
Tejun Heoe22bee72010-06-29 10:07:14 +02003252 * trying to drain or butcher and clears ROGUE, rebinds
3253 * all remaining workers back to the cpu and releases
3254 * manager role.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003255 *
3256 * DONE Trustee will enter this state after BUTCHER or RELEASE
3257 * is complete.
3258 *
3259 * trustee CPU draining
3260 * took over down complete
3261 * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3262 * | | ^
3263 * | CPU is back online v return workers |
3264 * ----------------> RELEASE --------------
3265 */
3266
3267/**
3268 * trustee_wait_event_timeout - timed event wait for trustee
3269 * @cond: condition to wait for
3270 * @timeout: timeout in jiffies
3271 *
3272 * wait_event_timeout() for trustee to use. Handles locking and
3273 * checks for RELEASE request.
3274 *
3275 * CONTEXT:
3276 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3277 * multiple times. To be used by trustee.
3278 *
3279 * RETURNS:
3280 * Positive indicating left time if @cond is satisfied, 0 if timed
3281 * out, -1 if canceled.
3282 */
3283#define trustee_wait_event_timeout(cond, timeout) ({ \
3284 long __ret = (timeout); \
3285 while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \
3286 __ret) { \
3287 spin_unlock_irq(&gcwq->lock); \
3288 __wait_event_timeout(gcwq->trustee_wait, (cond) || \
3289 (gcwq->trustee_state == TRUSTEE_RELEASE), \
3290 __ret); \
3291 spin_lock_irq(&gcwq->lock); \
3292 } \
3293 gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret); \
3294})
3295
3296/**
3297 * trustee_wait_event - event wait for trustee
3298 * @cond: condition to wait for
3299 *
3300 * wait_event() for trustee to use. Automatically handles locking and
3301 * checks for CANCEL request.
3302 *
3303 * CONTEXT:
3304 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3305 * multiple times. To be used by trustee.
3306 *
3307 * RETURNS:
3308 * 0 if @cond is satisfied, -1 if canceled.
3309 */
3310#define trustee_wait_event(cond) ({ \
3311 long __ret1; \
3312 __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3313 __ret1 < 0 ? -1 : 0; \
3314})
3315
3316static int __cpuinit trustee_thread(void *__gcwq)
3317{
3318 struct global_cwq *gcwq = __gcwq;
3319 struct worker *worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02003320 struct work_struct *work;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003321 struct hlist_node *pos;
Tejun Heoe22bee72010-06-29 10:07:14 +02003322 long rc;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003323 int i;
3324
3325 BUG_ON(gcwq->cpu != smp_processor_id());
3326
3327 spin_lock_irq(&gcwq->lock);
3328 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02003329 * Claim the manager position and make all workers rogue.
3330 * Trustee must be bound to the target cpu and can't be
3331 * cancelled.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003332 */
3333 BUG_ON(gcwq->cpu != smp_processor_id());
Tejun Heoe22bee72010-06-29 10:07:14 +02003334 rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS));
3335 BUG_ON(rc < 0);
3336
3337 gcwq->flags |= GCWQ_MANAGING_WORKERS;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003338
3339 list_for_each_entry(worker, &gcwq->idle_list, entry)
Tejun Heocb444762010-07-02 10:03:50 +02003340 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003341
3342 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heocb444762010-07-02 10:03:50 +02003343 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003344
3345 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02003346 * Call schedule() so that we cross rq->lock and thus can
3347 * guarantee sched callbacks see the rogue flag. This is
3348 * necessary as scheduler callbacks may be invoked from other
3349 * cpus.
3350 */
3351 spin_unlock_irq(&gcwq->lock);
3352 schedule();
3353 spin_lock_irq(&gcwq->lock);
3354
3355 /*
Tejun Heocb444762010-07-02 10:03:50 +02003356 * Sched callbacks are disabled now. Zap nr_running. After
3357 * this, nr_running stays zero and need_more_worker() and
3358 * keep_working() are always true as long as the worklist is
3359 * not empty.
Tejun Heoe22bee72010-06-29 10:07:14 +02003360 */
Tejun Heocb444762010-07-02 10:03:50 +02003361 atomic_set(get_gcwq_nr_running(gcwq->cpu), 0);
Tejun Heoe22bee72010-06-29 10:07:14 +02003362
3363 spin_unlock_irq(&gcwq->lock);
3364 del_timer_sync(&gcwq->idle_timer);
3365 spin_lock_irq(&gcwq->lock);
3366
3367 /*
Tejun Heodb7bccf2010-06-29 10:07:12 +02003368 * We're now in charge. Notify and proceed to drain. We need
3369 * to keep the gcwq running during the whole CPU down
3370 * procedure as other cpu hotunplug callbacks may need to
3371 * flush currently running tasks.
3372 */
3373 gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3374 wake_up_all(&gcwq->trustee_wait);
3375
3376 /*
3377 * The original cpu is in the process of dying and may go away
3378 * anytime now. When that happens, we and all workers would
Tejun Heoe22bee72010-06-29 10:07:14 +02003379 * be migrated to other cpus. Try draining any left work. We
3380 * want to get it over with ASAP - spam rescuers, wake up as
3381 * many idlers as necessary and create new ones till the
3382 * worklist is empty. Note that if the gcwq is frozen, there
Tejun Heo58a69cb2011-02-16 09:25:31 +01003383 * may be frozen works in freezable cwqs. Don't declare
Tejun Heoe22bee72010-06-29 10:07:14 +02003384 * completion while frozen.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003385 */
3386 while (gcwq->nr_workers != gcwq->nr_idle ||
3387 gcwq->flags & GCWQ_FREEZING ||
3388 gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003389 int nr_works = 0;
3390
3391 list_for_each_entry(work, &gcwq->worklist, entry) {
3392 send_mayday(work);
3393 nr_works++;
3394 }
3395
3396 list_for_each_entry(worker, &gcwq->idle_list, entry) {
3397 if (!nr_works--)
3398 break;
3399 wake_up_process(worker->task);
3400 }
3401
3402 if (need_to_create_worker(gcwq)) {
3403 spin_unlock_irq(&gcwq->lock);
3404 worker = create_worker(gcwq, false);
3405 spin_lock_irq(&gcwq->lock);
3406 if (worker) {
Tejun Heocb444762010-07-02 10:03:50 +02003407 worker->flags |= WORKER_ROGUE;
Tejun Heoe22bee72010-06-29 10:07:14 +02003408 start_worker(worker);
3409 }
3410 }
3411
Tejun Heodb7bccf2010-06-29 10:07:12 +02003412 /* give a breather */
3413 if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3414 break;
3415 }
3416
Tejun Heoe22bee72010-06-29 10:07:14 +02003417 /*
3418 * Either all works have been scheduled and cpu is down, or
3419 * cpu down has already been canceled. Wait for and butcher
3420 * all workers till we're canceled.
3421 */
3422 do {
3423 rc = trustee_wait_event(!list_empty(&gcwq->idle_list));
3424 while (!list_empty(&gcwq->idle_list))
3425 destroy_worker(list_first_entry(&gcwq->idle_list,
3426 struct worker, entry));
3427 } while (gcwq->nr_workers && rc >= 0);
3428
3429 /*
3430 * At this point, either draining has completed and no worker
3431 * is left, or cpu down has been canceled or the cpu is being
3432 * brought back up. There shouldn't be any idle one left.
3433 * Tell the remaining busy ones to rebind once it finishes the
3434 * currently scheduled works by scheduling the rebind_work.
3435 */
3436 WARN_ON(!list_empty(&gcwq->idle_list));
3437
3438 for_each_busy_worker(worker, i, pos, gcwq) {
3439 struct work_struct *rebind_work = &worker->rebind_work;
3440
3441 /*
3442 * Rebind_work may race with future cpu hotplug
3443 * operations. Use a separate flag to mark that
3444 * rebinding is scheduled.
3445 */
Tejun Heocb444762010-07-02 10:03:50 +02003446 worker->flags |= WORKER_REBIND;
3447 worker->flags &= ~WORKER_ROGUE;
Tejun Heoe22bee72010-06-29 10:07:14 +02003448
3449 /* queue rebind_work, wq doesn't matter, use the default one */
3450 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3451 work_data_bits(rebind_work)))
3452 continue;
3453
3454 debug_work_activate(rebind_work);
Tejun Heod320c032010-06-29 10:07:14 +02003455 insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
Tejun Heoe22bee72010-06-29 10:07:14 +02003456 worker->scheduled.next,
3457 work_color_to_flags(WORK_NO_COLOR));
3458 }
3459
3460 /* relinquish manager role */
3461 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
3462
Tejun Heodb7bccf2010-06-29 10:07:12 +02003463 /* notify completion */
3464 gcwq->trustee = NULL;
3465 gcwq->trustee_state = TRUSTEE_DONE;
3466 wake_up_all(&gcwq->trustee_wait);
3467 spin_unlock_irq(&gcwq->lock);
3468 return 0;
3469}
3470
3471/**
3472 * wait_trustee_state - wait for trustee to enter the specified state
3473 * @gcwq: gcwq the trustee of interest belongs to
3474 * @state: target state to wait for
3475 *
3476 * Wait for the trustee to reach @state. DONE is already matched.
3477 *
3478 * CONTEXT:
3479 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3480 * multiple times. To be used by cpu_callback.
3481 */
3482static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09003483__releases(&gcwq->lock)
3484__acquires(&gcwq->lock)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003485{
3486 if (!(gcwq->trustee_state == state ||
3487 gcwq->trustee_state == TRUSTEE_DONE)) {
3488 spin_unlock_irq(&gcwq->lock);
3489 __wait_event(gcwq->trustee_wait,
3490 gcwq->trustee_state == state ||
3491 gcwq->trustee_state == TRUSTEE_DONE);
3492 spin_lock_irq(&gcwq->lock);
3493 }
3494}
3495
Oleg Nesterov3af244332007-05-09 02:34:09 -07003496static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
3497 unsigned long action,
3498 void *hcpu)
3499{
3500 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003501 struct global_cwq *gcwq = get_gcwq(cpu);
3502 struct task_struct *new_trustee = NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +02003503 struct worker *uninitialized_var(new_worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003504 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003505
Rafael J. Wysocki8bb78442007-05-09 02:35:10 -07003506 action &= ~CPU_TASKS_FROZEN;
3507
Linus Torvalds1da177e2005-04-16 15:20:36 -07003508 switch (action) {
Tejun Heodb7bccf2010-06-29 10:07:12 +02003509 case CPU_DOWN_PREPARE:
3510 new_trustee = kthread_create(trustee_thread, gcwq,
3511 "workqueue_trustee/%d\n", cpu);
3512 if (IS_ERR(new_trustee))
3513 return notifier_from_errno(PTR_ERR(new_trustee));
3514 kthread_bind(new_trustee, cpu);
Tejun Heoe22bee72010-06-29 10:07:14 +02003515 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003516 case CPU_UP_PREPARE:
Tejun Heoe22bee72010-06-29 10:07:14 +02003517 BUG_ON(gcwq->first_idle);
3518 new_worker = create_worker(gcwq, false);
3519 if (!new_worker) {
3520 if (new_trustee)
3521 kthread_stop(new_trustee);
3522 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003523 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003524 }
3525
Tejun Heodb7bccf2010-06-29 10:07:12 +02003526 /* some are called w/ irq disabled, don't disturb irq status */
3527 spin_lock_irqsave(&gcwq->lock, flags);
3528
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003529 switch (action) {
Tejun Heodb7bccf2010-06-29 10:07:12 +02003530 case CPU_DOWN_PREPARE:
3531 /* initialize trustee and tell it to acquire the gcwq */
3532 BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3533 gcwq->trustee = new_trustee;
3534 gcwq->trustee_state = TRUSTEE_START;
3535 wake_up_process(gcwq->trustee);
3536 wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003537 /* fall through */
3538 case CPU_UP_PREPARE:
3539 BUG_ON(gcwq->first_idle);
3540 gcwq->first_idle = new_worker;
3541 break;
3542
3543 case CPU_DYING:
3544 /*
3545 * Before this, the trustee and all workers except for
3546 * the ones which are still executing works from
3547 * before the last CPU down must be on the cpu. After
3548 * this, they'll all be diasporas.
3549 */
3550 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003551 break;
3552
Oleg Nesterov3da1c842008-07-25 01:47:50 -07003553 case CPU_POST_DEAD:
Tejun Heodb7bccf2010-06-29 10:07:12 +02003554 gcwq->trustee_state = TRUSTEE_BUTCHER;
Tejun Heoe22bee72010-06-29 10:07:14 +02003555 /* fall through */
3556 case CPU_UP_CANCELED:
3557 destroy_worker(gcwq->first_idle);
3558 gcwq->first_idle = NULL;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003559 break;
3560
3561 case CPU_DOWN_FAILED:
3562 case CPU_ONLINE:
Tejun Heoe22bee72010-06-29 10:07:14 +02003563 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003564 if (gcwq->trustee_state != TRUSTEE_DONE) {
3565 gcwq->trustee_state = TRUSTEE_RELEASE;
3566 wake_up_process(gcwq->trustee);
3567 wait_trustee_state(gcwq, TRUSTEE_DONE);
3568 }
3569
Tejun Heoe22bee72010-06-29 10:07:14 +02003570 /*
3571 * Trustee is done and there might be no worker left.
3572 * Put the first_idle in and request a real manager to
3573 * take a look.
3574 */
3575 spin_unlock_irq(&gcwq->lock);
3576 kthread_bind(gcwq->first_idle->task, cpu);
3577 spin_lock_irq(&gcwq->lock);
3578 gcwq->flags |= GCWQ_MANAGE_WORKERS;
3579 start_worker(gcwq->first_idle);
3580 gcwq->first_idle = NULL;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003581 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003582 }
3583
Tejun Heodb7bccf2010-06-29 10:07:12 +02003584 spin_unlock_irqrestore(&gcwq->lock, flags);
3585
Tejun Heo15376632010-06-29 10:07:11 +02003586 return notifier_from_errno(0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003587}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003588
Rusty Russell2d3854a2008-11-05 13:39:10 +11003589#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003590
Rusty Russell2d3854a2008-11-05 13:39:10 +11003591struct work_for_cpu {
Andrew Morton6b440032009-04-09 09:50:37 -06003592 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003593 long (*fn)(void *);
3594 void *arg;
3595 long ret;
3596};
3597
Andrew Morton6b440032009-04-09 09:50:37 -06003598static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003599{
Andrew Morton6b440032009-04-09 09:50:37 -06003600 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003601 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b440032009-04-09 09:50:37 -06003602 complete(&wfc->completion);
3603 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003604}
3605
3606/**
3607 * work_on_cpu - run a function in user context on a particular cpu
3608 * @cpu: the cpu to run on
3609 * @fn: the function to run
3610 * @arg: the function arg
3611 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003612 * This will return the value @fn returns.
3613 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06003614 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003615 */
3616long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3617{
Andrew Morton6b440032009-04-09 09:50:37 -06003618 struct task_struct *sub_thread;
3619 struct work_for_cpu wfc = {
3620 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3621 .fn = fn,
3622 .arg = arg,
3623 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003624
Andrew Morton6b440032009-04-09 09:50:37 -06003625 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3626 if (IS_ERR(sub_thread))
3627 return PTR_ERR(sub_thread);
3628 kthread_bind(sub_thread, cpu);
3629 wake_up_process(sub_thread);
3630 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003631 return wfc.ret;
3632}
3633EXPORT_SYMBOL_GPL(work_on_cpu);
3634#endif /* CONFIG_SMP */
3635
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003636#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303637
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003638/**
3639 * freeze_workqueues_begin - begin freezing workqueues
3640 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003641 * Start freezing workqueues. After this function returns, all freezable
3642 * workqueues will queue new works to their frozen_works list instead of
3643 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003644 *
3645 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003646 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003647 */
3648void freeze_workqueues_begin(void)
3649{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003650 unsigned int cpu;
3651
3652 spin_lock(&workqueue_lock);
3653
3654 BUG_ON(workqueue_freezing);
3655 workqueue_freezing = true;
3656
Tejun Heof3421792010-07-02 10:03:51 +02003657 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003658 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003659 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003660
3661 spin_lock_irq(&gcwq->lock);
3662
Tejun Heodb7bccf2010-06-29 10:07:12 +02003663 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3664 gcwq->flags |= GCWQ_FREEZING;
3665
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003666 list_for_each_entry(wq, &workqueues, list) {
3667 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3668
Tejun Heo58a69cb2011-02-16 09:25:31 +01003669 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003670 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003671 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003672
3673 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003674 }
3675
3676 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003677}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003678
3679/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003680 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003681 *
3682 * Check whether freezing is complete. This function must be called
3683 * between freeze_workqueues_begin() and thaw_workqueues().
3684 *
3685 * CONTEXT:
3686 * Grabs and releases workqueue_lock.
3687 *
3688 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003689 * %true if some freezable workqueues are still busy. %false if freezing
3690 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003691 */
3692bool freeze_workqueues_busy(void)
3693{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003694 unsigned int cpu;
3695 bool busy = false;
3696
3697 spin_lock(&workqueue_lock);
3698
3699 BUG_ON(!workqueue_freezing);
3700
Tejun Heof3421792010-07-02 10:03:51 +02003701 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003702 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003703 /*
3704 * nr_active is monotonically decreasing. It's safe
3705 * to peek without lock.
3706 */
3707 list_for_each_entry(wq, &workqueues, list) {
3708 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3709
Tejun Heo58a69cb2011-02-16 09:25:31 +01003710 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003711 continue;
3712
3713 BUG_ON(cwq->nr_active < 0);
3714 if (cwq->nr_active) {
3715 busy = true;
3716 goto out_unlock;
3717 }
3718 }
3719 }
3720out_unlock:
3721 spin_unlock(&workqueue_lock);
3722 return busy;
3723}
3724
3725/**
3726 * thaw_workqueues - thaw workqueues
3727 *
3728 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003729 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003730 *
3731 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003732 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003733 */
3734void thaw_workqueues(void)
3735{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003736 unsigned int cpu;
3737
3738 spin_lock(&workqueue_lock);
3739
3740 if (!workqueue_freezing)
3741 goto out_unlock;
3742
Tejun Heof3421792010-07-02 10:03:51 +02003743 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003744 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003745 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003746
3747 spin_lock_irq(&gcwq->lock);
3748
Tejun Heodb7bccf2010-06-29 10:07:12 +02003749 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3750 gcwq->flags &= ~GCWQ_FREEZING;
3751
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003752 list_for_each_entry(wq, &workqueues, list) {
3753 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3754
Tejun Heo58a69cb2011-02-16 09:25:31 +01003755 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003756 continue;
3757
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003758 /* restore max_active and repopulate worklist */
3759 cwq->max_active = wq->saved_max_active;
3760
3761 while (!list_empty(&cwq->delayed_works) &&
3762 cwq->nr_active < cwq->max_active)
3763 cwq_activate_first_delayed(cwq);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003764 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003765
Tejun Heoe22bee72010-06-29 10:07:14 +02003766 wake_up_worker(gcwq);
3767
Tejun Heo8b03ae32010-06-29 10:07:12 +02003768 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003769 }
3770
3771 workqueue_freezing = false;
3772out_unlock:
3773 spin_unlock(&workqueue_lock);
3774}
3775#endif /* CONFIG_FREEZER */
3776
Suresh Siddha6ee05782010-07-30 14:57:37 -07003777static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003778{
Tejun Heoc34056a2010-06-29 10:07:11 +02003779 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003780 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02003781
Tejun Heof6500942010-08-09 11:50:34 +02003782 cpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003783
3784 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003785 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003786 struct global_cwq *gcwq = get_gcwq(cpu);
3787
3788 spin_lock_init(&gcwq->lock);
Tejun Heo7e116292010-06-29 10:07:13 +02003789 INIT_LIST_HEAD(&gcwq->worklist);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003790 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003791 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003792
Tejun Heoc8e55f32010-06-29 10:07:12 +02003793 INIT_LIST_HEAD(&gcwq->idle_list);
3794 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3795 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3796
Tejun Heoe22bee72010-06-29 10:07:14 +02003797 init_timer_deferrable(&gcwq->idle_timer);
3798 gcwq->idle_timer.function = idle_worker_timeout;
3799 gcwq->idle_timer.data = (unsigned long)gcwq;
3800
3801 setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout,
3802 (unsigned long)gcwq);
3803
Tejun Heo8b03ae32010-06-29 10:07:12 +02003804 ida_init(&gcwq->worker_ida);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003805
3806 gcwq->trustee_state = TRUSTEE_DONE;
3807 init_waitqueue_head(&gcwq->trustee_wait);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003808 }
3809
Tejun Heoe22bee72010-06-29 10:07:14 +02003810 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003811 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003812 struct global_cwq *gcwq = get_gcwq(cpu);
3813 struct worker *worker;
3814
Tejun Heo477a3c32010-08-31 10:54:35 +02003815 if (cpu != WORK_CPU_UNBOUND)
3816 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heoe22bee72010-06-29 10:07:14 +02003817 worker = create_worker(gcwq, true);
3818 BUG_ON(!worker);
3819 spin_lock_irq(&gcwq->lock);
3820 start_worker(worker);
3821 spin_unlock_irq(&gcwq->lock);
3822 }
3823
Tejun Heod320c032010-06-29 10:07:14 +02003824 system_wq = alloc_workqueue("events", 0, 0);
3825 system_long_wq = alloc_workqueue("events_long", 0, 0);
3826 system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003827 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3828 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003829 system_freezable_wq = alloc_workqueue("events_freezable",
3830 WQ_FREEZABLE, 0);
Alan Stern62d3c542012-03-02 10:51:00 +01003831 system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
3832 WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
Hitoshi Mitakee5cba242010-11-26 12:06:44 +01003833 BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
Alan Stern62d3c542012-03-02 10:51:00 +01003834 !system_unbound_wq || !system_freezable_wq ||
3835 !system_nrt_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003836 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003837}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003838early_initcall(init_workqueues);