blob: d24a41101838b69e0a3a08cfc1f9ff06ca633472 [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>
Sasha Levin42f85702012-12-17 10:01:23 -050044#include <linux/hashtable.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020045
46#include "workqueue_sched.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Tejun Heoc8e55f32010-06-29 10:07:12 +020048enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070049 /*
50 * global_cwq flags
51 *
52 * A bound gcwq is either associated or disassociated with its CPU.
53 * While associated (!DISASSOCIATED), all workers are bound to the
54 * CPU and none has %WORKER_UNBOUND set and concurrency management
55 * is in effect.
56 *
57 * While DISASSOCIATED, the cpu may be offline and all workers have
58 * %WORKER_UNBOUND set and concurrency management disabled, and may
59 * be executing on any CPU. The gcwq behaves as an unbound one.
60 *
61 * Note that DISASSOCIATED can be flipped only while holding
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -070062 * assoc_mutex of all pools on the gcwq to avoid changing binding
Tejun Heobc2ae0f2012-07-17 12:39:27 -070063 * state while create_worker() is in progress.
64 */
Tejun Heo11ebea52012-07-12 14:46:37 -070065 GCWQ_DISASSOCIATED = 1 << 0, /* cpu can't serve workers */
66 GCWQ_FREEZING = 1 << 1, /* freeze in progress */
67
68 /* pool flags */
69 POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
Lai Jiangshan552a37e2012-09-10 10:03:33 -070070 POOL_MANAGING_WORKERS = 1 << 1, /* managing workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020071
Tejun Heoc8e55f32010-06-29 10:07:12 +020072 /* worker flags */
73 WORKER_STARTED = 1 << 0, /* started */
74 WORKER_DIE = 1 << 1, /* die die die */
75 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020076 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020077 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020078 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoe22bee72010-06-29 10:07:14 +020079
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -070080 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_UNBOUND |
Tejun Heo403c8212012-07-17 12:39:27 -070081 WORKER_CPU_INTENSIVE,
Tejun Heodb7bccf2010-06-29 10:07:12 +020082
Tejun Heo32704762012-07-13 22:16:45 -070083 NR_WORKER_POOLS = 2, /* # worker pools per gcwq */
Tejun Heo4ce62e92012-07-13 22:16:44 -070084
Tejun Heoc8e55f32010-06-29 10:07:12 +020085 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020086
Tejun Heoe22bee72010-06-29 10:07:14 +020087 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
88 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
89
Tejun Heo3233cdb2011-02-16 18:10:19 +010090 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
91 /* call for help after 10ms
92 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020093 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
94 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020095
96 /*
97 * Rescue workers are used only on emergencies and shared by
98 * all cpus. Give -20.
99 */
100 RESCUER_NICE_LEVEL = -20,
Tejun Heo32704762012-07-13 22:16:45 -0700101 HIGHPRI_NICE_LEVEL = -20,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200102};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
104/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200105 * Structure fields follow one of the following exclusion rules.
106 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200107 * I: Modifiable by initialization/destruction paths and read-only for
108 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200109 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200110 * P: Preemption protected. Disabling preemption is enough and should
111 * only be modified and accessed from the local cpu.
112 *
Tejun Heo8b03ae32010-06-29 10:07:12 +0200113 * L: gcwq->lock protected. Access with gcwq->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200114 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200115 * X: During normal operation, modification requires gcwq->lock and
116 * should be done only from local cpu. Either disabling preemption
117 * on local cpu or grabbing gcwq->lock is enough for read access.
Tejun Heof3421792010-07-02 10:03:51 +0200118 * If GCWQ_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200119 *
Tejun Heo73f53c42010-06-29 10:07:11 +0200120 * F: wq->flush_mutex protected.
121 *
Tejun Heo4690c4a2010-06-29 10:07:10 +0200122 * W: workqueue_lock protected.
123 */
124
Tejun Heo8b03ae32010-06-29 10:07:12 +0200125struct global_cwq;
Tejun Heobd7bdd42012-07-12 14:46:37 -0700126struct worker_pool;
Tejun Heoc34056a2010-06-29 10:07:11 +0200127
Tejun Heoe22bee72010-06-29 10:07:14 +0200128/*
129 * The poor guys doing the actual heavy lifting. All on-duty workers
130 * are either serving the manager role, on idle list or on busy hash.
131 */
Tejun Heoc34056a2010-06-29 10:07:11 +0200132struct worker {
Tejun Heoc8e55f32010-06-29 10:07:12 +0200133 /* on idle list while idle, on busy hash table while busy */
134 union {
135 struct list_head entry; /* L: while idle */
136 struct hlist_node hentry; /* L: while busy */
137 };
138
Tejun Heoc34056a2010-06-29 10:07:11 +0200139 struct work_struct *current_work; /* L: work being processed */
Tejun Heoa2c1c572012-12-18 10:35:02 -0800140 work_func_t current_func; /* L: current_work's fn */
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 */
Sasha Levin42f85702012-12-17 10:01:23 -0500183 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
Tejun Heoc8e55f32010-06-29 10:07:12 +0200184 /* 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) \
Sasha Levin42f85702012-12-17 10:01:23 -0500288 hash_for_each(gcwq->busy_hash, i, pos, worker, hentry)
Tejun Heodb7bccf2010-06-29 10:07:12 +0200289
Tejun Heof3421792010-07-02 10:03:51 +0200290static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
291 unsigned int sw)
292{
293 if (cpu < nr_cpu_ids) {
294 if (sw & 1) {
295 cpu = cpumask_next(cpu, mask);
296 if (cpu < nr_cpu_ids)
297 return cpu;
298 }
299 if (sw & 2)
300 return WORK_CPU_UNBOUND;
301 }
302 return WORK_CPU_NONE;
303}
304
305static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
306 struct workqueue_struct *wq)
307{
308 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
309}
310
Tejun Heo09884952010-08-01 11:50:12 +0200311/*
312 * CPU iterators
313 *
314 * An extra gcwq is defined for an invalid cpu number
315 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
316 * specific CPU. The following iterators are similar to
317 * for_each_*_cpu() iterators but also considers the unbound gcwq.
318 *
319 * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
320 * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
321 * for_each_cwq_cpu() : possible CPUs for bound workqueues,
322 * WORK_CPU_UNBOUND for unbound workqueues
323 */
Tejun Heof3421792010-07-02 10:03:51 +0200324#define for_each_gcwq_cpu(cpu) \
325 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
326 (cpu) < WORK_CPU_NONE; \
327 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
328
329#define for_each_online_gcwq_cpu(cpu) \
330 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
331 (cpu) < WORK_CPU_NONE; \
332 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
333
334#define for_each_cwq_cpu(cpu, wq) \
335 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
336 (cpu) < WORK_CPU_NONE; \
337 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
338
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900339#ifdef CONFIG_DEBUG_OBJECTS_WORK
340
341static struct debug_obj_descr work_debug_descr;
342
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100343static void *work_debug_hint(void *addr)
344{
345 return ((struct work_struct *) addr)->func;
346}
347
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900348/*
349 * fixup_init is called when:
350 * - an active object is initialized
351 */
352static int work_fixup_init(void *addr, enum debug_obj_state state)
353{
354 struct work_struct *work = addr;
355
356 switch (state) {
357 case ODEBUG_STATE_ACTIVE:
358 cancel_work_sync(work);
359 debug_object_init(work, &work_debug_descr);
360 return 1;
361 default:
362 return 0;
363 }
364}
365
366/*
367 * fixup_activate is called when:
368 * - an active object is activated
369 * - an unknown object is activated (might be a statically initialized object)
370 */
371static int work_fixup_activate(void *addr, enum debug_obj_state state)
372{
373 struct work_struct *work = addr;
374
375 switch (state) {
376
377 case ODEBUG_STATE_NOTAVAILABLE:
378 /*
379 * This is not really a fixup. The work struct was
380 * statically initialized. We just make sure that it
381 * is tracked in the object tracker.
382 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200383 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900384 debug_object_init(work, &work_debug_descr);
385 debug_object_activate(work, &work_debug_descr);
386 return 0;
387 }
388 WARN_ON_ONCE(1);
389 return 0;
390
391 case ODEBUG_STATE_ACTIVE:
392 WARN_ON(1);
393
394 default:
395 return 0;
396 }
397}
398
399/*
400 * fixup_free is called when:
401 * - an active object is freed
402 */
403static int work_fixup_free(void *addr, enum debug_obj_state state)
404{
405 struct work_struct *work = addr;
406
407 switch (state) {
408 case ODEBUG_STATE_ACTIVE:
409 cancel_work_sync(work);
410 debug_object_free(work, &work_debug_descr);
411 return 1;
412 default:
413 return 0;
414 }
415}
416
417static struct debug_obj_descr work_debug_descr = {
418 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100419 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900420 .fixup_init = work_fixup_init,
421 .fixup_activate = work_fixup_activate,
422 .fixup_free = work_fixup_free,
423};
424
425static inline void debug_work_activate(struct work_struct *work)
426{
427 debug_object_activate(work, &work_debug_descr);
428}
429
430static inline void debug_work_deactivate(struct work_struct *work)
431{
432 debug_object_deactivate(work, &work_debug_descr);
433}
434
435void __init_work(struct work_struct *work, int onstack)
436{
437 if (onstack)
438 debug_object_init_on_stack(work, &work_debug_descr);
439 else
440 debug_object_init(work, &work_debug_descr);
441}
442EXPORT_SYMBOL_GPL(__init_work);
443
444void destroy_work_on_stack(struct work_struct *work)
445{
446 debug_object_free(work, &work_debug_descr);
447}
448EXPORT_SYMBOL_GPL(destroy_work_on_stack);
449
450#else
451static inline void debug_work_activate(struct work_struct *work) { }
452static inline void debug_work_deactivate(struct work_struct *work) { }
453#endif
454
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100455/* Serializes the accesses to the list of workqueues. */
456static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200458static bool workqueue_freezing; /* W: have wqs started freezing? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
Oleg Nesterov14441962007-05-23 13:57:57 -0700460/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200461 * The almighty global cpu workqueues. nr_running is the only field
462 * which is expected to be used frequently by other cpus via
463 * try_to_wake_up(). Put it in a separate cacheline.
Oleg Nesterov14441962007-05-23 13:57:57 -0700464 */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200465static DEFINE_PER_CPU(struct global_cwq, global_cwq);
Tejun Heo4ce62e92012-07-13 22:16:44 -0700466static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
Nathan Lynchf756d5e2006-01-08 01:05:12 -0800467
Tejun Heof3421792010-07-02 10:03:51 +0200468/*
469 * Global cpu workqueue and nr_running counter for unbound gcwq. The
470 * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
471 * workers have WORKER_UNBOUND set.
472 */
473static struct global_cwq unbound_global_cwq;
Tejun Heo4ce62e92012-07-13 22:16:44 -0700474static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
475 [0 ... NR_WORKER_POOLS - 1] = ATOMIC_INIT(0), /* always 0 */
476};
Tejun Heof3421792010-07-02 10:03:51 +0200477
Tejun Heoc34056a2010-06-29 10:07:11 +0200478static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
Tejun Heo32704762012-07-13 22:16:45 -0700480static int worker_pool_pri(struct worker_pool *pool)
481{
482 return pool - pool->gcwq->pools;
483}
484
Tejun Heo8b03ae32010-06-29 10:07:12 +0200485static struct global_cwq *get_gcwq(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486{
Tejun Heof3421792010-07-02 10:03:51 +0200487 if (cpu != WORK_CPU_UNBOUND)
488 return &per_cpu(global_cwq, cpu);
489 else
490 return &unbound_global_cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491}
492
Tejun Heo63d95a92012-07-12 14:46:37 -0700493static atomic_t *get_pool_nr_running(struct worker_pool *pool)
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700494{
Tejun Heo63d95a92012-07-12 14:46:37 -0700495 int cpu = pool->gcwq->cpu;
Tejun Heo32704762012-07-13 22:16:45 -0700496 int idx = worker_pool_pri(pool);
Tejun Heo63d95a92012-07-12 14:46:37 -0700497
Tejun Heof3421792010-07-02 10:03:51 +0200498 if (cpu != WORK_CPU_UNBOUND)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700499 return &per_cpu(pool_nr_running, cpu)[idx];
Tejun Heof3421792010-07-02 10:03:51 +0200500 else
Tejun Heo4ce62e92012-07-13 22:16:44 -0700501 return &unbound_pool_nr_running[idx];
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700502}
503
Tejun Heo4690c4a2010-06-29 10:07:10 +0200504static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
505 struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700506{
Tejun Heof3421792010-07-02 10:03:51 +0200507 if (!(wq->flags & WQ_UNBOUND)) {
Lai Jiangshane06ffa12012-03-09 18:03:20 +0800508 if (likely(cpu < nr_cpu_ids))
Tejun Heof3421792010-07-02 10:03:51 +0200509 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
Tejun Heof3421792010-07-02 10:03:51 +0200510 } else if (likely(cpu == WORK_CPU_UNBOUND))
511 return wq->cpu_wq.single;
512 return NULL;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700513}
514
Tejun Heo73f53c42010-06-29 10:07:11 +0200515static unsigned int work_color_to_flags(int color)
516{
517 return color << WORK_STRUCT_COLOR_SHIFT;
518}
519
520static int get_work_color(struct work_struct *work)
521{
522 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
523 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
524}
525
526static int work_next_color(int color)
527{
528 return (color + 1) % WORK_NR_COLORS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529}
530
David Howells4594bf12006-12-07 11:33:26 +0000531/*
Tejun Heob5490072012-08-03 10:30:46 -0700532 * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
533 * contain the pointer to the queued cwq. Once execution starts, the flag
534 * is cleared and the high bits contain OFFQ flags and CPU number.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200535 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700536 * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
537 * and clear_work_data() can be used to set the cwq, cpu or clear
538 * work->data. These functions should only be called while the work is
539 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200540 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700541 * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
542 * a work. gcwq is available once the work has been queued anywhere after
543 * initialization until it is sync canceled. cwq is available only while
544 * the work item is queued.
545 *
546 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
547 * canceled. While being canceled, a work item may have its PENDING set
548 * but stay off timer and worklist for arbitrarily long and nobody should
549 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000550 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200551static inline void set_work_data(struct work_struct *work, unsigned long data,
552 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000553{
David Howells4594bf12006-12-07 11:33:26 +0000554 BUG_ON(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200555 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000556}
David Howells365970a2006-11-22 14:54:49 +0000557
Tejun Heo7a22ad72010-06-29 10:07:13 +0200558static void set_work_cwq(struct work_struct *work,
559 struct cpu_workqueue_struct *cwq,
560 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200561{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200562 set_work_data(work, (unsigned long)cwq,
Tejun Heoe1201532010-07-22 14:14:25 +0200563 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200564}
565
Tejun Heo8930cab2012-08-03 10:30:45 -0700566static void set_work_cpu_and_clear_pending(struct work_struct *work,
567 unsigned int cpu)
David Howells365970a2006-11-22 14:54:49 +0000568{
Tejun Heo23657bb2012-08-13 17:08:19 -0700569 /*
570 * The following wmb is paired with the implied mb in
571 * test_and_set_bit(PENDING) and ensures all updates to @work made
572 * here are visible to and precede any updates by the next PENDING
573 * owner.
574 */
575 smp_wmb();
Tejun Heob5490072012-08-03 10:30:46 -0700576 set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200577}
578
579static void clear_work_data(struct work_struct *work)
580{
Tejun Heo23657bb2012-08-13 17:08:19 -0700581 smp_wmb(); /* see set_work_cpu_and_clear_pending() */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200582 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
583}
584
Tejun Heo7a22ad72010-06-29 10:07:13 +0200585static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
586{
Tejun Heoe1201532010-07-22 14:14:25 +0200587 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200588
Tejun Heoe1201532010-07-22 14:14:25 +0200589 if (data & WORK_STRUCT_CWQ)
590 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
591 else
592 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200593}
594
595static struct global_cwq *get_work_gcwq(struct work_struct *work)
596{
Tejun Heoe1201532010-07-22 14:14:25 +0200597 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200598 unsigned int cpu;
599
Tejun Heoe1201532010-07-22 14:14:25 +0200600 if (data & WORK_STRUCT_CWQ)
601 return ((struct cpu_workqueue_struct *)
Tejun Heobd7bdd42012-07-12 14:46:37 -0700602 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200603
Tejun Heob5490072012-08-03 10:30:46 -0700604 cpu = data >> WORK_OFFQ_CPU_SHIFT;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200605 if (cpu == WORK_CPU_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200606 return NULL;
607
Tejun Heof3421792010-07-02 10:03:51 +0200608 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200609 return get_gcwq(cpu);
David Howells365970a2006-11-22 14:54:49 +0000610}
611
Tejun Heobbb68df2012-08-03 10:30:46 -0700612static void mark_work_canceling(struct work_struct *work)
613{
614 struct global_cwq *gcwq = get_work_gcwq(work);
615 unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
616
617 set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
618 WORK_STRUCT_PENDING);
619}
620
621static bool work_is_canceling(struct work_struct *work)
622{
623 unsigned long data = atomic_long_read(&work->data);
624
625 return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
626}
627
David Howells365970a2006-11-22 14:54:49 +0000628/*
Tejun Heo32704762012-07-13 22:16:45 -0700629 * Policy functions. These define the policies on how the global worker
630 * pools are managed. Unless noted otherwise, these functions assume that
631 * they're being called with gcwq->lock held.
David Howells365970a2006-11-22 14:54:49 +0000632 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200633
Tejun Heo63d95a92012-07-12 14:46:37 -0700634static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000635{
Tejun Heo32704762012-07-13 22:16:45 -0700636 return !atomic_read(get_pool_nr_running(pool));
David Howells365970a2006-11-22 14:54:49 +0000637}
638
Tejun Heoe22bee72010-06-29 10:07:14 +0200639/*
640 * Need to wake up a worker? Called from anything but currently
641 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700642 *
643 * Note that, because unbound workers never contribute to nr_running, this
644 * function will always return %true for unbound gcwq as long as the
645 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200646 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700647static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000648{
Tejun Heo63d95a92012-07-12 14:46:37 -0700649 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000650}
651
Tejun Heoe22bee72010-06-29 10:07:14 +0200652/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700653static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200654{
Tejun Heo63d95a92012-07-12 14:46:37 -0700655 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200656}
657
658/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700659static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200660{
Tejun Heo63d95a92012-07-12 14:46:37 -0700661 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200662
Tejun Heo32704762012-07-13 22:16:45 -0700663 return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200664}
665
666/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700667static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200668{
Tejun Heo63d95a92012-07-12 14:46:37 -0700669 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200670}
671
672/* Do I need to be the manager? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700673static bool need_to_manage_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200674{
Tejun Heo63d95a92012-07-12 14:46:37 -0700675 return need_to_create_worker(pool) ||
Tejun Heo11ebea52012-07-12 14:46:37 -0700676 (pool->flags & POOL_MANAGE_WORKERS);
Tejun Heoe22bee72010-06-29 10:07:14 +0200677}
678
679/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700680static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200681{
Lai Jiangshan552a37e2012-09-10 10:03:33 -0700682 bool managing = pool->flags & POOL_MANAGING_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -0700683 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
684 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200685
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700686 /*
687 * nr_idle and idle_list may disagree if idle rebinding is in
688 * progress. Never return %true if idle_list is empty.
689 */
690 if (list_empty(&pool->idle_list))
691 return false;
692
Tejun Heoe22bee72010-06-29 10:07:14 +0200693 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
694}
695
696/*
697 * Wake up functions.
698 */
699
Tejun Heo7e116292010-06-29 10:07:13 +0200700/* Return the first worker. Safe with preemption disabled */
Tejun Heo63d95a92012-07-12 14:46:37 -0700701static struct worker *first_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200702{
Tejun Heo63d95a92012-07-12 14:46:37 -0700703 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200704 return NULL;
705
Tejun Heo63d95a92012-07-12 14:46:37 -0700706 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200707}
708
709/**
710 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700711 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200712 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700713 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200714 *
715 * CONTEXT:
716 * spin_lock_irq(gcwq->lock).
717 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700718static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200719{
Tejun Heo63d95a92012-07-12 14:46:37 -0700720 struct worker *worker = first_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200721
722 if (likely(worker))
723 wake_up_process(worker->task);
724}
725
Tejun Heo4690c4a2010-06-29 10:07:10 +0200726/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200727 * wq_worker_waking_up - a worker is waking up
728 * @task: task waking up
729 * @cpu: CPU @task is waking up to
730 *
731 * This function is called during try_to_wake_up() when a worker is
732 * being awoken.
733 *
734 * CONTEXT:
735 * spin_lock_irq(rq->lock)
736 */
737void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
738{
739 struct worker *worker = kthread_data(task);
740
Joonsoo Kim36576002012-10-26 23:03:49 +0900741 if (!(worker->flags & WORKER_NOT_RUNNING)) {
742 WARN_ON_ONCE(worker->pool->gcwq->cpu != cpu);
Tejun Heo63d95a92012-07-12 14:46:37 -0700743 atomic_inc(get_pool_nr_running(worker->pool));
Joonsoo Kim36576002012-10-26 23:03:49 +0900744 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200745}
746
747/**
748 * wq_worker_sleeping - a worker is going to sleep
749 * @task: task going to sleep
750 * @cpu: CPU in question, must be the current CPU number
751 *
752 * This function is called during schedule() when a busy worker is
753 * going to sleep. Worker on the same cpu can be woken up by
754 * returning pointer to its task.
755 *
756 * CONTEXT:
757 * spin_lock_irq(rq->lock)
758 *
759 * RETURNS:
760 * Worker task on @cpu to wake up, %NULL if none.
761 */
762struct task_struct *wq_worker_sleeping(struct task_struct *task,
763 unsigned int cpu)
764{
765 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heobd7bdd42012-07-12 14:46:37 -0700766 struct worker_pool *pool = worker->pool;
Tejun Heo63d95a92012-07-12 14:46:37 -0700767 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200768
Steven Rostedt2d646722010-12-03 23:12:33 -0500769 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200770 return NULL;
771
772 /* this can only happen on the local cpu */
773 BUG_ON(cpu != raw_smp_processor_id());
774
775 /*
776 * The counterpart of the following dec_and_test, implied mb,
777 * worklist not empty test sequence is in insert_work().
778 * Please read comment there.
779 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700780 * NOT_RUNNING is clear. This means that we're bound to and
781 * running on the local cpu w/ rq lock held and preemption
782 * disabled, which in turn means that none else could be
783 * manipulating idle_list, so dereferencing idle_list without gcwq
784 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200785 */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700786 if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700787 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200788 return to_wakeup ? to_wakeup->task : NULL;
789}
790
791/**
792 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200793 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200794 * @flags: flags to set
795 * @wakeup: wakeup an idle worker if necessary
796 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200797 * Set @flags in @worker->flags and adjust nr_running accordingly. If
798 * nr_running becomes zero and @wakeup is %true, an idle worker is
799 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200800 *
Tejun Heocb444762010-07-02 10:03:50 +0200801 * CONTEXT:
802 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200803 */
804static inline void worker_set_flags(struct worker *worker, unsigned int flags,
805 bool wakeup)
806{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700807 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200808
Tejun Heocb444762010-07-02 10:03:50 +0200809 WARN_ON_ONCE(worker->task != current);
810
Tejun Heoe22bee72010-06-29 10:07:14 +0200811 /*
812 * If transitioning into NOT_RUNNING, adjust nr_running and
813 * wake up an idle worker as necessary if requested by
814 * @wakeup.
815 */
816 if ((flags & WORKER_NOT_RUNNING) &&
817 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heo63d95a92012-07-12 14:46:37 -0700818 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200819
820 if (wakeup) {
821 if (atomic_dec_and_test(nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700822 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700823 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200824 } else
825 atomic_dec(nr_running);
826 }
827
Tejun Heod302f012010-06-29 10:07:13 +0200828 worker->flags |= flags;
829}
830
831/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200832 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200833 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200834 * @flags: flags to clear
835 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200836 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200837 *
Tejun Heocb444762010-07-02 10:03:50 +0200838 * CONTEXT:
839 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200840 */
841static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
842{
Tejun Heo63d95a92012-07-12 14:46:37 -0700843 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200844 unsigned int oflags = worker->flags;
845
Tejun Heocb444762010-07-02 10:03:50 +0200846 WARN_ON_ONCE(worker->task != current);
847
Tejun Heod302f012010-06-29 10:07:13 +0200848 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200849
Tejun Heo42c025f2011-01-11 15:58:49 +0100850 /*
851 * If transitioning out of NOT_RUNNING, increment nr_running. Note
852 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
853 * of multiple flags, not a single flag.
854 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200855 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
856 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700857 atomic_inc(get_pool_nr_running(pool));
Tejun Heod302f012010-06-29 10:07:13 +0200858}
859
860/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200861 * find_worker_executing_work - find worker which is executing a work
862 * @gcwq: gcwq of interest
863 * @work: work to find worker for
864 *
Tejun Heoa2c1c572012-12-18 10:35:02 -0800865 * Find a worker which is executing @work on @gcwq by searching
866 * @gcwq->busy_hash which is keyed by the address of @work. For a worker
867 * to match, its current execution should match the address of @work and
868 * its work function. This is to avoid unwanted dependency between
869 * unrelated work executions through a work item being recycled while still
870 * being executed.
871 *
872 * This is a bit tricky. A work item may be freed once its execution
873 * starts and nothing prevents the freed area from being recycled for
874 * another work item. If the same work item address ends up being reused
875 * before the original execution finishes, workqueue will identify the
876 * recycled work item as currently executing and make it wait until the
877 * current execution finishes, introducing an unwanted dependency.
878 *
879 * This function checks the work item address, work function and workqueue
880 * to avoid false positives. Note that this isn't complete as one may
881 * construct a work function which can introduce dependency onto itself
882 * through a recycled work item. Well, if somebody wants to shoot oneself
883 * in the foot that badly, there's only so much we can do, and if such
884 * deadlock actually occurs, it should be easy to locate the culprit work
885 * function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200886 *
887 * CONTEXT:
888 * spin_lock_irq(gcwq->lock).
889 *
890 * RETURNS:
891 * Pointer to worker which is executing @work if found, NULL
892 * otherwise.
893 */
894static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
895 struct work_struct *work)
896{
Sasha Levin42f85702012-12-17 10:01:23 -0500897 struct worker *worker;
898 struct hlist_node *tmp;
899
Tejun Heoa2c1c572012-12-18 10:35:02 -0800900 hash_for_each_possible(gcwq->busy_hash, worker, tmp, hentry,
901 (unsigned long)work)
902 if (worker->current_work == work &&
903 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500904 return worker;
905
906 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200907}
908
909/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700910 * move_linked_works - move linked works to a list
911 * @work: start of series of works to be scheduled
912 * @head: target list to append @work to
913 * @nextp: out paramter for nested worklist walking
914 *
915 * Schedule linked works starting from @work to @head. Work series to
916 * be scheduled starts at @work and includes any consecutive work with
917 * WORK_STRUCT_LINKED set in its predecessor.
918 *
919 * If @nextp is not NULL, it's updated to point to the next work of
920 * the last scheduled work. This allows move_linked_works() to be
921 * nested inside outer list_for_each_entry_safe().
922 *
923 * CONTEXT:
924 * spin_lock_irq(gcwq->lock).
925 */
926static void move_linked_works(struct work_struct *work, struct list_head *head,
927 struct work_struct **nextp)
928{
929 struct work_struct *n;
930
931 /*
932 * Linked worklist will always end before the end of the list,
933 * use NULL for list head.
934 */
935 list_for_each_entry_safe_from(work, n, NULL, entry) {
936 list_move_tail(&work->entry, head);
937 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
938 break;
939 }
940
941 /*
942 * If we're already inside safe list traversal and have moved
943 * multiple works to the scheduled queue, the next position
944 * needs to be updated.
945 */
946 if (nextp)
947 *nextp = n;
948}
949
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700950static void cwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -0700951{
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700952 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -0700953
954 trace_workqueue_activate_work(work);
955 move_linked_works(work, &cwq->pool->worklist, NULL);
956 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
957 cwq->nr_active++;
958}
959
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700960static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
961{
962 struct work_struct *work = list_first_entry(&cwq->delayed_works,
963 struct work_struct, entry);
964
965 cwq_activate_delayed_work(work);
966}
967
Tejun Heobf4ede02012-08-03 10:30:46 -0700968/**
969 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
970 * @cwq: cwq of interest
971 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -0700972 *
973 * A work either has completed or is removed from pending queue,
974 * decrement nr_in_flight of its cwq and handle workqueue flushing.
975 *
976 * CONTEXT:
977 * spin_lock_irq(gcwq->lock).
978 */
Lai Jiangshanb3f9f402012-09-18 10:40:00 -0700979static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -0700980{
981 /* ignore uncolored works */
982 if (color == WORK_NO_COLOR)
983 return;
984
985 cwq->nr_in_flight[color]--;
986
Lai Jiangshanb3f9f402012-09-18 10:40:00 -0700987 cwq->nr_active--;
988 if (!list_empty(&cwq->delayed_works)) {
989 /* one down, submit a delayed one */
990 if (cwq->nr_active < cwq->max_active)
991 cwq_activate_first_delayed(cwq);
Tejun Heobf4ede02012-08-03 10:30:46 -0700992 }
993
994 /* is flush in progress and are we at the flushing tip? */
995 if (likely(cwq->flush_color != color))
996 return;
997
998 /* are there still in-flight works? */
999 if (cwq->nr_in_flight[color])
1000 return;
1001
1002 /* this cwq is done, clear flush_color */
1003 cwq->flush_color = -1;
1004
1005 /*
1006 * If this was the last cwq, wake up the first flusher. It
1007 * will handle the rest.
1008 */
1009 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1010 complete(&cwq->wq->first_flusher->done);
1011}
1012
Tejun Heo36e227d2012-08-03 10:30:46 -07001013/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001014 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001015 * @work: work item to steal
1016 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001017 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001018 *
1019 * Try to grab PENDING bit of @work. This function can handle @work in any
1020 * stable state - idle, on timer or on worklist. Return values are
1021 *
1022 * 1 if @work was pending and we successfully stole PENDING
1023 * 0 if @work was idle and we claimed PENDING
1024 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001025 * -ENOENT if someone else is canceling @work, this state may persist
1026 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001027 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001028 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001029 * interrupted while holding PENDING and @work off queue, irq must be
1030 * disabled on entry. This, combined with delayed_work->timer being
1031 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001032 *
1033 * On successful return, >= 0, irq is disabled and the caller is
1034 * responsible for releasing it using local_irq_restore(*@flags).
1035 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001036 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001037 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001038static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1039 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001040{
1041 struct global_cwq *gcwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001042
Tejun Heobbb68df2012-08-03 10:30:46 -07001043 local_irq_save(*flags);
1044
Tejun Heo36e227d2012-08-03 10:30:46 -07001045 /* try to steal the timer if it exists */
1046 if (is_dwork) {
1047 struct delayed_work *dwork = to_delayed_work(work);
1048
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001049 /*
1050 * dwork->timer is irqsafe. If del_timer() fails, it's
1051 * guaranteed that the timer is not queued anywhere and not
1052 * running on the local CPU.
1053 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001054 if (likely(del_timer(&dwork->timer)))
1055 return 1;
1056 }
1057
1058 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001059 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1060 return 0;
1061
1062 /*
1063 * The queueing is in progress, or it is already queued. Try to
1064 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1065 */
1066 gcwq = get_work_gcwq(work);
1067 if (!gcwq)
Tejun Heobbb68df2012-08-03 10:30:46 -07001068 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001069
Tejun Heobbb68df2012-08-03 10:30:46 -07001070 spin_lock(&gcwq->lock);
Tejun Heobf4ede02012-08-03 10:30:46 -07001071 if (!list_empty(&work->entry)) {
1072 /*
1073 * This work is queued, but perhaps we locked the wrong gcwq.
1074 * In that case we must see the new value after rmb(), see
1075 * insert_work()->wmb().
1076 */
1077 smp_rmb();
1078 if (gcwq == get_work_gcwq(work)) {
1079 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001080
1081 /*
1082 * A delayed work item cannot be grabbed directly
1083 * because it might have linked NO_COLOR work items
1084 * which, if left on the delayed_list, will confuse
1085 * cwq->nr_active management later on and cause
1086 * stall. Make sure the work item is activated
1087 * before grabbing.
1088 */
1089 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1090 cwq_activate_delayed_work(work);
1091
Tejun Heobf4ede02012-08-03 10:30:46 -07001092 list_del_init(&work->entry);
1093 cwq_dec_nr_in_flight(get_work_cwq(work),
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001094 get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001095
Tejun Heobbb68df2012-08-03 10:30:46 -07001096 spin_unlock(&gcwq->lock);
Tejun Heo36e227d2012-08-03 10:30:46 -07001097 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001098 }
1099 }
Tejun Heobbb68df2012-08-03 10:30:46 -07001100 spin_unlock(&gcwq->lock);
1101fail:
1102 local_irq_restore(*flags);
1103 if (work_is_canceling(work))
1104 return -ENOENT;
1105 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001106 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001107}
1108
1109/**
Tejun Heo7e116292010-06-29 10:07:13 +02001110 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +02001111 * @cwq: cwq @work belongs to
1112 * @work: work to insert
1113 * @head: insertion point
1114 * @extra_flags: extra WORK_STRUCT_* flags to set
1115 *
Tejun Heo7e116292010-06-29 10:07:13 +02001116 * Insert @work which belongs to @cwq into @gcwq after @head.
1117 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001118 *
1119 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001120 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001121 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001122static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +02001123 struct work_struct *work, struct list_head *head,
1124 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001125{
Tejun Heo63d95a92012-07-12 14:46:37 -07001126 struct worker_pool *pool = cwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001127
Tejun Heo4690c4a2010-06-29 10:07:10 +02001128 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +02001129 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001130
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001131 /*
1132 * Ensure that we get the right work->data if we see the
1133 * result of list_add() below, see try_to_grab_pending().
1134 */
1135 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +02001136
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001137 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +02001138
1139 /*
1140 * Ensure either worker_sched_deactivated() sees the above
1141 * list_add_tail() or we see zero nr_running to avoid workers
1142 * lying around lazily while there are works to be processed.
1143 */
1144 smp_mb();
1145
Tejun Heo63d95a92012-07-12 14:46:37 -07001146 if (__need_more_worker(pool))
1147 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001148}
1149
Tejun Heoc8efcc22010-12-20 19:32:04 +01001150/*
1151 * Test whether @work is being queued from another work executing on the
1152 * same workqueue. This is rather expensive and should only be used from
1153 * cold paths.
1154 */
1155static bool is_chained_work(struct workqueue_struct *wq)
1156{
1157 unsigned long flags;
1158 unsigned int cpu;
1159
1160 for_each_gcwq_cpu(cpu) {
1161 struct global_cwq *gcwq = get_gcwq(cpu);
1162 struct worker *worker;
1163 struct hlist_node *pos;
1164 int i;
1165
1166 spin_lock_irqsave(&gcwq->lock, flags);
1167 for_each_busy_worker(worker, i, pos, gcwq) {
1168 if (worker->task != current)
1169 continue;
1170 spin_unlock_irqrestore(&gcwq->lock, flags);
1171 /*
1172 * I'm @worker, no locking necessary. See if @work
1173 * is headed to the same workqueue.
1174 */
1175 return worker->current_cwq->wq == wq;
1176 }
1177 spin_unlock_irqrestore(&gcwq->lock, flags);
1178 }
1179 return false;
1180}
1181
Tejun Heo4690c4a2010-06-29 10:07:10 +02001182static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 struct work_struct *work)
1184{
Tejun Heo502ca9d2010-06-29 10:07:13 +02001185 struct global_cwq *gcwq;
1186 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001187 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001188 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001189 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001190
1191 /*
1192 * While a work item is PENDING && off queue, a task trying to
1193 * steal the PENDING will busy-loop waiting for it to either get
1194 * queued or lose PENDING. Grabbing PENDING and queueing should
1195 * happen with IRQ disabled.
1196 */
1197 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001199 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001200
Tejun Heoc8efcc22010-12-20 19:32:04 +01001201 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02001202 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001203 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001204 return;
1205
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001206 /* determine gcwq to use */
1207 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001208 struct global_cwq *last_gcwq;
1209
Tejun Heo57469822012-08-03 10:30:45 -07001210 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001211 cpu = raw_smp_processor_id();
1212
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001213 /*
Tejun Heodbf25762012-08-20 14:51:23 -07001214 * It's multi cpu. If @work was previously on a different
1215 * cpu, it might still be running there, in which case the
1216 * work needs to be queued on that cpu to guarantee
1217 * non-reentrancy.
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001218 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001219 gcwq = get_gcwq(cpu);
Tejun Heodbf25762012-08-20 14:51:23 -07001220 last_gcwq = get_work_gcwq(work);
1221
1222 if (last_gcwq && last_gcwq != gcwq) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001223 struct worker *worker;
1224
Tejun Heo8930cab2012-08-03 10:30:45 -07001225 spin_lock(&last_gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001226
1227 worker = find_worker_executing_work(last_gcwq, work);
1228
1229 if (worker && worker->current_cwq->wq == wq)
1230 gcwq = last_gcwq;
1231 else {
1232 /* meh... not running there, queue here */
Tejun Heo8930cab2012-08-03 10:30:45 -07001233 spin_unlock(&last_gcwq->lock);
1234 spin_lock(&gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001235 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001236 } else {
1237 spin_lock(&gcwq->lock);
1238 }
Tejun Heof3421792010-07-02 10:03:51 +02001239 } else {
1240 gcwq = get_gcwq(WORK_CPU_UNBOUND);
Tejun Heo8930cab2012-08-03 10:30:45 -07001241 spin_lock(&gcwq->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001242 }
1243
1244 /* gcwq determined, get cwq and queue */
1245 cwq = get_cwq(gcwq->cpu, wq);
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001246 trace_workqueue_queue_work(req_cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001247
Dan Carpenterf5b25522012-04-13 22:06:58 +03001248 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo8930cab2012-08-03 10:30:45 -07001249 spin_unlock(&gcwq->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001250 return;
1251 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001252
Tejun Heo73f53c42010-06-29 10:07:11 +02001253 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001254 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001255
1256 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001257 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001258 cwq->nr_active++;
Tejun Heo32704762012-07-13 22:16:45 -07001259 worklist = &cwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001260 } else {
1261 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001262 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001263 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001264
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001265 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001266
Tejun Heo8930cab2012-08-03 10:30:45 -07001267 spin_unlock(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268}
1269
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001270/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001271 * queue_work_on - queue work on specific cpu
1272 * @cpu: CPU number to execute work on
1273 * @wq: workqueue to use
1274 * @work: work to queue
1275 *
Tejun Heod4283e92012-08-03 10:30:44 -07001276 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001277 *
1278 * We queue the work to a specific CPU, the caller must ensure it
1279 * can't go away.
1280 */
Tejun Heod4283e92012-08-03 10:30:44 -07001281bool queue_work_on(int cpu, struct workqueue_struct *wq,
1282 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001283{
Tejun Heod4283e92012-08-03 10:30:44 -07001284 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001285 unsigned long flags;
1286
1287 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001288
Tejun Heo22df02b2010-06-29 10:07:10 +02001289 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001290 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001291 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001292 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001293
1294 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001295 return ret;
1296}
1297EXPORT_SYMBOL_GPL(queue_work_on);
1298
Tejun Heo0a13c002012-08-03 10:30:44 -07001299/**
1300 * queue_work - queue work on a workqueue
1301 * @wq: workqueue to use
1302 * @work: work to queue
1303 *
Tejun Heod4283e92012-08-03 10:30:44 -07001304 * Returns %false if @work was already on a queue, %true otherwise.
Tejun Heo0a13c002012-08-03 10:30:44 -07001305 *
1306 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1307 * it can be processed by another CPU.
1308 */
Tejun Heod4283e92012-08-03 10:30:44 -07001309bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07001310{
Tejun Heo57469822012-08-03 10:30:45 -07001311 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
Tejun Heo0a13c002012-08-03 10:30:44 -07001312}
1313EXPORT_SYMBOL_GPL(queue_work);
1314
Tejun Heod8e794d2012-08-03 10:30:45 -07001315void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316{
David Howells52bad642006-11-22 14:54:01 +00001317 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001318 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001320 /* should have been called from irqsafe timer with irq already off */
Tejun Heo12650572012-08-08 09:38:42 -07001321 __queue_work(dwork->cpu, cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322}
Tejun Heod8e794d2012-08-03 10:30:45 -07001323EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001325static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1326 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001328 struct timer_list *timer = &dwork->timer;
1329 struct work_struct *work = &dwork->work;
1330 unsigned int lcpu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001332 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1333 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001334 WARN_ON_ONCE(timer_pending(timer));
1335 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001336
Tejun Heo8852aac2012-12-01 16:23:42 -08001337 /*
1338 * If @delay is 0, queue @dwork->work immediately. This is for
1339 * both optimization and correctness. The earliest @timer can
1340 * expire is on the closest next tick and delayed_work users depend
1341 * on that there's no such delay when @delay is 0.
1342 */
1343 if (!delay) {
1344 __queue_work(cpu, wq, &dwork->work);
1345 return;
1346 }
1347
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001348 timer_stats_timer_set_start_info(&dwork->timer);
1349
1350 /*
1351 * This stores cwq for the moment, for the timer_fn. Note that the
1352 * work's gcwq is preserved to allow reentrance detection for
1353 * delayed works.
1354 */
1355 if (!(wq->flags & WQ_UNBOUND)) {
1356 struct global_cwq *gcwq = get_work_gcwq(work);
1357
Joonsoo Kime42986d2012-08-15 23:25:38 +09001358 /*
1359 * If we cannot get the last gcwq from @work directly,
1360 * select the last CPU such that it avoids unnecessarily
1361 * triggering non-reentrancy check in __queue_work().
1362 */
1363 lcpu = cpu;
1364 if (gcwq)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001365 lcpu = gcwq->cpu;
Joonsoo Kime42986d2012-08-15 23:25:38 +09001366 if (lcpu == WORK_CPU_UNBOUND)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001367 lcpu = raw_smp_processor_id();
1368 } else {
1369 lcpu = WORK_CPU_UNBOUND;
1370 }
1371
1372 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1373
Tejun Heo12650572012-08-08 09:38:42 -07001374 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001375 timer->expires = jiffies + delay;
1376
1377 if (unlikely(cpu != WORK_CPU_UNBOUND))
1378 add_timer_on(timer, cpu);
1379 else
1380 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381}
1382
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001383/**
1384 * queue_delayed_work_on - queue work on specific CPU after delay
1385 * @cpu: CPU number to execute work on
1386 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001387 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001388 * @delay: number of jiffies to wait before queueing
1389 *
Tejun Heo715f1302012-08-03 10:30:46 -07001390 * Returns %false if @work was already on a queue, %true otherwise. If
1391 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1392 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001393 */
Tejun Heod4283e92012-08-03 10:30:44 -07001394bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1395 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001396{
David Howells52bad642006-11-22 14:54:01 +00001397 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001398 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001399 unsigned long flags;
1400
1401 /* read the comment in __queue_work() */
1402 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001403
Tejun Heo22df02b2010-06-29 10:07:10 +02001404 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001405 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001406 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001407 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001408
1409 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001410 return ret;
1411}
Dave Jonesae90dd52006-06-30 01:40:45 -04001412EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413
Tejun Heoc8e55f32010-06-29 10:07:12 +02001414/**
Tejun Heo0a13c002012-08-03 10:30:44 -07001415 * queue_delayed_work - queue work on a workqueue after delay
1416 * @wq: workqueue to use
1417 * @dwork: delayable work to queue
1418 * @delay: number of jiffies to wait before queueing
1419 *
Tejun Heo715f1302012-08-03 10:30:46 -07001420 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
Tejun Heo0a13c002012-08-03 10:30:44 -07001421 */
Tejun Heod4283e92012-08-03 10:30:44 -07001422bool queue_delayed_work(struct workqueue_struct *wq,
Tejun Heo0a13c002012-08-03 10:30:44 -07001423 struct delayed_work *dwork, unsigned long delay)
1424{
Tejun Heo57469822012-08-03 10:30:45 -07001425 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
Tejun Heo0a13c002012-08-03 10:30:44 -07001426}
1427EXPORT_SYMBOL_GPL(queue_delayed_work);
1428
1429/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001430 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1431 * @cpu: CPU number to execute work on
1432 * @wq: workqueue to use
1433 * @dwork: work to queue
1434 * @delay: number of jiffies to wait before queueing
1435 *
1436 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1437 * modify @dwork's timer so that it expires after @delay. If @delay is
1438 * zero, @work is guaranteed to be scheduled immediately regardless of its
1439 * current state.
1440 *
1441 * Returns %false if @dwork was idle and queued, %true if @dwork was
1442 * pending and its timer was modified.
1443 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001444 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001445 * See try_to_grab_pending() for details.
1446 */
1447bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1448 struct delayed_work *dwork, unsigned long delay)
1449{
1450 unsigned long flags;
1451 int ret;
1452
1453 do {
1454 ret = try_to_grab_pending(&dwork->work, true, &flags);
1455 } while (unlikely(ret == -EAGAIN));
1456
1457 if (likely(ret >= 0)) {
1458 __queue_delayed_work(cpu, wq, dwork, delay);
1459 local_irq_restore(flags);
1460 }
1461
1462 /* -ENOENT from try_to_grab_pending() becomes %true */
1463 return ret;
1464}
1465EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1466
1467/**
1468 * mod_delayed_work - modify delay of or queue a delayed work
1469 * @wq: workqueue to use
1470 * @dwork: work to queue
1471 * @delay: number of jiffies to wait before queueing
1472 *
1473 * mod_delayed_work_on() on local CPU.
1474 */
1475bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1476 unsigned long delay)
1477{
1478 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1479}
1480EXPORT_SYMBOL_GPL(mod_delayed_work);
1481
1482/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001483 * worker_enter_idle - enter idle state
1484 * @worker: worker which is entering idle state
1485 *
1486 * @worker is entering idle state. Update stats and idle timer if
1487 * necessary.
1488 *
1489 * LOCKING:
1490 * spin_lock_irq(gcwq->lock).
1491 */
1492static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001494 struct worker_pool *pool = worker->pool;
1495 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496
Tejun Heoc8e55f32010-06-29 10:07:12 +02001497 BUG_ON(worker->flags & WORKER_IDLE);
1498 BUG_ON(!list_empty(&worker->entry) &&
1499 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500
Tejun Heocb444762010-07-02 10:03:50 +02001501 /* can't use worker_set_flags(), also called from start_worker() */
1502 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001503 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001504 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001505
Tejun Heoc8e55f32010-06-29 10:07:12 +02001506 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001507 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001508
Tejun Heo628c78e2012-07-17 12:39:27 -07001509 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1510 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001511
Tejun Heo544ecf32012-05-14 15:04:50 -07001512 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07001513 * Sanity check nr_running. Because gcwq_unbind_fn() releases
1514 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1515 * nr_running, the warning may trigger spuriously. Check iff
1516 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001517 */
Tejun Heo628c78e2012-07-17 12:39:27 -07001518 WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001519 pool->nr_workers == pool->nr_idle &&
Tejun Heo63d95a92012-07-12 14:46:37 -07001520 atomic_read(get_pool_nr_running(pool)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521}
1522
Tejun Heoc8e55f32010-06-29 10:07:12 +02001523/**
1524 * worker_leave_idle - leave idle state
1525 * @worker: worker which is leaving idle state
1526 *
1527 * @worker is leaving idle state. Update stats.
1528 *
1529 * LOCKING:
1530 * spin_lock_irq(gcwq->lock).
1531 */
1532static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001534 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
Tejun Heoc8e55f32010-06-29 10:07:12 +02001536 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001537 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001538 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001539 list_del_init(&worker->entry);
1540}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
Tejun Heoe22bee72010-06-29 10:07:14 +02001542/**
1543 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1544 * @worker: self
1545 *
1546 * Works which are scheduled while the cpu is online must at least be
1547 * scheduled to a worker which is bound to the cpu so that if they are
1548 * flushed from cpu callbacks while cpu is going down, they are
1549 * guaranteed to execute on the cpu.
1550 *
1551 * This function is to be used by rogue workers and rescuers to bind
1552 * themselves to the target cpu and may race with cpu going down or
1553 * coming online. kthread_bind() can't be used because it may put the
1554 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1555 * verbatim as it's best effort and blocking and gcwq may be
1556 * [dis]associated in the meantime.
1557 *
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001558 * This function tries set_cpus_allowed() and locks gcwq and verifies the
1559 * binding against %GCWQ_DISASSOCIATED which is set during
1560 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1561 * enters idle state or fetches works without dropping lock, it can
1562 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001563 *
1564 * CONTEXT:
1565 * Might sleep. Called without any lock but returns with gcwq->lock
1566 * held.
1567 *
1568 * RETURNS:
1569 * %true if the associated gcwq is online (@worker is successfully
1570 * bound), %false if offline.
1571 */
1572static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001573__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001574{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001575 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001576 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577
Tejun Heoe22bee72010-06-29 10:07:14 +02001578 while (true) {
1579 /*
1580 * The following call may fail, succeed or succeed
1581 * without actually migrating the task to the cpu if
1582 * it races with cpu hotunplug operation. Verify
1583 * against GCWQ_DISASSOCIATED.
1584 */
Tejun Heof3421792010-07-02 10:03:51 +02001585 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1586 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001587
Tejun Heoe22bee72010-06-29 10:07:14 +02001588 spin_lock_irq(&gcwq->lock);
1589 if (gcwq->flags & GCWQ_DISASSOCIATED)
1590 return false;
1591 if (task_cpu(task) == gcwq->cpu &&
1592 cpumask_equal(&current->cpus_allowed,
1593 get_cpu_mask(gcwq->cpu)))
1594 return true;
1595 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001596
Tejun Heo5035b202011-04-29 18:08:37 +02001597 /*
1598 * We've raced with CPU hot[un]plug. Give it a breather
1599 * and retry migration. cond_resched() is required here;
1600 * otherwise, we might deadlock against cpu_stop trying to
1601 * bring down the CPU on non-preemptive kernel.
1602 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001603 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001604 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001605 }
1606}
1607
1608/*
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001609 * Rebind an idle @worker to its CPU. worker_thread() will test
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001610 * list_empty(@worker->entry) before leaving idle and call this function.
Tejun Heo25511a42012-07-17 12:39:27 -07001611 */
1612static void idle_worker_rebind(struct worker *worker)
1613{
1614 struct global_cwq *gcwq = worker->pool->gcwq;
1615
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001616 /* CPU may go down again inbetween, clear UNBOUND only on success */
1617 if (worker_maybe_bind_and_lock(worker))
1618 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heo25511a42012-07-17 12:39:27 -07001619
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001620 /* rebind complete, become available again */
1621 list_add(&worker->entry, &worker->pool->idle_list);
1622 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07001623}
1624
1625/*
1626 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001627 * the associated cpu which is coming back online. This is scheduled by
1628 * cpu up but can race with other cpu hotplug operations and may be
1629 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001630 */
Tejun Heo25511a42012-07-17 12:39:27 -07001631static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001632{
1633 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001634 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001635
Lai Jiangshaneab6d822012-09-18 09:59:22 -07001636 if (worker_maybe_bind_and_lock(worker))
1637 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02001638
1639 spin_unlock_irq(&gcwq->lock);
1640}
1641
Tejun Heo25511a42012-07-17 12:39:27 -07001642/**
1643 * rebind_workers - rebind all workers of a gcwq to the associated CPU
1644 * @gcwq: gcwq of interest
1645 *
1646 * @gcwq->cpu is coming online. Rebind all workers to the CPU. Rebinding
1647 * is different for idle and busy ones.
1648 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001649 * Idle ones will be removed from the idle_list and woken up. They will
1650 * add themselves back after completing rebind. This ensures that the
1651 * idle_list doesn't contain any unbound workers when re-bound busy workers
1652 * try to perform local wake-ups for concurrency management.
Tejun Heo25511a42012-07-17 12:39:27 -07001653 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001654 * Busy workers can rebind after they finish their current work items.
1655 * Queueing the rebind work item at the head of the scheduled list is
1656 * enough. Note that nr_running will be properly bumped as busy workers
1657 * rebind.
Tejun Heo25511a42012-07-17 12:39:27 -07001658 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001659 * On return, all non-manager workers are scheduled for rebind - see
1660 * manage_workers() for the manager special case. Any idle worker
1661 * including the manager will not appear on @idle_list until rebind is
1662 * complete, making local wake-ups safe.
Tejun Heo25511a42012-07-17 12:39:27 -07001663 */
1664static void rebind_workers(struct global_cwq *gcwq)
Tejun Heo25511a42012-07-17 12:39:27 -07001665{
Tejun Heo25511a42012-07-17 12:39:27 -07001666 struct worker_pool *pool;
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001667 struct worker *worker, *n;
Tejun Heo25511a42012-07-17 12:39:27 -07001668 struct hlist_node *pos;
1669 int i;
1670
1671 lockdep_assert_held(&gcwq->lock);
1672
1673 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07001674 lockdep_assert_held(&pool->assoc_mutex);
Tejun Heo25511a42012-07-17 12:39:27 -07001675
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001676 /* dequeue and kick idle ones */
Tejun Heo25511a42012-07-17 12:39:27 -07001677 for_each_worker_pool(pool, gcwq) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001678 list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001679 /*
1680 * idle workers should be off @pool->idle_list
1681 * until rebind is complete to avoid receiving
1682 * premature local wake-ups.
1683 */
1684 list_del_init(&worker->entry);
Lai Jiangshan96e65302012-09-02 00:28:19 +08001685
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001686 /*
1687 * worker_thread() will see the above dequeuing
1688 * and call idle_worker_rebind().
1689 */
Tejun Heo25511a42012-07-17 12:39:27 -07001690 wake_up_process(worker->task);
1691 }
1692 }
1693
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001694 /* rebind busy workers */
Tejun Heo25511a42012-07-17 12:39:27 -07001695 for_each_busy_worker(worker, i, pos, gcwq) {
1696 struct work_struct *rebind_work = &worker->rebind_work;
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001697 struct workqueue_struct *wq;
Tejun Heo25511a42012-07-17 12:39:27 -07001698
1699 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1700 work_data_bits(rebind_work)))
1701 continue;
1702
Tejun Heo25511a42012-07-17 12:39:27 -07001703 debug_work_activate(rebind_work);
Tejun Heo90beca52012-09-04 23:12:33 -07001704
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001705 /*
1706 * wq doesn't really matter but let's keep @worker->pool
1707 * and @cwq->pool consistent for sanity.
1708 */
1709 if (worker_pool_pri(worker->pool))
1710 wq = system_highpri_wq;
1711 else
1712 wq = system_wq;
Tejun Heoec588152012-09-04 23:16:32 -07001713
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001714 insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
1715 worker->scheduled.next,
1716 work_color_to_flags(WORK_NO_COLOR));
Tejun Heoec588152012-09-04 23:16:32 -07001717 }
Tejun Heo25511a42012-07-17 12:39:27 -07001718}
1719
Tejun Heoc34056a2010-06-29 10:07:11 +02001720static struct worker *alloc_worker(void)
1721{
1722 struct worker *worker;
1723
1724 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001725 if (worker) {
1726 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001727 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001728 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001729 /* on creation a worker is in !idle && prep state */
1730 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001731 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001732 return worker;
1733}
1734
1735/**
1736 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001737 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001738 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001739 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001740 * can be started by calling start_worker() or destroyed using
1741 * destroy_worker().
1742 *
1743 * CONTEXT:
1744 * Might sleep. Does GFP_KERNEL allocations.
1745 *
1746 * RETURNS:
1747 * Pointer to the newly created worker.
1748 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001749static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001750{
Tejun Heo63d95a92012-07-12 14:46:37 -07001751 struct global_cwq *gcwq = pool->gcwq;
Tejun Heo32704762012-07-13 22:16:45 -07001752 const char *pri = worker_pool_pri(pool) ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001753 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001754 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001755
Tejun Heo8b03ae32010-06-29 10:07:12 +02001756 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001757 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001758 spin_unlock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001759 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001760 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001761 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001762 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001763 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001764
1765 worker = alloc_worker();
1766 if (!worker)
1767 goto fail;
1768
Tejun Heobd7bdd42012-07-12 14:46:37 -07001769 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001770 worker->id = id;
1771
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001772 if (gcwq->cpu != WORK_CPU_UNBOUND)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001773 worker->task = kthread_create_on_node(worker_thread,
Tejun Heo32704762012-07-13 22:16:45 -07001774 worker, cpu_to_node(gcwq->cpu),
1775 "kworker/%u:%d%s", gcwq->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001776 else
1777 worker->task = kthread_create(worker_thread, worker,
Tejun Heo32704762012-07-13 22:16:45 -07001778 "kworker/u:%d%s", id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001779 if (IS_ERR(worker->task))
1780 goto fail;
1781
Tejun Heo32704762012-07-13 22:16:45 -07001782 if (worker_pool_pri(pool))
1783 set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
1784
Tejun Heodb7bccf2010-06-29 10:07:12 +02001785 /*
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001786 * Determine CPU binding of the new worker depending on
1787 * %GCWQ_DISASSOCIATED. The caller is responsible for ensuring the
1788 * flag remains stable across this function. See the comments
1789 * above the flag definition for details.
1790 *
1791 * As an unbound worker may later become a regular one if CPU comes
1792 * online, make sure every worker has %PF_THREAD_BOUND set.
Tejun Heodb7bccf2010-06-29 10:07:12 +02001793 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001794 if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001795 kthread_bind(worker->task, gcwq->cpu);
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001796 } else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001797 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001798 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001800
Tejun Heoc34056a2010-06-29 10:07:11 +02001801 return worker;
1802fail:
1803 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001804 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001805 ida_remove(&pool->worker_ida, id);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001806 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001807 }
1808 kfree(worker);
1809 return NULL;
1810}
1811
1812/**
1813 * start_worker - start a newly created worker
1814 * @worker: worker to start
1815 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001816 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001817 *
1818 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001819 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001820 */
1821static void start_worker(struct worker *worker)
1822{
Tejun Heocb444762010-07-02 10:03:50 +02001823 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001824 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001825 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001826 wake_up_process(worker->task);
1827}
1828
1829/**
1830 * destroy_worker - destroy a workqueue worker
1831 * @worker: worker to be destroyed
1832 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001833 * Destroy @worker and adjust @gcwq stats accordingly.
1834 *
1835 * CONTEXT:
1836 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001837 */
1838static void destroy_worker(struct worker *worker)
1839{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001840 struct worker_pool *pool = worker->pool;
1841 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001842 int id = worker->id;
1843
1844 /* sanity check frenzy */
1845 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001846 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001847
Tejun Heoc8e55f32010-06-29 10:07:12 +02001848 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001849 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001850 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001851 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001852
1853 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001854 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001855
1856 spin_unlock_irq(&gcwq->lock);
1857
Tejun Heoc34056a2010-06-29 10:07:11 +02001858 kthread_stop(worker->task);
1859 kfree(worker);
1860
Tejun Heo8b03ae32010-06-29 10:07:12 +02001861 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001862 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001863}
1864
Tejun Heo63d95a92012-07-12 14:46:37 -07001865static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001866{
Tejun Heo63d95a92012-07-12 14:46:37 -07001867 struct worker_pool *pool = (void *)__pool;
1868 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001869
1870 spin_lock_irq(&gcwq->lock);
1871
Tejun Heo63d95a92012-07-12 14:46:37 -07001872 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001873 struct worker *worker;
1874 unsigned long expires;
1875
1876 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001877 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001878 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1879
1880 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001881 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001882 else {
1883 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001884 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001885 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001886 }
1887 }
1888
1889 spin_unlock_irq(&gcwq->lock);
1890}
1891
1892static bool send_mayday(struct work_struct *work)
1893{
1894 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1895 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001896 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001897
1898 if (!(wq->flags & WQ_RESCUER))
1899 return false;
1900
1901 /* mayday mayday mayday */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001902 cpu = cwq->pool->gcwq->cpu;
Tejun Heof3421792010-07-02 10:03:51 +02001903 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1904 if (cpu == WORK_CPU_UNBOUND)
1905 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001906 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001907 wake_up_process(wq->rescuer->task);
1908 return true;
1909}
1910
Tejun Heo63d95a92012-07-12 14:46:37 -07001911static void gcwq_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001912{
Tejun Heo63d95a92012-07-12 14:46:37 -07001913 struct worker_pool *pool = (void *)__pool;
1914 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001915 struct work_struct *work;
1916
1917 spin_lock_irq(&gcwq->lock);
1918
Tejun Heo63d95a92012-07-12 14:46:37 -07001919 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001920 /*
1921 * We've been trying to create a new worker but
1922 * haven't been successful. We might be hitting an
1923 * allocation deadlock. Send distress signals to
1924 * rescuers.
1925 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001926 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001927 send_mayday(work);
1928 }
1929
1930 spin_unlock_irq(&gcwq->lock);
1931
Tejun Heo63d95a92012-07-12 14:46:37 -07001932 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001933}
1934
1935/**
1936 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001937 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001938 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001939 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001940 * have at least one idle worker on return from this function. If
1941 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001942 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001943 * possible allocation deadlock.
1944 *
1945 * On return, need_to_create_worker() is guaranteed to be false and
1946 * may_start_working() true.
1947 *
1948 * LOCKING:
1949 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1950 * multiple times. Does GFP_KERNEL allocations. Called only from
1951 * manager.
1952 *
1953 * RETURNS:
1954 * false if no action was taken and gcwq->lock stayed locked, true
1955 * otherwise.
1956 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001957static bool maybe_create_worker(struct worker_pool *pool)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001958__releases(&gcwq->lock)
1959__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001960{
Tejun Heo63d95a92012-07-12 14:46:37 -07001961 struct global_cwq *gcwq = pool->gcwq;
1962
1963 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001964 return false;
1965restart:
Tejun Heo9f9c236442010-07-14 11:31:20 +02001966 spin_unlock_irq(&gcwq->lock);
1967
Tejun Heoe22bee72010-06-29 10:07:14 +02001968 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001969 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001970
1971 while (true) {
1972 struct worker *worker;
1973
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001974 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001975 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001976 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001977 spin_lock_irq(&gcwq->lock);
1978 start_worker(worker);
Tejun Heo63d95a92012-07-12 14:46:37 -07001979 BUG_ON(need_to_create_worker(pool));
Tejun Heoe22bee72010-06-29 10:07:14 +02001980 return true;
1981 }
1982
Tejun Heo63d95a92012-07-12 14:46:37 -07001983 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001984 break;
1985
Tejun Heoe22bee72010-06-29 10:07:14 +02001986 __set_current_state(TASK_INTERRUPTIBLE);
1987 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c236442010-07-14 11:31:20 +02001988
Tejun Heo63d95a92012-07-12 14:46:37 -07001989 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001990 break;
1991 }
1992
Tejun Heo63d95a92012-07-12 14:46:37 -07001993 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001994 spin_lock_irq(&gcwq->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07001995 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001996 goto restart;
1997 return true;
1998}
1999
2000/**
2001 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07002002 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02002003 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002004 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02002005 * IDLE_WORKER_TIMEOUT.
2006 *
2007 * LOCKING:
2008 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2009 * multiple times. Called only from manager.
2010 *
2011 * RETURNS:
2012 * false if no action was taken and gcwq->lock stayed locked, true
2013 * otherwise.
2014 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002015static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02002016{
2017 bool ret = false;
2018
Tejun Heo63d95a92012-07-12 14:46:37 -07002019 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002020 struct worker *worker;
2021 unsigned long expires;
2022
Tejun Heo63d95a92012-07-12 14:46:37 -07002023 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002024 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2025
2026 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002027 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02002028 break;
2029 }
2030
2031 destroy_worker(worker);
2032 ret = true;
2033 }
2034
2035 return ret;
2036}
2037
2038/**
2039 * manage_workers - manage worker pool
2040 * @worker: self
2041 *
2042 * Assume the manager role and manage gcwq worker pool @worker belongs
2043 * to. At any given time, there can be only zero or one manager per
2044 * gcwq. The exclusion is handled automatically by this function.
2045 *
2046 * The caller can safely start processing works on false return. On
2047 * true return, it's guaranteed that need_to_create_worker() is false
2048 * and may_start_working() is true.
2049 *
2050 * CONTEXT:
2051 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2052 * multiple times. Does GFP_KERNEL allocations.
2053 *
2054 * RETURNS:
2055 * false if no action was taken and gcwq->lock stayed locked, true if
2056 * some action was taken.
2057 */
2058static bool manage_workers(struct worker *worker)
2059{
Tejun Heo63d95a92012-07-12 14:46:37 -07002060 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002061 bool ret = false;
2062
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002063 if (pool->flags & POOL_MANAGING_WORKERS)
Tejun Heoe22bee72010-06-29 10:07:14 +02002064 return ret;
2065
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002066 pool->flags |= POOL_MANAGING_WORKERS;
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002067
2068 /*
2069 * To simplify both worker management and CPU hotplug, hold off
2070 * management while hotplug is in progress. CPU hotplug path can't
2071 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2072 * lead to idle worker depletion (all become busy thinking someone
2073 * else is managing) which in turn can result in deadlock under
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002074 * extreme circumstances. Use @pool->assoc_mutex to synchronize
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002075 * manager against CPU hotplug.
2076 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002077 * assoc_mutex would always be free unless CPU hotplug is in
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002078 * progress. trylock first without dropping @gcwq->lock.
2079 */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002080 if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002081 spin_unlock_irq(&pool->gcwq->lock);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002082 mutex_lock(&pool->assoc_mutex);
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002083 /*
2084 * CPU hotplug could have happened while we were waiting
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002085 * for assoc_mutex. Hotplug itself can't handle us
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002086 * because manager isn't either on idle or busy list, and
2087 * @gcwq's state and ours could have deviated.
2088 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002089 * As hotplug is now excluded via assoc_mutex, we can
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002090 * simply try to bind. It will succeed or fail depending
2091 * on @gcwq's current state. Try it and adjust
2092 * %WORKER_UNBOUND accordingly.
2093 */
2094 if (worker_maybe_bind_and_lock(worker))
2095 worker->flags &= ~WORKER_UNBOUND;
2096 else
2097 worker->flags |= WORKER_UNBOUND;
2098
2099 ret = true;
2100 }
2101
Tejun Heo11ebea52012-07-12 14:46:37 -07002102 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002103
2104 /*
2105 * Destroy and then create so that may_start_working() is true
2106 * on return.
2107 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002108 ret |= maybe_destroy_workers(pool);
2109 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002110
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002111 pool->flags &= ~POOL_MANAGING_WORKERS;
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002112 mutex_unlock(&pool->assoc_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02002113 return ret;
2114}
2115
Tejun Heoa62428c2010-06-29 10:07:10 +02002116/**
2117 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002118 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002119 * @work: work to process
2120 *
2121 * Process @work. This function contains all the logics necessary to
2122 * process a single work including synchronization against and
2123 * interaction with other workers on the same cpu, queueing and
2124 * flushing. As long as context requirement is met, any worker can
2125 * call this function to process a work.
2126 *
2127 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002128 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002129 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002130static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09002131__releases(&gcwq->lock)
2132__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002133{
Tejun Heo7e116292010-06-29 10:07:13 +02002134 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002135 struct worker_pool *pool = worker->pool;
2136 struct global_cwq *gcwq = pool->gcwq;
Tejun Heofb0e7be2010-06-29 10:07:15 +02002137 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002138 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002139 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002140#ifdef CONFIG_LOCKDEP
2141 /*
2142 * It is permissible to free the struct work_struct from
2143 * inside the function that is called from it, this we need to
2144 * take into account for lockdep too. To avoid bogus "held
2145 * lock freed" warnings as well as problems when looking into
2146 * work->lockdep_map, make a copy and use that here.
2147 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002148 struct lockdep_map lockdep_map;
2149
2150 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002151#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002152 /*
2153 * Ensure we're on the correct CPU. DISASSOCIATED test is
2154 * necessary to avoid spurious warnings from rescuers servicing the
2155 * unbound or a disassociated gcwq.
2156 */
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002157 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
Tejun Heo6fec10a2012-07-22 10:16:34 -07002158 !(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heo25511a42012-07-17 12:39:27 -07002159 raw_smp_processor_id() != gcwq->cpu);
2160
Tejun Heo7e116292010-06-29 10:07:13 +02002161 /*
2162 * A single work shouldn't be executed concurrently by
2163 * multiple workers on a single cpu. Check whether anyone is
2164 * already processing the work. If so, defer the work to the
2165 * currently executing one.
2166 */
Sasha Levin42f85702012-12-17 10:01:23 -05002167 collision = find_worker_executing_work(gcwq, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002168 if (unlikely(collision)) {
2169 move_linked_works(work, &collision->scheduled, NULL);
2170 return;
2171 }
2172
Tejun Heo8930cab2012-08-03 10:30:45 -07002173 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002174 debug_work_deactivate(work);
Sasha Levin42f85702012-12-17 10:01:23 -05002175 hash_add(gcwq->busy_hash, &worker->hentry, (unsigned long)worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02002176 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002177 worker->current_func = work->func;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002178 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002179 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002180
Tejun Heoa62428c2010-06-29 10:07:10 +02002181 list_del_init(&work->entry);
2182
Tejun Heo649027d2010-06-29 10:07:14 +02002183 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002184 * CPU intensive works don't participate in concurrency
2185 * management. They're the scheduler's responsibility.
2186 */
2187 if (unlikely(cpu_intensive))
2188 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2189
Tejun Heo974271c2012-07-12 14:46:37 -07002190 /*
2191 * Unbound gcwq isn't concurrency managed and work items should be
2192 * executed ASAP. Wake up another worker if necessary.
2193 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002194 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2195 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002196
Tejun Heo8930cab2012-08-03 10:30:45 -07002197 /*
Tejun Heo23657bb2012-08-13 17:08:19 -07002198 * Record the last CPU and clear PENDING which should be the last
2199 * update to @work. Also, do this inside @gcwq->lock so that
2200 * PENDING and queued state changes happen together while IRQ is
2201 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002202 */
Tejun Heo8930cab2012-08-03 10:30:45 -07002203 set_work_cpu_and_clear_pending(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02002204
Tejun Heoa62428c2010-06-29 10:07:10 +02002205 spin_unlock_irq(&gcwq->lock);
2206
Tejun Heoe159489b2011-01-09 23:32:15 +01002207 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002208 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002209 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002210 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002211 /*
2212 * While we must be careful to not use "work" after this, the trace
2213 * point will only record its address.
2214 */
2215 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002216 lock_map_release(&lockdep_map);
2217 lock_map_release(&cwq->wq->lockdep_map);
2218
2219 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002220 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2221 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002222 current->comm, preempt_count(), task_pid_nr(current),
2223 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002224 debug_show_held_locks(current);
2225 dump_stack();
2226 }
2227
Tejun Heo8b03ae32010-06-29 10:07:12 +02002228 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002229
Tejun Heofb0e7be2010-06-29 10:07:15 +02002230 /* clear cpu intensive status */
2231 if (unlikely(cpu_intensive))
2232 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2233
Tejun Heoa62428c2010-06-29 10:07:10 +02002234 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002235 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002236 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002237 worker->current_func = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002238 worker->current_cwq = NULL;
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07002239 cwq_dec_nr_in_flight(cwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002240}
2241
Tejun Heoaffee4b2010-06-29 10:07:12 +02002242/**
2243 * process_scheduled_works - process scheduled works
2244 * @worker: self
2245 *
2246 * Process all scheduled works. Please note that the scheduled list
2247 * may change while processing a work, so this function repeatedly
2248 * fetches a work from the top and executes it.
2249 *
2250 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002251 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002252 * multiple times.
2253 */
2254static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002256 while (!list_empty(&worker->scheduled)) {
2257 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002259 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261}
2262
Tejun Heo4690c4a2010-06-29 10:07:10 +02002263/**
2264 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002265 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002266 *
Tejun Heoe22bee72010-06-29 10:07:14 +02002267 * The gcwq worker thread function. There's a single dynamic pool of
2268 * these per each cpu. These workers process all works regardless of
2269 * their specific target workqueue. The only exception is works which
2270 * belong to workqueues with a rescuer which will be explained in
2271 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002272 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002273static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274{
Tejun Heoc34056a2010-06-29 10:07:11 +02002275 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002276 struct worker_pool *pool = worker->pool;
2277 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278
Tejun Heoe22bee72010-06-29 10:07:14 +02002279 /* tell the scheduler that this is a workqueue worker */
2280 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002281woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002282 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002284 /* we are off idle list if destruction or rebind is requested */
2285 if (unlikely(list_empty(&worker->entry))) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002286 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002287
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002288 /* if DIE is set, destruction is requested */
Tejun Heo25511a42012-07-17 12:39:27 -07002289 if (worker->flags & WORKER_DIE) {
2290 worker->task->flags &= ~PF_WQ_WORKER;
2291 return 0;
2292 }
2293
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002294 /* otherwise, rebind */
Tejun Heo25511a42012-07-17 12:39:27 -07002295 idle_worker_rebind(worker);
2296 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297 }
2298
Tejun Heoc8e55f32010-06-29 10:07:12 +02002299 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002300recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002301 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002302 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002303 goto sleep;
2304
2305 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002306 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002307 goto recheck;
2308
Tejun Heoc8e55f32010-06-29 10:07:12 +02002309 /*
2310 * ->scheduled list can only be filled while a worker is
2311 * preparing to process a work or actually processing it.
2312 * Make sure nobody diddled with it while I was sleeping.
2313 */
2314 BUG_ON(!list_empty(&worker->scheduled));
2315
Tejun Heoe22bee72010-06-29 10:07:14 +02002316 /*
2317 * When control reaches this point, we're guaranteed to have
2318 * at least one idle worker or that someone else has already
2319 * assumed the manager role.
2320 */
2321 worker_clr_flags(worker, WORKER_PREP);
2322
2323 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002324 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002325 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002326 struct work_struct, entry);
2327
2328 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2329 /* optimization path, not strictly necessary */
2330 process_one_work(worker, work);
2331 if (unlikely(!list_empty(&worker->scheduled)))
2332 process_scheduled_works(worker);
2333 } else {
2334 move_linked_works(work, &worker->scheduled, NULL);
2335 process_scheduled_works(worker);
2336 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002337 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002338
Tejun Heoe22bee72010-06-29 10:07:14 +02002339 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002340sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002341 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002342 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002343
Tejun Heoc8e55f32010-06-29 10:07:12 +02002344 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02002345 * gcwq->lock is held and there's no work to process and no
2346 * need to manage, sleep. Workers are woken up only while
2347 * holding gcwq->lock or from local cpu, so setting the
2348 * current state before releasing gcwq->lock is enough to
2349 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002350 */
2351 worker_enter_idle(worker);
2352 __set_current_state(TASK_INTERRUPTIBLE);
2353 spin_unlock_irq(&gcwq->lock);
2354 schedule();
2355 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356}
2357
Tejun Heoe22bee72010-06-29 10:07:14 +02002358/**
2359 * rescuer_thread - the rescuer thread function
2360 * @__wq: the associated workqueue
2361 *
2362 * Workqueue rescuer thread function. There's one rescuer for each
2363 * workqueue which has WQ_RESCUER set.
2364 *
2365 * Regular work processing on a gcwq may block trying to create a new
2366 * worker which uses GFP_KERNEL allocation which has slight chance of
2367 * developing into deadlock if some works currently on the same queue
2368 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2369 * the problem rescuer solves.
2370 *
2371 * When such condition is possible, the gcwq summons rescuers of all
2372 * workqueues which have works queued on the gcwq and let them process
2373 * those works so that forward progress can be guaranteed.
2374 *
2375 * This should happen rarely.
2376 */
2377static int rescuer_thread(void *__wq)
2378{
2379 struct workqueue_struct *wq = __wq;
2380 struct worker *rescuer = wq->rescuer;
2381 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002382 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002383 unsigned int cpu;
2384
2385 set_user_nice(current, RESCUER_NICE_LEVEL);
2386repeat:
2387 set_current_state(TASK_INTERRUPTIBLE);
2388
Mike Galbraith412d32e2012-11-28 07:17:18 +01002389 if (kthread_should_stop()) {
2390 __set_current_state(TASK_RUNNING);
Tejun Heoe22bee72010-06-29 10:07:14 +02002391 return 0;
Mike Galbraith412d32e2012-11-28 07:17:18 +01002392 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002393
Tejun Heof3421792010-07-02 10:03:51 +02002394 /*
2395 * See whether any cpu is asking for help. Unbounded
2396 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2397 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002398 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002399 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2400 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002401 struct worker_pool *pool = cwq->pool;
2402 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002403 struct work_struct *work, *n;
2404
2405 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002406 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002407
2408 /* migrate to the target cpu if possible */
Tejun Heobd7bdd42012-07-12 14:46:37 -07002409 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002410 worker_maybe_bind_and_lock(rescuer);
2411
2412 /*
2413 * Slurp in all works issued via this workqueue and
2414 * process'em.
2415 */
2416 BUG_ON(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002417 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002418 if (get_work_cwq(work) == cwq)
2419 move_linked_works(work, scheduled, &n);
2420
2421 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002422
2423 /*
2424 * Leave this gcwq. If keep_working() is %true, notify a
2425 * regular worker; otherwise, we end up with 0 concurrency
2426 * and stalling the execution.
2427 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002428 if (keep_working(pool))
2429 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002430
Tejun Heoe22bee72010-06-29 10:07:14 +02002431 spin_unlock_irq(&gcwq->lock);
2432 }
2433
2434 schedule();
2435 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436}
2437
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002438struct wq_barrier {
2439 struct work_struct work;
2440 struct completion done;
2441};
2442
2443static void wq_barrier_func(struct work_struct *work)
2444{
2445 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2446 complete(&barr->done);
2447}
2448
Tejun Heo4690c4a2010-06-29 10:07:10 +02002449/**
2450 * insert_wq_barrier - insert a barrier work
2451 * @cwq: cwq to insert barrier into
2452 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002453 * @target: target work to attach @barr to
2454 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002455 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002456 * @barr is linked to @target such that @barr is completed only after
2457 * @target finishes execution. Please note that the ordering
2458 * guarantee is observed only with respect to @target and on the local
2459 * cpu.
2460 *
2461 * Currently, a queued barrier can't be canceled. This is because
2462 * try_to_grab_pending() can't determine whether the work to be
2463 * grabbed is at the head of the queue and thus can't clear LINKED
2464 * flag of the previous work while there must be a valid next work
2465 * after a work with LINKED flag set.
2466 *
2467 * Note that when @worker is non-NULL, @target may be modified
2468 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002469 *
2470 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002471 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002472 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002473static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002474 struct wq_barrier *barr,
2475 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002476{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002477 struct list_head *head;
2478 unsigned int linked = 0;
2479
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002480 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002481 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002482 * as we know for sure that this will not trigger any of the
2483 * checks and call back into the fixup functions where we
2484 * might deadlock.
2485 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002486 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002487 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002488 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002489
Tejun Heoaffee4b2010-06-29 10:07:12 +02002490 /*
2491 * If @target is currently being executed, schedule the
2492 * barrier to the worker; otherwise, put it after @target.
2493 */
2494 if (worker)
2495 head = worker->scheduled.next;
2496 else {
2497 unsigned long *bits = work_data_bits(target);
2498
2499 head = target->entry.next;
2500 /* there can already be other linked works, inherit and set */
2501 linked = *bits & WORK_STRUCT_LINKED;
2502 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2503 }
2504
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002505 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002506 insert_work(cwq, &barr->work, head,
2507 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002508}
2509
Tejun Heo73f53c42010-06-29 10:07:11 +02002510/**
2511 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2512 * @wq: workqueue being flushed
2513 * @flush_color: new flush color, < 0 for no-op
2514 * @work_color: new work color, < 0 for no-op
2515 *
2516 * Prepare cwqs for workqueue flushing.
2517 *
2518 * If @flush_color is non-negative, flush_color on all cwqs should be
2519 * -1. If no cwq has in-flight commands at the specified color, all
2520 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2521 * has in flight commands, its cwq->flush_color is set to
2522 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2523 * wakeup logic is armed and %true is returned.
2524 *
2525 * The caller should have initialized @wq->first_flusher prior to
2526 * calling this function with non-negative @flush_color. If
2527 * @flush_color is negative, no flush color update is done and %false
2528 * is returned.
2529 *
2530 * If @work_color is non-negative, all cwqs should have the same
2531 * work_color which is previous to @work_color and all will be
2532 * advanced to @work_color.
2533 *
2534 * CONTEXT:
2535 * mutex_lock(wq->flush_mutex).
2536 *
2537 * RETURNS:
2538 * %true if @flush_color >= 0 and there's something to flush. %false
2539 * otherwise.
2540 */
2541static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2542 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543{
Tejun Heo73f53c42010-06-29 10:07:11 +02002544 bool wait = false;
2545 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002546
Tejun Heo73f53c42010-06-29 10:07:11 +02002547 if (flush_color >= 0) {
2548 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2549 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002550 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002551
Tejun Heof3421792010-07-02 10:03:51 +02002552 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002553 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002554 struct global_cwq *gcwq = cwq->pool->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002555
Tejun Heo8b03ae32010-06-29 10:07:12 +02002556 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002557
2558 if (flush_color >= 0) {
2559 BUG_ON(cwq->flush_color != -1);
2560
2561 if (cwq->nr_in_flight[flush_color]) {
2562 cwq->flush_color = flush_color;
2563 atomic_inc(&wq->nr_cwqs_to_flush);
2564 wait = true;
2565 }
2566 }
2567
2568 if (work_color >= 0) {
2569 BUG_ON(work_color != work_next_color(cwq->work_color));
2570 cwq->work_color = work_color;
2571 }
2572
Tejun Heo8b03ae32010-06-29 10:07:12 +02002573 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002574 }
2575
2576 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2577 complete(&wq->first_flusher->done);
2578
2579 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002580}
2581
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002582/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002584 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002585 *
2586 * Forces execution of the workqueue and blocks until its completion.
2587 * This is typically used in driver shutdown handlers.
2588 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002589 * We sleep until all works which were queued on entry have been handled,
2590 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002592void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593{
Tejun Heo73f53c42010-06-29 10:07:11 +02002594 struct wq_flusher this_flusher = {
2595 .list = LIST_HEAD_INIT(this_flusher.list),
2596 .flush_color = -1,
2597 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2598 };
2599 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002600
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002601 lock_map_acquire(&wq->lockdep_map);
2602 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002603
2604 mutex_lock(&wq->flush_mutex);
2605
2606 /*
2607 * Start-to-wait phase
2608 */
2609 next_color = work_next_color(wq->work_color);
2610
2611 if (next_color != wq->flush_color) {
2612 /*
2613 * Color space is not full. The current work_color
2614 * becomes our flush_color and work_color is advanced
2615 * by one.
2616 */
2617 BUG_ON(!list_empty(&wq->flusher_overflow));
2618 this_flusher.flush_color = wq->work_color;
2619 wq->work_color = next_color;
2620
2621 if (!wq->first_flusher) {
2622 /* no flush in progress, become the first flusher */
2623 BUG_ON(wq->flush_color != this_flusher.flush_color);
2624
2625 wq->first_flusher = &this_flusher;
2626
2627 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2628 wq->work_color)) {
2629 /* nothing to flush, done */
2630 wq->flush_color = next_color;
2631 wq->first_flusher = NULL;
2632 goto out_unlock;
2633 }
2634 } else {
2635 /* wait in queue */
2636 BUG_ON(wq->flush_color == this_flusher.flush_color);
2637 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2638 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2639 }
2640 } else {
2641 /*
2642 * Oops, color space is full, wait on overflow queue.
2643 * The next flush completion will assign us
2644 * flush_color and transfer to flusher_queue.
2645 */
2646 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2647 }
2648
2649 mutex_unlock(&wq->flush_mutex);
2650
2651 wait_for_completion(&this_flusher.done);
2652
2653 /*
2654 * Wake-up-and-cascade phase
2655 *
2656 * First flushers are responsible for cascading flushes and
2657 * handling overflow. Non-first flushers can simply return.
2658 */
2659 if (wq->first_flusher != &this_flusher)
2660 return;
2661
2662 mutex_lock(&wq->flush_mutex);
2663
Tejun Heo4ce48b32010-07-02 10:03:51 +02002664 /* we might have raced, check again with mutex held */
2665 if (wq->first_flusher != &this_flusher)
2666 goto out_unlock;
2667
Tejun Heo73f53c42010-06-29 10:07:11 +02002668 wq->first_flusher = NULL;
2669
2670 BUG_ON(!list_empty(&this_flusher.list));
2671 BUG_ON(wq->flush_color != this_flusher.flush_color);
2672
2673 while (true) {
2674 struct wq_flusher *next, *tmp;
2675
2676 /* complete all the flushers sharing the current flush color */
2677 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2678 if (next->flush_color != wq->flush_color)
2679 break;
2680 list_del_init(&next->list);
2681 complete(&next->done);
2682 }
2683
2684 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2685 wq->flush_color != work_next_color(wq->work_color));
2686
2687 /* this flush_color is finished, advance by one */
2688 wq->flush_color = work_next_color(wq->flush_color);
2689
2690 /* one color has been freed, handle overflow queue */
2691 if (!list_empty(&wq->flusher_overflow)) {
2692 /*
2693 * Assign the same color to all overflowed
2694 * flushers, advance work_color and append to
2695 * flusher_queue. This is the start-to-wait
2696 * phase for these overflowed flushers.
2697 */
2698 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2699 tmp->flush_color = wq->work_color;
2700
2701 wq->work_color = work_next_color(wq->work_color);
2702
2703 list_splice_tail_init(&wq->flusher_overflow,
2704 &wq->flusher_queue);
2705 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2706 }
2707
2708 if (list_empty(&wq->flusher_queue)) {
2709 BUG_ON(wq->flush_color != wq->work_color);
2710 break;
2711 }
2712
2713 /*
2714 * Need to flush more colors. Make the next flusher
2715 * the new first flusher and arm cwqs.
2716 */
2717 BUG_ON(wq->flush_color == wq->work_color);
2718 BUG_ON(wq->flush_color != next->flush_color);
2719
2720 list_del_init(&next->list);
2721 wq->first_flusher = next;
2722
2723 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2724 break;
2725
2726 /*
2727 * Meh... this color is already done, clear first
2728 * flusher and repeat cascading.
2729 */
2730 wq->first_flusher = NULL;
2731 }
2732
2733out_unlock:
2734 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002735}
Dave Jonesae90dd52006-06-30 01:40:45 -04002736EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002737
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002738/**
2739 * drain_workqueue - drain a workqueue
2740 * @wq: workqueue to drain
2741 *
2742 * Wait until the workqueue becomes empty. While draining is in progress,
2743 * only chain queueing is allowed. IOW, only currently pending or running
2744 * work items on @wq can queue further work items on it. @wq is flushed
2745 * repeatedly until it becomes empty. The number of flushing is detemined
2746 * by the depth of chaining and should be relatively short. Whine if it
2747 * takes too long.
2748 */
2749void drain_workqueue(struct workqueue_struct *wq)
2750{
2751 unsigned int flush_cnt = 0;
2752 unsigned int cpu;
2753
2754 /*
2755 * __queue_work() needs to test whether there are drainers, is much
2756 * hotter than drain_workqueue() and already looks at @wq->flags.
2757 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2758 */
2759 spin_lock(&workqueue_lock);
2760 if (!wq->nr_drainers++)
2761 wq->flags |= WQ_DRAINING;
2762 spin_unlock(&workqueue_lock);
2763reflush:
2764 flush_workqueue(wq);
2765
2766 for_each_cwq_cpu(cpu, wq) {
2767 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002768 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002769
Tejun Heobd7bdd42012-07-12 14:46:37 -07002770 spin_lock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002771 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002772 spin_unlock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002773
2774 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002775 continue;
2776
2777 if (++flush_cnt == 10 ||
2778 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Valentin Ilie044c7822012-08-19 00:52:42 +03002779 pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
2780 wq->name, flush_cnt);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002781 goto reflush;
2782 }
2783
2784 spin_lock(&workqueue_lock);
2785 if (!--wq->nr_drainers)
2786 wq->flags &= ~WQ_DRAINING;
2787 spin_unlock(&workqueue_lock);
2788}
2789EXPORT_SYMBOL_GPL(drain_workqueue);
2790
Tejun Heo606a5022012-08-20 14:51:23 -07002791static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002792{
2793 struct worker *worker = NULL;
2794 struct global_cwq *gcwq;
2795 struct cpu_workqueue_struct *cwq;
2796
2797 might_sleep();
2798 gcwq = get_work_gcwq(work);
2799 if (!gcwq)
2800 return false;
2801
2802 spin_lock_irq(&gcwq->lock);
2803 if (!list_empty(&work->entry)) {
2804 /*
2805 * See the comment near try_to_grab_pending()->smp_rmb().
2806 * If it was re-queued to a different gcwq under us, we
2807 * are not going to wait.
2808 */
2809 smp_rmb();
2810 cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002811 if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
Tejun Heobaf59022010-09-16 10:42:16 +02002812 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002813 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002814 worker = find_worker_executing_work(gcwq, work);
2815 if (!worker)
2816 goto already_gone;
2817 cwq = worker->current_cwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002818 }
Tejun Heobaf59022010-09-16 10:42:16 +02002819
2820 insert_wq_barrier(cwq, barr, work, worker);
2821 spin_unlock_irq(&gcwq->lock);
2822
Tejun Heoe159489b2011-01-09 23:32:15 +01002823 /*
2824 * If @max_active is 1 or rescuer is in use, flushing another work
2825 * item on the same workqueue may lead to deadlock. Make sure the
2826 * flusher is not running on the same workqueue by verifying write
2827 * access.
2828 */
2829 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2830 lock_map_acquire(&cwq->wq->lockdep_map);
2831 else
2832 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002833 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe159489b2011-01-09 23:32:15 +01002834
Tejun Heobaf59022010-09-16 10:42:16 +02002835 return true;
2836already_gone:
2837 spin_unlock_irq(&gcwq->lock);
2838 return false;
2839}
2840
Oleg Nesterovdb700892008-07-25 01:47:49 -07002841/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002842 * flush_work - wait for a work to finish executing the last queueing instance
2843 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002844 *
Tejun Heo606a5022012-08-20 14:51:23 -07002845 * Wait until @work has finished execution. @work is guaranteed to be idle
2846 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002847 *
2848 * RETURNS:
2849 * %true if flush_work() waited for the work to finish execution,
2850 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002851 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002852bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002853{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002854 struct wq_barrier barr;
2855
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002856 lock_map_acquire(&work->lockdep_map);
2857 lock_map_release(&work->lockdep_map);
2858
Tejun Heo606a5022012-08-20 14:51:23 -07002859 if (start_flush_work(work, &barr)) {
Tejun Heobaf59022010-09-16 10:42:16 +02002860 wait_for_completion(&barr.done);
2861 destroy_work_on_stack(&barr.work);
2862 return true;
Tejun Heo606a5022012-08-20 14:51:23 -07002863 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002864 return false;
Tejun Heo606a5022012-08-20 14:51:23 -07002865 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002866}
2867EXPORT_SYMBOL_GPL(flush_work);
2868
Tejun Heo36e227d2012-08-03 10:30:46 -07002869static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002870{
Tejun Heobbb68df2012-08-03 10:30:46 -07002871 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002872 int ret;
2873
2874 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002875 ret = try_to_grab_pending(work, is_dwork, &flags);
2876 /*
2877 * If someone else is canceling, wait for the same event it
2878 * would be waiting for before retrying.
2879 */
2880 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002881 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002882 } while (unlikely(ret < 0));
2883
Tejun Heobbb68df2012-08-03 10:30:46 -07002884 /* tell other tasks trying to grab @work to back off */
2885 mark_work_canceling(work);
2886 local_irq_restore(flags);
2887
Tejun Heo606a5022012-08-20 14:51:23 -07002888 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002889 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002890 return ret;
2891}
2892
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002893/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002894 * cancel_work_sync - cancel a work and wait for it to finish
2895 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002896 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002897 * Cancel @work and wait for its execution to finish. This function
2898 * can be used even if the work re-queues itself or migrates to
2899 * another workqueue. On return from this function, @work is
2900 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002901 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002902 * cancel_work_sync(&delayed_work->work) must not be used for
2903 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002904 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002905 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002906 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002907 *
2908 * RETURNS:
2909 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002910 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002911bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002912{
Tejun Heo36e227d2012-08-03 10:30:46 -07002913 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002914}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002915EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002916
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002917/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002918 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2919 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002920 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002921 * Delayed timer is cancelled and the pending work is queued for
2922 * immediate execution. Like flush_work(), this function only
2923 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002924 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002925 * RETURNS:
2926 * %true if flush_work() waited for the work to finish execution,
2927 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002928 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002929bool flush_delayed_work(struct delayed_work *dwork)
2930{
Tejun Heo8930cab2012-08-03 10:30:45 -07002931 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002932 if (del_timer_sync(&dwork->timer))
Tejun Heo12650572012-08-08 09:38:42 -07002933 __queue_work(dwork->cpu,
Tejun Heo401a8d02010-09-16 10:36:00 +02002934 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002935 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002936 return flush_work(&dwork->work);
2937}
2938EXPORT_SYMBOL(flush_delayed_work);
2939
2940/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002941 * cancel_delayed_work - cancel a delayed work
2942 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002943 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002944 * Kill off a pending delayed_work. Returns %true if @dwork was pending
2945 * and canceled; %false if wasn't pending. Note that the work callback
2946 * function may still be running on return, unless it returns %true and the
2947 * work doesn't re-arm itself. Explicitly flush or use
2948 * cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002949 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002950 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002951 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002952bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002953{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002954 unsigned long flags;
2955 int ret;
2956
2957 do {
2958 ret = try_to_grab_pending(&dwork->work, true, &flags);
2959 } while (unlikely(ret == -EAGAIN));
2960
2961 if (unlikely(ret < 0))
2962 return false;
2963
2964 set_work_cpu_and_clear_pending(&dwork->work, work_cpu(&dwork->work));
2965 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002966 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002967}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002968EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002969
2970/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002971 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2972 * @dwork: the delayed work cancel
2973 *
2974 * This is cancel_work_sync() for delayed works.
2975 *
2976 * RETURNS:
2977 * %true if @dwork was pending, %false otherwise.
2978 */
2979bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002980{
Tejun Heo36e227d2012-08-03 10:30:46 -07002981 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002982}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002983EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002984
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002985/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07002986 * schedule_work_on - put work task on a specific cpu
2987 * @cpu: cpu to put the work task on
2988 * @work: job to be done
2989 *
2990 * This puts a job on a specific cpu
2991 */
Tejun Heod4283e92012-08-03 10:30:44 -07002992bool schedule_work_on(int cpu, struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07002993{
Tejun Heod320c032010-06-29 10:07:14 +02002994 return queue_work_on(cpu, system_wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07002995}
2996EXPORT_SYMBOL(schedule_work_on);
2997
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002998/**
Dave Jonesae90dd52006-06-30 01:40:45 -04002999 * schedule_work - put work task in global workqueue
Linus Torvalds1da177e2005-04-16 15:20:36 -07003000 * @work: job to be done
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001 *
Tejun Heod4283e92012-08-03 10:30:44 -07003002 * Returns %false if @work was already on the kernel-global workqueue and
3003 * %true otherwise.
David Howells52bad642006-11-22 14:54:01 +00003004 *
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003005 * This puts a job in the kernel-global workqueue if it was not already
3006 * queued and leaves it in the same position on the kernel-global
3007 * workqueue otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003008 */
Tejun Heod4283e92012-08-03 10:30:44 -07003009bool schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010{
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003011 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003012}
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003013EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003014
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003015/**
3016 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
3017 * @cpu: cpu to use
3018 * @dwork: job to be done
3019 * @delay: number of jiffies to wait
3020 *
3021 * After waiting for a given time this puts a job in the kernel-global
3022 * workqueue on the specified CPU.
3023 */
Tejun Heod4283e92012-08-03 10:30:44 -07003024bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3025 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003026{
Tejun Heod320c032010-06-29 10:07:14 +02003027 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003028}
Dave Jonesae90dd52006-06-30 01:40:45 -04003029EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003030
Andrew Mortonb6136772006-06-25 05:47:49 -07003031/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003032 * schedule_delayed_work - put work task in global workqueue after delay
3033 * @dwork: job to be done
3034 * @delay: number of jiffies to wait or 0 for immediate execution
3035 *
3036 * After waiting for a given time this puts a job in the kernel-global
3037 * workqueue.
3038 */
Tejun Heod4283e92012-08-03 10:30:44 -07003039bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
Tejun Heo0a13c002012-08-03 10:30:44 -07003040{
3041 return queue_delayed_work(system_wq, dwork, delay);
3042}
3043EXPORT_SYMBOL(schedule_delayed_work);
3044
3045/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003046 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003047 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003048 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003049 * schedule_on_each_cpu() executes @func on each online CPU using the
3050 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003051 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003052 *
3053 * RETURNS:
3054 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003055 */
David Howells65f27f32006-11-22 14:55:48 +00003056int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003057{
3058 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003059 struct work_struct __percpu *works;
Christoph Lameter15316ba82006-01-08 01:00:43 -08003060
Andrew Mortonb6136772006-06-25 05:47:49 -07003061 works = alloc_percpu(struct work_struct);
3062 if (!works)
Christoph Lameter15316ba82006-01-08 01:00:43 -08003063 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003064
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003065 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003066
Christoph Lameter15316ba82006-01-08 01:00:43 -08003067 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003068 struct work_struct *work = per_cpu_ptr(works, cpu);
3069
3070 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003071 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003072 }
Tejun Heo93981802009-11-17 14:06:20 -08003073
3074 for_each_online_cpu(cpu)
3075 flush_work(per_cpu_ptr(works, cpu));
3076
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003077 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003078 free_percpu(works);
Christoph Lameter15316ba82006-01-08 01:00:43 -08003079 return 0;
3080}
3081
Alan Sterneef6a7d2010-02-12 17:39:21 +09003082/**
3083 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3084 *
3085 * Forces execution of the kernel-global workqueue and blocks until its
3086 * completion.
3087 *
3088 * Think twice before calling this function! It's very easy to get into
3089 * trouble if you don't take great care. Either of the following situations
3090 * will lead to deadlock:
3091 *
3092 * One of the work items currently on the workqueue needs to acquire
3093 * a lock held by your code or its caller.
3094 *
3095 * Your code is running in the context of a work routine.
3096 *
3097 * They will be detected by lockdep when they occur, but the first might not
3098 * occur very often. It depends on what work items are on the workqueue and
3099 * what locks they need, which you have no control over.
3100 *
3101 * In most situations flushing the entire workqueue is overkill; you merely
3102 * need to know that a particular work item isn't queued and isn't running.
3103 * In such cases you should use cancel_delayed_work_sync() or
3104 * cancel_work_sync() instead.
3105 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003106void flush_scheduled_work(void)
3107{
Tejun Heod320c032010-06-29 10:07:14 +02003108 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003109}
Dave Jonesae90dd52006-06-30 01:40:45 -04003110EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003111
3112/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003113 * execute_in_process_context - reliably execute the routine with user context
3114 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003115 * @ew: guaranteed storage for the execute work structure (must
3116 * be available when the work executes)
3117 *
3118 * Executes the function immediately if process context is available,
3119 * otherwise schedules the function for delayed execution.
3120 *
3121 * Returns: 0 - function was executed
3122 * 1 - function was scheduled for execution
3123 */
David Howells65f27f32006-11-22 14:55:48 +00003124int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003125{
3126 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003127 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003128 return 0;
3129 }
3130
David Howells65f27f32006-11-22 14:55:48 +00003131 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003132 schedule_work(&ew->work);
3133
3134 return 1;
3135}
3136EXPORT_SYMBOL_GPL(execute_in_process_context);
3137
Linus Torvalds1da177e2005-04-16 15:20:36 -07003138int keventd_up(void)
3139{
Tejun Heod320c032010-06-29 10:07:14 +02003140 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003141}
3142
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003143static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003144{
Oleg Nesterov3af244332007-05-09 02:34:09 -07003145 /*
Tejun Heo0f900042010-06-29 10:07:11 +02003146 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
3147 * Make sure that the alignment isn't lower than that of
3148 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07003149 */
Tejun Heo0f900042010-06-29 10:07:11 +02003150 const size_t size = sizeof(struct cpu_workqueue_struct);
3151 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
3152 __alignof__(unsigned long long));
Oleg Nesterov3af244332007-05-09 02:34:09 -07003153
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003154 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003155 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02003156 else {
Tejun Heof3421792010-07-02 10:03:51 +02003157 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003158
Tejun Heof3421792010-07-02 10:03:51 +02003159 /*
3160 * Allocate enough room to align cwq and put an extra
3161 * pointer at the end pointing back to the originally
3162 * allocated pointer which will be used for free.
3163 */
3164 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3165 if (ptr) {
3166 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3167 *(void **)(wq->cpu_wq.single + 1) = ptr;
3168 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003169 }
Tejun Heof3421792010-07-02 10:03:51 +02003170
Tejun Heo0415b00d12011-03-24 18:50:09 +01003171 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003172 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3173 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003174}
3175
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003176static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003177{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003178 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003179 free_percpu(wq->cpu_wq.pcpu);
3180 else if (wq->cpu_wq.single) {
3181 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003182 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003183 }
3184}
3185
Tejun Heof3421792010-07-02 10:03:51 +02003186static int wq_clamp_max_active(int max_active, unsigned int flags,
3187 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003188{
Tejun Heof3421792010-07-02 10:03:51 +02003189 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3190
3191 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003192 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3193 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003194
Tejun Heof3421792010-07-02 10:03:51 +02003195 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003196}
3197
Tejun Heob196be82012-01-10 15:11:35 -08003198struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003199 unsigned int flags,
3200 int max_active,
3201 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003202 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003203{
Tejun Heob196be82012-01-10 15:11:35 -08003204 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003205 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003206 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08003207 size_t namelen;
3208
3209 /* determine namelen, allocate wq and format name */
3210 va_start(args, lock_name);
3211 va_copy(args1, args);
3212 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3213
3214 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3215 if (!wq)
3216 goto err;
3217
3218 vsnprintf(wq->name, namelen, fmt, args1);
3219 va_end(args);
3220 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003221
Tejun Heof3421792010-07-02 10:03:51 +02003222 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02003223 * Workqueues which may be used during memory reclaim should
3224 * have a rescuer to guarantee forward progress.
3225 */
3226 if (flags & WQ_MEM_RECLAIM)
3227 flags |= WQ_RESCUER;
3228
Tejun Heod320c032010-06-29 10:07:14 +02003229 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003230 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003231
Tejun Heob196be82012-01-10 15:11:35 -08003232 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003233 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003234 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003235 mutex_init(&wq->flush_mutex);
3236 atomic_set(&wq->nr_cwqs_to_flush, 0);
3237 INIT_LIST_HEAD(&wq->flusher_queue);
3238 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003239
Johannes Bergeb13ba82008-01-16 09:51:58 +01003240 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003241 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003242
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003243 if (alloc_cwqs(wq) < 0)
3244 goto err;
3245
Tejun Heof3421792010-07-02 10:03:51 +02003246 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003247 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003248 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo32704762012-07-13 22:16:45 -07003249 int pool_idx = (bool)(flags & WQ_HIGHPRI);
Tejun Heo15376632010-06-29 10:07:11 +02003250
Tejun Heo0f900042010-06-29 10:07:11 +02003251 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo32704762012-07-13 22:16:45 -07003252 cwq->pool = &gcwq->pools[pool_idx];
Tejun Heoc34056a2010-06-29 10:07:11 +02003253 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003254 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003255 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003256 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003257 }
3258
Tejun Heoe22bee72010-06-29 10:07:14 +02003259 if (flags & WQ_RESCUER) {
3260 struct worker *rescuer;
3261
Tejun Heof2e005a2010-07-20 15:59:09 +02003262 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003263 goto err;
3264
3265 wq->rescuer = rescuer = alloc_worker();
3266 if (!rescuer)
3267 goto err;
3268
Tejun Heob196be82012-01-10 15:11:35 -08003269 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3270 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003271 if (IS_ERR(rescuer->task))
3272 goto err;
3273
Tejun Heoe22bee72010-06-29 10:07:14 +02003274 rescuer->task->flags |= PF_THREAD_BOUND;
3275 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003276 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003277
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003278 /*
3279 * workqueue_lock protects global freeze state and workqueues
3280 * list. Grab it, set max_active accordingly and add the new
3281 * workqueue to workqueues list.
3282 */
Tejun Heo15376632010-06-29 10:07:11 +02003283 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003284
Tejun Heo58a69cb2011-02-16 09:25:31 +01003285 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003286 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003287 get_cwq(cpu, wq)->max_active = 0;
3288
Tejun Heo15376632010-06-29 10:07:11 +02003289 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003290
Tejun Heo15376632010-06-29 10:07:11 +02003291 spin_unlock(&workqueue_lock);
3292
Oleg Nesterov3af244332007-05-09 02:34:09 -07003293 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003294err:
3295 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003296 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003297 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003298 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003299 kfree(wq);
3300 }
3301 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003302}
Tejun Heod320c032010-06-29 10:07:14 +02003303EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003304
3305/**
3306 * destroy_workqueue - safely terminate a workqueue
3307 * @wq: target workqueue
3308 *
3309 * Safely destroy a workqueue. All work currently pending will be done first.
3310 */
3311void destroy_workqueue(struct workqueue_struct *wq)
3312{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003313 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003314
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003315 /* drain it before proceeding with destruction */
3316 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003317
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003318 /*
3319 * wq list is used to freeze wq, remove from list after
3320 * flushing is complete in case freeze races us.
3321 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003322 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07003323 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003324 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003325
Tejun Heoe22bee72010-06-29 10:07:14 +02003326 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003327 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003328 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3329 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003330
Tejun Heo73f53c42010-06-29 10:07:11 +02003331 for (i = 0; i < WORK_NR_COLORS; i++)
3332 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003333 BUG_ON(cwq->nr_active);
3334 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003335 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003336
Tejun Heoe22bee72010-06-29 10:07:14 +02003337 if (wq->flags & WQ_RESCUER) {
3338 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003339 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003340 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003341 }
3342
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003343 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003344 kfree(wq);
3345}
3346EXPORT_SYMBOL_GPL(destroy_workqueue);
3347
Tejun Heodcd989c2010-06-29 10:07:14 +02003348/**
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003349 * cwq_set_max_active - adjust max_active of a cwq
3350 * @cwq: target cpu_workqueue_struct
3351 * @max_active: new max_active value.
3352 *
3353 * Set @cwq->max_active to @max_active and activate delayed works if
3354 * increased.
3355 *
3356 * CONTEXT:
3357 * spin_lock_irq(gcwq->lock).
3358 */
3359static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active)
3360{
3361 cwq->max_active = max_active;
3362
3363 while (!list_empty(&cwq->delayed_works) &&
3364 cwq->nr_active < cwq->max_active)
3365 cwq_activate_first_delayed(cwq);
3366}
3367
3368/**
Tejun Heodcd989c2010-06-29 10:07:14 +02003369 * workqueue_set_max_active - adjust max_active of a workqueue
3370 * @wq: target workqueue
3371 * @max_active: new max_active value.
3372 *
3373 * Set max_active of @wq to @max_active.
3374 *
3375 * CONTEXT:
3376 * Don't call from IRQ context.
3377 */
3378void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3379{
3380 unsigned int cpu;
3381
Tejun Heof3421792010-07-02 10:03:51 +02003382 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003383
3384 spin_lock(&workqueue_lock);
3385
3386 wq->saved_max_active = max_active;
3387
Tejun Heof3421792010-07-02 10:03:51 +02003388 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003389 struct global_cwq *gcwq = get_gcwq(cpu);
3390
3391 spin_lock_irq(&gcwq->lock);
3392
Tejun Heo58a69cb2011-02-16 09:25:31 +01003393 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003394 !(gcwq->flags & GCWQ_FREEZING))
Lai Jiangshan70369b12012-09-19 10:40:48 -07003395 cwq_set_max_active(get_cwq(gcwq->cpu, wq), max_active);
Tejun Heodcd989c2010-06-29 10:07:14 +02003396
3397 spin_unlock_irq(&gcwq->lock);
3398 }
3399
3400 spin_unlock(&workqueue_lock);
3401}
3402EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3403
3404/**
3405 * workqueue_congested - test whether a workqueue is congested
3406 * @cpu: CPU in question
3407 * @wq: target workqueue
3408 *
3409 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3410 * no synchronization around this function and the test result is
3411 * unreliable and only useful as advisory hints or for debugging.
3412 *
3413 * RETURNS:
3414 * %true if congested, %false otherwise.
3415 */
3416bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3417{
3418 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3419
3420 return !list_empty(&cwq->delayed_works);
3421}
3422EXPORT_SYMBOL_GPL(workqueue_congested);
3423
3424/**
3425 * work_cpu - return the last known associated cpu for @work
3426 * @work: the work of interest
3427 *
3428 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003429 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003430 */
3431unsigned int work_cpu(struct work_struct *work)
3432{
3433 struct global_cwq *gcwq = get_work_gcwq(work);
3434
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003435 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003436}
3437EXPORT_SYMBOL_GPL(work_cpu);
3438
3439/**
3440 * work_busy - test whether a work is currently pending or running
3441 * @work: the work to be tested
3442 *
3443 * Test whether @work is currently pending or running. There is no
3444 * synchronization around this function and the test result is
3445 * unreliable and only useful as advisory hints or for debugging.
3446 * Especially for reentrant wqs, the pending state might hide the
3447 * running state.
3448 *
3449 * RETURNS:
3450 * OR'd bitmask of WORK_BUSY_* bits.
3451 */
3452unsigned int work_busy(struct work_struct *work)
3453{
3454 struct global_cwq *gcwq = get_work_gcwq(work);
3455 unsigned long flags;
3456 unsigned int ret = 0;
3457
3458 if (!gcwq)
Joonsoo Kim999767b2012-10-21 01:30:06 +09003459 return 0;
Tejun Heodcd989c2010-06-29 10:07:14 +02003460
3461 spin_lock_irqsave(&gcwq->lock, flags);
3462
3463 if (work_pending(work))
3464 ret |= WORK_BUSY_PENDING;
3465 if (find_worker_executing_work(gcwq, work))
3466 ret |= WORK_BUSY_RUNNING;
3467
3468 spin_unlock_irqrestore(&gcwq->lock, flags);
3469
3470 return ret;
3471}
3472EXPORT_SYMBOL_GPL(work_busy);
3473
Tejun Heodb7bccf2010-06-29 10:07:12 +02003474/*
3475 * CPU hotplug.
3476 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003477 * There are two challenges in supporting CPU hotplug. Firstly, there
3478 * are a lot of assumptions on strong associations among work, cwq and
3479 * gcwq which make migrating pending and scheduled works very
3480 * difficult to implement without impacting hot paths. Secondly,
3481 * gcwqs serve mix of short, long and very long running works making
3482 * blocked draining impractical.
3483 *
Tejun Heo628c78e2012-07-17 12:39:27 -07003484 * This is solved by allowing a gcwq to be disassociated from the CPU
3485 * running as an unbound one and allowing it to be reattached later if the
3486 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003487 */
3488
Tejun Heo60373152012-07-17 12:39:27 -07003489/* claim manager positions of all pools */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003490static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003491{
3492 struct worker_pool *pool;
3493
3494 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003495 mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
Tejun Heo8db25e72012-07-17 12:39:28 -07003496 spin_lock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003497}
3498
3499/* release manager positions */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003500static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003501{
3502 struct worker_pool *pool;
3503
Tejun Heo8db25e72012-07-17 12:39:28 -07003504 spin_unlock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003505 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003506 mutex_unlock(&pool->assoc_mutex);
Tejun Heo60373152012-07-17 12:39:27 -07003507}
3508
Tejun Heo628c78e2012-07-17 12:39:27 -07003509static void gcwq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003510{
Tejun Heo628c78e2012-07-17 12:39:27 -07003511 struct global_cwq *gcwq = get_gcwq(smp_processor_id());
Tejun Heo4ce62e92012-07-13 22:16:44 -07003512 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003513 struct worker *worker;
3514 struct hlist_node *pos;
3515 int i;
3516
3517 BUG_ON(gcwq->cpu != smp_processor_id());
3518
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003519 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003520
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003521 /*
3522 * We've claimed all manager positions. Make all workers unbound
3523 * and set DISASSOCIATED. Before this, all workers except for the
3524 * ones which are still executing works from before the last CPU
3525 * down must be on the cpu. After this, they may become diasporas.
3526 */
Tejun Heo60373152012-07-17 12:39:27 -07003527 for_each_worker_pool(pool, gcwq)
Tejun Heo4ce62e92012-07-13 22:16:44 -07003528 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07003529 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003530
3531 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo403c8212012-07-17 12:39:27 -07003532 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003533
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003534 gcwq->flags |= GCWQ_DISASSOCIATED;
3535
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003536 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003537
3538 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07003539 * Call schedule() so that we cross rq->lock and thus can guarantee
3540 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3541 * as scheduler callbacks may be invoked from other cpus.
3542 */
3543 schedule();
3544
3545 /*
3546 * Sched callbacks are disabled now. Zap nr_running. After this,
3547 * nr_running stays zero and need_more_worker() and keep_working()
3548 * are always true as long as the worklist is not empty. @gcwq now
3549 * behaves as unbound (in terms of concurrency management) gcwq
3550 * which is served by workers tied to the CPU.
3551 *
3552 * On return from this function, the current worker would trigger
3553 * unbound chain execution of pending work items if other workers
3554 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02003555 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07003556 for_each_worker_pool(pool, gcwq)
3557 atomic_set(get_pool_nr_running(pool), 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003558}
3559
Tejun Heo8db25e72012-07-17 12:39:28 -07003560/*
3561 * Workqueues should be brought up before normal priority CPU notifiers.
3562 * This will be registered high priority CPU notifier.
3563 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003564static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07003565 unsigned long action,
3566 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003567{
3568 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003569 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003570 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003571
Tejun Heo8db25e72012-07-17 12:39:28 -07003572 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003573 case CPU_UP_PREPARE:
Tejun Heo4ce62e92012-07-13 22:16:44 -07003574 for_each_worker_pool(pool, gcwq) {
Tejun Heo3ce63372012-07-17 12:39:27 -07003575 struct worker *worker;
3576
3577 if (pool->nr_workers)
3578 continue;
3579
3580 worker = create_worker(pool);
3581 if (!worker)
3582 return NOTIFY_BAD;
3583
3584 spin_lock_irq(&gcwq->lock);
3585 start_worker(worker);
3586 spin_unlock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003587 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003588 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003589
Tejun Heo65758202012-07-17 12:39:26 -07003590 case CPU_DOWN_FAILED:
3591 case CPU_ONLINE:
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003592 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heo8db25e72012-07-17 12:39:28 -07003593 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3594 rebind_workers(gcwq);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003595 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heo8db25e72012-07-17 12:39:28 -07003596 break;
Tejun Heo65758202012-07-17 12:39:26 -07003597 }
3598 return NOTIFY_OK;
3599}
3600
3601/*
3602 * Workqueues should be brought down after normal priority CPU notifiers.
3603 * This will be registered as low priority CPU notifier.
3604 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003605static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07003606 unsigned long action,
3607 void *hcpu)
3608{
Tejun Heo8db25e72012-07-17 12:39:28 -07003609 unsigned int cpu = (unsigned long)hcpu;
3610 struct work_struct unbind_work;
3611
Tejun Heo65758202012-07-17 12:39:26 -07003612 switch (action & ~CPU_TASKS_FROZEN) {
3613 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003614 /* unbinding should happen on the local CPU */
3615 INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09003616 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07003617 flush_work(&unbind_work);
3618 break;
Tejun Heo65758202012-07-17 12:39:26 -07003619 }
3620 return NOTIFY_OK;
3621}
3622
Rusty Russell2d3854a2008-11-05 13:39:10 +11003623#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003624
Rusty Russell2d3854a2008-11-05 13:39:10 +11003625struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07003626 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003627 long (*fn)(void *);
3628 void *arg;
3629 long ret;
3630};
3631
Tejun Heoed48ece2012-09-18 12:48:43 -07003632static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003633{
Tejun Heoed48ece2012-09-18 12:48:43 -07003634 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3635
Rusty Russell2d3854a2008-11-05 13:39:10 +11003636 wfc->ret = wfc->fn(wfc->arg);
3637}
3638
3639/**
3640 * work_on_cpu - run a function in user context on a particular cpu
3641 * @cpu: the cpu to run on
3642 * @fn: the function to run
3643 * @arg: the function arg
3644 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003645 * This will return the value @fn returns.
3646 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b44003e2009-04-09 09:50:37 -06003647 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003648 */
3649long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3650{
Tejun Heoed48ece2012-09-18 12:48:43 -07003651 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003652
Tejun Heoed48ece2012-09-18 12:48:43 -07003653 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3654 schedule_work_on(cpu, &wfc.work);
3655 flush_work(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003656 return wfc.ret;
3657}
3658EXPORT_SYMBOL_GPL(work_on_cpu);
3659#endif /* CONFIG_SMP */
3660
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003661#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303662
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003663/**
3664 * freeze_workqueues_begin - begin freezing workqueues
3665 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003666 * Start freezing workqueues. After this function returns, all freezable
3667 * workqueues will queue new works to their frozen_works list instead of
3668 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003669 *
3670 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003671 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003672 */
3673void freeze_workqueues_begin(void)
3674{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003675 unsigned int cpu;
3676
3677 spin_lock(&workqueue_lock);
3678
3679 BUG_ON(workqueue_freezing);
3680 workqueue_freezing = true;
3681
Tejun Heof3421792010-07-02 10:03:51 +02003682 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003683 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003684 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003685
3686 spin_lock_irq(&gcwq->lock);
3687
Tejun Heodb7bccf2010-06-29 10:07:12 +02003688 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3689 gcwq->flags |= GCWQ_FREEZING;
3690
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003691 list_for_each_entry(wq, &workqueues, list) {
3692 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3693
Tejun Heo58a69cb2011-02-16 09:25:31 +01003694 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003695 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003696 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003697
3698 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003699 }
3700
3701 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003702}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003703
3704/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003705 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003706 *
3707 * Check whether freezing is complete. This function must be called
3708 * between freeze_workqueues_begin() and thaw_workqueues().
3709 *
3710 * CONTEXT:
3711 * Grabs and releases workqueue_lock.
3712 *
3713 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003714 * %true if some freezable workqueues are still busy. %false if freezing
3715 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003716 */
3717bool freeze_workqueues_busy(void)
3718{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003719 unsigned int cpu;
3720 bool busy = false;
3721
3722 spin_lock(&workqueue_lock);
3723
3724 BUG_ON(!workqueue_freezing);
3725
Tejun Heof3421792010-07-02 10:03:51 +02003726 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003727 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003728 /*
3729 * nr_active is monotonically decreasing. It's safe
3730 * to peek without lock.
3731 */
3732 list_for_each_entry(wq, &workqueues, list) {
3733 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3734
Tejun Heo58a69cb2011-02-16 09:25:31 +01003735 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003736 continue;
3737
3738 BUG_ON(cwq->nr_active < 0);
3739 if (cwq->nr_active) {
3740 busy = true;
3741 goto out_unlock;
3742 }
3743 }
3744 }
3745out_unlock:
3746 spin_unlock(&workqueue_lock);
3747 return busy;
3748}
3749
3750/**
3751 * thaw_workqueues - thaw workqueues
3752 *
3753 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003754 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003755 *
3756 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003757 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003758 */
3759void thaw_workqueues(void)
3760{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003761 unsigned int cpu;
3762
3763 spin_lock(&workqueue_lock);
3764
3765 if (!workqueue_freezing)
3766 goto out_unlock;
3767
Tejun Heof3421792010-07-02 10:03:51 +02003768 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003769 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003770 struct worker_pool *pool;
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003771 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003772
3773 spin_lock_irq(&gcwq->lock);
3774
Tejun Heodb7bccf2010-06-29 10:07:12 +02003775 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3776 gcwq->flags &= ~GCWQ_FREEZING;
3777
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003778 list_for_each_entry(wq, &workqueues, list) {
3779 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3780
Tejun Heo58a69cb2011-02-16 09:25:31 +01003781 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003782 continue;
3783
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003784 /* restore max_active and repopulate worklist */
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003785 cwq_set_max_active(cwq, wq->saved_max_active);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003786 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003787
Tejun Heo4ce62e92012-07-13 22:16:44 -07003788 for_each_worker_pool(pool, gcwq)
3789 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02003790
Tejun Heo8b03ae32010-06-29 10:07:12 +02003791 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003792 }
3793
3794 workqueue_freezing = false;
3795out_unlock:
3796 spin_unlock(&workqueue_lock);
3797}
3798#endif /* CONFIG_FREEZER */
3799
Suresh Siddha6ee05782010-07-30 14:57:37 -07003800static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003801{
Tejun Heoc34056a2010-06-29 10:07:11 +02003802 unsigned int cpu;
3803
Tejun Heob5490072012-08-03 10:30:46 -07003804 /* make sure we have enough bits for OFFQ CPU number */
3805 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3806 WORK_CPU_LAST);
3807
Tejun Heo65758202012-07-17 12:39:26 -07003808 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07003809 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003810
3811 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003812 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003813 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003814 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003815
3816 spin_lock_init(&gcwq->lock);
3817 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003818 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003819
Sasha Levin42f85702012-12-17 10:01:23 -05003820 hash_init(gcwq->busy_hash);
Tejun Heoc8e55f32010-06-29 10:07:12 +02003821
Tejun Heo4ce62e92012-07-13 22:16:44 -07003822 for_each_worker_pool(pool, gcwq) {
3823 pool->gcwq = gcwq;
3824 INIT_LIST_HEAD(&pool->worklist);
3825 INIT_LIST_HEAD(&pool->idle_list);
Tejun Heoe22bee72010-06-29 10:07:14 +02003826
Tejun Heo4ce62e92012-07-13 22:16:44 -07003827 init_timer_deferrable(&pool->idle_timer);
3828 pool->idle_timer.function = idle_worker_timeout;
3829 pool->idle_timer.data = (unsigned long)pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003830
Tejun Heo4ce62e92012-07-13 22:16:44 -07003831 setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
3832 (unsigned long)pool);
3833
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003834 mutex_init(&pool->assoc_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003835 ida_init(&pool->worker_ida);
3836 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003837 }
3838
Tejun Heoe22bee72010-06-29 10:07:14 +02003839 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003840 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003841 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003842 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003843
Tejun Heo477a3c32010-08-31 10:54:35 +02003844 if (cpu != WORK_CPU_UNBOUND)
3845 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003846
3847 for_each_worker_pool(pool, gcwq) {
3848 struct worker *worker;
3849
Tejun Heobc2ae0f2012-07-17 12:39:27 -07003850 worker = create_worker(pool);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003851 BUG_ON(!worker);
3852 spin_lock_irq(&gcwq->lock);
3853 start_worker(worker);
3854 spin_unlock_irq(&gcwq->lock);
3855 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003856 }
3857
Tejun Heod320c032010-06-29 10:07:14 +02003858 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003859 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02003860 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003861 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3862 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003863 system_freezable_wq = alloc_workqueue("events_freezable",
3864 WQ_FREEZABLE, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003865 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Tejun Heoae930e02012-08-20 14:51:23 -07003866 !system_unbound_wq || !system_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003867 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003868}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003869early_initcall(init_workqueues);