blob: 4c53fa216732a0f468b764cdeefc45bf736197ab [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 Heobce90382013-04-01 11:23:32 -070047#include <linux/nodemask.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020048
Tejun Heoea138442013-01-18 14:05:55 -080049#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Tejun Heoc8e55f32010-06-29 10:07:12 +020051enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070052 /*
Tejun Heo24647572013-01-24 11:01:33 -080053 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070054 *
Tejun Heo24647572013-01-24 11:01:33 -080055 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070056 * While associated (!DISASSOCIATED), all workers are bound to the
57 * CPU and none has %WORKER_UNBOUND set and concurrency management
58 * is in effect.
59 *
60 * While DISASSOCIATED, the cpu may be offline and all workers have
61 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080062 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070063 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070064 * Note that DISASSOCIATED should be flipped only while holding
65 * manager_mutex to avoid changing binding state while
Tejun Heo24647572013-01-24 11:01:33 -080066 * create_worker() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070067 */
Tejun Heo11ebea52012-07-12 14:46:37 -070068 POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */
Tejun Heo24647572013-01-24 11:01:33 -080069 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heo35b6bb62013-01-24 11:01:33 -080070 POOL_FREEZING = 1 << 3, /* freeze in progress */
Tejun Heodb7bccf2010-06-29 10:07:12 +020071
Tejun Heoc8e55f32010-06-29 10:07:12 +020072 /* worker flags */
73 WORKER_STARTED = 1 << 0, /* started */
74 WORKER_DIE = 1 << 1, /* die die die */
75 WORKER_IDLE = 1 << 2, /* is idle */
Tejun Heoe22bee72010-06-29 10:07:14 +020076 WORKER_PREP = 1 << 3, /* preparing to run works */
Tejun Heofb0e7be2010-06-29 10:07:15 +020077 WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */
Tejun Heof3421792010-07-02 10:03:51 +020078 WORKER_UNBOUND = 1 << 7, /* worker is unbound */
Tejun Heoa9ab7752013-03-19 13:45:21 -070079 WORKER_REBOUND = 1 << 8, /* worker was rebound */
Tejun Heoe22bee72010-06-29 10:07:14 +020080
Tejun Heoa9ab7752013-03-19 13:45:21 -070081 WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE |
82 WORKER_UNBOUND | WORKER_REBOUND,
Tejun Heodb7bccf2010-06-29 10:07:12 +020083
Tejun Heoe34cdddb2013-01-24 11:01:33 -080084 NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */
Tejun Heo4ce62e92012-07-13 22:16:44 -070085
Tejun Heo29c91e92013-03-12 11:30:03 -070086 UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */
Tejun Heoc8e55f32010-06-29 10:07:12 +020087 BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020088
Tejun Heoe22bee72010-06-29 10:07:14 +020089 MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */
90 IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */
91
Tejun Heo3233cdb2011-02-16 18:10:19 +010092 MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2,
93 /* call for help after 10ms
94 (min two ticks) */
Tejun Heoe22bee72010-06-29 10:07:14 +020095 MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */
96 CREATE_COOLDOWN = HZ, /* time to breath after fail */
Tejun Heoe22bee72010-06-29 10:07:14 +020097
98 /*
99 * Rescue workers are used only on emergencies and shared by
100 * all cpus. Give -20.
101 */
102 RESCUER_NICE_LEVEL = -20,
Tejun Heo32704762012-07-13 22:16:45 -0700103 HIGHPRI_NICE_LEVEL = -20,
Tejun Heoecf68812013-04-01 11:23:34 -0700104
105 WQ_NAME_LEN = 24,
Tejun Heoc8e55f32010-06-29 10:07:12 +0200106};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108/*
Tejun Heo4690c4a2010-06-29 10:07:10 +0200109 * Structure fields follow one of the following exclusion rules.
110 *
Tejun Heoe41e7042010-08-24 14:22:47 +0200111 * I: Modifiable by initialization/destruction paths and read-only for
112 * everyone else.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200113 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200114 * P: Preemption protected. Disabling preemption is enough and should
115 * only be modified and accessed from the local cpu.
116 *
Tejun Heod565ed62013-01-24 11:01:33 -0800117 * L: pool->lock protected. Access with pool->lock held.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200118 *
Tejun Heod565ed62013-01-24 11:01:33 -0800119 * X: During normal operation, modification requires pool->lock and should
120 * be done only from local cpu. Either disabling preemption on local
121 * cpu or grabbing pool->lock is enough for read access. If
122 * POOL_DISASSOCIATED is set, it's identical to L.
Tejun Heoe22bee72010-06-29 10:07:14 +0200123 *
Tejun Heo822d8402013-03-19 13:45:21 -0700124 * MG: pool->manager_mutex and pool->lock protected. Writes require both
125 * locks. Reads can happen under either lock.
126 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700127 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700128 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700129 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700130 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700131 * WQ: wq->mutex protected.
132 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700133 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700134 *
135 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200136 */
137
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800138/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200139
Tejun Heobd7bdd42012-07-12 14:46:37 -0700140struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800141 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700142 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700143 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800144 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700145 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700146
147 struct list_head worklist; /* L: list of pending works */
148 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700149
150 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700151 int nr_idle; /* L: currently idle ones */
152
153 struct list_head idle_list; /* X: list of idle workers */
154 struct timer_list idle_timer; /* L: worker idle timeout */
155 struct timer_list mayday_timer; /* L: SOS timer for workers */
156
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700157 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800158 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
159 /* L: hash of busy workers */
160
Tejun Heobc3a1af2013-03-13 19:47:39 -0700161 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo34a06bd2013-03-12 11:30:00 -0700162 struct mutex manager_arb; /* manager arbitration */
Tejun Heobc3a1af2013-03-13 19:47:39 -0700163 struct mutex manager_mutex; /* manager exclusion */
Tejun Heo822d8402013-03-19 13:45:21 -0700164 struct idr worker_idr; /* MG: worker IDs and iteration */
Tejun Heoe19e3972013-01-24 11:39:44 -0800165
Tejun Heo7a4e3442013-03-12 11:30:00 -0700166 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700167 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
168 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700169
Tejun Heoe19e3972013-01-24 11:39:44 -0800170 /*
171 * The current concurrency level. As it's likely to be accessed
172 * from other CPUs during try_to_wake_up(), put it in a separate
173 * cacheline.
174 */
175 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700176
177 /*
178 * Destruction of pool is sched-RCU protected to allow dereferences
179 * from get_work_pool().
180 */
181 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200182} ____cacheline_aligned_in_smp;
183
184/*
Tejun Heo112202d2013-02-13 19:29:12 -0800185 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
186 * of work_struct->data are used for flags and the remaining high bits
187 * point to the pwq; thus, pwqs need to be aligned at two's power of the
188 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 */
Tejun Heo112202d2013-02-13 19:29:12 -0800190struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700191 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200192 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200193 int work_color; /* L: current color */
194 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700195 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200196 int nr_in_flight[WORK_NR_COLORS];
197 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200198 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200199 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200200 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700201 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700202 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700203
204 /*
205 * Release of unbound pwq is punted to system_wq. See put_pwq()
206 * and pwq_unbound_release_workfn() for details. pool_workqueue
207 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700208 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700209 */
210 struct work_struct unbound_release_work;
211 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700212} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200215 * Structure used to wait for workqueue flush.
216 */
217struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700218 struct list_head list; /* WQ: list of flushers */
219 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200220 struct completion done; /* flush completion */
221};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Tejun Heo226223a2013-03-12 11:30:05 -0700223struct wq_device;
224
Tejun Heo73f53c42010-06-29 10:07:11 +0200225/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700226 * The externally visible workqueue. It relays the issued work items to
227 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 */
229struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700230 struct list_head pwqs; /* WR: all pwqs of this wq */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700231 struct list_head list; /* PL: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200232
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700233 struct mutex mutex; /* protects this wq */
234 int work_color; /* WQ: current work color */
235 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800236 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700237 struct wq_flusher *first_flusher; /* WQ: first flusher */
238 struct list_head flusher_queue; /* WQ: flush waiters */
239 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200240
Tejun Heo2e109a22013-03-13 19:47:40 -0700241 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200242 struct worker *rescuer; /* I: rescue worker */
243
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700244 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700245 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700246
Tejun Heo6029a912013-04-01 11:23:34 -0700247 struct workqueue_attrs *unbound_attrs; /* WQ: only for unbound wqs */
248
Tejun Heo226223a2013-03-12 11:30:05 -0700249#ifdef CONFIG_SYSFS
250 struct wq_device *wq_dev; /* I: for sysfs interface */
251#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700252#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200253 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700254#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700255 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700256
257 /* hot fields used during command issue, aligned to cacheline */
258 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
259 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260};
261
Tejun Heoe904e6c2013-03-12 11:29:57 -0700262static struct kmem_cache *pwq_cache;
263
Tejun Heobce90382013-04-01 11:23:32 -0700264static int wq_numa_tbl_len; /* highest possible NUMA node id + 1 */
265static cpumask_var_t *wq_numa_possible_cpumask;
266 /* possible CPUs of each node */
267
268static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
269
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700270static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700271static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo5bcab332013-03-13 19:47:40 -0700272
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700273static LIST_HEAD(workqueues); /* PL: list of all workqueues */
274static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700275
276/* the per-cpu worker pools */
277static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
278 cpu_worker_pools);
279
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700280static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700281
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700282/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700283static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
284
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700285/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700286static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
287
Tejun Heod320c032010-06-29 10:07:14 +0200288struct workqueue_struct *system_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200289EXPORT_SYMBOL_GPL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300290struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900291EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300292struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200293EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300294struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200295EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300296struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100297EXPORT_SYMBOL_GPL(system_freezable_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200298
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700299static int worker_thread(void *__worker);
300static void copy_workqueue_attrs(struct workqueue_attrs *to,
301 const struct workqueue_attrs *from);
302
Tejun Heo97bd2342010-10-05 10:41:14 +0200303#define CREATE_TRACE_POINTS
304#include <trace/events/workqueue.h>
305
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700306#define assert_rcu_or_pool_mutex() \
Tejun Heo5bcab332013-03-13 19:47:40 -0700307 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700308 lockdep_is_held(&wq_pool_mutex), \
309 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700310
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700311#define assert_rcu_or_wq_mutex(wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700312 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshanb5927602013-03-25 16:57:19 -0700313 lockdep_is_held(&wq->mutex), \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700314 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700315
Tejun Heo822d8402013-03-19 13:45:21 -0700316#ifdef CONFIG_LOCKDEP
317#define assert_manager_or_pool_lock(pool) \
Lai Jiangshan519e3c12013-03-20 03:28:21 +0800318 WARN_ONCE(debug_locks && \
319 !lockdep_is_held(&(pool)->manager_mutex) && \
Tejun Heo822d8402013-03-19 13:45:21 -0700320 !lockdep_is_held(&(pool)->lock), \
321 "pool->manager_mutex or ->lock should be held")
322#else
323#define assert_manager_or_pool_lock(pool) do { } while (0)
324#endif
325
Tejun Heof02ae732013-03-12 11:30:03 -0700326#define for_each_cpu_worker_pool(pool, cpu) \
327 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
328 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700329 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700330
Tejun Heo49e3cf42013-03-12 11:29:58 -0700331/**
Tejun Heo17116962013-03-12 11:29:58 -0700332 * for_each_pool - iterate through all worker_pools in the system
333 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700334 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700335 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700336 * This must be called either with wq_pool_mutex held or sched RCU read
337 * locked. If the pool needs to be used beyond the locking in effect, the
338 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700339 *
340 * The if/else clause exists only for the lockdep assertion and can be
341 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700342 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700343#define for_each_pool(pool, pi) \
344 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700345 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700346 else
Tejun Heo17116962013-03-12 11:29:58 -0700347
348/**
Tejun Heo822d8402013-03-19 13:45:21 -0700349 * for_each_pool_worker - iterate through all workers of a worker_pool
350 * @worker: iteration cursor
351 * @wi: integer used for iteration
352 * @pool: worker_pool to iterate workers of
353 *
354 * This must be called with either @pool->manager_mutex or ->lock held.
355 *
356 * The if/else clause exists only for the lockdep assertion and can be
357 * ignored.
358 */
359#define for_each_pool_worker(worker, wi, pool) \
360 idr_for_each_entry(&(pool)->worker_idr, (worker), (wi)) \
361 if (({ assert_manager_or_pool_lock((pool)); false; })) { } \
362 else
363
364/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700365 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
366 * @pwq: iteration cursor
367 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700368 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700369 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700370 * If the pwq needs to be used beyond the locking in effect, the caller is
371 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700372 *
373 * The if/else clause exists only for the lockdep assertion and can be
374 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700375 */
376#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700377 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700378 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700379 else
Tejun Heof3421792010-07-02 10:03:51 +0200380
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900381#ifdef CONFIG_DEBUG_OBJECTS_WORK
382
383static struct debug_obj_descr work_debug_descr;
384
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100385static void *work_debug_hint(void *addr)
386{
387 return ((struct work_struct *) addr)->func;
388}
389
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900390/*
391 * fixup_init is called when:
392 * - an active object is initialized
393 */
394static int work_fixup_init(void *addr, enum debug_obj_state state)
395{
396 struct work_struct *work = addr;
397
398 switch (state) {
399 case ODEBUG_STATE_ACTIVE:
400 cancel_work_sync(work);
401 debug_object_init(work, &work_debug_descr);
402 return 1;
403 default:
404 return 0;
405 }
406}
407
408/*
409 * fixup_activate is called when:
410 * - an active object is activated
411 * - an unknown object is activated (might be a statically initialized object)
412 */
413static int work_fixup_activate(void *addr, enum debug_obj_state state)
414{
415 struct work_struct *work = addr;
416
417 switch (state) {
418
419 case ODEBUG_STATE_NOTAVAILABLE:
420 /*
421 * This is not really a fixup. The work struct was
422 * statically initialized. We just make sure that it
423 * is tracked in the object tracker.
424 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200425 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900426 debug_object_init(work, &work_debug_descr);
427 debug_object_activate(work, &work_debug_descr);
428 return 0;
429 }
430 WARN_ON_ONCE(1);
431 return 0;
432
433 case ODEBUG_STATE_ACTIVE:
434 WARN_ON(1);
435
436 default:
437 return 0;
438 }
439}
440
441/*
442 * fixup_free is called when:
443 * - an active object is freed
444 */
445static int work_fixup_free(void *addr, enum debug_obj_state state)
446{
447 struct work_struct *work = addr;
448
449 switch (state) {
450 case ODEBUG_STATE_ACTIVE:
451 cancel_work_sync(work);
452 debug_object_free(work, &work_debug_descr);
453 return 1;
454 default:
455 return 0;
456 }
457}
458
459static struct debug_obj_descr work_debug_descr = {
460 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100461 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900462 .fixup_init = work_fixup_init,
463 .fixup_activate = work_fixup_activate,
464 .fixup_free = work_fixup_free,
465};
466
467static inline void debug_work_activate(struct work_struct *work)
468{
469 debug_object_activate(work, &work_debug_descr);
470}
471
472static inline void debug_work_deactivate(struct work_struct *work)
473{
474 debug_object_deactivate(work, &work_debug_descr);
475}
476
477void __init_work(struct work_struct *work, int onstack)
478{
479 if (onstack)
480 debug_object_init_on_stack(work, &work_debug_descr);
481 else
482 debug_object_init(work, &work_debug_descr);
483}
484EXPORT_SYMBOL_GPL(__init_work);
485
486void destroy_work_on_stack(struct work_struct *work)
487{
488 debug_object_free(work, &work_debug_descr);
489}
490EXPORT_SYMBOL_GPL(destroy_work_on_stack);
491
492#else
493static inline void debug_work_activate(struct work_struct *work) { }
494static inline void debug_work_deactivate(struct work_struct *work) { }
495#endif
496
Tejun Heo9daf9e62013-01-24 11:01:33 -0800497/* allocate ID and assign it to @pool */
498static int worker_pool_assign_id(struct worker_pool *pool)
499{
500 int ret;
501
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700502 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700503
Tejun Heofa1b54e2013-03-12 11:30:00 -0700504 do {
505 if (!idr_pre_get(&worker_pool_idr, GFP_KERNEL))
506 return -ENOMEM;
Tejun Heofa1b54e2013-03-12 11:30:00 -0700507 ret = idr_get_new(&worker_pool_idr, pool, &pool->id);
Tejun Heofa1b54e2013-03-12 11:30:00 -0700508 } while (ret == -EAGAIN);
Tejun Heo9daf9e62013-01-24 11:01:33 -0800509
510 return ret;
511}
512
Tejun Heo76af4d92013-03-12 11:30:00 -0700513/**
514 * first_pwq - return the first pool_workqueue of the specified workqueue
515 * @wq: the target workqueue
516 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700517 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700518 * If the pwq needs to be used beyond the locking in effect, the caller is
519 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700520 */
Tejun Heo7fb98ea2013-03-12 11:30:00 -0700521static struct pool_workqueue *first_pwq(struct workqueue_struct *wq)
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700522{
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700523 assert_rcu_or_wq_mutex(wq);
Tejun Heo76af4d92013-03-12 11:30:00 -0700524 return list_first_or_null_rcu(&wq->pwqs, struct pool_workqueue,
525 pwqs_node);
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700526}
527
Tejun Heo73f53c42010-06-29 10:07:11 +0200528static unsigned int work_color_to_flags(int color)
529{
530 return color << WORK_STRUCT_COLOR_SHIFT;
531}
532
533static int get_work_color(struct work_struct *work)
534{
535 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
536 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
537}
538
539static int work_next_color(int color)
540{
541 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -0700542}
543
David Howells4594bf12006-12-07 11:33:26 +0000544/*
Tejun Heo112202d2013-02-13 19:29:12 -0800545 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
546 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800547 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200548 *
Tejun Heo112202d2013-02-13 19:29:12 -0800549 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
550 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700551 * work->data. These functions should only be called while the work is
552 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200553 *
Tejun Heo112202d2013-02-13 19:29:12 -0800554 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800555 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800556 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800557 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700558 *
559 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
560 * canceled. While being canceled, a work item may have its PENDING set
561 * but stay off timer and worklist for arbitrarily long and nobody should
562 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000563 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200564static inline void set_work_data(struct work_struct *work, unsigned long data,
565 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000566{
Tejun Heo6183c002013-03-12 11:29:57 -0700567 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200568 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000569}
David Howells365970a2006-11-22 14:54:49 +0000570
Tejun Heo112202d2013-02-13 19:29:12 -0800571static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200572 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200573{
Tejun Heo112202d2013-02-13 19:29:12 -0800574 set_work_data(work, (unsigned long)pwq,
575 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200576}
577
Lai Jiangshan4468a002013-02-06 18:04:53 -0800578static void set_work_pool_and_keep_pending(struct work_struct *work,
579 int pool_id)
580{
581 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
582 WORK_STRUCT_PENDING);
583}
584
Tejun Heo7c3eed52013-01-24 11:01:33 -0800585static void set_work_pool_and_clear_pending(struct work_struct *work,
586 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000587{
Tejun Heo23657bb2012-08-13 17:08:19 -0700588 /*
589 * The following wmb is paired with the implied mb in
590 * test_and_set_bit(PENDING) and ensures all updates to @work made
591 * here are visible to and precede any updates by the next PENDING
592 * owner.
593 */
594 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800595 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200596}
597
598static void clear_work_data(struct work_struct *work)
599{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800600 smp_wmb(); /* see set_work_pool_and_clear_pending() */
601 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200602}
603
Tejun Heo112202d2013-02-13 19:29:12 -0800604static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200605{
Tejun Heoe1201532010-07-22 14:14:25 +0200606 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200607
Tejun Heo112202d2013-02-13 19:29:12 -0800608 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200609 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
610 else
611 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200612}
613
Tejun Heo7c3eed52013-01-24 11:01:33 -0800614/**
615 * get_work_pool - return the worker_pool a given work was associated with
616 * @work: the work item of interest
617 *
618 * Return the worker_pool @work was last associated with. %NULL if none.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700619 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700620 * Pools are created and destroyed under wq_pool_mutex, and allows read
621 * access under sched-RCU read lock. As such, this function should be
622 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700623 *
624 * All fields of the returned pool are accessible as long as the above
625 * mentioned locking is in effect. If the returned pool needs to be used
626 * beyond the critical section, the caller is responsible for ensuring the
627 * returned pool is and stays online.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800628 */
629static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200630{
Tejun Heoe1201532010-07-22 14:14:25 +0200631 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800632 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200633
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700634 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700635
Tejun Heo112202d2013-02-13 19:29:12 -0800636 if (data & WORK_STRUCT_PWQ)
637 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800638 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200639
Tejun Heo7c3eed52013-01-24 11:01:33 -0800640 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
641 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200642 return NULL;
643
Tejun Heofa1b54e2013-03-12 11:30:00 -0700644 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800645}
646
647/**
648 * get_work_pool_id - return the worker pool ID a given work is associated with
649 * @work: the work item of interest
650 *
651 * Return the worker_pool ID @work was last associated with.
652 * %WORK_OFFQ_POOL_NONE if none.
653 */
654static int get_work_pool_id(struct work_struct *work)
655{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800656 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800657
Tejun Heo112202d2013-02-13 19:29:12 -0800658 if (data & WORK_STRUCT_PWQ)
659 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800660 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
661
662 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800663}
664
Tejun Heobbb68df2012-08-03 10:30:46 -0700665static void mark_work_canceling(struct work_struct *work)
666{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800667 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700668
Tejun Heo7c3eed52013-01-24 11:01:33 -0800669 pool_id <<= WORK_OFFQ_POOL_SHIFT;
670 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700671}
672
673static bool work_is_canceling(struct work_struct *work)
674{
675 unsigned long data = atomic_long_read(&work->data);
676
Tejun Heo112202d2013-02-13 19:29:12 -0800677 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700678}
679
David Howells365970a2006-11-22 14:54:49 +0000680/*
Tejun Heo32704762012-07-13 22:16:45 -0700681 * Policy functions. These define the policies on how the global worker
682 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800683 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000684 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200685
Tejun Heo63d95a92012-07-12 14:46:37 -0700686static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000687{
Tejun Heoe19e3972013-01-24 11:39:44 -0800688 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000689}
690
Tejun Heoe22bee72010-06-29 10:07:14 +0200691/*
692 * Need to wake up a worker? Called from anything but currently
693 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700694 *
695 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800696 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700697 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200698 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700699static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000700{
Tejun Heo63d95a92012-07-12 14:46:37 -0700701 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000702}
703
Tejun Heoe22bee72010-06-29 10:07:14 +0200704/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700705static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200706{
Tejun Heo63d95a92012-07-12 14:46:37 -0700707 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200708}
709
710/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700711static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200712{
Tejun Heoe19e3972013-01-24 11:39:44 -0800713 return !list_empty(&pool->worklist) &&
714 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200715}
716
717/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700718static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200719{
Tejun Heo63d95a92012-07-12 14:46:37 -0700720 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200721}
722
723/* Do I need to be the manager? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700724static bool need_to_manage_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200725{
Tejun Heo63d95a92012-07-12 14:46:37 -0700726 return need_to_create_worker(pool) ||
Tejun Heo11ebea52012-07-12 14:46:37 -0700727 (pool->flags & POOL_MANAGE_WORKERS);
Tejun Heoe22bee72010-06-29 10:07:14 +0200728}
729
730/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700731static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200732{
Tejun Heo34a06bd2013-03-12 11:30:00 -0700733 bool managing = mutex_is_locked(&pool->manager_arb);
Tejun Heo63d95a92012-07-12 14:46:37 -0700734 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
735 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200736
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700737 /*
738 * nr_idle and idle_list may disagree if idle rebinding is in
739 * progress. Never return %true if idle_list is empty.
740 */
741 if (list_empty(&pool->idle_list))
742 return false;
743
Tejun Heoe22bee72010-06-29 10:07:14 +0200744 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
745}
746
747/*
748 * Wake up functions.
749 */
750
Tejun Heo7e116292010-06-29 10:07:13 +0200751/* Return the first worker. Safe with preemption disabled */
Tejun Heo63d95a92012-07-12 14:46:37 -0700752static struct worker *first_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200753{
Tejun Heo63d95a92012-07-12 14:46:37 -0700754 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200755 return NULL;
756
Tejun Heo63d95a92012-07-12 14:46:37 -0700757 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200758}
759
760/**
761 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700762 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200763 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700764 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200765 *
766 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800767 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200768 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700769static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200770{
Tejun Heo63d95a92012-07-12 14:46:37 -0700771 struct worker *worker = first_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200772
773 if (likely(worker))
774 wake_up_process(worker->task);
775}
776
Tejun Heo4690c4a2010-06-29 10:07:10 +0200777/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200778 * wq_worker_waking_up - a worker is waking up
779 * @task: task waking up
780 * @cpu: CPU @task is waking up to
781 *
782 * This function is called during try_to_wake_up() when a worker is
783 * being awoken.
784 *
785 * CONTEXT:
786 * spin_lock_irq(rq->lock)
787 */
Tejun Heod84ff052013-03-12 11:29:59 -0700788void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200789{
790 struct worker *worker = kthread_data(task);
791
Joonsoo Kim36576002012-10-26 23:03:49 +0900792 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800793 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800794 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900795 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200796}
797
798/**
799 * wq_worker_sleeping - a worker is going to sleep
800 * @task: task going to sleep
801 * @cpu: CPU in question, must be the current CPU number
802 *
803 * This function is called during schedule() when a busy worker is
804 * going to sleep. Worker on the same cpu can be woken up by
805 * returning pointer to its task.
806 *
807 * CONTEXT:
808 * spin_lock_irq(rq->lock)
809 *
810 * RETURNS:
811 * Worker task on @cpu to wake up, %NULL if none.
812 */
Tejun Heod84ff052013-03-12 11:29:59 -0700813struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200814{
815 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800816 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200817
Tejun Heo111c2252013-01-17 17:16:24 -0800818 /*
819 * Rescuers, which may not have all the fields set up like normal
820 * workers, also reach here, let's not access anything before
821 * checking NOT_RUNNING.
822 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500823 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200824 return NULL;
825
Tejun Heo111c2252013-01-17 17:16:24 -0800826 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800827
Tejun Heoe22bee72010-06-29 10:07:14 +0200828 /* this can only happen on the local cpu */
Tejun Heo6183c002013-03-12 11:29:57 -0700829 if (WARN_ON_ONCE(cpu != raw_smp_processor_id()))
830 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200831
832 /*
833 * The counterpart of the following dec_and_test, implied mb,
834 * worklist not empty test sequence is in insert_work().
835 * Please read comment there.
836 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700837 * NOT_RUNNING is clear. This means that we're bound to and
838 * running on the local cpu w/ rq lock held and preemption
839 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800840 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700841 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200842 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800843 if (atomic_dec_and_test(&pool->nr_running) &&
844 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700845 to_wakeup = first_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200846 return to_wakeup ? to_wakeup->task : NULL;
847}
848
849/**
850 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200851 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200852 * @flags: flags to set
853 * @wakeup: wakeup an idle worker if necessary
854 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200855 * Set @flags in @worker->flags and adjust nr_running accordingly. If
856 * nr_running becomes zero and @wakeup is %true, an idle worker is
857 * woken up.
Tejun Heod302f012010-06-29 10:07:13 +0200858 *
Tejun Heocb444762010-07-02 10:03:50 +0200859 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800860 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200861 */
862static inline void worker_set_flags(struct worker *worker, unsigned int flags,
863 bool wakeup)
864{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700865 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200866
Tejun Heocb444762010-07-02 10:03:50 +0200867 WARN_ON_ONCE(worker->task != current);
868
Tejun Heoe22bee72010-06-29 10:07:14 +0200869 /*
870 * If transitioning into NOT_RUNNING, adjust nr_running and
871 * wake up an idle worker as necessary if requested by
872 * @wakeup.
873 */
874 if ((flags & WORKER_NOT_RUNNING) &&
875 !(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoe22bee72010-06-29 10:07:14 +0200876 if (wakeup) {
Tejun Heoe19e3972013-01-24 11:39:44 -0800877 if (atomic_dec_and_test(&pool->nr_running) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -0700878 !list_empty(&pool->worklist))
Tejun Heo63d95a92012-07-12 14:46:37 -0700879 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200880 } else
Tejun Heoe19e3972013-01-24 11:39:44 -0800881 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200882 }
883
Tejun Heod302f012010-06-29 10:07:13 +0200884 worker->flags |= flags;
885}
886
887/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200888 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200889 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200890 * @flags: flags to clear
891 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200892 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200893 *
Tejun Heocb444762010-07-02 10:03:50 +0200894 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800895 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200896 */
897static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
898{
Tejun Heo63d95a92012-07-12 14:46:37 -0700899 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200900 unsigned int oflags = worker->flags;
901
Tejun Heocb444762010-07-02 10:03:50 +0200902 WARN_ON_ONCE(worker->task != current);
903
Tejun Heod302f012010-06-29 10:07:13 +0200904 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200905
Tejun Heo42c025f2011-01-11 15:58:49 +0100906 /*
907 * If transitioning out of NOT_RUNNING, increment nr_running. Note
908 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
909 * of multiple flags, not a single flag.
910 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200911 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
912 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800913 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200914}
915
916/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200917 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800918 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200919 * @work: work to find worker for
920 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800921 * Find a worker which is executing @work on @pool by searching
922 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800923 * to match, its current execution should match the address of @work and
924 * its work function. This is to avoid unwanted dependency between
925 * unrelated work executions through a work item being recycled while still
926 * being executed.
927 *
928 * This is a bit tricky. A work item may be freed once its execution
929 * starts and nothing prevents the freed area from being recycled for
930 * another work item. If the same work item address ends up being reused
931 * before the original execution finishes, workqueue will identify the
932 * recycled work item as currently executing and make it wait until the
933 * current execution finishes, introducing an unwanted dependency.
934 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700935 * This function checks the work item address and work function to avoid
936 * false positives. Note that this isn't complete as one may construct a
937 * work function which can introduce dependency onto itself through a
938 * recycled work item. Well, if somebody wants to shoot oneself in the
939 * foot that badly, there's only so much we can do, and if such deadlock
940 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200941 *
942 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800943 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200944 *
945 * RETURNS:
946 * Pointer to worker which is executing @work if found, NULL
947 * otherwise.
948 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800949static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200950 struct work_struct *work)
951{
Sasha Levin42f85702012-12-17 10:01:23 -0500952 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -0500953
Sasha Levinb67bfe02013-02-27 17:06:00 -0800954 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800955 (unsigned long)work)
956 if (worker->current_work == work &&
957 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500958 return worker;
959
960 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200961}
962
963/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700964 * move_linked_works - move linked works to a list
965 * @work: start of series of works to be scheduled
966 * @head: target list to append @work to
967 * @nextp: out paramter for nested worklist walking
968 *
969 * Schedule linked works starting from @work to @head. Work series to
970 * be scheduled starts at @work and includes any consecutive work with
971 * WORK_STRUCT_LINKED set in its predecessor.
972 *
973 * If @nextp is not NULL, it's updated to point to the next work of
974 * the last scheduled work. This allows move_linked_works() to be
975 * nested inside outer list_for_each_entry_safe().
976 *
977 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800978 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -0700979 */
980static void move_linked_works(struct work_struct *work, struct list_head *head,
981 struct work_struct **nextp)
982{
983 struct work_struct *n;
984
985 /*
986 * Linked worklist will always end before the end of the list,
987 * use NULL for list head.
988 */
989 list_for_each_entry_safe_from(work, n, NULL, entry) {
990 list_move_tail(&work->entry, head);
991 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
992 break;
993 }
994
995 /*
996 * If we're already inside safe list traversal and have moved
997 * multiple works to the scheduled queue, the next position
998 * needs to be updated.
999 */
1000 if (nextp)
1001 *nextp = n;
1002}
1003
Tejun Heo8864b4e2013-03-12 11:30:04 -07001004/**
1005 * get_pwq - get an extra reference on the specified pool_workqueue
1006 * @pwq: pool_workqueue to get
1007 *
1008 * Obtain an extra reference on @pwq. The caller should guarantee that
1009 * @pwq has positive refcnt and be holding the matching pool->lock.
1010 */
1011static void get_pwq(struct pool_workqueue *pwq)
1012{
1013 lockdep_assert_held(&pwq->pool->lock);
1014 WARN_ON_ONCE(pwq->refcnt <= 0);
1015 pwq->refcnt++;
1016}
1017
1018/**
1019 * put_pwq - put a pool_workqueue reference
1020 * @pwq: pool_workqueue to put
1021 *
1022 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1023 * destruction. The caller should be holding the matching pool->lock.
1024 */
1025static void put_pwq(struct pool_workqueue *pwq)
1026{
1027 lockdep_assert_held(&pwq->pool->lock);
1028 if (likely(--pwq->refcnt))
1029 return;
1030 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1031 return;
1032 /*
1033 * @pwq can't be released under pool->lock, bounce to
1034 * pwq_unbound_release_workfn(). This never recurses on the same
1035 * pool->lock as this path is taken only for unbound workqueues and
1036 * the release work item is scheduled on a per-cpu workqueue. To
1037 * avoid lockdep warning, unbound pool->locks are given lockdep
1038 * subclass of 1 in get_unbound_pool().
1039 */
1040 schedule_work(&pwq->unbound_release_work);
1041}
1042
Tejun Heo112202d2013-02-13 19:29:12 -08001043static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001044{
Tejun Heo112202d2013-02-13 19:29:12 -08001045 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001046
1047 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001048 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001049 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001050 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001051}
1052
Tejun Heo112202d2013-02-13 19:29:12 -08001053static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001054{
Tejun Heo112202d2013-02-13 19:29:12 -08001055 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001056 struct work_struct, entry);
1057
Tejun Heo112202d2013-02-13 19:29:12 -08001058 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001059}
1060
Tejun Heobf4ede02012-08-03 10:30:46 -07001061/**
Tejun Heo112202d2013-02-13 19:29:12 -08001062 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1063 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001064 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001065 *
1066 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001067 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001068 *
1069 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001070 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001071 */
Tejun Heo112202d2013-02-13 19:29:12 -08001072static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001073{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001074 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001075 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001076 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001077
Tejun Heo112202d2013-02-13 19:29:12 -08001078 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001079
Tejun Heo112202d2013-02-13 19:29:12 -08001080 pwq->nr_active--;
1081 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001082 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001083 if (pwq->nr_active < pwq->max_active)
1084 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001085 }
1086
1087 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001088 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001089 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001090
1091 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001092 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001093 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001094
Tejun Heo112202d2013-02-13 19:29:12 -08001095 /* this pwq is done, clear flush_color */
1096 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001097
1098 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001099 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001100 * will handle the rest.
1101 */
Tejun Heo112202d2013-02-13 19:29:12 -08001102 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1103 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001104out_put:
1105 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001106}
1107
Tejun Heo36e227d2012-08-03 10:30:46 -07001108/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001109 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001110 * @work: work item to steal
1111 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001112 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001113 *
1114 * Try to grab PENDING bit of @work. This function can handle @work in any
1115 * stable state - idle, on timer or on worklist. Return values are
1116 *
1117 * 1 if @work was pending and we successfully stole PENDING
1118 * 0 if @work was idle and we claimed PENDING
1119 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001120 * -ENOENT if someone else is canceling @work, this state may persist
1121 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001122 *
Tejun Heobbb68df2012-08-03 10:30:46 -07001123 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001124 * interrupted while holding PENDING and @work off queue, irq must be
1125 * disabled on entry. This, combined with delayed_work->timer being
1126 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001127 *
1128 * On successful return, >= 0, irq is disabled and the caller is
1129 * responsible for releasing it using local_irq_restore(*@flags).
1130 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001131 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001132 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001133static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1134 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001135{
Tejun Heod565ed62013-01-24 11:01:33 -08001136 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001137 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001138
Tejun Heobbb68df2012-08-03 10:30:46 -07001139 local_irq_save(*flags);
1140
Tejun Heo36e227d2012-08-03 10:30:46 -07001141 /* try to steal the timer if it exists */
1142 if (is_dwork) {
1143 struct delayed_work *dwork = to_delayed_work(work);
1144
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001145 /*
1146 * dwork->timer is irqsafe. If del_timer() fails, it's
1147 * guaranteed that the timer is not queued anywhere and not
1148 * running on the local CPU.
1149 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001150 if (likely(del_timer(&dwork->timer)))
1151 return 1;
1152 }
1153
1154 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001155 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1156 return 0;
1157
1158 /*
1159 * The queueing is in progress, or it is already queued. Try to
1160 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1161 */
Tejun Heod565ed62013-01-24 11:01:33 -08001162 pool = get_work_pool(work);
1163 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001164 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001165
Tejun Heod565ed62013-01-24 11:01:33 -08001166 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001167 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001168 * work->data is guaranteed to point to pwq only while the work
1169 * item is queued on pwq->wq, and both updating work->data to point
1170 * to pwq on queueing and to pool on dequeueing are done under
1171 * pwq->pool->lock. This in turn guarantees that, if work->data
1172 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001173 * item is currently queued on that pool.
1174 */
Tejun Heo112202d2013-02-13 19:29:12 -08001175 pwq = get_work_pwq(work);
1176 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001177 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001178
Tejun Heo16062832013-02-06 18:04:53 -08001179 /*
1180 * A delayed work item cannot be grabbed directly because
1181 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001182 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001183 * management later on and cause stall. Make sure the work
1184 * item is activated before grabbing.
1185 */
1186 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001187 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001188
Tejun Heo16062832013-02-06 18:04:53 -08001189 list_del_init(&work->entry);
Tejun Heo112202d2013-02-13 19:29:12 -08001190 pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001191
Tejun Heo112202d2013-02-13 19:29:12 -08001192 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001193 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001194
Tejun Heo16062832013-02-06 18:04:53 -08001195 spin_unlock(&pool->lock);
1196 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001197 }
Tejun Heod565ed62013-01-24 11:01:33 -08001198 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001199fail:
1200 local_irq_restore(*flags);
1201 if (work_is_canceling(work))
1202 return -ENOENT;
1203 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001204 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001205}
1206
1207/**
Tejun Heo706026c2013-01-24 11:01:34 -08001208 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001209 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001210 * @work: work to insert
1211 * @head: insertion point
1212 * @extra_flags: extra WORK_STRUCT_* flags to set
1213 *
Tejun Heo112202d2013-02-13 19:29:12 -08001214 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001215 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001216 *
1217 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001218 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001219 */
Tejun Heo112202d2013-02-13 19:29:12 -08001220static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1221 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001222{
Tejun Heo112202d2013-02-13 19:29:12 -08001223 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001224
Tejun Heo4690c4a2010-06-29 10:07:10 +02001225 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001226 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001227 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001228 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001229
1230 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001231 * Ensure either wq_worker_sleeping() sees the above
1232 * list_add_tail() or we see zero nr_running to avoid workers lying
1233 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001234 */
1235 smp_mb();
1236
Tejun Heo63d95a92012-07-12 14:46:37 -07001237 if (__need_more_worker(pool))
1238 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001239}
1240
Tejun Heoc8efcc22010-12-20 19:32:04 +01001241/*
1242 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001243 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001244 */
1245static bool is_chained_work(struct workqueue_struct *wq)
1246{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001247 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001248
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001249 worker = current_wq_worker();
1250 /*
1251 * Return %true iff I'm a worker execuing a work item on @wq. If
1252 * I'm @worker, it's safe to dereference it without locking.
1253 */
Tejun Heo112202d2013-02-13 19:29:12 -08001254 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001255}
1256
Tejun Heod84ff052013-03-12 11:29:59 -07001257static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 struct work_struct *work)
1259{
Tejun Heo112202d2013-02-13 19:29:12 -08001260 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001261 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001262 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001263 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001264 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001265
1266 /*
1267 * While a work item is PENDING && off queue, a task trying to
1268 * steal the PENDING will busy-loop waiting for it to either get
1269 * queued or lose PENDING. Grabbing PENDING and queueing should
1270 * happen with IRQ disabled.
1271 */
1272 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001274 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001275
Tejun Heoc8efcc22010-12-20 19:32:04 +01001276 /* if dying, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001277 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001278 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001279 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001280retry:
Tejun Heoc9178082013-03-12 11:30:04 -07001281 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001282 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo57469822012-08-03 10:30:45 -07001283 if (cpu == WORK_CPU_UNBOUND)
Tejun Heoc7fc77f2010-07-02 10:03:51 +02001284 cpu = raw_smp_processor_id();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001285 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heoc9178082013-03-12 11:30:04 -07001286 } else {
1287 pwq = first_pwq(wq);
1288 }
Tejun Heodbf25762012-08-20 14:51:23 -07001289
Tejun Heoc9178082013-03-12 11:30:04 -07001290 /*
1291 * If @work was previously on a different pool, it might still be
1292 * running there, in which case the work needs to be queued on that
1293 * pool to guarantee non-reentrancy.
1294 */
1295 last_pool = get_work_pool(work);
1296 if (last_pool && last_pool != pwq->pool) {
1297 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001298
Tejun Heoc9178082013-03-12 11:30:04 -07001299 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001300
Tejun Heoc9178082013-03-12 11:30:04 -07001301 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001302
Tejun Heoc9178082013-03-12 11:30:04 -07001303 if (worker && worker->current_pwq->wq == wq) {
1304 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001305 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001306 /* meh... not running there, queue here */
1307 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001308 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001309 }
Tejun Heof3421792010-07-02 10:03:51 +02001310 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001311 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001312 }
1313
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001314 /*
1315 * pwq is determined and locked. For unbound pools, we could have
1316 * raced with pwq release and it could already be dead. If its
1317 * refcnt is zero, repeat pwq selection. Note that pwqs never die
1318 * without another pwq replacing it as the first pwq or while a
1319 * work item is executing on it, so the retying is guaranteed to
1320 * make forward-progress.
1321 */
1322 if (unlikely(!pwq->refcnt)) {
1323 if (wq->flags & WQ_UNBOUND) {
1324 spin_unlock(&pwq->pool->lock);
1325 cpu_relax();
1326 goto retry;
1327 }
1328 /* oops */
1329 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1330 wq->name, cpu);
1331 }
1332
Tejun Heo112202d2013-02-13 19:29:12 -08001333 /* pwq determined, queue */
1334 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001335
Dan Carpenterf5b25522012-04-13 22:06:58 +03001336 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001337 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001338 return;
1339 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001340
Tejun Heo112202d2013-02-13 19:29:12 -08001341 pwq->nr_in_flight[pwq->work_color]++;
1342 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001343
Tejun Heo112202d2013-02-13 19:29:12 -08001344 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001345 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001346 pwq->nr_active++;
1347 worklist = &pwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001348 } else {
1349 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001350 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001351 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001352
Tejun Heo112202d2013-02-13 19:29:12 -08001353 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001354
Tejun Heo112202d2013-02-13 19:29:12 -08001355 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356}
1357
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001358/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001359 * queue_work_on - queue work on specific cpu
1360 * @cpu: CPU number to execute work on
1361 * @wq: workqueue to use
1362 * @work: work to queue
1363 *
Tejun Heod4283e92012-08-03 10:30:44 -07001364 * Returns %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001365 *
1366 * We queue the work to a specific CPU, the caller must ensure it
1367 * can't go away.
1368 */
Tejun Heod4283e92012-08-03 10:30:44 -07001369bool queue_work_on(int cpu, struct workqueue_struct *wq,
1370 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001371{
Tejun Heod4283e92012-08-03 10:30:44 -07001372 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001373 unsigned long flags;
1374
1375 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001376
Tejun Heo22df02b2010-06-29 10:07:10 +02001377 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001378 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001379 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001380 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001381
1382 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001383 return ret;
1384}
1385EXPORT_SYMBOL_GPL(queue_work_on);
1386
Tejun Heod8e794d2012-08-03 10:30:45 -07001387void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388{
David Howells52bad642006-11-22 14:54:01 +00001389 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001391 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001392 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001394EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001396static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1397 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001399 struct timer_list *timer = &dwork->timer;
1400 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001402 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1403 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001404 WARN_ON_ONCE(timer_pending(timer));
1405 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001406
Tejun Heo8852aac2012-12-01 16:23:42 -08001407 /*
1408 * If @delay is 0, queue @dwork->work immediately. This is for
1409 * both optimization and correctness. The earliest @timer can
1410 * expire is on the closest next tick and delayed_work users depend
1411 * on that there's no such delay when @delay is 0.
1412 */
1413 if (!delay) {
1414 __queue_work(cpu, wq, &dwork->work);
1415 return;
1416 }
1417
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001418 timer_stats_timer_set_start_info(&dwork->timer);
1419
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001420 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001421 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001422 timer->expires = jiffies + delay;
1423
1424 if (unlikely(cpu != WORK_CPU_UNBOUND))
1425 add_timer_on(timer, cpu);
1426 else
1427 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428}
1429
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001430/**
1431 * queue_delayed_work_on - queue work on specific CPU after delay
1432 * @cpu: CPU number to execute work on
1433 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001434 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001435 * @delay: number of jiffies to wait before queueing
1436 *
Tejun Heo715f1302012-08-03 10:30:46 -07001437 * Returns %false if @work was already on a queue, %true otherwise. If
1438 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1439 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001440 */
Tejun Heod4283e92012-08-03 10:30:44 -07001441bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1442 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001443{
David Howells52bad642006-11-22 14:54:01 +00001444 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001445 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001446 unsigned long flags;
1447
1448 /* read the comment in __queue_work() */
1449 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001450
Tejun Heo22df02b2010-06-29 10:07:10 +02001451 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001452 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001453 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001454 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001455
1456 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001457 return ret;
1458}
Dave Jonesae90dd52006-06-30 01:40:45 -04001459EXPORT_SYMBOL_GPL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460
Tejun Heoc8e55f32010-06-29 10:07:12 +02001461/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001462 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1463 * @cpu: CPU number to execute work on
1464 * @wq: workqueue to use
1465 * @dwork: work to queue
1466 * @delay: number of jiffies to wait before queueing
1467 *
1468 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1469 * modify @dwork's timer so that it expires after @delay. If @delay is
1470 * zero, @work is guaranteed to be scheduled immediately regardless of its
1471 * current state.
1472 *
1473 * Returns %false if @dwork was idle and queued, %true if @dwork was
1474 * pending and its timer was modified.
1475 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001476 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001477 * See try_to_grab_pending() for details.
1478 */
1479bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1480 struct delayed_work *dwork, unsigned long delay)
1481{
1482 unsigned long flags;
1483 int ret;
1484
1485 do {
1486 ret = try_to_grab_pending(&dwork->work, true, &flags);
1487 } while (unlikely(ret == -EAGAIN));
1488
1489 if (likely(ret >= 0)) {
1490 __queue_delayed_work(cpu, wq, dwork, delay);
1491 local_irq_restore(flags);
1492 }
1493
1494 /* -ENOENT from try_to_grab_pending() becomes %true */
1495 return ret;
1496}
1497EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1498
1499/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001500 * worker_enter_idle - enter idle state
1501 * @worker: worker which is entering idle state
1502 *
1503 * @worker is entering idle state. Update stats and idle timer if
1504 * necessary.
1505 *
1506 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001507 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001508 */
1509static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001511 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512
Tejun Heo6183c002013-03-12 11:29:57 -07001513 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1514 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1515 (worker->hentry.next || worker->hentry.pprev)))
1516 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517
Tejun Heocb444762010-07-02 10:03:50 +02001518 /* can't use worker_set_flags(), also called from start_worker() */
1519 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001520 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001521 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001522
Tejun Heoc8e55f32010-06-29 10:07:12 +02001523 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001524 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001525
Tejun Heo628c78e2012-07-17 12:39:27 -07001526 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1527 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001528
Tejun Heo544ecf32012-05-14 15:04:50 -07001529 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001530 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001531 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001532 * nr_running, the warning may trigger spuriously. Check iff
1533 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001534 */
Tejun Heo24647572013-01-24 11:01:33 -08001535 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001536 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001537 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538}
1539
Tejun Heoc8e55f32010-06-29 10:07:12 +02001540/**
1541 * worker_leave_idle - leave idle state
1542 * @worker: worker which is leaving idle state
1543 *
1544 * @worker is leaving idle state. Update stats.
1545 *
1546 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001547 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001548 */
1549static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001551 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
Tejun Heo6183c002013-03-12 11:29:57 -07001553 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1554 return;
Tejun Heod302f012010-06-29 10:07:13 +02001555 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001556 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001557 list_del_init(&worker->entry);
1558}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Tejun Heoe22bee72010-06-29 10:07:14 +02001560/**
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001561 * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it
1562 * @pool: target worker_pool
1563 *
1564 * Bind %current to the cpu of @pool if it is associated and lock @pool.
Tejun Heoe22bee72010-06-29 10:07:14 +02001565 *
1566 * Works which are scheduled while the cpu is online must at least be
1567 * scheduled to a worker which is bound to the cpu so that if they are
1568 * flushed from cpu callbacks while cpu is going down, they are
1569 * guaranteed to execute on the cpu.
1570 *
Lai Jiangshanf5faa072013-02-19 12:17:02 -08001571 * This function is to be used by unbound workers and rescuers to bind
Tejun Heoe22bee72010-06-29 10:07:14 +02001572 * themselves to the target cpu and may race with cpu going down or
1573 * coming online. kthread_bind() can't be used because it may put the
1574 * worker to already dead cpu and set_cpus_allowed_ptr() can't be used
Tejun Heo706026c2013-01-24 11:01:34 -08001575 * verbatim as it's best effort and blocking and pool may be
Tejun Heoe22bee72010-06-29 10:07:14 +02001576 * [dis]associated in the meantime.
1577 *
Tejun Heo706026c2013-01-24 11:01:34 -08001578 * This function tries set_cpus_allowed() and locks pool and verifies the
Tejun Heo24647572013-01-24 11:01:33 -08001579 * binding against %POOL_DISASSOCIATED which is set during
Tejun Heof2d5a0e2012-07-17 12:39:26 -07001580 * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker
1581 * enters idle state or fetches works without dropping lock, it can
1582 * guarantee the scheduling requirement described in the first paragraph.
Tejun Heoe22bee72010-06-29 10:07:14 +02001583 *
1584 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001585 * Might sleep. Called without any lock but returns with pool->lock
Tejun Heoe22bee72010-06-29 10:07:14 +02001586 * held.
1587 *
1588 * RETURNS:
Tejun Heo706026c2013-01-24 11:01:34 -08001589 * %true if the associated pool is online (@worker is successfully
Tejun Heoe22bee72010-06-29 10:07:14 +02001590 * bound), %false if offline.
1591 */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08001592static bool worker_maybe_bind_and_lock(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001593__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001594{
Tejun Heoe22bee72010-06-29 10:07:14 +02001595 while (true) {
1596 /*
1597 * The following call may fail, succeed or succeed
1598 * without actually migrating the task to the cpu if
1599 * it races with cpu hotunplug operation. Verify
Tejun Heo24647572013-01-24 11:01:33 -08001600 * against POOL_DISASSOCIATED.
Tejun Heoe22bee72010-06-29 10:07:14 +02001601 */
Tejun Heo24647572013-01-24 11:01:33 -08001602 if (!(pool->flags & POOL_DISASSOCIATED))
Tejun Heo7a4e3442013-03-12 11:30:00 -07001603 set_cpus_allowed_ptr(current, pool->attrs->cpumask);
Oleg Nesterov85f41862007-05-09 02:34:20 -07001604
Tejun Heod565ed62013-01-24 11:01:33 -08001605 spin_lock_irq(&pool->lock);
Tejun Heo24647572013-01-24 11:01:33 -08001606 if (pool->flags & POOL_DISASSOCIATED)
Tejun Heoe22bee72010-06-29 10:07:14 +02001607 return false;
Lai Jiangshanf5faa072013-02-19 12:17:02 -08001608 if (task_cpu(current) == pool->cpu &&
Tejun Heo7a4e3442013-03-12 11:30:00 -07001609 cpumask_equal(&current->cpus_allowed, pool->attrs->cpumask))
Tejun Heoe22bee72010-06-29 10:07:14 +02001610 return true;
Tejun Heod565ed62013-01-24 11:01:33 -08001611 spin_unlock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07001612
Tejun Heo5035b202011-04-29 18:08:37 +02001613 /*
1614 * We've raced with CPU hot[un]plug. Give it a breather
1615 * and retry migration. cond_resched() is required here;
1616 * otherwise, we might deadlock against cpu_stop trying to
1617 * bring down the CPU on non-preemptive kernel.
1618 */
Tejun Heoe22bee72010-06-29 10:07:14 +02001619 cpu_relax();
Tejun Heo5035b202011-04-29 18:08:37 +02001620 cond_resched();
Tejun Heoe22bee72010-06-29 10:07:14 +02001621 }
1622}
1623
Tejun Heoc34056a2010-06-29 10:07:11 +02001624static struct worker *alloc_worker(void)
1625{
1626 struct worker *worker;
1627
1628 worker = kzalloc(sizeof(*worker), GFP_KERNEL);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001629 if (worker) {
1630 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001631 INIT_LIST_HEAD(&worker->scheduled);
Tejun Heoe22bee72010-06-29 10:07:14 +02001632 /* on creation a worker is in !idle && prep state */
1633 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001634 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001635 return worker;
1636}
1637
1638/**
1639 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001640 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001641 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001642 * Create a new worker which is bound to @pool. The returned worker
Tejun Heoc34056a2010-06-29 10:07:11 +02001643 * can be started by calling start_worker() or destroyed using
1644 * destroy_worker().
1645 *
1646 * CONTEXT:
1647 * Might sleep. Does GFP_KERNEL allocations.
1648 *
1649 * RETURNS:
1650 * Pointer to the newly created worker.
1651 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001652static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001653{
Tejun Heoc34056a2010-06-29 10:07:11 +02001654 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001655 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001656 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001657
Tejun Heocd549682013-03-13 19:47:39 -07001658 lockdep_assert_held(&pool->manager_mutex);
1659
Tejun Heo822d8402013-03-19 13:45:21 -07001660 /*
1661 * ID is needed to determine kthread name. Allocate ID first
1662 * without installing the pointer.
1663 */
1664 idr_preload(GFP_KERNEL);
Tejun Heod565ed62013-01-24 11:01:33 -08001665 spin_lock_irq(&pool->lock);
Tejun Heo822d8402013-03-19 13:45:21 -07001666
1667 id = idr_alloc(&pool->worker_idr, NULL, 0, 0, GFP_NOWAIT);
1668
Tejun Heod565ed62013-01-24 11:01:33 -08001669 spin_unlock_irq(&pool->lock);
Tejun Heo822d8402013-03-19 13:45:21 -07001670 idr_preload_end();
1671 if (id < 0)
1672 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001673
1674 worker = alloc_worker();
1675 if (!worker)
1676 goto fail;
1677
Tejun Heobd7bdd42012-07-12 14:46:37 -07001678 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001679 worker->id = id;
1680
Tejun Heo29c91e92013-03-12 11:30:03 -07001681 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001682 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1683 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001684 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001685 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1686
Tejun Heof3f90ad2013-04-01 11:23:34 -07001687 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001688 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001689 if (IS_ERR(worker->task))
1690 goto fail;
1691
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001692 /*
1693 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1694 * online CPUs. It'll be re-applied when any of the CPUs come up.
1695 */
Tejun Heo7a4e3442013-03-12 11:30:00 -07001696 set_user_nice(worker->task, pool->attrs->nice);
1697 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
Tejun Heo32704762012-07-13 22:16:45 -07001698
Tejun Heo14a40ff2013-03-19 13:45:20 -07001699 /* prevent userland from meddling with cpumask of workqueue workers */
1700 worker->task->flags |= PF_NO_SETAFFINITY;
Tejun Heo7a4e3442013-03-12 11:30:00 -07001701
1702 /*
1703 * The caller is responsible for ensuring %POOL_DISASSOCIATED
1704 * remains stable across this function. See the comments above the
1705 * flag definition for details.
1706 */
1707 if (pool->flags & POOL_DISASSOCIATED)
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001708 worker->flags |= WORKER_UNBOUND;
Oleg Nesterov3af244332007-05-09 02:34:09 -07001709
Tejun Heo822d8402013-03-19 13:45:21 -07001710 /* successful, commit the pointer to idr */
1711 spin_lock_irq(&pool->lock);
1712 idr_replace(&pool->worker_idr, worker, worker->id);
1713 spin_unlock_irq(&pool->lock);
1714
Tejun Heoc34056a2010-06-29 10:07:11 +02001715 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001716
Tejun Heoc34056a2010-06-29 10:07:11 +02001717fail:
1718 if (id >= 0) {
Tejun Heod565ed62013-01-24 11:01:33 -08001719 spin_lock_irq(&pool->lock);
Tejun Heo822d8402013-03-19 13:45:21 -07001720 idr_remove(&pool->worker_idr, id);
Tejun Heod565ed62013-01-24 11:01:33 -08001721 spin_unlock_irq(&pool->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001722 }
1723 kfree(worker);
1724 return NULL;
1725}
1726
1727/**
1728 * start_worker - start a newly created worker
1729 * @worker: worker to start
1730 *
Tejun Heo706026c2013-01-24 11:01:34 -08001731 * Make the pool aware of @worker and start it.
Tejun Heoc34056a2010-06-29 10:07:11 +02001732 *
1733 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001734 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001735 */
1736static void start_worker(struct worker *worker)
1737{
Tejun Heocb444762010-07-02 10:03:50 +02001738 worker->flags |= WORKER_STARTED;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001739 worker->pool->nr_workers++;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001740 worker_enter_idle(worker);
Tejun Heoc34056a2010-06-29 10:07:11 +02001741 wake_up_process(worker->task);
1742}
1743
1744/**
Tejun Heoebf44d12013-03-13 19:47:39 -07001745 * create_and_start_worker - create and start a worker for a pool
1746 * @pool: the target pool
1747 *
Tejun Heocd549682013-03-13 19:47:39 -07001748 * Grab the managership of @pool and create and start a new worker for it.
Tejun Heoebf44d12013-03-13 19:47:39 -07001749 */
1750static int create_and_start_worker(struct worker_pool *pool)
1751{
1752 struct worker *worker;
1753
Tejun Heocd549682013-03-13 19:47:39 -07001754 mutex_lock(&pool->manager_mutex);
1755
Tejun Heoebf44d12013-03-13 19:47:39 -07001756 worker = create_worker(pool);
1757 if (worker) {
1758 spin_lock_irq(&pool->lock);
1759 start_worker(worker);
1760 spin_unlock_irq(&pool->lock);
1761 }
1762
Tejun Heocd549682013-03-13 19:47:39 -07001763 mutex_unlock(&pool->manager_mutex);
1764
Tejun Heoebf44d12013-03-13 19:47:39 -07001765 return worker ? 0 : -ENOMEM;
1766}
1767
1768/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001769 * destroy_worker - destroy a workqueue worker
1770 * @worker: worker to be destroyed
1771 *
Tejun Heo706026c2013-01-24 11:01:34 -08001772 * Destroy @worker and adjust @pool stats accordingly.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001773 *
1774 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001775 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoc34056a2010-06-29 10:07:11 +02001776 */
1777static void destroy_worker(struct worker *worker)
1778{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001779 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001780
Tejun Heocd549682013-03-13 19:47:39 -07001781 lockdep_assert_held(&pool->manager_mutex);
1782 lockdep_assert_held(&pool->lock);
1783
Tejun Heoc34056a2010-06-29 10:07:11 +02001784 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001785 if (WARN_ON(worker->current_work) ||
1786 WARN_ON(!list_empty(&worker->scheduled)))
1787 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001788
Tejun Heoc8e55f32010-06-29 10:07:12 +02001789 if (worker->flags & WORKER_STARTED)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001790 pool->nr_workers--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001791 if (worker->flags & WORKER_IDLE)
Tejun Heobd7bdd42012-07-12 14:46:37 -07001792 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001793
1794 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001795 worker->flags |= WORKER_DIE;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001796
Tejun Heo822d8402013-03-19 13:45:21 -07001797 idr_remove(&pool->worker_idr, worker->id);
1798
Tejun Heod565ed62013-01-24 11:01:33 -08001799 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001800
Tejun Heoc34056a2010-06-29 10:07:11 +02001801 kthread_stop(worker->task);
1802 kfree(worker);
1803
Tejun Heod565ed62013-01-24 11:01:33 -08001804 spin_lock_irq(&pool->lock);
Tejun Heoc34056a2010-06-29 10:07:11 +02001805}
1806
Tejun Heo63d95a92012-07-12 14:46:37 -07001807static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001808{
Tejun Heo63d95a92012-07-12 14:46:37 -07001809 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001810
Tejun Heod565ed62013-01-24 11:01:33 -08001811 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001812
Tejun Heo63d95a92012-07-12 14:46:37 -07001813 if (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001814 struct worker *worker;
1815 unsigned long expires;
1816
1817 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001818 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001819 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1820
1821 if (time_before(jiffies, expires))
Tejun Heo63d95a92012-07-12 14:46:37 -07001822 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001823 else {
1824 /* it's been idle for too long, wake up manager */
Tejun Heo11ebea52012-07-12 14:46:37 -07001825 pool->flags |= POOL_MANAGE_WORKERS;
Tejun Heo63d95a92012-07-12 14:46:37 -07001826 wake_up_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001827 }
1828 }
1829
Tejun Heod565ed62013-01-24 11:01:33 -08001830 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001831}
1832
Tejun Heo493a1722013-03-12 11:29:59 -07001833static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001834{
Tejun Heo112202d2013-02-13 19:29:12 -08001835 struct pool_workqueue *pwq = get_work_pwq(work);
1836 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001837
Tejun Heo2e109a22013-03-13 19:47:40 -07001838 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001839
Tejun Heo493008a2013-03-12 11:30:03 -07001840 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001841 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001842
1843 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001844 if (list_empty(&pwq->mayday_node)) {
1845 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001846 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001847 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001848}
1849
Tejun Heo706026c2013-01-24 11:01:34 -08001850static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001851{
Tejun Heo63d95a92012-07-12 14:46:37 -07001852 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001853 struct work_struct *work;
1854
Tejun Heo2e109a22013-03-13 19:47:40 -07001855 spin_lock_irq(&wq_mayday_lock); /* for wq->maydays */
Tejun Heo493a1722013-03-12 11:29:59 -07001856 spin_lock(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001857
Tejun Heo63d95a92012-07-12 14:46:37 -07001858 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001859 /*
1860 * We've been trying to create a new worker but
1861 * haven't been successful. We might be hitting an
1862 * allocation deadlock. Send distress signals to
1863 * rescuers.
1864 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001865 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001866 send_mayday(work);
1867 }
1868
Tejun Heo493a1722013-03-12 11:29:59 -07001869 spin_unlock(&pool->lock);
Tejun Heo2e109a22013-03-13 19:47:40 -07001870 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001871
Tejun Heo63d95a92012-07-12 14:46:37 -07001872 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001873}
1874
1875/**
1876 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001877 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001878 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001879 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001880 * have at least one idle worker on return from this function. If
1881 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001882 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001883 * possible allocation deadlock.
1884 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001885 * On return, need_to_create_worker() is guaranteed to be %false and
1886 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001887 *
1888 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001889 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001890 * multiple times. Does GFP_KERNEL allocations. Called only from
1891 * manager.
1892 *
1893 * RETURNS:
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001894 * %false if no action was taken and pool->lock stayed locked, %true
Tejun Heoe22bee72010-06-29 10:07:14 +02001895 * otherwise.
1896 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001897static bool maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001898__releases(&pool->lock)
1899__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001900{
Tejun Heo63d95a92012-07-12 14:46:37 -07001901 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001902 return false;
1903restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001904 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001905
Tejun Heoe22bee72010-06-29 10:07:14 +02001906 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001907 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001908
1909 while (true) {
1910 struct worker *worker;
1911
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001912 worker = create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001913 if (worker) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001914 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001915 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001916 start_worker(worker);
Tejun Heo6183c002013-03-12 11:29:57 -07001917 if (WARN_ON_ONCE(need_to_create_worker(pool)))
1918 goto restart;
Tejun Heoe22bee72010-06-29 10:07:14 +02001919 return true;
1920 }
1921
Tejun Heo63d95a92012-07-12 14:46:37 -07001922 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001923 break;
1924
Tejun Heoe22bee72010-06-29 10:07:14 +02001925 __set_current_state(TASK_INTERRUPTIBLE);
1926 schedule_timeout(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001927
Tejun Heo63d95a92012-07-12 14:46:37 -07001928 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001929 break;
1930 }
1931
Tejun Heo63d95a92012-07-12 14:46:37 -07001932 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001933 spin_lock_irq(&pool->lock);
Tejun Heo63d95a92012-07-12 14:46:37 -07001934 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001935 goto restart;
1936 return true;
1937}
1938
1939/**
1940 * maybe_destroy_worker - destroy workers which have been idle for a while
Tejun Heo63d95a92012-07-12 14:46:37 -07001941 * @pool: pool to destroy workers for
Tejun Heoe22bee72010-06-29 10:07:14 +02001942 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001943 * Destroy @pool workers which have been idle for longer than
Tejun Heoe22bee72010-06-29 10:07:14 +02001944 * IDLE_WORKER_TIMEOUT.
1945 *
1946 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001947 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001948 * multiple times. Called only from manager.
1949 *
1950 * RETURNS:
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001951 * %false if no action was taken and pool->lock stayed locked, %true
Tejun Heoe22bee72010-06-29 10:07:14 +02001952 * otherwise.
1953 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001954static bool maybe_destroy_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001955{
1956 bool ret = false;
1957
Tejun Heo63d95a92012-07-12 14:46:37 -07001958 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001959 struct worker *worker;
1960 unsigned long expires;
1961
Tejun Heo63d95a92012-07-12 14:46:37 -07001962 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001963 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1964
1965 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001966 mod_timer(&pool->idle_timer, expires);
Tejun Heoe22bee72010-06-29 10:07:14 +02001967 break;
1968 }
1969
1970 destroy_worker(worker);
1971 ret = true;
1972 }
1973
1974 return ret;
1975}
1976
1977/**
1978 * manage_workers - manage worker pool
1979 * @worker: self
1980 *
Tejun Heo706026c2013-01-24 11:01:34 -08001981 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001982 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001983 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001984 *
1985 * The caller can safely start processing works on false return. On
1986 * true return, it's guaranteed that need_to_create_worker() is false
1987 * and may_start_working() is true.
1988 *
1989 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001990 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001991 * multiple times. Does GFP_KERNEL allocations.
1992 *
1993 * RETURNS:
Tejun Heod565ed62013-01-24 11:01:33 -08001994 * spin_lock_irq(pool->lock) which may be released and regrabbed
1995 * multiple times. Does GFP_KERNEL allocations.
Tejun Heoe22bee72010-06-29 10:07:14 +02001996 */
1997static bool manage_workers(struct worker *worker)
1998{
Tejun Heo63d95a92012-07-12 14:46:37 -07001999 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002000 bool ret = false;
2001
Tejun Heobc3a1af2013-03-13 19:47:39 -07002002 /*
2003 * Managership is governed by two mutexes - manager_arb and
2004 * manager_mutex. manager_arb handles arbitration of manager role.
2005 * Anyone who successfully grabs manager_arb wins the arbitration
2006 * and becomes the manager. mutex_trylock() on pool->manager_arb
2007 * failure while holding pool->lock reliably indicates that someone
2008 * else is managing the pool and the worker which failed trylock
2009 * can proceed to executing work items. This means that anyone
2010 * grabbing manager_arb is responsible for actually performing
2011 * manager duties. If manager_arb is grabbed and released without
2012 * actual management, the pool may stall indefinitely.
2013 *
2014 * manager_mutex is used for exclusion of actual management
2015 * operations. The holder of manager_mutex can be sure that none
2016 * of management operations, including creation and destruction of
2017 * workers, won't take place until the mutex is released. Because
2018 * manager_mutex doesn't interfere with manager role arbitration,
2019 * it is guaranteed that the pool's management, while may be
2020 * delayed, won't be disturbed by someone else grabbing
2021 * manager_mutex.
2022 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07002023 if (!mutex_trylock(&pool->manager_arb))
Tejun Heoe22bee72010-06-29 10:07:14 +02002024 return ret;
2025
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002026 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07002027 * With manager arbitration won, manager_mutex would be free in
2028 * most cases. trylock first without dropping @pool->lock.
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002029 */
Tejun Heobc3a1af2013-03-13 19:47:39 -07002030 if (unlikely(!mutex_trylock(&pool->manager_mutex))) {
Tejun Heod565ed62013-01-24 11:01:33 -08002031 spin_unlock_irq(&pool->lock);
Tejun Heobc3a1af2013-03-13 19:47:39 -07002032 mutex_lock(&pool->manager_mutex);
Lai Jiangshanee378aa2012-09-10 10:03:44 -07002033 ret = true;
2034 }
2035
Tejun Heo11ebea52012-07-12 14:46:37 -07002036 pool->flags &= ~POOL_MANAGE_WORKERS;
Tejun Heoe22bee72010-06-29 10:07:14 +02002037
2038 /*
2039 * Destroy and then create so that may_start_working() is true
2040 * on return.
2041 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002042 ret |= maybe_destroy_workers(pool);
2043 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02002044
Tejun Heobc3a1af2013-03-13 19:47:39 -07002045 mutex_unlock(&pool->manager_mutex);
Tejun Heo34a06bd2013-03-12 11:30:00 -07002046 mutex_unlock(&pool->manager_arb);
Tejun Heoe22bee72010-06-29 10:07:14 +02002047 return ret;
2048}
2049
Tejun Heoa62428c2010-06-29 10:07:10 +02002050/**
2051 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02002052 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02002053 * @work: work to process
2054 *
2055 * Process @work. This function contains all the logics necessary to
2056 * process a single work including synchronization against and
2057 * interaction with other workers on the same cpu, queueing and
2058 * flushing. As long as context requirement is met, any worker can
2059 * call this function to process a work.
2060 *
2061 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002062 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02002063 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002064static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08002065__releases(&pool->lock)
2066__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02002067{
Tejun Heo112202d2013-02-13 19:29:12 -08002068 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07002069 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002070 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02002071 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02002072 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02002073#ifdef CONFIG_LOCKDEP
2074 /*
2075 * It is permissible to free the struct work_struct from
2076 * inside the function that is called from it, this we need to
2077 * take into account for lockdep too. To avoid bogus "held
2078 * lock freed" warnings as well as problems when looking into
2079 * work->lockdep_map, make a copy and use that here.
2080 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07002081 struct lockdep_map lockdep_map;
2082
2083 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002084#endif
Tejun Heo6fec10a2012-07-22 10:16:34 -07002085 /*
2086 * Ensure we're on the correct CPU. DISASSOCIATED test is
2087 * necessary to avoid spurious warnings from rescuers servicing the
Tejun Heo24647572013-01-24 11:01:33 -08002088 * unbound or a disassociated pool.
Tejun Heo6fec10a2012-07-22 10:16:34 -07002089 */
Lai Jiangshan5f7dabf2012-09-18 09:59:23 -07002090 WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) &&
Tejun Heo24647572013-01-24 11:01:33 -08002091 !(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08002092 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07002093
Tejun Heo7e116292010-06-29 10:07:13 +02002094 /*
2095 * A single work shouldn't be executed concurrently by
2096 * multiple workers on a single cpu. Check whether anyone is
2097 * already processing the work. If so, defer the work to the
2098 * currently executing one.
2099 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002100 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02002101 if (unlikely(collision)) {
2102 move_linked_works(work, &collision->scheduled, NULL);
2103 return;
2104 }
2105
Tejun Heo8930cab2012-08-03 10:30:45 -07002106 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02002107 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002108 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02002109 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002110 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08002111 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02002112 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002113
Tejun Heoa62428c2010-06-29 10:07:10 +02002114 list_del_init(&work->entry);
2115
Tejun Heo649027d2010-06-29 10:07:14 +02002116 /*
Tejun Heofb0e7be2010-06-29 10:07:15 +02002117 * CPU intensive works don't participate in concurrency
2118 * management. They're the scheduler's responsibility.
2119 */
2120 if (unlikely(cpu_intensive))
2121 worker_set_flags(worker, WORKER_CPU_INTENSIVE, true);
2122
Tejun Heo974271c2012-07-12 14:46:37 -07002123 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002124 * Unbound pool isn't concurrency managed and work items should be
Tejun Heo974271c2012-07-12 14:46:37 -07002125 * executed ASAP. Wake up another worker if necessary.
2126 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002127 if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool))
2128 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002129
Tejun Heo8930cab2012-08-03 10:30:45 -07002130 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002131 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002132 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002133 * PENDING and queued state changes happen together while IRQ is
2134 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002135 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002136 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002137
Tejun Heod565ed62013-01-24 11:01:33 -08002138 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002139
Tejun Heo112202d2013-02-13 19:29:12 -08002140 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002141 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002142 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002143 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002144 /*
2145 * While we must be careful to not use "work" after this, the trace
2146 * point will only record its address.
2147 */
2148 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002149 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002150 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002151
2152 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002153 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2154 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002155 current->comm, preempt_count(), task_pid_nr(current),
2156 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002157 debug_show_held_locks(current);
2158 dump_stack();
2159 }
2160
Tejun Heod565ed62013-01-24 11:01:33 -08002161 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002162
Tejun Heofb0e7be2010-06-29 10:07:15 +02002163 /* clear cpu intensive status */
2164 if (unlikely(cpu_intensive))
2165 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2166
Tejun Heoa62428c2010-06-29 10:07:10 +02002167 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002168 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002169 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002170 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002171 worker->current_pwq = NULL;
2172 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002173}
2174
Tejun Heoaffee4b2010-06-29 10:07:12 +02002175/**
2176 * process_scheduled_works - process scheduled works
2177 * @worker: self
2178 *
2179 * Process all scheduled works. Please note that the scheduled list
2180 * may change while processing a work, so this function repeatedly
2181 * fetches a work from the top and executes it.
2182 *
2183 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002184 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002185 * multiple times.
2186 */
2187static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002189 while (!list_empty(&worker->scheduled)) {
2190 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002192 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194}
2195
Tejun Heo4690c4a2010-06-29 10:07:10 +02002196/**
2197 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002198 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002199 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002200 * The worker thread function. All workers belong to a worker_pool -
2201 * either a per-cpu one or dynamic unbound one. These workers process all
2202 * work items regardless of their specific target workqueue. The only
2203 * exception is work items which belong to workqueues with a rescuer which
2204 * will be explained in rescuer_thread().
Tejun Heo4690c4a2010-06-29 10:07:10 +02002205 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002206static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207{
Tejun Heoc34056a2010-06-29 10:07:11 +02002208 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002209 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210
Tejun Heoe22bee72010-06-29 10:07:14 +02002211 /* tell the scheduler that this is a workqueue worker */
2212 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002213woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002214 spin_lock_irq(&pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215
Tejun Heoa9ab7752013-03-19 13:45:21 -07002216 /* am I supposed to die? */
2217 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002218 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002219 WARN_ON_ONCE(!list_empty(&worker->entry));
2220 worker->task->flags &= ~PF_WQ_WORKER;
2221 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222 }
2223
Tejun Heoc8e55f32010-06-29 10:07:12 +02002224 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002225recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002226 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002227 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002228 goto sleep;
2229
2230 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002231 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002232 goto recheck;
2233
Tejun Heoc8e55f32010-06-29 10:07:12 +02002234 /*
2235 * ->scheduled list can only be filled while a worker is
2236 * preparing to process a work or actually processing it.
2237 * Make sure nobody diddled with it while I was sleeping.
2238 */
Tejun Heo6183c002013-03-12 11:29:57 -07002239 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002240
Tejun Heoe22bee72010-06-29 10:07:14 +02002241 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002242 * Finish PREP stage. We're guaranteed to have at least one idle
2243 * worker or that someone else has already assumed the manager
2244 * role. This is where @worker starts participating in concurrency
2245 * management if applicable and concurrency management is restored
2246 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002247 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002248 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002249
2250 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002251 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002252 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002253 struct work_struct, entry);
2254
2255 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2256 /* optimization path, not strictly necessary */
2257 process_one_work(worker, work);
2258 if (unlikely(!list_empty(&worker->scheduled)))
2259 process_scheduled_works(worker);
2260 } else {
2261 move_linked_works(work, &worker->scheduled, NULL);
2262 process_scheduled_works(worker);
2263 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002264 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002265
Tejun Heoe22bee72010-06-29 10:07:14 +02002266 worker_set_flags(worker, WORKER_PREP, false);
Tejun Heod313dd82010-07-02 10:03:51 +02002267sleep:
Tejun Heo63d95a92012-07-12 14:46:37 -07002268 if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002269 goto recheck;
Tejun Heod313dd82010-07-02 10:03:51 +02002270
Tejun Heoc8e55f32010-06-29 10:07:12 +02002271 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002272 * pool->lock is held and there's no work to process and no need to
2273 * manage, sleep. Workers are woken up only while holding
2274 * pool->lock or from local cpu, so setting the current state
2275 * before releasing pool->lock is enough to prevent losing any
2276 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002277 */
2278 worker_enter_idle(worker);
2279 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002280 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002281 schedule();
2282 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283}
2284
Tejun Heoe22bee72010-06-29 10:07:14 +02002285/**
2286 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002287 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002288 *
2289 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002290 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002291 *
Tejun Heo706026c2013-01-24 11:01:34 -08002292 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002293 * worker which uses GFP_KERNEL allocation which has slight chance of
2294 * developing into deadlock if some works currently on the same queue
2295 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2296 * the problem rescuer solves.
2297 *
Tejun Heo706026c2013-01-24 11:01:34 -08002298 * When such condition is possible, the pool summons rescuers of all
2299 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002300 * those works so that forward progress can be guaranteed.
2301 *
2302 * This should happen rarely.
2303 */
Tejun Heo111c2252013-01-17 17:16:24 -08002304static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002305{
Tejun Heo111c2252013-01-17 17:16:24 -08002306 struct worker *rescuer = __rescuer;
2307 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002308 struct list_head *scheduled = &rescuer->scheduled;
Tejun Heoe22bee72010-06-29 10:07:14 +02002309
2310 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002311
2312 /*
2313 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2314 * doesn't participate in concurrency management.
2315 */
2316 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002317repeat:
2318 set_current_state(TASK_INTERRUPTIBLE);
2319
Mike Galbraith412d32e2012-11-28 07:17:18 +01002320 if (kthread_should_stop()) {
2321 __set_current_state(TASK_RUNNING);
Tejun Heo111c2252013-01-17 17:16:24 -08002322 rescuer->task->flags &= ~PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002323 return 0;
Mike Galbraith412d32e2012-11-28 07:17:18 +01002324 }
Tejun Heoe22bee72010-06-29 10:07:14 +02002325
Tejun Heo493a1722013-03-12 11:29:59 -07002326 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002327 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002328
2329 while (!list_empty(&wq->maydays)) {
2330 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2331 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002332 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002333 struct work_struct *work, *n;
2334
2335 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002336 list_del_init(&pwq->mayday_node);
2337
Tejun Heo2e109a22013-03-13 19:47:40 -07002338 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002339
2340 /* migrate to the target cpu if possible */
Lai Jiangshanf36dc672013-02-19 12:17:02 -08002341 worker_maybe_bind_and_lock(pool);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002342 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002343
2344 /*
2345 * Slurp in all works issued via this workqueue and
2346 * process'em.
2347 */
Tejun Heo6183c002013-03-12 11:29:57 -07002348 WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002349 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heo112202d2013-02-13 19:29:12 -08002350 if (get_work_pwq(work) == pwq)
Tejun Heoe22bee72010-06-29 10:07:14 +02002351 move_linked_works(work, scheduled, &n);
2352
2353 process_scheduled_works(rescuer);
Tejun Heo75769582011-02-14 14:04:46 +01002354
2355 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002356 * Leave this pool. If keep_working() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002357 * regular worker; otherwise, we end up with 0 concurrency
2358 * and stalling the execution.
2359 */
Tejun Heo63d95a92012-07-12 14:46:37 -07002360 if (keep_working(pool))
2361 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002362
Lai Jiangshanb3104102013-02-19 12:17:02 -08002363 rescuer->pool = NULL;
Tejun Heo493a1722013-03-12 11:29:59 -07002364 spin_unlock(&pool->lock);
Tejun Heo2e109a22013-03-13 19:47:40 -07002365 spin_lock(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002366 }
2367
Tejun Heo2e109a22013-03-13 19:47:40 -07002368 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002369
Tejun Heo111c2252013-01-17 17:16:24 -08002370 /* rescuers should never participate in concurrency management */
2371 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002372 schedule();
2373 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374}
2375
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002376struct wq_barrier {
2377 struct work_struct work;
2378 struct completion done;
2379};
2380
2381static void wq_barrier_func(struct work_struct *work)
2382{
2383 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2384 complete(&barr->done);
2385}
2386
Tejun Heo4690c4a2010-06-29 10:07:10 +02002387/**
2388 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002389 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002390 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002391 * @target: target work to attach @barr to
2392 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002393 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002394 * @barr is linked to @target such that @barr is completed only after
2395 * @target finishes execution. Please note that the ordering
2396 * guarantee is observed only with respect to @target and on the local
2397 * cpu.
2398 *
2399 * Currently, a queued barrier can't be canceled. This is because
2400 * try_to_grab_pending() can't determine whether the work to be
2401 * grabbed is at the head of the queue and thus can't clear LINKED
2402 * flag of the previous work while there must be a valid next work
2403 * after a work with LINKED flag set.
2404 *
2405 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002406 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002407 *
2408 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002409 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002410 */
Tejun Heo112202d2013-02-13 19:29:12 -08002411static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002412 struct wq_barrier *barr,
2413 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002414{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002415 struct list_head *head;
2416 unsigned int linked = 0;
2417
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002418 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002419 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002420 * as we know for sure that this will not trigger any of the
2421 * checks and call back into the fixup functions where we
2422 * might deadlock.
2423 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002424 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002425 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002426 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002427
Tejun Heoaffee4b2010-06-29 10:07:12 +02002428 /*
2429 * If @target is currently being executed, schedule the
2430 * barrier to the worker; otherwise, put it after @target.
2431 */
2432 if (worker)
2433 head = worker->scheduled.next;
2434 else {
2435 unsigned long *bits = work_data_bits(target);
2436
2437 head = target->entry.next;
2438 /* there can already be other linked works, inherit and set */
2439 linked = *bits & WORK_STRUCT_LINKED;
2440 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2441 }
2442
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002443 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002444 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002445 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002446}
2447
Tejun Heo73f53c42010-06-29 10:07:11 +02002448/**
Tejun Heo112202d2013-02-13 19:29:12 -08002449 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002450 * @wq: workqueue being flushed
2451 * @flush_color: new flush color, < 0 for no-op
2452 * @work_color: new work color, < 0 for no-op
2453 *
Tejun Heo112202d2013-02-13 19:29:12 -08002454 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002455 *
Tejun Heo112202d2013-02-13 19:29:12 -08002456 * If @flush_color is non-negative, flush_color on all pwqs should be
2457 * -1. If no pwq has in-flight commands at the specified color, all
2458 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2459 * has in flight commands, its pwq->flush_color is set to
2460 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002461 * wakeup logic is armed and %true is returned.
2462 *
2463 * The caller should have initialized @wq->first_flusher prior to
2464 * calling this function with non-negative @flush_color. If
2465 * @flush_color is negative, no flush color update is done and %false
2466 * is returned.
2467 *
Tejun Heo112202d2013-02-13 19:29:12 -08002468 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002469 * work_color which is previous to @work_color and all will be
2470 * advanced to @work_color.
2471 *
2472 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002473 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002474 *
2475 * RETURNS:
2476 * %true if @flush_color >= 0 and there's something to flush. %false
2477 * otherwise.
2478 */
Tejun Heo112202d2013-02-13 19:29:12 -08002479static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002480 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481{
Tejun Heo73f53c42010-06-29 10:07:11 +02002482 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002483 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002484
Tejun Heo73f53c42010-06-29 10:07:11 +02002485 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002486 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002487 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002488 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002489
Tejun Heo49e3cf42013-03-12 11:29:58 -07002490 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002491 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002492
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002493 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002494
2495 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002496 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002497
Tejun Heo112202d2013-02-13 19:29:12 -08002498 if (pwq->nr_in_flight[flush_color]) {
2499 pwq->flush_color = flush_color;
2500 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002501 wait = true;
2502 }
2503 }
2504
2505 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002506 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002507 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002508 }
2509
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002510 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002511 }
2512
Tejun Heo112202d2013-02-13 19:29:12 -08002513 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002514 complete(&wq->first_flusher->done);
2515
2516 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517}
2518
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002519/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002521 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002523 * This function sleeps until all work items which were queued on entry
2524 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002526void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527{
Tejun Heo73f53c42010-06-29 10:07:11 +02002528 struct wq_flusher this_flusher = {
2529 .list = LIST_HEAD_INIT(this_flusher.list),
2530 .flush_color = -1,
2531 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2532 };
2533 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002534
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002535 lock_map_acquire(&wq->lockdep_map);
2536 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002537
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002538 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002539
2540 /*
2541 * Start-to-wait phase
2542 */
2543 next_color = work_next_color(wq->work_color);
2544
2545 if (next_color != wq->flush_color) {
2546 /*
2547 * Color space is not full. The current work_color
2548 * becomes our flush_color and work_color is advanced
2549 * by one.
2550 */
Tejun Heo6183c002013-03-12 11:29:57 -07002551 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002552 this_flusher.flush_color = wq->work_color;
2553 wq->work_color = next_color;
2554
2555 if (!wq->first_flusher) {
2556 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002557 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002558
2559 wq->first_flusher = &this_flusher;
2560
Tejun Heo112202d2013-02-13 19:29:12 -08002561 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002562 wq->work_color)) {
2563 /* nothing to flush, done */
2564 wq->flush_color = next_color;
2565 wq->first_flusher = NULL;
2566 goto out_unlock;
2567 }
2568 } else {
2569 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002570 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002571 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002572 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002573 }
2574 } else {
2575 /*
2576 * Oops, color space is full, wait on overflow queue.
2577 * The next flush completion will assign us
2578 * flush_color and transfer to flusher_queue.
2579 */
2580 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2581 }
2582
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002583 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002584
2585 wait_for_completion(&this_flusher.done);
2586
2587 /*
2588 * Wake-up-and-cascade phase
2589 *
2590 * First flushers are responsible for cascading flushes and
2591 * handling overflow. Non-first flushers can simply return.
2592 */
2593 if (wq->first_flusher != &this_flusher)
2594 return;
2595
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002596 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002597
Tejun Heo4ce48b32010-07-02 10:03:51 +02002598 /* we might have raced, check again with mutex held */
2599 if (wq->first_flusher != &this_flusher)
2600 goto out_unlock;
2601
Tejun Heo73f53c42010-06-29 10:07:11 +02002602 wq->first_flusher = NULL;
2603
Tejun Heo6183c002013-03-12 11:29:57 -07002604 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2605 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002606
2607 while (true) {
2608 struct wq_flusher *next, *tmp;
2609
2610 /* complete all the flushers sharing the current flush color */
2611 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2612 if (next->flush_color != wq->flush_color)
2613 break;
2614 list_del_init(&next->list);
2615 complete(&next->done);
2616 }
2617
Tejun Heo6183c002013-03-12 11:29:57 -07002618 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2619 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002620
2621 /* this flush_color is finished, advance by one */
2622 wq->flush_color = work_next_color(wq->flush_color);
2623
2624 /* one color has been freed, handle overflow queue */
2625 if (!list_empty(&wq->flusher_overflow)) {
2626 /*
2627 * Assign the same color to all overflowed
2628 * flushers, advance work_color and append to
2629 * flusher_queue. This is the start-to-wait
2630 * phase for these overflowed flushers.
2631 */
2632 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2633 tmp->flush_color = wq->work_color;
2634
2635 wq->work_color = work_next_color(wq->work_color);
2636
2637 list_splice_tail_init(&wq->flusher_overflow,
2638 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002639 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002640 }
2641
2642 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002643 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002644 break;
2645 }
2646
2647 /*
2648 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002649 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002650 */
Tejun Heo6183c002013-03-12 11:29:57 -07002651 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2652 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002653
2654 list_del_init(&next->list);
2655 wq->first_flusher = next;
2656
Tejun Heo112202d2013-02-13 19:29:12 -08002657 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002658 break;
2659
2660 /*
2661 * Meh... this color is already done, clear first
2662 * flusher and repeat cascading.
2663 */
2664 wq->first_flusher = NULL;
2665 }
2666
2667out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002668 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669}
Dave Jonesae90dd52006-06-30 01:40:45 -04002670EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002672/**
2673 * drain_workqueue - drain a workqueue
2674 * @wq: workqueue to drain
2675 *
2676 * Wait until the workqueue becomes empty. While draining is in progress,
2677 * only chain queueing is allowed. IOW, only currently pending or running
2678 * work items on @wq can queue further work items on it. @wq is flushed
2679 * repeatedly until it becomes empty. The number of flushing is detemined
2680 * by the depth of chaining and should be relatively short. Whine if it
2681 * takes too long.
2682 */
2683void drain_workqueue(struct workqueue_struct *wq)
2684{
2685 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002686 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002687
2688 /*
2689 * __queue_work() needs to test whether there are drainers, is much
2690 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002691 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002692 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002693 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002694 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002695 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002696 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002697reflush:
2698 flush_workqueue(wq);
2699
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002700 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002701
Tejun Heo49e3cf42013-03-12 11:29:58 -07002702 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002703 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002704
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002705 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002706 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002707 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002708
2709 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002710 continue;
2711
2712 if (++flush_cnt == 10 ||
2713 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002714 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002715 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002716
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002717 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002718 goto reflush;
2719 }
2720
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002721 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002722 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002723 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002724}
2725EXPORT_SYMBOL_GPL(drain_workqueue);
2726
Tejun Heo606a5022012-08-20 14:51:23 -07002727static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002728{
2729 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002730 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002731 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002732
2733 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002734
Tejun Heofa1b54e2013-03-12 11:30:00 -07002735 local_irq_disable();
2736 pool = get_work_pool(work);
2737 if (!pool) {
2738 local_irq_enable();
2739 return false;
2740 }
2741
2742 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002743 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002744 pwq = get_work_pwq(work);
2745 if (pwq) {
2746 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002747 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002748 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002749 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002750 if (!worker)
2751 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002752 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002753 }
Tejun Heobaf59022010-09-16 10:42:16 +02002754
Tejun Heo112202d2013-02-13 19:29:12 -08002755 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002756 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002757
Tejun Heoe1594892011-01-09 23:32:15 +01002758 /*
2759 * If @max_active is 1 or rescuer is in use, flushing another work
2760 * item on the same workqueue may lead to deadlock. Make sure the
2761 * flusher is not running on the same workqueue by verifying write
2762 * access.
2763 */
Tejun Heo493008a2013-03-12 11:30:03 -07002764 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002765 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002766 else
Tejun Heo112202d2013-02-13 19:29:12 -08002767 lock_map_acquire_read(&pwq->wq->lockdep_map);
2768 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002769
Tejun Heobaf59022010-09-16 10:42:16 +02002770 return true;
2771already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002772 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002773 return false;
2774}
2775
Oleg Nesterovdb700892008-07-25 01:47:49 -07002776/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002777 * flush_work - wait for a work to finish executing the last queueing instance
2778 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002779 *
Tejun Heo606a5022012-08-20 14:51:23 -07002780 * Wait until @work has finished execution. @work is guaranteed to be idle
2781 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002782 *
2783 * RETURNS:
2784 * %true if flush_work() waited for the work to finish execution,
2785 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002786 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002787bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002788{
Oleg Nesterovdb700892008-07-25 01:47:49 -07002789 struct wq_barrier barr;
2790
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002791 lock_map_acquire(&work->lockdep_map);
2792 lock_map_release(&work->lockdep_map);
2793
Tejun Heo606a5022012-08-20 14:51:23 -07002794 if (start_flush_work(work, &barr)) {
Tejun Heobaf59022010-09-16 10:42:16 +02002795 wait_for_completion(&barr.done);
2796 destroy_work_on_stack(&barr.work);
2797 return true;
Tejun Heo606a5022012-08-20 14:51:23 -07002798 } else {
Tejun Heobaf59022010-09-16 10:42:16 +02002799 return false;
Tejun Heo606a5022012-08-20 14:51:23 -07002800 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002801}
2802EXPORT_SYMBOL_GPL(flush_work);
2803
Tejun Heo36e227d2012-08-03 10:30:46 -07002804static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002805{
Tejun Heobbb68df2012-08-03 10:30:46 -07002806 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002807 int ret;
2808
2809 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002810 ret = try_to_grab_pending(work, is_dwork, &flags);
2811 /*
2812 * If someone else is canceling, wait for the same event it
2813 * would be waiting for before retrying.
2814 */
2815 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002816 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002817 } while (unlikely(ret < 0));
2818
Tejun Heobbb68df2012-08-03 10:30:46 -07002819 /* tell other tasks trying to grab @work to back off */
2820 mark_work_canceling(work);
2821 local_irq_restore(flags);
2822
Tejun Heo606a5022012-08-20 14:51:23 -07002823 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002824 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002825 return ret;
2826}
2827
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002828/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002829 * cancel_work_sync - cancel a work and wait for it to finish
2830 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002831 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002832 * Cancel @work and wait for its execution to finish. This function
2833 * can be used even if the work re-queues itself or migrates to
2834 * another workqueue. On return from this function, @work is
2835 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002836 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002837 * cancel_work_sync(&delayed_work->work) must not be used for
2838 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002839 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002840 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002841 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002842 *
2843 * RETURNS:
2844 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002845 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002846bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002847{
Tejun Heo36e227d2012-08-03 10:30:46 -07002848 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002849}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002850EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002851
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002852/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002853 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2854 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002855 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002856 * Delayed timer is cancelled and the pending work is queued for
2857 * immediate execution. Like flush_work(), this function only
2858 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002859 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002860 * RETURNS:
2861 * %true if flush_work() waited for the work to finish execution,
2862 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002863 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002864bool flush_delayed_work(struct delayed_work *dwork)
2865{
Tejun Heo8930cab2012-08-03 10:30:45 -07002866 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002867 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002868 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002869 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002870 return flush_work(&dwork->work);
2871}
2872EXPORT_SYMBOL(flush_delayed_work);
2873
2874/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002875 * cancel_delayed_work - cancel a delayed work
2876 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002877 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002878 * Kill off a pending delayed_work. Returns %true if @dwork was pending
2879 * and canceled; %false if wasn't pending. Note that the work callback
2880 * function may still be running on return, unless it returns %true and the
2881 * work doesn't re-arm itself. Explicitly flush or use
2882 * cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002883 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002884 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002885 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002886bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002887{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002888 unsigned long flags;
2889 int ret;
2890
2891 do {
2892 ret = try_to_grab_pending(&dwork->work, true, &flags);
2893 } while (unlikely(ret == -EAGAIN));
2894
2895 if (unlikely(ret < 0))
2896 return false;
2897
Tejun Heo7c3eed52013-01-24 11:01:33 -08002898 set_work_pool_and_clear_pending(&dwork->work,
2899 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002900 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002901 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002902}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002903EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002904
2905/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002906 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2907 * @dwork: the delayed work cancel
2908 *
2909 * This is cancel_work_sync() for delayed works.
2910 *
2911 * RETURNS:
2912 * %true if @dwork was pending, %false otherwise.
2913 */
2914bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002915{
Tejun Heo36e227d2012-08-03 10:30:46 -07002916 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002917}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002918EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002919
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002920/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002921 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002922 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002923 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002924 * schedule_on_each_cpu() executes @func on each online CPU using the
2925 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002926 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002927 *
2928 * RETURNS:
2929 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002930 */
David Howells65f27f32006-11-22 14:55:48 +00002931int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002932{
2933 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002934 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002935
Andrew Mortonb6136772006-06-25 05:47:49 -07002936 works = alloc_percpu(struct work_struct);
2937 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002938 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002939
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002940 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002941
Christoph Lameter15316ba2006-01-08 01:00:43 -08002942 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002943 struct work_struct *work = per_cpu_ptr(works, cpu);
2944
2945 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002946 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002947 }
Tejun Heo93981802009-11-17 14:06:20 -08002948
2949 for_each_online_cpu(cpu)
2950 flush_work(per_cpu_ptr(works, cpu));
2951
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002952 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002953 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08002954 return 0;
2955}
2956
Alan Sterneef6a7d2010-02-12 17:39:21 +09002957/**
2958 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2959 *
2960 * Forces execution of the kernel-global workqueue and blocks until its
2961 * completion.
2962 *
2963 * Think twice before calling this function! It's very easy to get into
2964 * trouble if you don't take great care. Either of the following situations
2965 * will lead to deadlock:
2966 *
2967 * One of the work items currently on the workqueue needs to acquire
2968 * a lock held by your code or its caller.
2969 *
2970 * Your code is running in the context of a work routine.
2971 *
2972 * They will be detected by lockdep when they occur, but the first might not
2973 * occur very often. It depends on what work items are on the workqueue and
2974 * what locks they need, which you have no control over.
2975 *
2976 * In most situations flushing the entire workqueue is overkill; you merely
2977 * need to know that a particular work item isn't queued and isn't running.
2978 * In such cases you should use cancel_delayed_work_sync() or
2979 * cancel_work_sync() instead.
2980 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002981void flush_scheduled_work(void)
2982{
Tejun Heod320c032010-06-29 10:07:14 +02002983 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002984}
Dave Jonesae90dd52006-06-30 01:40:45 -04002985EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002986
2987/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06002988 * execute_in_process_context - reliably execute the routine with user context
2989 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06002990 * @ew: guaranteed storage for the execute work structure (must
2991 * be available when the work executes)
2992 *
2993 * Executes the function immediately if process context is available,
2994 * otherwise schedules the function for delayed execution.
2995 *
2996 * Returns: 0 - function was executed
2997 * 1 - function was scheduled for execution
2998 */
David Howells65f27f32006-11-22 14:55:48 +00002999int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06003000{
3001 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00003002 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003003 return 0;
3004 }
3005
David Howells65f27f32006-11-22 14:55:48 +00003006 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06003007 schedule_work(&ew->work);
3008
3009 return 1;
3010}
3011EXPORT_SYMBOL_GPL(execute_in_process_context);
3012
Tejun Heo226223a2013-03-12 11:30:05 -07003013#ifdef CONFIG_SYSFS
3014/*
3015 * Workqueues with WQ_SYSFS flag set is visible to userland via
3016 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
3017 * following attributes.
3018 *
3019 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
3020 * max_active RW int : maximum number of in-flight work items
3021 *
3022 * Unbound workqueues have the following extra attributes.
3023 *
3024 * id RO int : the associated pool ID
3025 * nice RW int : nice value of the workers
3026 * cpumask RW mask : bitmask of allowed CPUs for the workers
3027 */
3028struct wq_device {
3029 struct workqueue_struct *wq;
3030 struct device dev;
3031};
3032
3033static struct workqueue_struct *dev_to_wq(struct device *dev)
3034{
3035 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3036
3037 return wq_dev->wq;
3038}
3039
3040static ssize_t wq_per_cpu_show(struct device *dev,
3041 struct device_attribute *attr, char *buf)
3042{
3043 struct workqueue_struct *wq = dev_to_wq(dev);
3044
3045 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
3046}
3047
3048static ssize_t wq_max_active_show(struct device *dev,
3049 struct device_attribute *attr, char *buf)
3050{
3051 struct workqueue_struct *wq = dev_to_wq(dev);
3052
3053 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
3054}
3055
3056static ssize_t wq_max_active_store(struct device *dev,
3057 struct device_attribute *attr,
3058 const char *buf, size_t count)
3059{
3060 struct workqueue_struct *wq = dev_to_wq(dev);
3061 int val;
3062
3063 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
3064 return -EINVAL;
3065
3066 workqueue_set_max_active(wq, val);
3067 return count;
3068}
3069
3070static struct device_attribute wq_sysfs_attrs[] = {
3071 __ATTR(per_cpu, 0444, wq_per_cpu_show, NULL),
3072 __ATTR(max_active, 0644, wq_max_active_show, wq_max_active_store),
3073 __ATTR_NULL,
3074};
3075
3076static ssize_t wq_pool_id_show(struct device *dev,
3077 struct device_attribute *attr, char *buf)
3078{
3079 struct workqueue_struct *wq = dev_to_wq(dev);
3080 struct worker_pool *pool;
3081 int written;
3082
3083 rcu_read_lock_sched();
3084 pool = first_pwq(wq)->pool;
3085 written = scnprintf(buf, PAGE_SIZE, "%d\n", pool->id);
3086 rcu_read_unlock_sched();
3087
3088 return written;
3089}
3090
3091static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
3092 char *buf)
3093{
3094 struct workqueue_struct *wq = dev_to_wq(dev);
3095 int written;
3096
Tejun Heo6029a912013-04-01 11:23:34 -07003097 mutex_lock(&wq->mutex);
3098 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
3099 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003100
3101 return written;
3102}
3103
3104/* prepare workqueue_attrs for sysfs store operations */
3105static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
3106{
3107 struct workqueue_attrs *attrs;
3108
3109 attrs = alloc_workqueue_attrs(GFP_KERNEL);
3110 if (!attrs)
3111 return NULL;
3112
Tejun Heo6029a912013-04-01 11:23:34 -07003113 mutex_lock(&wq->mutex);
3114 copy_workqueue_attrs(attrs, wq->unbound_attrs);
3115 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003116 return attrs;
3117}
3118
3119static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
3120 const char *buf, size_t count)
3121{
3122 struct workqueue_struct *wq = dev_to_wq(dev);
3123 struct workqueue_attrs *attrs;
3124 int ret;
3125
3126 attrs = wq_sysfs_prep_attrs(wq);
3127 if (!attrs)
3128 return -ENOMEM;
3129
3130 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
3131 attrs->nice >= -20 && attrs->nice <= 19)
3132 ret = apply_workqueue_attrs(wq, attrs);
3133 else
3134 ret = -EINVAL;
3135
3136 free_workqueue_attrs(attrs);
3137 return ret ?: count;
3138}
3139
3140static ssize_t wq_cpumask_show(struct device *dev,
3141 struct device_attribute *attr, char *buf)
3142{
3143 struct workqueue_struct *wq = dev_to_wq(dev);
3144 int written;
3145
Tejun Heo6029a912013-04-01 11:23:34 -07003146 mutex_lock(&wq->mutex);
3147 written = cpumask_scnprintf(buf, PAGE_SIZE, wq->unbound_attrs->cpumask);
3148 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003149
3150 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3151 return written;
3152}
3153
3154static ssize_t wq_cpumask_store(struct device *dev,
3155 struct device_attribute *attr,
3156 const char *buf, size_t count)
3157{
3158 struct workqueue_struct *wq = dev_to_wq(dev);
3159 struct workqueue_attrs *attrs;
3160 int ret;
3161
3162 attrs = wq_sysfs_prep_attrs(wq);
3163 if (!attrs)
3164 return -ENOMEM;
3165
3166 ret = cpumask_parse(buf, attrs->cpumask);
3167 if (!ret)
3168 ret = apply_workqueue_attrs(wq, attrs);
3169
3170 free_workqueue_attrs(attrs);
3171 return ret ?: count;
3172}
3173
3174static struct device_attribute wq_sysfs_unbound_attrs[] = {
3175 __ATTR(pool_id, 0444, wq_pool_id_show, NULL),
3176 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
3177 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
3178 __ATTR_NULL,
3179};
3180
3181static struct bus_type wq_subsys = {
3182 .name = "workqueue",
3183 .dev_attrs = wq_sysfs_attrs,
3184};
3185
3186static int __init wq_sysfs_init(void)
3187{
3188 return subsys_virtual_register(&wq_subsys, NULL);
3189}
3190core_initcall(wq_sysfs_init);
3191
3192static void wq_device_release(struct device *dev)
3193{
3194 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3195
3196 kfree(wq_dev);
3197}
3198
3199/**
3200 * workqueue_sysfs_register - make a workqueue visible in sysfs
3201 * @wq: the workqueue to register
3202 *
3203 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
3204 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
3205 * which is the preferred method.
3206 *
3207 * Workqueue user should use this function directly iff it wants to apply
3208 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
3209 * apply_workqueue_attrs() may race against userland updating the
3210 * attributes.
3211 *
3212 * Returns 0 on success, -errno on failure.
3213 */
3214int workqueue_sysfs_register(struct workqueue_struct *wq)
3215{
3216 struct wq_device *wq_dev;
3217 int ret;
3218
3219 /*
3220 * Adjusting max_active or creating new pwqs by applyting
3221 * attributes breaks ordering guarantee. Disallow exposing ordered
3222 * workqueues.
3223 */
3224 if (WARN_ON(wq->flags & __WQ_ORDERED))
3225 return -EINVAL;
3226
3227 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
3228 if (!wq_dev)
3229 return -ENOMEM;
3230
3231 wq_dev->wq = wq;
3232 wq_dev->dev.bus = &wq_subsys;
3233 wq_dev->dev.init_name = wq->name;
3234 wq_dev->dev.release = wq_device_release;
3235
3236 /*
3237 * unbound_attrs are created separately. Suppress uevent until
3238 * everything is ready.
3239 */
3240 dev_set_uevent_suppress(&wq_dev->dev, true);
3241
3242 ret = device_register(&wq_dev->dev);
3243 if (ret) {
3244 kfree(wq_dev);
3245 wq->wq_dev = NULL;
3246 return ret;
3247 }
3248
3249 if (wq->flags & WQ_UNBOUND) {
3250 struct device_attribute *attr;
3251
3252 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
3253 ret = device_create_file(&wq_dev->dev, attr);
3254 if (ret) {
3255 device_unregister(&wq_dev->dev);
3256 wq->wq_dev = NULL;
3257 return ret;
3258 }
3259 }
3260 }
3261
3262 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
3263 return 0;
3264}
3265
3266/**
3267 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
3268 * @wq: the workqueue to unregister
3269 *
3270 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
3271 */
3272static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
3273{
3274 struct wq_device *wq_dev = wq->wq_dev;
3275
3276 if (!wq->wq_dev)
3277 return;
3278
3279 wq->wq_dev = NULL;
3280 device_unregister(&wq_dev->dev);
3281}
3282#else /* CONFIG_SYSFS */
3283static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
3284#endif /* CONFIG_SYSFS */
3285
Tejun Heo7a4e3442013-03-12 11:30:00 -07003286/**
3287 * free_workqueue_attrs - free a workqueue_attrs
3288 * @attrs: workqueue_attrs to free
3289 *
3290 * Undo alloc_workqueue_attrs().
3291 */
3292void free_workqueue_attrs(struct workqueue_attrs *attrs)
3293{
3294 if (attrs) {
3295 free_cpumask_var(attrs->cpumask);
3296 kfree(attrs);
3297 }
3298}
3299
3300/**
3301 * alloc_workqueue_attrs - allocate a workqueue_attrs
3302 * @gfp_mask: allocation mask to use
3303 *
3304 * Allocate a new workqueue_attrs, initialize with default settings and
3305 * return it. Returns NULL on failure.
3306 */
3307struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3308{
3309 struct workqueue_attrs *attrs;
3310
3311 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3312 if (!attrs)
3313 goto fail;
3314 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3315 goto fail;
3316
Tejun Heo13e2e552013-04-01 11:23:31 -07003317 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003318 return attrs;
3319fail:
3320 free_workqueue_attrs(attrs);
3321 return NULL;
3322}
3323
Tejun Heo29c91e92013-03-12 11:30:03 -07003324static void copy_workqueue_attrs(struct workqueue_attrs *to,
3325 const struct workqueue_attrs *from)
3326{
3327 to->nice = from->nice;
3328 cpumask_copy(to->cpumask, from->cpumask);
3329}
3330
Tejun Heo29c91e92013-03-12 11:30:03 -07003331/* hash value of the content of @attr */
3332static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3333{
3334 u32 hash = 0;
3335
3336 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003337 hash = jhash(cpumask_bits(attrs->cpumask),
3338 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003339 return hash;
3340}
3341
3342/* content equality test */
3343static bool wqattrs_equal(const struct workqueue_attrs *a,
3344 const struct workqueue_attrs *b)
3345{
3346 if (a->nice != b->nice)
3347 return false;
3348 if (!cpumask_equal(a->cpumask, b->cpumask))
3349 return false;
3350 return true;
3351}
3352
Tejun Heo7a4e3442013-03-12 11:30:00 -07003353/**
3354 * init_worker_pool - initialize a newly zalloc'd worker_pool
3355 * @pool: worker_pool to initialize
3356 *
3357 * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
Tejun Heo29c91e92013-03-12 11:30:03 -07003358 * Returns 0 on success, -errno on failure. Even on failure, all fields
3359 * inside @pool proper are initialized and put_unbound_pool() can be called
3360 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003361 */
3362static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003363{
3364 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003365 pool->id = -1;
3366 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003367 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003368 pool->flags |= POOL_DISASSOCIATED;
3369 INIT_LIST_HEAD(&pool->worklist);
3370 INIT_LIST_HEAD(&pool->idle_list);
3371 hash_init(pool->busy_hash);
3372
3373 init_timer_deferrable(&pool->idle_timer);
3374 pool->idle_timer.function = idle_worker_timeout;
3375 pool->idle_timer.data = (unsigned long)pool;
3376
3377 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3378 (unsigned long)pool);
3379
3380 mutex_init(&pool->manager_arb);
Tejun Heobc3a1af2013-03-13 19:47:39 -07003381 mutex_init(&pool->manager_mutex);
Tejun Heo822d8402013-03-19 13:45:21 -07003382 idr_init(&pool->worker_idr);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003383
Tejun Heo29c91e92013-03-12 11:30:03 -07003384 INIT_HLIST_NODE(&pool->hash_node);
3385 pool->refcnt = 1;
3386
3387 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003388 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3389 if (!pool->attrs)
3390 return -ENOMEM;
3391 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003392}
3393
Tejun Heo29c91e92013-03-12 11:30:03 -07003394static void rcu_free_pool(struct rcu_head *rcu)
3395{
3396 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3397
Tejun Heo822d8402013-03-19 13:45:21 -07003398 idr_destroy(&pool->worker_idr);
Tejun Heo29c91e92013-03-12 11:30:03 -07003399 free_workqueue_attrs(pool->attrs);
3400 kfree(pool);
3401}
3402
3403/**
3404 * put_unbound_pool - put a worker_pool
3405 * @pool: worker_pool to put
3406 *
3407 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003408 * safe manner. get_unbound_pool() calls this function on its failure path
3409 * and this function should be able to release pools which went through,
3410 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003411 *
3412 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003413 */
3414static void put_unbound_pool(struct worker_pool *pool)
3415{
3416 struct worker *worker;
3417
Tejun Heoa892cac2013-04-01 11:23:32 -07003418 lockdep_assert_held(&wq_pool_mutex);
3419
3420 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003421 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003422
3423 /* sanity checks */
3424 if (WARN_ON(!(pool->flags & POOL_DISASSOCIATED)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003425 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003426 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003427
3428 /* release id and unhash */
3429 if (pool->id >= 0)
3430 idr_remove(&worker_pool_idr, pool->id);
3431 hash_del(&pool->hash_node);
3432
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003433 /*
3434 * Become the manager and destroy all workers. Grabbing
3435 * manager_arb prevents @pool's workers from blocking on
3436 * manager_mutex.
3437 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003438 mutex_lock(&pool->manager_arb);
Tejun Heocd549682013-03-13 19:47:39 -07003439 mutex_lock(&pool->manager_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003440 spin_lock_irq(&pool->lock);
3441
3442 while ((worker = first_worker(pool)))
3443 destroy_worker(worker);
3444 WARN_ON(pool->nr_workers || pool->nr_idle);
3445
3446 spin_unlock_irq(&pool->lock);
Tejun Heocd549682013-03-13 19:47:39 -07003447 mutex_unlock(&pool->manager_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003448 mutex_unlock(&pool->manager_arb);
3449
3450 /* shut down the timers */
3451 del_timer_sync(&pool->idle_timer);
3452 del_timer_sync(&pool->mayday_timer);
3453
3454 /* sched-RCU protected to allow dereferences from get_work_pool() */
3455 call_rcu_sched(&pool->rcu, rcu_free_pool);
3456}
3457
3458/**
3459 * get_unbound_pool - get a worker_pool with the specified attributes
3460 * @attrs: the attributes of the worker_pool to get
3461 *
3462 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3463 * reference count and return it. If there already is a matching
3464 * worker_pool, it will be used; otherwise, this function attempts to
3465 * create a new one. On failure, returns NULL.
Tejun Heoa892cac2013-04-01 11:23:32 -07003466 *
3467 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003468 */
3469static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3470{
Tejun Heo29c91e92013-03-12 11:30:03 -07003471 u32 hash = wqattrs_hash(attrs);
3472 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003473 int node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003474
Tejun Heoa892cac2013-04-01 11:23:32 -07003475 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003476
3477 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003478 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3479 if (wqattrs_equal(pool->attrs, attrs)) {
3480 pool->refcnt++;
3481 goto out_unlock;
3482 }
3483 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003484
3485 /* nope, create a new one */
3486 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
3487 if (!pool || init_worker_pool(pool) < 0)
3488 goto fail;
3489
Lai Jiangshan12ee4fc2013-03-20 03:28:01 +08003490 if (workqueue_freezing)
3491 pool->flags |= POOL_FREEZING;
3492
Tejun Heo8864b4e2013-03-12 11:30:04 -07003493 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003494 copy_workqueue_attrs(pool->attrs, attrs);
3495
Tejun Heof3f90ad2013-04-01 11:23:34 -07003496 /* if cpumask is contained inside a NUMA node, we belong to that node */
3497 if (wq_numa_enabled) {
3498 for_each_node(node) {
3499 if (cpumask_subset(pool->attrs->cpumask,
3500 wq_numa_possible_cpumask[node])) {
3501 pool->node = node;
3502 break;
3503 }
3504 }
3505 }
3506
Tejun Heo29c91e92013-03-12 11:30:03 -07003507 if (worker_pool_assign_id(pool) < 0)
3508 goto fail;
3509
3510 /* create and start the initial worker */
Tejun Heoebf44d12013-03-13 19:47:39 -07003511 if (create_and_start_worker(pool) < 0)
Tejun Heo29c91e92013-03-12 11:30:03 -07003512 goto fail;
3513
Tejun Heo29c91e92013-03-12 11:30:03 -07003514 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003515 hash_add(unbound_pool_hash, &pool->hash_node, hash);
3516out_unlock:
Tejun Heo29c91e92013-03-12 11:30:03 -07003517 return pool;
3518fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003519 if (pool)
3520 put_unbound_pool(pool);
3521 return NULL;
3522}
3523
Tejun Heo8864b4e2013-03-12 11:30:04 -07003524static void rcu_free_pwq(struct rcu_head *rcu)
3525{
3526 kmem_cache_free(pwq_cache,
3527 container_of(rcu, struct pool_workqueue, rcu));
3528}
3529
3530/*
3531 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3532 * and needs to be destroyed.
3533 */
3534static void pwq_unbound_release_workfn(struct work_struct *work)
3535{
3536 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3537 unbound_release_work);
3538 struct workqueue_struct *wq = pwq->wq;
3539 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003540 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003541
3542 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3543 return;
3544
Tejun Heo75ccf592013-03-12 11:30:04 -07003545 /*
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003546 * Unlink @pwq. Synchronization against wq->mutex isn't strictly
Tejun Heo75ccf592013-03-12 11:30:04 -07003547 * necessary on release but do it anyway. It's easier to verify
3548 * and consistent with the linking path.
3549 */
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003550 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003551 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003552 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003553 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003554
Tejun Heoa892cac2013-04-01 11:23:32 -07003555 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003556 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003557 mutex_unlock(&wq_pool_mutex);
3558
Tejun Heo8864b4e2013-03-12 11:30:04 -07003559 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3560
3561 /*
3562 * If we're the last pwq going away, @wq is already dead and no one
3563 * is gonna access it anymore. Free it.
3564 */
Tejun Heo6029a912013-04-01 11:23:34 -07003565 if (is_last) {
3566 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003567 kfree(wq);
Tejun Heo6029a912013-04-01 11:23:34 -07003568 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003569}
3570
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003571/**
Tejun Heo699ce092013-03-13 16:51:35 -07003572 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003573 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003574 *
Tejun Heo699ce092013-03-13 16:51:35 -07003575 * If @pwq isn't freezing, set @pwq->max_active to the associated
3576 * workqueue's saved_max_active and activate delayed work items
3577 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003578 */
Tejun Heo699ce092013-03-13 16:51:35 -07003579static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003580{
Tejun Heo699ce092013-03-13 16:51:35 -07003581 struct workqueue_struct *wq = pwq->wq;
3582 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003583
Tejun Heo699ce092013-03-13 16:51:35 -07003584 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003585 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003586
3587 /* fast exit for non-freezable wqs */
3588 if (!freezable && pwq->max_active == wq->saved_max_active)
3589 return;
3590
Lai Jiangshana357fc02013-03-25 16:57:19 -07003591 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003592
3593 if (!freezable || !(pwq->pool->flags & POOL_FREEZING)) {
3594 pwq->max_active = wq->saved_max_active;
3595
3596 while (!list_empty(&pwq->delayed_works) &&
3597 pwq->nr_active < pwq->max_active)
3598 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003599
3600 /*
3601 * Need to kick a worker after thawed or an unbound wq's
3602 * max_active is bumped. It's a slow path. Do it always.
3603 */
3604 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003605 } else {
3606 pwq->max_active = 0;
3607 }
3608
Lai Jiangshana357fc02013-03-25 16:57:19 -07003609 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003610}
3611
Tejun Heod2c1d402013-03-12 11:30:04 -07003612static void init_and_link_pwq(struct pool_workqueue *pwq,
3613 struct workqueue_struct *wq,
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003614 struct worker_pool *pool,
3615 struct pool_workqueue **p_last_pwq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003616{
3617 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3618
3619 pwq->pool = pool;
3620 pwq->wq = wq;
3621 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003622 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003623 INIT_LIST_HEAD(&pwq->delayed_works);
3624 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003625 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heod2c1d402013-03-12 11:30:04 -07003626
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003627 mutex_lock(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003628
Tejun Heo983ca252013-03-13 16:51:35 -07003629 /*
3630 * Set the matching work_color. This is synchronized with
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003631 * wq->mutex to avoid confusing flush_workqueue().
Tejun Heo983ca252013-03-13 16:51:35 -07003632 */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003633 if (p_last_pwq)
3634 *p_last_pwq = first_pwq(wq);
Tejun Heo75ccf592013-03-12 11:30:04 -07003635 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003636
3637 /* sync max_active to the current setting */
3638 pwq_adjust_max_active(pwq);
3639
3640 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003641 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Lai Jiangshana357fc02013-03-25 16:57:19 -07003642
Tejun Heo6029a912013-04-01 11:23:34 -07003643 if (wq->flags & WQ_UNBOUND)
3644 copy_workqueue_attrs(wq->unbound_attrs, pool->attrs);
3645
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003646 mutex_unlock(&wq->mutex);
Tejun Heod2c1d402013-03-12 11:30:04 -07003647}
3648
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003649/**
3650 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3651 * @wq: the target workqueue
3652 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3653 *
3654 * Apply @attrs to an unbound workqueue @wq. If @attrs doesn't match the
3655 * current attributes, a new pwq is created and made the first pwq which
3656 * will serve all new work items. Older pwqs are released as in-flight
3657 * work items finish. Note that a work item which repeatedly requeues
3658 * itself back-to-back will stay on its current pwq.
3659 *
3660 * Performs GFP_KERNEL allocations. Returns 0 on success and -errno on
3661 * failure.
3662 */
3663int apply_workqueue_attrs(struct workqueue_struct *wq,
3664 const struct workqueue_attrs *attrs)
3665{
Tejun Heo13e2e552013-04-01 11:23:31 -07003666 struct workqueue_attrs *new_attrs;
3667 struct pool_workqueue *pwq = NULL, *last_pwq;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003668 struct worker_pool *pool;
Tejun Heo48621252013-04-01 11:23:31 -07003669 int ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003670
Tejun Heo8719dce2013-03-12 11:30:04 -07003671 /* only unbound workqueues can change attributes */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003672 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3673 return -EINVAL;
3674
Tejun Heo8719dce2013-03-12 11:30:04 -07003675 /* creating multiple pwqs breaks ordering guarantee */
3676 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3677 return -EINVAL;
3678
Tejun Heo13e2e552013-04-01 11:23:31 -07003679 /* make a copy of @attrs and sanitize it */
3680 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3681 if (!new_attrs)
3682 goto enomem;
3683
3684 copy_workqueue_attrs(new_attrs, attrs);
3685 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
3686
Tejun Heoa892cac2013-04-01 11:23:32 -07003687 mutex_lock(&wq_pool_mutex);
3688
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003689 pwq = kmem_cache_zalloc(pwq_cache, GFP_KERNEL);
Tejun Heoa892cac2013-04-01 11:23:32 -07003690 if (!pwq) {
3691 mutex_unlock(&wq_pool_mutex);
Tejun Heo13e2e552013-04-01 11:23:31 -07003692 goto enomem;
Tejun Heoa892cac2013-04-01 11:23:32 -07003693 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003694
Tejun Heo13e2e552013-04-01 11:23:31 -07003695 pool = get_unbound_pool(new_attrs);
Tejun Heoa892cac2013-04-01 11:23:32 -07003696 if (!pool) {
3697 mutex_unlock(&wq_pool_mutex);
Tejun Heo13e2e552013-04-01 11:23:31 -07003698 goto enomem;
Tejun Heoa892cac2013-04-01 11:23:32 -07003699 }
3700
3701 mutex_unlock(&wq_pool_mutex);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003702
3703 init_and_link_pwq(pwq, wq, pool, &last_pwq);
3704 if (last_pwq) {
3705 spin_lock_irq(&last_pwq->pool->lock);
3706 put_pwq(last_pwq);
3707 spin_unlock_irq(&last_pwq->pool->lock);
3708 }
3709
Tejun Heo48621252013-04-01 11:23:31 -07003710 ret = 0;
3711 /* fall through */
3712out_free:
3713 free_workqueue_attrs(new_attrs);
3714 return ret;
Tejun Heo13e2e552013-04-01 11:23:31 -07003715
3716enomem:
3717 kmem_cache_free(pwq_cache, pwq);
Tejun Heo48621252013-04-01 11:23:31 -07003718 ret = -ENOMEM;
3719 goto out_free;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003720}
3721
Tejun Heo30cdf242013-03-12 11:29:57 -07003722static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003723{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003724 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo30cdf242013-03-12 11:29:57 -07003725 int cpu;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003726
Tejun Heo30cdf242013-03-12 11:29:57 -07003727 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003728 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3729 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003730 return -ENOMEM;
3731
3732 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003733 struct pool_workqueue *pwq =
3734 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003735 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003736 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003737
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003738 init_and_link_pwq(pwq, wq, &cpu_pools[highpri], NULL);
Tejun Heo30cdf242013-03-12 11:29:57 -07003739 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003740 return 0;
Tejun Heo30cdf242013-03-12 11:29:57 -07003741 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003742 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003743 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003744}
3745
Tejun Heof3421792010-07-02 10:03:51 +02003746static int wq_clamp_max_active(int max_active, unsigned int flags,
3747 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003748{
Tejun Heof3421792010-07-02 10:03:51 +02003749 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3750
3751 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03003752 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
3753 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003754
Tejun Heof3421792010-07-02 10:03:51 +02003755 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02003756}
3757
Tejun Heob196be82012-01-10 15:11:35 -08003758struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02003759 unsigned int flags,
3760 int max_active,
3761 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08003762 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07003763{
Tejun Heoecf68812013-04-01 11:23:34 -07003764 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003765 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07003766 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08003767
Tejun Heoecf68812013-04-01 11:23:34 -07003768 /* allocate wq and format name */
3769 wq = kzalloc(sizeof(*wq), GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08003770 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07003771 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08003772
Tejun Heo6029a912013-04-01 11:23:34 -07003773 if (flags & WQ_UNBOUND) {
3774 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3775 if (!wq->unbound_attrs)
3776 goto err_free_wq;
3777 }
3778
Tejun Heoecf68812013-04-01 11:23:34 -07003779 va_start(args, lock_name);
3780 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08003781 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003782
Tejun Heod320c032010-06-29 10:07:14 +02003783 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08003784 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003785
Tejun Heob196be82012-01-10 15:11:35 -08003786 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02003787 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003788 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003789 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08003790 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07003791 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02003792 INIT_LIST_HEAD(&wq->flusher_queue);
3793 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07003794 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003795
Johannes Bergeb13ba82008-01-16 09:51:58 +01003796 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07003797 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003798
Tejun Heo30cdf242013-03-12 11:29:57 -07003799 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07003800 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003801
Tejun Heo493008a2013-03-12 11:30:03 -07003802 /*
3803 * Workqueues which may be used during memory reclaim should
3804 * have a rescuer to guarantee forward progress.
3805 */
3806 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003807 struct worker *rescuer;
3808
Tejun Heod2c1d402013-03-12 11:30:04 -07003809 rescuer = alloc_worker();
Tejun Heoe22bee72010-06-29 10:07:14 +02003810 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07003811 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02003812
Tejun Heo111c2252013-01-17 17:16:24 -08003813 rescuer->rescue_wq = wq;
3814 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08003815 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07003816 if (IS_ERR(rescuer->task)) {
3817 kfree(rescuer);
3818 goto err_destroy;
3819 }
Tejun Heoe22bee72010-06-29 10:07:14 +02003820
Tejun Heod2c1d402013-03-12 11:30:04 -07003821 wq->rescuer = rescuer;
Tejun Heo14a40ff2013-03-19 13:45:20 -07003822 rescuer->task->flags |= PF_NO_SETAFFINITY;
Tejun Heoe22bee72010-06-29 10:07:14 +02003823 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003824 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003825
Tejun Heo226223a2013-03-12 11:30:05 -07003826 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
3827 goto err_destroy;
3828
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003829 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003830 * wq_pool_mutex protects global freeze state and workqueues list.
3831 * Grab it, adjust max_active and add the new @wq to workqueues
3832 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003833 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003834 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003835
Lai Jiangshana357fc02013-03-25 16:57:19 -07003836 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003837 for_each_pwq(pwq, wq)
3838 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07003839 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003840
Tejun Heo15376632010-06-29 10:07:11 +02003841 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003842
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003843 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02003844
Oleg Nesterov3af244332007-05-09 02:34:09 -07003845 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003846
3847err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07003848 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07003849 kfree(wq);
3850 return NULL;
3851err_destroy:
3852 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02003853 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003854}
Tejun Heod320c032010-06-29 10:07:14 +02003855EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003856
3857/**
3858 * destroy_workqueue - safely terminate a workqueue
3859 * @wq: target workqueue
3860 *
3861 * Safely destroy a workqueue. All work currently pending will be done first.
3862 */
3863void destroy_workqueue(struct workqueue_struct *wq)
3864{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003865 struct pool_workqueue *pwq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07003866
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02003867 /* drain it before proceeding with destruction */
3868 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01003869
Tejun Heo6183c002013-03-12 11:29:57 -07003870 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003871 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07003872 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07003873 int i;
3874
Tejun Heo76af4d92013-03-12 11:30:00 -07003875 for (i = 0; i < WORK_NR_COLORS; i++) {
3876 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003877 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003878 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003879 }
3880 }
3881
Tejun Heo8864b4e2013-03-12 11:30:04 -07003882 if (WARN_ON(pwq->refcnt > 1) ||
3883 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07003884 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003885 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003886 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07003887 }
Tejun Heo6183c002013-03-12 11:29:57 -07003888 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07003889 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07003890
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02003891 /*
3892 * wq list is used to freeze wq, remove from list after
3893 * flushing is complete in case freeze races us.
3894 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003895 mutex_lock(&wq_pool_mutex);
Tejun Heod2c1d402013-03-12 11:30:04 -07003896 list_del_init(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07003897 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07003898
Tejun Heo226223a2013-03-12 11:30:05 -07003899 workqueue_sysfs_unregister(wq);
3900
Tejun Heo493008a2013-03-12 11:30:03 -07003901 if (wq->rescuer) {
Tejun Heoe22bee72010-06-29 10:07:14 +02003902 kthread_stop(wq->rescuer->task);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02003903 kfree(wq->rescuer);
Tejun Heo493008a2013-03-12 11:30:03 -07003904 wq->rescuer = NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +02003905 }
3906
Tejun Heo8864b4e2013-03-12 11:30:04 -07003907 if (!(wq->flags & WQ_UNBOUND)) {
3908 /*
3909 * The base ref is never dropped on per-cpu pwqs. Directly
3910 * free the pwqs and wq.
3911 */
3912 free_percpu(wq->cpu_pwqs);
3913 kfree(wq);
3914 } else {
3915 /*
3916 * We're the sole accessor of @wq at this point. Directly
3917 * access the first pwq and put the base ref. As both pwqs
3918 * and pools are sched-RCU protected, the lock operations
3919 * are safe. @wq will be freed when the last pwq is
3920 * released.
3921 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003922 pwq = list_first_entry(&wq->pwqs, struct pool_workqueue,
3923 pwqs_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003924 spin_lock_irq(&pwq->pool->lock);
3925 put_pwq(pwq);
3926 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003927 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003928}
3929EXPORT_SYMBOL_GPL(destroy_workqueue);
3930
Tejun Heodcd989c2010-06-29 10:07:14 +02003931/**
3932 * workqueue_set_max_active - adjust max_active of a workqueue
3933 * @wq: target workqueue
3934 * @max_active: new max_active value.
3935 *
3936 * Set max_active of @wq to @max_active.
3937 *
3938 * CONTEXT:
3939 * Don't call from IRQ context.
3940 */
3941void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
3942{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003943 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02003944
Tejun Heo8719dce2013-03-12 11:30:04 -07003945 /* disallow meddling with max_active for ordered workqueues */
3946 if (WARN_ON(wq->flags & __WQ_ORDERED))
3947 return;
3948
Tejun Heof3421792010-07-02 10:03:51 +02003949 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02003950
Lai Jiangshana357fc02013-03-25 16:57:19 -07003951 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02003952
3953 wq->saved_max_active = max_active;
3954
Tejun Heo699ce092013-03-13 16:51:35 -07003955 for_each_pwq(pwq, wq)
3956 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02003957
Lai Jiangshana357fc02013-03-25 16:57:19 -07003958 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02003959}
3960EXPORT_SYMBOL_GPL(workqueue_set_max_active);
3961
3962/**
Tejun Heoe6267612013-03-12 17:41:37 -07003963 * current_is_workqueue_rescuer - is %current workqueue rescuer?
3964 *
3965 * Determine whether %current is a workqueue rescuer. Can be used from
3966 * work functions to determine whether it's being run off the rescuer task.
3967 */
3968bool current_is_workqueue_rescuer(void)
3969{
3970 struct worker *worker = current_wq_worker();
3971
Lai Jiangshan6a092df2013-03-20 03:28:03 +08003972 return worker && worker->rescue_wq;
Tejun Heoe6267612013-03-12 17:41:37 -07003973}
3974
3975/**
Tejun Heodcd989c2010-06-29 10:07:14 +02003976 * workqueue_congested - test whether a workqueue is congested
3977 * @cpu: CPU in question
3978 * @wq: target workqueue
3979 *
3980 * Test whether @wq's cpu workqueue for @cpu is congested. There is
3981 * no synchronization around this function and the test result is
3982 * unreliable and only useful as advisory hints or for debugging.
3983 *
3984 * RETURNS:
3985 * %true if congested, %false otherwise.
3986 */
Tejun Heod84ff052013-03-12 11:29:59 -07003987bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02003988{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003989 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07003990 bool ret;
3991
Lai Jiangshan88109452013-03-20 03:28:10 +08003992 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003993
3994 if (!(wq->flags & WQ_UNBOUND))
3995 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
3996 else
3997 pwq = first_pwq(wq);
Tejun Heodcd989c2010-06-29 10:07:14 +02003998
Tejun Heo76af4d92013-03-12 11:30:00 -07003999 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004000 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004001
4002 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004003}
4004EXPORT_SYMBOL_GPL(workqueue_congested);
4005
4006/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004007 * work_busy - test whether a work is currently pending or running
4008 * @work: the work to be tested
4009 *
4010 * Test whether @work is currently pending or running. There is no
4011 * synchronization around this function and the test result is
4012 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004013 *
4014 * RETURNS:
4015 * OR'd bitmask of WORK_BUSY_* bits.
4016 */
4017unsigned int work_busy(struct work_struct *work)
4018{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004019 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004020 unsigned long flags;
4021 unsigned int ret = 0;
4022
Tejun Heodcd989c2010-06-29 10:07:14 +02004023 if (work_pending(work))
4024 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004025
Tejun Heofa1b54e2013-03-12 11:30:00 -07004026 local_irq_save(flags);
4027 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004028 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004029 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004030 if (find_worker_executing_work(pool, work))
4031 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004032 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004033 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004034 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004035
4036 return ret;
4037}
4038EXPORT_SYMBOL_GPL(work_busy);
4039
Tejun Heodb7bccf2010-06-29 10:07:12 +02004040/*
4041 * CPU hotplug.
4042 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004043 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004044 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004045 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004046 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004047 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004048 * blocked draining impractical.
4049 *
Tejun Heo24647572013-01-24 11:01:33 -08004050 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004051 * running as an unbound one and allowing it to be reattached later if the
4052 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004053 */
4054
Tejun Heo706026c2013-01-24 11:01:34 -08004055static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004056{
Tejun Heo38db41d2013-01-24 11:01:34 -08004057 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004058 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004059 struct worker *worker;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004060 int wi;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004061
Tejun Heof02ae732013-03-12 11:30:03 -07004062 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo6183c002013-03-12 11:29:57 -07004063 WARN_ON_ONCE(cpu != smp_processor_id());
Tejun Heo94cf58b2013-01-24 11:01:33 -08004064
Tejun Heobc3a1af2013-03-13 19:47:39 -07004065 mutex_lock(&pool->manager_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004066 spin_lock_irq(&pool->lock);
4067
4068 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07004069 * We've blocked all manager operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004070 * unbound and set DISASSOCIATED. Before this, all workers
4071 * except for the ones which are still executing works from
4072 * before the last CPU down must be on the cpu. After
4073 * this, they may become diasporas.
4074 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004075 for_each_pool_worker(worker, wi, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004076 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004077
Tejun Heo24647572013-01-24 11:01:33 -08004078 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004079
Tejun Heo94cf58b2013-01-24 11:01:33 -08004080 spin_unlock_irq(&pool->lock);
Tejun Heobc3a1af2013-03-13 19:47:39 -07004081 mutex_unlock(&pool->manager_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004082 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004083
4084 /*
Tejun Heo628c78e2012-07-17 12:39:27 -07004085 * Call schedule() so that we cross rq->lock and thus can guarantee
4086 * sched callbacks see the %WORKER_UNBOUND flag. This is necessary
4087 * as scheduler callbacks may be invoked from other cpus.
4088 */
4089 schedule();
4090
4091 /*
4092 * Sched callbacks are disabled now. Zap nr_running. After this,
4093 * nr_running stays zero and need_more_worker() and keep_working()
Tejun Heo38db41d2013-01-24 11:01:34 -08004094 * are always true as long as the worklist is not empty. Pools on
4095 * @cpu now behave as unbound (in terms of concurrency management)
4096 * pools which are served by workers tied to the CPU.
Tejun Heo628c78e2012-07-17 12:39:27 -07004097 *
4098 * On return from this function, the current worker would trigger
4099 * unbound chain execution of pending work items if other workers
4100 * didn't already.
Tejun Heoe22bee72010-06-29 10:07:14 +02004101 */
Tejun Heof02ae732013-03-12 11:30:03 -07004102 for_each_cpu_worker_pool(pool, cpu)
Tejun Heoe19e3972013-01-24 11:39:44 -08004103 atomic_set(&pool->nr_running, 0);
Tejun Heodb7bccf2010-06-29 10:07:12 +02004104}
4105
Tejun Heobd7c0892013-03-19 13:45:21 -07004106/**
4107 * rebind_workers - rebind all workers of a pool to the associated CPU
4108 * @pool: pool of interest
4109 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004110 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004111 */
4112static void rebind_workers(struct worker_pool *pool)
4113{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004114 struct worker *worker;
4115 int wi;
Tejun Heobd7c0892013-03-19 13:45:21 -07004116
4117 lockdep_assert_held(&pool->manager_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004118
Tejun Heoa9ab7752013-03-19 13:45:21 -07004119 /*
4120 * Restore CPU affinity of all workers. As all idle workers should
4121 * be on the run-queue of the associated CPU before any local
4122 * wake-ups for concurrency management happen, restore CPU affinty
4123 * of all workers first and then clear UNBOUND. As we're called
4124 * from CPU_ONLINE, the following shouldn't fail.
4125 */
4126 for_each_pool_worker(worker, wi, pool)
4127 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4128 pool->attrs->cpumask) < 0);
4129
4130 spin_lock_irq(&pool->lock);
4131
4132 for_each_pool_worker(worker, wi, pool) {
4133 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004134
4135 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004136 * A bound idle worker should actually be on the runqueue
4137 * of the associated CPU for local wake-ups targeting it to
4138 * work. Kick all idle workers so that they migrate to the
4139 * associated CPU. Doing this in the same loop as
4140 * replacing UNBOUND with REBOUND is safe as no worker will
4141 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004142 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004143 if (worker_flags & WORKER_IDLE)
4144 wake_up_process(worker->task);
4145
4146 /*
4147 * We want to clear UNBOUND but can't directly call
4148 * worker_clr_flags() or adjust nr_running. Atomically
4149 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4150 * @worker will clear REBOUND using worker_clr_flags() when
4151 * it initiates the next execution cycle thus restoring
4152 * concurrency management. Note that when or whether
4153 * @worker clears REBOUND doesn't affect correctness.
4154 *
4155 * ACCESS_ONCE() is necessary because @worker->flags may be
4156 * tested without holding any lock in
4157 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4158 * fail incorrectly leading to premature concurrency
4159 * management operations.
4160 */
4161 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4162 worker_flags |= WORKER_REBOUND;
4163 worker_flags &= ~WORKER_UNBOUND;
4164 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004165 }
4166
Tejun Heoa9ab7752013-03-19 13:45:21 -07004167 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004168}
4169
Tejun Heo7dbc7252013-03-19 13:45:21 -07004170/**
4171 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4172 * @pool: unbound pool of interest
4173 * @cpu: the CPU which is coming up
4174 *
4175 * An unbound pool may end up with a cpumask which doesn't have any online
4176 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4177 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4178 * online CPU before, cpus_allowed of all its workers should be restored.
4179 */
4180static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4181{
4182 static cpumask_t cpumask;
4183 struct worker *worker;
4184 int wi;
4185
4186 lockdep_assert_held(&pool->manager_mutex);
4187
4188 /* is @cpu allowed for @pool? */
4189 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4190 return;
4191
4192 /* is @cpu the only online CPU? */
4193 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4194 if (cpumask_weight(&cpumask) != 1)
4195 return;
4196
4197 /* as we're called from CPU_ONLINE, the following shouldn't fail */
4198 for_each_pool_worker(worker, wi, pool)
4199 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4200 pool->attrs->cpumask) < 0);
4201}
4202
Tejun Heo8db25e72012-07-17 12:39:28 -07004203/*
4204 * Workqueues should be brought up before normal priority CPU notifiers.
4205 * This will be registered high priority CPU notifier.
4206 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07004207static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07004208 unsigned long action,
4209 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004210{
Tejun Heod84ff052013-03-12 11:29:59 -07004211 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07004212 struct worker_pool *pool;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004213 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004214
Tejun Heo8db25e72012-07-17 12:39:28 -07004215 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004216 case CPU_UP_PREPARE:
Tejun Heof02ae732013-03-12 11:30:03 -07004217 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07004218 if (pool->nr_workers)
4219 continue;
Tejun Heoebf44d12013-03-13 19:47:39 -07004220 if (create_and_start_worker(pool) < 0)
Tejun Heo3ce63372012-07-17 12:39:27 -07004221 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004222 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004223 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004224
Tejun Heo65758202012-07-17 12:39:26 -07004225 case CPU_DOWN_FAILED:
4226 case CPU_ONLINE:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004227 mutex_lock(&wq_pool_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004228
4229 for_each_pool(pool, pi) {
Tejun Heobc3a1af2013-03-13 19:47:39 -07004230 mutex_lock(&pool->manager_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004231
Tejun Heo7dbc7252013-03-19 13:45:21 -07004232 if (pool->cpu == cpu) {
4233 spin_lock_irq(&pool->lock);
4234 pool->flags &= ~POOL_DISASSOCIATED;
4235 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07004236
Tejun Heo7dbc7252013-03-19 13:45:21 -07004237 rebind_workers(pool);
4238 } else if (pool->cpu < 0) {
4239 restore_unbound_workers_cpumask(pool, cpu);
4240 }
Tejun Heo94cf58b2013-01-24 11:01:33 -08004241
Tejun Heobc3a1af2013-03-13 19:47:39 -07004242 mutex_unlock(&pool->manager_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004243 }
Tejun Heo7dbc7252013-03-19 13:45:21 -07004244
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004245 mutex_unlock(&wq_pool_mutex);
Tejun Heo8db25e72012-07-17 12:39:28 -07004246 break;
Tejun Heo65758202012-07-17 12:39:26 -07004247 }
4248 return NOTIFY_OK;
4249}
4250
4251/*
4252 * Workqueues should be brought down after normal priority CPU notifiers.
4253 * This will be registered as low priority CPU notifier.
4254 */
Lai Jiangshan9fdf9b72012-09-18 09:59:23 -07004255static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07004256 unsigned long action,
4257 void *hcpu)
4258{
Tejun Heod84ff052013-03-12 11:29:59 -07004259 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07004260 struct work_struct unbind_work;
4261
Tejun Heo65758202012-07-17 12:39:26 -07004262 switch (action & ~CPU_TASKS_FROZEN) {
4263 case CPU_DOWN_PREPARE:
Tejun Heo8db25e72012-07-17 12:39:28 -07004264 /* unbinding should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08004265 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09004266 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07004267 flush_work(&unbind_work);
4268 break;
Tejun Heo65758202012-07-17 12:39:26 -07004269 }
4270 return NOTIFY_OK;
4271}
4272
Rusty Russell2d3854a2008-11-05 13:39:10 +11004273#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004274
Rusty Russell2d3854a2008-11-05 13:39:10 +11004275struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004276 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004277 long (*fn)(void *);
4278 void *arg;
4279 long ret;
4280};
4281
Tejun Heoed48ece2012-09-18 12:48:43 -07004282static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004283{
Tejun Heoed48ece2012-09-18 12:48:43 -07004284 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4285
Rusty Russell2d3854a2008-11-05 13:39:10 +11004286 wfc->ret = wfc->fn(wfc->arg);
4287}
4288
4289/**
4290 * work_on_cpu - run a function in user context on a particular cpu
4291 * @cpu: the cpu to run on
4292 * @fn: the function to run
4293 * @arg: the function arg
4294 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004295 * This will return the value @fn returns.
4296 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06004297 * The caller must not hold any locks which would prevent @fn from completing.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004298 */
Tejun Heod84ff052013-03-12 11:29:59 -07004299long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004300{
Tejun Heoed48ece2012-09-18 12:48:43 -07004301 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004302
Tejun Heoed48ece2012-09-18 12:48:43 -07004303 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4304 schedule_work_on(cpu, &wfc.work);
4305 flush_work(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004306 return wfc.ret;
4307}
4308EXPORT_SYMBOL_GPL(work_on_cpu);
4309#endif /* CONFIG_SMP */
4310
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004311#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304312
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004313/**
4314 * freeze_workqueues_begin - begin freezing workqueues
4315 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004316 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004317 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004318 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004319 *
4320 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004321 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004322 */
4323void freeze_workqueues_begin(void)
4324{
Tejun Heo17116962013-03-12 11:29:58 -07004325 struct worker_pool *pool;
Tejun Heo24b8a842013-03-12 11:29:58 -07004326 struct workqueue_struct *wq;
4327 struct pool_workqueue *pwq;
Tejun Heo611c92a2013-03-13 16:51:36 -07004328 int pi;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004329
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004330 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004331
Tejun Heo6183c002013-03-12 11:29:57 -07004332 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004333 workqueue_freezing = true;
4334
Tejun Heo24b8a842013-03-12 11:29:58 -07004335 /* set FREEZING */
Tejun Heo611c92a2013-03-13 16:51:36 -07004336 for_each_pool(pool, pi) {
Tejun Heo5bcab332013-03-13 19:47:40 -07004337 spin_lock_irq(&pool->lock);
Tejun Heo17116962013-03-12 11:29:58 -07004338 WARN_ON_ONCE(pool->flags & POOL_FREEZING);
4339 pool->flags |= POOL_FREEZING;
Tejun Heo5bcab332013-03-13 19:47:40 -07004340 spin_unlock_irq(&pool->lock);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004341 }
4342
Tejun Heo24b8a842013-03-12 11:29:58 -07004343 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004344 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004345 for_each_pwq(pwq, wq)
4346 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004347 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004348 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004349
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004350 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004351}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004352
4353/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004354 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004355 *
4356 * Check whether freezing is complete. This function must be called
4357 * between freeze_workqueues_begin() and thaw_workqueues().
4358 *
4359 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004360 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004361 *
4362 * RETURNS:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004363 * %true if some freezable workqueues are still busy. %false if freezing
4364 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004365 */
4366bool freeze_workqueues_busy(void)
4367{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004368 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004369 struct workqueue_struct *wq;
4370 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004371
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004372 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004373
Tejun Heo6183c002013-03-12 11:29:57 -07004374 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004375
Tejun Heo24b8a842013-03-12 11:29:58 -07004376 list_for_each_entry(wq, &workqueues, list) {
4377 if (!(wq->flags & WQ_FREEZABLE))
4378 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004379 /*
4380 * nr_active is monotonically decreasing. It's safe
4381 * to peek without lock.
4382 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004383 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004384 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004385 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004386 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004387 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004388 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004389 goto out_unlock;
4390 }
4391 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004392 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004393 }
4394out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004395 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004396 return busy;
4397}
4398
4399/**
4400 * thaw_workqueues - thaw workqueues
4401 *
4402 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004403 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004404 *
4405 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004406 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004407 */
4408void thaw_workqueues(void)
4409{
Tejun Heo24b8a842013-03-12 11:29:58 -07004410 struct workqueue_struct *wq;
4411 struct pool_workqueue *pwq;
4412 struct worker_pool *pool;
Tejun Heo611c92a2013-03-13 16:51:36 -07004413 int pi;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004414
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004415 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004416
4417 if (!workqueue_freezing)
4418 goto out_unlock;
4419
Tejun Heo24b8a842013-03-12 11:29:58 -07004420 /* clear FREEZING */
Tejun Heo611c92a2013-03-13 16:51:36 -07004421 for_each_pool(pool, pi) {
Tejun Heo5bcab332013-03-13 19:47:40 -07004422 spin_lock_irq(&pool->lock);
Tejun Heo24b8a842013-03-12 11:29:58 -07004423 WARN_ON_ONCE(!(pool->flags & POOL_FREEZING));
4424 pool->flags &= ~POOL_FREEZING;
Tejun Heo5bcab332013-03-13 19:47:40 -07004425 spin_unlock_irq(&pool->lock);
Tejun Heo24b8a842013-03-12 11:29:58 -07004426 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02004427
Tejun Heo24b8a842013-03-12 11:29:58 -07004428 /* restore max_active and repopulate worklist */
4429 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004430 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004431 for_each_pwq(pwq, wq)
4432 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004433 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004434 }
4435
4436 workqueue_freezing = false;
4437out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004438 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004439}
4440#endif /* CONFIG_FREEZER */
4441
Tejun Heobce90382013-04-01 11:23:32 -07004442static void __init wq_numa_init(void)
4443{
4444 cpumask_var_t *tbl;
4445 int node, cpu;
4446
4447 /* determine NUMA pwq table len - highest node id + 1 */
4448 for_each_node(node)
4449 wq_numa_tbl_len = max(wq_numa_tbl_len, node + 1);
4450
4451 if (num_possible_nodes() <= 1)
4452 return;
4453
4454 /*
4455 * We want masks of possible CPUs of each node which isn't readily
4456 * available. Build one from cpu_to_node() which should have been
4457 * fully initialized by now.
4458 */
4459 tbl = kzalloc(wq_numa_tbl_len * sizeof(tbl[0]), GFP_KERNEL);
4460 BUG_ON(!tbl);
4461
4462 for_each_node(node)
4463 BUG_ON(!alloc_cpumask_var_node(&tbl[node], GFP_KERNEL, node));
4464
4465 for_each_possible_cpu(cpu) {
4466 node = cpu_to_node(cpu);
4467 if (WARN_ON(node == NUMA_NO_NODE)) {
4468 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
4469 /* happens iff arch is bonkers, let's just proceed */
4470 return;
4471 }
4472 cpumask_set_cpu(cpu, tbl[node]);
4473 }
4474
4475 wq_numa_possible_cpumask = tbl;
4476 wq_numa_enabled = true;
4477}
4478
Suresh Siddha6ee05782010-07-30 14:57:37 -07004479static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004480{
Tejun Heo7a4e3442013-03-12 11:30:00 -07004481 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
4482 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02004483
Tejun Heo7c3eed52013-01-24 11:01:33 -08004484 /* make sure we have enough bits for OFFQ pool ID */
4485 BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT)) <
Lai Jiangshan6be19582013-02-06 18:04:53 -08004486 WORK_CPU_END * NR_STD_WORKER_POOLS);
Tejun Heob5490072012-08-03 10:30:46 -07004487
Tejun Heoe904e6c2013-03-12 11:29:57 -07004488 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
4489
4490 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
4491
Tejun Heo65758202012-07-17 12:39:26 -07004492 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07004493 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02004494
Tejun Heobce90382013-04-01 11:23:32 -07004495 wq_numa_init();
4496
Tejun Heo706026c2013-01-24 11:01:34 -08004497 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07004498 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07004499 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004500
Tejun Heo7a4e3442013-03-12 11:30:00 -07004501 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07004502 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07004503 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08004504 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07004505 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07004506 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07004507 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07004508
Tejun Heo9daf9e62013-01-24 11:01:33 -08004509 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004510 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08004511 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004512 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07004513 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02004514 }
4515
Tejun Heoe22bee72010-06-29 10:07:14 +02004516 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07004517 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07004518 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02004519
Tejun Heof02ae732013-03-12 11:30:03 -07004520 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07004521 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoebf44d12013-03-13 19:47:39 -07004522 BUG_ON(create_and_start_worker(pool) < 0);
Tejun Heo4ce62e92012-07-13 22:16:44 -07004523 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004524 }
4525
Tejun Heo29c91e92013-03-12 11:30:03 -07004526 /* create default unbound wq attrs */
4527 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
4528 struct workqueue_attrs *attrs;
4529
4530 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07004531 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07004532 unbound_std_wq_attrs[i] = attrs;
4533 }
4534
Tejun Heod320c032010-06-29 10:07:14 +02004535 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09004536 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02004537 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02004538 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
4539 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01004540 system_freezable_wq = alloc_workqueue("events_freezable",
4541 WQ_FREEZABLE, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09004542 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Tejun Heoae930e02012-08-20 14:51:23 -07004543 !system_unbound_wq || !system_freezable_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07004544 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004545}
Suresh Siddha6ee05782010-07-30 14:57:37 -07004546early_initcall(init_workqueues);