blob: acd417be819942a72233637987a722f18ff1c864 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
19 * automatically managed. There is one worker pool for each CPU and
20 * one extra for works which are better served by workers which are
21 * not bound to any specific CPU.
22 *
23 * Please read Documentation/workqueue.txt for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 */
25
Paul Gortmaker9984de12011-05-23 14:51:41 -040026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/kernel.h>
28#include <linux/sched.h>
29#include <linux/init.h>
30#include <linux/signal.h>
31#include <linux/completion.h>
32#include <linux/workqueue.h>
33#include <linux/slab.h>
34#include <linux/cpu.h>
35#include <linux/notifier.h>
36#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060037#include <linux/hardirq.h>
Christoph Lameter46934022006-10-11 01:21:26 -070038#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080039#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080040#include <linux/kallsyms.h>
41#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070042#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020043#include <linux/idr.h>
Sasha Levin42f85702012-12-17 10:01:23 -050044#include <linux/hashtable.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020045
46#include "workqueue_sched.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Tejun Heoc8e55f32010-06-29 10:07:12 +020048enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070049 /*
50 * global_cwq flags
51 *
52 * A bound gcwq is either associated or disassociated with its CPU.
53 * While associated (!DISASSOCIATED), all workers are bound to the
54 * CPU and none has %WORKER_UNBOUND set and concurrency management
55 * is in effect.
56 *
57 * While DISASSOCIATED, the cpu may be offline and all workers have
58 * %WORKER_UNBOUND set and concurrency management disabled, and may
59 * be executing on any CPU. The gcwq behaves as an unbound one.
60 *
61 * Note that DISASSOCIATED can be flipped only while holding
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -070062 * assoc_mutex of all pools on the gcwq to avoid changing binding
Tejun Heobc2ae0f2012-07-17 12:39:27 -070063 * state while create_worker() is in progress.
64 */
Tejun Heo11ebea52012-07-12 14:46:37 -070065 GCWQ_DISASSOCIATED = 1 << 0, /* cpu can't serve workers */
66 GCWQ_FREEZING = 1 << 1, /* freeze in progress */
67
68 /* pool flags */
69 POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
Lai Jiangshan552a37e2012-09-10 10:03:33 -070070 POOL_MANAGING_WORKERS = 1 << 1, /* managing workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020071
Tejun Heoc8e55f32010-06-29 10:07:12 +020072 /* worker flags */
73 WORKER_STARTED = 1 << 0, /* started */
74 WORKER_DIE = 1 << 1, /* die die die */
75 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020076 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020077 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020078 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoe22bee72010-06-29 10:07:14 +020079
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -070080 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_UNBOUND |
Tejun Heo403c8212012-07-17 12:39:27 -070081 WORKER_CPU_INTENSIVE,
Tejun Heodb7bccf2010-06-29 10:07:12 +020082
Tejun Heo32704762012-07-13 22:16:45 -070083 NR_WORKER_POOLS = 2, /* # worker pools per gcwq */
Tejun Heo4ce62e92012-07-13 22:16:44 -070084
Tejun Heoc8e55f32010-06-29 10:07:12 +020085 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020086
Tejun Heoe22bee72010-06-29 10:07:14 +020087 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
88 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
89
Tejun Heo3233cdb2011-02-16 18:10:19 +010090 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
91 /* call for help after 10ms
92 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020093 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
94 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020095
96 /*
97 * Rescue workers are used only on emergencies and shared by
98 * all cpus. Give -20.
99 */
100 RESCUER_NICE_LEVEL = -20,
Tejun Heo32704762012-07-13 22:16:45 -0700101 HIGHPRI_NICE_LEVEL = -20,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200102};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
104/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200105 * Structure fields follow one of the following exclusion rules.
106 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200107 * I: Modifiable by initialization/destruction paths and read-only for
108 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200109 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200110 * P: Preemption protected. Disabling preemption is enough and should
111 * only be modified and accessed from the local cpu.
112 *
Tejun Heo8b03ae32010-06-29 10:07:12 +0200113 * L: gcwq->lock protected. Access with gcwq->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200114 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200115 * X: During normal operation, modification requires gcwq->lock and
116 * should be done only from local cpu. Either disabling preemption
117 * on local cpu or grabbing gcwq->lock is enough for read access.
Tejun Heof3421792010-07-02 10:03:51 +0200118 * If GCWQ_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200119 *
Tejun Heo73f53c42010-06-29 10:07:11 +0200120 * F: wq->flush_mutex protected.
121 *
Tejun Heo4690c4a2010-06-29 10:07:10 +0200122 * W: workqueue_lock protected.
123 */
124
Tejun Heo8b03ae32010-06-29 10:07:12 +0200125struct global_cwq;
Tejun Heobd7bdd42012-07-12 14:46:37 -0700126struct worker_pool;
Tejun Heoc34056a2010-06-29 10:07:11 +0200127
Tejun Heoe22bee72010-06-29 10:07:14 +0200128/*
129 * The poor guys doing the actual heavy lifting. All on-duty workers
130 * are either serving the manager role, on idle list or on busy hash.
131 */
Tejun Heoc34056a2010-06-29 10:07:11 +0200132struct worker {
Tejun Heoc8e55f32010-06-29 10:07:12 +0200133 /* on idle list while idle, on busy hash table while busy */
134 union {
135 struct list_head entry; /* L: while idle */
136 struct hlist_node hentry; /* L: while busy */
137 };
138
Tejun Heoc34056a2010-06-29 10:07:11 +0200139 struct work_struct *current_work; /* L: work being processed */
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200140 struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */
Tejun Heoaffee4b2010-06-29 10:07:12 +0200141 struct list_head scheduled; /* L: scheduled works */
Tejun Heoc34056a2010-06-29 10:07:11 +0200142 struct task_struct *task; /* I: worker task */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700143 struct worker_pool *pool; /* I: the associated pool */
Tejun Heoe22bee72010-06-29 10:07:14 +0200144 /* 64 bytes boundary on 64bit, 32 on 32bit */
145 unsigned long last_active; /* L: last active timestamp */
146 unsigned int flags; /* X: flags */
Tejun Heoc34056a2010-06-29 10:07:11 +0200147 int id; /* I: worker id */
Tejun Heo25511a42012-07-17 12:39:27 -0700148
149 /* for rebinding worker to CPU */
Tejun Heo25511a42012-07-17 12:39:27 -0700150 struct work_struct rebind_work; /* L: for busy worker */
Tejun Heoc34056a2010-06-29 10:07:11 +0200151};
152
Tejun Heobd7bdd42012-07-12 14:46:37 -0700153struct worker_pool {
154 struct global_cwq *gcwq; /* I: the owning gcwq */
Tejun Heo11ebea52012-07-12 14:46:37 -0700155 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700156
157 struct list_head worklist; /* L: list of pending works */
158 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700159
160 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700161 int nr_idle; /* L: currently idle ones */
162
163 struct list_head idle_list; /* X: list of idle workers */
164 struct timer_list idle_timer; /* L: worker idle timeout */
165 struct timer_list mayday_timer; /* L: SOS timer for workers */
166
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -0700167 struct mutex assoc_mutex; /* protect GCWQ_DISASSOCIATED */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700168 struct ida worker_ida; /* L: for worker IDs */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700169};
170
Tejun Heo4690c4a2010-06-29 10:07:10 +0200171/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200172 * Global per-cpu workqueue. There's one and only one for each cpu
173 * and all works are queued and processed here regardless of their
174 * target workqueues.
Tejun Heo8b03ae32010-06-29 10:07:12 +0200175 */
176struct global_cwq {
177 spinlock_t lock; /* the gcwq lock */
178 unsigned int cpu; /* I: the associated cpu */
Tejun Heodb7bccf2010-06-29 10:07:12 +0200179 unsigned int flags; /* L: GCWQ_* flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +0200180
Tejun Heobd7bdd42012-07-12 14:46:37 -0700181 /* workers are chained either in busy_hash or pool idle_list */
Sasha Levin42f85702012-12-17 10:01:23 -0500182 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
Tejun Heoc8e55f32010-06-29 10:07:12 +0200183 /* L: hash of busy workers */
184
Joonsoo Kim330dad52012-08-15 23:25:36 +0900185 struct worker_pool pools[NR_WORKER_POOLS];
186 /* normal and highpri pools */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200187} ____cacheline_aligned_in_smp;
188
189/*
Tejun Heo502ca9d2010-06-29 10:07:13 +0200190 * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of
Tejun Heo0f900042010-06-29 10:07:11 +0200191 * work_struct->data are used for flags and thus cwqs need to be
192 * aligned at two's power of the number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 */
194struct cpu_workqueue_struct {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700195 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200196 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200197 int work_color; /* L: current color */
198 int flush_color; /* L: flushing color */
199 int nr_in_flight[WORK_NR_COLORS];
200 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200201 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200202 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200203 struct list_head delayed_works; /* L: delayed works */
Tejun Heo0f900042010-06-29 10:07:11 +0200204};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200207 * Structure used to wait for workqueue flush.
208 */
209struct wq_flusher {
210 struct list_head list; /* F: list of flushers */
211 int flush_color; /* F: flush color waiting for */
212 struct completion done; /* flush completion */
213};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Tejun Heo73f53c42010-06-29 10:07:11 +0200215/*
Tejun Heof2e005a2010-07-20 15:59:09 +0200216 * All cpumasks are assumed to be always set on UP and thus can't be
217 * used to determine whether there's something to be done.
218 */
219#ifdef CONFIG_SMP
220typedef cpumask_var_t mayday_mask_t;
221#define mayday_test_and_set_cpu(cpu, mask) \
222 cpumask_test_and_set_cpu((cpu), (mask))
223#define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask))
224#define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask))
Tejun Heo9c375472010-08-31 11:18:34 +0200225#define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp))
Tejun Heof2e005a2010-07-20 15:59:09 +0200226#define free_mayday_mask(mask) free_cpumask_var((mask))
227#else
228typedef unsigned long mayday_mask_t;
229#define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask))
230#define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask))
231#define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask))
232#define alloc_mayday_mask(maskp, gfp) true
233#define free_mayday_mask(mask) do { } while (0)
234#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
236/*
237 * The externally visible workqueue abstraction is an array of
238 * per-CPU workqueues:
239 */
240struct workqueue_struct {
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200241 unsigned int flags; /* W: WQ_* flags */
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200242 union {
243 struct cpu_workqueue_struct __percpu *pcpu;
244 struct cpu_workqueue_struct *single;
245 unsigned long v;
246 } cpu_wq; /* I: cwq's */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200247 struct list_head list; /* W: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200248
249 struct mutex flush_mutex; /* protects wq flushing */
250 int work_color; /* F: current work color */
251 int flush_color; /* F: current flush color */
252 atomic_t nr_cwqs_to_flush; /* flush in progress */
253 struct wq_flusher *first_flusher; /* F: first flusher */
254 struct list_head flusher_queue; /* F: flush waiters */
255 struct list_head flusher_overflow; /* F: flush overflow list */
256
Tejun Heof2e005a2010-07-20 15:59:09 +0200257 mayday_mask_t mayday_mask; /* cpus requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200258 struct worker *rescuer; /* I: rescue worker */
259
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200260 int nr_drainers; /* W: drain in progress */
Tejun Heodcd989c2010-06-29 10:07:14 +0200261 int saved_max_active; /* W: saved cwq max_active */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700262#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200263 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700264#endif
Tejun Heob196be82012-01-10 15:11:35 -0800265 char name[]; /* I: workqueue name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266};
267
Tejun Heod320c032010-06-29 10:07:14 +0200268struct workqueue_struct *system_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200269EXPORT_SYMBOL_GPL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300270struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900271EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300272struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200273EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300274struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200275EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300276struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100277EXPORT_SYMBOL_GPL(system_freezable_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200278
Tejun Heo97bd2342010-10-05 10:41:14 +0200279#define CREATE_TRACE_POINTS
280#include <trace/events/workqueue.h>
281
Tejun Heo4ce62e92012-07-13 22:16:44 -0700282#define for_each_worker_pool(pool, gcwq) \
Tejun Heo32704762012-07-13 22:16:45 -0700283 for ((pool) = &(gcwq)->pools[0]; \
284 (pool) < &(gcwq)->pools[NR_WORKER_POOLS]; (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700285
Tejun Heodb7bccf2010-06-29 10:07:12 +0200286#define for_each_busy_worker(worker, i, pos, gcwq) \
Sasha Levin42f85702012-12-17 10:01:23 -0500287 hash_for_each(gcwq->busy_hash, i, pos, worker, hentry)
Tejun Heodb7bccf2010-06-29 10:07:12 +0200288
Tejun Heof3421792010-07-02 10:03:51 +0200289static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask,
290 unsigned int sw)
291{
292 if (cpu < nr_cpu_ids) {
293 if (sw & 1) {
294 cpu = cpumask_next(cpu, mask);
295 if (cpu < nr_cpu_ids)
296 return cpu;
297 }
298 if (sw & 2)
299 return WORK_CPU_UNBOUND;
300 }
301 return WORK_CPU_NONE;
302}
303
304static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
305 struct workqueue_struct *wq)
306{
307 return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2);
308}
309
Tejun Heo09884952010-08-01 11:50:12 +0200310/*
311 * CPU iterators
312 *
313 * An extra gcwq is defined for an invalid cpu number
314 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
315 * specific CPU. The following iterators are similar to
316 * for_each_*_cpu() iterators but also considers the unbound gcwq.
317 *
318 * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND
319 * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND
320 * for_each_cwq_cpu() : possible CPUs for bound workqueues,
321 * WORK_CPU_UNBOUND for unbound workqueues
322 */
Tejun Heof3421792010-07-02 10:03:51 +0200323#define for_each_gcwq_cpu(cpu) \
324 for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \
325 (cpu) < WORK_CPU_NONE; \
326 (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3))
327
328#define for_each_online_gcwq_cpu(cpu) \
329 for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \
330 (cpu) < WORK_CPU_NONE; \
331 (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3))
332
333#define for_each_cwq_cpu(cpu, wq) \
334 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \
335 (cpu) < WORK_CPU_NONE; \
336 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq)))
337
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900338#ifdef CONFIG_DEBUG_OBJECTS_WORK
339
340static struct debug_obj_descr work_debug_descr;
341
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100342static void *work_debug_hint(void *addr)
343{
344 return ((struct work_struct *) addr)->func;
345}
346
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900347/*
348 * fixup_init is called when:
349 * - an active object is initialized
350 */
351static int work_fixup_init(void *addr, enum debug_obj_state state)
352{
353 struct work_struct *work = addr;
354
355 switch (state) {
356 case ODEBUG_STATE_ACTIVE:
357 cancel_work_sync(work);
358 debug_object_init(work, &work_debug_descr);
359 return 1;
360 default:
361 return 0;
362 }
363}
364
365/*
366 * fixup_activate is called when:
367 * - an active object is activated
368 * - an unknown object is activated (might be a statically initialized object)
369 */
370static int work_fixup_activate(void *addr, enum debug_obj_state state)
371{
372 struct work_struct *work = addr;
373
374 switch (state) {
375
376 case ODEBUG_STATE_NOTAVAILABLE:
377 /*
378 * This is not really a fixup. The work struct was
379 * statically initialized. We just make sure that it
380 * is tracked in the object tracker.
381 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200382 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900383 debug_object_init(work, &work_debug_descr);
384 debug_object_activate(work, &work_debug_descr);
385 return 0;
386 }
387 WARN_ON_ONCE(1);
388 return 0;
389
390 case ODEBUG_STATE_ACTIVE:
391 WARN_ON(1);
392
393 default:
394 return 0;
395 }
396}
397
398/*
399 * fixup_free is called when:
400 * - an active object is freed
401 */
402static int work_fixup_free(void *addr, enum debug_obj_state state)
403{
404 struct work_struct *work = addr;
405
406 switch (state) {
407 case ODEBUG_STATE_ACTIVE:
408 cancel_work_sync(work);
409 debug_object_free(work, &work_debug_descr);
410 return 1;
411 default:
412 return 0;
413 }
414}
415
416static struct debug_obj_descr work_debug_descr = {
417 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100418 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900419 .fixup_init = work_fixup_init,
420 .fixup_activate = work_fixup_activate,
421 .fixup_free = work_fixup_free,
422};
423
424static inline void debug_work_activate(struct work_struct *work)
425{
426 debug_object_activate(work, &work_debug_descr);
427}
428
429static inline void debug_work_deactivate(struct work_struct *work)
430{
431 debug_object_deactivate(work, &work_debug_descr);
432}
433
434void __init_work(struct work_struct *work, int onstack)
435{
436 if (onstack)
437 debug_object_init_on_stack(work, &work_debug_descr);
438 else
439 debug_object_init(work, &work_debug_descr);
440}
441EXPORT_SYMBOL_GPL(__init_work);
442
443void destroy_work_on_stack(struct work_struct *work)
444{
445 debug_object_free(work, &work_debug_descr);
446}
447EXPORT_SYMBOL_GPL(destroy_work_on_stack);
448
449#else
450static inline void debug_work_activate(struct work_struct *work) { }
451static inline void debug_work_deactivate(struct work_struct *work) { }
452#endif
453
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100454/* Serializes the accesses to the list of workqueues. */
455static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200457static bool workqueue_freezing; /* W: have wqs started freezing? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
Oleg Nesterov14441962007-05-23 13:57:57 -0700459/*
Tejun Heoe22bee72010-06-29 10:07:14 +0200460 * The almighty global cpu workqueues. nr_running is the only field
461 * which is expected to be used frequently by other cpus via
462 * try_to_wake_up(). Put it in a separate cacheline.
Oleg Nesterov14441962007-05-23 13:57:57 -0700463 */
Tejun Heo8b03ae32010-06-29 10:07:12 +0200464static DEFINE_PER_CPU(struct global_cwq, global_cwq);
Tejun Heo4ce62e92012-07-13 22:16:44 -0700465static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_WORKER_POOLS]);
Nathan Lynchf756d5e2006-01-08 01:05:12 -0800466
Tejun Heof3421792010-07-02 10:03:51 +0200467/*
468 * Global cpu workqueue and nr_running counter for unbound gcwq. The
469 * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its
470 * workers have WORKER_UNBOUND set.
471 */
472static struct global_cwq unbound_global_cwq;
Tejun Heo4ce62e92012-07-13 22:16:44 -0700473static atomic_t unbound_pool_nr_running[NR_WORKER_POOLS] = {
474 [0 ... NR_WORKER_POOLS - 1] = ATOMIC_INIT(0), /* always 0 */
475};
Tejun Heof3421792010-07-02 10:03:51 +0200476
Tejun Heoc34056a2010-06-29 10:07:11 +0200477static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
Tejun Heo32704762012-07-13 22:16:45 -0700479static int worker_pool_pri(struct worker_pool *pool)
480{
481 return pool - pool->gcwq->pools;
482}
483
Tejun Heo8b03ae32010-06-29 10:07:12 +0200484static struct global_cwq *get_gcwq(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485{
Tejun Heof3421792010-07-02 10:03:51 +0200486 if (cpu != WORK_CPU_UNBOUND)
487 return &per_cpu(global_cwq, cpu);
488 else
489 return &unbound_global_cwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490}
491
Tejun Heo63d95a92012-07-12 14:46:37 -0700492static atomic_t *get_pool_nr_running(struct worker_pool *pool)
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700493{
Tejun Heo63d95a92012-07-12 14:46:37 -0700494 int cpu = pool->gcwq->cpu;
Tejun Heo32704762012-07-13 22:16:45 -0700495 int idx = worker_pool_pri(pool);
Tejun Heo63d95a92012-07-12 14:46:37 -0700496
Tejun Heof3421792010-07-02 10:03:51 +0200497 if (cpu != WORK_CPU_UNBOUND)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700498 return &per_cpu(pool_nr_running, cpu)[idx];
Tejun Heof3421792010-07-02 10:03:51 +0200499 else
Tejun Heo4ce62e92012-07-13 22:16:44 -0700500 return &unbound_pool_nr_running[idx];
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700501}
502
Tejun Heo4690c4a2010-06-29 10:07:10 +0200503static struct cpu_workqueue_struct *get_cwq(unsigned int cpu,
504 struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700505{
Tejun Heof3421792010-07-02 10:03:51 +0200506 if (!(wq->flags & WQ_UNBOUND)) {
Lai Jiangshane06ffa12012-03-09 18:03:20 +0800507 if (likely(cpu < nr_cpu_ids))
Tejun Heof3421792010-07-02 10:03:51 +0200508 return per_cpu_ptr(wq->cpu_wq.pcpu, cpu);
Tejun Heof3421792010-07-02 10:03:51 +0200509 } else if (likely(cpu == WORK_CPU_UNBOUND))
510 return wq->cpu_wq.single;
511 return NULL;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700512}
513
Tejun Heo73f53c42010-06-29 10:07:11 +0200514static unsigned int work_color_to_flags(int color)
515{
516 return color << WORK_STRUCT_COLOR_SHIFT;
517}
518
519static int get_work_color(struct work_struct *work)
520{
521 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
522 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
523}
524
525static int work_next_color(int color)
526{
527 return (color + 1) % WORK_NR_COLORS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528}
529
David Howells4594bf12006-12-07 11:33:26 +0000530/*
Tejun Heob5490072012-08-03 10:30:46 -0700531 * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data
532 * contain the pointer to the queued cwq. Once execution starts, the flag
533 * is cleared and the high bits contain OFFQ flags and CPU number.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200534 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700535 * set_work_cwq(), set_work_cpu_and_clear_pending(), mark_work_canceling()
536 * and clear_work_data() can be used to set the cwq, cpu or clear
537 * work->data. These functions should only be called while the work is
538 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200539 *
Tejun Heobbb68df2012-08-03 10:30:46 -0700540 * get_work_[g]cwq() can be used to obtain the gcwq or cwq corresponding to
541 * a work. gcwq is available once the work has been queued anywhere after
542 * initialization until it is sync canceled. cwq is available only while
543 * the work item is queued.
544 *
545 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
546 * canceled. While being canceled, a work item may have its PENDING set
547 * but stay off timer and worklist for arbitrarily long and nobody should
548 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000549 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200550static inline void set_work_data(struct work_struct *work, unsigned long data,
551 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000552{
David Howells4594bf12006-12-07 11:33:26 +0000553 BUG_ON(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200554 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000555}
David Howells365970a2006-11-22 14:54:49 +0000556
Tejun Heo7a22ad72010-06-29 10:07:13 +0200557static void set_work_cwq(struct work_struct *work,
558 struct cpu_workqueue_struct *cwq,
559 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200560{
Tejun Heo7a22ad72010-06-29 10:07:13 +0200561 set_work_data(work, (unsigned long)cwq,
Tejun Heoe1201532010-07-22 14:14:25 +0200562 WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200563}
564
Tejun Heo8930cab2012-08-03 10:30:45 -0700565static void set_work_cpu_and_clear_pending(struct work_struct *work,
566 unsigned int cpu)
David Howells365970a2006-11-22 14:54:49 +0000567{
Tejun Heo23657bb2012-08-13 17:08:19 -0700568 /*
569 * The following wmb is paired with the implied mb in
570 * test_and_set_bit(PENDING) and ensures all updates to @work made
571 * here are visible to and precede any updates by the next PENDING
572 * owner.
573 */
574 smp_wmb();
Tejun Heob5490072012-08-03 10:30:46 -0700575 set_work_data(work, (unsigned long)cpu << WORK_OFFQ_CPU_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200576}
577
578static void clear_work_data(struct work_struct *work)
579{
Tejun Heo23657bb2012-08-13 17:08:19 -0700580 smp_wmb(); /* see set_work_cpu_and_clear_pending() */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200581 set_work_data(work, WORK_STRUCT_NO_CPU, 0);
582}
583
Tejun Heo7a22ad72010-06-29 10:07:13 +0200584static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work)
585{
Tejun Heoe1201532010-07-22 14:14:25 +0200586 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200587
Tejun Heoe1201532010-07-22 14:14:25 +0200588 if (data & WORK_STRUCT_CWQ)
589 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
590 else
591 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200592}
593
594static struct global_cwq *get_work_gcwq(struct work_struct *work)
595{
Tejun Heoe1201532010-07-22 14:14:25 +0200596 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200597 unsigned int cpu;
598
Tejun Heoe1201532010-07-22 14:14:25 +0200599 if (data & WORK_STRUCT_CWQ)
600 return ((struct cpu_workqueue_struct *)
Tejun Heobd7bdd42012-07-12 14:46:37 -0700601 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->gcwq;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200602
Tejun Heob5490072012-08-03 10:30:46 -0700603 cpu = data >> WORK_OFFQ_CPU_SHIFT;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200604 if (cpu == WORK_CPU_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200605 return NULL;
606
Tejun Heof3421792010-07-02 10:03:51 +0200607 BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200608 return get_gcwq(cpu);
David Howells365970a2006-11-22 14:54:49 +0000609}
610
Tejun Heobbb68df2012-08-03 10:30:46 -0700611static void mark_work_canceling(struct work_struct *work)
612{
613 struct global_cwq *gcwq = get_work_gcwq(work);
614 unsigned long cpu = gcwq ? gcwq->cpu : WORK_CPU_NONE;
615
616 set_work_data(work, (cpu << WORK_OFFQ_CPU_SHIFT) | WORK_OFFQ_CANCELING,
617 WORK_STRUCT_PENDING);
618}
619
620static bool work_is_canceling(struct work_struct *work)
621{
622 unsigned long data = atomic_long_read(&work->data);
623
624 return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING);
625}
626
David Howells365970a2006-11-22 14:54:49 +0000627/*
Tejun Heo32704762012-07-13 22:16:45 -0700628 * Policy functions. These define the policies on how the global worker
629 * pools are managed. Unless noted otherwise, these functions assume that
630 * they're being called with gcwq->lock held.
David Howells365970a2006-11-22 14:54:49 +0000631 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200632
Tejun Heo63d95a92012-07-12 14:46:37 -0700633static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000634{
Tejun Heo32704762012-07-13 22:16:45 -0700635 return !atomic_read(get_pool_nr_running(pool));
David Howells365970a2006-11-22 14:54:49 +0000636}
637
Tejun Heoe22bee72010-06-29 10:07:14 +0200638/*
639 * Need to wake up a worker? Called from anything but currently
640 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700641 *
642 * Note that, because unbound workers never contribute to nr_running, this
643 * function will always return %true for unbound gcwq as long as the
644 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200645 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700646static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000647{
Tejun Heo63d95a92012-07-12 14:46:37 -0700648 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000649}
650
Tejun Heoe22bee72010-06-29 10:07:14 +0200651/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700652static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200653{
Tejun Heo63d95a92012-07-12 14:46:37 -0700654 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200655}
656
657/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700658static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200659{
Tejun Heo63d95a92012-07-12 14:46:37 -0700660 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200661
Tejun Heo32704762012-07-13 22:16:45 -0700662 return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200663}
664
665/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700666static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200667{
Tejun Heo63d95a92012-07-12 14:46:37 -0700668 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200669}
670
671/* Do I need to be the manager? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700672static bool need_to_manage_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200673{
Tejun Heo63d95a92012-07-12 14:46:37 -0700674 return need_to_create_worker(pool) ||
Tejun Heo11ebea52012-07-12 14:46:37 -0700675 (pool->flags & POOL_MANAGE_WORKERS);
Tejun Heoe22bee72010-06-29 10:07:14 +0200676}
677
678/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700679static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200680{
Lai Jiangshan552a37e2012-09-10 10:03:33 -0700681 bool managing = pool->flags & POOL_MANAGING_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -0700682 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
683 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200684
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700685 /*
686 * nr_idle and idle_list may disagree if idle rebinding is in
687 * progress. Never return %true if idle_list is empty.
688 */
689 if (list_empty(&pool->idle_list))
690 return false;
691
Tejun Heoe22bee72010-06-29 10:07:14 +0200692 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
693}
694
695/*
696 * Wake up functions.
697 */
698
Tejun Heo7e116292010-06-29 10:07:13 +0200699/* Return the first worker. Safe with preemption disabled */
Tejun Heo63d95a92012-07-12 14:46:37 -0700700static struct worker *first_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200701{
Tejun Heo63d95a92012-07-12 14:46:37 -0700702 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200703 return NULL;
704
Tejun Heo63d95a92012-07-12 14:46:37 -0700705 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200706}
707
708/**
709 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700710 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200711 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700712 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200713 *
714 * CONTEXT:
715 * spin_lock_irq(gcwq->lock).
716 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700717static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200718{
Tejun Heo63d95a92012-07-12 14:46:37 -0700719 struct worker *worker = first_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200720
721 if (likely(worker))
722 wake_up_process(worker->task);
723}
724
Tejun Heo4690c4a2010-06-29 10:07:10 +0200725/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200726 * wq_worker_waking_up - a worker is waking up
727 * @task: task waking up
728 * @cpu: CPU @task is waking up to
729 *
730 * This function is called during try_to_wake_up() when a worker is
731 * being awoken.
732 *
733 * CONTEXT:
734 * spin_lock_irq(rq->lock)
735 */
736void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
737{
738 struct worker *worker = kthread_data(task);
739
Joonsoo Kim36576002012-10-26 23:03:49 +0900740 if (!(worker->flags & WORKER_NOT_RUNNING)) {
741 WARN_ON_ONCE(worker->pool->gcwq->cpu != cpu);
Tejun Heo63d95a92012-07-12 14:46:37 -0700742 atomic_inc(get_pool_nr_running(worker->pool));
Joonsoo Kim36576002012-10-26 23:03:49 +0900743 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200744}
745
746/**
747 * wq_worker_sleeping - a worker is going to sleep
748 * @task: task going to sleep
749 * @cpu: CPU in question, must be the current CPU number
750 *
751 * This function is called during schedule() when a busy worker is
752 * going to sleep. Worker on the same cpu can be woken up by
753 * returning pointer to its task.
754 *
755 * CONTEXT:
756 * spin_lock_irq(rq->lock)
757 *
758 * RETURNS:
759 * Worker task on @cpu to wake up, %NULL if none.
760 */
761struct task_struct *wq_worker_sleeping(struct task_struct *task,
762 unsigned int cpu)
763{
764 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heobd7bdd42012-07-12 14:46:37 -0700765 struct worker_pool *pool = worker->pool;
Tejun Heo63d95a92012-07-12 14:46:37 -0700766 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200767
Steven Rostedt2d646722010-12-03 23:12:33 -0500768 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200769 return NULL;
770
771 /* this can only happen on the local cpu */
772 BUG_ON(cpu != raw_smp_processor_id());
773
774 /*
775 * The counterpart of the following dec_and_test, implied mb,
776 * worklist not empty test sequence is in insert_work().
777 * Please read comment there.
778 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700779 * NOT_RUNNING is clear. This means that we're bound to and
780 * running on the local cpu w/ rq lock held and preemption
781 * disabled, which in turn means that none else could be
782 * manipulating idle_list, so dereferencing idle_list without gcwq
783 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200784 */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700785 if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700786 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200787 return to_wakeup ? to_wakeup->task : NULL;
788}
789
790/**
791 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200792 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200793 * @flags: flags to set
794 * @wakeup: wakeup an idle worker if necessary
795 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200796 * Set @flags in @worker->flags and adjust nr_running accordingly. If
797 * nr_running becomes zero and @wakeup is %true, an idle worker is
798 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200799 *
Tejun Heocb444762010-07-02 10:03:50 +0200800 * CONTEXT:
801 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200802 */
803static inline void worker_set_flags(struct worker *worker, unsigned int flags,
804 bool wakeup)
805{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700806 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200807
Tejun Heocb444762010-07-02 10:03:50 +0200808 WARN_ON_ONCE(worker->task != current);
809
Tejun Heoe22bee72010-06-29 10:07:14 +0200810 /*
811 * If transitioning into NOT_RUNNING, adjust nr_running and
812 * wake up an idle worker as necessary if requested by
813 * @wakeup.
814 */
815 if ((flags & WORKER_NOT_RUNNING) &&
816 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heo63d95a92012-07-12 14:46:37 -0700817 atomic_t *nr_running = get_pool_nr_running(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200818
819 if (wakeup) {
820 if (atomic_dec_and_test(nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700821 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700822 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200823 } else
824 atomic_dec(nr_running);
825 }
826
Tejun Heod302f012010-06-29 10:07:13 +0200827 worker->flags |= flags;
828}
829
830/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200831 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200832 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200833 * @flags: flags to clear
834 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200835 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200836 *
Tejun Heocb444762010-07-02 10:03:50 +0200837 * CONTEXT:
838 * spin_lock_irq(gcwq->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200839 */
840static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
841{
Tejun Heo63d95a92012-07-12 14:46:37 -0700842 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200843 unsigned int oflags = worker->flags;
844
Tejun Heocb444762010-07-02 10:03:50 +0200845 WARN_ON_ONCE(worker->task != current);
846
Tejun Heod302f012010-06-29 10:07:13 +0200847 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200848
Tejun Heo42c025f2011-01-11 15:58:49 +0100849 /*
850 * If transitioning out of NOT_RUNNING, increment nr_running. Note
851 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
852 * of multiple flags, not a single flag.
853 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200854 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
855 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heo63d95a92012-07-12 14:46:37 -0700856 atomic_inc(get_pool_nr_running(pool));
Tejun Heod302f012010-06-29 10:07:13 +0200857}
858
859/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200860 * find_worker_executing_work - find worker which is executing a work
861 * @gcwq: gcwq of interest
862 * @work: work to find worker for
863 *
864 * Find a worker which is executing @work on @gcwq. This function is
865 * identical to __find_worker_executing_work() except that this
866 * function calculates @bwh itself.
867 *
868 * CONTEXT:
869 * spin_lock_irq(gcwq->lock).
870 *
871 * RETURNS:
872 * Pointer to worker which is executing @work if found, NULL
873 * otherwise.
874 */
875static struct worker *find_worker_executing_work(struct global_cwq *gcwq,
876 struct work_struct *work)
877{
Sasha Levin42f85702012-12-17 10:01:23 -0500878 struct worker *worker;
879 struct hlist_node *tmp;
880
881 hash_for_each_possible(gcwq->busy_hash, worker, tmp, hentry, (unsigned long)work)
882 if (worker->current_work == work)
883 return worker;
884
885 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200886}
887
888/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700889 * move_linked_works - move linked works to a list
890 * @work: start of series of works to be scheduled
891 * @head: target list to append @work to
892 * @nextp: out paramter for nested worklist walking
893 *
894 * Schedule linked works starting from @work to @head. Work series to
895 * be scheduled starts at @work and includes any consecutive work with
896 * WORK_STRUCT_LINKED set in its predecessor.
897 *
898 * If @nextp is not NULL, it's updated to point to the next work of
899 * the last scheduled work. This allows move_linked_works() to be
900 * nested inside outer list_for_each_entry_safe().
901 *
902 * CONTEXT:
903 * spin_lock_irq(gcwq->lock).
904 */
905static void move_linked_works(struct work_struct *work, struct list_head *head,
906 struct work_struct **nextp)
907{
908 struct work_struct *n;
909
910 /*
911 * Linked worklist will always end before the end of the list,
912 * use NULL for list head.
913 */
914 list_for_each_entry_safe_from(work, n, NULL, entry) {
915 list_move_tail(&work->entry, head);
916 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
917 break;
918 }
919
920 /*
921 * If we're already inside safe list traversal and have moved
922 * multiple works to the scheduled queue, the next position
923 * needs to be updated.
924 */
925 if (nextp)
926 *nextp = n;
927}
928
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700929static void cwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -0700930{
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700931 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -0700932
933 trace_workqueue_activate_work(work);
934 move_linked_works(work, &cwq->pool->worklist, NULL);
935 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
936 cwq->nr_active++;
937}
938
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700939static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq)
940{
941 struct work_struct *work = list_first_entry(&cwq->delayed_works,
942 struct work_struct, entry);
943
944 cwq_activate_delayed_work(work);
945}
946
Tejun Heobf4ede02012-08-03 10:30:46 -0700947/**
948 * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight
949 * @cwq: cwq of interest
950 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -0700951 *
952 * A work either has completed or is removed from pending queue,
953 * decrement nr_in_flight of its cwq and handle workqueue flushing.
954 *
955 * CONTEXT:
956 * spin_lock_irq(gcwq->lock).
957 */
Lai Jiangshanb3f9f402012-09-18 10:40:00 -0700958static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -0700959{
960 /* ignore uncolored works */
961 if (color == WORK_NO_COLOR)
962 return;
963
964 cwq->nr_in_flight[color]--;
965
Lai Jiangshanb3f9f402012-09-18 10:40:00 -0700966 cwq->nr_active--;
967 if (!list_empty(&cwq->delayed_works)) {
968 /* one down, submit a delayed one */
969 if (cwq->nr_active < cwq->max_active)
970 cwq_activate_first_delayed(cwq);
Tejun Heobf4ede02012-08-03 10:30:46 -0700971 }
972
973 /* is flush in progress and are we at the flushing tip? */
974 if (likely(cwq->flush_color != color))
975 return;
976
977 /* are there still in-flight works? */
978 if (cwq->nr_in_flight[color])
979 return;
980
981 /* this cwq is done, clear flush_color */
982 cwq->flush_color = -1;
983
984 /*
985 * If this was the last cwq, wake up the first flusher. It
986 * will handle the rest.
987 */
988 if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush))
989 complete(&cwq->wq->first_flusher->done);
990}
991
Tejun Heo36e227d2012-08-03 10:30:46 -0700992/**
Tejun Heobbb68df2012-08-03 10:30:46 -0700993 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -0700994 * @work: work item to steal
995 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -0700996 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -0700997 *
998 * Try to grab PENDING bit of @work. This function can handle @work in any
999 * stable state - idle, on timer or on worklist. Return values are
1000 *
1001 * 1 if @work was pending and we successfully stole PENDING
1002 * 0 if @work was idle and we claimed PENDING
1003 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001004 * -ENOENT if someone else is canceling @work, this state may persist
1005 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001006 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001007 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001008 * interrupted while holding PENDING and @work off queue, irq must be
1009 * disabled on entry. This, combined with delayed_work->timer being
1010 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001011 *
1012 * On successful return, >= 0, irq is disabled and the caller is
1013 * responsible for releasing it using local_irq_restore(*@flags).
1014 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001015 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001016 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001017static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1018 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001019{
1020 struct global_cwq *gcwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001021
Tejun Heobbb68df2012-08-03 10:30:46 -07001022 local_irq_save(*flags);
1023
Tejun Heo36e227d2012-08-03 10:30:46 -07001024 /* try to steal the timer if it exists */
1025 if (is_dwork) {
1026 struct delayed_work *dwork = to_delayed_work(work);
1027
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001028 /*
1029 * dwork->timer is irqsafe. If del_timer() fails, it's
1030 * guaranteed that the timer is not queued anywhere and not
1031 * running on the local CPU.
1032 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001033 if (likely(del_timer(&dwork->timer)))
1034 return 1;
1035 }
1036
1037 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001038 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1039 return 0;
1040
1041 /*
1042 * The queueing is in progress, or it is already queued. Try to
1043 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1044 */
1045 gcwq = get_work_gcwq(work);
1046 if (!gcwq)
Tejun Heobbb68df2012-08-03 10:30:46 -07001047 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001048
Tejun Heobbb68df2012-08-03 10:30:46 -07001049 spin_lock(&gcwq->lock);
Tejun Heobf4ede02012-08-03 10:30:46 -07001050 if (!list_empty(&work->entry)) {
1051 /*
1052 * This work is queued, but perhaps we locked the wrong gcwq.
1053 * In that case we must see the new value after rmb(), see
1054 * insert_work()->wmb().
1055 */
1056 smp_rmb();
1057 if (gcwq == get_work_gcwq(work)) {
1058 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001059
1060 /*
1061 * A delayed work item cannot be grabbed directly
1062 * because it might have linked NO_COLOR work items
1063 * which, if left on the delayed_list, will confuse
1064 * cwq->nr_active management later on and cause
1065 * stall. Make sure the work item is activated
1066 * before grabbing.
1067 */
1068 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1069 cwq_activate_delayed_work(work);
1070
Tejun Heobf4ede02012-08-03 10:30:46 -07001071 list_del_init(&work->entry);
1072 cwq_dec_nr_in_flight(get_work_cwq(work),
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001073 get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001074
Tejun Heobbb68df2012-08-03 10:30:46 -07001075 spin_unlock(&gcwq->lock);
Tejun Heo36e227d2012-08-03 10:30:46 -07001076 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001077 }
1078 }
Tejun Heobbb68df2012-08-03 10:30:46 -07001079 spin_unlock(&gcwq->lock);
1080fail:
1081 local_irq_restore(*flags);
1082 if (work_is_canceling(work))
1083 return -ENOENT;
1084 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001085 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001086}
1087
1088/**
Tejun Heo7e116292010-06-29 10:07:13 +02001089 * insert_work - insert a work into gcwq
Tejun Heo4690c4a2010-06-29 10:07:10 +02001090 * @cwq: cwq @work belongs to
1091 * @work: work to insert
1092 * @head: insertion point
1093 * @extra_flags: extra WORK_STRUCT_* flags to set
1094 *
Tejun Heo7e116292010-06-29 10:07:13 +02001095 * Insert @work which belongs to @cwq into @gcwq after @head.
1096 * @extra_flags is or'd to work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001097 *
1098 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001099 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001100 */
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001101static void insert_work(struct cpu_workqueue_struct *cwq,
Tejun Heo4690c4a2010-06-29 10:07:10 +02001102 struct work_struct *work, struct list_head *head,
1103 unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001104{
Tejun Heo63d95a92012-07-12 14:46:37 -07001105 struct worker_pool *pool = cwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001106
Tejun Heo4690c4a2010-06-29 10:07:10 +02001107 /* we own @work, set data and link */
Tejun Heo7a22ad72010-06-29 10:07:13 +02001108 set_work_cwq(work, cwq, extra_flags);
Tejun Heo4690c4a2010-06-29 10:07:10 +02001109
Oleg Nesterov6e84d642007-05-09 02:34:46 -07001110 /*
1111 * Ensure that we get the right work->data if we see the
1112 * result of list_add() below, see try_to_grab_pending().
1113 */
1114 smp_wmb();
Tejun Heo4690c4a2010-06-29 10:07:10 +02001115
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001116 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +02001117
1118 /*
1119 * Ensure either worker_sched_deactivated() sees the above
1120 * list_add_tail() or we see zero nr_running to avoid workers
1121 * lying around lazily while there are works to be processed.
1122 */
1123 smp_mb();
1124
Tejun Heo63d95a92012-07-12 14:46:37 -07001125 if (__need_more_worker(pool))
1126 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001127}
1128
Tejun Heoc8efcc22010-12-20 19:32:04 +01001129/*
1130 * Test whether @work is being queued from another work executing on the
1131 * same workqueue. This is rather expensive and should only be used from
1132 * cold paths.
1133 */
1134static bool is_chained_work(struct workqueue_struct *wq)
1135{
1136 unsigned long flags;
1137 unsigned int cpu;
1138
1139 for_each_gcwq_cpu(cpu) {
1140 struct global_cwq *gcwq = get_gcwq(cpu);
1141 struct worker *worker;
1142 struct hlist_node *pos;
1143 int i;
1144
1145 spin_lock_irqsave(&gcwq->lock, flags);
1146 for_each_busy_worker(worker, i, pos, gcwq) {
1147 if (worker->task != current)
1148 continue;
1149 spin_unlock_irqrestore(&gcwq->lock, flags);
1150 /*
1151 * I'm @worker, no locking necessary. See if @work
1152 * is headed to the same workqueue.
1153 */
1154 return worker->current_cwq->wq == wq;
1155 }
1156 spin_unlock_irqrestore(&gcwq->lock, flags);
1157 }
1158 return false;
1159}
1160
Tejun Heo4690c4a2010-06-29 10:07:10 +02001161static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 struct work_struct *work)
1163{
Tejun Heo502ca9d2010-06-29 10:07:13 +02001164 struct global_cwq *gcwq;
1165 struct cpu_workqueue_struct *cwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001166 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001167 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001168 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001169
1170 /*
1171 * While a work item is PENDING && off queue, a task trying to
1172 * steal the PENDING will busy-loop waiting for it to either get
1173 * queued or lose PENDING. Grabbing PENDING and queueing should
1174 * happen with IRQ disabled.
1175 */
1176 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001178 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001179
Tejun Heoc8efcc22010-12-20 19:32:04 +01001180 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02001181 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001182 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001183 return;
1184
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001185 /* determine gcwq to use */
1186 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001187 struct global_cwq *last_gcwq;
1188
Tejun Heo57469822012-08-03 10:30:45 -07001189 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001190 cpu = raw_smp_processor_id();
1191
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001192 /*
Tejun Heodbf25762012-08-20 14:51:23 -07001193 * It's multi cpu. If @work was previously on a different
1194 * cpu, it might still be running there, in which case the
1195 * work needs to be queued on that cpu to guarantee
1196 * non-reentrancy.
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001197 */
Tejun Heo502ca9d2010-06-29 10:07:13 +02001198 gcwq = get_gcwq(cpu);
Tejun Heodbf25762012-08-20 14:51:23 -07001199 last_gcwq = get_work_gcwq(work);
1200
1201 if (last_gcwq && last_gcwq != gcwq) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001202 struct worker *worker;
1203
Tejun Heo8930cab2012-08-03 10:30:45 -07001204 spin_lock(&last_gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001205
1206 worker = find_worker_executing_work(last_gcwq, work);
1207
1208 if (worker && worker->current_cwq->wq == wq)
1209 gcwq = last_gcwq;
1210 else {
1211 /* meh... not running there, queue here */
Tejun Heo8930cab2012-08-03 10:30:45 -07001212 spin_unlock(&last_gcwq->lock);
1213 spin_lock(&gcwq->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001214 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001215 } else {
1216 spin_lock(&gcwq->lock);
1217 }
Tejun Heof3421792010-07-02 10:03:51 +02001218 } else {
1219 gcwq = get_gcwq(WORK_CPU_UNBOUND);
Tejun Heo8930cab2012-08-03 10:30:45 -07001220 spin_lock(&gcwq->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001221 }
1222
1223 /* gcwq determined, get cwq and queue */
1224 cwq = get_cwq(gcwq->cpu, wq);
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001225 trace_workqueue_queue_work(req_cpu, cwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001226
Dan Carpenterf5b25522012-04-13 22:06:58 +03001227 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo8930cab2012-08-03 10:30:45 -07001228 spin_unlock(&gcwq->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001229 return;
1230 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001231
Tejun Heo73f53c42010-06-29 10:07:11 +02001232 cwq->nr_in_flight[cwq->work_color]++;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001233 work_flags = work_color_to_flags(cwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001234
1235 if (likely(cwq->nr_active < cwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001236 trace_workqueue_activate_work(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001237 cwq->nr_active++;
Tejun Heo32704762012-07-13 22:16:45 -07001238 worklist = &cwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001239 } else {
1240 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001241 worklist = &cwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001242 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001243
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001244 insert_work(cwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001245
Tejun Heo8930cab2012-08-03 10:30:45 -07001246 spin_unlock(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247}
1248
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001249/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001250 * queue_work_on - queue work on specific cpu
1251 * @cpu: CPU number to execute work on
1252 * @wq: workqueue to use
1253 * @work: work to queue
1254 *
Tejun Heod4283e92012-08-03 10:30:44 -07001255 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001256 *
1257 * We queue the work to a specific CPU, the caller must ensure it
1258 * can't go away.
1259 */
Tejun Heod4283e92012-08-03 10:30:44 -07001260bool queue_work_on(int cpu, struct workqueue_struct *wq,
1261 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001262{
Tejun Heod4283e92012-08-03 10:30:44 -07001263 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001264 unsigned long flags;
1265
1266 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001267
Tejun Heo22df02b2010-06-29 10:07:10 +02001268 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001269 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001270 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001271 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001272
1273 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001274 return ret;
1275}
1276EXPORT_SYMBOL_GPL(queue_work_on);
1277
Tejun Heo0a13c002012-08-03 10:30:44 -07001278/**
1279 * queue_work - queue work on a workqueue
1280 * @wq: workqueue to use
1281 * @work: work to queue
1282 *
Tejun Heod4283e92012-08-03 10:30:44 -07001283 * Returns %false if @work was already on a queue, %true otherwise.
Tejun Heo0a13c002012-08-03 10:30:44 -07001284 *
1285 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1286 * it can be processed by another CPU.
1287 */
Tejun Heod4283e92012-08-03 10:30:44 -07001288bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07001289{
Tejun Heo57469822012-08-03 10:30:45 -07001290 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
Tejun Heo0a13c002012-08-03 10:30:44 -07001291}
1292EXPORT_SYMBOL_GPL(queue_work);
1293
Tejun Heod8e794d2012-08-03 10:30:45 -07001294void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295{
David Howells52bad642006-11-22 14:54:01 +00001296 struct delayed_work *dwork = (struct delayed_work *)__data;
Tejun Heo7a22ad72010-06-29 10:07:13 +02001297 struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001299 /* should have been called from irqsafe timer with irq already off */
Tejun Heo12650572012-08-08 09:38:42 -07001300 __queue_work(dwork->cpu, cwq->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301}
Tejun Heod8e794d2012-08-03 10:30:45 -07001302EXPORT_SYMBOL_GPL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001304static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1305 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001307 struct timer_list *timer = &dwork->timer;
1308 struct work_struct *work = &dwork->work;
1309 unsigned int lcpu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001311 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1312 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001313 WARN_ON_ONCE(timer_pending(timer));
1314 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001315
Tejun Heo8852aac2012-12-01 16:23:42 -08001316 /*
1317 * If @delay is 0, queue @dwork->work immediately. This is for
1318 * both optimization and correctness. The earliest @timer can
1319 * expire is on the closest next tick and delayed_work users depend
1320 * on that there's no such delay when @delay is 0.
1321 */
1322 if (!delay) {
1323 __queue_work(cpu, wq, &dwork->work);
1324 return;
1325 }
1326
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001327 timer_stats_timer_set_start_info(&dwork->timer);
1328
1329 /*
1330 * This stores cwq for the moment, for the timer_fn. Note that the
1331 * work's gcwq is preserved to allow reentrance detection for
1332 * delayed works.
1333 */
1334 if (!(wq->flags & WQ_UNBOUND)) {
1335 struct global_cwq *gcwq = get_work_gcwq(work);
1336
Joonsoo Kime42986d2012-08-15 23:25:38 +09001337 /*
1338 * If we cannot get the last gcwq from @work directly,
1339 * select the last CPU such that it avoids unnecessarily
1340 * triggering non-reentrancy check in __queue_work().
1341 */
1342 lcpu = cpu;
1343 if (gcwq)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001344 lcpu = gcwq->cpu;
Joonsoo Kime42986d2012-08-15 23:25:38 +09001345 if (lcpu == WORK_CPU_UNBOUND)
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001346 lcpu = raw_smp_processor_id();
1347 } else {
1348 lcpu = WORK_CPU_UNBOUND;
1349 }
1350
1351 set_work_cwq(work, get_cwq(lcpu, wq), 0);
1352
Tejun Heo12650572012-08-08 09:38:42 -07001353 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001354 timer->expires = jiffies + delay;
1355
1356 if (unlikely(cpu != WORK_CPU_UNBOUND))
1357 add_timer_on(timer, cpu);
1358 else
1359 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360}
1361
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001362/**
1363 * queue_delayed_work_on - queue work on specific CPU after delay
1364 * @cpu: CPU number to execute work on
1365 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001366 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001367 * @delay: number of jiffies to wait before queueing
1368 *
Tejun Heo715f1302012-08-03 10:30:46 -07001369 * Returns %false if @work was already on a queue, %true otherwise. If
1370 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1371 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001372 */
Tejun Heod4283e92012-08-03 10:30:44 -07001373bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1374 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001375{
David Howells52bad642006-11-22 14:54:01 +00001376 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001377 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001378 unsigned long flags;
1379
1380 /* read the comment in __queue_work() */
1381 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001382
Tejun Heo22df02b2010-06-29 10:07:10 +02001383 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001384 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001385 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001386 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001387
1388 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001389 return ret;
1390}
Dave Jonesae90dd52006-06-30 01:40:45 -04001391EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
Tejun Heoc8e55f32010-06-29 10:07:12 +02001393/**
Tejun Heo0a13c002012-08-03 10:30:44 -07001394 * queue_delayed_work - queue work on a workqueue after delay
1395 * @wq: workqueue to use
1396 * @dwork: delayable work to queue
1397 * @delay: number of jiffies to wait before queueing
1398 *
Tejun Heo715f1302012-08-03 10:30:46 -07001399 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
Tejun Heo0a13c002012-08-03 10:30:44 -07001400 */
Tejun Heod4283e92012-08-03 10:30:44 -07001401bool queue_delayed_work(struct workqueue_struct *wq,
Tejun Heo0a13c002012-08-03 10:30:44 -07001402 struct delayed_work *dwork, unsigned long delay)
1403{
Tejun Heo57469822012-08-03 10:30:45 -07001404 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
Tejun Heo0a13c002012-08-03 10:30:44 -07001405}
1406EXPORT_SYMBOL_GPL(queue_delayed_work);
1407
1408/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001409 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1410 * @cpu: CPU number to execute work on
1411 * @wq: workqueue to use
1412 * @dwork: work to queue
1413 * @delay: number of jiffies to wait before queueing
1414 *
1415 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1416 * modify @dwork's timer so that it expires after @delay. If @delay is
1417 * zero, @work is guaranteed to be scheduled immediately regardless of its
1418 * current state.
1419 *
1420 * Returns %false if @dwork was idle and queued, %true if @dwork was
1421 * pending and its timer was modified.
1422 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001423 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001424 * See try_to_grab_pending() for details.
1425 */
1426bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1427 struct delayed_work *dwork, unsigned long delay)
1428{
1429 unsigned long flags;
1430 int ret;
1431
1432 do {
1433 ret = try_to_grab_pending(&dwork->work, true, &flags);
1434 } while (unlikely(ret == -EAGAIN));
1435
1436 if (likely(ret >= 0)) {
1437 __queue_delayed_work(cpu, wq, dwork, delay);
1438 local_irq_restore(flags);
1439 }
1440
1441 /* -ENOENT from try_to_grab_pending() becomes %true */
1442 return ret;
1443}
1444EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1445
1446/**
1447 * mod_delayed_work - modify delay of or queue a delayed work
1448 * @wq: workqueue to use
1449 * @dwork: work to queue
1450 * @delay: number of jiffies to wait before queueing
1451 *
1452 * mod_delayed_work_on() on local CPU.
1453 */
1454bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1455 unsigned long delay)
1456{
1457 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1458}
1459EXPORT_SYMBOL_GPL(mod_delayed_work);
1460
1461/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001462 * worker_enter_idle - enter idle state
1463 * @worker: worker which is entering idle state
1464 *
1465 * @worker is entering idle state. Update stats and idle timer if
1466 * necessary.
1467 *
1468 * LOCKING:
1469 * spin_lock_irq(gcwq->lock).
1470 */
1471static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001473 struct worker_pool *pool = worker->pool;
1474 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475
Tejun Heoc8e55f32010-06-29 10:07:12 +02001476 BUG_ON(worker->flags & WORKER_IDLE);
1477 BUG_ON(!list_empty(&worker->entry) &&
1478 (worker->hentry.next || worker->hentry.pprev));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479
Tejun Heocb444762010-07-02 10:03:50 +02001480 /* can't use worker_set_flags(), also called from start_worker() */
1481 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001482 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001483 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001484
Tejun Heoc8e55f32010-06-29 10:07:12 +02001485 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001486 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001487
Tejun Heo628c78e2012-07-17 12:39:27 -07001488 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1489 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001490
Tejun Heo544ecf32012-05-14 15:04:50 -07001491 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07001492 * Sanity check nr_running. Because gcwq_unbind_fn() releases
1493 * gcwq->lock between setting %WORKER_UNBOUND and zapping
1494 * nr_running, the warning may trigger spuriously. Check iff
1495 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001496 */
Tejun Heo628c78e2012-07-17 12:39:27 -07001497 WARN_ON_ONCE(!(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001498 pool->nr_workers == pool->nr_idle &&
Tejun Heo63d95a92012-07-12 14:46:37 -07001499 atomic_read(get_pool_nr_running(pool)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500}
1501
Tejun Heoc8e55f32010-06-29 10:07:12 +02001502/**
1503 * worker_leave_idle - leave idle state
1504 * @worker: worker which is leaving idle state
1505 *
1506 * @worker is leaving idle state. Update stats.
1507 *
1508 * LOCKING:
1509 * spin_lock_irq(gcwq->lock).
1510 */
1511static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001513 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514
Tejun Heoc8e55f32010-06-29 10:07:12 +02001515 BUG_ON(!(worker->flags & WORKER_IDLE));
Tejun Heod302f012010-06-29 10:07:13 +02001516 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001517 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001518 list_del_init(&worker->entry);
1519}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Tejun Heoe22bee72010-06-29 10:07:14 +02001521/**
1522 * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq
1523 * @worker: self
1524 *
1525 * Works which are scheduled while the cpu is online must at least be
1526 * scheduled to a worker which is bound to the cpu so that if they are
1527 * flushed from cpu callbacks while cpu is going down, they are
1528 * guaranteed to execute on the cpu.
1529 *
1530 * This function is to be used by rogue workers and rescuers to bind
1531 * themselves to the target cpu and may race with cpu going down or
1532 * coming online. kthread_bind() can't be used because it may put the
1533 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
1534 * verbatim as it's best effort and blocking and gcwq may be
1535 * [dis]associated in the meantime.
1536 *
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001537 * This function tries set_cpus_allowed() and locks gcwq and verifies the
1538 * binding against %GCWQ_DISASSOCIATED which is set during
1539 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1540 * enters idle state or fetches works without dropping lock, it can
1541 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001542 *
1543 * CONTEXT:
1544 * Might sleep. Called without any lock but returns with gcwq->lock
1545 * held.
1546 *
1547 * RETURNS:
1548 * %true if the associated gcwq is online (@worker is successfully
1549 * bound), %false if offline.
1550 */
1551static bool worker_maybe_bind_and_lock(struct worker *worker)
Namhyung Kim972fa1c2010-08-22 23:19:43 +09001552__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001553{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001554 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001555 struct task_struct *task = worker->task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
Tejun Heoe22bee72010-06-29 10:07:14 +02001557 while (true) {
1558 /*
1559 * The following call may fail, succeed or succeed
1560 * without actually migrating the task to the cpu if
1561 * it races with cpu hotunplug operation. Verify
1562 * against GCWQ_DISASSOCIATED.
1563 */
Tejun Heof3421792010-07-02 10:03:51 +02001564 if (!(gcwq->flags & GCWQ_DISASSOCIATED))
1565 set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001566
Tejun Heoe22bee72010-06-29 10:07:14 +02001567 spin_lock_irq(&gcwq->lock);
1568 if (gcwq->flags & GCWQ_DISASSOCIATED)
1569 return false;
1570 if (task_cpu(task) == gcwq->cpu &&
1571 cpumask_equal(&current->cpus_allowed,
1572 get_cpu_mask(gcwq->cpu)))
1573 return true;
1574 spin_unlock_irq(&gcwq->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001575
Tejun Heo5035b202011-04-29 18:08:37 +02001576 /*
1577 * We've raced with CPU hot[un]plug. Give it a breather
1578 * and retry migration. cond_resched() is required here;
1579 * otherwise, we might deadlock against cpu_stop trying to
1580 * bring down the CPU on non-preemptive kernel.
1581 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001582 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001583 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001584 }
1585}
1586
1587/*
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001588 * Rebind an idle @worker to its CPU. worker_thread() will test
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001589 * list_empty(@worker->entry) before leaving idle and call this function.
Tejun Heo25511a42012-07-17 12:39:27 -07001590 */
1591static void idle_worker_rebind(struct worker *worker)
1592{
1593 struct global_cwq *gcwq = worker->pool->gcwq;
1594
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001595 /* CPU may go down again inbetween, clear UNBOUND only on success */
1596 if (worker_maybe_bind_and_lock(worker))
1597 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heo25511a42012-07-17 12:39:27 -07001598
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001599 /* rebind complete, become available again */
1600 list_add(&worker->entry, &worker->pool->idle_list);
1601 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07001602}
1603
1604/*
1605 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001606 * the associated cpu which is coming back online. This is scheduled by
1607 * cpu up but can race with other cpu hotplug operations and may be
1608 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001609 */
Tejun Heo25511a42012-07-17 12:39:27 -07001610static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001611{
1612 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001613 struct global_cwq *gcwq = worker->pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001614
Lai Jiangshaneab6d822012-09-18 09:59:22 -07001615 if (worker_maybe_bind_and_lock(worker))
1616 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02001617
1618 spin_unlock_irq(&gcwq->lock);
1619}
1620
Tejun Heo25511a42012-07-17 12:39:27 -07001621/**
1622 * rebind_workers - rebind all workers of a gcwq to the associated CPU
1623 * @gcwq: gcwq of interest
1624 *
1625 * @gcwq->cpu is coming online. Rebind all workers to the CPU. Rebinding
1626 * is different for idle and busy ones.
1627 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001628 * Idle ones will be removed from the idle_list and woken up. They will
1629 * add themselves back after completing rebind. This ensures that the
1630 * idle_list doesn't contain any unbound workers when re-bound busy workers
1631 * try to perform local wake-ups for concurrency management.
Tejun Heo25511a42012-07-17 12:39:27 -07001632 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001633 * Busy workers can rebind after they finish their current work items.
1634 * Queueing the rebind work item at the head of the scheduled list is
1635 * enough. Note that nr_running will be properly bumped as busy workers
1636 * rebind.
Tejun Heo25511a42012-07-17 12:39:27 -07001637 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001638 * On return, all non-manager workers are scheduled for rebind - see
1639 * manage_workers() for the manager special case. Any idle worker
1640 * including the manager will not appear on @idle_list until rebind is
1641 * complete, making local wake-ups safe.
Tejun Heo25511a42012-07-17 12:39:27 -07001642 */
1643static void rebind_workers(struct global_cwq *gcwq)
Tejun Heo25511a42012-07-17 12:39:27 -07001644{
Tejun Heo25511a42012-07-17 12:39:27 -07001645 struct worker_pool *pool;
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001646 struct worker *worker, *n;
Tejun Heo25511a42012-07-17 12:39:27 -07001647 struct hlist_node *pos;
1648 int i;
1649
1650 lockdep_assert_held(&gcwq->lock);
1651
1652 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07001653 lockdep_assert_held(&pool->assoc_mutex);
Tejun Heo25511a42012-07-17 12:39:27 -07001654
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001655 /* dequeue and kick idle ones */
Tejun Heo25511a42012-07-17 12:39:27 -07001656 for_each_worker_pool(pool, gcwq) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001657 list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001658 /*
1659 * idle workers should be off @pool->idle_list
1660 * until rebind is complete to avoid receiving
1661 * premature local wake-ups.
1662 */
1663 list_del_init(&worker->entry);
Lai Jiangshan96e65302012-09-02 00:28:19 +08001664
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001665 /*
1666 * worker_thread() will see the above dequeuing
1667 * and call idle_worker_rebind().
1668 */
Tejun Heo25511a42012-07-17 12:39:27 -07001669 wake_up_process(worker->task);
1670 }
1671 }
1672
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001673 /* rebind busy workers */
Tejun Heo25511a42012-07-17 12:39:27 -07001674 for_each_busy_worker(worker, i, pos, gcwq) {
1675 struct work_struct *rebind_work = &worker->rebind_work;
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001676 struct workqueue_struct *wq;
Tejun Heo25511a42012-07-17 12:39:27 -07001677
1678 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1679 work_data_bits(rebind_work)))
1680 continue;
1681
Tejun Heo25511a42012-07-17 12:39:27 -07001682 debug_work_activate(rebind_work);
Tejun Heo90beca52012-09-04 23:12:33 -07001683
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001684 /*
1685 * wq doesn't really matter but let's keep @worker->pool
1686 * and @cwq->pool consistent for sanity.
1687 */
1688 if (worker_pool_pri(worker->pool))
1689 wq = system_highpri_wq;
1690 else
1691 wq = system_wq;
Tejun Heoec588152012-09-04 23:16:32 -07001692
Joonsoo Kime2b6a6d2012-08-15 23:25:40 +09001693 insert_work(get_cwq(gcwq->cpu, wq), rebind_work,
1694 worker->scheduled.next,
1695 work_color_to_flags(WORK_NO_COLOR));
Tejun Heoec588152012-09-04 23:16:32 -07001696 }
Tejun Heo25511a42012-07-17 12:39:27 -07001697}
1698
Tejun Heoc34056a2010-06-29 10:07:11 +02001699static struct worker *alloc_worker(void)
1700{
1701 struct worker *worker;
1702
1703 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001704 if (worker) {
1705 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001706 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001707 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001708 /* on creation a worker is in !idle && prep state */
1709 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001710 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001711 return worker;
1712}
1713
1714/**
1715 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001716 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001717 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001718 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001719 * can be started by calling start_worker() or destroyed using
1720 * destroy_worker().
1721 *
1722 * CONTEXT:
1723 * Might sleep. Does GFP_KERNEL allocations.
1724 *
1725 * RETURNS:
1726 * Pointer to the newly created worker.
1727 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001728static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001729{
Tejun Heo63d95a92012-07-12 14:46:37 -07001730 struct global_cwq *gcwq = pool->gcwq;
Tejun Heo32704762012-07-13 22:16:45 -07001731 const char *pri = worker_pool_pri(pool) ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001732 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001733 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001734
Tejun Heo8b03ae32010-06-29 10:07:12 +02001735 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001736 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001737 spin_unlock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001738 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001739 goto fail;
Tejun Heo8b03ae32010-06-29 10:07:12 +02001740 spin_lock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001741 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02001742 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001743
1744 worker = alloc_worker();
1745 if (!worker)
1746 goto fail;
1747
Tejun Heobd7bdd42012-07-12 14:46:37 -07001748 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001749 worker->id = id;
1750
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001751 if (gcwq->cpu != WORK_CPU_UNBOUND)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001752 worker->task = kthread_create_on_node(worker_thread,
Tejun Heo32704762012-07-13 22:16:45 -07001753 worker, cpu_to_node(gcwq->cpu),
1754 "kworker/%u:%d%s", gcwq->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001755 else
1756 worker->task = kthread_create(worker_thread, worker,
Tejun Heo32704762012-07-13 22:16:45 -07001757 "kworker/u:%d%s", id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001758 if (IS_ERR(worker->task))
1759 goto fail;
1760
Tejun Heo32704762012-07-13 22:16:45 -07001761 if (worker_pool_pri(pool))
1762 set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
1763
Tejun Heodb7bccf2010-06-29 10:07:12 +02001764 /*
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001765 * Determine CPU binding of the new worker depending on
1766 * %GCWQ_DISASSOCIATED. The caller is responsible for ensuring the
1767 * flag remains stable across this function. See the comments
1768 * above the flag definition for details.
1769 *
1770 * As an unbound worker may later become a regular one if CPU comes
1771 * online, make sure every worker has %PF_THREAD_BOUND set.
Tejun Heodb7bccf2010-06-29 10:07:12 +02001772 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001773 if (!(gcwq->flags & GCWQ_DISASSOCIATED)) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001774 kthread_bind(worker->task, gcwq->cpu);
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001775 } else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001776 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001777 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001779
Tejun Heoc34056a2010-06-29 10:07:11 +02001780 return worker;
1781fail:
1782 if (id >= 0) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02001783 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001784 ida_remove(&pool->worker_ida, id);
Tejun Heo8b03ae32010-06-29 10:07:12 +02001785 spin_unlock_irq(&gcwq->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001786 }
1787 kfree(worker);
1788 return NULL;
1789}
1790
1791/**
1792 * start_worker - start a newly created worker
1793 * @worker: worker to start
1794 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001795 * Make the gcwq aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001796 *
1797 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02001798 * spin_lock_irq(gcwq->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001799 */
1800static void start_worker(struct worker *worker)
1801{
Tejun Heocb444762010-07-02 10:03:50 +02001802 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001803 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001804 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001805 wake_up_process(worker->task);
1806}
1807
1808/**
1809 * destroy_worker - destroy a workqueue worker
1810 * @worker: worker to be destroyed
1811 *
Tejun Heoc8e55f32010-06-29 10:07:12 +02001812 * Destroy @worker and adjust @gcwq stats accordingly.
1813 *
1814 * CONTEXT:
1815 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001816 */
1817static void destroy_worker(struct worker *worker)
1818{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001819 struct worker_pool *pool = worker->pool;
1820 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoc34056a2010-06-29 10:07:11 +02001821 int id = worker->id;
1822
1823 /* sanity check frenzy */
1824 BUG_ON(worker->current_work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001825 BUG_ON(!list_empty(&worker->scheduled));
Tejun Heoc34056a2010-06-29 10:07:11 +02001826
Tejun Heoc8e55f32010-06-29 10:07:12 +02001827 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001828 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001829 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001830 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001831
1832 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001833 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001834
1835 spin_unlock_irq(&gcwq->lock);
1836
Tejun Heoc34056a2010-06-29 10:07:11 +02001837 kthread_stop(worker->task);
1838 kfree(worker);
1839
Tejun Heo8b03ae32010-06-29 10:07:12 +02001840 spin_lock_irq(&gcwq->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001841 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001842}
1843
Tejun Heo63d95a92012-07-12 14:46:37 -07001844static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001845{
Tejun Heo63d95a92012-07-12 14:46:37 -07001846 struct worker_pool *pool = (void *)__pool;
1847 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001848
1849 spin_lock_irq(&gcwq->lock);
1850
Tejun Heo63d95a92012-07-12 14:46:37 -07001851 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001852 struct worker *worker;
1853 unsigned long expires;
1854
1855 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001856 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001857 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1858
1859 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001860 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001861 else {
1862 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001863 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001864 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001865 }
1866 }
1867
1868 spin_unlock_irq(&gcwq->lock);
1869}
1870
1871static bool send_mayday(struct work_struct *work)
1872{
1873 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
1874 struct workqueue_struct *wq = cwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001875 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001876
1877 if (!(wq->flags & WQ_RESCUER))
1878 return false;
1879
1880 /* mayday mayday mayday */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001881 cpu = cwq->pool->gcwq->cpu;
Tejun Heof3421792010-07-02 10:03:51 +02001882 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1883 if (cpu == WORK_CPU_UNBOUND)
1884 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001885 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001886 wake_up_process(wq->rescuer->task);
1887 return true;
1888}
1889
Tejun Heo63d95a92012-07-12 14:46:37 -07001890static void gcwq_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001891{
Tejun Heo63d95a92012-07-12 14:46:37 -07001892 struct worker_pool *pool = (void *)__pool;
1893 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02001894 struct work_struct *work;
1895
1896 spin_lock_irq(&gcwq->lock);
1897
Tejun Heo63d95a92012-07-12 14:46:37 -07001898 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001899 /*
1900 * We've been trying to create a new worker but
1901 * haven't been successful. We might be hitting an
1902 * allocation deadlock. Send distress signals to
1903 * rescuers.
1904 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001905 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001906 send_mayday(work);
1907 }
1908
1909 spin_unlock_irq(&gcwq->lock);
1910
Tejun Heo63d95a92012-07-12 14:46:37 -07001911 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001912}
1913
1914/**
1915 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001916 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001917 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001918 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001919 * have at least one idle worker on return from this function. If
1920 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001921 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001922 * possible allocation deadlock.
1923 *
1924 * On return, need_to_create_worker() is guaranteed to be false and
1925 * may_start_working() true.
1926 *
1927 * LOCKING:
1928 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1929 * multiple times. Does GFP_KERNEL allocations. Called only from
1930 * manager.
1931 *
1932 * RETURNS:
1933 * false if no action was taken and gcwq->lock stayed locked, true
1934 * otherwise.
1935 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001936static bool maybe_create_worker(struct worker_pool *pool)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09001937__releases(&gcwq->lock)
1938__acquires(&gcwq->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001939{
Tejun Heo63d95a92012-07-12 14:46:37 -07001940 struct global_cwq *gcwq = pool->gcwq;
1941
1942 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001943 return false;
1944restart:
Tejun Heo9f9c2362010-07-14 11:31:20 +02001945 spin_unlock_irq(&gcwq->lock);
1946
Tejun Heoe22bee72010-06-29 10:07:14 +02001947 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001948 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001949
1950 while (true) {
1951 struct worker *worker;
1952
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001953 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001954 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001955 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001956 spin_lock_irq(&gcwq->lock);
1957 start_worker(worker);
Tejun Heo63d95a92012-07-12 14:46:37 -07001958 BUG_ON(need_to_create_worker(pool));
Tejun Heoe22bee72010-06-29 10:07:14 +02001959 return true;
1960 }
1961
Tejun Heo63d95a92012-07-12 14:46:37 -07001962 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001963 break;
1964
Tejun Heoe22bee72010-06-29 10:07:14 +02001965 __set_current_state(TASK_INTERRUPTIBLE);
1966 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001967
Tejun Heo63d95a92012-07-12 14:46:37 -07001968 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001969 break;
1970 }
1971
Tejun Heo63d95a92012-07-12 14:46:37 -07001972 del_timer_sync(&pool->mayday_timer);
Tejun Heoe22bee72010-06-29 10:07:14 +02001973 spin_lock_irq(&gcwq->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07001974 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001975 goto restart;
1976 return true;
1977}
1978
1979/**
1980 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07001981 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02001982 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001983 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02001984 * IDLE_WORKER_TIMEOUT.
1985 *
1986 * LOCKING:
1987 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
1988 * multiple times. Called only from 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_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001995{
1996 bool ret = false;
1997
Tejun Heo63d95a92012-07-12 14:46:37 -07001998 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001999 struct worker *worker;
2000 unsigned long expires;
2001
Tejun Heo63d95a92012-07-12 14:46:37 -07002002 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002003 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2004
2005 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002006 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02002007 break;
2008 }
2009
2010 destroy_worker(worker);
2011 ret = true;
2012 }
2013
2014 return ret;
2015}
2016
2017/**
2018 * manage_workers - manage worker pool
2019 * @worker: self
2020 *
2021 * Assume the manager role and manage gcwq worker pool @worker belongs
2022 * to. At any given time, there can be only zero or one manager per
2023 * gcwq. The exclusion is handled automatically by this function.
2024 *
2025 * The caller can safely start processing works on false return. On
2026 * true return, it's guaranteed that need_to_create_worker() is false
2027 * and may_start_working() is true.
2028 *
2029 * CONTEXT:
2030 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
2031 * multiple times. Does GFP_KERNEL allocations.
2032 *
2033 * RETURNS:
2034 * false if no action was taken and gcwq->lock stayed locked, true if
2035 * some action was taken.
2036 */
2037static bool manage_workers(struct worker *worker)
2038{
Tejun Heo63d95a92012-07-12 14:46:37 -07002039 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002040 bool ret = false;
2041
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002042 if (pool->flags & POOL_MANAGING_WORKERS)
Tejun Heoe22bee72010-06-29 10:07:14 +02002043 return ret;
2044
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002045 pool->flags |= POOL_MANAGING_WORKERS;
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002046
2047 /*
2048 * To simplify both worker management and CPU hotplug, hold off
2049 * management while hotplug is in progress. CPU hotplug path can't
2050 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2051 * lead to idle worker depletion (all become busy thinking someone
2052 * else is managing) which in turn can result in deadlock under
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002053 * extreme circumstances. Use @pool->assoc_mutex to synchronize
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002054 * manager against CPU hotplug.
2055 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002056 * assoc_mutex would always be free unless CPU hotplug is in
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002057 * progress. trylock first without dropping @gcwq->lock.
2058 */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002059 if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002060 spin_unlock_irq(&pool->gcwq->lock);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002061 mutex_lock(&pool->assoc_mutex);
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002062 /*
2063 * CPU hotplug could have happened while we were waiting
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002064 * for assoc_mutex. Hotplug itself can't handle us
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002065 * because manager isn't either on idle or busy list, and
2066 * @gcwq's state and ours could have deviated.
2067 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002068 * As hotplug is now excluded via assoc_mutex, we can
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002069 * simply try to bind. It will succeed or fail depending
2070 * on @gcwq's current state. Try it and adjust
2071 * %WORKER_UNBOUND accordingly.
2072 */
2073 if (worker_maybe_bind_and_lock(worker))
2074 worker->flags &= ~WORKER_UNBOUND;
2075 else
2076 worker->flags |= WORKER_UNBOUND;
2077
2078 ret = true;
2079 }
2080
Tejun Heo11ebea52012-07-12 14:46:37 -07002081 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002082
2083 /*
2084 * Destroy and then create so that may_start_working() is true
2085 * on return.
2086 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002087 ret |= maybe_destroy_workers(pool);
2088 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002089
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002090 pool->flags &= ~POOL_MANAGING_WORKERS;
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002091 mutex_unlock(&pool->assoc_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02002092 return ret;
2093}
2094
Tejun Heoa62428c2010-06-29 10:07:10 +02002095/**
2096 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002097 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002098 * @work: work to process
2099 *
2100 * Process @work. This function contains all the logics necessary to
2101 * process a single work including synchronization against and
2102 * interaction with other workers on the same cpu, queueing and
2103 * flushing. As long as context requirement is met, any worker can
2104 * call this function to process a work.
2105 *
2106 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002107 * spin_lock_irq(gcwq->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002108 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002109static void process_one_work(struct worker *worker, struct work_struct *work)
Namhyung Kim06bd6eb2010-08-22 23:19:42 +09002110__releases(&gcwq->lock)
2111__acquires(&gcwq->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002112{
Tejun Heo7e116292010-06-29 10:07:13 +02002113 struct cpu_workqueue_struct *cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002114 struct worker_pool *pool = worker->pool;
2115 struct global_cwq *gcwq = pool->gcwq;
Tejun Heofb0e7be2010-06-29 10:07:15 +02002116 bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heoa62428c2010-06-29 10:07:10 +02002117 work_func_t f = work->func;
Tejun Heo73f53c42010-06-29 10:07:11 +02002118 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002119 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002120#ifdef CONFIG_LOCKDEP
2121 /*
2122 * It is permissible to free the struct work_struct from
2123 * inside the function that is called from it, this we need to
2124 * take into account for lockdep too. To avoid bogus "held
2125 * lock freed" warnings as well as problems when looking into
2126 * work->lockdep_map, make a copy and use that here.
2127 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002128 struct lockdep_map lockdep_map;
2129
2130 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002131#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002132 /*
2133 * Ensure we're on the correct CPU. DISASSOCIATED test is
2134 * necessary to avoid spurious warnings from rescuers servicing the
2135 * unbound or a disassociated gcwq.
2136 */
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002137 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
Tejun Heo6fec10a2012-07-22 10:16:34 -07002138 !(gcwq->flags & GCWQ_DISASSOCIATED) &&
Tejun Heo25511a42012-07-17 12:39:27 -07002139 raw_smp_processor_id() != gcwq->cpu);
2140
Tejun Heo7e116292010-06-29 10:07:13 +02002141 /*
2142 * A single work shouldn't be executed concurrently by
2143 * multiple workers on a single cpu. Check whether anyone is
2144 * already processing the work. If so, defer the work to the
2145 * currently executing one.
2146 */
Sasha Levin42f85702012-12-17 10:01:23 -05002147 collision = find_worker_executing_work(gcwq, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002148 if (unlikely(collision)) {
2149 move_linked_works(work, &collision->scheduled, NULL);
2150 return;
2151 }
2152
Tejun Heo8930cab2012-08-03 10:30:45 -07002153 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002154 debug_work_deactivate(work);
Sasha Levin42f85702012-12-17 10:01:23 -05002155 hash_add(gcwq->busy_hash, &worker->hentry, (unsigned long)worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02002156 worker->current_work = work;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002157 worker->current_cwq = cwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002158 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002159
Tejun Heoa62428c2010-06-29 10:07:10 +02002160 list_del_init(&work->entry);
2161
Tejun Heo649027d2010-06-29 10:07:14 +02002162 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002163 * CPU intensive works don't participate in concurrency
2164 * management. They're the scheduler's responsibility.
2165 */
2166 if (unlikely(cpu_intensive))
2167 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2168
Tejun Heo974271c2012-07-12 14:46:37 -07002169 /*
2170 * Unbound gcwq isn't concurrency managed and work items should be
2171 * executed ASAP. Wake up another worker if necessary.
2172 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002173 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2174 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002175
Tejun Heo8930cab2012-08-03 10:30:45 -07002176 /*
Tejun Heo23657bb2012-08-13 17:08:19 -07002177 * Record the last CPU and clear PENDING which should be the last
2178 * update to @work. Also, do this inside @gcwq->lock so that
2179 * PENDING and queued state changes happen together while IRQ is
2180 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002181 */
Tejun Heo8930cab2012-08-03 10:30:45 -07002182 set_work_cpu_and_clear_pending(work, gcwq->cpu);
Tejun Heoa62428c2010-06-29 10:07:10 +02002183
Tejun Heoa62428c2010-06-29 10:07:10 +02002184 spin_unlock_irq(&gcwq->lock);
2185
Tejun Heoe1594892011-01-09 23:32:15 +01002186 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002187 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002188 trace_workqueue_execute_start(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002189 f(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002190 /*
2191 * While we must be careful to not use "work" after this, the trace
2192 * point will only record its address.
2193 */
2194 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002195 lock_map_release(&lockdep_map);
2196 lock_map_release(&cwq->wq->lockdep_map);
2197
2198 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002199 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2200 " last function: %pf\n",
2201 current->comm, preempt_count(), task_pid_nr(current), f);
Tejun Heoa62428c2010-06-29 10:07:10 +02002202 debug_show_held_locks(current);
2203 dump_stack();
2204 }
2205
Tejun Heo8b03ae32010-06-29 10:07:12 +02002206 spin_lock_irq(&gcwq->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002207
Tejun Heofb0e7be2010-06-29 10:07:15 +02002208 /* clear cpu intensive status */
2209 if (unlikely(cpu_intensive))
2210 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2211
Tejun Heoa62428c2010-06-29 10:07:10 +02002212 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002213 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002214 worker->current_work = NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +02002215 worker->current_cwq = NULL;
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07002216 cwq_dec_nr_in_flight(cwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002217}
2218
Tejun Heoaffee4b2010-06-29 10:07:12 +02002219/**
2220 * process_scheduled_works - process scheduled works
2221 * @worker: self
2222 *
2223 * Process all scheduled works. Please note that the scheduled list
2224 * may change while processing a work, so this function repeatedly
2225 * fetches a work from the top and executes it.
2226 *
2227 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002228 * spin_lock_irq(gcwq->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002229 * multiple times.
2230 */
2231static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002233 while (!list_empty(&worker->scheduled)) {
2234 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002236 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238}
2239
Tejun Heo4690c4a2010-06-29 10:07:10 +02002240/**
2241 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002242 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002243 *
Tejun Heoe22bee72010-06-29 10:07:14 +02002244 * The gcwq worker thread function. There's a single dynamic pool of
2245 * these per each cpu. These workers process all works regardless of
2246 * their specific target workqueue. The only exception is works which
2247 * belong to workqueues with a rescuer which will be explained in
2248 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002249 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002250static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251{
Tejun Heoc34056a2010-06-29 10:07:11 +02002252 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002253 struct worker_pool *pool = worker->pool;
2254 struct global_cwq *gcwq = pool->gcwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255
Tejun Heoe22bee72010-06-29 10:07:14 +02002256 /* tell the scheduler that this is a workqueue worker */
2257 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002258woke_up:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002259 spin_lock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002261 /* we are off idle list if destruction or rebind is requested */
2262 if (unlikely(list_empty(&worker->entry))) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02002263 spin_unlock_irq(&gcwq->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002264
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002265 /* if DIE is set, destruction is requested */
Tejun Heo25511a42012-07-17 12:39:27 -07002266 if (worker->flags & WORKER_DIE) {
2267 worker->task->flags &= ~PF_WQ_WORKER;
2268 return 0;
2269 }
2270
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002271 /* otherwise, rebind */
Tejun Heo25511a42012-07-17 12:39:27 -07002272 idle_worker_rebind(worker);
2273 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274 }
2275
Tejun Heoc8e55f32010-06-29 10:07:12 +02002276 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002277recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002278 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002279 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002280 goto sleep;
2281
2282 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002283 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002284 goto recheck;
2285
Tejun Heoc8e55f32010-06-29 10:07:12 +02002286 /*
2287 * ->scheduled list can only be filled while a worker is
2288 * preparing to process a work or actually processing it.
2289 * Make sure nobody diddled with it while I was sleeping.
2290 */
2291 BUG_ON(!list_empty(&worker->scheduled));
2292
Tejun Heoe22bee72010-06-29 10:07:14 +02002293 /*
2294 * When control reaches this point, we're guaranteed to have
2295 * at least one idle worker or that someone else has already
2296 * assumed the manager role.
2297 */
2298 worker_clr_flags(worker, WORKER_PREP);
2299
2300 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002301 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002302 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002303 struct work_struct, entry);
2304
2305 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2306 /* optimization path, not strictly necessary */
2307 process_one_work(worker, work);
2308 if (unlikely(!list_empty(&worker->scheduled)))
2309 process_scheduled_works(worker);
2310 } else {
2311 move_linked_works(work, &worker->scheduled, NULL);
2312 process_scheduled_works(worker);
2313 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002314 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002315
Tejun Heoe22bee72010-06-29 10:07:14 +02002316 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002317sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002318 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002319 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002320
Tejun Heoc8e55f32010-06-29 10:07:12 +02002321 /*
Tejun Heoe22bee72010-06-29 10:07:14 +02002322 * gcwq->lock is held and there's no work to process and no
2323 * need to manage, sleep. Workers are woken up only while
2324 * holding gcwq->lock or from local cpu, so setting the
2325 * current state before releasing gcwq->lock is enough to
2326 * prevent losing any event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002327 */
2328 worker_enter_idle(worker);
2329 __set_current_state(TASK_INTERRUPTIBLE);
2330 spin_unlock_irq(&gcwq->lock);
2331 schedule();
2332 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333}
2334
Tejun Heoe22bee72010-06-29 10:07:14 +02002335/**
2336 * rescuer_thread - the rescuer thread function
2337 * @__wq: the associated workqueue
2338 *
2339 * Workqueue rescuer thread function. There's one rescuer for each
2340 * workqueue which has WQ_RESCUER set.
2341 *
2342 * Regular work processing on a gcwq may block trying to create a new
2343 * worker which uses GFP_KERNEL allocation which has slight chance of
2344 * developing into deadlock if some works currently on the same queue
2345 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2346 * the problem rescuer solves.
2347 *
2348 * When such condition is possible, the gcwq summons rescuers of all
2349 * workqueues which have works queued on the gcwq and let them process
2350 * those works so that forward progress can be guaranteed.
2351 *
2352 * This should happen rarely.
2353 */
2354static int rescuer_thread(void *__wq)
2355{
2356 struct workqueue_struct *wq = __wq;
2357 struct worker *rescuer = wq->rescuer;
2358 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002359 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002360 unsigned int cpu;
2361
2362 set_user_nice(current, RESCUER_NICE_LEVEL);
2363repeat:
2364 set_current_state(TASK_INTERRUPTIBLE);
2365
Mike Galbraith412d32e2012-11-28 07:17:18 +01002366 if (kthread_should_stop()) {
2367 __set_current_state(TASK_RUNNING);
Tejun Heoe22bee72010-06-29 10:07:14 +02002368 return 0;
Mike Galbraith412d32e2012-11-28 07:17:18 +01002369 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002370
Tejun Heof3421792010-07-02 10:03:51 +02002371 /*
2372 * See whether any cpu is asking for help. Unbounded
2373 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2374 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002375 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002376 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
2377 struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002378 struct worker_pool *pool = cwq->pool;
2379 struct global_cwq *gcwq = pool->gcwq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002380 struct work_struct *work, *n;
2381
2382 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002383 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002384
2385 /* migrate to the target cpu if possible */
Tejun Heobd7bdd42012-07-12 14:46:37 -07002386 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002387 worker_maybe_bind_and_lock(rescuer);
2388
2389 /*
2390 * Slurp in all works issued via this workqueue and
2391 * process'em.
2392 */
2393 BUG_ON(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002394 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02002395 if (get_work_cwq(work) == cwq)
2396 move_linked_works(work, scheduled, &n);
2397
2398 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002399
2400 /*
2401 * Leave this gcwq. If keep_working() is %true, notify a
2402 * regular worker; otherwise, we end up with 0 concurrency
2403 * and stalling the execution.
2404 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002405 if (keep_working(pool))
2406 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002407
Tejun Heoe22bee72010-06-29 10:07:14 +02002408 spin_unlock_irq(&gcwq->lock);
2409 }
2410
2411 schedule();
2412 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413}
2414
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002415struct wq_barrier {
2416 struct work_struct work;
2417 struct completion done;
2418};
2419
2420static void wq_barrier_func(struct work_struct *work)
2421{
2422 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2423 complete(&barr->done);
2424}
2425
Tejun Heo4690c4a2010-06-29 10:07:10 +02002426/**
2427 * insert_wq_barrier - insert a barrier work
2428 * @cwq: cwq to insert barrier into
2429 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002430 * @target: target work to attach @barr to
2431 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002432 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002433 * @barr is linked to @target such that @barr is completed only after
2434 * @target finishes execution. Please note that the ordering
2435 * guarantee is observed only with respect to @target and on the local
2436 * cpu.
2437 *
2438 * Currently, a queued barrier can't be canceled. This is because
2439 * try_to_grab_pending() can't determine whether the work to be
2440 * grabbed is at the head of the queue and thus can't clear LINKED
2441 * flag of the previous work while there must be a valid next work
2442 * after a work with LINKED flag set.
2443 *
2444 * Note that when @worker is non-NULL, @target may be modified
2445 * underneath us, so we can't reliably determine cwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002446 *
2447 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02002448 * spin_lock_irq(gcwq->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002449 */
Oleg Nesterov83c22522007-05-09 02:33:54 -07002450static void insert_wq_barrier(struct cpu_workqueue_struct *cwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002451 struct wq_barrier *barr,
2452 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002453{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002454 struct list_head *head;
2455 unsigned int linked = 0;
2456
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002457 /*
Tejun Heo8b03ae32010-06-29 10:07:12 +02002458 * debugobject calls are safe here even with gcwq->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002459 * as we know for sure that this will not trigger any of the
2460 * checks and call back into the fixup functions where we
2461 * might deadlock.
2462 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002463 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002464 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002465 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002466
Tejun Heoaffee4b2010-06-29 10:07:12 +02002467 /*
2468 * If @target is currently being executed, schedule the
2469 * barrier to the worker; otherwise, put it after @target.
2470 */
2471 if (worker)
2472 head = worker->scheduled.next;
2473 else {
2474 unsigned long *bits = work_data_bits(target);
2475
2476 head = target->entry.next;
2477 /* there can already be other linked works, inherit and set */
2478 linked = *bits & WORK_STRUCT_LINKED;
2479 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2480 }
2481
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002482 debug_work_activate(&barr->work);
Tejun Heoaffee4b2010-06-29 10:07:12 +02002483 insert_work(cwq, &barr->work, head,
2484 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002485}
2486
Tejun Heo73f53c42010-06-29 10:07:11 +02002487/**
2488 * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing
2489 * @wq: workqueue being flushed
2490 * @flush_color: new flush color, < 0 for no-op
2491 * @work_color: new work color, < 0 for no-op
2492 *
2493 * Prepare cwqs for workqueue flushing.
2494 *
2495 * If @flush_color is non-negative, flush_color on all cwqs should be
2496 * -1. If no cwq has in-flight commands at the specified color, all
2497 * cwq->flush_color's stay at -1 and %false is returned. If any cwq
2498 * has in flight commands, its cwq->flush_color is set to
2499 * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq
2500 * wakeup logic is armed and %true is returned.
2501 *
2502 * The caller should have initialized @wq->first_flusher prior to
2503 * calling this function with non-negative @flush_color. If
2504 * @flush_color is negative, no flush color update is done and %false
2505 * is returned.
2506 *
2507 * If @work_color is non-negative, all cwqs should have the same
2508 * work_color which is previous to @work_color and all will be
2509 * advanced to @work_color.
2510 *
2511 * CONTEXT:
2512 * mutex_lock(wq->flush_mutex).
2513 *
2514 * RETURNS:
2515 * %true if @flush_color >= 0 and there's something to flush. %false
2516 * otherwise.
2517 */
2518static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq,
2519 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520{
Tejun Heo73f53c42010-06-29 10:07:11 +02002521 bool wait = false;
2522 unsigned int cpu;
Oleg Nesterov14441962007-05-23 13:57:57 -07002523
Tejun Heo73f53c42010-06-29 10:07:11 +02002524 if (flush_color >= 0) {
2525 BUG_ON(atomic_read(&wq->nr_cwqs_to_flush));
2526 atomic_set(&wq->nr_cwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002527 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002528
Tejun Heof3421792010-07-02 10:03:51 +02002529 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02002530 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002531 struct global_cwq *gcwq = cwq->pool->gcwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002532
Tejun Heo8b03ae32010-06-29 10:07:12 +02002533 spin_lock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002534
2535 if (flush_color >= 0) {
2536 BUG_ON(cwq->flush_color != -1);
2537
2538 if (cwq->nr_in_flight[flush_color]) {
2539 cwq->flush_color = flush_color;
2540 atomic_inc(&wq->nr_cwqs_to_flush);
2541 wait = true;
2542 }
2543 }
2544
2545 if (work_color >= 0) {
2546 BUG_ON(work_color != work_next_color(cwq->work_color));
2547 cwq->work_color = work_color;
2548 }
2549
Tejun Heo8b03ae32010-06-29 10:07:12 +02002550 spin_unlock_irq(&gcwq->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002551 }
2552
2553 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush))
2554 complete(&wq->first_flusher->done);
2555
2556 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557}
2558
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002559/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002561 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002562 *
2563 * Forces execution of the workqueue and blocks until its completion.
2564 * This is typically used in driver shutdown handlers.
2565 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002566 * We sleep until all works which were queued on entry have been handled,
2567 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002569void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570{
Tejun Heo73f53c42010-06-29 10:07:11 +02002571 struct wq_flusher this_flusher = {
2572 .list = LIST_HEAD_INIT(this_flusher.list),
2573 .flush_color = -1,
2574 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2575 };
2576 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002577
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002578 lock_map_acquire(&wq->lockdep_map);
2579 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002580
2581 mutex_lock(&wq->flush_mutex);
2582
2583 /*
2584 * Start-to-wait phase
2585 */
2586 next_color = work_next_color(wq->work_color);
2587
2588 if (next_color != wq->flush_color) {
2589 /*
2590 * Color space is not full. The current work_color
2591 * becomes our flush_color and work_color is advanced
2592 * by one.
2593 */
2594 BUG_ON(!list_empty(&wq->flusher_overflow));
2595 this_flusher.flush_color = wq->work_color;
2596 wq->work_color = next_color;
2597
2598 if (!wq->first_flusher) {
2599 /* no flush in progress, become the first flusher */
2600 BUG_ON(wq->flush_color != this_flusher.flush_color);
2601
2602 wq->first_flusher = &this_flusher;
2603
2604 if (!flush_workqueue_prep_cwqs(wq, wq->flush_color,
2605 wq->work_color)) {
2606 /* nothing to flush, done */
2607 wq->flush_color = next_color;
2608 wq->first_flusher = NULL;
2609 goto out_unlock;
2610 }
2611 } else {
2612 /* wait in queue */
2613 BUG_ON(wq->flush_color == this_flusher.flush_color);
2614 list_add_tail(&this_flusher.list, &wq->flusher_queue);
2615 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2616 }
2617 } else {
2618 /*
2619 * Oops, color space is full, wait on overflow queue.
2620 * The next flush completion will assign us
2621 * flush_color and transfer to flusher_queue.
2622 */
2623 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2624 }
2625
2626 mutex_unlock(&wq->flush_mutex);
2627
2628 wait_for_completion(&this_flusher.done);
2629
2630 /*
2631 * Wake-up-and-cascade phase
2632 *
2633 * First flushers are responsible for cascading flushes and
2634 * handling overflow. Non-first flushers can simply return.
2635 */
2636 if (wq->first_flusher != &this_flusher)
2637 return;
2638
2639 mutex_lock(&wq->flush_mutex);
2640
Tejun Heo4ce48b32010-07-02 10:03:51 +02002641 /* we might have raced, check again with mutex held */
2642 if (wq->first_flusher != &this_flusher)
2643 goto out_unlock;
2644
Tejun Heo73f53c42010-06-29 10:07:11 +02002645 wq->first_flusher = NULL;
2646
2647 BUG_ON(!list_empty(&this_flusher.list));
2648 BUG_ON(wq->flush_color != this_flusher.flush_color);
2649
2650 while (true) {
2651 struct wq_flusher *next, *tmp;
2652
2653 /* complete all the flushers sharing the current flush color */
2654 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2655 if (next->flush_color != wq->flush_color)
2656 break;
2657 list_del_init(&next->list);
2658 complete(&next->done);
2659 }
2660
2661 BUG_ON(!list_empty(&wq->flusher_overflow) &&
2662 wq->flush_color != work_next_color(wq->work_color));
2663
2664 /* this flush_color is finished, advance by one */
2665 wq->flush_color = work_next_color(wq->flush_color);
2666
2667 /* one color has been freed, handle overflow queue */
2668 if (!list_empty(&wq->flusher_overflow)) {
2669 /*
2670 * Assign the same color to all overflowed
2671 * flushers, advance work_color and append to
2672 * flusher_queue. This is the start-to-wait
2673 * phase for these overflowed flushers.
2674 */
2675 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2676 tmp->flush_color = wq->work_color;
2677
2678 wq->work_color = work_next_color(wq->work_color);
2679
2680 list_splice_tail_init(&wq->flusher_overflow,
2681 &wq->flusher_queue);
2682 flush_workqueue_prep_cwqs(wq, -1, wq->work_color);
2683 }
2684
2685 if (list_empty(&wq->flusher_queue)) {
2686 BUG_ON(wq->flush_color != wq->work_color);
2687 break;
2688 }
2689
2690 /*
2691 * Need to flush more colors. Make the next flusher
2692 * the new first flusher and arm cwqs.
2693 */
2694 BUG_ON(wq->flush_color == wq->work_color);
2695 BUG_ON(wq->flush_color != next->flush_color);
2696
2697 list_del_init(&next->list);
2698 wq->first_flusher = next;
2699
2700 if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1))
2701 break;
2702
2703 /*
2704 * Meh... this color is already done, clear first
2705 * flusher and repeat cascading.
2706 */
2707 wq->first_flusher = NULL;
2708 }
2709
2710out_unlock:
2711 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002712}
Dave Jonesae90dd52006-06-30 01:40:45 -04002713EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002714
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002715/**
2716 * drain_workqueue - drain a workqueue
2717 * @wq: workqueue to drain
2718 *
2719 * Wait until the workqueue becomes empty. While draining is in progress,
2720 * only chain queueing is allowed. IOW, only currently pending or running
2721 * work items on @wq can queue further work items on it. @wq is flushed
2722 * repeatedly until it becomes empty. The number of flushing is detemined
2723 * by the depth of chaining and should be relatively short. Whine if it
2724 * takes too long.
2725 */
2726void drain_workqueue(struct workqueue_struct *wq)
2727{
2728 unsigned int flush_cnt = 0;
2729 unsigned int cpu;
2730
2731 /*
2732 * __queue_work() needs to test whether there are drainers, is much
2733 * hotter than drain_workqueue() and already looks at @wq->flags.
2734 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2735 */
2736 spin_lock(&workqueue_lock);
2737 if (!wq->nr_drainers++)
2738 wq->flags |= WQ_DRAINING;
2739 spin_unlock(&workqueue_lock);
2740reflush:
2741 flush_workqueue(wq);
2742
2743 for_each_cwq_cpu(cpu, wq) {
2744 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002745 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002746
Tejun Heobd7bdd42012-07-12 14:46:37 -07002747 spin_lock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002748 drained = !cwq->nr_active && list_empty(&cwq->delayed_works);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002749 spin_unlock_irq(&cwq->pool->gcwq->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002750
2751 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002752 continue;
2753
2754 if (++flush_cnt == 10 ||
2755 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Valentin Ilie044c7822012-08-19 00:52:42 +03002756 pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
2757 wq->name, flush_cnt);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002758 goto reflush;
2759 }
2760
2761 spin_lock(&workqueue_lock);
2762 if (!--wq->nr_drainers)
2763 wq->flags &= ~WQ_DRAINING;
2764 spin_unlock(&workqueue_lock);
2765}
2766EXPORT_SYMBOL_GPL(drain_workqueue);
2767
Tejun Heo606a5022012-08-20 14:51:23 -07002768static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002769{
2770 struct worker *worker = NULL;
2771 struct global_cwq *gcwq;
2772 struct cpu_workqueue_struct *cwq;
2773
2774 might_sleep();
2775 gcwq = get_work_gcwq(work);
2776 if (!gcwq)
2777 return false;
2778
2779 spin_lock_irq(&gcwq->lock);
2780 if (!list_empty(&work->entry)) {
2781 /*
2782 * See the comment near try_to_grab_pending()->smp_rmb().
2783 * If it was re-queued to a different gcwq under us, we
2784 * are not going to wait.
2785 */
2786 smp_rmb();
2787 cwq = get_work_cwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002788 if (unlikely(!cwq || gcwq != cwq->pool->gcwq))
Tejun Heobaf59022010-09-16 10:42:16 +02002789 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002790 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002791 worker = find_worker_executing_work(gcwq, work);
2792 if (!worker)
2793 goto already_gone;
2794 cwq = worker->current_cwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002795 }
Tejun Heobaf59022010-09-16 10:42:16 +02002796
2797 insert_wq_barrier(cwq, barr, work, worker);
2798 spin_unlock_irq(&gcwq->lock);
2799
Tejun Heoe1594892011-01-09 23:32:15 +01002800 /*
2801 * If @max_active is 1 or rescuer is in use, flushing another work
2802 * item on the same workqueue may lead to deadlock. Make sure the
2803 * flusher is not running on the same workqueue by verifying write
2804 * access.
2805 */
2806 if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER)
2807 lock_map_acquire(&cwq->wq->lockdep_map);
2808 else
2809 lock_map_acquire_read(&cwq->wq->lockdep_map);
Tejun Heobaf59022010-09-16 10:42:16 +02002810 lock_map_release(&cwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002811
Tejun Heobaf59022010-09-16 10:42:16 +02002812 return true;
2813already_gone:
2814 spin_unlock_irq(&gcwq->lock);
2815 return false;
2816}
2817
Oleg Nesterovdb700892008-07-25 01:47:49 -07002818/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002819 * flush_work - wait for a work to finish executing the last queueing instance
2820 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002821 *
Tejun Heo606a5022012-08-20 14:51:23 -07002822 * Wait until @work has finished execution. @work is guaranteed to be idle
2823 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002824 *
2825 * RETURNS:
2826 * %true if flush_work() waited for the work to finish execution,
2827 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002828 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002829bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002830{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002831 struct wq_barrier barr;
2832
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002833 lock_map_acquire(&work->lockdep_map);
2834 lock_map_release(&work->lockdep_map);
2835
Tejun Heo606a5022012-08-20 14:51:23 -07002836 if (start_flush_work(work, &barr)) {
Tejun Heobaf59022010-09-16 10:42:16 +02002837 wait_for_completion(&barr.done);
2838 destroy_work_on_stack(&barr.work);
2839 return true;
Tejun Heo606a5022012-08-20 14:51:23 -07002840 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002841 return false;
Tejun Heo606a5022012-08-20 14:51:23 -07002842 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002843}
2844EXPORT_SYMBOL_GPL(flush_work);
2845
Tejun Heo36e227d2012-08-03 10:30:46 -07002846static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002847{
Tejun Heobbb68df2012-08-03 10:30:46 -07002848 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002849 int ret;
2850
2851 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002852 ret = try_to_grab_pending(work, is_dwork, &flags);
2853 /*
2854 * If someone else is canceling, wait for the same event it
2855 * would be waiting for before retrying.
2856 */
2857 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002858 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002859 } while (unlikely(ret < 0));
2860
Tejun Heobbb68df2012-08-03 10:30:46 -07002861 /* tell other tasks trying to grab @work to back off */
2862 mark_work_canceling(work);
2863 local_irq_restore(flags);
2864
Tejun Heo606a5022012-08-20 14:51:23 -07002865 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002866 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002867 return ret;
2868}
2869
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002870/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002871 * cancel_work_sync - cancel a work and wait for it to finish
2872 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002873 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002874 * Cancel @work and wait for its execution to finish. This function
2875 * can be used even if the work re-queues itself or migrates to
2876 * another workqueue. On return from this function, @work is
2877 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002878 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002879 * cancel_work_sync(&delayed_work->work) must not be used for
2880 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002881 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002882 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002883 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002884 *
2885 * RETURNS:
2886 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002887 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002888bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002889{
Tejun Heo36e227d2012-08-03 10:30:46 -07002890 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002891}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002892EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002893
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002894/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002895 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2896 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002897 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002898 * Delayed timer is cancelled and the pending work is queued for
2899 * immediate execution. Like flush_work(), this function only
2900 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002901 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002902 * RETURNS:
2903 * %true if flush_work() waited for the work to finish execution,
2904 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002905 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002906bool flush_delayed_work(struct delayed_work *dwork)
2907{
Tejun Heo8930cab2012-08-03 10:30:45 -07002908 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002909 if (del_timer_sync(&dwork->timer))
Tejun Heo12650572012-08-08 09:38:42 -07002910 __queue_work(dwork->cpu,
Tejun Heo401a8d02010-09-16 10:36:00 +02002911 get_work_cwq(&dwork->work)->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002912 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002913 return flush_work(&dwork->work);
2914}
2915EXPORT_SYMBOL(flush_delayed_work);
2916
2917/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002918 * cancel_delayed_work - cancel a delayed work
2919 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002920 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002921 * Kill off a pending delayed_work. Returns %true if @dwork was pending
2922 * and canceled; %false if wasn't pending. Note that the work callback
2923 * function may still be running on return, unless it returns %true and the
2924 * work doesn't re-arm itself. Explicitly flush or use
2925 * cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002926 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002927 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002928 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002929bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002930{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002931 unsigned long flags;
2932 int ret;
2933
2934 do {
2935 ret = try_to_grab_pending(&dwork->work, true, &flags);
2936 } while (unlikely(ret == -EAGAIN));
2937
2938 if (unlikely(ret < 0))
2939 return false;
2940
2941 set_work_cpu_and_clear_pending(&dwork->work, work_cpu(&dwork->work));
2942 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002943 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002944}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002945EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002946
2947/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002948 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2949 * @dwork: the delayed work cancel
2950 *
2951 * This is cancel_work_sync() for delayed works.
2952 *
2953 * RETURNS:
2954 * %true if @dwork was pending, %false otherwise.
2955 */
2956bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002957{
Tejun Heo36e227d2012-08-03 10:30:46 -07002958 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002959}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002960EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002961
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002962/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07002963 * schedule_work_on - put work task on a specific cpu
2964 * @cpu: cpu to put the work task on
2965 * @work: job to be done
2966 *
2967 * This puts a job on a specific cpu
2968 */
Tejun Heod4283e92012-08-03 10:30:44 -07002969bool schedule_work_on(int cpu, struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07002970{
Tejun Heod320c032010-06-29 10:07:14 +02002971 return queue_work_on(cpu, system_wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07002972}
2973EXPORT_SYMBOL(schedule_work_on);
2974
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002975/**
Dave Jonesae90dd52006-06-30 01:40:45 -04002976 * schedule_work - put work task in global workqueue
Linus Torvalds1da177e2005-04-16 15:20:36 -07002977 * @work: job to be done
Linus Torvalds1da177e2005-04-16 15:20:36 -07002978 *
Tejun Heod4283e92012-08-03 10:30:44 -07002979 * Returns %false if @work was already on the kernel-global workqueue and
2980 * %true otherwise.
David Howells52bad642006-11-22 14:54:01 +00002981 *
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002982 * This puts a job in the kernel-global workqueue if it was not already
2983 * queued and leaves it in the same position on the kernel-global
2984 * workqueue otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002985 */
Tejun Heod4283e92012-08-03 10:30:44 -07002986bool schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987{
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002988 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002989}
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002990EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002992/**
2993 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
2994 * @cpu: cpu to use
2995 * @dwork: job to be done
2996 * @delay: number of jiffies to wait
2997 *
2998 * After waiting for a given time this puts a job in the kernel-global
2999 * workqueue on the specified CPU.
3000 */
Tejun Heod4283e92012-08-03 10:30:44 -07003001bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3002 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003003{
Tejun Heod320c032010-06-29 10:07:14 +02003004 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003005}
Dave Jonesae90dd52006-06-30 01:40:45 -04003006EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003007
Andrew Mortonb6136772006-06-25 05:47:49 -07003008/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003009 * schedule_delayed_work - put work task in global workqueue after delay
3010 * @dwork: job to be done
3011 * @delay: number of jiffies to wait or 0 for immediate execution
3012 *
3013 * After waiting for a given time this puts a job in the kernel-global
3014 * workqueue.
3015 */
Tejun Heod4283e92012-08-03 10:30:44 -07003016bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
Tejun Heo0a13c002012-08-03 10:30:44 -07003017{
3018 return queue_delayed_work(system_wq, dwork, delay);
3019}
3020EXPORT_SYMBOL(schedule_delayed_work);
3021
3022/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003023 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003024 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003025 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003026 * schedule_on_each_cpu() executes @func on each online CPU using the
3027 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003028 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003029 *
3030 * RETURNS:
3031 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003032 */
David Howells65f27f32006-11-22 14:55:48 +00003033int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003034{
3035 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003036 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003037
Andrew Mortonb6136772006-06-25 05:47:49 -07003038 works = alloc_percpu(struct work_struct);
3039 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003040 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003041
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003042 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003043
Christoph Lameter15316ba2006-01-08 01:00:43 -08003044 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003045 struct work_struct *work = per_cpu_ptr(works, cpu);
3046
3047 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003048 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003049 }
Tejun Heo93981802009-11-17 14:06:20 -08003050
3051 for_each_online_cpu(cpu)
3052 flush_work(per_cpu_ptr(works, cpu));
3053
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003054 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003055 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003056 return 0;
3057}
3058
Alan Sterneef6a7d2010-02-12 17:39:21 +09003059/**
3060 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3061 *
3062 * Forces execution of the kernel-global workqueue and blocks until its
3063 * completion.
3064 *
3065 * Think twice before calling this function! It's very easy to get into
3066 * trouble if you don't take great care. Either of the following situations
3067 * will lead to deadlock:
3068 *
3069 * One of the work items currently on the workqueue needs to acquire
3070 * a lock held by your code or its caller.
3071 *
3072 * Your code is running in the context of a work routine.
3073 *
3074 * They will be detected by lockdep when they occur, but the first might not
3075 * occur very often. It depends on what work items are on the workqueue and
3076 * what locks they need, which you have no control over.
3077 *
3078 * In most situations flushing the entire workqueue is overkill; you merely
3079 * need to know that a particular work item isn't queued and isn't running.
3080 * In such cases you should use cancel_delayed_work_sync() or
3081 * cancel_work_sync() instead.
3082 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003083void flush_scheduled_work(void)
3084{
Tejun Heod320c032010-06-29 10:07:14 +02003085 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003086}
Dave Jonesae90dd52006-06-30 01:40:45 -04003087EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003088
3089/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003090 * execute_in_process_context - reliably execute the routine with user context
3091 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003092 * @ew: guaranteed storage for the execute work structure (must
3093 * be available when the work executes)
3094 *
3095 * Executes the function immediately if process context is available,
3096 * otherwise schedules the function for delayed execution.
3097 *
3098 * Returns: 0 - function was executed
3099 * 1 - function was scheduled for execution
3100 */
David Howells65f27f32006-11-22 14:55:48 +00003101int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003102{
3103 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003104 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003105 return 0;
3106 }
3107
David Howells65f27f32006-11-22 14:55:48 +00003108 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003109 schedule_work(&ew->work);
3110
3111 return 1;
3112}
3113EXPORT_SYMBOL_GPL(execute_in_process_context);
3114
Linus Torvalds1da177e2005-04-16 15:20:36 -07003115int keventd_up(void)
3116{
Tejun Heod320c032010-06-29 10:07:14 +02003117 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003118}
3119
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003120static int alloc_cwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003121{
Oleg Nesterov3af244332007-05-09 02:34:09 -07003122 /*
Tejun Heo0f900042010-06-29 10:07:11 +02003123 * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS.
3124 * Make sure that the alignment isn't lower than that of
3125 * unsigned long long.
Oleg Nesterov3af244332007-05-09 02:34:09 -07003126 */
Tejun Heo0f900042010-06-29 10:07:11 +02003127 const size_t size = sizeof(struct cpu_workqueue_struct);
3128 const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS,
3129 __alignof__(unsigned long long));
Oleg Nesterov3af244332007-05-09 02:34:09 -07003130
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003131 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003132 wq->cpu_wq.pcpu = __alloc_percpu(size, align);
Tejun Heo931ac772010-07-20 11:07:48 +02003133 else {
Tejun Heof3421792010-07-02 10:03:51 +02003134 void *ptr;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003135
Tejun Heof3421792010-07-02 10:03:51 +02003136 /*
3137 * Allocate enough room to align cwq and put an extra
3138 * pointer at the end pointing back to the originally
3139 * allocated pointer which will be used for free.
3140 */
3141 ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL);
3142 if (ptr) {
3143 wq->cpu_wq.single = PTR_ALIGN(ptr, align);
3144 *(void **)(wq->cpu_wq.single + 1) = ptr;
3145 }
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003146 }
Tejun Heof3421792010-07-02 10:03:51 +02003147
Tejun Heo0415b00d12011-03-24 18:50:09 +01003148 /* just in case, make sure it's actually aligned */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003149 BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align));
3150 return wq->cpu_wq.v ? 0 : -ENOMEM;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003151}
3152
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003153static void free_cwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003154{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003155 if (!(wq->flags & WQ_UNBOUND))
Tejun Heof3421792010-07-02 10:03:51 +02003156 free_percpu(wq->cpu_wq.pcpu);
3157 else if (wq->cpu_wq.single) {
3158 /* the pointer to free is stored right after the cwq */
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003159 kfree(*(void **)(wq->cpu_wq.single + 1));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003160 }
3161}
3162
Tejun Heof3421792010-07-02 10:03:51 +02003163static int wq_clamp_max_active(int max_active, unsigned int flags,
3164 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003165{
Tejun Heof3421792010-07-02 10:03:51 +02003166 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3167
3168 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003169 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3170 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003171
Tejun Heof3421792010-07-02 10:03:51 +02003172 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003173}
3174
Tejun Heob196be82012-01-10 15:11:35 -08003175struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003176 unsigned int flags,
3177 int max_active,
3178 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003179 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003180{
Tejun Heob196be82012-01-10 15:11:35 -08003181 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003182 struct workqueue_struct *wq;
Tejun Heoc34056a2010-06-29 10:07:11 +02003183 unsigned int cpu;
Tejun Heob196be82012-01-10 15:11:35 -08003184 size_t namelen;
3185
3186 /* determine namelen, allocate wq and format name */
3187 va_start(args, lock_name);
3188 va_copy(args1, args);
3189 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3190
3191 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3192 if (!wq)
3193 goto err;
3194
3195 vsnprintf(wq->name, namelen, fmt, args1);
3196 va_end(args);
3197 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003198
Tejun Heof3421792010-07-02 10:03:51 +02003199 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02003200 * Workqueues which may be used during memory reclaim should
3201 * have a rescuer to guarantee forward progress.
3202 */
3203 if (flags & WQ_MEM_RECLAIM)
3204 flags |= WQ_RESCUER;
3205
Tejun Heod320c032010-06-29 10:07:14 +02003206 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003207 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003208
Tejun Heob196be82012-01-10 15:11:35 -08003209 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003210 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003211 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003212 mutex_init(&wq->flush_mutex);
3213 atomic_set(&wq->nr_cwqs_to_flush, 0);
3214 INIT_LIST_HEAD(&wq->flusher_queue);
3215 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003216
Johannes Bergeb13ba82008-01-16 09:51:58 +01003217 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003218 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003219
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003220 if (alloc_cwqs(wq) < 0)
3221 goto err;
3222
Tejun Heof3421792010-07-02 10:03:51 +02003223 for_each_cwq_cpu(cpu, wq) {
Tejun Heo15376632010-06-29 10:07:11 +02003224 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003225 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo32704762012-07-13 22:16:45 -07003226 int pool_idx = (bool)(flags & WQ_HIGHPRI);
Tejun Heo15376632010-06-29 10:07:11 +02003227
Tejun Heo0f900042010-06-29 10:07:11 +02003228 BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo32704762012-07-13 22:16:45 -07003229 cwq->pool = &gcwq->pools[pool_idx];
Tejun Heoc34056a2010-06-29 10:07:11 +02003230 cwq->wq = wq;
Tejun Heo73f53c42010-06-29 10:07:11 +02003231 cwq->flush_color = -1;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003232 cwq->max_active = max_active;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003233 INIT_LIST_HEAD(&cwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003234 }
3235
Tejun Heoe22bee72010-06-29 10:07:14 +02003236 if (flags & WQ_RESCUER) {
3237 struct worker *rescuer;
3238
Tejun Heof2e005a2010-07-20 15:59:09 +02003239 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003240 goto err;
3241
3242 wq->rescuer = rescuer = alloc_worker();
3243 if (!rescuer)
3244 goto err;
3245
Tejun Heob196be82012-01-10 15:11:35 -08003246 rescuer->task = kthread_create(rescuer_thread, wq, "%s",
3247 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003248 if (IS_ERR(rescuer->task))
3249 goto err;
3250
Tejun Heoe22bee72010-06-29 10:07:14 +02003251 rescuer->task->flags |= PF_THREAD_BOUND;
3252 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003253 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003254
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003255 /*
3256 * workqueue_lock protects global freeze state and workqueues
3257 * list. Grab it, set max_active accordingly and add the new
3258 * workqueue to workqueues list.
3259 */
Tejun Heo15376632010-06-29 10:07:11 +02003260 spin_lock(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003261
Tejun Heo58a69cb2011-02-16 09:25:31 +01003262 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heof3421792010-07-02 10:03:51 +02003263 for_each_cwq_cpu(cpu, wq)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003264 get_cwq(cpu, wq)->max_active = 0;
3265
Tejun Heo15376632010-06-29 10:07:11 +02003266 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003267
Tejun Heo15376632010-06-29 10:07:11 +02003268 spin_unlock(&workqueue_lock);
3269
Oleg Nesterov3af244332007-05-09 02:34:09 -07003270 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003271err:
3272 if (wq) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003273 free_cwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003274 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003275 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003276 kfree(wq);
3277 }
3278 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003279}
Tejun Heod320c032010-06-29 10:07:14 +02003280EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003281
3282/**
3283 * destroy_workqueue - safely terminate a workqueue
3284 * @wq: target workqueue
3285 *
3286 * Safely destroy a workqueue. All work currently pending will be done first.
3287 */
3288void destroy_workqueue(struct workqueue_struct *wq)
3289{
Tejun Heoc8e55f32010-06-29 10:07:12 +02003290 unsigned int cpu;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003291
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003292 /* drain it before proceeding with destruction */
3293 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003294
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003295 /*
3296 * wq list is used to freeze wq, remove from list after
3297 * flushing is complete in case freeze races us.
3298 */
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003299 spin_lock(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07003300 list_del(&wq->list);
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003301 spin_unlock(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003302
Tejun Heoe22bee72010-06-29 10:07:14 +02003303 /* sanity check */
Tejun Heof3421792010-07-02 10:03:51 +02003304 for_each_cwq_cpu(cpu, wq) {
Tejun Heo73f53c42010-06-29 10:07:11 +02003305 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3306 int i;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003307
Tejun Heo73f53c42010-06-29 10:07:11 +02003308 for (i = 0; i < WORK_NR_COLORS; i++)
3309 BUG_ON(cwq->nr_in_flight[i]);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02003310 BUG_ON(cwq->nr_active);
3311 BUG_ON(!list_empty(&cwq->delayed_works));
Tejun Heo73f53c42010-06-29 10:07:11 +02003312 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003313
Tejun Heoe22bee72010-06-29 10:07:14 +02003314 if (wq->flags & WQ_RESCUER) {
3315 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003316 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003317 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003318 }
3319
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003320 free_cwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003321 kfree(wq);
3322}
3323EXPORT_SYMBOL_GPL(destroy_workqueue);
3324
Tejun Heodcd989c2010-06-29 10:07:14 +02003325/**
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003326 * cwq_set_max_active - adjust max_active of a cwq
3327 * @cwq: target cpu_workqueue_struct
3328 * @max_active: new max_active value.
3329 *
3330 * Set @cwq->max_active to @max_active and activate delayed works if
3331 * increased.
3332 *
3333 * CONTEXT:
3334 * spin_lock_irq(gcwq->lock).
3335 */
3336static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active)
3337{
3338 cwq->max_active = max_active;
3339
3340 while (!list_empty(&cwq->delayed_works) &&
3341 cwq->nr_active < cwq->max_active)
3342 cwq_activate_first_delayed(cwq);
3343}
3344
3345/**
Tejun Heodcd989c2010-06-29 10:07:14 +02003346 * workqueue_set_max_active - adjust max_active of a workqueue
3347 * @wq: target workqueue
3348 * @max_active: new max_active value.
3349 *
3350 * Set max_active of @wq to @max_active.
3351 *
3352 * CONTEXT:
3353 * Don't call from IRQ context.
3354 */
3355void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3356{
3357 unsigned int cpu;
3358
Tejun Heof3421792010-07-02 10:03:51 +02003359 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003360
3361 spin_lock(&workqueue_lock);
3362
3363 wq->saved_max_active = max_active;
3364
Tejun Heof3421792010-07-02 10:03:51 +02003365 for_each_cwq_cpu(cpu, wq) {
Tejun Heodcd989c2010-06-29 10:07:14 +02003366 struct global_cwq *gcwq = get_gcwq(cpu);
3367
3368 spin_lock_irq(&gcwq->lock);
3369
Tejun Heo58a69cb2011-02-16 09:25:31 +01003370 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heodcd989c2010-06-29 10:07:14 +02003371 !(gcwq->flags & GCWQ_FREEZING))
Lai Jiangshan70369b12012-09-19 10:40:48 -07003372 cwq_set_max_active(get_cwq(gcwq->cpu, wq), max_active);
Tejun Heodcd989c2010-06-29 10:07:14 +02003373
3374 spin_unlock_irq(&gcwq->lock);
3375 }
3376
3377 spin_unlock(&workqueue_lock);
3378}
3379EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3380
3381/**
3382 * workqueue_congested - test whether a workqueue is congested
3383 * @cpu: CPU in question
3384 * @wq: target workqueue
3385 *
3386 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3387 * no synchronization around this function and the test result is
3388 * unreliable and only useful as advisory hints or for debugging.
3389 *
3390 * RETURNS:
3391 * %true if congested, %false otherwise.
3392 */
3393bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3394{
3395 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3396
3397 return !list_empty(&cwq->delayed_works);
3398}
3399EXPORT_SYMBOL_GPL(workqueue_congested);
3400
3401/**
3402 * work_cpu - return the last known associated cpu for @work
3403 * @work: the work of interest
3404 *
3405 * RETURNS:
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003406 * CPU number if @work was ever queued. WORK_CPU_NONE otherwise.
Tejun Heodcd989c2010-06-29 10:07:14 +02003407 */
3408unsigned int work_cpu(struct work_struct *work)
3409{
3410 struct global_cwq *gcwq = get_work_gcwq(work);
3411
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003412 return gcwq ? gcwq->cpu : WORK_CPU_NONE;
Tejun Heodcd989c2010-06-29 10:07:14 +02003413}
3414EXPORT_SYMBOL_GPL(work_cpu);
3415
3416/**
3417 * work_busy - test whether a work is currently pending or running
3418 * @work: the work to be tested
3419 *
3420 * Test whether @work is currently pending or running. There is no
3421 * synchronization around this function and the test result is
3422 * unreliable and only useful as advisory hints or for debugging.
3423 * Especially for reentrant wqs, the pending state might hide the
3424 * running state.
3425 *
3426 * RETURNS:
3427 * OR'd bitmask of WORK_BUSY_* bits.
3428 */
3429unsigned int work_busy(struct work_struct *work)
3430{
3431 struct global_cwq *gcwq = get_work_gcwq(work);
3432 unsigned long flags;
3433 unsigned int ret = 0;
3434
3435 if (!gcwq)
Joonsoo Kim999767b2012-10-21 01:30:06 +09003436 return 0;
Tejun Heodcd989c2010-06-29 10:07:14 +02003437
3438 spin_lock_irqsave(&gcwq->lock, flags);
3439
3440 if (work_pending(work))
3441 ret |= WORK_BUSY_PENDING;
3442 if (find_worker_executing_work(gcwq, work))
3443 ret |= WORK_BUSY_RUNNING;
3444
3445 spin_unlock_irqrestore(&gcwq->lock, flags);
3446
3447 return ret;
3448}
3449EXPORT_SYMBOL_GPL(work_busy);
3450
Tejun Heodb7bccf2010-06-29 10:07:12 +02003451/*
3452 * CPU hotplug.
3453 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003454 * There are two challenges in supporting CPU hotplug. Firstly, there
3455 * are a lot of assumptions on strong associations among work, cwq and
3456 * gcwq which make migrating pending and scheduled works very
3457 * difficult to implement without impacting hot paths. Secondly,
3458 * gcwqs serve mix of short, long and very long running works making
3459 * blocked draining impractical.
3460 *
Tejun Heo628c78e2012-07-17 12:39:27 -07003461 * This is solved by allowing a gcwq to be disassociated from the CPU
3462 * running as an unbound one and allowing it to be reattached later if the
3463 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003464 */
3465
Tejun Heo60373152012-07-17 12:39:27 -07003466/* claim manager positions of all pools */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003467static void gcwq_claim_assoc_and_lock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003468{
3469 struct worker_pool *pool;
3470
3471 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003472 mutex_lock_nested(&pool->assoc_mutex, pool - gcwq->pools);
Tejun Heo8db25e72012-07-17 12:39:28 -07003473 spin_lock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003474}
3475
3476/* release manager positions */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003477static void gcwq_release_assoc_and_unlock(struct global_cwq *gcwq)
Tejun Heo60373152012-07-17 12:39:27 -07003478{
3479 struct worker_pool *pool;
3480
Tejun Heo8db25e72012-07-17 12:39:28 -07003481 spin_unlock_irq(&gcwq->lock);
Tejun Heo60373152012-07-17 12:39:27 -07003482 for_each_worker_pool(pool, gcwq)
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003483 mutex_unlock(&pool->assoc_mutex);
Tejun Heo60373152012-07-17 12:39:27 -07003484}
3485
Tejun Heo628c78e2012-07-17 12:39:27 -07003486static void gcwq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003487{
Tejun Heo628c78e2012-07-17 12:39:27 -07003488 struct global_cwq *gcwq = get_gcwq(smp_processor_id());
Tejun Heo4ce62e92012-07-13 22:16:44 -07003489 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003490 struct worker *worker;
3491 struct hlist_node *pos;
3492 int i;
3493
3494 BUG_ON(gcwq->cpu != smp_processor_id());
3495
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003496 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003497
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003498 /*
3499 * We've claimed all manager positions. Make all workers unbound
3500 * and set DISASSOCIATED. Before this, all workers except for the
3501 * ones which are still executing works from before the last CPU
3502 * down must be on the cpu. After this, they may become diasporas.
3503 */
Tejun Heo60373152012-07-17 12:39:27 -07003504 for_each_worker_pool(pool, gcwq)
Tejun Heo4ce62e92012-07-13 22:16:44 -07003505 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07003506 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003507
3508 for_each_busy_worker(worker, i, pos, gcwq)
Tejun Heo403c8212012-07-17 12:39:27 -07003509 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003510
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003511 gcwq->flags |= GCWQ_DISASSOCIATED;
3512
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003513 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003514
3515 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07003516 * Call schedule() so that we cross rq->lock and thus can guarantee
3517 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3518 * as scheduler callbacks may be invoked from other cpus.
3519 */
3520 schedule();
3521
3522 /*
3523 * Sched callbacks are disabled now. Zap nr_running. After this,
3524 * nr_running stays zero and need_more_worker() and keep_working()
3525 * are always true as long as the worklist is not empty. @gcwq now
3526 * behaves as unbound (in terms of concurrency management) gcwq
3527 * which is served by workers tied to the CPU.
3528 *
3529 * On return from this function, the current worker would trigger
3530 * unbound chain execution of pending work items if other workers
3531 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02003532 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07003533 for_each_worker_pool(pool, gcwq)
3534 atomic_set(get_pool_nr_running(pool), 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003535}
3536
Tejun Heo8db25e72012-07-17 12:39:28 -07003537/*
3538 * Workqueues should be brought up before normal priority CPU notifiers.
3539 * This will be registered high priority CPU notifier.
3540 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003541static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07003542 unsigned long action,
3543 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003544{
3545 unsigned int cpu = (unsigned long)hcpu;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003546 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003547 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003548
Tejun Heo8db25e72012-07-17 12:39:28 -07003549 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003550 case CPU_UP_PREPARE:
Tejun Heo4ce62e92012-07-13 22:16:44 -07003551 for_each_worker_pool(pool, gcwq) {
Tejun Heo3ce63372012-07-17 12:39:27 -07003552 struct worker *worker;
3553
3554 if (pool->nr_workers)
3555 continue;
3556
3557 worker = create_worker(pool);
3558 if (!worker)
3559 return NOTIFY_BAD;
3560
3561 spin_lock_irq(&gcwq->lock);
3562 start_worker(worker);
3563 spin_unlock_irq(&gcwq->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003564 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003565 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003566
Tejun Heo65758202012-07-17 12:39:26 -07003567 case CPU_DOWN_FAILED:
3568 case CPU_ONLINE:
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003569 gcwq_claim_assoc_and_lock(gcwq);
Tejun Heo8db25e72012-07-17 12:39:28 -07003570 gcwq->flags &= ~GCWQ_DISASSOCIATED;
3571 rebind_workers(gcwq);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003572 gcwq_release_assoc_and_unlock(gcwq);
Tejun Heo8db25e72012-07-17 12:39:28 -07003573 break;
Tejun Heo65758202012-07-17 12:39:26 -07003574 }
3575 return NOTIFY_OK;
3576}
3577
3578/*
3579 * Workqueues should be brought down after normal priority CPU notifiers.
3580 * This will be registered as low priority CPU notifier.
3581 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003582static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07003583 unsigned long action,
3584 void *hcpu)
3585{
Tejun Heo8db25e72012-07-17 12:39:28 -07003586 unsigned int cpu = (unsigned long)hcpu;
3587 struct work_struct unbind_work;
3588
Tejun Heo65758202012-07-17 12:39:26 -07003589 switch (action & ~CPU_TASKS_FROZEN) {
3590 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003591 /* unbinding should happen on the local CPU */
3592 INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09003593 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07003594 flush_work(&unbind_work);
3595 break;
Tejun Heo65758202012-07-17 12:39:26 -07003596 }
3597 return NOTIFY_OK;
3598}
3599
Rusty Russell2d3854a2008-11-05 13:39:10 +11003600#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003601
Rusty Russell2d3854a2008-11-05 13:39:10 +11003602struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07003603 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003604 long (*fn)(void *);
3605 void *arg;
3606 long ret;
3607};
3608
Tejun Heoed48ece2012-09-18 12:48:43 -07003609static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003610{
Tejun Heoed48ece2012-09-18 12:48:43 -07003611 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3612
Rusty Russell2d3854a2008-11-05 13:39:10 +11003613 wfc->ret = wfc->fn(wfc->arg);
3614}
3615
3616/**
3617 * work_on_cpu - run a function in user context on a particular cpu
3618 * @cpu: the cpu to run on
3619 * @fn: the function to run
3620 * @arg: the function arg
3621 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003622 * This will return the value @fn returns.
3623 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06003624 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003625 */
3626long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3627{
Tejun Heoed48ece2012-09-18 12:48:43 -07003628 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003629
Tejun Heoed48ece2012-09-18 12:48:43 -07003630 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3631 schedule_work_on(cpu, &wfc.work);
3632 flush_work(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003633 return wfc.ret;
3634}
3635EXPORT_SYMBOL_GPL(work_on_cpu);
3636#endif /* CONFIG_SMP */
3637
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003638#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303639
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003640/**
3641 * freeze_workqueues_begin - begin freezing workqueues
3642 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003643 * Start freezing workqueues. After this function returns, all freezable
3644 * workqueues will queue new works to their frozen_works list instead of
3645 * gcwq->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003646 *
3647 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003648 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003649 */
3650void freeze_workqueues_begin(void)
3651{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003652 unsigned int cpu;
3653
3654 spin_lock(&workqueue_lock);
3655
3656 BUG_ON(workqueue_freezing);
3657 workqueue_freezing = true;
3658
Tejun Heof3421792010-07-02 10:03:51 +02003659 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003660 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003661 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003662
3663 spin_lock_irq(&gcwq->lock);
3664
Tejun Heodb7bccf2010-06-29 10:07:12 +02003665 BUG_ON(gcwq->flags & GCWQ_FREEZING);
3666 gcwq->flags |= GCWQ_FREEZING;
3667
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003668 list_for_each_entry(wq, &workqueues, list) {
3669 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3670
Tejun Heo58a69cb2011-02-16 09:25:31 +01003671 if (cwq && wq->flags & WQ_FREEZABLE)
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003672 cwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003673 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003674
3675 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003676 }
3677
3678 spin_unlock(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003679}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003680
3681/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003682 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003683 *
3684 * Check whether freezing is complete. This function must be called
3685 * between freeze_workqueues_begin() and thaw_workqueues().
3686 *
3687 * CONTEXT:
3688 * Grabs and releases workqueue_lock.
3689 *
3690 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003691 * %true if some freezable workqueues are still busy. %false if freezing
3692 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003693 */
3694bool freeze_workqueues_busy(void)
3695{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003696 unsigned int cpu;
3697 bool busy = false;
3698
3699 spin_lock(&workqueue_lock);
3700
3701 BUG_ON(!workqueue_freezing);
3702
Tejun Heof3421792010-07-02 10:03:51 +02003703 for_each_gcwq_cpu(cpu) {
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003704 struct workqueue_struct *wq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003705 /*
3706 * nr_active is monotonically decreasing. It's safe
3707 * to peek without lock.
3708 */
3709 list_for_each_entry(wq, &workqueues, list) {
3710 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3711
Tejun Heo58a69cb2011-02-16 09:25:31 +01003712 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003713 continue;
3714
3715 BUG_ON(cwq->nr_active < 0);
3716 if (cwq->nr_active) {
3717 busy = true;
3718 goto out_unlock;
3719 }
3720 }
3721 }
3722out_unlock:
3723 spin_unlock(&workqueue_lock);
3724 return busy;
3725}
3726
3727/**
3728 * thaw_workqueues - thaw workqueues
3729 *
3730 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo7e116292010-06-29 10:07:13 +02003731 * frozen works are transferred to their respective gcwq worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003732 *
3733 * CONTEXT:
Tejun Heo8b03ae32010-06-29 10:07:12 +02003734 * Grabs and releases workqueue_lock and gcwq->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003735 */
3736void thaw_workqueues(void)
3737{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003738 unsigned int cpu;
3739
3740 spin_lock(&workqueue_lock);
3741
3742 if (!workqueue_freezing)
3743 goto out_unlock;
3744
Tejun Heof3421792010-07-02 10:03:51 +02003745 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003746 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003747 struct worker_pool *pool;
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003748 struct workqueue_struct *wq;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003749
3750 spin_lock_irq(&gcwq->lock);
3751
Tejun Heodb7bccf2010-06-29 10:07:12 +02003752 BUG_ON(!(gcwq->flags & GCWQ_FREEZING));
3753 gcwq->flags &= ~GCWQ_FREEZING;
3754
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003755 list_for_each_entry(wq, &workqueues, list) {
3756 struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq);
3757
Tejun Heo58a69cb2011-02-16 09:25:31 +01003758 if (!cwq || !(wq->flags & WQ_FREEZABLE))
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003759 continue;
3760
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003761 /* restore max_active and repopulate worklist */
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003762 cwq_set_max_active(cwq, wq->saved_max_active);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003763 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003764
Tejun Heo4ce62e92012-07-13 22:16:44 -07003765 for_each_worker_pool(pool, gcwq)
3766 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02003767
Tejun Heo8b03ae32010-06-29 10:07:12 +02003768 spin_unlock_irq(&gcwq->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003769 }
3770
3771 workqueue_freezing = false;
3772out_unlock:
3773 spin_unlock(&workqueue_lock);
3774}
3775#endif /* CONFIG_FREEZER */
3776
Suresh Siddha6ee05782010-07-30 14:57:37 -07003777static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003778{
Tejun Heoc34056a2010-06-29 10:07:11 +02003779 unsigned int cpu;
3780
Tejun Heob5490072012-08-03 10:30:46 -07003781 /* make sure we have enough bits for OFFQ CPU number */
3782 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_CPU_SHIFT)) <
3783 WORK_CPU_LAST);
3784
Tejun Heo65758202012-07-17 12:39:26 -07003785 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07003786 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003787
3788 /* initialize gcwqs */
Tejun Heof3421792010-07-02 10:03:51 +02003789 for_each_gcwq_cpu(cpu) {
Tejun Heo8b03ae32010-06-29 10:07:12 +02003790 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003791 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003792
3793 spin_lock_init(&gcwq->lock);
3794 gcwq->cpu = cpu;
Tejun Heo477a3c32010-08-31 10:54:35 +02003795 gcwq->flags |= GCWQ_DISASSOCIATED;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003796
Sasha Levin42f85702012-12-17 10:01:23 -05003797 hash_init(gcwq->busy_hash);
Tejun Heoc8e55f32010-06-29 10:07:12 +02003798
Tejun Heo4ce62e92012-07-13 22:16:44 -07003799 for_each_worker_pool(pool, gcwq) {
3800 pool->gcwq = gcwq;
3801 INIT_LIST_HEAD(&pool->worklist);
3802 INIT_LIST_HEAD(&pool->idle_list);
Tejun Heoe22bee72010-06-29 10:07:14 +02003803
Tejun Heo4ce62e92012-07-13 22:16:44 -07003804 init_timer_deferrable(&pool->idle_timer);
3805 pool->idle_timer.function = idle_worker_timeout;
3806 pool->idle_timer.data = (unsigned long)pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003807
Tejun Heo4ce62e92012-07-13 22:16:44 -07003808 setup_timer(&pool->mayday_timer, gcwq_mayday_timeout,
3809 (unsigned long)pool);
3810
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003811 mutex_init(&pool->assoc_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003812 ida_init(&pool->worker_ida);
3813 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003814 }
3815
Tejun Heoe22bee72010-06-29 10:07:14 +02003816 /* create the initial worker */
Tejun Heof3421792010-07-02 10:03:51 +02003817 for_each_online_gcwq_cpu(cpu) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003818 struct global_cwq *gcwq = get_gcwq(cpu);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003819 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003820
Tejun Heo477a3c32010-08-31 10:54:35 +02003821 if (cpu != WORK_CPU_UNBOUND)
3822 gcwq->flags &= ~GCWQ_DISASSOCIATED;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003823
3824 for_each_worker_pool(pool, gcwq) {
3825 struct worker *worker;
3826
Tejun Heobc2ae0f2012-07-17 12:39:27 -07003827 worker = create_worker(pool);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003828 BUG_ON(!worker);
3829 spin_lock_irq(&gcwq->lock);
3830 start_worker(worker);
3831 spin_unlock_irq(&gcwq->lock);
3832 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003833 }
3834
Tejun Heod320c032010-06-29 10:07:14 +02003835 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003836 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02003837 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003838 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3839 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003840 system_freezable_wq = alloc_workqueue("events_freezable",
3841 WQ_FREEZABLE, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003842 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Tejun Heoae930e02012-08-20 14:51:23 -07003843 !system_unbound_wq || !system_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003844 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003845}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003846early_initcall(init_workqueues);