blob: 99c30116d2913ec37ab6e4384be5562a3c61c5cd [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
Tejun Heoea138442013-01-18 14:05:55 -080046#include "workqueue_internal.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 /*
Tejun Heo24647572013-01-24 11:01:33 -080050 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070051 *
Tejun Heo24647572013-01-24 11:01:33 -080052 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070053 * 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
Tejun Heo24647572013-01-24 11:01:33 -080059 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070060 *
61 * Note that DISASSOCIATED can be flipped only while holding
Tejun Heo24647572013-01-24 11:01:33 -080062 * assoc_mutex to avoid changing binding state while
63 * create_worker() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070064 */
Tejun Heo11ebea52012-07-12 14:46:37 -070065 POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
Lai Jiangshan552a37e2012-09-10 10:03:33 -070066 POOL_MANAGING_WORKERS = 1 << 1, /* managing workers */
Tejun Heo24647572013-01-24 11:01:33 -080067 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heo35b6bb62013-01-24 11:01:33 -080068 POOL_FREEZING = 1 << 3, /* freeze in progress */
Tejun Heodb7bccf2010-06-29 10:07:12 +020069
Tejun Heoc8e55f32010-06-29 10:07:12 +020070 /* worker flags */
71 WORKER_STARTED = 1 << 0, /* started */
72 WORKER_DIE = 1 << 1, /* die die die */
73 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020074 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020075 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020076 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoe22bee72010-06-29 10:07:14 +020077
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -070078 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_UNBOUND |
Tejun Heo403c8212012-07-17 12:39:27 -070079 WORKER_CPU_INTENSIVE,
Tejun Heodb7bccf2010-06-29 10:07:12 +020080
Tejun Heoe34cdddb2013-01-24 11:01:33 -080081 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070082
Tejun Heoc8e55f32010-06-29 10:07:12 +020083 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020084
Tejun Heoe22bee72010-06-29 10:07:14 +020085 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
86 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
87
Tejun Heo3233cdb2011-02-16 18:10:19 +010088 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
89 /* call for help after 10ms
90 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020091 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
92 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020093
94 /*
95 * Rescue workers are used only on emergencies and shared by
96 * all cpus. Give -20.
97 */
98 RESCUER_NICE_LEVEL = -20,
Tejun Heo32704762012-07-13 22:16:45 -070099 HIGHPRI_NICE_LEVEL = -20,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200100};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200103 * Structure fields follow one of the following exclusion rules.
104 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200105 * I: Modifiable by initialization/destruction paths and read-only for
106 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200107 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200108 * P: Preemption protected. Disabling preemption is enough and should
109 * only be modified and accessed from the local cpu.
110 *
Tejun Heo8b03ae32010-06-29 10:07:12 +0200111 * L: gcwq->lock protected. Access with gcwq->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200112 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200113 * X: During normal operation, modification requires gcwq->lock and
114 * should be done only from local cpu. Either disabling preemption
115 * on local cpu or grabbing gcwq->lock is enough for read access.
Tejun Heo24647572013-01-24 11:01:33 -0800116 * If POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200117 *
Tejun Heo73f53c42010-06-29 10:07:11 +0200118 * F: wq->flush_mutex protected.
119 *
Tejun Heo4690c4a2010-06-29 10:07:10 +0200120 * W: workqueue_lock protected.
121 */
122
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800123/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200124
Tejun Heobd7bdd42012-07-12 14:46:37 -0700125struct worker_pool {
126 struct global_cwq *gcwq; /* I: the owning gcwq */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800127 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700128 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700129
130 struct list_head worklist; /* L: list of pending works */
131 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700132
133 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700134 int nr_idle; /* L: currently idle ones */
135
136 struct list_head idle_list; /* X: list of idle workers */
137 struct timer_list idle_timer; /* L: worker idle timeout */
138 struct timer_list mayday_timer; /* L: SOS timer for workers */
139
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800140 /* workers are chained either in busy_hash or idle_list */
141 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
142 /* L: hash of busy workers */
143
Tejun Heo24647572013-01-24 11:01:33 -0800144 struct mutex assoc_mutex; /* protect POOL_DISASSOCIATED */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700145 struct ida worker_ida; /* L: for worker IDs */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700146};
147
Tejun Heo4690c4a2010-06-29 10:07:10 +0200148/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200149 * Global per-cpu workqueue. There's one and only one for each cpu
150 * and all works are queued and processed here regardless of their
151 * target workqueues.
Tejun Heo8b03ae32010-06-29 10:07:12 +0200152 */
153struct global_cwq {
154 spinlock_t lock; /* the gcwq lock */
155 unsigned int cpu; /* I: the associated cpu */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200156
Tejun Heoe34cdddb2013-01-24 11:01:33 -0800157 struct worker_pool pools[NR_STD_WORKER_POOLS];
Joonsoo Kim330dad52012-08-15 23:25:36 +0900158 /* normal and highpri pools */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200159} ____cacheline_aligned_in_smp;
160
161/*
Tejun Heo502ca9d2010-06-29 10:07:13 +0200162 * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of
Tejun Heo0f900042010-06-29 10:07:11 +0200163 * work_struct->data are used for flags and thus cwqs need to be
164 * aligned at two's power of the number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 */
166struct cpu_workqueue_struct {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700167 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200168 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200169 int work_color; /* L: current color */
170 int flush_color; /* L: flushing color */
171 int nr_in_flight[WORK_NR_COLORS];
172 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200173 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200174 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200175 struct list_head delayed_works; /* L: delayed works */
Tejun Heo0f900042010-06-29 10:07:11 +0200176};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200179 * Structure used to wait for workqueue flush.
180 */
181struct wq_flusher {
182 struct list_head list; /* F: list of flushers */
183 int flush_color; /* F: flush color waiting for */
184 struct completion done; /* flush completion */
185};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Tejun Heo73f53c42010-06-29 10:07:11 +0200187/*
Tejun Heof2e005a2010-07-20 15:59:09 +0200188 * All cpumasks are assumed to be always set on UP and thus can't be
189 * used to determine whether there's something to be done.
190 */
191#ifdef CONFIG_SMP
192typedef cpumask_var_t mayday_mask_t;
193#define mayday_test_and_set_cpu(cpu, mask) \
194 cpumask_test_and_set_cpu((cpu), (mask))
195#define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask))
196#define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask))
Tejun Heo9c375472010-08-31 11:18:34 +0200197#define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp))
Tejun Heof2e005a2010-07-20 15:59:09 +0200198#define free_mayday_mask(mask) free_cpumask_var((mask))
199#else
200typedef unsigned long mayday_mask_t;
201#define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask))
202#define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask))
203#define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask))
204#define alloc_mayday_mask(maskp, gfp) true
205#define free_mayday_mask(mask) do { } while (0)
206#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
208/*
209 * The externally visible workqueue abstraction is an array of
210 * per-CPU workqueues:
211 */
212struct workqueue_struct {
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200213 unsigned int flags; /* W: WQ_* flags */
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200214 union {
215 struct cpu_workqueue_struct __percpu *pcpu;
216 struct cpu_workqueue_struct *single;
217 unsigned long v;
218 } cpu_wq; /* I: cwq's */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200219 struct list_head list; /* W: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200220
221 struct mutex flush_mutex; /* protects wq flushing */
222 int work_color; /* F: current work color */
223 int flush_color; /* F: current flush color */
224 atomic_t nr_cwqs_to_flush; /* flush in progress */
225 struct wq_flusher *first_flusher; /* F: first flusher */
226 struct list_head flusher_queue; /* F: flush waiters */
227 struct list_head flusher_overflow; /* F: flush overflow list */
228
Tejun Heof2e005a2010-07-20 15:59:09 +0200229 mayday_mask_t mayday_mask; /* cpus requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200230 struct worker *rescuer; /* I: rescue worker */
231
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200232 int nr_drainers; /* W: drain in progress */
Tejun Heodcd989c2010-06-29 10:07:14 +0200233 int saved_max_active; /* W: saved cwq max_active */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700234#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200235 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700236#endif
Tejun Heob196be82012-01-10 15:11:35 -0800237 char name[]; /* I: workqueue name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238};
239
Tejun Heod320c032010-06-29 10:07:14 +0200240struct workqueue_struct *system_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200241EXPORT_SYMBOL_GPL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300242struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900243EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300244struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200245EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300246struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200247EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300248struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100249EXPORT_SYMBOL_GPL(system_freezable_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200250
Tejun Heo97bd2342010-10-05 10:41:14 +0200251#define CREATE_TRACE_POINTS
252#include <trace/events/workqueue.h>
253
Tejun Heo4ce62e92012-07-13 22:16:44 -0700254#define for_each_worker_pool(pool, gcwq) \
Tejun Heo32704762012-07-13 22:16:45 -0700255 for ((pool) = &(gcwq)->pools[0]; \
Tejun Heoe34cdddb2013-01-24 11:01:33 -0800256 (pool) < &(gcwq)->pools[NR_STD_WORKER_POOLS]; (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700257
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800258#define for_each_busy_worker(worker, i, pos, pool) \
259 hash_for_each(pool->busy_hash, i, pos, worker, hentry)
Tejun Heodb7bccf2010-06-29 10:07:12 +0200260
Tejun Heof3421792010-07-02 10:03:51 +0200261static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
262 unsigned int sw)
263{
264 if (cpu < nr_cpu_ids) {
265 if (sw & 1) {
266 cpu = cpumask_next(cpu, mask);
267 if (cpu < nr_cpu_ids)
268 return cpu;
269 }
270 if (sw & 2)
271 return WORK_CPU_UNBOUND;
272 }
273 return WORK_CPU_NONE;
274}
275
276static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
277 struct workqueue_struct *wq)
278{
279 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
280}
281
Tejun Heo09884952010-08-01 11:50:12 +0200282/*
283 * CPU iterators
284 *
285 * An extra gcwq is defined for an invalid cpu number
286 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
287 * specific CPU. The following iterators are similar to
288 * for_each_*_cpu() iterators but also considers the unbound gcwq.
289 *
290 * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
291 * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
292 * for_each_cwq_cpu() : possible CPUs for bound workqueues,
293 * WORK_CPU_UNBOUND for unbound workqueues
294 */
Tejun Heof3421792010-07-02 10:03:51 +0200295#define for_each_gcwq_cpu(cpu) \
296 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
297 (cpu) < WORK_CPU_NONE; \
298 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
299
300#define for_each_online_gcwq_cpu(cpu) \
301 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
302 (cpu) < WORK_CPU_NONE; \
303 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
304
305#define for_each_cwq_cpu(cpu, wq) \
306 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
307 (cpu) < WORK_CPU_NONE; \
308 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
309
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900310#ifdef CONFIG_DEBUG_OBJECTS_WORK
311
312static struct debug_obj_descr work_debug_descr;
313
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100314static void *work_debug_hint(void *addr)
315{
316 return ((struct work_struct *) addr)->func;
317}
318
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900319/*
320 * fixup_init is called when:
321 * - an active object is initialized
322 */
323static int work_fixup_init(void *addr, enum debug_obj_state state)
324{
325 struct work_struct *work = addr;
326
327 switch (state) {
328 case ODEBUG_STATE_ACTIVE:
329 cancel_work_sync(work);
330 debug_object_init(work, &work_debug_descr);
331 return 1;
332 default:
333 return 0;
334 }
335}
336
337/*
338 * fixup_activate is called when:
339 * - an active object is activated
340 * - an unknown object is activated (might be a statically initialized object)
341 */
342static int work_fixup_activate(void *addr, enum debug_obj_state state)
343{
344 struct work_struct *work = addr;
345
346 switch (state) {
347
348 case ODEBUG_STATE_NOTAVAILABLE:
349 /*
350 * This is not really a fixup. The work struct was
351 * statically initialized. We just make sure that it
352 * is tracked in the object tracker.
353 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200354 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900355 debug_object_init(work, &work_debug_descr);
356 debug_object_activate(work, &work_debug_descr);
357 return 0;
358 }
359 WARN_ON_ONCE(1);
360 return 0;
361
362 case ODEBUG_STATE_ACTIVE:
363 WARN_ON(1);
364
365 default:
366 return 0;
367 }
368}
369
370/*
371 * fixup_free is called when:
372 * - an active object is freed
373 */
374static int work_fixup_free(void *addr, enum debug_obj_state state)
375{
376 struct work_struct *work = addr;
377
378 switch (state) {
379 case ODEBUG_STATE_ACTIVE:
380 cancel_work_sync(work);
381 debug_object_free(work, &work_debug_descr);
382 return 1;
383 default:
384 return 0;
385 }
386}
387
388static struct debug_obj_descr work_debug_descr = {
389 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100390 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900391 .fixup_init = work_fixup_init,
392 .fixup_activate = work_fixup_activate,
393 .fixup_free = work_fixup_free,
394};
395
396static inline void debug_work_activate(struct work_struct *work)
397{
398 debug_object_activate(work, &work_debug_descr);
399}
400
401static inline void debug_work_deactivate(struct work_struct *work)
402{
403 debug_object_deactivate(work, &work_debug_descr);
404}
405
406void __init_work(struct work_struct *work, int onstack)
407{
408 if (onstack)
409 debug_object_init_on_stack(work, &work_debug_descr);
410 else
411 debug_object_init(work, &work_debug_descr);
412}
413EXPORT_SYMBOL_GPL(__init_work);
414
415void destroy_work_on_stack(struct work_struct *work)
416{
417 debug_object_free(work, &work_debug_descr);
418}
419EXPORT_SYMBOL_GPL(destroy_work_on_stack);
420
421#else
422static inline void debug_work_activate(struct work_struct *work) { }
423static inline void debug_work_deactivate(struct work_struct *work) { }
424#endif
425
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100426/* Serializes the accesses to the list of workqueues. */
427static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200429static bool workqueue_freezing; /* W: have wqs started freezing? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
Oleg Nesterov14441962007-05-23 13:57:57 -0700431/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200432 * The almighty global cpu workqueues. nr_running is the only field
433 * which is expected to be used frequently by other cpus via
434 * try_to_wake_up(). Put it in a separate cacheline.
Oleg Nesterov14441962007-05-23 13:57:57 -0700435 */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200436static DEFINE_PER_CPU(struct global_cwq, global_cwq);
Tejun Heoe34cdddb2013-01-24 11:01:33 -0800437static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_STD_WORKER_POOLS]);
Nathan Lynchf756d5e2006-01-08 01:05:12 -0800438
Tejun Heof3421792010-07-02 10:03:51 +0200439/*
Tejun Heo24647572013-01-24 11:01:33 -0800440 * Global cpu workqueue and nr_running counter for unbound gcwq. The pools
441 * for online CPUs have POOL_DISASSOCIATED set, and all their workers have
442 * WORKER_UNBOUND set.
Tejun Heof3421792010-07-02 10:03:51 +0200443 */
444static struct global_cwq unbound_global_cwq;
Tejun Heoe34cdddb2013-01-24 11:01:33 -0800445static atomic_t unbound_pool_nr_running[NR_STD_WORKER_POOLS] = {
446 [0 ... NR_STD_WORKER_POOLS - 1] = ATOMIC_INIT(0), /* always 0 */
Tejun Heo4ce62e92012-07-13 22:16:44 -0700447};
Tejun Heof3421792010-07-02 10:03:51 +0200448
Tejun Heo9daf9e62013-01-24 11:01:33 -0800449/* idr of all pools */
450static DEFINE_MUTEX(worker_pool_idr_mutex);
451static DEFINE_IDR(worker_pool_idr);
452
Tejun Heoc34056a2010-06-29 10:07:11 +0200453static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Tejun Heoe34cdddb2013-01-24 11:01:33 -0800455static int std_worker_pool_pri(struct worker_pool *pool)
Tejun Heo32704762012-07-13 22:16:45 -0700456{
457 return pool - pool->gcwq->pools;
458}
459
Tejun Heo8b03ae32010-06-29 10:07:12 +0200460static struct global_cwq *get_gcwq(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461{
Tejun Heof3421792010-07-02 10:03:51 +0200462 if (cpu != WORK_CPU_UNBOUND)
463 return &per_cpu(global_cwq, cpu);
464 else
465 return &unbound_global_cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466}
467
Tejun Heo9daf9e62013-01-24 11:01:33 -0800468/* allocate ID and assign it to @pool */
469static int worker_pool_assign_id(struct worker_pool *pool)
470{
471 int ret;
472
473 mutex_lock(&worker_pool_idr_mutex);
474 idr_pre_get(&worker_pool_idr, GFP_KERNEL);
475 ret = idr_get_new(&worker_pool_idr, pool, &pool->id);
476 mutex_unlock(&worker_pool_idr_mutex);
477
478 return ret;
479}
480
Tejun Heo7c3eed52013-01-24 11:01:33 -0800481/*
482 * Lookup worker_pool by id. The idr currently is built during boot and
483 * never modified. Don't worry about locking for now.
484 */
485static struct worker_pool *worker_pool_by_id(int pool_id)
486{
487 return idr_find(&worker_pool_idr, pool_id);
488}
489
Tejun Heo63d95a92012-07-12 14:46:37 -0700490static atomic_t *get_pool_nr_running(struct worker_pool *pool)
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700491{
Tejun Heo63d95a92012-07-12 14:46:37 -0700492 int cpu = pool->gcwq->cpu;
Tejun Heoe34cdddb2013-01-24 11:01:33 -0800493 int idx = std_worker_pool_pri(pool);
Tejun Heo63d95a92012-07-12 14:46:37 -0700494
Tejun Heof3421792010-07-02 10:03:51 +0200495 if (cpu != WORK_CPU_UNBOUND)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700496 return &per_cpu(pool_nr_running, cpu)[idx];
Tejun Heof3421792010-07-02 10:03:51 +0200497 else
Tejun Heo4ce62e92012-07-13 22:16:44 -0700498 return &unbound_pool_nr_running[idx];
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700499}
500
Tejun Heo4690c4a2010-06-29 10:07:10 +0200501static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
502 struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700503{
Tejun Heof3421792010-07-02 10:03:51 +0200504 if (!(wq->flags & WQ_UNBOUND)) {
Lai Jiangshane06ffa12012-03-09 18:03:20 +0800505 if (likely(cpu < nr_cpu_ids))
Tejun Heof3421792010-07-02 10:03:51 +0200506 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
Tejun Heof3421792010-07-02 10:03:51 +0200507 } else if (likely(cpu == WORK_CPU_UNBOUND))
508 return wq->cpu_wq.single;
509 return NULL;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700510}
511
Tejun Heo73f53c42010-06-29 10:07:11 +0200512static unsigned int work_color_to_flags(int color)
513{
514 return color << WORK_STRUCT_COLOR_SHIFT;
515}
516
517static int get_work_color(struct work_struct *work)
518{
519 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
520 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
521}
522
523static int work_next_color(int color)
524{
525 return (color + 1) % WORK_NR_COLORS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526}
527
David Howells4594bf12006-12-07 11:33:26 +0000528/*
Tejun Heob5490072012-08-03 10:30:46 -0700529 * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
530 * contain the pointer to the queued cwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800531 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200532 *
Tejun Heo7c3eed52013-01-24 11:01:33 -0800533 * set_work_cwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
534 * and clear_work_data() can be used to set the cwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700535 * work->data. These functions should only be called while the work is
536 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200537 *
Tejun Heo7c3eed52013-01-24 11:01:33 -0800538 * get_work_pool() and get_work_cwq() can be used to obtain the pool or cwq
539 * corresponding to a work. Pool is available once the work has been
540 * queued anywhere after initialization until it is sync canceled. cwq is
541 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700542 *
543 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
544 * canceled. While being canceled, a work item may have its PENDING set
545 * but stay off timer and worklist for arbitrarily long and nobody should
546 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000547 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200548static inline void set_work_data(struct work_struct *work, unsigned long data,
549 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000550{
David Howells4594bf12006-12-07 11:33:26 +0000551 BUG_ON(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200552 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000553}
David Howells365970a2006-11-22 14:54:49 +0000554
Tejun Heo7a22ad72010-06-29 10:07:13 +0200555static void set_work_cwq(struct work_struct *work,
556 struct cpu_workqueue_struct *cwq,
557 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200558{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200559 set_work_data(work, (unsigned long)cwq,
Tejun Heoe1201532010-07-22 14:14:25 +0200560 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200561}
562
Tejun Heo7c3eed52013-01-24 11:01:33 -0800563static void set_work_pool_and_clear_pending(struct work_struct *work,
564 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000565{
Tejun Heo23657bb2012-08-13 17:08:19 -0700566 /*
567 * The following wmb is paired with the implied mb in
568 * test_and_set_bit(PENDING) and ensures all updates to @work made
569 * here are visible to and precede any updates by the next PENDING
570 * owner.
571 */
572 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800573 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200574}
575
576static void clear_work_data(struct work_struct *work)
577{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800578 smp_wmb(); /* see set_work_pool_and_clear_pending() */
579 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200580}
581
Tejun Heo7a22ad72010-06-29 10:07:13 +0200582static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
583{
Tejun Heoe1201532010-07-22 14:14:25 +0200584 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200585
Tejun Heoe1201532010-07-22 14:14:25 +0200586 if (data & WORK_STRUCT_CWQ)
587 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
588 else
589 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200590}
591
Tejun Heo7c3eed52013-01-24 11:01:33 -0800592/**
593 * get_work_pool - return the worker_pool a given work was associated with
594 * @work: the work item of interest
595 *
596 * Return the worker_pool @work was last associated with. %NULL if none.
597 */
598static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200599{
Tejun Heoe1201532010-07-22 14:14:25 +0200600 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800601 struct worker_pool *pool;
602 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200603
Tejun Heoe1201532010-07-22 14:14:25 +0200604 if (data & WORK_STRUCT_CWQ)
605 return ((struct cpu_workqueue_struct *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800606 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200607
Tejun Heo7c3eed52013-01-24 11:01:33 -0800608 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
609 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200610 return NULL;
611
Tejun Heo7c3eed52013-01-24 11:01:33 -0800612 pool = worker_pool_by_id(pool_id);
613 WARN_ON_ONCE(!pool);
614 return pool;
615}
616
617/**
618 * get_work_pool_id - return the worker pool ID a given work is associated with
619 * @work: the work item of interest
620 *
621 * Return the worker_pool ID @work was last associated with.
622 * %WORK_OFFQ_POOL_NONE if none.
623 */
624static int get_work_pool_id(struct work_struct *work)
625{
626 struct worker_pool *pool = get_work_pool(work);
627
628 return pool ? pool->id : WORK_OFFQ_POOL_NONE;
629}
630
631static struct global_cwq *get_work_gcwq(struct work_struct *work)
632{
633 struct worker_pool *pool = get_work_pool(work);
634
635 return pool ? pool->gcwq : NULL;
David Howells365970a2006-11-22 14:54:49 +0000636}
637
Tejun Heobbb68df2012-08-03 10:30:46 -0700638static void mark_work_canceling(struct work_struct *work)
639{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800640 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700641
Tejun Heo7c3eed52013-01-24 11:01:33 -0800642 pool_id <<= WORK_OFFQ_POOL_SHIFT;
643 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700644}
645
646static bool work_is_canceling(struct work_struct *work)
647{
648 unsigned long data = atomic_long_read(&work->data);
649
650 return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
651}
652
David Howells365970a2006-11-22 14:54:49 +0000653/*
Tejun Heo32704762012-07-13 22:16:45 -0700654 * Policy functions. These define the policies on how the global worker
655 * pools are managed. Unless noted otherwise, these functions assume that
656 * they're being called with gcwq->lock held.
David Howells365970a2006-11-22 14:54:49 +0000657 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200658
Tejun Heo63d95a92012-07-12 14:46:37 -0700659static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000660{
Tejun Heo32704762012-07-13 22:16:45 -0700661 return !atomic_read(get_pool_nr_running(pool));
David Howells365970a2006-11-22 14:54:49 +0000662}
663
Tejun Heoe22bee72010-06-29 10:07:14 +0200664/*
665 * Need to wake up a worker? Called from anything but currently
666 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700667 *
668 * Note that, because unbound workers never contribute to nr_running, this
669 * function will always return %true for unbound gcwq as long as the
670 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200671 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700672static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000673{
Tejun Heo63d95a92012-07-12 14:46:37 -0700674 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000675}
676
Tejun Heoe22bee72010-06-29 10:07:14 +0200677/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700678static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200679{
Tejun Heo63d95a92012-07-12 14:46:37 -0700680 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200681}
682
683/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700684static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200685{
Tejun Heo63d95a92012-07-12 14:46:37 -0700686 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200687
Tejun Heo32704762012-07-13 22:16:45 -0700688 return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200689}
690
691/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700692static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200693{
Tejun Heo63d95a92012-07-12 14:46:37 -0700694 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200695}
696
697/* Do I need to be the manager? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700698static bool need_to_manage_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200699{
Tejun Heo63d95a92012-07-12 14:46:37 -0700700 return need_to_create_worker(pool) ||
Tejun Heo11ebea52012-07-12 14:46:37 -0700701 (pool->flags & POOL_MANAGE_WORKERS);
Tejun Heoe22bee72010-06-29 10:07:14 +0200702}
703
704/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700705static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200706{
Lai Jiangshan552a37e2012-09-10 10:03:33 -0700707 bool managing = pool->flags & POOL_MANAGING_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -0700708 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
709 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200710
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700711 /*
712 * nr_idle and idle_list may disagree if idle rebinding is in
713 * progress. Never return %true if idle_list is empty.
714 */
715 if (list_empty(&pool->idle_list))
716 return false;
717
Tejun Heoe22bee72010-06-29 10:07:14 +0200718 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
719}
720
721/*
722 * Wake up functions.
723 */
724
Tejun Heo7e116292010-06-29 10:07:13 +0200725/* Return the first worker. Safe with preemption disabled */
Tejun Heo63d95a92012-07-12 14:46:37 -0700726static struct worker *first_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200727{
Tejun Heo63d95a92012-07-12 14:46:37 -0700728 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200729 return NULL;
730
Tejun Heo63d95a92012-07-12 14:46:37 -0700731 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200732}
733
734/**
735 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700736 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200737 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700738 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200739 *
740 * CONTEXT:
741 * spin_lock_irq(gcwq->lock).
742 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700743static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200744{
Tejun Heo63d95a92012-07-12 14:46:37 -0700745 struct worker *worker = first_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200746
747 if (likely(worker))
748 wake_up_process(worker->task);
749}
750
Tejun Heo4690c4a2010-06-29 10:07:10 +0200751/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200752 * wq_worker_waking_up - a worker is waking up
753 * @task: task waking up
754 * @cpu: CPU @task is waking up to
755 *
756 * This function is called during try_to_wake_up() when a worker is
757 * being awoken.
758 *
759 * CONTEXT:
760 * spin_lock_irq(rq->lock)
761 */
762void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
763{
764 struct worker *worker = kthread_data(task);
765
Joonsoo Kim36576002012-10-26 23:03:49 +0900766 if (!(worker->flags & WORKER_NOT_RUNNING)) {
767 WARN_ON_ONCE(worker->pool->gcwq->cpu != cpu);
Tejun Heo63d95a92012-07-12 14:46:37 -0700768 atomic_inc(get_pool_nr_running(worker->pool));
Joonsoo Kim36576002012-10-26 23:03:49 +0900769 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200770}
771
772/**
773 * wq_worker_sleeping - a worker is going to sleep
774 * @task: task going to sleep
775 * @cpu: CPU in question, must be the current CPU number
776 *
777 * This function is called during schedule() when a busy worker is
778 * going to sleep. Worker on the same cpu can be woken up by
779 * returning pointer to its task.
780 *
781 * CONTEXT:
782 * spin_lock_irq(rq->lock)
783 *
784 * RETURNS:
785 * Worker task on @cpu to wake up, %NULL if none.
786 */
787struct task_struct *wq_worker_sleeping(struct task_struct *task,
788 unsigned int cpu)
789{
790 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800791 struct worker_pool *pool;
792 atomic_t *nr_running;
Tejun Heoe22bee72010-06-29 10:07:14 +0200793
Tejun Heo111c2252013-01-17 17:16:24 -0800794 /*
795 * Rescuers, which may not have all the fields set up like normal
796 * workers, also reach here, let's not access anything before
797 * checking NOT_RUNNING.
798 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500799 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200800 return NULL;
801
Tejun Heo111c2252013-01-17 17:16:24 -0800802 pool = worker->pool;
803 nr_running = get_pool_nr_running(pool);
804
Tejun Heoe22bee72010-06-29 10:07:14 +0200805 /* this can only happen on the local cpu */
806 BUG_ON(cpu != raw_smp_processor_id());
807
808 /*
809 * The counterpart of the following dec_and_test, implied mb,
810 * worklist not empty test sequence is in insert_work().
811 * Please read comment there.
812 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700813 * NOT_RUNNING is clear. This means that we're bound to and
814 * running on the local cpu w/ rq lock held and preemption
815 * disabled, which in turn means that none else could be
816 * manipulating idle_list, so dereferencing idle_list without gcwq
817 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200818 */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700819 if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700820 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200821 return to_wakeup ? to_wakeup->task : NULL;
822}
823
824/**
825 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200826 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200827 * @flags: flags to set
828 * @wakeup: wakeup an idle worker if necessary
829 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200830 * Set @flags in @worker->flags and adjust nr_running accordingly. If
831 * nr_running becomes zero and @wakeup is %true, an idle worker is
832 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200833 *
Tejun Heocb444762010-07-02 10:03:50 +0200834 * CONTEXT:
835 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200836 */
837static inline void worker_set_flags(struct worker *worker, unsigned int flags,
838 bool wakeup)
839{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700840 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200841
Tejun Heocb444762010-07-02 10:03:50 +0200842 WARN_ON_ONCE(worker->task != current);
843
Tejun Heoe22bee72010-06-29 10:07:14 +0200844 /*
845 * If transitioning into NOT_RUNNING, adjust nr_running and
846 * wake up an idle worker as necessary if requested by
847 * @wakeup.
848 */
849 if ((flags & WORKER_NOT_RUNNING) &&
850 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heo63d95a92012-07-12 14:46:37 -0700851 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200852
853 if (wakeup) {
854 if (atomic_dec_and_test(nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700855 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700856 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200857 } else
858 atomic_dec(nr_running);
859 }
860
Tejun Heod302f012010-06-29 10:07:13 +0200861 worker->flags |= flags;
862}
863
864/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200865 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200866 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200867 * @flags: flags to clear
868 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200869 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200870 *
Tejun Heocb444762010-07-02 10:03:50 +0200871 * CONTEXT:
872 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200873 */
874static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
875{
Tejun Heo63d95a92012-07-12 14:46:37 -0700876 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200877 unsigned int oflags = worker->flags;
878
Tejun Heocb444762010-07-02 10:03:50 +0200879 WARN_ON_ONCE(worker->task != current);
880
Tejun Heod302f012010-06-29 10:07:13 +0200881 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200882
Tejun Heo42c025f2011-01-11 15:58:49 +0100883 /*
884 * If transitioning out of NOT_RUNNING, increment nr_running. Note
885 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
886 * of multiple flags, not a single flag.
887 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200888 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
889 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700890 atomic_inc(get_pool_nr_running(pool));
Tejun Heod302f012010-06-29 10:07:13 +0200891}
892
893/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200894 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800895 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200896 * @work: work to find worker for
897 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800898 * Find a worker which is executing @work on @pool by searching
899 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800900 * to match, its current execution should match the address of @work and
901 * its work function. This is to avoid unwanted dependency between
902 * unrelated work executions through a work item being recycled while still
903 * being executed.
904 *
905 * This is a bit tricky. A work item may be freed once its execution
906 * starts and nothing prevents the freed area from being recycled for
907 * another work item. If the same work item address ends up being reused
908 * before the original execution finishes, workqueue will identify the
909 * recycled work item as currently executing and make it wait until the
910 * current execution finishes, introducing an unwanted dependency.
911 *
912 * This function checks the work item address, work function and workqueue
913 * to avoid false positives. Note that this isn't complete as one may
914 * construct a work function which can introduce dependency onto itself
915 * through a recycled work item. Well, if somebody wants to shoot oneself
916 * in the foot that badly, there's only so much we can do, and if such
917 * deadlock actually occurs, it should be easy to locate the culprit work
918 * function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200919 *
920 * CONTEXT:
921 * spin_lock_irq(gcwq->lock).
922 *
923 * RETURNS:
924 * Pointer to worker which is executing @work if found, NULL
925 * otherwise.
926 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800927static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200928 struct work_struct *work)
929{
Sasha Levin42f85702012-12-17 10:01:23 -0500930 struct worker *worker;
931 struct hlist_node *tmp;
932
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800933 hash_for_each_possible(pool->busy_hash, worker, tmp, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800934 (unsigned long)work)
935 if (worker->current_work == work &&
936 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500937 return worker;
938
939 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200940}
941
942/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700943 * move_linked_works - move linked works to a list
944 * @work: start of series of works to be scheduled
945 * @head: target list to append @work to
946 * @nextp: out paramter for nested worklist walking
947 *
948 * Schedule linked works starting from @work to @head. Work series to
949 * be scheduled starts at @work and includes any consecutive work with
950 * WORK_STRUCT_LINKED set in its predecessor.
951 *
952 * If @nextp is not NULL, it's updated to point to the next work of
953 * the last scheduled work. This allows move_linked_works() to be
954 * nested inside outer list_for_each_entry_safe().
955 *
956 * CONTEXT:
957 * spin_lock_irq(gcwq->lock).
958 */
959static void move_linked_works(struct work_struct *work, struct list_head *head,
960 struct work_struct **nextp)
961{
962 struct work_struct *n;
963
964 /*
965 * Linked worklist will always end before the end of the list,
966 * use NULL for list head.
967 */
968 list_for_each_entry_safe_from(work, n, NULL, entry) {
969 list_move_tail(&work->entry, head);
970 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
971 break;
972 }
973
974 /*
975 * If we're already inside safe list traversal and have moved
976 * multiple works to the scheduled queue, the next position
977 * needs to be updated.
978 */
979 if (nextp)
980 *nextp = n;
981}
982
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700983static void cwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -0700984{
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700985 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -0700986
987 trace_workqueue_activate_work(work);
988 move_linked_works(work, &cwq->pool->worklist, NULL);
989 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
990 cwq->nr_active++;
991}
992
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700993static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
994{
995 struct work_struct *work = list_first_entry(&cwq->delayed_works,
996 struct work_struct, entry);
997
998 cwq_activate_delayed_work(work);
999}
1000
Tejun Heobf4ede02012-08-03 10:30:46 -07001001/**
1002 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
1003 * @cwq: cwq of interest
1004 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001005 *
1006 * A work either has completed or is removed from pending queue,
1007 * decrement nr_in_flight of its cwq and handle workqueue flushing.
1008 *
1009 * CONTEXT:
1010 * spin_lock_irq(gcwq->lock).
1011 */
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001012static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001013{
1014 /* ignore uncolored works */
1015 if (color == WORK_NO_COLOR)
1016 return;
1017
1018 cwq->nr_in_flight[color]--;
1019
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001020 cwq->nr_active--;
1021 if (!list_empty(&cwq->delayed_works)) {
1022 /* one down, submit a delayed one */
1023 if (cwq->nr_active < cwq->max_active)
1024 cwq_activate_first_delayed(cwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001025 }
1026
1027 /* is flush in progress and are we at the flushing tip? */
1028 if (likely(cwq->flush_color != color))
1029 return;
1030
1031 /* are there still in-flight works? */
1032 if (cwq->nr_in_flight[color])
1033 return;
1034
1035 /* this cwq is done, clear flush_color */
1036 cwq->flush_color = -1;
1037
1038 /*
1039 * If this was the last cwq, wake up the first flusher. It
1040 * will handle the rest.
1041 */
1042 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
1043 complete(&cwq->wq->first_flusher->done);
1044}
1045
Tejun Heo36e227d2012-08-03 10:30:46 -07001046/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001047 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001048 * @work: work item to steal
1049 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001050 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001051 *
1052 * Try to grab PENDING bit of @work. This function can handle @work in any
1053 * stable state - idle, on timer or on worklist. Return values are
1054 *
1055 * 1 if @work was pending and we successfully stole PENDING
1056 * 0 if @work was idle and we claimed PENDING
1057 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001058 * -ENOENT if someone else is canceling @work, this state may persist
1059 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001060 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001061 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001062 * interrupted while holding PENDING and @work off queue, irq must be
1063 * disabled on entry. This, combined with delayed_work->timer being
1064 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001065 *
1066 * On successful return, >= 0, irq is disabled and the caller is
1067 * responsible for releasing it using local_irq_restore(*@flags).
1068 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001069 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001070 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001071static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1072 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001073{
1074 struct global_cwq *gcwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001075
Tejun Heobbb68df2012-08-03 10:30:46 -07001076 local_irq_save(*flags);
1077
Tejun Heo36e227d2012-08-03 10:30:46 -07001078 /* try to steal the timer if it exists */
1079 if (is_dwork) {
1080 struct delayed_work *dwork = to_delayed_work(work);
1081
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001082 /*
1083 * dwork->timer is irqsafe. If del_timer() fails, it's
1084 * guaranteed that the timer is not queued anywhere and not
1085 * running on the local CPU.
1086 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001087 if (likely(del_timer(&dwork->timer)))
1088 return 1;
1089 }
1090
1091 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001092 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1093 return 0;
1094
1095 /*
1096 * The queueing is in progress, or it is already queued. Try to
1097 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1098 */
1099 gcwq = get_work_gcwq(work);
1100 if (!gcwq)
Tejun Heobbb68df2012-08-03 10:30:46 -07001101 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001102
Tejun Heobbb68df2012-08-03 10:30:46 -07001103 spin_lock(&gcwq->lock);
Tejun Heobf4ede02012-08-03 10:30:46 -07001104 if (!list_empty(&work->entry)) {
1105 /*
1106 * This work is queued, but perhaps we locked the wrong gcwq.
1107 * In that case we must see the new value after rmb(), see
1108 * insert_work()->wmb().
1109 */
1110 smp_rmb();
1111 if (gcwq == get_work_gcwq(work)) {
1112 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001113
1114 /*
1115 * A delayed work item cannot be grabbed directly
1116 * because it might have linked NO_COLOR work items
1117 * which, if left on the delayed_list, will confuse
1118 * cwq->nr_active management later on and cause
1119 * stall. Make sure the work item is activated
1120 * before grabbing.
1121 */
1122 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1123 cwq_activate_delayed_work(work);
1124
Tejun Heobf4ede02012-08-03 10:30:46 -07001125 list_del_init(&work->entry);
1126 cwq_dec_nr_in_flight(get_work_cwq(work),
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001127 get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001128
Tejun Heobbb68df2012-08-03 10:30:46 -07001129 spin_unlock(&gcwq->lock);
Tejun Heo36e227d2012-08-03 10:30:46 -07001130 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001131 }
1132 }
Tejun Heobbb68df2012-08-03 10:30:46 -07001133 spin_unlock(&gcwq->lock);
1134fail:
1135 local_irq_restore(*flags);
1136 if (work_is_canceling(work))
1137 return -ENOENT;
1138 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001139 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001140}
1141
1142/**
Tejun Heo7e116292010-06-29 10:07:13 +02001143 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +02001144 * @cwq: cwq @work belongs to
1145 * @work: work to insert
1146 * @head: insertion point
1147 * @extra_flags: extra WORK_STRUCT_* flags to set
1148 *
Tejun Heo7e116292010-06-29 10:07:13 +02001149 * Insert @work which belongs to @cwq into @gcwq after @head.
1150 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001151 *
1152 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001153 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001154 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001155static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +02001156 struct work_struct *work, struct list_head *head,
1157 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001158{
Tejun Heo63d95a92012-07-12 14:46:37 -07001159 struct worker_pool *pool = cwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001160
Tejun Heo4690c4a2010-06-29 10:07:10 +02001161 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +02001162 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001163
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001164 /*
1165 * Ensure that we get the right work->data if we see the
1166 * result of list_add() below, see try_to_grab_pending().
1167 */
1168 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +02001169
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001170 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +02001171
1172 /*
1173 * Ensure either worker_sched_deactivated() sees the above
1174 * list_add_tail() or we see zero nr_running to avoid workers
1175 * lying around lazily while there are works to be processed.
1176 */
1177 smp_mb();
1178
Tejun Heo63d95a92012-07-12 14:46:37 -07001179 if (__need_more_worker(pool))
1180 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001181}
1182
Tejun Heoc8efcc22010-12-20 19:32:04 +01001183/*
1184 * Test whether @work is being queued from another work executing on the
1185 * same workqueue. This is rather expensive and should only be used from
1186 * cold paths.
1187 */
1188static bool is_chained_work(struct workqueue_struct *wq)
1189{
1190 unsigned long flags;
1191 unsigned int cpu;
1192
1193 for_each_gcwq_cpu(cpu) {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001194 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
1195 struct worker_pool *pool = cwq->pool;
1196 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001197 struct worker *worker;
1198 struct hlist_node *pos;
1199 int i;
1200
1201 spin_lock_irqsave(&gcwq->lock, flags);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001202 for_each_busy_worker(worker, i, pos, pool) {
Tejun Heoc8efcc22010-12-20 19:32:04 +01001203 if (worker->task != current)
1204 continue;
1205 spin_unlock_irqrestore(&gcwq->lock, flags);
1206 /*
1207 * I'm @worker, no locking necessary. See if @work
1208 * is headed to the same workqueue.
1209 */
1210 return worker->current_cwq->wq == wq;
1211 }
1212 spin_unlock_irqrestore(&gcwq->lock, flags);
1213 }
1214 return false;
1215}
1216
Tejun Heo4690c4a2010-06-29 10:07:10 +02001217static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 struct work_struct *work)
1219{
Tejun Heo502ca9d2010-06-29 10:07:13 +02001220 struct global_cwq *gcwq;
1221 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001222 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001223 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001224 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001225
1226 /*
1227 * While a work item is PENDING && off queue, a task trying to
1228 * steal the PENDING will busy-loop waiting for it to either get
1229 * queued or lose PENDING. Grabbing PENDING and queueing should
1230 * happen with IRQ disabled.
1231 */
1232 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001234 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001235
Tejun Heoc8efcc22010-12-20 19:32:04 +01001236 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02001237 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001238 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001239 return;
1240
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001241 /* determine gcwq to use */
1242 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001243 struct worker_pool *last_pool;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001244
Tejun Heo57469822012-08-03 10:30:45 -07001245 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001246 cpu = raw_smp_processor_id();
1247
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001248 /*
Tejun Heodbf25762012-08-20 14:51:23 -07001249 * It's multi cpu. If @work was previously on a different
1250 * cpu, it might still be running there, in which case the
1251 * work needs to be queued on that cpu to guarantee
1252 * non-reentrancy.
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001253 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001254 gcwq = get_gcwq(cpu);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001255 last_pool = get_work_pool(work);
Tejun Heodbf25762012-08-20 14:51:23 -07001256
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001257 if (last_pool && last_pool->gcwq != gcwq) {
1258 struct global_cwq *last_gcwq = last_pool->gcwq;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001259 struct worker *worker;
1260
Tejun Heo8930cab2012-08-03 10:30:45 -07001261 spin_lock(&last_gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001262
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001263 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001264
1265 if (worker && worker->current_cwq->wq == wq)
1266 gcwq = last_gcwq;
1267 else {
1268 /* meh... not running there, queue here */
Tejun Heo8930cab2012-08-03 10:30:45 -07001269 spin_unlock(&last_gcwq->lock);
1270 spin_lock(&gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001271 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001272 } else {
1273 spin_lock(&gcwq->lock);
1274 }
Tejun Heof3421792010-07-02 10:03:51 +02001275 } else {
1276 gcwq = get_gcwq(WORK_CPU_UNBOUND);
Tejun Heo8930cab2012-08-03 10:30:45 -07001277 spin_lock(&gcwq->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001278 }
1279
1280 /* gcwq determined, get cwq and queue */
1281 cwq = get_cwq(gcwq->cpu, wq);
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001282 trace_workqueue_queue_work(req_cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001283
Dan Carpenterf5b25522012-04-13 22:06:58 +03001284 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo8930cab2012-08-03 10:30:45 -07001285 spin_unlock(&gcwq->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001286 return;
1287 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001288
Tejun Heo73f53c42010-06-29 10:07:11 +02001289 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001290 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001291
1292 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001293 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001294 cwq->nr_active++;
Tejun Heo32704762012-07-13 22:16:45 -07001295 worklist = &cwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001296 } else {
1297 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001298 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001299 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001300
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001301 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001302
Tejun Heo8930cab2012-08-03 10:30:45 -07001303 spin_unlock(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304}
1305
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001306/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001307 * queue_work_on - queue work on specific cpu
1308 * @cpu: CPU number to execute work on
1309 * @wq: workqueue to use
1310 * @work: work to queue
1311 *
Tejun Heod4283e92012-08-03 10:30:44 -07001312 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001313 *
1314 * We queue the work to a specific CPU, the caller must ensure it
1315 * can't go away.
1316 */
Tejun Heod4283e92012-08-03 10:30:44 -07001317bool queue_work_on(int cpu, struct workqueue_struct *wq,
1318 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001319{
Tejun Heod4283e92012-08-03 10:30:44 -07001320 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001321 unsigned long flags;
1322
1323 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001324
Tejun Heo22df02b2010-06-29 10:07:10 +02001325 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001326 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001327 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001328 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001329
1330 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001331 return ret;
1332}
1333EXPORT_SYMBOL_GPL(queue_work_on);
1334
Tejun Heo0a13c002012-08-03 10:30:44 -07001335/**
1336 * queue_work - queue work on a workqueue
1337 * @wq: workqueue to use
1338 * @work: work to queue
1339 *
Tejun Heod4283e92012-08-03 10:30:44 -07001340 * Returns %false if @work was already on a queue, %true otherwise.
Tejun Heo0a13c002012-08-03 10:30:44 -07001341 *
1342 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1343 * it can be processed by another CPU.
1344 */
Tejun Heod4283e92012-08-03 10:30:44 -07001345bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07001346{
Tejun Heo57469822012-08-03 10:30:45 -07001347 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
Tejun Heo0a13c002012-08-03 10:30:44 -07001348}
1349EXPORT_SYMBOL_GPL(queue_work);
1350
Tejun Heod8e794d2012-08-03 10:30:45 -07001351void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352{
David Howells52bad642006-11-22 14:54:01 +00001353 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001354 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001356 /* should have been called from irqsafe timer with irq already off */
Tejun Heo12650572012-08-08 09:38:42 -07001357 __queue_work(dwork->cpu, cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358}
Tejun Heod8e794d2012-08-03 10:30:45 -07001359EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001361static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1362 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001364 struct timer_list *timer = &dwork->timer;
1365 struct work_struct *work = &dwork->work;
1366 unsigned int lcpu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001368 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1369 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001370 WARN_ON_ONCE(timer_pending(timer));
1371 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001372
Tejun Heo8852aac2012-12-01 16:23:42 -08001373 /*
1374 * If @delay is 0, queue @dwork->work immediately. This is for
1375 * both optimization and correctness. The earliest @timer can
1376 * expire is on the closest next tick and delayed_work users depend
1377 * on that there's no such delay when @delay is 0.
1378 */
1379 if (!delay) {
1380 __queue_work(cpu, wq, &dwork->work);
1381 return;
1382 }
1383
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001384 timer_stats_timer_set_start_info(&dwork->timer);
1385
1386 /*
1387 * This stores cwq for the moment, for the timer_fn. Note that the
1388 * work's gcwq is preserved to allow reentrance detection for
1389 * delayed works.
1390 */
1391 if (!(wq->flags & WQ_UNBOUND)) {
1392 struct global_cwq *gcwq = get_work_gcwq(work);
1393
Joonsoo Kime42986d2012-08-15 23:25:38 +09001394 /*
1395 * If we cannot get the last gcwq from @work directly,
1396 * select the last CPU such that it avoids unnecessarily
1397 * triggering non-reentrancy check in __queue_work().
1398 */
1399 lcpu = cpu;
1400 if (gcwq)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001401 lcpu = gcwq->cpu;
Joonsoo Kime42986d2012-08-15 23:25:38 +09001402 if (lcpu == WORK_CPU_UNBOUND)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001403 lcpu = raw_smp_processor_id();
1404 } else {
1405 lcpu = WORK_CPU_UNBOUND;
1406 }
1407
1408 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1409
Tejun Heo12650572012-08-08 09:38:42 -07001410 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001411 timer->expires = jiffies + delay;
1412
1413 if (unlikely(cpu != WORK_CPU_UNBOUND))
1414 add_timer_on(timer, cpu);
1415 else
1416 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417}
1418
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001419/**
1420 * queue_delayed_work_on - queue work on specific CPU after delay
1421 * @cpu: CPU number to execute work on
1422 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001423 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001424 * @delay: number of jiffies to wait before queueing
1425 *
Tejun Heo715f1302012-08-03 10:30:46 -07001426 * Returns %false if @work was already on a queue, %true otherwise. If
1427 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1428 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001429 */
Tejun Heod4283e92012-08-03 10:30:44 -07001430bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1431 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001432{
David Howells52bad642006-11-22 14:54:01 +00001433 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001434 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001435 unsigned long flags;
1436
1437 /* read the comment in __queue_work() */
1438 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001439
Tejun Heo22df02b2010-06-29 10:07:10 +02001440 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001441 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001442 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001443 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001444
1445 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001446 return ret;
1447}
Dave Jonesae90dd52006-06-30 01:40:45 -04001448EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449
Tejun Heoc8e55f32010-06-29 10:07:12 +02001450/**
Tejun Heo0a13c002012-08-03 10:30:44 -07001451 * queue_delayed_work - queue work on a workqueue after delay
1452 * @wq: workqueue to use
1453 * @dwork: delayable work to queue
1454 * @delay: number of jiffies to wait before queueing
1455 *
Tejun Heo715f1302012-08-03 10:30:46 -07001456 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
Tejun Heo0a13c002012-08-03 10:30:44 -07001457 */
Tejun Heod4283e92012-08-03 10:30:44 -07001458bool queue_delayed_work(struct workqueue_struct *wq,
Tejun Heo0a13c002012-08-03 10:30:44 -07001459 struct delayed_work *dwork, unsigned long delay)
1460{
Tejun Heo57469822012-08-03 10:30:45 -07001461 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
Tejun Heo0a13c002012-08-03 10:30:44 -07001462}
1463EXPORT_SYMBOL_GPL(queue_delayed_work);
1464
1465/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001466 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1467 * @cpu: CPU number to execute work on
1468 * @wq: workqueue to use
1469 * @dwork: work to queue
1470 * @delay: number of jiffies to wait before queueing
1471 *
1472 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1473 * modify @dwork's timer so that it expires after @delay. If @delay is
1474 * zero, @work is guaranteed to be scheduled immediately regardless of its
1475 * current state.
1476 *
1477 * Returns %false if @dwork was idle and queued, %true if @dwork was
1478 * pending and its timer was modified.
1479 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001480 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001481 * See try_to_grab_pending() for details.
1482 */
1483bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1484 struct delayed_work *dwork, unsigned long delay)
1485{
1486 unsigned long flags;
1487 int ret;
1488
1489 do {
1490 ret = try_to_grab_pending(&dwork->work, true, &flags);
1491 } while (unlikely(ret == -EAGAIN));
1492
1493 if (likely(ret >= 0)) {
1494 __queue_delayed_work(cpu, wq, dwork, delay);
1495 local_irq_restore(flags);
1496 }
1497
1498 /* -ENOENT from try_to_grab_pending() becomes %true */
1499 return ret;
1500}
1501EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1502
1503/**
1504 * mod_delayed_work - modify delay of or queue a delayed work
1505 * @wq: workqueue to use
1506 * @dwork: work to queue
1507 * @delay: number of jiffies to wait before queueing
1508 *
1509 * mod_delayed_work_on() on local CPU.
1510 */
1511bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1512 unsigned long delay)
1513{
1514 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1515}
1516EXPORT_SYMBOL_GPL(mod_delayed_work);
1517
1518/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001519 * worker_enter_idle - enter idle state
1520 * @worker: worker which is entering idle state
1521 *
1522 * @worker is entering idle state. Update stats and idle timer if
1523 * necessary.
1524 *
1525 * LOCKING:
1526 * spin_lock_irq(gcwq->lock).
1527 */
1528static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001530 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531
Tejun Heoc8e55f32010-06-29 10:07:12 +02001532 BUG_ON(worker->flags & WORKER_IDLE);
1533 BUG_ON(!list_empty(&worker->entry) &&
1534 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
Tejun Heocb444762010-07-02 10:03:50 +02001536 /* can't use worker_set_flags(), also called from start_worker() */
1537 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001538 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001539 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001540
Tejun Heoc8e55f32010-06-29 10:07:12 +02001541 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001542 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001543
Tejun Heo628c78e2012-07-17 12:39:27 -07001544 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1545 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001546
Tejun Heo544ecf32012-05-14 15:04:50 -07001547 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07001548 * Sanity check nr_running. Because gcwq_unbind_fn() releases
1549 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1550 * nr_running, the warning may trigger spuriously. Check iff
1551 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001552 */
Tejun Heo24647572013-01-24 11:01:33 -08001553 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001554 pool->nr_workers == pool->nr_idle &&
Tejun Heo63d95a92012-07-12 14:46:37 -07001555 atomic_read(get_pool_nr_running(pool)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556}
1557
Tejun Heoc8e55f32010-06-29 10:07:12 +02001558/**
1559 * worker_leave_idle - leave idle state
1560 * @worker: worker which is leaving idle state
1561 *
1562 * @worker is leaving idle state. Update stats.
1563 *
1564 * LOCKING:
1565 * spin_lock_irq(gcwq->lock).
1566 */
1567static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001569 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570
Tejun Heoc8e55f32010-06-29 10:07:12 +02001571 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001572 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001573 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001574 list_del_init(&worker->entry);
1575}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576
Tejun Heoe22bee72010-06-29 10:07:14 +02001577/**
1578 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1579 * @worker: self
1580 *
1581 * Works which are scheduled while the cpu is online must at least be
1582 * scheduled to a worker which is bound to the cpu so that if they are
1583 * flushed from cpu callbacks while cpu is going down, they are
1584 * guaranteed to execute on the cpu.
1585 *
1586 * This function is to be used by rogue workers and rescuers to bind
1587 * themselves to the target cpu and may race with cpu going down or
1588 * coming online. kthread_bind() can't be used because it may put the
1589 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1590 * verbatim as it's best effort and blocking and gcwq may be
1591 * [dis]associated in the meantime.
1592 *
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001593 * This function tries set_cpus_allowed() and locks gcwq and verifies the
Tejun Heo24647572013-01-24 11:01:33 -08001594 * binding against %POOL_DISASSOCIATED which is set during
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001595 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1596 * enters idle state or fetches works without dropping lock, it can
1597 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001598 *
1599 * CONTEXT:
1600 * Might sleep. Called without any lock but returns with gcwq->lock
1601 * held.
1602 *
1603 * RETURNS:
1604 * %true if the associated gcwq is online (@worker is successfully
1605 * bound), %false if offline.
1606 */
1607static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001608__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001609{
Tejun Heo24647572013-01-24 11:01:33 -08001610 struct worker_pool *pool = worker->pool;
1611 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001612 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
Tejun Heoe22bee72010-06-29 10:07:14 +02001614 while (true) {
1615 /*
1616 * The following call may fail, succeed or succeed
1617 * without actually migrating the task to the cpu if
1618 * it races with cpu hotunplug operation. Verify
Tejun Heo24647572013-01-24 11:01:33 -08001619 * against POOL_DISASSOCIATED.
Tejun Heoe22bee72010-06-29 10:07:14 +02001620 */
Tejun Heo24647572013-01-24 11:01:33 -08001621 if (!(pool->flags & POOL_DISASSOCIATED))
Tejun Heof3421792010-07-02 10:03:51 +02001622 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001623
Tejun Heoe22bee72010-06-29 10:07:14 +02001624 spin_lock_irq(&gcwq->lock);
Tejun Heo24647572013-01-24 11:01:33 -08001625 if (pool->flags & POOL_DISASSOCIATED)
Tejun Heoe22bee72010-06-29 10:07:14 +02001626 return false;
1627 if (task_cpu(task) == gcwq->cpu &&
1628 cpumask_equal(&current->cpus_allowed,
1629 get_cpu_mask(gcwq->cpu)))
1630 return true;
1631 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001632
Tejun Heo5035b202011-04-29 18:08:37 +02001633 /*
1634 * We've raced with CPU hot[un]plug. Give it a breather
1635 * and retry migration. cond_resched() is required here;
1636 * otherwise, we might deadlock against cpu_stop trying to
1637 * bring down the CPU on non-preemptive kernel.
1638 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001639 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001640 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001641 }
1642}
1643
1644/*
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001645 * Rebind an idle @worker to its CPU. worker_thread() will test
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001646 * list_empty(@worker->entry) before leaving idle and call this function.
Tejun Heo25511a42012-07-17 12:39:27 -07001647 */
1648static void idle_worker_rebind(struct worker *worker)
1649{
1650 struct global_cwq *gcwq = worker->pool->gcwq;
1651
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001652 /* CPU may go down again inbetween, clear UNBOUND only on success */
1653 if (worker_maybe_bind_and_lock(worker))
1654 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heo25511a42012-07-17 12:39:27 -07001655
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001656 /* rebind complete, become available again */
1657 list_add(&worker->entry, &worker->pool->idle_list);
1658 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07001659}
1660
1661/*
1662 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001663 * the associated cpu which is coming back online. This is scheduled by
1664 * cpu up but can race with other cpu hotplug operations and may be
1665 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001666 */
Tejun Heo25511a42012-07-17 12:39:27 -07001667static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001668{
1669 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001670 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001671
Lai Jiangshaneab6d822012-09-18 09:59:22 -07001672 if (worker_maybe_bind_and_lock(worker))
1673 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02001674
1675 spin_unlock_irq(&gcwq->lock);
1676}
1677
Tejun Heo25511a42012-07-17 12:39:27 -07001678/**
1679 * rebind_workers - rebind all workers of a gcwq to the associated CPU
1680 * @gcwq: gcwq of interest
1681 *
1682 * @gcwq->cpu is coming online. Rebind all workers to the CPU. Rebinding
1683 * is different for idle and busy ones.
1684 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001685 * Idle ones will be removed from the idle_list and woken up. They will
1686 * add themselves back after completing rebind. This ensures that the
1687 * idle_list doesn't contain any unbound workers when re-bound busy workers
1688 * try to perform local wake-ups for concurrency management.
Tejun Heo25511a42012-07-17 12:39:27 -07001689 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001690 * Busy workers can rebind after they finish their current work items.
1691 * Queueing the rebind work item at the head of the scheduled list is
1692 * enough. Note that nr_running will be properly bumped as busy workers
1693 * rebind.
Tejun Heo25511a42012-07-17 12:39:27 -07001694 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001695 * On return, all non-manager workers are scheduled for rebind - see
1696 * manage_workers() for the manager special case. Any idle worker
1697 * including the manager will not appear on @idle_list until rebind is
1698 * complete, making local wake-ups safe.
Tejun Heo25511a42012-07-17 12:39:27 -07001699 */
1700static void rebind_workers(struct global_cwq *gcwq)
Tejun Heo25511a42012-07-17 12:39:27 -07001701{
Tejun Heo25511a42012-07-17 12:39:27 -07001702 struct worker_pool *pool;
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001703 struct worker *worker, *n;
Tejun Heo25511a42012-07-17 12:39:27 -07001704 struct hlist_node *pos;
1705 int i;
1706
1707 lockdep_assert_held(&gcwq->lock);
1708
1709 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07001710 lockdep_assert_held(&pool->assoc_mutex);
Tejun Heo25511a42012-07-17 12:39:27 -07001711
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001712 /* dequeue and kick idle ones */
Tejun Heo25511a42012-07-17 12:39:27 -07001713 for_each_worker_pool(pool, gcwq) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001714 list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001715 /*
1716 * idle workers should be off @pool->idle_list
1717 * until rebind is complete to avoid receiving
1718 * premature local wake-ups.
1719 */
1720 list_del_init(&worker->entry);
Lai Jiangshan96e65302012-09-02 00:28:19 +08001721
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001722 /*
1723 * worker_thread() will see the above dequeuing
1724 * and call idle_worker_rebind().
1725 */
Tejun Heo25511a42012-07-17 12:39:27 -07001726 wake_up_process(worker->task);
1727 }
Tejun Heo25511a42012-07-17 12:39:27 -07001728
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001729 /* rebind busy workers */
1730 for_each_busy_worker(worker, i, pos, pool) {
1731 struct work_struct *rebind_work = &worker->rebind_work;
1732 struct workqueue_struct *wq;
Tejun Heo25511a42012-07-17 12:39:27 -07001733
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001734 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1735 work_data_bits(rebind_work)))
1736 continue;
Tejun Heo25511a42012-07-17 12:39:27 -07001737
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001738 debug_work_activate(rebind_work);
Tejun Heo90beca52012-09-04 23:12:33 -07001739
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001740 /*
1741 * wq doesn't really matter but let's keep
1742 * @worker->pool and @cwq->pool consistent for
1743 * sanity.
1744 */
1745 if (std_worker_pool_pri(worker->pool))
1746 wq = system_highpri_wq;
1747 else
1748 wq = system_wq;
Tejun Heoec588152012-09-04 23:16:32 -07001749
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001750 insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
1751 worker->scheduled.next,
1752 work_color_to_flags(WORK_NO_COLOR));
1753 }
Tejun Heoec588152012-09-04 23:16:32 -07001754 }
Tejun Heo25511a42012-07-17 12:39:27 -07001755}
1756
Tejun Heoc34056a2010-06-29 10:07:11 +02001757static struct worker *alloc_worker(void)
1758{
1759 struct worker *worker;
1760
1761 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001762 if (worker) {
1763 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001764 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001765 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001766 /* on creation a worker is in !idle && prep state */
1767 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001768 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001769 return worker;
1770}
1771
1772/**
1773 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001774 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001775 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001776 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001777 * can be started by calling start_worker() or destroyed using
1778 * destroy_worker().
1779 *
1780 * CONTEXT:
1781 * Might sleep. Does GFP_KERNEL allocations.
1782 *
1783 * RETURNS:
1784 * Pointer to the newly created worker.
1785 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001786static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001787{
Tejun Heo63d95a92012-07-12 14:46:37 -07001788 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe34cdddb2013-01-24 11:01:33 -08001789 const char *pri = std_worker_pool_pri(pool) ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001790 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001791 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001792
Tejun Heo8b03ae32010-06-29 10:07:12 +02001793 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001794 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001795 spin_unlock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001796 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001797 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001798 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001799 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001800 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001801
1802 worker = alloc_worker();
1803 if (!worker)
1804 goto fail;
1805
Tejun Heobd7bdd42012-07-12 14:46:37 -07001806 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001807 worker->id = id;
1808
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001809 if (gcwq->cpu != WORK_CPU_UNBOUND)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001810 worker->task = kthread_create_on_node(worker_thread,
Tejun Heo32704762012-07-13 22:16:45 -07001811 worker, cpu_to_node(gcwq->cpu),
1812 "kworker/%u:%d%s", gcwq->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001813 else
1814 worker->task = kthread_create(worker_thread, worker,
Tejun Heo32704762012-07-13 22:16:45 -07001815 "kworker/u:%d%s", id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001816 if (IS_ERR(worker->task))
1817 goto fail;
1818
Tejun Heoe34cdddb2013-01-24 11:01:33 -08001819 if (std_worker_pool_pri(pool))
Tejun Heo32704762012-07-13 22:16:45 -07001820 set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
1821
Tejun Heodb7bccf2010-06-29 10:07:12 +02001822 /*
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001823 * Determine CPU binding of the new worker depending on
Tejun Heo24647572013-01-24 11:01:33 -08001824 * %POOL_DISASSOCIATED. The caller is responsible for ensuring the
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001825 * flag remains stable across this function. See the comments
1826 * above the flag definition for details.
1827 *
1828 * As an unbound worker may later become a regular one if CPU comes
1829 * online, make sure every worker has %PF_THREAD_BOUND set.
Tejun Heodb7bccf2010-06-29 10:07:12 +02001830 */
Tejun Heo24647572013-01-24 11:01:33 -08001831 if (!(pool->flags & POOL_DISASSOCIATED)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001832 kthread_bind(worker->task, gcwq->cpu);
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001833 } else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001834 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001835 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001837
Tejun Heoc34056a2010-06-29 10:07:11 +02001838 return worker;
1839fail:
1840 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001841 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001842 ida_remove(&pool->worker_ida, id);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001843 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001844 }
1845 kfree(worker);
1846 return NULL;
1847}
1848
1849/**
1850 * start_worker - start a newly created worker
1851 * @worker: worker to start
1852 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001853 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001854 *
1855 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001856 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001857 */
1858static void start_worker(struct worker *worker)
1859{
Tejun Heocb444762010-07-02 10:03:50 +02001860 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001861 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001862 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001863 wake_up_process(worker->task);
1864}
1865
1866/**
1867 * destroy_worker - destroy a workqueue worker
1868 * @worker: worker to be destroyed
1869 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001870 * Destroy @worker and adjust @gcwq stats accordingly.
1871 *
1872 * CONTEXT:
1873 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001874 */
1875static void destroy_worker(struct worker *worker)
1876{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001877 struct worker_pool *pool = worker->pool;
1878 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001879 int id = worker->id;
1880
1881 /* sanity check frenzy */
1882 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001883 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001884
Tejun Heoc8e55f32010-06-29 10:07:12 +02001885 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001886 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001887 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001888 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001889
1890 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001891 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001892
1893 spin_unlock_irq(&gcwq->lock);
1894
Tejun Heoc34056a2010-06-29 10:07:11 +02001895 kthread_stop(worker->task);
1896 kfree(worker);
1897
Tejun Heo8b03ae32010-06-29 10:07:12 +02001898 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001899 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001900}
1901
Tejun Heo63d95a92012-07-12 14:46:37 -07001902static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001903{
Tejun Heo63d95a92012-07-12 14:46:37 -07001904 struct worker_pool *pool = (void *)__pool;
1905 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001906
1907 spin_lock_irq(&gcwq->lock);
1908
Tejun Heo63d95a92012-07-12 14:46:37 -07001909 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001910 struct worker *worker;
1911 unsigned long expires;
1912
1913 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001914 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001915 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1916
1917 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001918 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001919 else {
1920 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001921 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001922 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001923 }
1924 }
1925
1926 spin_unlock_irq(&gcwq->lock);
1927}
1928
1929static bool send_mayday(struct work_struct *work)
1930{
1931 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1932 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001933 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001934
1935 if (!(wq->flags & WQ_RESCUER))
1936 return false;
1937
1938 /* mayday mayday mayday */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001939 cpu = cwq->pool->gcwq->cpu;
Tejun Heof3421792010-07-02 10:03:51 +02001940 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1941 if (cpu == WORK_CPU_UNBOUND)
1942 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001943 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001944 wake_up_process(wq->rescuer->task);
1945 return true;
1946}
1947
Tejun Heo63d95a92012-07-12 14:46:37 -07001948static void gcwq_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001949{
Tejun Heo63d95a92012-07-12 14:46:37 -07001950 struct worker_pool *pool = (void *)__pool;
1951 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001952 struct work_struct *work;
1953
1954 spin_lock_irq(&gcwq->lock);
1955
Tejun Heo63d95a92012-07-12 14:46:37 -07001956 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001957 /*
1958 * We've been trying to create a new worker but
1959 * haven't been successful. We might be hitting an
1960 * allocation deadlock. Send distress signals to
1961 * rescuers.
1962 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001963 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001964 send_mayday(work);
1965 }
1966
1967 spin_unlock_irq(&gcwq->lock);
1968
Tejun Heo63d95a92012-07-12 14:46:37 -07001969 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001970}
1971
1972/**
1973 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001974 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001975 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001976 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001977 * have at least one idle worker on return from this function. If
1978 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001979 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001980 * possible allocation deadlock.
1981 *
1982 * On return, need_to_create_worker() is guaranteed to be false and
1983 * may_start_working() true.
1984 *
1985 * LOCKING:
1986 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1987 * multiple times. Does GFP_KERNEL allocations. Called only from
1988 * manager.
1989 *
1990 * RETURNS:
1991 * false if no action was taken and gcwq->lock stayed locked, true
1992 * otherwise.
1993 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001994static bool maybe_create_worker(struct worker_pool *pool)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001995__releases(&gcwq->lock)
1996__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001997{
Tejun Heo63d95a92012-07-12 14:46:37 -07001998 struct global_cwq *gcwq = pool->gcwq;
1999
2000 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002001 return false;
2002restart:
Tejun Heo9f9c2362010-07-14 11:31:20 +02002003 spin_unlock_irq(&gcwq->lock);
2004
Tejun Heoe22bee72010-06-29 10:07:14 +02002005 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07002006 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02002007
2008 while (true) {
2009 struct worker *worker;
2010
Tejun Heobc2ae0f2012-07-17 12:39:27 -07002011 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002012 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002013 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002014 spin_lock_irq(&gcwq->lock);
2015 start_worker(worker);
Tejun Heo63d95a92012-07-12 14:46:37 -07002016 BUG_ON(need_to_create_worker(pool));
Tejun Heoe22bee72010-06-29 10:07:14 +02002017 return true;
2018 }
2019
Tejun Heo63d95a92012-07-12 14:46:37 -07002020 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002021 break;
2022
Tejun Heoe22bee72010-06-29 10:07:14 +02002023 __set_current_state(TASK_INTERRUPTIBLE);
2024 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02002025
Tejun Heo63d95a92012-07-12 14:46:37 -07002026 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002027 break;
2028 }
2029
Tejun Heo63d95a92012-07-12 14:46:37 -07002030 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02002031 spin_lock_irq(&gcwq->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07002032 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002033 goto restart;
2034 return true;
2035}
2036
2037/**
2038 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07002039 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02002040 *
Tejun Heo63d95a92012-07-12 14:46:37 -07002041 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02002042 * IDLE_WORKER_TIMEOUT.
2043 *
2044 * LOCKING:
2045 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2046 * multiple times. Called only from manager.
2047 *
2048 * RETURNS:
2049 * false if no action was taken and gcwq->lock stayed locked, true
2050 * otherwise.
2051 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002052static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02002053{
2054 bool ret = false;
2055
Tejun Heo63d95a92012-07-12 14:46:37 -07002056 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002057 struct worker *worker;
2058 unsigned long expires;
2059
Tejun Heo63d95a92012-07-12 14:46:37 -07002060 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002061 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2062
2063 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002064 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02002065 break;
2066 }
2067
2068 destroy_worker(worker);
2069 ret = true;
2070 }
2071
2072 return ret;
2073}
2074
2075/**
2076 * manage_workers - manage worker pool
2077 * @worker: self
2078 *
2079 * Assume the manager role and manage gcwq worker pool @worker belongs
2080 * to. At any given time, there can be only zero or one manager per
2081 * gcwq. The exclusion is handled automatically by this function.
2082 *
2083 * The caller can safely start processing works on false return. On
2084 * true return, it's guaranteed that need_to_create_worker() is false
2085 * and may_start_working() is true.
2086 *
2087 * CONTEXT:
2088 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2089 * multiple times. Does GFP_KERNEL allocations.
2090 *
2091 * RETURNS:
2092 * false if no action was taken and gcwq->lock stayed locked, true if
2093 * some action was taken.
2094 */
2095static bool manage_workers(struct worker *worker)
2096{
Tejun Heo63d95a92012-07-12 14:46:37 -07002097 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002098 bool ret = false;
2099
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002100 if (pool->flags & POOL_MANAGING_WORKERS)
Tejun Heoe22bee72010-06-29 10:07:14 +02002101 return ret;
2102
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002103 pool->flags |= POOL_MANAGING_WORKERS;
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002104
2105 /*
2106 * To simplify both worker management and CPU hotplug, hold off
2107 * management while hotplug is in progress. CPU hotplug path can't
2108 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2109 * lead to idle worker depletion (all become busy thinking someone
2110 * else is managing) which in turn can result in deadlock under
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002111 * extreme circumstances. Use @pool->assoc_mutex to synchronize
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002112 * manager against CPU hotplug.
2113 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002114 * assoc_mutex would always be free unless CPU hotplug is in
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002115 * progress. trylock first without dropping @gcwq->lock.
2116 */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002117 if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002118 spin_unlock_irq(&pool->gcwq->lock);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002119 mutex_lock(&pool->assoc_mutex);
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002120 /*
2121 * CPU hotplug could have happened while we were waiting
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002122 * for assoc_mutex. Hotplug itself can't handle us
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002123 * because manager isn't either on idle or busy list, and
2124 * @gcwq's state and ours could have deviated.
2125 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002126 * As hotplug is now excluded via assoc_mutex, we can
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002127 * simply try to bind. It will succeed or fail depending
2128 * on @gcwq's current state. Try it and adjust
2129 * %WORKER_UNBOUND accordingly.
2130 */
2131 if (worker_maybe_bind_and_lock(worker))
2132 worker->flags &= ~WORKER_UNBOUND;
2133 else
2134 worker->flags |= WORKER_UNBOUND;
2135
2136 ret = true;
2137 }
2138
Tejun Heo11ebea52012-07-12 14:46:37 -07002139 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002140
2141 /*
2142 * Destroy and then create so that may_start_working() is true
2143 * on return.
2144 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002145 ret |= maybe_destroy_workers(pool);
2146 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002147
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002148 pool->flags &= ~POOL_MANAGING_WORKERS;
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002149 mutex_unlock(&pool->assoc_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02002150 return ret;
2151}
2152
Tejun Heoa62428c2010-06-29 10:07:10 +02002153/**
2154 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002155 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002156 * @work: work to process
2157 *
2158 * Process @work. This function contains all the logics necessary to
2159 * process a single work including synchronization against and
2160 * interaction with other workers on the same cpu, queueing and
2161 * flushing. As long as context requirement is met, any worker can
2162 * call this function to process a work.
2163 *
2164 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002165 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002166 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002167static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09002168__releases(&gcwq->lock)
2169__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002170{
Tejun Heo7e116292010-06-29 10:07:13 +02002171 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002172 struct worker_pool *pool = worker->pool;
2173 struct global_cwq *gcwq = pool->gcwq;
Tejun Heofb0e7be2010-06-29 10:07:15 +02002174 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002175 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002176 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002177#ifdef CONFIG_LOCKDEP
2178 /*
2179 * It is permissible to free the struct work_struct from
2180 * inside the function that is called from it, this we need to
2181 * take into account for lockdep too. To avoid bogus "held
2182 * lock freed" warnings as well as problems when looking into
2183 * work->lockdep_map, make a copy and use that here.
2184 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002185 struct lockdep_map lockdep_map;
2186
2187 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002188#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002189 /*
2190 * Ensure we're on the correct CPU. DISASSOCIATED test is
2191 * necessary to avoid spurious warnings from rescuers servicing the
Tejun Heo24647572013-01-24 11:01:33 -08002192 * unbound or a disassociated pool.
Tejun Heo6fec10a2012-07-22 10:16:34 -07002193 */
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002194 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
Tejun Heo24647572013-01-24 11:01:33 -08002195 !(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heo25511a42012-07-17 12:39:27 -07002196 raw_smp_processor_id() != gcwq->cpu);
2197
Tejun Heo7e116292010-06-29 10:07:13 +02002198 /*
2199 * A single work shouldn't be executed concurrently by
2200 * multiple workers on a single cpu. Check whether anyone is
2201 * already processing the work. If so, defer the work to the
2202 * currently executing one.
2203 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002204 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002205 if (unlikely(collision)) {
2206 move_linked_works(work, &collision->scheduled, NULL);
2207 return;
2208 }
2209
Tejun Heo8930cab2012-08-03 10:30:45 -07002210 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002211 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002212 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002213 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002214 worker->current_func = work->func;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002215 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002216 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002217
Tejun Heoa62428c2010-06-29 10:07:10 +02002218 list_del_init(&work->entry);
2219
Tejun Heo649027d2010-06-29 10:07:14 +02002220 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002221 * CPU intensive works don't participate in concurrency
2222 * management. They're the scheduler's responsibility.
2223 */
2224 if (unlikely(cpu_intensive))
2225 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2226
Tejun Heo974271c2012-07-12 14:46:37 -07002227 /*
2228 * Unbound gcwq isn't concurrency managed and work items should be
2229 * executed ASAP. Wake up another worker if necessary.
2230 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002231 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2232 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002233
Tejun Heo8930cab2012-08-03 10:30:45 -07002234 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002235 * Record the last pool and clear PENDING which should be the last
Tejun Heo23657bb2012-08-13 17:08:19 -07002236 * update to @work. Also, do this inside @gcwq->lock so that
2237 * PENDING and queued state changes happen together while IRQ is
2238 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002239 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002240 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002241
Tejun Heoa62428c2010-06-29 10:07:10 +02002242 spin_unlock_irq(&gcwq->lock);
2243
Tejun Heoe1594892011-01-09 23:32:15 +01002244 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002245 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002246 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002247 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002248 /*
2249 * While we must be careful to not use "work" after this, the trace
2250 * point will only record its address.
2251 */
2252 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002253 lock_map_release(&lockdep_map);
2254 lock_map_release(&cwq->wq->lockdep_map);
2255
2256 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002257 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2258 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002259 current->comm, preempt_count(), task_pid_nr(current),
2260 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002261 debug_show_held_locks(current);
2262 dump_stack();
2263 }
2264
Tejun Heo8b03ae32010-06-29 10:07:12 +02002265 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002266
Tejun Heofb0e7be2010-06-29 10:07:15 +02002267 /* clear cpu intensive status */
2268 if (unlikely(cpu_intensive))
2269 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2270
Tejun Heoa62428c2010-06-29 10:07:10 +02002271 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002272 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002273 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002274 worker->current_func = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002275 worker->current_cwq = NULL;
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07002276 cwq_dec_nr_in_flight(cwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002277}
2278
Tejun Heoaffee4b2010-06-29 10:07:12 +02002279/**
2280 * process_scheduled_works - process scheduled works
2281 * @worker: self
2282 *
2283 * Process all scheduled works. Please note that the scheduled list
2284 * may change while processing a work, so this function repeatedly
2285 * fetches a work from the top and executes it.
2286 *
2287 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002288 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002289 * multiple times.
2290 */
2291static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002293 while (!list_empty(&worker->scheduled)) {
2294 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002296 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298}
2299
Tejun Heo4690c4a2010-06-29 10:07:10 +02002300/**
2301 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002302 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002303 *
Tejun Heoe22bee72010-06-29 10:07:14 +02002304 * The gcwq worker thread function. There's a single dynamic pool of
2305 * these per each cpu. These workers process all works regardless of
2306 * their specific target workqueue. The only exception is works which
2307 * belong to workqueues with a rescuer which will be explained in
2308 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002309 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002310static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311{
Tejun Heoc34056a2010-06-29 10:07:11 +02002312 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002313 struct worker_pool *pool = worker->pool;
2314 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315
Tejun Heoe22bee72010-06-29 10:07:14 +02002316 /* tell the scheduler that this is a workqueue worker */
2317 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002318woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002319 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002321 /* we are off idle list if destruction or rebind is requested */
2322 if (unlikely(list_empty(&worker->entry))) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002323 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002324
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002325 /* if DIE is set, destruction is requested */
Tejun Heo25511a42012-07-17 12:39:27 -07002326 if (worker->flags & WORKER_DIE) {
2327 worker->task->flags &= ~PF_WQ_WORKER;
2328 return 0;
2329 }
2330
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002331 /* otherwise, rebind */
Tejun Heo25511a42012-07-17 12:39:27 -07002332 idle_worker_rebind(worker);
2333 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 }
2335
Tejun Heoc8e55f32010-06-29 10:07:12 +02002336 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002337recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002338 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002339 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002340 goto sleep;
2341
2342 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002343 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002344 goto recheck;
2345
Tejun Heoc8e55f32010-06-29 10:07:12 +02002346 /*
2347 * ->scheduled list can only be filled while a worker is
2348 * preparing to process a work or actually processing it.
2349 * Make sure nobody diddled with it while I was sleeping.
2350 */
2351 BUG_ON(!list_empty(&worker->scheduled));
2352
Tejun Heoe22bee72010-06-29 10:07:14 +02002353 /*
2354 * When control reaches this point, we're guaranteed to have
2355 * at least one idle worker or that someone else has already
2356 * assumed the manager role.
2357 */
2358 worker_clr_flags(worker, WORKER_PREP);
2359
2360 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002361 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002362 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002363 struct work_struct, entry);
2364
2365 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2366 /* optimization path, not strictly necessary */
2367 process_one_work(worker, work);
2368 if (unlikely(!list_empty(&worker->scheduled)))
2369 process_scheduled_works(worker);
2370 } else {
2371 move_linked_works(work, &worker->scheduled, NULL);
2372 process_scheduled_works(worker);
2373 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002374 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002375
Tejun Heoe22bee72010-06-29 10:07:14 +02002376 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002377sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002378 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002379 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002380
Tejun Heoc8e55f32010-06-29 10:07:12 +02002381 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02002382 * gcwq->lock is held and there's no work to process and no
2383 * need to manage, sleep. Workers are woken up only while
2384 * holding gcwq->lock or from local cpu, so setting the
2385 * current state before releasing gcwq->lock is enough to
2386 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002387 */
2388 worker_enter_idle(worker);
2389 __set_current_state(TASK_INTERRUPTIBLE);
2390 spin_unlock_irq(&gcwq->lock);
2391 schedule();
2392 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393}
2394
Tejun Heoe22bee72010-06-29 10:07:14 +02002395/**
2396 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002397 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002398 *
2399 * Workqueue rescuer thread function. There's one rescuer for each
2400 * workqueue which has WQ_RESCUER set.
2401 *
2402 * Regular work processing on a gcwq may block trying to create a new
2403 * worker which uses GFP_KERNEL allocation which has slight chance of
2404 * developing into deadlock if some works currently on the same queue
2405 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2406 * the problem rescuer solves.
2407 *
2408 * When such condition is possible, the gcwq summons rescuers of all
2409 * workqueues which have works queued on the gcwq and let them process
2410 * those works so that forward progress can be guaranteed.
2411 *
2412 * This should happen rarely.
2413 */
Tejun Heo111c2252013-01-17 17:16:24 -08002414static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002415{
Tejun Heo111c2252013-01-17 17:16:24 -08002416 struct worker *rescuer = __rescuer;
2417 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002418 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002419 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002420 unsigned int cpu;
2421
2422 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002423
2424 /*
2425 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2426 * doesn't participate in concurrency management.
2427 */
2428 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002429repeat:
2430 set_current_state(TASK_INTERRUPTIBLE);
2431
Mike Galbraith412d32e2012-11-28 07:17:18 +01002432 if (kthread_should_stop()) {
2433 __set_current_state(TASK_RUNNING);
Tejun Heo111c2252013-01-17 17:16:24 -08002434 rescuer->task->flags &= ~PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002435 return 0;
Mike Galbraith412d32e2012-11-28 07:17:18 +01002436 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002437
Tejun Heof3421792010-07-02 10:03:51 +02002438 /*
2439 * See whether any cpu is asking for help. Unbounded
2440 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2441 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002442 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002443 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2444 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002445 struct worker_pool *pool = cwq->pool;
2446 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002447 struct work_struct *work, *n;
2448
2449 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002450 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002451
2452 /* migrate to the target cpu if possible */
Tejun Heobd7bdd42012-07-12 14:46:37 -07002453 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002454 worker_maybe_bind_and_lock(rescuer);
2455
2456 /*
2457 * Slurp in all works issued via this workqueue and
2458 * process'em.
2459 */
2460 BUG_ON(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002461 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002462 if (get_work_cwq(work) == cwq)
2463 move_linked_works(work, scheduled, &n);
2464
2465 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002466
2467 /*
2468 * Leave this gcwq. If keep_working() is %true, notify a
2469 * regular worker; otherwise, we end up with 0 concurrency
2470 * and stalling the execution.
2471 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002472 if (keep_working(pool))
2473 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002474
Tejun Heoe22bee72010-06-29 10:07:14 +02002475 spin_unlock_irq(&gcwq->lock);
2476 }
2477
Tejun Heo111c2252013-01-17 17:16:24 -08002478 /* rescuers should never participate in concurrency management */
2479 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002480 schedule();
2481 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482}
2483
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002484struct wq_barrier {
2485 struct work_struct work;
2486 struct completion done;
2487};
2488
2489static void wq_barrier_func(struct work_struct *work)
2490{
2491 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2492 complete(&barr->done);
2493}
2494
Tejun Heo4690c4a2010-06-29 10:07:10 +02002495/**
2496 * insert_wq_barrier - insert a barrier work
2497 * @cwq: cwq to insert barrier into
2498 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002499 * @target: target work to attach @barr to
2500 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002501 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002502 * @barr is linked to @target such that @barr is completed only after
2503 * @target finishes execution. Please note that the ordering
2504 * guarantee is observed only with respect to @target and on the local
2505 * cpu.
2506 *
2507 * Currently, a queued barrier can't be canceled. This is because
2508 * try_to_grab_pending() can't determine whether the work to be
2509 * grabbed is at the head of the queue and thus can't clear LINKED
2510 * flag of the previous work while there must be a valid next work
2511 * after a work with LINKED flag set.
2512 *
2513 * Note that when @worker is non-NULL, @target may be modified
2514 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002515 *
2516 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002517 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002518 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002519static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002520 struct wq_barrier *barr,
2521 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002522{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002523 struct list_head *head;
2524 unsigned int linked = 0;
2525
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002526 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002527 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002528 * as we know for sure that this will not trigger any of the
2529 * checks and call back into the fixup functions where we
2530 * might deadlock.
2531 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002532 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002533 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002534 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002535
Tejun Heoaffee4b2010-06-29 10:07:12 +02002536 /*
2537 * If @target is currently being executed, schedule the
2538 * barrier to the worker; otherwise, put it after @target.
2539 */
2540 if (worker)
2541 head = worker->scheduled.next;
2542 else {
2543 unsigned long *bits = work_data_bits(target);
2544
2545 head = target->entry.next;
2546 /* there can already be other linked works, inherit and set */
2547 linked = *bits & WORK_STRUCT_LINKED;
2548 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2549 }
2550
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002551 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002552 insert_work(cwq, &barr->work, head,
2553 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002554}
2555
Tejun Heo73f53c42010-06-29 10:07:11 +02002556/**
2557 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2558 * @wq: workqueue being flushed
2559 * @flush_color: new flush color, < 0 for no-op
2560 * @work_color: new work color, < 0 for no-op
2561 *
2562 * Prepare cwqs for workqueue flushing.
2563 *
2564 * If @flush_color is non-negative, flush_color on all cwqs should be
2565 * -1. If no cwq has in-flight commands at the specified color, all
2566 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2567 * has in flight commands, its cwq->flush_color is set to
2568 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2569 * wakeup logic is armed and %true is returned.
2570 *
2571 * The caller should have initialized @wq->first_flusher prior to
2572 * calling this function with non-negative @flush_color. If
2573 * @flush_color is negative, no flush color update is done and %false
2574 * is returned.
2575 *
2576 * If @work_color is non-negative, all cwqs should have the same
2577 * work_color which is previous to @work_color and all will be
2578 * advanced to @work_color.
2579 *
2580 * CONTEXT:
2581 * mutex_lock(wq->flush_mutex).
2582 *
2583 * RETURNS:
2584 * %true if @flush_color >= 0 and there's something to flush. %false
2585 * otherwise.
2586 */
2587static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2588 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002589{
Tejun Heo73f53c42010-06-29 10:07:11 +02002590 bool wait = false;
2591 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002592
Tejun Heo73f53c42010-06-29 10:07:11 +02002593 if (flush_color >= 0) {
2594 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2595 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002596 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002597
Tejun Heof3421792010-07-02 10:03:51 +02002598 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002599 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002600 struct global_cwq *gcwq = cwq->pool->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002601
Tejun Heo8b03ae32010-06-29 10:07:12 +02002602 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002603
2604 if (flush_color >= 0) {
2605 BUG_ON(cwq->flush_color != -1);
2606
2607 if (cwq->nr_in_flight[flush_color]) {
2608 cwq->flush_color = flush_color;
2609 atomic_inc(&wq->nr_cwqs_to_flush);
2610 wait = true;
2611 }
2612 }
2613
2614 if (work_color >= 0) {
2615 BUG_ON(work_color != work_next_color(cwq->work_color));
2616 cwq->work_color = work_color;
2617 }
2618
Tejun Heo8b03ae32010-06-29 10:07:12 +02002619 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002620 }
2621
2622 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2623 complete(&wq->first_flusher->done);
2624
2625 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626}
2627
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002628/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002630 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631 *
2632 * Forces execution of the workqueue and blocks until its completion.
2633 * This is typically used in driver shutdown handlers.
2634 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002635 * We sleep until all works which were queued on entry have been handled,
2636 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002637 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002638void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639{
Tejun Heo73f53c42010-06-29 10:07:11 +02002640 struct wq_flusher this_flusher = {
2641 .list = LIST_HEAD_INIT(this_flusher.list),
2642 .flush_color = -1,
2643 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2644 };
2645 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002646
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002647 lock_map_acquire(&wq->lockdep_map);
2648 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002649
2650 mutex_lock(&wq->flush_mutex);
2651
2652 /*
2653 * Start-to-wait phase
2654 */
2655 next_color = work_next_color(wq->work_color);
2656
2657 if (next_color != wq->flush_color) {
2658 /*
2659 * Color space is not full. The current work_color
2660 * becomes our flush_color and work_color is advanced
2661 * by one.
2662 */
2663 BUG_ON(!list_empty(&wq->flusher_overflow));
2664 this_flusher.flush_color = wq->work_color;
2665 wq->work_color = next_color;
2666
2667 if (!wq->first_flusher) {
2668 /* no flush in progress, become the first flusher */
2669 BUG_ON(wq->flush_color != this_flusher.flush_color);
2670
2671 wq->first_flusher = &this_flusher;
2672
2673 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2674 wq->work_color)) {
2675 /* nothing to flush, done */
2676 wq->flush_color = next_color;
2677 wq->first_flusher = NULL;
2678 goto out_unlock;
2679 }
2680 } else {
2681 /* wait in queue */
2682 BUG_ON(wq->flush_color == this_flusher.flush_color);
2683 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2684 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2685 }
2686 } else {
2687 /*
2688 * Oops, color space is full, wait on overflow queue.
2689 * The next flush completion will assign us
2690 * flush_color and transfer to flusher_queue.
2691 */
2692 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2693 }
2694
2695 mutex_unlock(&wq->flush_mutex);
2696
2697 wait_for_completion(&this_flusher.done);
2698
2699 /*
2700 * Wake-up-and-cascade phase
2701 *
2702 * First flushers are responsible for cascading flushes and
2703 * handling overflow. Non-first flushers can simply return.
2704 */
2705 if (wq->first_flusher != &this_flusher)
2706 return;
2707
2708 mutex_lock(&wq->flush_mutex);
2709
Tejun Heo4ce48b32010-07-02 10:03:51 +02002710 /* we might have raced, check again with mutex held */
2711 if (wq->first_flusher != &this_flusher)
2712 goto out_unlock;
2713
Tejun Heo73f53c42010-06-29 10:07:11 +02002714 wq->first_flusher = NULL;
2715
2716 BUG_ON(!list_empty(&this_flusher.list));
2717 BUG_ON(wq->flush_color != this_flusher.flush_color);
2718
2719 while (true) {
2720 struct wq_flusher *next, *tmp;
2721
2722 /* complete all the flushers sharing the current flush color */
2723 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2724 if (next->flush_color != wq->flush_color)
2725 break;
2726 list_del_init(&next->list);
2727 complete(&next->done);
2728 }
2729
2730 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2731 wq->flush_color != work_next_color(wq->work_color));
2732
2733 /* this flush_color is finished, advance by one */
2734 wq->flush_color = work_next_color(wq->flush_color);
2735
2736 /* one color has been freed, handle overflow queue */
2737 if (!list_empty(&wq->flusher_overflow)) {
2738 /*
2739 * Assign the same color to all overflowed
2740 * flushers, advance work_color and append to
2741 * flusher_queue. This is the start-to-wait
2742 * phase for these overflowed flushers.
2743 */
2744 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2745 tmp->flush_color = wq->work_color;
2746
2747 wq->work_color = work_next_color(wq->work_color);
2748
2749 list_splice_tail_init(&wq->flusher_overflow,
2750 &wq->flusher_queue);
2751 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2752 }
2753
2754 if (list_empty(&wq->flusher_queue)) {
2755 BUG_ON(wq->flush_color != wq->work_color);
2756 break;
2757 }
2758
2759 /*
2760 * Need to flush more colors. Make the next flusher
2761 * the new first flusher and arm cwqs.
2762 */
2763 BUG_ON(wq->flush_color == wq->work_color);
2764 BUG_ON(wq->flush_color != next->flush_color);
2765
2766 list_del_init(&next->list);
2767 wq->first_flusher = next;
2768
2769 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2770 break;
2771
2772 /*
2773 * Meh... this color is already done, clear first
2774 * flusher and repeat cascading.
2775 */
2776 wq->first_flusher = NULL;
2777 }
2778
2779out_unlock:
2780 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781}
Dave Jonesae90dd52006-06-30 01:40:45 -04002782EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002784/**
2785 * drain_workqueue - drain a workqueue
2786 * @wq: workqueue to drain
2787 *
2788 * Wait until the workqueue becomes empty. While draining is in progress,
2789 * only chain queueing is allowed. IOW, only currently pending or running
2790 * work items on @wq can queue further work items on it. @wq is flushed
2791 * repeatedly until it becomes empty. The number of flushing is detemined
2792 * by the depth of chaining and should be relatively short. Whine if it
2793 * takes too long.
2794 */
2795void drain_workqueue(struct workqueue_struct *wq)
2796{
2797 unsigned int flush_cnt = 0;
2798 unsigned int cpu;
2799
2800 /*
2801 * __queue_work() needs to test whether there are drainers, is much
2802 * hotter than drain_workqueue() and already looks at @wq->flags.
2803 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2804 */
2805 spin_lock(&workqueue_lock);
2806 if (!wq->nr_drainers++)
2807 wq->flags |= WQ_DRAINING;
2808 spin_unlock(&workqueue_lock);
2809reflush:
2810 flush_workqueue(wq);
2811
2812 for_each_cwq_cpu(cpu, wq) {
2813 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002814 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002815
Tejun Heobd7bdd42012-07-12 14:46:37 -07002816 spin_lock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002817 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002818 spin_unlock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002819
2820 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002821 continue;
2822
2823 if (++flush_cnt == 10 ||
2824 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Valentin Ilie044c7822012-08-19 00:52:42 +03002825 pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
2826 wq->name, flush_cnt);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002827 goto reflush;
2828 }
2829
2830 spin_lock(&workqueue_lock);
2831 if (!--wq->nr_drainers)
2832 wq->flags &= ~WQ_DRAINING;
2833 spin_unlock(&workqueue_lock);
2834}
2835EXPORT_SYMBOL_GPL(drain_workqueue);
2836
Tejun Heo606a5022012-08-20 14:51:23 -07002837static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002838{
2839 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002840 struct worker_pool *pool;
Tejun Heobaf59022010-09-16 10:42:16 +02002841 struct global_cwq *gcwq;
2842 struct cpu_workqueue_struct *cwq;
2843
2844 might_sleep();
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002845 pool = get_work_pool(work);
2846 if (!pool)
Tejun Heobaf59022010-09-16 10:42:16 +02002847 return false;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002848 gcwq = pool->gcwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002849
2850 spin_lock_irq(&gcwq->lock);
2851 if (!list_empty(&work->entry)) {
2852 /*
2853 * See the comment near try_to_grab_pending()->smp_rmb().
2854 * If it was re-queued to a different gcwq under us, we
2855 * are not going to wait.
2856 */
2857 smp_rmb();
2858 cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002859 if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
Tejun Heobaf59022010-09-16 10:42:16 +02002860 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002861 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002862 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002863 if (!worker)
2864 goto already_gone;
2865 cwq = worker->current_cwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002866 }
Tejun Heobaf59022010-09-16 10:42:16 +02002867
2868 insert_wq_barrier(cwq, barr, work, worker);
2869 spin_unlock_irq(&gcwq->lock);
2870
Tejun Heoe1594892011-01-09 23:32:15 +01002871 /*
2872 * If @max_active is 1 or rescuer is in use, flushing another work
2873 * item on the same workqueue may lead to deadlock. Make sure the
2874 * flusher is not running on the same workqueue by verifying write
2875 * access.
2876 */
2877 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2878 lock_map_acquire(&cwq->wq->lockdep_map);
2879 else
2880 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002881 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002882
Tejun Heobaf59022010-09-16 10:42:16 +02002883 return true;
2884already_gone:
2885 spin_unlock_irq(&gcwq->lock);
2886 return false;
2887}
2888
Oleg Nesterovdb700892008-07-25 01:47:49 -07002889/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002890 * flush_work - wait for a work to finish executing the last queueing instance
2891 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002892 *
Tejun Heo606a5022012-08-20 14:51:23 -07002893 * Wait until @work has finished execution. @work is guaranteed to be idle
2894 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002895 *
2896 * RETURNS:
2897 * %true if flush_work() waited for the work to finish execution,
2898 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002899 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002900bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002901{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002902 struct wq_barrier barr;
2903
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002904 lock_map_acquire(&work->lockdep_map);
2905 lock_map_release(&work->lockdep_map);
2906
Tejun Heo606a5022012-08-20 14:51:23 -07002907 if (start_flush_work(work, &barr)) {
Tejun Heobaf59022010-09-16 10:42:16 +02002908 wait_for_completion(&barr.done);
2909 destroy_work_on_stack(&barr.work);
2910 return true;
Tejun Heo606a5022012-08-20 14:51:23 -07002911 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002912 return false;
Tejun Heo606a5022012-08-20 14:51:23 -07002913 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002914}
2915EXPORT_SYMBOL_GPL(flush_work);
2916
Tejun Heo36e227d2012-08-03 10:30:46 -07002917static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002918{
Tejun Heobbb68df2012-08-03 10:30:46 -07002919 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002920 int ret;
2921
2922 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002923 ret = try_to_grab_pending(work, is_dwork, &flags);
2924 /*
2925 * If someone else is canceling, wait for the same event it
2926 * would be waiting for before retrying.
2927 */
2928 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002929 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002930 } while (unlikely(ret < 0));
2931
Tejun Heobbb68df2012-08-03 10:30:46 -07002932 /* tell other tasks trying to grab @work to back off */
2933 mark_work_canceling(work);
2934 local_irq_restore(flags);
2935
Tejun Heo606a5022012-08-20 14:51:23 -07002936 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002937 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002938 return ret;
2939}
2940
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002941/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002942 * cancel_work_sync - cancel a work and wait for it to finish
2943 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002944 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002945 * Cancel @work and wait for its execution to finish. This function
2946 * can be used even if the work re-queues itself or migrates to
2947 * another workqueue. On return from this function, @work is
2948 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002949 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002950 * cancel_work_sync(&delayed_work->work) must not be used for
2951 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002952 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002953 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002954 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002955 *
2956 * RETURNS:
2957 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002958 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002959bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002960{
Tejun Heo36e227d2012-08-03 10:30:46 -07002961 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002962}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002963EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002964
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002965/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002966 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2967 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002968 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002969 * Delayed timer is cancelled and the pending work is queued for
2970 * immediate execution. Like flush_work(), this function only
2971 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002972 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002973 * RETURNS:
2974 * %true if flush_work() waited for the work to finish execution,
2975 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002976 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002977bool flush_delayed_work(struct delayed_work *dwork)
2978{
Tejun Heo8930cab2012-08-03 10:30:45 -07002979 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002980 if (del_timer_sync(&dwork->timer))
Tejun Heo12650572012-08-08 09:38:42 -07002981 __queue_work(dwork->cpu,
Tejun Heo401a8d02010-09-16 10:36:00 +02002982 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002983 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002984 return flush_work(&dwork->work);
2985}
2986EXPORT_SYMBOL(flush_delayed_work);
2987
2988/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002989 * cancel_delayed_work - cancel a delayed work
2990 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002991 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002992 * Kill off a pending delayed_work. Returns %true if @dwork was pending
2993 * and canceled; %false if wasn't pending. Note that the work callback
2994 * function may still be running on return, unless it returns %true and the
2995 * work doesn't re-arm itself. Explicitly flush or use
2996 * cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002997 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002998 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002999 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07003000bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02003001{
Tejun Heo57b30ae2012-08-21 13:18:24 -07003002 unsigned long flags;
3003 int ret;
3004
3005 do {
3006 ret = try_to_grab_pending(&dwork->work, true, &flags);
3007 } while (unlikely(ret == -EAGAIN));
3008
3009 if (unlikely(ret < 0))
3010 return false;
3011
Tejun Heo7c3eed52013-01-24 11:01:33 -08003012 set_work_pool_and_clear_pending(&dwork->work,
3013 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07003014 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07003015 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02003016}
Tejun Heo57b30ae2012-08-21 13:18:24 -07003017EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02003018
3019/**
Tejun Heo401a8d02010-09-16 10:36:00 +02003020 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3021 * @dwork: the delayed work cancel
3022 *
3023 * This is cancel_work_sync() for delayed works.
3024 *
3025 * RETURNS:
3026 * %true if @dwork was pending, %false otherwise.
3027 */
3028bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003029{
Tejun Heo36e227d2012-08-03 10:30:46 -07003030 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003031}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003032EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003033
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003034/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07003035 * schedule_work_on - put work task on a specific cpu
3036 * @cpu: cpu to put the work task on
3037 * @work: job to be done
3038 *
3039 * This puts a job on a specific cpu
3040 */
Tejun Heod4283e92012-08-03 10:30:44 -07003041bool schedule_work_on(int cpu, struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07003042{
Tejun Heod320c032010-06-29 10:07:14 +02003043 return queue_work_on(cpu, system_wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07003044}
3045EXPORT_SYMBOL(schedule_work_on);
3046
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003047/**
Dave Jonesae90dd52006-06-30 01:40:45 -04003048 * schedule_work - put work task in global workqueue
Linus Torvalds1da177e2005-04-16 15:20:36 -07003049 * @work: job to be done
Linus Torvalds1da177e2005-04-16 15:20:36 -07003050 *
Tejun Heod4283e92012-08-03 10:30:44 -07003051 * Returns %false if @work was already on the kernel-global workqueue and
3052 * %true otherwise.
David Howells52bad642006-11-22 14:54:01 +00003053 *
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003054 * This puts a job in the kernel-global workqueue if it was not already
3055 * queued and leaves it in the same position on the kernel-global
3056 * workqueue otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003057 */
Tejun Heod4283e92012-08-03 10:30:44 -07003058bool schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003059{
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003060 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003061}
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003062EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003063
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003064/**
3065 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
3066 * @cpu: cpu to use
3067 * @dwork: job to be done
3068 * @delay: number of jiffies to wait
3069 *
3070 * After waiting for a given time this puts a job in the kernel-global
3071 * workqueue on the specified CPU.
3072 */
Tejun Heod4283e92012-08-03 10:30:44 -07003073bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3074 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003075{
Tejun Heod320c032010-06-29 10:07:14 +02003076 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003077}
Dave Jonesae90dd52006-06-30 01:40:45 -04003078EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003079
Andrew Mortonb6136772006-06-25 05:47:49 -07003080/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003081 * schedule_delayed_work - put work task in global workqueue after delay
3082 * @dwork: job to be done
3083 * @delay: number of jiffies to wait or 0 for immediate execution
3084 *
3085 * After waiting for a given time this puts a job in the kernel-global
3086 * workqueue.
3087 */
Tejun Heod4283e92012-08-03 10:30:44 -07003088bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
Tejun Heo0a13c002012-08-03 10:30:44 -07003089{
3090 return queue_delayed_work(system_wq, dwork, delay);
3091}
3092EXPORT_SYMBOL(schedule_delayed_work);
3093
3094/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003095 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003096 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003097 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003098 * schedule_on_each_cpu() executes @func on each online CPU using the
3099 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003100 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003101 *
3102 * RETURNS:
3103 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003104 */
David Howells65f27f32006-11-22 14:55:48 +00003105int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003106{
3107 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003108 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003109
Andrew Mortonb6136772006-06-25 05:47:49 -07003110 works = alloc_percpu(struct work_struct);
3111 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003112 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003113
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003114 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003115
Christoph Lameter15316ba2006-01-08 01:00:43 -08003116 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003117 struct work_struct *work = per_cpu_ptr(works, cpu);
3118
3119 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003120 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003121 }
Tejun Heo93981802009-11-17 14:06:20 -08003122
3123 for_each_online_cpu(cpu)
3124 flush_work(per_cpu_ptr(works, cpu));
3125
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003126 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003127 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003128 return 0;
3129}
3130
Alan Sterneef6a7d2010-02-12 17:39:21 +09003131/**
3132 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3133 *
3134 * Forces execution of the kernel-global workqueue and blocks until its
3135 * completion.
3136 *
3137 * Think twice before calling this function! It's very easy to get into
3138 * trouble if you don't take great care. Either of the following situations
3139 * will lead to deadlock:
3140 *
3141 * One of the work items currently on the workqueue needs to acquire
3142 * a lock held by your code or its caller.
3143 *
3144 * Your code is running in the context of a work routine.
3145 *
3146 * They will be detected by lockdep when they occur, but the first might not
3147 * occur very often. It depends on what work items are on the workqueue and
3148 * what locks they need, which you have no control over.
3149 *
3150 * In most situations flushing the entire workqueue is overkill; you merely
3151 * need to know that a particular work item isn't queued and isn't running.
3152 * In such cases you should use cancel_delayed_work_sync() or
3153 * cancel_work_sync() instead.
3154 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003155void flush_scheduled_work(void)
3156{
Tejun Heod320c032010-06-29 10:07:14 +02003157 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003158}
Dave Jonesae90dd52006-06-30 01:40:45 -04003159EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003160
3161/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003162 * execute_in_process_context - reliably execute the routine with user context
3163 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003164 * @ew: guaranteed storage for the execute work structure (must
3165 * be available when the work executes)
3166 *
3167 * Executes the function immediately if process context is available,
3168 * otherwise schedules the function for delayed execution.
3169 *
3170 * Returns: 0 - function was executed
3171 * 1 - function was scheduled for execution
3172 */
David Howells65f27f32006-11-22 14:55:48 +00003173int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003174{
3175 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003176 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003177 return 0;
3178 }
3179
David Howells65f27f32006-11-22 14:55:48 +00003180 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003181 schedule_work(&ew->work);
3182
3183 return 1;
3184}
3185EXPORT_SYMBOL_GPL(execute_in_process_context);
3186
Linus Torvalds1da177e2005-04-16 15:20:36 -07003187int keventd_up(void)
3188{
Tejun Heod320c032010-06-29 10:07:14 +02003189 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003190}
3191
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003192static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003193{
Oleg Nesterov3af244332007-05-09 02:34:09 -07003194 /*
Tejun Heo0f900042010-06-29 10:07:11 +02003195 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
3196 * Make sure that the alignment isn't lower than that of
3197 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07003198 */
Tejun Heo0f900042010-06-29 10:07:11 +02003199 const size_t size = sizeof(struct cpu_workqueue_struct);
3200 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
3201 __alignof__(unsigned long long));
Oleg Nesterov3af244332007-05-09 02:34:09 -07003202
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003203 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003204 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02003205 else {
Tejun Heof3421792010-07-02 10:03:51 +02003206 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003207
Tejun Heof3421792010-07-02 10:03:51 +02003208 /*
3209 * Allocate enough room to align cwq and put an extra
3210 * pointer at the end pointing back to the originally
3211 * allocated pointer which will be used for free.
3212 */
3213 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3214 if (ptr) {
3215 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3216 *(void **)(wq->cpu_wq.single + 1) = ptr;
3217 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003218 }
Tejun Heof3421792010-07-02 10:03:51 +02003219
Tejun Heo0415b00d12011-03-24 18:50:09 +01003220 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003221 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3222 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003223}
3224
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003225static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003226{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003227 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003228 free_percpu(wq->cpu_wq.pcpu);
3229 else if (wq->cpu_wq.single) {
3230 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003231 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003232 }
3233}
3234
Tejun Heof3421792010-07-02 10:03:51 +02003235static int wq_clamp_max_active(int max_active, unsigned int flags,
3236 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003237{
Tejun Heof3421792010-07-02 10:03:51 +02003238 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3239
3240 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003241 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3242 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003243
Tejun Heof3421792010-07-02 10:03:51 +02003244 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003245}
3246
Tejun Heob196be82012-01-10 15:11:35 -08003247struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003248 unsigned int flags,
3249 int max_active,
3250 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003251 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003252{
Tejun Heob196be82012-01-10 15:11:35 -08003253 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003254 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003255 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08003256 size_t namelen;
3257
3258 /* determine namelen, allocate wq and format name */
3259 va_start(args, lock_name);
3260 va_copy(args1, args);
3261 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3262
3263 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3264 if (!wq)
3265 goto err;
3266
3267 vsnprintf(wq->name, namelen, fmt, args1);
3268 va_end(args);
3269 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003270
Tejun Heof3421792010-07-02 10:03:51 +02003271 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02003272 * Workqueues which may be used during memory reclaim should
3273 * have a rescuer to guarantee forward progress.
3274 */
3275 if (flags & WQ_MEM_RECLAIM)
3276 flags |= WQ_RESCUER;
3277
Tejun Heod320c032010-06-29 10:07:14 +02003278 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003279 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003280
Tejun Heob196be82012-01-10 15:11:35 -08003281 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003282 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003283 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003284 mutex_init(&wq->flush_mutex);
3285 atomic_set(&wq->nr_cwqs_to_flush, 0);
3286 INIT_LIST_HEAD(&wq->flusher_queue);
3287 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003288
Johannes Bergeb13ba82008-01-16 09:51:58 +01003289 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003290 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003291
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003292 if (alloc_cwqs(wq) < 0)
3293 goto err;
3294
Tejun Heof3421792010-07-02 10:03:51 +02003295 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003296 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003297 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo32704762012-07-13 22:16:45 -07003298 int pool_idx = (bool)(flags & WQ_HIGHPRI);
Tejun Heo15376632010-06-29 10:07:11 +02003299
Tejun Heo0f900042010-06-29 10:07:11 +02003300 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo32704762012-07-13 22:16:45 -07003301 cwq->pool = &gcwq->pools[pool_idx];
Tejun Heoc34056a2010-06-29 10:07:11 +02003302 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003303 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003304 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003305 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003306 }
3307
Tejun Heoe22bee72010-06-29 10:07:14 +02003308 if (flags & WQ_RESCUER) {
3309 struct worker *rescuer;
3310
Tejun Heof2e005a2010-07-20 15:59:09 +02003311 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003312 goto err;
3313
3314 wq->rescuer = rescuer = alloc_worker();
3315 if (!rescuer)
3316 goto err;
3317
Tejun Heo111c2252013-01-17 17:16:24 -08003318 rescuer->rescue_wq = wq;
3319 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003320 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003321 if (IS_ERR(rescuer->task))
3322 goto err;
3323
Tejun Heoe22bee72010-06-29 10:07:14 +02003324 rescuer->task->flags |= PF_THREAD_BOUND;
3325 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003326 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003327
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003328 /*
3329 * workqueue_lock protects global freeze state and workqueues
3330 * list. Grab it, set max_active accordingly and add the new
3331 * workqueue to workqueues list.
3332 */
Tejun Heo15376632010-06-29 10:07:11 +02003333 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003334
Tejun Heo58a69cb2011-02-16 09:25:31 +01003335 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003336 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003337 get_cwq(cpu, wq)->max_active = 0;
3338
Tejun Heo15376632010-06-29 10:07:11 +02003339 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003340
Tejun Heo15376632010-06-29 10:07:11 +02003341 spin_unlock(&workqueue_lock);
3342
Oleg Nesterov3af244332007-05-09 02:34:09 -07003343 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003344err:
3345 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003346 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003347 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003348 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003349 kfree(wq);
3350 }
3351 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003352}
Tejun Heod320c032010-06-29 10:07:14 +02003353EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003354
3355/**
3356 * destroy_workqueue - safely terminate a workqueue
3357 * @wq: target workqueue
3358 *
3359 * Safely destroy a workqueue. All work currently pending will be done first.
3360 */
3361void destroy_workqueue(struct workqueue_struct *wq)
3362{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003363 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003364
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003365 /* drain it before proceeding with destruction */
3366 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003367
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003368 /*
3369 * wq list is used to freeze wq, remove from list after
3370 * flushing is complete in case freeze races us.
3371 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003372 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07003373 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003374 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003375
Tejun Heoe22bee72010-06-29 10:07:14 +02003376 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003377 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003378 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3379 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003380
Tejun Heo73f53c42010-06-29 10:07:11 +02003381 for (i = 0; i < WORK_NR_COLORS; i++)
3382 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003383 BUG_ON(cwq->nr_active);
3384 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003385 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003386
Tejun Heoe22bee72010-06-29 10:07:14 +02003387 if (wq->flags & WQ_RESCUER) {
3388 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003389 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003390 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003391 }
3392
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003393 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003394 kfree(wq);
3395}
3396EXPORT_SYMBOL_GPL(destroy_workqueue);
3397
Tejun Heodcd989c2010-06-29 10:07:14 +02003398/**
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003399 * cwq_set_max_active - adjust max_active of a cwq
3400 * @cwq: target cpu_workqueue_struct
3401 * @max_active: new max_active value.
3402 *
3403 * Set @cwq->max_active to @max_active and activate delayed works if
3404 * increased.
3405 *
3406 * CONTEXT:
3407 * spin_lock_irq(gcwq->lock).
3408 */
3409static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active)
3410{
3411 cwq->max_active = max_active;
3412
3413 while (!list_empty(&cwq->delayed_works) &&
3414 cwq->nr_active < cwq->max_active)
3415 cwq_activate_first_delayed(cwq);
3416}
3417
3418/**
Tejun Heodcd989c2010-06-29 10:07:14 +02003419 * workqueue_set_max_active - adjust max_active of a workqueue
3420 * @wq: target workqueue
3421 * @max_active: new max_active value.
3422 *
3423 * Set max_active of @wq to @max_active.
3424 *
3425 * CONTEXT:
3426 * Don't call from IRQ context.
3427 */
3428void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3429{
3430 unsigned int cpu;
3431
Tejun Heof3421792010-07-02 10:03:51 +02003432 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003433
3434 spin_lock(&workqueue_lock);
3435
3436 wq->saved_max_active = max_active;
3437
Tejun Heof3421792010-07-02 10:03:51 +02003438 for_each_cwq_cpu(cpu, wq) {
Tejun Heo35b6bb62013-01-24 11:01:33 -08003439 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3440 struct worker_pool *pool = cwq->pool;
3441 struct global_cwq *gcwq = pool->gcwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02003442
3443 spin_lock_irq(&gcwq->lock);
3444
Tejun Heo58a69cb2011-02-16 09:25:31 +01003445 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heo35b6bb62013-01-24 11:01:33 -08003446 !(pool->flags & POOL_FREEZING))
3447 cwq_set_max_active(cwq, max_active);
Tejun Heodcd989c2010-06-29 10:07:14 +02003448
3449 spin_unlock_irq(&gcwq->lock);
3450 }
3451
3452 spin_unlock(&workqueue_lock);
3453}
3454EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3455
3456/**
3457 * workqueue_congested - test whether a workqueue is congested
3458 * @cpu: CPU in question
3459 * @wq: target workqueue
3460 *
3461 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3462 * no synchronization around this function and the test result is
3463 * unreliable and only useful as advisory hints or for debugging.
3464 *
3465 * RETURNS:
3466 * %true if congested, %false otherwise.
3467 */
3468bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3469{
3470 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3471
3472 return !list_empty(&cwq->delayed_works);
3473}
3474EXPORT_SYMBOL_GPL(workqueue_congested);
3475
3476/**
Tejun Heodcd989c2010-06-29 10:07:14 +02003477 * work_busy - test whether a work is currently pending or running
3478 * @work: the work to be tested
3479 *
3480 * Test whether @work is currently pending or running. There is no
3481 * synchronization around this function and the test result is
3482 * unreliable and only useful as advisory hints or for debugging.
3483 * Especially for reentrant wqs, the pending state might hide the
3484 * running state.
3485 *
3486 * RETURNS:
3487 * OR'd bitmask of WORK_BUSY_* bits.
3488 */
3489unsigned int work_busy(struct work_struct *work)
3490{
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003491 struct worker_pool *pool = get_work_pool(work);
3492 struct global_cwq *gcwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02003493 unsigned long flags;
3494 unsigned int ret = 0;
3495
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003496 if (!pool)
Joonsoo Kim999767b2012-10-21 01:30:06 +09003497 return 0;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003498 gcwq = pool->gcwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02003499
3500 spin_lock_irqsave(&gcwq->lock, flags);
3501
3502 if (work_pending(work))
3503 ret |= WORK_BUSY_PENDING;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003504 if (find_worker_executing_work(pool, work))
Tejun Heodcd989c2010-06-29 10:07:14 +02003505 ret |= WORK_BUSY_RUNNING;
3506
3507 spin_unlock_irqrestore(&gcwq->lock, flags);
3508
3509 return ret;
3510}
3511EXPORT_SYMBOL_GPL(work_busy);
3512
Tejun Heodb7bccf2010-06-29 10:07:12 +02003513/*
3514 * CPU hotplug.
3515 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003516 * There are two challenges in supporting CPU hotplug. Firstly, there
3517 * are a lot of assumptions on strong associations among work, cwq and
3518 * gcwq which make migrating pending and scheduled works very
3519 * difficult to implement without impacting hot paths. Secondly,
3520 * gcwqs serve mix of short, long and very long running works making
3521 * blocked draining impractical.
3522 *
Tejun Heo24647572013-01-24 11:01:33 -08003523 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07003524 * running as an unbound one and allowing it to be reattached later if the
3525 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003526 */
3527
Tejun Heo60373152012-07-17 12:39:27 -07003528/* claim manager positions of all pools */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003529static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003530{
3531 struct worker_pool *pool;
3532
3533 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003534 mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
Tejun Heo8db25e72012-07-17 12:39:28 -07003535 spin_lock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003536}
3537
3538/* release manager positions */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003539static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003540{
3541 struct worker_pool *pool;
3542
Tejun Heo8db25e72012-07-17 12:39:28 -07003543 spin_unlock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003544 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003545 mutex_unlock(&pool->assoc_mutex);
Tejun Heo60373152012-07-17 12:39:27 -07003546}
3547
Tejun Heo628c78e2012-07-17 12:39:27 -07003548static void gcwq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003549{
Tejun Heo628c78e2012-07-17 12:39:27 -07003550 struct global_cwq *gcwq = get_gcwq(smp_processor_id());
Tejun Heo4ce62e92012-07-13 22:16:44 -07003551 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003552 struct worker *worker;
3553 struct hlist_node *pos;
3554 int i;
3555
3556 BUG_ON(gcwq->cpu != smp_processor_id());
3557
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003558 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003559
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003560 /*
3561 * We've claimed all manager positions. Make all workers unbound
3562 * and set DISASSOCIATED. Before this, all workers except for the
3563 * ones which are still executing works from before the last CPU
3564 * down must be on the cpu. After this, they may become diasporas.
3565 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003566 for_each_worker_pool(pool, gcwq) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07003567 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07003568 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003569
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003570 for_each_busy_worker(worker, i, pos, pool)
3571 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003572
Tejun Heo24647572013-01-24 11:01:33 -08003573 pool->flags |= POOL_DISASSOCIATED;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003574 }
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003575
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003576 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003577
3578 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07003579 * Call schedule() so that we cross rq->lock and thus can guarantee
3580 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3581 * as scheduler callbacks may be invoked from other cpus.
3582 */
3583 schedule();
3584
3585 /*
3586 * Sched callbacks are disabled now. Zap nr_running. After this,
3587 * nr_running stays zero and need_more_worker() and keep_working()
3588 * are always true as long as the worklist is not empty. @gcwq now
3589 * behaves as unbound (in terms of concurrency management) gcwq
3590 * which is served by workers tied to the CPU.
3591 *
3592 * On return from this function, the current worker would trigger
3593 * unbound chain execution of pending work items if other workers
3594 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02003595 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07003596 for_each_worker_pool(pool, gcwq)
3597 atomic_set(get_pool_nr_running(pool), 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003598}
3599
Tejun Heo8db25e72012-07-17 12:39:28 -07003600/*
3601 * Workqueues should be brought up before normal priority CPU notifiers.
3602 * This will be registered high priority CPU notifier.
3603 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003604static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07003605 unsigned long action,
3606 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003607{
3608 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003609 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003610 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003611
Tejun Heo8db25e72012-07-17 12:39:28 -07003612 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003613 case CPU_UP_PREPARE:
Tejun Heo4ce62e92012-07-13 22:16:44 -07003614 for_each_worker_pool(pool, gcwq) {
Tejun Heo3ce63372012-07-17 12:39:27 -07003615 struct worker *worker;
3616
3617 if (pool->nr_workers)
3618 continue;
3619
3620 worker = create_worker(pool);
3621 if (!worker)
3622 return NOTIFY_BAD;
3623
3624 spin_lock_irq(&gcwq->lock);
3625 start_worker(worker);
3626 spin_unlock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003627 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003628 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003629
Tejun Heo65758202012-07-17 12:39:26 -07003630 case CPU_DOWN_FAILED:
3631 case CPU_ONLINE:
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003632 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heo24647572013-01-24 11:01:33 -08003633 for_each_worker_pool(pool, gcwq)
3634 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heo8db25e72012-07-17 12:39:28 -07003635 rebind_workers(gcwq);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003636 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heo8db25e72012-07-17 12:39:28 -07003637 break;
Tejun Heo65758202012-07-17 12:39:26 -07003638 }
3639 return NOTIFY_OK;
3640}
3641
3642/*
3643 * Workqueues should be brought down after normal priority CPU notifiers.
3644 * This will be registered as low priority CPU notifier.
3645 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003646static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07003647 unsigned long action,
3648 void *hcpu)
3649{
Tejun Heo8db25e72012-07-17 12:39:28 -07003650 unsigned int cpu = (unsigned long)hcpu;
3651 struct work_struct unbind_work;
3652
Tejun Heo65758202012-07-17 12:39:26 -07003653 switch (action & ~CPU_TASKS_FROZEN) {
3654 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003655 /* unbinding should happen on the local CPU */
3656 INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09003657 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07003658 flush_work(&unbind_work);
3659 break;
Tejun Heo65758202012-07-17 12:39:26 -07003660 }
3661 return NOTIFY_OK;
3662}
3663
Rusty Russell2d3854a2008-11-05 13:39:10 +11003664#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003665
Rusty Russell2d3854a2008-11-05 13:39:10 +11003666struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07003667 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003668 long (*fn)(void *);
3669 void *arg;
3670 long ret;
3671};
3672
Tejun Heoed48ece2012-09-18 12:48:43 -07003673static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003674{
Tejun Heoed48ece2012-09-18 12:48:43 -07003675 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3676
Rusty Russell2d3854a2008-11-05 13:39:10 +11003677 wfc->ret = wfc->fn(wfc->arg);
3678}
3679
3680/**
3681 * work_on_cpu - run a function in user context on a particular cpu
3682 * @cpu: the cpu to run on
3683 * @fn: the function to run
3684 * @arg: the function arg
3685 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003686 * This will return the value @fn returns.
3687 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06003688 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003689 */
3690long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3691{
Tejun Heoed48ece2012-09-18 12:48:43 -07003692 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003693
Tejun Heoed48ece2012-09-18 12:48:43 -07003694 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3695 schedule_work_on(cpu, &wfc.work);
3696 flush_work(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003697 return wfc.ret;
3698}
3699EXPORT_SYMBOL_GPL(work_on_cpu);
3700#endif /* CONFIG_SMP */
3701
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003702#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303703
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003704/**
3705 * freeze_workqueues_begin - begin freezing workqueues
3706 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003707 * Start freezing workqueues. After this function returns, all freezable
3708 * workqueues will queue new works to their frozen_works list instead of
3709 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003710 *
3711 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003712 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003713 */
3714void freeze_workqueues_begin(void)
3715{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003716 unsigned int cpu;
3717
3718 spin_lock(&workqueue_lock);
3719
3720 BUG_ON(workqueue_freezing);
3721 workqueue_freezing = true;
3722
Tejun Heof3421792010-07-02 10:03:51 +02003723 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003724 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo35b6bb62013-01-24 11:01:33 -08003725 struct worker_pool *pool;
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003726 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003727
3728 spin_lock_irq(&gcwq->lock);
3729
Tejun Heo35b6bb62013-01-24 11:01:33 -08003730 for_each_worker_pool(pool, gcwq) {
3731 WARN_ON_ONCE(pool->flags & POOL_FREEZING);
3732 pool->flags |= POOL_FREEZING;
3733 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003734
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003735 list_for_each_entry(wq, &workqueues, list) {
3736 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3737
Tejun Heo58a69cb2011-02-16 09:25:31 +01003738 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003739 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003740 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003741
3742 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003743 }
3744
3745 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003746}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003747
3748/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003749 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003750 *
3751 * Check whether freezing is complete. This function must be called
3752 * between freeze_workqueues_begin() and thaw_workqueues().
3753 *
3754 * CONTEXT:
3755 * Grabs and releases workqueue_lock.
3756 *
3757 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003758 * %true if some freezable workqueues are still busy. %false if freezing
3759 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003760 */
3761bool freeze_workqueues_busy(void)
3762{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003763 unsigned int cpu;
3764 bool busy = false;
3765
3766 spin_lock(&workqueue_lock);
3767
3768 BUG_ON(!workqueue_freezing);
3769
Tejun Heof3421792010-07-02 10:03:51 +02003770 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003771 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003772 /*
3773 * nr_active is monotonically decreasing. It's safe
3774 * to peek without lock.
3775 */
3776 list_for_each_entry(wq, &workqueues, list) {
3777 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3778
Tejun Heo58a69cb2011-02-16 09:25:31 +01003779 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003780 continue;
3781
3782 BUG_ON(cwq->nr_active < 0);
3783 if (cwq->nr_active) {
3784 busy = true;
3785 goto out_unlock;
3786 }
3787 }
3788 }
3789out_unlock:
3790 spin_unlock(&workqueue_lock);
3791 return busy;
3792}
3793
3794/**
3795 * thaw_workqueues - thaw workqueues
3796 *
3797 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003798 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003799 *
3800 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003801 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003802 */
3803void thaw_workqueues(void)
3804{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003805 unsigned int cpu;
3806
3807 spin_lock(&workqueue_lock);
3808
3809 if (!workqueue_freezing)
3810 goto out_unlock;
3811
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 Heobdbc5dd2010-07-02 10:03:51 +02003815 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003816
3817 spin_lock_irq(&gcwq->lock);
3818
Tejun Heo35b6bb62013-01-24 11:01:33 -08003819 for_each_worker_pool(pool, gcwq) {
3820 WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
3821 pool->flags &= ~POOL_FREEZING;
3822 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003823
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003824 list_for_each_entry(wq, &workqueues, list) {
3825 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3826
Tejun Heo58a69cb2011-02-16 09:25:31 +01003827 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003828 continue;
3829
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003830 /* restore max_active and repopulate worklist */
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003831 cwq_set_max_active(cwq, wq->saved_max_active);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003832 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003833
Tejun Heo4ce62e92012-07-13 22:16:44 -07003834 for_each_worker_pool(pool, gcwq)
3835 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02003836
Tejun Heo8b03ae32010-06-29 10:07:12 +02003837 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003838 }
3839
3840 workqueue_freezing = false;
3841out_unlock:
3842 spin_unlock(&workqueue_lock);
3843}
3844#endif /* CONFIG_FREEZER */
3845
Suresh Siddha6ee05782010-07-30 14:57:37 -07003846static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003847{
Tejun Heoc34056a2010-06-29 10:07:11 +02003848 unsigned int cpu;
3849
Tejun Heo7c3eed52013-01-24 11:01:33 -08003850 /* make sure we have enough bits for OFFQ pool ID */
3851 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT)) <
3852 WORK_CPU_LAST * NR_STD_WORKER_POOLS);
Tejun Heob5490072012-08-03 10:30:46 -07003853
Tejun Heo65758202012-07-17 12:39:26 -07003854 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07003855 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003856
3857 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003858 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003859 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003860 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003861
3862 spin_lock_init(&gcwq->lock);
3863 gcwq->cpu = cpu;
3864
Tejun Heo4ce62e92012-07-13 22:16:44 -07003865 for_each_worker_pool(pool, gcwq) {
3866 pool->gcwq = gcwq;
Tejun Heo24647572013-01-24 11:01:33 -08003867 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003868 INIT_LIST_HEAD(&pool->worklist);
3869 INIT_LIST_HEAD(&pool->idle_list);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003870 hash_init(pool->busy_hash);
Tejun Heoe22bee72010-06-29 10:07:14 +02003871
Tejun Heo4ce62e92012-07-13 22:16:44 -07003872 init_timer_deferrable(&pool->idle_timer);
3873 pool->idle_timer.function = idle_worker_timeout;
3874 pool->idle_timer.data = (unsigned long)pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003875
Tejun Heo4ce62e92012-07-13 22:16:44 -07003876 setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
3877 (unsigned long)pool);
3878
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003879 mutex_init(&pool->assoc_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003880 ida_init(&pool->worker_ida);
Tejun Heo9daf9e62013-01-24 11:01:33 -08003881
3882 /* alloc pool ID */
3883 BUG_ON(worker_pool_assign_id(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07003884 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003885 }
3886
Tejun Heoe22bee72010-06-29 10:07:14 +02003887 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003888 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003889 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003890 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003891
Tejun Heo4ce62e92012-07-13 22:16:44 -07003892 for_each_worker_pool(pool, gcwq) {
3893 struct worker *worker;
3894
Tejun Heo24647572013-01-24 11:01:33 -08003895 if (cpu != WORK_CPU_UNBOUND)
3896 pool->flags &= ~POOL_DISASSOCIATED;
3897
Tejun Heobc2ae0f2012-07-17 12:39:27 -07003898 worker = create_worker(pool);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003899 BUG_ON(!worker);
3900 spin_lock_irq(&gcwq->lock);
3901 start_worker(worker);
3902 spin_unlock_irq(&gcwq->lock);
3903 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003904 }
3905
Tejun Heod320c032010-06-29 10:07:14 +02003906 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003907 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02003908 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003909 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3910 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003911 system_freezable_wq = alloc_workqueue("events_freezable",
3912 WQ_FREEZABLE, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003913 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Tejun Heoae930e02012-08-20 14:51:23 -07003914 !system_unbound_wq || !system_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003915 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003916}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003917early_initcall(init_workqueues);