blob: b0d3cbb83f63cfbfd969d2dd32e1b64481341e18 [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 Heo76af4d92013-03-12 11:30:00 -070045#include <linux/rculist.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020046
Tejun Heoea138442013-01-18 14:05:55 -080047#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
Tejun Heoc8e55f32010-06-29 10:07:12 +020049enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070050 /*
Tejun Heo24647572013-01-24 11:01:33 -080051 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070052 *
Tejun Heo24647572013-01-24 11:01:33 -080053 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070054 * While associated (!DISASSOCIATED), all workers are bound to the
55 * CPU and none has %WORKER_UNBOUND set and concurrency management
56 * is in effect.
57 *
58 * While DISASSOCIATED, the cpu may be offline and all workers have
59 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080060 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070061 *
62 * Note that DISASSOCIATED can be flipped only while holding
Tejun Heo24647572013-01-24 11:01:33 -080063 * assoc_mutex to avoid changing binding state while
64 * create_worker() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070065 */
Tejun Heo11ebea52012-07-12 14:46:37 -070066 POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
Tejun Heo24647572013-01-24 11:01:33 -080067 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heo35b6bb62013-01-24 11:01:33 -080068 POOL_FREEZING = 1 << 3, /* freeze in progress */
Tejun Heodb7bccf2010-06-29 10:07:12 +020069
Tejun Heoc8e55f32010-06-29 10:07:12 +020070 /* worker flags */
71 WORKER_STARTED = 1 << 0, /* started */
72 WORKER_DIE = 1 << 1, /* die die die */
73 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020074 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020075 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020076 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoe22bee72010-06-29 10:07:14 +020077
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -070078 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_UNBOUND |
Tejun Heo403c8212012-07-17 12:39:27 -070079 WORKER_CPU_INTENSIVE,
Tejun Heodb7bccf2010-06-29 10:07:12 +020080
Tejun Heoe34cdddb2013-01-24 11:01:33 -080081 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070082
Tejun Heoc8e55f32010-06-29 10:07:12 +020083 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020084
Tejun Heoe22bee72010-06-29 10:07:14 +020085 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
86 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
87
Tejun Heo3233cdb2011-02-16 18:10:19 +010088 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
89 /* call for help after 10ms
90 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020091 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
92 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020093
94 /*
95 * Rescue workers are used only on emergencies and shared by
96 * all cpus. Give -20.
97 */
98 RESCUER_NICE_LEVEL = -20,
Tejun Heo32704762012-07-13 22:16:45 -070099 HIGHPRI_NICE_LEVEL = -20,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200100};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200103 * Structure fields follow one of the following exclusion rules.
104 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200105 * I: Modifiable by initialization/destruction paths and read-only for
106 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200107 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200108 * P: Preemption protected. Disabling preemption is enough and should
109 * only be modified and accessed from the local cpu.
110 *
Tejun Heod565ed62013-01-24 11:01:33 -0800111 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200112 *
Tejun Heod565ed62013-01-24 11:01:33 -0800113 * X: During normal operation, modification requires pool->lock and should
114 * be done only from local cpu. Either disabling preemption on local
115 * cpu or grabbing pool->lock is enough for read access. If
116 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200117 *
Tejun Heo73f53c42010-06-29 10:07:11 +0200118 * F: wq->flush_mutex protected.
119 *
Tejun Heo4690c4a2010-06-29 10:07:10 +0200120 * W: workqueue_lock protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700121 *
122 * R: workqueue_lock protected for writes. Sched-RCU protected for reads.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200123 */
124
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800125/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200126
Tejun Heobd7bdd42012-07-12 14:46:37 -0700127struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800128 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700129 int cpu; /* I: the associated cpu */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800130 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700131 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700132
133 struct list_head worklist; /* L: list of pending works */
134 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700135
136 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700137 int nr_idle; /* L: currently idle ones */
138
139 struct list_head idle_list; /* X: list of idle workers */
140 struct timer_list idle_timer; /* L: worker idle timeout */
141 struct timer_list mayday_timer; /* L: SOS timer for workers */
142
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800143 /* workers are chained either in busy_hash or idle_list */
144 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
145 /* L: hash of busy workers */
146
Tejun Heo34a06bd2013-03-12 11:30:00 -0700147 struct mutex manager_arb; /* manager arbitration */
Tejun Heo24647572013-01-24 11:01:33 -0800148 struct mutex assoc_mutex; /* protect POOL_DISASSOCIATED */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700149 struct ida worker_ida; /* L: for worker IDs */
Tejun Heoe19e3972013-01-24 11:39:44 -0800150
Tejun Heo7a4e3442013-03-12 11:30:00 -0700151 struct workqueue_attrs *attrs; /* I: worker attributes */
152
Tejun Heoe19e3972013-01-24 11:39:44 -0800153 /*
154 * The current concurrency level. As it's likely to be accessed
155 * from other CPUs during try_to_wake_up(), put it in a separate
156 * cacheline.
157 */
158 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200159} ____cacheline_aligned_in_smp;
160
161/*
Tejun Heo112202d2013-02-13 19:29:12 -0800162 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
163 * of work_struct->data are used for flags and the remaining high bits
164 * point to the pwq; thus, pwqs need to be aligned at two's power of the
165 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 */
Tejun Heo112202d2013-02-13 19:29:12 -0800167struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700168 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200169 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200170 int work_color; /* L: current color */
171 int flush_color; /* L: flushing color */
172 int nr_in_flight[WORK_NR_COLORS];
173 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200174 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200175 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200176 struct list_head delayed_works; /* L: delayed works */
Tejun Heo76af4d92013-03-12 11:30:00 -0700177 struct list_head pwqs_node; /* R: node on wq->pwqs */
Tejun Heo493a1722013-03-12 11:29:59 -0700178 struct list_head mayday_node; /* W: node on wq->maydays */
Tejun Heoe904e6c2013-03-12 11:29:57 -0700179} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200182 * Structure used to wait for workqueue flush.
183 */
184struct wq_flusher {
185 struct list_head list; /* F: list of flushers */
186 int flush_color; /* F: flush color waiting for */
187 struct completion done; /* flush completion */
188};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
Tejun Heo73f53c42010-06-29 10:07:11 +0200190/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 * The externally visible workqueue abstraction is an array of
192 * per-CPU workqueues:
193 */
194struct workqueue_struct {
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200195 unsigned int flags; /* W: WQ_* flags */
Tejun Heo420c0dd2013-03-12 11:29:59 -0700196 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwq's */
Tejun Heo76af4d92013-03-12 11:30:00 -0700197 struct list_head pwqs; /* R: all pwqs of this wq */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200198 struct list_head list; /* W: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200199
200 struct mutex flush_mutex; /* protects wq flushing */
201 int work_color; /* F: current work color */
202 int flush_color; /* F: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800203 atomic_t nr_pwqs_to_flush; /* flush in progress */
Tejun Heo73f53c42010-06-29 10:07:11 +0200204 struct wq_flusher *first_flusher; /* F: first flusher */
205 struct list_head flusher_queue; /* F: flush waiters */
206 struct list_head flusher_overflow; /* F: flush overflow list */
207
Tejun Heo493a1722013-03-12 11:29:59 -0700208 struct list_head maydays; /* W: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200209 struct worker *rescuer; /* I: rescue worker */
210
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200211 int nr_drainers; /* W: drain in progress */
Tejun Heo112202d2013-02-13 19:29:12 -0800212 int saved_max_active; /* W: saved pwq max_active */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700213#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200214 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700215#endif
Tejun Heob196be82012-01-10 15:11:35 -0800216 char name[]; /* I: workqueue name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217};
218
Tejun Heoe904e6c2013-03-12 11:29:57 -0700219static struct kmem_cache *pwq_cache;
220
Tejun Heod320c032010-06-29 10:07:14 +0200221struct workqueue_struct *system_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200222EXPORT_SYMBOL_GPL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300223struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900224EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300225struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200226EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300227struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200228EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300229struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100230EXPORT_SYMBOL_GPL(system_freezable_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200231
Tejun Heo97bd2342010-10-05 10:41:14 +0200232#define CREATE_TRACE_POINTS
233#include <trace/events/workqueue.h>
234
Tejun Heo76af4d92013-03-12 11:30:00 -0700235#define assert_rcu_or_wq_lock() \
236 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
237 lockdep_is_held(&workqueue_lock), \
238 "sched RCU or workqueue lock should be held")
239
Tejun Heo38db41d2013-01-24 11:01:34 -0800240#define for_each_std_worker_pool(pool, cpu) \
Tejun Heoa60dc392013-01-24 11:01:34 -0800241 for ((pool) = &std_worker_pools(cpu)[0]; \
242 (pool) < &std_worker_pools(cpu)[NR_STD_WORKER_POOLS]; (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700243
Sasha Levinb67bfe02013-02-27 17:06:00 -0800244#define for_each_busy_worker(worker, i, pool) \
245 hash_for_each(pool->busy_hash, i, worker, hentry)
Tejun Heodb7bccf2010-06-29 10:07:12 +0200246
Tejun Heo706026c2013-01-24 11:01:34 -0800247static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
248 unsigned int sw)
Tejun Heof3421792010-07-02 10:03:51 +0200249{
250 if (cpu < nr_cpu_ids) {
251 if (sw & 1) {
252 cpu = cpumask_next(cpu, mask);
253 if (cpu < nr_cpu_ids)
254 return cpu;
255 }
256 if (sw & 2)
257 return WORK_CPU_UNBOUND;
258 }
Lai Jiangshan6be19582013-02-06 18:04:53 -0800259 return WORK_CPU_END;
Tejun Heof3421792010-07-02 10:03:51 +0200260}
261
Tejun Heo09884952010-08-01 11:50:12 +0200262/*
263 * CPU iterators
264 *
Tejun Heo706026c2013-01-24 11:01:34 -0800265 * An extra cpu number is defined using an invalid cpu number
Tejun Heo09884952010-08-01 11:50:12 +0200266 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
Tejun Heo706026c2013-01-24 11:01:34 -0800267 * specific CPU. The following iterators are similar to for_each_*_cpu()
268 * iterators but also considers the unbound CPU.
Tejun Heo09884952010-08-01 11:50:12 +0200269 *
Tejun Heo706026c2013-01-24 11:01:34 -0800270 * for_each_wq_cpu() : possible CPUs + WORK_CPU_UNBOUND
271 * for_each_online_wq_cpu() : online CPUs + WORK_CPU_UNBOUND
Tejun Heo09884952010-08-01 11:50:12 +0200272 */
Tejun Heo706026c2013-01-24 11:01:34 -0800273#define for_each_wq_cpu(cpu) \
274 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, 3); \
Lai Jiangshan6be19582013-02-06 18:04:53 -0800275 (cpu) < WORK_CPU_END; \
Tejun Heo706026c2013-01-24 11:01:34 -0800276 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, 3))
Tejun Heof3421792010-07-02 10:03:51 +0200277
Tejun Heo706026c2013-01-24 11:01:34 -0800278#define for_each_online_wq_cpu(cpu) \
279 for ((cpu) = __next_wq_cpu(-1, cpu_online_mask, 3); \
Lai Jiangshan6be19582013-02-06 18:04:53 -0800280 (cpu) < WORK_CPU_END; \
Tejun Heo706026c2013-01-24 11:01:34 -0800281 (cpu) = __next_wq_cpu((cpu), cpu_online_mask, 3))
Tejun Heof3421792010-07-02 10:03:51 +0200282
Tejun Heo49e3cf42013-03-12 11:29:58 -0700283/**
Tejun Heo17116962013-03-12 11:29:58 -0700284 * for_each_pool - iterate through all worker_pools in the system
285 * @pool: iteration cursor
286 * @id: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700287 *
288 * This must be called either with workqueue_lock held or sched RCU read
289 * locked. If the pool needs to be used beyond the locking in effect, the
290 * caller is responsible for guaranteeing that the pool stays online.
291 *
292 * The if/else clause exists only for the lockdep assertion and can be
293 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700294 */
295#define for_each_pool(pool, id) \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700296 idr_for_each_entry(&worker_pool_idr, pool, id) \
297 if (({ assert_rcu_or_wq_lock(); false; })) { } \
298 else
Tejun Heo17116962013-03-12 11:29:58 -0700299
300/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700301 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
302 * @pwq: iteration cursor
303 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700304 *
305 * This must be called either with workqueue_lock held or sched RCU read
306 * locked. If the pwq needs to be used beyond the locking in effect, the
307 * caller is responsible for guaranteeing that the pwq stays online.
308 *
309 * The if/else clause exists only for the lockdep assertion and can be
310 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700311 */
312#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700313 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
314 if (({ assert_rcu_or_wq_lock(); false; })) { } \
315 else
Tejun Heof3421792010-07-02 10:03:51 +0200316
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900317#ifdef CONFIG_DEBUG_OBJECTS_WORK
318
319static struct debug_obj_descr work_debug_descr;
320
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100321static void *work_debug_hint(void *addr)
322{
323 return ((struct work_struct *) addr)->func;
324}
325
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900326/*
327 * fixup_init is called when:
328 * - an active object is initialized
329 */
330static int work_fixup_init(void *addr, enum debug_obj_state state)
331{
332 struct work_struct *work = addr;
333
334 switch (state) {
335 case ODEBUG_STATE_ACTIVE:
336 cancel_work_sync(work);
337 debug_object_init(work, &work_debug_descr);
338 return 1;
339 default:
340 return 0;
341 }
342}
343
344/*
345 * fixup_activate is called when:
346 * - an active object is activated
347 * - an unknown object is activated (might be a statically initialized object)
348 */
349static int work_fixup_activate(void *addr, enum debug_obj_state state)
350{
351 struct work_struct *work = addr;
352
353 switch (state) {
354
355 case ODEBUG_STATE_NOTAVAILABLE:
356 /*
357 * This is not really a fixup. The work struct was
358 * statically initialized. We just make sure that it
359 * is tracked in the object tracker.
360 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200361 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900362 debug_object_init(work, &work_debug_descr);
363 debug_object_activate(work, &work_debug_descr);
364 return 0;
365 }
366 WARN_ON_ONCE(1);
367 return 0;
368
369 case ODEBUG_STATE_ACTIVE:
370 WARN_ON(1);
371
372 default:
373 return 0;
374 }
375}
376
377/*
378 * fixup_free is called when:
379 * - an active object is freed
380 */
381static int work_fixup_free(void *addr, enum debug_obj_state state)
382{
383 struct work_struct *work = addr;
384
385 switch (state) {
386 case ODEBUG_STATE_ACTIVE:
387 cancel_work_sync(work);
388 debug_object_free(work, &work_debug_descr);
389 return 1;
390 default:
391 return 0;
392 }
393}
394
395static struct debug_obj_descr work_debug_descr = {
396 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100397 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900398 .fixup_init = work_fixup_init,
399 .fixup_activate = work_fixup_activate,
400 .fixup_free = work_fixup_free,
401};
402
403static inline void debug_work_activate(struct work_struct *work)
404{
405 debug_object_activate(work, &work_debug_descr);
406}
407
408static inline void debug_work_deactivate(struct work_struct *work)
409{
410 debug_object_deactivate(work, &work_debug_descr);
411}
412
413void __init_work(struct work_struct *work, int onstack)
414{
415 if (onstack)
416 debug_object_init_on_stack(work, &work_debug_descr);
417 else
418 debug_object_init(work, &work_debug_descr);
419}
420EXPORT_SYMBOL_GPL(__init_work);
421
422void destroy_work_on_stack(struct work_struct *work)
423{
424 debug_object_free(work, &work_debug_descr);
425}
426EXPORT_SYMBOL_GPL(destroy_work_on_stack);
427
428#else
429static inline void debug_work_activate(struct work_struct *work) { }
430static inline void debug_work_deactivate(struct work_struct *work) { }
431#endif
432
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100433/* Serializes the accesses to the list of workqueues. */
434static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200436static bool workqueue_freezing; /* W: have wqs started freezing? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
Oleg Nesterov14441962007-05-23 13:57:57 -0700438/*
Tejun Heoe19e3972013-01-24 11:39:44 -0800439 * The CPU and unbound standard worker pools. The unbound ones have
440 * POOL_DISASSOCIATED set, and their workers have WORKER_UNBOUND set.
Oleg Nesterov14441962007-05-23 13:57:57 -0700441 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800442static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
443 cpu_std_worker_pools);
Tejun Heoa60dc392013-01-24 11:01:34 -0800444static struct worker_pool unbound_std_worker_pools[NR_STD_WORKER_POOLS];
Tejun Heof3421792010-07-02 10:03:51 +0200445
Tejun Heofa1b54e2013-03-12 11:30:00 -0700446/*
447 * idr of all pools. Modifications are protected by workqueue_lock. Read
448 * accesses are protected by sched-RCU protected.
449 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800450static DEFINE_IDR(worker_pool_idr);
451
Tejun Heoc34056a2010-06-29 10:07:11 +0200452static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
Tejun Heoa60dc392013-01-24 11:01:34 -0800454static struct worker_pool *std_worker_pools(int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455{
Tejun Heof3421792010-07-02 10:03:51 +0200456 if (cpu != WORK_CPU_UNBOUND)
Tejun Heoa60dc392013-01-24 11:01:34 -0800457 return per_cpu(cpu_std_worker_pools, cpu);
Tejun Heof3421792010-07-02 10:03:51 +0200458 else
Tejun Heoa60dc392013-01-24 11:01:34 -0800459 return unbound_std_worker_pools;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460}
461
Tejun Heo4e8f0a62013-01-24 11:01:34 -0800462static int std_worker_pool_pri(struct worker_pool *pool)
463{
Tejun Heoa60dc392013-01-24 11:01:34 -0800464 return pool - std_worker_pools(pool->cpu);
Tejun Heo4e8f0a62013-01-24 11:01:34 -0800465}
466
Tejun Heo9daf9e62013-01-24 11:01:33 -0800467/* allocate ID and assign it to @pool */
468static int worker_pool_assign_id(struct worker_pool *pool)
469{
470 int ret;
471
Tejun Heofa1b54e2013-03-12 11:30:00 -0700472 do {
473 if (!idr_pre_get(&worker_pool_idr, GFP_KERNEL))
474 return -ENOMEM;
475
476 spin_lock_irq(&workqueue_lock);
477 ret = idr_get_new(&worker_pool_idr, pool, &pool->id);
478 spin_unlock_irq(&workqueue_lock);
479 } while (ret == -EAGAIN);
Tejun Heo9daf9e62013-01-24 11:01:33 -0800480
481 return ret;
482}
483
Tejun Heod565ed62013-01-24 11:01:33 -0800484static struct worker_pool *get_std_worker_pool(int cpu, bool highpri)
485{
Tejun Heoa60dc392013-01-24 11:01:34 -0800486 struct worker_pool *pools = std_worker_pools(cpu);
Tejun Heod565ed62013-01-24 11:01:33 -0800487
Tejun Heoa60dc392013-01-24 11:01:34 -0800488 return &pools[highpri];
Tejun Heod565ed62013-01-24 11:01:33 -0800489}
490
Tejun Heo76af4d92013-03-12 11:30:00 -0700491/**
492 * first_pwq - return the first pool_workqueue of the specified workqueue
493 * @wq: the target workqueue
494 *
495 * This must be called either with workqueue_lock held or sched RCU read
496 * locked. If the pwq needs to be used beyond the locking in effect, the
497 * caller is responsible for guaranteeing that the pwq stays online.
498 */
Tejun Heo7fb98ea2013-03-12 11:30:00 -0700499static struct pool_workqueue *first_pwq(struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700500{
Tejun Heo76af4d92013-03-12 11:30:00 -0700501 assert_rcu_or_wq_lock();
502 return list_first_or_null_rcu(&wq->pwqs, struct pool_workqueue,
503 pwqs_node);
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700504}
505
Tejun Heo73f53c42010-06-29 10:07:11 +0200506static unsigned int work_color_to_flags(int color)
507{
508 return color << WORK_STRUCT_COLOR_SHIFT;
509}
510
511static int get_work_color(struct work_struct *work)
512{
513 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
514 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
515}
516
517static int work_next_color(int color)
518{
519 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700520}
521
David Howells4594bf12006-12-07 11:33:26 +0000522/*
Tejun Heo112202d2013-02-13 19:29:12 -0800523 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
524 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800525 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200526 *
Tejun Heo112202d2013-02-13 19:29:12 -0800527 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
528 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700529 * work->data. These functions should only be called while the work is
530 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200531 *
Tejun Heo112202d2013-02-13 19:29:12 -0800532 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800533 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800534 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800535 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700536 *
537 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
538 * canceled. While being canceled, a work item may have its PENDING set
539 * but stay off timer and worklist for arbitrarily long and nobody should
540 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000541 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200542static inline void set_work_data(struct work_struct *work, unsigned long data,
543 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000544{
Tejun Heo6183c002013-03-12 11:29:57 -0700545 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200546 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000547}
David Howells365970a2006-11-22 14:54:49 +0000548
Tejun Heo112202d2013-02-13 19:29:12 -0800549static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200550 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200551{
Tejun Heo112202d2013-02-13 19:29:12 -0800552 set_work_data(work, (unsigned long)pwq,
553 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200554}
555
Lai Jiangshan4468a002013-02-06 18:04:53 -0800556static void set_work_pool_and_keep_pending(struct work_struct *work,
557 int pool_id)
558{
559 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
560 WORK_STRUCT_PENDING);
561}
562
Tejun Heo7c3eed52013-01-24 11:01:33 -0800563static void set_work_pool_and_clear_pending(struct work_struct *work,
564 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000565{
Tejun Heo23657bb2012-08-13 17:08:19 -0700566 /*
567 * The following wmb is paired with the implied mb in
568 * test_and_set_bit(PENDING) and ensures all updates to @work made
569 * here are visible to and precede any updates by the next PENDING
570 * owner.
571 */
572 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800573 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200574}
575
576static void clear_work_data(struct work_struct *work)
577{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800578 smp_wmb(); /* see set_work_pool_and_clear_pending() */
579 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200580}
581
Tejun Heo112202d2013-02-13 19:29:12 -0800582static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200583{
Tejun Heoe1201532010-07-22 14:14:25 +0200584 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200585
Tejun Heo112202d2013-02-13 19:29:12 -0800586 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200587 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
588 else
589 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200590}
591
Tejun Heo7c3eed52013-01-24 11:01:33 -0800592/**
593 * get_work_pool - return the worker_pool a given work was associated with
594 * @work: the work item of interest
595 *
596 * Return the worker_pool @work was last associated with. %NULL if none.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700597 *
598 * Pools are created and destroyed under workqueue_lock, and allows read
599 * access under sched-RCU read lock. As such, this function should be
600 * called under workqueue_lock or with preemption disabled.
601 *
602 * All fields of the returned pool are accessible as long as the above
603 * mentioned locking is in effect. If the returned pool needs to be used
604 * beyond the critical section, the caller is responsible for ensuring the
605 * returned pool is and stays online.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800606 */
607static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200608{
Tejun Heoe1201532010-07-22 14:14:25 +0200609 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800610 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200611
Tejun Heofa1b54e2013-03-12 11:30:00 -0700612 assert_rcu_or_wq_lock();
613
Tejun Heo112202d2013-02-13 19:29:12 -0800614 if (data & WORK_STRUCT_PWQ)
615 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800616 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200617
Tejun Heo7c3eed52013-01-24 11:01:33 -0800618 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
619 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200620 return NULL;
621
Tejun Heofa1b54e2013-03-12 11:30:00 -0700622 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800623}
624
625/**
626 * get_work_pool_id - return the worker pool ID a given work is associated with
627 * @work: the work item of interest
628 *
629 * Return the worker_pool ID @work was last associated with.
630 * %WORK_OFFQ_POOL_NONE if none.
631 */
632static int get_work_pool_id(struct work_struct *work)
633{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800634 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800635
Tejun Heo112202d2013-02-13 19:29:12 -0800636 if (data & WORK_STRUCT_PWQ)
637 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800638 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
639
640 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800641}
642
Tejun Heobbb68df2012-08-03 10:30:46 -0700643static void mark_work_canceling(struct work_struct *work)
644{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800645 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700646
Tejun Heo7c3eed52013-01-24 11:01:33 -0800647 pool_id <<= WORK_OFFQ_POOL_SHIFT;
648 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700649}
650
651static bool work_is_canceling(struct work_struct *work)
652{
653 unsigned long data = atomic_long_read(&work->data);
654
Tejun Heo112202d2013-02-13 19:29:12 -0800655 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700656}
657
David Howells365970a2006-11-22 14:54:49 +0000658/*
Tejun Heo32704762012-07-13 22:16:45 -0700659 * Policy functions. These define the policies on how the global worker
660 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800661 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000662 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200663
Tejun Heo63d95a92012-07-12 14:46:37 -0700664static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000665{
Tejun Heoe19e3972013-01-24 11:39:44 -0800666 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000667}
668
Tejun Heoe22bee72010-06-29 10:07:14 +0200669/*
670 * Need to wake up a worker? Called from anything but currently
671 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700672 *
673 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800674 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700675 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200676 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700677static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000678{
Tejun Heo63d95a92012-07-12 14:46:37 -0700679 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000680}
681
Tejun Heoe22bee72010-06-29 10:07:14 +0200682/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700683static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200684{
Tejun Heo63d95a92012-07-12 14:46:37 -0700685 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200686}
687
688/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700689static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200690{
Tejun Heoe19e3972013-01-24 11:39:44 -0800691 return !list_empty(&pool->worklist) &&
692 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200693}
694
695/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700696static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200697{
Tejun Heo63d95a92012-07-12 14:46:37 -0700698 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200699}
700
701/* Do I need to be the manager? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700702static bool need_to_manage_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200703{
Tejun Heo63d95a92012-07-12 14:46:37 -0700704 return need_to_create_worker(pool) ||
Tejun Heo11ebea52012-07-12 14:46:37 -0700705 (pool->flags & POOL_MANAGE_WORKERS);
Tejun Heoe22bee72010-06-29 10:07:14 +0200706}
707
708/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700709static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200710{
Tejun Heo34a06bd2013-03-12 11:30:00 -0700711 bool managing = mutex_is_locked(&pool->manager_arb);
Tejun Heo63d95a92012-07-12 14:46:37 -0700712 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
713 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200714
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700715 /*
716 * nr_idle and idle_list may disagree if idle rebinding is in
717 * progress. Never return %true if idle_list is empty.
718 */
719 if (list_empty(&pool->idle_list))
720 return false;
721
Tejun Heoe22bee72010-06-29 10:07:14 +0200722 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
723}
724
725/*
726 * Wake up functions.
727 */
728
Tejun Heo7e116292010-06-29 10:07:13 +0200729/* Return the first worker. Safe with preemption disabled */
Tejun Heo63d95a92012-07-12 14:46:37 -0700730static struct worker *first_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200731{
Tejun Heo63d95a92012-07-12 14:46:37 -0700732 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200733 return NULL;
734
Tejun Heo63d95a92012-07-12 14:46:37 -0700735 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200736}
737
738/**
739 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700740 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200741 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700742 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200743 *
744 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800745 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200746 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700747static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200748{
Tejun Heo63d95a92012-07-12 14:46:37 -0700749 struct worker *worker = first_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200750
751 if (likely(worker))
752 wake_up_process(worker->task);
753}
754
Tejun Heo4690c4a2010-06-29 10:07:10 +0200755/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200756 * wq_worker_waking_up - a worker is waking up
757 * @task: task waking up
758 * @cpu: CPU @task is waking up to
759 *
760 * This function is called during try_to_wake_up() when a worker is
761 * being awoken.
762 *
763 * CONTEXT:
764 * spin_lock_irq(rq->lock)
765 */
Tejun Heod84ff052013-03-12 11:29:59 -0700766void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200767{
768 struct worker *worker = kthread_data(task);
769
Joonsoo Kim36576002012-10-26 23:03:49 +0900770 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800771 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800772 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900773 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200774}
775
776/**
777 * wq_worker_sleeping - a worker is going to sleep
778 * @task: task going to sleep
779 * @cpu: CPU in question, must be the current CPU number
780 *
781 * This function is called during schedule() when a busy worker is
782 * going to sleep. Worker on the same cpu can be woken up by
783 * returning pointer to its task.
784 *
785 * CONTEXT:
786 * spin_lock_irq(rq->lock)
787 *
788 * RETURNS:
789 * Worker task on @cpu to wake up, %NULL if none.
790 */
Tejun Heod84ff052013-03-12 11:29:59 -0700791struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200792{
793 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800794 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200795
Tejun Heo111c2252013-01-17 17:16:24 -0800796 /*
797 * Rescuers, which may not have all the fields set up like normal
798 * workers, also reach here, let's not access anything before
799 * checking NOT_RUNNING.
800 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500801 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200802 return NULL;
803
Tejun Heo111c2252013-01-17 17:16:24 -0800804 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800805
Tejun Heoe22bee72010-06-29 10:07:14 +0200806 /* this can only happen on the local cpu */
Tejun Heo6183c002013-03-12 11:29:57 -0700807 if (WARN_ON_ONCE(cpu != raw_smp_processor_id()))
808 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200809
810 /*
811 * The counterpart of the following dec_and_test, implied mb,
812 * worklist not empty test sequence is in insert_work().
813 * Please read comment there.
814 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700815 * NOT_RUNNING is clear. This means that we're bound to and
816 * running on the local cpu w/ rq lock held and preemption
817 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800818 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700819 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200820 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800821 if (atomic_dec_and_test(&pool->nr_running) &&
822 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700823 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200824 return to_wakeup ? to_wakeup->task : NULL;
825}
826
827/**
828 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200829 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200830 * @flags: flags to set
831 * @wakeup: wakeup an idle worker if necessary
832 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200833 * Set @flags in @worker->flags and adjust nr_running accordingly. If
834 * nr_running becomes zero and @wakeup is %true, an idle worker is
835 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200836 *
Tejun Heocb444762010-07-02 10:03:50 +0200837 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800838 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200839 */
840static inline void worker_set_flags(struct worker *worker, unsigned int flags,
841 bool wakeup)
842{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700843 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200844
Tejun Heocb444762010-07-02 10:03:50 +0200845 WARN_ON_ONCE(worker->task != current);
846
Tejun Heoe22bee72010-06-29 10:07:14 +0200847 /*
848 * If transitioning into NOT_RUNNING, adjust nr_running and
849 * wake up an idle worker as necessary if requested by
850 * @wakeup.
851 */
852 if ((flags & WORKER_NOT_RUNNING) &&
853 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoe22bee72010-06-29 10:07:14 +0200854 if (wakeup) {
Tejun Heoe19e3972013-01-24 11:39:44 -0800855 if (atomic_dec_and_test(&pool->nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700856 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700857 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200858 } else
Tejun Heoe19e3972013-01-24 11:39:44 -0800859 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200860 }
861
Tejun Heod302f012010-06-29 10:07:13 +0200862 worker->flags |= flags;
863}
864
865/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200866 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200867 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200868 * @flags: flags to clear
869 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200870 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200871 *
Tejun Heocb444762010-07-02 10:03:50 +0200872 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800873 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200874 */
875static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
876{
Tejun Heo63d95a92012-07-12 14:46:37 -0700877 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200878 unsigned int oflags = worker->flags;
879
Tejun Heocb444762010-07-02 10:03:50 +0200880 WARN_ON_ONCE(worker->task != current);
881
Tejun Heod302f012010-06-29 10:07:13 +0200882 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200883
Tejun Heo42c025f2011-01-11 15:58:49 +0100884 /*
885 * If transitioning out of NOT_RUNNING, increment nr_running. Note
886 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
887 * of multiple flags, not a single flag.
888 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200889 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
890 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800891 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200892}
893
894/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200895 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800896 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200897 * @work: work to find worker for
898 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800899 * Find a worker which is executing @work on @pool by searching
900 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800901 * to match, its current execution should match the address of @work and
902 * its work function. This is to avoid unwanted dependency between
903 * unrelated work executions through a work item being recycled while still
904 * being executed.
905 *
906 * This is a bit tricky. A work item may be freed once its execution
907 * starts and nothing prevents the freed area from being recycled for
908 * another work item. If the same work item address ends up being reused
909 * before the original execution finishes, workqueue will identify the
910 * recycled work item as currently executing and make it wait until the
911 * current execution finishes, introducing an unwanted dependency.
912 *
913 * This function checks the work item address, work function and workqueue
914 * to avoid false positives. Note that this isn't complete as one may
915 * construct a work function which can introduce dependency onto itself
916 * through a recycled work item. Well, if somebody wants to shoot oneself
917 * in the foot that badly, there's only so much we can do, and if such
918 * deadlock actually occurs, it should be easy to locate the culprit work
919 * function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200920 *
921 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800922 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200923 *
924 * RETURNS:
925 * Pointer to worker which is executing @work if found, NULL
926 * otherwise.
927 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800928static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200929 struct work_struct *work)
930{
Sasha Levin42f85702012-12-17 10:01:23 -0500931 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -0500932
Sasha Levinb67bfe02013-02-27 17:06:00 -0800933 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800934 (unsigned long)work)
935 if (worker->current_work == work &&
936 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500937 return worker;
938
939 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200940}
941
942/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700943 * move_linked_works - move linked works to a list
944 * @work: start of series of works to be scheduled
945 * @head: target list to append @work to
946 * @nextp: out paramter for nested worklist walking
947 *
948 * Schedule linked works starting from @work to @head. Work series to
949 * be scheduled starts at @work and includes any consecutive work with
950 * WORK_STRUCT_LINKED set in its predecessor.
951 *
952 * If @nextp is not NULL, it's updated to point to the next work of
953 * the last scheduled work. This allows move_linked_works() to be
954 * nested inside outer list_for_each_entry_safe().
955 *
956 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800957 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -0700958 */
959static void move_linked_works(struct work_struct *work, struct list_head *head,
960 struct work_struct **nextp)
961{
962 struct work_struct *n;
963
964 /*
965 * Linked worklist will always end before the end of the list,
966 * use NULL for list head.
967 */
968 list_for_each_entry_safe_from(work, n, NULL, entry) {
969 list_move_tail(&work->entry, head);
970 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
971 break;
972 }
973
974 /*
975 * If we're already inside safe list traversal and have moved
976 * multiple works to the scheduled queue, the next position
977 * needs to be updated.
978 */
979 if (nextp)
980 *nextp = n;
981}
982
Tejun Heo112202d2013-02-13 19:29:12 -0800983static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -0700984{
Tejun Heo112202d2013-02-13 19:29:12 -0800985 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -0700986
987 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -0800988 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -0700989 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -0800990 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -0700991}
992
Tejun Heo112202d2013-02-13 19:29:12 -0800993static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700994{
Tejun Heo112202d2013-02-13 19:29:12 -0800995 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700996 struct work_struct, entry);
997
Tejun Heo112202d2013-02-13 19:29:12 -0800998 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700999}
1000
Tejun Heobf4ede02012-08-03 10:30:46 -07001001/**
Tejun Heo112202d2013-02-13 19:29:12 -08001002 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1003 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001004 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001005 *
1006 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001007 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001008 *
1009 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001010 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001011 */
Tejun Heo112202d2013-02-13 19:29:12 -08001012static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001013{
1014 /* ignore uncolored works */
1015 if (color == WORK_NO_COLOR)
1016 return;
1017
Tejun Heo112202d2013-02-13 19:29:12 -08001018 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001019
Tejun Heo112202d2013-02-13 19:29:12 -08001020 pwq->nr_active--;
1021 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001022 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001023 if (pwq->nr_active < pwq->max_active)
1024 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001025 }
1026
1027 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001028 if (likely(pwq->flush_color != color))
Tejun Heobf4ede02012-08-03 10:30:46 -07001029 return;
1030
1031 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001032 if (pwq->nr_in_flight[color])
Tejun Heobf4ede02012-08-03 10:30:46 -07001033 return;
1034
Tejun Heo112202d2013-02-13 19:29:12 -08001035 /* this pwq is done, clear flush_color */
1036 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001037
1038 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001039 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001040 * will handle the rest.
1041 */
Tejun Heo112202d2013-02-13 19:29:12 -08001042 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1043 complete(&pwq->wq->first_flusher->done);
Tejun Heobf4ede02012-08-03 10:30:46 -07001044}
1045
Tejun Heo36e227d2012-08-03 10:30:46 -07001046/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001047 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001048 * @work: work item to steal
1049 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001050 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001051 *
1052 * Try to grab PENDING bit of @work. This function can handle @work in any
1053 * stable state - idle, on timer or on worklist. Return values are
1054 *
1055 * 1 if @work was pending and we successfully stole PENDING
1056 * 0 if @work was idle and we claimed PENDING
1057 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001058 * -ENOENT if someone else is canceling @work, this state may persist
1059 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001060 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001061 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001062 * interrupted while holding PENDING and @work off queue, irq must be
1063 * disabled on entry. This, combined with delayed_work->timer being
1064 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001065 *
1066 * On successful return, >= 0, irq is disabled and the caller is
1067 * responsible for releasing it using local_irq_restore(*@flags).
1068 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001069 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001070 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001071static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1072 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001073{
Tejun Heod565ed62013-01-24 11:01:33 -08001074 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001075 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001076
Tejun Heobbb68df2012-08-03 10:30:46 -07001077 local_irq_save(*flags);
1078
Tejun Heo36e227d2012-08-03 10:30:46 -07001079 /* try to steal the timer if it exists */
1080 if (is_dwork) {
1081 struct delayed_work *dwork = to_delayed_work(work);
1082
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001083 /*
1084 * dwork->timer is irqsafe. If del_timer() fails, it's
1085 * guaranteed that the timer is not queued anywhere and not
1086 * running on the local CPU.
1087 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001088 if (likely(del_timer(&dwork->timer)))
1089 return 1;
1090 }
1091
1092 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001093 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1094 return 0;
1095
1096 /*
1097 * The queueing is in progress, or it is already queued. Try to
1098 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1099 */
Tejun Heod565ed62013-01-24 11:01:33 -08001100 pool = get_work_pool(work);
1101 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001102 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001103
Tejun Heod565ed62013-01-24 11:01:33 -08001104 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001105 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001106 * work->data is guaranteed to point to pwq only while the work
1107 * item is queued on pwq->wq, and both updating work->data to point
1108 * to pwq on queueing and to pool on dequeueing are done under
1109 * pwq->pool->lock. This in turn guarantees that, if work->data
1110 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001111 * item is currently queued on that pool.
1112 */
Tejun Heo112202d2013-02-13 19:29:12 -08001113 pwq = get_work_pwq(work);
1114 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001115 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001116
Tejun Heo16062832013-02-06 18:04:53 -08001117 /*
1118 * A delayed work item cannot be grabbed directly because
1119 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001120 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001121 * management later on and cause stall. Make sure the work
1122 * item is activated before grabbing.
1123 */
1124 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001125 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001126
Tejun Heo16062832013-02-06 18:04:53 -08001127 list_del_init(&work->entry);
Tejun Heo112202d2013-02-13 19:29:12 -08001128 pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001129
Tejun Heo112202d2013-02-13 19:29:12 -08001130 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001131 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001132
Tejun Heo16062832013-02-06 18:04:53 -08001133 spin_unlock(&pool->lock);
1134 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001135 }
Tejun Heod565ed62013-01-24 11:01:33 -08001136 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001137fail:
1138 local_irq_restore(*flags);
1139 if (work_is_canceling(work))
1140 return -ENOENT;
1141 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001142 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001143}
1144
1145/**
Tejun Heo706026c2013-01-24 11:01:34 -08001146 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001147 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001148 * @work: work to insert
1149 * @head: insertion point
1150 * @extra_flags: extra WORK_STRUCT_* flags to set
1151 *
Tejun Heo112202d2013-02-13 19:29:12 -08001152 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001153 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001154 *
1155 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001156 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001157 */
Tejun Heo112202d2013-02-13 19:29:12 -08001158static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1159 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001160{
Tejun Heo112202d2013-02-13 19:29:12 -08001161 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001162
Tejun Heo4690c4a2010-06-29 10:07:10 +02001163 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001164 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001165 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +02001166
1167 /*
1168 * Ensure either worker_sched_deactivated() sees the above
1169 * list_add_tail() or we see zero nr_running to avoid workers
1170 * lying around lazily while there are works to be processed.
1171 */
1172 smp_mb();
1173
Tejun Heo63d95a92012-07-12 14:46:37 -07001174 if (__need_more_worker(pool))
1175 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001176}
1177
Tejun Heoc8efcc22010-12-20 19:32:04 +01001178/*
1179 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001180 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001181 */
1182static bool is_chained_work(struct workqueue_struct *wq)
1183{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001184 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001185
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001186 worker = current_wq_worker();
1187 /*
1188 * Return %true iff I'm a worker execuing a work item on @wq. If
1189 * I'm @worker, it's safe to dereference it without locking.
1190 */
Tejun Heo112202d2013-02-13 19:29:12 -08001191 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001192}
1193
Tejun Heod84ff052013-03-12 11:29:59 -07001194static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 struct work_struct *work)
1196{
Tejun Heo112202d2013-02-13 19:29:12 -08001197 struct pool_workqueue *pwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001198 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001199 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001200 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001201
1202 /*
1203 * While a work item is PENDING && off queue, a task trying to
1204 * steal the PENDING will busy-loop waiting for it to either get
1205 * queued or lose PENDING. Grabbing PENDING and queueing should
1206 * happen with IRQ disabled.
1207 */
1208 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001210 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001211
Tejun Heoc8efcc22010-12-20 19:32:04 +01001212 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02001213 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001214 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001215 return;
1216
Tejun Heo112202d2013-02-13 19:29:12 -08001217 /* determine the pwq to use */
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001218 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001219 struct worker_pool *last_pool;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001220
Tejun Heo57469822012-08-03 10:30:45 -07001221 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001222 cpu = raw_smp_processor_id();
1223
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001224 /*
Tejun Heodbf25762012-08-20 14:51:23 -07001225 * It's multi cpu. If @work was previously on a different
1226 * cpu, it might still be running there, in which case the
1227 * work needs to be queued on that cpu to guarantee
1228 * non-reentrancy.
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001229 */
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001230 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001231 last_pool = get_work_pool(work);
Tejun Heodbf25762012-08-20 14:51:23 -07001232
Tejun Heo112202d2013-02-13 19:29:12 -08001233 if (last_pool && last_pool != pwq->pool) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001234 struct worker *worker;
1235
Tejun Heod565ed62013-01-24 11:01:33 -08001236 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001237
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001238 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001239
Tejun Heo112202d2013-02-13 19:29:12 -08001240 if (worker && worker->current_pwq->wq == wq) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001241 pwq = per_cpu_ptr(wq->cpu_pwqs, last_pool->cpu);
Lai Jiangshan8594fad2013-02-07 13:14:20 -08001242 } else {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001243 /* meh... not running there, queue here */
Tejun Heod565ed62013-01-24 11:01:33 -08001244 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001245 spin_lock(&pwq->pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001246 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001247 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001248 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001249 }
Tejun Heof3421792010-07-02 10:03:51 +02001250 } else {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001251 pwq = first_pwq(wq);
Tejun Heo112202d2013-02-13 19:29:12 -08001252 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001253 }
1254
Tejun Heo112202d2013-02-13 19:29:12 -08001255 /* pwq determined, queue */
1256 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001257
Dan Carpenterf5b25522012-04-13 22:06:58 +03001258 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001259 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001260 return;
1261 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001262
Tejun Heo112202d2013-02-13 19:29:12 -08001263 pwq->nr_in_flight[pwq->work_color]++;
1264 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001265
Tejun Heo112202d2013-02-13 19:29:12 -08001266 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001267 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001268 pwq->nr_active++;
1269 worklist = &pwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001270 } else {
1271 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001272 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001273 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001274
Tejun Heo112202d2013-02-13 19:29:12 -08001275 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001276
Tejun Heo112202d2013-02-13 19:29:12 -08001277 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278}
1279
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001280/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001281 * queue_work_on - queue work on specific cpu
1282 * @cpu: CPU number to execute work on
1283 * @wq: workqueue to use
1284 * @work: work to queue
1285 *
Tejun Heod4283e92012-08-03 10:30:44 -07001286 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001287 *
1288 * We queue the work to a specific CPU, the caller must ensure it
1289 * can't go away.
1290 */
Tejun Heod4283e92012-08-03 10:30:44 -07001291bool queue_work_on(int cpu, struct workqueue_struct *wq,
1292 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001293{
Tejun Heod4283e92012-08-03 10:30:44 -07001294 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001295 unsigned long flags;
1296
1297 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001298
Tejun Heo22df02b2010-06-29 10:07:10 +02001299 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001300 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001301 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001302 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001303
1304 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001305 return ret;
1306}
1307EXPORT_SYMBOL_GPL(queue_work_on);
1308
Tejun Heo0a13c002012-08-03 10:30:44 -07001309/**
1310 * queue_work - queue work on a workqueue
1311 * @wq: workqueue to use
1312 * @work: work to queue
1313 *
Tejun Heod4283e92012-08-03 10:30:44 -07001314 * Returns %false if @work was already on a queue, %true otherwise.
Tejun Heo0a13c002012-08-03 10:30:44 -07001315 *
1316 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1317 * it can be processed by another CPU.
1318 */
Tejun Heod4283e92012-08-03 10:30:44 -07001319bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07001320{
Tejun Heo57469822012-08-03 10:30:45 -07001321 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
Tejun Heo0a13c002012-08-03 10:30:44 -07001322}
1323EXPORT_SYMBOL_GPL(queue_work);
1324
Tejun Heod8e794d2012-08-03 10:30:45 -07001325void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326{
David Howells52bad642006-11-22 14:54:01 +00001327 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001329 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001330 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001332EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001334static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1335 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001337 struct timer_list *timer = &dwork->timer;
1338 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001340 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1341 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001342 WARN_ON_ONCE(timer_pending(timer));
1343 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001344
Tejun Heo8852aac2012-12-01 16:23:42 -08001345 /*
1346 * If @delay is 0, queue @dwork->work immediately. This is for
1347 * both optimization and correctness. The earliest @timer can
1348 * expire is on the closest next tick and delayed_work users depend
1349 * on that there's no such delay when @delay is 0.
1350 */
1351 if (!delay) {
1352 __queue_work(cpu, wq, &dwork->work);
1353 return;
1354 }
1355
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001356 timer_stats_timer_set_start_info(&dwork->timer);
1357
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001358 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001359 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001360 timer->expires = jiffies + delay;
1361
1362 if (unlikely(cpu != WORK_CPU_UNBOUND))
1363 add_timer_on(timer, cpu);
1364 else
1365 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366}
1367
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001368/**
1369 * queue_delayed_work_on - queue work on specific CPU after delay
1370 * @cpu: CPU number to execute work on
1371 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001372 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001373 * @delay: number of jiffies to wait before queueing
1374 *
Tejun Heo715f1302012-08-03 10:30:46 -07001375 * Returns %false if @work was already on a queue, %true otherwise. If
1376 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1377 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001378 */
Tejun Heod4283e92012-08-03 10:30:44 -07001379bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1380 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001381{
David Howells52bad642006-11-22 14:54:01 +00001382 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001383 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001384 unsigned long flags;
1385
1386 /* read the comment in __queue_work() */
1387 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001388
Tejun Heo22df02b2010-06-29 10:07:10 +02001389 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001390 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001391 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001392 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001393
1394 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001395 return ret;
1396}
Dave Jonesae90dd52006-06-30 01:40:45 -04001397EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398
Tejun Heoc8e55f32010-06-29 10:07:12 +02001399/**
Tejun Heo0a13c002012-08-03 10:30:44 -07001400 * queue_delayed_work - queue work on a workqueue after delay
1401 * @wq: workqueue to use
1402 * @dwork: delayable work to queue
1403 * @delay: number of jiffies to wait before queueing
1404 *
Tejun Heo715f1302012-08-03 10:30:46 -07001405 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
Tejun Heo0a13c002012-08-03 10:30:44 -07001406 */
Tejun Heod4283e92012-08-03 10:30:44 -07001407bool queue_delayed_work(struct workqueue_struct *wq,
Tejun Heo0a13c002012-08-03 10:30:44 -07001408 struct delayed_work *dwork, unsigned long delay)
1409{
Tejun Heo57469822012-08-03 10:30:45 -07001410 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
Tejun Heo0a13c002012-08-03 10:30:44 -07001411}
1412EXPORT_SYMBOL_GPL(queue_delayed_work);
1413
1414/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001415 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1416 * @cpu: CPU number to execute work on
1417 * @wq: workqueue to use
1418 * @dwork: work to queue
1419 * @delay: number of jiffies to wait before queueing
1420 *
1421 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1422 * modify @dwork's timer so that it expires after @delay. If @delay is
1423 * zero, @work is guaranteed to be scheduled immediately regardless of its
1424 * current state.
1425 *
1426 * Returns %false if @dwork was idle and queued, %true if @dwork was
1427 * pending and its timer was modified.
1428 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001429 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001430 * See try_to_grab_pending() for details.
1431 */
1432bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1433 struct delayed_work *dwork, unsigned long delay)
1434{
1435 unsigned long flags;
1436 int ret;
1437
1438 do {
1439 ret = try_to_grab_pending(&dwork->work, true, &flags);
1440 } while (unlikely(ret == -EAGAIN));
1441
1442 if (likely(ret >= 0)) {
1443 __queue_delayed_work(cpu, wq, dwork, delay);
1444 local_irq_restore(flags);
1445 }
1446
1447 /* -ENOENT from try_to_grab_pending() becomes %true */
1448 return ret;
1449}
1450EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1451
1452/**
1453 * mod_delayed_work - modify delay of or queue a delayed work
1454 * @wq: workqueue to use
1455 * @dwork: work to queue
1456 * @delay: number of jiffies to wait before queueing
1457 *
1458 * mod_delayed_work_on() on local CPU.
1459 */
1460bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1461 unsigned long delay)
1462{
1463 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1464}
1465EXPORT_SYMBOL_GPL(mod_delayed_work);
1466
1467/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001468 * worker_enter_idle - enter idle state
1469 * @worker: worker which is entering idle state
1470 *
1471 * @worker is entering idle state. Update stats and idle timer if
1472 * necessary.
1473 *
1474 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001475 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001476 */
1477static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001479 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480
Tejun Heo6183c002013-03-12 11:29:57 -07001481 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1482 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1483 (worker->hentry.next || worker->hentry.pprev)))
1484 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485
Tejun Heocb444762010-07-02 10:03:50 +02001486 /* can't use worker_set_flags(), also called from start_worker() */
1487 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001488 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001489 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001490
Tejun Heoc8e55f32010-06-29 10:07:12 +02001491 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001492 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001493
Tejun Heo628c78e2012-07-17 12:39:27 -07001494 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1495 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001496
Tejun Heo544ecf32012-05-14 15:04:50 -07001497 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001498 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001499 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001500 * nr_running, the warning may trigger spuriously. Check iff
1501 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001502 */
Tejun Heo24647572013-01-24 11:01:33 -08001503 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001504 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001505 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506}
1507
Tejun Heoc8e55f32010-06-29 10:07:12 +02001508/**
1509 * worker_leave_idle - leave idle state
1510 * @worker: worker which is leaving idle state
1511 *
1512 * @worker is leaving idle state. Update stats.
1513 *
1514 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001515 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001516 */
1517static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001519 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Tejun Heo6183c002013-03-12 11:29:57 -07001521 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1522 return;
Tejun Heod302f012010-06-29 10:07:13 +02001523 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001524 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001525 list_del_init(&worker->entry);
1526}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
Tejun Heoe22bee72010-06-29 10:07:14 +02001528/**
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001529 * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it
1530 * @pool: target worker_pool
1531 *
1532 * Bind %current to the cpu of @pool if it is associated and lock @pool.
Tejun Heoe22bee72010-06-29 10:07:14 +02001533 *
1534 * Works which are scheduled while the cpu is online must at least be
1535 * scheduled to a worker which is bound to the cpu so that if they are
1536 * flushed from cpu callbacks while cpu is going down, they are
1537 * guaranteed to execute on the cpu.
1538 *
Lai Jiangshanf5faa072013-02-19 12:17:02 -08001539 * This function is to be used by unbound workers and rescuers to bind
Tejun Heoe22bee72010-06-29 10:07:14 +02001540 * themselves to the target cpu and may race with cpu going down or
1541 * coming online. kthread_bind() can't be used because it may put the
1542 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
Tejun Heo706026c2013-01-24 11:01:34 -08001543 * verbatim as it's best effort and blocking and pool may be
Tejun Heoe22bee72010-06-29 10:07:14 +02001544 * [dis]associated in the meantime.
1545 *
Tejun Heo706026c2013-01-24 11:01:34 -08001546 * This function tries set_cpus_allowed() and locks pool and verifies the
Tejun Heo24647572013-01-24 11:01:33 -08001547 * binding against %POOL_DISASSOCIATED which is set during
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001548 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1549 * enters idle state or fetches works without dropping lock, it can
1550 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001551 *
1552 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001553 * Might sleep. Called without any lock but returns with pool->lock
Tejun Heoe22bee72010-06-29 10:07:14 +02001554 * held.
1555 *
1556 * RETURNS:
Tejun Heo706026c2013-01-24 11:01:34 -08001557 * %true if the associated pool is online (@worker is successfully
Tejun Heoe22bee72010-06-29 10:07:14 +02001558 * bound), %false if offline.
1559 */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001560static bool worker_maybe_bind_and_lock(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001561__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001562{
Tejun Heoe22bee72010-06-29 10:07:14 +02001563 while (true) {
1564 /*
1565 * The following call may fail, succeed or succeed
1566 * without actually migrating the task to the cpu if
1567 * it races with cpu hotunplug operation. Verify
Tejun Heo24647572013-01-24 11:01:33 -08001568 * against POOL_DISASSOCIATED.
Tejun Heoe22bee72010-06-29 10:07:14 +02001569 */
Tejun Heo24647572013-01-24 11:01:33 -08001570 if (!(pool->flags & POOL_DISASSOCIATED))
Tejun Heo7a4e3442013-03-12 11:30:00 -07001571 set_cpus_allowed_ptr(current, pool->attrs->cpumask);
Oleg Nesterov85f41862007-05-09 02:34:20 -07001572
Tejun Heod565ed62013-01-24 11:01:33 -08001573 spin_lock_irq(&pool->lock);
Tejun Heo24647572013-01-24 11:01:33 -08001574 if (pool->flags & POOL_DISASSOCIATED)
Tejun Heoe22bee72010-06-29 10:07:14 +02001575 return false;
Lai Jiangshanf5faa072013-02-19 12:17:02 -08001576 if (task_cpu(current) == pool->cpu &&
Tejun Heo7a4e3442013-03-12 11:30:00 -07001577 cpumask_equal(&current->cpus_allowed, pool->attrs->cpumask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001578 return true;
Tejun Heod565ed62013-01-24 11:01:33 -08001579 spin_unlock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001580
Tejun Heo5035b202011-04-29 18:08:37 +02001581 /*
1582 * We've raced with CPU hot[un]plug. Give it a breather
1583 * and retry migration. cond_resched() is required here;
1584 * otherwise, we might deadlock against cpu_stop trying to
1585 * bring down the CPU on non-preemptive kernel.
1586 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001587 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001588 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001589 }
1590}
1591
1592/*
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001593 * Rebind an idle @worker to its CPU. worker_thread() will test
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001594 * list_empty(@worker->entry) before leaving idle and call this function.
Tejun Heo25511a42012-07-17 12:39:27 -07001595 */
1596static void idle_worker_rebind(struct worker *worker)
1597{
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001598 /* CPU may go down again inbetween, clear UNBOUND only on success */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001599 if (worker_maybe_bind_and_lock(worker->pool))
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001600 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heo25511a42012-07-17 12:39:27 -07001601
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001602 /* rebind complete, become available again */
1603 list_add(&worker->entry, &worker->pool->idle_list);
Tejun Heod565ed62013-01-24 11:01:33 -08001604 spin_unlock_irq(&worker->pool->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07001605}
1606
1607/*
1608 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001609 * the associated cpu which is coming back online. This is scheduled by
1610 * cpu up but can race with other cpu hotplug operations and may be
1611 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001612 */
Tejun Heo25511a42012-07-17 12:39:27 -07001613static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001614{
1615 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heoe22bee72010-06-29 10:07:14 +02001616
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001617 if (worker_maybe_bind_and_lock(worker->pool))
Lai Jiangshaneab6d822012-09-18 09:59:22 -07001618 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02001619
Tejun Heod565ed62013-01-24 11:01:33 -08001620 spin_unlock_irq(&worker->pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001621}
1622
Tejun Heo25511a42012-07-17 12:39:27 -07001623/**
Tejun Heo94cf58b2013-01-24 11:01:33 -08001624 * rebind_workers - rebind all workers of a pool to the associated CPU
1625 * @pool: pool of interest
Tejun Heo25511a42012-07-17 12:39:27 -07001626 *
Tejun Heo94cf58b2013-01-24 11:01:33 -08001627 * @pool->cpu is coming online. Rebind all workers to the CPU. Rebinding
Tejun Heo25511a42012-07-17 12:39:27 -07001628 * is different for idle and busy ones.
1629 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001630 * Idle ones will be removed from the idle_list and woken up. They will
1631 * add themselves back after completing rebind. This ensures that the
1632 * idle_list doesn't contain any unbound workers when re-bound busy workers
1633 * try to perform local wake-ups for concurrency management.
Tejun Heo25511a42012-07-17 12:39:27 -07001634 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001635 * Busy workers can rebind after they finish their current work items.
1636 * Queueing the rebind work item at the head of the scheduled list is
1637 * enough. Note that nr_running will be properly bumped as busy workers
1638 * rebind.
Tejun Heo25511a42012-07-17 12:39:27 -07001639 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001640 * On return, all non-manager workers are scheduled for rebind - see
1641 * manage_workers() for the manager special case. Any idle worker
1642 * including the manager will not appear on @idle_list until rebind is
1643 * complete, making local wake-ups safe.
Tejun Heo25511a42012-07-17 12:39:27 -07001644 */
Tejun Heo94cf58b2013-01-24 11:01:33 -08001645static void rebind_workers(struct worker_pool *pool)
Tejun Heo25511a42012-07-17 12:39:27 -07001646{
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001647 struct worker *worker, *n;
Tejun Heo25511a42012-07-17 12:39:27 -07001648 int i;
1649
Tejun Heo94cf58b2013-01-24 11:01:33 -08001650 lockdep_assert_held(&pool->assoc_mutex);
1651 lockdep_assert_held(&pool->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07001652
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001653 /* dequeue and kick idle ones */
Tejun Heo94cf58b2013-01-24 11:01:33 -08001654 list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
1655 /*
1656 * idle workers should be off @pool->idle_list until rebind
1657 * is complete to avoid receiving premature local wake-ups.
1658 */
1659 list_del_init(&worker->entry);
Lai Jiangshan96e65302012-09-02 00:28:19 +08001660
Tejun Heo94cf58b2013-01-24 11:01:33 -08001661 /*
1662 * worker_thread() will see the above dequeuing and call
1663 * idle_worker_rebind().
1664 */
1665 wake_up_process(worker->task);
1666 }
Tejun Heo25511a42012-07-17 12:39:27 -07001667
Tejun Heo94cf58b2013-01-24 11:01:33 -08001668 /* rebind busy workers */
Sasha Levinb67bfe02013-02-27 17:06:00 -08001669 for_each_busy_worker(worker, i, pool) {
Tejun Heo94cf58b2013-01-24 11:01:33 -08001670 struct work_struct *rebind_work = &worker->rebind_work;
1671 struct workqueue_struct *wq;
Tejun Heo25511a42012-07-17 12:39:27 -07001672
Tejun Heo94cf58b2013-01-24 11:01:33 -08001673 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1674 work_data_bits(rebind_work)))
1675 continue;
Tejun Heo25511a42012-07-17 12:39:27 -07001676
Tejun Heo94cf58b2013-01-24 11:01:33 -08001677 debug_work_activate(rebind_work);
Tejun Heo90beca52012-09-04 23:12:33 -07001678
Tejun Heo94cf58b2013-01-24 11:01:33 -08001679 /*
1680 * wq doesn't really matter but let's keep @worker->pool
Tejun Heo112202d2013-02-13 19:29:12 -08001681 * and @pwq->pool consistent for sanity.
Tejun Heo94cf58b2013-01-24 11:01:33 -08001682 */
Tejun Heo7a4e3442013-03-12 11:30:00 -07001683 if (worker->pool->attrs->nice < 0)
Tejun Heo94cf58b2013-01-24 11:01:33 -08001684 wq = system_highpri_wq;
1685 else
1686 wq = system_wq;
Tejun Heoec588152012-09-04 23:16:32 -07001687
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001688 insert_work(per_cpu_ptr(wq->cpu_pwqs, pool->cpu), rebind_work,
Tejun Heo94cf58b2013-01-24 11:01:33 -08001689 worker->scheduled.next,
1690 work_color_to_flags(WORK_NO_COLOR));
Tejun Heoec588152012-09-04 23:16:32 -07001691 }
Tejun Heo25511a42012-07-17 12:39:27 -07001692}
1693
Tejun Heoc34056a2010-06-29 10:07:11 +02001694static struct worker *alloc_worker(void)
1695{
1696 struct worker *worker;
1697
1698 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001699 if (worker) {
1700 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001701 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001702 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001703 /* on creation a worker is in !idle && prep state */
1704 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001705 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001706 return worker;
1707}
1708
1709/**
1710 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001711 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001712 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001713 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001714 * can be started by calling start_worker() or destroyed using
1715 * destroy_worker().
1716 *
1717 * CONTEXT:
1718 * Might sleep. Does GFP_KERNEL allocations.
1719 *
1720 * RETURNS:
1721 * Pointer to the newly created worker.
1722 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001723static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001724{
Tejun Heo7a4e3442013-03-12 11:30:00 -07001725 const char *pri = pool->attrs->nice < 0 ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001726 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001727 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001728
Tejun Heod565ed62013-01-24 11:01:33 -08001729 spin_lock_irq(&pool->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001730 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heod565ed62013-01-24 11:01:33 -08001731 spin_unlock_irq(&pool->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001732 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001733 goto fail;
Tejun Heod565ed62013-01-24 11:01:33 -08001734 spin_lock_irq(&pool->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001735 }
Tejun Heod565ed62013-01-24 11:01:33 -08001736 spin_unlock_irq(&pool->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001737
1738 worker = alloc_worker();
1739 if (!worker)
1740 goto fail;
1741
Tejun Heobd7bdd42012-07-12 14:46:37 -07001742 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001743 worker->id = id;
1744
Tejun Heoec22ca52013-01-24 11:01:33 -08001745 if (pool->cpu != WORK_CPU_UNBOUND)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001746 worker->task = kthread_create_on_node(worker_thread,
Tejun Heoec22ca52013-01-24 11:01:33 -08001747 worker, cpu_to_node(pool->cpu),
Tejun Heod84ff052013-03-12 11:29:59 -07001748 "kworker/%d:%d%s", pool->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001749 else
1750 worker->task = kthread_create(worker_thread, worker,
Tejun Heo32704762012-07-13 22:16:45 -07001751 "kworker/u:%d%s", id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001752 if (IS_ERR(worker->task))
1753 goto fail;
1754
Tejun Heo7a4e3442013-03-12 11:30:00 -07001755 set_user_nice(worker->task, pool->attrs->nice);
1756 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
Tejun Heo32704762012-07-13 22:16:45 -07001757
Tejun Heodb7bccf2010-06-29 10:07:12 +02001758 /*
Tejun Heo7a4e3442013-03-12 11:30:00 -07001759 * %PF_THREAD_BOUND is used to prevent userland from meddling with
1760 * cpumask of workqueue workers. This is an abuse. We need
1761 * %PF_NO_SETAFFINITY.
Tejun Heodb7bccf2010-06-29 10:07:12 +02001762 */
Tejun Heo7a4e3442013-03-12 11:30:00 -07001763 worker->task->flags |= PF_THREAD_BOUND;
1764
1765 /*
1766 * The caller is responsible for ensuring %POOL_DISASSOCIATED
1767 * remains stable across this function. See the comments above the
1768 * flag definition for details.
1769 */
1770 if (pool->flags & POOL_DISASSOCIATED)
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001771 worker->flags |= WORKER_UNBOUND;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001772
Tejun Heoc34056a2010-06-29 10:07:11 +02001773 return worker;
1774fail:
1775 if (id >= 0) {
Tejun Heod565ed62013-01-24 11:01:33 -08001776 spin_lock_irq(&pool->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001777 ida_remove(&pool->worker_ida, id);
Tejun Heod565ed62013-01-24 11:01:33 -08001778 spin_unlock_irq(&pool->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001779 }
1780 kfree(worker);
1781 return NULL;
1782}
1783
1784/**
1785 * start_worker - start a newly created worker
1786 * @worker: worker to start
1787 *
Tejun Heo706026c2013-01-24 11:01:34 -08001788 * Make the pool aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001789 *
1790 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001791 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001792 */
1793static void start_worker(struct worker *worker)
1794{
Tejun Heocb444762010-07-02 10:03:50 +02001795 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001796 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001797 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001798 wake_up_process(worker->task);
1799}
1800
1801/**
1802 * destroy_worker - destroy a workqueue worker
1803 * @worker: worker to be destroyed
1804 *
Tejun Heo706026c2013-01-24 11:01:34 -08001805 * Destroy @worker and adjust @pool stats accordingly.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001806 *
1807 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001808 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001809 */
1810static void destroy_worker(struct worker *worker)
1811{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001812 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001813 int id = worker->id;
1814
1815 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001816 if (WARN_ON(worker->current_work) ||
1817 WARN_ON(!list_empty(&worker->scheduled)))
1818 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001819
Tejun Heoc8e55f32010-06-29 10:07:12 +02001820 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001821 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001822 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001823 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001824
1825 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001826 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001827
Tejun Heod565ed62013-01-24 11:01:33 -08001828 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001829
Tejun Heoc34056a2010-06-29 10:07:11 +02001830 kthread_stop(worker->task);
1831 kfree(worker);
1832
Tejun Heod565ed62013-01-24 11:01:33 -08001833 spin_lock_irq(&pool->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001834 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001835}
1836
Tejun Heo63d95a92012-07-12 14:46:37 -07001837static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001838{
Tejun Heo63d95a92012-07-12 14:46:37 -07001839 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001840
Tejun Heod565ed62013-01-24 11:01:33 -08001841 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001842
Tejun Heo63d95a92012-07-12 14:46:37 -07001843 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001844 struct worker *worker;
1845 unsigned long expires;
1846
1847 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001848 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001849 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1850
1851 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001852 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001853 else {
1854 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001855 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001856 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001857 }
1858 }
1859
Tejun Heod565ed62013-01-24 11:01:33 -08001860 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001861}
1862
Tejun Heo493a1722013-03-12 11:29:59 -07001863static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001864{
Tejun Heo112202d2013-02-13 19:29:12 -08001865 struct pool_workqueue *pwq = get_work_pwq(work);
1866 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001867
1868 lockdep_assert_held(&workqueue_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001869
1870 if (!(wq->flags & WQ_RESCUER))
Tejun Heo493a1722013-03-12 11:29:59 -07001871 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001872
1873 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001874 if (list_empty(&pwq->mayday_node)) {
1875 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001876 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001877 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001878}
1879
Tejun Heo706026c2013-01-24 11:01:34 -08001880static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001881{
Tejun Heo63d95a92012-07-12 14:46:37 -07001882 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001883 struct work_struct *work;
1884
Tejun Heo493a1722013-03-12 11:29:59 -07001885 spin_lock_irq(&workqueue_lock); /* for wq->maydays */
1886 spin_lock(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001887
Tejun Heo63d95a92012-07-12 14:46:37 -07001888 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001889 /*
1890 * We've been trying to create a new worker but
1891 * haven't been successful. We might be hitting an
1892 * allocation deadlock. Send distress signals to
1893 * rescuers.
1894 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001895 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001896 send_mayday(work);
1897 }
1898
Tejun Heo493a1722013-03-12 11:29:59 -07001899 spin_unlock(&pool->lock);
1900 spin_unlock_irq(&workqueue_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001901
Tejun Heo63d95a92012-07-12 14:46:37 -07001902 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001903}
1904
1905/**
1906 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001907 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001908 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001909 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001910 * have at least one idle worker on return from this function. If
1911 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001912 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001913 * possible allocation deadlock.
1914 *
1915 * On return, need_to_create_worker() is guaranteed to be false and
1916 * may_start_working() true.
1917 *
1918 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001919 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001920 * multiple times. Does GFP_KERNEL allocations. Called only from
1921 * manager.
1922 *
1923 * RETURNS:
Tejun Heod565ed62013-01-24 11:01:33 -08001924 * false if no action was taken and pool->lock stayed locked, true
Tejun Heoe22bee72010-06-29 10:07:14 +02001925 * otherwise.
1926 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001927static bool maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001928__releases(&pool->lock)
1929__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001930{
Tejun Heo63d95a92012-07-12 14:46:37 -07001931 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001932 return false;
1933restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001934 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001935
Tejun Heoe22bee72010-06-29 10:07:14 +02001936 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001937 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001938
1939 while (true) {
1940 struct worker *worker;
1941
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001942 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001943 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001944 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001945 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001946 start_worker(worker);
Tejun Heo6183c002013-03-12 11:29:57 -07001947 if (WARN_ON_ONCE(need_to_create_worker(pool)))
1948 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001949 return true;
1950 }
1951
Tejun Heo63d95a92012-07-12 14:46:37 -07001952 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001953 break;
1954
Tejun Heoe22bee72010-06-29 10:07:14 +02001955 __set_current_state(TASK_INTERRUPTIBLE);
1956 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001957
Tejun Heo63d95a92012-07-12 14:46:37 -07001958 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001959 break;
1960 }
1961
Tejun Heo63d95a92012-07-12 14:46:37 -07001962 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001963 spin_lock_irq(&pool->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07001964 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001965 goto restart;
1966 return true;
1967}
1968
1969/**
1970 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07001971 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02001972 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001973 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02001974 * IDLE_WORKER_TIMEOUT.
1975 *
1976 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001977 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001978 * multiple times. Called only from manager.
1979 *
1980 * RETURNS:
Tejun Heod565ed62013-01-24 11:01:33 -08001981 * false if no action was taken and pool->lock stayed locked, true
Tejun Heoe22bee72010-06-29 10:07:14 +02001982 * otherwise.
1983 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001984static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001985{
1986 bool ret = false;
1987
Tejun Heo63d95a92012-07-12 14:46:37 -07001988 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001989 struct worker *worker;
1990 unsigned long expires;
1991
Tejun Heo63d95a92012-07-12 14:46:37 -07001992 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001993 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1994
1995 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001996 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001997 break;
1998 }
1999
2000 destroy_worker(worker);
2001 ret = true;
2002 }
2003
2004 return ret;
2005}
2006
2007/**
2008 * manage_workers - manage worker pool
2009 * @worker: self
2010 *
Tejun Heo706026c2013-01-24 11:01:34 -08002011 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002012 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002013 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002014 *
2015 * The caller can safely start processing works on false return. On
2016 * true return, it's guaranteed that need_to_create_worker() is false
2017 * and may_start_working() is true.
2018 *
2019 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002020 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002021 * multiple times. Does GFP_KERNEL allocations.
2022 *
2023 * RETURNS:
Tejun Heod565ed62013-01-24 11:01:33 -08002024 * spin_lock_irq(pool->lock) which may be released and regrabbed
2025 * multiple times. Does GFP_KERNEL allocations.
Tejun Heoe22bee72010-06-29 10:07:14 +02002026 */
2027static bool manage_workers(struct worker *worker)
2028{
Tejun Heo63d95a92012-07-12 14:46:37 -07002029 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002030 bool ret = false;
2031
Tejun Heo34a06bd2013-03-12 11:30:00 -07002032 if (!mutex_trylock(&pool->manager_arb))
Tejun Heoe22bee72010-06-29 10:07:14 +02002033 return ret;
2034
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002035 /*
2036 * To simplify both worker management and CPU hotplug, hold off
2037 * management while hotplug is in progress. CPU hotplug path can't
Tejun Heo34a06bd2013-03-12 11:30:00 -07002038 * grab @pool->manager_arb to achieve this because that can lead to
2039 * idle worker depletion (all become busy thinking someone else is
2040 * managing) which in turn can result in deadlock under extreme
2041 * circumstances. Use @pool->assoc_mutex to synchronize manager
2042 * against CPU hotplug.
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002043 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002044 * assoc_mutex would always be free unless CPU hotplug is in
Tejun Heod565ed62013-01-24 11:01:33 -08002045 * progress. trylock first without dropping @pool->lock.
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002046 */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002047 if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
Tejun Heod565ed62013-01-24 11:01:33 -08002048 spin_unlock_irq(&pool->lock);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002049 mutex_lock(&pool->assoc_mutex);
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002050 /*
2051 * CPU hotplug could have happened while we were waiting
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002052 * for assoc_mutex. Hotplug itself can't handle us
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002053 * because manager isn't either on idle or busy list, and
Tejun Heo706026c2013-01-24 11:01:34 -08002054 * @pool's state and ours could have deviated.
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002055 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002056 * As hotplug is now excluded via assoc_mutex, we can
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002057 * simply try to bind. It will succeed or fail depending
Tejun Heo706026c2013-01-24 11:01:34 -08002058 * on @pool's current state. Try it and adjust
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002059 * %WORKER_UNBOUND accordingly.
2060 */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08002061 if (worker_maybe_bind_and_lock(pool))
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002062 worker->flags &= ~WORKER_UNBOUND;
2063 else
2064 worker->flags |= WORKER_UNBOUND;
2065
2066 ret = true;
2067 }
2068
Tejun Heo11ebea52012-07-12 14:46:37 -07002069 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002070
2071 /*
2072 * Destroy and then create so that may_start_working() is true
2073 * on return.
2074 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002075 ret |= maybe_destroy_workers(pool);
2076 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002077
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002078 mutex_unlock(&pool->assoc_mutex);
Tejun Heo34a06bd2013-03-12 11:30:00 -07002079 mutex_unlock(&pool->manager_arb);
Tejun Heoe22bee72010-06-29 10:07:14 +02002080 return ret;
2081}
2082
Tejun Heoa62428c2010-06-29 10:07:10 +02002083/**
2084 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002085 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002086 * @work: work to process
2087 *
2088 * Process @work. This function contains all the logics necessary to
2089 * process a single work including synchronization against and
2090 * interaction with other workers on the same cpu, queueing and
2091 * flushing. As long as context requirement is met, any worker can
2092 * call this function to process a work.
2093 *
2094 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002095 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002096 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002097static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002098__releases(&pool->lock)
2099__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002100{
Tejun Heo112202d2013-02-13 19:29:12 -08002101 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002102 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002103 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002104 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002105 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002106#ifdef CONFIG_LOCKDEP
2107 /*
2108 * It is permissible to free the struct work_struct from
2109 * inside the function that is called from it, this we need to
2110 * take into account for lockdep too. To avoid bogus "held
2111 * lock freed" warnings as well as problems when looking into
2112 * work->lockdep_map, make a copy and use that here.
2113 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002114 struct lockdep_map lockdep_map;
2115
2116 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002117#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002118 /*
2119 * Ensure we're on the correct CPU. DISASSOCIATED test is
2120 * necessary to avoid spurious warnings from rescuers servicing the
Tejun Heo24647572013-01-24 11:01:33 -08002121 * unbound or a disassociated pool.
Tejun Heo6fec10a2012-07-22 10:16:34 -07002122 */
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002123 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
Tejun Heo24647572013-01-24 11:01:33 -08002124 !(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002125 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002126
Tejun Heo7e116292010-06-29 10:07:13 +02002127 /*
2128 * A single work shouldn't be executed concurrently by
2129 * multiple workers on a single cpu. Check whether anyone is
2130 * already processing the work. If so, defer the work to the
2131 * currently executing one.
2132 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002133 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002134 if (unlikely(collision)) {
2135 move_linked_works(work, &collision->scheduled, NULL);
2136 return;
2137 }
2138
Tejun Heo8930cab2012-08-03 10:30:45 -07002139 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002140 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002141 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002142 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002143 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002144 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002145 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002146
Tejun Heoa62428c2010-06-29 10:07:10 +02002147 list_del_init(&work->entry);
2148
Tejun Heo649027d2010-06-29 10:07:14 +02002149 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002150 * CPU intensive works don't participate in concurrency
2151 * management. They're the scheduler's responsibility.
2152 */
2153 if (unlikely(cpu_intensive))
2154 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2155
Tejun Heo974271c2012-07-12 14:46:37 -07002156 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002157 * Unbound pool isn't concurrency managed and work items should be
Tejun Heo974271c2012-07-12 14:46:37 -07002158 * executed ASAP. Wake up another worker if necessary.
2159 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002160 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2161 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002162
Tejun Heo8930cab2012-08-03 10:30:45 -07002163 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002164 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002165 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002166 * PENDING and queued state changes happen together while IRQ is
2167 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002168 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002169 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002170
Tejun Heod565ed62013-01-24 11:01:33 -08002171 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002172
Tejun Heo112202d2013-02-13 19:29:12 -08002173 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002174 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002175 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002176 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002177 /*
2178 * While we must be careful to not use "work" after this, the trace
2179 * point will only record its address.
2180 */
2181 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002182 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002183 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002184
2185 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002186 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2187 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002188 current->comm, preempt_count(), task_pid_nr(current),
2189 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002190 debug_show_held_locks(current);
2191 dump_stack();
2192 }
2193
Tejun Heod565ed62013-01-24 11:01:33 -08002194 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002195
Tejun Heofb0e7be2010-06-29 10:07:15 +02002196 /* clear cpu intensive status */
2197 if (unlikely(cpu_intensive))
2198 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2199
Tejun Heoa62428c2010-06-29 10:07:10 +02002200 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002201 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002202 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002203 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002204 worker->current_pwq = NULL;
2205 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002206}
2207
Tejun Heoaffee4b2010-06-29 10:07:12 +02002208/**
2209 * process_scheduled_works - process scheduled works
2210 * @worker: self
2211 *
2212 * Process all scheduled works. Please note that the scheduled list
2213 * may change while processing a work, so this function repeatedly
2214 * fetches a work from the top and executes it.
2215 *
2216 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002217 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002218 * multiple times.
2219 */
2220static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002222 while (!list_empty(&worker->scheduled)) {
2223 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002225 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227}
2228
Tejun Heo4690c4a2010-06-29 10:07:10 +02002229/**
2230 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002231 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002232 *
Tejun Heo706026c2013-01-24 11:01:34 -08002233 * The worker thread function. There are NR_CPU_WORKER_POOLS dynamic pools
2234 * of these per each cpu. These workers process all works regardless of
Tejun Heoe22bee72010-06-29 10:07:14 +02002235 * their specific target workqueue. The only exception is works which
2236 * belong to workqueues with a rescuer which will be explained in
2237 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002238 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002239static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240{
Tejun Heoc34056a2010-06-29 10:07:11 +02002241 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002242 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243
Tejun Heoe22bee72010-06-29 10:07:14 +02002244 /* tell the scheduler that this is a workqueue worker */
2245 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002246woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002247 spin_lock_irq(&pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002249 /* we are off idle list if destruction or rebind is requested */
2250 if (unlikely(list_empty(&worker->entry))) {
Tejun Heod565ed62013-01-24 11:01:33 -08002251 spin_unlock_irq(&pool->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002252
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002253 /* if DIE is set, destruction is requested */
Tejun Heo25511a42012-07-17 12:39:27 -07002254 if (worker->flags & WORKER_DIE) {
2255 worker->task->flags &= ~PF_WQ_WORKER;
2256 return 0;
2257 }
2258
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002259 /* otherwise, rebind */
Tejun Heo25511a42012-07-17 12:39:27 -07002260 idle_worker_rebind(worker);
2261 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 }
2263
Tejun Heoc8e55f32010-06-29 10:07:12 +02002264 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002265recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002266 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002267 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002268 goto sleep;
2269
2270 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002271 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002272 goto recheck;
2273
Tejun Heoc8e55f32010-06-29 10:07:12 +02002274 /*
2275 * ->scheduled list can only be filled while a worker is
2276 * preparing to process a work or actually processing it.
2277 * Make sure nobody diddled with it while I was sleeping.
2278 */
Tejun Heo6183c002013-03-12 11:29:57 -07002279 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002280
Tejun Heoe22bee72010-06-29 10:07:14 +02002281 /*
2282 * When control reaches this point, we're guaranteed to have
2283 * at least one idle worker or that someone else has already
2284 * assumed the manager role.
2285 */
2286 worker_clr_flags(worker, WORKER_PREP);
2287
2288 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002289 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002290 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002291 struct work_struct, entry);
2292
2293 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2294 /* optimization path, not strictly necessary */
2295 process_one_work(worker, work);
2296 if (unlikely(!list_empty(&worker->scheduled)))
2297 process_scheduled_works(worker);
2298 } else {
2299 move_linked_works(work, &worker->scheduled, NULL);
2300 process_scheduled_works(worker);
2301 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002302 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002303
Tejun Heoe22bee72010-06-29 10:07:14 +02002304 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002305sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002306 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002307 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002308
Tejun Heoc8e55f32010-06-29 10:07:12 +02002309 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002310 * pool->lock is held and there's no work to process and no need to
2311 * manage, sleep. Workers are woken up only while holding
2312 * pool->lock or from local cpu, so setting the current state
2313 * before releasing pool->lock is enough to prevent losing any
2314 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002315 */
2316 worker_enter_idle(worker);
2317 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002318 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002319 schedule();
2320 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321}
2322
Tejun Heoe22bee72010-06-29 10:07:14 +02002323/**
2324 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002325 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002326 *
2327 * Workqueue rescuer thread function. There's one rescuer for each
2328 * workqueue which has WQ_RESCUER set.
2329 *
Tejun Heo706026c2013-01-24 11:01:34 -08002330 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002331 * worker which uses GFP_KERNEL allocation which has slight chance of
2332 * developing into deadlock if some works currently on the same queue
2333 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2334 * the problem rescuer solves.
2335 *
Tejun Heo706026c2013-01-24 11:01:34 -08002336 * When such condition is possible, the pool summons rescuers of all
2337 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002338 * those works so that forward progress can be guaranteed.
2339 *
2340 * This should happen rarely.
2341 */
Tejun Heo111c2252013-01-17 17:16:24 -08002342static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002343{
Tejun Heo111c2252013-01-17 17:16:24 -08002344 struct worker *rescuer = __rescuer;
2345 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002346 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heoe22bee72010-06-29 10:07:14 +02002347
2348 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002349
2350 /*
2351 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2352 * doesn't participate in concurrency management.
2353 */
2354 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002355repeat:
2356 set_current_state(TASK_INTERRUPTIBLE);
2357
Mike Galbraith412d32e2012-11-28 07:17:18 +01002358 if (kthread_should_stop()) {
2359 __set_current_state(TASK_RUNNING);
Tejun Heo111c2252013-01-17 17:16:24 -08002360 rescuer->task->flags &= ~PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002361 return 0;
Mike Galbraith412d32e2012-11-28 07:17:18 +01002362 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002363
Tejun Heo493a1722013-03-12 11:29:59 -07002364 /* see whether any pwq is asking for help */
2365 spin_lock_irq(&workqueue_lock);
2366
2367 while (!list_empty(&wq->maydays)) {
2368 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2369 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002370 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002371 struct work_struct *work, *n;
2372
2373 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002374 list_del_init(&pwq->mayday_node);
2375
2376 spin_unlock_irq(&workqueue_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002377
2378 /* migrate to the target cpu if possible */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08002379 worker_maybe_bind_and_lock(pool);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002380 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002381
2382 /*
2383 * Slurp in all works issued via this workqueue and
2384 * process'em.
2385 */
Tejun Heo6183c002013-03-12 11:29:57 -07002386 WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002387 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heo112202d2013-02-13 19:29:12 -08002388 if (get_work_pwq(work) == pwq)
Tejun Heoe22bee72010-06-29 10:07:14 +02002389 move_linked_works(work, scheduled, &n);
2390
2391 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002392
2393 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002394 * Leave this pool. If keep_working() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002395 * regular worker; otherwise, we end up with 0 concurrency
2396 * and stalling the execution.
2397 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002398 if (keep_working(pool))
2399 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002400
Lai Jiangshanb3104102013-02-19 12:17:02 -08002401 rescuer->pool = NULL;
Tejun Heo493a1722013-03-12 11:29:59 -07002402 spin_unlock(&pool->lock);
2403 spin_lock(&workqueue_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002404 }
2405
Tejun Heo493a1722013-03-12 11:29:59 -07002406 spin_unlock_irq(&workqueue_lock);
2407
Tejun Heo111c2252013-01-17 17:16:24 -08002408 /* rescuers should never participate in concurrency management */
2409 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002410 schedule();
2411 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412}
2413
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002414struct wq_barrier {
2415 struct work_struct work;
2416 struct completion done;
2417};
2418
2419static void wq_barrier_func(struct work_struct *work)
2420{
2421 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2422 complete(&barr->done);
2423}
2424
Tejun Heo4690c4a2010-06-29 10:07:10 +02002425/**
2426 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002427 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002428 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002429 * @target: target work to attach @barr to
2430 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002431 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002432 * @barr is linked to @target such that @barr is completed only after
2433 * @target finishes execution. Please note that the ordering
2434 * guarantee is observed only with respect to @target and on the local
2435 * cpu.
2436 *
2437 * Currently, a queued barrier can't be canceled. This is because
2438 * try_to_grab_pending() can't determine whether the work to be
2439 * grabbed is at the head of the queue and thus can't clear LINKED
2440 * flag of the previous work while there must be a valid next work
2441 * after a work with LINKED flag set.
2442 *
2443 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002444 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002445 *
2446 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002447 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002448 */
Tejun Heo112202d2013-02-13 19:29:12 -08002449static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002450 struct wq_barrier *barr,
2451 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002452{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002453 struct list_head *head;
2454 unsigned int linked = 0;
2455
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002456 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002457 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002458 * as we know for sure that this will not trigger any of the
2459 * checks and call back into the fixup functions where we
2460 * might deadlock.
2461 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002462 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002463 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002464 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002465
Tejun Heoaffee4b2010-06-29 10:07:12 +02002466 /*
2467 * If @target is currently being executed, schedule the
2468 * barrier to the worker; otherwise, put it after @target.
2469 */
2470 if (worker)
2471 head = worker->scheduled.next;
2472 else {
2473 unsigned long *bits = work_data_bits(target);
2474
2475 head = target->entry.next;
2476 /* there can already be other linked works, inherit and set */
2477 linked = *bits & WORK_STRUCT_LINKED;
2478 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2479 }
2480
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002481 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002482 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002483 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002484}
2485
Tejun Heo73f53c42010-06-29 10:07:11 +02002486/**
Tejun Heo112202d2013-02-13 19:29:12 -08002487 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002488 * @wq: workqueue being flushed
2489 * @flush_color: new flush color, < 0 for no-op
2490 * @work_color: new work color, < 0 for no-op
2491 *
Tejun Heo112202d2013-02-13 19:29:12 -08002492 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002493 *
Tejun Heo112202d2013-02-13 19:29:12 -08002494 * If @flush_color is non-negative, flush_color on all pwqs should be
2495 * -1. If no pwq has in-flight commands at the specified color, all
2496 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2497 * has in flight commands, its pwq->flush_color is set to
2498 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002499 * wakeup logic is armed and %true is returned.
2500 *
2501 * The caller should have initialized @wq->first_flusher prior to
2502 * calling this function with non-negative @flush_color. If
2503 * @flush_color is negative, no flush color update is done and %false
2504 * is returned.
2505 *
Tejun Heo112202d2013-02-13 19:29:12 -08002506 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002507 * work_color which is previous to @work_color and all will be
2508 * advanced to @work_color.
2509 *
2510 * CONTEXT:
2511 * mutex_lock(wq->flush_mutex).
2512 *
2513 * RETURNS:
2514 * %true if @flush_color >= 0 and there's something to flush. %false
2515 * otherwise.
2516 */
Tejun Heo112202d2013-02-13 19:29:12 -08002517static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002518 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519{
Tejun Heo73f53c42010-06-29 10:07:11 +02002520 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002521 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002522
Tejun Heo73f53c42010-06-29 10:07:11 +02002523 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002524 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002525 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002526 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002527
Tejun Heo76af4d92013-03-12 11:30:00 -07002528 local_irq_disable();
2529
Tejun Heo49e3cf42013-03-12 11:29:58 -07002530 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002531 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002532
Tejun Heo76af4d92013-03-12 11:30:00 -07002533 spin_lock(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002534
2535 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002536 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002537
Tejun Heo112202d2013-02-13 19:29:12 -08002538 if (pwq->nr_in_flight[flush_color]) {
2539 pwq->flush_color = flush_color;
2540 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002541 wait = true;
2542 }
2543 }
2544
2545 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002546 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002547 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002548 }
2549
Tejun Heo76af4d92013-03-12 11:30:00 -07002550 spin_unlock(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002551 }
2552
Tejun Heo76af4d92013-03-12 11:30:00 -07002553 local_irq_enable();
2554
Tejun Heo112202d2013-02-13 19:29:12 -08002555 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002556 complete(&wq->first_flusher->done);
2557
2558 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559}
2560
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002561/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002562 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002563 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564 *
2565 * Forces execution of the workqueue and blocks until its completion.
2566 * This is typically used in driver shutdown handlers.
2567 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002568 * We sleep until all works which were queued on entry have been handled,
2569 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002571void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572{
Tejun Heo73f53c42010-06-29 10:07:11 +02002573 struct wq_flusher this_flusher = {
2574 .list = LIST_HEAD_INIT(this_flusher.list),
2575 .flush_color = -1,
2576 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2577 };
2578 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002579
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002580 lock_map_acquire(&wq->lockdep_map);
2581 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002582
2583 mutex_lock(&wq->flush_mutex);
2584
2585 /*
2586 * Start-to-wait phase
2587 */
2588 next_color = work_next_color(wq->work_color);
2589
2590 if (next_color != wq->flush_color) {
2591 /*
2592 * Color space is not full. The current work_color
2593 * becomes our flush_color and work_color is advanced
2594 * by one.
2595 */
Tejun Heo6183c002013-03-12 11:29:57 -07002596 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002597 this_flusher.flush_color = wq->work_color;
2598 wq->work_color = next_color;
2599
2600 if (!wq->first_flusher) {
2601 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002602 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002603
2604 wq->first_flusher = &this_flusher;
2605
Tejun Heo112202d2013-02-13 19:29:12 -08002606 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002607 wq->work_color)) {
2608 /* nothing to flush, done */
2609 wq->flush_color = next_color;
2610 wq->first_flusher = NULL;
2611 goto out_unlock;
2612 }
2613 } else {
2614 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002615 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002616 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002617 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002618 }
2619 } else {
2620 /*
2621 * Oops, color space is full, wait on overflow queue.
2622 * The next flush completion will assign us
2623 * flush_color and transfer to flusher_queue.
2624 */
2625 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2626 }
2627
2628 mutex_unlock(&wq->flush_mutex);
2629
2630 wait_for_completion(&this_flusher.done);
2631
2632 /*
2633 * Wake-up-and-cascade phase
2634 *
2635 * First flushers are responsible for cascading flushes and
2636 * handling overflow. Non-first flushers can simply return.
2637 */
2638 if (wq->first_flusher != &this_flusher)
2639 return;
2640
2641 mutex_lock(&wq->flush_mutex);
2642
Tejun Heo4ce48b32010-07-02 10:03:51 +02002643 /* we might have raced, check again with mutex held */
2644 if (wq->first_flusher != &this_flusher)
2645 goto out_unlock;
2646
Tejun Heo73f53c42010-06-29 10:07:11 +02002647 wq->first_flusher = NULL;
2648
Tejun Heo6183c002013-03-12 11:29:57 -07002649 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2650 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002651
2652 while (true) {
2653 struct wq_flusher *next, *tmp;
2654
2655 /* complete all the flushers sharing the current flush color */
2656 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2657 if (next->flush_color != wq->flush_color)
2658 break;
2659 list_del_init(&next->list);
2660 complete(&next->done);
2661 }
2662
Tejun Heo6183c002013-03-12 11:29:57 -07002663 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2664 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002665
2666 /* this flush_color is finished, advance by one */
2667 wq->flush_color = work_next_color(wq->flush_color);
2668
2669 /* one color has been freed, handle overflow queue */
2670 if (!list_empty(&wq->flusher_overflow)) {
2671 /*
2672 * Assign the same color to all overflowed
2673 * flushers, advance work_color and append to
2674 * flusher_queue. This is the start-to-wait
2675 * phase for these overflowed flushers.
2676 */
2677 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2678 tmp->flush_color = wq->work_color;
2679
2680 wq->work_color = work_next_color(wq->work_color);
2681
2682 list_splice_tail_init(&wq->flusher_overflow,
2683 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002684 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002685 }
2686
2687 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002688 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002689 break;
2690 }
2691
2692 /*
2693 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002694 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002695 */
Tejun Heo6183c002013-03-12 11:29:57 -07002696 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2697 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002698
2699 list_del_init(&next->list);
2700 wq->first_flusher = next;
2701
Tejun Heo112202d2013-02-13 19:29:12 -08002702 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002703 break;
2704
2705 /*
2706 * Meh... this color is already done, clear first
2707 * flusher and repeat cascading.
2708 */
2709 wq->first_flusher = NULL;
2710 }
2711
2712out_unlock:
2713 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002714}
Dave Jonesae90dd52006-06-30 01:40:45 -04002715EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002717/**
2718 * drain_workqueue - drain a workqueue
2719 * @wq: workqueue to drain
2720 *
2721 * Wait until the workqueue becomes empty. While draining is in progress,
2722 * only chain queueing is allowed. IOW, only currently pending or running
2723 * work items on @wq can queue further work items on it. @wq is flushed
2724 * repeatedly until it becomes empty. The number of flushing is detemined
2725 * by the depth of chaining and should be relatively short. Whine if it
2726 * takes too long.
2727 */
2728void drain_workqueue(struct workqueue_struct *wq)
2729{
2730 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002731 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002732
2733 /*
2734 * __queue_work() needs to test whether there are drainers, is much
2735 * hotter than drain_workqueue() and already looks at @wq->flags.
2736 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2737 */
Tejun Heoe98d5b12013-03-12 11:29:57 -07002738 spin_lock_irq(&workqueue_lock);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002739 if (!wq->nr_drainers++)
2740 wq->flags |= WQ_DRAINING;
Tejun Heoe98d5b12013-03-12 11:29:57 -07002741 spin_unlock_irq(&workqueue_lock);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002742reflush:
2743 flush_workqueue(wq);
2744
Tejun Heo76af4d92013-03-12 11:30:00 -07002745 local_irq_disable();
2746
Tejun Heo49e3cf42013-03-12 11:29:58 -07002747 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002748 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002749
Tejun Heo76af4d92013-03-12 11:30:00 -07002750 spin_lock(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002751 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Tejun Heo76af4d92013-03-12 11:30:00 -07002752 spin_unlock(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002753
2754 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002755 continue;
2756
2757 if (++flush_cnt == 10 ||
2758 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Valentin Ilie044c7822012-08-19 00:52:42 +03002759 pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
2760 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002761
2762 local_irq_enable();
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002763 goto reflush;
2764 }
2765
Tejun Heo76af4d92013-03-12 11:30:00 -07002766 spin_lock(&workqueue_lock);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002767 if (!--wq->nr_drainers)
2768 wq->flags &= ~WQ_DRAINING;
Tejun Heo76af4d92013-03-12 11:30:00 -07002769 spin_unlock(&workqueue_lock);
2770
2771 local_irq_enable();
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002772}
2773EXPORT_SYMBOL_GPL(drain_workqueue);
2774
Tejun Heo606a5022012-08-20 14:51:23 -07002775static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002776{
2777 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002778 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002779 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002780
2781 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002782
Tejun Heofa1b54e2013-03-12 11:30:00 -07002783 local_irq_disable();
2784 pool = get_work_pool(work);
2785 if (!pool) {
2786 local_irq_enable();
2787 return false;
2788 }
2789
2790 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002791 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002792 pwq = get_work_pwq(work);
2793 if (pwq) {
2794 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002795 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002796 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002797 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002798 if (!worker)
2799 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002800 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002801 }
Tejun Heobaf59022010-09-16 10:42:16 +02002802
Tejun Heo112202d2013-02-13 19:29:12 -08002803 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002804 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002805
Tejun Heoe1594892011-01-09 23:32:15 +01002806 /*
2807 * If @max_active is 1 or rescuer is in use, flushing another work
2808 * item on the same workqueue may lead to deadlock. Make sure the
2809 * flusher is not running on the same workqueue by verifying write
2810 * access.
2811 */
Tejun Heo112202d2013-02-13 19:29:12 -08002812 if (pwq->wq->saved_max_active == 1 || pwq->wq->flags & WQ_RESCUER)
2813 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002814 else
Tejun Heo112202d2013-02-13 19:29:12 -08002815 lock_map_acquire_read(&pwq->wq->lockdep_map);
2816 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002817
Tejun Heobaf59022010-09-16 10:42:16 +02002818 return true;
2819already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002820 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002821 return false;
2822}
2823
Oleg Nesterovdb700892008-07-25 01:47:49 -07002824/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002825 * flush_work - wait for a work to finish executing the last queueing instance
2826 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002827 *
Tejun Heo606a5022012-08-20 14:51:23 -07002828 * Wait until @work has finished execution. @work is guaranteed to be idle
2829 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002830 *
2831 * RETURNS:
2832 * %true if flush_work() waited for the work to finish execution,
2833 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002834 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002835bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002836{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002837 struct wq_barrier barr;
2838
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002839 lock_map_acquire(&work->lockdep_map);
2840 lock_map_release(&work->lockdep_map);
2841
Tejun Heo606a5022012-08-20 14:51:23 -07002842 if (start_flush_work(work, &barr)) {
Tejun Heobaf59022010-09-16 10:42:16 +02002843 wait_for_completion(&barr.done);
2844 destroy_work_on_stack(&barr.work);
2845 return true;
Tejun Heo606a5022012-08-20 14:51:23 -07002846 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002847 return false;
Tejun Heo606a5022012-08-20 14:51:23 -07002848 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002849}
2850EXPORT_SYMBOL_GPL(flush_work);
2851
Tejun Heo36e227d2012-08-03 10:30:46 -07002852static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002853{
Tejun Heobbb68df2012-08-03 10:30:46 -07002854 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002855 int ret;
2856
2857 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002858 ret = try_to_grab_pending(work, is_dwork, &flags);
2859 /*
2860 * If someone else is canceling, wait for the same event it
2861 * would be waiting for before retrying.
2862 */
2863 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002864 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002865 } while (unlikely(ret < 0));
2866
Tejun Heobbb68df2012-08-03 10:30:46 -07002867 /* tell other tasks trying to grab @work to back off */
2868 mark_work_canceling(work);
2869 local_irq_restore(flags);
2870
Tejun Heo606a5022012-08-20 14:51:23 -07002871 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002872 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002873 return ret;
2874}
2875
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002876/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002877 * cancel_work_sync - cancel a work and wait for it to finish
2878 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002879 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002880 * Cancel @work and wait for its execution to finish. This function
2881 * can be used even if the work re-queues itself or migrates to
2882 * another workqueue. On return from this function, @work is
2883 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002884 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002885 * cancel_work_sync(&delayed_work->work) must not be used for
2886 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002887 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002888 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002889 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002890 *
2891 * RETURNS:
2892 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002893 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002894bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002895{
Tejun Heo36e227d2012-08-03 10:30:46 -07002896 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002897}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002898EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002899
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002900/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002901 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2902 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002903 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002904 * Delayed timer is cancelled and the pending work is queued for
2905 * immediate execution. Like flush_work(), this function only
2906 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002907 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002908 * RETURNS:
2909 * %true if flush_work() waited for the work to finish execution,
2910 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002911 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002912bool flush_delayed_work(struct delayed_work *dwork)
2913{
Tejun Heo8930cab2012-08-03 10:30:45 -07002914 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002915 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002916 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002917 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002918 return flush_work(&dwork->work);
2919}
2920EXPORT_SYMBOL(flush_delayed_work);
2921
2922/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002923 * cancel_delayed_work - cancel a delayed work
2924 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002925 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002926 * Kill off a pending delayed_work. Returns %true if @dwork was pending
2927 * and canceled; %false if wasn't pending. Note that the work callback
2928 * function may still be running on return, unless it returns %true and the
2929 * work doesn't re-arm itself. Explicitly flush or use
2930 * cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002931 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002932 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002933 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002934bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002935{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002936 unsigned long flags;
2937 int ret;
2938
2939 do {
2940 ret = try_to_grab_pending(&dwork->work, true, &flags);
2941 } while (unlikely(ret == -EAGAIN));
2942
2943 if (unlikely(ret < 0))
2944 return false;
2945
Tejun Heo7c3eed52013-01-24 11:01:33 -08002946 set_work_pool_and_clear_pending(&dwork->work,
2947 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002948 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002949 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002950}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002951EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002952
2953/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002954 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2955 * @dwork: the delayed work cancel
2956 *
2957 * This is cancel_work_sync() for delayed works.
2958 *
2959 * RETURNS:
2960 * %true if @dwork was pending, %false otherwise.
2961 */
2962bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002963{
Tejun Heo36e227d2012-08-03 10:30:46 -07002964 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002965}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002966EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002967
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002968/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07002969 * schedule_work_on - put work task on a specific cpu
2970 * @cpu: cpu to put the work task on
2971 * @work: job to be done
2972 *
2973 * This puts a job on a specific cpu
2974 */
Tejun Heod4283e92012-08-03 10:30:44 -07002975bool schedule_work_on(int cpu, struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07002976{
Tejun Heod320c032010-06-29 10:07:14 +02002977 return queue_work_on(cpu, system_wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07002978}
2979EXPORT_SYMBOL(schedule_work_on);
2980
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002981/**
Dave Jonesae90dd52006-06-30 01:40:45 -04002982 * schedule_work - put work task in global workqueue
Linus Torvalds1da177e2005-04-16 15:20:36 -07002983 * @work: job to be done
Linus Torvalds1da177e2005-04-16 15:20:36 -07002984 *
Tejun Heod4283e92012-08-03 10:30:44 -07002985 * Returns %false if @work was already on the kernel-global workqueue and
2986 * %true otherwise.
David Howells52bad642006-11-22 14:54:01 +00002987 *
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002988 * This puts a job in the kernel-global workqueue if it was not already
2989 * queued and leaves it in the same position on the kernel-global
2990 * workqueue otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991 */
Tejun Heod4283e92012-08-03 10:30:44 -07002992bool schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002993{
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002994 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002995}
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002996EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002997
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002998/**
2999 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
3000 * @cpu: cpu to use
3001 * @dwork: job to be done
3002 * @delay: number of jiffies to wait
3003 *
3004 * After waiting for a given time this puts a job in the kernel-global
3005 * workqueue on the specified CPU.
3006 */
Tejun Heod4283e92012-08-03 10:30:44 -07003007bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
3008 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003009{
Tejun Heod320c032010-06-29 10:07:14 +02003010 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011}
Dave Jonesae90dd52006-06-30 01:40:45 -04003012EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013
Andrew Mortonb6136772006-06-25 05:47:49 -07003014/**
Tejun Heo0a13c002012-08-03 10:30:44 -07003015 * schedule_delayed_work - put work task in global workqueue after delay
3016 * @dwork: job to be done
3017 * @delay: number of jiffies to wait or 0 for immediate execution
3018 *
3019 * After waiting for a given time this puts a job in the kernel-global
3020 * workqueue.
3021 */
Tejun Heod4283e92012-08-03 10:30:44 -07003022bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
Tejun Heo0a13c002012-08-03 10:30:44 -07003023{
3024 return queue_delayed_work(system_wq, dwork, delay);
3025}
3026EXPORT_SYMBOL(schedule_delayed_work);
3027
3028/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003029 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003030 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003031 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003032 * schedule_on_each_cpu() executes @func on each online CPU using the
3033 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003034 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003035 *
3036 * RETURNS:
3037 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003038 */
David Howells65f27f32006-11-22 14:55:48 +00003039int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003040{
3041 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003042 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003043
Andrew Mortonb6136772006-06-25 05:47:49 -07003044 works = alloc_percpu(struct work_struct);
3045 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003046 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003047
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003048 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003049
Christoph Lameter15316ba2006-01-08 01:00:43 -08003050 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003051 struct work_struct *work = per_cpu_ptr(works, cpu);
3052
3053 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003054 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003055 }
Tejun Heo93981802009-11-17 14:06:20 -08003056
3057 for_each_online_cpu(cpu)
3058 flush_work(per_cpu_ptr(works, cpu));
3059
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003060 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003061 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003062 return 0;
3063}
3064
Alan Sterneef6a7d2010-02-12 17:39:21 +09003065/**
3066 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3067 *
3068 * Forces execution of the kernel-global workqueue and blocks until its
3069 * completion.
3070 *
3071 * Think twice before calling this function! It's very easy to get into
3072 * trouble if you don't take great care. Either of the following situations
3073 * will lead to deadlock:
3074 *
3075 * One of the work items currently on the workqueue needs to acquire
3076 * a lock held by your code or its caller.
3077 *
3078 * Your code is running in the context of a work routine.
3079 *
3080 * They will be detected by lockdep when they occur, but the first might not
3081 * occur very often. It depends on what work items are on the workqueue and
3082 * what locks they need, which you have no control over.
3083 *
3084 * In most situations flushing the entire workqueue is overkill; you merely
3085 * need to know that a particular work item isn't queued and isn't running.
3086 * In such cases you should use cancel_delayed_work_sync() or
3087 * cancel_work_sync() instead.
3088 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003089void flush_scheduled_work(void)
3090{
Tejun Heod320c032010-06-29 10:07:14 +02003091 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003092}
Dave Jonesae90dd52006-06-30 01:40:45 -04003093EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003094
3095/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003096 * execute_in_process_context - reliably execute the routine with user context
3097 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003098 * @ew: guaranteed storage for the execute work structure (must
3099 * be available when the work executes)
3100 *
3101 * Executes the function immediately if process context is available,
3102 * otherwise schedules the function for delayed execution.
3103 *
3104 * Returns: 0 - function was executed
3105 * 1 - function was scheduled for execution
3106 */
David Howells65f27f32006-11-22 14:55:48 +00003107int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003108{
3109 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003110 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003111 return 0;
3112 }
3113
David Howells65f27f32006-11-22 14:55:48 +00003114 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003115 schedule_work(&ew->work);
3116
3117 return 1;
3118}
3119EXPORT_SYMBOL_GPL(execute_in_process_context);
3120
Linus Torvalds1da177e2005-04-16 15:20:36 -07003121int keventd_up(void)
3122{
Tejun Heod320c032010-06-29 10:07:14 +02003123 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003124}
3125
Tejun Heo7a4e3442013-03-12 11:30:00 -07003126/**
3127 * free_workqueue_attrs - free a workqueue_attrs
3128 * @attrs: workqueue_attrs to free
3129 *
3130 * Undo alloc_workqueue_attrs().
3131 */
3132void free_workqueue_attrs(struct workqueue_attrs *attrs)
3133{
3134 if (attrs) {
3135 free_cpumask_var(attrs->cpumask);
3136 kfree(attrs);
3137 }
3138}
3139
3140/**
3141 * alloc_workqueue_attrs - allocate a workqueue_attrs
3142 * @gfp_mask: allocation mask to use
3143 *
3144 * Allocate a new workqueue_attrs, initialize with default settings and
3145 * return it. Returns NULL on failure.
3146 */
3147struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3148{
3149 struct workqueue_attrs *attrs;
3150
3151 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3152 if (!attrs)
3153 goto fail;
3154 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3155 goto fail;
3156
3157 cpumask_setall(attrs->cpumask);
3158 return attrs;
3159fail:
3160 free_workqueue_attrs(attrs);
3161 return NULL;
3162}
3163
3164/**
3165 * init_worker_pool - initialize a newly zalloc'd worker_pool
3166 * @pool: worker_pool to initialize
3167 *
3168 * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
3169 * Returns 0 on success, -errno on failure.
3170 */
3171static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003172{
3173 spin_lock_init(&pool->lock);
3174 pool->flags |= POOL_DISASSOCIATED;
3175 INIT_LIST_HEAD(&pool->worklist);
3176 INIT_LIST_HEAD(&pool->idle_list);
3177 hash_init(pool->busy_hash);
3178
3179 init_timer_deferrable(&pool->idle_timer);
3180 pool->idle_timer.function = idle_worker_timeout;
3181 pool->idle_timer.data = (unsigned long)pool;
3182
3183 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3184 (unsigned long)pool);
3185
3186 mutex_init(&pool->manager_arb);
3187 mutex_init(&pool->assoc_mutex);
3188 ida_init(&pool->worker_ida);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003189
3190 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3191 if (!pool->attrs)
3192 return -ENOMEM;
3193 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003194}
3195
Tejun Heo30cdf242013-03-12 11:29:57 -07003196static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003197{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003198 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo30cdf242013-03-12 11:29:57 -07003199 int cpu;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003200
Tejun Heo30cdf242013-03-12 11:29:57 -07003201 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003202 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3203 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003204 return -ENOMEM;
3205
3206 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003207 struct pool_workqueue *pwq =
3208 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003209
Tejun Heo49e3cf42013-03-12 11:29:58 -07003210 pwq->pool = get_std_worker_pool(cpu, highpri);
Tejun Heo76af4d92013-03-12 11:30:00 -07003211 list_add_tail_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heo30cdf242013-03-12 11:29:57 -07003212 }
3213 } else {
3214 struct pool_workqueue *pwq;
3215
3216 pwq = kmem_cache_zalloc(pwq_cache, GFP_KERNEL);
3217 if (!pwq)
3218 return -ENOMEM;
3219
Tejun Heo49e3cf42013-03-12 11:29:58 -07003220 pwq->pool = get_std_worker_pool(WORK_CPU_UNBOUND, highpri);
Tejun Heo76af4d92013-03-12 11:30:00 -07003221 list_add_tail_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heo30cdf242013-03-12 11:29:57 -07003222 }
3223
3224 return 0;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003225}
3226
Tejun Heo112202d2013-02-13 19:29:12 -08003227static void free_pwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003228{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003229 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo420c0dd2013-03-12 11:29:59 -07003230 free_percpu(wq->cpu_pwqs);
3231 else if (!list_empty(&wq->pwqs))
3232 kmem_cache_free(pwq_cache, list_first_entry(&wq->pwqs,
3233 struct pool_workqueue, pwqs_node));
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003234}
3235
Tejun Heof3421792010-07-02 10:03:51 +02003236static int wq_clamp_max_active(int max_active, unsigned int flags,
3237 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003238{
Tejun Heof3421792010-07-02 10:03:51 +02003239 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3240
3241 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003242 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3243 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003244
Tejun Heof3421792010-07-02 10:03:51 +02003245 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003246}
3247
Tejun Heob196be82012-01-10 15:11:35 -08003248struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003249 unsigned int flags,
3250 int max_active,
3251 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003252 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003253{
Tejun Heob196be82012-01-10 15:11:35 -08003254 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003255 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003256 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003257 size_t namelen;
3258
3259 /* determine namelen, allocate wq and format name */
3260 va_start(args, lock_name);
3261 va_copy(args1, args);
3262 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3263
3264 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3265 if (!wq)
3266 goto err;
3267
3268 vsnprintf(wq->name, namelen, fmt, args1);
3269 va_end(args);
3270 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003271
Tejun Heof3421792010-07-02 10:03:51 +02003272 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02003273 * Workqueues which may be used during memory reclaim should
3274 * have a rescuer to guarantee forward progress.
3275 */
3276 if (flags & WQ_MEM_RECLAIM)
3277 flags |= WQ_RESCUER;
3278
Tejun Heod320c032010-06-29 10:07:14 +02003279 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003280 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003281
Tejun Heob196be82012-01-10 15:11:35 -08003282 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003283 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003284 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003285 mutex_init(&wq->flush_mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003286 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003287 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003288 INIT_LIST_HEAD(&wq->flusher_queue);
3289 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003290 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003291
Johannes Bergeb13ba82008-01-16 09:51:58 +01003292 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003293 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003294
Tejun Heo30cdf242013-03-12 11:29:57 -07003295 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003296 goto err;
3297
Tejun Heo76af4d92013-03-12 11:30:00 -07003298 local_irq_disable();
Tejun Heo49e3cf42013-03-12 11:29:58 -07003299 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08003300 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo112202d2013-02-13 19:29:12 -08003301 pwq->wq = wq;
3302 pwq->flush_color = -1;
3303 pwq->max_active = max_active;
3304 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo493a1722013-03-12 11:29:59 -07003305 INIT_LIST_HEAD(&pwq->mayday_node);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003306 }
Tejun Heo76af4d92013-03-12 11:30:00 -07003307 local_irq_enable();
Oleg Nesterov3af244332007-05-09 02:34:09 -07003308
Tejun Heoe22bee72010-06-29 10:07:14 +02003309 if (flags & WQ_RESCUER) {
3310 struct worker *rescuer;
3311
Tejun Heoe22bee72010-06-29 10:07:14 +02003312 wq->rescuer = rescuer = alloc_worker();
3313 if (!rescuer)
3314 goto err;
3315
Tejun Heo111c2252013-01-17 17:16:24 -08003316 rescuer->rescue_wq = wq;
3317 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003318 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003319 if (IS_ERR(rescuer->task))
3320 goto err;
3321
Tejun Heoe22bee72010-06-29 10:07:14 +02003322 rescuer->task->flags |= PF_THREAD_BOUND;
3323 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003324 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003325
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003326 /*
3327 * workqueue_lock protects global freeze state and workqueues
3328 * list. Grab it, set max_active accordingly and add the new
3329 * workqueue to workqueues list.
3330 */
Tejun Heoe98d5b12013-03-12 11:29:57 -07003331 spin_lock_irq(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003332
Tejun Heo58a69cb2011-02-16 09:25:31 +01003333 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heo49e3cf42013-03-12 11:29:58 -07003334 for_each_pwq(pwq, wq)
3335 pwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003336
Tejun Heo15376632010-06-29 10:07:11 +02003337 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003338
Tejun Heoe98d5b12013-03-12 11:29:57 -07003339 spin_unlock_irq(&workqueue_lock);
Tejun Heo15376632010-06-29 10:07:11 +02003340
Oleg Nesterov3af244332007-05-09 02:34:09 -07003341 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003342err:
3343 if (wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08003344 free_pwqs(wq);
Tejun Heoe22bee72010-06-29 10:07:14 +02003345 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003346 kfree(wq);
3347 }
3348 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003349}
Tejun Heod320c032010-06-29 10:07:14 +02003350EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003351
3352/**
3353 * destroy_workqueue - safely terminate a workqueue
3354 * @wq: target workqueue
3355 *
3356 * Safely destroy a workqueue. All work currently pending will be done first.
3357 */
3358void destroy_workqueue(struct workqueue_struct *wq)
3359{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003360 struct pool_workqueue *pwq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003361
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003362 /* drain it before proceeding with destruction */
3363 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003364
Tejun Heo76af4d92013-03-12 11:30:00 -07003365 spin_lock_irq(&workqueue_lock);
3366
Tejun Heo6183c002013-03-12 11:29:57 -07003367 /* sanity checks */
Tejun Heo49e3cf42013-03-12 11:29:58 -07003368 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07003369 int i;
3370
Tejun Heo76af4d92013-03-12 11:30:00 -07003371 for (i = 0; i < WORK_NR_COLORS; i++) {
3372 if (WARN_ON(pwq->nr_in_flight[i])) {
3373 spin_unlock_irq(&workqueue_lock);
Tejun Heo6183c002013-03-12 11:29:57 -07003374 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003375 }
3376 }
3377
Tejun Heo6183c002013-03-12 11:29:57 -07003378 if (WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07003379 WARN_ON(!list_empty(&pwq->delayed_works))) {
3380 spin_unlock_irq(&workqueue_lock);
Tejun Heo6183c002013-03-12 11:29:57 -07003381 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003382 }
Tejun Heo6183c002013-03-12 11:29:57 -07003383 }
3384
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003385 /*
3386 * wq list is used to freeze wq, remove from list after
3387 * flushing is complete in case freeze races us.
3388 */
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07003389 list_del(&wq->list);
Tejun Heo76af4d92013-03-12 11:30:00 -07003390
Tejun Heoe98d5b12013-03-12 11:29:57 -07003391 spin_unlock_irq(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003392
Tejun Heoe22bee72010-06-29 10:07:14 +02003393 if (wq->flags & WQ_RESCUER) {
3394 kthread_stop(wq->rescuer->task);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003395 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003396 }
3397
Tejun Heo112202d2013-02-13 19:29:12 -08003398 free_pwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003399 kfree(wq);
3400}
3401EXPORT_SYMBOL_GPL(destroy_workqueue);
3402
Tejun Heodcd989c2010-06-29 10:07:14 +02003403/**
Tejun Heo112202d2013-02-13 19:29:12 -08003404 * pwq_set_max_active - adjust max_active of a pwq
3405 * @pwq: target pool_workqueue
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003406 * @max_active: new max_active value.
3407 *
Tejun Heo112202d2013-02-13 19:29:12 -08003408 * Set @pwq->max_active to @max_active and activate delayed works if
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003409 * increased.
3410 *
3411 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08003412 * spin_lock_irq(pool->lock).
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003413 */
Tejun Heo112202d2013-02-13 19:29:12 -08003414static void pwq_set_max_active(struct pool_workqueue *pwq, int max_active)
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003415{
Tejun Heo112202d2013-02-13 19:29:12 -08003416 pwq->max_active = max_active;
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003417
Tejun Heo112202d2013-02-13 19:29:12 -08003418 while (!list_empty(&pwq->delayed_works) &&
3419 pwq->nr_active < pwq->max_active)
3420 pwq_activate_first_delayed(pwq);
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003421}
3422
3423/**
Tejun Heodcd989c2010-06-29 10:07:14 +02003424 * workqueue_set_max_active - adjust max_active of a workqueue
3425 * @wq: target workqueue
3426 * @max_active: new max_active value.
3427 *
3428 * Set max_active of @wq to @max_active.
3429 *
3430 * CONTEXT:
3431 * Don't call from IRQ context.
3432 */
3433void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3434{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003435 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02003436
Tejun Heof3421792010-07-02 10:03:51 +02003437 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003438
Tejun Heoe98d5b12013-03-12 11:29:57 -07003439 spin_lock_irq(&workqueue_lock);
Tejun Heodcd989c2010-06-29 10:07:14 +02003440
3441 wq->saved_max_active = max_active;
3442
Tejun Heo49e3cf42013-03-12 11:29:58 -07003443 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08003444 struct worker_pool *pool = pwq->pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02003445
Tejun Heoe98d5b12013-03-12 11:29:57 -07003446 spin_lock(&pool->lock);
Tejun Heodcd989c2010-06-29 10:07:14 +02003447
Tejun Heo58a69cb2011-02-16 09:25:31 +01003448 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heo35b6bb62013-01-24 11:01:33 -08003449 !(pool->flags & POOL_FREEZING))
Tejun Heo112202d2013-02-13 19:29:12 -08003450 pwq_set_max_active(pwq, max_active);
Tejun Heodcd989c2010-06-29 10:07:14 +02003451
Tejun Heoe98d5b12013-03-12 11:29:57 -07003452 spin_unlock(&pool->lock);
Tejun Heodcd989c2010-06-29 10:07:14 +02003453 }
3454
Tejun Heoe98d5b12013-03-12 11:29:57 -07003455 spin_unlock_irq(&workqueue_lock);
Tejun Heodcd989c2010-06-29 10:07:14 +02003456}
3457EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3458
3459/**
3460 * workqueue_congested - test whether a workqueue is congested
3461 * @cpu: CPU in question
3462 * @wq: target workqueue
3463 *
3464 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3465 * no synchronization around this function and the test result is
3466 * unreliable and only useful as advisory hints or for debugging.
3467 *
3468 * RETURNS:
3469 * %true if congested, %false otherwise.
3470 */
Tejun Heod84ff052013-03-12 11:29:59 -07003471bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02003472{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003473 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07003474 bool ret;
3475
3476 preempt_disable();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003477
3478 if (!(wq->flags & WQ_UNBOUND))
3479 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
3480 else
3481 pwq = first_pwq(wq);
Tejun Heodcd989c2010-06-29 10:07:14 +02003482
Tejun Heo76af4d92013-03-12 11:30:00 -07003483 ret = !list_empty(&pwq->delayed_works);
3484 preempt_enable();
3485
3486 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02003487}
3488EXPORT_SYMBOL_GPL(workqueue_congested);
3489
3490/**
Tejun Heodcd989c2010-06-29 10:07:14 +02003491 * work_busy - test whether a work is currently pending or running
3492 * @work: the work to be tested
3493 *
3494 * Test whether @work is currently pending or running. There is no
3495 * synchronization around this function and the test result is
3496 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02003497 *
3498 * RETURNS:
3499 * OR'd bitmask of WORK_BUSY_* bits.
3500 */
3501unsigned int work_busy(struct work_struct *work)
3502{
Tejun Heofa1b54e2013-03-12 11:30:00 -07003503 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02003504 unsigned long flags;
3505 unsigned int ret = 0;
3506
Tejun Heodcd989c2010-06-29 10:07:14 +02003507 if (work_pending(work))
3508 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02003509
Tejun Heofa1b54e2013-03-12 11:30:00 -07003510 local_irq_save(flags);
3511 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08003512 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07003513 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08003514 if (find_worker_executing_work(pool, work))
3515 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07003516 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08003517 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07003518 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02003519
3520 return ret;
3521}
3522EXPORT_SYMBOL_GPL(work_busy);
3523
Tejun Heodb7bccf2010-06-29 10:07:12 +02003524/*
3525 * CPU hotplug.
3526 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003527 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08003528 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08003529 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02003530 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08003531 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02003532 * blocked draining impractical.
3533 *
Tejun Heo24647572013-01-24 11:01:33 -08003534 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07003535 * running as an unbound one and allowing it to be reattached later if the
3536 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003537 */
3538
Tejun Heo706026c2013-01-24 11:01:34 -08003539static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003540{
Tejun Heo38db41d2013-01-24 11:01:34 -08003541 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07003542 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003543 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003544 int i;
3545
Tejun Heo38db41d2013-01-24 11:01:34 -08003546 for_each_std_worker_pool(pool, cpu) {
Tejun Heo6183c002013-03-12 11:29:57 -07003547 WARN_ON_ONCE(cpu != smp_processor_id());
Tejun Heo94cf58b2013-01-24 11:01:33 -08003548
3549 mutex_lock(&pool->assoc_mutex);
3550 spin_lock_irq(&pool->lock);
3551
3552 /*
3553 * We've claimed all manager positions. Make all workers
3554 * unbound and set DISASSOCIATED. Before this, all workers
3555 * except for the ones which are still executing works from
3556 * before the last CPU down must be on the cpu. After
3557 * this, they may become diasporas.
3558 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07003559 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07003560 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003561
Sasha Levinb67bfe02013-02-27 17:06:00 -08003562 for_each_busy_worker(worker, i, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003563 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003564
Tejun Heo24647572013-01-24 11:01:33 -08003565 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003566
Tejun Heo94cf58b2013-01-24 11:01:33 -08003567 spin_unlock_irq(&pool->lock);
3568 mutex_unlock(&pool->assoc_mutex);
3569 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003570
3571 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07003572 * Call schedule() so that we cross rq->lock and thus can guarantee
3573 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3574 * as scheduler callbacks may be invoked from other cpus.
3575 */
3576 schedule();
3577
3578 /*
3579 * Sched callbacks are disabled now. Zap nr_running. After this,
3580 * nr_running stays zero and need_more_worker() and keep_working()
Tejun Heo38db41d2013-01-24 11:01:34 -08003581 * are always true as long as the worklist is not empty. Pools on
3582 * @cpu now behave as unbound (in terms of concurrency management)
3583 * pools which are served by workers tied to the CPU.
Tejun Heo628c78e2012-07-17 12:39:27 -07003584 *
3585 * On return from this function, the current worker would trigger
3586 * unbound chain execution of pending work items if other workers
3587 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02003588 */
Tejun Heo38db41d2013-01-24 11:01:34 -08003589 for_each_std_worker_pool(pool, cpu)
Tejun Heoe19e3972013-01-24 11:39:44 -08003590 atomic_set(&pool->nr_running, 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003591}
3592
Tejun Heo8db25e72012-07-17 12:39:28 -07003593/*
3594 * Workqueues should be brought up before normal priority CPU notifiers.
3595 * This will be registered high priority CPU notifier.
3596 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003597static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07003598 unsigned long action,
3599 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003600{
Tejun Heod84ff052013-03-12 11:29:59 -07003601 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003602 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003603
Tejun Heo8db25e72012-07-17 12:39:28 -07003604 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003605 case CPU_UP_PREPARE:
Tejun Heo38db41d2013-01-24 11:01:34 -08003606 for_each_std_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07003607 struct worker *worker;
3608
3609 if (pool->nr_workers)
3610 continue;
3611
3612 worker = create_worker(pool);
3613 if (!worker)
3614 return NOTIFY_BAD;
3615
Tejun Heod565ed62013-01-24 11:01:33 -08003616 spin_lock_irq(&pool->lock);
Tejun Heo3ce63372012-07-17 12:39:27 -07003617 start_worker(worker);
Tejun Heod565ed62013-01-24 11:01:33 -08003618 spin_unlock_irq(&pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003619 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003620 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003621
Tejun Heo65758202012-07-17 12:39:26 -07003622 case CPU_DOWN_FAILED:
3623 case CPU_ONLINE:
Tejun Heo38db41d2013-01-24 11:01:34 -08003624 for_each_std_worker_pool(pool, cpu) {
Tejun Heo94cf58b2013-01-24 11:01:33 -08003625 mutex_lock(&pool->assoc_mutex);
3626 spin_lock_irq(&pool->lock);
3627
Tejun Heo24647572013-01-24 11:01:33 -08003628 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heo94cf58b2013-01-24 11:01:33 -08003629 rebind_workers(pool);
3630
3631 spin_unlock_irq(&pool->lock);
3632 mutex_unlock(&pool->assoc_mutex);
3633 }
Tejun Heo8db25e72012-07-17 12:39:28 -07003634 break;
Tejun Heo65758202012-07-17 12:39:26 -07003635 }
3636 return NOTIFY_OK;
3637}
3638
3639/*
3640 * Workqueues should be brought down after normal priority CPU notifiers.
3641 * This will be registered as low priority CPU notifier.
3642 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003643static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07003644 unsigned long action,
3645 void *hcpu)
3646{
Tejun Heod84ff052013-03-12 11:29:59 -07003647 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07003648 struct work_struct unbind_work;
3649
Tejun Heo65758202012-07-17 12:39:26 -07003650 switch (action & ~CPU_TASKS_FROZEN) {
3651 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003652 /* unbinding should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08003653 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09003654 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07003655 flush_work(&unbind_work);
3656 break;
Tejun Heo65758202012-07-17 12:39:26 -07003657 }
3658 return NOTIFY_OK;
3659}
3660
Rusty Russell2d3854a2008-11-05 13:39:10 +11003661#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003662
Rusty Russell2d3854a2008-11-05 13:39:10 +11003663struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07003664 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003665 long (*fn)(void *);
3666 void *arg;
3667 long ret;
3668};
3669
Tejun Heoed48ece2012-09-18 12:48:43 -07003670static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003671{
Tejun Heoed48ece2012-09-18 12:48:43 -07003672 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3673
Rusty Russell2d3854a2008-11-05 13:39:10 +11003674 wfc->ret = wfc->fn(wfc->arg);
3675}
3676
3677/**
3678 * work_on_cpu - run a function in user context on a particular cpu
3679 * @cpu: the cpu to run on
3680 * @fn: the function to run
3681 * @arg: the function arg
3682 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003683 * This will return the value @fn returns.
3684 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06003685 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003686 */
Tejun Heod84ff052013-03-12 11:29:59 -07003687long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003688{
Tejun Heoed48ece2012-09-18 12:48:43 -07003689 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003690
Tejun Heoed48ece2012-09-18 12:48:43 -07003691 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3692 schedule_work_on(cpu, &wfc.work);
3693 flush_work(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003694 return wfc.ret;
3695}
3696EXPORT_SYMBOL_GPL(work_on_cpu);
3697#endif /* CONFIG_SMP */
3698
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003699#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303700
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003701/**
3702 * freeze_workqueues_begin - begin freezing workqueues
3703 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003704 * Start freezing workqueues. After this function returns, all freezable
3705 * workqueues will queue new works to their frozen_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08003706 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003707 *
3708 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08003709 * Grabs and releases workqueue_lock and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003710 */
3711void freeze_workqueues_begin(void)
3712{
Tejun Heo17116962013-03-12 11:29:58 -07003713 struct worker_pool *pool;
Tejun Heo24b8a842013-03-12 11:29:58 -07003714 struct workqueue_struct *wq;
3715 struct pool_workqueue *pwq;
Tejun Heo17116962013-03-12 11:29:58 -07003716 int id;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003717
Tejun Heoe98d5b12013-03-12 11:29:57 -07003718 spin_lock_irq(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003719
Tejun Heo6183c002013-03-12 11:29:57 -07003720 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003721 workqueue_freezing = true;
3722
Tejun Heo24b8a842013-03-12 11:29:58 -07003723 /* set FREEZING */
Tejun Heo17116962013-03-12 11:29:58 -07003724 for_each_pool(pool, id) {
Tejun Heo17116962013-03-12 11:29:58 -07003725 spin_lock(&pool->lock);
Tejun Heo17116962013-03-12 11:29:58 -07003726 WARN_ON_ONCE(pool->flags & POOL_FREEZING);
3727 pool->flags |= POOL_FREEZING;
Tejun Heo17116962013-03-12 11:29:58 -07003728 spin_unlock(&pool->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003729 }
3730
Tejun Heo24b8a842013-03-12 11:29:58 -07003731 /* suppress further executions by setting max_active to zero */
3732 list_for_each_entry(wq, &workqueues, list) {
3733 if (!(wq->flags & WQ_FREEZABLE))
3734 continue;
3735
3736 for_each_pwq(pwq, wq) {
3737 spin_lock(&pwq->pool->lock);
3738 pwq->max_active = 0;
3739 spin_unlock(&pwq->pool->lock);
3740 }
3741 }
3742
Tejun Heoe98d5b12013-03-12 11:29:57 -07003743 spin_unlock_irq(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003744}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003745
3746/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003747 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003748 *
3749 * Check whether freezing is complete. This function must be called
3750 * between freeze_workqueues_begin() and thaw_workqueues().
3751 *
3752 * CONTEXT:
3753 * Grabs and releases workqueue_lock.
3754 *
3755 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003756 * %true if some freezable workqueues are still busy. %false if freezing
3757 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003758 */
3759bool freeze_workqueues_busy(void)
3760{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003761 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07003762 struct workqueue_struct *wq;
3763 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003764
Tejun Heoe98d5b12013-03-12 11:29:57 -07003765 spin_lock_irq(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003766
Tejun Heo6183c002013-03-12 11:29:57 -07003767 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003768
Tejun Heo24b8a842013-03-12 11:29:58 -07003769 list_for_each_entry(wq, &workqueues, list) {
3770 if (!(wq->flags & WQ_FREEZABLE))
3771 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003772 /*
3773 * nr_active is monotonically decreasing. It's safe
3774 * to peek without lock.
3775 */
Tejun Heo24b8a842013-03-12 11:29:58 -07003776 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07003777 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08003778 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003779 busy = true;
3780 goto out_unlock;
3781 }
3782 }
3783 }
3784out_unlock:
Tejun Heoe98d5b12013-03-12 11:29:57 -07003785 spin_unlock_irq(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003786 return busy;
3787}
3788
3789/**
3790 * thaw_workqueues - thaw workqueues
3791 *
3792 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08003793 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003794 *
3795 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08003796 * Grabs and releases workqueue_lock and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003797 */
3798void thaw_workqueues(void)
3799{
Tejun Heo24b8a842013-03-12 11:29:58 -07003800 struct workqueue_struct *wq;
3801 struct pool_workqueue *pwq;
3802 struct worker_pool *pool;
3803 int id;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003804
Tejun Heoe98d5b12013-03-12 11:29:57 -07003805 spin_lock_irq(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003806
3807 if (!workqueue_freezing)
3808 goto out_unlock;
3809
Tejun Heo24b8a842013-03-12 11:29:58 -07003810 /* clear FREEZING */
3811 for_each_pool(pool, id) {
3812 spin_lock(&pool->lock);
3813 WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
3814 pool->flags &= ~POOL_FREEZING;
3815 spin_unlock(&pool->lock);
3816 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003817
Tejun Heo24b8a842013-03-12 11:29:58 -07003818 /* restore max_active and repopulate worklist */
3819 list_for_each_entry(wq, &workqueues, list) {
3820 if (!(wq->flags & WQ_FREEZABLE))
3821 continue;
Tejun Heod565ed62013-01-24 11:01:33 -08003822
Tejun Heo24b8a842013-03-12 11:29:58 -07003823 for_each_pwq(pwq, wq) {
3824 spin_lock(&pwq->pool->lock);
3825 pwq_set_max_active(pwq, wq->saved_max_active);
3826 spin_unlock(&pwq->pool->lock);
Tejun Heod565ed62013-01-24 11:01:33 -08003827 }
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003828 }
3829
Tejun Heo24b8a842013-03-12 11:29:58 -07003830 /* kick workers */
3831 for_each_pool(pool, id) {
3832 spin_lock(&pool->lock);
3833 wake_up_worker(pool);
3834 spin_unlock(&pool->lock);
3835 }
3836
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003837 workqueue_freezing = false;
3838out_unlock:
Tejun Heoe98d5b12013-03-12 11:29:57 -07003839 spin_unlock_irq(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003840}
3841#endif /* CONFIG_FREEZER */
3842
Suresh Siddha6ee05782010-07-30 14:57:37 -07003843static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003844{
Tejun Heo7a4e3442013-03-12 11:30:00 -07003845 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
3846 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02003847
Tejun Heo7c3eed52013-01-24 11:01:33 -08003848 /* make sure we have enough bits for OFFQ pool ID */
3849 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT)) <
Lai Jiangshan6be19582013-02-06 18:04:53 -08003850 WORK_CPU_END * NR_STD_WORKER_POOLS);
Tejun Heob5490072012-08-03 10:30:46 -07003851
Tejun Heoe904e6c2013-03-12 11:29:57 -07003852 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
3853
3854 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
3855
Tejun Heo65758202012-07-17 12:39:26 -07003856 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07003857 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003858
Tejun Heo706026c2013-01-24 11:01:34 -08003859 /* initialize CPU pools */
3860 for_each_wq_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07003861 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003862
Tejun Heo7a4e3442013-03-12 11:30:00 -07003863 i = 0;
Tejun Heo38db41d2013-01-24 11:01:34 -08003864 for_each_std_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07003865 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08003866 pool->cpu = cpu;
Tejun Heo9daf9e62013-01-24 11:01:33 -08003867
Tejun Heo7a4e3442013-03-12 11:30:00 -07003868 if (cpu != WORK_CPU_UNBOUND)
3869 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
3870 else
3871 cpumask_setall(pool->attrs->cpumask);
3872
3873 pool->attrs->nice = std_nice[i++];
3874
Tejun Heo9daf9e62013-01-24 11:01:33 -08003875 /* alloc pool ID */
3876 BUG_ON(worker_pool_assign_id(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07003877 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003878 }
3879
Tejun Heoe22bee72010-06-29 10:07:14 +02003880 /* create the initial worker */
Tejun Heo706026c2013-01-24 11:01:34 -08003881 for_each_online_wq_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07003882 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003883
Tejun Heo38db41d2013-01-24 11:01:34 -08003884 for_each_std_worker_pool(pool, cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07003885 struct worker *worker;
3886
Tejun Heo24647572013-01-24 11:01:33 -08003887 if (cpu != WORK_CPU_UNBOUND)
3888 pool->flags &= ~POOL_DISASSOCIATED;
3889
Tejun Heobc2ae0f2012-07-17 12:39:27 -07003890 worker = create_worker(pool);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003891 BUG_ON(!worker);
Tejun Heod565ed62013-01-24 11:01:33 -08003892 spin_lock_irq(&pool->lock);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003893 start_worker(worker);
Tejun Heod565ed62013-01-24 11:01:33 -08003894 spin_unlock_irq(&pool->lock);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003895 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003896 }
3897
Tejun Heod320c032010-06-29 10:07:14 +02003898 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003899 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02003900 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003901 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3902 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003903 system_freezable_wq = alloc_workqueue("events_freezable",
3904 WQ_FREEZABLE, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003905 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Tejun Heoae930e02012-08-20 14:51:23 -07003906 !system_unbound_wq || !system_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003907 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003908}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003909early_initcall(init_workqueues);