blob: f2c5638bb5ab1aa44740dea600ffa8535a88018e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
19 * automatically managed. There is one worker pool for each CPU and
20 * one extra for works which are better served by workers which are
21 * not bound to any specific CPU.
22 *
23 * Please read Documentation/workqueue.txt for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 */
25
Paul Gortmaker9984de12011-05-23 14:51:41 -040026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/kernel.h>
28#include <linux/sched.h>
29#include <linux/init.h>
30#include <linux/signal.h>
31#include <linux/completion.h>
32#include <linux/workqueue.h>
33#include <linux/slab.h>
34#include <linux/cpu.h>
35#include <linux/notifier.h>
36#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060037#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070038#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080039#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080040#include <linux/kallsyms.h>
41#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070042#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020043#include <linux/idr.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020044
45#include "workqueue_sched.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Tejun Heoc8e55f32010-06-29 10:07:12 +020047enum {
Tejun 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 Nesterovb1f4ec172007-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 Nesterovb1f4ec172007-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)) {
479 if (likely(cpu < nr_cpu_ids)) {
480#ifdef CONFIG_SMP
481 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200482#else
Tejun Heof3421792010-07-02 10:03:51 +0200483 return wq->cpu_wq.single;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200484#endif
Tejun Heof3421792010-07-02 10:03:51 +0200485 }
486 } else if (likely(cpu == WORK_CPU_UNBOUND))
487 return wq->cpu_wq.single;
488 return NULL;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700489}
490
Tejun Heo73f53c42010-06-29 10:07:11 +0200491static unsigned int work_color_to_flags(int color)
492{
493 return color << WORK_STRUCT_COLOR_SHIFT;
494}
495
496static int get_work_color(struct work_struct *work)
497{
498 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
499 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
500}
501
502static int work_next_color(int color)
503{
504 return (color + 1) % WORK_NR_COLORS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505}
506
David Howells4594bf12006-12-07 11:33:26 +0000507/*
Tejun Heoe1201532010-07-22 14:14:25 +0200508 * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
509 * work is on queue. Once execution starts, WORK_STRUCT_CWQ is
510 * cleared and the work data contains the cpu number it was last on.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200511 *
512 * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
513 * cwq, cpu or clear work->data. These functions should only be
514 * called while the work is owned - ie. while the PENDING bit is set.
515 *
516 * get_work_[g]cwq() can be used to obtain the gcwq or cwq
517 * corresponding to a work. gcwq is available once the work has been
518 * queued anywhere after initialization. cwq is available only from
519 * queueing until execution starts.
David Howells4594bf12006-12-07 11:33:26 +0000520 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200521static inline void set_work_data(struct work_struct *work, unsigned long data,
522 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000523{
David Howells4594bf12006-12-07 11:33:26 +0000524 BUG_ON(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200525 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000526}
David Howells365970a2006-11-22 14:54:49 +0000527
Tejun Heo7a22ad72010-06-29 10:07:13 +0200528static void set_work_cwq(struct work_struct *work,
529 struct cpu_workqueue_struct *cwq,
530 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200531{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200532 set_work_data(work, (unsigned long)cwq,
Tejun Heoe1201532010-07-22 14:14:25 +0200533 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200534}
535
Tejun Heo7a22ad72010-06-29 10:07:13 +0200536static void set_work_cpu(struct work_struct *work, unsigned int cpu)
David Howells365970a2006-11-22 14:54:49 +0000537{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200538 set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
539}
540
541static void clear_work_data(struct work_struct *work)
542{
543 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
544}
545
Tejun Heo7a22ad72010-06-29 10:07:13 +0200546static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
547{
Tejun Heoe1201532010-07-22 14:14:25 +0200548 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200549
Tejun Heoe1201532010-07-22 14:14:25 +0200550 if (data & WORK_STRUCT_CWQ)
551 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
552 else
553 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200554}
555
556static struct global_cwq *get_work_gcwq(struct work_struct *work)
557{
Tejun Heoe1201532010-07-22 14:14:25 +0200558 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200559 unsigned int cpu;
560
Tejun Heoe1201532010-07-22 14:14:25 +0200561 if (data & WORK_STRUCT_CWQ)
562 return ((struct cpu_workqueue_struct *)
563 (data & WORK_STRUCT_WQ_DATA_MASK))->gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200564
565 cpu = data >> WORK_STRUCT_FLAG_BITS;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200566 if (cpu == WORK_CPU_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200567 return NULL;
568
Tejun Heof3421792010-07-02 10:03:51 +0200569 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200570 return get_gcwq(cpu);
David Howells365970a2006-11-22 14:54:49 +0000571}
572
573/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200574 * Policy functions. These define the policies on how the global
575 * worker pool is managed. Unless noted otherwise, these functions
576 * assume that they're being called with gcwq->lock held.
David Howells365970a2006-11-22 14:54:49 +0000577 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200578
Tejun Heo649027d2010-06-29 10:07:14 +0200579static bool __need_more_worker(struct global_cwq *gcwq)
David Howells365970a2006-11-22 14:54:49 +0000580{
Tejun Heo649027d2010-06-29 10:07:14 +0200581 return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) ||
582 gcwq->flags & GCWQ_HIGHPRI_PENDING;
David Howells365970a2006-11-22 14:54:49 +0000583}
584
Tejun Heoe22bee72010-06-29 10:07:14 +0200585/*
586 * Need to wake up a worker? Called from anything but currently
587 * running workers.
588 */
589static bool need_more_worker(struct global_cwq *gcwq)
David Howells365970a2006-11-22 14:54:49 +0000590{
Tejun Heo649027d2010-06-29 10:07:14 +0200591 return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq);
David Howells365970a2006-11-22 14:54:49 +0000592}
593
Tejun Heoe22bee72010-06-29 10:07:14 +0200594/* Can I start working? Called from busy but !running workers. */
595static bool may_start_working(struct global_cwq *gcwq)
596{
597 return gcwq->nr_idle;
598}
599
600/* Do I need to keep working? Called from currently running workers. */
601static bool keep_working(struct global_cwq *gcwq)
602{
603 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
604
Tejun Heo30310042010-10-11 11:51:57 +0200605 return !list_empty(&gcwq->worklist) &&
606 (atomic_read(nr_running) <= 1 ||
607 gcwq->flags & GCWQ_HIGHPRI_PENDING);
Tejun Heoe22bee72010-06-29 10:07:14 +0200608}
609
610/* Do we need a new worker? Called from manager. */
611static bool need_to_create_worker(struct global_cwq *gcwq)
612{
613 return need_more_worker(gcwq) && !may_start_working(gcwq);
614}
615
616/* Do I need to be the manager? */
617static bool need_to_manage_workers(struct global_cwq *gcwq)
618{
619 return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS;
620}
621
622/* Do we have too many workers and should some go away? */
623static bool too_many_workers(struct global_cwq *gcwq)
624{
625 bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS;
626 int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */
627 int nr_busy = gcwq->nr_workers - nr_idle;
628
629 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
630}
631
632/*
633 * Wake up functions.
634 */
635
Tejun Heo7e116292010-06-29 10:07:13 +0200636/* Return the first worker. Safe with preemption disabled */
637static struct worker *first_worker(struct global_cwq *gcwq)
638{
639 if (unlikely(list_empty(&gcwq->idle_list)))
640 return NULL;
641
642 return list_first_entry(&gcwq->idle_list, struct worker, entry);
643}
644
645/**
646 * wake_up_worker - wake up an idle worker
647 * @gcwq: gcwq to wake worker for
648 *
649 * Wake up the first idle worker of @gcwq.
650 *
651 * CONTEXT:
652 * spin_lock_irq(gcwq->lock).
653 */
654static void wake_up_worker(struct global_cwq *gcwq)
655{
656 struct worker *worker = first_worker(gcwq);
657
658 if (likely(worker))
659 wake_up_process(worker->task);
660}
661
Tejun Heo4690c4a2010-06-29 10:07:10 +0200662/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200663 * wq_worker_waking_up - a worker is waking up
664 * @task: task waking up
665 * @cpu: CPU @task is waking up to
666 *
667 * This function is called during try_to_wake_up() when a worker is
668 * being awoken.
669 *
670 * CONTEXT:
671 * spin_lock_irq(rq->lock)
672 */
673void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
674{
675 struct worker *worker = kthread_data(task);
676
Steven Rostedt2d646722010-12-03 23:12:33 -0500677 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe22bee72010-06-29 10:07:14 +0200678 atomic_inc(get_gcwq_nr_running(cpu));
679}
680
681/**
682 * wq_worker_sleeping - a worker is going to sleep
683 * @task: task going to sleep
684 * @cpu: CPU in question, must be the current CPU number
685 *
686 * This function is called during schedule() when a busy worker is
687 * going to sleep. Worker on the same cpu can be woken up by
688 * returning pointer to its task.
689 *
690 * CONTEXT:
691 * spin_lock_irq(rq->lock)
692 *
693 * RETURNS:
694 * Worker task on @cpu to wake up, %NULL if none.
695 */
696struct task_struct *wq_worker_sleeping(struct task_struct *task,
697 unsigned int cpu)
698{
699 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
700 struct global_cwq *gcwq = get_gcwq(cpu);
701 atomic_t *nr_running = get_gcwq_nr_running(cpu);
702
Steven Rostedt2d646722010-12-03 23:12:33 -0500703 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200704 return NULL;
705
706 /* this can only happen on the local cpu */
707 BUG_ON(cpu != raw_smp_processor_id());
708
709 /*
710 * The counterpart of the following dec_and_test, implied mb,
711 * worklist not empty test sequence is in insert_work().
712 * Please read comment there.
713 *
714 * NOT_RUNNING is clear. This means that trustee is not in
715 * charge and we're running on the local cpu w/ rq lock held
716 * and preemption disabled, which in turn means that none else
717 * could be manipulating idle_list, so dereferencing idle_list
718 * without gcwq lock is safe.
719 */
720 if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist))
721 to_wakeup = first_worker(gcwq);
722 return to_wakeup ? to_wakeup->task : NULL;
723}
724
725/**
726 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200727 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200728 * @flags: flags to set
729 * @wakeup: wakeup an idle worker if necessary
730 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200731 * Set @flags in @worker->flags and adjust nr_running accordingly. If
732 * nr_running becomes zero and @wakeup is %true, an idle worker is
733 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200734 *
Tejun Heocb444762010-07-02 10:03:50 +0200735 * CONTEXT:
736 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200737 */
738static inline void worker_set_flags(struct worker *worker, unsigned int flags,
739 bool wakeup)
740{
Tejun Heoe22bee72010-06-29 10:07:14 +0200741 struct global_cwq *gcwq = worker->gcwq;
742
Tejun Heocb444762010-07-02 10:03:50 +0200743 WARN_ON_ONCE(worker->task != current);
744
Tejun Heoe22bee72010-06-29 10:07:14 +0200745 /*
746 * If transitioning into NOT_RUNNING, adjust nr_running and
747 * wake up an idle worker as necessary if requested by
748 * @wakeup.
749 */
750 if ((flags & WORKER_NOT_RUNNING) &&
751 !(worker->flags & WORKER_NOT_RUNNING)) {
752 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
753
754 if (wakeup) {
755 if (atomic_dec_and_test(nr_running) &&
756 !list_empty(&gcwq->worklist))
757 wake_up_worker(gcwq);
758 } else
759 atomic_dec(nr_running);
760 }
761
Tejun Heod302f012010-06-29 10:07:13 +0200762 worker->flags |= flags;
763}
764
765/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200766 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200767 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200768 * @flags: flags to clear
769 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200770 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200771 *
Tejun Heocb444762010-07-02 10:03:50 +0200772 * CONTEXT:
773 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200774 */
775static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
776{
Tejun Heoe22bee72010-06-29 10:07:14 +0200777 struct global_cwq *gcwq = worker->gcwq;
778 unsigned int oflags = worker->flags;
779
Tejun Heocb444762010-07-02 10:03:50 +0200780 WARN_ON_ONCE(worker->task != current);
781
Tejun Heod302f012010-06-29 10:07:13 +0200782 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200783
Tejun Heo42c025f2011-01-11 15:58:49 +0100784 /*
785 * If transitioning out of NOT_RUNNING, increment nr_running. Note
786 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
787 * of multiple flags, not a single flag.
788 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200789 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
790 if (!(worker->flags & WORKER_NOT_RUNNING))
791 atomic_inc(get_gcwq_nr_running(gcwq->cpu));
Tejun Heod302f012010-06-29 10:07:13 +0200792}
793
794/**
Tejun Heoc8e55f32010-06-29 10:07:12 +0200795 * busy_worker_head - return the busy hash head for a work
796 * @gcwq: gcwq of interest
797 * @work: work to be hashed
798 *
799 * Return hash head of @gcwq for @work.
800 *
801 * CONTEXT:
802 * spin_lock_irq(gcwq->lock).
803 *
804 * RETURNS:
805 * Pointer to the hash head.
806 */
807static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
808 struct work_struct *work)
809{
810 const int base_shift = ilog2(sizeof(struct work_struct));
811 unsigned long v = (unsigned long)work;
812
813 /* simple shift and fold hash, do we need something better? */
814 v >>= base_shift;
815 v += v >> BUSY_WORKER_HASH_ORDER;
816 v &= BUSY_WORKER_HASH_MASK;
817
818 return &gcwq->busy_hash[v];
819}
820
821/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200822 * __find_worker_executing_work - find worker which is executing a work
823 * @gcwq: gcwq of interest
824 * @bwh: hash head as returned by busy_worker_head()
825 * @work: work to find worker for
826 *
827 * Find a worker which is executing @work on @gcwq. @bwh should be
828 * the hash head obtained by calling busy_worker_head() with the same
829 * work.
830 *
831 * CONTEXT:
832 * spin_lock_irq(gcwq->lock).
833 *
834 * RETURNS:
835 * Pointer to worker which is executing @work if found, NULL
836 * otherwise.
837 */
838static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
839 struct hlist_head *bwh,
840 struct work_struct *work)
841{
842 struct worker *worker;
843 struct hlist_node *tmp;
844
845 hlist_for_each_entry(worker, tmp, bwh, hentry)
846 if (worker->current_work == work)
847 return worker;
848 return NULL;
849}
850
851/**
852 * find_worker_executing_work - find worker which is executing a work
853 * @gcwq: gcwq of interest
854 * @work: work to find worker for
855 *
856 * Find a worker which is executing @work on @gcwq. This function is
857 * identical to __find_worker_executing_work() except that this
858 * function calculates @bwh itself.
859 *
860 * CONTEXT:
861 * spin_lock_irq(gcwq->lock).
862 *
863 * RETURNS:
864 * Pointer to worker which is executing @work if found, NULL
865 * otherwise.
866 */
867static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
868 struct work_struct *work)
869{
870 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
871 work);
872}
873
874/**
Tejun Heo649027d2010-06-29 10:07:14 +0200875 * gcwq_determine_ins_pos - find insertion position
876 * @gcwq: gcwq of interest
877 * @cwq: cwq a work is being queued for
878 *
879 * A work for @cwq is about to be queued on @gcwq, determine insertion
880 * position for the work. If @cwq is for HIGHPRI wq, the work is
881 * queued at the head of the queue but in FIFO order with respect to
882 * other HIGHPRI works; otherwise, at the end of the queue. This
883 * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that
884 * there are HIGHPRI works pending.
885 *
886 * CONTEXT:
887 * spin_lock_irq(gcwq->lock).
888 *
889 * RETURNS:
890 * Pointer to inserstion position.
891 */
892static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq,
893 struct cpu_workqueue_struct *cwq)
894{
895 struct work_struct *twork;
896
897 if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
898 return &gcwq->worklist;
899
900 list_for_each_entry(twork, &gcwq->worklist, entry) {
901 struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
902
903 if (!(tcwq->wq->flags & WQ_HIGHPRI))
904 break;
905 }
906
907 gcwq->flags |= GCWQ_HIGHPRI_PENDING;
908 return &twork->entry;
909}
910
911/**
Tejun Heo7e116292010-06-29 10:07:13 +0200912 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +0200913 * @cwq: cwq @work belongs to
914 * @work: work to insert
915 * @head: insertion point
916 * @extra_flags: extra WORK_STRUCT_* flags to set
917 *
Tejun Heo7e116292010-06-29 10:07:13 +0200918 * Insert @work which belongs to @cwq into @gcwq after @head.
919 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200920 *
921 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +0200922 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +0200923 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700924static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +0200925 struct work_struct *work, struct list_head *head,
926 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700927{
Tejun Heoe22bee72010-06-29 10:07:14 +0200928 struct global_cwq *gcwq = cwq->gcwq;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +0100929
Tejun Heo4690c4a2010-06-29 10:07:10 +0200930 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200931 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +0200932
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700933 /*
934 * Ensure that we get the right work->data if we see the
935 * result of list_add() below, see try_to_grab_pending().
936 */
937 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +0200938
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -0700939 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +0200940
941 /*
942 * Ensure either worker_sched_deactivated() sees the above
943 * list_add_tail() or we see zero nr_running to avoid workers
944 * lying around lazily while there are works to be processed.
945 */
946 smp_mb();
947
Tejun Heo649027d2010-06-29 10:07:14 +0200948 if (__need_more_worker(gcwq))
Tejun Heoe22bee72010-06-29 10:07:14 +0200949 wake_up_worker(gcwq);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700950}
951
Tejun Heoc8efcc22010-12-20 19:32:04 +0100952/*
953 * Test whether @work is being queued from another work executing on the
954 * same workqueue. This is rather expensive and should only be used from
955 * cold paths.
956 */
957static bool is_chained_work(struct workqueue_struct *wq)
958{
959 unsigned long flags;
960 unsigned int cpu;
961
962 for_each_gcwq_cpu(cpu) {
963 struct global_cwq *gcwq = get_gcwq(cpu);
964 struct worker *worker;
965 struct hlist_node *pos;
966 int i;
967
968 spin_lock_irqsave(&gcwq->lock, flags);
969 for_each_busy_worker(worker, i, pos, gcwq) {
970 if (worker->task != current)
971 continue;
972 spin_unlock_irqrestore(&gcwq->lock, flags);
973 /*
974 * I'm @worker, no locking necessary. See if @work
975 * is headed to the same workqueue.
976 */
977 return worker->current_cwq->wq == wq;
978 }
979 spin_unlock_irqrestore(&gcwq->lock, flags);
980 }
981 return false;
982}
983
Tejun Heo4690c4a2010-06-29 10:07:10 +0200984static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 struct work_struct *work)
986{
Tejun Heo502ca9d2010-06-29 10:07:13 +0200987 struct global_cwq *gcwq;
988 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200989 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +0200990 unsigned int work_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 unsigned long flags;
992
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900993 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200994
Tejun Heoc8efcc22010-12-20 19:32:04 +0100995 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200996 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +0100997 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +0200998 return;
999
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001000 /* determine gcwq to use */
1001 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001002 struct global_cwq *last_gcwq;
1003
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001004 if (unlikely(cpu == WORK_CPU_UNBOUND))
1005 cpu = raw_smp_processor_id();
1006
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001007 /*
1008 * It's multi cpu. If @wq is non-reentrant and @work
1009 * was previously on a different cpu, it might still
1010 * be running there, in which case the work needs to
1011 * be queued on that cpu to guarantee non-reentrance.
1012 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001013 gcwq = get_gcwq(cpu);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001014 if (wq->flags & WQ_NON_REENTRANT &&
1015 (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
1016 struct worker *worker;
1017
1018 spin_lock_irqsave(&last_gcwq->lock, flags);
1019
1020 worker = find_worker_executing_work(last_gcwq, work);
1021
1022 if (worker && worker->current_cwq->wq == wq)
1023 gcwq = last_gcwq;
1024 else {
1025 /* meh... not running there, queue here */
1026 spin_unlock_irqrestore(&last_gcwq->lock, flags);
1027 spin_lock_irqsave(&gcwq->lock, flags);
1028 }
1029 } else
1030 spin_lock_irqsave(&gcwq->lock, flags);
Tejun Heof3421792010-07-02 10:03:51 +02001031 } else {
1032 gcwq = get_gcwq(WORK_CPU_UNBOUND);
1033 spin_lock_irqsave(&gcwq->lock, flags);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001034 }
1035
1036 /* gcwq determined, get cwq and queue */
1037 cwq = get_cwq(gcwq->cpu, wq);
Tejun Heocdadf002010-10-05 10:49:55 +02001038 trace_workqueue_queue_work(cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001039
Tejun Heo4690c4a2010-06-29 10:07:10 +02001040 BUG_ON(!list_empty(&work->entry));
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001041
Tejun Heo73f53c42010-06-29 10:07:11 +02001042 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001043 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001044
1045 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001046 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001047 cwq->nr_active++;
Tejun Heo649027d2010-06-29 10:07:14 +02001048 worklist = gcwq_determine_ins_pos(gcwq, cwq);
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001049 } else {
1050 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001051 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001052 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001053
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001054 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001055
Tejun Heo8b03ae32010-06-29 10:07:12 +02001056 spin_unlock_irqrestore(&gcwq->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057}
1058
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001059/**
1060 * queue_work - queue work on a workqueue
1061 * @wq: workqueue to use
1062 * @work: work to queue
1063 *
Alan Stern057647f2006-10-28 10:38:58 -07001064 * Returns 0 if @work was already on a queue, non-zero otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 *
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07001066 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1067 * it can be processed by another CPU.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001069int queue_work(struct workqueue_struct *wq, struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070{
Oleg Nesterovef1ca232008-07-25 01:47:53 -07001071 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
Oleg Nesterovef1ca232008-07-25 01:47:53 -07001073 ret = queue_work_on(get_cpu(), wq, work);
1074 put_cpu();
1075
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 return ret;
1077}
Dave Jonesae90dd52006-06-30 01:40:45 -04001078EXPORT_SYMBOL_GPL(queue_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079
Zhang Ruic1a220e2008-07-23 21:28:39 -07001080/**
1081 * queue_work_on - queue work on specific cpu
1082 * @cpu: CPU number to execute work on
1083 * @wq: workqueue to use
1084 * @work: work to queue
1085 *
1086 * Returns 0 if @work was already on a queue, non-zero otherwise.
1087 *
1088 * We queue the work to a specific CPU, the caller must ensure it
1089 * can't go away.
1090 */
1091int
1092queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1093{
1094 int ret = 0;
1095
Tejun Heo22df02b2010-06-29 10:07:10 +02001096 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001097 __queue_work(cpu, wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001098 ret = 1;
1099 }
1100 return ret;
1101}
1102EXPORT_SYMBOL_GPL(queue_work_on);
1103
Li Zefan6d141c32008-02-08 04:21:09 -08001104static void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105{
David Howells52bad642006-11-22 14:54:01 +00001106 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001107 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108
Tejun Heo4690c4a2010-06-29 10:07:10 +02001109 __queue_work(smp_processor_id(), cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110}
1111
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001112/**
1113 * queue_delayed_work - queue work on a workqueue after delay
1114 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001115 * @dwork: delayable work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001116 * @delay: number of jiffies to wait before queueing
1117 *
Alan Stern057647f2006-10-28 10:38:58 -07001118 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001119 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001120int queue_delayed_work(struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +00001121 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122{
David Howells52bad642006-11-22 14:54:01 +00001123 if (delay == 0)
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001124 return queue_work(wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001126 return queue_delayed_work_on(-1, wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127}
Dave Jonesae90dd52006-06-30 01:40:45 -04001128EXPORT_SYMBOL_GPL(queue_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001130/**
1131 * queue_delayed_work_on - queue work on specific CPU after delay
1132 * @cpu: CPU number to execute work on
1133 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001134 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001135 * @delay: number of jiffies to wait before queueing
1136 *
Alan Stern057647f2006-10-28 10:38:58 -07001137 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001138 */
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001139int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +00001140 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001141{
1142 int ret = 0;
David Howells52bad642006-11-22 14:54:01 +00001143 struct timer_list *timer = &dwork->timer;
1144 struct work_struct *work = &dwork->work;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001145
Tejun Heo22df02b2010-06-29 10:07:10 +02001146 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001147 unsigned int lcpu;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001148
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001149 BUG_ON(timer_pending(timer));
1150 BUG_ON(!list_empty(&work->entry));
1151
Andrew Liu8a3e77c2008-05-01 04:35:14 -07001152 timer_stats_timer_set_start_info(&dwork->timer);
1153
Tejun Heo7a22ad72010-06-29 10:07:13 +02001154 /*
1155 * This stores cwq for the moment, for the timer_fn.
1156 * Note that the work's gcwq is preserved to allow
1157 * reentrance detection for delayed works.
1158 */
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001159 if (!(wq->flags & WQ_UNBOUND)) {
1160 struct global_cwq *gcwq = get_work_gcwq(work);
1161
1162 if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1163 lcpu = gcwq->cpu;
1164 else
1165 lcpu = raw_smp_processor_id();
1166 } else
1167 lcpu = WORK_CPU_UNBOUND;
1168
Tejun Heo7a22ad72010-06-29 10:07:13 +02001169 set_work_cwq(work, get_cwq(lcpu, wq), 0);
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001170
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001171 timer->expires = jiffies + delay;
David Howells52bad642006-11-22 14:54:01 +00001172 timer->data = (unsigned long)dwork;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001173 timer->function = delayed_work_timer_fn;
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001174
1175 if (unlikely(cpu >= 0))
1176 add_timer_on(timer, cpu);
1177 else
1178 add_timer(timer);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001179 ret = 1;
1180 }
1181 return ret;
1182}
Dave Jonesae90dd52006-06-30 01:40:45 -04001183EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184
Tejun Heoc8e55f32010-06-29 10:07:12 +02001185/**
1186 * worker_enter_idle - enter idle state
1187 * @worker: worker which is entering idle state
1188 *
1189 * @worker is entering idle state. Update stats and idle timer if
1190 * necessary.
1191 *
1192 * LOCKING:
1193 * spin_lock_irq(gcwq->lock).
1194 */
1195static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196{
Tejun Heoc8e55f32010-06-29 10:07:12 +02001197 struct global_cwq *gcwq = worker->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198
Tejun Heoc8e55f32010-06-29 10:07:12 +02001199 BUG_ON(worker->flags & WORKER_IDLE);
1200 BUG_ON(!list_empty(&worker->entry) &&
1201 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
Tejun Heocb444762010-07-02 10:03:50 +02001203 /* can't use worker_set_flags(), also called from start_worker() */
1204 worker->flags |= WORKER_IDLE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001205 gcwq->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001206 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001207
Tejun Heoc8e55f32010-06-29 10:07:12 +02001208 /* idle_list is LIFO */
1209 list_add(&worker->entry, &gcwq->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001210
Tejun Heoe22bee72010-06-29 10:07:14 +02001211 if (likely(!(worker->flags & WORKER_ROGUE))) {
1212 if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer))
1213 mod_timer(&gcwq->idle_timer,
1214 jiffies + IDLE_WORKER_TIMEOUT);
1215 } else
Tejun Heodb7bccf2010-06-29 10:07:12 +02001216 wake_up_all(&gcwq->trustee_wait);
Tejun Heocb444762010-07-02 10:03:50 +02001217
1218 /* sanity check nr_running */
1219 WARN_ON_ONCE(gcwq->nr_workers == gcwq->nr_idle &&
1220 atomic_read(get_gcwq_nr_running(gcwq->cpu)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221}
1222
Tejun Heoc8e55f32010-06-29 10:07:12 +02001223/**
1224 * worker_leave_idle - leave idle state
1225 * @worker: worker which is leaving idle state
1226 *
1227 * @worker is leaving idle state. Update stats.
1228 *
1229 * LOCKING:
1230 * spin_lock_irq(gcwq->lock).
1231 */
1232static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233{
Tejun Heoc8e55f32010-06-29 10:07:12 +02001234 struct global_cwq *gcwq = worker->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235
Tejun Heoc8e55f32010-06-29 10:07:12 +02001236 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001237 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001238 gcwq->nr_idle--;
1239 list_del_init(&worker->entry);
1240}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241
Tejun Heoe22bee72010-06-29 10:07:14 +02001242/**
1243 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1244 * @worker: self
1245 *
1246 * Works which are scheduled while the cpu is online must at least be
1247 * scheduled to a worker which is bound to the cpu so that if they are
1248 * flushed from cpu callbacks while cpu is going down, they are
1249 * guaranteed to execute on the cpu.
1250 *
1251 * This function is to be used by rogue workers and rescuers to bind
1252 * themselves to the target cpu and may race with cpu going down or
1253 * coming online. kthread_bind() can't be used because it may put the
1254 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1255 * verbatim as it's best effort and blocking and gcwq may be
1256 * [dis]associated in the meantime.
1257 *
1258 * This function tries set_cpus_allowed() and locks gcwq and verifies
1259 * the binding against GCWQ_DISASSOCIATED which is set during
1260 * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
1261 * idle state or fetches works without dropping lock, it can guarantee
1262 * the scheduling requirement described in the first paragraph.
1263 *
1264 * CONTEXT:
1265 * Might sleep. Called without any lock but returns with gcwq->lock
1266 * held.
1267 *
1268 * RETURNS:
1269 * %true if the associated gcwq is online (@worker is successfully
1270 * bound), %false if offline.
1271 */
1272static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001273__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001274{
1275 struct global_cwq *gcwq = worker->gcwq;
1276 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
Tejun Heoe22bee72010-06-29 10:07:14 +02001278 while (true) {
1279 /*
1280 * The following call may fail, succeed or succeed
1281 * without actually migrating the task to the cpu if
1282 * it races with cpu hotunplug operation. Verify
1283 * against GCWQ_DISASSOCIATED.
1284 */
Tejun Heof3421792010-07-02 10:03:51 +02001285 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1286 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001287
Tejun Heoe22bee72010-06-29 10:07:14 +02001288 spin_lock_irq(&gcwq->lock);
1289 if (gcwq->flags & GCWQ_DISASSOCIATED)
1290 return false;
1291 if (task_cpu(task) == gcwq->cpu &&
1292 cpumask_equal(&current->cpus_allowed,
1293 get_cpu_mask(gcwq->cpu)))
1294 return true;
1295 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001296
Tejun Heo5035b202011-04-29 18:08:37 +02001297 /*
1298 * We've raced with CPU hot[un]plug. Give it a breather
1299 * and retry migration. cond_resched() is required here;
1300 * otherwise, we might deadlock against cpu_stop trying to
1301 * bring down the CPU on non-preemptive kernel.
1302 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001303 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001304 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001305 }
1306}
1307
1308/*
1309 * Function for worker->rebind_work used to rebind rogue busy workers
1310 * to the associated cpu which is coming back online. This is
1311 * scheduled by cpu up but can race with other cpu hotplug operations
1312 * and may be executed twice without intervening cpu down.
1313 */
1314static void worker_rebind_fn(struct work_struct *work)
1315{
1316 struct worker *worker = container_of(work, struct worker, rebind_work);
1317 struct global_cwq *gcwq = worker->gcwq;
1318
1319 if (worker_maybe_bind_and_lock(worker))
1320 worker_clr_flags(worker, WORKER_REBIND);
1321
1322 spin_unlock_irq(&gcwq->lock);
1323}
1324
Tejun Heoc34056a2010-06-29 10:07:11 +02001325static struct worker *alloc_worker(void)
1326{
1327 struct worker *worker;
1328
1329 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001330 if (worker) {
1331 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001332 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heoe22bee72010-06-29 10:07:14 +02001333 INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1334 /* on creation a worker is in !idle && prep state */
1335 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001336 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001337 return worker;
1338}
1339
1340/**
1341 * create_worker - create a new workqueue worker
Tejun Heo7e116292010-06-29 10:07:13 +02001342 * @gcwq: gcwq the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001343 * @bind: whether to set affinity to @cpu or not
1344 *
Tejun Heo7e116292010-06-29 10:07:13 +02001345 * Create a new worker which is bound to @gcwq. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001346 * can be started by calling start_worker() or destroyed using
1347 * destroy_worker().
1348 *
1349 * CONTEXT:
1350 * Might sleep. Does GFP_KERNEL allocations.
1351 *
1352 * RETURNS:
1353 * Pointer to the newly created worker.
1354 */
Tejun Heo7e116292010-06-29 10:07:13 +02001355static struct worker *create_worker(struct global_cwq *gcwq, bool bind)
Tejun Heoc34056a2010-06-29 10:07:11 +02001356{
Tejun Heof3421792010-07-02 10:03:51 +02001357 bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
Tejun Heoc34056a2010-06-29 10:07:11 +02001358 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001359 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001360
Tejun Heo8b03ae32010-06-29 10:07:12 +02001361 spin_lock_irq(&gcwq->lock);
1362 while (ida_get_new(&gcwq->worker_ida, &id)) {
1363 spin_unlock_irq(&gcwq->lock);
1364 if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001365 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001366 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001367 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001368 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001369
1370 worker = alloc_worker();
1371 if (!worker)
1372 goto fail;
1373
Tejun Heo8b03ae32010-06-29 10:07:12 +02001374 worker->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001375 worker->id = id;
1376
Tejun Heof3421792010-07-02 10:03:51 +02001377 if (!on_unbound_cpu)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001378 worker->task = kthread_create_on_node(worker_thread,
1379 worker,
1380 cpu_to_node(gcwq->cpu),
1381 "kworker/%u:%d", gcwq->cpu, id);
Tejun Heof3421792010-07-02 10:03:51 +02001382 else
1383 worker->task = kthread_create(worker_thread, worker,
1384 "kworker/u:%d", id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001385 if (IS_ERR(worker->task))
1386 goto fail;
1387
Tejun Heodb7bccf2010-06-29 10:07:12 +02001388 /*
1389 * A rogue worker will become a regular one if CPU comes
1390 * online later on. Make sure every worker has
1391 * PF_THREAD_BOUND set.
1392 */
Tejun Heof3421792010-07-02 10:03:51 +02001393 if (bind && !on_unbound_cpu)
Tejun Heo8b03ae32010-06-29 10:07:12 +02001394 kthread_bind(worker->task, gcwq->cpu);
Tejun Heof3421792010-07-02 10:03:51 +02001395 else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001396 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heof3421792010-07-02 10:03:51 +02001397 if (on_unbound_cpu)
1398 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001400
Tejun Heoc34056a2010-06-29 10:07:11 +02001401 return worker;
1402fail:
1403 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001404 spin_lock_irq(&gcwq->lock);
1405 ida_remove(&gcwq->worker_ida, id);
1406 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001407 }
1408 kfree(worker);
1409 return NULL;
1410}
1411
1412/**
1413 * start_worker - start a newly created worker
1414 * @worker: worker to start
1415 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001416 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001417 *
1418 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001419 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001420 */
1421static void start_worker(struct worker *worker)
1422{
Tejun Heocb444762010-07-02 10:03:50 +02001423 worker->flags |= WORKER_STARTED;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001424 worker->gcwq->nr_workers++;
1425 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001426 wake_up_process(worker->task);
1427}
1428
1429/**
1430 * destroy_worker - destroy a workqueue worker
1431 * @worker: worker to be destroyed
1432 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001433 * Destroy @worker and adjust @gcwq stats accordingly.
1434 *
1435 * CONTEXT:
1436 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001437 */
1438static void destroy_worker(struct worker *worker)
1439{
Tejun Heo8b03ae32010-06-29 10:07:12 +02001440 struct global_cwq *gcwq = worker->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001441 int id = worker->id;
1442
1443 /* sanity check frenzy */
1444 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001445 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001446
Tejun Heoc8e55f32010-06-29 10:07:12 +02001447 if (worker->flags & WORKER_STARTED)
1448 gcwq->nr_workers--;
1449 if (worker->flags & WORKER_IDLE)
1450 gcwq->nr_idle--;
1451
1452 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001453 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001454
1455 spin_unlock_irq(&gcwq->lock);
1456
Tejun Heoc34056a2010-06-29 10:07:11 +02001457 kthread_stop(worker->task);
1458 kfree(worker);
1459
Tejun Heo8b03ae32010-06-29 10:07:12 +02001460 spin_lock_irq(&gcwq->lock);
1461 ida_remove(&gcwq->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001462}
1463
Tejun Heoe22bee72010-06-29 10:07:14 +02001464static void idle_worker_timeout(unsigned long __gcwq)
1465{
1466 struct global_cwq *gcwq = (void *)__gcwq;
1467
1468 spin_lock_irq(&gcwq->lock);
1469
1470 if (too_many_workers(gcwq)) {
1471 struct worker *worker;
1472 unsigned long expires;
1473
1474 /* idle_list is kept in LIFO order, check the last one */
1475 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1476 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1477
1478 if (time_before(jiffies, expires))
1479 mod_timer(&gcwq->idle_timer, expires);
1480 else {
1481 /* it's been idle for too long, wake up manager */
1482 gcwq->flags |= GCWQ_MANAGE_WORKERS;
1483 wake_up_worker(gcwq);
1484 }
1485 }
1486
1487 spin_unlock_irq(&gcwq->lock);
1488}
1489
1490static bool send_mayday(struct work_struct *work)
1491{
1492 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1493 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001494 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001495
1496 if (!(wq->flags & WQ_RESCUER))
1497 return false;
1498
1499 /* mayday mayday mayday */
Tejun Heof3421792010-07-02 10:03:51 +02001500 cpu = cwq->gcwq->cpu;
1501 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1502 if (cpu == WORK_CPU_UNBOUND)
1503 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001504 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001505 wake_up_process(wq->rescuer->task);
1506 return true;
1507}
1508
1509static void gcwq_mayday_timeout(unsigned long __gcwq)
1510{
1511 struct global_cwq *gcwq = (void *)__gcwq;
1512 struct work_struct *work;
1513
1514 spin_lock_irq(&gcwq->lock);
1515
1516 if (need_to_create_worker(gcwq)) {
1517 /*
1518 * We've been trying to create a new worker but
1519 * haven't been successful. We might be hitting an
1520 * allocation deadlock. Send distress signals to
1521 * rescuers.
1522 */
1523 list_for_each_entry(work, &gcwq->worklist, entry)
1524 send_mayday(work);
1525 }
1526
1527 spin_unlock_irq(&gcwq->lock);
1528
1529 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL);
1530}
1531
1532/**
1533 * maybe_create_worker - create a new worker if necessary
1534 * @gcwq: gcwq to create a new worker for
1535 *
1536 * Create a new worker for @gcwq if necessary. @gcwq is guaranteed to
1537 * have at least one idle worker on return from this function. If
1538 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1539 * sent to all rescuers with works scheduled on @gcwq to resolve
1540 * possible allocation deadlock.
1541 *
1542 * On return, need_to_create_worker() is guaranteed to be false and
1543 * may_start_working() true.
1544 *
1545 * LOCKING:
1546 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1547 * multiple times. Does GFP_KERNEL allocations. Called only from
1548 * manager.
1549 *
1550 * RETURNS:
1551 * false if no action was taken and gcwq->lock stayed locked, true
1552 * otherwise.
1553 */
1554static bool maybe_create_worker(struct global_cwq *gcwq)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001555__releases(&gcwq->lock)
1556__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001557{
1558 if (!need_to_create_worker(gcwq))
1559 return false;
1560restart:
Tejun Heo9f9c236442010-07-14 11:31:20 +02001561 spin_unlock_irq(&gcwq->lock);
1562
Tejun Heoe22bee72010-06-29 10:07:14 +02001563 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1564 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1565
1566 while (true) {
1567 struct worker *worker;
1568
Tejun Heoe22bee72010-06-29 10:07:14 +02001569 worker = create_worker(gcwq, true);
1570 if (worker) {
1571 del_timer_sync(&gcwq->mayday_timer);
1572 spin_lock_irq(&gcwq->lock);
1573 start_worker(worker);
1574 BUG_ON(need_to_create_worker(gcwq));
1575 return true;
1576 }
1577
1578 if (!need_to_create_worker(gcwq))
1579 break;
1580
Tejun Heoe22bee72010-06-29 10:07:14 +02001581 __set_current_state(TASK_INTERRUPTIBLE);
1582 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001583
Tejun Heoe22bee72010-06-29 10:07:14 +02001584 if (!need_to_create_worker(gcwq))
1585 break;
1586 }
1587
Tejun Heoe22bee72010-06-29 10:07:14 +02001588 del_timer_sync(&gcwq->mayday_timer);
1589 spin_lock_irq(&gcwq->lock);
1590 if (need_to_create_worker(gcwq))
1591 goto restart;
1592 return true;
1593}
1594
1595/**
1596 * maybe_destroy_worker - destroy workers which have been idle for a while
1597 * @gcwq: gcwq to destroy workers for
1598 *
1599 * Destroy @gcwq workers which have been idle for longer than
1600 * IDLE_WORKER_TIMEOUT.
1601 *
1602 * LOCKING:
1603 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1604 * multiple times. Called only from manager.
1605 *
1606 * RETURNS:
1607 * false if no action was taken and gcwq->lock stayed locked, true
1608 * otherwise.
1609 */
1610static bool maybe_destroy_workers(struct global_cwq *gcwq)
1611{
1612 bool ret = false;
1613
1614 while (too_many_workers(gcwq)) {
1615 struct worker *worker;
1616 unsigned long expires;
1617
1618 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1619 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1620
1621 if (time_before(jiffies, expires)) {
1622 mod_timer(&gcwq->idle_timer, expires);
1623 break;
1624 }
1625
1626 destroy_worker(worker);
1627 ret = true;
1628 }
1629
1630 return ret;
1631}
1632
1633/**
1634 * manage_workers - manage worker pool
1635 * @worker: self
1636 *
1637 * Assume the manager role and manage gcwq worker pool @worker belongs
1638 * to. At any given time, there can be only zero or one manager per
1639 * gcwq. The exclusion is handled automatically by this function.
1640 *
1641 * The caller can safely start processing works on false return. On
1642 * true return, it's guaranteed that need_to_create_worker() is false
1643 * and may_start_working() is true.
1644 *
1645 * CONTEXT:
1646 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1647 * multiple times. Does GFP_KERNEL allocations.
1648 *
1649 * RETURNS:
1650 * false if no action was taken and gcwq->lock stayed locked, true if
1651 * some action was taken.
1652 */
1653static bool manage_workers(struct worker *worker)
1654{
1655 struct global_cwq *gcwq = worker->gcwq;
1656 bool ret = false;
1657
1658 if (gcwq->flags & GCWQ_MANAGING_WORKERS)
1659 return ret;
1660
1661 gcwq->flags &= ~GCWQ_MANAGE_WORKERS;
1662 gcwq->flags |= GCWQ_MANAGING_WORKERS;
1663
1664 /*
1665 * Destroy and then create so that may_start_working() is true
1666 * on return.
1667 */
1668 ret |= maybe_destroy_workers(gcwq);
1669 ret |= maybe_create_worker(gcwq);
1670
1671 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
1672
1673 /*
1674 * The trustee might be waiting to take over the manager
1675 * position, tell it we're done.
1676 */
1677 if (unlikely(gcwq->trustee))
1678 wake_up_all(&gcwq->trustee_wait);
1679
1680 return ret;
1681}
1682
Tejun Heoa62428c2010-06-29 10:07:10 +02001683/**
Tejun Heoaffee4b2010-06-29 10:07:12 +02001684 * move_linked_works - move linked works to a list
1685 * @work: start of series of works to be scheduled
1686 * @head: target list to append @work to
1687 * @nextp: out paramter for nested worklist walking
1688 *
1689 * Schedule linked works starting from @work to @head. Work series to
1690 * be scheduled starts at @work and includes any consecutive work with
1691 * WORK_STRUCT_LINKED set in its predecessor.
1692 *
1693 * If @nextp is not NULL, it's updated to point to the next work of
1694 * the last scheduled work. This allows move_linked_works() to be
1695 * nested inside outer list_for_each_entry_safe().
1696 *
1697 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001698 * spin_lock_irq(gcwq->lock).
Tejun Heoaffee4b2010-06-29 10:07:12 +02001699 */
1700static void move_linked_works(struct work_struct *work, struct list_head *head,
1701 struct work_struct **nextp)
1702{
1703 struct work_struct *n;
1704
1705 /*
1706 * Linked worklist will always end before the end of the list,
1707 * use NULL for list head.
1708 */
1709 list_for_each_entry_safe_from(work, n, NULL, entry) {
1710 list_move_tail(&work->entry, head);
1711 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1712 break;
1713 }
1714
1715 /*
1716 * If we're already inside safe list traversal and have moved
1717 * multiple works to the scheduled queue, the next position
1718 * needs to be updated.
1719 */
1720 if (nextp)
1721 *nextp = n;
1722}
1723
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001724static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
1725{
1726 struct work_struct *work = list_first_entry(&cwq->delayed_works,
1727 struct work_struct, entry);
Tejun Heo649027d2010-06-29 10:07:14 +02001728 struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001729
Tejun Heocdadf002010-10-05 10:49:55 +02001730 trace_workqueue_activate_work(work);
Tejun Heo649027d2010-06-29 10:07:14 +02001731 move_linked_works(work, pos, NULL);
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001732 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001733 cwq->nr_active++;
1734}
1735
Tejun Heoaffee4b2010-06-29 10:07:12 +02001736/**
Tejun Heo73f53c42010-06-29 10:07:11 +02001737 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1738 * @cwq: cwq of interest
1739 * @color: color of work which left the queue
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001740 * @delayed: for a delayed work
Tejun Heo73f53c42010-06-29 10:07:11 +02001741 *
1742 * A work either has completed or is removed from pending queue,
1743 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1744 *
1745 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001746 * spin_lock_irq(gcwq->lock).
Tejun Heo73f53c42010-06-29 10:07:11 +02001747 */
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001748static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
1749 bool delayed)
Tejun Heo73f53c42010-06-29 10:07:11 +02001750{
1751 /* ignore uncolored works */
1752 if (color == WORK_NO_COLOR)
1753 return;
1754
1755 cwq->nr_in_flight[color]--;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001756
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001757 if (!delayed) {
1758 cwq->nr_active--;
1759 if (!list_empty(&cwq->delayed_works)) {
1760 /* one down, submit a delayed one */
1761 if (cwq->nr_active < cwq->max_active)
1762 cwq_activate_first_delayed(cwq);
1763 }
Tejun Heo502ca9d2010-06-29 10:07:13 +02001764 }
Tejun Heo73f53c42010-06-29 10:07:11 +02001765
1766 /* is flush in progress and are we at the flushing tip? */
1767 if (likely(cwq->flush_color != color))
1768 return;
1769
1770 /* are there still in-flight works? */
1771 if (cwq->nr_in_flight[color])
1772 return;
1773
1774 /* this cwq is done, clear flush_color */
1775 cwq->flush_color = -1;
1776
1777 /*
1778 * If this was the last cwq, wake up the first flusher. It
1779 * will handle the rest.
1780 */
1781 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1782 complete(&cwq->wq->first_flusher->done);
1783}
1784
1785/**
Tejun Heoa62428c2010-06-29 10:07:10 +02001786 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001787 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001788 * @work: work to process
1789 *
1790 * Process @work. This function contains all the logics necessary to
1791 * process a single work including synchronization against and
1792 * interaction with other workers on the same cpu, queueing and
1793 * flushing. As long as context requirement is met, any worker can
1794 * call this function to process a work.
1795 *
1796 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001797 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02001798 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001799static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001800__releases(&gcwq->lock)
1801__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02001802{
Tejun Heo7e116292010-06-29 10:07:13 +02001803 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001804 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001805 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heofb0e7be2010-06-29 10:07:15 +02001806 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02001807 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02001808 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02001809 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02001810#ifdef CONFIG_LOCKDEP
1811 /*
1812 * It is permissible to free the struct work_struct from
1813 * inside the function that is called from it, this we need to
1814 * take into account for lockdep too. To avoid bogus "held
1815 * lock freed" warnings as well as problems when looking into
1816 * work->lockdep_map, make a copy and use that here.
1817 */
1818 struct lockdep_map lockdep_map = work->lockdep_map;
1819#endif
Tejun Heo7e116292010-06-29 10:07:13 +02001820 /*
1821 * A single work shouldn't be executed concurrently by
1822 * multiple workers on a single cpu. Check whether anyone is
1823 * already processing the work. If so, defer the work to the
1824 * currently executing one.
1825 */
1826 collision = __find_worker_executing_work(gcwq, bwh, work);
1827 if (unlikely(collision)) {
1828 move_linked_works(work, &collision->scheduled, NULL);
1829 return;
1830 }
1831
Tejun Heoa62428c2010-06-29 10:07:10 +02001832 /* claim and process */
Tejun Heoa62428c2010-06-29 10:07:10 +02001833 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001834 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02001835 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001836 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001837 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001838
Tejun Heo7a22ad72010-06-29 10:07:13 +02001839 /* record the current cpu number in the work data and dequeue */
1840 set_work_cpu(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02001841 list_del_init(&work->entry);
1842
Tejun Heo649027d2010-06-29 10:07:14 +02001843 /*
1844 * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
1845 * wake up another worker; otherwise, clear HIGHPRI_PENDING.
1846 */
1847 if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) {
1848 struct work_struct *nwork = list_first_entry(&gcwq->worklist,
1849 struct work_struct, entry);
1850
1851 if (!list_empty(&gcwq->worklist) &&
1852 get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
1853 wake_up_worker(gcwq);
1854 else
1855 gcwq->flags &= ~GCWQ_HIGHPRI_PENDING;
1856 }
1857
Tejun Heofb0e7be2010-06-29 10:07:15 +02001858 /*
1859 * CPU intensive works don't participate in concurrency
1860 * management. They're the scheduler's responsibility.
1861 */
1862 if (unlikely(cpu_intensive))
1863 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1864
Tejun Heo8b03ae32010-06-29 10:07:12 +02001865 spin_unlock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001866
Tejun Heoa62428c2010-06-29 10:07:10 +02001867 work_clear_pending(work);
Tejun Heoe159489b2011-01-09 23:32:15 +01001868 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02001869 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07001870 trace_workqueue_execute_start(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02001871 f(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07001872 /*
1873 * While we must be careful to not use "work" after this, the trace
1874 * point will only record its address.
1875 */
1876 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02001877 lock_map_release(&lockdep_map);
1878 lock_map_release(&cwq->wq->lockdep_map);
1879
1880 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1881 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1882 "%s/0x%08x/%d\n",
1883 current->comm, preempt_count(), task_pid_nr(current));
1884 printk(KERN_ERR " last function: ");
1885 print_symbol("%s\n", (unsigned long)f);
1886 debug_show_held_locks(current);
1887 dump_stack();
1888 }
1889
Tejun Heo8b03ae32010-06-29 10:07:12 +02001890 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001891
Tejun Heofb0e7be2010-06-29 10:07:15 +02001892 /* clear cpu intensive status */
1893 if (unlikely(cpu_intensive))
1894 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1895
Tejun Heoa62428c2010-06-29 10:07:10 +02001896 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02001897 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001898 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001899 worker->current_cwq = NULL;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001900 cwq_dec_nr_in_flight(cwq, work_color, false);
Tejun Heoa62428c2010-06-29 10:07:10 +02001901}
1902
Tejun Heoaffee4b2010-06-29 10:07:12 +02001903/**
1904 * process_scheduled_works - process scheduled works
1905 * @worker: self
1906 *
1907 * Process all scheduled works. Please note that the scheduled list
1908 * may change while processing a work, so this function repeatedly
1909 * fetches a work from the top and executes it.
1910 *
1911 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001912 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02001913 * multiple times.
1914 */
1915static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916{
Tejun Heoaffee4b2010-06-29 10:07:12 +02001917 while (!list_empty(&worker->scheduled)) {
1918 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001920 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922}
1923
Tejun Heo4690c4a2010-06-29 10:07:10 +02001924/**
1925 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02001926 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02001927 *
Tejun Heoe22bee72010-06-29 10:07:14 +02001928 * The gcwq worker thread function. There's a single dynamic pool of
1929 * these per each cpu. These workers process all works regardless of
1930 * their specific target workqueue. The only exception is works which
1931 * belong to workqueues with a rescuer which will be explained in
1932 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02001933 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001934static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935{
Tejun Heoc34056a2010-06-29 10:07:11 +02001936 struct worker *worker = __worker;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001937 struct global_cwq *gcwq = worker->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938
Tejun Heoe22bee72010-06-29 10:07:14 +02001939 /* tell the scheduler that this is a workqueue worker */
1940 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001941woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02001942 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943
Tejun Heoc8e55f32010-06-29 10:07:12 +02001944 /* DIE can be set only while we're idle, checking here is enough */
1945 if (worker->flags & WORKER_DIE) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001946 spin_unlock_irq(&gcwq->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001947 worker->task->flags &= ~PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001948 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 }
1950
Tejun Heoc8e55f32010-06-29 10:07:12 +02001951 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001952recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02001953 /* no more worker necessary? */
1954 if (!need_more_worker(gcwq))
1955 goto sleep;
1956
1957 /* do we need to manage? */
1958 if (unlikely(!may_start_working(gcwq)) && manage_workers(worker))
1959 goto recheck;
1960
Tejun Heoc8e55f32010-06-29 10:07:12 +02001961 /*
1962 * ->scheduled list can only be filled while a worker is
1963 * preparing to process a work or actually processing it.
1964 * Make sure nobody diddled with it while I was sleeping.
1965 */
1966 BUG_ON(!list_empty(&worker->scheduled));
1967
Tejun Heoe22bee72010-06-29 10:07:14 +02001968 /*
1969 * When control reaches this point, we're guaranteed to have
1970 * at least one idle worker or that someone else has already
1971 * assumed the manager role.
1972 */
1973 worker_clr_flags(worker, WORKER_PREP);
1974
1975 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02001976 struct work_struct *work =
Tejun Heo7e116292010-06-29 10:07:13 +02001977 list_first_entry(&gcwq->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02001978 struct work_struct, entry);
1979
1980 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1981 /* optimization path, not strictly necessary */
1982 process_one_work(worker, work);
1983 if (unlikely(!list_empty(&worker->scheduled)))
1984 process_scheduled_works(worker);
1985 } else {
1986 move_linked_works(work, &worker->scheduled, NULL);
1987 process_scheduled_works(worker);
1988 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001989 } while (keep_working(gcwq));
Tejun Heoc8e55f32010-06-29 10:07:12 +02001990
Tejun Heoe22bee72010-06-29 10:07:14 +02001991 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02001992sleep:
Tejun Heoe22bee72010-06-29 10:07:14 +02001993 if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker))
1994 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02001995
Tejun Heoc8e55f32010-06-29 10:07:12 +02001996 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02001997 * gcwq->lock is held and there's no work to process and no
1998 * need to manage, sleep. Workers are woken up only while
1999 * holding gcwq->lock or from local cpu, so setting the
2000 * current state before releasing gcwq->lock is enough to
2001 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002002 */
2003 worker_enter_idle(worker);
2004 __set_current_state(TASK_INTERRUPTIBLE);
2005 spin_unlock_irq(&gcwq->lock);
2006 schedule();
2007 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008}
2009
Tejun Heoe22bee72010-06-29 10:07:14 +02002010/**
2011 * rescuer_thread - the rescuer thread function
2012 * @__wq: the associated workqueue
2013 *
2014 * Workqueue rescuer thread function. There's one rescuer for each
2015 * workqueue which has WQ_RESCUER set.
2016 *
2017 * Regular work processing on a gcwq may block trying to create a new
2018 * worker which uses GFP_KERNEL allocation which has slight chance of
2019 * developing into deadlock if some works currently on the same queue
2020 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2021 * the problem rescuer solves.
2022 *
2023 * When such condition is possible, the gcwq summons rescuers of all
2024 * workqueues which have works queued on the gcwq and let them process
2025 * those works so that forward progress can be guaranteed.
2026 *
2027 * This should happen rarely.
2028 */
2029static int rescuer_thread(void *__wq)
2030{
2031 struct workqueue_struct *wq = __wq;
2032 struct worker *rescuer = wq->rescuer;
2033 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002034 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002035 unsigned int cpu;
2036
2037 set_user_nice(current, RESCUER_NICE_LEVEL);
2038repeat:
2039 set_current_state(TASK_INTERRUPTIBLE);
2040
2041 if (kthread_should_stop())
2042 return 0;
2043
Tejun Heof3421792010-07-02 10:03:51 +02002044 /*
2045 * See whether any cpu is asking for help. Unbounded
2046 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2047 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002048 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002049 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2050 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heoe22bee72010-06-29 10:07:14 +02002051 struct global_cwq *gcwq = cwq->gcwq;
2052 struct work_struct *work, *n;
2053
2054 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002055 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002056
2057 /* migrate to the target cpu if possible */
2058 rescuer->gcwq = gcwq;
2059 worker_maybe_bind_and_lock(rescuer);
2060
2061 /*
2062 * Slurp in all works issued via this workqueue and
2063 * process'em.
2064 */
2065 BUG_ON(!list_empty(&rescuer->scheduled));
2066 list_for_each_entry_safe(work, n, &gcwq->worklist, entry)
2067 if (get_work_cwq(work) == cwq)
2068 move_linked_works(work, scheduled, &n);
2069
2070 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002071
2072 /*
2073 * Leave this gcwq. If keep_working() is %true, notify a
2074 * regular worker; otherwise, we end up with 0 concurrency
2075 * and stalling the execution.
2076 */
2077 if (keep_working(gcwq))
2078 wake_up_worker(gcwq);
2079
Tejun Heoe22bee72010-06-29 10:07:14 +02002080 spin_unlock_irq(&gcwq->lock);
2081 }
2082
2083 schedule();
2084 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085}
2086
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002087struct wq_barrier {
2088 struct work_struct work;
2089 struct completion done;
2090};
2091
2092static void wq_barrier_func(struct work_struct *work)
2093{
2094 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2095 complete(&barr->done);
2096}
2097
Tejun Heo4690c4a2010-06-29 10:07:10 +02002098/**
2099 * insert_wq_barrier - insert a barrier work
2100 * @cwq: cwq to insert barrier into
2101 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002102 * @target: target work to attach @barr to
2103 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002104 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002105 * @barr is linked to @target such that @barr is completed only after
2106 * @target finishes execution. Please note that the ordering
2107 * guarantee is observed only with respect to @target and on the local
2108 * cpu.
2109 *
2110 * Currently, a queued barrier can't be canceled. This is because
2111 * try_to_grab_pending() can't determine whether the work to be
2112 * grabbed is at the head of the queue and thus can't clear LINKED
2113 * flag of the previous work while there must be a valid next work
2114 * after a work with LINKED flag set.
2115 *
2116 * Note that when @worker is non-NULL, @target may be modified
2117 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002118 *
2119 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002120 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002121 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002122static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002123 struct wq_barrier *barr,
2124 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002125{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002126 struct list_head *head;
2127 unsigned int linked = 0;
2128
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002129 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002130 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002131 * as we know for sure that this will not trigger any of the
2132 * checks and call back into the fixup functions where we
2133 * might deadlock.
2134 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002135 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002136 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002137 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002138
Tejun Heoaffee4b2010-06-29 10:07:12 +02002139 /*
2140 * If @target is currently being executed, schedule the
2141 * barrier to the worker; otherwise, put it after @target.
2142 */
2143 if (worker)
2144 head = worker->scheduled.next;
2145 else {
2146 unsigned long *bits = work_data_bits(target);
2147
2148 head = target->entry.next;
2149 /* there can already be other linked works, inherit and set */
2150 linked = *bits & WORK_STRUCT_LINKED;
2151 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2152 }
2153
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002154 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002155 insert_work(cwq, &barr->work, head,
2156 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002157}
2158
Tejun Heo73f53c42010-06-29 10:07:11 +02002159/**
2160 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2161 * @wq: workqueue being flushed
2162 * @flush_color: new flush color, < 0 for no-op
2163 * @work_color: new work color, < 0 for no-op
2164 *
2165 * Prepare cwqs for workqueue flushing.
2166 *
2167 * If @flush_color is non-negative, flush_color on all cwqs should be
2168 * -1. If no cwq has in-flight commands at the specified color, all
2169 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2170 * has in flight commands, its cwq->flush_color is set to
2171 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2172 * wakeup logic is armed and %true is returned.
2173 *
2174 * The caller should have initialized @wq->first_flusher prior to
2175 * calling this function with non-negative @flush_color. If
2176 * @flush_color is negative, no flush color update is done and %false
2177 * is returned.
2178 *
2179 * If @work_color is non-negative, all cwqs should have the same
2180 * work_color which is previous to @work_color and all will be
2181 * advanced to @work_color.
2182 *
2183 * CONTEXT:
2184 * mutex_lock(wq->flush_mutex).
2185 *
2186 * RETURNS:
2187 * %true if @flush_color >= 0 and there's something to flush. %false
2188 * otherwise.
2189 */
2190static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2191 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192{
Tejun Heo73f53c42010-06-29 10:07:11 +02002193 bool wait = false;
2194 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002195
Tejun Heo73f53c42010-06-29 10:07:11 +02002196 if (flush_color >= 0) {
2197 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2198 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002199 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002200
Tejun Heof3421792010-07-02 10:03:51 +02002201 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002202 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002203 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002204
Tejun Heo8b03ae32010-06-29 10:07:12 +02002205 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002206
2207 if (flush_color >= 0) {
2208 BUG_ON(cwq->flush_color != -1);
2209
2210 if (cwq->nr_in_flight[flush_color]) {
2211 cwq->flush_color = flush_color;
2212 atomic_inc(&wq->nr_cwqs_to_flush);
2213 wait = true;
2214 }
2215 }
2216
2217 if (work_color >= 0) {
2218 BUG_ON(work_color != work_next_color(cwq->work_color));
2219 cwq->work_color = work_color;
2220 }
2221
Tejun Heo8b03ae32010-06-29 10:07:12 +02002222 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002223 }
2224
2225 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2226 complete(&wq->first_flusher->done);
2227
2228 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229}
2230
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002231/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002233 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234 *
2235 * Forces execution of the workqueue and blocks until its completion.
2236 * This is typically used in driver shutdown handlers.
2237 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002238 * We sleep until all works which were queued on entry have been handled,
2239 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002241void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242{
Tejun Heo73f53c42010-06-29 10:07:11 +02002243 struct wq_flusher this_flusher = {
2244 .list = LIST_HEAD_INIT(this_flusher.list),
2245 .flush_color = -1,
2246 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2247 };
2248 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002249
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002250 lock_map_acquire(&wq->lockdep_map);
2251 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002252
2253 mutex_lock(&wq->flush_mutex);
2254
2255 /*
2256 * Start-to-wait phase
2257 */
2258 next_color = work_next_color(wq->work_color);
2259
2260 if (next_color != wq->flush_color) {
2261 /*
2262 * Color space is not full. The current work_color
2263 * becomes our flush_color and work_color is advanced
2264 * by one.
2265 */
2266 BUG_ON(!list_empty(&wq->flusher_overflow));
2267 this_flusher.flush_color = wq->work_color;
2268 wq->work_color = next_color;
2269
2270 if (!wq->first_flusher) {
2271 /* no flush in progress, become the first flusher */
2272 BUG_ON(wq->flush_color != this_flusher.flush_color);
2273
2274 wq->first_flusher = &this_flusher;
2275
2276 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2277 wq->work_color)) {
2278 /* nothing to flush, done */
2279 wq->flush_color = next_color;
2280 wq->first_flusher = NULL;
2281 goto out_unlock;
2282 }
2283 } else {
2284 /* wait in queue */
2285 BUG_ON(wq->flush_color == this_flusher.flush_color);
2286 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2287 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2288 }
2289 } else {
2290 /*
2291 * Oops, color space is full, wait on overflow queue.
2292 * The next flush completion will assign us
2293 * flush_color and transfer to flusher_queue.
2294 */
2295 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2296 }
2297
2298 mutex_unlock(&wq->flush_mutex);
2299
2300 wait_for_completion(&this_flusher.done);
2301
2302 /*
2303 * Wake-up-and-cascade phase
2304 *
2305 * First flushers are responsible for cascading flushes and
2306 * handling overflow. Non-first flushers can simply return.
2307 */
2308 if (wq->first_flusher != &this_flusher)
2309 return;
2310
2311 mutex_lock(&wq->flush_mutex);
2312
Tejun Heo4ce48b32010-07-02 10:03:51 +02002313 /* we might have raced, check again with mutex held */
2314 if (wq->first_flusher != &this_flusher)
2315 goto out_unlock;
2316
Tejun Heo73f53c42010-06-29 10:07:11 +02002317 wq->first_flusher = NULL;
2318
2319 BUG_ON(!list_empty(&this_flusher.list));
2320 BUG_ON(wq->flush_color != this_flusher.flush_color);
2321
2322 while (true) {
2323 struct wq_flusher *next, *tmp;
2324
2325 /* complete all the flushers sharing the current flush color */
2326 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2327 if (next->flush_color != wq->flush_color)
2328 break;
2329 list_del_init(&next->list);
2330 complete(&next->done);
2331 }
2332
2333 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2334 wq->flush_color != work_next_color(wq->work_color));
2335
2336 /* this flush_color is finished, advance by one */
2337 wq->flush_color = work_next_color(wq->flush_color);
2338
2339 /* one color has been freed, handle overflow queue */
2340 if (!list_empty(&wq->flusher_overflow)) {
2341 /*
2342 * Assign the same color to all overflowed
2343 * flushers, advance work_color and append to
2344 * flusher_queue. This is the start-to-wait
2345 * phase for these overflowed flushers.
2346 */
2347 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2348 tmp->flush_color = wq->work_color;
2349
2350 wq->work_color = work_next_color(wq->work_color);
2351
2352 list_splice_tail_init(&wq->flusher_overflow,
2353 &wq->flusher_queue);
2354 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2355 }
2356
2357 if (list_empty(&wq->flusher_queue)) {
2358 BUG_ON(wq->flush_color != wq->work_color);
2359 break;
2360 }
2361
2362 /*
2363 * Need to flush more colors. Make the next flusher
2364 * the new first flusher and arm cwqs.
2365 */
2366 BUG_ON(wq->flush_color == wq->work_color);
2367 BUG_ON(wq->flush_color != next->flush_color);
2368
2369 list_del_init(&next->list);
2370 wq->first_flusher = next;
2371
2372 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2373 break;
2374
2375 /*
2376 * Meh... this color is already done, clear first
2377 * flusher and repeat cascading.
2378 */
2379 wq->first_flusher = NULL;
2380 }
2381
2382out_unlock:
2383 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384}
Dave Jonesae90dd52006-06-30 01:40:45 -04002385EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002387/**
2388 * drain_workqueue - drain a workqueue
2389 * @wq: workqueue to drain
2390 *
2391 * Wait until the workqueue becomes empty. While draining is in progress,
2392 * only chain queueing is allowed. IOW, only currently pending or running
2393 * work items on @wq can queue further work items on it. @wq is flushed
2394 * repeatedly until it becomes empty. The number of flushing is detemined
2395 * by the depth of chaining and should be relatively short. Whine if it
2396 * takes too long.
2397 */
2398void drain_workqueue(struct workqueue_struct *wq)
2399{
2400 unsigned int flush_cnt = 0;
2401 unsigned int cpu;
2402
2403 /*
2404 * __queue_work() needs to test whether there are drainers, is much
2405 * hotter than drain_workqueue() and already looks at @wq->flags.
2406 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2407 */
2408 spin_lock(&workqueue_lock);
2409 if (!wq->nr_drainers++)
2410 wq->flags |= WQ_DRAINING;
2411 spin_unlock(&workqueue_lock);
2412reflush:
2413 flush_workqueue(wq);
2414
2415 for_each_cwq_cpu(cpu, wq) {
2416 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002417 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002418
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002419 spin_lock_irq(&cwq->gcwq->lock);
2420 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
2421 spin_unlock_irq(&cwq->gcwq->lock);
2422
2423 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002424 continue;
2425
2426 if (++flush_cnt == 10 ||
2427 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2428 pr_warning("workqueue %s: flush on destruction isn't complete after %u tries\n",
2429 wq->name, flush_cnt);
2430 goto reflush;
2431 }
2432
2433 spin_lock(&workqueue_lock);
2434 if (!--wq->nr_drainers)
2435 wq->flags &= ~WQ_DRAINING;
2436 spin_unlock(&workqueue_lock);
2437}
2438EXPORT_SYMBOL_GPL(drain_workqueue);
2439
Tejun Heobaf59022010-09-16 10:42:16 +02002440static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2441 bool wait_executing)
2442{
2443 struct worker *worker = NULL;
2444 struct global_cwq *gcwq;
2445 struct cpu_workqueue_struct *cwq;
2446
2447 might_sleep();
2448 gcwq = get_work_gcwq(work);
2449 if (!gcwq)
2450 return false;
2451
2452 spin_lock_irq(&gcwq->lock);
2453 if (!list_empty(&work->entry)) {
2454 /*
2455 * See the comment near try_to_grab_pending()->smp_rmb().
2456 * If it was re-queued to a different gcwq under us, we
2457 * are not going to wait.
2458 */
2459 smp_rmb();
2460 cwq = get_work_cwq(work);
2461 if (unlikely(!cwq || gcwq != cwq->gcwq))
2462 goto already_gone;
2463 } else if (wait_executing) {
2464 worker = find_worker_executing_work(gcwq, work);
2465 if (!worker)
2466 goto already_gone;
2467 cwq = worker->current_cwq;
2468 } else
2469 goto already_gone;
2470
2471 insert_wq_barrier(cwq, barr, work, worker);
2472 spin_unlock_irq(&gcwq->lock);
2473
Tejun Heoe159489b2011-01-09 23:32:15 +01002474 /*
2475 * If @max_active is 1 or rescuer is in use, flushing another work
2476 * item on the same workqueue may lead to deadlock. Make sure the
2477 * flusher is not running on the same workqueue by verifying write
2478 * access.
2479 */
2480 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2481 lock_map_acquire(&cwq->wq->lockdep_map);
2482 else
2483 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002484 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe159489b2011-01-09 23:32:15 +01002485
Tejun Heobaf59022010-09-16 10:42:16 +02002486 return true;
2487already_gone:
2488 spin_unlock_irq(&gcwq->lock);
2489 return false;
2490}
2491
Oleg Nesterovdb700892008-07-25 01:47:49 -07002492/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002493 * flush_work - wait for a work to finish executing the last queueing instance
2494 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002495 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002496 * Wait until @work has finished execution. This function considers
2497 * only the last queueing instance of @work. If @work has been
2498 * enqueued across different CPUs on a non-reentrant workqueue or on
2499 * multiple workqueues, @work might still be executing on return on
2500 * some of the CPUs from earlier queueing.
Oleg Nesterova67da702008-07-25 01:47:52 -07002501 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002502 * If @work was queued only on a non-reentrant, ordered or unbound
2503 * workqueue, @work is guaranteed to be idle on return if it hasn't
2504 * been requeued since flush started.
2505 *
2506 * RETURNS:
2507 * %true if flush_work() waited for the work to finish execution,
2508 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002509 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002510bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002511{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002512 struct wq_barrier barr;
2513
Tejun Heobaf59022010-09-16 10:42:16 +02002514 if (start_flush_work(work, &barr, true)) {
2515 wait_for_completion(&barr.done);
2516 destroy_work_on_stack(&barr.work);
2517 return true;
2518 } else
2519 return false;
Oleg Nesterovdb700892008-07-25 01:47:49 -07002520}
2521EXPORT_SYMBOL_GPL(flush_work);
2522
Tejun Heo401a8d02010-09-16 10:36:00 +02002523static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
2524{
2525 struct wq_barrier barr;
2526 struct worker *worker;
2527
2528 spin_lock_irq(&gcwq->lock);
2529
2530 worker = find_worker_executing_work(gcwq, work);
2531 if (unlikely(worker))
2532 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
2533
2534 spin_unlock_irq(&gcwq->lock);
2535
2536 if (unlikely(worker)) {
2537 wait_for_completion(&barr.done);
2538 destroy_work_on_stack(&barr.work);
2539 return true;
2540 } else
2541 return false;
2542}
2543
2544static bool wait_on_work(struct work_struct *work)
2545{
2546 bool ret = false;
2547 int cpu;
2548
2549 might_sleep();
2550
2551 lock_map_acquire(&work->lockdep_map);
2552 lock_map_release(&work->lockdep_map);
2553
2554 for_each_gcwq_cpu(cpu)
2555 ret |= wait_on_cpu_work(get_gcwq(cpu), work);
2556 return ret;
2557}
2558
Tejun Heo09383492010-09-16 10:48:29 +02002559/**
2560 * flush_work_sync - wait until a work has finished execution
2561 * @work: the work to flush
2562 *
2563 * Wait until @work has finished execution. On return, it's
2564 * guaranteed that all queueing instances of @work which happened
2565 * before this function is called are finished. In other words, if
2566 * @work hasn't been requeued since this function was called, @work is
2567 * guaranteed to be idle on return.
2568 *
2569 * RETURNS:
2570 * %true if flush_work_sync() waited for the work to finish execution,
2571 * %false if it was already idle.
2572 */
2573bool flush_work_sync(struct work_struct *work)
2574{
2575 struct wq_barrier barr;
2576 bool pending, waited;
2577
2578 /* we'll wait for executions separately, queue barr only if pending */
2579 pending = start_flush_work(work, &barr, false);
2580
2581 /* wait for executions to finish */
2582 waited = wait_on_work(work);
2583
2584 /* wait for the pending one */
2585 if (pending) {
2586 wait_for_completion(&barr.done);
2587 destroy_work_on_stack(&barr.work);
2588 }
2589
2590 return pending || waited;
2591}
2592EXPORT_SYMBOL_GPL(flush_work_sync);
2593
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002594/*
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002595 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002596 * so this work can't be re-armed in any way.
2597 */
2598static int try_to_grab_pending(struct work_struct *work)
2599{
Tejun Heo8b03ae32010-06-29 10:07:12 +02002600 struct global_cwq *gcwq;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002601 int ret = -1;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002602
Tejun Heo22df02b2010-06-29 10:07:10 +02002603 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002604 return 0;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002605
2606 /*
2607 * The queueing is in progress, or it is already queued. Try to
2608 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
2609 */
Tejun Heo7a22ad72010-06-29 10:07:13 +02002610 gcwq = get_work_gcwq(work);
2611 if (!gcwq)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002612 return ret;
2613
Tejun Heo8b03ae32010-06-29 10:07:12 +02002614 spin_lock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002615 if (!list_empty(&work->entry)) {
2616 /*
Tejun Heo7a22ad72010-06-29 10:07:13 +02002617 * This work is queued, but perhaps we locked the wrong gcwq.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002618 * In that case we must see the new value after rmb(), see
2619 * insert_work()->wmb().
2620 */
2621 smp_rmb();
Tejun Heo7a22ad72010-06-29 10:07:13 +02002622 if (gcwq == get_work_gcwq(work)) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002623 debug_work_deactivate(work);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002624 list_del_init(&work->entry);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002625 cwq_dec_nr_in_flight(get_work_cwq(work),
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02002626 get_work_color(work),
2627 *work_data_bits(work) & WORK_STRUCT_DELAYED);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002628 ret = 1;
2629 }
2630 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02002631 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002632
2633 return ret;
2634}
2635
Tejun Heo401a8d02010-09-16 10:36:00 +02002636static bool __cancel_work_timer(struct work_struct *work,
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002637 struct timer_list* timer)
2638{
2639 int ret;
2640
2641 do {
2642 ret = (timer && likely(del_timer(timer)));
2643 if (!ret)
2644 ret = try_to_grab_pending(work);
2645 wait_on_work(work);
2646 } while (unlikely(ret < 0));
2647
Tejun Heo7a22ad72010-06-29 10:07:13 +02002648 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002649 return ret;
2650}
2651
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002652/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002653 * cancel_work_sync - cancel a work and wait for it to finish
2654 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002655 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002656 * Cancel @work and wait for its execution to finish. This function
2657 * can be used even if the work re-queues itself or migrates to
2658 * another workqueue. On return from this function, @work is
2659 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002660 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002661 * cancel_work_sync(&delayed_work->work) must not be used for
2662 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002663 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002664 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002665 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002666 *
2667 * RETURNS:
2668 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002669 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002670bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002671{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002672 return __cancel_work_timer(work, NULL);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002673}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002674EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002675
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002676/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002677 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2678 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002679 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002680 * Delayed timer is cancelled and the pending work is queued for
2681 * immediate execution. Like flush_work(), this function only
2682 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002683 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002684 * RETURNS:
2685 * %true if flush_work() waited for the work to finish execution,
2686 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002687 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002688bool flush_delayed_work(struct delayed_work *dwork)
2689{
2690 if (del_timer_sync(&dwork->timer))
2691 __queue_work(raw_smp_processor_id(),
2692 get_work_cwq(&dwork->work)->wq, &dwork->work);
2693 return flush_work(&dwork->work);
2694}
2695EXPORT_SYMBOL(flush_delayed_work);
2696
2697/**
Tejun Heo09383492010-09-16 10:48:29 +02002698 * flush_delayed_work_sync - wait for a dwork to finish
2699 * @dwork: the delayed work to flush
2700 *
2701 * Delayed timer is cancelled and the pending work is queued for
2702 * execution immediately. Other than timer handling, its behavior
2703 * is identical to flush_work_sync().
2704 *
2705 * RETURNS:
2706 * %true if flush_work_sync() waited for the work to finish execution,
2707 * %false if it was already idle.
2708 */
2709bool flush_delayed_work_sync(struct delayed_work *dwork)
2710{
2711 if (del_timer_sync(&dwork->timer))
2712 __queue_work(raw_smp_processor_id(),
2713 get_work_cwq(&dwork->work)->wq, &dwork->work);
2714 return flush_work_sync(&dwork->work);
2715}
2716EXPORT_SYMBOL(flush_delayed_work_sync);
2717
2718/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002719 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2720 * @dwork: the delayed work cancel
2721 *
2722 * This is cancel_work_sync() for delayed works.
2723 *
2724 * RETURNS:
2725 * %true if @dwork was pending, %false otherwise.
2726 */
2727bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002728{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002729 return __cancel_work_timer(&dwork->work, &dwork->timer);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002730}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002731EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002732
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002733/**
2734 * schedule_work - put work task in global workqueue
2735 * @work: job to be done
2736 *
Bart Van Assche5b0f437d2009-07-30 19:00:53 +02002737 * Returns zero if @work was already on the kernel-global workqueue and
2738 * non-zero otherwise.
2739 *
2740 * This puts a job in the kernel-global workqueue if it was not already
2741 * queued and leaves it in the same position on the kernel-global
2742 * workqueue otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002743 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002744int schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002745{
Tejun Heod320c032010-06-29 10:07:14 +02002746 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747}
Dave Jonesae90dd52006-06-30 01:40:45 -04002748EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749
Zhang Ruic1a220e2008-07-23 21:28:39 -07002750/*
2751 * schedule_work_on - put work task on a specific cpu
2752 * @cpu: cpu to put the work task on
2753 * @work: job to be done
2754 *
2755 * This puts a job on a specific cpu
2756 */
2757int schedule_work_on(int cpu, struct work_struct *work)
2758{
Tejun Heod320c032010-06-29 10:07:14 +02002759 return queue_work_on(cpu, system_wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07002760}
2761EXPORT_SYMBOL(schedule_work_on);
2762
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002763/**
2764 * schedule_delayed_work - put work task in global workqueue after delay
David Howells52bad642006-11-22 14:54:01 +00002765 * @dwork: job to be done
2766 * @delay: number of jiffies to wait or 0 for immediate execution
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002767 *
2768 * After waiting for a given time this puts a job in the kernel-global
2769 * workqueue.
2770 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002771int schedule_delayed_work(struct delayed_work *dwork,
Ingo Molnar82f67cd2007-02-16 01:28:13 -08002772 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773{
Tejun Heod320c032010-06-29 10:07:14 +02002774 return queue_delayed_work(system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775}
Dave Jonesae90dd52006-06-30 01:40:45 -04002776EXPORT_SYMBOL(schedule_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002777
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002778/**
2779 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
2780 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +00002781 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002782 * @delay: number of jiffies to wait
2783 *
2784 * After waiting for a given time this puts a job in the kernel-global
2785 * workqueue on the specified CPU.
2786 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787int schedule_delayed_work_on(int cpu,
David Howells52bad642006-11-22 14:54:01 +00002788 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789{
Tejun Heod320c032010-06-29 10:07:14 +02002790 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002791}
Dave Jonesae90dd52006-06-30 01:40:45 -04002792EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793
Andrew Mortonb6136772006-06-25 05:47:49 -07002794/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002795 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002796 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002797 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002798 * schedule_on_each_cpu() executes @func on each online CPU using the
2799 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002800 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002801 *
2802 * RETURNS:
2803 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002804 */
David Howells65f27f32006-11-22 14:55:48 +00002805int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002806{
2807 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002808 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002809
Andrew Mortonb6136772006-06-25 05:47:49 -07002810 works = alloc_percpu(struct work_struct);
2811 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002812 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002813
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002814 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002815
Christoph Lameter15316ba2006-01-08 01:00:43 -08002816 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002817 struct work_struct *work = per_cpu_ptr(works, cpu);
2818
2819 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002820 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002821 }
Tejun Heo93981802009-11-17 14:06:20 -08002822
2823 for_each_online_cpu(cpu)
2824 flush_work(per_cpu_ptr(works, cpu));
2825
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002826 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002827 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08002828 return 0;
2829}
2830
Alan Sterneef6a7d2010-02-12 17:39:21 +09002831/**
2832 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2833 *
2834 * Forces execution of the kernel-global workqueue and blocks until its
2835 * completion.
2836 *
2837 * Think twice before calling this function! It's very easy to get into
2838 * trouble if you don't take great care. Either of the following situations
2839 * will lead to deadlock:
2840 *
2841 * One of the work items currently on the workqueue needs to acquire
2842 * a lock held by your code or its caller.
2843 *
2844 * Your code is running in the context of a work routine.
2845 *
2846 * They will be detected by lockdep when they occur, but the first might not
2847 * occur very often. It depends on what work items are on the workqueue and
2848 * what locks they need, which you have no control over.
2849 *
2850 * In most situations flushing the entire workqueue is overkill; you merely
2851 * need to know that a particular work item isn't queued and isn't running.
2852 * In such cases you should use cancel_delayed_work_sync() or
2853 * cancel_work_sync() instead.
2854 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002855void flush_scheduled_work(void)
2856{
Tejun Heod320c032010-06-29 10:07:14 +02002857 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002858}
Dave Jonesae90dd52006-06-30 01:40:45 -04002859EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002860
2861/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06002862 * execute_in_process_context - reliably execute the routine with user context
2863 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06002864 * @ew: guaranteed storage for the execute work structure (must
2865 * be available when the work executes)
2866 *
2867 * Executes the function immediately if process context is available,
2868 * otherwise schedules the function for delayed execution.
2869 *
2870 * Returns: 0 - function was executed
2871 * 1 - function was scheduled for execution
2872 */
David Howells65f27f32006-11-22 14:55:48 +00002873int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06002874{
2875 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00002876 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002877 return 0;
2878 }
2879
David Howells65f27f32006-11-22 14:55:48 +00002880 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002881 schedule_work(&ew->work);
2882
2883 return 1;
2884}
2885EXPORT_SYMBOL_GPL(execute_in_process_context);
2886
Linus Torvalds1da177e2005-04-16 15:20:36 -07002887int keventd_up(void)
2888{
Tejun Heod320c032010-06-29 10:07:14 +02002889 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002890}
2891
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002892static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893{
Oleg Nesterov3af244332007-05-09 02:34:09 -07002894 /*
Tejun Heo0f900042010-06-29 10:07:11 +02002895 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
2896 * Make sure that the alignment isn't lower than that of
2897 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07002898 */
Tejun Heo0f900042010-06-29 10:07:11 +02002899 const size_t size = sizeof(struct cpu_workqueue_struct);
2900 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
2901 __alignof__(unsigned long long));
Tejun Heo931ac772010-07-20 11:07:48 +02002902#ifdef CONFIG_SMP
2903 bool percpu = !(wq->flags & WQ_UNBOUND);
2904#else
2905 bool percpu = false;
2906#endif
Oleg Nesterov3af244332007-05-09 02:34:09 -07002907
Tejun Heo931ac772010-07-20 11:07:48 +02002908 if (percpu)
Tejun Heof3421792010-07-02 10:03:51 +02002909 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02002910 else {
Tejun Heof3421792010-07-02 10:03:51 +02002911 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01002912
Tejun Heof3421792010-07-02 10:03:51 +02002913 /*
2914 * Allocate enough room to align cwq and put an extra
2915 * pointer at the end pointing back to the originally
2916 * allocated pointer which will be used for free.
2917 */
2918 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2919 if (ptr) {
2920 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2921 *(void **)(wq->cpu_wq.single + 1) = ptr;
2922 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002923 }
Tejun Heof3421792010-07-02 10:03:51 +02002924
Tejun Heo0415b00d12011-03-24 18:50:09 +01002925 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002926 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2927 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002928}
2929
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002930static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07002931{
Tejun Heo931ac772010-07-20 11:07:48 +02002932#ifdef CONFIG_SMP
2933 bool percpu = !(wq->flags & WQ_UNBOUND);
2934#else
2935 bool percpu = false;
2936#endif
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07002937
Tejun Heo931ac772010-07-20 11:07:48 +02002938 if (percpu)
Tejun Heof3421792010-07-02 10:03:51 +02002939 free_percpu(wq->cpu_wq.pcpu);
2940 else if (wq->cpu_wq.single) {
2941 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002942 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07002943 }
2944}
2945
Tejun Heof3421792010-07-02 10:03:51 +02002946static int wq_clamp_max_active(int max_active, unsigned int flags,
2947 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02002948{
Tejun Heof3421792010-07-02 10:03:51 +02002949 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2950
2951 if (max_active < 1 || max_active > lim)
Tejun Heob71ab8c2010-06-29 10:07:14 +02002952 printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2953 "is out of range, clamping between %d and %d\n",
Tejun Heof3421792010-07-02 10:03:51 +02002954 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002955
Tejun Heof3421792010-07-02 10:03:51 +02002956 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002957}
2958
Tejun Heob196be82012-01-10 15:11:35 -08002959struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02002960 unsigned int flags,
2961 int max_active,
2962 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08002963 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07002964{
Tejun Heob196be82012-01-10 15:11:35 -08002965 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002966 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02002967 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08002968 size_t namelen;
2969
2970 /* determine namelen, allocate wq and format name */
2971 va_start(args, lock_name);
2972 va_copy(args1, args);
2973 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
2974
2975 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
2976 if (!wq)
2977 goto err;
2978
2979 vsnprintf(wq->name, namelen, fmt, args1);
2980 va_end(args);
2981 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002982
Tejun Heof3421792010-07-02 10:03:51 +02002983 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02002984 * Workqueues which may be used during memory reclaim should
2985 * have a rescuer to guarantee forward progress.
2986 */
2987 if (flags & WQ_MEM_RECLAIM)
2988 flags |= WQ_RESCUER;
2989
2990 /*
Tejun Heof3421792010-07-02 10:03:51 +02002991 * Unbound workqueues aren't concurrency managed and should be
2992 * dispatched to workers immediately.
2993 */
2994 if (flags & WQ_UNBOUND)
2995 flags |= WQ_HIGHPRI;
2996
Tejun Heod320c032010-06-29 10:07:14 +02002997 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08002998 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002999
Tejun Heob196be82012-01-10 15:11:35 -08003000 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003001 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003002 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003003 mutex_init(&wq->flush_mutex);
3004 atomic_set(&wq->nr_cwqs_to_flush, 0);
3005 INIT_LIST_HEAD(&wq->flusher_queue);
3006 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003007
Johannes Bergeb13ba82008-01-16 09:51:58 +01003008 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003009 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003010
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003011 if (alloc_cwqs(wq) < 0)
3012 goto err;
3013
Tejun Heof3421792010-07-02 10:03:51 +02003014 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003015 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003016 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo15376632010-06-29 10:07:11 +02003017
Tejun Heo0f900042010-06-29 10:07:11 +02003018 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003019 cwq->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003020 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003021 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003022 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003023 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003024 }
3025
Tejun Heoe22bee72010-06-29 10:07:14 +02003026 if (flags & WQ_RESCUER) {
3027 struct worker *rescuer;
3028
Tejun Heof2e005a2010-07-20 15:59:09 +02003029 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003030 goto err;
3031
3032 wq->rescuer = rescuer = alloc_worker();
3033 if (!rescuer)
3034 goto err;
3035
Tejun Heob196be82012-01-10 15:11:35 -08003036 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3037 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003038 if (IS_ERR(rescuer->task))
3039 goto err;
3040
Tejun Heoe22bee72010-06-29 10:07:14 +02003041 rescuer->task->flags |= PF_THREAD_BOUND;
3042 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003043 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003044
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003045 /*
3046 * workqueue_lock protects global freeze state and workqueues
3047 * list. Grab it, set max_active accordingly and add the new
3048 * workqueue to workqueues list.
3049 */
Tejun Heo15376632010-06-29 10:07:11 +02003050 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003051
Tejun Heo58a69cb2011-02-16 09:25:31 +01003052 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003053 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003054 get_cwq(cpu, wq)->max_active = 0;
3055
Tejun Heo15376632010-06-29 10:07:11 +02003056 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003057
Tejun Heo15376632010-06-29 10:07:11 +02003058 spin_unlock(&workqueue_lock);
3059
Oleg Nesterov3af244332007-05-09 02:34:09 -07003060 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003061err:
3062 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003063 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003064 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003065 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003066 kfree(wq);
3067 }
3068 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003069}
Tejun Heod320c032010-06-29 10:07:14 +02003070EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003071
3072/**
3073 * destroy_workqueue - safely terminate a workqueue
3074 * @wq: target workqueue
3075 *
3076 * Safely destroy a workqueue. All work currently pending will be done first.
3077 */
3078void destroy_workqueue(struct workqueue_struct *wq)
3079{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003080 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003081
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003082 /* drain it before proceeding with destruction */
3083 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003084
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003085 /*
3086 * wq list is used to freeze wq, remove from list after
3087 * flushing is complete in case freeze races us.
3088 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003089 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07003090 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003091 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003092
Tejun Heoe22bee72010-06-29 10:07:14 +02003093 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003094 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003095 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3096 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003097
Tejun Heo73f53c42010-06-29 10:07:11 +02003098 for (i = 0; i < WORK_NR_COLORS; i++)
3099 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003100 BUG_ON(cwq->nr_active);
3101 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003102 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003103
Tejun Heoe22bee72010-06-29 10:07:14 +02003104 if (wq->flags & WQ_RESCUER) {
3105 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003106 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003107 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003108 }
3109
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003110 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003111 kfree(wq);
3112}
3113EXPORT_SYMBOL_GPL(destroy_workqueue);
3114
Tejun Heodcd989c2010-06-29 10:07:14 +02003115/**
3116 * workqueue_set_max_active - adjust max_active of a workqueue
3117 * @wq: target workqueue
3118 * @max_active: new max_active value.
3119 *
3120 * Set max_active of @wq to @max_active.
3121 *
3122 * CONTEXT:
3123 * Don't call from IRQ context.
3124 */
3125void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3126{
3127 unsigned int cpu;
3128
Tejun Heof3421792010-07-02 10:03:51 +02003129 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003130
3131 spin_lock(&workqueue_lock);
3132
3133 wq->saved_max_active = max_active;
3134
Tejun Heof3421792010-07-02 10:03:51 +02003135 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003136 struct global_cwq *gcwq = get_gcwq(cpu);
3137
3138 spin_lock_irq(&gcwq->lock);
3139
Tejun Heo58a69cb2011-02-16 09:25:31 +01003140 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003141 !(gcwq->flags & GCWQ_FREEZING))
3142 get_cwq(gcwq->cpu, wq)->max_active = max_active;
3143
3144 spin_unlock_irq(&gcwq->lock);
3145 }
3146
3147 spin_unlock(&workqueue_lock);
3148}
3149EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3150
3151/**
3152 * workqueue_congested - test whether a workqueue is congested
3153 * @cpu: CPU in question
3154 * @wq: target workqueue
3155 *
3156 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3157 * no synchronization around this function and the test result is
3158 * unreliable and only useful as advisory hints or for debugging.
3159 *
3160 * RETURNS:
3161 * %true if congested, %false otherwise.
3162 */
3163bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3164{
3165 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3166
3167 return !list_empty(&cwq->delayed_works);
3168}
3169EXPORT_SYMBOL_GPL(workqueue_congested);
3170
3171/**
3172 * work_cpu - return the last known associated cpu for @work
3173 * @work: the work of interest
3174 *
3175 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003176 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003177 */
3178unsigned int work_cpu(struct work_struct *work)
3179{
3180 struct global_cwq *gcwq = get_work_gcwq(work);
3181
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003182 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003183}
3184EXPORT_SYMBOL_GPL(work_cpu);
3185
3186/**
3187 * work_busy - test whether a work is currently pending or running
3188 * @work: the work to be tested
3189 *
3190 * Test whether @work is currently pending or running. There is no
3191 * synchronization around this function and the test result is
3192 * unreliable and only useful as advisory hints or for debugging.
3193 * Especially for reentrant wqs, the pending state might hide the
3194 * running state.
3195 *
3196 * RETURNS:
3197 * OR'd bitmask of WORK_BUSY_* bits.
3198 */
3199unsigned int work_busy(struct work_struct *work)
3200{
3201 struct global_cwq *gcwq = get_work_gcwq(work);
3202 unsigned long flags;
3203 unsigned int ret = 0;
3204
3205 if (!gcwq)
3206 return false;
3207
3208 spin_lock_irqsave(&gcwq->lock, flags);
3209
3210 if (work_pending(work))
3211 ret |= WORK_BUSY_PENDING;
3212 if (find_worker_executing_work(gcwq, work))
3213 ret |= WORK_BUSY_RUNNING;
3214
3215 spin_unlock_irqrestore(&gcwq->lock, flags);
3216
3217 return ret;
3218}
3219EXPORT_SYMBOL_GPL(work_busy);
3220
Tejun Heodb7bccf2010-06-29 10:07:12 +02003221/*
3222 * CPU hotplug.
3223 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003224 * There are two challenges in supporting CPU hotplug. Firstly, there
3225 * are a lot of assumptions on strong associations among work, cwq and
3226 * gcwq which make migrating pending and scheduled works very
3227 * difficult to implement without impacting hot paths. Secondly,
3228 * gcwqs serve mix of short, long and very long running works making
3229 * blocked draining impractical.
3230 *
3231 * This is solved by allowing a gcwq to be detached from CPU, running
3232 * it with unbound (rogue) workers and allowing it to be reattached
3233 * later if the cpu comes back online. A separate thread is created
3234 * to govern a gcwq in such state and is called the trustee of the
3235 * gcwq.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003236 *
3237 * Trustee states and their descriptions.
3238 *
3239 * START Command state used on startup. On CPU_DOWN_PREPARE, a
3240 * new trustee is started with this state.
3241 *
3242 * IN_CHARGE Once started, trustee will enter this state after
Tejun Heoe22bee72010-06-29 10:07:14 +02003243 * assuming the manager role and making all existing
3244 * workers rogue. DOWN_PREPARE waits for trustee to
3245 * enter this state. After reaching IN_CHARGE, trustee
3246 * tries to execute the pending worklist until it's empty
3247 * and the state is set to BUTCHER, or the state is set
3248 * to RELEASE.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003249 *
3250 * BUTCHER Command state which is set by the cpu callback after
3251 * the cpu has went down. Once this state is set trustee
3252 * knows that there will be no new works on the worklist
3253 * and once the worklist is empty it can proceed to
3254 * killing idle workers.
3255 *
3256 * RELEASE Command state which is set by the cpu callback if the
3257 * cpu down has been canceled or it has come online
3258 * again. After recognizing this state, trustee stops
Tejun Heoe22bee72010-06-29 10:07:14 +02003259 * trying to drain or butcher and clears ROGUE, rebinds
3260 * all remaining workers back to the cpu and releases
3261 * manager role.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003262 *
3263 * DONE Trustee will enter this state after BUTCHER or RELEASE
3264 * is complete.
3265 *
3266 * trustee CPU draining
3267 * took over down complete
3268 * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
3269 * | | ^
3270 * | CPU is back online v return workers |
3271 * ----------------> RELEASE --------------
3272 */
3273
3274/**
3275 * trustee_wait_event_timeout - timed event wait for trustee
3276 * @cond: condition to wait for
3277 * @timeout: timeout in jiffies
3278 *
3279 * wait_event_timeout() for trustee to use. Handles locking and
3280 * checks for RELEASE request.
3281 *
3282 * CONTEXT:
3283 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3284 * multiple times. To be used by trustee.
3285 *
3286 * RETURNS:
3287 * Positive indicating left time if @cond is satisfied, 0 if timed
3288 * out, -1 if canceled.
3289 */
3290#define trustee_wait_event_timeout(cond, timeout) ({ \
3291 long __ret = (timeout); \
3292 while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \
3293 __ret) { \
3294 spin_unlock_irq(&gcwq->lock); \
3295 __wait_event_timeout(gcwq->trustee_wait, (cond) || \
3296 (gcwq->trustee_state == TRUSTEE_RELEASE), \
3297 __ret); \
3298 spin_lock_irq(&gcwq->lock); \
3299 } \
3300 gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret); \
3301})
3302
3303/**
3304 * trustee_wait_event - event wait for trustee
3305 * @cond: condition to wait for
3306 *
3307 * wait_event() for trustee to use. Automatically handles locking and
3308 * checks for CANCEL request.
3309 *
3310 * CONTEXT:
3311 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3312 * multiple times. To be used by trustee.
3313 *
3314 * RETURNS:
3315 * 0 if @cond is satisfied, -1 if canceled.
3316 */
3317#define trustee_wait_event(cond) ({ \
3318 long __ret1; \
3319 __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3320 __ret1 < 0 ? -1 : 0; \
3321})
3322
3323static int __cpuinit trustee_thread(void *__gcwq)
3324{
3325 struct global_cwq *gcwq = __gcwq;
3326 struct worker *worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02003327 struct work_struct *work;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003328 struct hlist_node *pos;
Tejun Heoe22bee72010-06-29 10:07:14 +02003329 long rc;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003330 int i;
3331
3332 BUG_ON(gcwq->cpu != smp_processor_id());
3333
3334 spin_lock_irq(&gcwq->lock);
3335 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02003336 * Claim the manager position and make all workers rogue.
3337 * Trustee must be bound to the target cpu and can't be
3338 * cancelled.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003339 */
3340 BUG_ON(gcwq->cpu != smp_processor_id());
Tejun Heoe22bee72010-06-29 10:07:14 +02003341 rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS));
3342 BUG_ON(rc < 0);
3343
3344 gcwq->flags |= GCWQ_MANAGING_WORKERS;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003345
3346 list_for_each_entry(worker, &gcwq->idle_list, entry)
Tejun Heocb444762010-07-02 10:03:50 +02003347 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003348
3349 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heocb444762010-07-02 10:03:50 +02003350 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003351
3352 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02003353 * Call schedule() so that we cross rq->lock and thus can
3354 * guarantee sched callbacks see the rogue flag. This is
3355 * necessary as scheduler callbacks may be invoked from other
3356 * cpus.
3357 */
3358 spin_unlock_irq(&gcwq->lock);
3359 schedule();
3360 spin_lock_irq(&gcwq->lock);
3361
3362 /*
Tejun Heocb444762010-07-02 10:03:50 +02003363 * Sched callbacks are disabled now. Zap nr_running. After
3364 * this, nr_running stays zero and need_more_worker() and
3365 * keep_working() are always true as long as the worklist is
3366 * not empty.
Tejun Heoe22bee72010-06-29 10:07:14 +02003367 */
Tejun Heocb444762010-07-02 10:03:50 +02003368 atomic_set(get_gcwq_nr_running(gcwq->cpu), 0);
Tejun Heoe22bee72010-06-29 10:07:14 +02003369
3370 spin_unlock_irq(&gcwq->lock);
3371 del_timer_sync(&gcwq->idle_timer);
3372 spin_lock_irq(&gcwq->lock);
3373
3374 /*
Tejun Heodb7bccf2010-06-29 10:07:12 +02003375 * We're now in charge. Notify and proceed to drain. We need
3376 * to keep the gcwq running during the whole CPU down
3377 * procedure as other cpu hotunplug callbacks may need to
3378 * flush currently running tasks.
3379 */
3380 gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3381 wake_up_all(&gcwq->trustee_wait);
3382
3383 /*
3384 * The original cpu is in the process of dying and may go away
3385 * anytime now. When that happens, we and all workers would
Tejun Heoe22bee72010-06-29 10:07:14 +02003386 * be migrated to other cpus. Try draining any left work. We
3387 * want to get it over with ASAP - spam rescuers, wake up as
3388 * many idlers as necessary and create new ones till the
3389 * worklist is empty. Note that if the gcwq is frozen, there
Tejun Heo58a69cb2011-02-16 09:25:31 +01003390 * may be frozen works in freezable cwqs. Don't declare
Tejun Heoe22bee72010-06-29 10:07:14 +02003391 * completion while frozen.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003392 */
3393 while (gcwq->nr_workers != gcwq->nr_idle ||
3394 gcwq->flags & GCWQ_FREEZING ||
3395 gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003396 int nr_works = 0;
3397
3398 list_for_each_entry(work, &gcwq->worklist, entry) {
3399 send_mayday(work);
3400 nr_works++;
3401 }
3402
3403 list_for_each_entry(worker, &gcwq->idle_list, entry) {
3404 if (!nr_works--)
3405 break;
3406 wake_up_process(worker->task);
3407 }
3408
3409 if (need_to_create_worker(gcwq)) {
3410 spin_unlock_irq(&gcwq->lock);
3411 worker = create_worker(gcwq, false);
3412 spin_lock_irq(&gcwq->lock);
3413 if (worker) {
Tejun Heocb444762010-07-02 10:03:50 +02003414 worker->flags |= WORKER_ROGUE;
Tejun Heoe22bee72010-06-29 10:07:14 +02003415 start_worker(worker);
3416 }
3417 }
3418
Tejun Heodb7bccf2010-06-29 10:07:12 +02003419 /* give a breather */
3420 if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3421 break;
3422 }
3423
Tejun Heoe22bee72010-06-29 10:07:14 +02003424 /*
3425 * Either all works have been scheduled and cpu is down, or
3426 * cpu down has already been canceled. Wait for and butcher
3427 * all workers till we're canceled.
3428 */
3429 do {
3430 rc = trustee_wait_event(!list_empty(&gcwq->idle_list));
3431 while (!list_empty(&gcwq->idle_list))
3432 destroy_worker(list_first_entry(&gcwq->idle_list,
3433 struct worker, entry));
3434 } while (gcwq->nr_workers && rc >= 0);
3435
3436 /*
3437 * At this point, either draining has completed and no worker
3438 * is left, or cpu down has been canceled or the cpu is being
3439 * brought back up. There shouldn't be any idle one left.
3440 * Tell the remaining busy ones to rebind once it finishes the
3441 * currently scheduled works by scheduling the rebind_work.
3442 */
3443 WARN_ON(!list_empty(&gcwq->idle_list));
3444
3445 for_each_busy_worker(worker, i, pos, gcwq) {
3446 struct work_struct *rebind_work = &worker->rebind_work;
3447
3448 /*
3449 * Rebind_work may race with future cpu hotplug
3450 * operations. Use a separate flag to mark that
3451 * rebinding is scheduled.
3452 */
Tejun Heocb444762010-07-02 10:03:50 +02003453 worker->flags |= WORKER_REBIND;
3454 worker->flags &= ~WORKER_ROGUE;
Tejun Heoe22bee72010-06-29 10:07:14 +02003455
3456 /* queue rebind_work, wq doesn't matter, use the default one */
3457 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3458 work_data_bits(rebind_work)))
3459 continue;
3460
3461 debug_work_activate(rebind_work);
Tejun Heod320c032010-06-29 10:07:14 +02003462 insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
Tejun Heoe22bee72010-06-29 10:07:14 +02003463 worker->scheduled.next,
3464 work_color_to_flags(WORK_NO_COLOR));
3465 }
3466
3467 /* relinquish manager role */
3468 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
3469
Tejun Heodb7bccf2010-06-29 10:07:12 +02003470 /* notify completion */
3471 gcwq->trustee = NULL;
3472 gcwq->trustee_state = TRUSTEE_DONE;
3473 wake_up_all(&gcwq->trustee_wait);
3474 spin_unlock_irq(&gcwq->lock);
3475 return 0;
3476}
3477
3478/**
3479 * wait_trustee_state - wait for trustee to enter the specified state
3480 * @gcwq: gcwq the trustee of interest belongs to
3481 * @state: target state to wait for
3482 *
3483 * Wait for the trustee to reach @state. DONE is already matched.
3484 *
3485 * CONTEXT:
3486 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3487 * multiple times. To be used by cpu_callback.
3488 */
3489static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09003490__releases(&gcwq->lock)
3491__acquires(&gcwq->lock)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003492{
3493 if (!(gcwq->trustee_state == state ||
3494 gcwq->trustee_state == TRUSTEE_DONE)) {
3495 spin_unlock_irq(&gcwq->lock);
3496 __wait_event(gcwq->trustee_wait,
3497 gcwq->trustee_state == state ||
3498 gcwq->trustee_state == TRUSTEE_DONE);
3499 spin_lock_irq(&gcwq->lock);
3500 }
3501}
3502
Oleg Nesterov3af244332007-05-09 02:34:09 -07003503static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
3504 unsigned long action,
3505 void *hcpu)
3506{
3507 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003508 struct global_cwq *gcwq = get_gcwq(cpu);
3509 struct task_struct *new_trustee = NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +02003510 struct worker *uninitialized_var(new_worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003511 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003512
Rafael J. Wysocki8bb78442007-05-09 02:35:10 -07003513 action &= ~CPU_TASKS_FROZEN;
3514
Linus Torvalds1da177e2005-04-16 15:20:36 -07003515 switch (action) {
Tejun Heodb7bccf2010-06-29 10:07:12 +02003516 case CPU_DOWN_PREPARE:
3517 new_trustee = kthread_create(trustee_thread, gcwq,
3518 "workqueue_trustee/%d\n", cpu);
3519 if (IS_ERR(new_trustee))
3520 return notifier_from_errno(PTR_ERR(new_trustee));
3521 kthread_bind(new_trustee, cpu);
Tejun Heoe22bee72010-06-29 10:07:14 +02003522 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003523 case CPU_UP_PREPARE:
Tejun Heoe22bee72010-06-29 10:07:14 +02003524 BUG_ON(gcwq->first_idle);
3525 new_worker = create_worker(gcwq, false);
3526 if (!new_worker) {
3527 if (new_trustee)
3528 kthread_stop(new_trustee);
3529 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003530 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003531 }
3532
Tejun Heodb7bccf2010-06-29 10:07:12 +02003533 /* some are called w/ irq disabled, don't disturb irq status */
3534 spin_lock_irqsave(&gcwq->lock, flags);
3535
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003536 switch (action) {
Tejun Heodb7bccf2010-06-29 10:07:12 +02003537 case CPU_DOWN_PREPARE:
3538 /* initialize trustee and tell it to acquire the gcwq */
3539 BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3540 gcwq->trustee = new_trustee;
3541 gcwq->trustee_state = TRUSTEE_START;
3542 wake_up_process(gcwq->trustee);
3543 wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003544 /* fall through */
3545 case CPU_UP_PREPARE:
3546 BUG_ON(gcwq->first_idle);
3547 gcwq->first_idle = new_worker;
3548 break;
3549
3550 case CPU_DYING:
3551 /*
3552 * Before this, the trustee and all workers except for
3553 * the ones which are still executing works from
3554 * before the last CPU down must be on the cpu. After
3555 * this, they'll all be diasporas.
3556 */
3557 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003558 break;
3559
Oleg Nesterov3da1c842008-07-25 01:47:50 -07003560 case CPU_POST_DEAD:
Tejun Heodb7bccf2010-06-29 10:07:12 +02003561 gcwq->trustee_state = TRUSTEE_BUTCHER;
Tejun Heoe22bee72010-06-29 10:07:14 +02003562 /* fall through */
3563 case CPU_UP_CANCELED:
3564 destroy_worker(gcwq->first_idle);
3565 gcwq->first_idle = NULL;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003566 break;
3567
3568 case CPU_DOWN_FAILED:
3569 case CPU_ONLINE:
Tejun Heoe22bee72010-06-29 10:07:14 +02003570 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003571 if (gcwq->trustee_state != TRUSTEE_DONE) {
3572 gcwq->trustee_state = TRUSTEE_RELEASE;
3573 wake_up_process(gcwq->trustee);
3574 wait_trustee_state(gcwq, TRUSTEE_DONE);
3575 }
3576
Tejun Heoe22bee72010-06-29 10:07:14 +02003577 /*
3578 * Trustee is done and there might be no worker left.
3579 * Put the first_idle in and request a real manager to
3580 * take a look.
3581 */
3582 spin_unlock_irq(&gcwq->lock);
3583 kthread_bind(gcwq->first_idle->task, cpu);
3584 spin_lock_irq(&gcwq->lock);
3585 gcwq->flags |= GCWQ_MANAGE_WORKERS;
3586 start_worker(gcwq->first_idle);
3587 gcwq->first_idle = NULL;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003588 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003589 }
3590
Tejun Heodb7bccf2010-06-29 10:07:12 +02003591 spin_unlock_irqrestore(&gcwq->lock, flags);
3592
Tejun Heo15376632010-06-29 10:07:11 +02003593 return notifier_from_errno(0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003594}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003595
Rusty Russell2d3854a2008-11-05 13:39:10 +11003596#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003597
Rusty Russell2d3854a2008-11-05 13:39:10 +11003598struct work_for_cpu {
Andrew Morton6b44003e2009-04-09 09:50:37 -06003599 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003600 long (*fn)(void *);
3601 void *arg;
3602 long ret;
3603};
3604
Andrew Morton6b44003e2009-04-09 09:50:37 -06003605static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003606{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003607 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003608 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b44003e2009-04-09 09:50:37 -06003609 complete(&wfc->completion);
3610 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003611}
3612
3613/**
3614 * work_on_cpu - run a function in user context on a particular cpu
3615 * @cpu: the cpu to run on
3616 * @fn: the function to run
3617 * @arg: the function arg
3618 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003619 * This will return the value @fn returns.
3620 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06003621 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003622 */
3623long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3624{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003625 struct task_struct *sub_thread;
3626 struct work_for_cpu wfc = {
3627 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3628 .fn = fn,
3629 .arg = arg,
3630 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003631
Andrew Morton6b44003e2009-04-09 09:50:37 -06003632 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3633 if (IS_ERR(sub_thread))
3634 return PTR_ERR(sub_thread);
3635 kthread_bind(sub_thread, cpu);
3636 wake_up_process(sub_thread);
3637 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003638 return wfc.ret;
3639}
3640EXPORT_SYMBOL_GPL(work_on_cpu);
3641#endif /* CONFIG_SMP */
3642
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003643#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303644
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003645/**
3646 * freeze_workqueues_begin - begin freezing workqueues
3647 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003648 * Start freezing workqueues. After this function returns, all freezable
3649 * workqueues will queue new works to their frozen_works list instead of
3650 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003651 *
3652 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003653 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003654 */
3655void freeze_workqueues_begin(void)
3656{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003657 unsigned int cpu;
3658
3659 spin_lock(&workqueue_lock);
3660
3661 BUG_ON(workqueue_freezing);
3662 workqueue_freezing = true;
3663
Tejun Heof3421792010-07-02 10:03:51 +02003664 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003665 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003666 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003667
3668 spin_lock_irq(&gcwq->lock);
3669
Tejun Heodb7bccf2010-06-29 10:07:12 +02003670 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3671 gcwq->flags |= GCWQ_FREEZING;
3672
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003673 list_for_each_entry(wq, &workqueues, list) {
3674 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3675
Tejun Heo58a69cb2011-02-16 09:25:31 +01003676 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003677 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003678 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003679
3680 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003681 }
3682
3683 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003684}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003685
3686/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003687 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003688 *
3689 * Check whether freezing is complete. This function must be called
3690 * between freeze_workqueues_begin() and thaw_workqueues().
3691 *
3692 * CONTEXT:
3693 * Grabs and releases workqueue_lock.
3694 *
3695 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003696 * %true if some freezable workqueues are still busy. %false if freezing
3697 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003698 */
3699bool freeze_workqueues_busy(void)
3700{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003701 unsigned int cpu;
3702 bool busy = false;
3703
3704 spin_lock(&workqueue_lock);
3705
3706 BUG_ON(!workqueue_freezing);
3707
Tejun Heof3421792010-07-02 10:03:51 +02003708 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003709 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003710 /*
3711 * nr_active is monotonically decreasing. It's safe
3712 * to peek without lock.
3713 */
3714 list_for_each_entry(wq, &workqueues, list) {
3715 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3716
Tejun Heo58a69cb2011-02-16 09:25:31 +01003717 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003718 continue;
3719
3720 BUG_ON(cwq->nr_active < 0);
3721 if (cwq->nr_active) {
3722 busy = true;
3723 goto out_unlock;
3724 }
3725 }
3726 }
3727out_unlock:
3728 spin_unlock(&workqueue_lock);
3729 return busy;
3730}
3731
3732/**
3733 * thaw_workqueues - thaw workqueues
3734 *
3735 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003736 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003737 *
3738 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003739 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003740 */
3741void thaw_workqueues(void)
3742{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003743 unsigned int cpu;
3744
3745 spin_lock(&workqueue_lock);
3746
3747 if (!workqueue_freezing)
3748 goto out_unlock;
3749
Tejun Heof3421792010-07-02 10:03:51 +02003750 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003751 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003752 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003753
3754 spin_lock_irq(&gcwq->lock);
3755
Tejun Heodb7bccf2010-06-29 10:07:12 +02003756 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3757 gcwq->flags &= ~GCWQ_FREEZING;
3758
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003759 list_for_each_entry(wq, &workqueues, list) {
3760 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3761
Tejun Heo58a69cb2011-02-16 09:25:31 +01003762 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003763 continue;
3764
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003765 /* restore max_active and repopulate worklist */
3766 cwq->max_active = wq->saved_max_active;
3767
3768 while (!list_empty(&cwq->delayed_works) &&
3769 cwq->nr_active < cwq->max_active)
3770 cwq_activate_first_delayed(cwq);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003771 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003772
Tejun Heoe22bee72010-06-29 10:07:14 +02003773 wake_up_worker(gcwq);
3774
Tejun Heo8b03ae32010-06-29 10:07:12 +02003775 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003776 }
3777
3778 workqueue_freezing = false;
3779out_unlock:
3780 spin_unlock(&workqueue_lock);
3781}
3782#endif /* CONFIG_FREEZER */
3783
Suresh Siddha6ee05782010-07-30 14:57:37 -07003784static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003785{
Tejun Heoc34056a2010-06-29 10:07:11 +02003786 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003787 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02003788
Tejun Heof6500942010-08-09 11:50:34 +02003789 cpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003790
3791 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003792 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003793 struct global_cwq *gcwq = get_gcwq(cpu);
3794
3795 spin_lock_init(&gcwq->lock);
Tejun Heo7e116292010-06-29 10:07:13 +02003796 INIT_LIST_HEAD(&gcwq->worklist);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003797 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003798 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003799
Tejun Heoc8e55f32010-06-29 10:07:12 +02003800 INIT_LIST_HEAD(&gcwq->idle_list);
3801 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3802 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3803
Tejun Heoe22bee72010-06-29 10:07:14 +02003804 init_timer_deferrable(&gcwq->idle_timer);
3805 gcwq->idle_timer.function = idle_worker_timeout;
3806 gcwq->idle_timer.data = (unsigned long)gcwq;
3807
3808 setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout,
3809 (unsigned long)gcwq);
3810
Tejun Heo8b03ae32010-06-29 10:07:12 +02003811 ida_init(&gcwq->worker_ida);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003812
3813 gcwq->trustee_state = TRUSTEE_DONE;
3814 init_waitqueue_head(&gcwq->trustee_wait);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003815 }
3816
Tejun Heoe22bee72010-06-29 10:07:14 +02003817 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003818 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003819 struct global_cwq *gcwq = get_gcwq(cpu);
3820 struct worker *worker;
3821
Tejun Heo477a3c32010-08-31 10:54:35 +02003822 if (cpu != WORK_CPU_UNBOUND)
3823 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heoe22bee72010-06-29 10:07:14 +02003824 worker = create_worker(gcwq, true);
3825 BUG_ON(!worker);
3826 spin_lock_irq(&gcwq->lock);
3827 start_worker(worker);
3828 spin_unlock_irq(&gcwq->lock);
3829 }
3830
Tejun Heod320c032010-06-29 10:07:14 +02003831 system_wq = alloc_workqueue("events", 0, 0);
3832 system_long_wq = alloc_workqueue("events_long", 0, 0);
3833 system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003834 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3835 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003836 system_freezable_wq = alloc_workqueue("events_freezable",
3837 WQ_FREEZABLE, 0);
Alan Stern62d3c542012-03-02 10:51:00 +01003838 system_nrt_freezable_wq = alloc_workqueue("events_nrt_freezable",
3839 WQ_NON_REENTRANT | WQ_FREEZABLE, 0);
Hitoshi Mitakee5cba242010-11-26 12:06:44 +01003840 BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq ||
Alan Stern62d3c542012-03-02 10:51:00 +01003841 !system_unbound_wq || !system_freezable_wq ||
3842 !system_nrt_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003843 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003844}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003845early_initcall(init_workqueues);