blob: d2fe8e77ceb70d781ec0806c8cf5a4d86ea98483 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
19 * automatically managed. There is one worker pool for each CPU and
20 * one extra for works which are better served by workers which are
21 * not bound to any specific CPU.
22 *
23 * Please read Documentation/workqueue.txt for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 */
25
Paul Gortmaker9984de12011-05-23 14:51:41 -040026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/kernel.h>
28#include <linux/sched.h>
29#include <linux/init.h>
30#include <linux/signal.h>
31#include <linux/completion.h>
32#include <linux/workqueue.h>
33#include <linux/slab.h>
34#include <linux/cpu.h>
35#include <linux/notifier.h>
36#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060037#include <linux/hardirq.h>
Christoph Lameter46934022006-10-11 01:21:26 -070038#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080039#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080040#include <linux/kallsyms.h>
41#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070042#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020043#include <linux/idr.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020044
45#include "workqueue_sched.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Tejun Heoc8e55f32010-06-29 10:07:12 +020047enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070048 /*
49 * global_cwq flags
50 *
51 * A bound gcwq is either associated or disassociated with its CPU.
52 * While associated (!DISASSOCIATED), all workers are bound to the
53 * CPU and none has %WORKER_UNBOUND set and concurrency management
54 * is in effect.
55 *
56 * While DISASSOCIATED, the cpu may be offline and all workers have
57 * %WORKER_UNBOUND set and concurrency management disabled, and may
58 * be executing on any CPU. The gcwq behaves as an unbound one.
59 *
60 * Note that DISASSOCIATED can be flipped only while holding
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -070061 * assoc_mutex of all pools on the gcwq to avoid changing binding
Tejun Heobc2ae0f2012-07-17 12:39:27 -070062 * state while create_worker() is in progress.
63 */
Tejun Heo11ebea52012-07-12 14:46:37 -070064 GCWQ_DISASSOCIATED = 1 << 0, /* cpu can't serve workers */
65 GCWQ_FREEZING = 1 << 1, /* freeze in progress */
66
67 /* pool flags */
68 POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
Lai Jiangshan552a37e2012-09-10 10:03:33 -070069 POOL_MANAGING_WORKERS = 1 << 1, /* managing workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020070
Tejun Heoc8e55f32010-06-29 10:07:12 +020071 /* worker flags */
72 WORKER_STARTED = 1 << 0, /* started */
73 WORKER_DIE = 1 << 1, /* die die die */
74 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020075 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020076 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020077 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoe22bee72010-06-29 10:07:14 +020078
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -070079 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_UNBOUND |
Tejun Heo403c8212012-07-17 12:39:27 -070080 WORKER_CPU_INTENSIVE,
Tejun Heodb7bccf2010-06-29 10:07:12 +020081
Tejun Heo32704762012-07-13 22:16:45 -070082 NR_WORKER_POOLS = 2, /* # worker pools per gcwq */
Tejun Heo4ce62e92012-07-13 22:16:44 -070083
Tejun Heoc8e55f32010-06-29 10:07:12 +020084 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
85 BUSY_WORKER_HASH_SIZE = 1 << BUSY_WORKER_HASH_ORDER,
86 BUSY_WORKER_HASH_MASK = BUSY_WORKER_HASH_SIZE - 1,
Tejun Heodb7bccf2010-06-29 10:07:12 +020087
Tejun Heoe22bee72010-06-29 10:07:14 +020088 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
89 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
90
Tejun Heo3233cdb2011-02-16 18:10:19 +010091 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
92 /* call for help after 10ms
93 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020094 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
95 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020096
97 /*
98 * Rescue workers are used only on emergencies and shared by
99 * all cpus. Give -20.
100 */
101 RESCUER_NICE_LEVEL = -20,
Tejun Heo32704762012-07-13 22:16:45 -0700102 HIGHPRI_NICE_LEVEL = -20,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200103};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200106 * Structure fields follow one of the following exclusion rules.
107 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200108 * I: Modifiable by initialization/destruction paths and read-only for
109 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200110 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200111 * P: Preemption protected. Disabling preemption is enough and should
112 * only be modified and accessed from the local cpu.
113 *
Tejun Heo8b03ae32010-06-29 10:07:12 +0200114 * L: gcwq->lock protected. Access with gcwq->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200115 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200116 * X: During normal operation, modification requires gcwq->lock and
117 * should be done only from local cpu. Either disabling preemption
118 * on local cpu or grabbing gcwq->lock is enough for read access.
Tejun Heof3421792010-07-02 10:03:51 +0200119 * If GCWQ_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200120 *
Tejun Heo73f53c42010-06-29 10:07:11 +0200121 * F: wq->flush_mutex protected.
122 *
Tejun Heo4690c4a2010-06-29 10:07:10 +0200123 * W: workqueue_lock protected.
124 */
125
Tejun Heo8b03ae32010-06-29 10:07:12 +0200126struct global_cwq;
Tejun Heobd7bdd42012-07-12 14:46:37 -0700127struct worker_pool;
Tejun Heoc34056a2010-06-29 10:07:11 +0200128
Tejun Heoe22bee72010-06-29 10:07:14 +0200129/*
130 * The poor guys doing the actual heavy lifting. All on-duty workers
131 * are either serving the manager role, on idle list or on busy hash.
132 */
Tejun Heoc34056a2010-06-29 10:07:11 +0200133struct worker {
Tejun Heoc8e55f32010-06-29 10:07:12 +0200134 /* on idle list while idle, on busy hash table while busy */
135 union {
136 struct list_head entry; /* L: while idle */
137 struct hlist_node hentry; /* L: while busy */
138 };
139
Tejun Heoc34056a2010-06-29 10:07:11 +0200140 struct work_struct *current_work; /* L: work being processed */
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200141 struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
Tejun Heoaffee4b2010-06-29 10:07:12 +0200142 struct list_head scheduled; /* L: scheduled works */
Tejun Heoc34056a2010-06-29 10:07:11 +0200143 struct task_struct *task; /* I: worker task */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700144 struct worker_pool *pool; /* I: the associated pool */
Tejun Heoe22bee72010-06-29 10:07:14 +0200145 /* 64 bytes boundary on 64bit, 32 on 32bit */
146 unsigned long last_active; /* L: last active timestamp */
147 unsigned int flags; /* X: flags */
Tejun Heoc34056a2010-06-29 10:07:11 +0200148 int id; /* I: worker id */
Tejun Heo25511a42012-07-17 12:39:27 -0700149
150 /* for rebinding worker to CPU */
Tejun Heo25511a42012-07-17 12:39:27 -0700151 struct work_struct rebind_work; /* L: for busy worker */
Tejun Heoc34056a2010-06-29 10:07:11 +0200152};
153
Tejun Heobd7bdd42012-07-12 14:46:37 -0700154struct worker_pool {
155 struct global_cwq *gcwq; /* I: the owning gcwq */
Tejun Heo11ebea52012-07-12 14:46:37 -0700156 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700157
158 struct list_head worklist; /* L: list of pending works */
159 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700160
161 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700162 int nr_idle; /* L: currently idle ones */
163
164 struct list_head idle_list; /* X: list of idle workers */
165 struct timer_list idle_timer; /* L: worker idle timeout */
166 struct timer_list mayday_timer; /* L: SOS timer for workers */
167
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -0700168 struct mutex assoc_mutex; /* protect GCWQ_DISASSOCIATED */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700169 struct ida worker_ida; /* L: for worker IDs */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700170};
171
Tejun Heo4690c4a2010-06-29 10:07:10 +0200172/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200173 * Global per-cpu workqueue. There's one and only one for each cpu
174 * and all works are queued and processed here regardless of their
175 * target workqueues.
Tejun Heo8b03ae32010-06-29 10:07:12 +0200176 */
177struct global_cwq {
178 spinlock_t lock; /* the gcwq lock */
179 unsigned int cpu; /* I: the associated cpu */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200180 unsigned int flags; /* L: GCWQ_* flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200181
Tejun Heobd7bdd42012-07-12 14:46:37 -0700182 /* workers are chained either in busy_hash or pool idle_list */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200183 struct hlist_head busy_hash[BUSY_WORKER_HASH_SIZE];
184 /* L: hash of busy workers */
185
Joonsoo Kim330dad52012-08-15 23:25:36 +0900186 struct worker_pool pools[NR_WORKER_POOLS];
187 /* normal and highpri pools */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200188} ____cacheline_aligned_in_smp;
189
190/*
Tejun Heo502ca9d2010-06-29 10:07:13 +0200191 * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of
Tejun Heo0f900042010-06-29 10:07:11 +0200192 * work_struct->data are used for flags and thus cwqs need to be
193 * aligned at two's power of the number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 */
195struct cpu_workqueue_struct {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700196 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200197 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200198 int work_color; /* L: current color */
199 int flush_color; /* L: flushing color */
200 int nr_in_flight[WORK_NR_COLORS];
201 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200202 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200203 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200204 struct list_head delayed_works; /* L: delayed works */
Tejun Heo0f900042010-06-29 10:07:11 +0200205};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200208 * Structure used to wait for workqueue flush.
209 */
210struct wq_flusher {
211 struct list_head list; /* F: list of flushers */
212 int flush_color; /* F: flush color waiting for */
213 struct completion done; /* flush completion */
214};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Tejun Heo73f53c42010-06-29 10:07:11 +0200216/*
Tejun Heof2e005a2010-07-20 15:59:09 +0200217 * All cpumasks are assumed to be always set on UP and thus can't be
218 * used to determine whether there's something to be done.
219 */
220#ifdef CONFIG_SMP
221typedef cpumask_var_t mayday_mask_t;
222#define mayday_test_and_set_cpu(cpu, mask) \
223 cpumask_test_and_set_cpu((cpu), (mask))
224#define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask))
225#define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask))
Tejun Heo9c375472010-08-31 11:18:34 +0200226#define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp))
Tejun Heof2e005a2010-07-20 15:59:09 +0200227#define free_mayday_mask(mask) free_cpumask_var((mask))
228#else
229typedef unsigned long mayday_mask_t;
230#define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask))
231#define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask))
232#define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask))
233#define alloc_mayday_mask(maskp, gfp) true
234#define free_mayday_mask(mask) do { } while (0)
235#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
237/*
238 * The externally visible workqueue abstraction is an array of
239 * per-CPU workqueues:
240 */
241struct workqueue_struct {
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200242 unsigned int flags; /* W: WQ_* flags */
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200243 union {
244 struct cpu_workqueue_struct __percpu *pcpu;
245 struct cpu_workqueue_struct *single;
246 unsigned long v;
247 } cpu_wq; /* I: cwq's */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200248 struct list_head list; /* W: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200249
250 struct mutex flush_mutex; /* protects wq flushing */
251 int work_color; /* F: current work color */
252 int flush_color; /* F: current flush color */
253 atomic_t nr_cwqs_to_flush; /* flush in progress */
254 struct wq_flusher *first_flusher; /* F: first flusher */
255 struct list_head flusher_queue; /* F: flush waiters */
256 struct list_head flusher_overflow; /* F: flush overflow list */
257
Tejun Heof2e005a2010-07-20 15:59:09 +0200258 mayday_mask_t mayday_mask; /* cpus requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200259 struct worker *rescuer; /* I: rescue worker */
260
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200261 int nr_drainers; /* W: drain in progress */
Tejun Heodcd989c2010-06-29 10:07:14 +0200262 int saved_max_active; /* W: saved cwq max_active */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700263#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200264 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700265#endif
Tejun Heob196be82012-01-10 15:11:35 -0800266 char name[]; /* I: workqueue name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267};
268
Tejun Heod320c032010-06-29 10:07:14 +0200269struct workqueue_struct *system_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200270EXPORT_SYMBOL_GPL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300271struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900272EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300273struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200274EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300275struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200276EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300277struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100278EXPORT_SYMBOL_GPL(system_freezable_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200279
Tejun Heo97bd2342010-10-05 10:41:14 +0200280#define CREATE_TRACE_POINTS
281#include <trace/events/workqueue.h>
282
Tejun Heo4ce62e92012-07-13 22:16:44 -0700283#define for_each_worker_pool(pool, gcwq) \
Tejun Heo32704762012-07-13 22:16:45 -0700284 for ((pool) = &(gcwq)->pools[0]; \
285 (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700286
Tejun Heodb7bccf2010-06-29 10:07:12 +0200287#define for_each_busy_worker(worker, i, pos, gcwq) \
288 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \
289 hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry)
290
Tejun Heof3421792010-07-02 10:03:51 +0200291static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
292 unsigned int sw)
293{
294 if (cpu < nr_cpu_ids) {
295 if (sw & 1) {
296 cpu = cpumask_next(cpu, mask);
297 if (cpu < nr_cpu_ids)
298 return cpu;
299 }
300 if (sw & 2)
301 return WORK_CPU_UNBOUND;
302 }
303 return WORK_CPU_NONE;
304}
305
306static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
307 struct workqueue_struct *wq)
308{
309 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
310}
311
Tejun Heo09884952010-08-01 11:50:12 +0200312/*
313 * CPU iterators
314 *
315 * An extra gcwq is defined for an invalid cpu number
316 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
317 * specific CPU. The following iterators are similar to
318 * for_each_*_cpu() iterators but also considers the unbound gcwq.
319 *
320 * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
321 * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
322 * for_each_cwq_cpu() : possible CPUs for bound workqueues,
323 * WORK_CPU_UNBOUND for unbound workqueues
324 */
Tejun Heof3421792010-07-02 10:03:51 +0200325#define for_each_gcwq_cpu(cpu) \
326 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
327 (cpu) < WORK_CPU_NONE; \
328 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
329
330#define for_each_online_gcwq_cpu(cpu) \
331 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
332 (cpu) < WORK_CPU_NONE; \
333 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
334
335#define for_each_cwq_cpu(cpu, wq) \
336 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
337 (cpu) < WORK_CPU_NONE; \
338 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
339
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900340#ifdef CONFIG_DEBUG_OBJECTS_WORK
341
342static struct debug_obj_descr work_debug_descr;
343
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100344static void *work_debug_hint(void *addr)
345{
346 return ((struct work_struct *) addr)->func;
347}
348
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900349/*
350 * fixup_init is called when:
351 * - an active object is initialized
352 */
353static int work_fixup_init(void *addr, enum debug_obj_state state)
354{
355 struct work_struct *work = addr;
356
357 switch (state) {
358 case ODEBUG_STATE_ACTIVE:
359 cancel_work_sync(work);
360 debug_object_init(work, &work_debug_descr);
361 return 1;
362 default:
363 return 0;
364 }
365}
366
367/*
368 * fixup_activate is called when:
369 * - an active object is activated
370 * - an unknown object is activated (might be a statically initialized object)
371 */
372static int work_fixup_activate(void *addr, enum debug_obj_state state)
373{
374 struct work_struct *work = addr;
375
376 switch (state) {
377
378 case ODEBUG_STATE_NOTAVAILABLE:
379 /*
380 * This is not really a fixup. The work struct was
381 * statically initialized. We just make sure that it
382 * is tracked in the object tracker.
383 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200384 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900385 debug_object_init(work, &work_debug_descr);
386 debug_object_activate(work, &work_debug_descr);
387 return 0;
388 }
389 WARN_ON_ONCE(1);
390 return 0;
391
392 case ODEBUG_STATE_ACTIVE:
393 WARN_ON(1);
394
395 default:
396 return 0;
397 }
398}
399
400/*
401 * fixup_free is called when:
402 * - an active object is freed
403 */
404static int work_fixup_free(void *addr, enum debug_obj_state state)
405{
406 struct work_struct *work = addr;
407
408 switch (state) {
409 case ODEBUG_STATE_ACTIVE:
410 cancel_work_sync(work);
411 debug_object_free(work, &work_debug_descr);
412 return 1;
413 default:
414 return 0;
415 }
416}
417
418static struct debug_obj_descr work_debug_descr = {
419 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100420 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900421 .fixup_init = work_fixup_init,
422 .fixup_activate = work_fixup_activate,
423 .fixup_free = work_fixup_free,
424};
425
426static inline void debug_work_activate(struct work_struct *work)
427{
428 debug_object_activate(work, &work_debug_descr);
429}
430
431static inline void debug_work_deactivate(struct work_struct *work)
432{
433 debug_object_deactivate(work, &work_debug_descr);
434}
435
436void __init_work(struct work_struct *work, int onstack)
437{
438 if (onstack)
439 debug_object_init_on_stack(work, &work_debug_descr);
440 else
441 debug_object_init(work, &work_debug_descr);
442}
443EXPORT_SYMBOL_GPL(__init_work);
444
445void destroy_work_on_stack(struct work_struct *work)
446{
447 debug_object_free(work, &work_debug_descr);
448}
449EXPORT_SYMBOL_GPL(destroy_work_on_stack);
450
451#else
452static inline void debug_work_activate(struct work_struct *work) { }
453static inline void debug_work_deactivate(struct work_struct *work) { }
454#endif
455
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100456/* Serializes the accesses to the list of workqueues. */
457static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200459static bool workqueue_freezing; /* W: have wqs started freezing? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
Oleg Nesterov14441962007-05-23 13:57:57 -0700461/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200462 * The almighty global cpu workqueues. nr_running is the only field
463 * which is expected to be used frequently by other cpus via
464 * try_to_wake_up(). Put it in a separate cacheline.
Oleg Nesterov14441962007-05-23 13:57:57 -0700465 */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200466static DEFINE_PER_CPU(struct global_cwq, global_cwq);
Tejun Heo4ce62e92012-07-13 22:16:44 -0700467static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
Nathan Lynchf756d5e2006-01-08 01:05:12 -0800468
Tejun Heof3421792010-07-02 10:03:51 +0200469/*
470 * Global cpu workqueue and nr_running counter for unbound gcwq. The
471 * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
472 * workers have WORKER_UNBOUND set.
473 */
474static struct global_cwq unbound_global_cwq;
Tejun Heo4ce62e92012-07-13 22:16:44 -0700475static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
476 [0 ... NR_WORKER_POOLS - 1] = ATOMIC_INIT(0), /* always 0 */
477};
Tejun Heof3421792010-07-02 10:03:51 +0200478
Tejun Heoc34056a2010-06-29 10:07:11 +0200479static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
Tejun Heo32704762012-07-13 22:16:45 -0700481static int worker_pool_pri(struct worker_pool *pool)
482{
483 return pool - pool->gcwq->pools;
484}
485
Tejun Heo8b03ae32010-06-29 10:07:12 +0200486static struct global_cwq *get_gcwq(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487{
Tejun Heof3421792010-07-02 10:03:51 +0200488 if (cpu != WORK_CPU_UNBOUND)
489 return &per_cpu(global_cwq, cpu);
490 else
491 return &unbound_global_cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492}
493
Tejun Heo63d95a92012-07-12 14:46:37 -0700494static atomic_t *get_pool_nr_running(struct worker_pool *pool)
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700495{
Tejun Heo63d95a92012-07-12 14:46:37 -0700496 int cpu = pool->gcwq->cpu;
Tejun Heo32704762012-07-13 22:16:45 -0700497 int idx = worker_pool_pri(pool);
Tejun Heo63d95a92012-07-12 14:46:37 -0700498
Tejun Heof3421792010-07-02 10:03:51 +0200499 if (cpu != WORK_CPU_UNBOUND)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700500 return &per_cpu(pool_nr_running, cpu)[idx];
Tejun Heof3421792010-07-02 10:03:51 +0200501 else
Tejun Heo4ce62e92012-07-13 22:16:44 -0700502 return &unbound_pool_nr_running[idx];
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700503}
504
Tejun Heo4690c4a2010-06-29 10:07:10 +0200505static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
506 struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700507{
Tejun Heof3421792010-07-02 10:03:51 +0200508 if (!(wq->flags & WQ_UNBOUND)) {
Lai Jiangshane06ffa12012-03-09 18:03:20 +0800509 if (likely(cpu < nr_cpu_ids))
Tejun Heof3421792010-07-02 10:03:51 +0200510 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
Tejun Heof3421792010-07-02 10:03:51 +0200511 } else if (likely(cpu == WORK_CPU_UNBOUND))
512 return wq->cpu_wq.single;
513 return NULL;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700514}
515
Tejun Heo73f53c42010-06-29 10:07:11 +0200516static unsigned int work_color_to_flags(int color)
517{
518 return color << WORK_STRUCT_COLOR_SHIFT;
519}
520
521static int get_work_color(struct work_struct *work)
522{
523 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
524 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
525}
526
527static int work_next_color(int color)
528{
529 return (color + 1) % WORK_NR_COLORS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530}
531
David Howells4594bf12006-12-07 11:33:26 +0000532/*
Tejun Heob5490072012-08-03 10:30:46 -0700533 * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
534 * contain the pointer to the queued cwq. Once execution starts, the flag
535 * is cleared and the high bits contain OFFQ flags and CPU number.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200536 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700537 * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
538 * and clear_work_data() can be used to set the cwq, cpu or clear
539 * work->data. These functions should only be called while the work is
540 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200541 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700542 * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
543 * a work. gcwq is available once the work has been queued anywhere after
544 * initialization until it is sync canceled. cwq is available only while
545 * the work item is queued.
546 *
547 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
548 * canceled. While being canceled, a work item may have its PENDING set
549 * but stay off timer and worklist for arbitrarily long and nobody should
550 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000551 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200552static inline void set_work_data(struct work_struct *work, unsigned long data,
553 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000554{
David Howells4594bf12006-12-07 11:33:26 +0000555 BUG_ON(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200556 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000557}
David Howells365970a2006-11-22 14:54:49 +0000558
Tejun Heo7a22ad72010-06-29 10:07:13 +0200559static void set_work_cwq(struct work_struct *work,
560 struct cpu_workqueue_struct *cwq,
561 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200562{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200563 set_work_data(work, (unsigned long)cwq,
Tejun Heoe1201532010-07-22 14:14:25 +0200564 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200565}
566
Tejun Heo8930cab2012-08-03 10:30:45 -0700567static void set_work_cpu_and_clear_pending(struct work_struct *work,
568 unsigned int cpu)
David Howells365970a2006-11-22 14:54:49 +0000569{
Tejun Heo23657bb2012-08-13 17:08:19 -0700570 /*
571 * The following wmb is paired with the implied mb in
572 * test_and_set_bit(PENDING) and ensures all updates to @work made
573 * here are visible to and precede any updates by the next PENDING
574 * owner.
575 */
576 smp_wmb();
Tejun Heob5490072012-08-03 10:30:46 -0700577 set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200578}
579
580static void clear_work_data(struct work_struct *work)
581{
Tejun Heo23657bb2012-08-13 17:08:19 -0700582 smp_wmb(); /* see set_work_cpu_and_clear_pending() */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200583 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
584}
585
Tejun Heo7a22ad72010-06-29 10:07:13 +0200586static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
587{
Tejun Heoe1201532010-07-22 14:14:25 +0200588 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200589
Tejun Heoe1201532010-07-22 14:14:25 +0200590 if (data & WORK_STRUCT_CWQ)
591 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
592 else
593 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200594}
595
596static struct global_cwq *get_work_gcwq(struct work_struct *work)
597{
Tejun Heoe1201532010-07-22 14:14:25 +0200598 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200599 unsigned int cpu;
600
Tejun Heoe1201532010-07-22 14:14:25 +0200601 if (data & WORK_STRUCT_CWQ)
602 return ((struct cpu_workqueue_struct *)
Tejun Heobd7bdd42012-07-12 14:46:37 -0700603 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200604
Tejun Heob5490072012-08-03 10:30:46 -0700605 cpu = data >> WORK_OFFQ_CPU_SHIFT;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200606 if (cpu == WORK_CPU_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200607 return NULL;
608
Tejun Heof3421792010-07-02 10:03:51 +0200609 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200610 return get_gcwq(cpu);
David Howells365970a2006-11-22 14:54:49 +0000611}
612
Tejun Heobbb68df2012-08-03 10:30:46 -0700613static void mark_work_canceling(struct work_struct *work)
614{
615 struct global_cwq *gcwq = get_work_gcwq(work);
616 unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
617
618 set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
619 WORK_STRUCT_PENDING);
620}
621
622static bool work_is_canceling(struct work_struct *work)
623{
624 unsigned long data = atomic_long_read(&work->data);
625
626 return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
627}
628
David Howells365970a2006-11-22 14:54:49 +0000629/*
Tejun Heo32704762012-07-13 22:16:45 -0700630 * Policy functions. These define the policies on how the global worker
631 * pools are managed. Unless noted otherwise, these functions assume that
632 * they're being called with gcwq->lock held.
David Howells365970a2006-11-22 14:54:49 +0000633 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200634
Tejun Heo63d95a92012-07-12 14:46:37 -0700635static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000636{
Tejun Heo32704762012-07-13 22:16:45 -0700637 return !atomic_read(get_pool_nr_running(pool));
David Howells365970a2006-11-22 14:54:49 +0000638}
639
Tejun Heoe22bee72010-06-29 10:07:14 +0200640/*
641 * Need to wake up a worker? Called from anything but currently
642 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700643 *
644 * Note that, because unbound workers never contribute to nr_running, this
645 * function will always return %true for unbound gcwq as long as the
646 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200647 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700648static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000649{
Tejun Heo63d95a92012-07-12 14:46:37 -0700650 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000651}
652
Tejun Heoe22bee72010-06-29 10:07:14 +0200653/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700654static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200655{
Tejun Heo63d95a92012-07-12 14:46:37 -0700656 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200657}
658
659/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700660static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200661{
Tejun Heo63d95a92012-07-12 14:46:37 -0700662 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200663
Tejun Heo32704762012-07-13 22:16:45 -0700664 return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200665}
666
667/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700668static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200669{
Tejun Heo63d95a92012-07-12 14:46:37 -0700670 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200671}
672
673/* Do I need to be the manager? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700674static bool need_to_manage_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200675{
Tejun Heo63d95a92012-07-12 14:46:37 -0700676 return need_to_create_worker(pool) ||
Tejun Heo11ebea52012-07-12 14:46:37 -0700677 (pool->flags & POOL_MANAGE_WORKERS);
Tejun Heoe22bee72010-06-29 10:07:14 +0200678}
679
680/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700681static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200682{
Lai Jiangshan552a37e2012-09-10 10:03:33 -0700683 bool managing = pool->flags & POOL_MANAGING_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -0700684 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
685 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200686
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700687 /*
688 * nr_idle and idle_list may disagree if idle rebinding is in
689 * progress. Never return %true if idle_list is empty.
690 */
691 if (list_empty(&pool->idle_list))
692 return false;
693
Tejun Heoe22bee72010-06-29 10:07:14 +0200694 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
695}
696
697/*
698 * Wake up functions.
699 */
700
Tejun Heo7e116292010-06-29 10:07:13 +0200701/* Return the first worker. Safe with preemption disabled */
Tejun Heo63d95a92012-07-12 14:46:37 -0700702static struct worker *first_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200703{
Tejun Heo63d95a92012-07-12 14:46:37 -0700704 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200705 return NULL;
706
Tejun Heo63d95a92012-07-12 14:46:37 -0700707 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200708}
709
710/**
711 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700712 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200713 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700714 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200715 *
716 * CONTEXT:
717 * spin_lock_irq(gcwq->lock).
718 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700719static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200720{
Tejun Heo63d95a92012-07-12 14:46:37 -0700721 struct worker *worker = first_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200722
723 if (likely(worker))
724 wake_up_process(worker->task);
725}
726
Tejun Heo4690c4a2010-06-29 10:07:10 +0200727/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200728 * wq_worker_waking_up - a worker is waking up
729 * @task: task waking up
730 * @cpu: CPU @task is waking up to
731 *
732 * This function is called during try_to_wake_up() when a worker is
733 * being awoken.
734 *
735 * CONTEXT:
736 * spin_lock_irq(rq->lock)
737 */
738void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
739{
740 struct worker *worker = kthread_data(task);
741
Steven Rostedt2d646722010-12-03 23:12:33 -0500742 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700743 atomic_inc(get_pool_nr_running(worker->pool));
Tejun Heoe22bee72010-06-29 10:07:14 +0200744}
745
746/**
747 * wq_worker_sleeping - a worker is going to sleep
748 * @task: task going to sleep
749 * @cpu: CPU in question, must be the current CPU number
750 *
751 * This function is called during schedule() when a busy worker is
752 * going to sleep. Worker on the same cpu can be woken up by
753 * returning pointer to its task.
754 *
755 * CONTEXT:
756 * spin_lock_irq(rq->lock)
757 *
758 * RETURNS:
759 * Worker task on @cpu to wake up, %NULL if none.
760 */
761struct task_struct *wq_worker_sleeping(struct task_struct *task,
762 unsigned int cpu)
763{
764 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heobd7bdd42012-07-12 14:46:37 -0700765 struct worker_pool *pool = worker->pool;
Tejun Heo63d95a92012-07-12 14:46:37 -0700766 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200767
Steven Rostedt2d646722010-12-03 23:12:33 -0500768 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200769 return NULL;
770
771 /* this can only happen on the local cpu */
772 BUG_ON(cpu != raw_smp_processor_id());
773
774 /*
775 * The counterpart of the following dec_and_test, implied mb,
776 * worklist not empty test sequence is in insert_work().
777 * Please read comment there.
778 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700779 * NOT_RUNNING is clear. This means that we're bound to and
780 * running on the local cpu w/ rq lock held and preemption
781 * disabled, which in turn means that none else could be
782 * manipulating idle_list, so dereferencing idle_list without gcwq
783 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200784 */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700785 if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700786 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200787 return to_wakeup ? to_wakeup->task : NULL;
788}
789
790/**
791 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200792 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200793 * @flags: flags to set
794 * @wakeup: wakeup an idle worker if necessary
795 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200796 * Set @flags in @worker->flags and adjust nr_running accordingly. If
797 * nr_running becomes zero and @wakeup is %true, an idle worker is
798 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200799 *
Tejun Heocb444762010-07-02 10:03:50 +0200800 * CONTEXT:
801 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200802 */
803static inline void worker_set_flags(struct worker *worker, unsigned int flags,
804 bool wakeup)
805{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700806 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200807
Tejun Heocb444762010-07-02 10:03:50 +0200808 WARN_ON_ONCE(worker->task != current);
809
Tejun Heoe22bee72010-06-29 10:07:14 +0200810 /*
811 * If transitioning into NOT_RUNNING, adjust nr_running and
812 * wake up an idle worker as necessary if requested by
813 * @wakeup.
814 */
815 if ((flags & WORKER_NOT_RUNNING) &&
816 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heo63d95a92012-07-12 14:46:37 -0700817 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200818
819 if (wakeup) {
820 if (atomic_dec_and_test(nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700821 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700822 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200823 } else
824 atomic_dec(nr_running);
825 }
826
Tejun Heod302f012010-06-29 10:07:13 +0200827 worker->flags |= flags;
828}
829
830/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200831 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200832 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200833 * @flags: flags to clear
834 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200835 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200836 *
Tejun Heocb444762010-07-02 10:03:50 +0200837 * CONTEXT:
838 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200839 */
840static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
841{
Tejun Heo63d95a92012-07-12 14:46:37 -0700842 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200843 unsigned int oflags = worker->flags;
844
Tejun Heocb444762010-07-02 10:03:50 +0200845 WARN_ON_ONCE(worker->task != current);
846
Tejun Heod302f012010-06-29 10:07:13 +0200847 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200848
Tejun Heo42c025f2011-01-11 15:58:49 +0100849 /*
850 * If transitioning out of NOT_RUNNING, increment nr_running. Note
851 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
852 * of multiple flags, not a single flag.
853 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200854 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
855 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700856 atomic_inc(get_pool_nr_running(pool));
Tejun Heod302f012010-06-29 10:07:13 +0200857}
858
859/**
Tejun Heoc8e55f32010-06-29 10:07:12 +0200860 * busy_worker_head - return the busy hash head for a work
861 * @gcwq: gcwq of interest
862 * @work: work to be hashed
863 *
864 * Return hash head of @gcwq for @work.
865 *
866 * CONTEXT:
867 * spin_lock_irq(gcwq->lock).
868 *
869 * RETURNS:
870 * Pointer to the hash head.
871 */
872static struct hlist_head *busy_worker_head(struct global_cwq *gcwq,
873 struct work_struct *work)
874{
875 const int base_shift = ilog2(sizeof(struct work_struct));
876 unsigned long v = (unsigned long)work;
877
878 /* simple shift and fold hash, do we need something better? */
879 v >>= base_shift;
880 v += v >> BUSY_WORKER_HASH_ORDER;
881 v &= BUSY_WORKER_HASH_MASK;
882
883 return &gcwq->busy_hash[v];
884}
885
886/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200887 * __find_worker_executing_work - find worker which is executing a work
888 * @gcwq: gcwq of interest
889 * @bwh: hash head as returned by busy_worker_head()
890 * @work: work to find worker for
891 *
892 * Find a worker which is executing @work on @gcwq. @bwh should be
893 * the hash head obtained by calling busy_worker_head() with the same
894 * work.
895 *
896 * CONTEXT:
897 * spin_lock_irq(gcwq->lock).
898 *
899 * RETURNS:
900 * Pointer to worker which is executing @work if found, NULL
901 * otherwise.
902 */
903static struct worker *__find_worker_executing_work(struct global_cwq *gcwq,
904 struct hlist_head *bwh,
905 struct work_struct *work)
906{
907 struct worker *worker;
908 struct hlist_node *tmp;
909
910 hlist_for_each_entry(worker, tmp, bwh, hentry)
911 if (worker->current_work == work)
912 return worker;
913 return NULL;
914}
915
916/**
917 * find_worker_executing_work - find worker which is executing a work
918 * @gcwq: gcwq of interest
919 * @work: work to find worker for
920 *
921 * Find a worker which is executing @work on @gcwq. This function is
922 * identical to __find_worker_executing_work() except that this
923 * function calculates @bwh itself.
924 *
925 * CONTEXT:
926 * spin_lock_irq(gcwq->lock).
927 *
928 * RETURNS:
929 * Pointer to worker which is executing @work if found, NULL
930 * otherwise.
931 */
932static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
933 struct work_struct *work)
934{
935 return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work),
936 work);
937}
938
939/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700940 * move_linked_works - move linked works to a list
941 * @work: start of series of works to be scheduled
942 * @head: target list to append @work to
943 * @nextp: out paramter for nested worklist walking
944 *
945 * Schedule linked works starting from @work to @head. Work series to
946 * be scheduled starts at @work and includes any consecutive work with
947 * WORK_STRUCT_LINKED set in its predecessor.
948 *
949 * If @nextp is not NULL, it's updated to point to the next work of
950 * the last scheduled work. This allows move_linked_works() to be
951 * nested inside outer list_for_each_entry_safe().
952 *
953 * CONTEXT:
954 * spin_lock_irq(gcwq->lock).
955 */
956static void move_linked_works(struct work_struct *work, struct list_head *head,
957 struct work_struct **nextp)
958{
959 struct work_struct *n;
960
961 /*
962 * Linked worklist will always end before the end of the list,
963 * use NULL for list head.
964 */
965 list_for_each_entry_safe_from(work, n, NULL, entry) {
966 list_move_tail(&work->entry, head);
967 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
968 break;
969 }
970
971 /*
972 * If we're already inside safe list traversal and have moved
973 * multiple works to the scheduled queue, the next position
974 * needs to be updated.
975 */
976 if (nextp)
977 *nextp = n;
978}
979
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700980static void cwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -0700981{
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700982 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -0700983
984 trace_workqueue_activate_work(work);
985 move_linked_works(work, &cwq->pool->worklist, NULL);
986 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
987 cwq->nr_active++;
988}
989
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700990static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
991{
992 struct work_struct *work = list_first_entry(&cwq->delayed_works,
993 struct work_struct, entry);
994
995 cwq_activate_delayed_work(work);
996}
997
Tejun Heobf4ede02012-08-03 10:30:46 -0700998/**
999 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1000 * @cwq: cwq of interest
1001 * @color: color of work which left the queue
1002 * @delayed: for a delayed work
1003 *
1004 * A work either has completed or is removed from pending queue,
1005 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1006 *
1007 * CONTEXT:
1008 * spin_lock_irq(gcwq->lock).
1009 */
1010static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color,
1011 bool delayed)
1012{
1013 /* ignore uncolored works */
1014 if (color == WORK_NO_COLOR)
1015 return;
1016
1017 cwq->nr_in_flight[color]--;
1018
1019 if (!delayed) {
1020 cwq->nr_active--;
1021 if (!list_empty(&cwq->delayed_works)) {
1022 /* one down, submit a delayed one */
1023 if (cwq->nr_active < cwq->max_active)
1024 cwq_activate_first_delayed(cwq);
1025 }
1026 }
1027
1028 /* is flush in progress and are we at the flushing tip? */
1029 if (likely(cwq->flush_color != color))
1030 return;
1031
1032 /* are there still in-flight works? */
1033 if (cwq->nr_in_flight[color])
1034 return;
1035
1036 /* this cwq is done, clear flush_color */
1037 cwq->flush_color = -1;
1038
1039 /*
1040 * If this was the last cwq, wake up the first flusher. It
1041 * will handle the rest.
1042 */
1043 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1044 complete(&cwq->wq->first_flusher->done);
1045}
1046
Tejun Heo36e227d2012-08-03 10:30:46 -07001047/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001048 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001049 * @work: work item to steal
1050 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001051 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001052 *
1053 * Try to grab PENDING bit of @work. This function can handle @work in any
1054 * stable state - idle, on timer or on worklist. Return values are
1055 *
1056 * 1 if @work was pending and we successfully stole PENDING
1057 * 0 if @work was idle and we claimed PENDING
1058 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001059 * -ENOENT if someone else is canceling @work, this state may persist
1060 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001061 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001062 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001063 * interrupted while holding PENDING and @work off queue, irq must be
1064 * disabled on entry. This, combined with delayed_work->timer being
1065 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001066 *
1067 * On successful return, >= 0, irq is disabled and the caller is
1068 * responsible for releasing it using local_irq_restore(*@flags).
1069 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001070 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001071 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001072static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1073 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001074{
1075 struct global_cwq *gcwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001076
Tejun Heobbb68df2012-08-03 10:30:46 -07001077 WARN_ON_ONCE(in_irq());
1078
1079 local_irq_save(*flags);
1080
Tejun Heo36e227d2012-08-03 10:30:46 -07001081 /* try to steal the timer if it exists */
1082 if (is_dwork) {
1083 struct delayed_work *dwork = to_delayed_work(work);
1084
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001085 /*
1086 * dwork->timer is irqsafe. If del_timer() fails, it's
1087 * guaranteed that the timer is not queued anywhere and not
1088 * running on the local CPU.
1089 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001090 if (likely(del_timer(&dwork->timer)))
1091 return 1;
1092 }
1093
1094 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001095 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1096 return 0;
1097
1098 /*
1099 * The queueing is in progress, or it is already queued. Try to
1100 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1101 */
1102 gcwq = get_work_gcwq(work);
1103 if (!gcwq)
Tejun Heobbb68df2012-08-03 10:30:46 -07001104 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001105
Tejun Heobbb68df2012-08-03 10:30:46 -07001106 spin_lock(&gcwq->lock);
Tejun Heobf4ede02012-08-03 10:30:46 -07001107 if (!list_empty(&work->entry)) {
1108 /*
1109 * This work is queued, but perhaps we locked the wrong gcwq.
1110 * In that case we must see the new value after rmb(), see
1111 * insert_work()->wmb().
1112 */
1113 smp_rmb();
1114 if (gcwq == get_work_gcwq(work)) {
1115 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001116
1117 /*
1118 * A delayed work item cannot be grabbed directly
1119 * because it might have linked NO_COLOR work items
1120 * which, if left on the delayed_list, will confuse
1121 * cwq->nr_active management later on and cause
1122 * stall. Make sure the work item is activated
1123 * before grabbing.
1124 */
1125 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1126 cwq_activate_delayed_work(work);
1127
Tejun Heobf4ede02012-08-03 10:30:46 -07001128 list_del_init(&work->entry);
1129 cwq_dec_nr_in_flight(get_work_cwq(work),
1130 get_work_color(work),
1131 *work_data_bits(work) & WORK_STRUCT_DELAYED);
Tejun Heo36e227d2012-08-03 10:30:46 -07001132
Tejun Heobbb68df2012-08-03 10:30:46 -07001133 spin_unlock(&gcwq->lock);
Tejun Heo36e227d2012-08-03 10:30:46 -07001134 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001135 }
1136 }
Tejun Heobbb68df2012-08-03 10:30:46 -07001137 spin_unlock(&gcwq->lock);
1138fail:
1139 local_irq_restore(*flags);
1140 if (work_is_canceling(work))
1141 return -ENOENT;
1142 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001143 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001144}
1145
1146/**
Tejun Heo7e116292010-06-29 10:07:13 +02001147 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +02001148 * @cwq: cwq @work belongs to
1149 * @work: work to insert
1150 * @head: insertion point
1151 * @extra_flags: extra WORK_STRUCT_* flags to set
1152 *
Tejun Heo7e116292010-06-29 10:07:13 +02001153 * Insert @work which belongs to @cwq into @gcwq after @head.
1154 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001155 *
1156 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001157 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001158 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001159static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +02001160 struct work_struct *work, struct list_head *head,
1161 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001162{
Tejun Heo63d95a92012-07-12 14:46:37 -07001163 struct worker_pool *pool = cwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001164
Tejun Heo4690c4a2010-06-29 10:07:10 +02001165 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +02001166 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001167
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001168 /*
1169 * Ensure that we get the right work->data if we see the
1170 * result of list_add() below, see try_to_grab_pending().
1171 */
1172 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +02001173
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001174 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +02001175
1176 /*
1177 * Ensure either worker_sched_deactivated() sees the above
1178 * list_add_tail() or we see zero nr_running to avoid workers
1179 * lying around lazily while there are works to be processed.
1180 */
1181 smp_mb();
1182
Tejun Heo63d95a92012-07-12 14:46:37 -07001183 if (__need_more_worker(pool))
1184 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001185}
1186
Tejun Heoc8efcc22010-12-20 19:32:04 +01001187/*
1188 * Test whether @work is being queued from another work executing on the
1189 * same workqueue. This is rather expensive and should only be used from
1190 * cold paths.
1191 */
1192static bool is_chained_work(struct workqueue_struct *wq)
1193{
1194 unsigned long flags;
1195 unsigned int cpu;
1196
1197 for_each_gcwq_cpu(cpu) {
1198 struct global_cwq *gcwq = get_gcwq(cpu);
1199 struct worker *worker;
1200 struct hlist_node *pos;
1201 int i;
1202
1203 spin_lock_irqsave(&gcwq->lock, flags);
1204 for_each_busy_worker(worker, i, pos, gcwq) {
1205 if (worker->task != current)
1206 continue;
1207 spin_unlock_irqrestore(&gcwq->lock, flags);
1208 /*
1209 * I'm @worker, no locking necessary. See if @work
1210 * is headed to the same workqueue.
1211 */
1212 return worker->current_cwq->wq == wq;
1213 }
1214 spin_unlock_irqrestore(&gcwq->lock, flags);
1215 }
1216 return false;
1217}
1218
Tejun Heo4690c4a2010-06-29 10:07:10 +02001219static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 struct work_struct *work)
1221{
Tejun Heo502ca9d2010-06-29 10:07:13 +02001222 struct global_cwq *gcwq;
1223 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001224 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001225 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001226 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001227
1228 /*
1229 * While a work item is PENDING && off queue, a task trying to
1230 * steal the PENDING will busy-loop waiting for it to either get
1231 * queued or lose PENDING. Grabbing PENDING and queueing should
1232 * happen with IRQ disabled.
1233 */
1234 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001236 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001237
Tejun Heoc8efcc22010-12-20 19:32:04 +01001238 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02001239 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001240 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001241 return;
1242
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001243 /* determine gcwq to use */
1244 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001245 struct global_cwq *last_gcwq;
1246
Tejun Heo57469822012-08-03 10:30:45 -07001247 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001248 cpu = raw_smp_processor_id();
1249
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001250 /*
Tejun Heodbf25762012-08-20 14:51:23 -07001251 * It's multi cpu. If @work was previously on a different
1252 * cpu, it might still be running there, in which case the
1253 * work needs to be queued on that cpu to guarantee
1254 * non-reentrancy.
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001255 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001256 gcwq = get_gcwq(cpu);
Tejun Heodbf25762012-08-20 14:51:23 -07001257 last_gcwq = get_work_gcwq(work);
1258
1259 if (last_gcwq && last_gcwq != gcwq) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001260 struct worker *worker;
1261
Tejun Heo8930cab2012-08-03 10:30:45 -07001262 spin_lock(&last_gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001263
1264 worker = find_worker_executing_work(last_gcwq, work);
1265
1266 if (worker && worker->current_cwq->wq == wq)
1267 gcwq = last_gcwq;
1268 else {
1269 /* meh... not running there, queue here */
Tejun Heo8930cab2012-08-03 10:30:45 -07001270 spin_unlock(&last_gcwq->lock);
1271 spin_lock(&gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001272 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001273 } else {
1274 spin_lock(&gcwq->lock);
1275 }
Tejun Heof3421792010-07-02 10:03:51 +02001276 } else {
1277 gcwq = get_gcwq(WORK_CPU_UNBOUND);
Tejun Heo8930cab2012-08-03 10:30:45 -07001278 spin_lock(&gcwq->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001279 }
1280
1281 /* gcwq determined, get cwq and queue */
1282 cwq = get_cwq(gcwq->cpu, wq);
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001283 trace_workqueue_queue_work(req_cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001284
Dan Carpenterf5b25522012-04-13 22:06:58 +03001285 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo8930cab2012-08-03 10:30:45 -07001286 spin_unlock(&gcwq->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001287 return;
1288 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001289
Tejun Heo73f53c42010-06-29 10:07:11 +02001290 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001291 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001292
1293 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001294 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001295 cwq->nr_active++;
Tejun Heo32704762012-07-13 22:16:45 -07001296 worklist = &cwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001297 } else {
1298 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001299 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001300 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001301
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001302 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001303
Tejun Heo8930cab2012-08-03 10:30:45 -07001304 spin_unlock(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305}
1306
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001307/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001308 * queue_work_on - queue work on specific cpu
1309 * @cpu: CPU number to execute work on
1310 * @wq: workqueue to use
1311 * @work: work to queue
1312 *
Tejun Heod4283e92012-08-03 10:30:44 -07001313 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001314 *
1315 * We queue the work to a specific CPU, the caller must ensure it
1316 * can't go away.
1317 */
Tejun Heod4283e92012-08-03 10:30:44 -07001318bool queue_work_on(int cpu, struct workqueue_struct *wq,
1319 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001320{
Tejun Heod4283e92012-08-03 10:30:44 -07001321 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001322 unsigned long flags;
1323
1324 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001325
Tejun Heo22df02b2010-06-29 10:07:10 +02001326 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001327 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001328 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001329 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001330
1331 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001332 return ret;
1333}
1334EXPORT_SYMBOL_GPL(queue_work_on);
1335
Tejun Heo0a13c002012-08-03 10:30:44 -07001336/**
1337 * queue_work - queue work on a workqueue
1338 * @wq: workqueue to use
1339 * @work: work to queue
1340 *
Tejun Heod4283e92012-08-03 10:30:44 -07001341 * Returns %false if @work was already on a queue, %true otherwise.
Tejun Heo0a13c002012-08-03 10:30:44 -07001342 *
1343 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1344 * it can be processed by another CPU.
1345 */
Tejun Heod4283e92012-08-03 10:30:44 -07001346bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07001347{
Tejun Heo57469822012-08-03 10:30:45 -07001348 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
Tejun Heo0a13c002012-08-03 10:30:44 -07001349}
1350EXPORT_SYMBOL_GPL(queue_work);
1351
Tejun Heod8e794d2012-08-03 10:30:45 -07001352void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353{
David Howells52bad642006-11-22 14:54:01 +00001354 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001355 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001357 /* should have been called from irqsafe timer with irq already off */
Tejun Heo12650572012-08-08 09:38:42 -07001358 __queue_work(dwork->cpu, cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359}
Tejun Heod8e794d2012-08-03 10:30:45 -07001360EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001362static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1363 struct delayed_work *dwork, unsigned long delay)
1364{
1365 struct timer_list *timer = &dwork->timer;
1366 struct work_struct *work = &dwork->work;
1367 unsigned int lcpu;
1368
1369 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1370 timer->data != (unsigned long)dwork);
1371 BUG_ON(timer_pending(timer));
1372 BUG_ON(!list_empty(&work->entry));
1373
1374 timer_stats_timer_set_start_info(&dwork->timer);
1375
1376 /*
1377 * This stores cwq for the moment, for the timer_fn. Note that the
1378 * work's gcwq is preserved to allow reentrance detection for
1379 * delayed works.
1380 */
1381 if (!(wq->flags & WQ_UNBOUND)) {
1382 struct global_cwq *gcwq = get_work_gcwq(work);
1383
Joonsoo Kime42986d2012-08-15 23:25:38 +09001384 /*
1385 * If we cannot get the last gcwq from @work directly,
1386 * select the last CPU such that it avoids unnecessarily
1387 * triggering non-reentrancy check in __queue_work().
1388 */
1389 lcpu = cpu;
1390 if (gcwq)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001391 lcpu = gcwq->cpu;
Joonsoo Kime42986d2012-08-15 23:25:38 +09001392 if (lcpu == WORK_CPU_UNBOUND)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001393 lcpu = raw_smp_processor_id();
1394 } else {
1395 lcpu = WORK_CPU_UNBOUND;
1396 }
1397
1398 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1399
Tejun Heo12650572012-08-08 09:38:42 -07001400 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001401 timer->expires = jiffies + delay;
1402
1403 if (unlikely(cpu != WORK_CPU_UNBOUND))
1404 add_timer_on(timer, cpu);
1405 else
1406 add_timer(timer);
1407}
1408
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001409/**
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001410 * queue_delayed_work_on - queue work on specific CPU after delay
1411 * @cpu: CPU number to execute work on
1412 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001413 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001414 * @delay: number of jiffies to wait before queueing
1415 *
Tejun Heo715f1302012-08-03 10:30:46 -07001416 * Returns %false if @work was already on a queue, %true otherwise. If
1417 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1418 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001419 */
Tejun Heod4283e92012-08-03 10:30:44 -07001420bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1421 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001422{
David Howells52bad642006-11-22 14:54:01 +00001423 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001424 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001425 unsigned long flags;
1426
Tejun Heo715f1302012-08-03 10:30:46 -07001427 if (!delay)
1428 return queue_work_on(cpu, wq, &dwork->work);
1429
Tejun Heo8930cab2012-08-03 10:30:45 -07001430 /* read the comment in __queue_work() */
1431 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001432
Tejun Heo22df02b2010-06-29 10:07:10 +02001433 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001434 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001435 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001436 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001437
1438 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001439 return ret;
1440}
Dave Jonesae90dd52006-06-30 01:40:45 -04001441EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442
Tejun Heoc8e55f32010-06-29 10:07:12 +02001443/**
Tejun Heo0a13c002012-08-03 10:30:44 -07001444 * queue_delayed_work - queue work on a workqueue after delay
1445 * @wq: workqueue to use
1446 * @dwork: delayable work to queue
1447 * @delay: number of jiffies to wait before queueing
1448 *
Tejun Heo715f1302012-08-03 10:30:46 -07001449 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
Tejun Heo0a13c002012-08-03 10:30:44 -07001450 */
Tejun Heod4283e92012-08-03 10:30:44 -07001451bool queue_delayed_work(struct workqueue_struct *wq,
Tejun Heo0a13c002012-08-03 10:30:44 -07001452 struct delayed_work *dwork, unsigned long delay)
1453{
Tejun Heo57469822012-08-03 10:30:45 -07001454 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
Tejun Heo0a13c002012-08-03 10:30:44 -07001455}
1456EXPORT_SYMBOL_GPL(queue_delayed_work);
1457
1458/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001459 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1460 * @cpu: CPU number to execute work on
1461 * @wq: workqueue to use
1462 * @dwork: work to queue
1463 * @delay: number of jiffies to wait before queueing
1464 *
1465 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1466 * modify @dwork's timer so that it expires after @delay. If @delay is
1467 * zero, @work is guaranteed to be scheduled immediately regardless of its
1468 * current state.
1469 *
1470 * Returns %false if @dwork was idle and queued, %true if @dwork was
1471 * pending and its timer was modified.
1472 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001473 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001474 * See try_to_grab_pending() for details.
1475 */
1476bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1477 struct delayed_work *dwork, unsigned long delay)
1478{
1479 unsigned long flags;
1480 int ret;
1481
1482 do {
1483 ret = try_to_grab_pending(&dwork->work, true, &flags);
1484 } while (unlikely(ret == -EAGAIN));
1485
1486 if (likely(ret >= 0)) {
1487 __queue_delayed_work(cpu, wq, dwork, delay);
1488 local_irq_restore(flags);
1489 }
1490
1491 /* -ENOENT from try_to_grab_pending() becomes %true */
1492 return ret;
1493}
1494EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1495
1496/**
1497 * mod_delayed_work - modify delay of or queue a delayed work
1498 * @wq: workqueue to use
1499 * @dwork: work to queue
1500 * @delay: number of jiffies to wait before queueing
1501 *
1502 * mod_delayed_work_on() on local CPU.
1503 */
1504bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1505 unsigned long delay)
1506{
1507 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1508}
1509EXPORT_SYMBOL_GPL(mod_delayed_work);
1510
1511/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001512 * worker_enter_idle - enter idle state
1513 * @worker: worker which is entering idle state
1514 *
1515 * @worker is entering idle state. Update stats and idle timer if
1516 * necessary.
1517 *
1518 * LOCKING:
1519 * spin_lock_irq(gcwq->lock).
1520 */
1521static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001523 struct worker_pool *pool = worker->pool;
1524 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525
Tejun Heoc8e55f32010-06-29 10:07:12 +02001526 BUG_ON(worker->flags & WORKER_IDLE);
1527 BUG_ON(!list_empty(&worker->entry) &&
1528 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
Tejun Heocb444762010-07-02 10:03:50 +02001530 /* can't use worker_set_flags(), also called from start_worker() */
1531 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001532 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001533 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001534
Tejun Heoc8e55f32010-06-29 10:07:12 +02001535 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001536 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001537
Tejun Heo628c78e2012-07-17 12:39:27 -07001538 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1539 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001540
Tejun Heo544ecf32012-05-14 15:04:50 -07001541 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07001542 * Sanity check nr_running. Because gcwq_unbind_fn() releases
1543 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1544 * nr_running, the warning may trigger spuriously. Check iff
1545 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001546 */
Tejun Heo628c78e2012-07-17 12:39:27 -07001547 WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001548 pool->nr_workers == pool->nr_idle &&
Tejun Heo63d95a92012-07-12 14:46:37 -07001549 atomic_read(get_pool_nr_running(pool)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550}
1551
Tejun Heoc8e55f32010-06-29 10:07:12 +02001552/**
1553 * worker_leave_idle - leave idle state
1554 * @worker: worker which is leaving idle state
1555 *
1556 * @worker is leaving idle state. Update stats.
1557 *
1558 * LOCKING:
1559 * spin_lock_irq(gcwq->lock).
1560 */
1561static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001563 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
Tejun Heoc8e55f32010-06-29 10:07:12 +02001565 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001566 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001567 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001568 list_del_init(&worker->entry);
1569}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570
Tejun Heoe22bee72010-06-29 10:07:14 +02001571/**
1572 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1573 * @worker: self
1574 *
1575 * Works which are scheduled while the cpu is online must at least be
1576 * scheduled to a worker which is bound to the cpu so that if they are
1577 * flushed from cpu callbacks while cpu is going down, they are
1578 * guaranteed to execute on the cpu.
1579 *
1580 * This function is to be used by rogue workers and rescuers to bind
1581 * themselves to the target cpu and may race with cpu going down or
1582 * coming online. kthread_bind() can't be used because it may put the
1583 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1584 * verbatim as it's best effort and blocking and gcwq may be
1585 * [dis]associated in the meantime.
1586 *
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001587 * This function tries set_cpus_allowed() and locks gcwq and verifies the
1588 * binding against %GCWQ_DISASSOCIATED which is set during
1589 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1590 * enters idle state or fetches works without dropping lock, it can
1591 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001592 *
1593 * CONTEXT:
1594 * Might sleep. Called without any lock but returns with gcwq->lock
1595 * held.
1596 *
1597 * RETURNS:
1598 * %true if the associated gcwq is online (@worker is successfully
1599 * bound), %false if offline.
1600 */
1601static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001602__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001603{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001604 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001605 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606
Tejun Heoe22bee72010-06-29 10:07:14 +02001607 while (true) {
1608 /*
1609 * The following call may fail, succeed or succeed
1610 * without actually migrating the task to the cpu if
1611 * it races with cpu hotunplug operation. Verify
1612 * against GCWQ_DISASSOCIATED.
1613 */
Tejun Heof3421792010-07-02 10:03:51 +02001614 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1615 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001616
Tejun Heoe22bee72010-06-29 10:07:14 +02001617 spin_lock_irq(&gcwq->lock);
1618 if (gcwq->flags & GCWQ_DISASSOCIATED)
1619 return false;
1620 if (task_cpu(task) == gcwq->cpu &&
1621 cpumask_equal(&current->cpus_allowed,
1622 get_cpu_mask(gcwq->cpu)))
1623 return true;
1624 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001625
Tejun Heo5035b202011-04-29 18:08:37 +02001626 /*
1627 * We've raced with CPU hot[un]plug. Give it a breather
1628 * and retry migration. cond_resched() is required here;
1629 * otherwise, we might deadlock against cpu_stop trying to
1630 * bring down the CPU on non-preemptive kernel.
1631 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001632 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001633 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001634 }
1635}
1636
1637/*
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001638 * Rebind an idle @worker to its CPU. worker_thread() will test
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001639 * list_empty(@worker->entry) before leaving idle and call this function.
Tejun Heo25511a42012-07-17 12:39:27 -07001640 */
1641static void idle_worker_rebind(struct worker *worker)
1642{
1643 struct global_cwq *gcwq = worker->pool->gcwq;
1644
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001645 /* CPU may go down again inbetween, clear UNBOUND only on success */
1646 if (worker_maybe_bind_and_lock(worker))
1647 worker_clr_flags(worker, WORKER_UNBOUND);
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001648
1649 /* rebind complete, become available again */
1650 list_add(&worker->entry, &worker->pool->idle_list);
1651 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07001652}
1653
1654/*
1655 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001656 * the associated cpu which is coming back online. This is scheduled by
1657 * cpu up but can race with other cpu hotplug operations and may be
1658 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001659 */
Tejun Heo25511a42012-07-17 12:39:27 -07001660static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001661{
1662 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001663 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001664
Lai Jiangshaneab6d822012-09-18 09:59:22 -07001665 if (worker_maybe_bind_and_lock(worker))
1666 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02001667
1668 spin_unlock_irq(&gcwq->lock);
1669}
1670
Tejun Heo25511a42012-07-17 12:39:27 -07001671/**
1672 * rebind_workers - rebind all workers of a gcwq to the associated CPU
1673 * @gcwq: gcwq of interest
1674 *
1675 * @gcwq->cpu is coming online. Rebind all workers to the CPU. Rebinding
1676 * is different for idle and busy ones.
1677 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001678 * Idle ones will be removed from the idle_list and woken up. They will
1679 * add themselves back after completing rebind. This ensures that the
1680 * idle_list doesn't contain any unbound workers when re-bound busy workers
1681 * try to perform local wake-ups for concurrency management.
Tejun Heo25511a42012-07-17 12:39:27 -07001682 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001683 * Busy workers can rebind after they finish their current work items.
1684 * Queueing the rebind work item at the head of the scheduled list is
1685 * enough. Note that nr_running will be properly bumped as busy workers
1686 * rebind.
Tejun Heo25511a42012-07-17 12:39:27 -07001687 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001688 * On return, all non-manager workers are scheduled for rebind - see
1689 * manage_workers() for the manager special case. Any idle worker
1690 * including the manager will not appear on @idle_list until rebind is
1691 * complete, making local wake-ups safe.
Tejun Heo25511a42012-07-17 12:39:27 -07001692 */
1693static void rebind_workers(struct global_cwq *gcwq)
Tejun Heo25511a42012-07-17 12:39:27 -07001694{
Tejun Heo25511a42012-07-17 12:39:27 -07001695 struct worker_pool *pool;
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001696 struct worker *worker, *n;
Tejun Heo25511a42012-07-17 12:39:27 -07001697 struct hlist_node *pos;
1698 int i;
1699
1700 lockdep_assert_held(&gcwq->lock);
1701
1702 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07001703 lockdep_assert_held(&pool->assoc_mutex);
Tejun Heo25511a42012-07-17 12:39:27 -07001704
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001705 /* dequeue and kick idle ones */
Tejun Heo25511a42012-07-17 12:39:27 -07001706 for_each_worker_pool(pool, gcwq) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001707 list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001708 /*
1709 * idle workers should be off @pool->idle_list
1710 * until rebind is complete to avoid receiving
1711 * premature local wake-ups.
1712 */
1713 list_del_init(&worker->entry);
Tejun Heo25511a42012-07-17 12:39:27 -07001714
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001715 /*
1716 * worker_thread() will see the above dequeuing
1717 * and call idle_worker_rebind().
1718 */
Tejun Heo25511a42012-07-17 12:39:27 -07001719 wake_up_process(worker->task);
1720 }
1721 }
1722
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001723 /* rebind busy workers */
Tejun Heo25511a42012-07-17 12:39:27 -07001724 for_each_busy_worker(worker, i, pos, gcwq) {
1725 struct work_struct *rebind_work = &worker->rebind_work;
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001726 struct workqueue_struct *wq;
Tejun Heo25511a42012-07-17 12:39:27 -07001727
Tejun Heo25511a42012-07-17 12:39:27 -07001728 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1729 work_data_bits(rebind_work)))
1730 continue;
1731
Tejun Heo25511a42012-07-17 12:39:27 -07001732 debug_work_activate(rebind_work);
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001733
1734 /*
1735 * wq doesn't really matter but let's keep @worker->pool
1736 * and @cwq->pool consistent for sanity.
1737 */
1738 if (worker_pool_pri(worker->pool))
1739 wq = system_highpri_wq;
1740 else
1741 wq = system_wq;
1742
1743 insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
1744 worker->scheduled.next,
1745 work_color_to_flags(WORK_NO_COLOR));
Tejun Heo25511a42012-07-17 12:39:27 -07001746 }
1747}
1748
Tejun Heoc34056a2010-06-29 10:07:11 +02001749static struct worker *alloc_worker(void)
1750{
1751 struct worker *worker;
1752
1753 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001754 if (worker) {
1755 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001756 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001757 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001758 /* on creation a worker is in !idle && prep state */
1759 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001760 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001761 return worker;
1762}
1763
1764/**
1765 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001766 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001767 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001768 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001769 * can be started by calling start_worker() or destroyed using
1770 * destroy_worker().
1771 *
1772 * CONTEXT:
1773 * Might sleep. Does GFP_KERNEL allocations.
1774 *
1775 * RETURNS:
1776 * Pointer to the newly created worker.
1777 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001778static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001779{
Tejun Heo63d95a92012-07-12 14:46:37 -07001780 struct global_cwq *gcwq = pool->gcwq;
Tejun Heo32704762012-07-13 22:16:45 -07001781 const char *pri = worker_pool_pri(pool) ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001782 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001783 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001784
Tejun Heo8b03ae32010-06-29 10:07:12 +02001785 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001786 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001787 spin_unlock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001788 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001789 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001790 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001791 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001792 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001793
1794 worker = alloc_worker();
1795 if (!worker)
1796 goto fail;
1797
Tejun Heobd7bdd42012-07-12 14:46:37 -07001798 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001799 worker->id = id;
1800
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001801 if (gcwq->cpu != WORK_CPU_UNBOUND)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001802 worker->task = kthread_create_on_node(worker_thread,
Tejun Heo32704762012-07-13 22:16:45 -07001803 worker, cpu_to_node(gcwq->cpu),
1804 "kworker/%u:%d%s", gcwq->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001805 else
1806 worker->task = kthread_create(worker_thread, worker,
Tejun Heo32704762012-07-13 22:16:45 -07001807 "kworker/u:%d%s", id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001808 if (IS_ERR(worker->task))
1809 goto fail;
1810
Tejun Heo32704762012-07-13 22:16:45 -07001811 if (worker_pool_pri(pool))
1812 set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
1813
Tejun Heodb7bccf2010-06-29 10:07:12 +02001814 /*
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001815 * Determine CPU binding of the new worker depending on
1816 * %GCWQ_DISASSOCIATED. The caller is responsible for ensuring the
1817 * flag remains stable across this function. See the comments
1818 * above the flag definition for details.
1819 *
1820 * As an unbound worker may later become a regular one if CPU comes
1821 * online, make sure every worker has %PF_THREAD_BOUND set.
Tejun Heodb7bccf2010-06-29 10:07:12 +02001822 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001823 if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001824 kthread_bind(worker->task, gcwq->cpu);
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001825 } else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001826 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001827 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001829
Tejun Heoc34056a2010-06-29 10:07:11 +02001830 return worker;
1831fail:
1832 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001833 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001834 ida_remove(&pool->worker_ida, id);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001835 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001836 }
1837 kfree(worker);
1838 return NULL;
1839}
1840
1841/**
1842 * start_worker - start a newly created worker
1843 * @worker: worker to start
1844 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001845 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001846 *
1847 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001848 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001849 */
1850static void start_worker(struct worker *worker)
1851{
Tejun Heocb444762010-07-02 10:03:50 +02001852 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001853 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001854 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001855 wake_up_process(worker->task);
1856}
1857
1858/**
1859 * destroy_worker - destroy a workqueue worker
1860 * @worker: worker to be destroyed
1861 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001862 * Destroy @worker and adjust @gcwq stats accordingly.
1863 *
1864 * CONTEXT:
1865 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001866 */
1867static void destroy_worker(struct worker *worker)
1868{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001869 struct worker_pool *pool = worker->pool;
1870 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001871 int id = worker->id;
1872
1873 /* sanity check frenzy */
1874 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001875 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001876
Tejun Heoc8e55f32010-06-29 10:07:12 +02001877 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001878 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001879 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001880 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001881
1882 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001883 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001884
1885 spin_unlock_irq(&gcwq->lock);
1886
Tejun Heoc34056a2010-06-29 10:07:11 +02001887 kthread_stop(worker->task);
1888 kfree(worker);
1889
Tejun Heo8b03ae32010-06-29 10:07:12 +02001890 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001891 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001892}
1893
Tejun Heo63d95a92012-07-12 14:46:37 -07001894static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001895{
Tejun Heo63d95a92012-07-12 14:46:37 -07001896 struct worker_pool *pool = (void *)__pool;
1897 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001898
1899 spin_lock_irq(&gcwq->lock);
1900
Tejun Heo63d95a92012-07-12 14:46:37 -07001901 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001902 struct worker *worker;
1903 unsigned long expires;
1904
1905 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001906 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001907 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1908
1909 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001910 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001911 else {
1912 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001913 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001914 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001915 }
1916 }
1917
1918 spin_unlock_irq(&gcwq->lock);
1919}
1920
1921static bool send_mayday(struct work_struct *work)
1922{
1923 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1924 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001925 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001926
1927 if (!(wq->flags & WQ_RESCUER))
1928 return false;
1929
1930 /* mayday mayday mayday */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001931 cpu = cwq->pool->gcwq->cpu;
Tejun Heof3421792010-07-02 10:03:51 +02001932 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1933 if (cpu == WORK_CPU_UNBOUND)
1934 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001935 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001936 wake_up_process(wq->rescuer->task);
1937 return true;
1938}
1939
Tejun Heo63d95a92012-07-12 14:46:37 -07001940static void gcwq_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001941{
Tejun Heo63d95a92012-07-12 14:46:37 -07001942 struct worker_pool *pool = (void *)__pool;
1943 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001944 struct work_struct *work;
1945
1946 spin_lock_irq(&gcwq->lock);
1947
Tejun Heo63d95a92012-07-12 14:46:37 -07001948 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001949 /*
1950 * We've been trying to create a new worker but
1951 * haven't been successful. We might be hitting an
1952 * allocation deadlock. Send distress signals to
1953 * rescuers.
1954 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001955 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001956 send_mayday(work);
1957 }
1958
1959 spin_unlock_irq(&gcwq->lock);
1960
Tejun Heo63d95a92012-07-12 14:46:37 -07001961 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001962}
1963
1964/**
1965 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001966 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001967 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001968 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001969 * have at least one idle worker on return from this function. If
1970 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001971 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001972 * possible allocation deadlock.
1973 *
1974 * On return, need_to_create_worker() is guaranteed to be false and
1975 * may_start_working() true.
1976 *
1977 * LOCKING:
1978 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1979 * multiple times. Does GFP_KERNEL allocations. Called only from
1980 * manager.
1981 *
1982 * RETURNS:
1983 * false if no action was taken and gcwq->lock stayed locked, true
1984 * otherwise.
1985 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001986static bool maybe_create_worker(struct worker_pool *pool)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001987__releases(&gcwq->lock)
1988__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001989{
Tejun Heo63d95a92012-07-12 14:46:37 -07001990 struct global_cwq *gcwq = pool->gcwq;
1991
1992 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001993 return false;
1994restart:
Tejun Heo9f9c2362010-07-14 11:31:20 +02001995 spin_unlock_irq(&gcwq->lock);
1996
Tejun Heoe22bee72010-06-29 10:07:14 +02001997 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001998 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001999
2000 while (true) {
2001 struct worker *worker;
2002
Tejun Heobc2ae0f2012-07-17 12:39:27 -07002003 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002004 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002005 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002006 spin_lock_irq(&gcwq->lock);
2007 start_worker(worker);
Tejun Heo63d95a92012-07-12 14:46:37 -07002008 BUG_ON(need_to_create_worker(pool));
Tejun Heoe22bee72010-06-29 10:07:14 +02002009 return true;
2010 }
2011
Tejun Heo63d95a92012-07-12 14:46:37 -07002012 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002013 break;
2014
Tejun Heoe22bee72010-06-29 10:07:14 +02002015 __set_current_state(TASK_INTERRUPTIBLE);
2016 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02002017
Tejun Heo63d95a92012-07-12 14:46:37 -07002018 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002019 break;
2020 }
2021
Tejun Heo63d95a92012-07-12 14:46:37 -07002022 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002023 spin_lock_irq(&gcwq->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07002024 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002025 goto restart;
2026 return true;
2027}
2028
2029/**
2030 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07002031 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02002032 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002033 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02002034 * IDLE_WORKER_TIMEOUT.
2035 *
2036 * LOCKING:
2037 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2038 * multiple times. Called only from manager.
2039 *
2040 * RETURNS:
2041 * false if no action was taken and gcwq->lock stayed locked, true
2042 * otherwise.
2043 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002044static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02002045{
2046 bool ret = false;
2047
Tejun Heo63d95a92012-07-12 14:46:37 -07002048 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002049 struct worker *worker;
2050 unsigned long expires;
2051
Tejun Heo63d95a92012-07-12 14:46:37 -07002052 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002053 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2054
2055 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002056 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02002057 break;
2058 }
2059
2060 destroy_worker(worker);
2061 ret = true;
2062 }
2063
2064 return ret;
2065}
2066
2067/**
2068 * manage_workers - manage worker pool
2069 * @worker: self
2070 *
2071 * Assume the manager role and manage gcwq worker pool @worker belongs
2072 * to. At any given time, there can be only zero or one manager per
2073 * gcwq. The exclusion is handled automatically by this function.
2074 *
2075 * The caller can safely start processing works on false return. On
2076 * true return, it's guaranteed that need_to_create_worker() is false
2077 * and may_start_working() is true.
2078 *
2079 * CONTEXT:
2080 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2081 * multiple times. Does GFP_KERNEL allocations.
2082 *
2083 * RETURNS:
2084 * false if no action was taken and gcwq->lock stayed locked, true if
2085 * some action was taken.
2086 */
2087static bool manage_workers(struct worker *worker)
2088{
Tejun Heo63d95a92012-07-12 14:46:37 -07002089 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002090 bool ret = false;
2091
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002092 if (pool->flags & POOL_MANAGING_WORKERS)
Tejun Heoe22bee72010-06-29 10:07:14 +02002093 return ret;
2094
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002095 pool->flags |= POOL_MANAGING_WORKERS;
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002096
2097 /*
2098 * To simplify both worker management and CPU hotplug, hold off
2099 * management while hotplug is in progress. CPU hotplug path can't
2100 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2101 * lead to idle worker depletion (all become busy thinking someone
2102 * else is managing) which in turn can result in deadlock under
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002103 * extreme circumstances. Use @pool->assoc_mutex to synchronize
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002104 * manager against CPU hotplug.
2105 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002106 * assoc_mutex would always be free unless CPU hotplug is in
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002107 * progress. trylock first without dropping @gcwq->lock.
2108 */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002109 if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002110 spin_unlock_irq(&pool->gcwq->lock);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002111 mutex_lock(&pool->assoc_mutex);
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002112 /*
2113 * CPU hotplug could have happened while we were waiting
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002114 * for assoc_mutex. Hotplug itself can't handle us
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002115 * because manager isn't either on idle or busy list, and
2116 * @gcwq's state and ours could have deviated.
2117 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002118 * As hotplug is now excluded via assoc_mutex, we can
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002119 * simply try to bind. It will succeed or fail depending
2120 * on @gcwq's current state. Try it and adjust
2121 * %WORKER_UNBOUND accordingly.
2122 */
2123 if (worker_maybe_bind_and_lock(worker))
2124 worker->flags &= ~WORKER_UNBOUND;
2125 else
2126 worker->flags |= WORKER_UNBOUND;
2127
2128 ret = true;
2129 }
2130
Tejun Heo11ebea52012-07-12 14:46:37 -07002131 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002132
2133 /*
2134 * Destroy and then create so that may_start_working() is true
2135 * on return.
2136 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002137 ret |= maybe_destroy_workers(pool);
2138 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002139
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002140 pool->flags &= ~POOL_MANAGING_WORKERS;
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002141 mutex_unlock(&pool->assoc_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02002142 return ret;
2143}
2144
Tejun Heoa62428c2010-06-29 10:07:10 +02002145/**
2146 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002147 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002148 * @work: work to process
2149 *
2150 * Process @work. This function contains all the logics necessary to
2151 * process a single work including synchronization against and
2152 * interaction with other workers on the same cpu, queueing and
2153 * flushing. As long as context requirement is met, any worker can
2154 * call this function to process a work.
2155 *
2156 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002157 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002158 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002159static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09002160__releases(&gcwq->lock)
2161__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002162{
Tejun Heo7e116292010-06-29 10:07:13 +02002163 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002164 struct worker_pool *pool = worker->pool;
2165 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002166 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002167 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02002168 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02002169 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002170 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002171#ifdef CONFIG_LOCKDEP
2172 /*
2173 * It is permissible to free the struct work_struct from
2174 * inside the function that is called from it, this we need to
2175 * take into account for lockdep too. To avoid bogus "held
2176 * lock freed" warnings as well as problems when looking into
2177 * work->lockdep_map, make a copy and use that here.
2178 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002179 struct lockdep_map lockdep_map;
2180
2181 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002182#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002183 /*
2184 * Ensure we're on the correct CPU. DISASSOCIATED test is
2185 * necessary to avoid spurious warnings from rescuers servicing the
2186 * unbound or a disassociated gcwq.
2187 */
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002188 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
Tejun Heo6fec10a2012-07-22 10:16:34 -07002189 !(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heo25511a42012-07-17 12:39:27 -07002190 raw_smp_processor_id() != gcwq->cpu);
2191
Tejun Heo7e116292010-06-29 10:07:13 +02002192 /*
2193 * A single work shouldn't be executed concurrently by
2194 * multiple workers on a single cpu. Check whether anyone is
2195 * already processing the work. If so, defer the work to the
2196 * currently executing one.
2197 */
2198 collision = __find_worker_executing_work(gcwq, bwh, work);
2199 if (unlikely(collision)) {
2200 move_linked_works(work, &collision->scheduled, NULL);
2201 return;
2202 }
2203
Tejun Heo8930cab2012-08-03 10:30:45 -07002204 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002205 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002206 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02002207 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002208 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002209 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002210
Tejun Heoa62428c2010-06-29 10:07:10 +02002211 list_del_init(&work->entry);
2212
Tejun Heo649027d2010-06-29 10:07:14 +02002213 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002214 * CPU intensive works don't participate in concurrency
2215 * management. They're the scheduler's responsibility.
2216 */
2217 if (unlikely(cpu_intensive))
2218 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2219
Tejun Heo974271c2012-07-12 14:46:37 -07002220 /*
2221 * Unbound gcwq isn't concurrency managed and work items should be
2222 * executed ASAP. Wake up another worker if necessary.
2223 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002224 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2225 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002226
Tejun Heo8930cab2012-08-03 10:30:45 -07002227 /*
Tejun Heo23657bb2012-08-13 17:08:19 -07002228 * Record the last CPU and clear PENDING which should be the last
2229 * update to @work. Also, do this inside @gcwq->lock so that
2230 * PENDING and queued state changes happen together while IRQ is
2231 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002232 */
Tejun Heo8930cab2012-08-03 10:30:45 -07002233 set_work_cpu_and_clear_pending(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02002234
Tejun Heo8930cab2012-08-03 10:30:45 -07002235 spin_unlock_irq(&gcwq->lock);
Tejun Heo959d1af2012-08-03 10:30:45 -07002236
Tejun Heoe1594892011-01-09 23:32:15 +01002237 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002238 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002239 trace_workqueue_execute_start(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002240 f(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002241 /*
2242 * While we must be careful to not use "work" after this, the trace
2243 * point will only record its address.
2244 */
2245 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002246 lock_map_release(&lockdep_map);
2247 lock_map_release(&cwq->wq->lockdep_map);
2248
2249 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002250 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2251 " last function: %pf\n",
2252 current->comm, preempt_count(), task_pid_nr(current), f);
Tejun Heoa62428c2010-06-29 10:07:10 +02002253 debug_show_held_locks(current);
2254 dump_stack();
2255 }
2256
Tejun Heo8b03ae32010-06-29 10:07:12 +02002257 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002258
Tejun Heofb0e7be2010-06-29 10:07:15 +02002259 /* clear cpu intensive status */
2260 if (unlikely(cpu_intensive))
2261 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2262
Tejun Heoa62428c2010-06-29 10:07:10 +02002263 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02002264 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002265 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002266 worker->current_cwq = NULL;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02002267 cwq_dec_nr_in_flight(cwq, work_color, false);
Tejun Heoa62428c2010-06-29 10:07:10 +02002268}
2269
Tejun Heoaffee4b2010-06-29 10:07:12 +02002270/**
2271 * process_scheduled_works - process scheduled works
2272 * @worker: self
2273 *
2274 * Process all scheduled works. Please note that the scheduled list
2275 * may change while processing a work, so this function repeatedly
2276 * fetches a work from the top and executes it.
2277 *
2278 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002279 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002280 * multiple times.
2281 */
2282static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002284 while (!list_empty(&worker->scheduled)) {
2285 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002287 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289}
2290
Tejun Heo4690c4a2010-06-29 10:07:10 +02002291/**
2292 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002293 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002294 *
Tejun Heoe22bee72010-06-29 10:07:14 +02002295 * The gcwq worker thread function. There's a single dynamic pool of
2296 * these per each cpu. These workers process all works regardless of
2297 * their specific target workqueue. The only exception is works which
2298 * belong to workqueues with a rescuer which will be explained in
2299 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002300 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002301static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302{
Tejun Heoc34056a2010-06-29 10:07:11 +02002303 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002304 struct worker_pool *pool = worker->pool;
2305 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306
Tejun Heoe22bee72010-06-29 10:07:14 +02002307 /* tell the scheduler that this is a workqueue worker */
2308 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002309woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002310 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002312 /* we are off idle list if destruction or rebind is requested */
2313 if (unlikely(list_empty(&worker->entry))) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002314 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002315
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002316 /* if DIE is set, destruction is requested */
Tejun Heo25511a42012-07-17 12:39:27 -07002317 if (worker->flags & WORKER_DIE) {
2318 worker->task->flags &= ~PF_WQ_WORKER;
2319 return 0;
2320 }
2321
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002322 /* otherwise, rebind */
Tejun Heo25511a42012-07-17 12:39:27 -07002323 idle_worker_rebind(worker);
2324 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 }
2326
Tejun Heoc8e55f32010-06-29 10:07:12 +02002327 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002328recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002329 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002330 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002331 goto sleep;
2332
2333 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002334 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002335 goto recheck;
2336
Tejun Heoc8e55f32010-06-29 10:07:12 +02002337 /*
2338 * ->scheduled list can only be filled while a worker is
2339 * preparing to process a work or actually processing it.
2340 * Make sure nobody diddled with it while I was sleeping.
2341 */
2342 BUG_ON(!list_empty(&worker->scheduled));
2343
Tejun Heoe22bee72010-06-29 10:07:14 +02002344 /*
2345 * When control reaches this point, we're guaranteed to have
2346 * at least one idle worker or that someone else has already
2347 * assumed the manager role.
2348 */
2349 worker_clr_flags(worker, WORKER_PREP);
2350
2351 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002352 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002353 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002354 struct work_struct, entry);
2355
2356 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2357 /* optimization path, not strictly necessary */
2358 process_one_work(worker, work);
2359 if (unlikely(!list_empty(&worker->scheduled)))
2360 process_scheduled_works(worker);
2361 } else {
2362 move_linked_works(work, &worker->scheduled, NULL);
2363 process_scheduled_works(worker);
2364 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002365 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002366
Tejun Heoe22bee72010-06-29 10:07:14 +02002367 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002368sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002369 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002370 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002371
Tejun Heoc8e55f32010-06-29 10:07:12 +02002372 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02002373 * gcwq->lock is held and there's no work to process and no
2374 * need to manage, sleep. Workers are woken up only while
2375 * holding gcwq->lock or from local cpu, so setting the
2376 * current state before releasing gcwq->lock is enough to
2377 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002378 */
2379 worker_enter_idle(worker);
2380 __set_current_state(TASK_INTERRUPTIBLE);
2381 spin_unlock_irq(&gcwq->lock);
2382 schedule();
2383 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384}
2385
Tejun Heoe22bee72010-06-29 10:07:14 +02002386/**
2387 * rescuer_thread - the rescuer thread function
2388 * @__wq: the associated workqueue
2389 *
2390 * Workqueue rescuer thread function. There's one rescuer for each
2391 * workqueue which has WQ_RESCUER set.
2392 *
2393 * Regular work processing on a gcwq may block trying to create a new
2394 * worker which uses GFP_KERNEL allocation which has slight chance of
2395 * developing into deadlock if some works currently on the same queue
2396 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2397 * the problem rescuer solves.
2398 *
2399 * When such condition is possible, the gcwq summons rescuers of all
2400 * workqueues which have works queued on the gcwq and let them process
2401 * those works so that forward progress can be guaranteed.
2402 *
2403 * This should happen rarely.
2404 */
2405static int rescuer_thread(void *__wq)
2406{
2407 struct workqueue_struct *wq = __wq;
2408 struct worker *rescuer = wq->rescuer;
2409 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002410 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002411 unsigned int cpu;
2412
2413 set_user_nice(current, RESCUER_NICE_LEVEL);
2414repeat:
2415 set_current_state(TASK_INTERRUPTIBLE);
2416
2417 if (kthread_should_stop())
2418 return 0;
2419
Tejun Heof3421792010-07-02 10:03:51 +02002420 /*
2421 * See whether any cpu is asking for help. Unbounded
2422 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2423 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002424 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002425 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2426 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002427 struct worker_pool *pool = cwq->pool;
2428 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002429 struct work_struct *work, *n;
2430
2431 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002432 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002433
2434 /* migrate to the target cpu if possible */
Tejun Heobd7bdd42012-07-12 14:46:37 -07002435 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002436 worker_maybe_bind_and_lock(rescuer);
2437
2438 /*
2439 * Slurp in all works issued via this workqueue and
2440 * process'em.
2441 */
2442 BUG_ON(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002443 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002444 if (get_work_cwq(work) == cwq)
2445 move_linked_works(work, scheduled, &n);
2446
2447 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002448
2449 /*
2450 * Leave this gcwq. If keep_working() is %true, notify a
2451 * regular worker; otherwise, we end up with 0 concurrency
2452 * and stalling the execution.
2453 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002454 if (keep_working(pool))
2455 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002456
Tejun Heoe22bee72010-06-29 10:07:14 +02002457 spin_unlock_irq(&gcwq->lock);
2458 }
2459
2460 schedule();
2461 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462}
2463
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002464struct wq_barrier {
2465 struct work_struct work;
2466 struct completion done;
2467};
2468
2469static void wq_barrier_func(struct work_struct *work)
2470{
2471 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2472 complete(&barr->done);
2473}
2474
Tejun Heo4690c4a2010-06-29 10:07:10 +02002475/**
2476 * insert_wq_barrier - insert a barrier work
2477 * @cwq: cwq to insert barrier into
2478 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002479 * @target: target work to attach @barr to
2480 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002481 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002482 * @barr is linked to @target such that @barr is completed only after
2483 * @target finishes execution. Please note that the ordering
2484 * guarantee is observed only with respect to @target and on the local
2485 * cpu.
2486 *
2487 * Currently, a queued barrier can't be canceled. This is because
2488 * try_to_grab_pending() can't determine whether the work to be
2489 * grabbed is at the head of the queue and thus can't clear LINKED
2490 * flag of the previous work while there must be a valid next work
2491 * after a work with LINKED flag set.
2492 *
2493 * Note that when @worker is non-NULL, @target may be modified
2494 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002495 *
2496 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002497 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002498 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002499static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002500 struct wq_barrier *barr,
2501 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002502{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002503 struct list_head *head;
2504 unsigned int linked = 0;
2505
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002506 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002507 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002508 * as we know for sure that this will not trigger any of the
2509 * checks and call back into the fixup functions where we
2510 * might deadlock.
2511 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002512 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002513 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002514 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002515
Tejun Heoaffee4b2010-06-29 10:07:12 +02002516 /*
2517 * If @target is currently being executed, schedule the
2518 * barrier to the worker; otherwise, put it after @target.
2519 */
2520 if (worker)
2521 head = worker->scheduled.next;
2522 else {
2523 unsigned long *bits = work_data_bits(target);
2524
2525 head = target->entry.next;
2526 /* there can already be other linked works, inherit and set */
2527 linked = *bits & WORK_STRUCT_LINKED;
2528 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2529 }
2530
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002531 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002532 insert_work(cwq, &barr->work, head,
2533 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002534}
2535
Tejun Heo73f53c42010-06-29 10:07:11 +02002536/**
2537 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2538 * @wq: workqueue being flushed
2539 * @flush_color: new flush color, < 0 for no-op
2540 * @work_color: new work color, < 0 for no-op
2541 *
2542 * Prepare cwqs for workqueue flushing.
2543 *
2544 * If @flush_color is non-negative, flush_color on all cwqs should be
2545 * -1. If no cwq has in-flight commands at the specified color, all
2546 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2547 * has in flight commands, its cwq->flush_color is set to
2548 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2549 * wakeup logic is armed and %true is returned.
2550 *
2551 * The caller should have initialized @wq->first_flusher prior to
2552 * calling this function with non-negative @flush_color. If
2553 * @flush_color is negative, no flush color update is done and %false
2554 * is returned.
2555 *
2556 * If @work_color is non-negative, all cwqs should have the same
2557 * work_color which is previous to @work_color and all will be
2558 * advanced to @work_color.
2559 *
2560 * CONTEXT:
2561 * mutex_lock(wq->flush_mutex).
2562 *
2563 * RETURNS:
2564 * %true if @flush_color >= 0 and there's something to flush. %false
2565 * otherwise.
2566 */
2567static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2568 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569{
Tejun Heo73f53c42010-06-29 10:07:11 +02002570 bool wait = false;
2571 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002572
Tejun Heo73f53c42010-06-29 10:07:11 +02002573 if (flush_color >= 0) {
2574 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2575 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002576 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002577
Tejun Heof3421792010-07-02 10:03:51 +02002578 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002579 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002580 struct global_cwq *gcwq = cwq->pool->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002581
Tejun Heo8b03ae32010-06-29 10:07:12 +02002582 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002583
2584 if (flush_color >= 0) {
2585 BUG_ON(cwq->flush_color != -1);
2586
2587 if (cwq->nr_in_flight[flush_color]) {
2588 cwq->flush_color = flush_color;
2589 atomic_inc(&wq->nr_cwqs_to_flush);
2590 wait = true;
2591 }
2592 }
2593
2594 if (work_color >= 0) {
2595 BUG_ON(work_color != work_next_color(cwq->work_color));
2596 cwq->work_color = work_color;
2597 }
2598
Tejun Heo8b03ae32010-06-29 10:07:12 +02002599 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002600 }
2601
2602 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2603 complete(&wq->first_flusher->done);
2604
2605 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606}
2607
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002608/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002610 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002611 *
2612 * Forces execution of the workqueue and blocks until its completion.
2613 * This is typically used in driver shutdown handlers.
2614 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002615 * We sleep until all works which were queued on entry have been handled,
2616 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002618void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002619{
Tejun Heo73f53c42010-06-29 10:07:11 +02002620 struct wq_flusher this_flusher = {
2621 .list = LIST_HEAD_INIT(this_flusher.list),
2622 .flush_color = -1,
2623 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2624 };
2625 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002626
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002627 lock_map_acquire(&wq->lockdep_map);
2628 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002629
2630 mutex_lock(&wq->flush_mutex);
2631
2632 /*
2633 * Start-to-wait phase
2634 */
2635 next_color = work_next_color(wq->work_color);
2636
2637 if (next_color != wq->flush_color) {
2638 /*
2639 * Color space is not full. The current work_color
2640 * becomes our flush_color and work_color is advanced
2641 * by one.
2642 */
2643 BUG_ON(!list_empty(&wq->flusher_overflow));
2644 this_flusher.flush_color = wq->work_color;
2645 wq->work_color = next_color;
2646
2647 if (!wq->first_flusher) {
2648 /* no flush in progress, become the first flusher */
2649 BUG_ON(wq->flush_color != this_flusher.flush_color);
2650
2651 wq->first_flusher = &this_flusher;
2652
2653 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2654 wq->work_color)) {
2655 /* nothing to flush, done */
2656 wq->flush_color = next_color;
2657 wq->first_flusher = NULL;
2658 goto out_unlock;
2659 }
2660 } else {
2661 /* wait in queue */
2662 BUG_ON(wq->flush_color == this_flusher.flush_color);
2663 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2664 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2665 }
2666 } else {
2667 /*
2668 * Oops, color space is full, wait on overflow queue.
2669 * The next flush completion will assign us
2670 * flush_color and transfer to flusher_queue.
2671 */
2672 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2673 }
2674
2675 mutex_unlock(&wq->flush_mutex);
2676
2677 wait_for_completion(&this_flusher.done);
2678
2679 /*
2680 * Wake-up-and-cascade phase
2681 *
2682 * First flushers are responsible for cascading flushes and
2683 * handling overflow. Non-first flushers can simply return.
2684 */
2685 if (wq->first_flusher != &this_flusher)
2686 return;
2687
2688 mutex_lock(&wq->flush_mutex);
2689
Tejun Heo4ce48b32010-07-02 10:03:51 +02002690 /* we might have raced, check again with mutex held */
2691 if (wq->first_flusher != &this_flusher)
2692 goto out_unlock;
2693
Tejun Heo73f53c42010-06-29 10:07:11 +02002694 wq->first_flusher = NULL;
2695
2696 BUG_ON(!list_empty(&this_flusher.list));
2697 BUG_ON(wq->flush_color != this_flusher.flush_color);
2698
2699 while (true) {
2700 struct wq_flusher *next, *tmp;
2701
2702 /* complete all the flushers sharing the current flush color */
2703 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2704 if (next->flush_color != wq->flush_color)
2705 break;
2706 list_del_init(&next->list);
2707 complete(&next->done);
2708 }
2709
2710 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2711 wq->flush_color != work_next_color(wq->work_color));
2712
2713 /* this flush_color is finished, advance by one */
2714 wq->flush_color = work_next_color(wq->flush_color);
2715
2716 /* one color has been freed, handle overflow queue */
2717 if (!list_empty(&wq->flusher_overflow)) {
2718 /*
2719 * Assign the same color to all overflowed
2720 * flushers, advance work_color and append to
2721 * flusher_queue. This is the start-to-wait
2722 * phase for these overflowed flushers.
2723 */
2724 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2725 tmp->flush_color = wq->work_color;
2726
2727 wq->work_color = work_next_color(wq->work_color);
2728
2729 list_splice_tail_init(&wq->flusher_overflow,
2730 &wq->flusher_queue);
2731 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2732 }
2733
2734 if (list_empty(&wq->flusher_queue)) {
2735 BUG_ON(wq->flush_color != wq->work_color);
2736 break;
2737 }
2738
2739 /*
2740 * Need to flush more colors. Make the next flusher
2741 * the new first flusher and arm cwqs.
2742 */
2743 BUG_ON(wq->flush_color == wq->work_color);
2744 BUG_ON(wq->flush_color != next->flush_color);
2745
2746 list_del_init(&next->list);
2747 wq->first_flusher = next;
2748
2749 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2750 break;
2751
2752 /*
2753 * Meh... this color is already done, clear first
2754 * flusher and repeat cascading.
2755 */
2756 wq->first_flusher = NULL;
2757 }
2758
2759out_unlock:
2760 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761}
Dave Jonesae90dd52006-06-30 01:40:45 -04002762EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002763
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002764/**
2765 * drain_workqueue - drain a workqueue
2766 * @wq: workqueue to drain
2767 *
2768 * Wait until the workqueue becomes empty. While draining is in progress,
2769 * only chain queueing is allowed. IOW, only currently pending or running
2770 * work items on @wq can queue further work items on it. @wq is flushed
2771 * repeatedly until it becomes empty. The number of flushing is detemined
2772 * by the depth of chaining and should be relatively short. Whine if it
2773 * takes too long.
2774 */
2775void drain_workqueue(struct workqueue_struct *wq)
2776{
2777 unsigned int flush_cnt = 0;
2778 unsigned int cpu;
2779
2780 /*
2781 * __queue_work() needs to test whether there are drainers, is much
2782 * hotter than drain_workqueue() and already looks at @wq->flags.
2783 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2784 */
2785 spin_lock(&workqueue_lock);
2786 if (!wq->nr_drainers++)
2787 wq->flags |= WQ_DRAINING;
2788 spin_unlock(&workqueue_lock);
2789reflush:
2790 flush_workqueue(wq);
2791
2792 for_each_cwq_cpu(cpu, wq) {
2793 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002794 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002795
Tejun Heobd7bdd42012-07-12 14:46:37 -07002796 spin_lock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002797 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002798 spin_unlock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002799
2800 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002801 continue;
2802
2803 if (++flush_cnt == 10 ||
2804 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Valentin Ilie044c7822012-08-19 00:52:42 +03002805 pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
2806 wq->name, flush_cnt);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002807 goto reflush;
2808 }
2809
2810 spin_lock(&workqueue_lock);
2811 if (!--wq->nr_drainers)
2812 wq->flags &= ~WQ_DRAINING;
2813 spin_unlock(&workqueue_lock);
2814}
2815EXPORT_SYMBOL_GPL(drain_workqueue);
2816
Tejun Heo606a5022012-08-20 14:51:23 -07002817static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002818{
2819 struct worker *worker = NULL;
2820 struct global_cwq *gcwq;
2821 struct cpu_workqueue_struct *cwq;
2822
2823 might_sleep();
2824 gcwq = get_work_gcwq(work);
2825 if (!gcwq)
2826 return false;
2827
2828 spin_lock_irq(&gcwq->lock);
2829 if (!list_empty(&work->entry)) {
2830 /*
2831 * See the comment near try_to_grab_pending()->smp_rmb().
2832 * If it was re-queued to a different gcwq under us, we
2833 * are not going to wait.
2834 */
2835 smp_rmb();
2836 cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002837 if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
Tejun Heobaf59022010-09-16 10:42:16 +02002838 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002839 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002840 worker = find_worker_executing_work(gcwq, work);
2841 if (!worker)
2842 goto already_gone;
2843 cwq = worker->current_cwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002844 }
Tejun Heobaf59022010-09-16 10:42:16 +02002845
2846 insert_wq_barrier(cwq, barr, work, worker);
2847 spin_unlock_irq(&gcwq->lock);
2848
Tejun Heoe1594892011-01-09 23:32:15 +01002849 /*
2850 * If @max_active is 1 or rescuer is in use, flushing another work
2851 * item on the same workqueue may lead to deadlock. Make sure the
2852 * flusher is not running on the same workqueue by verifying write
2853 * access.
2854 */
2855 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2856 lock_map_acquire(&cwq->wq->lockdep_map);
2857 else
2858 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002859 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002860
Tejun Heobaf59022010-09-16 10:42:16 +02002861 return true;
2862already_gone:
2863 spin_unlock_irq(&gcwq->lock);
2864 return false;
2865}
2866
Oleg Nesterovdb700892008-07-25 01:47:49 -07002867/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002868 * flush_work - wait for a work to finish executing the last queueing instance
2869 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002870 *
Tejun Heo606a5022012-08-20 14:51:23 -07002871 * Wait until @work has finished execution. @work is guaranteed to be idle
2872 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002873 *
2874 * RETURNS:
2875 * %true if flush_work() waited for the work to finish execution,
2876 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002877 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002878bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002879{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002880 struct wq_barrier barr;
2881
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002882 lock_map_acquire(&work->lockdep_map);
2883 lock_map_release(&work->lockdep_map);
2884
Tejun Heo606a5022012-08-20 14:51:23 -07002885 if (start_flush_work(work, &barr)) {
Tejun Heobaf59022010-09-16 10:42:16 +02002886 wait_for_completion(&barr.done);
2887 destroy_work_on_stack(&barr.work);
2888 return true;
Tejun Heo606a5022012-08-20 14:51:23 -07002889 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002890 return false;
Tejun Heo606a5022012-08-20 14:51:23 -07002891 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002892}
2893EXPORT_SYMBOL_GPL(flush_work);
2894
Tejun Heo36e227d2012-08-03 10:30:46 -07002895static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002896{
Tejun Heobbb68df2012-08-03 10:30:46 -07002897 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002898 int ret;
2899
2900 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002901 ret = try_to_grab_pending(work, is_dwork, &flags);
2902 /*
2903 * If someone else is canceling, wait for the same event it
2904 * would be waiting for before retrying.
2905 */
2906 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002907 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002908 } while (unlikely(ret < 0));
2909
Tejun Heobbb68df2012-08-03 10:30:46 -07002910 /* tell other tasks trying to grab @work to back off */
2911 mark_work_canceling(work);
2912 local_irq_restore(flags);
2913
Tejun Heo606a5022012-08-20 14:51:23 -07002914 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002915 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002916 return ret;
2917}
2918
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002919/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002920 * cancel_work_sync - cancel a work and wait for it to finish
2921 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002922 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002923 * Cancel @work and wait for its execution to finish. This function
2924 * can be used even if the work re-queues itself or migrates to
2925 * another workqueue. On return from this function, @work is
2926 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002927 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002928 * cancel_work_sync(&delayed_work->work) must not be used for
2929 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002930 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002931 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002932 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002933 *
2934 * RETURNS:
2935 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002936 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002937bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002938{
Tejun Heo36e227d2012-08-03 10:30:46 -07002939 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002940}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002941EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002942
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002943/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002944 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2945 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002946 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002947 * Delayed timer is cancelled and the pending work is queued for
2948 * immediate execution. Like flush_work(), this function only
2949 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002950 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002951 * RETURNS:
2952 * %true if flush_work() waited for the work to finish execution,
2953 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002954 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002955bool flush_delayed_work(struct delayed_work *dwork)
2956{
Tejun Heo8930cab2012-08-03 10:30:45 -07002957 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002958 if (del_timer_sync(&dwork->timer))
Tejun Heo12650572012-08-08 09:38:42 -07002959 __queue_work(dwork->cpu,
Tejun Heo401a8d02010-09-16 10:36:00 +02002960 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002961 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002962 return flush_work(&dwork->work);
2963}
2964EXPORT_SYMBOL(flush_delayed_work);
2965
2966/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002967 * cancel_delayed_work - cancel a delayed work
2968 * @dwork: delayed_work to cancel
2969 *
2970 * Kill off a pending delayed_work. Returns %true if @dwork was pending
2971 * and canceled; %false if wasn't pending. Note that the work callback
2972 * function may still be running on return, unless it returns %true and the
2973 * work doesn't re-arm itself. Explicitly flush or use
2974 * cancel_delayed_work_sync() to wait on it.
2975 *
2976 * This function is safe to call from any context including IRQ handler.
2977 */
2978bool cancel_delayed_work(struct delayed_work *dwork)
2979{
2980 unsigned long flags;
2981 int ret;
2982
2983 do {
2984 ret = try_to_grab_pending(&dwork->work, true, &flags);
2985 } while (unlikely(ret == -EAGAIN));
2986
2987 if (unlikely(ret < 0))
2988 return false;
2989
2990 set_work_cpu_and_clear_pending(&dwork->work, work_cpu(&dwork->work));
2991 local_irq_restore(flags);
2992 return true;
2993}
2994EXPORT_SYMBOL(cancel_delayed_work);
2995
2996/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002997 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2998 * @dwork: the delayed work cancel
2999 *
3000 * This is cancel_work_sync() for delayed works.
3001 *
3002 * RETURNS:
3003 * %true if @dwork was pending, %false otherwise.
3004 */
3005bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003006{
Tejun Heo36e227d2012-08-03 10:30:46 -07003007 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003008}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003009EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010
Tejun Heod4283e92012-08-03 10:30:44 -07003011/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003012 * schedule_work_on - put work task on a specific cpu
3013 * @cpu: cpu to put the work task on
3014 * @work: job to be done
3015 *
3016 * This puts a job on a specific cpu
3017 */
Tejun Heod4283e92012-08-03 10:30:44 -07003018bool schedule_work_on(int cpu, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07003019{
3020 return queue_work_on(cpu, system_wq, work);
3021}
3022EXPORT_SYMBOL(schedule_work_on);
3023
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003024/**
3025 * schedule_work - put work task in global workqueue
3026 * @work: job to be done
3027 *
Tejun Heod4283e92012-08-03 10:30:44 -07003028 * Returns %false if @work was already on the kernel-global workqueue and
3029 * %true otherwise.
Bart Van Assche5b0f437d2009-07-30 19:00:53 +02003030 *
3031 * This puts a job in the kernel-global workqueue if it was not already
3032 * queued and leaves it in the same position on the kernel-global
3033 * workqueue otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003034 */
Tejun Heod4283e92012-08-03 10:30:44 -07003035bool schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003036{
Tejun Heod320c032010-06-29 10:07:14 +02003037 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003038}
Dave Jonesae90dd52006-06-30 01:40:45 -04003039EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003040
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003041/**
3042 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
3043 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +00003044 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003045 * @delay: number of jiffies to wait
3046 *
3047 * After waiting for a given time this puts a job in the kernel-global
3048 * workqueue on the specified CPU.
3049 */
Tejun Heod4283e92012-08-03 10:30:44 -07003050bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3051 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003052{
Tejun Heod320c032010-06-29 10:07:14 +02003053 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003054}
Dave Jonesae90dd52006-06-30 01:40:45 -04003055EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003056
Andrew Mortonb6136772006-06-25 05:47:49 -07003057/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003058 * schedule_delayed_work - put work task in global workqueue after delay
3059 * @dwork: job to be done
3060 * @delay: number of jiffies to wait or 0 for immediate execution
3061 *
3062 * After waiting for a given time this puts a job in the kernel-global
3063 * workqueue.
3064 */
Tejun Heod4283e92012-08-03 10:30:44 -07003065bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
Tejun Heo0a13c002012-08-03 10:30:44 -07003066{
3067 return queue_delayed_work(system_wq, dwork, delay);
3068}
3069EXPORT_SYMBOL(schedule_delayed_work);
3070
3071/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003072 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003073 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003074 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003075 * schedule_on_each_cpu() executes @func on each online CPU using the
3076 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003077 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003078 *
3079 * RETURNS:
3080 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003081 */
David Howells65f27f32006-11-22 14:55:48 +00003082int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003083{
3084 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003085 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003086
Andrew Mortonb6136772006-06-25 05:47:49 -07003087 works = alloc_percpu(struct work_struct);
3088 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003089 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003090
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003091 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003092
Christoph Lameter15316ba2006-01-08 01:00:43 -08003093 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003094 struct work_struct *work = per_cpu_ptr(works, cpu);
3095
3096 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003097 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003098 }
Tejun Heo93981802009-11-17 14:06:20 -08003099
3100 for_each_online_cpu(cpu)
3101 flush_work(per_cpu_ptr(works, cpu));
3102
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003103 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003104 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003105 return 0;
3106}
3107
Alan Sterneef6a7d2010-02-12 17:39:21 +09003108/**
3109 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3110 *
3111 * Forces execution of the kernel-global workqueue and blocks until its
3112 * completion.
3113 *
3114 * Think twice before calling this function! It's very easy to get into
3115 * trouble if you don't take great care. Either of the following situations
3116 * will lead to deadlock:
3117 *
3118 * One of the work items currently on the workqueue needs to acquire
3119 * a lock held by your code or its caller.
3120 *
3121 * Your code is running in the context of a work routine.
3122 *
3123 * They will be detected by lockdep when they occur, but the first might not
3124 * occur very often. It depends on what work items are on the workqueue and
3125 * what locks they need, which you have no control over.
3126 *
3127 * In most situations flushing the entire workqueue is overkill; you merely
3128 * need to know that a particular work item isn't queued and isn't running.
3129 * In such cases you should use cancel_delayed_work_sync() or
3130 * cancel_work_sync() instead.
3131 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003132void flush_scheduled_work(void)
3133{
Tejun Heod320c032010-06-29 10:07:14 +02003134 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003135}
Dave Jonesae90dd52006-06-30 01:40:45 -04003136EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003137
3138/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003139 * execute_in_process_context - reliably execute the routine with user context
3140 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003141 * @ew: guaranteed storage for the execute work structure (must
3142 * be available when the work executes)
3143 *
3144 * Executes the function immediately if process context is available,
3145 * otherwise schedules the function for delayed execution.
3146 *
3147 * Returns: 0 - function was executed
3148 * 1 - function was scheduled for execution
3149 */
David Howells65f27f32006-11-22 14:55:48 +00003150int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003151{
3152 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003153 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003154 return 0;
3155 }
3156
David Howells65f27f32006-11-22 14:55:48 +00003157 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003158 schedule_work(&ew->work);
3159
3160 return 1;
3161}
3162EXPORT_SYMBOL_GPL(execute_in_process_context);
3163
Linus Torvalds1da177e2005-04-16 15:20:36 -07003164int keventd_up(void)
3165{
Tejun Heod320c032010-06-29 10:07:14 +02003166 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003167}
3168
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003169static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170{
Oleg Nesterov3af244332007-05-09 02:34:09 -07003171 /*
Tejun Heo0f900042010-06-29 10:07:11 +02003172 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
3173 * Make sure that the alignment isn't lower than that of
3174 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07003175 */
Tejun Heo0f900042010-06-29 10:07:11 +02003176 const size_t size = sizeof(struct cpu_workqueue_struct);
3177 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
3178 __alignof__(unsigned long long));
Oleg Nesterov3af244332007-05-09 02:34:09 -07003179
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003180 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003181 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02003182 else {
Tejun Heof3421792010-07-02 10:03:51 +02003183 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003184
Tejun Heof3421792010-07-02 10:03:51 +02003185 /*
3186 * Allocate enough room to align cwq and put an extra
3187 * pointer at the end pointing back to the originally
3188 * allocated pointer which will be used for free.
3189 */
3190 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3191 if (ptr) {
3192 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3193 *(void **)(wq->cpu_wq.single + 1) = ptr;
3194 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003195 }
Tejun Heof3421792010-07-02 10:03:51 +02003196
Tejun Heo0415b00d12011-03-24 18:50:09 +01003197 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003198 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3199 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003200}
3201
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003202static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003203{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003204 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003205 free_percpu(wq->cpu_wq.pcpu);
3206 else if (wq->cpu_wq.single) {
3207 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003208 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003209 }
3210}
3211
Tejun Heof3421792010-07-02 10:03:51 +02003212static int wq_clamp_max_active(int max_active, unsigned int flags,
3213 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003214{
Tejun Heof3421792010-07-02 10:03:51 +02003215 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3216
3217 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003218 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3219 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003220
Tejun Heof3421792010-07-02 10:03:51 +02003221 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003222}
3223
Tejun Heob196be82012-01-10 15:11:35 -08003224struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003225 unsigned int flags,
3226 int max_active,
3227 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003228 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003229{
Tejun Heob196be82012-01-10 15:11:35 -08003230 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003231 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003232 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08003233 size_t namelen;
3234
3235 /* determine namelen, allocate wq and format name */
3236 va_start(args, lock_name);
3237 va_copy(args1, args);
3238 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3239
3240 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3241 if (!wq)
3242 goto err;
3243
3244 vsnprintf(wq->name, namelen, fmt, args1);
3245 va_end(args);
3246 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003247
Tejun Heof3421792010-07-02 10:03:51 +02003248 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02003249 * Workqueues which may be used during memory reclaim should
3250 * have a rescuer to guarantee forward progress.
3251 */
3252 if (flags & WQ_MEM_RECLAIM)
3253 flags |= WQ_RESCUER;
3254
Tejun Heod320c032010-06-29 10:07:14 +02003255 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003256 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003257
Tejun Heob196be82012-01-10 15:11:35 -08003258 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003259 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003260 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003261 mutex_init(&wq->flush_mutex);
3262 atomic_set(&wq->nr_cwqs_to_flush, 0);
3263 INIT_LIST_HEAD(&wq->flusher_queue);
3264 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003265
Johannes Bergeb13ba82008-01-16 09:51:58 +01003266 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003267 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003268
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003269 if (alloc_cwqs(wq) < 0)
3270 goto err;
3271
Tejun Heof3421792010-07-02 10:03:51 +02003272 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003273 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003274 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo32704762012-07-13 22:16:45 -07003275 int pool_idx = (bool)(flags & WQ_HIGHPRI);
Tejun Heo15376632010-06-29 10:07:11 +02003276
Tejun Heo0f900042010-06-29 10:07:11 +02003277 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo32704762012-07-13 22:16:45 -07003278 cwq->pool = &gcwq->pools[pool_idx];
Tejun Heoc34056a2010-06-29 10:07:11 +02003279 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003280 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003281 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003282 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003283 }
3284
Tejun Heoe22bee72010-06-29 10:07:14 +02003285 if (flags & WQ_RESCUER) {
3286 struct worker *rescuer;
3287
Tejun Heof2e005a2010-07-20 15:59:09 +02003288 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003289 goto err;
3290
3291 wq->rescuer = rescuer = alloc_worker();
3292 if (!rescuer)
3293 goto err;
3294
Tejun Heob196be82012-01-10 15:11:35 -08003295 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3296 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003297 if (IS_ERR(rescuer->task))
3298 goto err;
3299
Tejun Heoe22bee72010-06-29 10:07:14 +02003300 rescuer->task->flags |= PF_THREAD_BOUND;
3301 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003302 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003303
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003304 /*
3305 * workqueue_lock protects global freeze state and workqueues
3306 * list. Grab it, set max_active accordingly and add the new
3307 * workqueue to workqueues list.
3308 */
Tejun Heo15376632010-06-29 10:07:11 +02003309 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003310
Tejun Heo58a69cb2011-02-16 09:25:31 +01003311 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003312 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003313 get_cwq(cpu, wq)->max_active = 0;
3314
Tejun Heo15376632010-06-29 10:07:11 +02003315 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003316
Tejun Heo15376632010-06-29 10:07:11 +02003317 spin_unlock(&workqueue_lock);
3318
Oleg Nesterov3af244332007-05-09 02:34:09 -07003319 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003320err:
3321 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003322 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003323 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003324 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003325 kfree(wq);
3326 }
3327 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003328}
Tejun Heod320c032010-06-29 10:07:14 +02003329EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003330
3331/**
3332 * destroy_workqueue - safely terminate a workqueue
3333 * @wq: target workqueue
3334 *
3335 * Safely destroy a workqueue. All work currently pending will be done first.
3336 */
3337void destroy_workqueue(struct workqueue_struct *wq)
3338{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003339 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003340
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003341 /* drain it before proceeding with destruction */
3342 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003343
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003344 /*
3345 * wq list is used to freeze wq, remove from list after
3346 * flushing is complete in case freeze races us.
3347 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003348 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07003349 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003350 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003351
Tejun Heoe22bee72010-06-29 10:07:14 +02003352 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003353 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003354 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3355 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003356
Tejun Heo73f53c42010-06-29 10:07:11 +02003357 for (i = 0; i < WORK_NR_COLORS; i++)
3358 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003359 BUG_ON(cwq->nr_active);
3360 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003361 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003362
Tejun Heoe22bee72010-06-29 10:07:14 +02003363 if (wq->flags & WQ_RESCUER) {
3364 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003365 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003366 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003367 }
3368
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003369 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003370 kfree(wq);
3371}
3372EXPORT_SYMBOL_GPL(destroy_workqueue);
3373
Tejun Heodcd989c2010-06-29 10:07:14 +02003374/**
3375 * workqueue_set_max_active - adjust max_active of a workqueue
3376 * @wq: target workqueue
3377 * @max_active: new max_active value.
3378 *
3379 * Set max_active of @wq to @max_active.
3380 *
3381 * CONTEXT:
3382 * Don't call from IRQ context.
3383 */
3384void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3385{
3386 unsigned int cpu;
3387
Tejun Heof3421792010-07-02 10:03:51 +02003388 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003389
3390 spin_lock(&workqueue_lock);
3391
3392 wq->saved_max_active = max_active;
3393
Tejun Heof3421792010-07-02 10:03:51 +02003394 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003395 struct global_cwq *gcwq = get_gcwq(cpu);
3396
3397 spin_lock_irq(&gcwq->lock);
3398
Tejun Heo58a69cb2011-02-16 09:25:31 +01003399 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003400 !(gcwq->flags & GCWQ_FREEZING))
3401 get_cwq(gcwq->cpu, wq)->max_active = max_active;
3402
3403 spin_unlock_irq(&gcwq->lock);
3404 }
3405
3406 spin_unlock(&workqueue_lock);
3407}
3408EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3409
3410/**
3411 * workqueue_congested - test whether a workqueue is congested
3412 * @cpu: CPU in question
3413 * @wq: target workqueue
3414 *
3415 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3416 * no synchronization around this function and the test result is
3417 * unreliable and only useful as advisory hints or for debugging.
3418 *
3419 * RETURNS:
3420 * %true if congested, %false otherwise.
3421 */
3422bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3423{
3424 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3425
3426 return !list_empty(&cwq->delayed_works);
3427}
3428EXPORT_SYMBOL_GPL(workqueue_congested);
3429
3430/**
3431 * work_cpu - return the last known associated cpu for @work
3432 * @work: the work of interest
3433 *
3434 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003435 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003436 */
3437unsigned int work_cpu(struct work_struct *work)
3438{
3439 struct global_cwq *gcwq = get_work_gcwq(work);
3440
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003441 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003442}
3443EXPORT_SYMBOL_GPL(work_cpu);
3444
3445/**
3446 * work_busy - test whether a work is currently pending or running
3447 * @work: the work to be tested
3448 *
3449 * Test whether @work is currently pending or running. There is no
3450 * synchronization around this function and the test result is
3451 * unreliable and only useful as advisory hints or for debugging.
3452 * Especially for reentrant wqs, the pending state might hide the
3453 * running state.
3454 *
3455 * RETURNS:
3456 * OR'd bitmask of WORK_BUSY_* bits.
3457 */
3458unsigned int work_busy(struct work_struct *work)
3459{
3460 struct global_cwq *gcwq = get_work_gcwq(work);
3461 unsigned long flags;
3462 unsigned int ret = 0;
3463
3464 if (!gcwq)
3465 return false;
3466
3467 spin_lock_irqsave(&gcwq->lock, flags);
3468
3469 if (work_pending(work))
3470 ret |= WORK_BUSY_PENDING;
3471 if (find_worker_executing_work(gcwq, work))
3472 ret |= WORK_BUSY_RUNNING;
3473
3474 spin_unlock_irqrestore(&gcwq->lock, flags);
3475
3476 return ret;
3477}
3478EXPORT_SYMBOL_GPL(work_busy);
3479
Tejun Heodb7bccf2010-06-29 10:07:12 +02003480/*
3481 * CPU hotplug.
3482 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003483 * There are two challenges in supporting CPU hotplug. Firstly, there
3484 * are a lot of assumptions on strong associations among work, cwq and
3485 * gcwq which make migrating pending and scheduled works very
3486 * difficult to implement without impacting hot paths. Secondly,
3487 * gcwqs serve mix of short, long and very long running works making
3488 * blocked draining impractical.
3489 *
Tejun Heo628c78e2012-07-17 12:39:27 -07003490 * This is solved by allowing a gcwq to be disassociated from the CPU
3491 * running as an unbound one and allowing it to be reattached later if the
3492 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003493 */
3494
Tejun Heo60373152012-07-17 12:39:27 -07003495/* claim manager positions of all pools */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003496static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003497{
3498 struct worker_pool *pool;
3499
3500 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003501 mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
Tejun Heo8db25e72012-07-17 12:39:28 -07003502 spin_lock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003503}
3504
3505/* release manager positions */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003506static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003507{
3508 struct worker_pool *pool;
3509
Tejun Heo8db25e72012-07-17 12:39:28 -07003510 spin_unlock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003511 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003512 mutex_unlock(&pool->assoc_mutex);
Tejun Heo60373152012-07-17 12:39:27 -07003513}
3514
Tejun Heo628c78e2012-07-17 12:39:27 -07003515static void gcwq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003516{
Tejun Heo628c78e2012-07-17 12:39:27 -07003517 struct global_cwq *gcwq = get_gcwq(smp_processor_id());
Tejun Heo4ce62e92012-07-13 22:16:44 -07003518 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003519 struct worker *worker;
3520 struct hlist_node *pos;
3521 int i;
3522
3523 BUG_ON(gcwq->cpu != smp_processor_id());
3524
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003525 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003526
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003527 /*
3528 * We've claimed all manager positions. Make all workers unbound
3529 * and set DISASSOCIATED. Before this, all workers except for the
3530 * ones which are still executing works from before the last CPU
3531 * down must be on the cpu. After this, they may become diasporas.
3532 */
Tejun Heo60373152012-07-17 12:39:27 -07003533 for_each_worker_pool(pool, gcwq)
Tejun Heo4ce62e92012-07-13 22:16:44 -07003534 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07003535 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003536
3537 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo403c8212012-07-17 12:39:27 -07003538 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003539
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003540 gcwq->flags |= GCWQ_DISASSOCIATED;
3541
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003542 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003543
3544 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07003545 * Call schedule() so that we cross rq->lock and thus can guarantee
3546 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3547 * as scheduler callbacks may be invoked from other cpus.
3548 */
3549 schedule();
3550
3551 /*
3552 * Sched callbacks are disabled now. Zap nr_running. After this,
3553 * nr_running stays zero and need_more_worker() and keep_working()
3554 * are always true as long as the worklist is not empty. @gcwq now
3555 * behaves as unbound (in terms of concurrency management) gcwq
3556 * which is served by workers tied to the CPU.
3557 *
3558 * On return from this function, the current worker would trigger
3559 * unbound chain execution of pending work items if other workers
3560 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02003561 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07003562 for_each_worker_pool(pool, gcwq)
3563 atomic_set(get_pool_nr_running(pool), 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003564}
3565
Tejun Heo8db25e72012-07-17 12:39:28 -07003566/*
3567 * Workqueues should be brought up before normal priority CPU notifiers.
3568 * This will be registered high priority CPU notifier.
3569 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003570static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07003571 unsigned long action,
3572 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003573{
3574 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003575 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003576 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003577
Tejun Heo8db25e72012-07-17 12:39:28 -07003578 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003579 case CPU_UP_PREPARE:
Tejun Heo4ce62e92012-07-13 22:16:44 -07003580 for_each_worker_pool(pool, gcwq) {
Tejun Heo3ce63372012-07-17 12:39:27 -07003581 struct worker *worker;
3582
3583 if (pool->nr_workers)
3584 continue;
3585
3586 worker = create_worker(pool);
3587 if (!worker)
3588 return NOTIFY_BAD;
3589
3590 spin_lock_irq(&gcwq->lock);
3591 start_worker(worker);
3592 spin_unlock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003593 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003594 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003595
Tejun Heo65758202012-07-17 12:39:26 -07003596 case CPU_DOWN_FAILED:
3597 case CPU_ONLINE:
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003598 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heo8db25e72012-07-17 12:39:28 -07003599 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3600 rebind_workers(gcwq);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003601 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heo8db25e72012-07-17 12:39:28 -07003602 break;
Tejun Heo65758202012-07-17 12:39:26 -07003603 }
3604 return NOTIFY_OK;
3605}
3606
3607/*
3608 * Workqueues should be brought down after normal priority CPU notifiers.
3609 * This will be registered as low priority CPU notifier.
3610 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003611static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07003612 unsigned long action,
3613 void *hcpu)
3614{
Tejun Heo8db25e72012-07-17 12:39:28 -07003615 unsigned int cpu = (unsigned long)hcpu;
3616 struct work_struct unbind_work;
3617
Tejun Heo65758202012-07-17 12:39:26 -07003618 switch (action & ~CPU_TASKS_FROZEN) {
3619 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003620 /* unbinding should happen on the local CPU */
3621 INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09003622 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07003623 flush_work(&unbind_work);
3624 break;
Tejun Heo65758202012-07-17 12:39:26 -07003625 }
3626 return NOTIFY_OK;
3627}
3628
Rusty Russell2d3854a2008-11-05 13:39:10 +11003629#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003630
Rusty Russell2d3854a2008-11-05 13:39:10 +11003631struct work_for_cpu {
Andrew Morton6b440032009-04-09 09:50:37 -06003632 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003633 long (*fn)(void *);
3634 void *arg;
3635 long ret;
3636};
3637
Andrew Morton6b440032009-04-09 09:50:37 -06003638static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003639{
Andrew Morton6b440032009-04-09 09:50:37 -06003640 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003641 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b440032009-04-09 09:50:37 -06003642 complete(&wfc->completion);
3643 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003644}
3645
3646/**
3647 * work_on_cpu - run a function in user context on a particular cpu
3648 * @cpu: the cpu to run on
3649 * @fn: the function to run
3650 * @arg: the function arg
3651 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003652 * This will return the value @fn returns.
3653 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06003654 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003655 */
3656long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3657{
Andrew Morton6b440032009-04-09 09:50:37 -06003658 struct task_struct *sub_thread;
3659 struct work_for_cpu wfc = {
3660 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3661 .fn = fn,
3662 .arg = arg,
3663 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003664
Andrew Morton6b440032009-04-09 09:50:37 -06003665 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3666 if (IS_ERR(sub_thread))
3667 return PTR_ERR(sub_thread);
3668 kthread_bind(sub_thread, cpu);
3669 wake_up_process(sub_thread);
3670 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003671 return wfc.ret;
3672}
3673EXPORT_SYMBOL_GPL(work_on_cpu);
3674#endif /* CONFIG_SMP */
3675
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003676#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303677
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003678/**
3679 * freeze_workqueues_begin - begin freezing workqueues
3680 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003681 * Start freezing workqueues. After this function returns, all freezable
3682 * workqueues will queue new works to their frozen_works list instead of
3683 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003684 *
3685 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003686 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003687 */
3688void freeze_workqueues_begin(void)
3689{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003690 unsigned int cpu;
3691
3692 spin_lock(&workqueue_lock);
3693
3694 BUG_ON(workqueue_freezing);
3695 workqueue_freezing = true;
3696
Tejun Heof3421792010-07-02 10:03:51 +02003697 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003698 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003699 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003700
3701 spin_lock_irq(&gcwq->lock);
3702
Tejun Heodb7bccf2010-06-29 10:07:12 +02003703 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3704 gcwq->flags |= GCWQ_FREEZING;
3705
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003706 list_for_each_entry(wq, &workqueues, list) {
3707 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3708
Tejun Heo58a69cb2011-02-16 09:25:31 +01003709 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003710 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003711 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003712
3713 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003714 }
3715
3716 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003717}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003718
3719/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003720 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003721 *
3722 * Check whether freezing is complete. This function must be called
3723 * between freeze_workqueues_begin() and thaw_workqueues().
3724 *
3725 * CONTEXT:
3726 * Grabs and releases workqueue_lock.
3727 *
3728 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003729 * %true if some freezable workqueues are still busy. %false if freezing
3730 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003731 */
3732bool freeze_workqueues_busy(void)
3733{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003734 unsigned int cpu;
3735 bool busy = false;
3736
3737 spin_lock(&workqueue_lock);
3738
3739 BUG_ON(!workqueue_freezing);
3740
Tejun Heof3421792010-07-02 10:03:51 +02003741 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003742 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003743 /*
3744 * nr_active is monotonically decreasing. It's safe
3745 * to peek without lock.
3746 */
3747 list_for_each_entry(wq, &workqueues, list) {
3748 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3749
Tejun Heo58a69cb2011-02-16 09:25:31 +01003750 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003751 continue;
3752
3753 BUG_ON(cwq->nr_active < 0);
3754 if (cwq->nr_active) {
3755 busy = true;
3756 goto out_unlock;
3757 }
3758 }
3759 }
3760out_unlock:
3761 spin_unlock(&workqueue_lock);
3762 return busy;
3763}
3764
3765/**
3766 * thaw_workqueues - thaw workqueues
3767 *
3768 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003769 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003770 *
3771 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003772 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003773 */
3774void thaw_workqueues(void)
3775{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003776 unsigned int cpu;
3777
3778 spin_lock(&workqueue_lock);
3779
3780 if (!workqueue_freezing)
3781 goto out_unlock;
3782
Tejun Heof3421792010-07-02 10:03:51 +02003783 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003784 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003785 struct worker_pool *pool;
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003786 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003787
3788 spin_lock_irq(&gcwq->lock);
3789
Tejun Heodb7bccf2010-06-29 10:07:12 +02003790 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3791 gcwq->flags &= ~GCWQ_FREEZING;
3792
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003793 list_for_each_entry(wq, &workqueues, list) {
3794 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3795
Tejun Heo58a69cb2011-02-16 09:25:31 +01003796 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003797 continue;
3798
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003799 /* restore max_active and repopulate worklist */
3800 cwq->max_active = wq->saved_max_active;
3801
3802 while (!list_empty(&cwq->delayed_works) &&
3803 cwq->nr_active < cwq->max_active)
3804 cwq_activate_first_delayed(cwq);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003805 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003806
Tejun Heo4ce62e92012-07-13 22:16:44 -07003807 for_each_worker_pool(pool, gcwq)
3808 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02003809
Tejun Heo8b03ae32010-06-29 10:07:12 +02003810 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003811 }
3812
3813 workqueue_freezing = false;
3814out_unlock:
3815 spin_unlock(&workqueue_lock);
3816}
3817#endif /* CONFIG_FREEZER */
3818
Suresh Siddha6ee05782010-07-30 14:57:37 -07003819static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003820{
Tejun Heoc34056a2010-06-29 10:07:11 +02003821 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003822 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02003823
Tejun Heob5490072012-08-03 10:30:46 -07003824 /* make sure we have enough bits for OFFQ CPU number */
3825 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3826 WORK_CPU_LAST);
3827
Tejun Heo65758202012-07-17 12:39:26 -07003828 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07003829 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003830
3831 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003832 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003833 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003834 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003835
3836 spin_lock_init(&gcwq->lock);
3837 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003838 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003839
Tejun Heoc8e55f32010-06-29 10:07:12 +02003840 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3841 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3842
Tejun Heo4ce62e92012-07-13 22:16:44 -07003843 for_each_worker_pool(pool, gcwq) {
3844 pool->gcwq = gcwq;
3845 INIT_LIST_HEAD(&pool->worklist);
3846 INIT_LIST_HEAD(&pool->idle_list);
Tejun Heoe22bee72010-06-29 10:07:14 +02003847
Tejun Heo4ce62e92012-07-13 22:16:44 -07003848 init_timer_deferrable(&pool->idle_timer);
3849 pool->idle_timer.function = idle_worker_timeout;
3850 pool->idle_timer.data = (unsigned long)pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003851
Tejun Heo4ce62e92012-07-13 22:16:44 -07003852 setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
3853 (unsigned long)pool);
3854
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003855 mutex_init(&pool->assoc_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003856 ida_init(&pool->worker_ida);
3857 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003858 }
3859
Tejun Heoe22bee72010-06-29 10:07:14 +02003860 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003861 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003862 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003863 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003864
Tejun Heo477a3c32010-08-31 10:54:35 +02003865 if (cpu != WORK_CPU_UNBOUND)
3866 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003867
3868 for_each_worker_pool(pool, gcwq) {
3869 struct worker *worker;
3870
Tejun Heobc2ae0f2012-07-17 12:39:27 -07003871 worker = create_worker(pool);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003872 BUG_ON(!worker);
3873 spin_lock_irq(&gcwq->lock);
3874 start_worker(worker);
3875 spin_unlock_irq(&gcwq->lock);
3876 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003877 }
3878
Tejun Heod320c032010-06-29 10:07:14 +02003879 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003880 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02003881 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003882 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3883 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003884 system_freezable_wq = alloc_workqueue("events_freezable",
3885 WQ_FREEZABLE, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003886 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Tejun Heoae930e02012-08-20 14:51:23 -07003887 !system_unbound_wq || !system_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003888 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003889}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003890early_initcall(init_workqueues);