blob: 8942cc74d83b54bd5d2bcc2a1e5227329277f237 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Tejun Heoc54fce62010-09-10 16:51:36 +02002 * kernel/workqueue.c - generic async execution with shared worker pool
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Tejun Heoc54fce62010-09-10 16:51:36 +02004 * Copyright (C) 2002 Ingo Molnar
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Tejun Heoc54fce62010-09-10 16:51:36 +02006 * Derived from the taskqueue/keventd code by:
7 * David Woodhouse <dwmw2@infradead.org>
8 * Andrew Morton
9 * Kai Petzke <wpp@marie.physik.tu-berlin.de>
10 * Theodore Ts'o <tytso@mit.edu>
Christoph Lameter89ada672005-10-30 15:01:59 -080011 *
Christoph Lametercde53532008-07-04 09:59:22 -070012 * Made to use alloc_percpu by Christoph Lameter.
Tejun Heoc54fce62010-09-10 16:51:36 +020013 *
14 * Copyright (C) 2010 SUSE Linux Products GmbH
15 * Copyright (C) 2010 Tejun Heo <tj@kernel.org>
16 *
17 * This is the generic async execution mechanism. Work items as are
18 * executed in process context. The worker pool is shared and
19 * automatically managed. There is one worker pool for each CPU and
20 * one extra for works which are better served by workers which are
21 * not bound to any specific CPU.
22 *
23 * Please read Documentation/workqueue.txt for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 */
25
Paul Gortmaker9984de12011-05-23 14:51:41 -040026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/kernel.h>
28#include <linux/sched.h>
29#include <linux/init.h>
30#include <linux/signal.h>
31#include <linux/completion.h>
32#include <linux/workqueue.h>
33#include <linux/slab.h>
34#include <linux/cpu.h>
35#include <linux/notifier.h>
36#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060037#include <linux/hardirq.h>
Christoph Lameter46934022006-10-11 01:21:26 -070038#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080039#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080040#include <linux/kallsyms.h>
41#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070042#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020043#include <linux/idr.h>
Sasha Levin42f85702012-12-17 10:01:23 -050044#include <linux/hashtable.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020045
Tejun Heoea138442013-01-18 14:05:55 -080046#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Tejun Heoc8e55f32010-06-29 10:07:12 +020048enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070049 /*
Tejun Heo24647572013-01-24 11:01:33 -080050 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070051 *
Tejun Heo24647572013-01-24 11:01:33 -080052 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070053 * While associated (!DISASSOCIATED), all workers are bound to the
54 * CPU and none has %WORKER_UNBOUND set and concurrency management
55 * is in effect.
56 *
57 * While DISASSOCIATED, the cpu may be offline and all workers have
58 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080059 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070060 *
61 * Note that DISASSOCIATED can be flipped only while holding
Tejun Heo24647572013-01-24 11:01:33 -080062 * assoc_mutex to avoid changing binding state while
63 * create_worker() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070064 */
Tejun Heo11ebea52012-07-12 14:46:37 -070065 POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
Lai Jiangshan552a37e2012-09-10 10:03:33 -070066 POOL_MANAGING_WORKERS = 1 << 1, /* managing workers */
Tejun Heo24647572013-01-24 11:01:33 -080067 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heo35b6bb62013-01-24 11:01:33 -080068 POOL_FREEZING = 1 << 3, /* freeze in progress */
Tejun Heodb7bccf2010-06-29 10:07:12 +020069
Tejun Heoc8e55f32010-06-29 10:07:12 +020070 /* worker flags */
71 WORKER_STARTED = 1 << 0, /* started */
72 WORKER_DIE = 1 << 1, /* die die die */
73 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020074 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020075 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020076 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoe22bee72010-06-29 10:07:14 +020077
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -070078 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_UNBOUND |
Tejun Heo403c8212012-07-17 12:39:27 -070079 WORKER_CPU_INTENSIVE,
Tejun Heodb7bccf2010-06-29 10:07:12 +020080
Tejun Heoe34cdddb2013-01-24 11:01:33 -080081 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070082
Tejun Heoc8e55f32010-06-29 10:07:12 +020083 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020084
Tejun Heoe22bee72010-06-29 10:07:14 +020085 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
86 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
87
Tejun Heo3233cdb2011-02-16 18:10:19 +010088 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
89 /* call for help after 10ms
90 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020091 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
92 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020093
94 /*
95 * Rescue workers are used only on emergencies and shared by
96 * all cpus. Give -20.
97 */
98 RESCUER_NICE_LEVEL = -20,
Tejun Heo32704762012-07-13 22:16:45 -070099 HIGHPRI_NICE_LEVEL = -20,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200100};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200103 * Structure fields follow one of the following exclusion rules.
104 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200105 * I: Modifiable by initialization/destruction paths and read-only for
106 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200107 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200108 * P: Preemption protected. Disabling preemption is enough and should
109 * only be modified and accessed from the local cpu.
110 *
Tejun 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.
121 */
122
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800123/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200124
Tejun Heobd7bdd42012-07-12 14:46:37 -0700125struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800126 spinlock_t lock; /* the pool lock */
Tejun Heoec22ca52013-01-24 11:01:33 -0800127 unsigned int cpu; /* I: the associated cpu */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800128 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700129 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700130
131 struct list_head worklist; /* L: list of pending works */
132 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700133
134 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700135 int nr_idle; /* L: currently idle ones */
136
137 struct list_head idle_list; /* X: list of idle workers */
138 struct timer_list idle_timer; /* L: worker idle timeout */
139 struct timer_list mayday_timer; /* L: SOS timer for workers */
140
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800141 /* workers are chained either in busy_hash or idle_list */
142 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
143 /* L: hash of busy workers */
144
Tejun Heo24647572013-01-24 11:01:33 -0800145 struct mutex assoc_mutex; /* protect POOL_DISASSOCIATED */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700146 struct ida worker_ida; /* L: for worker IDs */
Tejun Heoe19e3972013-01-24 11:39:44 -0800147
148 /*
149 * The current concurrency level. As it's likely to be accessed
150 * from other CPUs during try_to_wake_up(), put it in a separate
151 * cacheline.
152 */
153 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200154} ____cacheline_aligned_in_smp;
155
156/*
Tejun Heo112202d2013-02-13 19:29:12 -0800157 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
158 * of work_struct->data are used for flags and the remaining high bits
159 * point to the pwq; thus, pwqs need to be aligned at two's power of the
160 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 */
Tejun Heo112202d2013-02-13 19:29:12 -0800162struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700163 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200164 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200165 int work_color; /* L: current color */
166 int flush_color; /* L: flushing color */
167 int nr_in_flight[WORK_NR_COLORS];
168 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200169 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200170 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200171 struct list_head delayed_works; /* L: delayed works */
Tejun Heo30cdf242013-03-12 11:29:57 -0700172 struct list_head pwqs_node; /* I: node on wq->pwqs */
Tejun Heoe904e6c2013-03-12 11:29:57 -0700173} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200176 * Structure used to wait for workqueue flush.
177 */
178struct wq_flusher {
179 struct list_head list; /* F: list of flushers */
180 int flush_color; /* F: flush color waiting for */
181 struct completion done; /* flush completion */
182};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
Tejun Heo73f53c42010-06-29 10:07:11 +0200184/*
Tejun Heof2e005a2010-07-20 15:59:09 +0200185 * All cpumasks are assumed to be always set on UP and thus can't be
186 * used to determine whether there's something to be done.
187 */
188#ifdef CONFIG_SMP
189typedef cpumask_var_t mayday_mask_t;
190#define mayday_test_and_set_cpu(cpu, mask) \
191 cpumask_test_and_set_cpu((cpu), (mask))
192#define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask))
193#define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask))
Tejun Heo9c375472010-08-31 11:18:34 +0200194#define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp))
Tejun Heof2e005a2010-07-20 15:59:09 +0200195#define free_mayday_mask(mask) free_cpumask_var((mask))
196#else
197typedef unsigned long mayday_mask_t;
198#define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask))
199#define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask))
200#define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask))
201#define alloc_mayday_mask(maskp, gfp) true
202#define free_mayday_mask(mask) do { } while (0)
203#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
205/*
206 * The externally visible workqueue abstraction is an array of
207 * per-CPU workqueues:
208 */
209struct workqueue_struct {
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200210 unsigned int flags; /* W: WQ_* flags */
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200211 union {
Tejun Heo112202d2013-02-13 19:29:12 -0800212 struct pool_workqueue __percpu *pcpu;
213 struct pool_workqueue *single;
Tejun Heobdbc5dd2010-07-02 10:03:51 +0200214 unsigned long v;
Tejun Heo112202d2013-02-13 19:29:12 -0800215 } pool_wq; /* I: pwq's */
Tejun Heo30cdf242013-03-12 11:29:57 -0700216 struct list_head pwqs; /* I: all pwqs of this wq */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200217 struct list_head list; /* W: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200218
219 struct mutex flush_mutex; /* protects wq flushing */
220 int work_color; /* F: current work color */
221 int flush_color; /* F: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800222 atomic_t nr_pwqs_to_flush; /* flush in progress */
Tejun Heo73f53c42010-06-29 10:07:11 +0200223 struct wq_flusher *first_flusher; /* F: first flusher */
224 struct list_head flusher_queue; /* F: flush waiters */
225 struct list_head flusher_overflow; /* F: flush overflow list */
226
Tejun Heof2e005a2010-07-20 15:59:09 +0200227 mayday_mask_t mayday_mask; /* cpus requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200228 struct worker *rescuer; /* I: rescue worker */
229
Tejun Heo9c5a2ba2011-04-05 18:01:44 +0200230 int nr_drainers; /* W: drain in progress */
Tejun Heo112202d2013-02-13 19:29:12 -0800231 int saved_max_active; /* W: saved pwq max_active */
Johannes Berg4e6045f2007-10-18 23:39:55 -0700232#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200233 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700234#endif
Tejun Heob196be82012-01-10 15:11:35 -0800235 char name[]; /* I: workqueue name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236};
237
Tejun Heoe904e6c2013-03-12 11:29:57 -0700238static struct kmem_cache *pwq_cache;
239
Tejun Heod320c032010-06-29 10:07:14 +0200240struct workqueue_struct *system_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200241EXPORT_SYMBOL_GPL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300242struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900243EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300244struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200245EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300246struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200247EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300248struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100249EXPORT_SYMBOL_GPL(system_freezable_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200250
Tejun Heo97bd2342010-10-05 10:41:14 +0200251#define CREATE_TRACE_POINTS
252#include <trace/events/workqueue.h>
253
Tejun Heo38db41d2013-01-24 11:01:34 -0800254#define for_each_std_worker_pool(pool, cpu) \
Tejun Heoa60dc392013-01-24 11:01:34 -0800255 for ((pool) = &std_worker_pools(cpu)[0]; \
256 (pool) < &std_worker_pools(cpu)[NR_STD_WORKER_POOLS]; (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700257
Sasha Levinb67bfe02013-02-27 17:06:00 -0800258#define for_each_busy_worker(worker, i, pool) \
259 hash_for_each(pool->busy_hash, i, worker, hentry)
Tejun Heodb7bccf2010-06-29 10:07:12 +0200260
Tejun Heo706026c2013-01-24 11:01:34 -0800261static inline int __next_wq_cpu(int cpu, const struct cpumask *mask,
262 unsigned int sw)
Tejun Heof3421792010-07-02 10:03:51 +0200263{
264 if (cpu < nr_cpu_ids) {
265 if (sw & 1) {
266 cpu = cpumask_next(cpu, mask);
267 if (cpu < nr_cpu_ids)
268 return cpu;
269 }
270 if (sw & 2)
271 return WORK_CPU_UNBOUND;
272 }
Lai Jiangshan6be19582013-02-06 18:04:53 -0800273 return WORK_CPU_END;
Tejun Heof3421792010-07-02 10:03:51 +0200274}
275
Tejun Heo09884952010-08-01 11:50:12 +0200276/*
277 * CPU iterators
278 *
Tejun Heo706026c2013-01-24 11:01:34 -0800279 * An extra cpu number is defined using an invalid cpu number
Tejun Heo09884952010-08-01 11:50:12 +0200280 * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any
Tejun Heo706026c2013-01-24 11:01:34 -0800281 * specific CPU. The following iterators are similar to for_each_*_cpu()
282 * iterators but also considers the unbound CPU.
Tejun Heo09884952010-08-01 11:50:12 +0200283 *
Tejun Heo706026c2013-01-24 11:01:34 -0800284 * for_each_wq_cpu() : possible CPUs + WORK_CPU_UNBOUND
285 * for_each_online_wq_cpu() : online CPUs + WORK_CPU_UNBOUND
Tejun Heo09884952010-08-01 11:50:12 +0200286 */
Tejun Heo706026c2013-01-24 11:01:34 -0800287#define for_each_wq_cpu(cpu) \
288 for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, 3); \
Lai Jiangshan6be19582013-02-06 18:04:53 -0800289 (cpu) < WORK_CPU_END; \
Tejun Heo706026c2013-01-24 11:01:34 -0800290 (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, 3))
Tejun Heof3421792010-07-02 10:03:51 +0200291
Tejun Heo706026c2013-01-24 11:01:34 -0800292#define for_each_online_wq_cpu(cpu) \
293 for ((cpu) = __next_wq_cpu(-1, cpu_online_mask, 3); \
Lai Jiangshan6be19582013-02-06 18:04:53 -0800294 (cpu) < WORK_CPU_END; \
Tejun Heo706026c2013-01-24 11:01:34 -0800295 (cpu) = __next_wq_cpu((cpu), cpu_online_mask, 3))
Tejun Heof3421792010-07-02 10:03:51 +0200296
Tejun Heo49e3cf42013-03-12 11:29:58 -0700297/**
Tejun Heo17116962013-03-12 11:29:58 -0700298 * for_each_pool - iterate through all worker_pools in the system
299 * @pool: iteration cursor
300 * @id: integer used for iteration
301 */
302#define for_each_pool(pool, id) \
303 idr_for_each_entry(&worker_pool_idr, pool, id)
304
305/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700306 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
307 * @pwq: iteration cursor
308 * @wq: the target workqueue
309 */
310#define for_each_pwq(pwq, wq) \
311 list_for_each_entry((pwq), &(wq)->pwqs, pwqs_node)
Tejun Heof3421792010-07-02 10:03:51 +0200312
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900313#ifdef CONFIG_DEBUG_OBJECTS_WORK
314
315static struct debug_obj_descr work_debug_descr;
316
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100317static void *work_debug_hint(void *addr)
318{
319 return ((struct work_struct *) addr)->func;
320}
321
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900322/*
323 * fixup_init is called when:
324 * - an active object is initialized
325 */
326static int work_fixup_init(void *addr, enum debug_obj_state state)
327{
328 struct work_struct *work = addr;
329
330 switch (state) {
331 case ODEBUG_STATE_ACTIVE:
332 cancel_work_sync(work);
333 debug_object_init(work, &work_debug_descr);
334 return 1;
335 default:
336 return 0;
337 }
338}
339
340/*
341 * fixup_activate is called when:
342 * - an active object is activated
343 * - an unknown object is activated (might be a statically initialized object)
344 */
345static int work_fixup_activate(void *addr, enum debug_obj_state state)
346{
347 struct work_struct *work = addr;
348
349 switch (state) {
350
351 case ODEBUG_STATE_NOTAVAILABLE:
352 /*
353 * This is not really a fixup. The work struct was
354 * statically initialized. We just make sure that it
355 * is tracked in the object tracker.
356 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200357 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900358 debug_object_init(work, &work_debug_descr);
359 debug_object_activate(work, &work_debug_descr);
360 return 0;
361 }
362 WARN_ON_ONCE(1);
363 return 0;
364
365 case ODEBUG_STATE_ACTIVE:
366 WARN_ON(1);
367
368 default:
369 return 0;
370 }
371}
372
373/*
374 * fixup_free is called when:
375 * - an active object is freed
376 */
377static int work_fixup_free(void *addr, enum debug_obj_state state)
378{
379 struct work_struct *work = addr;
380
381 switch (state) {
382 case ODEBUG_STATE_ACTIVE:
383 cancel_work_sync(work);
384 debug_object_free(work, &work_debug_descr);
385 return 1;
386 default:
387 return 0;
388 }
389}
390
391static struct debug_obj_descr work_debug_descr = {
392 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100393 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900394 .fixup_init = work_fixup_init,
395 .fixup_activate = work_fixup_activate,
396 .fixup_free = work_fixup_free,
397};
398
399static inline void debug_work_activate(struct work_struct *work)
400{
401 debug_object_activate(work, &work_debug_descr);
402}
403
404static inline void debug_work_deactivate(struct work_struct *work)
405{
406 debug_object_deactivate(work, &work_debug_descr);
407}
408
409void __init_work(struct work_struct *work, int onstack)
410{
411 if (onstack)
412 debug_object_init_on_stack(work, &work_debug_descr);
413 else
414 debug_object_init(work, &work_debug_descr);
415}
416EXPORT_SYMBOL_GPL(__init_work);
417
418void destroy_work_on_stack(struct work_struct *work)
419{
420 debug_object_free(work, &work_debug_descr);
421}
422EXPORT_SYMBOL_GPL(destroy_work_on_stack);
423
424#else
425static inline void debug_work_activate(struct work_struct *work) { }
426static inline void debug_work_deactivate(struct work_struct *work) { }
427#endif
428
Gautham R Shenoy95402b32008-01-25 21:08:02 +0100429/* Serializes the accesses to the list of workqueues. */
430static DEFINE_SPINLOCK(workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431static LIST_HEAD(workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200432static bool workqueue_freezing; /* W: have wqs started freezing? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
Oleg Nesterov14441962007-05-23 13:57:57 -0700434/*
Tejun Heoe19e3972013-01-24 11:39:44 -0800435 * The CPU and unbound standard worker pools. The unbound ones have
436 * POOL_DISASSOCIATED set, and their workers have WORKER_UNBOUND set.
Oleg Nesterov14441962007-05-23 13:57:57 -0700437 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800438static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
439 cpu_std_worker_pools);
Tejun Heoa60dc392013-01-24 11:01:34 -0800440static struct worker_pool unbound_std_worker_pools[NR_STD_WORKER_POOLS];
Tejun Heof3421792010-07-02 10:03:51 +0200441
Tejun Heo9daf9e62013-01-24 11:01:33 -0800442/* idr of all pools */
443static DEFINE_MUTEX(worker_pool_idr_mutex);
444static DEFINE_IDR(worker_pool_idr);
445
Tejun Heoc34056a2010-06-29 10:07:11 +0200446static int worker_thread(void *__worker);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Tejun Heoa60dc392013-01-24 11:01:34 -0800448static struct worker_pool *std_worker_pools(int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449{
Tejun Heof3421792010-07-02 10:03:51 +0200450 if (cpu != WORK_CPU_UNBOUND)
Tejun Heoa60dc392013-01-24 11:01:34 -0800451 return per_cpu(cpu_std_worker_pools, cpu);
Tejun Heof3421792010-07-02 10:03:51 +0200452 else
Tejun Heoa60dc392013-01-24 11:01:34 -0800453 return unbound_std_worker_pools;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454}
455
Tejun Heo4e8f0a62013-01-24 11:01:34 -0800456static int std_worker_pool_pri(struct worker_pool *pool)
457{
Tejun Heoa60dc392013-01-24 11:01:34 -0800458 return pool - std_worker_pools(pool->cpu);
Tejun Heo4e8f0a62013-01-24 11:01:34 -0800459}
460
Tejun Heo9daf9e62013-01-24 11:01:33 -0800461/* allocate ID and assign it to @pool */
462static int worker_pool_assign_id(struct worker_pool *pool)
463{
464 int ret;
465
466 mutex_lock(&worker_pool_idr_mutex);
467 idr_pre_get(&worker_pool_idr, GFP_KERNEL);
468 ret = idr_get_new(&worker_pool_idr, pool, &pool->id);
469 mutex_unlock(&worker_pool_idr_mutex);
470
471 return ret;
472}
473
Tejun Heo7c3eed52013-01-24 11:01:33 -0800474/*
475 * Lookup worker_pool by id. The idr currently is built during boot and
476 * never modified. Don't worry about locking for now.
477 */
478static struct worker_pool *worker_pool_by_id(int pool_id)
479{
480 return idr_find(&worker_pool_idr, pool_id);
481}
482
Tejun Heod565ed62013-01-24 11:01:33 -0800483static struct worker_pool *get_std_worker_pool(int cpu, bool highpri)
484{
Tejun Heoa60dc392013-01-24 11:01:34 -0800485 struct worker_pool *pools = std_worker_pools(cpu);
Tejun Heod565ed62013-01-24 11:01:33 -0800486
Tejun Heoa60dc392013-01-24 11:01:34 -0800487 return &pools[highpri];
Tejun Heod565ed62013-01-24 11:01:33 -0800488}
489
Tejun Heo112202d2013-02-13 19:29:12 -0800490static struct pool_workqueue *get_pwq(unsigned int cpu,
491 struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700492{
Tejun Heof3421792010-07-02 10:03:51 +0200493 if (!(wq->flags & WQ_UNBOUND)) {
Lai Jiangshane06ffa12012-03-09 18:03:20 +0800494 if (likely(cpu < nr_cpu_ids))
Tejun Heo112202d2013-02-13 19:29:12 -0800495 return per_cpu_ptr(wq->pool_wq.pcpu, cpu);
Tejun Heof3421792010-07-02 10:03:51 +0200496 } else if (likely(cpu == WORK_CPU_UNBOUND))
Tejun Heo112202d2013-02-13 19:29:12 -0800497 return wq->pool_wq.single;
Tejun Heof3421792010-07-02 10:03:51 +0200498 return NULL;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700499}
500
Tejun Heo73f53c42010-06-29 10:07:11 +0200501static unsigned int work_color_to_flags(int color)
502{
503 return color << WORK_STRUCT_COLOR_SHIFT;
504}
505
506static int get_work_color(struct work_struct *work)
507{
508 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
509 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
510}
511
512static int work_next_color(int color)
513{
514 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700515}
516
David Howells4594bf12006-12-07 11:33:26 +0000517/*
Tejun Heo112202d2013-02-13 19:29:12 -0800518 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
519 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800520 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200521 *
Tejun Heo112202d2013-02-13 19:29:12 -0800522 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
523 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700524 * work->data. These functions should only be called while the work is
525 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200526 *
Tejun Heo112202d2013-02-13 19:29:12 -0800527 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800528 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800529 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800530 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700531 *
532 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
533 * canceled. While being canceled, a work item may have its PENDING set
534 * but stay off timer and worklist for arbitrarily long and nobody should
535 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000536 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200537static inline void set_work_data(struct work_struct *work, unsigned long data,
538 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000539{
Tejun Heo6183c002013-03-12 11:29:57 -0700540 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200541 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000542}
David Howells365970a2006-11-22 14:54:49 +0000543
Tejun Heo112202d2013-02-13 19:29:12 -0800544static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200545 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200546{
Tejun Heo112202d2013-02-13 19:29:12 -0800547 set_work_data(work, (unsigned long)pwq,
548 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200549}
550
Lai Jiangshan4468a002013-02-06 18:04:53 -0800551static void set_work_pool_and_keep_pending(struct work_struct *work,
552 int pool_id)
553{
554 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
555 WORK_STRUCT_PENDING);
556}
557
Tejun Heo7c3eed52013-01-24 11:01:33 -0800558static void set_work_pool_and_clear_pending(struct work_struct *work,
559 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000560{
Tejun Heo23657bb2012-08-13 17:08:19 -0700561 /*
562 * The following wmb is paired with the implied mb in
563 * test_and_set_bit(PENDING) and ensures all updates to @work made
564 * here are visible to and precede any updates by the next PENDING
565 * owner.
566 */
567 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800568 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200569}
570
571static void clear_work_data(struct work_struct *work)
572{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800573 smp_wmb(); /* see set_work_pool_and_clear_pending() */
574 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200575}
576
Tejun Heo112202d2013-02-13 19:29:12 -0800577static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200578{
Tejun Heoe1201532010-07-22 14:14:25 +0200579 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200580
Tejun Heo112202d2013-02-13 19:29:12 -0800581 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200582 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
583 else
584 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200585}
586
Tejun Heo7c3eed52013-01-24 11:01:33 -0800587/**
588 * get_work_pool - return the worker_pool a given work was associated with
589 * @work: the work item of interest
590 *
591 * Return the worker_pool @work was last associated with. %NULL if none.
592 */
593static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200594{
Tejun Heoe1201532010-07-22 14:14:25 +0200595 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800596 struct worker_pool *pool;
597 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200598
Tejun Heo112202d2013-02-13 19:29:12 -0800599 if (data & WORK_STRUCT_PWQ)
600 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800601 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200602
Tejun Heo7c3eed52013-01-24 11:01:33 -0800603 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
604 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200605 return NULL;
606
Tejun Heo7c3eed52013-01-24 11:01:33 -0800607 pool = worker_pool_by_id(pool_id);
608 WARN_ON_ONCE(!pool);
609 return pool;
610}
611
612/**
613 * get_work_pool_id - return the worker pool ID a given work is associated with
614 * @work: the work item of interest
615 *
616 * Return the worker_pool ID @work was last associated with.
617 * %WORK_OFFQ_POOL_NONE if none.
618 */
619static int get_work_pool_id(struct work_struct *work)
620{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800621 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800622
Tejun Heo112202d2013-02-13 19:29:12 -0800623 if (data & WORK_STRUCT_PWQ)
624 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800625 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
626
627 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800628}
629
Tejun Heobbb68df2012-08-03 10:30:46 -0700630static void mark_work_canceling(struct work_struct *work)
631{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800632 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700633
Tejun Heo7c3eed52013-01-24 11:01:33 -0800634 pool_id <<= WORK_OFFQ_POOL_SHIFT;
635 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700636}
637
638static bool work_is_canceling(struct work_struct *work)
639{
640 unsigned long data = atomic_long_read(&work->data);
641
Tejun Heo112202d2013-02-13 19:29:12 -0800642 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700643}
644
David Howells365970a2006-11-22 14:54:49 +0000645/*
Tejun Heo32704762012-07-13 22:16:45 -0700646 * Policy functions. These define the policies on how the global worker
647 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800648 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000649 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200650
Tejun Heo63d95a92012-07-12 14:46:37 -0700651static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000652{
Tejun Heoe19e3972013-01-24 11:39:44 -0800653 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000654}
655
Tejun Heoe22bee72010-06-29 10:07:14 +0200656/*
657 * Need to wake up a worker? Called from anything but currently
658 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700659 *
660 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800661 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700662 * worklist isn't empty.
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 Heo63d95a92012-07-12 14:46:37 -0700666 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000667}
668
Tejun Heoe22bee72010-06-29 10:07:14 +0200669/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700670static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200671{
Tejun Heo63d95a92012-07-12 14:46:37 -0700672 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200673}
674
675/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700676static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200677{
Tejun Heoe19e3972013-01-24 11:39:44 -0800678 return !list_empty(&pool->worklist) &&
679 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200680}
681
682/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700683static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200684{
Tejun Heo63d95a92012-07-12 14:46:37 -0700685 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200686}
687
688/* Do I need to be the manager? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700689static bool need_to_manage_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200690{
Tejun Heo63d95a92012-07-12 14:46:37 -0700691 return need_to_create_worker(pool) ||
Tejun Heo11ebea52012-07-12 14:46:37 -0700692 (pool->flags & POOL_MANAGE_WORKERS);
Tejun Heoe22bee72010-06-29 10:07:14 +0200693}
694
695/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700696static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200697{
Lai Jiangshan552a37e2012-09-10 10:03:33 -0700698 bool managing = pool->flags & POOL_MANAGING_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -0700699 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
700 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200701
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700702 /*
703 * nr_idle and idle_list may disagree if idle rebinding is in
704 * progress. Never return %true if idle_list is empty.
705 */
706 if (list_empty(&pool->idle_list))
707 return false;
708
Tejun Heoe22bee72010-06-29 10:07:14 +0200709 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
710}
711
712/*
713 * Wake up functions.
714 */
715
Tejun Heo7e116292010-06-29 10:07:13 +0200716/* Return the first worker. Safe with preemption disabled */
Tejun Heo63d95a92012-07-12 14:46:37 -0700717static struct worker *first_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200718{
Tejun Heo63d95a92012-07-12 14:46:37 -0700719 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200720 return NULL;
721
Tejun Heo63d95a92012-07-12 14:46:37 -0700722 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200723}
724
725/**
726 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700727 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200728 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700729 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200730 *
731 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800732 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200733 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700734static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200735{
Tejun Heo63d95a92012-07-12 14:46:37 -0700736 struct worker *worker = first_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200737
738 if (likely(worker))
739 wake_up_process(worker->task);
740}
741
Tejun Heo4690c4a2010-06-29 10:07:10 +0200742/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200743 * wq_worker_waking_up - a worker is waking up
744 * @task: task waking up
745 * @cpu: CPU @task is waking up to
746 *
747 * This function is called during try_to_wake_up() when a worker is
748 * being awoken.
749 *
750 * CONTEXT:
751 * spin_lock_irq(rq->lock)
752 */
753void wq_worker_waking_up(struct task_struct *task, unsigned int cpu)
754{
755 struct worker *worker = kthread_data(task);
756
Joonsoo Kim36576002012-10-26 23:03:49 +0900757 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800758 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800759 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900760 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200761}
762
763/**
764 * wq_worker_sleeping - a worker is going to sleep
765 * @task: task going to sleep
766 * @cpu: CPU in question, must be the current CPU number
767 *
768 * This function is called during schedule() when a busy worker is
769 * going to sleep. Worker on the same cpu can be woken up by
770 * returning pointer to its task.
771 *
772 * CONTEXT:
773 * spin_lock_irq(rq->lock)
774 *
775 * RETURNS:
776 * Worker task on @cpu to wake up, %NULL if none.
777 */
778struct task_struct *wq_worker_sleeping(struct task_struct *task,
779 unsigned int cpu)
780{
781 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800782 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200783
Tejun Heo111c2252013-01-17 17:16:24 -0800784 /*
785 * Rescuers, which may not have all the fields set up like normal
786 * workers, also reach here, let's not access anything before
787 * checking NOT_RUNNING.
788 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500789 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200790 return NULL;
791
Tejun Heo111c2252013-01-17 17:16:24 -0800792 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800793
Tejun Heoe22bee72010-06-29 10:07:14 +0200794 /* this can only happen on the local cpu */
Tejun Heo6183c002013-03-12 11:29:57 -0700795 if (WARN_ON_ONCE(cpu != raw_smp_processor_id()))
796 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200797
798 /*
799 * The counterpart of the following dec_and_test, implied mb,
800 * worklist not empty test sequence is in insert_work().
801 * Please read comment there.
802 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700803 * NOT_RUNNING is clear. This means that we're bound to and
804 * running on the local cpu w/ rq lock held and preemption
805 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800806 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700807 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200808 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800809 if (atomic_dec_and_test(&pool->nr_running) &&
810 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700811 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200812 return to_wakeup ? to_wakeup->task : NULL;
813}
814
815/**
816 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200817 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200818 * @flags: flags to set
819 * @wakeup: wakeup an idle worker if necessary
820 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200821 * Set @flags in @worker->flags and adjust nr_running accordingly. If
822 * nr_running becomes zero and @wakeup is %true, an idle worker is
823 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200824 *
Tejun Heocb444762010-07-02 10:03:50 +0200825 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800826 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200827 */
828static inline void worker_set_flags(struct worker *worker, unsigned int flags,
829 bool wakeup)
830{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700831 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200832
Tejun Heocb444762010-07-02 10:03:50 +0200833 WARN_ON_ONCE(worker->task != current);
834
Tejun Heoe22bee72010-06-29 10:07:14 +0200835 /*
836 * If transitioning into NOT_RUNNING, adjust nr_running and
837 * wake up an idle worker as necessary if requested by
838 * @wakeup.
839 */
840 if ((flags & WORKER_NOT_RUNNING) &&
841 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoe22bee72010-06-29 10:07:14 +0200842 if (wakeup) {
Tejun Heoe19e3972013-01-24 11:39:44 -0800843 if (atomic_dec_and_test(&pool->nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700844 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700845 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200846 } else
Tejun Heoe19e3972013-01-24 11:39:44 -0800847 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200848 }
849
Tejun Heod302f012010-06-29 10:07:13 +0200850 worker->flags |= flags;
851}
852
853/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200854 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200855 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200856 * @flags: flags to clear
857 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200858 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200859 *
Tejun Heocb444762010-07-02 10:03:50 +0200860 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800861 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200862 */
863static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
864{
Tejun Heo63d95a92012-07-12 14:46:37 -0700865 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200866 unsigned int oflags = worker->flags;
867
Tejun Heocb444762010-07-02 10:03:50 +0200868 WARN_ON_ONCE(worker->task != current);
869
Tejun Heod302f012010-06-29 10:07:13 +0200870 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200871
Tejun Heo42c025f2011-01-11 15:58:49 +0100872 /*
873 * If transitioning out of NOT_RUNNING, increment nr_running. Note
874 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
875 * of multiple flags, not a single flag.
876 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200877 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
878 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800879 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200880}
881
882/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200883 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800884 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200885 * @work: work to find worker for
886 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800887 * Find a worker which is executing @work on @pool by searching
888 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800889 * to match, its current execution should match the address of @work and
890 * its work function. This is to avoid unwanted dependency between
891 * unrelated work executions through a work item being recycled while still
892 * being executed.
893 *
894 * This is a bit tricky. A work item may be freed once its execution
895 * starts and nothing prevents the freed area from being recycled for
896 * another work item. If the same work item address ends up being reused
897 * before the original execution finishes, workqueue will identify the
898 * recycled work item as currently executing and make it wait until the
899 * current execution finishes, introducing an unwanted dependency.
900 *
901 * This function checks the work item address, work function and workqueue
902 * to avoid false positives. Note that this isn't complete as one may
903 * construct a work function which can introduce dependency onto itself
904 * through a recycled work item. Well, if somebody wants to shoot oneself
905 * in the foot that badly, there's only so much we can do, and if such
906 * deadlock actually occurs, it should be easy to locate the culprit work
907 * function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200908 *
909 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800910 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200911 *
912 * RETURNS:
913 * Pointer to worker which is executing @work if found, NULL
914 * otherwise.
915 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800916static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200917 struct work_struct *work)
918{
Sasha Levin42f85702012-12-17 10:01:23 -0500919 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -0500920
Sasha Levinb67bfe02013-02-27 17:06:00 -0800921 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800922 (unsigned long)work)
923 if (worker->current_work == work &&
924 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500925 return worker;
926
927 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200928}
929
930/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700931 * move_linked_works - move linked works to a list
932 * @work: start of series of works to be scheduled
933 * @head: target list to append @work to
934 * @nextp: out paramter for nested worklist walking
935 *
936 * Schedule linked works starting from @work to @head. Work series to
937 * be scheduled starts at @work and includes any consecutive work with
938 * WORK_STRUCT_LINKED set in its predecessor.
939 *
940 * If @nextp is not NULL, it's updated to point to the next work of
941 * the last scheduled work. This allows move_linked_works() to be
942 * nested inside outer list_for_each_entry_safe().
943 *
944 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800945 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -0700946 */
947static void move_linked_works(struct work_struct *work, struct list_head *head,
948 struct work_struct **nextp)
949{
950 struct work_struct *n;
951
952 /*
953 * Linked worklist will always end before the end of the list,
954 * use NULL for list head.
955 */
956 list_for_each_entry_safe_from(work, n, NULL, entry) {
957 list_move_tail(&work->entry, head);
958 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
959 break;
960 }
961
962 /*
963 * If we're already inside safe list traversal and have moved
964 * multiple works to the scheduled queue, the next position
965 * needs to be updated.
966 */
967 if (nextp)
968 *nextp = n;
969}
970
Tejun Heo112202d2013-02-13 19:29:12 -0800971static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -0700972{
Tejun Heo112202d2013-02-13 19:29:12 -0800973 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -0700974
975 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -0800976 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -0700977 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -0800978 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -0700979}
980
Tejun Heo112202d2013-02-13 19:29:12 -0800981static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700982{
Tejun Heo112202d2013-02-13 19:29:12 -0800983 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700984 struct work_struct, entry);
985
Tejun Heo112202d2013-02-13 19:29:12 -0800986 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -0700987}
988
Tejun Heobf4ede02012-08-03 10:30:46 -0700989/**
Tejun Heo112202d2013-02-13 19:29:12 -0800990 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
991 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -0700992 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -0700993 *
994 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -0800995 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -0700996 *
997 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800998 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -0700999 */
Tejun Heo112202d2013-02-13 19:29:12 -08001000static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001001{
1002 /* ignore uncolored works */
1003 if (color == WORK_NO_COLOR)
1004 return;
1005
Tejun Heo112202d2013-02-13 19:29:12 -08001006 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001007
Tejun Heo112202d2013-02-13 19:29:12 -08001008 pwq->nr_active--;
1009 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001010 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001011 if (pwq->nr_active < pwq->max_active)
1012 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001013 }
1014
1015 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001016 if (likely(pwq->flush_color != color))
Tejun Heobf4ede02012-08-03 10:30:46 -07001017 return;
1018
1019 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001020 if (pwq->nr_in_flight[color])
Tejun Heobf4ede02012-08-03 10:30:46 -07001021 return;
1022
Tejun Heo112202d2013-02-13 19:29:12 -08001023 /* this pwq is done, clear flush_color */
1024 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001025
1026 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001027 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001028 * will handle the rest.
1029 */
Tejun Heo112202d2013-02-13 19:29:12 -08001030 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1031 complete(&pwq->wq->first_flusher->done);
Tejun Heobf4ede02012-08-03 10:30:46 -07001032}
1033
Tejun Heo36e227d2012-08-03 10:30:46 -07001034/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001035 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001036 * @work: work item to steal
1037 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001038 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001039 *
1040 * Try to grab PENDING bit of @work. This function can handle @work in any
1041 * stable state - idle, on timer or on worklist. Return values are
1042 *
1043 * 1 if @work was pending and we successfully stole PENDING
1044 * 0 if @work was idle and we claimed PENDING
1045 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001046 * -ENOENT if someone else is canceling @work, this state may persist
1047 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001048 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001049 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001050 * interrupted while holding PENDING and @work off queue, irq must be
1051 * disabled on entry. This, combined with delayed_work->timer being
1052 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001053 *
1054 * On successful return, >= 0, irq is disabled and the caller is
1055 * responsible for releasing it using local_irq_restore(*@flags).
1056 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001057 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001058 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001059static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1060 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001061{
Tejun Heod565ed62013-01-24 11:01:33 -08001062 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001063 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001064
Tejun Heobbb68df2012-08-03 10:30:46 -07001065 local_irq_save(*flags);
1066
Tejun Heo36e227d2012-08-03 10:30:46 -07001067 /* try to steal the timer if it exists */
1068 if (is_dwork) {
1069 struct delayed_work *dwork = to_delayed_work(work);
1070
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001071 /*
1072 * dwork->timer is irqsafe. If del_timer() fails, it's
1073 * guaranteed that the timer is not queued anywhere and not
1074 * running on the local CPU.
1075 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001076 if (likely(del_timer(&dwork->timer)))
1077 return 1;
1078 }
1079
1080 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001081 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1082 return 0;
1083
1084 /*
1085 * The queueing is in progress, or it is already queued. Try to
1086 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1087 */
Tejun Heod565ed62013-01-24 11:01:33 -08001088 pool = get_work_pool(work);
1089 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001090 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001091
Tejun Heod565ed62013-01-24 11:01:33 -08001092 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001093 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001094 * work->data is guaranteed to point to pwq only while the work
1095 * item is queued on pwq->wq, and both updating work->data to point
1096 * to pwq on queueing and to pool on dequeueing are done under
1097 * pwq->pool->lock. This in turn guarantees that, if work->data
1098 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001099 * item is currently queued on that pool.
1100 */
Tejun Heo112202d2013-02-13 19:29:12 -08001101 pwq = get_work_pwq(work);
1102 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001103 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001104
Tejun Heo16062832013-02-06 18:04:53 -08001105 /*
1106 * A delayed work item cannot be grabbed directly because
1107 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001108 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001109 * management later on and cause stall. Make sure the work
1110 * item is activated before grabbing.
1111 */
1112 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001113 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001114
Tejun Heo16062832013-02-06 18:04:53 -08001115 list_del_init(&work->entry);
Tejun Heo112202d2013-02-13 19:29:12 -08001116 pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001117
Tejun Heo112202d2013-02-13 19:29:12 -08001118 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001119 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001120
Tejun Heo16062832013-02-06 18:04:53 -08001121 spin_unlock(&pool->lock);
1122 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001123 }
Tejun Heod565ed62013-01-24 11:01:33 -08001124 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001125fail:
1126 local_irq_restore(*flags);
1127 if (work_is_canceling(work))
1128 return -ENOENT;
1129 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001130 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001131}
1132
1133/**
Tejun Heo706026c2013-01-24 11:01:34 -08001134 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001135 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001136 * @work: work to insert
1137 * @head: insertion point
1138 * @extra_flags: extra WORK_STRUCT_* flags to set
1139 *
Tejun Heo112202d2013-02-13 19:29:12 -08001140 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001141 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001142 *
1143 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001144 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001145 */
Tejun Heo112202d2013-02-13 19:29:12 -08001146static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1147 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001148{
Tejun Heo112202d2013-02-13 19:29:12 -08001149 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001150
Tejun Heo4690c4a2010-06-29 10:07:10 +02001151 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001152 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001153 list_add_tail(&work->entry, head);
Tejun Heoe22bee72010-06-29 10:07:14 +02001154
1155 /*
1156 * Ensure either worker_sched_deactivated() sees the above
1157 * list_add_tail() or we see zero nr_running to avoid workers
1158 * lying around lazily while there are works to be processed.
1159 */
1160 smp_mb();
1161
Tejun Heo63d95a92012-07-12 14:46:37 -07001162 if (__need_more_worker(pool))
1163 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001164}
1165
Tejun Heoc8efcc22010-12-20 19:32:04 +01001166/*
1167 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001168 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001169 */
1170static bool is_chained_work(struct workqueue_struct *wq)
1171{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001172 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001173
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001174 worker = current_wq_worker();
1175 /*
1176 * Return %true iff I'm a worker execuing a work item on @wq. If
1177 * I'm @worker, it's safe to dereference it without locking.
1178 */
Tejun Heo112202d2013-02-13 19:29:12 -08001179 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001180}
1181
Tejun Heo4690c4a2010-06-29 10:07:10 +02001182static void __queue_work(unsigned int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 struct work_struct *work)
1184{
Tejun Heo112202d2013-02-13 19:29:12 -08001185 struct pool_workqueue *pwq;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001186 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001187 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001188 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001189
1190 /*
1191 * While a work item is PENDING && off queue, a task trying to
1192 * steal the PENDING will busy-loop waiting for it to either get
1193 * queued or lose PENDING. Grabbing PENDING and queueing should
1194 * happen with IRQ disabled.
1195 */
1196 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001198 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001199
Tejun Heoc8efcc22010-12-20 19:32:04 +01001200 /* if dying, only works from the same workqueue are allowed */
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02001201 if (unlikely(wq->flags & WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001202 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001203 return;
1204
Tejun Heo112202d2013-02-13 19:29:12 -08001205 /* determine the pwq to use */
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001206 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001207 struct worker_pool *last_pool;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001208
Tejun Heo57469822012-08-03 10:30:45 -07001209 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001210 cpu = raw_smp_processor_id();
1211
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001212 /*
Tejun Heodbf25762012-08-20 14:51:23 -07001213 * It's multi cpu. If @work was previously on a different
1214 * cpu, it might still be running there, in which case the
1215 * work needs to be queued on that cpu to guarantee
1216 * non-reentrancy.
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001217 */
Tejun Heo112202d2013-02-13 19:29:12 -08001218 pwq = get_pwq(cpu, wq);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001219 last_pool = get_work_pool(work);
Tejun Heodbf25762012-08-20 14:51:23 -07001220
Tejun Heo112202d2013-02-13 19:29:12 -08001221 if (last_pool && last_pool != pwq->pool) {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001222 struct worker *worker;
1223
Tejun Heod565ed62013-01-24 11:01:33 -08001224 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001225
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001226 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001227
Tejun Heo112202d2013-02-13 19:29:12 -08001228 if (worker && worker->current_pwq->wq == wq) {
1229 pwq = get_pwq(last_pool->cpu, wq);
Lai Jiangshan8594fad2013-02-07 13:14:20 -08001230 } else {
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001231 /* meh... not running there, queue here */
Tejun Heod565ed62013-01-24 11:01:33 -08001232 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001233 spin_lock(&pwq->pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001234 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001235 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001236 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001237 }
Tejun Heof3421792010-07-02 10:03:51 +02001238 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001239 pwq = get_pwq(WORK_CPU_UNBOUND, wq);
1240 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001241 }
1242
Tejun Heo112202d2013-02-13 19:29:12 -08001243 /* pwq determined, queue */
1244 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001245
Dan Carpenterf5b25522012-04-13 22:06:58 +03001246 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001247 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001248 return;
1249 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001250
Tejun Heo112202d2013-02-13 19:29:12 -08001251 pwq->nr_in_flight[pwq->work_color]++;
1252 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001253
Tejun Heo112202d2013-02-13 19:29:12 -08001254 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001255 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001256 pwq->nr_active++;
1257 worklist = &pwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001258 } else {
1259 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001260 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001261 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001262
Tejun Heo112202d2013-02-13 19:29:12 -08001263 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001264
Tejun Heo112202d2013-02-13 19:29:12 -08001265 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266}
1267
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001268/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001269 * queue_work_on - queue work on specific cpu
1270 * @cpu: CPU number to execute work on
1271 * @wq: workqueue to use
1272 * @work: work to queue
1273 *
Tejun Heod4283e92012-08-03 10:30:44 -07001274 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001275 *
1276 * We queue the work to a specific CPU, the caller must ensure it
1277 * can't go away.
1278 */
Tejun Heod4283e92012-08-03 10:30:44 -07001279bool queue_work_on(int cpu, struct workqueue_struct *wq,
1280 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001281{
Tejun Heod4283e92012-08-03 10:30:44 -07001282 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001283 unsigned long flags;
1284
1285 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001286
Tejun Heo22df02b2010-06-29 10:07:10 +02001287 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001288 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001289 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001290 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001291
1292 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001293 return ret;
1294}
1295EXPORT_SYMBOL_GPL(queue_work_on);
1296
Tejun Heo0a13c002012-08-03 10:30:44 -07001297/**
1298 * queue_work - queue work on a workqueue
1299 * @wq: workqueue to use
1300 * @work: work to queue
1301 *
Tejun Heod4283e92012-08-03 10:30:44 -07001302 * Returns %false if @work was already on a queue, %true otherwise.
Tejun Heo0a13c002012-08-03 10:30:44 -07001303 *
1304 * We queue the work to the CPU on which it was submitted, but if the CPU dies
1305 * it can be processed by another CPU.
1306 */
Tejun Heod4283e92012-08-03 10:30:44 -07001307bool queue_work(struct workqueue_struct *wq, struct work_struct *work)
Tejun Heo0a13c002012-08-03 10:30:44 -07001308{
Tejun Heo57469822012-08-03 10:30:45 -07001309 return queue_work_on(WORK_CPU_UNBOUND, wq, work);
Tejun Heo0a13c002012-08-03 10:30:44 -07001310}
1311EXPORT_SYMBOL_GPL(queue_work);
1312
Tejun Heod8e794d2012-08-03 10:30:45 -07001313void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314{
David Howells52bad642006-11-22 14:54:01 +00001315 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001317 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001318 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001320EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001322static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1323 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001325 struct timer_list *timer = &dwork->timer;
1326 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001328 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1329 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001330 WARN_ON_ONCE(timer_pending(timer));
1331 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001332
Tejun Heo8852aac2012-12-01 16:23:42 -08001333 /*
1334 * If @delay is 0, queue @dwork->work immediately. This is for
1335 * both optimization and correctness. The earliest @timer can
1336 * expire is on the closest next tick and delayed_work users depend
1337 * on that there's no such delay when @delay is 0.
1338 */
1339 if (!delay) {
1340 __queue_work(cpu, wq, &dwork->work);
1341 return;
1342 }
1343
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001344 timer_stats_timer_set_start_info(&dwork->timer);
1345
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001346 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001347 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001348 timer->expires = jiffies + delay;
1349
1350 if (unlikely(cpu != WORK_CPU_UNBOUND))
1351 add_timer_on(timer, cpu);
1352 else
1353 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354}
1355
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001356/**
1357 * queue_delayed_work_on - queue work on specific CPU after delay
1358 * @cpu: CPU number to execute work on
1359 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001360 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001361 * @delay: number of jiffies to wait before queueing
1362 *
Tejun Heo715f1302012-08-03 10:30:46 -07001363 * Returns %false if @work was already on a queue, %true otherwise. If
1364 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1365 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001366 */
Tejun Heod4283e92012-08-03 10:30:44 -07001367bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1368 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001369{
David Howells52bad642006-11-22 14:54:01 +00001370 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001371 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001372 unsigned long flags;
1373
1374 /* read the comment in __queue_work() */
1375 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001376
Tejun Heo22df02b2010-06-29 10:07:10 +02001377 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001378 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001379 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001380 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001381
1382 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001383 return ret;
1384}
Dave Jonesae90dd52006-06-30 01:40:45 -04001385EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386
Tejun Heoc8e55f32010-06-29 10:07:12 +02001387/**
Tejun Heo0a13c002012-08-03 10:30:44 -07001388 * queue_delayed_work - queue work on a workqueue after delay
1389 * @wq: workqueue to use
1390 * @dwork: delayable work to queue
1391 * @delay: number of jiffies to wait before queueing
1392 *
Tejun Heo715f1302012-08-03 10:30:46 -07001393 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
Tejun Heo0a13c002012-08-03 10:30:44 -07001394 */
Tejun Heod4283e92012-08-03 10:30:44 -07001395bool queue_delayed_work(struct workqueue_struct *wq,
Tejun Heo0a13c002012-08-03 10:30:44 -07001396 struct delayed_work *dwork, unsigned long delay)
1397{
Tejun Heo57469822012-08-03 10:30:45 -07001398 return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
Tejun Heo0a13c002012-08-03 10:30:44 -07001399}
1400EXPORT_SYMBOL_GPL(queue_delayed_work);
1401
1402/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001403 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1404 * @cpu: CPU number to execute work on
1405 * @wq: workqueue to use
1406 * @dwork: work to queue
1407 * @delay: number of jiffies to wait before queueing
1408 *
1409 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1410 * modify @dwork's timer so that it expires after @delay. If @delay is
1411 * zero, @work is guaranteed to be scheduled immediately regardless of its
1412 * current state.
1413 *
1414 * Returns %false if @dwork was idle and queued, %true if @dwork was
1415 * pending and its timer was modified.
1416 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001417 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001418 * See try_to_grab_pending() for details.
1419 */
1420bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1421 struct delayed_work *dwork, unsigned long delay)
1422{
1423 unsigned long flags;
1424 int ret;
1425
1426 do {
1427 ret = try_to_grab_pending(&dwork->work, true, &flags);
1428 } while (unlikely(ret == -EAGAIN));
1429
1430 if (likely(ret >= 0)) {
1431 __queue_delayed_work(cpu, wq, dwork, delay);
1432 local_irq_restore(flags);
1433 }
1434
1435 /* -ENOENT from try_to_grab_pending() becomes %true */
1436 return ret;
1437}
1438EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1439
1440/**
1441 * mod_delayed_work - modify delay of or queue a delayed work
1442 * @wq: workqueue to use
1443 * @dwork: work to queue
1444 * @delay: number of jiffies to wait before queueing
1445 *
1446 * mod_delayed_work_on() on local CPU.
1447 */
1448bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork,
1449 unsigned long delay)
1450{
1451 return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
1452}
1453EXPORT_SYMBOL_GPL(mod_delayed_work);
1454
1455/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001456 * worker_enter_idle - enter idle state
1457 * @worker: worker which is entering idle state
1458 *
1459 * @worker is entering idle state. Update stats and idle timer if
1460 * necessary.
1461 *
1462 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001463 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001464 */
1465static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001467 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468
Tejun Heo6183c002013-03-12 11:29:57 -07001469 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1470 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1471 (worker->hentry.next || worker->hentry.pprev)))
1472 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473
Tejun Heocb444762010-07-02 10:03:50 +02001474 /* can't use worker_set_flags(), also called from start_worker() */
1475 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001476 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001477 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001478
Tejun Heoc8e55f32010-06-29 10:07:12 +02001479 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001480 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001481
Tejun Heo628c78e2012-07-17 12:39:27 -07001482 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1483 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001484
Tejun Heo544ecf32012-05-14 15:04:50 -07001485 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001486 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001487 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001488 * nr_running, the warning may trigger spuriously. Check iff
1489 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001490 */
Tejun Heo24647572013-01-24 11:01:33 -08001491 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001492 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001493 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494}
1495
Tejun Heoc8e55f32010-06-29 10:07:12 +02001496/**
1497 * worker_leave_idle - leave idle state
1498 * @worker: worker which is leaving idle state
1499 *
1500 * @worker is leaving idle state. Update stats.
1501 *
1502 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001503 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001504 */
1505static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001507 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508
Tejun Heo6183c002013-03-12 11:29:57 -07001509 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1510 return;
Tejun Heod302f012010-06-29 10:07:13 +02001511 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001512 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001513 list_del_init(&worker->entry);
1514}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
Tejun Heoe22bee72010-06-29 10:07:14 +02001516/**
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001517 * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it
1518 * @pool: target worker_pool
1519 *
1520 * Bind %current to the cpu of @pool if it is associated and lock @pool.
Tejun Heoe22bee72010-06-29 10:07:14 +02001521 *
1522 * Works which are scheduled while the cpu is online must at least be
1523 * scheduled to a worker which is bound to the cpu so that if they are
1524 * flushed from cpu callbacks while cpu is going down, they are
1525 * guaranteed to execute on the cpu.
1526 *
Lai Jiangshanf5faa072013-02-19 12:17:02 -08001527 * This function is to be used by unbound workers and rescuers to bind
Tejun Heoe22bee72010-06-29 10:07:14 +02001528 * themselves to the target cpu and may race with cpu going down or
1529 * coming online. kthread_bind() can't be used because it may put the
1530 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
Tejun Heo706026c2013-01-24 11:01:34 -08001531 * verbatim as it's best effort and blocking and pool may be
Tejun Heoe22bee72010-06-29 10:07:14 +02001532 * [dis]associated in the meantime.
1533 *
Tejun Heo706026c2013-01-24 11:01:34 -08001534 * This function tries set_cpus_allowed() and locks pool and verifies the
Tejun Heo24647572013-01-24 11:01:33 -08001535 * binding against %POOL_DISASSOCIATED which is set during
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001536 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1537 * enters idle state or fetches works without dropping lock, it can
1538 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001539 *
1540 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001541 * Might sleep. Called without any lock but returns with pool->lock
Tejun Heoe22bee72010-06-29 10:07:14 +02001542 * held.
1543 *
1544 * RETURNS:
Tejun Heo706026c2013-01-24 11:01:34 -08001545 * %true if the associated pool is online (@worker is successfully
Tejun Heoe22bee72010-06-29 10:07:14 +02001546 * bound), %false if offline.
1547 */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001548static bool worker_maybe_bind_and_lock(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001549__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001550{
Tejun Heoe22bee72010-06-29 10:07:14 +02001551 while (true) {
1552 /*
1553 * The following call may fail, succeed or succeed
1554 * without actually migrating the task to the cpu if
1555 * it races with cpu hotunplug operation. Verify
Tejun Heo24647572013-01-24 11:01:33 -08001556 * against POOL_DISASSOCIATED.
Tejun Heoe22bee72010-06-29 10:07:14 +02001557 */
Tejun Heo24647572013-01-24 11:01:33 -08001558 if (!(pool->flags & POOL_DISASSOCIATED))
Lai Jiangshanf5faa072013-02-19 12:17:02 -08001559 set_cpus_allowed_ptr(current, get_cpu_mask(pool->cpu));
Oleg Nesterov85f41862007-05-09 02:34:20 -07001560
Tejun Heod565ed62013-01-24 11:01:33 -08001561 spin_lock_irq(&pool->lock);
Tejun Heo24647572013-01-24 11:01:33 -08001562 if (pool->flags & POOL_DISASSOCIATED)
Tejun Heoe22bee72010-06-29 10:07:14 +02001563 return false;
Lai Jiangshanf5faa072013-02-19 12:17:02 -08001564 if (task_cpu(current) == pool->cpu &&
Tejun Heoe22bee72010-06-29 10:07:14 +02001565 cpumask_equal(&current->cpus_allowed,
Tejun Heoec22ca52013-01-24 11:01:33 -08001566 get_cpu_mask(pool->cpu)))
Tejun Heoe22bee72010-06-29 10:07:14 +02001567 return true;
Tejun Heod565ed62013-01-24 11:01:33 -08001568 spin_unlock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001569
Tejun Heo5035b202011-04-29 18:08:37 +02001570 /*
1571 * We've raced with CPU hot[un]plug. Give it a breather
1572 * and retry migration. cond_resched() is required here;
1573 * otherwise, we might deadlock against cpu_stop trying to
1574 * bring down the CPU on non-preemptive kernel.
1575 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001576 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001577 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001578 }
1579}
1580
1581/*
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001582 * Rebind an idle @worker to its CPU. worker_thread() will test
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001583 * list_empty(@worker->entry) before leaving idle and call this function.
Tejun Heo25511a42012-07-17 12:39:27 -07001584 */
1585static void idle_worker_rebind(struct worker *worker)
1586{
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001587 /* CPU may go down again inbetween, clear UNBOUND only on success */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001588 if (worker_maybe_bind_and_lock(worker->pool))
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001589 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heo25511a42012-07-17 12:39:27 -07001590
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001591 /* rebind complete, become available again */
1592 list_add(&worker->entry, &worker->pool->idle_list);
Tejun Heod565ed62013-01-24 11:01:33 -08001593 spin_unlock_irq(&worker->pool->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07001594}
1595
1596/*
1597 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001598 * the associated cpu which is coming back online. This is scheduled by
1599 * cpu up but can race with other cpu hotplug operations and may be
1600 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001601 */
Tejun Heo25511a42012-07-17 12:39:27 -07001602static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001603{
1604 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heoe22bee72010-06-29 10:07:14 +02001605
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001606 if (worker_maybe_bind_and_lock(worker->pool))
Lai Jiangshaneab6d822012-09-18 09:59:22 -07001607 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02001608
Tejun Heod565ed62013-01-24 11:01:33 -08001609 spin_unlock_irq(&worker->pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001610}
1611
Tejun Heo25511a42012-07-17 12:39:27 -07001612/**
Tejun Heo94cf58b2013-01-24 11:01:33 -08001613 * rebind_workers - rebind all workers of a pool to the associated CPU
1614 * @pool: pool of interest
Tejun Heo25511a42012-07-17 12:39:27 -07001615 *
Tejun Heo94cf58b2013-01-24 11:01:33 -08001616 * @pool->cpu is coming online. Rebind all workers to the CPU. Rebinding
Tejun Heo25511a42012-07-17 12:39:27 -07001617 * is different for idle and busy ones.
1618 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001619 * Idle ones will be removed from the idle_list and woken up. They will
1620 * add themselves back after completing rebind. This ensures that the
1621 * idle_list doesn't contain any unbound workers when re-bound busy workers
1622 * try to perform local wake-ups for concurrency management.
Tejun Heo25511a42012-07-17 12:39:27 -07001623 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001624 * Busy workers can rebind after they finish their current work items.
1625 * Queueing the rebind work item at the head of the scheduled list is
1626 * enough. Note that nr_running will be properly bumped as busy workers
1627 * rebind.
Tejun Heo25511a42012-07-17 12:39:27 -07001628 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001629 * On return, all non-manager workers are scheduled for rebind - see
1630 * manage_workers() for the manager special case. Any idle worker
1631 * including the manager will not appear on @idle_list until rebind is
1632 * complete, making local wake-ups safe.
Tejun Heo25511a42012-07-17 12:39:27 -07001633 */
Tejun Heo94cf58b2013-01-24 11:01:33 -08001634static void rebind_workers(struct worker_pool *pool)
Tejun Heo25511a42012-07-17 12:39:27 -07001635{
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001636 struct worker *worker, *n;
Tejun Heo25511a42012-07-17 12:39:27 -07001637 int i;
1638
Tejun Heo94cf58b2013-01-24 11:01:33 -08001639 lockdep_assert_held(&pool->assoc_mutex);
1640 lockdep_assert_held(&pool->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07001641
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001642 /* dequeue and kick idle ones */
Tejun Heo94cf58b2013-01-24 11:01:33 -08001643 list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
1644 /*
1645 * idle workers should be off @pool->idle_list until rebind
1646 * is complete to avoid receiving premature local wake-ups.
1647 */
1648 list_del_init(&worker->entry);
Lai Jiangshan96e65302012-09-02 00:28:19 +08001649
Tejun Heo94cf58b2013-01-24 11:01:33 -08001650 /*
1651 * worker_thread() will see the above dequeuing and call
1652 * idle_worker_rebind().
1653 */
1654 wake_up_process(worker->task);
1655 }
Tejun Heo25511a42012-07-17 12:39:27 -07001656
Tejun Heo94cf58b2013-01-24 11:01:33 -08001657 /* rebind busy workers */
Sasha Levinb67bfe02013-02-27 17:06:00 -08001658 for_each_busy_worker(worker, i, pool) {
Tejun Heo94cf58b2013-01-24 11:01:33 -08001659 struct work_struct *rebind_work = &worker->rebind_work;
1660 struct workqueue_struct *wq;
Tejun Heo25511a42012-07-17 12:39:27 -07001661
Tejun Heo94cf58b2013-01-24 11:01:33 -08001662 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1663 work_data_bits(rebind_work)))
1664 continue;
Tejun Heo25511a42012-07-17 12:39:27 -07001665
Tejun Heo94cf58b2013-01-24 11:01:33 -08001666 debug_work_activate(rebind_work);
Tejun Heo90beca52012-09-04 23:12:33 -07001667
Tejun Heo94cf58b2013-01-24 11:01:33 -08001668 /*
1669 * wq doesn't really matter but let's keep @worker->pool
Tejun Heo112202d2013-02-13 19:29:12 -08001670 * and @pwq->pool consistent for sanity.
Tejun Heo94cf58b2013-01-24 11:01:33 -08001671 */
1672 if (std_worker_pool_pri(worker->pool))
1673 wq = system_highpri_wq;
1674 else
1675 wq = system_wq;
Tejun Heoec588152012-09-04 23:16:32 -07001676
Tejun Heo112202d2013-02-13 19:29:12 -08001677 insert_work(get_pwq(pool->cpu, wq), rebind_work,
Tejun Heo94cf58b2013-01-24 11:01:33 -08001678 worker->scheduled.next,
1679 work_color_to_flags(WORK_NO_COLOR));
Tejun Heoec588152012-09-04 23:16:32 -07001680 }
Tejun Heo25511a42012-07-17 12:39:27 -07001681}
1682
Tejun Heoc34056a2010-06-29 10:07:11 +02001683static struct worker *alloc_worker(void)
1684{
1685 struct worker *worker;
1686
1687 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001688 if (worker) {
1689 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001690 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001691 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001692 /* on creation a worker is in !idle && prep state */
1693 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001694 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001695 return worker;
1696}
1697
1698/**
1699 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001700 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001701 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001702 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001703 * can be started by calling start_worker() or destroyed using
1704 * destroy_worker().
1705 *
1706 * CONTEXT:
1707 * Might sleep. Does GFP_KERNEL allocations.
1708 *
1709 * RETURNS:
1710 * Pointer to the newly created worker.
1711 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001712static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001713{
Tejun Heoe34cdddb2013-01-24 11:01:33 -08001714 const char *pri = std_worker_pool_pri(pool) ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001715 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001716 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001717
Tejun Heod565ed62013-01-24 11:01:33 -08001718 spin_lock_irq(&pool->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001719 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heod565ed62013-01-24 11:01:33 -08001720 spin_unlock_irq(&pool->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001721 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001722 goto fail;
Tejun Heod565ed62013-01-24 11:01:33 -08001723 spin_lock_irq(&pool->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001724 }
Tejun Heod565ed62013-01-24 11:01:33 -08001725 spin_unlock_irq(&pool->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001726
1727 worker = alloc_worker();
1728 if (!worker)
1729 goto fail;
1730
Tejun Heobd7bdd42012-07-12 14:46:37 -07001731 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001732 worker->id = id;
1733
Tejun Heoec22ca52013-01-24 11:01:33 -08001734 if (pool->cpu != WORK_CPU_UNBOUND)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001735 worker->task = kthread_create_on_node(worker_thread,
Tejun Heoec22ca52013-01-24 11:01:33 -08001736 worker, cpu_to_node(pool->cpu),
1737 "kworker/%u:%d%s", pool->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001738 else
1739 worker->task = kthread_create(worker_thread, worker,
Tejun Heo32704762012-07-13 22:16:45 -07001740 "kworker/u:%d%s", id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001741 if (IS_ERR(worker->task))
1742 goto fail;
1743
Tejun Heoe34cdddb2013-01-24 11:01:33 -08001744 if (std_worker_pool_pri(pool))
Tejun Heo32704762012-07-13 22:16:45 -07001745 set_user_nice(worker->task, HIGHPRI_NICE_LEVEL);
1746
Tejun Heodb7bccf2010-06-29 10:07:12 +02001747 /*
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001748 * Determine CPU binding of the new worker depending on
Tejun Heo24647572013-01-24 11:01:33 -08001749 * %POOL_DISASSOCIATED. The caller is responsible for ensuring the
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001750 * flag remains stable across this function. See the comments
1751 * above the flag definition for details.
1752 *
1753 * As an unbound worker may later become a regular one if CPU comes
1754 * online, make sure every worker has %PF_THREAD_BOUND set.
Tejun Heodb7bccf2010-06-29 10:07:12 +02001755 */
Tejun Heo24647572013-01-24 11:01:33 -08001756 if (!(pool->flags & POOL_DISASSOCIATED)) {
Tejun Heoec22ca52013-01-24 11:01:33 -08001757 kthread_bind(worker->task, pool->cpu);
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001758 } else {
Tejun Heodb7bccf2010-06-29 10:07:12 +02001759 worker->task->flags |= PF_THREAD_BOUND;
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001760 worker->flags |= WORKER_UNBOUND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07001762
Tejun Heoc34056a2010-06-29 10:07:11 +02001763 return worker;
1764fail:
1765 if (id >= 0) {
Tejun Heod565ed62013-01-24 11:01:33 -08001766 spin_lock_irq(&pool->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001767 ida_remove(&pool->worker_ida, id);
Tejun Heod565ed62013-01-24 11:01:33 -08001768 spin_unlock_irq(&pool->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001769 }
1770 kfree(worker);
1771 return NULL;
1772}
1773
1774/**
1775 * start_worker - start a newly created worker
1776 * @worker: worker to start
1777 *
Tejun Heo706026c2013-01-24 11:01:34 -08001778 * Make the pool aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001779 *
1780 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001781 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001782 */
1783static void start_worker(struct worker *worker)
1784{
Tejun Heocb444762010-07-02 10:03:50 +02001785 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001786 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001787 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001788 wake_up_process(worker->task);
1789}
1790
1791/**
1792 * destroy_worker - destroy a workqueue worker
1793 * @worker: worker to be destroyed
1794 *
Tejun Heo706026c2013-01-24 11:01:34 -08001795 * Destroy @worker and adjust @pool stats accordingly.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001796 *
1797 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001798 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001799 */
1800static void destroy_worker(struct worker *worker)
1801{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001802 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001803 int id = worker->id;
1804
1805 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001806 if (WARN_ON(worker->current_work) ||
1807 WARN_ON(!list_empty(&worker->scheduled)))
1808 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001809
Tejun Heoc8e55f32010-06-29 10:07:12 +02001810 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001811 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001812 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001813 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001814
1815 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001816 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001817
Tejun Heod565ed62013-01-24 11:01:33 -08001818 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001819
Tejun Heoc34056a2010-06-29 10:07:11 +02001820 kthread_stop(worker->task);
1821 kfree(worker);
1822
Tejun Heod565ed62013-01-24 11:01:33 -08001823 spin_lock_irq(&pool->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001824 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001825}
1826
Tejun Heo63d95a92012-07-12 14:46:37 -07001827static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001828{
Tejun Heo63d95a92012-07-12 14:46:37 -07001829 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001830
Tejun Heod565ed62013-01-24 11:01:33 -08001831 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001832
Tejun Heo63d95a92012-07-12 14:46:37 -07001833 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001834 struct worker *worker;
1835 unsigned long expires;
1836
1837 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001838 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001839 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1840
1841 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001842 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001843 else {
1844 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001845 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001846 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001847 }
1848 }
1849
Tejun Heod565ed62013-01-24 11:01:33 -08001850 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001851}
1852
1853static bool send_mayday(struct work_struct *work)
1854{
Tejun Heo112202d2013-02-13 19:29:12 -08001855 struct pool_workqueue *pwq = get_work_pwq(work);
1856 struct workqueue_struct *wq = pwq->wq;
Tejun Heof3421792010-07-02 10:03:51 +02001857 unsigned int cpu;
Tejun Heoe22bee72010-06-29 10:07:14 +02001858
1859 if (!(wq->flags & WQ_RESCUER))
1860 return false;
1861
1862 /* mayday mayday mayday */
Tejun Heo112202d2013-02-13 19:29:12 -08001863 cpu = pwq->pool->cpu;
Tejun Heof3421792010-07-02 10:03:51 +02001864 /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */
1865 if (cpu == WORK_CPU_UNBOUND)
1866 cpu = 0;
Tejun Heof2e005a2010-07-20 15:59:09 +02001867 if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001868 wake_up_process(wq->rescuer->task);
1869 return true;
1870}
1871
Tejun Heo706026c2013-01-24 11:01:34 -08001872static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001873{
Tejun Heo63d95a92012-07-12 14:46:37 -07001874 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001875 struct work_struct *work;
1876
Tejun Heod565ed62013-01-24 11:01:33 -08001877 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001878
Tejun Heo63d95a92012-07-12 14:46:37 -07001879 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001880 /*
1881 * We've been trying to create a new worker but
1882 * haven't been successful. We might be hitting an
1883 * allocation deadlock. Send distress signals to
1884 * rescuers.
1885 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001886 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001887 send_mayday(work);
1888 }
1889
Tejun Heod565ed62013-01-24 11:01:33 -08001890 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001891
Tejun Heo63d95a92012-07-12 14:46:37 -07001892 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001893}
1894
1895/**
1896 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001897 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001898 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001899 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001900 * have at least one idle worker on return from this function. If
1901 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001902 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001903 * possible allocation deadlock.
1904 *
1905 * On return, need_to_create_worker() is guaranteed to be false and
1906 * may_start_working() true.
1907 *
1908 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001909 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001910 * multiple times. Does GFP_KERNEL allocations. Called only from
1911 * manager.
1912 *
1913 * RETURNS:
Tejun Heod565ed62013-01-24 11:01:33 -08001914 * false if no action was taken and pool->lock stayed locked, true
Tejun Heoe22bee72010-06-29 10:07:14 +02001915 * otherwise.
1916 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001917static bool maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001918__releases(&pool->lock)
1919__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001920{
Tejun Heo63d95a92012-07-12 14:46:37 -07001921 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001922 return false;
1923restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001924 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001925
Tejun Heoe22bee72010-06-29 10:07:14 +02001926 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001927 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001928
1929 while (true) {
1930 struct worker *worker;
1931
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001932 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001933 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001934 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001935 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001936 start_worker(worker);
Tejun Heo6183c002013-03-12 11:29:57 -07001937 if (WARN_ON_ONCE(need_to_create_worker(pool)))
1938 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001939 return true;
1940 }
1941
Tejun Heo63d95a92012-07-12 14:46:37 -07001942 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001943 break;
1944
Tejun Heoe22bee72010-06-29 10:07:14 +02001945 __set_current_state(TASK_INTERRUPTIBLE);
1946 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001947
Tejun Heo63d95a92012-07-12 14:46:37 -07001948 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001949 break;
1950 }
1951
Tejun Heo63d95a92012-07-12 14:46:37 -07001952 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001953 spin_lock_irq(&pool->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07001954 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001955 goto restart;
1956 return true;
1957}
1958
1959/**
1960 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07001961 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02001962 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001963 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02001964 * IDLE_WORKER_TIMEOUT.
1965 *
1966 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001967 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001968 * multiple times. Called only from manager.
1969 *
1970 * RETURNS:
Tejun Heod565ed62013-01-24 11:01:33 -08001971 * false if no action was taken and pool->lock stayed locked, true
Tejun Heoe22bee72010-06-29 10:07:14 +02001972 * otherwise.
1973 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001974static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001975{
1976 bool ret = false;
1977
Tejun Heo63d95a92012-07-12 14:46:37 -07001978 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001979 struct worker *worker;
1980 unsigned long expires;
1981
Tejun Heo63d95a92012-07-12 14:46:37 -07001982 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001983 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1984
1985 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001986 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001987 break;
1988 }
1989
1990 destroy_worker(worker);
1991 ret = true;
1992 }
1993
1994 return ret;
1995}
1996
1997/**
1998 * manage_workers - manage worker pool
1999 * @worker: self
2000 *
Tejun Heo706026c2013-01-24 11:01:34 -08002001 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002002 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002003 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002004 *
2005 * The caller can safely start processing works on false return. On
2006 * true return, it's guaranteed that need_to_create_worker() is false
2007 * and may_start_working() is true.
2008 *
2009 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002010 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002011 * multiple times. Does GFP_KERNEL allocations.
2012 *
2013 * RETURNS:
Tejun Heod565ed62013-01-24 11:01:33 -08002014 * spin_lock_irq(pool->lock) which may be released and regrabbed
2015 * multiple times. Does GFP_KERNEL allocations.
Tejun Heoe22bee72010-06-29 10:07:14 +02002016 */
2017static bool manage_workers(struct worker *worker)
2018{
Tejun Heo63d95a92012-07-12 14:46:37 -07002019 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002020 bool ret = false;
2021
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002022 if (pool->flags & POOL_MANAGING_WORKERS)
Tejun Heoe22bee72010-06-29 10:07:14 +02002023 return ret;
2024
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002025 pool->flags |= POOL_MANAGING_WORKERS;
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002026
2027 /*
2028 * To simplify both worker management and CPU hotplug, hold off
2029 * management while hotplug is in progress. CPU hotplug path can't
2030 * grab %POOL_MANAGING_WORKERS to achieve this because that can
2031 * lead to idle worker depletion (all become busy thinking someone
2032 * else is managing) which in turn can result in deadlock under
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002033 * extreme circumstances. Use @pool->assoc_mutex to synchronize
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002034 * manager against CPU hotplug.
2035 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002036 * assoc_mutex would always be free unless CPU hotplug is in
Tejun Heod565ed62013-01-24 11:01:33 -08002037 * progress. trylock first without dropping @pool->lock.
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002038 */
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002039 if (unlikely(!mutex_trylock(&pool->assoc_mutex))) {
Tejun Heod565ed62013-01-24 11:01:33 -08002040 spin_unlock_irq(&pool->lock);
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002041 mutex_lock(&pool->assoc_mutex);
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002042 /*
2043 * CPU hotplug could have happened while we were waiting
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002044 * for assoc_mutex. Hotplug itself can't handle us
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002045 * because manager isn't either on idle or busy list, and
Tejun Heo706026c2013-01-24 11:01:34 -08002046 * @pool's state and ours could have deviated.
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002047 *
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002048 * As hotplug is now excluded via assoc_mutex, we can
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002049 * simply try to bind. It will succeed or fail depending
Tejun Heo706026c2013-01-24 11:01:34 -08002050 * on @pool's current state. Try it and adjust
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002051 * %WORKER_UNBOUND accordingly.
2052 */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08002053 if (worker_maybe_bind_and_lock(pool))
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002054 worker->flags &= ~WORKER_UNBOUND;
2055 else
2056 worker->flags |= WORKER_UNBOUND;
2057
2058 ret = true;
2059 }
2060
Tejun Heo11ebea52012-07-12 14:46:37 -07002061 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002062
2063 /*
2064 * Destroy and then create so that may_start_working() is true
2065 * on return.
2066 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002067 ret |= maybe_destroy_workers(pool);
2068 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002069
Lai Jiangshan552a37e2012-09-10 10:03:33 -07002070 pool->flags &= ~POOL_MANAGING_WORKERS;
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002071 mutex_unlock(&pool->assoc_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02002072 return ret;
2073}
2074
Tejun Heoa62428c2010-06-29 10:07:10 +02002075/**
2076 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002077 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002078 * @work: work to process
2079 *
2080 * Process @work. This function contains all the logics necessary to
2081 * process a single work including synchronization against and
2082 * interaction with other workers on the same cpu, queueing and
2083 * flushing. As long as context requirement is met, any worker can
2084 * call this function to process a work.
2085 *
2086 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002087 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002088 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002089static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002090__releases(&pool->lock)
2091__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002092{
Tejun Heo112202d2013-02-13 19:29:12 -08002093 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002094 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002095 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002096 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002097 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002098#ifdef CONFIG_LOCKDEP
2099 /*
2100 * It is permissible to free the struct work_struct from
2101 * inside the function that is called from it, this we need to
2102 * take into account for lockdep too. To avoid bogus "held
2103 * lock freed" warnings as well as problems when looking into
2104 * work->lockdep_map, make a copy and use that here.
2105 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002106 struct lockdep_map lockdep_map;
2107
2108 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002109#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002110 /*
2111 * Ensure we're on the correct CPU. DISASSOCIATED test is
2112 * necessary to avoid spurious warnings from rescuers servicing the
Tejun Heo24647572013-01-24 11:01:33 -08002113 * unbound or a disassociated pool.
Tejun Heo6fec10a2012-07-22 10:16:34 -07002114 */
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002115 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
Tejun Heo24647572013-01-24 11:01:33 -08002116 !(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002117 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002118
Tejun Heo7e116292010-06-29 10:07:13 +02002119 /*
2120 * A single work shouldn't be executed concurrently by
2121 * multiple workers on a single cpu. Check whether anyone is
2122 * already processing the work. If so, defer the work to the
2123 * currently executing one.
2124 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002125 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002126 if (unlikely(collision)) {
2127 move_linked_works(work, &collision->scheduled, NULL);
2128 return;
2129 }
2130
Tejun Heo8930cab2012-08-03 10:30:45 -07002131 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002132 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002133 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002134 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002135 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002136 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002137 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002138
Tejun Heoa62428c2010-06-29 10:07:10 +02002139 list_del_init(&work->entry);
2140
Tejun Heo649027d2010-06-29 10:07:14 +02002141 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002142 * CPU intensive works don't participate in concurrency
2143 * management. They're the scheduler's responsibility.
2144 */
2145 if (unlikely(cpu_intensive))
2146 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2147
Tejun Heo974271c2012-07-12 14:46:37 -07002148 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002149 * Unbound pool isn't concurrency managed and work items should be
Tejun Heo974271c2012-07-12 14:46:37 -07002150 * executed ASAP. Wake up another worker if necessary.
2151 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002152 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2153 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002154
Tejun Heo8930cab2012-08-03 10:30:45 -07002155 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002156 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002157 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002158 * PENDING and queued state changes happen together while IRQ is
2159 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002160 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002161 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002162
Tejun Heod565ed62013-01-24 11:01:33 -08002163 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002164
Tejun Heo112202d2013-02-13 19:29:12 -08002165 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002166 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002167 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002168 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002169 /*
2170 * While we must be careful to not use "work" after this, the trace
2171 * point will only record its address.
2172 */
2173 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002174 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002175 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002176
2177 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002178 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2179 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002180 current->comm, preempt_count(), task_pid_nr(current),
2181 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002182 debug_show_held_locks(current);
2183 dump_stack();
2184 }
2185
Tejun Heod565ed62013-01-24 11:01:33 -08002186 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002187
Tejun Heofb0e7be2010-06-29 10:07:15 +02002188 /* clear cpu intensive status */
2189 if (unlikely(cpu_intensive))
2190 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2191
Tejun Heoa62428c2010-06-29 10:07:10 +02002192 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002193 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002194 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002195 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002196 worker->current_pwq = NULL;
2197 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002198}
2199
Tejun Heoaffee4b2010-06-29 10:07:12 +02002200/**
2201 * process_scheduled_works - process scheduled works
2202 * @worker: self
2203 *
2204 * Process all scheduled works. Please note that the scheduled list
2205 * may change while processing a work, so this function repeatedly
2206 * fetches a work from the top and executes it.
2207 *
2208 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002209 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002210 * multiple times.
2211 */
2212static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002214 while (!list_empty(&worker->scheduled)) {
2215 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002217 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219}
2220
Tejun Heo4690c4a2010-06-29 10:07:10 +02002221/**
2222 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002223 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002224 *
Tejun Heo706026c2013-01-24 11:01:34 -08002225 * The worker thread function. There are NR_CPU_WORKER_POOLS dynamic pools
2226 * of these per each cpu. These workers process all works regardless of
Tejun Heoe22bee72010-06-29 10:07:14 +02002227 * their specific target workqueue. The only exception is works which
2228 * belong to workqueues with a rescuer which will be explained in
2229 * rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002230 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002231static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232{
Tejun Heoc34056a2010-06-29 10:07:11 +02002233 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002234 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235
Tejun Heoe22bee72010-06-29 10:07:14 +02002236 /* tell the scheduler that this is a workqueue worker */
2237 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002238woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002239 spin_lock_irq(&pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002241 /* we are off idle list if destruction or rebind is requested */
2242 if (unlikely(list_empty(&worker->entry))) {
Tejun Heod565ed62013-01-24 11:01:33 -08002243 spin_unlock_irq(&pool->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002244
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002245 /* if DIE is set, destruction is requested */
Tejun Heo25511a42012-07-17 12:39:27 -07002246 if (worker->flags & WORKER_DIE) {
2247 worker->task->flags &= ~PF_WQ_WORKER;
2248 return 0;
2249 }
2250
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002251 /* otherwise, rebind */
Tejun Heo25511a42012-07-17 12:39:27 -07002252 idle_worker_rebind(worker);
2253 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 }
2255
Tejun Heoc8e55f32010-06-29 10:07:12 +02002256 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002257recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002258 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002259 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002260 goto sleep;
2261
2262 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002263 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002264 goto recheck;
2265
Tejun Heoc8e55f32010-06-29 10:07:12 +02002266 /*
2267 * ->scheduled list can only be filled while a worker is
2268 * preparing to process a work or actually processing it.
2269 * Make sure nobody diddled with it while I was sleeping.
2270 */
Tejun Heo6183c002013-03-12 11:29:57 -07002271 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002272
Tejun Heoe22bee72010-06-29 10:07:14 +02002273 /*
2274 * When control reaches this point, we're guaranteed to have
2275 * at least one idle worker or that someone else has already
2276 * assumed the manager role.
2277 */
2278 worker_clr_flags(worker, WORKER_PREP);
2279
2280 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002281 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002282 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002283 struct work_struct, entry);
2284
2285 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2286 /* optimization path, not strictly necessary */
2287 process_one_work(worker, work);
2288 if (unlikely(!list_empty(&worker->scheduled)))
2289 process_scheduled_works(worker);
2290 } else {
2291 move_linked_works(work, &worker->scheduled, NULL);
2292 process_scheduled_works(worker);
2293 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002294 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002295
Tejun Heoe22bee72010-06-29 10:07:14 +02002296 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002297sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002298 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002299 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002300
Tejun Heoc8e55f32010-06-29 10:07:12 +02002301 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002302 * pool->lock is held and there's no work to process and no need to
2303 * manage, sleep. Workers are woken up only while holding
2304 * pool->lock or from local cpu, so setting the current state
2305 * before releasing pool->lock is enough to prevent losing any
2306 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002307 */
2308 worker_enter_idle(worker);
2309 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002310 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002311 schedule();
2312 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313}
2314
Tejun Heoe22bee72010-06-29 10:07:14 +02002315/**
2316 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002317 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002318 *
2319 * Workqueue rescuer thread function. There's one rescuer for each
2320 * workqueue which has WQ_RESCUER set.
2321 *
Tejun Heo706026c2013-01-24 11:01:34 -08002322 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002323 * worker which uses GFP_KERNEL allocation which has slight chance of
2324 * developing into deadlock if some works currently on the same queue
2325 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2326 * the problem rescuer solves.
2327 *
Tejun Heo706026c2013-01-24 11:01:34 -08002328 * When such condition is possible, the pool summons rescuers of all
2329 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002330 * those works so that forward progress can be guaranteed.
2331 *
2332 * This should happen rarely.
2333 */
Tejun Heo111c2252013-01-17 17:16:24 -08002334static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002335{
Tejun Heo111c2252013-01-17 17:16:24 -08002336 struct worker *rescuer = __rescuer;
2337 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002338 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heof3421792010-07-02 10:03:51 +02002339 bool is_unbound = wq->flags & WQ_UNBOUND;
Tejun Heoe22bee72010-06-29 10:07:14 +02002340 unsigned int cpu;
2341
2342 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002343
2344 /*
2345 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2346 * doesn't participate in concurrency management.
2347 */
2348 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002349repeat:
2350 set_current_state(TASK_INTERRUPTIBLE);
2351
Mike Galbraith412d32e2012-11-28 07:17:18 +01002352 if (kthread_should_stop()) {
2353 __set_current_state(TASK_RUNNING);
Tejun Heo111c2252013-01-17 17:16:24 -08002354 rescuer->task->flags &= ~PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002355 return 0;
Mike Galbraith412d32e2012-11-28 07:17:18 +01002356 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002357
Tejun Heof3421792010-07-02 10:03:51 +02002358 /*
2359 * See whether any cpu is asking for help. Unbounded
2360 * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND.
2361 */
Tejun Heof2e005a2010-07-20 15:59:09 +02002362 for_each_mayday_cpu(cpu, wq->mayday_mask) {
Tejun Heof3421792010-07-02 10:03:51 +02002363 unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu;
Tejun Heo112202d2013-02-13 19:29:12 -08002364 struct pool_workqueue *pwq = get_pwq(tcpu, wq);
2365 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002366 struct work_struct *work, *n;
2367
2368 __set_current_state(TASK_RUNNING);
Tejun Heof2e005a2010-07-20 15:59:09 +02002369 mayday_clear_cpu(cpu, wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02002370
2371 /* migrate to the target cpu if possible */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08002372 worker_maybe_bind_and_lock(pool);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002373 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002374
2375 /*
2376 * Slurp in all works issued via this workqueue and
2377 * process'em.
2378 */
Tejun Heo6183c002013-03-12 11:29:57 -07002379 WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002380 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heo112202d2013-02-13 19:29:12 -08002381 if (get_work_pwq(work) == pwq)
Tejun Heoe22bee72010-06-29 10:07:14 +02002382 move_linked_works(work, scheduled, &n);
2383
2384 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002385
2386 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002387 * Leave this pool. If keep_working() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002388 * regular worker; otherwise, we end up with 0 concurrency
2389 * and stalling the execution.
2390 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002391 if (keep_working(pool))
2392 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002393
Lai Jiangshanb3104102013-02-19 12:17:02 -08002394 rescuer->pool = NULL;
Tejun Heod565ed62013-01-24 11:01:33 -08002395 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002396 }
2397
Tejun Heo111c2252013-01-17 17:16:24 -08002398 /* rescuers should never participate in concurrency management */
2399 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002400 schedule();
2401 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402}
2403
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002404struct wq_barrier {
2405 struct work_struct work;
2406 struct completion done;
2407};
2408
2409static void wq_barrier_func(struct work_struct *work)
2410{
2411 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2412 complete(&barr->done);
2413}
2414
Tejun Heo4690c4a2010-06-29 10:07:10 +02002415/**
2416 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002417 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002418 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002419 * @target: target work to attach @barr to
2420 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002421 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002422 * @barr is linked to @target such that @barr is completed only after
2423 * @target finishes execution. Please note that the ordering
2424 * guarantee is observed only with respect to @target and on the local
2425 * cpu.
2426 *
2427 * Currently, a queued barrier can't be canceled. This is because
2428 * try_to_grab_pending() can't determine whether the work to be
2429 * grabbed is at the head of the queue and thus can't clear LINKED
2430 * flag of the previous work while there must be a valid next work
2431 * after a work with LINKED flag set.
2432 *
2433 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002434 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002435 *
2436 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002437 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002438 */
Tejun Heo112202d2013-02-13 19:29:12 -08002439static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002440 struct wq_barrier *barr,
2441 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002442{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002443 struct list_head *head;
2444 unsigned int linked = 0;
2445
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002446 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002447 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002448 * as we know for sure that this will not trigger any of the
2449 * checks and call back into the fixup functions where we
2450 * might deadlock.
2451 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002452 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002453 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002454 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002455
Tejun Heoaffee4b2010-06-29 10:07:12 +02002456 /*
2457 * If @target is currently being executed, schedule the
2458 * barrier to the worker; otherwise, put it after @target.
2459 */
2460 if (worker)
2461 head = worker->scheduled.next;
2462 else {
2463 unsigned long *bits = work_data_bits(target);
2464
2465 head = target->entry.next;
2466 /* there can already be other linked works, inherit and set */
2467 linked = *bits & WORK_STRUCT_LINKED;
2468 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2469 }
2470
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002471 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002472 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002473 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002474}
2475
Tejun Heo73f53c42010-06-29 10:07:11 +02002476/**
Tejun Heo112202d2013-02-13 19:29:12 -08002477 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002478 * @wq: workqueue being flushed
2479 * @flush_color: new flush color, < 0 for no-op
2480 * @work_color: new work color, < 0 for no-op
2481 *
Tejun Heo112202d2013-02-13 19:29:12 -08002482 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002483 *
Tejun Heo112202d2013-02-13 19:29:12 -08002484 * If @flush_color is non-negative, flush_color on all pwqs should be
2485 * -1. If no pwq has in-flight commands at the specified color, all
2486 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2487 * has in flight commands, its pwq->flush_color is set to
2488 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002489 * wakeup logic is armed and %true is returned.
2490 *
2491 * The caller should have initialized @wq->first_flusher prior to
2492 * calling this function with non-negative @flush_color. If
2493 * @flush_color is negative, no flush color update is done and %false
2494 * is returned.
2495 *
Tejun Heo112202d2013-02-13 19:29:12 -08002496 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002497 * work_color which is previous to @work_color and all will be
2498 * advanced to @work_color.
2499 *
2500 * CONTEXT:
2501 * mutex_lock(wq->flush_mutex).
2502 *
2503 * RETURNS:
2504 * %true if @flush_color >= 0 and there's something to flush. %false
2505 * otherwise.
2506 */
Tejun Heo112202d2013-02-13 19:29:12 -08002507static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002508 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509{
Tejun Heo73f53c42010-06-29 10:07:11 +02002510 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002511 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002512
Tejun Heo73f53c42010-06-29 10:07:11 +02002513 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002514 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002515 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002516 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002517
Tejun Heo49e3cf42013-03-12 11:29:58 -07002518 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002519 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002520
Tejun Heod565ed62013-01-24 11:01:33 -08002521 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002522
2523 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002524 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002525
Tejun Heo112202d2013-02-13 19:29:12 -08002526 if (pwq->nr_in_flight[flush_color]) {
2527 pwq->flush_color = flush_color;
2528 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002529 wait = true;
2530 }
2531 }
2532
2533 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002534 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002535 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002536 }
2537
Tejun Heod565ed62013-01-24 11:01:33 -08002538 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002539 }
2540
Tejun Heo112202d2013-02-13 19:29:12 -08002541 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002542 complete(&wq->first_flusher->done);
2543
2544 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545}
2546
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002547/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002549 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550 *
2551 * Forces execution of the workqueue and blocks until its completion.
2552 * This is typically used in driver shutdown handlers.
2553 *
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002554 * We sleep until all works which were queued on entry have been handled,
2555 * but we are not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002557void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558{
Tejun Heo73f53c42010-06-29 10:07:11 +02002559 struct wq_flusher this_flusher = {
2560 .list = LIST_HEAD_INIT(this_flusher.list),
2561 .flush_color = -1,
2562 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2563 };
2564 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002565
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002566 lock_map_acquire(&wq->lockdep_map);
2567 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002568
2569 mutex_lock(&wq->flush_mutex);
2570
2571 /*
2572 * Start-to-wait phase
2573 */
2574 next_color = work_next_color(wq->work_color);
2575
2576 if (next_color != wq->flush_color) {
2577 /*
2578 * Color space is not full. The current work_color
2579 * becomes our flush_color and work_color is advanced
2580 * by one.
2581 */
Tejun Heo6183c002013-03-12 11:29:57 -07002582 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002583 this_flusher.flush_color = wq->work_color;
2584 wq->work_color = next_color;
2585
2586 if (!wq->first_flusher) {
2587 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002588 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002589
2590 wq->first_flusher = &this_flusher;
2591
Tejun Heo112202d2013-02-13 19:29:12 -08002592 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002593 wq->work_color)) {
2594 /* nothing to flush, done */
2595 wq->flush_color = next_color;
2596 wq->first_flusher = NULL;
2597 goto out_unlock;
2598 }
2599 } else {
2600 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002601 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002602 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002603 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002604 }
2605 } else {
2606 /*
2607 * Oops, color space is full, wait on overflow queue.
2608 * The next flush completion will assign us
2609 * flush_color and transfer to flusher_queue.
2610 */
2611 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2612 }
2613
2614 mutex_unlock(&wq->flush_mutex);
2615
2616 wait_for_completion(&this_flusher.done);
2617
2618 /*
2619 * Wake-up-and-cascade phase
2620 *
2621 * First flushers are responsible for cascading flushes and
2622 * handling overflow. Non-first flushers can simply return.
2623 */
2624 if (wq->first_flusher != &this_flusher)
2625 return;
2626
2627 mutex_lock(&wq->flush_mutex);
2628
Tejun Heo4ce48b32010-07-02 10:03:51 +02002629 /* we might have raced, check again with mutex held */
2630 if (wq->first_flusher != &this_flusher)
2631 goto out_unlock;
2632
Tejun Heo73f53c42010-06-29 10:07:11 +02002633 wq->first_flusher = NULL;
2634
Tejun Heo6183c002013-03-12 11:29:57 -07002635 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2636 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002637
2638 while (true) {
2639 struct wq_flusher *next, *tmp;
2640
2641 /* complete all the flushers sharing the current flush color */
2642 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2643 if (next->flush_color != wq->flush_color)
2644 break;
2645 list_del_init(&next->list);
2646 complete(&next->done);
2647 }
2648
Tejun Heo6183c002013-03-12 11:29:57 -07002649 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2650 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002651
2652 /* this flush_color is finished, advance by one */
2653 wq->flush_color = work_next_color(wq->flush_color);
2654
2655 /* one color has been freed, handle overflow queue */
2656 if (!list_empty(&wq->flusher_overflow)) {
2657 /*
2658 * Assign the same color to all overflowed
2659 * flushers, advance work_color and append to
2660 * flusher_queue. This is the start-to-wait
2661 * phase for these overflowed flushers.
2662 */
2663 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2664 tmp->flush_color = wq->work_color;
2665
2666 wq->work_color = work_next_color(wq->work_color);
2667
2668 list_splice_tail_init(&wq->flusher_overflow,
2669 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002670 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002671 }
2672
2673 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002674 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002675 break;
2676 }
2677
2678 /*
2679 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002680 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002681 */
Tejun Heo6183c002013-03-12 11:29:57 -07002682 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2683 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002684
2685 list_del_init(&next->list);
2686 wq->first_flusher = next;
2687
Tejun Heo112202d2013-02-13 19:29:12 -08002688 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002689 break;
2690
2691 /*
2692 * Meh... this color is already done, clear first
2693 * flusher and repeat cascading.
2694 */
2695 wq->first_flusher = NULL;
2696 }
2697
2698out_unlock:
2699 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002700}
Dave Jonesae90dd52006-06-30 01:40:45 -04002701EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002703/**
2704 * drain_workqueue - drain a workqueue
2705 * @wq: workqueue to drain
2706 *
2707 * Wait until the workqueue becomes empty. While draining is in progress,
2708 * only chain queueing is allowed. IOW, only currently pending or running
2709 * work items on @wq can queue further work items on it. @wq is flushed
2710 * repeatedly until it becomes empty. The number of flushing is detemined
2711 * by the depth of chaining and should be relatively short. Whine if it
2712 * takes too long.
2713 */
2714void drain_workqueue(struct workqueue_struct *wq)
2715{
2716 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002717 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002718
2719 /*
2720 * __queue_work() needs to test whether there are drainers, is much
2721 * hotter than drain_workqueue() and already looks at @wq->flags.
2722 * Use WQ_DRAINING so that queue doesn't have to check nr_drainers.
2723 */
Tejun Heoe98d5b12013-03-12 11:29:57 -07002724 spin_lock_irq(&workqueue_lock);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002725 if (!wq->nr_drainers++)
2726 wq->flags |= WQ_DRAINING;
Tejun Heoe98d5b12013-03-12 11:29:57 -07002727 spin_unlock_irq(&workqueue_lock);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002728reflush:
2729 flush_workqueue(wq);
2730
Tejun Heo49e3cf42013-03-12 11:29:58 -07002731 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002732 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002733
Tejun Heo112202d2013-02-13 19:29:12 -08002734 spin_lock_irq(&pwq->pool->lock);
2735 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
2736 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002737
2738 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002739 continue;
2740
2741 if (++flush_cnt == 10 ||
2742 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Valentin Ilie044c7822012-08-19 00:52:42 +03002743 pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n",
2744 wq->name, flush_cnt);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002745 goto reflush;
2746 }
2747
Tejun Heoe98d5b12013-03-12 11:29:57 -07002748 spin_lock_irq(&workqueue_lock);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002749 if (!--wq->nr_drainers)
2750 wq->flags &= ~WQ_DRAINING;
Tejun Heoe98d5b12013-03-12 11:29:57 -07002751 spin_unlock_irq(&workqueue_lock);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002752}
2753EXPORT_SYMBOL_GPL(drain_workqueue);
2754
Tejun Heo606a5022012-08-20 14:51:23 -07002755static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002756{
2757 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002758 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002759 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002760
2761 might_sleep();
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002762 pool = get_work_pool(work);
2763 if (!pool)
Tejun Heobaf59022010-09-16 10:42:16 +02002764 return false;
2765
Tejun Heod565ed62013-01-24 11:01:33 -08002766 spin_lock_irq(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002767 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002768 pwq = get_work_pwq(work);
2769 if (pwq) {
2770 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002771 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002772 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002773 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002774 if (!worker)
2775 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002776 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002777 }
Tejun Heobaf59022010-09-16 10:42:16 +02002778
Tejun Heo112202d2013-02-13 19:29:12 -08002779 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002780 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002781
Tejun Heoe1594892011-01-09 23:32:15 +01002782 /*
2783 * If @max_active is 1 or rescuer is in use, flushing another work
2784 * item on the same workqueue may lead to deadlock. Make sure the
2785 * flusher is not running on the same workqueue by verifying write
2786 * access.
2787 */
Tejun Heo112202d2013-02-13 19:29:12 -08002788 if (pwq->wq->saved_max_active == 1 || pwq->wq->flags & WQ_RESCUER)
2789 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002790 else
Tejun Heo112202d2013-02-13 19:29:12 -08002791 lock_map_acquire_read(&pwq->wq->lockdep_map);
2792 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002793
Tejun Heobaf59022010-09-16 10:42:16 +02002794 return true;
2795already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002796 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002797 return false;
2798}
2799
Oleg Nesterovdb700892008-07-25 01:47:49 -07002800/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002801 * flush_work - wait for a work to finish executing the last queueing instance
2802 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002803 *
Tejun Heo606a5022012-08-20 14:51:23 -07002804 * Wait until @work has finished execution. @work is guaranteed to be idle
2805 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002806 *
2807 * RETURNS:
2808 * %true if flush_work() waited for the work to finish execution,
2809 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002810 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002811bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002812{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002813 struct wq_barrier barr;
2814
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002815 lock_map_acquire(&work->lockdep_map);
2816 lock_map_release(&work->lockdep_map);
2817
Tejun Heo606a5022012-08-20 14:51:23 -07002818 if (start_flush_work(work, &barr)) {
Tejun Heobaf59022010-09-16 10:42:16 +02002819 wait_for_completion(&barr.done);
2820 destroy_work_on_stack(&barr.work);
2821 return true;
Tejun Heo606a5022012-08-20 14:51:23 -07002822 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002823 return false;
Tejun Heo606a5022012-08-20 14:51:23 -07002824 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002825}
2826EXPORT_SYMBOL_GPL(flush_work);
2827
Tejun Heo36e227d2012-08-03 10:30:46 -07002828static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002829{
Tejun Heobbb68df2012-08-03 10:30:46 -07002830 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002831 int ret;
2832
2833 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002834 ret = try_to_grab_pending(work, is_dwork, &flags);
2835 /*
2836 * If someone else is canceling, wait for the same event it
2837 * would be waiting for before retrying.
2838 */
2839 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002840 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002841 } while (unlikely(ret < 0));
2842
Tejun Heobbb68df2012-08-03 10:30:46 -07002843 /* tell other tasks trying to grab @work to back off */
2844 mark_work_canceling(work);
2845 local_irq_restore(flags);
2846
Tejun Heo606a5022012-08-20 14:51:23 -07002847 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002848 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002849 return ret;
2850}
2851
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002852/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002853 * cancel_work_sync - cancel a work and wait for it to finish
2854 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002855 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002856 * Cancel @work and wait for its execution to finish. This function
2857 * can be used even if the work re-queues itself or migrates to
2858 * another workqueue. On return from this function, @work is
2859 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002860 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002861 * cancel_work_sync(&delayed_work->work) must not be used for
2862 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002863 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002864 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002865 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002866 *
2867 * RETURNS:
2868 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002869 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002870bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002871{
Tejun Heo36e227d2012-08-03 10:30:46 -07002872 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002873}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002874EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002875
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002876/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002877 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2878 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002879 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002880 * Delayed timer is cancelled and the pending work is queued for
2881 * immediate execution. Like flush_work(), this function only
2882 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002883 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002884 * RETURNS:
2885 * %true if flush_work() waited for the work to finish execution,
2886 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002887 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002888bool flush_delayed_work(struct delayed_work *dwork)
2889{
Tejun Heo8930cab2012-08-03 10:30:45 -07002890 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002891 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002892 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002893 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002894 return flush_work(&dwork->work);
2895}
2896EXPORT_SYMBOL(flush_delayed_work);
2897
2898/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002899 * cancel_delayed_work - cancel a delayed work
2900 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002901 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002902 * Kill off a pending delayed_work. Returns %true if @dwork was pending
2903 * and canceled; %false if wasn't pending. Note that the work callback
2904 * function may still be running on return, unless it returns %true and the
2905 * work doesn't re-arm itself. Explicitly flush or use
2906 * cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002907 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002908 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002909 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002910bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002911{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002912 unsigned long flags;
2913 int ret;
2914
2915 do {
2916 ret = try_to_grab_pending(&dwork->work, true, &flags);
2917 } while (unlikely(ret == -EAGAIN));
2918
2919 if (unlikely(ret < 0))
2920 return false;
2921
Tejun Heo7c3eed52013-01-24 11:01:33 -08002922 set_work_pool_and_clear_pending(&dwork->work,
2923 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002924 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002925 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002926}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002927EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002928
2929/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002930 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2931 * @dwork: the delayed work cancel
2932 *
2933 * This is cancel_work_sync() for delayed works.
2934 *
2935 * RETURNS:
2936 * %true if @dwork was pending, %false otherwise.
2937 */
2938bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002939{
Tejun Heo36e227d2012-08-03 10:30:46 -07002940 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002941}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002942EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002943
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002944/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07002945 * schedule_work_on - put work task on a specific cpu
2946 * @cpu: cpu to put the work task on
2947 * @work: job to be done
2948 *
2949 * This puts a job on a specific cpu
2950 */
Tejun Heod4283e92012-08-03 10:30:44 -07002951bool schedule_work_on(int cpu, struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07002952{
Tejun Heod320c032010-06-29 10:07:14 +02002953 return queue_work_on(cpu, system_wq, work);
Zhang Ruic1a220e2008-07-23 21:28:39 -07002954}
2955EXPORT_SYMBOL(schedule_work_on);
2956
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002957/**
Dave Jonesae90dd52006-06-30 01:40:45 -04002958 * schedule_work - put work task in global workqueue
Linus Torvalds1da177e2005-04-16 15:20:36 -07002959 * @work: job to be done
Linus Torvalds1da177e2005-04-16 15:20:36 -07002960 *
Tejun Heod4283e92012-08-03 10:30:44 -07002961 * Returns %false if @work was already on the kernel-global workqueue and
2962 * %true otherwise.
David Howells52bad642006-11-22 14:54:01 +00002963 *
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002964 * This puts a job in the kernel-global workqueue if it was not already
2965 * queued and leaves it in the same position on the kernel-global
2966 * workqueue otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002967 */
Tejun Heod4283e92012-08-03 10:30:44 -07002968bool schedule_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002969{
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002970 return queue_work(system_wq, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002971}
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002972EXPORT_SYMBOL(schedule_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002973
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002974/**
2975 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
2976 * @cpu: cpu to use
2977 * @dwork: job to be done
2978 * @delay: number of jiffies to wait
2979 *
2980 * After waiting for a given time this puts a job in the kernel-global
2981 * workqueue on the specified CPU.
2982 */
Tejun Heod4283e92012-08-03 10:30:44 -07002983bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
2984 unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002985{
Tejun Heod320c032010-06-29 10:07:14 +02002986 return queue_delayed_work_on(cpu, system_wq, dwork, delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987}
Dave Jonesae90dd52006-06-30 01:40:45 -04002988EXPORT_SYMBOL(schedule_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002989
Andrew Mortonb6136772006-06-25 05:47:49 -07002990/**
Tejun Heo0a13c002012-08-03 10:30:44 -07002991 * schedule_delayed_work - put work task in global workqueue after delay
2992 * @dwork: job to be done
2993 * @delay: number of jiffies to wait or 0 for immediate execution
2994 *
2995 * After waiting for a given time this puts a job in the kernel-global
2996 * workqueue.
2997 */
Tejun Heod4283e92012-08-03 10:30:44 -07002998bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay)
Tejun Heo0a13c002012-08-03 10:30:44 -07002999{
3000 return queue_delayed_work(system_wq, dwork, delay);
3001}
3002EXPORT_SYMBOL(schedule_delayed_work);
3003
3004/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003005 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003006 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003007 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003008 * schedule_on_each_cpu() executes @func on each online CPU using the
3009 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003010 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003011 *
3012 * RETURNS:
3013 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003014 */
David Howells65f27f32006-11-22 14:55:48 +00003015int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003016{
3017 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003018 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003019
Andrew Mortonb6136772006-06-25 05:47:49 -07003020 works = alloc_percpu(struct work_struct);
3021 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003022 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003023
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003024 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003025
Christoph Lameter15316ba2006-01-08 01:00:43 -08003026 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003027 struct work_struct *work = per_cpu_ptr(works, cpu);
3028
3029 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003030 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003031 }
Tejun Heo93981802009-11-17 14:06:20 -08003032
3033 for_each_online_cpu(cpu)
3034 flush_work(per_cpu_ptr(works, cpu));
3035
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003036 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003037 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003038 return 0;
3039}
3040
Alan Sterneef6a7d2010-02-12 17:39:21 +09003041/**
3042 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3043 *
3044 * Forces execution of the kernel-global workqueue and blocks until its
3045 * completion.
3046 *
3047 * Think twice before calling this function! It's very easy to get into
3048 * trouble if you don't take great care. Either of the following situations
3049 * will lead to deadlock:
3050 *
3051 * One of the work items currently on the workqueue needs to acquire
3052 * a lock held by your code or its caller.
3053 *
3054 * Your code is running in the context of a work routine.
3055 *
3056 * They will be detected by lockdep when they occur, but the first might not
3057 * occur very often. It depends on what work items are on the workqueue and
3058 * what locks they need, which you have no control over.
3059 *
3060 * In most situations flushing the entire workqueue is overkill; you merely
3061 * need to know that a particular work item isn't queued and isn't running.
3062 * In such cases you should use cancel_delayed_work_sync() or
3063 * cancel_work_sync() instead.
3064 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003065void flush_scheduled_work(void)
3066{
Tejun Heod320c032010-06-29 10:07:14 +02003067 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003068}
Dave Jonesae90dd52006-06-30 01:40:45 -04003069EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003070
3071/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003072 * execute_in_process_context - reliably execute the routine with user context
3073 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003074 * @ew: guaranteed storage for the execute work structure (must
3075 * be available when the work executes)
3076 *
3077 * Executes the function immediately if process context is available,
3078 * otherwise schedules the function for delayed execution.
3079 *
3080 * Returns: 0 - function was executed
3081 * 1 - function was scheduled for execution
3082 */
David Howells65f27f32006-11-22 14:55:48 +00003083int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003084{
3085 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003086 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003087 return 0;
3088 }
3089
David Howells65f27f32006-11-22 14:55:48 +00003090 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003091 schedule_work(&ew->work);
3092
3093 return 1;
3094}
3095EXPORT_SYMBOL_GPL(execute_in_process_context);
3096
Linus Torvalds1da177e2005-04-16 15:20:36 -07003097int keventd_up(void)
3098{
Tejun Heod320c032010-06-29 10:07:14 +02003099 return system_wq != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003100}
3101
Tejun Heo30cdf242013-03-12 11:29:57 -07003102static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003103{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003104 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo30cdf242013-03-12 11:29:57 -07003105 int cpu;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003106
Tejun Heo30cdf242013-03-12 11:29:57 -07003107 if (!(wq->flags & WQ_UNBOUND)) {
3108 wq->pool_wq.pcpu = alloc_percpu(struct pool_workqueue);
3109 if (!wq->pool_wq.pcpu)
3110 return -ENOMEM;
3111
3112 for_each_possible_cpu(cpu) {
3113 struct pool_workqueue *pwq = get_pwq(cpu, wq);
3114
Tejun Heo49e3cf42013-03-12 11:29:58 -07003115 pwq->pool = get_std_worker_pool(cpu, highpri);
Tejun Heo30cdf242013-03-12 11:29:57 -07003116 list_add_tail(&pwq->pwqs_node, &wq->pwqs);
3117 }
3118 } else {
3119 struct pool_workqueue *pwq;
3120
3121 pwq = kmem_cache_zalloc(pwq_cache, GFP_KERNEL);
3122 if (!pwq)
3123 return -ENOMEM;
3124
3125 wq->pool_wq.single = pwq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003126 pwq->pool = get_std_worker_pool(WORK_CPU_UNBOUND, highpri);
Tejun Heo30cdf242013-03-12 11:29:57 -07003127 list_add_tail(&pwq->pwqs_node, &wq->pwqs);
3128 }
3129
3130 return 0;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003131}
3132
Tejun Heo112202d2013-02-13 19:29:12 -08003133static void free_pwqs(struct workqueue_struct *wq)
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003134{
Lai Jiangshane06ffa12012-03-09 18:03:20 +08003135 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo112202d2013-02-13 19:29:12 -08003136 free_percpu(wq->pool_wq.pcpu);
Tejun Heoe904e6c2013-03-12 11:29:57 -07003137 else
3138 kmem_cache_free(pwq_cache, wq->pool_wq.single);
Oleg Nesterov06ba38a2007-05-09 02:34:15 -07003139}
3140
Tejun Heof3421792010-07-02 10:03:51 +02003141static int wq_clamp_max_active(int max_active, unsigned int flags,
3142 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003143{
Tejun Heof3421792010-07-02 10:03:51 +02003144 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3145
3146 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003147 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3148 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003149
Tejun Heof3421792010-07-02 10:03:51 +02003150 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003151}
3152
Tejun Heob196be82012-01-10 15:11:35 -08003153struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003154 unsigned int flags,
3155 int max_active,
3156 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003157 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003158{
Tejun Heob196be82012-01-10 15:11:35 -08003159 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003160 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003161 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003162 size_t namelen;
3163
3164 /* determine namelen, allocate wq and format name */
3165 va_start(args, lock_name);
3166 va_copy(args1, args);
3167 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3168
3169 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3170 if (!wq)
3171 goto err;
3172
3173 vsnprintf(wq->name, namelen, fmt, args1);
3174 va_end(args);
3175 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003176
Tejun Heof3421792010-07-02 10:03:51 +02003177 /*
Tejun Heo6370a6a2010-10-11 15:12:27 +02003178 * Workqueues which may be used during memory reclaim should
3179 * have a rescuer to guarantee forward progress.
3180 */
3181 if (flags & WQ_MEM_RECLAIM)
3182 flags |= WQ_RESCUER;
3183
Tejun Heod320c032010-06-29 10:07:14 +02003184 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003185 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003186
Tejun Heob196be82012-01-10 15:11:35 -08003187 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003188 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003189 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003190 mutex_init(&wq->flush_mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003191 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003192 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003193 INIT_LIST_HEAD(&wq->flusher_queue);
3194 INIT_LIST_HEAD(&wq->flusher_overflow);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003195
Johannes Bergeb13ba82008-01-16 09:51:58 +01003196 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003197 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003198
Tejun Heo30cdf242013-03-12 11:29:57 -07003199 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heobdbc5dd2010-07-02 10:03:51 +02003200 goto err;
3201
Tejun Heo49e3cf42013-03-12 11:29:58 -07003202 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08003203 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
Tejun Heo112202d2013-02-13 19:29:12 -08003204 pwq->wq = wq;
3205 pwq->flush_color = -1;
3206 pwq->max_active = max_active;
3207 INIT_LIST_HEAD(&pwq->delayed_works);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003208 }
3209
Tejun Heoe22bee72010-06-29 10:07:14 +02003210 if (flags & WQ_RESCUER) {
3211 struct worker *rescuer;
3212
Tejun Heof2e005a2010-07-20 15:59:09 +02003213 if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL))
Tejun Heoe22bee72010-06-29 10:07:14 +02003214 goto err;
3215
3216 wq->rescuer = rescuer = alloc_worker();
3217 if (!rescuer)
3218 goto err;
3219
Tejun Heo111c2252013-01-17 17:16:24 -08003220 rescuer->rescue_wq = wq;
3221 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003222 wq->name);
Tejun Heoe22bee72010-06-29 10:07:14 +02003223 if (IS_ERR(rescuer->task))
3224 goto err;
3225
Tejun Heoe22bee72010-06-29 10:07:14 +02003226 rescuer->task->flags |= PF_THREAD_BOUND;
3227 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003228 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003229
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003230 /*
3231 * workqueue_lock protects global freeze state and workqueues
3232 * list. Grab it, set max_active accordingly and add the new
3233 * workqueue to workqueues list.
3234 */
Tejun Heoe98d5b12013-03-12 11:29:57 -07003235 spin_lock_irq(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003236
Tejun Heo58a69cb2011-02-16 09:25:31 +01003237 if (workqueue_freezing && wq->flags & WQ_FREEZABLE)
Tejun Heo49e3cf42013-03-12 11:29:58 -07003238 for_each_pwq(pwq, wq)
3239 pwq->max_active = 0;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003240
Tejun Heo15376632010-06-29 10:07:11 +02003241 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003242
Tejun Heoe98d5b12013-03-12 11:29:57 -07003243 spin_unlock_irq(&workqueue_lock);
Tejun Heo15376632010-06-29 10:07:11 +02003244
Oleg Nesterov3af244332007-05-09 02:34:09 -07003245 return wq;
Tejun Heo4690c4a2010-06-29 10:07:10 +02003246err:
3247 if (wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08003248 free_pwqs(wq);
Tejun Heof2e005a2010-07-20 15:59:09 +02003249 free_mayday_mask(wq->mayday_mask);
Tejun Heoe22bee72010-06-29 10:07:14 +02003250 kfree(wq->rescuer);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003251 kfree(wq);
3252 }
3253 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003254}
Tejun Heod320c032010-06-29 10:07:14 +02003255EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003256
3257/**
3258 * destroy_workqueue - safely terminate a workqueue
3259 * @wq: target workqueue
3260 *
3261 * Safely destroy a workqueue. All work currently pending will be done first.
3262 */
3263void destroy_workqueue(struct workqueue_struct *wq)
3264{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003265 struct pool_workqueue *pwq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003266
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003267 /* drain it before proceeding with destruction */
3268 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003269
Tejun Heo6183c002013-03-12 11:29:57 -07003270 /* sanity checks */
Tejun Heo49e3cf42013-03-12 11:29:58 -07003271 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07003272 int i;
3273
3274 for (i = 0; i < WORK_NR_COLORS; i++)
3275 if (WARN_ON(pwq->nr_in_flight[i]))
3276 return;
3277 if (WARN_ON(pwq->nr_active) ||
3278 WARN_ON(!list_empty(&pwq->delayed_works)))
3279 return;
3280 }
3281
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003282 /*
3283 * wq list is used to freeze wq, remove from list after
3284 * flushing is complete in case freeze races us.
3285 */
Tejun Heoe98d5b12013-03-12 11:29:57 -07003286 spin_lock_irq(&workqueue_lock);
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07003287 list_del(&wq->list);
Tejun Heoe98d5b12013-03-12 11:29:57 -07003288 spin_unlock_irq(&workqueue_lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003289
Tejun Heoe22bee72010-06-29 10:07:14 +02003290 if (wq->flags & WQ_RESCUER) {
3291 kthread_stop(wq->rescuer->task);
Tejun Heof2e005a2010-07-20 15:59:09 +02003292 free_mayday_mask(wq->mayday_mask);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003293 kfree(wq->rescuer);
Tejun Heoe22bee72010-06-29 10:07:14 +02003294 }
3295
Tejun Heo112202d2013-02-13 19:29:12 -08003296 free_pwqs(wq);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003297 kfree(wq);
3298}
3299EXPORT_SYMBOL_GPL(destroy_workqueue);
3300
Tejun Heodcd989c2010-06-29 10:07:14 +02003301/**
Tejun Heo112202d2013-02-13 19:29:12 -08003302 * pwq_set_max_active - adjust max_active of a pwq
3303 * @pwq: target pool_workqueue
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003304 * @max_active: new max_active value.
3305 *
Tejun Heo112202d2013-02-13 19:29:12 -08003306 * Set @pwq->max_active to @max_active and activate delayed works if
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003307 * increased.
3308 *
3309 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08003310 * spin_lock_irq(pool->lock).
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003311 */
Tejun Heo112202d2013-02-13 19:29:12 -08003312static void pwq_set_max_active(struct pool_workqueue *pwq, int max_active)
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003313{
Tejun Heo112202d2013-02-13 19:29:12 -08003314 pwq->max_active = max_active;
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003315
Tejun Heo112202d2013-02-13 19:29:12 -08003316 while (!list_empty(&pwq->delayed_works) &&
3317 pwq->nr_active < pwq->max_active)
3318 pwq_activate_first_delayed(pwq);
Lai Jiangshan9f4bd4c2012-09-19 10:40:48 -07003319}
3320
3321/**
Tejun Heodcd989c2010-06-29 10:07:14 +02003322 * workqueue_set_max_active - adjust max_active of a workqueue
3323 * @wq: target workqueue
3324 * @max_active: new max_active value.
3325 *
3326 * Set max_active of @wq to @max_active.
3327 *
3328 * CONTEXT:
3329 * Don't call from IRQ context.
3330 */
3331void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3332{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003333 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02003334
Tejun Heof3421792010-07-02 10:03:51 +02003335 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003336
Tejun Heoe98d5b12013-03-12 11:29:57 -07003337 spin_lock_irq(&workqueue_lock);
Tejun Heodcd989c2010-06-29 10:07:14 +02003338
3339 wq->saved_max_active = max_active;
3340
Tejun Heo49e3cf42013-03-12 11:29:58 -07003341 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08003342 struct worker_pool *pool = pwq->pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02003343
Tejun Heoe98d5b12013-03-12 11:29:57 -07003344 spin_lock(&pool->lock);
Tejun Heodcd989c2010-06-29 10:07:14 +02003345
Tejun Heo58a69cb2011-02-16 09:25:31 +01003346 if (!(wq->flags & WQ_FREEZABLE) ||
Tejun Heo35b6bb62013-01-24 11:01:33 -08003347 !(pool->flags & POOL_FREEZING))
Tejun Heo112202d2013-02-13 19:29:12 -08003348 pwq_set_max_active(pwq, max_active);
Tejun Heodcd989c2010-06-29 10:07:14 +02003349
Tejun Heoe98d5b12013-03-12 11:29:57 -07003350 spin_unlock(&pool->lock);
Tejun Heodcd989c2010-06-29 10:07:14 +02003351 }
3352
Tejun Heoe98d5b12013-03-12 11:29:57 -07003353 spin_unlock_irq(&workqueue_lock);
Tejun Heodcd989c2010-06-29 10:07:14 +02003354}
3355EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3356
3357/**
3358 * workqueue_congested - test whether a workqueue is congested
3359 * @cpu: CPU in question
3360 * @wq: target workqueue
3361 *
3362 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3363 * no synchronization around this function and the test result is
3364 * unreliable and only useful as advisory hints or for debugging.
3365 *
3366 * RETURNS:
3367 * %true if congested, %false otherwise.
3368 */
3369bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq)
3370{
Tejun Heo112202d2013-02-13 19:29:12 -08003371 struct pool_workqueue *pwq = get_pwq(cpu, wq);
Tejun Heodcd989c2010-06-29 10:07:14 +02003372
Tejun Heo112202d2013-02-13 19:29:12 -08003373 return !list_empty(&pwq->delayed_works);
Tejun Heodcd989c2010-06-29 10:07:14 +02003374}
3375EXPORT_SYMBOL_GPL(workqueue_congested);
3376
3377/**
Tejun Heodcd989c2010-06-29 10:07:14 +02003378 * work_busy - test whether a work is currently pending or running
3379 * @work: the work to be tested
3380 *
3381 * Test whether @work is currently pending or running. There is no
3382 * synchronization around this function and the test result is
3383 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02003384 *
3385 * RETURNS:
3386 * OR'd bitmask of WORK_BUSY_* bits.
3387 */
3388unsigned int work_busy(struct work_struct *work)
3389{
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003390 struct worker_pool *pool = get_work_pool(work);
Tejun Heodcd989c2010-06-29 10:07:14 +02003391 unsigned long flags;
3392 unsigned int ret = 0;
3393
Tejun Heodcd989c2010-06-29 10:07:14 +02003394 if (work_pending(work))
3395 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02003396
Lai Jiangshan038366c2013-02-06 18:04:53 -08003397 if (pool) {
3398 spin_lock_irqsave(&pool->lock, flags);
3399 if (find_worker_executing_work(pool, work))
3400 ret |= WORK_BUSY_RUNNING;
3401 spin_unlock_irqrestore(&pool->lock, flags);
3402 }
Tejun Heodcd989c2010-06-29 10:07:14 +02003403
3404 return ret;
3405}
3406EXPORT_SYMBOL_GPL(work_busy);
3407
Tejun Heodb7bccf2010-06-29 10:07:12 +02003408/*
3409 * CPU hotplug.
3410 *
Tejun Heoe22bee72010-06-29 10:07:14 +02003411 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08003412 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08003413 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02003414 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08003415 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02003416 * blocked draining impractical.
3417 *
Tejun Heo24647572013-01-24 11:01:33 -08003418 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07003419 * running as an unbound one and allowing it to be reattached later if the
3420 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02003421 */
3422
Tejun Heo706026c2013-01-24 11:01:34 -08003423static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02003424{
Tejun Heo38db41d2013-01-24 11:01:34 -08003425 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07003426 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003427 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003428 int i;
3429
Tejun Heo38db41d2013-01-24 11:01:34 -08003430 for_each_std_worker_pool(pool, cpu) {
Tejun Heo6183c002013-03-12 11:29:57 -07003431 WARN_ON_ONCE(cpu != smp_processor_id());
Tejun Heo94cf58b2013-01-24 11:01:33 -08003432
3433 mutex_lock(&pool->assoc_mutex);
3434 spin_lock_irq(&pool->lock);
3435
3436 /*
3437 * We've claimed all manager positions. Make all workers
3438 * unbound and set DISASSOCIATED. Before this, all workers
3439 * except for the ones which are still executing works from
3440 * before the last CPU down must be on the cpu. After
3441 * this, they may become diasporas.
3442 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07003443 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07003444 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003445
Sasha Levinb67bfe02013-02-27 17:06:00 -08003446 for_each_busy_worker(worker, i, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003447 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02003448
Tejun Heo24647572013-01-24 11:01:33 -08003449 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07003450
Tejun Heo94cf58b2013-01-24 11:01:33 -08003451 spin_unlock_irq(&pool->lock);
3452 mutex_unlock(&pool->assoc_mutex);
3453 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003454
3455 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07003456 * Call schedule() so that we cross rq->lock and thus can guarantee
3457 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
3458 * as scheduler callbacks may be invoked from other cpus.
3459 */
3460 schedule();
3461
3462 /*
3463 * Sched callbacks are disabled now. Zap nr_running. After this,
3464 * nr_running stays zero and need_more_worker() and keep_working()
Tejun Heo38db41d2013-01-24 11:01:34 -08003465 * are always true as long as the worklist is not empty. Pools on
3466 * @cpu now behave as unbound (in terms of concurrency management)
3467 * pools which are served by workers tied to the CPU.
Tejun Heo628c78e2012-07-17 12:39:27 -07003468 *
3469 * On return from this function, the current worker would trigger
3470 * unbound chain execution of pending work items if other workers
3471 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02003472 */
Tejun Heo38db41d2013-01-24 11:01:34 -08003473 for_each_std_worker_pool(pool, cpu)
Tejun Heoe19e3972013-01-24 11:39:44 -08003474 atomic_set(&pool->nr_running, 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02003475}
3476
Tejun Heo8db25e72012-07-17 12:39:28 -07003477/*
3478 * Workqueues should be brought up before normal priority CPU notifiers.
3479 * This will be registered high priority CPU notifier.
3480 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003481static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07003482 unsigned long action,
3483 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003484{
3485 unsigned int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003486 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003487
Tejun Heo8db25e72012-07-17 12:39:28 -07003488 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489 case CPU_UP_PREPARE:
Tejun Heo38db41d2013-01-24 11:01:34 -08003490 for_each_std_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07003491 struct worker *worker;
3492
3493 if (pool->nr_workers)
3494 continue;
3495
3496 worker = create_worker(pool);
3497 if (!worker)
3498 return NOTIFY_BAD;
3499
Tejun Heod565ed62013-01-24 11:01:33 -08003500 spin_lock_irq(&pool->lock);
Tejun Heo3ce63372012-07-17 12:39:27 -07003501 start_worker(worker);
Tejun Heod565ed62013-01-24 11:01:33 -08003502 spin_unlock_irq(&pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003503 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02003504 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07003505
Tejun Heo65758202012-07-17 12:39:26 -07003506 case CPU_DOWN_FAILED:
3507 case CPU_ONLINE:
Tejun Heo38db41d2013-01-24 11:01:34 -08003508 for_each_std_worker_pool(pool, cpu) {
Tejun Heo94cf58b2013-01-24 11:01:33 -08003509 mutex_lock(&pool->assoc_mutex);
3510 spin_lock_irq(&pool->lock);
3511
Tejun Heo24647572013-01-24 11:01:33 -08003512 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heo94cf58b2013-01-24 11:01:33 -08003513 rebind_workers(pool);
3514
3515 spin_unlock_irq(&pool->lock);
3516 mutex_unlock(&pool->assoc_mutex);
3517 }
Tejun Heo8db25e72012-07-17 12:39:28 -07003518 break;
Tejun Heo65758202012-07-17 12:39:26 -07003519 }
3520 return NOTIFY_OK;
3521}
3522
3523/*
3524 * Workqueues should be brought down after normal priority CPU notifiers.
3525 * This will be registered as low priority CPU notifier.
3526 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07003527static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07003528 unsigned long action,
3529 void *hcpu)
3530{
Tejun Heo8db25e72012-07-17 12:39:28 -07003531 unsigned int cpu = (unsigned long)hcpu;
3532 struct work_struct unbind_work;
3533
Tejun Heo65758202012-07-17 12:39:26 -07003534 switch (action & ~CPU_TASKS_FROZEN) {
3535 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07003536 /* unbinding should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08003537 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09003538 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07003539 flush_work(&unbind_work);
3540 break;
Tejun Heo65758202012-07-17 12:39:26 -07003541 }
3542 return NOTIFY_OK;
3543}
3544
Rusty Russell2d3854a2008-11-05 13:39:10 +11003545#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08003546
Rusty Russell2d3854a2008-11-05 13:39:10 +11003547struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07003548 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11003549 long (*fn)(void *);
3550 void *arg;
3551 long ret;
3552};
3553
Tejun Heoed48ece2012-09-18 12:48:43 -07003554static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11003555{
Tejun Heoed48ece2012-09-18 12:48:43 -07003556 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
3557
Rusty Russell2d3854a2008-11-05 13:39:10 +11003558 wfc->ret = wfc->fn(wfc->arg);
3559}
3560
3561/**
3562 * work_on_cpu - run a function in user context on a particular cpu
3563 * @cpu: the cpu to run on
3564 * @fn: the function to run
3565 * @arg: the function arg
3566 *
Rusty Russell31ad9082009-01-16 15:31:15 -08003567 * This will return the value @fn returns.
3568 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06003569 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11003570 */
3571long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg)
3572{
Tejun Heoed48ece2012-09-18 12:48:43 -07003573 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11003574
Tejun Heoed48ece2012-09-18 12:48:43 -07003575 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
3576 schedule_work_on(cpu, &wfc.work);
3577 flush_work(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11003578 return wfc.ret;
3579}
3580EXPORT_SYMBOL_GPL(work_on_cpu);
3581#endif /* CONFIG_SMP */
3582
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003583#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10303584
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003585/**
3586 * freeze_workqueues_begin - begin freezing workqueues
3587 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01003588 * Start freezing workqueues. After this function returns, all freezable
3589 * workqueues will queue new works to their frozen_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08003590 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003591 *
3592 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08003593 * Grabs and releases workqueue_lock and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003594 */
3595void freeze_workqueues_begin(void)
3596{
Tejun Heo17116962013-03-12 11:29:58 -07003597 struct worker_pool *pool;
Tejun Heo24b8a842013-03-12 11:29:58 -07003598 struct workqueue_struct *wq;
3599 struct pool_workqueue *pwq;
Tejun Heo17116962013-03-12 11:29:58 -07003600 int id;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003601
Tejun Heoe98d5b12013-03-12 11:29:57 -07003602 spin_lock_irq(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003603
Tejun Heo6183c002013-03-12 11:29:57 -07003604 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003605 workqueue_freezing = true;
3606
Tejun Heo24b8a842013-03-12 11:29:58 -07003607 /* set FREEZING */
Tejun Heo17116962013-03-12 11:29:58 -07003608 for_each_pool(pool, id) {
Tejun Heo17116962013-03-12 11:29:58 -07003609 spin_lock(&pool->lock);
Tejun Heo17116962013-03-12 11:29:58 -07003610 WARN_ON_ONCE(pool->flags & POOL_FREEZING);
3611 pool->flags |= POOL_FREEZING;
Tejun Heo17116962013-03-12 11:29:58 -07003612 spin_unlock(&pool->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003613 }
3614
Tejun Heo24b8a842013-03-12 11:29:58 -07003615 /* suppress further executions by setting max_active to zero */
3616 list_for_each_entry(wq, &workqueues, list) {
3617 if (!(wq->flags & WQ_FREEZABLE))
3618 continue;
3619
3620 for_each_pwq(pwq, wq) {
3621 spin_lock(&pwq->pool->lock);
3622 pwq->max_active = 0;
3623 spin_unlock(&pwq->pool->lock);
3624 }
3625 }
3626
Tejun Heoe98d5b12013-03-12 11:29:57 -07003627 spin_unlock_irq(&workqueue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003628}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003629
3630/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01003631 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003632 *
3633 * Check whether freezing is complete. This function must be called
3634 * between freeze_workqueues_begin() and thaw_workqueues().
3635 *
3636 * CONTEXT:
3637 * Grabs and releases workqueue_lock.
3638 *
3639 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01003640 * %true if some freezable workqueues are still busy. %false if freezing
3641 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003642 */
3643bool freeze_workqueues_busy(void)
3644{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003645 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07003646 struct workqueue_struct *wq;
3647 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003648
Tejun Heoe98d5b12013-03-12 11:29:57 -07003649 spin_lock_irq(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003650
Tejun Heo6183c002013-03-12 11:29:57 -07003651 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003652
Tejun Heo24b8a842013-03-12 11:29:58 -07003653 list_for_each_entry(wq, &workqueues, list) {
3654 if (!(wq->flags & WQ_FREEZABLE))
3655 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003656 /*
3657 * nr_active is monotonically decreasing. It's safe
3658 * to peek without lock.
3659 */
Tejun Heo24b8a842013-03-12 11:29:58 -07003660 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07003661 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08003662 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003663 busy = true;
3664 goto out_unlock;
3665 }
3666 }
3667 }
3668out_unlock:
Tejun Heoe98d5b12013-03-12 11:29:57 -07003669 spin_unlock_irq(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003670 return busy;
3671}
3672
3673/**
3674 * thaw_workqueues - thaw workqueues
3675 *
3676 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08003677 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003678 *
3679 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08003680 * Grabs and releases workqueue_lock and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003681 */
3682void thaw_workqueues(void)
3683{
Tejun Heo24b8a842013-03-12 11:29:58 -07003684 struct workqueue_struct *wq;
3685 struct pool_workqueue *pwq;
3686 struct worker_pool *pool;
3687 int id;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003688
Tejun Heoe98d5b12013-03-12 11:29:57 -07003689 spin_lock_irq(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003690
3691 if (!workqueue_freezing)
3692 goto out_unlock;
3693
Tejun Heo24b8a842013-03-12 11:29:58 -07003694 /* clear FREEZING */
3695 for_each_pool(pool, id) {
3696 spin_lock(&pool->lock);
3697 WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
3698 pool->flags &= ~POOL_FREEZING;
3699 spin_unlock(&pool->lock);
3700 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003701
Tejun Heo24b8a842013-03-12 11:29:58 -07003702 /* restore max_active and repopulate worklist */
3703 list_for_each_entry(wq, &workqueues, list) {
3704 if (!(wq->flags & WQ_FREEZABLE))
3705 continue;
Tejun Heod565ed62013-01-24 11:01:33 -08003706
Tejun Heo24b8a842013-03-12 11:29:58 -07003707 for_each_pwq(pwq, wq) {
3708 spin_lock(&pwq->pool->lock);
3709 pwq_set_max_active(pwq, wq->saved_max_active);
3710 spin_unlock(&pwq->pool->lock);
Tejun Heod565ed62013-01-24 11:01:33 -08003711 }
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003712 }
3713
Tejun Heo24b8a842013-03-12 11:29:58 -07003714 /* kick workers */
3715 for_each_pool(pool, id) {
3716 spin_lock(&pool->lock);
3717 wake_up_worker(pool);
3718 spin_unlock(&pool->lock);
3719 }
3720
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003721 workqueue_freezing = false;
3722out_unlock:
Tejun Heoe98d5b12013-03-12 11:29:57 -07003723 spin_unlock_irq(&workqueue_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003724}
3725#endif /* CONFIG_FREEZER */
3726
Suresh Siddha6ee05782010-07-30 14:57:37 -07003727static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003728{
Tejun Heoc34056a2010-06-29 10:07:11 +02003729 unsigned int cpu;
3730
Tejun Heo7c3eed52013-01-24 11:01:33 -08003731 /* make sure we have enough bits for OFFQ pool ID */
3732 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT)) <
Lai Jiangshan6be19582013-02-06 18:04:53 -08003733 WORK_CPU_END * NR_STD_WORKER_POOLS);
Tejun Heob5490072012-08-03 10:30:46 -07003734
Tejun Heoe904e6c2013-03-12 11:29:57 -07003735 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
3736
3737 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
3738
Tejun Heo65758202012-07-17 12:39:26 -07003739 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07003740 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02003741
Tejun Heo706026c2013-01-24 11:01:34 -08003742 /* initialize CPU pools */
3743 for_each_wq_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07003744 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02003745
Tejun Heo38db41d2013-01-24 11:01:34 -08003746 for_each_std_worker_pool(pool, cpu) {
Tejun Heod565ed62013-01-24 11:01:33 -08003747 spin_lock_init(&pool->lock);
Tejun Heoec22ca52013-01-24 11:01:33 -08003748 pool->cpu = cpu;
Tejun Heo24647572013-01-24 11:01:33 -08003749 pool->flags |= POOL_DISASSOCIATED;
Tejun Heo4ce62e92012-07-13 22:16:44 -07003750 INIT_LIST_HEAD(&pool->worklist);
3751 INIT_LIST_HEAD(&pool->idle_list);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08003752 hash_init(pool->busy_hash);
Tejun Heoe22bee72010-06-29 10:07:14 +02003753
Tejun Heo4ce62e92012-07-13 22:16:44 -07003754 init_timer_deferrable(&pool->idle_timer);
3755 pool->idle_timer.function = idle_worker_timeout;
3756 pool->idle_timer.data = (unsigned long)pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003757
Tejun Heo706026c2013-01-24 11:01:34 -08003758 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
Tejun Heo4ce62e92012-07-13 22:16:44 -07003759 (unsigned long)pool);
3760
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07003761 mutex_init(&pool->assoc_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003762 ida_init(&pool->worker_ida);
Tejun Heo9daf9e62013-01-24 11:01:33 -08003763
3764 /* alloc pool ID */
3765 BUG_ON(worker_pool_assign_id(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07003766 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02003767 }
3768
Tejun Heoe22bee72010-06-29 10:07:14 +02003769 /* create the initial worker */
Tejun Heo706026c2013-01-24 11:01:34 -08003770 for_each_online_wq_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07003771 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02003772
Tejun Heo38db41d2013-01-24 11:01:34 -08003773 for_each_std_worker_pool(pool, cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07003774 struct worker *worker;
3775
Tejun Heo24647572013-01-24 11:01:33 -08003776 if (cpu != WORK_CPU_UNBOUND)
3777 pool->flags &= ~POOL_DISASSOCIATED;
3778
Tejun Heobc2ae0f2012-07-17 12:39:27 -07003779 worker = create_worker(pool);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003780 BUG_ON(!worker);
Tejun Heod565ed62013-01-24 11:01:33 -08003781 spin_lock_irq(&pool->lock);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003782 start_worker(worker);
Tejun Heod565ed62013-01-24 11:01:33 -08003783 spin_unlock_irq(&pool->lock);
Tejun Heo4ce62e92012-07-13 22:16:44 -07003784 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003785 }
3786
Tejun Heod320c032010-06-29 10:07:14 +02003787 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003788 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02003789 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02003790 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
3791 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01003792 system_freezable_wq = alloc_workqueue("events_freezable",
3793 WQ_FREEZABLE, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09003794 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Tejun Heoae930e02012-08-20 14:51:23 -07003795 !system_unbound_wq || !system_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07003796 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003797}
Suresh Siddha6ee05782010-07-30 14:57:37 -07003798early_initcall(init_workqueues);