blob: e5cb7faac58ea83d29b25c35e35e8f260296c105 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/kernel/workqueue.c
3 *
4 * Generic mechanism for defining kernel helper threads for running
5 * arbitrary tasks in process context.
6 *
7 * Started by Ingo Molnar, Copyright (C) 2002
8 *
9 * Derived from the taskqueue/keventd code by:
10 *
11 * David Woodhouse <dwmw2@infradead.org>
Francois Camie1f8e872008-10-15 22:01:59 -070012 * Andrew Morton
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
14 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080015 *
Christoph Lametercde53532008-07-04 09:59:22 -070016 * Made to use alloc_percpu by Christoph Lameter.
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
18
19#include <linux/module.h>
20#include <linux/kernel.h>
21#include <linux/sched.h>
22#include <linux/init.h>
23#include <linux/signal.h>
24#include <linux/completion.h>
25#include <linux/workqueue.h>
26#include <linux/slab.h>
27#include <linux/cpu.h>
28#include <linux/notifier.h>
29#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060030#include <linux/hardirq.h>
Christoph Lameter469340232006-10-11 01:21:26 -070031#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080032#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080033#include <linux/kallsyms.h>
34#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070035#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020036#include <linux/idr.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020037
38#include "workqueue_sched.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Tejun Heoc8e55f32010-06-29 10:07:12 +020040enum {
Tejun Heodb7bccf2010-06-29 10:07:12 +020041 /* global_cwq flags */
Tejun Heoe22bee72010-06-29 10:07:14 +020042 GCWQ_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
43 GCWQ_MANAGING_WORKERS = 1 << 1, /* managing workers */
44 GCWQ_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020045 GCWQ_FREEZING = 1 << 3, /* freeze in progress */
Tejun Heo649027d2010-06-29 10:07:14 +020046 GCWQ_HIGHPRI_PENDING = 1 << 4, /* highpri works on queue */
Tejun Heodb7bccf2010-06-29 10:07:12 +020047
Tejun Heoc8e55f32010-06-29 10:07:12 +020048 /* worker flags */
49 WORKER_STARTED = 1 << 0, /* started */
50 WORKER_DIE = 1 << 1, /* die die die */
51 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020052 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heodb7bccf2010-06-29 10:07:12 +020053 WORKER_ROGUE = 1 << 4, /* not bound to any cpu */
Tejun Heoe22bee72010-06-29 10:07:14 +020054 WORKER_REBIND = 1 << 5, /* mom is home, come back */
Tejun Heofb0e7be2010-06-29 10:07:15 +020055 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020056 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoe22bee72010-06-29 10:07:14 +020057
Tejun Heofb0e7be2010-06-29 10:07:15 +020058 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_ROGUE | WORKER_REBIND |
Tejun Heof3421792010-07-02 10:03:51 +020059 WORKER_CPU_INTENSIVE | WORKER_UNBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020060
61 /* gcwq->trustee_state */
62 TRUSTEE_START = 0, /* start */
63 TRUSTEE_IN_CHARGE = 1, /* trustee in charge of gcwq */
64 TRUSTEE_BUTCHER = 2, /* butcher workers */
65 TRUSTEE_RELEASE = 3, /* release workers */
66 TRUSTEE_DONE = 4, /* trustee is done */
Tejun Heoc8e55f32010-06-29 10:07:12 +020067
68 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
69 BUSY_WORKER_HASH_SIZE = 1 << BUSY_WORKER_HASH_ORDER,
70 BUSY_WORKER_HASH_MASK = BUSY_WORKER_HASH_SIZE - 1,
Tejun Heodb7bccf2010-06-29 10:07:12 +020071
Tejun Heoe22bee72010-06-29 10:07:14 +020072 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
73 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
74
75 MAYDAY_INITIAL_TIMEOUT = HZ / 100, /* call for help after 10ms */
76 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
77 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heodb7bccf2010-06-29 10:07:12 +020078 TRUSTEE_COOLDOWN = HZ / 10, /* for trustee draining */
Tejun Heoe22bee72010-06-29 10:07:14 +020079
80 /*
81 * Rescue workers are used only on emergencies and shared by
82 * all cpus. Give -20.
83 */
84 RESCUER_NICE_LEVEL = -20,
Tejun Heoc8e55f32010-06-29 10:07:12 +020085};
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087/*
Tejun Heo4690c4a2010-06-29 10:07:10 +020088 * Structure fields follow one of the following exclusion rules.
89 *
90 * I: Set during initialization and read-only afterwards.
91 *
Tejun Heoe22bee72010-06-29 10:07:14 +020092 * P: Preemption protected. Disabling preemption is enough and should
93 * only be modified and accessed from the local cpu.
94 *
Tejun Heo8b03ae32010-06-29 10:07:12 +020095 * L: gcwq->lock protected. Access with gcwq->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +020096 *
Tejun Heoe22bee72010-06-29 10:07:14 +020097 * X: During normal operation, modification requires gcwq->lock and
98 * should be done only from local cpu. Either disabling preemption
99 * on local cpu or grabbing gcwq->lock is enough for read access.
Tejun Heof3421792010-07-02 10:03:51 +0200100 * If GCWQ_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200101 *
Tejun Heo73f53c42010-06-29 10:07:11 +0200102 * F: wq->flush_mutex protected.
103 *
Tejun Heo4690c4a2010-06-29 10:07:10 +0200104 * W: workqueue_lock protected.
105 */
106
Tejun Heo8b03ae32010-06-29 10:07:12 +0200107struct global_cwq;
Tejun Heoc34056a2010-06-29 10:07:11 +0200108
Tejun Heoe22bee72010-06-29 10:07:14 +0200109/*
110 * The poor guys doing the actual heavy lifting. All on-duty workers
111 * are either serving the manager role, on idle list or on busy hash.
112 */
Tejun Heoc34056a2010-06-29 10:07:11 +0200113struct worker {
Tejun Heoc8e55f32010-06-29 10:07:12 +0200114 /* on idle list while idle, on busy hash table while busy */
115 union {
116 struct list_head entry; /* L: while idle */
117 struct hlist_node hentry; /* L: while busy */
118 };
119
Tejun Heoc34056a2010-06-29 10:07:11 +0200120 struct work_struct *current_work; /* L: work being processed */
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200121 struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
Tejun Heoaffee4b2010-06-29 10:07:12 +0200122 struct list_head scheduled; /* L: scheduled works */
Tejun Heoc34056a2010-06-29 10:07:11 +0200123 struct task_struct *task; /* I: worker task */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200124 struct global_cwq *gcwq; /* I: the associated gcwq */
Tejun Heoe22bee72010-06-29 10:07:14 +0200125 /* 64 bytes boundary on 64bit, 32 on 32bit */
126 unsigned long last_active; /* L: last active timestamp */
127 unsigned int flags; /* X: flags */
Tejun Heoc34056a2010-06-29 10:07:11 +0200128 int id; /* I: worker id */
Tejun Heoe22bee72010-06-29 10:07:14 +0200129 struct work_struct rebind_work; /* L: rebind worker to cpu */
Tejun Heoc34056a2010-06-29 10:07:11 +0200130};
131
Tejun Heo4690c4a2010-06-29 10:07:10 +0200132/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200133 * Global per-cpu workqueue. There's one and only one for each cpu
134 * and all works are queued and processed here regardless of their
135 * target workqueues.
Tejun Heo8b03ae32010-06-29 10:07:12 +0200136 */
137struct global_cwq {
138 spinlock_t lock; /* the gcwq lock */
Tejun Heo7e116292010-06-29 10:07:13 +0200139 struct list_head worklist; /* L: list of pending works */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200140 unsigned int cpu; /* I: the associated cpu */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200141 unsigned int flags; /* L: GCWQ_* flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200142
143 int nr_workers; /* L: total number of workers */
144 int nr_idle; /* L: currently idle ones */
145
146 /* workers are chained either in the idle_list or busy_hash */
Tejun Heoe22bee72010-06-29 10:07:14 +0200147 struct list_head idle_list; /* X: list of idle workers */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200148 struct hlist_head busy_hash[BUSY_WORKER_HASH_SIZE];
149 /* L: hash of busy workers */
150
Tejun Heoe22bee72010-06-29 10:07:14 +0200151 struct timer_list idle_timer; /* L: worker idle timeout */
152 struct timer_list mayday_timer; /* L: SOS timer for dworkers */
153
Tejun Heo8b03ae32010-06-29 10:07:12 +0200154 struct ida worker_ida; /* L: for worker IDs */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200155
156 struct task_struct *trustee; /* L: for gcwq shutdown */
157 unsigned int trustee_state; /* L: trustee state */
158 wait_queue_head_t trustee_wait; /* trustee wait */
Tejun Heoe22bee72010-06-29 10:07:14 +0200159 struct worker *first_idle; /* L: first idle worker */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200160} ____cacheline_aligned_in_smp;
161
162/*
Tejun Heo502ca9d2010-06-29 10:07:13 +0200163 * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of
Tejun Heo0f900042010-06-29 10:07:11 +0200164 * work_struct->data are used for flags and thus cwqs need to be
165 * aligned at two's power of the number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 */
167struct cpu_workqueue_struct {
Tejun Heo8b03ae32010-06-29 10:07:12 +0200168 struct global_cwq *gcwq; /* I: the associated gcwq */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200169 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200170 int work_color; /* L: current color */
171 int flush_color; /* L: flushing color */
172 int nr_in_flight[WORK_NR_COLORS];
173 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200174 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200175 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200176 struct list_head delayed_works; /* L: delayed works */
Tejun Heo0f900042010-06-29 10:07:11 +0200177};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200180 * Structure used to wait for workqueue flush.
181 */
182struct wq_flusher {
183 struct list_head list; /* F: list of flushers */
184 int flush_color; /* F: flush color waiting for */
185 struct completion done; /* flush completion */
186};
187
188/*
Tejun Heof2e005a2010-07-20 15:59:09 +0200189 * All cpumasks are assumed to be always set on UP and thus can't be
190 * used to determine whether there's something to be done.
191 */
192#ifdef CONFIG_SMP
193typedef cpumask_var_t mayday_mask_t;
194#define mayday_test_and_set_cpu(cpu, mask) \
195 cpumask_test_and_set_cpu((cpu), (mask))
196#define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask))
197#define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask))
198#define alloc_mayday_mask(maskp, gfp) alloc_cpumask_var((maskp), (gfp))
199#define free_mayday_mask(mask) free_cpumask_var((mask))
200#else
201typedef unsigned long mayday_mask_t;
202#define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask))
203#define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask))
204#define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask))
205#define alloc_mayday_mask(maskp, gfp) true
206#define free_mayday_mask(mask) do { } while (0)
207#endif
208
209/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 * The externally visible workqueue abstraction is an array of
211 * per-CPU workqueues:
212 */
213struct workqueue_struct {
Tejun Heo97e37d72010-06-29 10:07:10 +0200214 unsigned int flags; /* I: WQ_* flags */
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200215 union {
216 struct cpu_workqueue_struct __percpu *pcpu;
217 struct cpu_workqueue_struct *single;
218 unsigned long v;
219 } cpu_wq; /* I: cwq's */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200220 struct list_head list; /* W: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200221
222 struct mutex flush_mutex; /* protects wq flushing */
223 int work_color; /* F: current work color */
224 int flush_color; /* F: current flush color */
225 atomic_t nr_cwqs_to_flush; /* flush in progress */
226 struct wq_flusher *first_flusher; /* F: first flusher */
227 struct list_head flusher_queue; /* F: flush waiters */
228 struct list_head flusher_overflow; /* F: flush overflow list */
229
Tejun Heof2e005a2010-07-20 15:59:09 +0200230 mayday_mask_t mayday_mask; /* cpus requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200231 struct worker *rescuer; /* I: rescue worker */
232
Tejun Heodcd989c2010-06-29 10:07:14 +0200233 int saved_max_active; /* W: saved cwq max_active */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200234 const char *name; /* I: workqueue name */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700235#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200236 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700237#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238};
239
Tejun Heod320c032010-06-29 10:07:14 +0200240struct workqueue_struct *system_wq __read_mostly;
241struct workqueue_struct *system_long_wq __read_mostly;
242struct workqueue_struct *system_nrt_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200243struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200244EXPORT_SYMBOL_GPL(system_wq);
245EXPORT_SYMBOL_GPL(system_long_wq);
246EXPORT_SYMBOL_GPL(system_nrt_wq);
Tejun Heof3421792010-07-02 10:03:51 +0200247EXPORT_SYMBOL_GPL(system_unbound_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200248
Tejun Heodb7bccf2010-06-29 10:07:12 +0200249#define for_each_busy_worker(worker, i, pos, gcwq) \
250 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \
251 hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
252
Tejun Heof3421792010-07-02 10:03:51 +0200253static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
254 unsigned int sw)
255{
256 if (cpu < nr_cpu_ids) {
257 if (sw & 1) {
258 cpu = cpumask_next(cpu, mask);
259 if (cpu < nr_cpu_ids)
260 return cpu;
261 }
262 if (sw & 2)
263 return WORK_CPU_UNBOUND;
264 }
265 return WORK_CPU_NONE;
266}
267
268static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
269 struct workqueue_struct *wq)
270{
271 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
272}
273
274#define for_each_gcwq_cpu(cpu) \
275 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
276 (cpu) < WORK_CPU_NONE; \
277 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
278
279#define for_each_online_gcwq_cpu(cpu) \
280 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
281 (cpu) < WORK_CPU_NONE; \
282 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
283
284#define for_each_cwq_cpu(cpu, wq) \
285 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
286 (cpu) < WORK_CPU_NONE; \
287 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
288
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900289#ifdef CONFIG_DEBUG_OBJECTS_WORK
290
291static struct debug_obj_descr work_debug_descr;
292
293/*
294 * fixup_init is called when:
295 * - an active object is initialized
296 */
297static int work_fixup_init(void *addr, enum debug_obj_state state)
298{
299 struct work_struct *work = addr;
300
301 switch (state) {
302 case ODEBUG_STATE_ACTIVE:
303 cancel_work_sync(work);
304 debug_object_init(work, &work_debug_descr);
305 return 1;
306 default:
307 return 0;
308 }
309}
310
311/*
312 * fixup_activate is called when:
313 * - an active object is activated
314 * - an unknown object is activated (might be a statically initialized object)
315 */
316static int work_fixup_activate(void *addr, enum debug_obj_state state)
317{
318 struct work_struct *work = addr;
319
320 switch (state) {
321
322 case ODEBUG_STATE_NOTAVAILABLE:
323 /*
324 * This is not really a fixup. The work struct was
325 * statically initialized. We just make sure that it
326 * is tracked in the object tracker.
327 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200328 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900329 debug_object_init(work, &work_debug_descr);
330 debug_object_activate(work, &work_debug_descr);
331 return 0;
332 }
333 WARN_ON_ONCE(1);
334 return 0;
335
336 case ODEBUG_STATE_ACTIVE:
337 WARN_ON(1);
338
339 default:
340 return 0;
341 }
342}
343
344/*
345 * fixup_free is called when:
346 * - an active object is freed
347 */
348static int work_fixup_free(void *addr, enum debug_obj_state state)
349{
350 struct work_struct *work = addr;
351
352 switch (state) {
353 case ODEBUG_STATE_ACTIVE:
354 cancel_work_sync(work);
355 debug_object_free(work, &work_debug_descr);
356 return 1;
357 default:
358 return 0;
359 }
360}
361
362static struct debug_obj_descr work_debug_descr = {
363 .name = "work_struct",
364 .fixup_init = work_fixup_init,
365 .fixup_activate = work_fixup_activate,
366 .fixup_free = work_fixup_free,
367};
368
369static inline void debug_work_activate(struct work_struct *work)
370{
371 debug_object_activate(work, &work_debug_descr);
372}
373
374static inline void debug_work_deactivate(struct work_struct *work)
375{
376 debug_object_deactivate(work, &work_debug_descr);
377}
378
379void __init_work(struct work_struct *work, int onstack)
380{
381 if (onstack)
382 debug_object_init_on_stack(work, &work_debug_descr);
383 else
384 debug_object_init(work, &work_debug_descr);
385}
386EXPORT_SYMBOL_GPL(__init_work);
387
388void destroy_work_on_stack(struct work_struct *work)
389{
390 debug_object_free(work, &work_debug_descr);
391}
392EXPORT_SYMBOL_GPL(destroy_work_on_stack);
393
394#else
395static inline void debug_work_activate(struct work_struct *work) { }
396static inline void debug_work_deactivate(struct work_struct *work) { }
397#endif
398
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100399/* Serializes the accesses to the list of workqueues. */
400static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200402static bool workqueue_freezing; /* W: have wqs started freezing? */
Tejun Heoc34056a2010-06-29 10:07:11 +0200403
Tejun Heoe22bee72010-06-29 10:07:14 +0200404/*
405 * The almighty global cpu workqueues. nr_running is the only field
406 * which is expected to be used frequently by other cpus via
407 * try_to_wake_up(). Put it in a separate cacheline.
408 */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200409static DEFINE_PER_CPU(struct global_cwq, global_cwq);
Tejun Heoe22bee72010-06-29 10:07:14 +0200410static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, gcwq_nr_running);
Tejun Heo8b03ae32010-06-29 10:07:12 +0200411
Tejun Heof3421792010-07-02 10:03:51 +0200412/*
413 * Global cpu workqueue and nr_running counter for unbound gcwq. The
414 * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
415 * workers have WORKER_UNBOUND set.
416 */
417static struct global_cwq unbound_global_cwq;
418static atomic_t unbound_gcwq_nr_running = ATOMIC_INIT(0); /* always 0 */
419
Tejun Heoc34056a2010-06-29 10:07:11 +0200420static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
Tejun Heo8b03ae32010-06-29 10:07:12 +0200422static struct global_cwq *get_gcwq(unsigned int cpu)
423{
Tejun Heof3421792010-07-02 10:03:51 +0200424 if (cpu != WORK_CPU_UNBOUND)
425 return &per_cpu(global_cwq, cpu);
426 else
427 return &unbound_global_cwq;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200428}
429
Tejun Heoe22bee72010-06-29 10:07:14 +0200430static atomic_t *get_gcwq_nr_running(unsigned int cpu)
431{
Tejun Heof3421792010-07-02 10:03:51 +0200432 if (cpu != WORK_CPU_UNBOUND)
433 return &per_cpu(gcwq_nr_running, cpu);
434 else
435 return &unbound_gcwq_nr_running;
Tejun Heoe22bee72010-06-29 10:07:14 +0200436}
437
Tejun Heo4690c4a2010-06-29 10:07:10 +0200438static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
439 struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700440{
Tejun Heof3421792010-07-02 10:03:51 +0200441 if (!(wq->flags & WQ_UNBOUND)) {
442 if (likely(cpu < nr_cpu_ids)) {
443#ifdef CONFIG_SMP
444 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200445#else
Tejun Heof3421792010-07-02 10:03:51 +0200446 return wq->cpu_wq.single;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200447#endif
Tejun Heof3421792010-07-02 10:03:51 +0200448 }
449 } else if (likely(cpu == WORK_CPU_UNBOUND))
450 return wq->cpu_wq.single;
451 return NULL;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700452}
453
Tejun Heo73f53c42010-06-29 10:07:11 +0200454static unsigned int work_color_to_flags(int color)
455{
456 return color << WORK_STRUCT_COLOR_SHIFT;
457}
458
459static int get_work_color(struct work_struct *work)
460{
461 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
462 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
463}
464
465static int work_next_color(int color)
466{
467 return (color + 1) % WORK_NR_COLORS;
468}
469
David Howells4594bf12006-12-07 11:33:26 +0000470/*
Tejun Heoe1201532010-07-22 14:14:25 +0200471 * A work's data points to the cwq with WORK_STRUCT_CWQ set while the
472 * work is on queue. Once execution starts, WORK_STRUCT_CWQ is
473 * cleared and the work data contains the cpu number it was last on.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200474 *
475 * set_work_{cwq|cpu}() and clear_work_data() can be used to set the
476 * cwq, cpu or clear work->data. These functions should only be
477 * called while the work is owned - ie. while the PENDING bit is set.
478 *
479 * get_work_[g]cwq() can be used to obtain the gcwq or cwq
480 * corresponding to a work. gcwq is available once the work has been
481 * queued anywhere after initialization. cwq is available only from
482 * queueing until execution starts.
David Howells4594bf12006-12-07 11:33:26 +0000483 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200484static inline void set_work_data(struct work_struct *work, unsigned long data,
485 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000486{
David Howells4594bf12006-12-07 11:33:26 +0000487 BUG_ON(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200488 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000489}
490
Tejun Heo7a22ad72010-06-29 10:07:13 +0200491static void set_work_cwq(struct work_struct *work,
492 struct cpu_workqueue_struct *cwq,
493 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200494{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200495 set_work_data(work, (unsigned long)cwq,
Tejun Heoe1201532010-07-22 14:14:25 +0200496 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200497}
498
Tejun Heo7a22ad72010-06-29 10:07:13 +0200499static void set_work_cpu(struct work_struct *work, unsigned int cpu)
David Howells365970a2006-11-22 14:54:49 +0000500{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200501 set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING);
502}
503
504static void clear_work_data(struct work_struct *work)
505{
506 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
507}
508
Tejun Heo7a22ad72010-06-29 10:07:13 +0200509static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
510{
Tejun Heoe1201532010-07-22 14:14:25 +0200511 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200512
Tejun Heoe1201532010-07-22 14:14:25 +0200513 if (data & WORK_STRUCT_CWQ)
514 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
515 else
516 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200517}
518
519static struct global_cwq *get_work_gcwq(struct work_struct *work)
520{
Tejun Heoe1201532010-07-22 14:14:25 +0200521 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200522 unsigned int cpu;
523
Tejun Heoe1201532010-07-22 14:14:25 +0200524 if (data & WORK_STRUCT_CWQ)
525 return ((struct cpu_workqueue_struct *)
526 (data & WORK_STRUCT_WQ_DATA_MASK))->gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200527
528 cpu = data >> WORK_STRUCT_FLAG_BITS;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200529 if (cpu == WORK_CPU_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200530 return NULL;
531
Tejun Heof3421792010-07-02 10:03:51 +0200532 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200533 return get_gcwq(cpu);
David Howells365970a2006-11-22 14:54:49 +0000534}
535
Tejun Heoe22bee72010-06-29 10:07:14 +0200536/*
537 * Policy functions. These define the policies on how the global
538 * worker pool is managed. Unless noted otherwise, these functions
539 * assume that they're being called with gcwq->lock held.
540 */
541
Tejun Heo649027d2010-06-29 10:07:14 +0200542static bool __need_more_worker(struct global_cwq *gcwq)
543{
544 return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) ||
545 gcwq->flags & GCWQ_HIGHPRI_PENDING;
546}
547
Tejun Heoe22bee72010-06-29 10:07:14 +0200548/*
549 * Need to wake up a worker? Called from anything but currently
550 * running workers.
551 */
552static bool need_more_worker(struct global_cwq *gcwq)
553{
Tejun Heo649027d2010-06-29 10:07:14 +0200554 return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +0200555}
556
557/* Can I start working? Called from busy but !running workers. */
558static bool may_start_working(struct global_cwq *gcwq)
559{
560 return gcwq->nr_idle;
561}
562
563/* Do I need to keep working? Called from currently running workers. */
564static bool keep_working(struct global_cwq *gcwq)
565{
566 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
567
568 return !list_empty(&gcwq->worklist) && atomic_read(nr_running) <= 1;
569}
570
571/* Do we need a new worker? Called from manager. */
572static bool need_to_create_worker(struct global_cwq *gcwq)
573{
574 return need_more_worker(gcwq) && !may_start_working(gcwq);
575}
576
577/* Do I need to be the manager? */
578static bool need_to_manage_workers(struct global_cwq *gcwq)
579{
580 return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS;
581}
582
583/* Do we have too many workers and should some go away? */
584static bool too_many_workers(struct global_cwq *gcwq)
585{
586 bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS;
587 int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */
588 int nr_busy = gcwq->nr_workers - nr_idle;
589
590 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
591}
592
593/*
594 * Wake up functions.
595 */
596
Tejun Heo7e116292010-06-29 10:07:13 +0200597/* Return the first worker. Safe with preemption disabled */
598static struct worker *first_worker(struct global_cwq *gcwq)
599{
600 if (unlikely(list_empty(&gcwq->idle_list)))
601 return NULL;
602
603 return list_first_entry(&gcwq->idle_list, struct worker, entry);
604}
605
606/**
607 * wake_up_worker - wake up an idle worker
608 * @gcwq: gcwq to wake worker for
609 *
610 * Wake up the first idle worker of @gcwq.
611 *
612 * CONTEXT:
613 * spin_lock_irq(gcwq->lock).
614 */
615static void wake_up_worker(struct global_cwq *gcwq)
616{
617 struct worker *worker = first_worker(gcwq);
618
619 if (likely(worker))
620 wake_up_process(worker->task);
621}
622
Tejun Heo4690c4a2010-06-29 10:07:10 +0200623/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200624 * wq_worker_waking_up - a worker is waking up
625 * @task: task waking up
626 * @cpu: CPU @task is waking up to
627 *
628 * This function is called during try_to_wake_up() when a worker is
629 * being awoken.
630 *
631 * CONTEXT:
632 * spin_lock_irq(rq->lock)
633 */
634void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
635{
636 struct worker *worker = kthread_data(task);
637
638 if (likely(!(worker->flags & WORKER_NOT_RUNNING)))
639 atomic_inc(get_gcwq_nr_running(cpu));
640}
641
642/**
643 * wq_worker_sleeping - a worker is going to sleep
644 * @task: task going to sleep
645 * @cpu: CPU in question, must be the current CPU number
646 *
647 * This function is called during schedule() when a busy worker is
648 * going to sleep. Worker on the same cpu can be woken up by
649 * returning pointer to its task.
650 *
651 * CONTEXT:
652 * spin_lock_irq(rq->lock)
653 *
654 * RETURNS:
655 * Worker task on @cpu to wake up, %NULL if none.
656 */
657struct task_struct *wq_worker_sleeping(struct task_struct *task,
658 unsigned int cpu)
659{
660 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
661 struct global_cwq *gcwq = get_gcwq(cpu);
662 atomic_t *nr_running = get_gcwq_nr_running(cpu);
663
664 if (unlikely(worker->flags & WORKER_NOT_RUNNING))
665 return NULL;
666
667 /* this can only happen on the local cpu */
668 BUG_ON(cpu != raw_smp_processor_id());
669
670 /*
671 * The counterpart of the following dec_and_test, implied mb,
672 * worklist not empty test sequence is in insert_work().
673 * Please read comment there.
674 *
675 * NOT_RUNNING is clear. This means that trustee is not in
676 * charge and we're running on the local cpu w/ rq lock held
677 * and preemption disabled, which in turn means that none else
678 * could be manipulating idle_list, so dereferencing idle_list
679 * without gcwq lock is safe.
680 */
681 if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist))
682 to_wakeup = first_worker(gcwq);
683 return to_wakeup ? to_wakeup->task : NULL;
684}
685
686/**
687 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200688 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200689 * @flags: flags to set
690 * @wakeup: wakeup an idle worker if necessary
691 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200692 * Set @flags in @worker->flags and adjust nr_running accordingly. If
693 * nr_running becomes zero and @wakeup is %true, an idle worker is
694 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200695 *
Tejun Heocb444762010-07-02 10:03:50 +0200696 * CONTEXT:
697 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200698 */
699static inline void worker_set_flags(struct worker *worker, unsigned int flags,
700 bool wakeup)
701{
Tejun Heoe22bee72010-06-29 10:07:14 +0200702 struct global_cwq *gcwq = worker->gcwq;
703
Tejun Heocb444762010-07-02 10:03:50 +0200704 WARN_ON_ONCE(worker->task != current);
705
Tejun Heoe22bee72010-06-29 10:07:14 +0200706 /*
707 * If transitioning into NOT_RUNNING, adjust nr_running and
708 * wake up an idle worker as necessary if requested by
709 * @wakeup.
710 */
711 if ((flags & WORKER_NOT_RUNNING) &&
712 !(worker->flags & WORKER_NOT_RUNNING)) {
713 atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu);
714
715 if (wakeup) {
716 if (atomic_dec_and_test(nr_running) &&
717 !list_empty(&gcwq->worklist))
718 wake_up_worker(gcwq);
719 } else
720 atomic_dec(nr_running);
721 }
722
Tejun Heod302f012010-06-29 10:07:13 +0200723 worker->flags |= flags;
724}
725
726/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200727 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200728 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200729 * @flags: flags to clear
730 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200731 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200732 *
Tejun Heocb444762010-07-02 10:03:50 +0200733 * CONTEXT:
734 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200735 */
736static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
737{
Tejun Heoe22bee72010-06-29 10:07:14 +0200738 struct global_cwq *gcwq = worker->gcwq;
739 unsigned int oflags = worker->flags;
740
Tejun Heocb444762010-07-02 10:03:50 +0200741 WARN_ON_ONCE(worker->task != current);
742
Tejun Heod302f012010-06-29 10:07:13 +0200743 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200744
745 /* if transitioning out of NOT_RUNNING, increment nr_running */
746 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
747 if (!(worker->flags & WORKER_NOT_RUNNING))
748 atomic_inc(get_gcwq_nr_running(gcwq->cpu));
Tejun Heod302f012010-06-29 10:07:13 +0200749}
750
751/**
Tejun Heoc8e55f32010-06-29 10:07:12 +0200752 * busy_worker_head - return the busy hash head for a work
753 * @gcwq: gcwq of interest
754 * @work: work to be hashed
755 *
756 * Return hash head of @gcwq for @work.
757 *
758 * CONTEXT:
759 * spin_lock_irq(gcwq->lock).
760 *
761 * RETURNS:
762 * Pointer to the hash head.
763 */
764static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
765 struct work_struct *work)
766{
767 const int base_shift = ilog2(sizeof(struct work_struct));
768 unsigned long v = (unsigned long)work;
769
770 /* simple shift and fold hash, do we need something better? */
771 v >>= base_shift;
772 v += v >> BUSY_WORKER_HASH_ORDER;
773 v &= BUSY_WORKER_HASH_MASK;
774
775 return &gcwq->busy_hash[v];
776}
777
778/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200779 * __find_worker_executing_work - find worker which is executing a work
780 * @gcwq: gcwq of interest
781 * @bwh: hash head as returned by busy_worker_head()
782 * @work: work to find worker for
783 *
784 * Find a worker which is executing @work on @gcwq. @bwh should be
785 * the hash head obtained by calling busy_worker_head() with the same
786 * work.
787 *
788 * CONTEXT:
789 * spin_lock_irq(gcwq->lock).
790 *
791 * RETURNS:
792 * Pointer to worker which is executing @work if found, NULL
793 * otherwise.
794 */
795static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
796 struct hlist_head *bwh,
797 struct work_struct *work)
798{
799 struct worker *worker;
800 struct hlist_node *tmp;
801
802 hlist_for_each_entry(worker, tmp, bwh, hentry)
803 if (worker->current_work == work)
804 return worker;
805 return NULL;
806}
807
808/**
809 * find_worker_executing_work - find worker which is executing a work
810 * @gcwq: gcwq of interest
811 * @work: work to find worker for
812 *
813 * Find a worker which is executing @work on @gcwq. This function is
814 * identical to __find_worker_executing_work() except that this
815 * function calculates @bwh itself.
816 *
817 * CONTEXT:
818 * spin_lock_irq(gcwq->lock).
819 *
820 * RETURNS:
821 * Pointer to worker which is executing @work if found, NULL
822 * otherwise.
823 */
824static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
825 struct work_struct *work)
826{
827 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
828 work);
829}
830
831/**
Tejun Heo649027d2010-06-29 10:07:14 +0200832 * gcwq_determine_ins_pos - find insertion position
833 * @gcwq: gcwq of interest
834 * @cwq: cwq a work is being queued for
835 *
836 * A work for @cwq is about to be queued on @gcwq, determine insertion
837 * position for the work. If @cwq is for HIGHPRI wq, the work is
838 * queued at the head of the queue but in FIFO order with respect to
839 * other HIGHPRI works; otherwise, at the end of the queue. This
840 * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that
841 * there are HIGHPRI works pending.
842 *
843 * CONTEXT:
844 * spin_lock_irq(gcwq->lock).
845 *
846 * RETURNS:
847 * Pointer to inserstion position.
848 */
849static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq,
850 struct cpu_workqueue_struct *cwq)
851{
852 struct work_struct *twork;
853
854 if (likely(!(cwq->wq->flags & WQ_HIGHPRI)))
855 return &gcwq->worklist;
856
857 list_for_each_entry(twork, &gcwq->worklist, entry) {
858 struct cpu_workqueue_struct *tcwq = get_work_cwq(twork);
859
860 if (!(tcwq->wq->flags & WQ_HIGHPRI))
861 break;
862 }
863
864 gcwq->flags |= GCWQ_HIGHPRI_PENDING;
865 return &twork->entry;
866}
867
868/**
Tejun Heo7e116292010-06-29 10:07:13 +0200869 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +0200870 * @cwq: cwq @work belongs to
871 * @work: work to insert
872 * @head: insertion point
873 * @extra_flags: extra WORK_STRUCT_* flags to set
874 *
Tejun Heo7e116292010-06-29 10:07:13 +0200875 * Insert @work which belongs to @cwq into @gcwq after @head.
876 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200877 *
878 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +0200879 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +0200880 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700881static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +0200882 struct work_struct *work, struct list_head *head,
883 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700884{
Tejun Heoe22bee72010-06-29 10:07:14 +0200885 struct global_cwq *gcwq = cwq->gcwq;
886
Tejun Heo4690c4a2010-06-29 10:07:10 +0200887 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200888 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +0200889
Oleg Nesterov6e84d642007-05-09 02:34:46 -0700890 /*
891 * Ensure that we get the right work->data if we see the
892 * result of list_add() below, see try_to_grab_pending().
893 */
894 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +0200895
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -0700896 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +0200897
898 /*
899 * Ensure either worker_sched_deactivated() sees the above
900 * list_add_tail() or we see zero nr_running to avoid workers
901 * lying around lazily while there are works to be processed.
902 */
903 smp_mb();
904
Tejun Heo649027d2010-06-29 10:07:14 +0200905 if (__need_more_worker(gcwq))
Tejun Heoe22bee72010-06-29 10:07:14 +0200906 wake_up_worker(gcwq);
Oleg Nesterovb89deed2007-05-09 02:33:52 -0700907}
908
Tejun Heo4690c4a2010-06-29 10:07:10 +0200909static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 struct work_struct *work)
911{
Tejun Heo502ca9d2010-06-29 10:07:13 +0200912 struct global_cwq *gcwq;
913 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200914 struct list_head *worklist;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 unsigned long flags;
916
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900917 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200918
Tejun Heoc7fc77f2010-07-02 10:03:51 +0200919 /* determine gcwq to use */
920 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +0200921 struct global_cwq *last_gcwq;
922
Tejun Heoc7fc77f2010-07-02 10:03:51 +0200923 if (unlikely(cpu == WORK_CPU_UNBOUND))
924 cpu = raw_smp_processor_id();
925
Tejun Heo18aa9ef2010-06-29 10:07:13 +0200926 /*
927 * It's multi cpu. If @wq is non-reentrant and @work
928 * was previously on a different cpu, it might still
929 * be running there, in which case the work needs to
930 * be queued on that cpu to guarantee non-reentrance.
931 */
Tejun Heo502ca9d2010-06-29 10:07:13 +0200932 gcwq = get_gcwq(cpu);
Tejun Heo18aa9ef2010-06-29 10:07:13 +0200933 if (wq->flags & WQ_NON_REENTRANT &&
934 (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) {
935 struct worker *worker;
936
937 spin_lock_irqsave(&last_gcwq->lock, flags);
938
939 worker = find_worker_executing_work(last_gcwq, work);
940
941 if (worker && worker->current_cwq->wq == wq)
942 gcwq = last_gcwq;
943 else {
944 /* meh... not running there, queue here */
945 spin_unlock_irqrestore(&last_gcwq->lock, flags);
946 spin_lock_irqsave(&gcwq->lock, flags);
947 }
948 } else
949 spin_lock_irqsave(&gcwq->lock, flags);
Tejun Heof3421792010-07-02 10:03:51 +0200950 } else {
951 gcwq = get_gcwq(WORK_CPU_UNBOUND);
952 spin_lock_irqsave(&gcwq->lock, flags);
Tejun Heo502ca9d2010-06-29 10:07:13 +0200953 }
954
955 /* gcwq determined, get cwq and queue */
956 cwq = get_cwq(gcwq->cpu, wq);
957
Tejun Heo4690c4a2010-06-29 10:07:10 +0200958 BUG_ON(!list_empty(&work->entry));
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200959
Tejun Heo73f53c42010-06-29 10:07:11 +0200960 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200961
962 if (likely(cwq->nr_active < cwq->max_active)) {
963 cwq->nr_active++;
Tejun Heo649027d2010-06-29 10:07:14 +0200964 worklist = gcwq_determine_ins_pos(gcwq, cwq);
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200965 } else
966 worklist = &cwq->delayed_works;
967
968 insert_work(cwq, work, worklist, work_color_to_flags(cwq->work_color));
969
Tejun Heo8b03ae32010-06-29 10:07:12 +0200970 spin_unlock_irqrestore(&gcwq->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971}
972
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -0700973/**
974 * queue_work - queue work on a workqueue
975 * @wq: workqueue to use
976 * @work: work to queue
977 *
Alan Stern057647f2006-10-28 10:38:58 -0700978 * Returns 0 if @work was already on a queue, non-zero otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 *
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -0700980 * We queue the work to the CPU on which it was submitted, but if the CPU dies
981 * it can be processed by another CPU.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -0800983int queue_work(struct workqueue_struct *wq, struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984{
Oleg Nesterovef1ca232008-07-25 01:47:53 -0700985 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
Oleg Nesterovef1ca232008-07-25 01:47:53 -0700987 ret = queue_work_on(get_cpu(), wq, work);
988 put_cpu();
989
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 return ret;
991}
Dave Jonesae90dd52006-06-30 01:40:45 -0400992EXPORT_SYMBOL_GPL(queue_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
Zhang Ruic1a220e2008-07-23 21:28:39 -0700994/**
995 * queue_work_on - queue work on specific cpu
996 * @cpu: CPU number to execute work on
997 * @wq: workqueue to use
998 * @work: work to queue
999 *
1000 * Returns 0 if @work was already on a queue, non-zero otherwise.
1001 *
1002 * We queue the work to a specific CPU, the caller must ensure it
1003 * can't go away.
1004 */
1005int
1006queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work)
1007{
1008 int ret = 0;
1009
Tejun Heo22df02b2010-06-29 10:07:10 +02001010 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001011 __queue_work(cpu, wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001012 ret = 1;
1013 }
1014 return ret;
1015}
1016EXPORT_SYMBOL_GPL(queue_work_on);
1017
Li Zefan6d141c32008-02-08 04:21:09 -08001018static void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019{
David Howells52bad642006-11-22 14:54:01 +00001020 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001021 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022
Tejun Heo4690c4a2010-06-29 10:07:10 +02001023 __queue_work(smp_processor_id(), cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024}
1025
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001026/**
1027 * queue_delayed_work - queue work on a workqueue after delay
1028 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001029 * @dwork: delayable work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001030 * @delay: number of jiffies to wait before queueing
1031 *
Alan Stern057647f2006-10-28 10:38:58 -07001032 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001033 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08001034int queue_delayed_work(struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +00001035 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036{
David Howells52bad642006-11-22 14:54:01 +00001037 if (delay == 0)
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001038 return queue_work(wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001040 return queue_delayed_work_on(-1, wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041}
Dave Jonesae90dd52006-06-30 01:40:45 -04001042EXPORT_SYMBOL_GPL(queue_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001044/**
1045 * queue_delayed_work_on - queue work on specific CPU after delay
1046 * @cpu: CPU number to execute work on
1047 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001048 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001049 * @delay: number of jiffies to wait before queueing
1050 *
Alan Stern057647f2006-10-28 10:38:58 -07001051 * Returns 0 if @work was already on a queue, non-zero otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001052 */
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001053int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
David Howells52bad642006-11-22 14:54:01 +00001054 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001055{
1056 int ret = 0;
David Howells52bad642006-11-22 14:54:01 +00001057 struct timer_list *timer = &dwork->timer;
1058 struct work_struct *work = &dwork->work;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001059
Tejun Heo22df02b2010-06-29 10:07:10 +02001060 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001061 unsigned int lcpu;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001062
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001063 BUG_ON(timer_pending(timer));
1064 BUG_ON(!list_empty(&work->entry));
1065
Andrew Liu8a3e77c2008-05-01 04:35:14 -07001066 timer_stats_timer_set_start_info(&dwork->timer);
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001067
Tejun Heo7a22ad72010-06-29 10:07:13 +02001068 /*
1069 * This stores cwq for the moment, for the timer_fn.
1070 * Note that the work's gcwq is preserved to allow
1071 * reentrance detection for delayed works.
1072 */
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001073 if (!(wq->flags & WQ_UNBOUND)) {
1074 struct global_cwq *gcwq = get_work_gcwq(work);
1075
1076 if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND)
1077 lcpu = gcwq->cpu;
1078 else
1079 lcpu = raw_smp_processor_id();
1080 } else
1081 lcpu = WORK_CPU_UNBOUND;
1082
Tejun Heo7a22ad72010-06-29 10:07:13 +02001083 set_work_cwq(work, get_cwq(lcpu, wq), 0);
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001084
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001085 timer->expires = jiffies + delay;
David Howells52bad642006-11-22 14:54:01 +00001086 timer->data = (unsigned long)dwork;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001087 timer->function = delayed_work_timer_fn;
Oleg Nesterov63bc0362007-05-09 02:34:16 -07001088
1089 if (unlikely(cpu >= 0))
1090 add_timer_on(timer, cpu);
1091 else
1092 add_timer(timer);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001093 ret = 1;
1094 }
1095 return ret;
1096}
Dave Jonesae90dd52006-06-30 01:40:45 -04001097EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098
Tejun Heoc8e55f32010-06-29 10:07:12 +02001099/**
1100 * worker_enter_idle - enter idle state
1101 * @worker: worker which is entering idle state
1102 *
1103 * @worker is entering idle state. Update stats and idle timer if
1104 * necessary.
1105 *
1106 * LOCKING:
1107 * spin_lock_irq(gcwq->lock).
1108 */
1109static void worker_enter_idle(struct worker *worker)
1110{
1111 struct global_cwq *gcwq = worker->gcwq;
1112
1113 BUG_ON(worker->flags & WORKER_IDLE);
1114 BUG_ON(!list_empty(&worker->entry) &&
1115 (worker->hentry.next || worker->hentry.pprev));
1116
Tejun Heocb444762010-07-02 10:03:50 +02001117 /* can't use worker_set_flags(), also called from start_worker() */
1118 worker->flags |= WORKER_IDLE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001119 gcwq->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001120 worker->last_active = jiffies;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001121
1122 /* idle_list is LIFO */
1123 list_add(&worker->entry, &gcwq->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001124
Tejun Heoe22bee72010-06-29 10:07:14 +02001125 if (likely(!(worker->flags & WORKER_ROGUE))) {
1126 if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer))
1127 mod_timer(&gcwq->idle_timer,
1128 jiffies + IDLE_WORKER_TIMEOUT);
1129 } else
Tejun Heodb7bccf2010-06-29 10:07:12 +02001130 wake_up_all(&gcwq->trustee_wait);
Tejun Heocb444762010-07-02 10:03:50 +02001131
1132 /* sanity check nr_running */
1133 WARN_ON_ONCE(gcwq->nr_workers == gcwq->nr_idle &&
1134 atomic_read(get_gcwq_nr_running(gcwq->cpu)));
Tejun Heoc8e55f32010-06-29 10:07:12 +02001135}
1136
1137/**
1138 * worker_leave_idle - leave idle state
1139 * @worker: worker which is leaving idle state
1140 *
1141 * @worker is leaving idle state. Update stats.
1142 *
1143 * LOCKING:
1144 * spin_lock_irq(gcwq->lock).
1145 */
1146static void worker_leave_idle(struct worker *worker)
1147{
1148 struct global_cwq *gcwq = worker->gcwq;
1149
1150 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001151 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001152 gcwq->nr_idle--;
1153 list_del_init(&worker->entry);
1154}
1155
Tejun Heoe22bee72010-06-29 10:07:14 +02001156/**
1157 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1158 * @worker: self
1159 *
1160 * Works which are scheduled while the cpu is online must at least be
1161 * scheduled to a worker which is bound to the cpu so that if they are
1162 * flushed from cpu callbacks while cpu is going down, they are
1163 * guaranteed to execute on the cpu.
1164 *
1165 * This function is to be used by rogue workers and rescuers to bind
1166 * themselves to the target cpu and may race with cpu going down or
1167 * coming online. kthread_bind() can't be used because it may put the
1168 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1169 * verbatim as it's best effort and blocking and gcwq may be
1170 * [dis]associated in the meantime.
1171 *
1172 * This function tries set_cpus_allowed() and locks gcwq and verifies
1173 * the binding against GCWQ_DISASSOCIATED which is set during
1174 * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters
1175 * idle state or fetches works without dropping lock, it can guarantee
1176 * the scheduling requirement described in the first paragraph.
1177 *
1178 * CONTEXT:
1179 * Might sleep. Called without any lock but returns with gcwq->lock
1180 * held.
1181 *
1182 * RETURNS:
1183 * %true if the associated gcwq is online (@worker is successfully
1184 * bound), %false if offline.
1185 */
1186static bool worker_maybe_bind_and_lock(struct worker *worker)
1187{
1188 struct global_cwq *gcwq = worker->gcwq;
1189 struct task_struct *task = worker->task;
1190
1191 while (true) {
1192 /*
1193 * The following call may fail, succeed or succeed
1194 * without actually migrating the task to the cpu if
1195 * it races with cpu hotunplug operation. Verify
1196 * against GCWQ_DISASSOCIATED.
1197 */
Tejun Heof3421792010-07-02 10:03:51 +02001198 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1199 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Tejun Heoe22bee72010-06-29 10:07:14 +02001200
1201 spin_lock_irq(&gcwq->lock);
1202 if (gcwq->flags & GCWQ_DISASSOCIATED)
1203 return false;
1204 if (task_cpu(task) == gcwq->cpu &&
1205 cpumask_equal(&current->cpus_allowed,
1206 get_cpu_mask(gcwq->cpu)))
1207 return true;
1208 spin_unlock_irq(&gcwq->lock);
1209
1210 /* CPU has come up inbetween, retry migration */
1211 cpu_relax();
1212 }
1213}
1214
1215/*
1216 * Function for worker->rebind_work used to rebind rogue busy workers
1217 * to the associated cpu which is coming back online. This is
1218 * scheduled by cpu up but can race with other cpu hotplug operations
1219 * and may be executed twice without intervening cpu down.
1220 */
1221static void worker_rebind_fn(struct work_struct *work)
1222{
1223 struct worker *worker = container_of(work, struct worker, rebind_work);
1224 struct global_cwq *gcwq = worker->gcwq;
1225
1226 if (worker_maybe_bind_and_lock(worker))
1227 worker_clr_flags(worker, WORKER_REBIND);
1228
1229 spin_unlock_irq(&gcwq->lock);
1230}
1231
Tejun Heoc34056a2010-06-29 10:07:11 +02001232static struct worker *alloc_worker(void)
1233{
1234 struct worker *worker;
1235
1236 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001237 if (worker) {
1238 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001239 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heoe22bee72010-06-29 10:07:14 +02001240 INIT_WORK(&worker->rebind_work, worker_rebind_fn);
1241 /* on creation a worker is in !idle && prep state */
1242 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001243 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001244 return worker;
1245}
1246
1247/**
1248 * create_worker - create a new workqueue worker
Tejun Heo7e116292010-06-29 10:07:13 +02001249 * @gcwq: gcwq the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001250 * @bind: whether to set affinity to @cpu or not
1251 *
Tejun Heo7e116292010-06-29 10:07:13 +02001252 * Create a new worker which is bound to @gcwq. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001253 * can be started by calling start_worker() or destroyed using
1254 * destroy_worker().
1255 *
1256 * CONTEXT:
1257 * Might sleep. Does GFP_KERNEL allocations.
1258 *
1259 * RETURNS:
1260 * Pointer to the newly created worker.
1261 */
Tejun Heo7e116292010-06-29 10:07:13 +02001262static struct worker *create_worker(struct global_cwq *gcwq, bool bind)
Tejun Heoc34056a2010-06-29 10:07:11 +02001263{
Tejun Heof3421792010-07-02 10:03:51 +02001264 bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND;
Tejun Heoc34056a2010-06-29 10:07:11 +02001265 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001266 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001267
Tejun Heo8b03ae32010-06-29 10:07:12 +02001268 spin_lock_irq(&gcwq->lock);
1269 while (ida_get_new(&gcwq->worker_ida, &id)) {
1270 spin_unlock_irq(&gcwq->lock);
1271 if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001272 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001273 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001274 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001275 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001276
1277 worker = alloc_worker();
1278 if (!worker)
1279 goto fail;
1280
Tejun Heo8b03ae32010-06-29 10:07:12 +02001281 worker->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001282 worker->id = id;
1283
Tejun Heof3421792010-07-02 10:03:51 +02001284 if (!on_unbound_cpu)
1285 worker->task = kthread_create(worker_thread, worker,
1286 "kworker/%u:%d", gcwq->cpu, id);
1287 else
1288 worker->task = kthread_create(worker_thread, worker,
1289 "kworker/u:%d", id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001290 if (IS_ERR(worker->task))
1291 goto fail;
1292
Tejun Heodb7bccf2010-06-29 10:07:12 +02001293 /*
1294 * A rogue worker will become a regular one if CPU comes
1295 * online later on. Make sure every worker has
1296 * PF_THREAD_BOUND set.
1297 */
Tejun Heof3421792010-07-02 10:03:51 +02001298 if (bind && !on_unbound_cpu)
Tejun Heo8b03ae32010-06-29 10:07:12 +02001299 kthread_bind(worker->task, gcwq->cpu);
Tejun Heof3421792010-07-02 10:03:51 +02001300 else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001301 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heof3421792010-07-02 10:03:51 +02001302 if (on_unbound_cpu)
1303 worker->flags |= WORKER_UNBOUND;
1304 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001305
1306 return worker;
1307fail:
1308 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001309 spin_lock_irq(&gcwq->lock);
1310 ida_remove(&gcwq->worker_ida, id);
1311 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001312 }
1313 kfree(worker);
1314 return NULL;
1315}
1316
1317/**
1318 * start_worker - start a newly created worker
1319 * @worker: worker to start
1320 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001321 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001322 *
1323 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001324 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001325 */
1326static void start_worker(struct worker *worker)
1327{
Tejun Heocb444762010-07-02 10:03:50 +02001328 worker->flags |= WORKER_STARTED;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001329 worker->gcwq->nr_workers++;
1330 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001331 wake_up_process(worker->task);
1332}
1333
1334/**
1335 * destroy_worker - destroy a workqueue worker
1336 * @worker: worker to be destroyed
1337 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001338 * Destroy @worker and adjust @gcwq stats accordingly.
1339 *
1340 * CONTEXT:
1341 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001342 */
1343static void destroy_worker(struct worker *worker)
1344{
Tejun Heo8b03ae32010-06-29 10:07:12 +02001345 struct global_cwq *gcwq = worker->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001346 int id = worker->id;
1347
1348 /* sanity check frenzy */
1349 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001350 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001351
Tejun Heoc8e55f32010-06-29 10:07:12 +02001352 if (worker->flags & WORKER_STARTED)
1353 gcwq->nr_workers--;
1354 if (worker->flags & WORKER_IDLE)
1355 gcwq->nr_idle--;
1356
1357 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001358 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001359
1360 spin_unlock_irq(&gcwq->lock);
1361
Tejun Heoc34056a2010-06-29 10:07:11 +02001362 kthread_stop(worker->task);
1363 kfree(worker);
1364
Tejun Heo8b03ae32010-06-29 10:07:12 +02001365 spin_lock_irq(&gcwq->lock);
1366 ida_remove(&gcwq->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001367}
1368
Tejun Heoe22bee72010-06-29 10:07:14 +02001369static void idle_worker_timeout(unsigned long __gcwq)
1370{
1371 struct global_cwq *gcwq = (void *)__gcwq;
1372
1373 spin_lock_irq(&gcwq->lock);
1374
1375 if (too_many_workers(gcwq)) {
1376 struct worker *worker;
1377 unsigned long expires;
1378
1379 /* idle_list is kept in LIFO order, check the last one */
1380 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1381 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1382
1383 if (time_before(jiffies, expires))
1384 mod_timer(&gcwq->idle_timer, expires);
1385 else {
1386 /* it's been idle for too long, wake up manager */
1387 gcwq->flags |= GCWQ_MANAGE_WORKERS;
1388 wake_up_worker(gcwq);
1389 }
1390 }
1391
1392 spin_unlock_irq(&gcwq->lock);
1393}
1394
1395static bool send_mayday(struct work_struct *work)
1396{
1397 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1398 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001399 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001400
1401 if (!(wq->flags & WQ_RESCUER))
1402 return false;
1403
1404 /* mayday mayday mayday */
Tejun Heof3421792010-07-02 10:03:51 +02001405 cpu = cwq->gcwq->cpu;
1406 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1407 if (cpu == WORK_CPU_UNBOUND)
1408 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001409 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001410 wake_up_process(wq->rescuer->task);
1411 return true;
1412}
1413
1414static void gcwq_mayday_timeout(unsigned long __gcwq)
1415{
1416 struct global_cwq *gcwq = (void *)__gcwq;
1417 struct work_struct *work;
1418
1419 spin_lock_irq(&gcwq->lock);
1420
1421 if (need_to_create_worker(gcwq)) {
1422 /*
1423 * We've been trying to create a new worker but
1424 * haven't been successful. We might be hitting an
1425 * allocation deadlock. Send distress signals to
1426 * rescuers.
1427 */
1428 list_for_each_entry(work, &gcwq->worklist, entry)
1429 send_mayday(work);
1430 }
1431
1432 spin_unlock_irq(&gcwq->lock);
1433
1434 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL);
1435}
1436
1437/**
1438 * maybe_create_worker - create a new worker if necessary
1439 * @gcwq: gcwq to create a new worker for
1440 *
1441 * Create a new worker for @gcwq if necessary. @gcwq is guaranteed to
1442 * have at least one idle worker on return from this function. If
1443 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
1444 * sent to all rescuers with works scheduled on @gcwq to resolve
1445 * possible allocation deadlock.
1446 *
1447 * On return, need_to_create_worker() is guaranteed to be false and
1448 * may_start_working() true.
1449 *
1450 * LOCKING:
1451 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1452 * multiple times. Does GFP_KERNEL allocations. Called only from
1453 * manager.
1454 *
1455 * RETURNS:
1456 * false if no action was taken and gcwq->lock stayed locked, true
1457 * otherwise.
1458 */
1459static bool maybe_create_worker(struct global_cwq *gcwq)
1460{
1461 if (!need_to_create_worker(gcwq))
1462 return false;
1463restart:
Tejun Heo9f9c236442010-07-14 11:31:20 +02001464 spin_unlock_irq(&gcwq->lock);
1465
Tejun Heoe22bee72010-06-29 10:07:14 +02001466 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
1467 mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
1468
1469 while (true) {
1470 struct worker *worker;
1471
Tejun Heoe22bee72010-06-29 10:07:14 +02001472 worker = create_worker(gcwq, true);
1473 if (worker) {
1474 del_timer_sync(&gcwq->mayday_timer);
1475 spin_lock_irq(&gcwq->lock);
1476 start_worker(worker);
1477 BUG_ON(need_to_create_worker(gcwq));
1478 return true;
1479 }
1480
1481 if (!need_to_create_worker(gcwq))
1482 break;
1483
Tejun Heoe22bee72010-06-29 10:07:14 +02001484 __set_current_state(TASK_INTERRUPTIBLE);
1485 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001486
Tejun Heoe22bee72010-06-29 10:07:14 +02001487 if (!need_to_create_worker(gcwq))
1488 break;
1489 }
1490
Tejun Heoe22bee72010-06-29 10:07:14 +02001491 del_timer_sync(&gcwq->mayday_timer);
1492 spin_lock_irq(&gcwq->lock);
1493 if (need_to_create_worker(gcwq))
1494 goto restart;
1495 return true;
1496}
1497
1498/**
1499 * maybe_destroy_worker - destroy workers which have been idle for a while
1500 * @gcwq: gcwq to destroy workers for
1501 *
1502 * Destroy @gcwq workers which have been idle for longer than
1503 * IDLE_WORKER_TIMEOUT.
1504 *
1505 * LOCKING:
1506 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1507 * multiple times. Called only from manager.
1508 *
1509 * RETURNS:
1510 * false if no action was taken and gcwq->lock stayed locked, true
1511 * otherwise.
1512 */
1513static bool maybe_destroy_workers(struct global_cwq *gcwq)
1514{
1515 bool ret = false;
1516
1517 while (too_many_workers(gcwq)) {
1518 struct worker *worker;
1519 unsigned long expires;
1520
1521 worker = list_entry(gcwq->idle_list.prev, struct worker, entry);
1522 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1523
1524 if (time_before(jiffies, expires)) {
1525 mod_timer(&gcwq->idle_timer, expires);
1526 break;
1527 }
1528
1529 destroy_worker(worker);
1530 ret = true;
1531 }
1532
1533 return ret;
1534}
1535
1536/**
1537 * manage_workers - manage worker pool
1538 * @worker: self
1539 *
1540 * Assume the manager role and manage gcwq worker pool @worker belongs
1541 * to. At any given time, there can be only zero or one manager per
1542 * gcwq. The exclusion is handled automatically by this function.
1543 *
1544 * The caller can safely start processing works on false return. On
1545 * true return, it's guaranteed that need_to_create_worker() is false
1546 * and may_start_working() is true.
1547 *
1548 * CONTEXT:
1549 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1550 * multiple times. Does GFP_KERNEL allocations.
1551 *
1552 * RETURNS:
1553 * false if no action was taken and gcwq->lock stayed locked, true if
1554 * some action was taken.
1555 */
1556static bool manage_workers(struct worker *worker)
1557{
1558 struct global_cwq *gcwq = worker->gcwq;
1559 bool ret = false;
1560
1561 if (gcwq->flags & GCWQ_MANAGING_WORKERS)
1562 return ret;
1563
1564 gcwq->flags &= ~GCWQ_MANAGE_WORKERS;
1565 gcwq->flags |= GCWQ_MANAGING_WORKERS;
1566
1567 /*
1568 * Destroy and then create so that may_start_working() is true
1569 * on return.
1570 */
1571 ret |= maybe_destroy_workers(gcwq);
1572 ret |= maybe_create_worker(gcwq);
1573
1574 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
1575
1576 /*
1577 * The trustee might be waiting to take over the manager
1578 * position, tell it we're done.
1579 */
1580 if (unlikely(gcwq->trustee))
1581 wake_up_all(&gcwq->trustee_wait);
1582
1583 return ret;
1584}
1585
Tejun Heoa62428c2010-06-29 10:07:10 +02001586/**
Tejun Heoaffee4b2010-06-29 10:07:12 +02001587 * move_linked_works - move linked works to a list
1588 * @work: start of series of works to be scheduled
1589 * @head: target list to append @work to
1590 * @nextp: out paramter for nested worklist walking
1591 *
1592 * Schedule linked works starting from @work to @head. Work series to
1593 * be scheduled starts at @work and includes any consecutive work with
1594 * WORK_STRUCT_LINKED set in its predecessor.
1595 *
1596 * If @nextp is not NULL, it's updated to point to the next work of
1597 * the last scheduled work. This allows move_linked_works() to be
1598 * nested inside outer list_for_each_entry_safe().
1599 *
1600 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001601 * spin_lock_irq(gcwq->lock).
Tejun Heoaffee4b2010-06-29 10:07:12 +02001602 */
1603static void move_linked_works(struct work_struct *work, struct list_head *head,
1604 struct work_struct **nextp)
1605{
1606 struct work_struct *n;
1607
1608 /*
1609 * Linked worklist will always end before the end of the list,
1610 * use NULL for list head.
1611 */
1612 list_for_each_entry_safe_from(work, n, NULL, entry) {
1613 list_move_tail(&work->entry, head);
1614 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1615 break;
1616 }
1617
1618 /*
1619 * If we're already inside safe list traversal and have moved
1620 * multiple works to the scheduled queue, the next position
1621 * needs to be updated.
1622 */
1623 if (nextp)
1624 *nextp = n;
1625}
1626
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001627static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
1628{
1629 struct work_struct *work = list_first_entry(&cwq->delayed_works,
1630 struct work_struct, entry);
Tejun Heo649027d2010-06-29 10:07:14 +02001631 struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001632
Tejun Heo649027d2010-06-29 10:07:14 +02001633 move_linked_works(work, pos, NULL);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001634 cwq->nr_active++;
1635}
1636
Tejun Heoaffee4b2010-06-29 10:07:12 +02001637/**
Tejun Heo73f53c42010-06-29 10:07:11 +02001638 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1639 * @cwq: cwq of interest
1640 * @color: color of work which left the queue
1641 *
1642 * A work either has completed or is removed from pending queue,
1643 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1644 *
1645 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001646 * spin_lock_irq(gcwq->lock).
Tejun Heo73f53c42010-06-29 10:07:11 +02001647 */
1648static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
1649{
1650 /* ignore uncolored works */
1651 if (color == WORK_NO_COLOR)
1652 return;
1653
1654 cwq->nr_in_flight[color]--;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001655 cwq->nr_active--;
1656
Tejun Heo502ca9d2010-06-29 10:07:13 +02001657 if (!list_empty(&cwq->delayed_works)) {
1658 /* one down, submit a delayed one */
1659 if (cwq->nr_active < cwq->max_active)
1660 cwq_activate_first_delayed(cwq);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001661 }
Tejun Heo73f53c42010-06-29 10:07:11 +02001662
1663 /* is flush in progress and are we at the flushing tip? */
1664 if (likely(cwq->flush_color != color))
1665 return;
1666
1667 /* are there still in-flight works? */
1668 if (cwq->nr_in_flight[color])
1669 return;
1670
1671 /* this cwq is done, clear flush_color */
1672 cwq->flush_color = -1;
1673
1674 /*
1675 * If this was the last cwq, wake up the first flusher. It
1676 * will handle the rest.
1677 */
1678 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1679 complete(&cwq->wq->first_flusher->done);
1680}
1681
1682/**
Tejun Heoa62428c2010-06-29 10:07:10 +02001683 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001684 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001685 * @work: work to process
1686 *
1687 * Process @work. This function contains all the logics necessary to
1688 * process a single work including synchronization against and
1689 * interaction with other workers on the same cpu, queueing and
1690 * flushing. As long as context requirement is met, any worker can
1691 * call this function to process a work.
1692 *
1693 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001694 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02001695 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001696static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heoa62428c2010-06-29 10:07:10 +02001697{
Tejun Heo7e116292010-06-29 10:07:13 +02001698 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001699 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001700 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heofb0e7be2010-06-29 10:07:15 +02001701 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02001702 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02001703 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02001704 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02001705#ifdef CONFIG_LOCKDEP
1706 /*
1707 * It is permissible to free the struct work_struct from
1708 * inside the function that is called from it, this we need to
1709 * take into account for lockdep too. To avoid bogus "held
1710 * lock freed" warnings as well as problems when looking into
1711 * work->lockdep_map, make a copy and use that here.
1712 */
1713 struct lockdep_map lockdep_map = work->lockdep_map;
1714#endif
Tejun Heo7e116292010-06-29 10:07:13 +02001715 /*
1716 * A single work shouldn't be executed concurrently by
1717 * multiple workers on a single cpu. Check whether anyone is
1718 * already processing the work. If so, defer the work to the
1719 * currently executing one.
1720 */
1721 collision = __find_worker_executing_work(gcwq, bwh, work);
1722 if (unlikely(collision)) {
1723 move_linked_works(work, &collision->scheduled, NULL);
1724 return;
1725 }
1726
Tejun Heoa62428c2010-06-29 10:07:10 +02001727 /* claim and process */
Tejun Heoa62428c2010-06-29 10:07:10 +02001728 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001729 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02001730 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001731 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001732 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001733
Tejun Heo7a22ad72010-06-29 10:07:13 +02001734 /* record the current cpu number in the work data and dequeue */
1735 set_work_cpu(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02001736 list_del_init(&work->entry);
1737
Tejun Heo649027d2010-06-29 10:07:14 +02001738 /*
1739 * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI,
1740 * wake up another worker; otherwise, clear HIGHPRI_PENDING.
1741 */
1742 if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) {
1743 struct work_struct *nwork = list_first_entry(&gcwq->worklist,
1744 struct work_struct, entry);
1745
1746 if (!list_empty(&gcwq->worklist) &&
1747 get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI)
1748 wake_up_worker(gcwq);
1749 else
1750 gcwq->flags &= ~GCWQ_HIGHPRI_PENDING;
1751 }
1752
Tejun Heofb0e7be2010-06-29 10:07:15 +02001753 /*
1754 * CPU intensive works don't participate in concurrency
1755 * management. They're the scheduler's responsibility.
1756 */
1757 if (unlikely(cpu_intensive))
1758 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
1759
Tejun Heo8b03ae32010-06-29 10:07:12 +02001760 spin_unlock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001761
Tejun Heoa62428c2010-06-29 10:07:10 +02001762 work_clear_pending(work);
1763 lock_map_acquire(&cwq->wq->lockdep_map);
1764 lock_map_acquire(&lockdep_map);
1765 f(work);
1766 lock_map_release(&lockdep_map);
1767 lock_map_release(&cwq->wq->lockdep_map);
1768
1769 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
1770 printk(KERN_ERR "BUG: workqueue leaked lock or atomic: "
1771 "%s/0x%08x/%d\n",
1772 current->comm, preempt_count(), task_pid_nr(current));
1773 printk(KERN_ERR " last function: ");
1774 print_symbol("%s\n", (unsigned long)f);
1775 debug_show_held_locks(current);
1776 dump_stack();
1777 }
1778
Tejun Heo8b03ae32010-06-29 10:07:12 +02001779 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02001780
Tejun Heofb0e7be2010-06-29 10:07:15 +02001781 /* clear cpu intensive status */
1782 if (unlikely(cpu_intensive))
1783 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
1784
Tejun Heoa62428c2010-06-29 10:07:10 +02001785 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02001786 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001787 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02001788 worker->current_cwq = NULL;
Tejun Heo73f53c42010-06-29 10:07:11 +02001789 cwq_dec_nr_in_flight(cwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02001790}
1791
Tejun Heoaffee4b2010-06-29 10:07:12 +02001792/**
1793 * process_scheduled_works - process scheduled works
1794 * @worker: self
1795 *
1796 * Process all scheduled works. Please note that the scheduled list
1797 * may change while processing a work, so this function repeatedly
1798 * fetches a work from the top and executes it.
1799 *
1800 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001801 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02001802 * multiple times.
1803 */
1804static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805{
Tejun Heoaffee4b2010-06-29 10:07:12 +02001806 while (!list_empty(&worker->scheduled)) {
1807 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02001809 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811}
1812
Tejun Heo4690c4a2010-06-29 10:07:10 +02001813/**
1814 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02001815 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02001816 *
Tejun Heoe22bee72010-06-29 10:07:14 +02001817 * The gcwq worker thread function. There's a single dynamic pool of
1818 * these per each cpu. These workers process all works regardless of
1819 * their specific target workqueue. The only exception is works which
1820 * belong to workqueues with a rescuer which will be explained in
1821 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02001822 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001823static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824{
Tejun Heoc34056a2010-06-29 10:07:11 +02001825 struct worker *worker = __worker;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001826 struct global_cwq *gcwq = worker->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827
Tejun Heoe22bee72010-06-29 10:07:14 +02001828 /* tell the scheduler that this is a workqueue worker */
1829 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001830woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02001831 spin_lock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001832
Tejun Heoc8e55f32010-06-29 10:07:12 +02001833 /* DIE can be set only while we're idle, checking here is enough */
1834 if (worker->flags & WORKER_DIE) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001835 spin_unlock_irq(&gcwq->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001836 worker->task->flags &= ~PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001837 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001839
Tejun Heoc8e55f32010-06-29 10:07:12 +02001840 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001841recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02001842 /* no more worker necessary? */
1843 if (!need_more_worker(gcwq))
1844 goto sleep;
1845
1846 /* do we need to manage? */
1847 if (unlikely(!may_start_working(gcwq)) && manage_workers(worker))
1848 goto recheck;
1849
Tejun Heoc8e55f32010-06-29 10:07:12 +02001850 /*
1851 * ->scheduled list can only be filled while a worker is
1852 * preparing to process a work or actually processing it.
1853 * Make sure nobody diddled with it while I was sleeping.
1854 */
1855 BUG_ON(!list_empty(&worker->scheduled));
1856
Tejun Heoe22bee72010-06-29 10:07:14 +02001857 /*
1858 * When control reaches this point, we're guaranteed to have
1859 * at least one idle worker or that someone else has already
1860 * assumed the manager role.
1861 */
1862 worker_clr_flags(worker, WORKER_PREP);
1863
1864 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02001865 struct work_struct *work =
Tejun Heo7e116292010-06-29 10:07:13 +02001866 list_first_entry(&gcwq->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02001867 struct work_struct, entry);
1868
1869 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
1870 /* optimization path, not strictly necessary */
1871 process_one_work(worker, work);
1872 if (unlikely(!list_empty(&worker->scheduled)))
1873 process_scheduled_works(worker);
1874 } else {
1875 move_linked_works(work, &worker->scheduled, NULL);
1876 process_scheduled_works(worker);
1877 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001878 } while (keep_working(gcwq));
Tejun Heoc8e55f32010-06-29 10:07:12 +02001879
Tejun Heoe22bee72010-06-29 10:07:14 +02001880 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02001881sleep:
Tejun Heoe22bee72010-06-29 10:07:14 +02001882 if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker))
1883 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02001884
Tejun Heoc8e55f32010-06-29 10:07:12 +02001885 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02001886 * gcwq->lock is held and there's no work to process and no
1887 * need to manage, sleep. Workers are woken up only while
1888 * holding gcwq->lock or from local cpu, so setting the
1889 * current state before releasing gcwq->lock is enough to
1890 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001891 */
1892 worker_enter_idle(worker);
1893 __set_current_state(TASK_INTERRUPTIBLE);
1894 spin_unlock_irq(&gcwq->lock);
1895 schedule();
1896 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897}
1898
Tejun Heoe22bee72010-06-29 10:07:14 +02001899/**
1900 * rescuer_thread - the rescuer thread function
1901 * @__wq: the associated workqueue
1902 *
1903 * Workqueue rescuer thread function. There's one rescuer for each
1904 * workqueue which has WQ_RESCUER set.
1905 *
1906 * Regular work processing on a gcwq may block trying to create a new
1907 * worker which uses GFP_KERNEL allocation which has slight chance of
1908 * developing into deadlock if some works currently on the same queue
1909 * need to be processed to satisfy the GFP_KERNEL allocation. This is
1910 * the problem rescuer solves.
1911 *
1912 * When such condition is possible, the gcwq summons rescuers of all
1913 * workqueues which have works queued on the gcwq and let them process
1914 * those works so that forward progress can be guaranteed.
1915 *
1916 * This should happen rarely.
1917 */
1918static int rescuer_thread(void *__wq)
1919{
1920 struct workqueue_struct *wq = __wq;
1921 struct worker *rescuer = wq->rescuer;
1922 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02001923 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02001924 unsigned int cpu;
1925
1926 set_user_nice(current, RESCUER_NICE_LEVEL);
1927repeat:
1928 set_current_state(TASK_INTERRUPTIBLE);
1929
1930 if (kthread_should_stop())
1931 return 0;
1932
Tejun Heof3421792010-07-02 10:03:51 +02001933 /*
1934 * See whether any cpu is asking for help. Unbounded
1935 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
1936 */
Tejun Heof2e005a2010-07-20 15:59:09 +02001937 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02001938 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
1939 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001940 struct global_cwq *gcwq = cwq->gcwq;
1941 struct work_struct *work, *n;
1942
1943 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02001944 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02001945
1946 /* migrate to the target cpu if possible */
1947 rescuer->gcwq = gcwq;
1948 worker_maybe_bind_and_lock(rescuer);
1949
1950 /*
1951 * Slurp in all works issued via this workqueue and
1952 * process'em.
1953 */
1954 BUG_ON(!list_empty(&rescuer->scheduled));
1955 list_for_each_entry_safe(work, n, &gcwq->worklist, entry)
1956 if (get_work_cwq(work) == cwq)
1957 move_linked_works(work, scheduled, &n);
1958
1959 process_scheduled_works(rescuer);
1960 spin_unlock_irq(&gcwq->lock);
1961 }
1962
1963 schedule();
1964 goto repeat;
1965}
1966
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07001967struct wq_barrier {
1968 struct work_struct work;
1969 struct completion done;
1970};
1971
1972static void wq_barrier_func(struct work_struct *work)
1973{
1974 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
1975 complete(&barr->done);
1976}
1977
Tejun Heo4690c4a2010-06-29 10:07:10 +02001978/**
1979 * insert_wq_barrier - insert a barrier work
1980 * @cwq: cwq to insert barrier into
1981 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02001982 * @target: target work to attach @barr to
1983 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02001984 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02001985 * @barr is linked to @target such that @barr is completed only after
1986 * @target finishes execution. Please note that the ordering
1987 * guarantee is observed only with respect to @target and on the local
1988 * cpu.
1989 *
1990 * Currently, a queued barrier can't be canceled. This is because
1991 * try_to_grab_pending() can't determine whether the work to be
1992 * grabbed is at the head of the queue and thus can't clear LINKED
1993 * flag of the previous work while there must be a valid next work
1994 * after a work with LINKED flag set.
1995 *
1996 * Note that when @worker is non-NULL, @target may be modified
1997 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001998 *
1999 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002000 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002001 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002002static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002003 struct wq_barrier *barr,
2004 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002005{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002006 struct list_head *head;
2007 unsigned int linked = 0;
2008
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002009 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002010 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002011 * as we know for sure that this will not trigger any of the
2012 * checks and call back into the fixup functions where we
2013 * might deadlock.
2014 */
2015 INIT_WORK_ON_STACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002016 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002017 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002018
Tejun Heoaffee4b2010-06-29 10:07:12 +02002019 /*
2020 * If @target is currently being executed, schedule the
2021 * barrier to the worker; otherwise, put it after @target.
2022 */
2023 if (worker)
2024 head = worker->scheduled.next;
2025 else {
2026 unsigned long *bits = work_data_bits(target);
2027
2028 head = target->entry.next;
2029 /* there can already be other linked works, inherit and set */
2030 linked = *bits & WORK_STRUCT_LINKED;
2031 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2032 }
2033
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002034 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002035 insert_work(cwq, &barr->work, head,
2036 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002037}
2038
Tejun Heo73f53c42010-06-29 10:07:11 +02002039/**
2040 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2041 * @wq: workqueue being flushed
2042 * @flush_color: new flush color, < 0 for no-op
2043 * @work_color: new work color, < 0 for no-op
2044 *
2045 * Prepare cwqs for workqueue flushing.
2046 *
2047 * If @flush_color is non-negative, flush_color on all cwqs should be
2048 * -1. If no cwq has in-flight commands at the specified color, all
2049 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2050 * has in flight commands, its cwq->flush_color is set to
2051 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2052 * wakeup logic is armed and %true is returned.
2053 *
2054 * The caller should have initialized @wq->first_flusher prior to
2055 * calling this function with non-negative @flush_color. If
2056 * @flush_color is negative, no flush color update is done and %false
2057 * is returned.
2058 *
2059 * If @work_color is non-negative, all cwqs should have the same
2060 * work_color which is previous to @work_color and all will be
2061 * advanced to @work_color.
2062 *
2063 * CONTEXT:
2064 * mutex_lock(wq->flush_mutex).
2065 *
2066 * RETURNS:
2067 * %true if @flush_color >= 0 and there's something to flush. %false
2068 * otherwise.
2069 */
2070static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2071 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072{
Tejun Heo73f53c42010-06-29 10:07:11 +02002073 bool wait = false;
2074 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002075
Tejun Heo73f53c42010-06-29 10:07:11 +02002076 if (flush_color >= 0) {
2077 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2078 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002079 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002080
Tejun Heof3421792010-07-02 10:03:51 +02002081 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002082 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002083 struct global_cwq *gcwq = cwq->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002084
Tejun Heo8b03ae32010-06-29 10:07:12 +02002085 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002086
2087 if (flush_color >= 0) {
2088 BUG_ON(cwq->flush_color != -1);
2089
2090 if (cwq->nr_in_flight[flush_color]) {
2091 cwq->flush_color = flush_color;
2092 atomic_inc(&wq->nr_cwqs_to_flush);
2093 wait = true;
2094 }
2095 }
2096
2097 if (work_color >= 0) {
2098 BUG_ON(work_color != work_next_color(cwq->work_color));
2099 cwq->work_color = work_color;
2100 }
2101
Tejun Heo8b03ae32010-06-29 10:07:12 +02002102 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002103 }
2104
2105 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2106 complete(&wq->first_flusher->done);
2107
2108 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109}
2110
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002111/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002113 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 *
2115 * Forces execution of the workqueue and blocks until its completion.
2116 * This is typically used in driver shutdown handlers.
2117 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002118 * We sleep until all works which were queued on entry have been handled,
2119 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002121void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122{
Tejun Heo73f53c42010-06-29 10:07:11 +02002123 struct wq_flusher this_flusher = {
2124 .list = LIST_HEAD_INIT(this_flusher.list),
2125 .flush_color = -1,
2126 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2127 };
2128 int next_color;
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002129
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002130 lock_map_acquire(&wq->lockdep_map);
2131 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002132
2133 mutex_lock(&wq->flush_mutex);
2134
2135 /*
2136 * Start-to-wait phase
2137 */
2138 next_color = work_next_color(wq->work_color);
2139
2140 if (next_color != wq->flush_color) {
2141 /*
2142 * Color space is not full. The current work_color
2143 * becomes our flush_color and work_color is advanced
2144 * by one.
2145 */
2146 BUG_ON(!list_empty(&wq->flusher_overflow));
2147 this_flusher.flush_color = wq->work_color;
2148 wq->work_color = next_color;
2149
2150 if (!wq->first_flusher) {
2151 /* no flush in progress, become the first flusher */
2152 BUG_ON(wq->flush_color != this_flusher.flush_color);
2153
2154 wq->first_flusher = &this_flusher;
2155
2156 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2157 wq->work_color)) {
2158 /* nothing to flush, done */
2159 wq->flush_color = next_color;
2160 wq->first_flusher = NULL;
2161 goto out_unlock;
2162 }
2163 } else {
2164 /* wait in queue */
2165 BUG_ON(wq->flush_color == this_flusher.flush_color);
2166 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2167 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2168 }
2169 } else {
2170 /*
2171 * Oops, color space is full, wait on overflow queue.
2172 * The next flush completion will assign us
2173 * flush_color and transfer to flusher_queue.
2174 */
2175 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2176 }
2177
2178 mutex_unlock(&wq->flush_mutex);
2179
2180 wait_for_completion(&this_flusher.done);
2181
2182 /*
2183 * Wake-up-and-cascade phase
2184 *
2185 * First flushers are responsible for cascading flushes and
2186 * handling overflow. Non-first flushers can simply return.
2187 */
2188 if (wq->first_flusher != &this_flusher)
2189 return;
2190
2191 mutex_lock(&wq->flush_mutex);
2192
Tejun Heo4ce48b32010-07-02 10:03:51 +02002193 /* we might have raced, check again with mutex held */
2194 if (wq->first_flusher != &this_flusher)
2195 goto out_unlock;
2196
Tejun Heo73f53c42010-06-29 10:07:11 +02002197 wq->first_flusher = NULL;
2198
2199 BUG_ON(!list_empty(&this_flusher.list));
2200 BUG_ON(wq->flush_color != this_flusher.flush_color);
2201
2202 while (true) {
2203 struct wq_flusher *next, *tmp;
2204
2205 /* complete all the flushers sharing the current flush color */
2206 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2207 if (next->flush_color != wq->flush_color)
2208 break;
2209 list_del_init(&next->list);
2210 complete(&next->done);
2211 }
2212
2213 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2214 wq->flush_color != work_next_color(wq->work_color));
2215
2216 /* this flush_color is finished, advance by one */
2217 wq->flush_color = work_next_color(wq->flush_color);
2218
2219 /* one color has been freed, handle overflow queue */
2220 if (!list_empty(&wq->flusher_overflow)) {
2221 /*
2222 * Assign the same color to all overflowed
2223 * flushers, advance work_color and append to
2224 * flusher_queue. This is the start-to-wait
2225 * phase for these overflowed flushers.
2226 */
2227 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2228 tmp->flush_color = wq->work_color;
2229
2230 wq->work_color = work_next_color(wq->work_color);
2231
2232 list_splice_tail_init(&wq->flusher_overflow,
2233 &wq->flusher_queue);
2234 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2235 }
2236
2237 if (list_empty(&wq->flusher_queue)) {
2238 BUG_ON(wq->flush_color != wq->work_color);
2239 break;
2240 }
2241
2242 /*
2243 * Need to flush more colors. Make the next flusher
2244 * the new first flusher and arm cwqs.
2245 */
2246 BUG_ON(wq->flush_color == wq->work_color);
2247 BUG_ON(wq->flush_color != next->flush_color);
2248
2249 list_del_init(&next->list);
2250 wq->first_flusher = next;
2251
2252 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2253 break;
2254
2255 /*
2256 * Meh... this color is already done, clear first
2257 * flusher and repeat cascading.
2258 */
2259 wq->first_flusher = NULL;
2260 }
2261
2262out_unlock:
2263 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264}
Dave Jonesae90dd52006-06-30 01:40:45 -04002265EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266
Oleg Nesterovdb700892008-07-25 01:47:49 -07002267/**
2268 * flush_work - block until a work_struct's callback has terminated
2269 * @work: the work which is to be flushed
2270 *
Oleg Nesterova67da702008-07-25 01:47:52 -07002271 * Returns false if @work has already terminated.
2272 *
Oleg Nesterovdb700892008-07-25 01:47:49 -07002273 * It is expected that, prior to calling flush_work(), the caller has
2274 * arranged for the work to not be requeued, otherwise it doesn't make
2275 * sense to use this function.
2276 */
2277int flush_work(struct work_struct *work)
2278{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002279 struct worker *worker = NULL;
Tejun Heo8b03ae32010-06-29 10:07:12 +02002280 struct global_cwq *gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +02002281 struct cpu_workqueue_struct *cwq;
Oleg Nesterovdb700892008-07-25 01:47:49 -07002282 struct wq_barrier barr;
2283
2284 might_sleep();
Tejun Heo7a22ad72010-06-29 10:07:13 +02002285 gcwq = get_work_gcwq(work);
2286 if (!gcwq)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002287 return 0;
Oleg Nesterova67da702008-07-25 01:47:52 -07002288
Tejun Heo8b03ae32010-06-29 10:07:12 +02002289 spin_lock_irq(&gcwq->lock);
Oleg Nesterovdb700892008-07-25 01:47:49 -07002290 if (!list_empty(&work->entry)) {
2291 /*
2292 * See the comment near try_to_grab_pending()->smp_rmb().
Tejun Heo7a22ad72010-06-29 10:07:13 +02002293 * If it was re-queued to a different gcwq under us, we
2294 * are not going to wait.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002295 */
2296 smp_rmb();
Tejun Heo7a22ad72010-06-29 10:07:13 +02002297 cwq = get_work_cwq(work);
2298 if (unlikely(!cwq || gcwq != cwq->gcwq))
Tejun Heo4690c4a2010-06-29 10:07:10 +02002299 goto already_gone;
Oleg Nesterovdb700892008-07-25 01:47:49 -07002300 } else {
Tejun Heo7a22ad72010-06-29 10:07:13 +02002301 worker = find_worker_executing_work(gcwq, work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002302 if (!worker)
Tejun Heo4690c4a2010-06-29 10:07:10 +02002303 goto already_gone;
Tejun Heo7a22ad72010-06-29 10:07:13 +02002304 cwq = worker->current_cwq;
Oleg Nesterovdb700892008-07-25 01:47:49 -07002305 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002306
Tejun Heoaffee4b2010-06-29 10:07:12 +02002307 insert_wq_barrier(cwq, &barr, work, worker);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002308 spin_unlock_irq(&gcwq->lock);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002309
2310 lock_map_acquire(&cwq->wq->lockdep_map);
2311 lock_map_release(&cwq->wq->lockdep_map);
2312
Oleg Nesterovdb700892008-07-25 01:47:49 -07002313 wait_for_completion(&barr.done);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002314 destroy_work_on_stack(&barr.work);
Oleg Nesterovdb700892008-07-25 01:47:49 -07002315 return 1;
Tejun Heo4690c4a2010-06-29 10:07:10 +02002316already_gone:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002317 spin_unlock_irq(&gcwq->lock);
Tejun Heo4690c4a2010-06-29 10:07:10 +02002318 return 0;
Oleg Nesterovdb700892008-07-25 01:47:49 -07002319}
2320EXPORT_SYMBOL_GPL(flush_work);
2321
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002322/*
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002323 * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit,
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002324 * so this work can't be re-armed in any way.
2325 */
2326static int try_to_grab_pending(struct work_struct *work)
2327{
Tejun Heo8b03ae32010-06-29 10:07:12 +02002328 struct global_cwq *gcwq;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002329 int ret = -1;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002330
Tejun Heo22df02b2010-06-29 10:07:10 +02002331 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002332 return 0;
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002333
2334 /*
2335 * The queueing is in progress, or it is already queued. Try to
2336 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
2337 */
Tejun Heo7a22ad72010-06-29 10:07:13 +02002338 gcwq = get_work_gcwq(work);
2339 if (!gcwq)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002340 return ret;
2341
Tejun Heo8b03ae32010-06-29 10:07:12 +02002342 spin_lock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002343 if (!list_empty(&work->entry)) {
2344 /*
Tejun Heo7a22ad72010-06-29 10:07:13 +02002345 * This work is queued, but perhaps we locked the wrong gcwq.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002346 * In that case we must see the new value after rmb(), see
2347 * insert_work()->wmb().
2348 */
2349 smp_rmb();
Tejun Heo7a22ad72010-06-29 10:07:13 +02002350 if (gcwq == get_work_gcwq(work)) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002351 debug_work_deactivate(work);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002352 list_del_init(&work->entry);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002353 cwq_dec_nr_in_flight(get_work_cwq(work),
2354 get_work_color(work));
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002355 ret = 1;
2356 }
2357 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02002358 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002359
2360 return ret;
2361}
2362
Tejun Heo7a22ad72010-06-29 10:07:13 +02002363static void wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002364{
2365 struct wq_barrier barr;
Tejun Heoaffee4b2010-06-29 10:07:12 +02002366 struct worker *worker;
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002367
Tejun Heo8b03ae32010-06-29 10:07:12 +02002368 spin_lock_irq(&gcwq->lock);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002369
Tejun Heo7a22ad72010-06-29 10:07:13 +02002370 worker = find_worker_executing_work(gcwq, work);
2371 if (unlikely(worker))
2372 insert_wq_barrier(worker->current_cwq, &barr, work, worker);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002373
Tejun Heo8b03ae32010-06-29 10:07:12 +02002374 spin_unlock_irq(&gcwq->lock);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002375
Tejun Heoaffee4b2010-06-29 10:07:12 +02002376 if (unlikely(worker)) {
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002377 wait_for_completion(&barr.done);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002378 destroy_work_on_stack(&barr.work);
2379 }
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002380}
2381
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002382static void wait_on_work(struct work_struct *work)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002383{
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002384 int cpu;
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002385
Oleg Nesterovf293ea92007-05-09 02:34:10 -07002386 might_sleep();
2387
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002388 lock_map_acquire(&work->lockdep_map);
2389 lock_map_release(&work->lockdep_map);
Johannes Berg4e6045f2007-10-18 23:39:55 -07002390
Tejun Heof3421792010-07-02 10:03:51 +02002391 for_each_gcwq_cpu(cpu)
Tejun Heo7a22ad72010-06-29 10:07:13 +02002392 wait_on_cpu_work(get_gcwq(cpu), work);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002393}
2394
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002395static int __cancel_work_timer(struct work_struct *work,
2396 struct timer_list* timer)
2397{
2398 int ret;
2399
2400 do {
2401 ret = (timer && likely(del_timer(timer)));
2402 if (!ret)
2403 ret = try_to_grab_pending(work);
2404 wait_on_work(work);
2405 } while (unlikely(ret < 0));
2406
Tejun Heo7a22ad72010-06-29 10:07:13 +02002407 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002408 return ret;
2409}
2410
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002411/**
2412 * cancel_work_sync - block until a work_struct's callback has terminated
2413 * @work: the work which is to be flushed
2414 *
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002415 * Returns true if @work was pending.
2416 *
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002417 * cancel_work_sync() will cancel the work if it is queued. If the work's
2418 * callback appears to be running, cancel_work_sync() will block until it
2419 * has completed.
2420 *
2421 * It is possible to use this function if the work re-queues itself. It can
2422 * cancel the work even if it migrates to another workqueue, however in that
2423 * case it only guarantees that work->func() has completed on the last queued
2424 * workqueue.
2425 *
2426 * cancel_work_sync(&delayed_work->work) should be used only if ->timer is not
2427 * pending, otherwise it goes into a busy-wait loop until the timer expires.
2428 *
2429 * The caller must ensure that workqueue_struct on which this work was last
2430 * queued can't be destroyed before this function returns.
2431 */
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002432int cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002433{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002434 return __cancel_work_timer(work, NULL);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002435}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002436EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002437
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002438/**
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002439 * cancel_delayed_work_sync - reliably kill off a delayed work.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002440 * @dwork: the delayed work struct
2441 *
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002442 * Returns true if @dwork was pending.
2443 *
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002444 * It is possible to use this function if @dwork rearms itself via queue_work()
2445 * or queue_delayed_work(). See also the comment for cancel_work_sync().
2446 */
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002447int cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002448{
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002449 return __cancel_work_timer(&dwork->work, &dwork->timer);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002450}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002451EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002453/**
2454 * schedule_work - put work task in global workqueue
2455 * @work: job to be done
2456 *
Bart Van Assche5b0f437d2009-07-30 19:00:53 +02002457 * Returns zero if @work was already on the kernel-global workqueue and
2458 * non-zero otherwise.
2459 *
2460 * This puts a job in the kernel-global workqueue if it was not already
2461 * queued and leaves it in the same position on the kernel-global
2462 * workqueue otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002463 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002464int schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465{
Tejun Heod320c032010-06-29 10:07:14 +02002466 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467}
Dave Jonesae90dd52006-06-30 01:40:45 -04002468EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469
Zhang Ruic1a220e2008-07-23 21:28:39 -07002470/*
2471 * schedule_work_on - put work task on a specific cpu
2472 * @cpu: cpu to put the work task on
2473 * @work: job to be done
2474 *
2475 * This puts a job on a specific cpu
2476 */
2477int schedule_work_on(int cpu, struct work_struct *work)
2478{
Tejun Heod320c032010-06-29 10:07:14 +02002479 return queue_work_on(cpu, system_wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07002480}
2481EXPORT_SYMBOL(schedule_work_on);
2482
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002483/**
2484 * schedule_delayed_work - put work task in global workqueue after delay
David Howells52bad642006-11-22 14:54:01 +00002485 * @dwork: job to be done
2486 * @delay: number of jiffies to wait or 0 for immediate execution
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002487 *
2488 * After waiting for a given time this puts a job in the kernel-global
2489 * workqueue.
2490 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002491int schedule_delayed_work(struct delayed_work *dwork,
Ingo Molnar82f67cd2007-02-16 01:28:13 -08002492 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493{
Tejun Heod320c032010-06-29 10:07:14 +02002494 return queue_delayed_work(system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002495}
Dave Jonesae90dd52006-06-30 01:40:45 -04002496EXPORT_SYMBOL(schedule_delayed_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002498/**
Linus Torvalds8c53e462009-10-14 09:16:42 -07002499 * flush_delayed_work - block until a dwork_struct's callback has terminated
2500 * @dwork: the delayed work which is to be flushed
2501 *
2502 * Any timeout is cancelled, and any pending work is run immediately.
2503 */
2504void flush_delayed_work(struct delayed_work *dwork)
2505{
2506 if (del_timer_sync(&dwork->timer)) {
Tejun Heo7a22ad72010-06-29 10:07:13 +02002507 __queue_work(get_cpu(), get_work_cwq(&dwork->work)->wq,
Tejun Heo4690c4a2010-06-29 10:07:10 +02002508 &dwork->work);
Linus Torvalds8c53e462009-10-14 09:16:42 -07002509 put_cpu();
2510 }
2511 flush_work(&dwork->work);
2512}
2513EXPORT_SYMBOL(flush_delayed_work);
2514
2515/**
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002516 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
2517 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +00002518 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002519 * @delay: number of jiffies to wait
2520 *
2521 * After waiting for a given time this puts a job in the kernel-global
2522 * workqueue on the specified CPU.
2523 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524int schedule_delayed_work_on(int cpu,
David Howells52bad642006-11-22 14:54:01 +00002525 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002526{
Tejun Heod320c032010-06-29 10:07:14 +02002527 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528}
Dave Jonesae90dd52006-06-30 01:40:45 -04002529EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530
Andrew Mortonb6136772006-06-25 05:47:49 -07002531/**
2532 * schedule_on_each_cpu - call a function on each online CPU from keventd
2533 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002534 *
2535 * Returns zero on success.
2536 * Returns -ve errno on failure.
2537 *
Andrew Mortonb6136772006-06-25 05:47:49 -07002538 * schedule_on_each_cpu() is very slow.
2539 */
David Howells65f27f32006-11-22 14:55:48 +00002540int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002541{
2542 int cpu;
Andrew Mortonb6136772006-06-25 05:47:49 -07002543 struct work_struct *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002544
Andrew Mortonb6136772006-06-25 05:47:49 -07002545 works = alloc_percpu(struct work_struct);
2546 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002547 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002548
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002549 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002550
Christoph Lameter15316ba2006-01-08 01:00:43 -08002551 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002552 struct work_struct *work = per_cpu_ptr(works, cpu);
2553
2554 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002555 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002556 }
Tejun Heo93981802009-11-17 14:06:20 -08002557
2558 for_each_online_cpu(cpu)
2559 flush_work(per_cpu_ptr(works, cpu));
2560
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002561 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002562 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08002563 return 0;
2564}
2565
Alan Sterneef6a7d2010-02-12 17:39:21 +09002566/**
2567 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2568 *
2569 * Forces execution of the kernel-global workqueue and blocks until its
2570 * completion.
2571 *
2572 * Think twice before calling this function! It's very easy to get into
2573 * trouble if you don't take great care. Either of the following situations
2574 * will lead to deadlock:
2575 *
2576 * One of the work items currently on the workqueue needs to acquire
2577 * a lock held by your code or its caller.
2578 *
2579 * Your code is running in the context of a work routine.
2580 *
2581 * They will be detected by lockdep when they occur, but the first might not
2582 * occur very often. It depends on what work items are on the workqueue and
2583 * what locks they need, which you have no control over.
2584 *
2585 * In most situations flushing the entire workqueue is overkill; you merely
2586 * need to know that a particular work item isn't queued and isn't running.
2587 * In such cases you should use cancel_delayed_work_sync() or
2588 * cancel_work_sync() instead.
2589 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590void flush_scheduled_work(void)
2591{
Tejun Heod320c032010-06-29 10:07:14 +02002592 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593}
Dave Jonesae90dd52006-06-30 01:40:45 -04002594EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595
2596/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06002597 * execute_in_process_context - reliably execute the routine with user context
2598 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06002599 * @ew: guaranteed storage for the execute work structure (must
2600 * be available when the work executes)
2601 *
2602 * Executes the function immediately if process context is available,
2603 * otherwise schedules the function for delayed execution.
2604 *
2605 * Returns: 0 - function was executed
2606 * 1 - function was scheduled for execution
2607 */
David Howells65f27f32006-11-22 14:55:48 +00002608int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06002609{
2610 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00002611 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002612 return 0;
2613 }
2614
David Howells65f27f32006-11-22 14:55:48 +00002615 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002616 schedule_work(&ew->work);
2617
2618 return 1;
2619}
2620EXPORT_SYMBOL_GPL(execute_in_process_context);
2621
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622int keventd_up(void)
2623{
Tejun Heod320c032010-06-29 10:07:14 +02002624 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625}
2626
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002627static int alloc_cwqs(struct workqueue_struct *wq)
Tejun Heo0f900042010-06-29 10:07:11 +02002628{
2629 /*
2630 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
2631 * Make sure that the alignment isn't lower than that of
2632 * unsigned long long.
2633 */
2634 const size_t size = sizeof(struct cpu_workqueue_struct);
2635 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
2636 __alignof__(unsigned long long));
Tejun Heo931ac772010-07-20 11:07:48 +02002637#ifdef CONFIG_SMP
2638 bool percpu = !(wq->flags & WQ_UNBOUND);
2639#else
2640 bool percpu = false;
2641#endif
Tejun Heo0f900042010-06-29 10:07:11 +02002642
Tejun Heo931ac772010-07-20 11:07:48 +02002643 if (percpu)
Tejun Heof3421792010-07-02 10:03:51 +02002644 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02002645 else {
Tejun Heof3421792010-07-02 10:03:51 +02002646 void *ptr;
2647
2648 /*
2649 * Allocate enough room to align cwq and put an extra
2650 * pointer at the end pointing back to the originally
2651 * allocated pointer which will be used for free.
2652 */
2653 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
2654 if (ptr) {
2655 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
2656 *(void **)(wq->cpu_wq.single + 1) = ptr;
2657 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002658 }
Tejun Heof3421792010-07-02 10:03:51 +02002659
Tejun Heo0f900042010-06-29 10:07:11 +02002660 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002661 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
2662 return wq->cpu_wq.v ? 0 : -ENOMEM;
Tejun Heo0f900042010-06-29 10:07:11 +02002663}
2664
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002665static void free_cwqs(struct workqueue_struct *wq)
Tejun Heo0f900042010-06-29 10:07:11 +02002666{
Tejun Heo931ac772010-07-20 11:07:48 +02002667#ifdef CONFIG_SMP
2668 bool percpu = !(wq->flags & WQ_UNBOUND);
2669#else
2670 bool percpu = false;
2671#endif
2672
2673 if (percpu)
Tejun Heof3421792010-07-02 10:03:51 +02002674 free_percpu(wq->cpu_wq.pcpu);
2675 else if (wq->cpu_wq.single) {
2676 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002677 kfree(*(void **)(wq->cpu_wq.single + 1));
Tejun Heof3421792010-07-02 10:03:51 +02002678 }
Tejun Heo0f900042010-06-29 10:07:11 +02002679}
2680
Tejun Heof3421792010-07-02 10:03:51 +02002681static int wq_clamp_max_active(int max_active, unsigned int flags,
2682 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02002683{
Tejun Heof3421792010-07-02 10:03:51 +02002684 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
2685
2686 if (max_active < 1 || max_active > lim)
Tejun Heob71ab8c2010-06-29 10:07:14 +02002687 printk(KERN_WARNING "workqueue: max_active %d requested for %s "
2688 "is out of range, clamping between %d and %d\n",
Tejun Heof3421792010-07-02 10:03:51 +02002689 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002690
Tejun Heof3421792010-07-02 10:03:51 +02002691 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002692}
2693
Tejun Heod320c032010-06-29 10:07:14 +02002694struct workqueue_struct *__alloc_workqueue_key(const char *name,
2695 unsigned int flags,
2696 int max_active,
2697 struct lock_class_key *key,
2698 const char *lock_name)
Oleg Nesterov3af244332007-05-09 02:34:09 -07002699{
2700 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02002701 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002702
Tejun Heof3421792010-07-02 10:03:51 +02002703 /*
2704 * Unbound workqueues aren't concurrency managed and should be
2705 * dispatched to workers immediately.
2706 */
2707 if (flags & WQ_UNBOUND)
2708 flags |= WQ_HIGHPRI;
2709
Tejun Heod320c032010-06-29 10:07:14 +02002710 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heof3421792010-07-02 10:03:51 +02002711 max_active = wq_clamp_max_active(max_active, flags, name);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02002712
Oleg Nesterov3af244332007-05-09 02:34:09 -07002713 wq = kzalloc(sizeof(*wq), GFP_KERNEL);
2714 if (!wq)
Tejun Heo4690c4a2010-06-29 10:07:10 +02002715 goto err;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002716
Tejun Heo97e37d72010-06-29 10:07:10 +02002717 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002718 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02002719 mutex_init(&wq->flush_mutex);
2720 atomic_set(&wq->nr_cwqs_to_flush, 0);
2721 INIT_LIST_HEAD(&wq->flusher_queue);
2722 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo502ca9d2010-06-29 10:07:13 +02002723
Oleg Nesterov3af244332007-05-09 02:34:09 -07002724 wq->name = name;
Johannes Bergeb13ba82008-01-16 09:51:58 +01002725 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07002726 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002727
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002728 if (alloc_cwqs(wq) < 0)
2729 goto err;
2730
Tejun Heof3421792010-07-02 10:03:51 +02002731 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02002732 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002733 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo15376632010-06-29 10:07:11 +02002734
Tejun Heo0f900042010-06-29 10:07:11 +02002735 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo8b03ae32010-06-29 10:07:12 +02002736 cwq->gcwq = gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02002737 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002738 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02002739 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02002740 INIT_LIST_HEAD(&cwq->delayed_works);
Tejun Heoe22bee72010-06-29 10:07:14 +02002741 }
Tejun Heo15376632010-06-29 10:07:11 +02002742
Tejun Heoe22bee72010-06-29 10:07:14 +02002743 if (flags & WQ_RESCUER) {
2744 struct worker *rescuer;
2745
Tejun Heof2e005a2010-07-20 15:59:09 +02002746 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02002747 goto err;
2748
2749 wq->rescuer = rescuer = alloc_worker();
2750 if (!rescuer)
2751 goto err;
2752
2753 rescuer->task = kthread_create(rescuer_thread, wq, "%s", name);
2754 if (IS_ERR(rescuer->task))
2755 goto err;
2756
2757 wq->rescuer = rescuer;
2758 rescuer->task->flags |= PF_THREAD_BOUND;
2759 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002760 }
2761
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002762 /*
2763 * workqueue_lock protects global freeze state and workqueues
2764 * list. Grab it, set max_active accordingly and add the new
2765 * workqueue to workqueues list.
2766 */
Tejun Heo15376632010-06-29 10:07:11 +02002767 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002768
2769 if (workqueue_freezing && wq->flags & WQ_FREEZEABLE)
Tejun Heof3421792010-07-02 10:03:51 +02002770 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002771 get_cwq(cpu, wq)->max_active = 0;
2772
Tejun Heo15376632010-06-29 10:07:11 +02002773 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002774
Tejun Heo15376632010-06-29 10:07:11 +02002775 spin_unlock(&workqueue_lock);
2776
Oleg Nesterov3af244332007-05-09 02:34:09 -07002777 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02002778err:
2779 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002780 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02002781 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002782 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02002783 kfree(wq);
2784 }
2785 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002786}
Tejun Heod320c032010-06-29 10:07:14 +02002787EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002788
Oleg Nesterov3af244332007-05-09 02:34:09 -07002789/**
2790 * destroy_workqueue - safely terminate a workqueue
2791 * @wq: target workqueue
2792 *
2793 * Safely destroy a workqueue. All work currently pending will be done first.
2794 */
2795void destroy_workqueue(struct workqueue_struct *wq)
2796{
Tejun Heoc8e55f32010-06-29 10:07:12 +02002797 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07002798
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02002799 flush_workqueue(wq);
2800
2801 /*
2802 * wq list is used to freeze wq, remove from list after
2803 * flushing is complete in case freeze races us.
2804 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002805 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec172007-05-09 02:34:12 -07002806 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002807 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002808
Tejun Heoe22bee72010-06-29 10:07:14 +02002809 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02002810 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002811 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2812 int i;
2813
Tejun Heo73f53c42010-06-29 10:07:11 +02002814 for (i = 0; i < WORK_NR_COLORS; i++)
2815 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02002816 BUG_ON(cwq->nr_active);
2817 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02002818 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002819
Tejun Heoe22bee72010-06-29 10:07:14 +02002820 if (wq->flags & WQ_RESCUER) {
2821 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02002822 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002823 }
2824
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002825 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002826 kfree(wq);
2827}
2828EXPORT_SYMBOL_GPL(destroy_workqueue);
2829
Tejun Heodcd989c2010-06-29 10:07:14 +02002830/**
2831 * workqueue_set_max_active - adjust max_active of a workqueue
2832 * @wq: target workqueue
2833 * @max_active: new max_active value.
2834 *
2835 * Set max_active of @wq to @max_active.
2836 *
2837 * CONTEXT:
2838 * Don't call from IRQ context.
2839 */
2840void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
2841{
2842 unsigned int cpu;
2843
Tejun Heof3421792010-07-02 10:03:51 +02002844 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02002845
2846 spin_lock(&workqueue_lock);
2847
2848 wq->saved_max_active = max_active;
2849
Tejun Heof3421792010-07-02 10:03:51 +02002850 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02002851 struct global_cwq *gcwq = get_gcwq(cpu);
2852
2853 spin_lock_irq(&gcwq->lock);
2854
2855 if (!(wq->flags & WQ_FREEZEABLE) ||
2856 !(gcwq->flags & GCWQ_FREEZING))
2857 get_cwq(gcwq->cpu, wq)->max_active = max_active;
2858
2859 spin_unlock_irq(&gcwq->lock);
2860 }
2861
2862 spin_unlock(&workqueue_lock);
2863}
2864EXPORT_SYMBOL_GPL(workqueue_set_max_active);
2865
2866/**
2867 * workqueue_congested - test whether a workqueue is congested
2868 * @cpu: CPU in question
2869 * @wq: target workqueue
2870 *
2871 * Test whether @wq's cpu workqueue for @cpu is congested. There is
2872 * no synchronization around this function and the test result is
2873 * unreliable and only useful as advisory hints or for debugging.
2874 *
2875 * RETURNS:
2876 * %true if congested, %false otherwise.
2877 */
2878bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
2879{
2880 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
2881
2882 return !list_empty(&cwq->delayed_works);
2883}
2884EXPORT_SYMBOL_GPL(workqueue_congested);
2885
2886/**
2887 * work_cpu - return the last known associated cpu for @work
2888 * @work: the work of interest
2889 *
2890 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002891 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02002892 */
2893unsigned int work_cpu(struct work_struct *work)
2894{
2895 struct global_cwq *gcwq = get_work_gcwq(work);
2896
Tejun Heobdbc5dd2010-07-02 10:03:51 +02002897 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02002898}
2899EXPORT_SYMBOL_GPL(work_cpu);
2900
2901/**
2902 * work_busy - test whether a work is currently pending or running
2903 * @work: the work to be tested
2904 *
2905 * Test whether @work is currently pending or running. There is no
2906 * synchronization around this function and the test result is
2907 * unreliable and only useful as advisory hints or for debugging.
2908 * Especially for reentrant wqs, the pending state might hide the
2909 * running state.
2910 *
2911 * RETURNS:
2912 * OR'd bitmask of WORK_BUSY_* bits.
2913 */
2914unsigned int work_busy(struct work_struct *work)
2915{
2916 struct global_cwq *gcwq = get_work_gcwq(work);
2917 unsigned long flags;
2918 unsigned int ret = 0;
2919
2920 if (!gcwq)
2921 return false;
2922
2923 spin_lock_irqsave(&gcwq->lock, flags);
2924
2925 if (work_pending(work))
2926 ret |= WORK_BUSY_PENDING;
2927 if (find_worker_executing_work(gcwq, work))
2928 ret |= WORK_BUSY_RUNNING;
2929
2930 spin_unlock_irqrestore(&gcwq->lock, flags);
2931
2932 return ret;
2933}
2934EXPORT_SYMBOL_GPL(work_busy);
2935
Tejun Heodb7bccf2010-06-29 10:07:12 +02002936/*
2937 * CPU hotplug.
2938 *
Tejun Heoe22bee72010-06-29 10:07:14 +02002939 * There are two challenges in supporting CPU hotplug. Firstly, there
2940 * are a lot of assumptions on strong associations among work, cwq and
2941 * gcwq which make migrating pending and scheduled works very
2942 * difficult to implement without impacting hot paths. Secondly,
2943 * gcwqs serve mix of short, long and very long running works making
2944 * blocked draining impractical.
2945 *
2946 * This is solved by allowing a gcwq to be detached from CPU, running
2947 * it with unbound (rogue) workers and allowing it to be reattached
2948 * later if the cpu comes back online. A separate thread is created
2949 * to govern a gcwq in such state and is called the trustee of the
2950 * gcwq.
Tejun Heodb7bccf2010-06-29 10:07:12 +02002951 *
2952 * Trustee states and their descriptions.
2953 *
2954 * START Command state used on startup. On CPU_DOWN_PREPARE, a
2955 * new trustee is started with this state.
2956 *
2957 * IN_CHARGE Once started, trustee will enter this state after
Tejun Heoe22bee72010-06-29 10:07:14 +02002958 * assuming the manager role and making all existing
2959 * workers rogue. DOWN_PREPARE waits for trustee to
2960 * enter this state. After reaching IN_CHARGE, trustee
2961 * tries to execute the pending worklist until it's empty
2962 * and the state is set to BUTCHER, or the state is set
2963 * to RELEASE.
Tejun Heodb7bccf2010-06-29 10:07:12 +02002964 *
2965 * BUTCHER Command state which is set by the cpu callback after
2966 * the cpu has went down. Once this state is set trustee
2967 * knows that there will be no new works on the worklist
2968 * and once the worklist is empty it can proceed to
2969 * killing idle workers.
2970 *
2971 * RELEASE Command state which is set by the cpu callback if the
2972 * cpu down has been canceled or it has come online
2973 * again. After recognizing this state, trustee stops
Tejun Heoe22bee72010-06-29 10:07:14 +02002974 * trying to drain or butcher and clears ROGUE, rebinds
2975 * all remaining workers back to the cpu and releases
2976 * manager role.
Tejun Heodb7bccf2010-06-29 10:07:12 +02002977 *
2978 * DONE Trustee will enter this state after BUTCHER or RELEASE
2979 * is complete.
2980 *
2981 * trustee CPU draining
2982 * took over down complete
2983 * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE
2984 * | | ^
2985 * | CPU is back online v return workers |
2986 * ----------------> RELEASE --------------
2987 */
2988
2989/**
2990 * trustee_wait_event_timeout - timed event wait for trustee
2991 * @cond: condition to wait for
2992 * @timeout: timeout in jiffies
2993 *
2994 * wait_event_timeout() for trustee to use. Handles locking and
2995 * checks for RELEASE request.
2996 *
2997 * CONTEXT:
2998 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2999 * multiple times. To be used by trustee.
3000 *
3001 * RETURNS:
3002 * Positive indicating left time if @cond is satisfied, 0 if timed
3003 * out, -1 if canceled.
3004 */
3005#define trustee_wait_event_timeout(cond, timeout) ({ \
3006 long __ret = (timeout); \
3007 while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \
3008 __ret) { \
3009 spin_unlock_irq(&gcwq->lock); \
3010 __wait_event_timeout(gcwq->trustee_wait, (cond) || \
3011 (gcwq->trustee_state == TRUSTEE_RELEASE), \
3012 __ret); \
3013 spin_lock_irq(&gcwq->lock); \
3014 } \
3015 gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret); \
3016})
3017
3018/**
3019 * trustee_wait_event - event wait for trustee
3020 * @cond: condition to wait for
3021 *
3022 * wait_event() for trustee to use. Automatically handles locking and
3023 * checks for CANCEL request.
3024 *
3025 * CONTEXT:
3026 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3027 * multiple times. To be used by trustee.
3028 *
3029 * RETURNS:
3030 * 0 if @cond is satisfied, -1 if canceled.
3031 */
3032#define trustee_wait_event(cond) ({ \
3033 long __ret1; \
3034 __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\
3035 __ret1 < 0 ? -1 : 0; \
3036})
3037
3038static int __cpuinit trustee_thread(void *__gcwq)
3039{
3040 struct global_cwq *gcwq = __gcwq;
3041 struct worker *worker;
Tejun Heoe22bee72010-06-29 10:07:14 +02003042 struct work_struct *work;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003043 struct hlist_node *pos;
Tejun Heoe22bee72010-06-29 10:07:14 +02003044 long rc;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003045 int i;
3046
3047 BUG_ON(gcwq->cpu != smp_processor_id());
3048
3049 spin_lock_irq(&gcwq->lock);
3050 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02003051 * Claim the manager position and make all workers rogue.
3052 * Trustee must be bound to the target cpu and can't be
3053 * cancelled.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003054 */
3055 BUG_ON(gcwq->cpu != smp_processor_id());
Tejun Heoe22bee72010-06-29 10:07:14 +02003056 rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS));
3057 BUG_ON(rc < 0);
3058
3059 gcwq->flags |= GCWQ_MANAGING_WORKERS;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003060
3061 list_for_each_entry(worker, &gcwq->idle_list, entry)
Tejun Heocb444762010-07-02 10:03:50 +02003062 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003063
3064 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heocb444762010-07-02 10:03:50 +02003065 worker->flags |= WORKER_ROGUE;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003066
3067 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02003068 * Call schedule() so that we cross rq->lock and thus can
3069 * guarantee sched callbacks see the rogue flag. This is
3070 * necessary as scheduler callbacks may be invoked from other
3071 * cpus.
3072 */
3073 spin_unlock_irq(&gcwq->lock);
3074 schedule();
3075 spin_lock_irq(&gcwq->lock);
3076
3077 /*
Tejun Heocb444762010-07-02 10:03:50 +02003078 * Sched callbacks are disabled now. Zap nr_running. After
3079 * this, nr_running stays zero and need_more_worker() and
3080 * keep_working() are always true as long as the worklist is
3081 * not empty.
Tejun Heoe22bee72010-06-29 10:07:14 +02003082 */
Tejun Heocb444762010-07-02 10:03:50 +02003083 atomic_set(get_gcwq_nr_running(gcwq->cpu), 0);
Tejun Heoe22bee72010-06-29 10:07:14 +02003084
3085 spin_unlock_irq(&gcwq->lock);
3086 del_timer_sync(&gcwq->idle_timer);
3087 spin_lock_irq(&gcwq->lock);
3088
3089 /*
Tejun Heodb7bccf2010-06-29 10:07:12 +02003090 * We're now in charge. Notify and proceed to drain. We need
3091 * to keep the gcwq running during the whole CPU down
3092 * procedure as other cpu hotunplug callbacks may need to
3093 * flush currently running tasks.
3094 */
3095 gcwq->trustee_state = TRUSTEE_IN_CHARGE;
3096 wake_up_all(&gcwq->trustee_wait);
3097
3098 /*
3099 * The original cpu is in the process of dying and may go away
3100 * anytime now. When that happens, we and all workers would
Tejun Heoe22bee72010-06-29 10:07:14 +02003101 * be migrated to other cpus. Try draining any left work. We
3102 * want to get it over with ASAP - spam rescuers, wake up as
3103 * many idlers as necessary and create new ones till the
3104 * worklist is empty. Note that if the gcwq is frozen, there
3105 * may be frozen works in freezeable cwqs. Don't declare
3106 * completion while frozen.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003107 */
3108 while (gcwq->nr_workers != gcwq->nr_idle ||
3109 gcwq->flags & GCWQ_FREEZING ||
3110 gcwq->trustee_state == TRUSTEE_IN_CHARGE) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003111 int nr_works = 0;
3112
3113 list_for_each_entry(work, &gcwq->worklist, entry) {
3114 send_mayday(work);
3115 nr_works++;
3116 }
3117
3118 list_for_each_entry(worker, &gcwq->idle_list, entry) {
3119 if (!nr_works--)
3120 break;
3121 wake_up_process(worker->task);
3122 }
3123
3124 if (need_to_create_worker(gcwq)) {
3125 spin_unlock_irq(&gcwq->lock);
3126 worker = create_worker(gcwq, false);
3127 spin_lock_irq(&gcwq->lock);
3128 if (worker) {
Tejun Heocb444762010-07-02 10:03:50 +02003129 worker->flags |= WORKER_ROGUE;
Tejun Heoe22bee72010-06-29 10:07:14 +02003130 start_worker(worker);
3131 }
3132 }
3133
Tejun Heodb7bccf2010-06-29 10:07:12 +02003134 /* give a breather */
3135 if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0)
3136 break;
3137 }
3138
Tejun Heoe22bee72010-06-29 10:07:14 +02003139 /*
3140 * Either all works have been scheduled and cpu is down, or
3141 * cpu down has already been canceled. Wait for and butcher
3142 * all workers till we're canceled.
3143 */
3144 do {
3145 rc = trustee_wait_event(!list_empty(&gcwq->idle_list));
3146 while (!list_empty(&gcwq->idle_list))
3147 destroy_worker(list_first_entry(&gcwq->idle_list,
3148 struct worker, entry));
3149 } while (gcwq->nr_workers && rc >= 0);
3150
3151 /*
3152 * At this point, either draining has completed and no worker
3153 * is left, or cpu down has been canceled or the cpu is being
3154 * brought back up. There shouldn't be any idle one left.
3155 * Tell the remaining busy ones to rebind once it finishes the
3156 * currently scheduled works by scheduling the rebind_work.
3157 */
3158 WARN_ON(!list_empty(&gcwq->idle_list));
3159
3160 for_each_busy_worker(worker, i, pos, gcwq) {
3161 struct work_struct *rebind_work = &worker->rebind_work;
3162
3163 /*
3164 * Rebind_work may race with future cpu hotplug
3165 * operations. Use a separate flag to mark that
3166 * rebinding is scheduled.
3167 */
Tejun Heocb444762010-07-02 10:03:50 +02003168 worker->flags |= WORKER_REBIND;
3169 worker->flags &= ~WORKER_ROGUE;
Tejun Heoe22bee72010-06-29 10:07:14 +02003170
3171 /* queue rebind_work, wq doesn't matter, use the default one */
3172 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
3173 work_data_bits(rebind_work)))
3174 continue;
3175
3176 debug_work_activate(rebind_work);
Tejun Heod320c032010-06-29 10:07:14 +02003177 insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work,
Tejun Heoe22bee72010-06-29 10:07:14 +02003178 worker->scheduled.next,
3179 work_color_to_flags(WORK_NO_COLOR));
3180 }
3181
3182 /* relinquish manager role */
3183 gcwq->flags &= ~GCWQ_MANAGING_WORKERS;
3184
Tejun Heodb7bccf2010-06-29 10:07:12 +02003185 /* notify completion */
3186 gcwq->trustee = NULL;
3187 gcwq->trustee_state = TRUSTEE_DONE;
3188 wake_up_all(&gcwq->trustee_wait);
3189 spin_unlock_irq(&gcwq->lock);
3190 return 0;
3191}
3192
3193/**
3194 * wait_trustee_state - wait for trustee to enter the specified state
3195 * @gcwq: gcwq the trustee of interest belongs to
3196 * @state: target state to wait for
3197 *
3198 * Wait for the trustee to reach @state. DONE is already matched.
3199 *
3200 * CONTEXT:
3201 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
3202 * multiple times. To be used by cpu_callback.
3203 */
3204static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state)
3205{
3206 if (!(gcwq->trustee_state == state ||
3207 gcwq->trustee_state == TRUSTEE_DONE)) {
3208 spin_unlock_irq(&gcwq->lock);
3209 __wait_event(gcwq->trustee_wait,
3210 gcwq->trustee_state == state ||
3211 gcwq->trustee_state == TRUSTEE_DONE);
3212 spin_lock_irq(&gcwq->lock);
3213 }
3214}
3215
Oleg Nesterov3af244332007-05-09 02:34:09 -07003216static int __devinit workqueue_cpu_callback(struct notifier_block *nfb,
3217 unsigned long action,
3218 void *hcpu)
3219{
3220 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003221 struct global_cwq *gcwq = get_gcwq(cpu);
3222 struct task_struct *new_trustee = NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +02003223 struct worker *uninitialized_var(new_worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003224 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003225
Rafael J. Wysocki8bb78442007-05-09 02:35:10 -07003226 action &= ~CPU_TASKS_FROZEN;
3227
Tejun Heodb7bccf2010-06-29 10:07:12 +02003228 switch (action) {
3229 case CPU_DOWN_PREPARE:
3230 new_trustee = kthread_create(trustee_thread, gcwq,
3231 "workqueue_trustee/%d\n", cpu);
3232 if (IS_ERR(new_trustee))
3233 return notifier_from_errno(PTR_ERR(new_trustee));
3234 kthread_bind(new_trustee, cpu);
Tejun Heoe22bee72010-06-29 10:07:14 +02003235 /* fall through */
3236 case CPU_UP_PREPARE:
3237 BUG_ON(gcwq->first_idle);
3238 new_worker = create_worker(gcwq, false);
3239 if (!new_worker) {
3240 if (new_trustee)
3241 kthread_stop(new_trustee);
3242 return NOTIFY_BAD;
3243 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003244 }
3245
Tejun Heodb7bccf2010-06-29 10:07:12 +02003246 /* some are called w/ irq disabled, don't disturb irq status */
3247 spin_lock_irqsave(&gcwq->lock, flags);
3248
3249 switch (action) {
3250 case CPU_DOWN_PREPARE:
3251 /* initialize trustee and tell it to acquire the gcwq */
3252 BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE);
3253 gcwq->trustee = new_trustee;
3254 gcwq->trustee_state = TRUSTEE_START;
3255 wake_up_process(gcwq->trustee);
3256 wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE);
Tejun Heoe22bee72010-06-29 10:07:14 +02003257 /* fall through */
3258 case CPU_UP_PREPARE:
3259 BUG_ON(gcwq->first_idle);
3260 gcwq->first_idle = new_worker;
3261 break;
3262
3263 case CPU_DYING:
3264 /*
3265 * Before this, the trustee and all workers except for
3266 * the ones which are still executing works from
3267 * before the last CPU down must be on the cpu. After
3268 * this, they'll all be diasporas.
3269 */
3270 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003271 break;
3272
3273 case CPU_POST_DEAD:
3274 gcwq->trustee_state = TRUSTEE_BUTCHER;
Tejun Heoe22bee72010-06-29 10:07:14 +02003275 /* fall through */
3276 case CPU_UP_CANCELED:
3277 destroy_worker(gcwq->first_idle);
3278 gcwq->first_idle = NULL;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003279 break;
3280
3281 case CPU_DOWN_FAILED:
3282 case CPU_ONLINE:
Tejun Heoe22bee72010-06-29 10:07:14 +02003283 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003284 if (gcwq->trustee_state != TRUSTEE_DONE) {
3285 gcwq->trustee_state = TRUSTEE_RELEASE;
3286 wake_up_process(gcwq->trustee);
3287 wait_trustee_state(gcwq, TRUSTEE_DONE);
3288 }
3289
Tejun Heoe22bee72010-06-29 10:07:14 +02003290 /*
3291 * Trustee is done and there might be no worker left.
3292 * Put the first_idle in and request a real manager to
3293 * take a look.
3294 */
3295 spin_unlock_irq(&gcwq->lock);
3296 kthread_bind(gcwq->first_idle->task, cpu);
3297 spin_lock_irq(&gcwq->lock);
3298 gcwq->flags |= GCWQ_MANAGE_WORKERS;
3299 start_worker(gcwq->first_idle);
3300 gcwq->first_idle = NULL;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003301 break;
3302 }
3303
3304 spin_unlock_irqrestore(&gcwq->lock, flags);
3305
Tejun Heo15376632010-06-29 10:07:11 +02003306 return notifier_from_errno(0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003307}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003308
Rusty Russell2d3854a2008-11-05 13:39:10 +11003309#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003310
Rusty Russell2d3854a2008-11-05 13:39:10 +11003311struct work_for_cpu {
Andrew Morton6b44003e2009-04-09 09:50:37 -06003312 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003313 long (*fn)(void *);
3314 void *arg;
3315 long ret;
3316};
3317
Andrew Morton6b44003e2009-04-09 09:50:37 -06003318static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003319{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003320 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003321 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b44003e2009-04-09 09:50:37 -06003322 complete(&wfc->completion);
3323 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003324}
3325
3326/**
3327 * work_on_cpu - run a function in user context on a particular cpu
3328 * @cpu: the cpu to run on
3329 * @fn: the function to run
3330 * @arg: the function arg
3331 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003332 * This will return the value @fn returns.
3333 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06003334 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003335 */
3336long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3337{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003338 struct task_struct *sub_thread;
3339 struct work_for_cpu wfc = {
3340 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3341 .fn = fn,
3342 .arg = arg,
3343 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003344
Andrew Morton6b44003e2009-04-09 09:50:37 -06003345 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3346 if (IS_ERR(sub_thread))
3347 return PTR_ERR(sub_thread);
3348 kthread_bind(sub_thread, cpu);
3349 wake_up_process(sub_thread);
3350 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003351 return wfc.ret;
3352}
3353EXPORT_SYMBOL_GPL(work_on_cpu);
3354#endif /* CONFIG_SMP */
3355
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003356#ifdef CONFIG_FREEZER
3357
3358/**
3359 * freeze_workqueues_begin - begin freezing workqueues
3360 *
3361 * Start freezing workqueues. After this function returns, all
3362 * freezeable workqueues will queue new works to their frozen_works
Tejun Heo7e116292010-06-29 10:07:13 +02003363 * list instead of gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003364 *
3365 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003366 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003367 */
3368void freeze_workqueues_begin(void)
3369{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003370 unsigned int cpu;
3371
3372 spin_lock(&workqueue_lock);
3373
3374 BUG_ON(workqueue_freezing);
3375 workqueue_freezing = true;
3376
Tejun Heof3421792010-07-02 10:03:51 +02003377 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003378 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003379 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003380
3381 spin_lock_irq(&gcwq->lock);
3382
Tejun Heodb7bccf2010-06-29 10:07:12 +02003383 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3384 gcwq->flags |= GCWQ_FREEZING;
3385
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003386 list_for_each_entry(wq, &workqueues, list) {
3387 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3388
Tejun Heof3421792010-07-02 10:03:51 +02003389 if (cwq && wq->flags & WQ_FREEZEABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003390 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003391 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003392
3393 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003394 }
3395
3396 spin_unlock(&workqueue_lock);
3397}
3398
3399/**
3400 * freeze_workqueues_busy - are freezeable workqueues still busy?
3401 *
3402 * Check whether freezing is complete. This function must be called
3403 * between freeze_workqueues_begin() and thaw_workqueues().
3404 *
3405 * CONTEXT:
3406 * Grabs and releases workqueue_lock.
3407 *
3408 * RETURNS:
3409 * %true if some freezeable workqueues are still busy. %false if
3410 * freezing is complete.
3411 */
3412bool freeze_workqueues_busy(void)
3413{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003414 unsigned int cpu;
3415 bool busy = false;
3416
3417 spin_lock(&workqueue_lock);
3418
3419 BUG_ON(!workqueue_freezing);
3420
Tejun Heof3421792010-07-02 10:03:51 +02003421 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003422 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003423 /*
3424 * nr_active is monotonically decreasing. It's safe
3425 * to peek without lock.
3426 */
3427 list_for_each_entry(wq, &workqueues, list) {
3428 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3429
Tejun Heof3421792010-07-02 10:03:51 +02003430 if (!cwq || !(wq->flags & WQ_FREEZEABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003431 continue;
3432
3433 BUG_ON(cwq->nr_active < 0);
3434 if (cwq->nr_active) {
3435 busy = true;
3436 goto out_unlock;
3437 }
3438 }
3439 }
3440out_unlock:
3441 spin_unlock(&workqueue_lock);
3442 return busy;
3443}
3444
3445/**
3446 * thaw_workqueues - thaw workqueues
3447 *
3448 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003449 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003450 *
3451 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003452 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003453 */
3454void thaw_workqueues(void)
3455{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003456 unsigned int cpu;
3457
3458 spin_lock(&workqueue_lock);
3459
3460 if (!workqueue_freezing)
3461 goto out_unlock;
3462
Tejun Heof3421792010-07-02 10:03:51 +02003463 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003464 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003465 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003466
3467 spin_lock_irq(&gcwq->lock);
3468
Tejun Heodb7bccf2010-06-29 10:07:12 +02003469 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3470 gcwq->flags &= ~GCWQ_FREEZING;
3471
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003472 list_for_each_entry(wq, &workqueues, list) {
3473 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3474
Tejun Heof3421792010-07-02 10:03:51 +02003475 if (!cwq || !(wq->flags & WQ_FREEZEABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003476 continue;
3477
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003478 /* restore max_active and repopulate worklist */
3479 cwq->max_active = wq->saved_max_active;
3480
3481 while (!list_empty(&cwq->delayed_works) &&
3482 cwq->nr_active < cwq->max_active)
3483 cwq_activate_first_delayed(cwq);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003484 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003485
Tejun Heoe22bee72010-06-29 10:07:14 +02003486 wake_up_worker(gcwq);
3487
Tejun Heo8b03ae32010-06-29 10:07:12 +02003488 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003489 }
3490
3491 workqueue_freezing = false;
3492out_unlock:
3493 spin_unlock(&workqueue_lock);
3494}
3495#endif /* CONFIG_FREEZER */
3496
Oleg Nesterovc12920d2007-05-09 02:34:14 -07003497void __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003498{
Tejun Heoc34056a2010-06-29 10:07:11 +02003499 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003500 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02003501
Tejun Heodb7bccf2010-06-29 10:07:12 +02003502 hotcpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003503
3504 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003505 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003506 struct global_cwq *gcwq = get_gcwq(cpu);
3507
3508 spin_lock_init(&gcwq->lock);
Tejun Heo7e116292010-06-29 10:07:13 +02003509 INIT_LIST_HEAD(&gcwq->worklist);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003510 gcwq->cpu = cpu;
Tejun Heof3421792010-07-02 10:03:51 +02003511 if (cpu == WORK_CPU_UNBOUND)
3512 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003513
Tejun Heoc8e55f32010-06-29 10:07:12 +02003514 INIT_LIST_HEAD(&gcwq->idle_list);
3515 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3516 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3517
Tejun Heoe22bee72010-06-29 10:07:14 +02003518 init_timer_deferrable(&gcwq->idle_timer);
3519 gcwq->idle_timer.function = idle_worker_timeout;
3520 gcwq->idle_timer.data = (unsigned long)gcwq;
3521
3522 setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout,
3523 (unsigned long)gcwq);
3524
Tejun Heo8b03ae32010-06-29 10:07:12 +02003525 ida_init(&gcwq->worker_ida);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003526
3527 gcwq->trustee_state = TRUSTEE_DONE;
3528 init_waitqueue_head(&gcwq->trustee_wait);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003529 }
3530
Tejun Heoe22bee72010-06-29 10:07:14 +02003531 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003532 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003533 struct global_cwq *gcwq = get_gcwq(cpu);
3534 struct worker *worker;
3535
3536 worker = create_worker(gcwq, true);
3537 BUG_ON(!worker);
3538 spin_lock_irq(&gcwq->lock);
3539 start_worker(worker);
3540 spin_unlock_irq(&gcwq->lock);
3541 }
3542
Tejun Heod320c032010-06-29 10:07:14 +02003543 system_wq = alloc_workqueue("events", 0, 0);
3544 system_long_wq = alloc_workqueue("events_long", 0, 0);
3545 system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003546 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3547 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heod320c032010-06-29 10:07:14 +02003548 BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003549}