blob: 4f5c61f8b0e7c548768a1eb85b0b3d7841720f3c [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
Tejun Heobf4ede02012-08-03 10:30:46 -07001002 *
1003 * A work either has completed or is removed from pending queue,
1004 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1005 *
1006 * CONTEXT:
1007 * spin_lock_irq(gcwq->lock).
1008 */
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001009static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001010{
1011 /* ignore uncolored works */
1012 if (color == WORK_NO_COLOR)
1013 return;
1014
1015 cwq->nr_in_flight[color]--;
1016
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001017 cwq->nr_active--;
1018 if (!list_empty(&cwq->delayed_works)) {
1019 /* one down, submit a delayed one */
1020 if (cwq->nr_active < cwq->max_active)
1021 cwq_activate_first_delayed(cwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001022 }
1023
1024 /* is flush in progress and are we at the flushing tip? */
1025 if (likely(cwq->flush_color != color))
1026 return;
1027
1028 /* are there still in-flight works? */
1029 if (cwq->nr_in_flight[color])
1030 return;
1031
1032 /* this cwq is done, clear flush_color */
1033 cwq->flush_color = -1;
1034
1035 /*
1036 * If this was the last cwq, wake up the first flusher. It
1037 * will handle the rest.
1038 */
1039 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1040 complete(&cwq->wq->first_flusher->done);
1041}
1042
Tejun Heo36e227d2012-08-03 10:30:46 -07001043/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001044 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001045 * @work: work item to steal
1046 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001047 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001048 *
1049 * Try to grab PENDING bit of @work. This function can handle @work in any
1050 * stable state - idle, on timer or on worklist. Return values are
1051 *
1052 * 1 if @work was pending and we successfully stole PENDING
1053 * 0 if @work was idle and we claimed PENDING
1054 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001055 * -ENOENT if someone else is canceling @work, this state may persist
1056 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001057 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001058 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001059 * interrupted while holding PENDING and @work off queue, irq must be
1060 * disabled on entry. This, combined with delayed_work->timer being
1061 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001062 *
1063 * On successful return, >= 0, irq is disabled and the caller is
1064 * responsible for releasing it using local_irq_restore(*@flags).
1065 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001066 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001067 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001068static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1069 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001070{
1071 struct global_cwq *gcwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001072
Tejun Heobbb68df2012-08-03 10:30:46 -07001073 WARN_ON_ONCE(in_irq());
1074
1075 local_irq_save(*flags);
1076
Tejun Heo36e227d2012-08-03 10:30:46 -07001077 /* try to steal the timer if it exists */
1078 if (is_dwork) {
1079 struct delayed_work *dwork = to_delayed_work(work);
1080
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001081 /*
1082 * dwork->timer is irqsafe. If del_timer() fails, it's
1083 * guaranteed that the timer is not queued anywhere and not
1084 * running on the local CPU.
1085 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001086 if (likely(del_timer(&dwork->timer)))
1087 return 1;
1088 }
1089
1090 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001091 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1092 return 0;
1093
1094 /*
1095 * The queueing is in progress, or it is already queued. Try to
1096 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1097 */
1098 gcwq = get_work_gcwq(work);
1099 if (!gcwq)
Tejun Heobbb68df2012-08-03 10:30:46 -07001100 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001101
Tejun Heobbb68df2012-08-03 10:30:46 -07001102 spin_lock(&gcwq->lock);
Tejun Heobf4ede02012-08-03 10:30:46 -07001103 if (!list_empty(&work->entry)) {
1104 /*
1105 * This work is queued, but perhaps we locked the wrong gcwq.
1106 * In that case we must see the new value after rmb(), see
1107 * insert_work()->wmb().
1108 */
1109 smp_rmb();
1110 if (gcwq == get_work_gcwq(work)) {
1111 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001112
1113 /*
1114 * A delayed work item cannot be grabbed directly
1115 * because it might have linked NO_COLOR work items
1116 * which, if left on the delayed_list, will confuse
1117 * cwq->nr_active management later on and cause
1118 * stall. Make sure the work item is activated
1119 * before grabbing.
1120 */
1121 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1122 cwq_activate_delayed_work(work);
1123
Tejun Heobf4ede02012-08-03 10:30:46 -07001124 list_del_init(&work->entry);
1125 cwq_dec_nr_in_flight(get_work_cwq(work),
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001126 get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001127
Tejun Heobbb68df2012-08-03 10:30:46 -07001128 spin_unlock(&gcwq->lock);
Tejun Heo36e227d2012-08-03 10:30:46 -07001129 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001130 }
1131 }
Tejun Heobbb68df2012-08-03 10:30:46 -07001132 spin_unlock(&gcwq->lock);
1133fail:
1134 local_irq_restore(*flags);
1135 if (work_is_canceling(work))
1136 return -ENOENT;
1137 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001138 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001139}
1140
1141/**
Tejun Heo7e116292010-06-29 10:07:13 +02001142 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +02001143 * @cwq: cwq @work belongs to
1144 * @work: work to insert
1145 * @head: insertion point
1146 * @extra_flags: extra WORK_STRUCT_* flags to set
1147 *
Tejun Heo7e116292010-06-29 10:07:13 +02001148 * Insert @work which belongs to @cwq into @gcwq after @head.
1149 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001150 *
1151 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001152 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001153 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001154static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +02001155 struct work_struct *work, struct list_head *head,
1156 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001157{
Tejun Heo63d95a92012-07-12 14:46:37 -07001158 struct worker_pool *pool = cwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001159
Tejun Heo4690c4a2010-06-29 10:07:10 +02001160 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +02001161 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001162
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001163 /*
1164 * Ensure that we get the right work->data if we see the
1165 * result of list_add() below, see try_to_grab_pending().
1166 */
1167 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +02001168
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001169 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +02001170
1171 /*
1172 * Ensure either worker_sched_deactivated() sees the above
1173 * list_add_tail() or we see zero nr_running to avoid workers
1174 * lying around lazily while there are works to be processed.
1175 */
1176 smp_mb();
1177
Tejun Heo63d95a92012-07-12 14:46:37 -07001178 if (__need_more_worker(pool))
1179 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001180}
1181
Tejun Heoc8efcc22010-12-20 19:32:04 +01001182/*
1183 * Test whether @work is being queued from another work executing on the
1184 * same workqueue. This is rather expensive and should only be used from
1185 * cold paths.
1186 */
1187static bool is_chained_work(struct workqueue_struct *wq)
1188{
1189 unsigned long flags;
1190 unsigned int cpu;
1191
1192 for_each_gcwq_cpu(cpu) {
1193 struct global_cwq *gcwq = get_gcwq(cpu);
1194 struct worker *worker;
1195 struct hlist_node *pos;
1196 int i;
1197
1198 spin_lock_irqsave(&gcwq->lock, flags);
1199 for_each_busy_worker(worker, i, pos, gcwq) {
1200 if (worker->task != current)
1201 continue;
1202 spin_unlock_irqrestore(&gcwq->lock, flags);
1203 /*
1204 * I'm @worker, no locking necessary. See if @work
1205 * is headed to the same workqueue.
1206 */
1207 return worker->current_cwq->wq == wq;
1208 }
1209 spin_unlock_irqrestore(&gcwq->lock, flags);
1210 }
1211 return false;
1212}
1213
Tejun Heo4690c4a2010-06-29 10:07:10 +02001214static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 struct work_struct *work)
1216{
Tejun Heo502ca9d2010-06-29 10:07:13 +02001217 struct global_cwq *gcwq;
1218 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001219 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001220 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001221 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001222
1223 /*
1224 * While a work item is PENDING && off queue, a task trying to
1225 * steal the PENDING will busy-loop waiting for it to either get
1226 * queued or lose PENDING. Grabbing PENDING and queueing should
1227 * happen with IRQ disabled.
1228 */
1229 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001231 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001232
Tejun Heoc8efcc22010-12-20 19:32:04 +01001233 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02001234 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001235 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001236 return;
1237
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001238 /* determine gcwq to use */
1239 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001240 struct global_cwq *last_gcwq;
1241
Tejun Heo57469822012-08-03 10:30:45 -07001242 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001243 cpu = raw_smp_processor_id();
1244
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001245 /*
Tejun Heodbf25762012-08-20 14:51:23 -07001246 * It's multi cpu. If @work was previously on a different
1247 * cpu, it might still be running there, in which case the
1248 * work needs to be queued on that cpu to guarantee
1249 * non-reentrancy.
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001250 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001251 gcwq = get_gcwq(cpu);
Tejun Heodbf25762012-08-20 14:51:23 -07001252 last_gcwq = get_work_gcwq(work);
1253
1254 if (last_gcwq && last_gcwq != gcwq) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001255 struct worker *worker;
1256
Tejun Heo8930cab2012-08-03 10:30:45 -07001257 spin_lock(&last_gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001258
1259 worker = find_worker_executing_work(last_gcwq, work);
1260
1261 if (worker && worker->current_cwq->wq == wq)
1262 gcwq = last_gcwq;
1263 else {
1264 /* meh... not running there, queue here */
Tejun Heo8930cab2012-08-03 10:30:45 -07001265 spin_unlock(&last_gcwq->lock);
1266 spin_lock(&gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001267 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001268 } else {
1269 spin_lock(&gcwq->lock);
1270 }
Tejun Heof3421792010-07-02 10:03:51 +02001271 } else {
1272 gcwq = get_gcwq(WORK_CPU_UNBOUND);
Tejun Heo8930cab2012-08-03 10:30:45 -07001273 spin_lock(&gcwq->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001274 }
1275
1276 /* gcwq determined, get cwq and queue */
1277 cwq = get_cwq(gcwq->cpu, wq);
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001278 trace_workqueue_queue_work(req_cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001279
Dan Carpenterf5b25522012-04-13 22:06:58 +03001280 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo8930cab2012-08-03 10:30:45 -07001281 spin_unlock(&gcwq->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001282 return;
1283 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001284
Tejun Heo73f53c42010-06-29 10:07:11 +02001285 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001286 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001287
1288 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001289 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001290 cwq->nr_active++;
Tejun Heo32704762012-07-13 22:16:45 -07001291 worklist = &cwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001292 } else {
1293 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001294 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001295 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001296
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001297 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001298
Tejun Heo8930cab2012-08-03 10:30:45 -07001299 spin_unlock(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300}
1301
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001302/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001303 * queue_work_on - queue work on specific cpu
1304 * @cpu: CPU number to execute work on
1305 * @wq: workqueue to use
1306 * @work: work to queue
1307 *
Tejun Heod4283e92012-08-03 10:30:44 -07001308 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001309 *
1310 * We queue the work to a specific CPU, the caller must ensure it
1311 * can't go away.
1312 */
Tejun Heod4283e92012-08-03 10:30:44 -07001313bool queue_work_on(int cpu, struct workqueue_struct *wq,
1314 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001315{
Tejun Heod4283e92012-08-03 10:30:44 -07001316 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001317 unsigned long flags;
1318
1319 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001320
Tejun Heo22df02b2010-06-29 10:07:10 +02001321 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001322 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001323 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001324 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001325
1326 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001327 return ret;
1328}
1329EXPORT_SYMBOL_GPL(queue_work_on);
1330
Tejun Heo0a13c002012-08-03 10:30:44 -07001331/**
1332 * queue_work - queue work on a workqueue
1333 * @wq: workqueue to use
1334 * @work: work to queue
1335 *
Tejun Heod4283e92012-08-03 10:30:44 -07001336 * Returns %false if @work was already on a queue, %true otherwise.
Tejun Heo0a13c002012-08-03 10:30:44 -07001337 *
1338 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1339 * it can be processed by another CPU.
1340 */
Tejun Heod4283e92012-08-03 10:30:44 -07001341bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07001342{
Tejun Heo57469822012-08-03 10:30:45 -07001343 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
Tejun Heo0a13c002012-08-03 10:30:44 -07001344}
1345EXPORT_SYMBOL_GPL(queue_work);
1346
Tejun Heod8e794d2012-08-03 10:30:45 -07001347void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348{
David Howells52bad642006-11-22 14:54:01 +00001349 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001350 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001352 /* should have been called from irqsafe timer with irq already off */
Tejun Heo12650572012-08-08 09:38:42 -07001353 __queue_work(dwork->cpu, cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354}
Tejun Heod8e794d2012-08-03 10:30:45 -07001355EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001357static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1358 struct delayed_work *dwork, unsigned long delay)
1359{
1360 struct timer_list *timer = &dwork->timer;
1361 struct work_struct *work = &dwork->work;
1362 unsigned int lcpu;
1363
1364 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1365 timer->data != (unsigned long)dwork);
1366 BUG_ON(timer_pending(timer));
1367 BUG_ON(!list_empty(&work->entry));
1368
1369 timer_stats_timer_set_start_info(&dwork->timer);
1370
1371 /*
1372 * This stores cwq for the moment, for the timer_fn. Note that the
1373 * work's gcwq is preserved to allow reentrance detection for
1374 * delayed works.
1375 */
1376 if (!(wq->flags & WQ_UNBOUND)) {
1377 struct global_cwq *gcwq = get_work_gcwq(work);
1378
Joonsoo Kime42986d2012-08-15 23:25:38 +09001379 /*
1380 * If we cannot get the last gcwq from @work directly,
1381 * select the last CPU such that it avoids unnecessarily
1382 * triggering non-reentrancy check in __queue_work().
1383 */
1384 lcpu = cpu;
1385 if (gcwq)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001386 lcpu = gcwq->cpu;
Joonsoo Kime42986d2012-08-15 23:25:38 +09001387 if (lcpu == WORK_CPU_UNBOUND)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001388 lcpu = raw_smp_processor_id();
1389 } else {
1390 lcpu = WORK_CPU_UNBOUND;
1391 }
1392
1393 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1394
Tejun Heo12650572012-08-08 09:38:42 -07001395 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001396 timer->expires = jiffies + delay;
1397
1398 if (unlikely(cpu != WORK_CPU_UNBOUND))
1399 add_timer_on(timer, cpu);
1400 else
1401 add_timer(timer);
1402}
1403
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001404/**
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001405 * queue_delayed_work_on - queue work on specific CPU after delay
1406 * @cpu: CPU number to execute work on
1407 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001408 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001409 * @delay: number of jiffies to wait before queueing
1410 *
Tejun Heo715f1302012-08-03 10:30:46 -07001411 * Returns %false if @work was already on a queue, %true otherwise. If
1412 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1413 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001414 */
Tejun Heod4283e92012-08-03 10:30:44 -07001415bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1416 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001417{
David Howells52bad642006-11-22 14:54:01 +00001418 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001419 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001420 unsigned long flags;
1421
Tejun Heo715f1302012-08-03 10:30:46 -07001422 if (!delay)
1423 return queue_work_on(cpu, wq, &dwork->work);
1424
Tejun Heo8930cab2012-08-03 10:30:45 -07001425 /* read the comment in __queue_work() */
1426 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001427
Tejun Heo22df02b2010-06-29 10:07:10 +02001428 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001429 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001430 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001431 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001432
1433 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001434 return ret;
1435}
Dave Jonesae90dd52006-06-30 01:40:45 -04001436EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437
Tejun Heoc8e55f32010-06-29 10:07:12 +02001438/**
Tejun Heo0a13c002012-08-03 10:30:44 -07001439 * queue_delayed_work - queue work on a workqueue after delay
1440 * @wq: workqueue to use
1441 * @dwork: delayable work to queue
1442 * @delay: number of jiffies to wait before queueing
1443 *
Tejun Heo715f1302012-08-03 10:30:46 -07001444 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
Tejun Heo0a13c002012-08-03 10:30:44 -07001445 */
Tejun Heod4283e92012-08-03 10:30:44 -07001446bool queue_delayed_work(struct workqueue_struct *wq,
Tejun Heo0a13c002012-08-03 10:30:44 -07001447 struct delayed_work *dwork, unsigned long delay)
1448{
Tejun Heo57469822012-08-03 10:30:45 -07001449 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
Tejun Heo0a13c002012-08-03 10:30:44 -07001450}
1451EXPORT_SYMBOL_GPL(queue_delayed_work);
1452
1453/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001454 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1455 * @cpu: CPU number to execute work on
1456 * @wq: workqueue to use
1457 * @dwork: work to queue
1458 * @delay: number of jiffies to wait before queueing
1459 *
1460 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1461 * modify @dwork's timer so that it expires after @delay. If @delay is
1462 * zero, @work is guaranteed to be scheduled immediately regardless of its
1463 * current state.
1464 *
1465 * Returns %false if @dwork was idle and queued, %true if @dwork was
1466 * pending and its timer was modified.
1467 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001468 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001469 * See try_to_grab_pending() for details.
1470 */
1471bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1472 struct delayed_work *dwork, unsigned long delay)
1473{
1474 unsigned long flags;
1475 int ret;
1476
1477 do {
1478 ret = try_to_grab_pending(&dwork->work, true, &flags);
1479 } while (unlikely(ret == -EAGAIN));
1480
1481 if (likely(ret >= 0)) {
1482 __queue_delayed_work(cpu, wq, dwork, delay);
1483 local_irq_restore(flags);
1484 }
1485
1486 /* -ENOENT from try_to_grab_pending() becomes %true */
1487 return ret;
1488}
1489EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1490
1491/**
1492 * mod_delayed_work - modify delay of or queue a delayed work
1493 * @wq: workqueue to use
1494 * @dwork: work to queue
1495 * @delay: number of jiffies to wait before queueing
1496 *
1497 * mod_delayed_work_on() on local CPU.
1498 */
1499bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1500 unsigned long delay)
1501{
1502 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1503}
1504EXPORT_SYMBOL_GPL(mod_delayed_work);
1505
1506/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001507 * worker_enter_idle - enter idle state
1508 * @worker: worker which is entering idle state
1509 *
1510 * @worker is entering idle state. Update stats and idle timer if
1511 * necessary.
1512 *
1513 * LOCKING:
1514 * spin_lock_irq(gcwq->lock).
1515 */
1516static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001518 struct worker_pool *pool = worker->pool;
1519 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Tejun Heoc8e55f32010-06-29 10:07:12 +02001521 BUG_ON(worker->flags & WORKER_IDLE);
1522 BUG_ON(!list_empty(&worker->entry) &&
1523 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524
Tejun Heocb444762010-07-02 10:03:50 +02001525 /* can't use worker_set_flags(), also called from start_worker() */
1526 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001527 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001528 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001529
Tejun Heoc8e55f32010-06-29 10:07:12 +02001530 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001531 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001532
Tejun Heo628c78e2012-07-17 12:39:27 -07001533 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1534 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001535
Tejun Heo544ecf32012-05-14 15:04:50 -07001536 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07001537 * Sanity check nr_running. Because gcwq_unbind_fn() releases
1538 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1539 * nr_running, the warning may trigger spuriously. Check iff
1540 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001541 */
Tejun Heo628c78e2012-07-17 12:39:27 -07001542 WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001543 pool->nr_workers == pool->nr_idle &&
Tejun Heo63d95a92012-07-12 14:46:37 -07001544 atomic_read(get_pool_nr_running(pool)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545}
1546
Tejun Heoc8e55f32010-06-29 10:07:12 +02001547/**
1548 * worker_leave_idle - leave idle state
1549 * @worker: worker which is leaving idle state
1550 *
1551 * @worker is leaving idle state. Update stats.
1552 *
1553 * LOCKING:
1554 * spin_lock_irq(gcwq->lock).
1555 */
1556static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001558 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Tejun Heoc8e55f32010-06-29 10:07:12 +02001560 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001561 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001562 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001563 list_del_init(&worker->entry);
1564}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565
Tejun Heoe22bee72010-06-29 10:07:14 +02001566/**
1567 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1568 * @worker: self
1569 *
1570 * Works which are scheduled while the cpu is online must at least be
1571 * scheduled to a worker which is bound to the cpu so that if they are
1572 * flushed from cpu callbacks while cpu is going down, they are
1573 * guaranteed to execute on the cpu.
1574 *
1575 * This function is to be used by rogue workers and rescuers to bind
1576 * themselves to the target cpu and may race with cpu going down or
1577 * coming online. kthread_bind() can't be used because it may put the
1578 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1579 * verbatim as it's best effort and blocking and gcwq may be
1580 * [dis]associated in the meantime.
1581 *
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001582 * This function tries set_cpus_allowed() and locks gcwq and verifies the
1583 * binding against %GCWQ_DISASSOCIATED which is set during
1584 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1585 * enters idle state or fetches works without dropping lock, it can
1586 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001587 *
1588 * CONTEXT:
1589 * Might sleep. Called without any lock but returns with gcwq->lock
1590 * held.
1591 *
1592 * RETURNS:
1593 * %true if the associated gcwq is online (@worker is successfully
1594 * bound), %false if offline.
1595 */
1596static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001597__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001598{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001599 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001600 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601
Tejun Heoe22bee72010-06-29 10:07:14 +02001602 while (true) {
1603 /*
1604 * The following call may fail, succeed or succeed
1605 * without actually migrating the task to the cpu if
1606 * it races with cpu hotunplug operation. Verify
1607 * against GCWQ_DISASSOCIATED.
1608 */
Tejun Heof3421792010-07-02 10:03:51 +02001609 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1610 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001611
Tejun Heoe22bee72010-06-29 10:07:14 +02001612 spin_lock_irq(&gcwq->lock);
1613 if (gcwq->flags & GCWQ_DISASSOCIATED)
1614 return false;
1615 if (task_cpu(task) == gcwq->cpu &&
1616 cpumask_equal(&current->cpus_allowed,
1617 get_cpu_mask(gcwq->cpu)))
1618 return true;
1619 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001620
Tejun Heo5035b202011-04-29 18:08:37 +02001621 /*
1622 * We've raced with CPU hot[un]plug. Give it a breather
1623 * and retry migration. cond_resched() is required here;
1624 * otherwise, we might deadlock against cpu_stop trying to
1625 * bring down the CPU on non-preemptive kernel.
1626 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001627 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001628 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001629 }
1630}
1631
1632/*
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001633 * Rebind an idle @worker to its CPU. worker_thread() will test
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001634 * list_empty(@worker->entry) before leaving idle and call this function.
Tejun Heo25511a42012-07-17 12:39:27 -07001635 */
1636static void idle_worker_rebind(struct worker *worker)
1637{
1638 struct global_cwq *gcwq = worker->pool->gcwq;
1639
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001640 /* CPU may go down again inbetween, clear UNBOUND only on success */
1641 if (worker_maybe_bind_and_lock(worker))
1642 worker_clr_flags(worker, WORKER_UNBOUND);
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001643
1644 /* rebind complete, become available again */
1645 list_add(&worker->entry, &worker->pool->idle_list);
1646 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07001647}
1648
1649/*
1650 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001651 * the associated cpu which is coming back online. This is scheduled by
1652 * cpu up but can race with other cpu hotplug operations and may be
1653 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001654 */
Tejun Heo25511a42012-07-17 12:39:27 -07001655static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001656{
1657 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001658 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001659
Lai Jiangshaneab6d822012-09-18 09:59:22 -07001660 if (worker_maybe_bind_and_lock(worker))
1661 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02001662
1663 spin_unlock_irq(&gcwq->lock);
1664}
1665
Tejun Heo25511a42012-07-17 12:39:27 -07001666/**
1667 * rebind_workers - rebind all workers of a gcwq to the associated CPU
1668 * @gcwq: gcwq of interest
1669 *
1670 * @gcwq->cpu is coming online. Rebind all workers to the CPU. Rebinding
1671 * is different for idle and busy ones.
1672 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001673 * Idle ones will be removed from the idle_list and woken up. They will
1674 * add themselves back after completing rebind. This ensures that the
1675 * idle_list doesn't contain any unbound workers when re-bound busy workers
1676 * try to perform local wake-ups for concurrency management.
Tejun Heo25511a42012-07-17 12:39:27 -07001677 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001678 * Busy workers can rebind after they finish their current work items.
1679 * Queueing the rebind work item at the head of the scheduled list is
1680 * enough. Note that nr_running will be properly bumped as busy workers
1681 * rebind.
Tejun Heo25511a42012-07-17 12:39:27 -07001682 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001683 * On return, all non-manager workers are scheduled for rebind - see
1684 * manage_workers() for the manager special case. Any idle worker
1685 * including the manager will not appear on @idle_list until rebind is
1686 * complete, making local wake-ups safe.
Tejun Heo25511a42012-07-17 12:39:27 -07001687 */
1688static void rebind_workers(struct global_cwq *gcwq)
Tejun Heo25511a42012-07-17 12:39:27 -07001689{
Tejun Heo25511a42012-07-17 12:39:27 -07001690 struct worker_pool *pool;
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001691 struct worker *worker, *n;
Tejun Heo25511a42012-07-17 12:39:27 -07001692 struct hlist_node *pos;
1693 int i;
1694
1695 lockdep_assert_held(&gcwq->lock);
1696
1697 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07001698 lockdep_assert_held(&pool->assoc_mutex);
Tejun Heo25511a42012-07-17 12:39:27 -07001699
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001700 /* dequeue and kick idle ones */
Tejun Heo25511a42012-07-17 12:39:27 -07001701 for_each_worker_pool(pool, gcwq) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001702 list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001703 /*
1704 * idle workers should be off @pool->idle_list
1705 * until rebind is complete to avoid receiving
1706 * premature local wake-ups.
1707 */
1708 list_del_init(&worker->entry);
Tejun Heo25511a42012-07-17 12:39:27 -07001709
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001710 /*
1711 * worker_thread() will see the above dequeuing
1712 * and call idle_worker_rebind().
1713 */
Tejun Heo25511a42012-07-17 12:39:27 -07001714 wake_up_process(worker->task);
1715 }
1716 }
1717
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001718 /* rebind busy workers */
Tejun Heo25511a42012-07-17 12:39:27 -07001719 for_each_busy_worker(worker, i, pos, gcwq) {
1720 struct work_struct *rebind_work = &worker->rebind_work;
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001721 struct workqueue_struct *wq;
Tejun Heo25511a42012-07-17 12:39:27 -07001722
Tejun Heo25511a42012-07-17 12:39:27 -07001723 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1724 work_data_bits(rebind_work)))
1725 continue;
1726
Tejun Heo25511a42012-07-17 12:39:27 -07001727 debug_work_activate(rebind_work);
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001728
1729 /*
1730 * wq doesn't really matter but let's keep @worker->pool
1731 * and @cwq->pool consistent for sanity.
1732 */
1733 if (worker_pool_pri(worker->pool))
1734 wq = system_highpri_wq;
1735 else
1736 wq = system_wq;
1737
1738 insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
1739 worker->scheduled.next,
1740 work_color_to_flags(WORK_NO_COLOR));
Tejun Heo25511a42012-07-17 12:39:27 -07001741 }
1742}
1743
Tejun Heoc34056a2010-06-29 10:07:11 +02001744static struct worker *alloc_worker(void)
1745{
1746 struct worker *worker;
1747
1748 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001749 if (worker) {
1750 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001751 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001752 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001753 /* on creation a worker is in !idle && prep state */
1754 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001755 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001756 return worker;
1757}
1758
1759/**
1760 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001761 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001762 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001763 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001764 * can be started by calling start_worker() or destroyed using
1765 * destroy_worker().
1766 *
1767 * CONTEXT:
1768 * Might sleep. Does GFP_KERNEL allocations.
1769 *
1770 * RETURNS:
1771 * Pointer to the newly created worker.
1772 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001773static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001774{
Tejun Heo63d95a92012-07-12 14:46:37 -07001775 struct global_cwq *gcwq = pool->gcwq;
Tejun Heo32704762012-07-13 22:16:45 -07001776 const char *pri = worker_pool_pri(pool) ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001777 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001778 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001779
Tejun Heo8b03ae32010-06-29 10:07:12 +02001780 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001781 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001782 spin_unlock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001783 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001784 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001785 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001786 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001787 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001788
1789 worker = alloc_worker();
1790 if (!worker)
1791 goto fail;
1792
Tejun Heobd7bdd42012-07-12 14:46:37 -07001793 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001794 worker->id = id;
1795
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001796 if (gcwq->cpu != WORK_CPU_UNBOUND)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001797 worker->task = kthread_create_on_node(worker_thread,
Tejun Heo32704762012-07-13 22:16:45 -07001798 worker, cpu_to_node(gcwq->cpu),
1799 "kworker/%u:%d%s", gcwq->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001800 else
1801 worker->task = kthread_create(worker_thread, worker,
Tejun Heo32704762012-07-13 22:16:45 -07001802 "kworker/u:%d%s", id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001803 if (IS_ERR(worker->task))
1804 goto fail;
1805
Tejun Heo32704762012-07-13 22:16:45 -07001806 if (worker_pool_pri(pool))
1807 set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
1808
Tejun Heodb7bccf2010-06-29 10:07:12 +02001809 /*
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001810 * Determine CPU binding of the new worker depending on
1811 * %GCWQ_DISASSOCIATED. The caller is responsible for ensuring the
1812 * flag remains stable across this function. See the comments
1813 * above the flag definition for details.
1814 *
1815 * As an unbound worker may later become a regular one if CPU comes
1816 * online, make sure every worker has %PF_THREAD_BOUND set.
Tejun Heodb7bccf2010-06-29 10:07:12 +02001817 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001818 if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001819 kthread_bind(worker->task, gcwq->cpu);
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001820 } else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001821 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001822 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001824
Tejun Heoc34056a2010-06-29 10:07:11 +02001825 return worker;
1826fail:
1827 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001828 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001829 ida_remove(&pool->worker_ida, id);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001830 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001831 }
1832 kfree(worker);
1833 return NULL;
1834}
1835
1836/**
1837 * start_worker - start a newly created worker
1838 * @worker: worker to start
1839 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001840 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001841 *
1842 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001843 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001844 */
1845static void start_worker(struct worker *worker)
1846{
Tejun Heocb444762010-07-02 10:03:50 +02001847 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001848 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001849 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001850 wake_up_process(worker->task);
1851}
1852
1853/**
1854 * destroy_worker - destroy a workqueue worker
1855 * @worker: worker to be destroyed
1856 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001857 * Destroy @worker and adjust @gcwq stats accordingly.
1858 *
1859 * CONTEXT:
1860 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001861 */
1862static void destroy_worker(struct worker *worker)
1863{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001864 struct worker_pool *pool = worker->pool;
1865 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001866 int id = worker->id;
1867
1868 /* sanity check frenzy */
1869 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001870 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001871
Tejun Heoc8e55f32010-06-29 10:07:12 +02001872 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001873 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001874 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001875 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001876
1877 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001878 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001879
1880 spin_unlock_irq(&gcwq->lock);
1881
Tejun Heoc34056a2010-06-29 10:07:11 +02001882 kthread_stop(worker->task);
1883 kfree(worker);
1884
Tejun Heo8b03ae32010-06-29 10:07:12 +02001885 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001886 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001887}
1888
Tejun Heo63d95a92012-07-12 14:46:37 -07001889static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001890{
Tejun Heo63d95a92012-07-12 14:46:37 -07001891 struct worker_pool *pool = (void *)__pool;
1892 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001893
1894 spin_lock_irq(&gcwq->lock);
1895
Tejun Heo63d95a92012-07-12 14:46:37 -07001896 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001897 struct worker *worker;
1898 unsigned long expires;
1899
1900 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001901 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001902 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1903
1904 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001905 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001906 else {
1907 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001908 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001909 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001910 }
1911 }
1912
1913 spin_unlock_irq(&gcwq->lock);
1914}
1915
1916static bool send_mayday(struct work_struct *work)
1917{
1918 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1919 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001920 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001921
1922 if (!(wq->flags & WQ_RESCUER))
1923 return false;
1924
1925 /* mayday mayday mayday */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001926 cpu = cwq->pool->gcwq->cpu;
Tejun Heof3421792010-07-02 10:03:51 +02001927 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1928 if (cpu == WORK_CPU_UNBOUND)
1929 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001930 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001931 wake_up_process(wq->rescuer->task);
1932 return true;
1933}
1934
Tejun Heo63d95a92012-07-12 14:46:37 -07001935static void gcwq_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001936{
Tejun Heo63d95a92012-07-12 14:46:37 -07001937 struct worker_pool *pool = (void *)__pool;
1938 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001939 struct work_struct *work;
1940
1941 spin_lock_irq(&gcwq->lock);
1942
Tejun Heo63d95a92012-07-12 14:46:37 -07001943 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001944 /*
1945 * We've been trying to create a new worker but
1946 * haven't been successful. We might be hitting an
1947 * allocation deadlock. Send distress signals to
1948 * rescuers.
1949 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001950 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001951 send_mayday(work);
1952 }
1953
1954 spin_unlock_irq(&gcwq->lock);
1955
Tejun Heo63d95a92012-07-12 14:46:37 -07001956 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001957}
1958
1959/**
1960 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001961 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001962 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001963 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001964 * have at least one idle worker on return from this function. If
1965 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001966 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001967 * possible allocation deadlock.
1968 *
1969 * On return, need_to_create_worker() is guaranteed to be false and
1970 * may_start_working() true.
1971 *
1972 * LOCKING:
1973 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1974 * multiple times. Does GFP_KERNEL allocations. Called only from
1975 * manager.
1976 *
1977 * RETURNS:
1978 * false if no action was taken and gcwq->lock stayed locked, true
1979 * otherwise.
1980 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001981static bool maybe_create_worker(struct worker_pool *pool)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001982__releases(&gcwq->lock)
1983__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001984{
Tejun Heo63d95a92012-07-12 14:46:37 -07001985 struct global_cwq *gcwq = pool->gcwq;
1986
1987 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001988 return false;
1989restart:
Tejun Heo9f9c2362010-07-14 11:31:20 +02001990 spin_unlock_irq(&gcwq->lock);
1991
Tejun Heoe22bee72010-06-29 10:07:14 +02001992 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001993 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001994
1995 while (true) {
1996 struct worker *worker;
1997
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001998 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001999 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002000 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002001 spin_lock_irq(&gcwq->lock);
2002 start_worker(worker);
Tejun Heo63d95a92012-07-12 14:46:37 -07002003 BUG_ON(need_to_create_worker(pool));
Tejun Heoe22bee72010-06-29 10:07:14 +02002004 return true;
2005 }
2006
Tejun Heo63d95a92012-07-12 14:46:37 -07002007 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002008 break;
2009
Tejun Heoe22bee72010-06-29 10:07:14 +02002010 __set_current_state(TASK_INTERRUPTIBLE);
2011 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02002012
Tejun Heo63d95a92012-07-12 14:46:37 -07002013 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002014 break;
2015 }
2016
Tejun Heo63d95a92012-07-12 14:46:37 -07002017 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002018 spin_lock_irq(&gcwq->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07002019 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002020 goto restart;
2021 return true;
2022}
2023
2024/**
2025 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07002026 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02002027 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002028 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02002029 * IDLE_WORKER_TIMEOUT.
2030 *
2031 * LOCKING:
2032 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2033 * multiple times. Called only from manager.
2034 *
2035 * RETURNS:
2036 * false if no action was taken and gcwq->lock stayed locked, true
2037 * otherwise.
2038 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002039static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02002040{
2041 bool ret = false;
2042
Tejun Heo63d95a92012-07-12 14:46:37 -07002043 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002044 struct worker *worker;
2045 unsigned long expires;
2046
Tejun Heo63d95a92012-07-12 14:46:37 -07002047 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002048 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2049
2050 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002051 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02002052 break;
2053 }
2054
2055 destroy_worker(worker);
2056 ret = true;
2057 }
2058
2059 return ret;
2060}
2061
2062/**
2063 * manage_workers - manage worker pool
2064 * @worker: self
2065 *
2066 * Assume the manager role and manage gcwq worker pool @worker belongs
2067 * to. At any given time, there can be only zero or one manager per
2068 * gcwq. The exclusion is handled automatically by this function.
2069 *
2070 * The caller can safely start processing works on false return. On
2071 * true return, it's guaranteed that need_to_create_worker() is false
2072 * and may_start_working() is true.
2073 *
2074 * CONTEXT:
2075 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2076 * multiple times. Does GFP_KERNEL allocations.
2077 *
2078 * RETURNS:
2079 * false if no action was taken and gcwq->lock stayed locked, true if
2080 * some action was taken.
2081 */
2082static bool manage_workers(struct worker *worker)
2083{
Tejun Heo63d95a92012-07-12 14:46:37 -07002084 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002085 bool ret = false;
2086
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002087 if (pool->flags & POOL_MANAGING_WORKERS)
Tejun Heoe22bee72010-06-29 10:07:14 +02002088 return ret;
2089
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002090 pool->flags |= POOL_MANAGING_WORKERS;
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002091
2092 /*
2093 * To simplify both worker management and CPU hotplug, hold off
2094 * management while hotplug is in progress. CPU hotplug path can't
2095 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2096 * lead to idle worker depletion (all become busy thinking someone
2097 * else is managing) which in turn can result in deadlock under
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002098 * extreme circumstances. Use @pool->assoc_mutex to synchronize
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002099 * manager against CPU hotplug.
2100 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002101 * assoc_mutex would always be free unless CPU hotplug is in
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002102 * progress. trylock first without dropping @gcwq->lock.
2103 */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002104 if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002105 spin_unlock_irq(&pool->gcwq->lock);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002106 mutex_lock(&pool->assoc_mutex);
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002107 /*
2108 * CPU hotplug could have happened while we were waiting
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002109 * for assoc_mutex. Hotplug itself can't handle us
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002110 * because manager isn't either on idle or busy list, and
2111 * @gcwq's state and ours could have deviated.
2112 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002113 * As hotplug is now excluded via assoc_mutex, we can
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002114 * simply try to bind. It will succeed or fail depending
2115 * on @gcwq's current state. Try it and adjust
2116 * %WORKER_UNBOUND accordingly.
2117 */
2118 if (worker_maybe_bind_and_lock(worker))
2119 worker->flags &= ~WORKER_UNBOUND;
2120 else
2121 worker->flags |= WORKER_UNBOUND;
2122
2123 ret = true;
2124 }
2125
Tejun Heo11ebea52012-07-12 14:46:37 -07002126 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002127
2128 /*
2129 * Destroy and then create so that may_start_working() is true
2130 * on return.
2131 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002132 ret |= maybe_destroy_workers(pool);
2133 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002134
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002135 pool->flags &= ~POOL_MANAGING_WORKERS;
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002136 mutex_unlock(&pool->assoc_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02002137 return ret;
2138}
2139
Tejun Heoa62428c2010-06-29 10:07:10 +02002140/**
2141 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002142 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002143 * @work: work to process
2144 *
2145 * Process @work. This function contains all the logics necessary to
2146 * process a single work including synchronization against and
2147 * interaction with other workers on the same cpu, queueing and
2148 * flushing. As long as context requirement is met, any worker can
2149 * call this function to process a work.
2150 *
2151 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002152 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002153 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002154static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09002155__releases(&gcwq->lock)
2156__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002157{
Tejun Heo7e116292010-06-29 10:07:13 +02002158 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002159 struct worker_pool *pool = worker->pool;
2160 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002161 struct hlist_head *bwh = busy_worker_head(gcwq, work);
Tejun Heofb0e7be2010-06-29 10:07:15 +02002162 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02002163 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02002164 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002165 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002166#ifdef CONFIG_LOCKDEP
2167 /*
2168 * It is permissible to free the struct work_struct from
2169 * inside the function that is called from it, this we need to
2170 * take into account for lockdep too. To avoid bogus "held
2171 * lock freed" warnings as well as problems when looking into
2172 * work->lockdep_map, make a copy and use that here.
2173 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002174 struct lockdep_map lockdep_map;
2175
2176 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002177#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002178 /*
2179 * Ensure we're on the correct CPU. DISASSOCIATED test is
2180 * necessary to avoid spurious warnings from rescuers servicing the
2181 * unbound or a disassociated gcwq.
2182 */
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002183 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
Tejun Heo6fec10a2012-07-22 10:16:34 -07002184 !(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heo25511a42012-07-17 12:39:27 -07002185 raw_smp_processor_id() != gcwq->cpu);
2186
Tejun Heo7e116292010-06-29 10:07:13 +02002187 /*
2188 * A single work shouldn't be executed concurrently by
2189 * multiple workers on a single cpu. Check whether anyone is
2190 * already processing the work. If so, defer the work to the
2191 * currently executing one.
2192 */
2193 collision = __find_worker_executing_work(gcwq, bwh, work);
2194 if (unlikely(collision)) {
2195 move_linked_works(work, &collision->scheduled, NULL);
2196 return;
2197 }
2198
Tejun Heo8930cab2012-08-03 10:30:45 -07002199 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002200 debug_work_deactivate(work);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002201 hlist_add_head(&worker->hentry, bwh);
Tejun Heoc34056a2010-06-29 10:07:11 +02002202 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002203 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002204 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002205
Tejun Heoa62428c2010-06-29 10:07:10 +02002206 list_del_init(&work->entry);
2207
Tejun Heo649027d2010-06-29 10:07:14 +02002208 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002209 * CPU intensive works don't participate in concurrency
2210 * management. They're the scheduler's responsibility.
2211 */
2212 if (unlikely(cpu_intensive))
2213 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2214
Tejun Heo974271c2012-07-12 14:46:37 -07002215 /*
2216 * Unbound gcwq isn't concurrency managed and work items should be
2217 * executed ASAP. Wake up another worker if necessary.
2218 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002219 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2220 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002221
Tejun Heo8930cab2012-08-03 10:30:45 -07002222 /*
Tejun Heo23657bb2012-08-13 17:08:19 -07002223 * Record the last CPU and clear PENDING which should be the last
2224 * update to @work. Also, do this inside @gcwq->lock so that
2225 * PENDING and queued state changes happen together while IRQ is
2226 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002227 */
Tejun Heo8930cab2012-08-03 10:30:45 -07002228 set_work_cpu_and_clear_pending(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02002229
Tejun Heo8930cab2012-08-03 10:30:45 -07002230 spin_unlock_irq(&gcwq->lock);
Tejun Heo959d1af2012-08-03 10:30:45 -07002231
Tejun Heoe1594892011-01-09 23:32:15 +01002232 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002233 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002234 trace_workqueue_execute_start(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002235 f(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002236 /*
2237 * While we must be careful to not use "work" after this, the trace
2238 * point will only record its address.
2239 */
2240 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002241 lock_map_release(&lockdep_map);
2242 lock_map_release(&cwq->wq->lockdep_map);
2243
2244 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002245 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2246 " last function: %pf\n",
2247 current->comm, preempt_count(), task_pid_nr(current), f);
Tejun Heoa62428c2010-06-29 10:07:10 +02002248 debug_show_held_locks(current);
2249 dump_stack();
2250 }
2251
Tejun Heo8b03ae32010-06-29 10:07:12 +02002252 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002253
Tejun Heofb0e7be2010-06-29 10:07:15 +02002254 /* clear cpu intensive status */
2255 if (unlikely(cpu_intensive))
2256 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2257
Tejun Heoa62428c2010-06-29 10:07:10 +02002258 /* we're done with it, release */
Tejun Heoc8e55f32010-06-29 10:07:12 +02002259 hlist_del_init(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002260 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002261 worker->current_cwq = NULL;
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07002262 cwq_dec_nr_in_flight(cwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002263}
2264
Tejun Heoaffee4b2010-06-29 10:07:12 +02002265/**
2266 * process_scheduled_works - process scheduled works
2267 * @worker: self
2268 *
2269 * Process all scheduled works. Please note that the scheduled list
2270 * may change while processing a work, so this function repeatedly
2271 * fetches a work from the top and executes it.
2272 *
2273 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002274 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002275 * multiple times.
2276 */
2277static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002279 while (!list_empty(&worker->scheduled)) {
2280 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002282 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284}
2285
Tejun Heo4690c4a2010-06-29 10:07:10 +02002286/**
2287 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002288 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002289 *
Tejun Heoe22bee72010-06-29 10:07:14 +02002290 * The gcwq worker thread function. There's a single dynamic pool of
2291 * these per each cpu. These workers process all works regardless of
2292 * their specific target workqueue. The only exception is works which
2293 * belong to workqueues with a rescuer which will be explained in
2294 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002295 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002296static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297{
Tejun Heoc34056a2010-06-29 10:07:11 +02002298 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002299 struct worker_pool *pool = worker->pool;
2300 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301
Tejun Heoe22bee72010-06-29 10:07:14 +02002302 /* tell the scheduler that this is a workqueue worker */
2303 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002304woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002305 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002307 /* we are off idle list if destruction or rebind is requested */
2308 if (unlikely(list_empty(&worker->entry))) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002309 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002310
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002311 /* if DIE is set, destruction is requested */
Tejun Heo25511a42012-07-17 12:39:27 -07002312 if (worker->flags & WORKER_DIE) {
2313 worker->task->flags &= ~PF_WQ_WORKER;
2314 return 0;
2315 }
2316
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002317 /* otherwise, rebind */
Tejun Heo25511a42012-07-17 12:39:27 -07002318 idle_worker_rebind(worker);
2319 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 }
2321
Tejun Heoc8e55f32010-06-29 10:07:12 +02002322 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002323recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002324 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002325 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002326 goto sleep;
2327
2328 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002329 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002330 goto recheck;
2331
Tejun Heoc8e55f32010-06-29 10:07:12 +02002332 /*
2333 * ->scheduled list can only be filled while a worker is
2334 * preparing to process a work or actually processing it.
2335 * Make sure nobody diddled with it while I was sleeping.
2336 */
2337 BUG_ON(!list_empty(&worker->scheduled));
2338
Tejun Heoe22bee72010-06-29 10:07:14 +02002339 /*
2340 * When control reaches this point, we're guaranteed to have
2341 * at least one idle worker or that someone else has already
2342 * assumed the manager role.
2343 */
2344 worker_clr_flags(worker, WORKER_PREP);
2345
2346 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002347 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002348 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002349 struct work_struct, entry);
2350
2351 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2352 /* optimization path, not strictly necessary */
2353 process_one_work(worker, work);
2354 if (unlikely(!list_empty(&worker->scheduled)))
2355 process_scheduled_works(worker);
2356 } else {
2357 move_linked_works(work, &worker->scheduled, NULL);
2358 process_scheduled_works(worker);
2359 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002360 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002361
Tejun Heoe22bee72010-06-29 10:07:14 +02002362 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002363sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002364 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002365 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002366
Tejun Heoc8e55f32010-06-29 10:07:12 +02002367 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02002368 * gcwq->lock is held and there's no work to process and no
2369 * need to manage, sleep. Workers are woken up only while
2370 * holding gcwq->lock or from local cpu, so setting the
2371 * current state before releasing gcwq->lock is enough to
2372 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002373 */
2374 worker_enter_idle(worker);
2375 __set_current_state(TASK_INTERRUPTIBLE);
2376 spin_unlock_irq(&gcwq->lock);
2377 schedule();
2378 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379}
2380
Tejun Heoe22bee72010-06-29 10:07:14 +02002381/**
2382 * rescuer_thread - the rescuer thread function
2383 * @__wq: the associated workqueue
2384 *
2385 * Workqueue rescuer thread function. There's one rescuer for each
2386 * workqueue which has WQ_RESCUER set.
2387 *
2388 * Regular work processing on a gcwq may block trying to create a new
2389 * worker which uses GFP_KERNEL allocation which has slight chance of
2390 * developing into deadlock if some works currently on the same queue
2391 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2392 * the problem rescuer solves.
2393 *
2394 * When such condition is possible, the gcwq summons rescuers of all
2395 * workqueues which have works queued on the gcwq and let them process
2396 * those works so that forward progress can be guaranteed.
2397 *
2398 * This should happen rarely.
2399 */
2400static int rescuer_thread(void *__wq)
2401{
2402 struct workqueue_struct *wq = __wq;
2403 struct worker *rescuer = wq->rescuer;
2404 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002405 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002406 unsigned int cpu;
2407
2408 set_user_nice(current, RESCUER_NICE_LEVEL);
2409repeat:
2410 set_current_state(TASK_INTERRUPTIBLE);
2411
2412 if (kthread_should_stop())
2413 return 0;
2414
Tejun Heof3421792010-07-02 10:03:51 +02002415 /*
2416 * See whether any cpu is asking for help. Unbounded
2417 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2418 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002419 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002420 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2421 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002422 struct worker_pool *pool = cwq->pool;
2423 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002424 struct work_struct *work, *n;
2425
2426 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002427 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002428
2429 /* migrate to the target cpu if possible */
Tejun Heobd7bdd42012-07-12 14:46:37 -07002430 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002431 worker_maybe_bind_and_lock(rescuer);
2432
2433 /*
2434 * Slurp in all works issued via this workqueue and
2435 * process'em.
2436 */
2437 BUG_ON(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002438 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002439 if (get_work_cwq(work) == cwq)
2440 move_linked_works(work, scheduled, &n);
2441
2442 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002443
2444 /*
2445 * Leave this gcwq. If keep_working() is %true, notify a
2446 * regular worker; otherwise, we end up with 0 concurrency
2447 * and stalling the execution.
2448 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002449 if (keep_working(pool))
2450 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002451
Tejun Heoe22bee72010-06-29 10:07:14 +02002452 spin_unlock_irq(&gcwq->lock);
2453 }
2454
2455 schedule();
2456 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457}
2458
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002459struct wq_barrier {
2460 struct work_struct work;
2461 struct completion done;
2462};
2463
2464static void wq_barrier_func(struct work_struct *work)
2465{
2466 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2467 complete(&barr->done);
2468}
2469
Tejun Heo4690c4a2010-06-29 10:07:10 +02002470/**
2471 * insert_wq_barrier - insert a barrier work
2472 * @cwq: cwq to insert barrier into
2473 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002474 * @target: target work to attach @barr to
2475 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002476 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002477 * @barr is linked to @target such that @barr is completed only after
2478 * @target finishes execution. Please note that the ordering
2479 * guarantee is observed only with respect to @target and on the local
2480 * cpu.
2481 *
2482 * Currently, a queued barrier can't be canceled. This is because
2483 * try_to_grab_pending() can't determine whether the work to be
2484 * grabbed is at the head of the queue and thus can't clear LINKED
2485 * flag of the previous work while there must be a valid next work
2486 * after a work with LINKED flag set.
2487 *
2488 * Note that when @worker is non-NULL, @target may be modified
2489 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002490 *
2491 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002492 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002493 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002494static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002495 struct wq_barrier *barr,
2496 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002497{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002498 struct list_head *head;
2499 unsigned int linked = 0;
2500
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002501 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002502 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002503 * as we know for sure that this will not trigger any of the
2504 * checks and call back into the fixup functions where we
2505 * might deadlock.
2506 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002507 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002508 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002509 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002510
Tejun Heoaffee4b2010-06-29 10:07:12 +02002511 /*
2512 * If @target is currently being executed, schedule the
2513 * barrier to the worker; otherwise, put it after @target.
2514 */
2515 if (worker)
2516 head = worker->scheduled.next;
2517 else {
2518 unsigned long *bits = work_data_bits(target);
2519
2520 head = target->entry.next;
2521 /* there can already be other linked works, inherit and set */
2522 linked = *bits & WORK_STRUCT_LINKED;
2523 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2524 }
2525
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002526 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002527 insert_work(cwq, &barr->work, head,
2528 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002529}
2530
Tejun Heo73f53c42010-06-29 10:07:11 +02002531/**
2532 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2533 * @wq: workqueue being flushed
2534 * @flush_color: new flush color, < 0 for no-op
2535 * @work_color: new work color, < 0 for no-op
2536 *
2537 * Prepare cwqs for workqueue flushing.
2538 *
2539 * If @flush_color is non-negative, flush_color on all cwqs should be
2540 * -1. If no cwq has in-flight commands at the specified color, all
2541 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2542 * has in flight commands, its cwq->flush_color is set to
2543 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2544 * wakeup logic is armed and %true is returned.
2545 *
2546 * The caller should have initialized @wq->first_flusher prior to
2547 * calling this function with non-negative @flush_color. If
2548 * @flush_color is negative, no flush color update is done and %false
2549 * is returned.
2550 *
2551 * If @work_color is non-negative, all cwqs should have the same
2552 * work_color which is previous to @work_color and all will be
2553 * advanced to @work_color.
2554 *
2555 * CONTEXT:
2556 * mutex_lock(wq->flush_mutex).
2557 *
2558 * RETURNS:
2559 * %true if @flush_color >= 0 and there's something to flush. %false
2560 * otherwise.
2561 */
2562static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2563 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564{
Tejun Heo73f53c42010-06-29 10:07:11 +02002565 bool wait = false;
2566 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002567
Tejun Heo73f53c42010-06-29 10:07:11 +02002568 if (flush_color >= 0) {
2569 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2570 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002571 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002572
Tejun Heof3421792010-07-02 10:03:51 +02002573 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002574 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002575 struct global_cwq *gcwq = cwq->pool->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002576
Tejun Heo8b03ae32010-06-29 10:07:12 +02002577 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002578
2579 if (flush_color >= 0) {
2580 BUG_ON(cwq->flush_color != -1);
2581
2582 if (cwq->nr_in_flight[flush_color]) {
2583 cwq->flush_color = flush_color;
2584 atomic_inc(&wq->nr_cwqs_to_flush);
2585 wait = true;
2586 }
2587 }
2588
2589 if (work_color >= 0) {
2590 BUG_ON(work_color != work_next_color(cwq->work_color));
2591 cwq->work_color = work_color;
2592 }
2593
Tejun Heo8b03ae32010-06-29 10:07:12 +02002594 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002595 }
2596
2597 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2598 complete(&wq->first_flusher->done);
2599
2600 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601}
2602
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002603/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002604 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002605 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606 *
2607 * Forces execution of the workqueue and blocks until its completion.
2608 * This is typically used in driver shutdown handlers.
2609 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002610 * We sleep until all works which were queued on entry have been handled,
2611 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002613void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614{
Tejun Heo73f53c42010-06-29 10:07:11 +02002615 struct wq_flusher this_flusher = {
2616 .list = LIST_HEAD_INIT(this_flusher.list),
2617 .flush_color = -1,
2618 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2619 };
2620 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002621
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002622 lock_map_acquire(&wq->lockdep_map);
2623 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002624
2625 mutex_lock(&wq->flush_mutex);
2626
2627 /*
2628 * Start-to-wait phase
2629 */
2630 next_color = work_next_color(wq->work_color);
2631
2632 if (next_color != wq->flush_color) {
2633 /*
2634 * Color space is not full. The current work_color
2635 * becomes our flush_color and work_color is advanced
2636 * by one.
2637 */
2638 BUG_ON(!list_empty(&wq->flusher_overflow));
2639 this_flusher.flush_color = wq->work_color;
2640 wq->work_color = next_color;
2641
2642 if (!wq->first_flusher) {
2643 /* no flush in progress, become the first flusher */
2644 BUG_ON(wq->flush_color != this_flusher.flush_color);
2645
2646 wq->first_flusher = &this_flusher;
2647
2648 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2649 wq->work_color)) {
2650 /* nothing to flush, done */
2651 wq->flush_color = next_color;
2652 wq->first_flusher = NULL;
2653 goto out_unlock;
2654 }
2655 } else {
2656 /* wait in queue */
2657 BUG_ON(wq->flush_color == this_flusher.flush_color);
2658 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2659 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2660 }
2661 } else {
2662 /*
2663 * Oops, color space is full, wait on overflow queue.
2664 * The next flush completion will assign us
2665 * flush_color and transfer to flusher_queue.
2666 */
2667 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2668 }
2669
2670 mutex_unlock(&wq->flush_mutex);
2671
2672 wait_for_completion(&this_flusher.done);
2673
2674 /*
2675 * Wake-up-and-cascade phase
2676 *
2677 * First flushers are responsible for cascading flushes and
2678 * handling overflow. Non-first flushers can simply return.
2679 */
2680 if (wq->first_flusher != &this_flusher)
2681 return;
2682
2683 mutex_lock(&wq->flush_mutex);
2684
Tejun Heo4ce48b32010-07-02 10:03:51 +02002685 /* we might have raced, check again with mutex held */
2686 if (wq->first_flusher != &this_flusher)
2687 goto out_unlock;
2688
Tejun Heo73f53c42010-06-29 10:07:11 +02002689 wq->first_flusher = NULL;
2690
2691 BUG_ON(!list_empty(&this_flusher.list));
2692 BUG_ON(wq->flush_color != this_flusher.flush_color);
2693
2694 while (true) {
2695 struct wq_flusher *next, *tmp;
2696
2697 /* complete all the flushers sharing the current flush color */
2698 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2699 if (next->flush_color != wq->flush_color)
2700 break;
2701 list_del_init(&next->list);
2702 complete(&next->done);
2703 }
2704
2705 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2706 wq->flush_color != work_next_color(wq->work_color));
2707
2708 /* this flush_color is finished, advance by one */
2709 wq->flush_color = work_next_color(wq->flush_color);
2710
2711 /* one color has been freed, handle overflow queue */
2712 if (!list_empty(&wq->flusher_overflow)) {
2713 /*
2714 * Assign the same color to all overflowed
2715 * flushers, advance work_color and append to
2716 * flusher_queue. This is the start-to-wait
2717 * phase for these overflowed flushers.
2718 */
2719 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2720 tmp->flush_color = wq->work_color;
2721
2722 wq->work_color = work_next_color(wq->work_color);
2723
2724 list_splice_tail_init(&wq->flusher_overflow,
2725 &wq->flusher_queue);
2726 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2727 }
2728
2729 if (list_empty(&wq->flusher_queue)) {
2730 BUG_ON(wq->flush_color != wq->work_color);
2731 break;
2732 }
2733
2734 /*
2735 * Need to flush more colors. Make the next flusher
2736 * the new first flusher and arm cwqs.
2737 */
2738 BUG_ON(wq->flush_color == wq->work_color);
2739 BUG_ON(wq->flush_color != next->flush_color);
2740
2741 list_del_init(&next->list);
2742 wq->first_flusher = next;
2743
2744 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2745 break;
2746
2747 /*
2748 * Meh... this color is already done, clear first
2749 * flusher and repeat cascading.
2750 */
2751 wq->first_flusher = NULL;
2752 }
2753
2754out_unlock:
2755 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756}
Dave Jonesae90dd52006-06-30 01:40:45 -04002757EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002759/**
2760 * drain_workqueue - drain a workqueue
2761 * @wq: workqueue to drain
2762 *
2763 * Wait until the workqueue becomes empty. While draining is in progress,
2764 * only chain queueing is allowed. IOW, only currently pending or running
2765 * work items on @wq can queue further work items on it. @wq is flushed
2766 * repeatedly until it becomes empty. The number of flushing is detemined
2767 * by the depth of chaining and should be relatively short. Whine if it
2768 * takes too long.
2769 */
2770void drain_workqueue(struct workqueue_struct *wq)
2771{
2772 unsigned int flush_cnt = 0;
2773 unsigned int cpu;
2774
2775 /*
2776 * __queue_work() needs to test whether there are drainers, is much
2777 * hotter than drain_workqueue() and already looks at @wq->flags.
2778 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2779 */
2780 spin_lock(&workqueue_lock);
2781 if (!wq->nr_drainers++)
2782 wq->flags |= WQ_DRAINING;
2783 spin_unlock(&workqueue_lock);
2784reflush:
2785 flush_workqueue(wq);
2786
2787 for_each_cwq_cpu(cpu, wq) {
2788 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002789 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002790
Tejun Heobd7bdd42012-07-12 14:46:37 -07002791 spin_lock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002792 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002793 spin_unlock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002794
2795 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002796 continue;
2797
2798 if (++flush_cnt == 10 ||
2799 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Valentin Ilie044c7822012-08-19 00:52:42 +03002800 pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
2801 wq->name, flush_cnt);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002802 goto reflush;
2803 }
2804
2805 spin_lock(&workqueue_lock);
2806 if (!--wq->nr_drainers)
2807 wq->flags &= ~WQ_DRAINING;
2808 spin_unlock(&workqueue_lock);
2809}
2810EXPORT_SYMBOL_GPL(drain_workqueue);
2811
Tejun Heo606a5022012-08-20 14:51:23 -07002812static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002813{
2814 struct worker *worker = NULL;
2815 struct global_cwq *gcwq;
2816 struct cpu_workqueue_struct *cwq;
2817
2818 might_sleep();
2819 gcwq = get_work_gcwq(work);
2820 if (!gcwq)
2821 return false;
2822
2823 spin_lock_irq(&gcwq->lock);
2824 if (!list_empty(&work->entry)) {
2825 /*
2826 * See the comment near try_to_grab_pending()->smp_rmb().
2827 * If it was re-queued to a different gcwq under us, we
2828 * are not going to wait.
2829 */
2830 smp_rmb();
2831 cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002832 if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
Tejun Heobaf59022010-09-16 10:42:16 +02002833 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002834 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002835 worker = find_worker_executing_work(gcwq, work);
2836 if (!worker)
2837 goto already_gone;
2838 cwq = worker->current_cwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002839 }
Tejun Heobaf59022010-09-16 10:42:16 +02002840
2841 insert_wq_barrier(cwq, barr, work, worker);
2842 spin_unlock_irq(&gcwq->lock);
2843
Tejun Heoe1594892011-01-09 23:32:15 +01002844 /*
2845 * If @max_active is 1 or rescuer is in use, flushing another work
2846 * item on the same workqueue may lead to deadlock. Make sure the
2847 * flusher is not running on the same workqueue by verifying write
2848 * access.
2849 */
2850 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2851 lock_map_acquire(&cwq->wq->lockdep_map);
2852 else
2853 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002854 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002855
Tejun Heobaf59022010-09-16 10:42:16 +02002856 return true;
2857already_gone:
2858 spin_unlock_irq(&gcwq->lock);
2859 return false;
2860}
2861
Oleg Nesterovdb700892008-07-25 01:47:49 -07002862/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002863 * flush_work - wait for a work to finish executing the last queueing instance
2864 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002865 *
Tejun Heo606a5022012-08-20 14:51:23 -07002866 * Wait until @work has finished execution. @work is guaranteed to be idle
2867 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002868 *
2869 * RETURNS:
2870 * %true if flush_work() waited for the work to finish execution,
2871 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002872 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002873bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002874{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002875 struct wq_barrier barr;
2876
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002877 lock_map_acquire(&work->lockdep_map);
2878 lock_map_release(&work->lockdep_map);
2879
Tejun Heo606a5022012-08-20 14:51:23 -07002880 if (start_flush_work(work, &barr)) {
Tejun Heobaf59022010-09-16 10:42:16 +02002881 wait_for_completion(&barr.done);
2882 destroy_work_on_stack(&barr.work);
2883 return true;
Tejun Heo606a5022012-08-20 14:51:23 -07002884 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002885 return false;
Tejun Heo606a5022012-08-20 14:51:23 -07002886 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002887}
2888EXPORT_SYMBOL_GPL(flush_work);
2889
Tejun Heo36e227d2012-08-03 10:30:46 -07002890static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002891{
Tejun Heobbb68df2012-08-03 10:30:46 -07002892 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002893 int ret;
2894
2895 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002896 ret = try_to_grab_pending(work, is_dwork, &flags);
2897 /*
2898 * If someone else is canceling, wait for the same event it
2899 * would be waiting for before retrying.
2900 */
2901 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002902 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002903 } while (unlikely(ret < 0));
2904
Tejun Heobbb68df2012-08-03 10:30:46 -07002905 /* tell other tasks trying to grab @work to back off */
2906 mark_work_canceling(work);
2907 local_irq_restore(flags);
2908
Tejun Heo606a5022012-08-20 14:51:23 -07002909 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002910 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002911 return ret;
2912}
2913
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002914/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002915 * cancel_work_sync - cancel a work and wait for it to finish
2916 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002917 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002918 * Cancel @work and wait for its execution to finish. This function
2919 * can be used even if the work re-queues itself or migrates to
2920 * another workqueue. On return from this function, @work is
2921 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002922 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002923 * cancel_work_sync(&delayed_work->work) must not be used for
2924 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002925 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002926 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002927 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002928 *
2929 * RETURNS:
2930 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002931 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002932bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002933{
Tejun Heo36e227d2012-08-03 10:30:46 -07002934 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002935}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002936EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002937
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002938/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002939 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2940 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002941 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002942 * Delayed timer is cancelled and the pending work is queued for
2943 * immediate execution. Like flush_work(), this function only
2944 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002945 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002946 * RETURNS:
2947 * %true if flush_work() waited for the work to finish execution,
2948 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002949 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002950bool flush_delayed_work(struct delayed_work *dwork)
2951{
Tejun Heo8930cab2012-08-03 10:30:45 -07002952 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002953 if (del_timer_sync(&dwork->timer))
Tejun Heo12650572012-08-08 09:38:42 -07002954 __queue_work(dwork->cpu,
Tejun Heo401a8d02010-09-16 10:36:00 +02002955 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002956 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002957 return flush_work(&dwork->work);
2958}
2959EXPORT_SYMBOL(flush_delayed_work);
2960
2961/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002962 * cancel_delayed_work - cancel a delayed work
2963 * @dwork: delayed_work to cancel
2964 *
2965 * Kill off a pending delayed_work. Returns %true if @dwork was pending
2966 * and canceled; %false if wasn't pending. Note that the work callback
2967 * function may still be running on return, unless it returns %true and the
2968 * work doesn't re-arm itself. Explicitly flush or use
2969 * cancel_delayed_work_sync() to wait on it.
2970 *
2971 * This function is safe to call from any context including IRQ handler.
2972 */
2973bool cancel_delayed_work(struct delayed_work *dwork)
2974{
2975 unsigned long flags;
2976 int ret;
2977
2978 do {
2979 ret = try_to_grab_pending(&dwork->work, true, &flags);
2980 } while (unlikely(ret == -EAGAIN));
2981
2982 if (unlikely(ret < 0))
2983 return false;
2984
2985 set_work_cpu_and_clear_pending(&dwork->work, work_cpu(&dwork->work));
2986 local_irq_restore(flags);
2987 return true;
2988}
2989EXPORT_SYMBOL(cancel_delayed_work);
2990
2991/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002992 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2993 * @dwork: the delayed work cancel
2994 *
2995 * This is cancel_work_sync() for delayed works.
2996 *
2997 * RETURNS:
2998 * %true if @dwork was pending, %false otherwise.
2999 */
3000bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003001{
Tejun Heo36e227d2012-08-03 10:30:46 -07003002 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003003}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003004EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003005
Tejun Heod4283e92012-08-03 10:30:44 -07003006/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003007 * schedule_work_on - put work task on a specific cpu
3008 * @cpu: cpu to put the work task on
3009 * @work: job to be done
3010 *
3011 * This puts a job on a specific cpu
3012 */
Tejun Heod4283e92012-08-03 10:30:44 -07003013bool schedule_work_on(int cpu, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07003014{
3015 return queue_work_on(cpu, system_wq, work);
3016}
3017EXPORT_SYMBOL(schedule_work_on);
3018
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003019/**
3020 * schedule_work - put work task in global workqueue
3021 * @work: job to be done
3022 *
Tejun Heod4283e92012-08-03 10:30:44 -07003023 * Returns %false if @work was already on the kernel-global workqueue and
3024 * %true otherwise.
Bart Van Assche5b0f437d2009-07-30 19:00:53 +02003025 *
3026 * This puts a job in the kernel-global workqueue if it was not already
3027 * queued and leaves it in the same position on the kernel-global
3028 * workqueue otherwise.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003029 */
Tejun Heod4283e92012-08-03 10:30:44 -07003030bool schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003031{
Tejun Heod320c032010-06-29 10:07:14 +02003032 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003033}
Dave Jonesae90dd52006-06-30 01:40:45 -04003034EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003035
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003036/**
3037 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
3038 * @cpu: cpu to use
David Howells52bad642006-11-22 14:54:01 +00003039 * @dwork: job to be done
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003040 * @delay: number of jiffies to wait
3041 *
3042 * After waiting for a given time this puts a job in the kernel-global
3043 * workqueue on the specified CPU.
3044 */
Tejun Heod4283e92012-08-03 10:30:44 -07003045bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3046 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003047{
Tejun Heod320c032010-06-29 10:07:14 +02003048 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003049}
Dave Jonesae90dd52006-06-30 01:40:45 -04003050EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003051
Andrew Mortonb6136772006-06-25 05:47:49 -07003052/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003053 * schedule_delayed_work - put work task in global workqueue after delay
3054 * @dwork: job to be done
3055 * @delay: number of jiffies to wait or 0 for immediate execution
3056 *
3057 * After waiting for a given time this puts a job in the kernel-global
3058 * workqueue.
3059 */
Tejun Heod4283e92012-08-03 10:30:44 -07003060bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
Tejun Heo0a13c002012-08-03 10:30:44 -07003061{
3062 return queue_delayed_work(system_wq, dwork, delay);
3063}
3064EXPORT_SYMBOL(schedule_delayed_work);
3065
3066/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003067 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003068 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003069 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003070 * schedule_on_each_cpu() executes @func on each online CPU using the
3071 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003072 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003073 *
3074 * RETURNS:
3075 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003076 */
David Howells65f27f32006-11-22 14:55:48 +00003077int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003078{
3079 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003080 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003081
Andrew Mortonb6136772006-06-25 05:47:49 -07003082 works = alloc_percpu(struct work_struct);
3083 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003084 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003085
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003086 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003087
Christoph Lameter15316ba2006-01-08 01:00:43 -08003088 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003089 struct work_struct *work = per_cpu_ptr(works, cpu);
3090
3091 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003092 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003093 }
Tejun Heo93981802009-11-17 14:06:20 -08003094
3095 for_each_online_cpu(cpu)
3096 flush_work(per_cpu_ptr(works, cpu));
3097
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003098 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003099 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003100 return 0;
3101}
3102
Alan Sterneef6a7d2010-02-12 17:39:21 +09003103/**
3104 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3105 *
3106 * Forces execution of the kernel-global workqueue and blocks until its
3107 * completion.
3108 *
3109 * Think twice before calling this function! It's very easy to get into
3110 * trouble if you don't take great care. Either of the following situations
3111 * will lead to deadlock:
3112 *
3113 * One of the work items currently on the workqueue needs to acquire
3114 * a lock held by your code or its caller.
3115 *
3116 * Your code is running in the context of a work routine.
3117 *
3118 * They will be detected by lockdep when they occur, but the first might not
3119 * occur very often. It depends on what work items are on the workqueue and
3120 * what locks they need, which you have no control over.
3121 *
3122 * In most situations flushing the entire workqueue is overkill; you merely
3123 * need to know that a particular work item isn't queued and isn't running.
3124 * In such cases you should use cancel_delayed_work_sync() or
3125 * cancel_work_sync() instead.
3126 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003127void flush_scheduled_work(void)
3128{
Tejun Heod320c032010-06-29 10:07:14 +02003129 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003130}
Dave Jonesae90dd52006-06-30 01:40:45 -04003131EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003132
3133/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003134 * execute_in_process_context - reliably execute the routine with user context
3135 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003136 * @ew: guaranteed storage for the execute work structure (must
3137 * be available when the work executes)
3138 *
3139 * Executes the function immediately if process context is available,
3140 * otherwise schedules the function for delayed execution.
3141 *
3142 * Returns: 0 - function was executed
3143 * 1 - function was scheduled for execution
3144 */
David Howells65f27f32006-11-22 14:55:48 +00003145int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003146{
3147 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003148 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003149 return 0;
3150 }
3151
David Howells65f27f32006-11-22 14:55:48 +00003152 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003153 schedule_work(&ew->work);
3154
3155 return 1;
3156}
3157EXPORT_SYMBOL_GPL(execute_in_process_context);
3158
Linus Torvalds1da177e2005-04-16 15:20:36 -07003159int keventd_up(void)
3160{
Tejun Heod320c032010-06-29 10:07:14 +02003161 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003162}
3163
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003164static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003165{
Oleg Nesterov3af244332007-05-09 02:34:09 -07003166 /*
Tejun Heo0f900042010-06-29 10:07:11 +02003167 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
3168 * Make sure that the alignment isn't lower than that of
3169 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07003170 */
Tejun Heo0f900042010-06-29 10:07:11 +02003171 const size_t size = sizeof(struct cpu_workqueue_struct);
3172 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
3173 __alignof__(unsigned long long));
Oleg Nesterov3af244332007-05-09 02:34:09 -07003174
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003175 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003176 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02003177 else {
Tejun Heof3421792010-07-02 10:03:51 +02003178 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003179
Tejun Heof3421792010-07-02 10:03:51 +02003180 /*
3181 * Allocate enough room to align cwq and put an extra
3182 * pointer at the end pointing back to the originally
3183 * allocated pointer which will be used for free.
3184 */
3185 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3186 if (ptr) {
3187 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3188 *(void **)(wq->cpu_wq.single + 1) = ptr;
3189 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003190 }
Tejun Heof3421792010-07-02 10:03:51 +02003191
Tejun Heo0415b00d12011-03-24 18:50:09 +01003192 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003193 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3194 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003195}
3196
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003197static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003198{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003199 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003200 free_percpu(wq->cpu_wq.pcpu);
3201 else if (wq->cpu_wq.single) {
3202 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003203 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003204 }
3205}
3206
Tejun Heof3421792010-07-02 10:03:51 +02003207static int wq_clamp_max_active(int max_active, unsigned int flags,
3208 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003209{
Tejun Heof3421792010-07-02 10:03:51 +02003210 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3211
3212 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003213 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3214 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003215
Tejun Heof3421792010-07-02 10:03:51 +02003216 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003217}
3218
Tejun Heob196be82012-01-10 15:11:35 -08003219struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003220 unsigned int flags,
3221 int max_active,
3222 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003223 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003224{
Tejun Heob196be82012-01-10 15:11:35 -08003225 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003226 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003227 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08003228 size_t namelen;
3229
3230 /* determine namelen, allocate wq and format name */
3231 va_start(args, lock_name);
3232 va_copy(args1, args);
3233 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3234
3235 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3236 if (!wq)
3237 goto err;
3238
3239 vsnprintf(wq->name, namelen, fmt, args1);
3240 va_end(args);
3241 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003242
Tejun Heof3421792010-07-02 10:03:51 +02003243 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02003244 * Workqueues which may be used during memory reclaim should
3245 * have a rescuer to guarantee forward progress.
3246 */
3247 if (flags & WQ_MEM_RECLAIM)
3248 flags |= WQ_RESCUER;
3249
Tejun Heod320c032010-06-29 10:07:14 +02003250 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003251 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003252
Tejun Heob196be82012-01-10 15:11:35 -08003253 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003254 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003255 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003256 mutex_init(&wq->flush_mutex);
3257 atomic_set(&wq->nr_cwqs_to_flush, 0);
3258 INIT_LIST_HEAD(&wq->flusher_queue);
3259 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003260
Johannes Bergeb13ba82008-01-16 09:51:58 +01003261 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003262 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003263
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003264 if (alloc_cwqs(wq) < 0)
3265 goto err;
3266
Tejun Heof3421792010-07-02 10:03:51 +02003267 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003268 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003269 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo32704762012-07-13 22:16:45 -07003270 int pool_idx = (bool)(flags & WQ_HIGHPRI);
Tejun Heo15376632010-06-29 10:07:11 +02003271
Tejun Heo0f900042010-06-29 10:07:11 +02003272 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo32704762012-07-13 22:16:45 -07003273 cwq->pool = &gcwq->pools[pool_idx];
Tejun Heoc34056a2010-06-29 10:07:11 +02003274 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003275 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003276 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003277 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003278 }
3279
Tejun Heoe22bee72010-06-29 10:07:14 +02003280 if (flags & WQ_RESCUER) {
3281 struct worker *rescuer;
3282
Tejun Heof2e005a2010-07-20 15:59:09 +02003283 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003284 goto err;
3285
3286 wq->rescuer = rescuer = alloc_worker();
3287 if (!rescuer)
3288 goto err;
3289
Tejun Heob196be82012-01-10 15:11:35 -08003290 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3291 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003292 if (IS_ERR(rescuer->task))
3293 goto err;
3294
Tejun Heoe22bee72010-06-29 10:07:14 +02003295 rescuer->task->flags |= PF_THREAD_BOUND;
3296 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003297 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003298
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003299 /*
3300 * workqueue_lock protects global freeze state and workqueues
3301 * list. Grab it, set max_active accordingly and add the new
3302 * workqueue to workqueues list.
3303 */
Tejun Heo15376632010-06-29 10:07:11 +02003304 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003305
Tejun Heo58a69cb2011-02-16 09:25:31 +01003306 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003307 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003308 get_cwq(cpu, wq)->max_active = 0;
3309
Tejun Heo15376632010-06-29 10:07:11 +02003310 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003311
Tejun Heo15376632010-06-29 10:07:11 +02003312 spin_unlock(&workqueue_lock);
3313
Oleg Nesterov3af244332007-05-09 02:34:09 -07003314 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003315err:
3316 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003317 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003318 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003319 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003320 kfree(wq);
3321 }
3322 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003323}
Tejun Heod320c032010-06-29 10:07:14 +02003324EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003325
3326/**
3327 * destroy_workqueue - safely terminate a workqueue
3328 * @wq: target workqueue
3329 *
3330 * Safely destroy a workqueue. All work currently pending will be done first.
3331 */
3332void destroy_workqueue(struct workqueue_struct *wq)
3333{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003334 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003335
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003336 /* drain it before proceeding with destruction */
3337 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003338
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003339 /*
3340 * wq list is used to freeze wq, remove from list after
3341 * flushing is complete in case freeze races us.
3342 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003343 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07003344 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003345 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003346
Tejun Heoe22bee72010-06-29 10:07:14 +02003347 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003348 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003349 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3350 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003351
Tejun Heo73f53c42010-06-29 10:07:11 +02003352 for (i = 0; i < WORK_NR_COLORS; i++)
3353 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003354 BUG_ON(cwq->nr_active);
3355 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003356 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003357
Tejun Heoe22bee72010-06-29 10:07:14 +02003358 if (wq->flags & WQ_RESCUER) {
3359 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003360 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003361 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003362 }
3363
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003364 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003365 kfree(wq);
3366}
3367EXPORT_SYMBOL_GPL(destroy_workqueue);
3368
Tejun Heodcd989c2010-06-29 10:07:14 +02003369/**
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003370 * cwq_set_max_active - adjust max_active of a cwq
3371 * @cwq: target cpu_workqueue_struct
3372 * @max_active: new max_active value.
3373 *
3374 * Set @cwq->max_active to @max_active and activate delayed works if
3375 * increased.
3376 *
3377 * CONTEXT:
3378 * spin_lock_irq(gcwq->lock).
3379 */
3380static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active)
3381{
3382 cwq->max_active = max_active;
3383
3384 while (!list_empty(&cwq->delayed_works) &&
3385 cwq->nr_active < cwq->max_active)
3386 cwq_activate_first_delayed(cwq);
3387}
3388
3389/**
Tejun Heodcd989c2010-06-29 10:07:14 +02003390 * workqueue_set_max_active - adjust max_active of a workqueue
3391 * @wq: target workqueue
3392 * @max_active: new max_active value.
3393 *
3394 * Set max_active of @wq to @max_active.
3395 *
3396 * CONTEXT:
3397 * Don't call from IRQ context.
3398 */
3399void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3400{
3401 unsigned int cpu;
3402
Tejun Heof3421792010-07-02 10:03:51 +02003403 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003404
3405 spin_lock(&workqueue_lock);
3406
3407 wq->saved_max_active = max_active;
3408
Tejun Heof3421792010-07-02 10:03:51 +02003409 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003410 struct global_cwq *gcwq = get_gcwq(cpu);
3411
3412 spin_lock_irq(&gcwq->lock);
3413
Tejun Heo58a69cb2011-02-16 09:25:31 +01003414 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003415 !(gcwq->flags & GCWQ_FREEZING))
Lai Jiangshan70369b12012-09-19 10:40:48 -07003416 cwq_set_max_active(get_cwq(gcwq->cpu, wq), max_active);
Tejun Heodcd989c2010-06-29 10:07:14 +02003417
3418 spin_unlock_irq(&gcwq->lock);
3419 }
3420
3421 spin_unlock(&workqueue_lock);
3422}
3423EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3424
3425/**
3426 * workqueue_congested - test whether a workqueue is congested
3427 * @cpu: CPU in question
3428 * @wq: target workqueue
3429 *
3430 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3431 * no synchronization around this function and the test result is
3432 * unreliable and only useful as advisory hints or for debugging.
3433 *
3434 * RETURNS:
3435 * %true if congested, %false otherwise.
3436 */
3437bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3438{
3439 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3440
3441 return !list_empty(&cwq->delayed_works);
3442}
3443EXPORT_SYMBOL_GPL(workqueue_congested);
3444
3445/**
3446 * work_cpu - return the last known associated cpu for @work
3447 * @work: the work of interest
3448 *
3449 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003450 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003451 */
3452unsigned int work_cpu(struct work_struct *work)
3453{
3454 struct global_cwq *gcwq = get_work_gcwq(work);
3455
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003456 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003457}
3458EXPORT_SYMBOL_GPL(work_cpu);
3459
3460/**
3461 * work_busy - test whether a work is currently pending or running
3462 * @work: the work to be tested
3463 *
3464 * Test whether @work is currently pending or running. There is no
3465 * synchronization around this function and the test result is
3466 * unreliable and only useful as advisory hints or for debugging.
3467 * Especially for reentrant wqs, the pending state might hide the
3468 * running state.
3469 *
3470 * RETURNS:
3471 * OR'd bitmask of WORK_BUSY_* bits.
3472 */
3473unsigned int work_busy(struct work_struct *work)
3474{
3475 struct global_cwq *gcwq = get_work_gcwq(work);
3476 unsigned long flags;
3477 unsigned int ret = 0;
3478
3479 if (!gcwq)
3480 return false;
3481
3482 spin_lock_irqsave(&gcwq->lock, flags);
3483
3484 if (work_pending(work))
3485 ret |= WORK_BUSY_PENDING;
3486 if (find_worker_executing_work(gcwq, work))
3487 ret |= WORK_BUSY_RUNNING;
3488
3489 spin_unlock_irqrestore(&gcwq->lock, flags);
3490
3491 return ret;
3492}
3493EXPORT_SYMBOL_GPL(work_busy);
3494
Tejun Heodb7bccf2010-06-29 10:07:12 +02003495/*
3496 * CPU hotplug.
3497 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003498 * There are two challenges in supporting CPU hotplug. Firstly, there
3499 * are a lot of assumptions on strong associations among work, cwq and
3500 * gcwq which make migrating pending and scheduled works very
3501 * difficult to implement without impacting hot paths. Secondly,
3502 * gcwqs serve mix of short, long and very long running works making
3503 * blocked draining impractical.
3504 *
Tejun Heo628c78e2012-07-17 12:39:27 -07003505 * This is solved by allowing a gcwq to be disassociated from the CPU
3506 * running as an unbound one and allowing it to be reattached later if the
3507 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003508 */
3509
Tejun Heo60373152012-07-17 12:39:27 -07003510/* claim manager positions of all pools */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003511static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003512{
3513 struct worker_pool *pool;
3514
3515 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003516 mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
Tejun Heo8db25e72012-07-17 12:39:28 -07003517 spin_lock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003518}
3519
3520/* release manager positions */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003521static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003522{
3523 struct worker_pool *pool;
3524
Tejun Heo8db25e72012-07-17 12:39:28 -07003525 spin_unlock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003526 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003527 mutex_unlock(&pool->assoc_mutex);
Tejun Heo60373152012-07-17 12:39:27 -07003528}
3529
Tejun Heo628c78e2012-07-17 12:39:27 -07003530static void gcwq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003531{
Tejun Heo628c78e2012-07-17 12:39:27 -07003532 struct global_cwq *gcwq = get_gcwq(smp_processor_id());
Tejun Heo4ce62e92012-07-13 22:16:44 -07003533 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003534 struct worker *worker;
3535 struct hlist_node *pos;
3536 int i;
3537
3538 BUG_ON(gcwq->cpu != smp_processor_id());
3539
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003540 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003541
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003542 /*
3543 * We've claimed all manager positions. Make all workers unbound
3544 * and set DISASSOCIATED. Before this, all workers except for the
3545 * ones which are still executing works from before the last CPU
3546 * down must be on the cpu. After this, they may become diasporas.
3547 */
Tejun Heo60373152012-07-17 12:39:27 -07003548 for_each_worker_pool(pool, gcwq)
Tejun Heo4ce62e92012-07-13 22:16:44 -07003549 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07003550 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003551
3552 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo403c8212012-07-17 12:39:27 -07003553 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003554
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003555 gcwq->flags |= GCWQ_DISASSOCIATED;
3556
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003557 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003558
3559 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07003560 * Call schedule() so that we cross rq->lock and thus can guarantee
3561 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3562 * as scheduler callbacks may be invoked from other cpus.
3563 */
3564 schedule();
3565
3566 /*
3567 * Sched callbacks are disabled now. Zap nr_running. After this,
3568 * nr_running stays zero and need_more_worker() and keep_working()
3569 * are always true as long as the worklist is not empty. @gcwq now
3570 * behaves as unbound (in terms of concurrency management) gcwq
3571 * which is served by workers tied to the CPU.
3572 *
3573 * On return from this function, the current worker would trigger
3574 * unbound chain execution of pending work items if other workers
3575 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02003576 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07003577 for_each_worker_pool(pool, gcwq)
3578 atomic_set(get_pool_nr_running(pool), 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003579}
3580
Tejun Heo8db25e72012-07-17 12:39:28 -07003581/*
3582 * Workqueues should be brought up before normal priority CPU notifiers.
3583 * This will be registered high priority CPU notifier.
3584 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003585static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07003586 unsigned long action,
3587 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003588{
3589 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003590 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003591 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003592
Tejun Heo8db25e72012-07-17 12:39:28 -07003593 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003594 case CPU_UP_PREPARE:
Tejun Heo4ce62e92012-07-13 22:16:44 -07003595 for_each_worker_pool(pool, gcwq) {
Tejun Heo3ce63372012-07-17 12:39:27 -07003596 struct worker *worker;
3597
3598 if (pool->nr_workers)
3599 continue;
3600
3601 worker = create_worker(pool);
3602 if (!worker)
3603 return NOTIFY_BAD;
3604
3605 spin_lock_irq(&gcwq->lock);
3606 start_worker(worker);
3607 spin_unlock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003608 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003609 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003610
Tejun Heo65758202012-07-17 12:39:26 -07003611 case CPU_DOWN_FAILED:
3612 case CPU_ONLINE:
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003613 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heo8db25e72012-07-17 12:39:28 -07003614 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3615 rebind_workers(gcwq);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003616 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heo8db25e72012-07-17 12:39:28 -07003617 break;
Tejun Heo65758202012-07-17 12:39:26 -07003618 }
3619 return NOTIFY_OK;
3620}
3621
3622/*
3623 * Workqueues should be brought down after normal priority CPU notifiers.
3624 * This will be registered as low priority CPU notifier.
3625 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003626static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07003627 unsigned long action,
3628 void *hcpu)
3629{
Tejun Heo8db25e72012-07-17 12:39:28 -07003630 unsigned int cpu = (unsigned long)hcpu;
3631 struct work_struct unbind_work;
3632
Tejun Heo65758202012-07-17 12:39:26 -07003633 switch (action & ~CPU_TASKS_FROZEN) {
3634 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003635 /* unbinding should happen on the local CPU */
3636 INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09003637 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07003638 flush_work(&unbind_work);
3639 break;
Tejun Heo65758202012-07-17 12:39:26 -07003640 }
3641 return NOTIFY_OK;
3642}
3643
Rusty Russell2d3854a2008-11-05 13:39:10 +11003644#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003645
Rusty Russell2d3854a2008-11-05 13:39:10 +11003646struct work_for_cpu {
Andrew Morton6b44003e2009-04-09 09:50:37 -06003647 struct completion completion;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003648 long (*fn)(void *);
3649 void *arg;
3650 long ret;
3651};
3652
Andrew Morton6b44003e2009-04-09 09:50:37 -06003653static int do_work_for_cpu(void *_wfc)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003654{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003655 struct work_for_cpu *wfc = _wfc;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003656 wfc->ret = wfc->fn(wfc->arg);
Andrew Morton6b44003e2009-04-09 09:50:37 -06003657 complete(&wfc->completion);
3658 return 0;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003659}
3660
3661/**
3662 * work_on_cpu - run a function in user context on a particular cpu
3663 * @cpu: the cpu to run on
3664 * @fn: the function to run
3665 * @arg: the function arg
3666 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003667 * This will return the value @fn returns.
3668 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06003669 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003670 */
3671long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3672{
Andrew Morton6b44003e2009-04-09 09:50:37 -06003673 struct task_struct *sub_thread;
3674 struct work_for_cpu wfc = {
3675 .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion),
3676 .fn = fn,
3677 .arg = arg,
3678 };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003679
Andrew Morton6b44003e2009-04-09 09:50:37 -06003680 sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu");
3681 if (IS_ERR(sub_thread))
3682 return PTR_ERR(sub_thread);
3683 kthread_bind(sub_thread, cpu);
3684 wake_up_process(sub_thread);
3685 wait_for_completion(&wfc.completion);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003686 return wfc.ret;
3687}
3688EXPORT_SYMBOL_GPL(work_on_cpu);
3689#endif /* CONFIG_SMP */
3690
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003691#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303692
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003693/**
3694 * freeze_workqueues_begin - begin freezing workqueues
3695 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003696 * Start freezing workqueues. After this function returns, all freezable
3697 * workqueues will queue new works to their frozen_works list instead of
3698 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003699 *
3700 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003701 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003702 */
3703void freeze_workqueues_begin(void)
3704{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003705 unsigned int cpu;
3706
3707 spin_lock(&workqueue_lock);
3708
3709 BUG_ON(workqueue_freezing);
3710 workqueue_freezing = true;
3711
Tejun Heof3421792010-07-02 10:03:51 +02003712 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003713 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003714 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003715
3716 spin_lock_irq(&gcwq->lock);
3717
Tejun Heodb7bccf2010-06-29 10:07:12 +02003718 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3719 gcwq->flags |= GCWQ_FREEZING;
3720
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003721 list_for_each_entry(wq, &workqueues, list) {
3722 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3723
Tejun Heo58a69cb2011-02-16 09:25:31 +01003724 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003725 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003726 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003727
3728 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003729 }
3730
3731 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003732}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003733
3734/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003735 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003736 *
3737 * Check whether freezing is complete. This function must be called
3738 * between freeze_workqueues_begin() and thaw_workqueues().
3739 *
3740 * CONTEXT:
3741 * Grabs and releases workqueue_lock.
3742 *
3743 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003744 * %true if some freezable workqueues are still busy. %false if freezing
3745 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003746 */
3747bool freeze_workqueues_busy(void)
3748{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003749 unsigned int cpu;
3750 bool busy = false;
3751
3752 spin_lock(&workqueue_lock);
3753
3754 BUG_ON(!workqueue_freezing);
3755
Tejun Heof3421792010-07-02 10:03:51 +02003756 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003757 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003758 /*
3759 * nr_active is monotonically decreasing. It's safe
3760 * to peek without lock.
3761 */
3762 list_for_each_entry(wq, &workqueues, list) {
3763 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3764
Tejun Heo58a69cb2011-02-16 09:25:31 +01003765 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003766 continue;
3767
3768 BUG_ON(cwq->nr_active < 0);
3769 if (cwq->nr_active) {
3770 busy = true;
3771 goto out_unlock;
3772 }
3773 }
3774 }
3775out_unlock:
3776 spin_unlock(&workqueue_lock);
3777 return busy;
3778}
3779
3780/**
3781 * thaw_workqueues - thaw workqueues
3782 *
3783 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003784 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003785 *
3786 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003787 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003788 */
3789void thaw_workqueues(void)
3790{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003791 unsigned int cpu;
3792
3793 spin_lock(&workqueue_lock);
3794
3795 if (!workqueue_freezing)
3796 goto out_unlock;
3797
Tejun Heof3421792010-07-02 10:03:51 +02003798 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003799 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003800 struct worker_pool *pool;
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003801 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003802
3803 spin_lock_irq(&gcwq->lock);
3804
Tejun Heodb7bccf2010-06-29 10:07:12 +02003805 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3806 gcwq->flags &= ~GCWQ_FREEZING;
3807
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003808 list_for_each_entry(wq, &workqueues, list) {
3809 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3810
Tejun Heo58a69cb2011-02-16 09:25:31 +01003811 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003812 continue;
3813
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003814 /* restore max_active and repopulate worklist */
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003815 cwq_set_max_active(cwq, wq->saved_max_active);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003816 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003817
Tejun Heo4ce62e92012-07-13 22:16:44 -07003818 for_each_worker_pool(pool, gcwq)
3819 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02003820
Tejun Heo8b03ae32010-06-29 10:07:12 +02003821 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003822 }
3823
3824 workqueue_freezing = false;
3825out_unlock:
3826 spin_unlock(&workqueue_lock);
3827}
3828#endif /* CONFIG_FREEZER */
3829
Suresh Siddha6ee05782010-07-30 14:57:37 -07003830static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003831{
Tejun Heoc34056a2010-06-29 10:07:11 +02003832 unsigned int cpu;
Tejun Heoc8e55f32010-06-29 10:07:12 +02003833 int i;
Tejun Heoc34056a2010-06-29 10:07:11 +02003834
Tejun Heob5490072012-08-03 10:30:46 -07003835 /* make sure we have enough bits for OFFQ CPU number */
3836 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3837 WORK_CPU_LAST);
3838
Tejun Heo65758202012-07-17 12:39:26 -07003839 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07003840 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003841
3842 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003843 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003844 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003845 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003846
3847 spin_lock_init(&gcwq->lock);
3848 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003849 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003850
Tejun Heoc8e55f32010-06-29 10:07:12 +02003851 for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++)
3852 INIT_HLIST_HEAD(&gcwq->busy_hash[i]);
3853
Tejun Heo4ce62e92012-07-13 22:16:44 -07003854 for_each_worker_pool(pool, gcwq) {
3855 pool->gcwq = gcwq;
3856 INIT_LIST_HEAD(&pool->worklist);
3857 INIT_LIST_HEAD(&pool->idle_list);
Tejun Heoe22bee72010-06-29 10:07:14 +02003858
Tejun Heo4ce62e92012-07-13 22:16:44 -07003859 init_timer_deferrable(&pool->idle_timer);
3860 pool->idle_timer.function = idle_worker_timeout;
3861 pool->idle_timer.data = (unsigned long)pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003862
Tejun Heo4ce62e92012-07-13 22:16:44 -07003863 setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
3864 (unsigned long)pool);
3865
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003866 mutex_init(&pool->assoc_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003867 ida_init(&pool->worker_ida);
3868 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003869 }
3870
Tejun Heoe22bee72010-06-29 10:07:14 +02003871 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003872 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003873 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003874 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003875
Tejun Heo477a3c32010-08-31 10:54:35 +02003876 if (cpu != WORK_CPU_UNBOUND)
3877 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003878
3879 for_each_worker_pool(pool, gcwq) {
3880 struct worker *worker;
3881
Tejun Heobc2ae0f2012-07-17 12:39:27 -07003882 worker = create_worker(pool);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003883 BUG_ON(!worker);
3884 spin_lock_irq(&gcwq->lock);
3885 start_worker(worker);
3886 spin_unlock_irq(&gcwq->lock);
3887 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003888 }
3889
Tejun Heod320c032010-06-29 10:07:14 +02003890 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003891 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02003892 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003893 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3894 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003895 system_freezable_wq = alloc_workqueue("events_freezable",
3896 WQ_FREEZABLE, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003897 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Tejun Heoae930e02012-08-20 14:51:23 -07003898 !system_unbound_wq || !system_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003899 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003900}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003901early_initcall(init_workqueues);