blob: 39a591f65b08d45d7fe08e9dbba2deb73fe51dd2 [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>
Tejun Heo29c91e92013-03-12 11:30:03 -070044#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050045#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070046#include <linux/rculist.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020047
Tejun Heoea138442013-01-18 14:05:55 -080048#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Tejun Heoc8e55f32010-06-29 10:07:12 +020050enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070051 /*
Tejun Heo24647572013-01-24 11:01:33 -080052 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070053 *
Tejun Heo24647572013-01-24 11:01:33 -080054 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070055 * While associated (!DISASSOCIATED), all workers are bound to the
56 * CPU and none has %WORKER_UNBOUND set and concurrency management
57 * is in effect.
58 *
59 * While DISASSOCIATED, the cpu may be offline and all workers have
60 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080061 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070062 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070063 * Note that DISASSOCIATED should be flipped only while holding
64 * manager_mutex to avoid changing binding state while
Tejun Heo24647572013-01-24 11:01:33 -080065 * create_worker() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070066 */
Tejun Heo11ebea52012-07-12 14:46:37 -070067 POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
Tejun Heo24647572013-01-24 11:01:33 -080068 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heo35b6bb62013-01-24 11:01:33 -080069 POOL_FREEZING = 1 << 3, /* freeze in progress */
Tejun Heodb7bccf2010-06-29 10:07:12 +020070
Tejun Heoc8e55f32010-06-29 10:07:12 +020071 /* worker flags */
72 WORKER_STARTED = 1 << 0, /* started */
73 WORKER_DIE = 1 << 1, /* die die die */
74 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020075 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020076 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020077 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoe22bee72010-06-29 10:07:14 +020078
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -070079 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_UNBOUND |
Tejun Heo403c8212012-07-17 12:39:27 -070080 WORKER_CPU_INTENSIVE,
Tejun Heodb7bccf2010-06-29 10:07:12 +020081
Tejun Heoe34cdddb2013-01-24 11:01:33 -080082 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070083
Tejun Heo29c91e92013-03-12 11:30:03 -070084 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020085 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020086
Tejun Heoe22bee72010-06-29 10:07:14 +020087 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
88 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
89
Tejun Heo3233cdb2011-02-16 18:10:19 +010090 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
91 /* call for help after 10ms
92 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020093 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
94 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020095
96 /*
97 * Rescue workers are used only on emergencies and shared by
98 * all cpus. Give -20.
99 */
100 RESCUER_NICE_LEVEL = -20,
Tejun Heo32704762012-07-13 22:16:45 -0700101 HIGHPRI_NICE_LEVEL = -20,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200102};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
104/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200105 * Structure fields follow one of the following exclusion rules.
106 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200107 * I: Modifiable by initialization/destruction paths and read-only for
108 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200109 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200110 * P: Preemption protected. Disabling preemption is enough and should
111 * only be modified and accessed from the local cpu.
112 *
Tejun Heod565ed62013-01-24 11:01:33 -0800113 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200114 *
Tejun Heod565ed62013-01-24 11:01:33 -0800115 * X: During normal operation, modification requires pool->lock and should
116 * be done only from local cpu. Either disabling preemption on local
117 * cpu or grabbing pool->lock is enough for read access. If
118 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200119 *
Tejun Heo73f53c42010-06-29 10:07:11 +0200120 * F: wq->flush_mutex protected.
121 *
Tejun Heo5bcab332013-03-13 19:47:40 -0700122 * WQ: wq_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700123 *
Tejun Heo5bcab332013-03-13 19:47:40 -0700124 * WR: wq_mutex protected for writes. Sched-RCU protected for reads.
125 *
Tejun Heo794b18b2013-03-13 19:47:40 -0700126 * PW: pwq_lock protected.
127 *
Tejun Heo794b18b2013-03-13 19:47:40 -0700128 * FR: wq->flush_mutex and pwq_lock protected for writes. Sched-RCU
Tejun Heo75ccf592013-03-12 11:30:04 -0700129 * protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700130 *
131 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200132 */
133
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800134/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200135
Tejun Heobd7bdd42012-07-12 14:46:37 -0700136struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800137 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700138 int cpu; /* I: the associated cpu */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800139 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700140 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700141
142 struct list_head worklist; /* L: list of pending works */
143 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700144
145 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700146 int nr_idle; /* L: currently idle ones */
147
148 struct list_head idle_list; /* X: list of idle workers */
149 struct timer_list idle_timer; /* L: worker idle timeout */
150 struct timer_list mayday_timer; /* L: SOS timer for workers */
151
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700152 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800153 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
154 /* L: hash of busy workers */
155
Tejun Heobc3a1af2013-03-13 19:47:39 -0700156 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo34a06bd2013-03-12 11:30:00 -0700157 struct mutex manager_arb; /* manager arbitration */
Tejun Heobc3a1af2013-03-13 19:47:39 -0700158 struct mutex manager_mutex; /* manager exclusion */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700159 struct ida worker_ida; /* L: for worker IDs */
Tejun Heoe19e3972013-01-24 11:39:44 -0800160
Tejun Heo7a4e3442013-03-12 11:30:00 -0700161 struct workqueue_attrs *attrs; /* I: worker attributes */
Tejun Heo5bcab332013-03-13 19:47:40 -0700162 struct hlist_node hash_node; /* WQ: unbound_pool_hash node */
163 int refcnt; /* WQ: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700164
Tejun Heoe19e3972013-01-24 11:39:44 -0800165 /*
166 * The current concurrency level. As it's likely to be accessed
167 * from other CPUs during try_to_wake_up(), put it in a separate
168 * cacheline.
169 */
170 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700171
172 /*
173 * Destruction of pool is sched-RCU protected to allow dereferences
174 * from get_work_pool().
175 */
176 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200177} ____cacheline_aligned_in_smp;
178
179/*
Tejun Heo112202d2013-02-13 19:29:12 -0800180 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
181 * of work_struct->data are used for flags and the remaining high bits
182 * point to the pwq; thus, pwqs need to be aligned at two's power of the
183 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 */
Tejun Heo112202d2013-02-13 19:29:12 -0800185struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700186 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200187 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200188 int work_color; /* L: current color */
189 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700190 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200191 int nr_in_flight[WORK_NR_COLORS];
192 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200193 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200194 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200195 struct list_head delayed_works; /* L: delayed works */
Tejun Heo75ccf592013-03-12 11:30:04 -0700196 struct list_head pwqs_node; /* FR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700197 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700198
199 /*
200 * Release of unbound pwq is punted to system_wq. See put_pwq()
201 * and pwq_unbound_release_workfn() for details. pool_workqueue
202 * itself is also sched-RCU protected so that the first pwq can be
Tejun Heo794b18b2013-03-13 19:47:40 -0700203 * determined without grabbing pwq_lock.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700204 */
205 struct work_struct unbound_release_work;
206 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700207} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200210 * Structure used to wait for workqueue flush.
211 */
212struct wq_flusher {
213 struct list_head list; /* F: list of flushers */
214 int flush_color; /* F: flush color waiting for */
215 struct completion done; /* flush completion */
216};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
Tejun Heo226223a2013-03-12 11:30:05 -0700218struct wq_device;
219
Tejun Heo73f53c42010-06-29 10:07:11 +0200220/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700221 * The externally visible workqueue. It relays the issued work items to
222 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 */
224struct workqueue_struct {
Tejun Heo5bcab332013-03-13 19:47:40 -0700225 unsigned int flags; /* WQ: WQ_* flags */
Tejun Heo420c0dd2013-03-12 11:29:59 -0700226 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwq's */
Tejun Heo75ccf592013-03-12 11:30:04 -0700227 struct list_head pwqs; /* FR: all pwqs of this wq */
Tejun Heo5bcab332013-03-13 19:47:40 -0700228 struct list_head list; /* WQ: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200229
230 struct mutex flush_mutex; /* protects wq flushing */
231 int work_color; /* F: current work color */
232 int flush_color; /* F: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800233 atomic_t nr_pwqs_to_flush; /* flush in progress */
Tejun Heo73f53c42010-06-29 10:07:11 +0200234 struct wq_flusher *first_flusher; /* F: first flusher */
235 struct list_head flusher_queue; /* F: flush waiters */
236 struct list_head flusher_overflow; /* F: flush overflow list */
237
Tejun Heo2e109a22013-03-13 19:47:40 -0700238 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200239 struct worker *rescuer; /* I: rescue worker */
240
Tejun Heo5bcab332013-03-13 19:47:40 -0700241 int nr_drainers; /* WQ: drain in progress */
Tejun Heo794b18b2013-03-13 19:47:40 -0700242 int saved_max_active; /* PW: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700243
244#ifdef CONFIG_SYSFS
245 struct wq_device *wq_dev; /* I: for sysfs interface */
246#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700247#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200248 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700249#endif
Tejun Heob196be82012-01-10 15:11:35 -0800250 char name[]; /* I: workqueue name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251};
252
Tejun Heoe904e6c2013-03-12 11:29:57 -0700253static struct kmem_cache *pwq_cache;
254
Tejun Heo5bcab332013-03-13 19:47:40 -0700255static DEFINE_MUTEX(wq_mutex); /* protects workqueues and pools */
Tejun Heo794b18b2013-03-13 19:47:40 -0700256static DEFINE_SPINLOCK(pwq_lock); /* protects pool_workqueues */
Tejun Heo2e109a22013-03-13 19:47:40 -0700257static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo5bcab332013-03-13 19:47:40 -0700258
259static LIST_HEAD(workqueues); /* WQ: list of all workqueues */
260static bool workqueue_freezing; /* WQ: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700261
262/* the per-cpu worker pools */
263static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
264 cpu_worker_pools);
265
Tejun Heo5bcab332013-03-13 19:47:40 -0700266static DEFINE_IDR(worker_pool_idr); /* WR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700267
Tejun Heo5bcab332013-03-13 19:47:40 -0700268/* WQ: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700269static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
270
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700271/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700272static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
273
Tejun Heod320c032010-06-29 10:07:14 +0200274struct workqueue_struct *system_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200275EXPORT_SYMBOL_GPL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300276struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900277EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300278struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200279EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300280struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200281EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300282struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100283EXPORT_SYMBOL_GPL(system_freezable_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200284
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700285static int worker_thread(void *__worker);
286static void copy_workqueue_attrs(struct workqueue_attrs *to,
287 const struct workqueue_attrs *from);
288
Tejun Heo97bd2342010-10-05 10:41:14 +0200289#define CREATE_TRACE_POINTS
290#include <trace/events/workqueue.h>
291
Tejun Heo5bcab332013-03-13 19:47:40 -0700292#define assert_rcu_or_wq_mutex() \
293 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
294 lockdep_is_held(&wq_mutex), \
295 "sched RCU or wq_mutex should be held")
296
Tejun Heo794b18b2013-03-13 19:47:40 -0700297#define assert_rcu_or_pwq_lock() \
Tejun Heo76af4d92013-03-12 11:30:00 -0700298 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Tejun Heo794b18b2013-03-13 19:47:40 -0700299 lockdep_is_held(&pwq_lock), \
300 "sched RCU or pwq_lock should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700301
Tejun Heof02ae732013-03-12 11:30:03 -0700302#define for_each_cpu_worker_pool(pool, cpu) \
303 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
304 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700305 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700306
Sasha Levinb67bfe02013-02-27 17:06:00 -0800307#define for_each_busy_worker(worker, i, pool) \
308 hash_for_each(pool->busy_hash, i, worker, hentry)
Tejun Heodb7bccf2010-06-29 10:07:12 +0200309
Tejun Heo49e3cf42013-03-12 11:29:58 -0700310/**
Tejun Heo17116962013-03-12 11:29:58 -0700311 * for_each_pool - iterate through all worker_pools in the system
312 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700313 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700314 *
Tejun Heo5bcab332013-03-13 19:47:40 -0700315 * This must be called either with wq_mutex held or sched RCU read locked.
316 * If the pool needs to be used beyond the locking in effect, the caller is
317 * responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700318 *
319 * The if/else clause exists only for the lockdep assertion and can be
320 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700321 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700322#define for_each_pool(pool, pi) \
323 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Tejun Heo5bcab332013-03-13 19:47:40 -0700324 if (({ assert_rcu_or_wq_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700325 else
Tejun Heo17116962013-03-12 11:29:58 -0700326
327/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700328 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
329 * @pwq: iteration cursor
330 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700331 *
Tejun Heo794b18b2013-03-13 19:47:40 -0700332 * This must be called either with pwq_lock held or sched RCU read locked.
333 * If the pwq needs to be used beyond the locking in effect, the caller is
334 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700335 *
336 * The if/else clause exists only for the lockdep assertion and can be
337 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700338 */
339#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700340 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Tejun Heo794b18b2013-03-13 19:47:40 -0700341 if (({ assert_rcu_or_pwq_lock(); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700342 else
Tejun Heof3421792010-07-02 10:03:51 +0200343
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900344#ifdef CONFIG_DEBUG_OBJECTS_WORK
345
346static struct debug_obj_descr work_debug_descr;
347
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100348static void *work_debug_hint(void *addr)
349{
350 return ((struct work_struct *) addr)->func;
351}
352
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900353/*
354 * fixup_init is called when:
355 * - an active object is initialized
356 */
357static int work_fixup_init(void *addr, enum debug_obj_state state)
358{
359 struct work_struct *work = addr;
360
361 switch (state) {
362 case ODEBUG_STATE_ACTIVE:
363 cancel_work_sync(work);
364 debug_object_init(work, &work_debug_descr);
365 return 1;
366 default:
367 return 0;
368 }
369}
370
371/*
372 * fixup_activate is called when:
373 * - an active object is activated
374 * - an unknown object is activated (might be a statically initialized object)
375 */
376static int work_fixup_activate(void *addr, enum debug_obj_state state)
377{
378 struct work_struct *work = addr;
379
380 switch (state) {
381
382 case ODEBUG_STATE_NOTAVAILABLE:
383 /*
384 * This is not really a fixup. The work struct was
385 * statically initialized. We just make sure that it
386 * is tracked in the object tracker.
387 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200388 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900389 debug_object_init(work, &work_debug_descr);
390 debug_object_activate(work, &work_debug_descr);
391 return 0;
392 }
393 WARN_ON_ONCE(1);
394 return 0;
395
396 case ODEBUG_STATE_ACTIVE:
397 WARN_ON(1);
398
399 default:
400 return 0;
401 }
402}
403
404/*
405 * fixup_free is called when:
406 * - an active object is freed
407 */
408static int work_fixup_free(void *addr, enum debug_obj_state state)
409{
410 struct work_struct *work = addr;
411
412 switch (state) {
413 case ODEBUG_STATE_ACTIVE:
414 cancel_work_sync(work);
415 debug_object_free(work, &work_debug_descr);
416 return 1;
417 default:
418 return 0;
419 }
420}
421
422static struct debug_obj_descr work_debug_descr = {
423 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100424 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900425 .fixup_init = work_fixup_init,
426 .fixup_activate = work_fixup_activate,
427 .fixup_free = work_fixup_free,
428};
429
430static inline void debug_work_activate(struct work_struct *work)
431{
432 debug_object_activate(work, &work_debug_descr);
433}
434
435static inline void debug_work_deactivate(struct work_struct *work)
436{
437 debug_object_deactivate(work, &work_debug_descr);
438}
439
440void __init_work(struct work_struct *work, int onstack)
441{
442 if (onstack)
443 debug_object_init_on_stack(work, &work_debug_descr);
444 else
445 debug_object_init(work, &work_debug_descr);
446}
447EXPORT_SYMBOL_GPL(__init_work);
448
449void destroy_work_on_stack(struct work_struct *work)
450{
451 debug_object_free(work, &work_debug_descr);
452}
453EXPORT_SYMBOL_GPL(destroy_work_on_stack);
454
455#else
456static inline void debug_work_activate(struct work_struct *work) { }
457static inline void debug_work_deactivate(struct work_struct *work) { }
458#endif
459
Tejun Heo9daf9e62013-01-24 11:01:33 -0800460/* allocate ID and assign it to @pool */
461static int worker_pool_assign_id(struct worker_pool *pool)
462{
463 int ret;
464
Tejun Heo5bcab332013-03-13 19:47:40 -0700465 lockdep_assert_held(&wq_mutex);
466
Tejun Heofa1b54e2013-03-12 11:30:00 -0700467 do {
468 if (!idr_pre_get(&worker_pool_idr, GFP_KERNEL))
469 return -ENOMEM;
Tejun Heofa1b54e2013-03-12 11:30:00 -0700470 ret = idr_get_new(&worker_pool_idr, pool, &pool->id);
Tejun Heofa1b54e2013-03-12 11:30:00 -0700471 } while (ret == -EAGAIN);
Tejun Heo9daf9e62013-01-24 11:01:33 -0800472
473 return ret;
474}
475
Tejun Heo76af4d92013-03-12 11:30:00 -0700476/**
477 * first_pwq - return the first pool_workqueue of the specified workqueue
478 * @wq: the target workqueue
479 *
Tejun Heo794b18b2013-03-13 19:47:40 -0700480 * This must be called either with pwq_lock held or sched RCU read locked.
481 * If the pwq needs to be used beyond the locking in effect, the caller is
482 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700483 */
Tejun Heo7fb98ea2013-03-12 11:30:00 -0700484static struct pool_workqueue *first_pwq(struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700485{
Tejun Heo794b18b2013-03-13 19:47:40 -0700486 assert_rcu_or_pwq_lock();
Tejun Heo76af4d92013-03-12 11:30:00 -0700487 return list_first_or_null_rcu(&wq->pwqs, struct pool_workqueue,
488 pwqs_node);
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700489}
490
Tejun Heo73f53c42010-06-29 10:07:11 +0200491static unsigned int work_color_to_flags(int color)
492{
493 return color << WORK_STRUCT_COLOR_SHIFT;
494}
495
496static int get_work_color(struct work_struct *work)
497{
498 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
499 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
500}
501
502static int work_next_color(int color)
503{
504 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700505}
506
David Howells4594bf12006-12-07 11:33:26 +0000507/*
Tejun Heo112202d2013-02-13 19:29:12 -0800508 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
509 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800510 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200511 *
Tejun Heo112202d2013-02-13 19:29:12 -0800512 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
513 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700514 * work->data. These functions should only be called while the work is
515 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200516 *
Tejun Heo112202d2013-02-13 19:29:12 -0800517 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800518 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800519 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800520 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700521 *
522 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
523 * canceled. While being canceled, a work item may have its PENDING set
524 * but stay off timer and worklist for arbitrarily long and nobody should
525 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000526 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200527static inline void set_work_data(struct work_struct *work, unsigned long data,
528 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000529{
Tejun Heo6183c002013-03-12 11:29:57 -0700530 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200531 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000532}
David Howells365970a2006-11-22 14:54:49 +0000533
Tejun Heo112202d2013-02-13 19:29:12 -0800534static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200535 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200536{
Tejun Heo112202d2013-02-13 19:29:12 -0800537 set_work_data(work, (unsigned long)pwq,
538 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200539}
540
Lai Jiangshan4468a002013-02-06 18:04:53 -0800541static void set_work_pool_and_keep_pending(struct work_struct *work,
542 int pool_id)
543{
544 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
545 WORK_STRUCT_PENDING);
546}
547
Tejun Heo7c3eed52013-01-24 11:01:33 -0800548static void set_work_pool_and_clear_pending(struct work_struct *work,
549 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000550{
Tejun Heo23657bb2012-08-13 17:08:19 -0700551 /*
552 * The following wmb is paired with the implied mb in
553 * test_and_set_bit(PENDING) and ensures all updates to @work made
554 * here are visible to and precede any updates by the next PENDING
555 * owner.
556 */
557 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800558 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200559}
560
561static void clear_work_data(struct work_struct *work)
562{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800563 smp_wmb(); /* see set_work_pool_and_clear_pending() */
564 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200565}
566
Tejun Heo112202d2013-02-13 19:29:12 -0800567static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200568{
Tejun Heoe1201532010-07-22 14:14:25 +0200569 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200570
Tejun Heo112202d2013-02-13 19:29:12 -0800571 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200572 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
573 else
574 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200575}
576
Tejun Heo7c3eed52013-01-24 11:01:33 -0800577/**
578 * get_work_pool - return the worker_pool a given work was associated with
579 * @work: the work item of interest
580 *
581 * Return the worker_pool @work was last associated with. %NULL if none.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700582 *
Tejun Heo5bcab332013-03-13 19:47:40 -0700583 * Pools are created and destroyed under wq_mutex, and allows read access
584 * under sched-RCU read lock. As such, this function should be called
585 * under wq_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700586 *
587 * All fields of the returned pool are accessible as long as the above
588 * mentioned locking is in effect. If the returned pool needs to be used
589 * beyond the critical section, the caller is responsible for ensuring the
590 * returned pool is and stays online.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800591 */
592static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200593{
Tejun Heoe1201532010-07-22 14:14:25 +0200594 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800595 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200596
Tejun Heo5bcab332013-03-13 19:47:40 -0700597 assert_rcu_or_wq_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700598
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 Heofa1b54e2013-03-12 11:30:00 -0700607 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800608}
609
610/**
611 * get_work_pool_id - return the worker pool ID a given work is associated with
612 * @work: the work item of interest
613 *
614 * Return the worker_pool ID @work was last associated with.
615 * %WORK_OFFQ_POOL_NONE if none.
616 */
617static int get_work_pool_id(struct work_struct *work)
618{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800619 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800620
Tejun Heo112202d2013-02-13 19:29:12 -0800621 if (data & WORK_STRUCT_PWQ)
622 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800623 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
624
625 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800626}
627
Tejun Heobbb68df2012-08-03 10:30:46 -0700628static void mark_work_canceling(struct work_struct *work)
629{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800630 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700631
Tejun Heo7c3eed52013-01-24 11:01:33 -0800632 pool_id <<= WORK_OFFQ_POOL_SHIFT;
633 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700634}
635
636static bool work_is_canceling(struct work_struct *work)
637{
638 unsigned long data = atomic_long_read(&work->data);
639
Tejun Heo112202d2013-02-13 19:29:12 -0800640 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700641}
642
David Howells365970a2006-11-22 14:54:49 +0000643/*
Tejun Heo32704762012-07-13 22:16:45 -0700644 * Policy functions. These define the policies on how the global worker
645 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800646 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000647 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200648
Tejun Heo63d95a92012-07-12 14:46:37 -0700649static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000650{
Tejun Heoe19e3972013-01-24 11:39:44 -0800651 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000652}
653
Tejun Heoe22bee72010-06-29 10:07:14 +0200654/*
655 * Need to wake up a worker? Called from anything but currently
656 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700657 *
658 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800659 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700660 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200661 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700662static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000663{
Tejun Heo63d95a92012-07-12 14:46:37 -0700664 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000665}
666
Tejun Heoe22bee72010-06-29 10:07:14 +0200667/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700668static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200669{
Tejun Heo63d95a92012-07-12 14:46:37 -0700670 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200671}
672
673/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700674static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200675{
Tejun Heoe19e3972013-01-24 11:39:44 -0800676 return !list_empty(&pool->worklist) &&
677 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200678}
679
680/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700681static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200682{
Tejun Heo63d95a92012-07-12 14:46:37 -0700683 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200684}
685
686/* Do I need to be the manager? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700687static bool need_to_manage_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200688{
Tejun Heo63d95a92012-07-12 14:46:37 -0700689 return need_to_create_worker(pool) ||
Tejun Heo11ebea52012-07-12 14:46:37 -0700690 (pool->flags & POOL_MANAGE_WORKERS);
Tejun Heoe22bee72010-06-29 10:07:14 +0200691}
692
693/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700694static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200695{
Tejun Heo34a06bd2013-03-12 11:30:00 -0700696 bool managing = mutex_is_locked(&pool->manager_arb);
Tejun Heo63d95a92012-07-12 14:46:37 -0700697 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
698 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200699
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700700 /*
701 * nr_idle and idle_list may disagree if idle rebinding is in
702 * progress. Never return %true if idle_list is empty.
703 */
704 if (list_empty(&pool->idle_list))
705 return false;
706
Tejun Heoe22bee72010-06-29 10:07:14 +0200707 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
708}
709
710/*
711 * Wake up functions.
712 */
713
Tejun Heo7e116292010-06-29 10:07:13 +0200714/* Return the first worker. Safe with preemption disabled */
Tejun Heo63d95a92012-07-12 14:46:37 -0700715static struct worker *first_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200716{
Tejun Heo63d95a92012-07-12 14:46:37 -0700717 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200718 return NULL;
719
Tejun Heo63d95a92012-07-12 14:46:37 -0700720 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200721}
722
723/**
724 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700725 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200726 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700727 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200728 *
729 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800730 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200731 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700732static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200733{
Tejun Heo63d95a92012-07-12 14:46:37 -0700734 struct worker *worker = first_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200735
736 if (likely(worker))
737 wake_up_process(worker->task);
738}
739
Tejun Heo4690c4a2010-06-29 10:07:10 +0200740/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200741 * wq_worker_waking_up - a worker is waking up
742 * @task: task waking up
743 * @cpu: CPU @task is waking up to
744 *
745 * This function is called during try_to_wake_up() when a worker is
746 * being awoken.
747 *
748 * CONTEXT:
749 * spin_lock_irq(rq->lock)
750 */
Tejun Heod84ff052013-03-12 11:29:59 -0700751void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200752{
753 struct worker *worker = kthread_data(task);
754
Joonsoo Kim36576002012-10-26 23:03:49 +0900755 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800756 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800757 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900758 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200759}
760
761/**
762 * wq_worker_sleeping - a worker is going to sleep
763 * @task: task going to sleep
764 * @cpu: CPU in question, must be the current CPU number
765 *
766 * This function is called during schedule() when a busy worker is
767 * going to sleep. Worker on the same cpu can be woken up by
768 * returning pointer to its task.
769 *
770 * CONTEXT:
771 * spin_lock_irq(rq->lock)
772 *
773 * RETURNS:
774 * Worker task on @cpu to wake up, %NULL if none.
775 */
Tejun Heod84ff052013-03-12 11:29:59 -0700776struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200777{
778 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800779 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200780
Tejun Heo111c2252013-01-17 17:16:24 -0800781 /*
782 * Rescuers, which may not have all the fields set up like normal
783 * workers, also reach here, let's not access anything before
784 * checking NOT_RUNNING.
785 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500786 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200787 return NULL;
788
Tejun Heo111c2252013-01-17 17:16:24 -0800789 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800790
Tejun Heoe22bee72010-06-29 10:07:14 +0200791 /* this can only happen on the local cpu */
Tejun Heo6183c002013-03-12 11:29:57 -0700792 if (WARN_ON_ONCE(cpu != raw_smp_processor_id()))
793 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200794
795 /*
796 * The counterpart of the following dec_and_test, implied mb,
797 * worklist not empty test sequence is in insert_work().
798 * Please read comment there.
799 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700800 * NOT_RUNNING is clear. This means that we're bound to and
801 * running on the local cpu w/ rq lock held and preemption
802 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800803 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700804 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200805 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800806 if (atomic_dec_and_test(&pool->nr_running) &&
807 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700808 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200809 return to_wakeup ? to_wakeup->task : NULL;
810}
811
812/**
813 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200814 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200815 * @flags: flags to set
816 * @wakeup: wakeup an idle worker if necessary
817 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200818 * Set @flags in @worker->flags and adjust nr_running accordingly. If
819 * nr_running becomes zero and @wakeup is %true, an idle worker is
820 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200821 *
Tejun Heocb444762010-07-02 10:03:50 +0200822 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800823 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200824 */
825static inline void worker_set_flags(struct worker *worker, unsigned int flags,
826 bool wakeup)
827{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700828 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200829
Tejun Heocb444762010-07-02 10:03:50 +0200830 WARN_ON_ONCE(worker->task != current);
831
Tejun Heoe22bee72010-06-29 10:07:14 +0200832 /*
833 * If transitioning into NOT_RUNNING, adjust nr_running and
834 * wake up an idle worker as necessary if requested by
835 * @wakeup.
836 */
837 if ((flags & WORKER_NOT_RUNNING) &&
838 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoe22bee72010-06-29 10:07:14 +0200839 if (wakeup) {
Tejun Heoe19e3972013-01-24 11:39:44 -0800840 if (atomic_dec_and_test(&pool->nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700841 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700842 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200843 } else
Tejun Heoe19e3972013-01-24 11:39:44 -0800844 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200845 }
846
Tejun Heod302f012010-06-29 10:07:13 +0200847 worker->flags |= flags;
848}
849
850/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200851 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200852 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200853 * @flags: flags to clear
854 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200855 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200856 *
Tejun Heocb444762010-07-02 10:03:50 +0200857 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800858 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200859 */
860static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
861{
Tejun Heo63d95a92012-07-12 14:46:37 -0700862 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200863 unsigned int oflags = worker->flags;
864
Tejun Heocb444762010-07-02 10:03:50 +0200865 WARN_ON_ONCE(worker->task != current);
866
Tejun Heod302f012010-06-29 10:07:13 +0200867 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200868
Tejun Heo42c025f2011-01-11 15:58:49 +0100869 /*
870 * If transitioning out of NOT_RUNNING, increment nr_running. Note
871 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
872 * of multiple flags, not a single flag.
873 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200874 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
875 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800876 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200877}
878
879/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200880 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800881 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200882 * @work: work to find worker for
883 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800884 * Find a worker which is executing @work on @pool by searching
885 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800886 * to match, its current execution should match the address of @work and
887 * its work function. This is to avoid unwanted dependency between
888 * unrelated work executions through a work item being recycled while still
889 * being executed.
890 *
891 * This is a bit tricky. A work item may be freed once its execution
892 * starts and nothing prevents the freed area from being recycled for
893 * another work item. If the same work item address ends up being reused
894 * before the original execution finishes, workqueue will identify the
895 * recycled work item as currently executing and make it wait until the
896 * current execution finishes, introducing an unwanted dependency.
897 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700898 * This function checks the work item address and work function to avoid
899 * false positives. Note that this isn't complete as one may construct a
900 * work function which can introduce dependency onto itself through a
901 * recycled work item. Well, if somebody wants to shoot oneself in the
902 * foot that badly, there's only so much we can do, and if such deadlock
903 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200904 *
905 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800906 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200907 *
908 * RETURNS:
909 * Pointer to worker which is executing @work if found, NULL
910 * otherwise.
911 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800912static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200913 struct work_struct *work)
914{
Sasha Levin42f85702012-12-17 10:01:23 -0500915 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -0500916
Sasha Levinb67bfe02013-02-27 17:06:00 -0800917 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800918 (unsigned long)work)
919 if (worker->current_work == work &&
920 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500921 return worker;
922
923 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200924}
925
926/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700927 * move_linked_works - move linked works to a list
928 * @work: start of series of works to be scheduled
929 * @head: target list to append @work to
930 * @nextp: out paramter for nested worklist walking
931 *
932 * Schedule linked works starting from @work to @head. Work series to
933 * be scheduled starts at @work and includes any consecutive work with
934 * WORK_STRUCT_LINKED set in its predecessor.
935 *
936 * If @nextp is not NULL, it's updated to point to the next work of
937 * the last scheduled work. This allows move_linked_works() to be
938 * nested inside outer list_for_each_entry_safe().
939 *
940 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800941 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -0700942 */
943static void move_linked_works(struct work_struct *work, struct list_head *head,
944 struct work_struct **nextp)
945{
946 struct work_struct *n;
947
948 /*
949 * Linked worklist will always end before the end of the list,
950 * use NULL for list head.
951 */
952 list_for_each_entry_safe_from(work, n, NULL, entry) {
953 list_move_tail(&work->entry, head);
954 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
955 break;
956 }
957
958 /*
959 * If we're already inside safe list traversal and have moved
960 * multiple works to the scheduled queue, the next position
961 * needs to be updated.
962 */
963 if (nextp)
964 *nextp = n;
965}
966
Tejun Heo8864b4e2013-03-12 11:30:04 -0700967/**
968 * get_pwq - get an extra reference on the specified pool_workqueue
969 * @pwq: pool_workqueue to get
970 *
971 * Obtain an extra reference on @pwq. The caller should guarantee that
972 * @pwq has positive refcnt and be holding the matching pool->lock.
973 */
974static void get_pwq(struct pool_workqueue *pwq)
975{
976 lockdep_assert_held(&pwq->pool->lock);
977 WARN_ON_ONCE(pwq->refcnt <= 0);
978 pwq->refcnt++;
979}
980
981/**
982 * put_pwq - put a pool_workqueue reference
983 * @pwq: pool_workqueue to put
984 *
985 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
986 * destruction. The caller should be holding the matching pool->lock.
987 */
988static void put_pwq(struct pool_workqueue *pwq)
989{
990 lockdep_assert_held(&pwq->pool->lock);
991 if (likely(--pwq->refcnt))
992 return;
993 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
994 return;
995 /*
996 * @pwq can't be released under pool->lock, bounce to
997 * pwq_unbound_release_workfn(). This never recurses on the same
998 * pool->lock as this path is taken only for unbound workqueues and
999 * the release work item is scheduled on a per-cpu workqueue. To
1000 * avoid lockdep warning, unbound pool->locks are given lockdep
1001 * subclass of 1 in get_unbound_pool().
1002 */
1003 schedule_work(&pwq->unbound_release_work);
1004}
1005
Tejun Heo112202d2013-02-13 19:29:12 -08001006static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001007{
Tejun Heo112202d2013-02-13 19:29:12 -08001008 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001009
1010 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001011 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001012 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001013 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001014}
1015
Tejun Heo112202d2013-02-13 19:29:12 -08001016static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001017{
Tejun Heo112202d2013-02-13 19:29:12 -08001018 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001019 struct work_struct, entry);
1020
Tejun Heo112202d2013-02-13 19:29:12 -08001021 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001022}
1023
Tejun Heobf4ede02012-08-03 10:30:46 -07001024/**
Tejun Heo112202d2013-02-13 19:29:12 -08001025 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1026 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001027 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001028 *
1029 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001030 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001031 *
1032 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001033 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001034 */
Tejun Heo112202d2013-02-13 19:29:12 -08001035static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001036{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001037 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001038 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001039 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001040
Tejun Heo112202d2013-02-13 19:29:12 -08001041 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001042
Tejun Heo112202d2013-02-13 19:29:12 -08001043 pwq->nr_active--;
1044 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001045 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001046 if (pwq->nr_active < pwq->max_active)
1047 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001048 }
1049
1050 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001051 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001052 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001053
1054 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001055 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001056 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001057
Tejun Heo112202d2013-02-13 19:29:12 -08001058 /* this pwq is done, clear flush_color */
1059 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001060
1061 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001062 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001063 * will handle the rest.
1064 */
Tejun Heo112202d2013-02-13 19:29:12 -08001065 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1066 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001067out_put:
1068 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001069}
1070
Tejun Heo36e227d2012-08-03 10:30:46 -07001071/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001072 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001073 * @work: work item to steal
1074 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001075 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001076 *
1077 * Try to grab PENDING bit of @work. This function can handle @work in any
1078 * stable state - idle, on timer or on worklist. Return values are
1079 *
1080 * 1 if @work was pending and we successfully stole PENDING
1081 * 0 if @work was idle and we claimed PENDING
1082 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001083 * -ENOENT if someone else is canceling @work, this state may persist
1084 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001085 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001086 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001087 * interrupted while holding PENDING and @work off queue, irq must be
1088 * disabled on entry. This, combined with delayed_work->timer being
1089 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001090 *
1091 * On successful return, >= 0, irq is disabled and the caller is
1092 * responsible for releasing it using local_irq_restore(*@flags).
1093 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001094 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001095 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001096static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1097 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001098{
Tejun Heod565ed62013-01-24 11:01:33 -08001099 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001100 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001101
Tejun Heobbb68df2012-08-03 10:30:46 -07001102 local_irq_save(*flags);
1103
Tejun Heo36e227d2012-08-03 10:30:46 -07001104 /* try to steal the timer if it exists */
1105 if (is_dwork) {
1106 struct delayed_work *dwork = to_delayed_work(work);
1107
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001108 /*
1109 * dwork->timer is irqsafe. If del_timer() fails, it's
1110 * guaranteed that the timer is not queued anywhere and not
1111 * running on the local CPU.
1112 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001113 if (likely(del_timer(&dwork->timer)))
1114 return 1;
1115 }
1116
1117 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001118 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1119 return 0;
1120
1121 /*
1122 * The queueing is in progress, or it is already queued. Try to
1123 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1124 */
Tejun Heod565ed62013-01-24 11:01:33 -08001125 pool = get_work_pool(work);
1126 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001127 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001128
Tejun Heod565ed62013-01-24 11:01:33 -08001129 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001130 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001131 * work->data is guaranteed to point to pwq only while the work
1132 * item is queued on pwq->wq, and both updating work->data to point
1133 * to pwq on queueing and to pool on dequeueing are done under
1134 * pwq->pool->lock. This in turn guarantees that, if work->data
1135 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001136 * item is currently queued on that pool.
1137 */
Tejun Heo112202d2013-02-13 19:29:12 -08001138 pwq = get_work_pwq(work);
1139 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001140 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001141
Tejun Heo16062832013-02-06 18:04:53 -08001142 /*
1143 * A delayed work item cannot be grabbed directly because
1144 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001145 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001146 * management later on and cause stall. Make sure the work
1147 * item is activated before grabbing.
1148 */
1149 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001150 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001151
Tejun Heo16062832013-02-06 18:04:53 -08001152 list_del_init(&work->entry);
Tejun Heo112202d2013-02-13 19:29:12 -08001153 pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001154
Tejun Heo112202d2013-02-13 19:29:12 -08001155 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001156 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001157
Tejun Heo16062832013-02-06 18:04:53 -08001158 spin_unlock(&pool->lock);
1159 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001160 }
Tejun Heod565ed62013-01-24 11:01:33 -08001161 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001162fail:
1163 local_irq_restore(*flags);
1164 if (work_is_canceling(work))
1165 return -ENOENT;
1166 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001167 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001168}
1169
1170/**
Tejun Heo706026c2013-01-24 11:01:34 -08001171 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001172 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001173 * @work: work to insert
1174 * @head: insertion point
1175 * @extra_flags: extra WORK_STRUCT_* flags to set
1176 *
Tejun Heo112202d2013-02-13 19:29:12 -08001177 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001178 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001179 *
1180 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001181 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001182 */
Tejun Heo112202d2013-02-13 19:29:12 -08001183static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1184 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001185{
Tejun Heo112202d2013-02-13 19:29:12 -08001186 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001187
Tejun Heo4690c4a2010-06-29 10:07:10 +02001188 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001189 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001190 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001191 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001192
1193 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001194 * Ensure either wq_worker_sleeping() sees the above
1195 * list_add_tail() or we see zero nr_running to avoid workers lying
1196 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001197 */
1198 smp_mb();
1199
Tejun Heo63d95a92012-07-12 14:46:37 -07001200 if (__need_more_worker(pool))
1201 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001202}
1203
Tejun Heoc8efcc22010-12-20 19:32:04 +01001204/*
1205 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001206 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001207 */
1208static bool is_chained_work(struct workqueue_struct *wq)
1209{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001210 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001211
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001212 worker = current_wq_worker();
1213 /*
1214 * Return %true iff I'm a worker execuing a work item on @wq. If
1215 * I'm @worker, it's safe to dereference it without locking.
1216 */
Tejun Heo112202d2013-02-13 19:29:12 -08001217 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001218}
1219
Tejun Heod84ff052013-03-12 11:29:59 -07001220static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 struct work_struct *work)
1222{
Tejun Heo112202d2013-02-13 19:29:12 -08001223 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001224 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001225 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001226 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001227 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001228
1229 /*
1230 * While a work item is PENDING && off queue, a task trying to
1231 * steal the PENDING will busy-loop waiting for it to either get
1232 * queued or lose PENDING. Grabbing PENDING and queueing should
1233 * happen with IRQ disabled.
1234 */
1235 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001237 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001238
Tejun Heoc8efcc22010-12-20 19:32:04 +01001239 /* if dying, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001240 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001241 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001242 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001243retry:
Tejun Heoc9178082013-03-12 11:30:04 -07001244 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001245 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo57469822012-08-03 10:30:45 -07001246 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001247 cpu = raw_smp_processor_id();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001248 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heoc9178082013-03-12 11:30:04 -07001249 } else {
1250 pwq = first_pwq(wq);
1251 }
Tejun Heodbf25762012-08-20 14:51:23 -07001252
Tejun Heoc9178082013-03-12 11:30:04 -07001253 /*
1254 * If @work was previously on a different pool, it might still be
1255 * running there, in which case the work needs to be queued on that
1256 * pool to guarantee non-reentrancy.
1257 */
1258 last_pool = get_work_pool(work);
1259 if (last_pool && last_pool != pwq->pool) {
1260 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001261
Tejun Heoc9178082013-03-12 11:30:04 -07001262 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001263
Tejun Heoc9178082013-03-12 11:30:04 -07001264 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001265
Tejun Heoc9178082013-03-12 11:30:04 -07001266 if (worker && worker->current_pwq->wq == wq) {
1267 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001268 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001269 /* meh... not running there, queue here */
1270 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001271 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001272 }
Tejun Heof3421792010-07-02 10:03:51 +02001273 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001274 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001275 }
1276
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001277 /*
1278 * pwq is determined and locked. For unbound pools, we could have
1279 * raced with pwq release and it could already be dead. If its
1280 * refcnt is zero, repeat pwq selection. Note that pwqs never die
1281 * without another pwq replacing it as the first pwq or while a
1282 * work item is executing on it, so the retying is guaranteed to
1283 * make forward-progress.
1284 */
1285 if (unlikely(!pwq->refcnt)) {
1286 if (wq->flags & WQ_UNBOUND) {
1287 spin_unlock(&pwq->pool->lock);
1288 cpu_relax();
1289 goto retry;
1290 }
1291 /* oops */
1292 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1293 wq->name, cpu);
1294 }
1295
Tejun Heo112202d2013-02-13 19:29:12 -08001296 /* pwq determined, queue */
1297 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001298
Dan Carpenterf5b25522012-04-13 22:06:58 +03001299 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001300 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001301 return;
1302 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001303
Tejun Heo112202d2013-02-13 19:29:12 -08001304 pwq->nr_in_flight[pwq->work_color]++;
1305 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001306
Tejun Heo112202d2013-02-13 19:29:12 -08001307 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001308 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001309 pwq->nr_active++;
1310 worklist = &pwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001311 } else {
1312 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001313 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001314 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001315
Tejun Heo112202d2013-02-13 19:29:12 -08001316 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001317
Tejun Heo112202d2013-02-13 19:29:12 -08001318 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319}
1320
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001321/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001322 * queue_work_on - queue work on specific cpu
1323 * @cpu: CPU number to execute work on
1324 * @wq: workqueue to use
1325 * @work: work to queue
1326 *
Tejun Heod4283e92012-08-03 10:30:44 -07001327 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001328 *
1329 * We queue the work to a specific CPU, the caller must ensure it
1330 * can't go away.
1331 */
Tejun Heod4283e92012-08-03 10:30:44 -07001332bool queue_work_on(int cpu, struct workqueue_struct *wq,
1333 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001334{
Tejun Heod4283e92012-08-03 10:30:44 -07001335 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001336 unsigned long flags;
1337
1338 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001339
Tejun Heo22df02b2010-06-29 10:07:10 +02001340 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001341 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001342 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001343 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001344
1345 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001346 return ret;
1347}
1348EXPORT_SYMBOL_GPL(queue_work_on);
1349
Tejun Heod8e794d2012-08-03 10:30:45 -07001350void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351{
David Howells52bad642006-11-22 14:54:01 +00001352 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001354 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001355 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001357EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001359static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1360 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001362 struct timer_list *timer = &dwork->timer;
1363 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001365 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1366 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001367 WARN_ON_ONCE(timer_pending(timer));
1368 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001369
Tejun Heo8852aac2012-12-01 16:23:42 -08001370 /*
1371 * If @delay is 0, queue @dwork->work immediately. This is for
1372 * both optimization and correctness. The earliest @timer can
1373 * expire is on the closest next tick and delayed_work users depend
1374 * on that there's no such delay when @delay is 0.
1375 */
1376 if (!delay) {
1377 __queue_work(cpu, wq, &dwork->work);
1378 return;
1379 }
1380
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001381 timer_stats_timer_set_start_info(&dwork->timer);
1382
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001383 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001384 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001385 timer->expires = jiffies + delay;
1386
1387 if (unlikely(cpu != WORK_CPU_UNBOUND))
1388 add_timer_on(timer, cpu);
1389 else
1390 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391}
1392
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001393/**
1394 * queue_delayed_work_on - queue work on specific CPU after delay
1395 * @cpu: CPU number to execute work on
1396 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001397 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001398 * @delay: number of jiffies to wait before queueing
1399 *
Tejun Heo715f1302012-08-03 10:30:46 -07001400 * Returns %false if @work was already on a queue, %true otherwise. If
1401 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1402 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001403 */
Tejun Heod4283e92012-08-03 10:30:44 -07001404bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1405 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001406{
David Howells52bad642006-11-22 14:54:01 +00001407 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001408 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001409 unsigned long flags;
1410
1411 /* read the comment in __queue_work() */
1412 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001413
Tejun Heo22df02b2010-06-29 10:07:10 +02001414 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001415 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001416 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001417 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001418
1419 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001420 return ret;
1421}
Dave Jonesae90dd52006-06-30 01:40:45 -04001422EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423
Tejun Heoc8e55f32010-06-29 10:07:12 +02001424/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001425 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1426 * @cpu: CPU number to execute work on
1427 * @wq: workqueue to use
1428 * @dwork: work to queue
1429 * @delay: number of jiffies to wait before queueing
1430 *
1431 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1432 * modify @dwork's timer so that it expires after @delay. If @delay is
1433 * zero, @work is guaranteed to be scheduled immediately regardless of its
1434 * current state.
1435 *
1436 * Returns %false if @dwork was idle and queued, %true if @dwork was
1437 * pending and its timer was modified.
1438 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001439 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001440 * See try_to_grab_pending() for details.
1441 */
1442bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1443 struct delayed_work *dwork, unsigned long delay)
1444{
1445 unsigned long flags;
1446 int ret;
1447
1448 do {
1449 ret = try_to_grab_pending(&dwork->work, true, &flags);
1450 } while (unlikely(ret == -EAGAIN));
1451
1452 if (likely(ret >= 0)) {
1453 __queue_delayed_work(cpu, wq, dwork, delay);
1454 local_irq_restore(flags);
1455 }
1456
1457 /* -ENOENT from try_to_grab_pending() becomes %true */
1458 return ret;
1459}
1460EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1461
1462/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001463 * worker_enter_idle - enter idle state
1464 * @worker: worker which is entering idle state
1465 *
1466 * @worker is entering idle state. Update stats and idle timer if
1467 * necessary.
1468 *
1469 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001470 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001471 */
1472static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001474 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475
Tejun Heo6183c002013-03-12 11:29:57 -07001476 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1477 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1478 (worker->hentry.next || worker->hentry.pprev)))
1479 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480
Tejun Heocb444762010-07-02 10:03:50 +02001481 /* can't use worker_set_flags(), also called from start_worker() */
1482 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001483 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001484 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001485
Tejun Heoc8e55f32010-06-29 10:07:12 +02001486 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001487 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001488
Tejun Heo628c78e2012-07-17 12:39:27 -07001489 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1490 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001491
Tejun Heo544ecf32012-05-14 15:04:50 -07001492 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001493 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001494 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001495 * nr_running, the warning may trigger spuriously. Check iff
1496 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001497 */
Tejun Heo24647572013-01-24 11:01:33 -08001498 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001499 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001500 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501}
1502
Tejun Heoc8e55f32010-06-29 10:07:12 +02001503/**
1504 * worker_leave_idle - leave idle state
1505 * @worker: worker which is leaving idle state
1506 *
1507 * @worker is leaving idle state. Update stats.
1508 *
1509 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001510 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001511 */
1512static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001514 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
Tejun Heo6183c002013-03-12 11:29:57 -07001516 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1517 return;
Tejun Heod302f012010-06-29 10:07:13 +02001518 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001519 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001520 list_del_init(&worker->entry);
1521}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522
Tejun Heoe22bee72010-06-29 10:07:14 +02001523/**
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001524 * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it
1525 * @pool: target worker_pool
1526 *
1527 * Bind %current to the cpu of @pool if it is associated and lock @pool.
Tejun Heoe22bee72010-06-29 10:07:14 +02001528 *
1529 * Works which are scheduled while the cpu is online must at least be
1530 * scheduled to a worker which is bound to the cpu so that if they are
1531 * flushed from cpu callbacks while cpu is going down, they are
1532 * guaranteed to execute on the cpu.
1533 *
Lai Jiangshanf5faa072013-02-19 12:17:02 -08001534 * This function is to be used by unbound workers and rescuers to bind
Tejun Heoe22bee72010-06-29 10:07:14 +02001535 * themselves to the target cpu and may race with cpu going down or
1536 * coming online. kthread_bind() can't be used because it may put the
1537 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
Tejun Heo706026c2013-01-24 11:01:34 -08001538 * verbatim as it's best effort and blocking and pool may be
Tejun Heoe22bee72010-06-29 10:07:14 +02001539 * [dis]associated in the meantime.
1540 *
Tejun Heo706026c2013-01-24 11:01:34 -08001541 * This function tries set_cpus_allowed() and locks pool and verifies the
Tejun Heo24647572013-01-24 11:01:33 -08001542 * binding against %POOL_DISASSOCIATED which is set during
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001543 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1544 * enters idle state or fetches works without dropping lock, it can
1545 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001546 *
1547 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001548 * Might sleep. Called without any lock but returns with pool->lock
Tejun Heoe22bee72010-06-29 10:07:14 +02001549 * held.
1550 *
1551 * RETURNS:
Tejun Heo706026c2013-01-24 11:01:34 -08001552 * %true if the associated pool is online (@worker is successfully
Tejun Heoe22bee72010-06-29 10:07:14 +02001553 * bound), %false if offline.
1554 */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001555static bool worker_maybe_bind_and_lock(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001556__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001557{
Tejun Heoe22bee72010-06-29 10:07:14 +02001558 while (true) {
1559 /*
1560 * The following call may fail, succeed or succeed
1561 * without actually migrating the task to the cpu if
1562 * it races with cpu hotunplug operation. Verify
Tejun Heo24647572013-01-24 11:01:33 -08001563 * against POOL_DISASSOCIATED.
Tejun Heoe22bee72010-06-29 10:07:14 +02001564 */
Tejun Heo24647572013-01-24 11:01:33 -08001565 if (!(pool->flags & POOL_DISASSOCIATED))
Tejun Heo7a4e3442013-03-12 11:30:00 -07001566 set_cpus_allowed_ptr(current, pool->attrs->cpumask);
Oleg Nesterov85f41862007-05-09 02:34:20 -07001567
Tejun Heod565ed62013-01-24 11:01:33 -08001568 spin_lock_irq(&pool->lock);
Tejun Heo24647572013-01-24 11:01:33 -08001569 if (pool->flags & POOL_DISASSOCIATED)
Tejun Heoe22bee72010-06-29 10:07:14 +02001570 return false;
Lai Jiangshanf5faa072013-02-19 12:17:02 -08001571 if (task_cpu(current) == pool->cpu &&
Tejun Heo7a4e3442013-03-12 11:30:00 -07001572 cpumask_equal(&current->cpus_allowed, pool->attrs->cpumask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001573 return true;
Tejun Heod565ed62013-01-24 11:01:33 -08001574 spin_unlock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001575
Tejun Heo5035b202011-04-29 18:08:37 +02001576 /*
1577 * We've raced with CPU hot[un]plug. Give it a breather
1578 * and retry migration. cond_resched() is required here;
1579 * otherwise, we might deadlock against cpu_stop trying to
1580 * bring down the CPU on non-preemptive kernel.
1581 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001582 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001583 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001584 }
1585}
1586
1587/*
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001588 * Rebind an idle @worker to its CPU. worker_thread() will test
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001589 * list_empty(@worker->entry) before leaving idle and call this function.
Tejun Heo25511a42012-07-17 12:39:27 -07001590 */
1591static void idle_worker_rebind(struct worker *worker)
1592{
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001593 /* CPU may go down again inbetween, clear UNBOUND only on success */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001594 if (worker_maybe_bind_and_lock(worker->pool))
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001595 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heo25511a42012-07-17 12:39:27 -07001596
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001597 /* rebind complete, become available again */
1598 list_add(&worker->entry, &worker->pool->idle_list);
Tejun Heod565ed62013-01-24 11:01:33 -08001599 spin_unlock_irq(&worker->pool->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07001600}
1601
1602/*
1603 * Function for @worker->rebind.work used to rebind unbound busy workers to
Tejun Heo403c8212012-07-17 12:39:27 -07001604 * the associated cpu which is coming back online. This is scheduled by
1605 * cpu up but can race with other cpu hotplug operations and may be
1606 * executed twice without intervening cpu down.
Tejun Heoe22bee72010-06-29 10:07:14 +02001607 */
Tejun Heo25511a42012-07-17 12:39:27 -07001608static void busy_worker_rebind_fn(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001609{
1610 struct worker *worker = container_of(work, struct worker, rebind_work);
Tejun Heoe22bee72010-06-29 10:07:14 +02001611
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001612 if (worker_maybe_bind_and_lock(worker->pool))
Lai Jiangshaneab6d822012-09-18 09:59:22 -07001613 worker_clr_flags(worker, WORKER_UNBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02001614
Tejun Heod565ed62013-01-24 11:01:33 -08001615 spin_unlock_irq(&worker->pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001616}
1617
Tejun Heo25511a42012-07-17 12:39:27 -07001618/**
Tejun Heo94cf58b2013-01-24 11:01:33 -08001619 * rebind_workers - rebind all workers of a pool to the associated CPU
1620 * @pool: pool of interest
Tejun Heo25511a42012-07-17 12:39:27 -07001621 *
Tejun Heo94cf58b2013-01-24 11:01:33 -08001622 * @pool->cpu is coming online. Rebind all workers to the CPU. Rebinding
Tejun Heo25511a42012-07-17 12:39:27 -07001623 * is different for idle and busy ones.
1624 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001625 * Idle ones will be removed from the idle_list and woken up. They will
1626 * add themselves back after completing rebind. This ensures that the
1627 * idle_list doesn't contain any unbound workers when re-bound busy workers
1628 * try to perform local wake-ups for concurrency management.
Tejun Heo25511a42012-07-17 12:39:27 -07001629 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001630 * Busy workers can rebind after they finish their current work items.
1631 * Queueing the rebind work item at the head of the scheduled list is
1632 * enough. Note that nr_running will be properly bumped as busy workers
1633 * rebind.
Tejun Heo25511a42012-07-17 12:39:27 -07001634 *
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001635 * On return, all non-manager workers are scheduled for rebind - see
1636 * manage_workers() for the manager special case. Any idle worker
1637 * including the manager will not appear on @idle_list until rebind is
1638 * complete, making local wake-ups safe.
Tejun Heo25511a42012-07-17 12:39:27 -07001639 */
Tejun Heo94cf58b2013-01-24 11:01:33 -08001640static void rebind_workers(struct worker_pool *pool)
Tejun Heo25511a42012-07-17 12:39:27 -07001641{
Lai Jiangshanea1abd62012-09-18 09:59:22 -07001642 struct worker *worker, *n;
Tejun Heo25511a42012-07-17 12:39:27 -07001643 int i;
1644
Tejun Heobc3a1af2013-03-13 19:47:39 -07001645 lockdep_assert_held(&pool->manager_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08001646 lockdep_assert_held(&pool->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07001647
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07001648 /* dequeue and kick idle ones */
Tejun Heo94cf58b2013-01-24 11:01:33 -08001649 list_for_each_entry_safe(worker, n, &pool->idle_list, entry) {
1650 /*
1651 * idle workers should be off @pool->idle_list until rebind
1652 * is complete to avoid receiving premature local wake-ups.
1653 */
1654 list_del_init(&worker->entry);
Lai Jiangshan96e65302012-09-02 00:28:19 +08001655
Tejun Heo94cf58b2013-01-24 11:01:33 -08001656 /*
1657 * worker_thread() will see the above dequeuing and call
1658 * idle_worker_rebind().
1659 */
1660 wake_up_process(worker->task);
1661 }
Tejun Heo25511a42012-07-17 12:39:27 -07001662
Tejun Heo94cf58b2013-01-24 11:01:33 -08001663 /* rebind busy workers */
Sasha Levinb67bfe02013-02-27 17:06:00 -08001664 for_each_busy_worker(worker, i, pool) {
Tejun Heo94cf58b2013-01-24 11:01:33 -08001665 struct work_struct *rebind_work = &worker->rebind_work;
1666 struct workqueue_struct *wq;
Tejun Heo25511a42012-07-17 12:39:27 -07001667
Tejun Heo94cf58b2013-01-24 11:01:33 -08001668 if (test_and_set_bit(WORK_STRUCT_PENDING_BIT,
1669 work_data_bits(rebind_work)))
1670 continue;
Tejun Heo25511a42012-07-17 12:39:27 -07001671
Tejun Heo94cf58b2013-01-24 11:01:33 -08001672 debug_work_activate(rebind_work);
Tejun Heo90beca52012-09-04 23:12:33 -07001673
Tejun Heo94cf58b2013-01-24 11:01:33 -08001674 /*
1675 * wq doesn't really matter but let's keep @worker->pool
Tejun Heo112202d2013-02-13 19:29:12 -08001676 * and @pwq->pool consistent for sanity.
Tejun Heo94cf58b2013-01-24 11:01:33 -08001677 */
Tejun Heo7a4e3442013-03-12 11:30:00 -07001678 if (worker->pool->attrs->nice < 0)
Tejun Heo94cf58b2013-01-24 11:01:33 -08001679 wq = system_highpri_wq;
1680 else
1681 wq = system_wq;
Tejun Heoec588152012-09-04 23:16:32 -07001682
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001683 insert_work(per_cpu_ptr(wq->cpu_pwqs, pool->cpu), rebind_work,
Tejun Heo94cf58b2013-01-24 11:01:33 -08001684 worker->scheduled.next,
1685 work_color_to_flags(WORK_NO_COLOR));
Tejun Heoec588152012-09-04 23:16:32 -07001686 }
Tejun Heo25511a42012-07-17 12:39:27 -07001687}
1688
Tejun Heoc34056a2010-06-29 10:07:11 +02001689static struct worker *alloc_worker(void)
1690{
1691 struct worker *worker;
1692
1693 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001694 if (worker) {
1695 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001696 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heo25511a42012-07-17 12:39:27 -07001697 INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn);
Tejun Heoe22bee72010-06-29 10:07:14 +02001698 /* on creation a worker is in !idle && prep state */
1699 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001700 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001701 return worker;
1702}
1703
1704/**
1705 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001706 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001707 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001708 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001709 * can be started by calling start_worker() or destroyed using
1710 * destroy_worker().
1711 *
1712 * CONTEXT:
1713 * Might sleep. Does GFP_KERNEL allocations.
1714 *
1715 * RETURNS:
1716 * Pointer to the newly created worker.
1717 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001718static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001719{
Tejun Heo7a4e3442013-03-12 11:30:00 -07001720 const char *pri = pool->attrs->nice < 0 ? "H" : "";
Tejun Heoc34056a2010-06-29 10:07:11 +02001721 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001722 int id = -1;
Tejun Heoc34056a2010-06-29 10:07:11 +02001723
Tejun Heocd549682013-03-13 19:47:39 -07001724 lockdep_assert_held(&pool->manager_mutex);
1725
Tejun Heod565ed62013-01-24 11:01:33 -08001726 spin_lock_irq(&pool->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001727 while (ida_get_new(&pool->worker_ida, &id)) {
Tejun Heod565ed62013-01-24 11:01:33 -08001728 spin_unlock_irq(&pool->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001729 if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL))
Tejun Heoc34056a2010-06-29 10:07:11 +02001730 goto fail;
Tejun Heod565ed62013-01-24 11:01:33 -08001731 spin_lock_irq(&pool->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001732 }
Tejun Heod565ed62013-01-24 11:01:33 -08001733 spin_unlock_irq(&pool->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001734
1735 worker = alloc_worker();
1736 if (!worker)
1737 goto fail;
1738
Tejun Heobd7bdd42012-07-12 14:46:37 -07001739 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001740 worker->id = id;
1741
Tejun Heo29c91e92013-03-12 11:30:03 -07001742 if (pool->cpu >= 0)
Eric Dumazet94dcf292011-03-22 16:30:45 -07001743 worker->task = kthread_create_on_node(worker_thread,
Tejun Heoec22ca52013-01-24 11:01:33 -08001744 worker, cpu_to_node(pool->cpu),
Tejun Heod84ff052013-03-12 11:29:59 -07001745 "kworker/%d:%d%s", pool->cpu, id, pri);
Tejun Heof3421792010-07-02 10:03:51 +02001746 else
1747 worker->task = kthread_create(worker_thread, worker,
Tejun Heoac6104c2013-03-12 11:30:03 -07001748 "kworker/u%d:%d%s",
1749 pool->id, id, pri);
Tejun Heoc34056a2010-06-29 10:07:11 +02001750 if (IS_ERR(worker->task))
1751 goto fail;
1752
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001753 /*
1754 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1755 * online CPUs. It'll be re-applied when any of the CPUs come up.
1756 */
Tejun Heo7a4e3442013-03-12 11:30:00 -07001757 set_user_nice(worker->task, pool->attrs->nice);
1758 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
Tejun Heo32704762012-07-13 22:16:45 -07001759
Tejun Heo14a40ff2013-03-19 13:45:20 -07001760 /* prevent userland from meddling with cpumask of workqueue workers */
1761 worker->task->flags |= PF_NO_SETAFFINITY;
Tejun Heo7a4e3442013-03-12 11:30:00 -07001762
1763 /*
1764 * The caller is responsible for ensuring %POOL_DISASSOCIATED
1765 * remains stable across this function. See the comments above the
1766 * flag definition for details.
1767 */
1768 if (pool->flags & POOL_DISASSOCIATED)
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001769 worker->flags |= WORKER_UNBOUND;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001770
Tejun Heoc34056a2010-06-29 10:07:11 +02001771 return worker;
1772fail:
1773 if (id >= 0) {
Tejun Heod565ed62013-01-24 11:01:33 -08001774 spin_lock_irq(&pool->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001775 ida_remove(&pool->worker_ida, id);
Tejun Heod565ed62013-01-24 11:01:33 -08001776 spin_unlock_irq(&pool->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001777 }
1778 kfree(worker);
1779 return NULL;
1780}
1781
1782/**
1783 * start_worker - start a newly created worker
1784 * @worker: worker to start
1785 *
Tejun Heo706026c2013-01-24 11:01:34 -08001786 * Make the pool aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001787 *
1788 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001789 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001790 */
1791static void start_worker(struct worker *worker)
1792{
Tejun Heocb444762010-07-02 10:03:50 +02001793 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001794 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001795 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001796 wake_up_process(worker->task);
1797}
1798
1799/**
Tejun Heoebf44d12013-03-13 19:47:39 -07001800 * create_and_start_worker - create and start a worker for a pool
1801 * @pool: the target pool
1802 *
Tejun Heocd549682013-03-13 19:47:39 -07001803 * Grab the managership of @pool and create and start a new worker for it.
Tejun Heoebf44d12013-03-13 19:47:39 -07001804 */
1805static int create_and_start_worker(struct worker_pool *pool)
1806{
1807 struct worker *worker;
1808
Tejun Heocd549682013-03-13 19:47:39 -07001809 mutex_lock(&pool->manager_mutex);
1810
Tejun Heoebf44d12013-03-13 19:47:39 -07001811 worker = create_worker(pool);
1812 if (worker) {
1813 spin_lock_irq(&pool->lock);
1814 start_worker(worker);
1815 spin_unlock_irq(&pool->lock);
1816 }
1817
Tejun Heocd549682013-03-13 19:47:39 -07001818 mutex_unlock(&pool->manager_mutex);
1819
Tejun Heoebf44d12013-03-13 19:47:39 -07001820 return worker ? 0 : -ENOMEM;
1821}
1822
1823/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001824 * destroy_worker - destroy a workqueue worker
1825 * @worker: worker to be destroyed
1826 *
Tejun Heo706026c2013-01-24 11:01:34 -08001827 * Destroy @worker and adjust @pool stats accordingly.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001828 *
1829 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001830 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001831 */
1832static void destroy_worker(struct worker *worker)
1833{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001834 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001835 int id = worker->id;
1836
Tejun Heocd549682013-03-13 19:47:39 -07001837 lockdep_assert_held(&pool->manager_mutex);
1838 lockdep_assert_held(&pool->lock);
1839
Tejun Heoc34056a2010-06-29 10:07:11 +02001840 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001841 if (WARN_ON(worker->current_work) ||
1842 WARN_ON(!list_empty(&worker->scheduled)))
1843 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001844
Tejun Heoc8e55f32010-06-29 10:07:12 +02001845 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001846 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001847 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001848 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001849
1850 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001851 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001852
Tejun Heod565ed62013-01-24 11:01:33 -08001853 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001854
Tejun Heoc34056a2010-06-29 10:07:11 +02001855 kthread_stop(worker->task);
1856 kfree(worker);
1857
Tejun Heod565ed62013-01-24 11:01:33 -08001858 spin_lock_irq(&pool->lock);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001859 ida_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001860}
1861
Tejun Heo63d95a92012-07-12 14:46:37 -07001862static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001863{
Tejun Heo63d95a92012-07-12 14:46:37 -07001864 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001865
Tejun Heod565ed62013-01-24 11:01:33 -08001866 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001867
Tejun Heo63d95a92012-07-12 14:46:37 -07001868 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001869 struct worker *worker;
1870 unsigned long expires;
1871
1872 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001873 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001874 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1875
1876 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001877 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001878 else {
1879 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001880 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001881 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001882 }
1883 }
1884
Tejun Heod565ed62013-01-24 11:01:33 -08001885 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001886}
1887
Tejun Heo493a1722013-03-12 11:29:59 -07001888static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001889{
Tejun Heo112202d2013-02-13 19:29:12 -08001890 struct pool_workqueue *pwq = get_work_pwq(work);
1891 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001892
Tejun Heo2e109a22013-03-13 19:47:40 -07001893 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001894
Tejun Heo493008a2013-03-12 11:30:03 -07001895 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001896 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001897
1898 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001899 if (list_empty(&pwq->mayday_node)) {
1900 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001901 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001902 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001903}
1904
Tejun Heo706026c2013-01-24 11:01:34 -08001905static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001906{
Tejun Heo63d95a92012-07-12 14:46:37 -07001907 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001908 struct work_struct *work;
1909
Tejun Heo2e109a22013-03-13 19:47:40 -07001910 spin_lock_irq(&wq_mayday_lock); /* for wq->maydays */
Tejun Heo493a1722013-03-12 11:29:59 -07001911 spin_lock(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001912
Tejun Heo63d95a92012-07-12 14:46:37 -07001913 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001914 /*
1915 * We've been trying to create a new worker but
1916 * haven't been successful. We might be hitting an
1917 * allocation deadlock. Send distress signals to
1918 * rescuers.
1919 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001920 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001921 send_mayday(work);
1922 }
1923
Tejun Heo493a1722013-03-12 11:29:59 -07001924 spin_unlock(&pool->lock);
Tejun Heo2e109a22013-03-13 19:47:40 -07001925 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001926
Tejun Heo63d95a92012-07-12 14:46:37 -07001927 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001928}
1929
1930/**
1931 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001932 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001933 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001934 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001935 * have at least one idle worker on return from this function. If
1936 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001937 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001938 * possible allocation deadlock.
1939 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001940 * On return, need_to_create_worker() is guaranteed to be %false and
1941 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001942 *
1943 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001944 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001945 * multiple times. Does GFP_KERNEL allocations. Called only from
1946 * manager.
1947 *
1948 * RETURNS:
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001949 * %false if no action was taken and pool->lock stayed locked, %true
Tejun Heoe22bee72010-06-29 10:07:14 +02001950 * otherwise.
1951 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001952static bool maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001953__releases(&pool->lock)
1954__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001955{
Tejun Heo63d95a92012-07-12 14:46:37 -07001956 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001957 return false;
1958restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001959 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001960
Tejun Heoe22bee72010-06-29 10:07:14 +02001961 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001962 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001963
1964 while (true) {
1965 struct worker *worker;
1966
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001967 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001968 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001969 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001970 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001971 start_worker(worker);
Tejun Heo6183c002013-03-12 11:29:57 -07001972 if (WARN_ON_ONCE(need_to_create_worker(pool)))
1973 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001974 return true;
1975 }
1976
Tejun Heo63d95a92012-07-12 14:46:37 -07001977 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001978 break;
1979
Tejun Heoe22bee72010-06-29 10:07:14 +02001980 __set_current_state(TASK_INTERRUPTIBLE);
1981 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001982
Tejun Heo63d95a92012-07-12 14:46:37 -07001983 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001984 break;
1985 }
1986
Tejun Heo63d95a92012-07-12 14:46:37 -07001987 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001988 spin_lock_irq(&pool->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07001989 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001990 goto restart;
1991 return true;
1992}
1993
1994/**
1995 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07001996 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02001997 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001998 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02001999 * IDLE_WORKER_TIMEOUT.
2000 *
2001 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08002002 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002003 * multiple times. Called only from manager.
2004 *
2005 * RETURNS:
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002006 * %false if no action was taken and pool->lock stayed locked, %true
Tejun Heoe22bee72010-06-29 10:07:14 +02002007 * otherwise.
2008 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002009static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02002010{
2011 bool ret = false;
2012
Tejun Heo63d95a92012-07-12 14:46:37 -07002013 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02002014 struct worker *worker;
2015 unsigned long expires;
2016
Tejun Heo63d95a92012-07-12 14:46:37 -07002017 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02002018 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
2019
2020 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07002021 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02002022 break;
2023 }
2024
2025 destroy_worker(worker);
2026 ret = true;
2027 }
2028
2029 return ret;
2030}
2031
2032/**
2033 * manage_workers - manage worker pool
2034 * @worker: self
2035 *
Tejun Heo706026c2013-01-24 11:01:34 -08002036 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02002037 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08002038 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02002039 *
2040 * The caller can safely start processing works on false return. On
2041 * true return, it's guaranteed that need_to_create_worker() is false
2042 * and may_start_working() is true.
2043 *
2044 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002045 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02002046 * multiple times. Does GFP_KERNEL allocations.
2047 *
2048 * RETURNS:
Tejun Heod565ed62013-01-24 11:01:33 -08002049 * spin_lock_irq(pool->lock) which may be released and regrabbed
2050 * multiple times. Does GFP_KERNEL allocations.
Tejun Heoe22bee72010-06-29 10:07:14 +02002051 */
2052static bool manage_workers(struct worker *worker)
2053{
Tejun Heo63d95a92012-07-12 14:46:37 -07002054 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002055 bool ret = false;
2056
Tejun Heobc3a1af2013-03-13 19:47:39 -07002057 /*
2058 * Managership is governed by two mutexes - manager_arb and
2059 * manager_mutex. manager_arb handles arbitration of manager role.
2060 * Anyone who successfully grabs manager_arb wins the arbitration
2061 * and becomes the manager. mutex_trylock() on pool->manager_arb
2062 * failure while holding pool->lock reliably indicates that someone
2063 * else is managing the pool and the worker which failed trylock
2064 * can proceed to executing work items. This means that anyone
2065 * grabbing manager_arb is responsible for actually performing
2066 * manager duties. If manager_arb is grabbed and released without
2067 * actual management, the pool may stall indefinitely.
2068 *
2069 * manager_mutex is used for exclusion of actual management
2070 * operations. The holder of manager_mutex can be sure that none
2071 * of management operations, including creation and destruction of
2072 * workers, won't take place until the mutex is released. Because
2073 * manager_mutex doesn't interfere with manager role arbitration,
2074 * it is guaranteed that the pool's management, while may be
2075 * delayed, won't be disturbed by someone else grabbing
2076 * manager_mutex.
2077 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07002078 if (!mutex_trylock(&pool->manager_arb))
Tejun Heoe22bee72010-06-29 10:07:14 +02002079 return ret;
2080
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002081 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07002082 * With manager arbitration won, manager_mutex would be free in
2083 * most cases. trylock first without dropping @pool->lock.
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002084 */
Tejun Heobc3a1af2013-03-13 19:47:39 -07002085 if (unlikely(!mutex_trylock(&pool->manager_mutex))) {
Tejun Heod565ed62013-01-24 11:01:33 -08002086 spin_unlock_irq(&pool->lock);
Tejun Heobc3a1af2013-03-13 19:47:39 -07002087 mutex_lock(&pool->manager_mutex);
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002088 /*
2089 * CPU hotplug could have happened while we were waiting
Lai Jiangshanb2eb83d2012-09-18 09:59:23 -07002090 * for assoc_mutex. Hotplug itself can't handle us
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002091 * because manager isn't either on idle or busy list, and
Tejun Heo706026c2013-01-24 11:01:34 -08002092 * @pool's state and ours could have deviated.
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002093 *
Tejun Heobc3a1af2013-03-13 19:47:39 -07002094 * As hotplug is now excluded via manager_mutex, we can
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002095 * simply try to bind. It will succeed or fail depending
Tejun Heo706026c2013-01-24 11:01:34 -08002096 * on @pool's current state. Try it and adjust
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002097 * %WORKER_UNBOUND accordingly.
2098 */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08002099 if (worker_maybe_bind_and_lock(pool))
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002100 worker->flags &= ~WORKER_UNBOUND;
2101 else
2102 worker->flags |= WORKER_UNBOUND;
2103
2104 ret = true;
2105 }
2106
Tejun Heo11ebea52012-07-12 14:46:37 -07002107 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002108
2109 /*
2110 * Destroy and then create so that may_start_working() is true
2111 * on return.
2112 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002113 ret |= maybe_destroy_workers(pool);
2114 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002115
Tejun Heobc3a1af2013-03-13 19:47:39 -07002116 mutex_unlock(&pool->manager_mutex);
Tejun Heo34a06bd2013-03-12 11:30:00 -07002117 mutex_unlock(&pool->manager_arb);
Tejun Heoe22bee72010-06-29 10:07:14 +02002118 return ret;
2119}
2120
Tejun Heoa62428c2010-06-29 10:07:10 +02002121/**
2122 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002123 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002124 * @work: work to process
2125 *
2126 * Process @work. This function contains all the logics necessary to
2127 * process a single work including synchronization against and
2128 * interaction with other workers on the same cpu, queueing and
2129 * flushing. As long as context requirement is met, any worker can
2130 * call this function to process a work.
2131 *
2132 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002133 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002134 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002135static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002136__releases(&pool->lock)
2137__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002138{
Tejun Heo112202d2013-02-13 19:29:12 -08002139 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002140 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002141 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002142 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002143 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002144#ifdef CONFIG_LOCKDEP
2145 /*
2146 * It is permissible to free the struct work_struct from
2147 * inside the function that is called from it, this we need to
2148 * take into account for lockdep too. To avoid bogus "held
2149 * lock freed" warnings as well as problems when looking into
2150 * work->lockdep_map, make a copy and use that here.
2151 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002152 struct lockdep_map lockdep_map;
2153
2154 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002155#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002156 /*
2157 * Ensure we're on the correct CPU. DISASSOCIATED test is
2158 * necessary to avoid spurious warnings from rescuers servicing the
Tejun Heo24647572013-01-24 11:01:33 -08002159 * unbound or a disassociated pool.
Tejun Heo6fec10a2012-07-22 10:16:34 -07002160 */
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002161 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
Tejun Heo24647572013-01-24 11:01:33 -08002162 !(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002163 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002164
Tejun Heo7e116292010-06-29 10:07:13 +02002165 /*
2166 * A single work shouldn't be executed concurrently by
2167 * multiple workers on a single cpu. Check whether anyone is
2168 * already processing the work. If so, defer the work to the
2169 * currently executing one.
2170 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002171 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002172 if (unlikely(collision)) {
2173 move_linked_works(work, &collision->scheduled, NULL);
2174 return;
2175 }
2176
Tejun Heo8930cab2012-08-03 10:30:45 -07002177 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002178 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002179 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002180 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002181 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002182 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002183 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002184
Tejun Heoa62428c2010-06-29 10:07:10 +02002185 list_del_init(&work->entry);
2186
Tejun Heo649027d2010-06-29 10:07:14 +02002187 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002188 * CPU intensive works don't participate in concurrency
2189 * management. They're the scheduler's responsibility.
2190 */
2191 if (unlikely(cpu_intensive))
2192 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2193
Tejun Heo974271c2012-07-12 14:46:37 -07002194 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002195 * Unbound pool isn't concurrency managed and work items should be
Tejun Heo974271c2012-07-12 14:46:37 -07002196 * executed ASAP. Wake up another worker if necessary.
2197 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002198 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2199 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002200
Tejun Heo8930cab2012-08-03 10:30:45 -07002201 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002202 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002203 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002204 * PENDING and queued state changes happen together while IRQ is
2205 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002206 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002207 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002208
Tejun Heod565ed62013-01-24 11:01:33 -08002209 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002210
Tejun Heo112202d2013-02-13 19:29:12 -08002211 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002212 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002213 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002214 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002215 /*
2216 * While we must be careful to not use "work" after this, the trace
2217 * point will only record its address.
2218 */
2219 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002220 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002221 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002222
2223 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002224 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2225 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002226 current->comm, preempt_count(), task_pid_nr(current),
2227 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002228 debug_show_held_locks(current);
2229 dump_stack();
2230 }
2231
Tejun Heod565ed62013-01-24 11:01:33 -08002232 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002233
Tejun Heofb0e7be2010-06-29 10:07:15 +02002234 /* clear cpu intensive status */
2235 if (unlikely(cpu_intensive))
2236 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2237
Tejun Heoa62428c2010-06-29 10:07:10 +02002238 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002239 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002240 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002241 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002242 worker->current_pwq = NULL;
2243 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002244}
2245
Tejun Heoaffee4b2010-06-29 10:07:12 +02002246/**
2247 * process_scheduled_works - process scheduled works
2248 * @worker: self
2249 *
2250 * Process all scheduled works. Please note that the scheduled list
2251 * may change while processing a work, so this function repeatedly
2252 * fetches a work from the top and executes it.
2253 *
2254 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002255 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002256 * multiple times.
2257 */
2258static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002260 while (!list_empty(&worker->scheduled)) {
2261 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002263 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265}
2266
Tejun Heo4690c4a2010-06-29 10:07:10 +02002267/**
2268 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002269 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002270 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002271 * The worker thread function. All workers belong to a worker_pool -
2272 * either a per-cpu one or dynamic unbound one. These workers process all
2273 * work items regardless of their specific target workqueue. The only
2274 * exception is work items which belong to workqueues with a rescuer which
2275 * will be explained in rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002276 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002277static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278{
Tejun Heoc34056a2010-06-29 10:07:11 +02002279 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002280 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281
Tejun Heoe22bee72010-06-29 10:07:14 +02002282 /* tell the scheduler that this is a workqueue worker */
2283 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002284woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002285 spin_lock_irq(&pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002287 /* we are off idle list if destruction or rebind is requested */
2288 if (unlikely(list_empty(&worker->entry))) {
Tejun Heod565ed62013-01-24 11:01:33 -08002289 spin_unlock_irq(&pool->lock);
Tejun Heo25511a42012-07-17 12:39:27 -07002290
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002291 /* if DIE is set, destruction is requested */
Tejun Heo25511a42012-07-17 12:39:27 -07002292 if (worker->flags & WORKER_DIE) {
2293 worker->task->flags &= ~PF_WQ_WORKER;
2294 return 0;
2295 }
2296
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002297 /* otherwise, rebind */
Tejun Heo25511a42012-07-17 12:39:27 -07002298 idle_worker_rebind(worker);
2299 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300 }
2301
Tejun Heoc8e55f32010-06-29 10:07:12 +02002302 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002303recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002304 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002305 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002306 goto sleep;
2307
2308 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002309 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002310 goto recheck;
2311
Tejun Heoc8e55f32010-06-29 10:07:12 +02002312 /*
2313 * ->scheduled list can only be filled while a worker is
2314 * preparing to process a work or actually processing it.
2315 * Make sure nobody diddled with it while I was sleeping.
2316 */
Tejun Heo6183c002013-03-12 11:29:57 -07002317 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002318
Tejun Heoe22bee72010-06-29 10:07:14 +02002319 /*
2320 * When control reaches this point, we're guaranteed to have
2321 * at least one idle worker or that someone else has already
2322 * assumed the manager role.
2323 */
2324 worker_clr_flags(worker, WORKER_PREP);
2325
2326 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002327 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002328 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002329 struct work_struct, entry);
2330
2331 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2332 /* optimization path, not strictly necessary */
2333 process_one_work(worker, work);
2334 if (unlikely(!list_empty(&worker->scheduled)))
2335 process_scheduled_works(worker);
2336 } else {
2337 move_linked_works(work, &worker->scheduled, NULL);
2338 process_scheduled_works(worker);
2339 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002340 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002341
Tejun Heoe22bee72010-06-29 10:07:14 +02002342 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002343sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002344 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002345 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002346
Tejun Heoc8e55f32010-06-29 10:07:12 +02002347 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002348 * pool->lock is held and there's no work to process and no need to
2349 * manage, sleep. Workers are woken up only while holding
2350 * pool->lock or from local cpu, so setting the current state
2351 * before releasing pool->lock is enough to prevent losing any
2352 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002353 */
2354 worker_enter_idle(worker);
2355 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002356 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002357 schedule();
2358 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359}
2360
Tejun Heoe22bee72010-06-29 10:07:14 +02002361/**
2362 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002363 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002364 *
2365 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002366 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002367 *
Tejun Heo706026c2013-01-24 11:01:34 -08002368 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002369 * worker which uses GFP_KERNEL allocation which has slight chance of
2370 * developing into deadlock if some works currently on the same queue
2371 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2372 * the problem rescuer solves.
2373 *
Tejun Heo706026c2013-01-24 11:01:34 -08002374 * When such condition is possible, the pool summons rescuers of all
2375 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002376 * those works so that forward progress can be guaranteed.
2377 *
2378 * This should happen rarely.
2379 */
Tejun Heo111c2252013-01-17 17:16:24 -08002380static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002381{
Tejun Heo111c2252013-01-17 17:16:24 -08002382 struct worker *rescuer = __rescuer;
2383 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002384 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heoe22bee72010-06-29 10:07:14 +02002385
2386 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002387
2388 /*
2389 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2390 * doesn't participate in concurrency management.
2391 */
2392 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002393repeat:
2394 set_current_state(TASK_INTERRUPTIBLE);
2395
Mike Galbraith412d32e2012-11-28 07:17:18 +01002396 if (kthread_should_stop()) {
2397 __set_current_state(TASK_RUNNING);
Tejun Heo111c2252013-01-17 17:16:24 -08002398 rescuer->task->flags &= ~PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002399 return 0;
Mike Galbraith412d32e2012-11-28 07:17:18 +01002400 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002401
Tejun Heo493a1722013-03-12 11:29:59 -07002402 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002403 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002404
2405 while (!list_empty(&wq->maydays)) {
2406 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2407 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002408 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002409 struct work_struct *work, *n;
2410
2411 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002412 list_del_init(&pwq->mayday_node);
2413
Tejun Heo2e109a22013-03-13 19:47:40 -07002414 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002415
2416 /* migrate to the target cpu if possible */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08002417 worker_maybe_bind_and_lock(pool);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002418 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002419
2420 /*
2421 * Slurp in all works issued via this workqueue and
2422 * process'em.
2423 */
Tejun Heo6183c002013-03-12 11:29:57 -07002424 WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002425 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heo112202d2013-02-13 19:29:12 -08002426 if (get_work_pwq(work) == pwq)
Tejun Heoe22bee72010-06-29 10:07:14 +02002427 move_linked_works(work, scheduled, &n);
2428
2429 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002430
2431 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002432 * Leave this pool. If keep_working() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002433 * regular worker; otherwise, we end up with 0 concurrency
2434 * and stalling the execution.
2435 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002436 if (keep_working(pool))
2437 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002438
Lai Jiangshanb3104102013-02-19 12:17:02 -08002439 rescuer->pool = NULL;
Tejun Heo493a1722013-03-12 11:29:59 -07002440 spin_unlock(&pool->lock);
Tejun Heo2e109a22013-03-13 19:47:40 -07002441 spin_lock(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002442 }
2443
Tejun Heo2e109a22013-03-13 19:47:40 -07002444 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002445
Tejun Heo111c2252013-01-17 17:16:24 -08002446 /* rescuers should never participate in concurrency management */
2447 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002448 schedule();
2449 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450}
2451
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002452struct wq_barrier {
2453 struct work_struct work;
2454 struct completion done;
2455};
2456
2457static void wq_barrier_func(struct work_struct *work)
2458{
2459 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2460 complete(&barr->done);
2461}
2462
Tejun Heo4690c4a2010-06-29 10:07:10 +02002463/**
2464 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002465 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002466 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002467 * @target: target work to attach @barr to
2468 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002469 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002470 * @barr is linked to @target such that @barr is completed only after
2471 * @target finishes execution. Please note that the ordering
2472 * guarantee is observed only with respect to @target and on the local
2473 * cpu.
2474 *
2475 * Currently, a queued barrier can't be canceled. This is because
2476 * try_to_grab_pending() can't determine whether the work to be
2477 * grabbed is at the head of the queue and thus can't clear LINKED
2478 * flag of the previous work while there must be a valid next work
2479 * after a work with LINKED flag set.
2480 *
2481 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002482 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002483 *
2484 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002485 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002486 */
Tejun Heo112202d2013-02-13 19:29:12 -08002487static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002488 struct wq_barrier *barr,
2489 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002490{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002491 struct list_head *head;
2492 unsigned int linked = 0;
2493
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002494 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002495 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002496 * as we know for sure that this will not trigger any of the
2497 * checks and call back into the fixup functions where we
2498 * might deadlock.
2499 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002500 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002501 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002502 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002503
Tejun Heoaffee4b2010-06-29 10:07:12 +02002504 /*
2505 * If @target is currently being executed, schedule the
2506 * barrier to the worker; otherwise, put it after @target.
2507 */
2508 if (worker)
2509 head = worker->scheduled.next;
2510 else {
2511 unsigned long *bits = work_data_bits(target);
2512
2513 head = target->entry.next;
2514 /* there can already be other linked works, inherit and set */
2515 linked = *bits & WORK_STRUCT_LINKED;
2516 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2517 }
2518
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002519 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002520 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002521 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002522}
2523
Tejun Heo73f53c42010-06-29 10:07:11 +02002524/**
Tejun Heo112202d2013-02-13 19:29:12 -08002525 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002526 * @wq: workqueue being flushed
2527 * @flush_color: new flush color, < 0 for no-op
2528 * @work_color: new work color, < 0 for no-op
2529 *
Tejun Heo112202d2013-02-13 19:29:12 -08002530 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002531 *
Tejun Heo112202d2013-02-13 19:29:12 -08002532 * If @flush_color is non-negative, flush_color on all pwqs should be
2533 * -1. If no pwq has in-flight commands at the specified color, all
2534 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2535 * has in flight commands, its pwq->flush_color is set to
2536 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002537 * wakeup logic is armed and %true is returned.
2538 *
2539 * The caller should have initialized @wq->first_flusher prior to
2540 * calling this function with non-negative @flush_color. If
2541 * @flush_color is negative, no flush color update is done and %false
2542 * is returned.
2543 *
Tejun Heo112202d2013-02-13 19:29:12 -08002544 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002545 * work_color which is previous to @work_color and all will be
2546 * advanced to @work_color.
2547 *
2548 * CONTEXT:
2549 * mutex_lock(wq->flush_mutex).
2550 *
2551 * RETURNS:
2552 * %true if @flush_color >= 0 and there's something to flush. %false
2553 * otherwise.
2554 */
Tejun Heo112202d2013-02-13 19:29:12 -08002555static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002556 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557{
Tejun Heo73f53c42010-06-29 10:07:11 +02002558 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002559 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002560
Tejun Heo73f53c42010-06-29 10:07:11 +02002561 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002562 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002563 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002564 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002565
Tejun Heo76af4d92013-03-12 11:30:00 -07002566 local_irq_disable();
2567
Tejun Heo49e3cf42013-03-12 11:29:58 -07002568 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002569 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002570
Tejun Heo76af4d92013-03-12 11:30:00 -07002571 spin_lock(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002572
2573 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002574 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002575
Tejun Heo112202d2013-02-13 19:29:12 -08002576 if (pwq->nr_in_flight[flush_color]) {
2577 pwq->flush_color = flush_color;
2578 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002579 wait = true;
2580 }
2581 }
2582
2583 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002584 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002585 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002586 }
2587
Tejun Heo76af4d92013-03-12 11:30:00 -07002588 spin_unlock(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002589 }
2590
Tejun Heo76af4d92013-03-12 11:30:00 -07002591 local_irq_enable();
2592
Tejun Heo112202d2013-02-13 19:29:12 -08002593 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002594 complete(&wq->first_flusher->done);
2595
2596 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002597}
2598
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002599/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002601 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002603 * This function sleeps until all work items which were queued on entry
2604 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002606void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607{
Tejun Heo73f53c42010-06-29 10:07:11 +02002608 struct wq_flusher this_flusher = {
2609 .list = LIST_HEAD_INIT(this_flusher.list),
2610 .flush_color = -1,
2611 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2612 };
2613 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002614
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002615 lock_map_acquire(&wq->lockdep_map);
2616 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002617
2618 mutex_lock(&wq->flush_mutex);
2619
2620 /*
2621 * Start-to-wait phase
2622 */
2623 next_color = work_next_color(wq->work_color);
2624
2625 if (next_color != wq->flush_color) {
2626 /*
2627 * Color space is not full. The current work_color
2628 * becomes our flush_color and work_color is advanced
2629 * by one.
2630 */
Tejun Heo6183c002013-03-12 11:29:57 -07002631 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002632 this_flusher.flush_color = wq->work_color;
2633 wq->work_color = next_color;
2634
2635 if (!wq->first_flusher) {
2636 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002637 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002638
2639 wq->first_flusher = &this_flusher;
2640
Tejun Heo112202d2013-02-13 19:29:12 -08002641 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002642 wq->work_color)) {
2643 /* nothing to flush, done */
2644 wq->flush_color = next_color;
2645 wq->first_flusher = NULL;
2646 goto out_unlock;
2647 }
2648 } else {
2649 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002650 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002651 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002652 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002653 }
2654 } else {
2655 /*
2656 * Oops, color space is full, wait on overflow queue.
2657 * The next flush completion will assign us
2658 * flush_color and transfer to flusher_queue.
2659 */
2660 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2661 }
2662
2663 mutex_unlock(&wq->flush_mutex);
2664
2665 wait_for_completion(&this_flusher.done);
2666
2667 /*
2668 * Wake-up-and-cascade phase
2669 *
2670 * First flushers are responsible for cascading flushes and
2671 * handling overflow. Non-first flushers can simply return.
2672 */
2673 if (wq->first_flusher != &this_flusher)
2674 return;
2675
2676 mutex_lock(&wq->flush_mutex);
2677
Tejun Heo4ce48b32010-07-02 10:03:51 +02002678 /* we might have raced, check again with mutex held */
2679 if (wq->first_flusher != &this_flusher)
2680 goto out_unlock;
2681
Tejun Heo73f53c42010-06-29 10:07:11 +02002682 wq->first_flusher = NULL;
2683
Tejun Heo6183c002013-03-12 11:29:57 -07002684 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2685 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002686
2687 while (true) {
2688 struct wq_flusher *next, *tmp;
2689
2690 /* complete all the flushers sharing the current flush color */
2691 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2692 if (next->flush_color != wq->flush_color)
2693 break;
2694 list_del_init(&next->list);
2695 complete(&next->done);
2696 }
2697
Tejun Heo6183c002013-03-12 11:29:57 -07002698 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2699 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002700
2701 /* this flush_color is finished, advance by one */
2702 wq->flush_color = work_next_color(wq->flush_color);
2703
2704 /* one color has been freed, handle overflow queue */
2705 if (!list_empty(&wq->flusher_overflow)) {
2706 /*
2707 * Assign the same color to all overflowed
2708 * flushers, advance work_color and append to
2709 * flusher_queue. This is the start-to-wait
2710 * phase for these overflowed flushers.
2711 */
2712 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2713 tmp->flush_color = wq->work_color;
2714
2715 wq->work_color = work_next_color(wq->work_color);
2716
2717 list_splice_tail_init(&wq->flusher_overflow,
2718 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002719 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002720 }
2721
2722 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002723 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002724 break;
2725 }
2726
2727 /*
2728 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002729 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002730 */
Tejun Heo6183c002013-03-12 11:29:57 -07002731 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2732 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002733
2734 list_del_init(&next->list);
2735 wq->first_flusher = next;
2736
Tejun Heo112202d2013-02-13 19:29:12 -08002737 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002738 break;
2739
2740 /*
2741 * Meh... this color is already done, clear first
2742 * flusher and repeat cascading.
2743 */
2744 wq->first_flusher = NULL;
2745 }
2746
2747out_unlock:
2748 mutex_unlock(&wq->flush_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749}
Dave Jonesae90dd52006-06-30 01:40:45 -04002750EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002751
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002752/**
2753 * drain_workqueue - drain a workqueue
2754 * @wq: workqueue to drain
2755 *
2756 * Wait until the workqueue becomes empty. While draining is in progress,
2757 * only chain queueing is allowed. IOW, only currently pending or running
2758 * work items on @wq can queue further work items on it. @wq is flushed
2759 * repeatedly until it becomes empty. The number of flushing is detemined
2760 * by the depth of chaining and should be relatively short. Whine if it
2761 * takes too long.
2762 */
2763void drain_workqueue(struct workqueue_struct *wq)
2764{
2765 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002766 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002767
2768 /*
2769 * __queue_work() needs to test whether there are drainers, is much
2770 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002771 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002772 */
Tejun Heo5bcab332013-03-13 19:47:40 -07002773 mutex_lock(&wq_mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002774 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002775 wq->flags |= __WQ_DRAINING;
Tejun Heo5bcab332013-03-13 19:47:40 -07002776 mutex_unlock(&wq_mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002777reflush:
2778 flush_workqueue(wq);
2779
Tejun Heo76af4d92013-03-12 11:30:00 -07002780 local_irq_disable();
2781
Tejun Heo49e3cf42013-03-12 11:29:58 -07002782 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002783 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002784
Tejun Heo76af4d92013-03-12 11:30:00 -07002785 spin_lock(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002786 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Tejun Heo76af4d92013-03-12 11:30:00 -07002787 spin_unlock(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002788
2789 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002790 continue;
2791
2792 if (++flush_cnt == 10 ||
2793 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002794 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002795 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002796
2797 local_irq_enable();
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002798 goto reflush;
2799 }
2800
Tejun Heo5bcab332013-03-13 19:47:40 -07002801 local_irq_enable();
2802
2803 mutex_lock(&wq_mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002804 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002805 wq->flags &= ~__WQ_DRAINING;
Tejun Heo5bcab332013-03-13 19:47:40 -07002806 mutex_unlock(&wq_mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002807}
2808EXPORT_SYMBOL_GPL(drain_workqueue);
2809
Tejun Heo606a5022012-08-20 14:51:23 -07002810static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002811{
2812 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002813 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002814 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002815
2816 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002817
Tejun Heofa1b54e2013-03-12 11:30:00 -07002818 local_irq_disable();
2819 pool = get_work_pool(work);
2820 if (!pool) {
2821 local_irq_enable();
2822 return false;
2823 }
2824
2825 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002826 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002827 pwq = get_work_pwq(work);
2828 if (pwq) {
2829 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002830 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002831 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002832 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002833 if (!worker)
2834 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002835 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002836 }
Tejun Heobaf59022010-09-16 10:42:16 +02002837
Tejun Heo112202d2013-02-13 19:29:12 -08002838 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002839 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002840
Tejun Heoe1594892011-01-09 23:32:15 +01002841 /*
2842 * If @max_active is 1 or rescuer is in use, flushing another work
2843 * item on the same workqueue may lead to deadlock. Make sure the
2844 * flusher is not running on the same workqueue by verifying write
2845 * access.
2846 */
Tejun Heo493008a2013-03-12 11:30:03 -07002847 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002848 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002849 else
Tejun Heo112202d2013-02-13 19:29:12 -08002850 lock_map_acquire_read(&pwq->wq->lockdep_map);
2851 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002852
Tejun Heobaf59022010-09-16 10:42:16 +02002853 return true;
2854already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002855 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002856 return false;
2857}
2858
Oleg Nesterovdb700892008-07-25 01:47:49 -07002859/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002860 * flush_work - wait for a work to finish executing the last queueing instance
2861 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002862 *
Tejun Heo606a5022012-08-20 14:51:23 -07002863 * Wait until @work has finished execution. @work is guaranteed to be idle
2864 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002865 *
2866 * RETURNS:
2867 * %true if flush_work() waited for the work to finish execution,
2868 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002869 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002870bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002871{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002872 struct wq_barrier barr;
2873
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002874 lock_map_acquire(&work->lockdep_map);
2875 lock_map_release(&work->lockdep_map);
2876
Tejun Heo606a5022012-08-20 14:51:23 -07002877 if (start_flush_work(work, &barr)) {
Tejun Heobaf59022010-09-16 10:42:16 +02002878 wait_for_completion(&barr.done);
2879 destroy_work_on_stack(&barr.work);
2880 return true;
Tejun Heo606a5022012-08-20 14:51:23 -07002881 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002882 return false;
Tejun Heo606a5022012-08-20 14:51:23 -07002883 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002884}
2885EXPORT_SYMBOL_GPL(flush_work);
2886
Tejun Heo36e227d2012-08-03 10:30:46 -07002887static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002888{
Tejun Heobbb68df2012-08-03 10:30:46 -07002889 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002890 int ret;
2891
2892 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002893 ret = try_to_grab_pending(work, is_dwork, &flags);
2894 /*
2895 * If someone else is canceling, wait for the same event it
2896 * would be waiting for before retrying.
2897 */
2898 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002899 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002900 } while (unlikely(ret < 0));
2901
Tejun Heobbb68df2012-08-03 10:30:46 -07002902 /* tell other tasks trying to grab @work to back off */
2903 mark_work_canceling(work);
2904 local_irq_restore(flags);
2905
Tejun Heo606a5022012-08-20 14:51:23 -07002906 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002907 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002908 return ret;
2909}
2910
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002911/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002912 * cancel_work_sync - cancel a work and wait for it to finish
2913 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002914 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002915 * Cancel @work and wait for its execution to finish. This function
2916 * can be used even if the work re-queues itself or migrates to
2917 * another workqueue. On return from this function, @work is
2918 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002919 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002920 * cancel_work_sync(&delayed_work->work) must not be used for
2921 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002922 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002923 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002924 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002925 *
2926 * RETURNS:
2927 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002928 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002929bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002930{
Tejun Heo36e227d2012-08-03 10:30:46 -07002931 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002932}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002933EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002934
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002935/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002936 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2937 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002938 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002939 * Delayed timer is cancelled and the pending work is queued for
2940 * immediate execution. Like flush_work(), this function only
2941 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002942 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002943 * RETURNS:
2944 * %true if flush_work() waited for the work to finish execution,
2945 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002946 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002947bool flush_delayed_work(struct delayed_work *dwork)
2948{
Tejun Heo8930cab2012-08-03 10:30:45 -07002949 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002950 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002951 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002952 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002953 return flush_work(&dwork->work);
2954}
2955EXPORT_SYMBOL(flush_delayed_work);
2956
2957/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002958 * cancel_delayed_work - cancel a delayed work
2959 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002960 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002961 * Kill off a pending delayed_work. Returns %true if @dwork was pending
2962 * and canceled; %false if wasn't pending. Note that the work callback
2963 * function may still be running on return, unless it returns %true and the
2964 * work doesn't re-arm itself. Explicitly flush or use
2965 * cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002966 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002967 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002968 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002969bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002970{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002971 unsigned long flags;
2972 int ret;
2973
2974 do {
2975 ret = try_to_grab_pending(&dwork->work, true, &flags);
2976 } while (unlikely(ret == -EAGAIN));
2977
2978 if (unlikely(ret < 0))
2979 return false;
2980
Tejun Heo7c3eed52013-01-24 11:01:33 -08002981 set_work_pool_and_clear_pending(&dwork->work,
2982 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002983 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002984 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002985}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002986EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002987
2988/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002989 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2990 * @dwork: the delayed work cancel
2991 *
2992 * This is cancel_work_sync() for delayed works.
2993 *
2994 * RETURNS:
2995 * %true if @dwork was pending, %false otherwise.
2996 */
2997bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002998{
Tejun Heo36e227d2012-08-03 10:30:46 -07002999 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07003000}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07003001EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003002
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07003003/**
Tejun Heo31ddd872010-10-19 11:14:49 +02003004 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07003005 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07003006 *
Tejun Heo31ddd872010-10-19 11:14:49 +02003007 * schedule_on_each_cpu() executes @func on each online CPU using the
3008 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07003009 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02003010 *
3011 * RETURNS:
3012 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07003013 */
David Howells65f27f32006-11-22 14:55:48 +00003014int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003015{
3016 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02003017 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08003018
Andrew Mortonb6136772006-06-25 05:47:49 -07003019 works = alloc_percpu(struct work_struct);
3020 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08003021 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07003022
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003023 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08003024
Christoph Lameter15316ba2006-01-08 01:00:43 -08003025 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01003026 struct work_struct *work = per_cpu_ptr(works, cpu);
3027
3028 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003029 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02003030 }
Tejun Heo93981802009-11-17 14:06:20 -08003031
3032 for_each_online_cpu(cpu)
3033 flush_work(per_cpu_ptr(works, cpu));
3034
Gautham R Shenoy95402b32008-01-25 21:08:02 +01003035 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07003036 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08003037 return 0;
3038}
3039
Alan Sterneef6a7d2010-02-12 17:39:21 +09003040/**
3041 * flush_scheduled_work - ensure that any scheduled work has run to completion.
3042 *
3043 * Forces execution of the kernel-global workqueue and blocks until its
3044 * completion.
3045 *
3046 * Think twice before calling this function! It's very easy to get into
3047 * trouble if you don't take great care. Either of the following situations
3048 * will lead to deadlock:
3049 *
3050 * One of the work items currently on the workqueue needs to acquire
3051 * a lock held by your code or its caller.
3052 *
3053 * Your code is running in the context of a work routine.
3054 *
3055 * They will be detected by lockdep when they occur, but the first might not
3056 * occur very often. It depends on what work items are on the workqueue and
3057 * what locks they need, which you have no control over.
3058 *
3059 * In most situations flushing the entire workqueue is overkill; you merely
3060 * need to know that a particular work item isn't queued and isn't running.
3061 * In such cases you should use cancel_delayed_work_sync() or
3062 * cancel_work_sync() instead.
3063 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003064void flush_scheduled_work(void)
3065{
Tejun Heod320c032010-06-29 10:07:14 +02003066 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003067}
Dave Jonesae90dd52006-06-30 01:40:45 -04003068EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003069
3070/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06003071 * execute_in_process_context - reliably execute the routine with user context
3072 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06003073 * @ew: guaranteed storage for the execute work structure (must
3074 * be available when the work executes)
3075 *
3076 * Executes the function immediately if process context is available,
3077 * otherwise schedules the function for delayed execution.
3078 *
3079 * Returns: 0 - function was executed
3080 * 1 - function was scheduled for execution
3081 */
David Howells65f27f32006-11-22 14:55:48 +00003082int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003083{
3084 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003085 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003086 return 0;
3087 }
3088
David Howells65f27f32006-11-22 14:55:48 +00003089 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003090 schedule_work(&ew->work);
3091
3092 return 1;
3093}
3094EXPORT_SYMBOL_GPL(execute_in_process_context);
3095
Tejun Heo226223a2013-03-12 11:30:05 -07003096#ifdef CONFIG_SYSFS
3097/*
3098 * Workqueues with WQ_SYSFS flag set is visible to userland via
3099 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
3100 * following attributes.
3101 *
3102 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
3103 * max_active RW int : maximum number of in-flight work items
3104 *
3105 * Unbound workqueues have the following extra attributes.
3106 *
3107 * id RO int : the associated pool ID
3108 * nice RW int : nice value of the workers
3109 * cpumask RW mask : bitmask of allowed CPUs for the workers
3110 */
3111struct wq_device {
3112 struct workqueue_struct *wq;
3113 struct device dev;
3114};
3115
3116static struct workqueue_struct *dev_to_wq(struct device *dev)
3117{
3118 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3119
3120 return wq_dev->wq;
3121}
3122
3123static ssize_t wq_per_cpu_show(struct device *dev,
3124 struct device_attribute *attr, char *buf)
3125{
3126 struct workqueue_struct *wq = dev_to_wq(dev);
3127
3128 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
3129}
3130
3131static ssize_t wq_max_active_show(struct device *dev,
3132 struct device_attribute *attr, char *buf)
3133{
3134 struct workqueue_struct *wq = dev_to_wq(dev);
3135
3136 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
3137}
3138
3139static ssize_t wq_max_active_store(struct device *dev,
3140 struct device_attribute *attr,
3141 const char *buf, size_t count)
3142{
3143 struct workqueue_struct *wq = dev_to_wq(dev);
3144 int val;
3145
3146 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
3147 return -EINVAL;
3148
3149 workqueue_set_max_active(wq, val);
3150 return count;
3151}
3152
3153static struct device_attribute wq_sysfs_attrs[] = {
3154 __ATTR(per_cpu, 0444, wq_per_cpu_show, NULL),
3155 __ATTR(max_active, 0644, wq_max_active_show, wq_max_active_store),
3156 __ATTR_NULL,
3157};
3158
3159static ssize_t wq_pool_id_show(struct device *dev,
3160 struct device_attribute *attr, char *buf)
3161{
3162 struct workqueue_struct *wq = dev_to_wq(dev);
3163 struct worker_pool *pool;
3164 int written;
3165
3166 rcu_read_lock_sched();
3167 pool = first_pwq(wq)->pool;
3168 written = scnprintf(buf, PAGE_SIZE, "%d\n", pool->id);
3169 rcu_read_unlock_sched();
3170
3171 return written;
3172}
3173
3174static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
3175 char *buf)
3176{
3177 struct workqueue_struct *wq = dev_to_wq(dev);
3178 int written;
3179
3180 rcu_read_lock_sched();
3181 written = scnprintf(buf, PAGE_SIZE, "%d\n",
3182 first_pwq(wq)->pool->attrs->nice);
3183 rcu_read_unlock_sched();
3184
3185 return written;
3186}
3187
3188/* prepare workqueue_attrs for sysfs store operations */
3189static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
3190{
3191 struct workqueue_attrs *attrs;
3192
3193 attrs = alloc_workqueue_attrs(GFP_KERNEL);
3194 if (!attrs)
3195 return NULL;
3196
3197 rcu_read_lock_sched();
3198 copy_workqueue_attrs(attrs, first_pwq(wq)->pool->attrs);
3199 rcu_read_unlock_sched();
3200 return attrs;
3201}
3202
3203static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
3204 const char *buf, size_t count)
3205{
3206 struct workqueue_struct *wq = dev_to_wq(dev);
3207 struct workqueue_attrs *attrs;
3208 int ret;
3209
3210 attrs = wq_sysfs_prep_attrs(wq);
3211 if (!attrs)
3212 return -ENOMEM;
3213
3214 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
3215 attrs->nice >= -20 && attrs->nice <= 19)
3216 ret = apply_workqueue_attrs(wq, attrs);
3217 else
3218 ret = -EINVAL;
3219
3220 free_workqueue_attrs(attrs);
3221 return ret ?: count;
3222}
3223
3224static ssize_t wq_cpumask_show(struct device *dev,
3225 struct device_attribute *attr, char *buf)
3226{
3227 struct workqueue_struct *wq = dev_to_wq(dev);
3228 int written;
3229
3230 rcu_read_lock_sched();
3231 written = cpumask_scnprintf(buf, PAGE_SIZE,
3232 first_pwq(wq)->pool->attrs->cpumask);
3233 rcu_read_unlock_sched();
3234
3235 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3236 return written;
3237}
3238
3239static ssize_t wq_cpumask_store(struct device *dev,
3240 struct device_attribute *attr,
3241 const char *buf, size_t count)
3242{
3243 struct workqueue_struct *wq = dev_to_wq(dev);
3244 struct workqueue_attrs *attrs;
3245 int ret;
3246
3247 attrs = wq_sysfs_prep_attrs(wq);
3248 if (!attrs)
3249 return -ENOMEM;
3250
3251 ret = cpumask_parse(buf, attrs->cpumask);
3252 if (!ret)
3253 ret = apply_workqueue_attrs(wq, attrs);
3254
3255 free_workqueue_attrs(attrs);
3256 return ret ?: count;
3257}
3258
3259static struct device_attribute wq_sysfs_unbound_attrs[] = {
3260 __ATTR(pool_id, 0444, wq_pool_id_show, NULL),
3261 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
3262 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
3263 __ATTR_NULL,
3264};
3265
3266static struct bus_type wq_subsys = {
3267 .name = "workqueue",
3268 .dev_attrs = wq_sysfs_attrs,
3269};
3270
3271static int __init wq_sysfs_init(void)
3272{
3273 return subsys_virtual_register(&wq_subsys, NULL);
3274}
3275core_initcall(wq_sysfs_init);
3276
3277static void wq_device_release(struct device *dev)
3278{
3279 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3280
3281 kfree(wq_dev);
3282}
3283
3284/**
3285 * workqueue_sysfs_register - make a workqueue visible in sysfs
3286 * @wq: the workqueue to register
3287 *
3288 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
3289 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
3290 * which is the preferred method.
3291 *
3292 * Workqueue user should use this function directly iff it wants to apply
3293 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
3294 * apply_workqueue_attrs() may race against userland updating the
3295 * attributes.
3296 *
3297 * Returns 0 on success, -errno on failure.
3298 */
3299int workqueue_sysfs_register(struct workqueue_struct *wq)
3300{
3301 struct wq_device *wq_dev;
3302 int ret;
3303
3304 /*
3305 * Adjusting max_active or creating new pwqs by applyting
3306 * attributes breaks ordering guarantee. Disallow exposing ordered
3307 * workqueues.
3308 */
3309 if (WARN_ON(wq->flags & __WQ_ORDERED))
3310 return -EINVAL;
3311
3312 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
3313 if (!wq_dev)
3314 return -ENOMEM;
3315
3316 wq_dev->wq = wq;
3317 wq_dev->dev.bus = &wq_subsys;
3318 wq_dev->dev.init_name = wq->name;
3319 wq_dev->dev.release = wq_device_release;
3320
3321 /*
3322 * unbound_attrs are created separately. Suppress uevent until
3323 * everything is ready.
3324 */
3325 dev_set_uevent_suppress(&wq_dev->dev, true);
3326
3327 ret = device_register(&wq_dev->dev);
3328 if (ret) {
3329 kfree(wq_dev);
3330 wq->wq_dev = NULL;
3331 return ret;
3332 }
3333
3334 if (wq->flags & WQ_UNBOUND) {
3335 struct device_attribute *attr;
3336
3337 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
3338 ret = device_create_file(&wq_dev->dev, attr);
3339 if (ret) {
3340 device_unregister(&wq_dev->dev);
3341 wq->wq_dev = NULL;
3342 return ret;
3343 }
3344 }
3345 }
3346
3347 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
3348 return 0;
3349}
3350
3351/**
3352 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
3353 * @wq: the workqueue to unregister
3354 *
3355 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
3356 */
3357static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
3358{
3359 struct wq_device *wq_dev = wq->wq_dev;
3360
3361 if (!wq->wq_dev)
3362 return;
3363
3364 wq->wq_dev = NULL;
3365 device_unregister(&wq_dev->dev);
3366}
3367#else /* CONFIG_SYSFS */
3368static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
3369#endif /* CONFIG_SYSFS */
3370
Tejun Heo7a4e3442013-03-12 11:30:00 -07003371/**
3372 * free_workqueue_attrs - free a workqueue_attrs
3373 * @attrs: workqueue_attrs to free
3374 *
3375 * Undo alloc_workqueue_attrs().
3376 */
3377void free_workqueue_attrs(struct workqueue_attrs *attrs)
3378{
3379 if (attrs) {
3380 free_cpumask_var(attrs->cpumask);
3381 kfree(attrs);
3382 }
3383}
3384
3385/**
3386 * alloc_workqueue_attrs - allocate a workqueue_attrs
3387 * @gfp_mask: allocation mask to use
3388 *
3389 * Allocate a new workqueue_attrs, initialize with default settings and
3390 * return it. Returns NULL on failure.
3391 */
3392struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3393{
3394 struct workqueue_attrs *attrs;
3395
3396 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3397 if (!attrs)
3398 goto fail;
3399 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3400 goto fail;
3401
3402 cpumask_setall(attrs->cpumask);
3403 return attrs;
3404fail:
3405 free_workqueue_attrs(attrs);
3406 return NULL;
3407}
3408
Tejun Heo29c91e92013-03-12 11:30:03 -07003409static void copy_workqueue_attrs(struct workqueue_attrs *to,
3410 const struct workqueue_attrs *from)
3411{
3412 to->nice = from->nice;
3413 cpumask_copy(to->cpumask, from->cpumask);
3414}
3415
3416/*
3417 * Hacky implementation of jhash of bitmaps which only considers the
3418 * specified number of bits. We probably want a proper implementation in
3419 * include/linux/jhash.h.
3420 */
3421static u32 jhash_bitmap(const unsigned long *bitmap, int bits, u32 hash)
3422{
3423 int nr_longs = bits / BITS_PER_LONG;
3424 int nr_leftover = bits % BITS_PER_LONG;
3425 unsigned long leftover = 0;
3426
3427 if (nr_longs)
3428 hash = jhash(bitmap, nr_longs * sizeof(long), hash);
3429 if (nr_leftover) {
3430 bitmap_copy(&leftover, bitmap + nr_longs, nr_leftover);
3431 hash = jhash(&leftover, sizeof(long), hash);
3432 }
3433 return hash;
3434}
3435
3436/* hash value of the content of @attr */
3437static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3438{
3439 u32 hash = 0;
3440
3441 hash = jhash_1word(attrs->nice, hash);
3442 hash = jhash_bitmap(cpumask_bits(attrs->cpumask), nr_cpu_ids, hash);
3443 return hash;
3444}
3445
3446/* content equality test */
3447static bool wqattrs_equal(const struct workqueue_attrs *a,
3448 const struct workqueue_attrs *b)
3449{
3450 if (a->nice != b->nice)
3451 return false;
3452 if (!cpumask_equal(a->cpumask, b->cpumask))
3453 return false;
3454 return true;
3455}
3456
Tejun Heo7a4e3442013-03-12 11:30:00 -07003457/**
3458 * init_worker_pool - initialize a newly zalloc'd worker_pool
3459 * @pool: worker_pool to initialize
3460 *
3461 * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
Tejun Heo29c91e92013-03-12 11:30:03 -07003462 * Returns 0 on success, -errno on failure. Even on failure, all fields
3463 * inside @pool proper are initialized and put_unbound_pool() can be called
3464 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003465 */
3466static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003467{
3468 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003469 pool->id = -1;
3470 pool->cpu = -1;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003471 pool->flags |= POOL_DISASSOCIATED;
3472 INIT_LIST_HEAD(&pool->worklist);
3473 INIT_LIST_HEAD(&pool->idle_list);
3474 hash_init(pool->busy_hash);
3475
3476 init_timer_deferrable(&pool->idle_timer);
3477 pool->idle_timer.function = idle_worker_timeout;
3478 pool->idle_timer.data = (unsigned long)pool;
3479
3480 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3481 (unsigned long)pool);
3482
3483 mutex_init(&pool->manager_arb);
Tejun Heobc3a1af2013-03-13 19:47:39 -07003484 mutex_init(&pool->manager_mutex);
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003485 ida_init(&pool->worker_ida);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003486
Tejun Heo29c91e92013-03-12 11:30:03 -07003487 INIT_HLIST_NODE(&pool->hash_node);
3488 pool->refcnt = 1;
3489
3490 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003491 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3492 if (!pool->attrs)
3493 return -ENOMEM;
3494 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003495}
3496
Tejun Heo29c91e92013-03-12 11:30:03 -07003497static void rcu_free_pool(struct rcu_head *rcu)
3498{
3499 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3500
3501 ida_destroy(&pool->worker_ida);
3502 free_workqueue_attrs(pool->attrs);
3503 kfree(pool);
3504}
3505
3506/**
3507 * put_unbound_pool - put a worker_pool
3508 * @pool: worker_pool to put
3509 *
3510 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003511 * safe manner. get_unbound_pool() calls this function on its failure path
3512 * and this function should be able to release pools which went through,
3513 * successfully or not, init_worker_pool().
Tejun Heo29c91e92013-03-12 11:30:03 -07003514 */
3515static void put_unbound_pool(struct worker_pool *pool)
3516{
3517 struct worker *worker;
3518
Tejun Heo5bcab332013-03-13 19:47:40 -07003519 mutex_lock(&wq_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003520 if (--pool->refcnt) {
Tejun Heo5bcab332013-03-13 19:47:40 -07003521 mutex_unlock(&wq_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003522 return;
3523 }
3524
3525 /* sanity checks */
3526 if (WARN_ON(!(pool->flags & POOL_DISASSOCIATED)) ||
3527 WARN_ON(!list_empty(&pool->worklist))) {
Tejun Heo5bcab332013-03-13 19:47:40 -07003528 mutex_unlock(&wq_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003529 return;
3530 }
3531
3532 /* release id and unhash */
3533 if (pool->id >= 0)
3534 idr_remove(&worker_pool_idr, pool->id);
3535 hash_del(&pool->hash_node);
3536
Tejun Heo5bcab332013-03-13 19:47:40 -07003537 mutex_unlock(&wq_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003538
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003539 /*
3540 * Become the manager and destroy all workers. Grabbing
3541 * manager_arb prevents @pool's workers from blocking on
3542 * manager_mutex.
3543 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003544 mutex_lock(&pool->manager_arb);
Tejun Heocd549682013-03-13 19:47:39 -07003545 mutex_lock(&pool->manager_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003546 spin_lock_irq(&pool->lock);
3547
3548 while ((worker = first_worker(pool)))
3549 destroy_worker(worker);
3550 WARN_ON(pool->nr_workers || pool->nr_idle);
3551
3552 spin_unlock_irq(&pool->lock);
Tejun Heocd549682013-03-13 19:47:39 -07003553 mutex_unlock(&pool->manager_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003554 mutex_unlock(&pool->manager_arb);
3555
3556 /* shut down the timers */
3557 del_timer_sync(&pool->idle_timer);
3558 del_timer_sync(&pool->mayday_timer);
3559
3560 /* sched-RCU protected to allow dereferences from get_work_pool() */
3561 call_rcu_sched(&pool->rcu, rcu_free_pool);
3562}
3563
3564/**
3565 * get_unbound_pool - get a worker_pool with the specified attributes
3566 * @attrs: the attributes of the worker_pool to get
3567 *
3568 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3569 * reference count and return it. If there already is a matching
3570 * worker_pool, it will be used; otherwise, this function attempts to
3571 * create a new one. On failure, returns NULL.
3572 */
3573static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3574{
Tejun Heo29c91e92013-03-12 11:30:03 -07003575 u32 hash = wqattrs_hash(attrs);
3576 struct worker_pool *pool;
Tejun Heo29c91e92013-03-12 11:30:03 -07003577
Tejun Heo5bcab332013-03-13 19:47:40 -07003578 mutex_lock(&wq_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003579
3580 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003581 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3582 if (wqattrs_equal(pool->attrs, attrs)) {
3583 pool->refcnt++;
3584 goto out_unlock;
3585 }
3586 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003587
3588 /* nope, create a new one */
3589 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
3590 if (!pool || init_worker_pool(pool) < 0)
3591 goto fail;
3592
Tejun Heo8864b4e2013-03-12 11:30:04 -07003593 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003594 copy_workqueue_attrs(pool->attrs, attrs);
3595
3596 if (worker_pool_assign_id(pool) < 0)
3597 goto fail;
3598
3599 /* create and start the initial worker */
Tejun Heoebf44d12013-03-13 19:47:39 -07003600 if (create_and_start_worker(pool) < 0)
Tejun Heo29c91e92013-03-12 11:30:03 -07003601 goto fail;
3602
Tejun Heo29c91e92013-03-12 11:30:03 -07003603 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003604 hash_add(unbound_pool_hash, &pool->hash_node, hash);
3605out_unlock:
Tejun Heo5bcab332013-03-13 19:47:40 -07003606 mutex_unlock(&wq_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003607 return pool;
3608fail:
Tejun Heo5bcab332013-03-13 19:47:40 -07003609 mutex_unlock(&wq_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003610 if (pool)
3611 put_unbound_pool(pool);
3612 return NULL;
3613}
3614
Tejun Heo8864b4e2013-03-12 11:30:04 -07003615static void rcu_free_pwq(struct rcu_head *rcu)
3616{
3617 kmem_cache_free(pwq_cache,
3618 container_of(rcu, struct pool_workqueue, rcu));
3619}
3620
3621/*
3622 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3623 * and needs to be destroyed.
3624 */
3625static void pwq_unbound_release_workfn(struct work_struct *work)
3626{
3627 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3628 unbound_release_work);
3629 struct workqueue_struct *wq = pwq->wq;
3630 struct worker_pool *pool = pwq->pool;
3631
3632 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3633 return;
3634
Tejun Heo75ccf592013-03-12 11:30:04 -07003635 /*
3636 * Unlink @pwq. Synchronization against flush_mutex isn't strictly
3637 * necessary on release but do it anyway. It's easier to verify
3638 * and consistent with the linking path.
3639 */
3640 mutex_lock(&wq->flush_mutex);
Tejun Heo794b18b2013-03-13 19:47:40 -07003641 spin_lock_irq(&pwq_lock);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003642 list_del_rcu(&pwq->pwqs_node);
Tejun Heo794b18b2013-03-13 19:47:40 -07003643 spin_unlock_irq(&pwq_lock);
Tejun Heo75ccf592013-03-12 11:30:04 -07003644 mutex_unlock(&wq->flush_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003645
3646 put_unbound_pool(pool);
3647 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3648
3649 /*
3650 * If we're the last pwq going away, @wq is already dead and no one
3651 * is gonna access it anymore. Free it.
3652 */
3653 if (list_empty(&wq->pwqs))
3654 kfree(wq);
3655}
3656
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003657/**
Tejun Heo699ce092013-03-13 16:51:35 -07003658 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003659 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003660 *
Tejun Heo699ce092013-03-13 16:51:35 -07003661 * If @pwq isn't freezing, set @pwq->max_active to the associated
3662 * workqueue's saved_max_active and activate delayed work items
3663 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003664 */
Tejun Heo699ce092013-03-13 16:51:35 -07003665static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003666{
Tejun Heo699ce092013-03-13 16:51:35 -07003667 struct workqueue_struct *wq = pwq->wq;
3668 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003669
Tejun Heo699ce092013-03-13 16:51:35 -07003670 /* for @wq->saved_max_active */
Tejun Heo794b18b2013-03-13 19:47:40 -07003671 lockdep_assert_held(&pwq_lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003672
3673 /* fast exit for non-freezable wqs */
3674 if (!freezable && pwq->max_active == wq->saved_max_active)
3675 return;
3676
3677 spin_lock(&pwq->pool->lock);
3678
3679 if (!freezable || !(pwq->pool->flags & POOL_FREEZING)) {
3680 pwq->max_active = wq->saved_max_active;
3681
3682 while (!list_empty(&pwq->delayed_works) &&
3683 pwq->nr_active < pwq->max_active)
3684 pwq_activate_first_delayed(pwq);
3685 } else {
3686 pwq->max_active = 0;
3687 }
3688
3689 spin_unlock(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003690}
3691
Tejun Heod2c1d402013-03-12 11:30:04 -07003692static void init_and_link_pwq(struct pool_workqueue *pwq,
3693 struct workqueue_struct *wq,
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003694 struct worker_pool *pool,
3695 struct pool_workqueue **p_last_pwq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003696{
3697 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3698
3699 pwq->pool = pool;
3700 pwq->wq = wq;
3701 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003702 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003703 INIT_LIST_HEAD(&pwq->delayed_works);
3704 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003705 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heod2c1d402013-03-12 11:30:04 -07003706
Tejun Heo75ccf592013-03-12 11:30:04 -07003707 mutex_lock(&wq->flush_mutex);
Tejun Heo794b18b2013-03-13 19:47:40 -07003708 spin_lock_irq(&pwq_lock);
Tejun Heo75ccf592013-03-12 11:30:04 -07003709
Tejun Heo983ca252013-03-13 16:51:35 -07003710 /*
3711 * Set the matching work_color. This is synchronized with
3712 * flush_mutex to avoid confusing flush_workqueue().
3713 */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003714 if (p_last_pwq)
3715 *p_last_pwq = first_pwq(wq);
Tejun Heo75ccf592013-03-12 11:30:04 -07003716 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003717
3718 /* sync max_active to the current setting */
3719 pwq_adjust_max_active(pwq);
3720
3721 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003722 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heo75ccf592013-03-12 11:30:04 -07003723
Tejun Heo794b18b2013-03-13 19:47:40 -07003724 spin_unlock_irq(&pwq_lock);
Tejun Heo75ccf592013-03-12 11:30:04 -07003725 mutex_unlock(&wq->flush_mutex);
Tejun Heod2c1d402013-03-12 11:30:04 -07003726}
3727
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003728/**
3729 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3730 * @wq: the target workqueue
3731 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3732 *
3733 * Apply @attrs to an unbound workqueue @wq. If @attrs doesn't match the
3734 * current attributes, a new pwq is created and made the first pwq which
3735 * will serve all new work items. Older pwqs are released as in-flight
3736 * work items finish. Note that a work item which repeatedly requeues
3737 * itself back-to-back will stay on its current pwq.
3738 *
3739 * Performs GFP_KERNEL allocations. Returns 0 on success and -errno on
3740 * failure.
3741 */
3742int apply_workqueue_attrs(struct workqueue_struct *wq,
3743 const struct workqueue_attrs *attrs)
3744{
3745 struct pool_workqueue *pwq, *last_pwq;
3746 struct worker_pool *pool;
3747
Tejun Heo8719dce2013-03-12 11:30:04 -07003748 /* only unbound workqueues can change attributes */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003749 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3750 return -EINVAL;
3751
Tejun Heo8719dce2013-03-12 11:30:04 -07003752 /* creating multiple pwqs breaks ordering guarantee */
3753 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3754 return -EINVAL;
3755
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003756 pwq = kmem_cache_zalloc(pwq_cache, GFP_KERNEL);
3757 if (!pwq)
3758 return -ENOMEM;
3759
3760 pool = get_unbound_pool(attrs);
3761 if (!pool) {
3762 kmem_cache_free(pwq_cache, pwq);
3763 return -ENOMEM;
3764 }
3765
3766 init_and_link_pwq(pwq, wq, pool, &last_pwq);
3767 if (last_pwq) {
3768 spin_lock_irq(&last_pwq->pool->lock);
3769 put_pwq(last_pwq);
3770 spin_unlock_irq(&last_pwq->pool->lock);
3771 }
3772
3773 return 0;
3774}
3775
Tejun Heo30cdf242013-03-12 11:29:57 -07003776static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003777{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003778 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo30cdf242013-03-12 11:29:57 -07003779 int cpu;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003780
Tejun Heo30cdf242013-03-12 11:29:57 -07003781 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003782 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3783 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003784 return -ENOMEM;
3785
3786 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003787 struct pool_workqueue *pwq =
3788 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003789 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003790 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003791
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003792 init_and_link_pwq(pwq, wq, &cpu_pools[highpri], NULL);
Tejun Heo30cdf242013-03-12 11:29:57 -07003793 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003794 return 0;
Tejun Heo30cdf242013-03-12 11:29:57 -07003795 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003796 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003797 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003798}
3799
Tejun Heof3421792010-07-02 10:03:51 +02003800static int wq_clamp_max_active(int max_active, unsigned int flags,
3801 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003802{
Tejun Heof3421792010-07-02 10:03:51 +02003803 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3804
3805 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003806 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3807 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003808
Tejun Heof3421792010-07-02 10:03:51 +02003809 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003810}
3811
Tejun Heob196be82012-01-10 15:11:35 -08003812struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003813 unsigned int flags,
3814 int max_active,
3815 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003816 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003817{
Tejun Heob196be82012-01-10 15:11:35 -08003818 va_list args, args1;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003819 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003820 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003821 size_t namelen;
3822
3823 /* determine namelen, allocate wq and format name */
3824 va_start(args, lock_name);
3825 va_copy(args1, args);
3826 namelen = vsnprintf(NULL, 0, fmt, args) + 1;
3827
3828 wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL);
3829 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003830 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003831
3832 vsnprintf(wq->name, namelen, fmt, args1);
3833 va_end(args);
3834 va_end(args1);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003835
Tejun Heod320c032010-06-29 10:07:14 +02003836 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003837 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003838
Tejun Heob196be82012-01-10 15:11:35 -08003839 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003840 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003841 wq->saved_max_active = max_active;
Tejun Heo73f53c42010-06-29 10:07:11 +02003842 mutex_init(&wq->flush_mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003843 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003844 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003845 INIT_LIST_HEAD(&wq->flusher_queue);
3846 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003847 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003848
Johannes Bergeb13ba82008-01-16 09:51:58 +01003849 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003850 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003851
Tejun Heo30cdf242013-03-12 11:29:57 -07003852 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07003853 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003854
Tejun Heo493008a2013-03-12 11:30:03 -07003855 /*
3856 * Workqueues which may be used during memory reclaim should
3857 * have a rescuer to guarantee forward progress.
3858 */
3859 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003860 struct worker *rescuer;
3861
Tejun Heod2c1d402013-03-12 11:30:04 -07003862 rescuer = alloc_worker();
Tejun Heoe22bee72010-06-29 10:07:14 +02003863 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07003864 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02003865
Tejun Heo111c2252013-01-17 17:16:24 -08003866 rescuer->rescue_wq = wq;
3867 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003868 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07003869 if (IS_ERR(rescuer->task)) {
3870 kfree(rescuer);
3871 goto err_destroy;
3872 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003873
Tejun Heod2c1d402013-03-12 11:30:04 -07003874 wq->rescuer = rescuer;
Tejun Heo14a40ff2013-03-19 13:45:20 -07003875 rescuer->task->flags |= PF_NO_SETAFFINITY;
Tejun Heoe22bee72010-06-29 10:07:14 +02003876 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003877 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003878
Tejun Heo226223a2013-03-12 11:30:05 -07003879 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
3880 goto err_destroy;
3881
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003882 /*
Tejun Heo5bcab332013-03-13 19:47:40 -07003883 * wq_mutex protects global freeze state and workqueues list. Grab
3884 * it, adjust max_active and add the new @wq to workqueues list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003885 */
Tejun Heo5bcab332013-03-13 19:47:40 -07003886 mutex_lock(&wq_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003887
Tejun Heo794b18b2013-03-13 19:47:40 -07003888 spin_lock_irq(&pwq_lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003889 for_each_pwq(pwq, wq)
3890 pwq_adjust_max_active(pwq);
Tejun Heo794b18b2013-03-13 19:47:40 -07003891 spin_unlock_irq(&pwq_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003892
Tejun Heo15376632010-06-29 10:07:11 +02003893 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003894
Tejun Heo5bcab332013-03-13 19:47:40 -07003895 mutex_unlock(&wq_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02003896
Oleg Nesterov3af244332007-05-09 02:34:09 -07003897 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003898
3899err_free_wq:
3900 kfree(wq);
3901 return NULL;
3902err_destroy:
3903 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003904 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003905}
Tejun Heod320c032010-06-29 10:07:14 +02003906EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003907
3908/**
3909 * destroy_workqueue - safely terminate a workqueue
3910 * @wq: target workqueue
3911 *
3912 * Safely destroy a workqueue. All work currently pending will be done first.
3913 */
3914void destroy_workqueue(struct workqueue_struct *wq)
3915{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003916 struct pool_workqueue *pwq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003917
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003918 /* drain it before proceeding with destruction */
3919 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003920
Tejun Heo6183c002013-03-12 11:29:57 -07003921 /* sanity checks */
Tejun Heo794b18b2013-03-13 19:47:40 -07003922 spin_lock_irq(&pwq_lock);
Tejun Heo49e3cf42013-03-12 11:29:58 -07003923 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07003924 int i;
3925
Tejun Heo76af4d92013-03-12 11:30:00 -07003926 for (i = 0; i < WORK_NR_COLORS; i++) {
3927 if (WARN_ON(pwq->nr_in_flight[i])) {
Tejun Heo794b18b2013-03-13 19:47:40 -07003928 spin_unlock_irq(&pwq_lock);
Tejun Heo6183c002013-03-12 11:29:57 -07003929 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003930 }
3931 }
3932
Tejun Heo8864b4e2013-03-12 11:30:04 -07003933 if (WARN_ON(pwq->refcnt > 1) ||
3934 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07003935 WARN_ON(!list_empty(&pwq->delayed_works))) {
Tejun Heo794b18b2013-03-13 19:47:40 -07003936 spin_unlock_irq(&pwq_lock);
Tejun Heo6183c002013-03-12 11:29:57 -07003937 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003938 }
Tejun Heo6183c002013-03-12 11:29:57 -07003939 }
Tejun Heo794b18b2013-03-13 19:47:40 -07003940 spin_unlock_irq(&pwq_lock);
Tejun Heo6183c002013-03-12 11:29:57 -07003941
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003942 /*
3943 * wq list is used to freeze wq, remove from list after
3944 * flushing is complete in case freeze races us.
3945 */
Tejun Heo5bcab332013-03-13 19:47:40 -07003946 mutex_lock(&wq_mutex);
Tejun Heod2c1d402013-03-12 11:30:04 -07003947 list_del_init(&wq->list);
Tejun Heo5bcab332013-03-13 19:47:40 -07003948 mutex_unlock(&wq_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003949
Tejun Heo226223a2013-03-12 11:30:05 -07003950 workqueue_sysfs_unregister(wq);
3951
Tejun Heo493008a2013-03-12 11:30:03 -07003952 if (wq->rescuer) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003953 kthread_stop(wq->rescuer->task);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003954 kfree(wq->rescuer);
Tejun Heo493008a2013-03-12 11:30:03 -07003955 wq->rescuer = NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +02003956 }
3957
Tejun Heo8864b4e2013-03-12 11:30:04 -07003958 if (!(wq->flags & WQ_UNBOUND)) {
3959 /*
3960 * The base ref is never dropped on per-cpu pwqs. Directly
3961 * free the pwqs and wq.
3962 */
3963 free_percpu(wq->cpu_pwqs);
3964 kfree(wq);
3965 } else {
3966 /*
3967 * We're the sole accessor of @wq at this point. Directly
3968 * access the first pwq and put the base ref. As both pwqs
3969 * and pools are sched-RCU protected, the lock operations
3970 * are safe. @wq will be freed when the last pwq is
3971 * released.
3972 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003973 pwq = list_first_entry(&wq->pwqs, struct pool_workqueue,
3974 pwqs_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003975 spin_lock_irq(&pwq->pool->lock);
3976 put_pwq(pwq);
3977 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003978 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003979}
3980EXPORT_SYMBOL_GPL(destroy_workqueue);
3981
Tejun Heodcd989c2010-06-29 10:07:14 +02003982/**
3983 * workqueue_set_max_active - adjust max_active of a workqueue
3984 * @wq: target workqueue
3985 * @max_active: new max_active value.
3986 *
3987 * Set max_active of @wq to @max_active.
3988 *
3989 * CONTEXT:
3990 * Don't call from IRQ context.
3991 */
3992void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3993{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003994 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02003995
Tejun Heo8719dce2013-03-12 11:30:04 -07003996 /* disallow meddling with max_active for ordered workqueues */
3997 if (WARN_ON(wq->flags & __WQ_ORDERED))
3998 return;
3999
Tejun Heof3421792010-07-02 10:03:51 +02004000 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004001
Tejun Heo794b18b2013-03-13 19:47:40 -07004002 spin_lock_irq(&pwq_lock);
Tejun Heodcd989c2010-06-29 10:07:14 +02004003
4004 wq->saved_max_active = max_active;
4005
Tejun Heo699ce092013-03-13 16:51:35 -07004006 for_each_pwq(pwq, wq)
4007 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004008
Tejun Heo794b18b2013-03-13 19:47:40 -07004009 spin_unlock_irq(&pwq_lock);
Tejun Heodcd989c2010-06-29 10:07:14 +02004010}
4011EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4012
4013/**
Tejun Heoe6267612013-03-12 17:41:37 -07004014 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4015 *
4016 * Determine whether %current is a workqueue rescuer. Can be used from
4017 * work functions to determine whether it's being run off the rescuer task.
4018 */
4019bool current_is_workqueue_rescuer(void)
4020{
4021 struct worker *worker = current_wq_worker();
4022
4023 return worker && worker == worker->current_pwq->wq->rescuer;
4024}
4025
4026/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004027 * workqueue_congested - test whether a workqueue is congested
4028 * @cpu: CPU in question
4029 * @wq: target workqueue
4030 *
4031 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4032 * no synchronization around this function and the test result is
4033 * unreliable and only useful as advisory hints or for debugging.
4034 *
4035 * RETURNS:
4036 * %true if congested, %false otherwise.
4037 */
Tejun Heod84ff052013-03-12 11:29:59 -07004038bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004039{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004040 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004041 bool ret;
4042
4043 preempt_disable();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004044
4045 if (!(wq->flags & WQ_UNBOUND))
4046 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4047 else
4048 pwq = first_pwq(wq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004049
Tejun Heo76af4d92013-03-12 11:30:00 -07004050 ret = !list_empty(&pwq->delayed_works);
4051 preempt_enable();
4052
4053 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004054}
4055EXPORT_SYMBOL_GPL(workqueue_congested);
4056
4057/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004058 * work_busy - test whether a work is currently pending or running
4059 * @work: the work to be tested
4060 *
4061 * Test whether @work is currently pending or running. There is no
4062 * synchronization around this function and the test result is
4063 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004064 *
4065 * RETURNS:
4066 * OR'd bitmask of WORK_BUSY_* bits.
4067 */
4068unsigned int work_busy(struct work_struct *work)
4069{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004070 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004071 unsigned long flags;
4072 unsigned int ret = 0;
4073
Tejun Heodcd989c2010-06-29 10:07:14 +02004074 if (work_pending(work))
4075 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004076
Tejun Heofa1b54e2013-03-12 11:30:00 -07004077 local_irq_save(flags);
4078 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004079 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004080 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004081 if (find_worker_executing_work(pool, work))
4082 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004083 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004084 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004085 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004086
4087 return ret;
4088}
4089EXPORT_SYMBOL_GPL(work_busy);
4090
Tejun Heodb7bccf2010-06-29 10:07:12 +02004091/*
4092 * CPU hotplug.
4093 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004094 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004095 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004096 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004097 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004098 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004099 * blocked draining impractical.
4100 *
Tejun Heo24647572013-01-24 11:01:33 -08004101 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004102 * running as an unbound one and allowing it to be reattached later if the
4103 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004104 */
4105
Tejun Heo706026c2013-01-24 11:01:34 -08004106static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004107{
Tejun Heo38db41d2013-01-24 11:01:34 -08004108 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004109 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004110 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004111 int i;
4112
Tejun Heof02ae732013-03-12 11:30:03 -07004113 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo6183c002013-03-12 11:29:57 -07004114 WARN_ON_ONCE(cpu != smp_processor_id());
Tejun Heo94cf58b2013-01-24 11:01:33 -08004115
Tejun Heobc3a1af2013-03-13 19:47:39 -07004116 mutex_lock(&pool->manager_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004117 spin_lock_irq(&pool->lock);
4118
4119 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07004120 * We've blocked all manager operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004121 * unbound and set DISASSOCIATED. Before this, all workers
4122 * except for the ones which are still executing works from
4123 * before the last CPU down must be on the cpu. After
4124 * this, they may become diasporas.
4125 */
Tejun Heo4ce62e92012-07-13 22:16:44 -07004126 list_for_each_entry(worker, &pool->idle_list, entry)
Tejun Heo403c8212012-07-17 12:39:27 -07004127 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004128
Sasha Levinb67bfe02013-02-27 17:06:00 -08004129 for_each_busy_worker(worker, i, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004130 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004131
Tejun Heo24647572013-01-24 11:01:33 -08004132 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004133
Tejun Heo94cf58b2013-01-24 11:01:33 -08004134 spin_unlock_irq(&pool->lock);
Tejun Heobc3a1af2013-03-13 19:47:39 -07004135 mutex_unlock(&pool->manager_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004136 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004137
4138 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07004139 * Call schedule() so that we cross rq->lock and thus can guarantee
4140 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
4141 * as scheduler callbacks may be invoked from other cpus.
4142 */
4143 schedule();
4144
4145 /*
4146 * Sched callbacks are disabled now. Zap nr_running. After this,
4147 * nr_running stays zero and need_more_worker() and keep_working()
Tejun Heo38db41d2013-01-24 11:01:34 -08004148 * are always true as long as the worklist is not empty. Pools on
4149 * @cpu now behave as unbound (in terms of concurrency management)
4150 * pools which are served by workers tied to the CPU.
Tejun Heo628c78e2012-07-17 12:39:27 -07004151 *
4152 * On return from this function, the current worker would trigger
4153 * unbound chain execution of pending work items if other workers
4154 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02004155 */
Tejun Heof02ae732013-03-12 11:30:03 -07004156 for_each_cpu_worker_pool(pool, cpu)
Tejun Heoe19e3972013-01-24 11:39:44 -08004157 atomic_set(&pool->nr_running, 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02004158}
4159
Tejun Heo8db25e72012-07-17 12:39:28 -07004160/*
4161 * Workqueues should be brought up before normal priority CPU notifiers.
4162 * This will be registered high priority CPU notifier.
4163 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07004164static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07004165 unsigned long action,
4166 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004167{
Tejun Heod84ff052013-03-12 11:29:59 -07004168 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07004169 struct worker_pool *pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004170
Tejun Heo8db25e72012-07-17 12:39:28 -07004171 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004172 case CPU_UP_PREPARE:
Tejun Heof02ae732013-03-12 11:30:03 -07004173 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07004174 if (pool->nr_workers)
4175 continue;
Tejun Heoebf44d12013-03-13 19:47:39 -07004176 if (create_and_start_worker(pool) < 0)
Tejun Heo3ce63372012-07-17 12:39:27 -07004177 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004178 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004179 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004180
Tejun Heo65758202012-07-17 12:39:26 -07004181 case CPU_DOWN_FAILED:
4182 case CPU_ONLINE:
Tejun Heof02ae732013-03-12 11:30:03 -07004183 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heobc3a1af2013-03-13 19:47:39 -07004184 mutex_lock(&pool->manager_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004185 spin_lock_irq(&pool->lock);
4186
Tejun Heo24647572013-01-24 11:01:33 -08004187 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heo94cf58b2013-01-24 11:01:33 -08004188 rebind_workers(pool);
4189
4190 spin_unlock_irq(&pool->lock);
Tejun Heobc3a1af2013-03-13 19:47:39 -07004191 mutex_unlock(&pool->manager_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004192 }
Tejun Heo8db25e72012-07-17 12:39:28 -07004193 break;
Tejun Heo65758202012-07-17 12:39:26 -07004194 }
4195 return NOTIFY_OK;
4196}
4197
4198/*
4199 * Workqueues should be brought down after normal priority CPU notifiers.
4200 * This will be registered as low priority CPU notifier.
4201 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07004202static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07004203 unsigned long action,
4204 void *hcpu)
4205{
Tejun Heod84ff052013-03-12 11:29:59 -07004206 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07004207 struct work_struct unbind_work;
4208
Tejun Heo65758202012-07-17 12:39:26 -07004209 switch (action & ~CPU_TASKS_FROZEN) {
4210 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07004211 /* unbinding should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08004212 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09004213 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07004214 flush_work(&unbind_work);
4215 break;
Tejun Heo65758202012-07-17 12:39:26 -07004216 }
4217 return NOTIFY_OK;
4218}
4219
Rusty Russell2d3854a2008-11-05 13:39:10 +11004220#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004221
Rusty Russell2d3854a2008-11-05 13:39:10 +11004222struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004223 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004224 long (*fn)(void *);
4225 void *arg;
4226 long ret;
4227};
4228
Tejun Heoed48ece2012-09-18 12:48:43 -07004229static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004230{
Tejun Heoed48ece2012-09-18 12:48:43 -07004231 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4232
Rusty Russell2d3854a2008-11-05 13:39:10 +11004233 wfc->ret = wfc->fn(wfc->arg);
4234}
4235
4236/**
4237 * work_on_cpu - run a function in user context on a particular cpu
4238 * @cpu: the cpu to run on
4239 * @fn: the function to run
4240 * @arg: the function arg
4241 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004242 * This will return the value @fn returns.
4243 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06004244 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004245 */
Tejun Heod84ff052013-03-12 11:29:59 -07004246long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004247{
Tejun Heoed48ece2012-09-18 12:48:43 -07004248 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004249
Tejun Heoed48ece2012-09-18 12:48:43 -07004250 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4251 schedule_work_on(cpu, &wfc.work);
4252 flush_work(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004253 return wfc.ret;
4254}
4255EXPORT_SYMBOL_GPL(work_on_cpu);
4256#endif /* CONFIG_SMP */
4257
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004258#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304259
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004260/**
4261 * freeze_workqueues_begin - begin freezing workqueues
4262 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004263 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004264 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004265 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004266 *
4267 * CONTEXT:
Tejun Heo794b18b2013-03-13 19:47:40 -07004268 * Grabs and releases wq_mutex, pwq_lock and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004269 */
4270void freeze_workqueues_begin(void)
4271{
Tejun Heo17116962013-03-12 11:29:58 -07004272 struct worker_pool *pool;
Tejun Heo24b8a842013-03-12 11:29:58 -07004273 struct workqueue_struct *wq;
4274 struct pool_workqueue *pwq;
Tejun Heo611c92a2013-03-13 16:51:36 -07004275 int pi;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004276
Tejun Heo5bcab332013-03-13 19:47:40 -07004277 mutex_lock(&wq_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004278
Tejun Heo6183c002013-03-12 11:29:57 -07004279 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004280 workqueue_freezing = true;
4281
Tejun Heo24b8a842013-03-12 11:29:58 -07004282 /* set FREEZING */
Tejun Heo611c92a2013-03-13 16:51:36 -07004283 for_each_pool(pool, pi) {
Tejun Heo5bcab332013-03-13 19:47:40 -07004284 spin_lock_irq(&pool->lock);
Tejun Heo17116962013-03-12 11:29:58 -07004285 WARN_ON_ONCE(pool->flags & POOL_FREEZING);
4286 pool->flags |= POOL_FREEZING;
Tejun Heo5bcab332013-03-13 19:47:40 -07004287 spin_unlock_irq(&pool->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004288 }
4289
Tejun Heo24b8a842013-03-12 11:29:58 -07004290 /* suppress further executions by setting max_active to zero */
Tejun Heo794b18b2013-03-13 19:47:40 -07004291 spin_lock_irq(&pwq_lock);
Tejun Heo24b8a842013-03-12 11:29:58 -07004292 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo699ce092013-03-13 16:51:35 -07004293 for_each_pwq(pwq, wq)
4294 pwq_adjust_max_active(pwq);
Tejun Heo24b8a842013-03-12 11:29:58 -07004295 }
Tejun Heo794b18b2013-03-13 19:47:40 -07004296 spin_unlock_irq(&pwq_lock);
Tejun Heo5bcab332013-03-13 19:47:40 -07004297
4298 mutex_unlock(&wq_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004299}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004300
4301/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004302 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004303 *
4304 * Check whether freezing is complete. This function must be called
4305 * between freeze_workqueues_begin() and thaw_workqueues().
4306 *
4307 * CONTEXT:
Tejun Heo5bcab332013-03-13 19:47:40 -07004308 * Grabs and releases wq_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004309 *
4310 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004311 * %true if some freezable workqueues are still busy. %false if freezing
4312 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004313 */
4314bool freeze_workqueues_busy(void)
4315{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004316 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004317 struct workqueue_struct *wq;
4318 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004319
Tejun Heo5bcab332013-03-13 19:47:40 -07004320 mutex_lock(&wq_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004321
Tejun Heo6183c002013-03-12 11:29:57 -07004322 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004323
Tejun Heo24b8a842013-03-12 11:29:58 -07004324 list_for_each_entry(wq, &workqueues, list) {
4325 if (!(wq->flags & WQ_FREEZABLE))
4326 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004327 /*
4328 * nr_active is monotonically decreasing. It's safe
4329 * to peek without lock.
4330 */
Tejun Heo5bcab332013-03-13 19:47:40 -07004331 preempt_disable();
Tejun Heo24b8a842013-03-12 11:29:58 -07004332 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004333 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004334 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004335 busy = true;
Tejun Heo5bcab332013-03-13 19:47:40 -07004336 preempt_enable();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004337 goto out_unlock;
4338 }
4339 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004340 preempt_enable();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004341 }
4342out_unlock:
Tejun Heo5bcab332013-03-13 19:47:40 -07004343 mutex_unlock(&wq_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004344 return busy;
4345}
4346
4347/**
4348 * thaw_workqueues - thaw workqueues
4349 *
4350 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004351 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004352 *
4353 * CONTEXT:
Tejun Heo794b18b2013-03-13 19:47:40 -07004354 * Grabs and releases wq_mutex, pwq_lock and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004355 */
4356void thaw_workqueues(void)
4357{
Tejun Heo24b8a842013-03-12 11:29:58 -07004358 struct workqueue_struct *wq;
4359 struct pool_workqueue *pwq;
4360 struct worker_pool *pool;
Tejun Heo611c92a2013-03-13 16:51:36 -07004361 int pi;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004362
Tejun Heo5bcab332013-03-13 19:47:40 -07004363 mutex_lock(&wq_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004364
4365 if (!workqueue_freezing)
4366 goto out_unlock;
4367
Tejun Heo24b8a842013-03-12 11:29:58 -07004368 /* clear FREEZING */
Tejun Heo611c92a2013-03-13 16:51:36 -07004369 for_each_pool(pool, pi) {
Tejun Heo5bcab332013-03-13 19:47:40 -07004370 spin_lock_irq(&pool->lock);
Tejun Heo24b8a842013-03-12 11:29:58 -07004371 WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
4372 pool->flags &= ~POOL_FREEZING;
Tejun Heo5bcab332013-03-13 19:47:40 -07004373 spin_unlock_irq(&pool->lock);
Tejun Heo24b8a842013-03-12 11:29:58 -07004374 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02004375
Tejun Heo24b8a842013-03-12 11:29:58 -07004376 /* restore max_active and repopulate worklist */
Tejun Heo794b18b2013-03-13 19:47:40 -07004377 spin_lock_irq(&pwq_lock);
Tejun Heo24b8a842013-03-12 11:29:58 -07004378 list_for_each_entry(wq, &workqueues, list) {
Tejun Heo699ce092013-03-13 16:51:35 -07004379 for_each_pwq(pwq, wq)
4380 pwq_adjust_max_active(pwq);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004381 }
Tejun Heo794b18b2013-03-13 19:47:40 -07004382 spin_unlock_irq(&pwq_lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004383
Tejun Heo24b8a842013-03-12 11:29:58 -07004384 /* kick workers */
Tejun Heo611c92a2013-03-13 16:51:36 -07004385 for_each_pool(pool, pi) {
Tejun Heo5bcab332013-03-13 19:47:40 -07004386 spin_lock_irq(&pool->lock);
Tejun Heo24b8a842013-03-12 11:29:58 -07004387 wake_up_worker(pool);
Tejun Heo5bcab332013-03-13 19:47:40 -07004388 spin_unlock_irq(&pool->lock);
Tejun Heo24b8a842013-03-12 11:29:58 -07004389 }
4390
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004391 workqueue_freezing = false;
4392out_unlock:
Tejun Heo5bcab332013-03-13 19:47:40 -07004393 mutex_unlock(&wq_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004394}
4395#endif /* CONFIG_FREEZER */
4396
Suresh Siddha6ee05782010-07-30 14:57:37 -07004397static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004398{
Tejun Heo7a4e3442013-03-12 11:30:00 -07004399 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
4400 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02004401
Tejun Heo7c3eed52013-01-24 11:01:33 -08004402 /* make sure we have enough bits for OFFQ pool ID */
4403 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT)) <
Lai Jiangshan6be19582013-02-06 18:04:53 -08004404 WORK_CPU_END * NR_STD_WORKER_POOLS);
Tejun Heob5490072012-08-03 10:30:46 -07004405
Tejun Heoe904e6c2013-03-12 11:29:57 -07004406 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
4407
4408 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
4409
Tejun Heo65758202012-07-17 12:39:26 -07004410 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07004411 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02004412
Tejun Heo706026c2013-01-24 11:01:34 -08004413 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07004414 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07004415 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004416
Tejun Heo7a4e3442013-03-12 11:30:00 -07004417 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07004418 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07004419 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08004420 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07004421 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07004422 pool->attrs->nice = std_nice[i++];
4423
Tejun Heo9daf9e62013-01-24 11:01:33 -08004424 /* alloc pool ID */
Tejun Heo5bcab332013-03-13 19:47:40 -07004425 mutex_lock(&wq_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08004426 BUG_ON(worker_pool_assign_id(pool));
Tejun Heo5bcab332013-03-13 19:47:40 -07004427 mutex_unlock(&wq_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07004428 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02004429 }
4430
Tejun Heoe22bee72010-06-29 10:07:14 +02004431 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07004432 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07004433 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02004434
Tejun Heof02ae732013-03-12 11:30:03 -07004435 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07004436 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoebf44d12013-03-13 19:47:39 -07004437 BUG_ON(create_and_start_worker(pool) < 0);
Tejun Heo4ce62e92012-07-13 22:16:44 -07004438 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004439 }
4440
Tejun Heo29c91e92013-03-12 11:30:03 -07004441 /* create default unbound wq attrs */
4442 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
4443 struct workqueue_attrs *attrs;
4444
4445 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
4446
4447 attrs->nice = std_nice[i];
4448 cpumask_setall(attrs->cpumask);
4449
4450 unbound_std_wq_attrs[i] = attrs;
4451 }
4452
Tejun Heod320c032010-06-29 10:07:14 +02004453 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09004454 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02004455 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02004456 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
4457 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01004458 system_freezable_wq = alloc_workqueue("events_freezable",
4459 WQ_FREEZABLE, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09004460 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Tejun Heoae930e02012-08-20 14:51:23 -07004461 !system_unbound_wq || !system_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07004462 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004463}
Suresh Siddha6ee05782010-07-30 14:57:37 -07004464early_initcall(init_workqueues);