blob: c36c86cf7900a3e116abdc46d41dd416ae181862 [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
548 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200549}
550
551static struct global_cwq *get_work_gcwq(struct work_struct *work)
552{
Tejun Heoe1201532010-07-22 14:14:25 +0200553 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200554 unsigned int cpu;
555
Tejun Heoe1201532010-07-22 14:14:25 +0200556 if (data & WORK_STRUCT_CWQ)
557 return ((struct cpu_workqueue_struct *)
558 (data & WORK_STRUCT_WQ_DATA_MASK))->gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200559
560 cpu = data >> WORK_STRUCT_FLAG_BITS;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200561 if (cpu == WORK_CPU_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200562 return NULL;
563
Tejun Heof3421792010-07-02 10:03:51 +0200564 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200565 return get_gcwq(cpu);
David Howells365970a2006-11-22 14:54:49 +0000566}
567
568/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200569 * Policy functions. These define the policies on how the global
570 * worker pool is managed. Unless noted otherwise, these functions
571 * assume that they're being called with gcwq->lock held.
David Howells365970a2006-11-22 14:54:49 +0000572 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200573
Tejun Heo649027d2010-06-29 10:07:14 +0200574static bool __need_more_worker(struct global_cwq *gcwq)
David Howells365970a2006-11-22 14:54:49 +0000575{
Tejun Heo649027d2010-06-29 10:07:14 +0200576 return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) ||
577 gcwq->flags & GCWQ_HIGHPRI_PENDING;
David Howells365970a2006-11-22 14:54:49 +0000578}
579
Tejun Heoe22bee72010-06-29 10:07:14 +0200580/*
581 * Need to wake up a worker? Called from anything but currently
582 * running workers.
583 */
584static bool need_more_worker(struct global_cwq *gcwq)
David Howells365970a2006-11-22 14:54:49 +0000585{
Tejun Heo649027d2010-06-29 10:07:14 +0200586 return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq);
David Howells365970a2006-11-22 14:54:49 +0000587}
588
Tejun Heoe22bee72010-06-29 10:07:14 +0200589/* Can I start working? Called from busy but !running workers. */
590static bool may_start_working(struct global_cwq *gcwq)
591{
592 return gcwq->nr_idle;
593}
594
595/* Do I need to keep working? Called from currently running workers. */
596static bool keep_working(struct global_cwq *gcwq)
597{
598 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
599
Tejun Heo30310042010-10-11 11:51:57 +0200600 return !list_empty(&gcwq->worklist) &&
601 (atomic_read(nr_running) <= 1 ||
602 gcwq->flags & GCWQ_HIGHPRI_PENDING);
Tejun Heoe22bee72010-06-29 10:07:14 +0200603}
604
605/* Do we need a new worker? Called from manager. */
606static bool need_to_create_worker(struct global_cwq *gcwq)
607{
608 return need_more_worker(gcwq) && !may_start_working(gcwq);
609}
610
611/* Do I need to be the manager? */
612static bool need_to_manage_workers(struct global_cwq *gcwq)
613{
614 return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS;
615}
616
617/* Do we have too many workers and should some go away? */
618static bool too_many_workers(struct global_cwq *gcwq)
619{
620 bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS;
621 int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */
622 int nr_busy = gcwq->nr_workers - nr_idle;
623
624 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
625}
626
627/*
628 * Wake up functions.
629 */
630
Tejun Heo7e116292010-06-29 10:07:13 +0200631/* Return the first worker. Safe with preemption disabled */
632static struct worker *first_worker(struct global_cwq *gcwq)
633{
634 if (unlikely(list_empty(&gcwq->idle_list)))
635 return NULL;
636
637 return list_first_entry(&gcwq->idle_list, struct worker, entry);
638}
639
640/**
641 * wake_up_worker - wake up an idle worker
642 * @gcwq: gcwq to wake worker for
643 *
644 * Wake up the first idle worker of @gcwq.
645 *
646 * CONTEXT:
647 * spin_lock_irq(gcwq->lock).
648 */
649static void wake_up_worker(struct global_cwq *gcwq)
650{
651 struct worker *worker = first_worker(gcwq);
652
653 if (likely(worker))
654 wake_up_process(worker->task);
655}
656
Tejun Heo4690c4a2010-06-29 10:07:10 +0200657/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200658 * wq_worker_waking_up - a worker is waking up
659 * @task: task waking up
660 * @cpu: CPU @task is waking up to
661 *
662 * This function is called during try_to_wake_up() when a worker is
663 * being awoken.
664 *
665 * CONTEXT:
666 * spin_lock_irq(rq->lock)
667 */
668void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
669{
670 struct worker *worker = kthread_data(task);
671
Steven Rostedt2d646722010-12-03 23:12:33 -0500672 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe22bee72010-06-29 10:07:14 +0200673 atomic_inc(get_gcwq_nr_running(cpu));
674}
675
676/**
677 * wq_worker_sleeping - a worker is going to sleep
678 * @task: task going to sleep
679 * @cpu: CPU in question, must be the current CPU number
680 *
681 * This function is called during schedule() when a busy worker is
682 * going to sleep. Worker on the same cpu can be woken up by
683 * returning pointer to its task.
684 *
685 * CONTEXT:
686 * spin_lock_irq(rq->lock)
687 *
688 * RETURNS:
689 * Worker task on @cpu to wake up, %NULL if none.
690 */
691struct task_struct *wq_worker_sleeping(struct task_struct *task,
692 unsigned int cpu)
693{
694 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
695 struct global_cwq *gcwq = get_gcwq(cpu);
696 atomic_t *nr_running = get_gcwq_nr_running(cpu);
697
Steven Rostedt2d646722010-12-03 23:12:33 -0500698 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200699 return NULL;
700
701 /* this can only happen on the local cpu */
702 BUG_ON(cpu != raw_smp_processor_id());
703
704 /*
705 * The counterpart of the following dec_and_test, implied mb,
706 * worklist not empty test sequence is in insert_work().
707 * Please read comment there.
708 *
709 * NOT_RUNNING is clear. This means that trustee is not in
710 * charge and we're running on the local cpu w/ rq lock held
711 * and preemption disabled, which in turn means that none else
712 * could be manipulating idle_list, so dereferencing idle_list
713 * without gcwq lock is safe.
714 */
715 if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist))
716 to_wakeup = first_worker(gcwq);
717 return to_wakeup ? to_wakeup->task : NULL;
718}
719
720/**
721 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200722 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200723 * @flags: flags to set
724 * @wakeup: wakeup an idle worker if necessary
725 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200726 * Set @flags in @worker->flags and adjust nr_running accordingly. If
727 * nr_running becomes zero and @wakeup is %true, an idle worker is
728 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200729 *
Tejun Heocb444762010-07-02 10:03:50 +0200730 * CONTEXT:
731 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200732 */
733static inline void worker_set_flags(struct worker *worker, unsigned int flags,
734 bool wakeup)
735{
Tejun Heoe22bee72010-06-29 10:07:14 +0200736 struct global_cwq *gcwq = worker->gcwq;
737
Tejun Heocb444762010-07-02 10:03:50 +0200738 WARN_ON_ONCE(worker->task != current);
739
Tejun Heoe22bee72010-06-29 10:07:14 +0200740 /*
741 * If transitioning into NOT_RUNNING, adjust nr_running and
742 * wake up an idle worker as necessary if requested by
743 * @wakeup.
744 */
745 if ((flags & WORKER_NOT_RUNNING) &&
746 !(worker->flags & WORKER_NOT_RUNNING)) {
747 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
748
749 if (wakeup) {
750 if (atomic_dec_and_test(nr_running) &&
751 !list_empty(&gcwq->worklist))
752 wake_up_worker(gcwq);
753 } else
754 atomic_dec(nr_running);
755 }
756
Tejun Heod302f012010-06-29 10:07:13 +0200757 worker->flags |= flags;
758}
759
760/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200761 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200762 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200763 * @flags: flags to clear
764 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200765 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200766 *
Tejun Heocb444762010-07-02 10:03:50 +0200767 * CONTEXT:
768 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200769 */
770static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
771{
Tejun Heoe22bee72010-06-29 10:07:14 +0200772 struct global_cwq *gcwq = worker->gcwq;
773 unsigned int oflags = worker->flags;
774
Tejun Heocb444762010-07-02 10:03:50 +0200775 WARN_ON_ONCE(worker->task != current);
776
Tejun Heod302f012010-06-29 10:07:13 +0200777 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200778
Tejun Heo42c025f2011-01-11 15:58:49 +0100779 /*
780 * If transitioning out of NOT_RUNNING, increment nr_running. Note
781 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
782 * of multiple flags, not a single flag.
783 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200784 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
785 if (!(worker->flags & WORKER_NOT_RUNNING))
786 atomic_inc(get_gcwq_nr_running(gcwq->cpu));
Tejun Heod302f012010-06-29 10:07:13 +0200787}
788
789/**
Tejun Heoc8e55f32010-06-29 10:07:12 +0200790 * busy_worker_head - return the busy hash head for a work
791 * @gcwq: gcwq of interest
792 * @work: work to be hashed
793 *
794 * Return hash head of @gcwq for @work.
795 *
796 * CONTEXT:
797 * spin_lock_irq(gcwq->lock).
798 *
799 * RETURNS:
800 * Pointer to the hash head.
801 */
802static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
803 struct work_struct *work)
804{
805 const int base_shift = ilog2(sizeof(struct work_struct));
806 unsigned long v = (unsigned long)work;
807
808 /* simple shift and fold hash, do we need something better? */
809 v >>= base_shift;
810 v += v >> BUSY_WORKER_HASH_ORDER;
811 v &= BUSY_WORKER_HASH_MASK;
812
813 return &gcwq->busy_hash[v];
814}
815
816/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200817 * __find_worker_executing_work - find worker which is executing a work
818 * @gcwq: gcwq of interest
819 * @bwh: hash head as returned by busy_worker_head()
820 * @work: work to find worker for
821 *
822 * Find a worker which is executing @work on @gcwq. @bwh should be
823 * the hash head obtained by calling busy_worker_head() with the same
824 * work.
825 *
826 * CONTEXT:
827 * spin_lock_irq(gcwq->lock).
828 *
829 * RETURNS:
830 * Pointer to worker which is executing @work if found, NULL
831 * otherwise.
832 */
833static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
834 struct hlist_head *bwh,
835 struct work_struct *work)
836{
837 struct worker *worker;
838 struct hlist_node *tmp;
839
840 hlist_for_each_entry(worker, tmp, bwh, hentry)
841 if (worker->current_work == work)
842 return worker;
843 return NULL;
844}
845
846/**
847 * find_worker_executing_work - find worker which is executing a work
848 * @gcwq: gcwq of interest
849 * @work: work to find worker for
850 *
851 * Find a worker which is executing @work on @gcwq. This function is
852 * identical to __find_worker_executing_work() except that this
853 * function calculates @bwh itself.
854 *
855 * CONTEXT:
856 * spin_lock_irq(gcwq->lock).
857 *
858 * RETURNS:
859 * Pointer to worker which is executing @work if found, NULL
860 * otherwise.
861 */
862static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
863 struct work_struct *work)
864{
865 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
866 work);
867}
868
869/**
Tejun Heo649027d2010-06-29 10:07:14 +0200870 * gcwq_determine_ins_pos - find insertion position
871 * @gcwq: gcwq of interest
872 * @cwq: cwq a work is being queued for
873 *
874 * A work for @cwq is about to be queued on @gcwq, determine insertion
875 * position for the work. If @cwq is for HIGHPRI wq, the work is
876 * queued at the head of the queue but in FIFO order with respect to
877 * other HIGHPRI works; otherwise, at the end of the queue. This
878 * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that
879 * there are HIGHPRI works pending.
880 *
881 * CONTEXT:
882 * spin_lock_irq(gcwq->lock).
883 *
884 * RETURNS:
885 * Pointer to inserstion position.
886 */
887static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq,
888 struct cpu_workqueue_struct *cwq)
889{
890 struct work_struct *twork;
891
892 if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
893 return &gcwq->worklist;
894
895 list_for_each_entry(twork, &gcwq->worklist, entry) {
896 struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
897
898 if (!(tcwq->wq->flags & WQ_HIGHPRI))
899 break;
900 }
901
902 gcwq->flags |= GCWQ_HIGHPRI_PENDING;
903 return &twork->entry;
904}
905
906/**
Tejun Heo7e116292010-06-29 10:07:13 +0200907 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +0200908 * @cwq: cwq @work belongs to
909 * @work: work to insert
910 * @head: insertion point
911 * @extra_flags: extra WORK_STRUCT_* flags to set
912 *
Tejun Heo7e116292010-06-29 10:07:13 +0200913 * Insert @work which belongs to @cwq into @gcwq after @head.
914 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200915 *
916 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +0200917 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +0200918 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700919static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +0200920 struct work_struct *work, struct list_head *head,
921 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700922{
Tejun Heoe22bee72010-06-29 10:07:14 +0200923 struct global_cwq *gcwq = cwq->gcwq;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +0100924
Tejun Heo4690c4a2010-06-29 10:07:10 +0200925 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200926 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +0200927
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700928 /*
929 * Ensure that we get the right work->data if we see the
930 * result of list_add() below, see try_to_grab_pending().
931 */
932 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +0200933
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -0700934 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +0200935
936 /*
937 * Ensure either worker_sched_deactivated() sees the above
938 * list_add_tail() or we see zero nr_running to avoid workers
939 * lying around lazily while there are works to be processed.
940 */
941 smp_mb();
942
Tejun Heo649027d2010-06-29 10:07:14 +0200943 if (__need_more_worker(gcwq))
Tejun Heoe22bee72010-06-29 10:07:14 +0200944 wake_up_worker(gcwq);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700945}
946
Tejun Heoc8efcc22010-12-20 19:32:04 +0100947/*
948 * Test whether @work is being queued from another work executing on the
949 * same workqueue. This is rather expensive and should only be used from
950 * cold paths.
951 */
952static bool is_chained_work(struct workqueue_struct *wq)
953{
954 unsigned long flags;
955 unsigned int cpu;
956
957 for_each_gcwq_cpu(cpu) {
958 struct global_cwq *gcwq = get_gcwq(cpu);
959 struct worker *worker;
960 struct hlist_node *pos;
961 int i;
962
963 spin_lock_irqsave(&gcwq->lock, flags);
964 for_each_busy_worker(worker, i, pos, gcwq) {
965 if (worker->task != current)
966 continue;
967 spin_unlock_irqrestore(&gcwq->lock, flags);
968 /*
969 * I'm @worker, no locking necessary. See if @work
970 * is headed to the same workqueue.
971 */
972 return worker->current_cwq->wq == wq;
973 }
974 spin_unlock_irqrestore(&gcwq->lock, flags);
975 }
976 return false;
977}
978
Tejun Heo4690c4a2010-06-29 10:07:10 +0200979static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 struct work_struct *work)
981{
Tejun Heo502ca9d2010-06-29 10:07:13 +0200982 struct global_cwq *gcwq;
983 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200984 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +0200985 unsigned int work_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 unsigned long flags;
987
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900988 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200989
Tejun Heoc8efcc22010-12-20 19:32:04 +0100990 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200991 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +0100992 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +0200993 return;
994
Tejun Heoc7fc77f2010-07-02 10:03:51 +0200995 /* determine gcwq to use */
996 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +0200997 struct global_cwq *last_gcwq;
998
Tejun Heoc7fc77f2010-07-02 10:03:51 +0200999 if (unlikely(cpu == WORK_CPU_UNBOUND))
1000 cpu = raw_smp_processor_id();
1001
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001002 /*
1003 * It's multi cpu. If @wq is non-reentrant and @work
1004 * was previously on a different cpu, it might still
1005 * be running there, in which case the work needs to
1006 * be queued on that cpu to guarantee non-reentrance.
1007 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001008 gcwq = get_gcwq(cpu);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001009 if (wq->flags & WQ_NON_REENTRANT &&
1010 (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
1011 struct worker *worker;
1012
1013 spin_lock_irqsave(&last_gcwq->lock, flags);
1014
1015 worker = find_worker_executing_work(last_gcwq, work);
1016
1017 if (worker && worker->current_cwq->wq == wq)
1018 gcwq = last_gcwq;
1019 else {
1020 /* meh... not running there, queue here */
1021 spin_unlock_irqrestore(&last_gcwq->lock, flags);
1022 spin_lock_irqsave(&gcwq->lock, flags);
1023 }
1024 } else
1025 spin_lock_irqsave(&gcwq->lock, flags);
Tejun Heof3421792010-07-02 10:03:51 +02001026 } else {
1027 gcwq = get_gcwq(WORK_CPU_UNBOUND);
1028 spin_lock_irqsave(&gcwq->lock, flags);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001029 }
1030
1031 /* gcwq determined, get cwq and queue */
1032 cwq = get_cwq(gcwq->cpu, wq);
Tejun Heocdadf002010-10-05 10:49:55 +02001033 trace_workqueue_queue_work(cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001034
Dan Carpenterf5b25522012-04-13 22:06:58 +03001035 if (WARN_ON(!list_empty(&work->entry))) {
1036 spin_unlock_irqrestore(&gcwq->lock, flags);
1037 return;
1038 }
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
Tejun Heo4690c4a2010-06-29 10:07:10 +02001107 __queue_work(smp_processor_id(), cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108}
1109
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001110/**
1111 * queue_delayed_work - queue work on a workqueue after delay
1112 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001113 * @dwork: delayable work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001114 * @delay: number of jiffies to wait before queueing
1115 *
Alan Stern057647f2006-10-28 10:38:58 -07001116 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001117 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001118int queue_delayed_work(struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +00001119 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120{
David Howells52bad642006-11-22 14:54:01 +00001121 if (delay == 0)
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001122 return queue_work(wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001124 return queue_delayed_work_on(-1, wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125}
Dave Jonesae90dd52006-06-30 01:40:45 -04001126EXPORT_SYMBOL_GPL(queue_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001128/**
1129 * queue_delayed_work_on - queue work on specific CPU after delay
1130 * @cpu: CPU number to execute work on
1131 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001132 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001133 * @delay: number of jiffies to wait before queueing
1134 *
Alan Stern057647f2006-10-28 10:38:58 -07001135 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001136 */
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001137int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +00001138 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001139{
1140 int ret = 0;
David Howells52bad642006-11-22 14:54:01 +00001141 struct timer_list *timer = &dwork->timer;
1142 struct work_struct *work = &dwork->work;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001143
Tejun Heo22df02b2010-06-29 10:07:10 +02001144 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001145 unsigned int lcpu;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001146
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001147 BUG_ON(timer_pending(timer));
1148 BUG_ON(!list_empty(&work->entry));
1149
Andrew Liu8a3e77c2008-05-01 04:35:14 -07001150 timer_stats_timer_set_start_info(&dwork->timer);
1151
Tejun Heo7a22ad72010-06-29 10:07:13 +02001152 /*
1153 * This stores cwq for the moment, for the timer_fn.
1154 * Note that the work's gcwq is preserved to allow
1155 * reentrance detection for delayed works.
1156 */
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001157 if (!(wq->flags & WQ_UNBOUND)) {
1158 struct global_cwq *gcwq = get_work_gcwq(work);
1159
1160 if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1161 lcpu = gcwq->cpu;
1162 else
1163 lcpu = raw_smp_processor_id();
1164 } else
1165 lcpu = WORK_CPU_UNBOUND;
1166
Tejun Heo7a22ad72010-06-29 10:07:13 +02001167 set_work_cwq(work, get_cwq(lcpu, wq), 0);
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001168
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001169 timer->expires = jiffies + delay;
David Howells52bad642006-11-22 14:54:01 +00001170 timer->data = (unsigned long)dwork;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001171 timer->function = delayed_work_timer_fn;
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001172
1173 if (unlikely(cpu >= 0))
1174 add_timer_on(timer, cpu);
1175 else
1176 add_timer(timer);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001177 ret = 1;
1178 }
1179 return ret;
1180}
Dave Jonesae90dd52006-06-30 01:40:45 -04001181EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182
Tejun Heoc8e55f32010-06-29 10:07:12 +02001183/**
1184 * worker_enter_idle - enter idle state
1185 * @worker: worker which is entering idle state
1186 *
1187 * @worker is entering idle state. Update stats and idle timer if
1188 * necessary.
1189 *
1190 * LOCKING:
1191 * spin_lock_irq(gcwq->lock).
1192 */
1193static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194{
Tejun Heoc8e55f32010-06-29 10:07:12 +02001195 struct global_cwq *gcwq = worker->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196
Tejun Heoc8e55f32010-06-29 10:07:12 +02001197 BUG_ON(worker->flags & WORKER_IDLE);
1198 BUG_ON(!list_empty(&worker->entry) &&
1199 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200
Tejun Heocb444762010-07-02 10:03:50 +02001201 /* can't use worker_set_flags(), also called from start_worker() */
1202 worker->flags |= WORKER_IDLE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001203 gcwq->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001204 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001205
Tejun Heoc8e55f32010-06-29 10:07:12 +02001206 /* idle_list is LIFO */
1207 list_add(&worker->entry, &gcwq->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001208
Tejun Heoe22bee72010-06-29 10:07:14 +02001209 if (likely(!(worker->flags & WORKER_ROGUE))) {
1210 if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer))
1211 mod_timer(&gcwq->idle_timer,
1212 jiffies + IDLE_WORKER_TIMEOUT);
1213 } else
Tejun Heodb7bccf2010-06-29 10:07:12 +02001214 wake_up_all(&gcwq->trustee_wait);
Tejun Heocb444762010-07-02 10:03:50 +02001215
Tejun Heo544ecf32012-05-14 15:04:50 -07001216 /*
1217 * Sanity check nr_running. Because trustee releases gcwq->lock
1218 * between setting %WORKER_ROGUE and zapping nr_running, the
1219 * warning may trigger spuriously. Check iff trustee is idle.
1220 */
1221 WARN_ON_ONCE(gcwq->trustee_state == TRUSTEE_DONE &&
1222 gcwq->nr_workers == gcwq->nr_idle &&
Tejun Heocb444762010-07-02 10:03:50 +02001223 atomic_read(get_gcwq_nr_running(gcwq->cpu)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224}
1225
Tejun Heoc8e55f32010-06-29 10:07:12 +02001226/**
1227 * worker_leave_idle - leave idle state
1228 * @worker: worker which is leaving idle state
1229 *
1230 * @worker is leaving idle state. Update stats.
1231 *
1232 * LOCKING:
1233 * spin_lock_irq(gcwq->lock).
1234 */
1235static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236{
Tejun Heoc8e55f32010-06-29 10:07:12 +02001237 struct global_cwq *gcwq = worker->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238
Tejun Heoc8e55f32010-06-29 10:07:12 +02001239 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001240 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001241 gcwq->nr_idle--;
1242 list_del_init(&worker->entry);
1243}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244
Tejun Heoe22bee72010-06-29 10:07:14 +02001245/**
1246 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1247 * @worker: self
1248 *
1249 * Works which are scheduled while the cpu is online must at least be
1250 * scheduled to a worker which is bound to the cpu so that if they are
1251 * flushed from cpu callbacks while cpu is going down, they are
1252 * guaranteed to execute on the cpu.
1253 *
1254 * This function is to be used by rogue workers and rescuers to bind
1255 * themselves to the target cpu and may race with cpu going down or
1256 * coming online. kthread_bind() can't be used because it may put the
1257 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1258 * verbatim as it's best effort and blocking and gcwq may be
1259 * [dis]associated in the meantime.
1260 *
1261 * This function tries set_cpus_allowed() and locks gcwq and verifies
1262 * the binding against GCWQ_DISASSOCIATED which is set during
1263 * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
1264 * idle state or fetches works without dropping lock, it can guarantee
1265 * the scheduling requirement described in the first paragraph.
1266 *
1267 * CONTEXT:
1268 * Might sleep. Called without any lock but returns with gcwq->lock
1269 * held.
1270 *
1271 * RETURNS:
1272 * %true if the associated gcwq is online (@worker is successfully
1273 * bound), %false if offline.
1274 */
1275static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001276__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001277{
1278 struct global_cwq *gcwq = worker->gcwq;
1279 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280
Tejun Heoe22bee72010-06-29 10:07:14 +02001281 while (true) {
1282 /*
1283 * The following call may fail, succeed or succeed
1284 * without actually migrating the task to the cpu if
1285 * it races with cpu hotunplug operation. Verify
1286 * against GCWQ_DISASSOCIATED.
1287 */
Tejun Heof3421792010-07-02 10:03:51 +02001288 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1289 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001290
Tejun Heoe22bee72010-06-29 10:07:14 +02001291 spin_lock_irq(&gcwq->lock);
1292 if (gcwq->flags & GCWQ_DISASSOCIATED)
1293 return false;
1294 if (task_cpu(task) == gcwq->cpu &&
1295 cpumask_equal(&current->cpus_allowed,
1296 get_cpu_mask(gcwq->cpu)))
1297 return true;
1298 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001299
Tejun Heo5035b202011-04-29 18:08:37 +02001300 /*
1301 * We've raced with CPU hot[un]plug. Give it a breather
1302 * and retry migration. cond_resched() is required here;
1303 * otherwise, we might deadlock against cpu_stop trying to
1304 * bring down the CPU on non-preemptive kernel.
1305 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001306 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001307 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001308 }
1309}
1310
1311/*
1312 * Function for worker->rebind_work used to rebind rogue busy workers
1313 * to the associated cpu which is coming back online. This is
1314 * scheduled by cpu up but can race with other cpu hotplug operations
1315 * and may be executed twice without intervening cpu down.
1316 */
1317static void worker_rebind_fn(struct work_struct *work)
1318{
1319 struct worker *worker = container_of(work, struct worker, rebind_work);
1320 struct global_cwq *gcwq = worker->gcwq;
1321
1322 if (worker_maybe_bind_and_lock(worker))
1323 worker_clr_flags(worker, WORKER_REBIND);
1324
1325 spin_unlock_irq(&gcwq->lock);
1326}
1327
Tejun Heoc34056a2010-06-29 10:07:11 +02001328static struct worker *alloc_worker(void)
1329{
1330 struct worker *worker;
1331
1332 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001333 if (worker) {
1334 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001335 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heoe22bee72010-06-29 10:07:14 +02001336 INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1337 /* on creation a worker is in !idle && prep state */
1338 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001339 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001340 return worker;
1341}
1342
1343/**
1344 * create_worker - create a new workqueue worker
Tejun Heo7e116292010-06-29 10:07:13 +02001345 * @gcwq: gcwq the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001346 * @bind: whether to set affinity to @cpu or not
1347 *
Tejun Heo7e116292010-06-29 10:07:13 +02001348 * Create a new worker which is bound to @gcwq. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001349 * can be started by calling start_worker() or destroyed using
1350 * destroy_worker().
1351 *
1352 * CONTEXT:
1353 * Might sleep. Does GFP_KERNEL allocations.
1354 *
1355 * RETURNS:
1356 * Pointer to the newly created worker.
1357 */
Tejun Heo7e116292010-06-29 10:07:13 +02001358static struct worker *create_worker(struct global_cwq *gcwq, bool bind)
Tejun Heoc34056a2010-06-29 10:07:11 +02001359{
Tejun Heof3421792010-07-02 10:03:51 +02001360 bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
Tejun Heoc34056a2010-06-29 10:07:11 +02001361 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001362 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001363
Tejun Heo8b03ae32010-06-29 10:07:12 +02001364 spin_lock_irq(&gcwq->lock);
1365 while (ida_get_new(&gcwq->worker_ida, &id)) {
1366 spin_unlock_irq(&gcwq->lock);
1367 if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001368 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001369 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001370 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001371 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001372
1373 worker = alloc_worker();
1374 if (!worker)
1375 goto fail;
1376
Tejun Heo8b03ae32010-06-29 10:07:12 +02001377 worker->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001378 worker->id = id;
1379
Tejun Heof3421792010-07-02 10:03:51 +02001380 if (!on_unbound_cpu)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001381 worker->task = kthread_create_on_node(worker_thread,
1382 worker,
1383 cpu_to_node(gcwq->cpu),
1384 "kworker/%u:%d", gcwq->cpu, id);
Tejun Heof3421792010-07-02 10:03:51 +02001385 else
1386 worker->task = kthread_create(worker_thread, worker,
1387 "kworker/u:%d", id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001388 if (IS_ERR(worker->task))
1389 goto fail;
1390
Tejun Heodb7bccf2010-06-29 10:07:12 +02001391 /*
1392 * A rogue worker will become a regular one if CPU comes
1393 * online later on. Make sure every worker has
1394 * PF_THREAD_BOUND set.
1395 */
Tejun Heof3421792010-07-02 10:03:51 +02001396 if (bind && !on_unbound_cpu)
Tejun Heo8b03ae32010-06-29 10:07:12 +02001397 kthread_bind(worker->task, gcwq->cpu);
Tejun Heof3421792010-07-02 10:03:51 +02001398 else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001399 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heof3421792010-07-02 10:03:51 +02001400 if (on_unbound_cpu)
1401 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001403
Tejun Heoc34056a2010-06-29 10:07:11 +02001404 return worker;
1405fail:
1406 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001407 spin_lock_irq(&gcwq->lock);
1408 ida_remove(&gcwq->worker_ida, id);
1409 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001410 }
1411 kfree(worker);
1412 return NULL;
1413}
1414
1415/**
1416 * start_worker - start a newly created worker
1417 * @worker: worker to start
1418 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001419 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001420 *
1421 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001422 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001423 */
1424static void start_worker(struct worker *worker)
1425{
Tejun Heocb444762010-07-02 10:03:50 +02001426 worker->flags |= WORKER_STARTED;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001427 worker->gcwq->nr_workers++;
1428 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001429 wake_up_process(worker->task);
1430}
1431
1432/**
1433 * destroy_worker - destroy a workqueue worker
1434 * @worker: worker to be destroyed
1435 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001436 * Destroy @worker and adjust @gcwq stats accordingly.
1437 *
1438 * CONTEXT:
1439 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001440 */
1441static void destroy_worker(struct worker *worker)
1442{
Tejun Heo8b03ae32010-06-29 10:07:12 +02001443 struct global_cwq *gcwq = worker->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001444 int id = worker->id;
1445
1446 /* sanity check frenzy */
1447 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001448 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001449
Tejun Heoc8e55f32010-06-29 10:07:12 +02001450 if (worker->flags & WORKER_STARTED)
1451 gcwq->nr_workers--;
1452 if (worker->flags & WORKER_IDLE)
1453 gcwq->nr_idle--;
1454
1455 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001456 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001457
1458 spin_unlock_irq(&gcwq->lock);
1459
Tejun Heoc34056a2010-06-29 10:07:11 +02001460 kthread_stop(worker->task);
1461 kfree(worker);
1462
Tejun Heo8b03ae32010-06-29 10:07:12 +02001463 spin_lock_irq(&gcwq->lock);
1464 ida_remove(&gcwq->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001465}
1466
Tejun Heoe22bee72010-06-29 10:07:14 +02001467static void idle_worker_timeout(unsigned long __gcwq)
1468{
1469 struct global_cwq *gcwq = (void *)__gcwq;
1470
1471 spin_lock_irq(&gcwq->lock);
1472
1473 if (too_many_workers(gcwq)) {
1474 struct worker *worker;
1475 unsigned long expires;
1476
1477 /* idle_list is kept in LIFO order, check the last one */
1478 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1479 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1480
1481 if (time_before(jiffies, expires))
1482 mod_timer(&gcwq->idle_timer, expires);
1483 else {
1484 /* it's been idle for too long, wake up manager */
1485 gcwq->flags |= GCWQ_MANAGE_WORKERS;
1486 wake_up_worker(gcwq);
1487 }
1488 }
1489
1490 spin_unlock_irq(&gcwq->lock);
1491}
1492
1493static bool send_mayday(struct work_struct *work)
1494{
1495 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1496 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001497 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001498
1499 if (!(wq->flags & WQ_RESCUER))
1500 return false;
1501
1502 /* mayday mayday mayday */
Tejun Heof3421792010-07-02 10:03:51 +02001503 cpu = cwq->gcwq->cpu;
1504 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1505 if (cpu == WORK_CPU_UNBOUND)
1506 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001507 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001508 wake_up_process(wq->rescuer->task);
1509 return true;
1510}
1511
1512static void gcwq_mayday_timeout(unsigned long __gcwq)
1513{
1514 struct global_cwq *gcwq = (void *)__gcwq;
1515 struct work_struct *work;
1516
1517 spin_lock_irq(&gcwq->lock);
1518
1519 if (need_to_create_worker(gcwq)) {
1520 /*
1521 * We've been trying to create a new worker but
1522 * haven't been successful. We might be hitting an
1523 * allocation deadlock. Send distress signals to
1524 * rescuers.
1525 */
1526 list_for_each_entry(work, &gcwq->worklist, entry)
1527 send_mayday(work);
1528 }
1529
1530 spin_unlock_irq(&gcwq->lock);
1531
1532 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL);
1533}
1534
1535/**
1536 * maybe_create_worker - create a new worker if necessary
1537 * @gcwq: gcwq to create a new worker for
1538 *
1539 * Create a new worker for @gcwq if necessary. @gcwq is guaranteed to
1540 * have at least one idle worker on return from this function. If
1541 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1542 * sent to all rescuers with works scheduled on @gcwq to resolve
1543 * possible allocation deadlock.
1544 *
1545 * On return, need_to_create_worker() is guaranteed to be false and
1546 * may_start_working() true.
1547 *
1548 * LOCKING:
1549 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1550 * multiple times. Does GFP_KERNEL allocations. Called only from
1551 * manager.
1552 *
1553 * RETURNS:
1554 * false if no action was taken and gcwq->lock stayed locked, true
1555 * otherwise.
1556 */
1557static bool maybe_create_worker(struct global_cwq *gcwq)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001558__releases(&gcwq->lock)
1559__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001560{
1561 if (!need_to_create_worker(gcwq))
1562 return false;
1563restart:
Tejun Heo9f9c2362010-07-14 11:31:20 +02001564 spin_unlock_irq(&gcwq->lock);
1565
Tejun Heoe22bee72010-06-29 10:07:14 +02001566 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1567 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1568
1569 while (true) {
1570 struct worker *worker;
1571
Tejun Heoe22bee72010-06-29 10:07:14 +02001572 worker = create_worker(gcwq, true);
1573 if (worker) {
1574 del_timer_sync(&gcwq->mayday_timer);
1575 spin_lock_irq(&gcwq->lock);
1576 start_worker(worker);
1577 BUG_ON(need_to_create_worker(gcwq));
1578 return true;
1579 }
1580
1581 if (!need_to_create_worker(gcwq))
1582 break;
1583
Tejun Heoe22bee72010-06-29 10:07:14 +02001584 __set_current_state(TASK_INTERRUPTIBLE);
1585 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001586
Tejun Heoe22bee72010-06-29 10:07:14 +02001587 if (!need_to_create_worker(gcwq))
1588 break;
1589 }
1590
Tejun Heoe22bee72010-06-29 10:07:14 +02001591 del_timer_sync(&gcwq->mayday_timer);
1592 spin_lock_irq(&gcwq->lock);
1593 if (need_to_create_worker(gcwq))
1594 goto restart;
1595 return true;
1596}
1597
1598/**
1599 * maybe_destroy_worker - destroy workers which have been idle for a while
1600 * @gcwq: gcwq to destroy workers for
1601 *
1602 * Destroy @gcwq workers which have been idle for longer than
1603 * IDLE_WORKER_TIMEOUT.
1604 *
1605 * LOCKING:
1606 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1607 * multiple times. Called only from manager.
1608 *
1609 * RETURNS:
1610 * false if no action was taken and gcwq->lock stayed locked, true
1611 * otherwise.
1612 */
1613static bool maybe_destroy_workers(struct global_cwq *gcwq)
1614{
1615 bool ret = false;
1616
1617 while (too_many_workers(gcwq)) {
1618 struct worker *worker;
1619 unsigned long expires;
1620
1621 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1622 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1623
1624 if (time_before(jiffies, expires)) {
1625 mod_timer(&gcwq->idle_timer, expires);
1626 break;
1627 }
1628
1629 destroy_worker(worker);
1630 ret = true;
1631 }
1632
1633 return ret;
1634}
1635
1636/**
1637 * manage_workers - manage worker pool
1638 * @worker: self
1639 *
1640 * Assume the manager role and manage gcwq worker pool @worker belongs
1641 * to. At any given time, there can be only zero or one manager per
1642 * gcwq. The exclusion is handled automatically by this function.
1643 *
1644 * The caller can safely start processing works on false return. On
1645 * true return, it's guaranteed that need_to_create_worker() is false
1646 * and may_start_working() is true.
1647 *
1648 * CONTEXT:
1649 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1650 * multiple times. Does GFP_KERNEL allocations.
1651 *
1652 * RETURNS:
1653 * false if no action was taken and gcwq->lock stayed locked, true if
1654 * some action was taken.
1655 */
1656static bool manage_workers(struct worker *worker)
1657{
1658 struct global_cwq *gcwq = worker->gcwq;
1659 bool ret = false;
1660
1661 if (gcwq->flags & GCWQ_MANAGING_WORKERS)
1662 return ret;
1663
1664 gcwq->flags &= ~GCWQ_MANAGE_WORKERS;
1665 gcwq->flags |= GCWQ_MANAGING_WORKERS;
1666
1667 /*
1668 * Destroy and then create so that may_start_working() is true
1669 * on return.
1670 */
1671 ret |= maybe_destroy_workers(gcwq);
1672 ret |= maybe_create_worker(gcwq);
1673
1674 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
1675
1676 /*
1677 * The trustee might be waiting to take over the manager
1678 * position, tell it we're done.
1679 */
1680 if (unlikely(gcwq->trustee))
1681 wake_up_all(&gcwq->trustee_wait);
1682
1683 return ret;
1684}
1685
Tejun Heoa62428c2010-06-29 10:07:10 +02001686/**
Tejun Heoaffee4b2010-06-29 10:07:12 +02001687 * move_linked_works - move linked works to a list
1688 * @work: start of series of works to be scheduled
1689 * @head: target list to append @work to
1690 * @nextp: out paramter for nested worklist walking
1691 *
1692 * Schedule linked works starting from @work to @head. Work series to
1693 * be scheduled starts at @work and includes any consecutive work with
1694 * WORK_STRUCT_LINKED set in its predecessor.
1695 *
1696 * If @nextp is not NULL, it's updated to point to the next work of
1697 * the last scheduled work. This allows move_linked_works() to be
1698 * nested inside outer list_for_each_entry_safe().
1699 *
1700 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001701 * spin_lock_irq(gcwq->lock).
Tejun Heoaffee4b2010-06-29 10:07:12 +02001702 */
1703static void move_linked_works(struct work_struct *work, struct list_head *head,
1704 struct work_struct **nextp)
1705{
1706 struct work_struct *n;
1707
1708 /*
1709 * Linked worklist will always end before the end of the list,
1710 * use NULL for list head.
1711 */
1712 list_for_each_entry_safe_from(work, n, NULL, entry) {
1713 list_move_tail(&work->entry, head);
1714 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1715 break;
1716 }
1717
1718 /*
1719 * If we're already inside safe list traversal and have moved
1720 * multiple works to the scheduled queue, the next position
1721 * needs to be updated.
1722 */
1723 if (nextp)
1724 *nextp = n;
1725}
1726
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001727static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
1728{
1729 struct work_struct *work = list_first_entry(&cwq->delayed_works,
1730 struct work_struct, entry);
Tejun Heo649027d2010-06-29 10:07:14 +02001731 struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001732
Tejun Heocdadf002010-10-05 10:49:55 +02001733 trace_workqueue_activate_work(work);
Tejun Heo649027d2010-06-29 10:07:14 +02001734 move_linked_works(work, pos, NULL);
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001735 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001736 cwq->nr_active++;
1737}
1738
Tejun Heoaffee4b2010-06-29 10:07:12 +02001739/**
Tejun Heo73f53c42010-06-29 10:07:11 +02001740 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1741 * @cwq: cwq of interest
1742 * @color: color of work which left the queue
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001743 * @delayed: for a delayed work
Tejun Heo73f53c42010-06-29 10:07:11 +02001744 *
1745 * A work either has completed or is removed from pending queue,
1746 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1747 *
1748 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001749 * spin_lock_irq(gcwq->lock).
Tejun Heo73f53c42010-06-29 10:07:11 +02001750 */
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001751static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
1752 bool delayed)
Tejun Heo73f53c42010-06-29 10:07:11 +02001753{
1754 /* ignore uncolored works */
1755 if (color == WORK_NO_COLOR)
1756 return;
1757
1758 cwq->nr_in_flight[color]--;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001759
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001760 if (!delayed) {
1761 cwq->nr_active--;
1762 if (!list_empty(&cwq->delayed_works)) {
1763 /* one down, submit a delayed one */
1764 if (cwq->nr_active < cwq->max_active)
1765 cwq_activate_first_delayed(cwq);
1766 }
Tejun Heo502ca9d2010-06-29 10:07:13 +02001767 }
Tejun Heo73f53c42010-06-29 10:07:11 +02001768
1769 /* is flush in progress and are we at the flushing tip? */
1770 if (likely(cwq->flush_color != color))
1771 return;
1772
1773 /* are there still in-flight works? */
1774 if (cwq->nr_in_flight[color])
1775 return;
1776
1777 /* this cwq is done, clear flush_color */
1778 cwq->flush_color = -1;
1779
1780 /*
1781 * If this was the last cwq, wake up the first flusher. It
1782 * will handle the rest.
1783 */
1784 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1785 complete(&cwq->wq->first_flusher->done);
1786}
1787
1788/**
Tejun Heoa62428c2010-06-29 10:07:10 +02001789 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001790 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001791 * @work: work to process
1792 *
1793 * Process @work. This function contains all the logics necessary to
1794 * process a single work including synchronization against and
1795 * interaction with other workers on the same cpu, queueing and
1796 * flushing. As long as context requirement is met, any worker can
1797 * call this function to process a work.
1798 *
1799 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001800 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02001801 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001802static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001803__releases(&gcwq->lock)
1804__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02001805{
Tejun Heo7e116292010-06-29 10:07:13 +02001806 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001807 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001808 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heofb0e7be2010-06-29 10:07:15 +02001809 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02001810 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02001811 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02001812 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02001813#ifdef CONFIG_LOCKDEP
1814 /*
1815 * It is permissible to free the struct work_struct from
1816 * inside the function that is called from it, this we need to
1817 * take into account for lockdep too. To avoid bogus "held
1818 * lock freed" warnings as well as problems when looking into
1819 * work->lockdep_map, make a copy and use that here.
1820 */
1821 struct lockdep_map lockdep_map = work->lockdep_map;
1822#endif
Tejun Heo7e116292010-06-29 10:07:13 +02001823 /*
1824 * A single work shouldn't be executed concurrently by
1825 * multiple workers on a single cpu. Check whether anyone is
1826 * already processing the work. If so, defer the work to the
1827 * currently executing one.
1828 */
1829 collision = __find_worker_executing_work(gcwq, bwh, work);
1830 if (unlikely(collision)) {
1831 move_linked_works(work, &collision->scheduled, NULL);
1832 return;
1833 }
1834
Tejun Heoa62428c2010-06-29 10:07:10 +02001835 /* claim and process */
Tejun Heoa62428c2010-06-29 10:07:10 +02001836 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001837 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02001838 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001839 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001840 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001841
Tejun Heo7a22ad72010-06-29 10:07:13 +02001842 /* record the current cpu number in the work data and dequeue */
1843 set_work_cpu(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02001844 list_del_init(&work->entry);
1845
Tejun Heo649027d2010-06-29 10:07:14 +02001846 /*
1847 * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
1848 * wake up another worker; otherwise, clear HIGHPRI_PENDING.
1849 */
1850 if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) {
1851 struct work_struct *nwork = list_first_entry(&gcwq->worklist,
1852 struct work_struct, entry);
1853
1854 if (!list_empty(&gcwq->worklist) &&
1855 get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
1856 wake_up_worker(gcwq);
1857 else
1858 gcwq->flags &= ~GCWQ_HIGHPRI_PENDING;
1859 }
1860
Tejun Heofb0e7be2010-06-29 10:07:15 +02001861 /*
1862 * CPU intensive works don't participate in concurrency
1863 * management. They're the scheduler's responsibility.
1864 */
1865 if (unlikely(cpu_intensive))
1866 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1867
Tejun Heo8b03ae32010-06-29 10:07:12 +02001868 spin_unlock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001869
Tejun Heoa62428c2010-06-29 10:07:10 +02001870 work_clear_pending(work);
Tejun Heoe1594892011-01-09 23:32:15 +01001871 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02001872 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07001873 trace_workqueue_execute_start(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02001874 f(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07001875 /*
1876 * While we must be careful to not use "work" after this, the trace
1877 * point will only record its address.
1878 */
1879 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02001880 lock_map_release(&lockdep_map);
1881 lock_map_release(&cwq->wq->lockdep_map);
1882
1883 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1884 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1885 "%s/0x%08x/%d\n",
1886 current->comm, preempt_count(), task_pid_nr(current));
1887 printk(KERN_ERR " last function: ");
1888 print_symbol("%s\n", (unsigned long)f);
1889 debug_show_held_locks(current);
1890 dump_stack();
1891 }
1892
Tejun Heo8b03ae32010-06-29 10:07:12 +02001893 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001894
Tejun Heofb0e7be2010-06-29 10:07:15 +02001895 /* clear cpu intensive status */
1896 if (unlikely(cpu_intensive))
1897 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1898
Tejun Heoa62428c2010-06-29 10:07:10 +02001899 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02001900 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001901 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001902 worker->current_cwq = NULL;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001903 cwq_dec_nr_in_flight(cwq, work_color, false);
Tejun Heoa62428c2010-06-29 10:07:10 +02001904}
1905
Tejun Heoaffee4b2010-06-29 10:07:12 +02001906/**
1907 * process_scheduled_works - process scheduled works
1908 * @worker: self
1909 *
1910 * Process all scheduled works. Please note that the scheduled list
1911 * may change while processing a work, so this function repeatedly
1912 * fetches a work from the top and executes it.
1913 *
1914 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001915 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02001916 * multiple times.
1917 */
1918static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919{
Tejun Heoaffee4b2010-06-29 10:07:12 +02001920 while (!list_empty(&worker->scheduled)) {
1921 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001923 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925}
1926
Tejun Heo4690c4a2010-06-29 10:07:10 +02001927/**
1928 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02001929 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02001930 *
Tejun Heoe22bee72010-06-29 10:07:14 +02001931 * The gcwq worker thread function. There's a single dynamic pool of
1932 * these per each cpu. These workers process all works regardless of
1933 * their specific target workqueue. The only exception is works which
1934 * belong to workqueues with a rescuer which will be explained in
1935 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02001936 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001937static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938{
Tejun Heoc34056a2010-06-29 10:07:11 +02001939 struct worker *worker = __worker;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001940 struct global_cwq *gcwq = worker->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941
Tejun Heoe22bee72010-06-29 10:07:14 +02001942 /* tell the scheduler that this is a workqueue worker */
1943 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001944woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02001945 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946
Tejun Heoc8e55f32010-06-29 10:07:12 +02001947 /* DIE can be set only while we're idle, checking here is enough */
1948 if (worker->flags & WORKER_DIE) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001949 spin_unlock_irq(&gcwq->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001950 worker->task->flags &= ~PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001951 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 }
1953
Tejun Heoc8e55f32010-06-29 10:07:12 +02001954 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001955recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02001956 /* no more worker necessary? */
1957 if (!need_more_worker(gcwq))
1958 goto sleep;
1959
1960 /* do we need to manage? */
1961 if (unlikely(!may_start_working(gcwq)) && manage_workers(worker))
1962 goto recheck;
1963
Tejun Heoc8e55f32010-06-29 10:07:12 +02001964 /*
1965 * ->scheduled list can only be filled while a worker is
1966 * preparing to process a work or actually processing it.
1967 * Make sure nobody diddled with it while I was sleeping.
1968 */
1969 BUG_ON(!list_empty(&worker->scheduled));
1970
Tejun Heoe22bee72010-06-29 10:07:14 +02001971 /*
1972 * When control reaches this point, we're guaranteed to have
1973 * at least one idle worker or that someone else has already
1974 * assumed the manager role.
1975 */
1976 worker_clr_flags(worker, WORKER_PREP);
1977
1978 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02001979 struct work_struct *work =
Tejun Heo7e116292010-06-29 10:07:13 +02001980 list_first_entry(&gcwq->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02001981 struct work_struct, entry);
1982
1983 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1984 /* optimization path, not strictly necessary */
1985 process_one_work(worker, work);
1986 if (unlikely(!list_empty(&worker->scheduled)))
1987 process_scheduled_works(worker);
1988 } else {
1989 move_linked_works(work, &worker->scheduled, NULL);
1990 process_scheduled_works(worker);
1991 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001992 } while (keep_working(gcwq));
Tejun Heoc8e55f32010-06-29 10:07:12 +02001993
Tejun Heoe22bee72010-06-29 10:07:14 +02001994 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02001995sleep:
Tejun Heoe22bee72010-06-29 10:07:14 +02001996 if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker))
1997 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02001998
Tejun Heoc8e55f32010-06-29 10:07:12 +02001999 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02002000 * gcwq->lock is held and there's no work to process and no
2001 * need to manage, sleep. Workers are woken up only while
2002 * holding gcwq->lock or from local cpu, so setting the
2003 * current state before releasing gcwq->lock is enough to
2004 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002005 */
2006 worker_enter_idle(worker);
2007 __set_current_state(TASK_INTERRUPTIBLE);
2008 spin_unlock_irq(&gcwq->lock);
2009 schedule();
2010 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011}
2012
Tejun Heoe22bee72010-06-29 10:07:14 +02002013/**
2014 * rescuer_thread - the rescuer thread function
2015 * @__wq: the associated workqueue
2016 *
2017 * Workqueue rescuer thread function. There's one rescuer for each
2018 * workqueue which has WQ_RESCUER set.
2019 *
2020 * Regular work processing on a gcwq may block trying to create a new
2021 * worker which uses GFP_KERNEL allocation which has slight chance of
2022 * developing into deadlock if some works currently on the same queue
2023 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2024 * the problem rescuer solves.
2025 *
2026 * When such condition is possible, the gcwq summons rescuers of all
2027 * workqueues which have works queued on the gcwq and let them process
2028 * those works so that forward progress can be guaranteed.
2029 *
2030 * This should happen rarely.
2031 */
2032static int rescuer_thread(void *__wq)
2033{
2034 struct workqueue_struct *wq = __wq;
2035 struct worker *rescuer = wq->rescuer;
2036 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002037 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002038 unsigned int cpu;
2039
2040 set_user_nice(current, RESCUER_NICE_LEVEL);
2041repeat:
2042 set_current_state(TASK_INTERRUPTIBLE);
2043
2044 if (kthread_should_stop())
2045 return 0;
2046
Tejun Heof3421792010-07-02 10:03:51 +02002047 /*
2048 * See whether any cpu is asking for help. Unbounded
2049 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2050 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002051 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002052 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2053 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heoe22bee72010-06-29 10:07:14 +02002054 struct global_cwq *gcwq = cwq->gcwq;
2055 struct work_struct *work, *n;
2056
2057 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002058 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002059
2060 /* migrate to the target cpu if possible */
2061 rescuer->gcwq = gcwq;
2062 worker_maybe_bind_and_lock(rescuer);
2063
2064 /*
2065 * Slurp in all works issued via this workqueue and
2066 * process'em.
2067 */
2068 BUG_ON(!list_empty(&rescuer->scheduled));
2069 list_for_each_entry_safe(work, n, &gcwq->worklist, entry)
2070 if (get_work_cwq(work) == cwq)
2071 move_linked_works(work, scheduled, &n);
2072
2073 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002074
2075 /*
2076 * Leave this gcwq. If keep_working() is %true, notify a
2077 * regular worker; otherwise, we end up with 0 concurrency
2078 * and stalling the execution.
2079 */
2080 if (keep_working(gcwq))
2081 wake_up_worker(gcwq);
2082
Tejun Heoe22bee72010-06-29 10:07:14 +02002083 spin_unlock_irq(&gcwq->lock);
2084 }
2085
2086 schedule();
2087 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088}
2089
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002090struct wq_barrier {
2091 struct work_struct work;
2092 struct completion done;
2093};
2094
2095static void wq_barrier_func(struct work_struct *work)
2096{
2097 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2098 complete(&barr->done);
2099}
2100
Tejun Heo4690c4a2010-06-29 10:07:10 +02002101/**
2102 * insert_wq_barrier - insert a barrier work
2103 * @cwq: cwq to insert barrier into
2104 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002105 * @target: target work to attach @barr to
2106 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002107 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002108 * @barr is linked to @target such that @barr is completed only after
2109 * @target finishes execution. Please note that the ordering
2110 * guarantee is observed only with respect to @target and on the local
2111 * cpu.
2112 *
2113 * Currently, a queued barrier can't be canceled. This is because
2114 * try_to_grab_pending() can't determine whether the work to be
2115 * grabbed is at the head of the queue and thus can't clear LINKED
2116 * flag of the previous work while there must be a valid next work
2117 * after a work with LINKED flag set.
2118 *
2119 * Note that when @worker is non-NULL, @target may be modified
2120 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002121 *
2122 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002123 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002124 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002125static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002126 struct wq_barrier *barr,
2127 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002128{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002129 struct list_head *head;
2130 unsigned int linked = 0;
2131
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002132 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002133 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002134 * as we know for sure that this will not trigger any of the
2135 * checks and call back into the fixup functions where we
2136 * might deadlock.
2137 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002138 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002139 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002140 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002141
Tejun Heoaffee4b2010-06-29 10:07:12 +02002142 /*
2143 * If @target is currently being executed, schedule the
2144 * barrier to the worker; otherwise, put it after @target.
2145 */
2146 if (worker)
2147 head = worker->scheduled.next;
2148 else {
2149 unsigned long *bits = work_data_bits(target);
2150
2151 head = target->entry.next;
2152 /* there can already be other linked works, inherit and set */
2153 linked = *bits & WORK_STRUCT_LINKED;
2154 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2155 }
2156
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002157 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002158 insert_work(cwq, &barr->work, head,
2159 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002160}
2161
Tejun Heo73f53c42010-06-29 10:07:11 +02002162/**
2163 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2164 * @wq: workqueue being flushed
2165 * @flush_color: new flush color, < 0 for no-op
2166 * @work_color: new work color, < 0 for no-op
2167 *
2168 * Prepare cwqs for workqueue flushing.
2169 *
2170 * If @flush_color is non-negative, flush_color on all cwqs should be
2171 * -1. If no cwq has in-flight commands at the specified color, all
2172 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2173 * has in flight commands, its cwq->flush_color is set to
2174 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2175 * wakeup logic is armed and %true is returned.
2176 *
2177 * The caller should have initialized @wq->first_flusher prior to
2178 * calling this function with non-negative @flush_color. If
2179 * @flush_color is negative, no flush color update is done and %false
2180 * is returned.
2181 *
2182 * If @work_color is non-negative, all cwqs should have the same
2183 * work_color which is previous to @work_color and all will be
2184 * advanced to @work_color.
2185 *
2186 * CONTEXT:
2187 * mutex_lock(wq->flush_mutex).
2188 *
2189 * RETURNS:
2190 * %true if @flush_color >= 0 and there's something to flush. %false
2191 * otherwise.
2192 */
2193static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2194 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195{
Tejun Heo73f53c42010-06-29 10:07:11 +02002196 bool wait = false;
2197 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002198
Tejun Heo73f53c42010-06-29 10:07:11 +02002199 if (flush_color >= 0) {
2200 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2201 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002202 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002203
Tejun Heof3421792010-07-02 10:03:51 +02002204 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002205 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002206 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002207
Tejun Heo8b03ae32010-06-29 10:07:12 +02002208 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002209
2210 if (flush_color >= 0) {
2211 BUG_ON(cwq->flush_color != -1);
2212
2213 if (cwq->nr_in_flight[flush_color]) {
2214 cwq->flush_color = flush_color;
2215 atomic_inc(&wq->nr_cwqs_to_flush);
2216 wait = true;
2217 }
2218 }
2219
2220 if (work_color >= 0) {
2221 BUG_ON(work_color != work_next_color(cwq->work_color));
2222 cwq->work_color = work_color;
2223 }
2224
Tejun Heo8b03ae32010-06-29 10:07:12 +02002225 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002226 }
2227
2228 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2229 complete(&wq->first_flusher->done);
2230
2231 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232}
2233
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002234/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002236 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237 *
2238 * Forces execution of the workqueue and blocks until its completion.
2239 * This is typically used in driver shutdown handlers.
2240 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002241 * We sleep until all works which were queued on entry have been handled,
2242 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002244void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245{
Tejun Heo73f53c42010-06-29 10:07:11 +02002246 struct wq_flusher this_flusher = {
2247 .list = LIST_HEAD_INIT(this_flusher.list),
2248 .flush_color = -1,
2249 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2250 };
2251 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002252
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002253 lock_map_acquire(&wq->lockdep_map);
2254 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002255
2256 mutex_lock(&wq->flush_mutex);
2257
2258 /*
2259 * Start-to-wait phase
2260 */
2261 next_color = work_next_color(wq->work_color);
2262
2263 if (next_color != wq->flush_color) {
2264 /*
2265 * Color space is not full. The current work_color
2266 * becomes our flush_color and work_color is advanced
2267 * by one.
2268 */
2269 BUG_ON(!list_empty(&wq->flusher_overflow));
2270 this_flusher.flush_color = wq->work_color;
2271 wq->work_color = next_color;
2272
2273 if (!wq->first_flusher) {
2274 /* no flush in progress, become the first flusher */
2275 BUG_ON(wq->flush_color != this_flusher.flush_color);
2276
2277 wq->first_flusher = &this_flusher;
2278
2279 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2280 wq->work_color)) {
2281 /* nothing to flush, done */
2282 wq->flush_color = next_color;
2283 wq->first_flusher = NULL;
2284 goto out_unlock;
2285 }
2286 } else {
2287 /* wait in queue */
2288 BUG_ON(wq->flush_color == this_flusher.flush_color);
2289 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2290 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2291 }
2292 } else {
2293 /*
2294 * Oops, color space is full, wait on overflow queue.
2295 * The next flush completion will assign us
2296 * flush_color and transfer to flusher_queue.
2297 */
2298 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2299 }
2300
2301 mutex_unlock(&wq->flush_mutex);
2302
2303 wait_for_completion(&this_flusher.done);
2304
2305 /*
2306 * Wake-up-and-cascade phase
2307 *
2308 * First flushers are responsible for cascading flushes and
2309 * handling overflow. Non-first flushers can simply return.
2310 */
2311 if (wq->first_flusher != &this_flusher)
2312 return;
2313
2314 mutex_lock(&wq->flush_mutex);
2315
Tejun Heo4ce48b32010-07-02 10:03:51 +02002316 /* we might have raced, check again with mutex held */
2317 if (wq->first_flusher != &this_flusher)
2318 goto out_unlock;
2319
Tejun Heo73f53c42010-06-29 10:07:11 +02002320 wq->first_flusher = NULL;
2321
2322 BUG_ON(!list_empty(&this_flusher.list));
2323 BUG_ON(wq->flush_color != this_flusher.flush_color);
2324
2325 while (true) {
2326 struct wq_flusher *next, *tmp;
2327
2328 /* complete all the flushers sharing the current flush color */
2329 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2330 if (next->flush_color != wq->flush_color)
2331 break;
2332 list_del_init(&next->list);
2333 complete(&next->done);
2334 }
2335
2336 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2337 wq->flush_color != work_next_color(wq->work_color));
2338
2339 /* this flush_color is finished, advance by one */
2340 wq->flush_color = work_next_color(wq->flush_color);
2341
2342 /* one color has been freed, handle overflow queue */
2343 if (!list_empty(&wq->flusher_overflow)) {
2344 /*
2345 * Assign the same color to all overflowed
2346 * flushers, advance work_color and append to
2347 * flusher_queue. This is the start-to-wait
2348 * phase for these overflowed flushers.
2349 */
2350 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2351 tmp->flush_color = wq->work_color;
2352
2353 wq->work_color = work_next_color(wq->work_color);
2354
2355 list_splice_tail_init(&wq->flusher_overflow,
2356 &wq->flusher_queue);
2357 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2358 }
2359
2360 if (list_empty(&wq->flusher_queue)) {
2361 BUG_ON(wq->flush_color != wq->work_color);
2362 break;
2363 }
2364
2365 /*
2366 * Need to flush more colors. Make the next flusher
2367 * the new first flusher and arm cwqs.
2368 */
2369 BUG_ON(wq->flush_color == wq->work_color);
2370 BUG_ON(wq->flush_color != next->flush_color);
2371
2372 list_del_init(&next->list);
2373 wq->first_flusher = next;
2374
2375 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2376 break;
2377
2378 /*
2379 * Meh... this color is already done, clear first
2380 * flusher and repeat cascading.
2381 */
2382 wq->first_flusher = NULL;
2383 }
2384
2385out_unlock:
2386 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387}
Dave Jonesae90dd52006-06-30 01:40:45 -04002388EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002390/**
2391 * drain_workqueue - drain a workqueue
2392 * @wq: workqueue to drain
2393 *
2394 * Wait until the workqueue becomes empty. While draining is in progress,
2395 * only chain queueing is allowed. IOW, only currently pending or running
2396 * work items on @wq can queue further work items on it. @wq is flushed
2397 * repeatedly until it becomes empty. The number of flushing is detemined
2398 * by the depth of chaining and should be relatively short. Whine if it
2399 * takes too long.
2400 */
2401void drain_workqueue(struct workqueue_struct *wq)
2402{
2403 unsigned int flush_cnt = 0;
2404 unsigned int cpu;
2405
2406 /*
2407 * __queue_work() needs to test whether there are drainers, is much
2408 * hotter than drain_workqueue() and already looks at @wq->flags.
2409 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2410 */
2411 spin_lock(&workqueue_lock);
2412 if (!wq->nr_drainers++)
2413 wq->flags |= WQ_DRAINING;
2414 spin_unlock(&workqueue_lock);
2415reflush:
2416 flush_workqueue(wq);
2417
2418 for_each_cwq_cpu(cpu, wq) {
2419 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002420 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002421
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002422 spin_lock_irq(&cwq->gcwq->lock);
2423 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2424 spin_unlock_irq(&cwq->gcwq->lock);
2425
2426 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002427 continue;
2428
2429 if (++flush_cnt == 10 ||
2430 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2431 pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
2432 wq->name, flush_cnt);
2433 goto reflush;
2434 }
2435
2436 spin_lock(&workqueue_lock);
2437 if (!--wq->nr_drainers)
2438 wq->flags &= ~WQ_DRAINING;
2439 spin_unlock(&workqueue_lock);
2440}
2441EXPORT_SYMBOL_GPL(drain_workqueue);
2442
Tejun Heobaf59022010-09-16 10:42:16 +02002443static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2444 bool wait_executing)
2445{
2446 struct worker *worker = NULL;
2447 struct global_cwq *gcwq;
2448 struct cpu_workqueue_struct *cwq;
2449
2450 might_sleep();
2451 gcwq = get_work_gcwq(work);
2452 if (!gcwq)
2453 return false;
2454
2455 spin_lock_irq(&gcwq->lock);
2456 if (!list_empty(&work->entry)) {
2457 /*
2458 * See the comment near try_to_grab_pending()->smp_rmb().
2459 * If it was re-queued to a different gcwq under us, we
2460 * are not going to wait.
2461 */
2462 smp_rmb();
2463 cwq = get_work_cwq(work);
2464 if (unlikely(!cwq || gcwq != cwq->gcwq))
2465 goto already_gone;
2466 } else if (wait_executing) {
2467 worker = find_worker_executing_work(gcwq, work);
2468 if (!worker)
2469 goto already_gone;
2470 cwq = worker->current_cwq;
2471 } else
2472 goto already_gone;
2473
2474 insert_wq_barrier(cwq, barr, work, worker);
2475 spin_unlock_irq(&gcwq->lock);
2476
Tejun Heoe1594892011-01-09 23:32:15 +01002477 /*
2478 * If @max_active is 1 or rescuer is in use, flushing another work
2479 * item on the same workqueue may lead to deadlock. Make sure the
2480 * flusher is not running on the same workqueue by verifying write
2481 * access.
2482 */
2483 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2484 lock_map_acquire(&cwq->wq->lockdep_map);
2485 else
2486 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002487 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002488
Tejun Heobaf59022010-09-16 10:42:16 +02002489 return true;
2490already_gone:
2491 spin_unlock_irq(&gcwq->lock);
2492 return false;
2493}
2494
Oleg Nesterovdb700892008-07-25 01:47:49 -07002495/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002496 * flush_work - wait for a work to finish executing the last queueing instance
2497 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002498 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002499 * Wait until @work has finished execution. This function considers
2500 * only the last queueing instance of @work. If @work has been
2501 * enqueued across different CPUs on a non-reentrant workqueue or on
2502 * multiple workqueues, @work might still be executing on return on
2503 * some of the CPUs from earlier queueing.
Oleg Nesterova67da702008-07-25 01:47:52 -07002504 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002505 * If @work was queued only on a non-reentrant, ordered or unbound
2506 * workqueue, @work is guaranteed to be idle on return if it hasn't
2507 * been requeued since flush started.
2508 *
2509 * RETURNS:
2510 * %true if flush_work() waited for the work to finish execution,
2511 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002512 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002513bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002514{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002515 struct wq_barrier barr;
2516
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002517 lock_map_acquire(&work->lockdep_map);
2518 lock_map_release(&work->lockdep_map);
2519
Tejun Heobaf59022010-09-16 10:42:16 +02002520 if (start_flush_work(work, &barr, true)) {
2521 wait_for_completion(&barr.done);
2522 destroy_work_on_stack(&barr.work);
2523 return true;
2524 } else
2525 return false;
Oleg Nesterovdb700892008-07-25 01:47:49 -07002526}
2527EXPORT_SYMBOL_GPL(flush_work);
2528
Tejun Heo401a8d02010-09-16 10:36:00 +02002529static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2530{
2531 struct wq_barrier barr;
2532 struct worker *worker;
2533
2534 spin_lock_irq(&gcwq->lock);
2535
2536 worker = find_worker_executing_work(gcwq, work);
2537 if (unlikely(worker))
2538 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2539
2540 spin_unlock_irq(&gcwq->lock);
2541
2542 if (unlikely(worker)) {
2543 wait_for_completion(&barr.done);
2544 destroy_work_on_stack(&barr.work);
2545 return true;
2546 } else
2547 return false;
2548}
2549
2550static bool wait_on_work(struct work_struct *work)
2551{
2552 bool ret = false;
2553 int cpu;
2554
2555 might_sleep();
2556
2557 lock_map_acquire(&work->lockdep_map);
2558 lock_map_release(&work->lockdep_map);
2559
2560 for_each_gcwq_cpu(cpu)
2561 ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2562 return ret;
2563}
2564
Tejun Heo09383492010-09-16 10:48:29 +02002565/**
2566 * flush_work_sync - wait until a work has finished execution
2567 * @work: the work to flush
2568 *
2569 * Wait until @work has finished execution. On return, it's
2570 * guaranteed that all queueing instances of @work which happened
2571 * before this function is called are finished. In other words, if
2572 * @work hasn't been requeued since this function was called, @work is
2573 * guaranteed to be idle on return.
2574 *
2575 * RETURNS:
2576 * %true if flush_work_sync() waited for the work to finish execution,
2577 * %false if it was already idle.
2578 */
2579bool flush_work_sync(struct work_struct *work)
2580{
2581 struct wq_barrier barr;
2582 bool pending, waited;
2583
2584 /* we'll wait for executions separately, queue barr only if pending */
2585 pending = start_flush_work(work, &barr, false);
2586
2587 /* wait for executions to finish */
2588 waited = wait_on_work(work);
2589
2590 /* wait for the pending one */
2591 if (pending) {
2592 wait_for_completion(&barr.done);
2593 destroy_work_on_stack(&barr.work);
2594 }
2595
2596 return pending || waited;
2597}
2598EXPORT_SYMBOL_GPL(flush_work_sync);
2599
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002600/*
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002601 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002602 * so this work can't be re-armed in any way.
2603 */
2604static int try_to_grab_pending(struct work_struct *work)
2605{
Tejun Heo8b03ae32010-06-29 10:07:12 +02002606 struct global_cwq *gcwq;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002607 int ret = -1;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002608
Tejun Heo22df02b2010-06-29 10:07:10 +02002609 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002610 return 0;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002611
2612 /*
2613 * The queueing is in progress, or it is already queued. Try to
2614 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
2615 */
Tejun Heo7a22ad72010-06-29 10:07:13 +02002616 gcwq = get_work_gcwq(work);
2617 if (!gcwq)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002618 return ret;
2619
Tejun Heo8b03ae32010-06-29 10:07:12 +02002620 spin_lock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002621 if (!list_empty(&work->entry)) {
2622 /*
Tejun Heo7a22ad72010-06-29 10:07:13 +02002623 * This work is queued, but perhaps we locked the wrong gcwq.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002624 * In that case we must see the new value after rmb(), see
2625 * insert_work()->wmb().
2626 */
2627 smp_rmb();
Tejun Heo7a22ad72010-06-29 10:07:13 +02002628 if (gcwq == get_work_gcwq(work)) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002629 debug_work_deactivate(work);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002630 list_del_init(&work->entry);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002631 cwq_dec_nr_in_flight(get_work_cwq(work),
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02002632 get_work_color(work),
2633 *work_data_bits(work) & WORK_STRUCT_DELAYED);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002634 ret = 1;
2635 }
2636 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02002637 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002638
2639 return ret;
2640}
2641
Tejun Heo401a8d02010-09-16 10:36:00 +02002642static bool __cancel_work_timer(struct work_struct *work,
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002643 struct timer_list* timer)
2644{
2645 int ret;
2646
2647 do {
2648 ret = (timer && likely(del_timer(timer)));
2649 if (!ret)
2650 ret = try_to_grab_pending(work);
2651 wait_on_work(work);
2652 } while (unlikely(ret < 0));
2653
Tejun Heo7a22ad72010-06-29 10:07:13 +02002654 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002655 return ret;
2656}
2657
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002658/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002659 * cancel_work_sync - cancel a work and wait for it to finish
2660 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002661 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002662 * Cancel @work and wait for its execution to finish. This function
2663 * can be used even if the work re-queues itself or migrates to
2664 * another workqueue. On return from this function, @work is
2665 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002666 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002667 * cancel_work_sync(&delayed_work->work) must not be used for
2668 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002669 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002670 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002671 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002672 *
2673 * RETURNS:
2674 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002675 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002676bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002677{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002678 return __cancel_work_timer(work, NULL);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002679}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002680EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002681
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002682/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002683 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2684 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002685 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002686 * Delayed timer is cancelled and the pending work is queued for
2687 * immediate execution. Like flush_work(), this function only
2688 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002689 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002690 * RETURNS:
2691 * %true if flush_work() waited for the work to finish execution,
2692 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002693 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002694bool flush_delayed_work(struct delayed_work *dwork)
2695{
2696 if (del_timer_sync(&dwork->timer))
2697 __queue_work(raw_smp_processor_id(),
2698 get_work_cwq(&dwork->work)->wq, &dwork->work);
2699 return flush_work(&dwork->work);
2700}
2701EXPORT_SYMBOL(flush_delayed_work);
2702
2703/**
Tejun Heo09383492010-09-16 10:48:29 +02002704 * flush_delayed_work_sync - wait for a dwork to finish
2705 * @dwork: the delayed work to flush
2706 *
2707 * Delayed timer is cancelled and the pending work is queued for
2708 * execution immediately. Other than timer handling, its behavior
2709 * is identical to flush_work_sync().
2710 *
2711 * RETURNS:
2712 * %true if flush_work_sync() waited for the work to finish execution,
2713 * %false if it was already idle.
2714 */
2715bool flush_delayed_work_sync(struct delayed_work *dwork)
2716{
2717 if (del_timer_sync(&dwork->timer))
2718 __queue_work(raw_smp_processor_id(),
2719 get_work_cwq(&dwork->work)->wq, &dwork->work);
2720 return flush_work_sync(&dwork->work);
2721}
2722EXPORT_SYMBOL(flush_delayed_work_sync);
2723
2724/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002725 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2726 * @dwork: the delayed work cancel
2727 *
2728 * This is cancel_work_sync() for delayed works.
2729 *
2730 * RETURNS:
2731 * %true if @dwork was pending, %false otherwise.
2732 */
2733bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002734{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002735 return __cancel_work_timer(&dwork->work, &dwork->timer);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002736}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002737EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002739/**
2740 * schedule_work - put work task in global workqueue
2741 * @work: job to be done
2742 *
Bart Van Assche5b0f437d2009-07-30 19:00:53 +02002743 * Returns zero if @work was already on the kernel-global workqueue and
2744 * non-zero otherwise.
2745 *
2746 * This puts a job in the kernel-global workqueue if it was not already
2747 * queued and leaves it in the same position on the kernel-global
2748 * workqueue otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002749 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002750int schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002751{
Tejun Heod320c032010-06-29 10:07:14 +02002752 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002753}
Dave Jonesae90dd52006-06-30 01:40:45 -04002754EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002755
Zhang Ruic1a220e2008-07-23 21:28:39 -07002756/*
2757 * schedule_work_on - put work task on a specific cpu
2758 * @cpu: cpu to put the work task on
2759 * @work: job to be done
2760 *
2761 * This puts a job on a specific cpu
2762 */
2763int schedule_work_on(int cpu, struct work_struct *work)
2764{
Tejun Heod320c032010-06-29 10:07:14 +02002765 return queue_work_on(cpu, system_wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07002766}
2767EXPORT_SYMBOL(schedule_work_on);
2768
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002769/**
2770 * schedule_delayed_work - put work task in global workqueue after delay
David Howells52bad642006-11-22 14:54:01 +00002771 * @dwork: job to be done
2772 * @delay: number of jiffies to wait or 0 for immediate execution
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002773 *
2774 * After waiting for a given time this puts a job in the kernel-global
2775 * workqueue.
2776 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002777int schedule_delayed_work(struct delayed_work *dwork,
Ingo Molnar82f67cd2007-02-16 01:28:13 -08002778 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779{
Tejun Heod320c032010-06-29 10:07:14 +02002780 return queue_delayed_work(system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781}
Dave Jonesae90dd52006-06-30 01:40:45 -04002782EXPORT_SYMBOL(schedule_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002784/**
2785 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
2786 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +00002787 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002788 * @delay: number of jiffies to wait
2789 *
2790 * After waiting for a given time this puts a job in the kernel-global
2791 * workqueue on the specified CPU.
2792 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793int schedule_delayed_work_on(int cpu,
David Howells52bad642006-11-22 14:54:01 +00002794 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795{
Tejun Heod320c032010-06-29 10:07:14 +02002796 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002797}
Dave Jonesae90dd52006-06-30 01:40:45 -04002798EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799
Andrew Mortonb6136772006-06-25 05:47:49 -07002800/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002801 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002802 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002803 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002804 * schedule_on_each_cpu() executes @func on each online CPU using the
2805 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002806 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002807 *
2808 * RETURNS:
2809 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002810 */
David Howells65f27f32006-11-22 14:55:48 +00002811int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002812{
2813 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002814 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002815
Andrew Mortonb6136772006-06-25 05:47:49 -07002816 works = alloc_percpu(struct work_struct);
2817 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002818 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002819
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002820 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002821
Christoph Lameter15316ba2006-01-08 01:00:43 -08002822 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002823 struct work_struct *work = per_cpu_ptr(works, cpu);
2824
2825 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002826 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002827 }
Tejun Heo93981802009-11-17 14:06:20 -08002828
2829 for_each_online_cpu(cpu)
2830 flush_work(per_cpu_ptr(works, cpu));
2831
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002832 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002833 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08002834 return 0;
2835}
2836
Alan Sterneef6a7d2010-02-12 17:39:21 +09002837/**
2838 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2839 *
2840 * Forces execution of the kernel-global workqueue and blocks until its
2841 * completion.
2842 *
2843 * Think twice before calling this function! It's very easy to get into
2844 * trouble if you don't take great care. Either of the following situations
2845 * will lead to deadlock:
2846 *
2847 * One of the work items currently on the workqueue needs to acquire
2848 * a lock held by your code or its caller.
2849 *
2850 * Your code is running in the context of a work routine.
2851 *
2852 * They will be detected by lockdep when they occur, but the first might not
2853 * occur very often. It depends on what work items are on the workqueue and
2854 * what locks they need, which you have no control over.
2855 *
2856 * In most situations flushing the entire workqueue is overkill; you merely
2857 * need to know that a particular work item isn't queued and isn't running.
2858 * In such cases you should use cancel_delayed_work_sync() or
2859 * cancel_work_sync() instead.
2860 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002861void flush_scheduled_work(void)
2862{
Tejun Heod320c032010-06-29 10:07:14 +02002863 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002864}
Dave Jonesae90dd52006-06-30 01:40:45 -04002865EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002866
2867/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06002868 * execute_in_process_context - reliably execute the routine with user context
2869 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06002870 * @ew: guaranteed storage for the execute work structure (must
2871 * be available when the work executes)
2872 *
2873 * Executes the function immediately if process context is available,
2874 * otherwise schedules the function for delayed execution.
2875 *
2876 * Returns: 0 - function was executed
2877 * 1 - function was scheduled for execution
2878 */
David Howells65f27f32006-11-22 14:55:48 +00002879int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06002880{
2881 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00002882 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002883 return 0;
2884 }
2885
David Howells65f27f32006-11-22 14:55:48 +00002886 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002887 schedule_work(&ew->work);
2888
2889 return 1;
2890}
2891EXPORT_SYMBOL_GPL(execute_in_process_context);
2892
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893int keventd_up(void)
2894{
Tejun Heod320c032010-06-29 10:07:14 +02002895 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002896}
2897
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002898static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002899{
Oleg Nesterov3af244332007-05-09 02:34:09 -07002900 /*
Tejun Heo0f900042010-06-29 10:07:11 +02002901 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
2902 * Make sure that the alignment isn't lower than that of
2903 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07002904 */
Tejun Heo0f900042010-06-29 10:07:11 +02002905 const size_t size = sizeof(struct cpu_workqueue_struct);
2906 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
2907 __alignof__(unsigned long long));
Oleg Nesterov3af244332007-05-09 02:34:09 -07002908
Lai Jiangshane06ffa12012-03-09 18:03:20 +08002909 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02002910 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02002911 else {
Tejun Heof3421792010-07-02 10:03:51 +02002912 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01002913
Tejun Heof3421792010-07-02 10:03:51 +02002914 /*
2915 * Allocate enough room to align cwq and put an extra
2916 * pointer at the end pointing back to the originally
2917 * allocated pointer which will be used for free.
2918 */
2919 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2920 if (ptr) {
2921 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2922 *(void **)(wq->cpu_wq.single + 1) = ptr;
2923 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002924 }
Tejun Heof3421792010-07-02 10:03:51 +02002925
Tejun Heo0415b00d12011-03-24 18:50:09 +01002926 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002927 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2928 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002929}
2930
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002931static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07002932{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08002933 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02002934 free_percpu(wq->cpu_wq.pcpu);
2935 else if (wq->cpu_wq.single) {
2936 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002937 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07002938 }
2939}
2940
Tejun Heof3421792010-07-02 10:03:51 +02002941static int wq_clamp_max_active(int max_active, unsigned int flags,
2942 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02002943{
Tejun Heof3421792010-07-02 10:03:51 +02002944 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2945
2946 if (max_active < 1 || max_active > lim)
Tejun Heob71ab8c2010-06-29 10:07:14 +02002947 printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2948 "is out of range, clamping between %d and %d\n",
Tejun Heof3421792010-07-02 10:03:51 +02002949 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002950
Tejun Heof3421792010-07-02 10:03:51 +02002951 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002952}
2953
Tejun Heob196be82012-01-10 15:11:35 -08002954struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02002955 unsigned int flags,
2956 int max_active,
2957 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08002958 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07002959{
Tejun Heob196be82012-01-10 15:11:35 -08002960 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002961 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02002962 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08002963 size_t namelen;
2964
2965 /* determine namelen, allocate wq and format name */
2966 va_start(args, lock_name);
2967 va_copy(args1, args);
2968 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
2969
2970 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
2971 if (!wq)
2972 goto err;
2973
2974 vsnprintf(wq->name, namelen, fmt, args1);
2975 va_end(args);
2976 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002977
Tejun Heof3421792010-07-02 10:03:51 +02002978 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02002979 * Workqueues which may be used during memory reclaim should
2980 * have a rescuer to guarantee forward progress.
2981 */
2982 if (flags & WQ_MEM_RECLAIM)
2983 flags |= WQ_RESCUER;
2984
2985 /*
Tejun Heof3421792010-07-02 10:03:51 +02002986 * Unbound workqueues aren't concurrency managed and should be
2987 * dispatched to workers immediately.
2988 */
2989 if (flags & WQ_UNBOUND)
2990 flags |= WQ_HIGHPRI;
2991
Tejun Heod320c032010-06-29 10:07:14 +02002992 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08002993 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002994
Tejun Heob196be82012-01-10 15:11:35 -08002995 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02002996 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002997 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02002998 mutex_init(&wq->flush_mutex);
2999 atomic_set(&wq->nr_cwqs_to_flush, 0);
3000 INIT_LIST_HEAD(&wq->flusher_queue);
3001 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003002
Johannes Bergeb13ba82008-01-16 09:51:58 +01003003 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003004 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003005
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003006 if (alloc_cwqs(wq) < 0)
3007 goto err;
3008
Tejun Heof3421792010-07-02 10:03:51 +02003009 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003010 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003011 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo15376632010-06-29 10:07:11 +02003012
Tejun Heo0f900042010-06-29 10:07:11 +02003013 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003014 cwq->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003015 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003016 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003017 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003018 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003019 }
3020
Tejun Heoe22bee72010-06-29 10:07:14 +02003021 if (flags & WQ_RESCUER) {
3022 struct worker *rescuer;
3023
Tejun Heof2e005a2010-07-20 15:59:09 +02003024 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003025 goto err;
3026
3027 wq->rescuer = rescuer = alloc_worker();
3028 if (!rescuer)
3029 goto err;
3030
Tejun Heob196be82012-01-10 15:11:35 -08003031 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3032 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003033 if (IS_ERR(rescuer->task))
3034 goto err;
3035
Tejun Heoe22bee72010-06-29 10:07:14 +02003036 rescuer->task->flags |= PF_THREAD_BOUND;
3037 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003038 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003039
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003040 /*
3041 * workqueue_lock protects global freeze state and workqueues
3042 * list. Grab it, set max_active accordingly and add the new
3043 * workqueue to workqueues list.
3044 */
Tejun Heo15376632010-06-29 10:07:11 +02003045 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003046
Tejun Heo58a69cb2011-02-16 09:25:31 +01003047 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003048 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003049 get_cwq(cpu, wq)->max_active = 0;
3050
Tejun Heo15376632010-06-29 10:07:11 +02003051 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003052
Tejun Heo15376632010-06-29 10:07:11 +02003053 spin_unlock(&workqueue_lock);
3054
Oleg Nesterov3af244332007-05-09 02:34:09 -07003055 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003056err:
3057 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003058 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003059 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003060 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003061 kfree(wq);
3062 }
3063 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003064}
Tejun Heod320c032010-06-29 10:07:14 +02003065EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003066
3067/**
3068 * destroy_workqueue - safely terminate a workqueue
3069 * @wq: target workqueue
3070 *
3071 * Safely destroy a workqueue. All work currently pending will be done first.
3072 */
3073void destroy_workqueue(struct workqueue_struct *wq)
3074{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003075 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003076
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003077 /* drain it before proceeding with destruction */
3078 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003079
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003080 /*
3081 * wq list is used to freeze wq, remove from list after
3082 * flushing is complete in case freeze races us.
3083 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003084 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07003085 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003086 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003087
Tejun Heoe22bee72010-06-29 10:07:14 +02003088 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003089 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003090 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3091 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003092
Tejun Heo73f53c42010-06-29 10:07:11 +02003093 for (i = 0; i < WORK_NR_COLORS; i++)
3094 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003095 BUG_ON(cwq->nr_active);
3096 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003097 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003098
Tejun Heoe22bee72010-06-29 10:07:14 +02003099 if (wq->flags & WQ_RESCUER) {
3100 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003101 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003102 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003103 }
3104
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003105 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003106 kfree(wq);
3107}
3108EXPORT_SYMBOL_GPL(destroy_workqueue);
3109
Tejun Heodcd989c2010-06-29 10:07:14 +02003110/**
3111 * workqueue_set_max_active - adjust max_active of a workqueue
3112 * @wq: target workqueue
3113 * @max_active: new max_active value.
3114 *
3115 * Set max_active of @wq to @max_active.
3116 *
3117 * CONTEXT:
3118 * Don't call from IRQ context.
3119 */
3120void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3121{
3122 unsigned int cpu;
3123
Tejun Heof3421792010-07-02 10:03:51 +02003124 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003125
3126 spin_lock(&workqueue_lock);
3127
3128 wq->saved_max_active = max_active;
3129
Tejun Heof3421792010-07-02 10:03:51 +02003130 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003131 struct global_cwq *gcwq = get_gcwq(cpu);
3132
3133 spin_lock_irq(&gcwq->lock);
3134
Tejun Heo58a69cb2011-02-16 09:25:31 +01003135 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003136 !(gcwq->flags & GCWQ_FREEZING))
3137 get_cwq(gcwq->cpu, wq)->max_active = max_active;
3138
3139 spin_unlock_irq(&gcwq->lock);
3140 }
3141
3142 spin_unlock(&workqueue_lock);
3143}
3144EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3145
3146/**
3147 * workqueue_congested - test whether a workqueue is congested
3148 * @cpu: CPU in question
3149 * @wq: target workqueue
3150 *
3151 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3152 * no synchronization around this function and the test result is
3153 * unreliable and only useful as advisory hints or for debugging.
3154 *
3155 * RETURNS:
3156 * %true if congested, %false otherwise.
3157 */
3158bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3159{
3160 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3161
3162 return !list_empty(&cwq->delayed_works);
3163}
3164EXPORT_SYMBOL_GPL(workqueue_congested);
3165
3166/**
3167 * work_cpu - return the last known associated cpu for @work
3168 * @work: the work of interest
3169 *
3170 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003171 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003172 */
3173unsigned int work_cpu(struct work_struct *work)
3174{
3175 struct global_cwq *gcwq = get_work_gcwq(work);
3176
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003177 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003178}
3179EXPORT_SYMBOL_GPL(work_cpu);
3180
3181/**
3182 * work_busy - test whether a work is currently pending or running
3183 * @work: the work to be tested
3184 *
3185 * Test whether @work is currently pending or running. There is no
3186 * synchronization around this function and the test result is
3187 * unreliable and only useful as advisory hints or for debugging.
3188 * Especially for reentrant wqs, the pending state might hide the
3189 * running state.
3190 *
3191 * RETURNS:
3192 * OR'd bitmask of WORK_BUSY_* bits.
3193 */
3194unsigned int work_busy(struct work_struct *work)
3195{
3196 struct global_cwq *gcwq = get_work_gcwq(work);
3197 unsigned long flags;
3198 unsigned int ret = 0;
3199
3200 if (!gcwq)
3201 return false;
3202
3203 spin_lock_irqsave(&gcwq->lock, flags);
3204
3205 if (work_pending(work))
3206 ret |= WORK_BUSY_PENDING;
3207 if (find_worker_executing_work(gcwq, work))
3208 ret |= WORK_BUSY_RUNNING;
3209
3210 spin_unlock_irqrestore(&gcwq->lock, flags);
3211
3212 return ret;
3213}
3214EXPORT_SYMBOL_GPL(work_busy);
3215
Tejun Heodb7bccf2010-06-29 10:07:12 +02003216/*
3217 * CPU hotplug.
3218 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003219 * There are two challenges in supporting CPU hotplug. Firstly, there
3220 * are a lot of assumptions on strong associations among work, cwq and
3221 * gcwq which make migrating pending and scheduled works very
3222 * difficult to implement without impacting hot paths. Secondly,
3223 * gcwqs serve mix of short, long and very long running works making
3224 * blocked draining impractical.
3225 *
3226 * This is solved by allowing a gcwq to be detached from CPU, running
3227 * it with unbound (rogue) workers and allowing it to be reattached
3228 * later if the cpu comes back online. A separate thread is created
3229 * to govern a gcwq in such state and is called the trustee of the
3230 * gcwq.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003231 *
3232 * Trustee states and their descriptions.
3233 *
3234 * START Command state used on startup. On CPU_DOWN_PREPARE, a
3235 * new trustee is started with this state.
3236 *
3237 * IN_CHARGE Once started, trustee will enter this state after
Tejun Heoe22bee72010-06-29 10:07:14 +02003238 * assuming the manager role and making all existing
3239 * workers rogue. DOWN_PREPARE waits for trustee to
3240 * enter this state. After reaching IN_CHARGE, trustee
3241 * tries to execute the pending worklist until it's empty
3242 * and the state is set to BUTCHER, or the state is set
3243 * to RELEASE.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003244 *
3245 * BUTCHER Command state which is set by the cpu callback after
3246 * the cpu has went down. Once this state is set trustee
3247 * knows that there will be no new works on the worklist
3248 * and once the worklist is empty it can proceed to
3249 * killing idle workers.
3250 *
3251 * RELEASE Command state which is set by the cpu callback if the
3252 * cpu down has been canceled or it has come online
3253 * again. After recognizing this state, trustee stops
Tejun Heoe22bee72010-06-29 10:07:14 +02003254 * trying to drain or butcher and clears ROGUE, rebinds
3255 * all remaining workers back to the cpu and releases
3256 * manager role.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003257 *
3258 * DONE Trustee will enter this state after BUTCHER or RELEASE
3259 * is complete.
3260 *
3261 * trustee CPU draining
3262 * took over down complete
3263 * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3264 * | | ^
3265 * | CPU is back online v return workers |
3266 * ----------------> RELEASE --------------
3267 */
3268
3269/**
3270 * trustee_wait_event_timeout - timed event wait for trustee
3271 * @cond: condition to wait for
3272 * @timeout: timeout in jiffies
3273 *
3274 * wait_event_timeout() for trustee to use. Handles locking and
3275 * checks for RELEASE request.
3276 *
3277 * CONTEXT:
3278 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3279 * multiple times. To be used by trustee.
3280 *
3281 * RETURNS:
3282 * Positive indicating left time if @cond is satisfied, 0 if timed
3283 * out, -1 if canceled.
3284 */
3285#define trustee_wait_event_timeout(cond, timeout) ({ \
3286 long __ret = (timeout); \
3287 while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \
3288 __ret) { \
3289 spin_unlock_irq(&gcwq->lock); \
3290 __wait_event_timeout(gcwq->trustee_wait, (cond) || \
3291 (gcwq->trustee_state == TRUSTEE_RELEASE), \
3292 __ret); \
3293 spin_lock_irq(&gcwq->lock); \
3294 } \
3295 gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret); \
3296})
3297
3298/**
3299 * trustee_wait_event - event wait for trustee
3300 * @cond: condition to wait for
3301 *
3302 * wait_event() for trustee to use. Automatically handles locking and
3303 * checks for CANCEL request.
3304 *
3305 * CONTEXT:
3306 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3307 * multiple times. To be used by trustee.
3308 *
3309 * RETURNS:
3310 * 0 if @cond is satisfied, -1 if canceled.
3311 */
3312#define trustee_wait_event(cond) ({ \
3313 long __ret1; \
3314 __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3315 __ret1 < 0 ? -1 : 0; \
3316})
3317
3318static int __cpuinit trustee_thread(void *__gcwq)
3319{
3320 struct global_cwq *gcwq = __gcwq;
3321 struct worker *worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02003322 struct work_struct *work;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003323 struct hlist_node *pos;
Tejun Heoe22bee72010-06-29 10:07:14 +02003324 long rc;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003325 int i;
3326
3327 BUG_ON(gcwq->cpu != smp_processor_id());
3328
3329 spin_lock_irq(&gcwq->lock);
3330 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02003331 * Claim the manager position and make all workers rogue.
3332 * Trustee must be bound to the target cpu and can't be
3333 * cancelled.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003334 */
3335 BUG_ON(gcwq->cpu != smp_processor_id());
Tejun Heoe22bee72010-06-29 10:07:14 +02003336 rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS));
3337 BUG_ON(rc < 0);
3338
3339 gcwq->flags |= GCWQ_MANAGING_WORKERS;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003340
3341 list_for_each_entry(worker, &gcwq->idle_list, entry)
Tejun Heocb444762010-07-02 10:03:50 +02003342 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003343
3344 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heocb444762010-07-02 10:03:50 +02003345 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003346
3347 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02003348 * Call schedule() so that we cross rq->lock and thus can
3349 * guarantee sched callbacks see the rogue flag. This is
3350 * necessary as scheduler callbacks may be invoked from other
3351 * cpus.
3352 */
3353 spin_unlock_irq(&gcwq->lock);
3354 schedule();
3355 spin_lock_irq(&gcwq->lock);
3356
3357 /*
Tejun Heocb444762010-07-02 10:03:50 +02003358 * Sched callbacks are disabled now. Zap nr_running. After
3359 * this, nr_running stays zero and need_more_worker() and
3360 * keep_working() are always true as long as the worklist is
3361 * not empty.
Tejun Heoe22bee72010-06-29 10:07:14 +02003362 */
Tejun Heocb444762010-07-02 10:03:50 +02003363 atomic_set(get_gcwq_nr_running(gcwq->cpu), 0);
Tejun Heoe22bee72010-06-29 10:07:14 +02003364
3365 spin_unlock_irq(&gcwq->lock);
3366 del_timer_sync(&gcwq->idle_timer);
3367 spin_lock_irq(&gcwq->lock);
3368
3369 /*
Tejun Heodb7bccf2010-06-29 10:07:12 +02003370 * We're now in charge. Notify and proceed to drain. We need
3371 * to keep the gcwq running during the whole CPU down
3372 * procedure as other cpu hotunplug callbacks may need to
3373 * flush currently running tasks.
3374 */
3375 gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3376 wake_up_all(&gcwq->trustee_wait);
3377
3378 /*
3379 * The original cpu is in the process of dying and may go away
3380 * anytime now. When that happens, we and all workers would
Tejun Heoe22bee72010-06-29 10:07:14 +02003381 * be migrated to other cpus. Try draining any left work. We
3382 * want to get it over with ASAP - spam rescuers, wake up as
3383 * many idlers as necessary and create new ones till the
3384 * worklist is empty. Note that if the gcwq is frozen, there
Tejun Heo58a69cb2011-02-16 09:25:31 +01003385 * may be frozen works in freezable cwqs. Don't declare
Tejun Heoe22bee72010-06-29 10:07:14 +02003386 * completion while frozen.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003387 */
3388 while (gcwq->nr_workers != gcwq->nr_idle ||
3389 gcwq->flags & GCWQ_FREEZING ||
3390 gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003391 int nr_works = 0;
3392
3393 list_for_each_entry(work, &gcwq->worklist, entry) {
3394 send_mayday(work);
3395 nr_works++;
3396 }
3397
3398 list_for_each_entry(worker, &gcwq->idle_list, entry) {
3399 if (!nr_works--)
3400 break;
3401 wake_up_process(worker->task);
3402 }
3403
3404 if (need_to_create_worker(gcwq)) {
3405 spin_unlock_irq(&gcwq->lock);
3406 worker = create_worker(gcwq, false);
3407 spin_lock_irq(&gcwq->lock);
3408 if (worker) {
Tejun Heocb444762010-07-02 10:03:50 +02003409 worker->flags |= WORKER_ROGUE;
Tejun Heoe22bee72010-06-29 10:07:14 +02003410 start_worker(worker);
3411 }
3412 }
3413
Tejun Heodb7bccf2010-06-29 10:07:12 +02003414 /* give a breather */
3415 if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3416 break;
3417 }
3418
Tejun Heoe22bee72010-06-29 10:07:14 +02003419 /*
3420 * Either all works have been scheduled and cpu is down, or
3421 * cpu down has already been canceled. Wait for and butcher
3422 * all workers till we're canceled.
3423 */
3424 do {
3425 rc = trustee_wait_event(!list_empty(&gcwq->idle_list));
3426 while (!list_empty(&gcwq->idle_list))
3427 destroy_worker(list_first_entry(&gcwq->idle_list,
3428 struct worker, entry));
3429 } while (gcwq->nr_workers && rc >= 0);
3430
3431 /*
3432 * At this point, either draining has completed and no worker
3433 * is left, or cpu down has been canceled or the cpu is being
3434 * brought back up. There shouldn't be any idle one left.
3435 * Tell the remaining busy ones to rebind once it finishes the
3436 * currently scheduled works by scheduling the rebind_work.
3437 */
3438 WARN_ON(!list_empty(&gcwq->idle_list));
3439
3440 for_each_busy_worker(worker, i, pos, gcwq) {
3441 struct work_struct *rebind_work = &worker->rebind_work;
3442
3443 /*
3444 * Rebind_work may race with future cpu hotplug
3445 * operations. Use a separate flag to mark that
3446 * rebinding is scheduled.
3447 */
Tejun Heocb444762010-07-02 10:03:50 +02003448 worker->flags |= WORKER_REBIND;
3449 worker->flags &= ~WORKER_ROGUE;
Tejun Heoe22bee72010-06-29 10:07:14 +02003450
3451 /* queue rebind_work, wq doesn't matter, use the default one */
3452 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3453 work_data_bits(rebind_work)))
3454 continue;
3455
3456 debug_work_activate(rebind_work);
Tejun Heod320c032010-06-29 10:07:14 +02003457 insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
Tejun Heoe22bee72010-06-29 10:07:14 +02003458 worker->scheduled.next,
3459 work_color_to_flags(WORK_NO_COLOR));
3460 }
3461
3462 /* relinquish manager role */
3463 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
3464
Tejun Heodb7bccf2010-06-29 10:07:12 +02003465 /* notify completion */
3466 gcwq->trustee = NULL;
3467 gcwq->trustee_state = TRUSTEE_DONE;
3468 wake_up_all(&gcwq->trustee_wait);
3469 spin_unlock_irq(&gcwq->lock);
3470 return 0;
3471}
3472
3473/**
3474 * wait_trustee_state - wait for trustee to enter the specified state
3475 * @gcwq: gcwq the trustee of interest belongs to
3476 * @state: target state to wait for
3477 *
3478 * Wait for the trustee to reach @state. DONE is already matched.
3479 *
3480 * CONTEXT:
3481 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3482 * multiple times. To be used by cpu_callback.
3483 */
3484static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09003485__releases(&gcwq->lock)
3486__acquires(&gcwq->lock)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003487{
3488 if (!(gcwq->trustee_state == state ||
3489 gcwq->trustee_state == TRUSTEE_DONE)) {
3490 spin_unlock_irq(&gcwq->lock);
3491 __wait_event(gcwq->trustee_wait,
3492 gcwq->trustee_state == state ||
3493 gcwq->trustee_state == TRUSTEE_DONE);
3494 spin_lock_irq(&gcwq->lock);
3495 }
3496}
3497
Oleg Nesterov3af244332007-05-09 02:34:09 -07003498static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
3499 unsigned long action,
3500 void *hcpu)
3501{
3502 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003503 struct global_cwq *gcwq = get_gcwq(cpu);
3504 struct task_struct *new_trustee = NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +02003505 struct worker *uninitialized_var(new_worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003506 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003507
Rafael J. Wysocki8bb78442007-05-09 02:35:10 -07003508 action &= ~CPU_TASKS_FROZEN;
3509
Linus Torvalds1da177e2005-04-16 15:20:36 -07003510 switch (action) {
Tejun Heodb7bccf2010-06-29 10:07:12 +02003511 case CPU_DOWN_PREPARE:
3512 new_trustee = kthread_create(trustee_thread, gcwq,
3513 "workqueue_trustee/%d\n", cpu);
3514 if (IS_ERR(new_trustee))
3515 return notifier_from_errno(PTR_ERR(new_trustee));
3516 kthread_bind(new_trustee, cpu);
Tejun Heoe22bee72010-06-29 10:07:14 +02003517 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003518 case CPU_UP_PREPARE:
Tejun Heoe22bee72010-06-29 10:07:14 +02003519 BUG_ON(gcwq->first_idle);
3520 new_worker = create_worker(gcwq, false);
3521 if (!new_worker) {
3522 if (new_trustee)
3523 kthread_stop(new_trustee);
3524 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003525 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003526 }
3527
Tejun Heodb7bccf2010-06-29 10:07:12 +02003528 /* some are called w/ irq disabled, don't disturb irq status */
3529 spin_lock_irqsave(&gcwq->lock, flags);
3530
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003531 switch (action) {
Tejun Heodb7bccf2010-06-29 10:07:12 +02003532 case CPU_DOWN_PREPARE:
3533 /* initialize trustee and tell it to acquire the gcwq */
3534 BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3535 gcwq->trustee = new_trustee;
3536 gcwq->trustee_state = TRUSTEE_START;
3537 wake_up_process(gcwq->trustee);
3538 wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003539 /* fall through */
3540 case CPU_UP_PREPARE:
3541 BUG_ON(gcwq->first_idle);
3542 gcwq->first_idle = new_worker;
3543 break;
3544
3545 case CPU_DYING:
3546 /*
3547 * Before this, the trustee and all workers except for
3548 * the ones which are still executing works from
3549 * before the last CPU down must be on the cpu. After
3550 * this, they'll all be diasporas.
3551 */
3552 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003553 break;
3554
Oleg Nesterov3da1c842008-07-25 01:47:50 -07003555 case CPU_POST_DEAD:
Tejun Heodb7bccf2010-06-29 10:07:12 +02003556 gcwq->trustee_state = TRUSTEE_BUTCHER;
Tejun Heoe22bee72010-06-29 10:07:14 +02003557 /* fall through */
3558 case CPU_UP_CANCELED:
3559 destroy_worker(gcwq->first_idle);
3560 gcwq->first_idle = NULL;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003561 break;
3562
3563 case CPU_DOWN_FAILED:
3564 case CPU_ONLINE:
Tejun Heoe22bee72010-06-29 10:07:14 +02003565 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003566 if (gcwq->trustee_state != TRUSTEE_DONE) {
3567 gcwq->trustee_state = TRUSTEE_RELEASE;
3568 wake_up_process(gcwq->trustee);
3569 wait_trustee_state(gcwq, TRUSTEE_DONE);
3570 }
3571
Tejun Heoe22bee72010-06-29 10:07:14 +02003572 /*
3573 * Trustee is done and there might be no worker left.
3574 * Put the first_idle in and request a real manager to
3575 * take a look.
3576 */
3577 spin_unlock_irq(&gcwq->lock);
3578 kthread_bind(gcwq->first_idle->task, cpu);
3579 spin_lock_irq(&gcwq->lock);
3580 gcwq->flags |= GCWQ_MANAGE_WORKERS;
3581 start_worker(gcwq->first_idle);
3582 gcwq->first_idle = NULL;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003583 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003584 }
3585
Tejun Heodb7bccf2010-06-29 10:07:12 +02003586 spin_unlock_irqrestore(&gcwq->lock, flags);
3587
Tejun Heo15376632010-06-29 10:07:11 +02003588 return notifier_from_errno(0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003589}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003590
Rusty Russell2d3854a2008-11-05 13:39:10 +11003591#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003592
Rusty Russell2d3854a2008-11-05 13:39:10 +11003593struct work_for_cpu {
Andrew Morton6b44003e2009-04-09 09:50:37 -06003594 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003595 long (*fn)(void *);
3596 void *arg;
3597 long ret;
3598};
3599
Andrew Morton6b44003e2009-04-09 09:50:37 -06003600static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003601{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003602 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003603 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b44003e2009-04-09 09:50:37 -06003604 complete(&wfc->completion);
3605 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003606}
3607
3608/**
3609 * work_on_cpu - run a function in user context on a particular cpu
3610 * @cpu: the cpu to run on
3611 * @fn: the function to run
3612 * @arg: the function arg
3613 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003614 * This will return the value @fn returns.
3615 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06003616 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003617 */
3618long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3619{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003620 struct task_struct *sub_thread;
3621 struct work_for_cpu wfc = {
3622 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3623 .fn = fn,
3624 .arg = arg,
3625 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003626
Andrew Morton6b44003e2009-04-09 09:50:37 -06003627 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3628 if (IS_ERR(sub_thread))
3629 return PTR_ERR(sub_thread);
3630 kthread_bind(sub_thread, cpu);
3631 wake_up_process(sub_thread);
3632 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003633 return wfc.ret;
3634}
3635EXPORT_SYMBOL_GPL(work_on_cpu);
3636#endif /* CONFIG_SMP */
3637
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003638#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303639
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003640/**
3641 * freeze_workqueues_begin - begin freezing workqueues
3642 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003643 * Start freezing workqueues. After this function returns, all freezable
3644 * workqueues will queue new works to their frozen_works list instead of
3645 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003646 *
3647 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003648 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003649 */
3650void freeze_workqueues_begin(void)
3651{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003652 unsigned int cpu;
3653
3654 spin_lock(&workqueue_lock);
3655
3656 BUG_ON(workqueue_freezing);
3657 workqueue_freezing = true;
3658
Tejun Heof3421792010-07-02 10:03:51 +02003659 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003660 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003661 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003662
3663 spin_lock_irq(&gcwq->lock);
3664
Tejun Heodb7bccf2010-06-29 10:07:12 +02003665 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3666 gcwq->flags |= GCWQ_FREEZING;
3667
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003668 list_for_each_entry(wq, &workqueues, list) {
3669 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3670
Tejun Heo58a69cb2011-02-16 09:25:31 +01003671 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003672 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003673 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003674
3675 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003676 }
3677
3678 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003679}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003680
3681/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003682 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003683 *
3684 * Check whether freezing is complete. This function must be called
3685 * between freeze_workqueues_begin() and thaw_workqueues().
3686 *
3687 * CONTEXT:
3688 * Grabs and releases workqueue_lock.
3689 *
3690 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003691 * %true if some freezable workqueues are still busy. %false if freezing
3692 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003693 */
3694bool freeze_workqueues_busy(void)
3695{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003696 unsigned int cpu;
3697 bool busy = false;
3698
3699 spin_lock(&workqueue_lock);
3700
3701 BUG_ON(!workqueue_freezing);
3702
Tejun Heof3421792010-07-02 10:03:51 +02003703 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003704 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003705 /*
3706 * nr_active is monotonically decreasing. It's safe
3707 * to peek without lock.
3708 */
3709 list_for_each_entry(wq, &workqueues, list) {
3710 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3711
Tejun Heo58a69cb2011-02-16 09:25:31 +01003712 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003713 continue;
3714
3715 BUG_ON(cwq->nr_active < 0);
3716 if (cwq->nr_active) {
3717 busy = true;
3718 goto out_unlock;
3719 }
3720 }
3721 }
3722out_unlock:
3723 spin_unlock(&workqueue_lock);
3724 return busy;
3725}
3726
3727/**
3728 * thaw_workqueues - thaw workqueues
3729 *
3730 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003731 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003732 *
3733 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003734 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003735 */
3736void thaw_workqueues(void)
3737{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003738 unsigned int cpu;
3739
3740 spin_lock(&workqueue_lock);
3741
3742 if (!workqueue_freezing)
3743 goto out_unlock;
3744
Tejun Heof3421792010-07-02 10:03:51 +02003745 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003746 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003747 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003748
3749 spin_lock_irq(&gcwq->lock);
3750
Tejun Heodb7bccf2010-06-29 10:07:12 +02003751 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3752 gcwq->flags &= ~GCWQ_FREEZING;
3753
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003754 list_for_each_entry(wq, &workqueues, list) {
3755 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3756
Tejun Heo58a69cb2011-02-16 09:25:31 +01003757 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003758 continue;
3759
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003760 /* restore max_active and repopulate worklist */
3761 cwq->max_active = wq->saved_max_active;
3762
3763 while (!list_empty(&cwq->delayed_works) &&
3764 cwq->nr_active < cwq->max_active)
3765 cwq_activate_first_delayed(cwq);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003766 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003767
Tejun Heoe22bee72010-06-29 10:07:14 +02003768 wake_up_worker(gcwq);
3769
Tejun Heo8b03ae32010-06-29 10:07:12 +02003770 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003771 }
3772
3773 workqueue_freezing = false;
3774out_unlock:
3775 spin_unlock(&workqueue_lock);
3776}
3777#endif /* CONFIG_FREEZER */
3778
Suresh Siddha6ee05782010-07-30 14:57:37 -07003779static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003780{
Tejun Heoc34056a2010-06-29 10:07:11 +02003781 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003782 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02003783
Tejun Heof6500942010-08-09 11:50:34 +02003784 cpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003785
3786 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003787 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003788 struct global_cwq *gcwq = get_gcwq(cpu);
3789
3790 spin_lock_init(&gcwq->lock);
Tejun Heo7e116292010-06-29 10:07:13 +02003791 INIT_LIST_HEAD(&gcwq->worklist);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003792 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003793 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003794
Tejun Heoc8e55f32010-06-29 10:07:12 +02003795 INIT_LIST_HEAD(&gcwq->idle_list);
3796 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3797 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3798
Tejun Heoe22bee72010-06-29 10:07:14 +02003799 init_timer_deferrable(&gcwq->idle_timer);
3800 gcwq->idle_timer.function = idle_worker_timeout;
3801 gcwq->idle_timer.data = (unsigned long)gcwq;
3802
3803 setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout,
3804 (unsigned long)gcwq);
3805
Tejun Heo8b03ae32010-06-29 10:07:12 +02003806 ida_init(&gcwq->worker_ida);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003807
3808 gcwq->trustee_state = TRUSTEE_DONE;
3809 init_waitqueue_head(&gcwq->trustee_wait);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003810 }
3811
Tejun Heoe22bee72010-06-29 10:07:14 +02003812 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003813 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003814 struct global_cwq *gcwq = get_gcwq(cpu);
3815 struct worker *worker;
3816
Tejun Heo477a3c32010-08-31 10:54:35 +02003817 if (cpu != WORK_CPU_UNBOUND)
3818 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heoe22bee72010-06-29 10:07:14 +02003819 worker = create_worker(gcwq, true);
3820 BUG_ON(!worker);
3821 spin_lock_irq(&gcwq->lock);
3822 start_worker(worker);
3823 spin_unlock_irq(&gcwq->lock);
3824 }
3825
Tejun Heod320c032010-06-29 10:07:14 +02003826 system_wq = alloc_workqueue("events", 0, 0);
3827 system_long_wq = alloc_workqueue("events_long", 0, 0);
3828 system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003829 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3830 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003831 system_freezable_wq = alloc_workqueue("events_freezable",
3832 WQ_FREEZABLE, 0);
Alan Stern62d3c542012-03-02 10:51:00 +01003833 system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
3834 WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
Hitoshi Mitakee5cba242010-11-26 12:06:44 +01003835 BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
Alan Stern62d3c542012-03-02 10:51:00 +01003836 !system_unbound_wq || !system_freezable_wq ||
3837 !system_nrt_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003838 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003839}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003840early_initcall(init_workqueues);