blob: 4cb8527a578313e02dee4923f4ecc6d26adfc26f [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
Libinb11895c2013-08-21 08:50:39 +080019 * automatically managed. There are two worker pools for each CPU (one for
20 * normal work items and the other for high priority ones) and some extra
21 * pools for workqueues which are not bound to any specific CPU - the
22 * number of these backing pools is dynamic.
Tejun Heoc54fce62010-09-10 16:51:36 +020023 *
24 * Please read Documentation/workqueue.txt for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 */
26
Paul Gortmaker9984de12011-05-23 14:51:41 -040027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/kernel.h>
29#include <linux/sched.h>
30#include <linux/init.h>
31#include <linux/signal.h>
32#include <linux/completion.h>
33#include <linux/workqueue.h>
34#include <linux/slab.h>
35#include <linux/cpu.h>
36#include <linux/notifier.h>
37#include <linux/kthread.h>
James Bottomley1fa44ec2006-02-23 12:43:43 -060038#include <linux/hardirq.h>
Christoph Lameter46934022006-10-11 01:21:26 -070039#include <linux/mempolicy.h>
Rafael J. Wysocki341a5952006-12-06 20:34:49 -080040#include <linux/freezer.h>
Peter Zijlstrad5abe662006-12-06 20:37:26 -080041#include <linux/kallsyms.h>
42#include <linux/debug_locks.h>
Johannes Berg4e6045f2007-10-18 23:39:55 -070043#include <linux/lockdep.h>
Tejun Heoc34056a2010-06-29 10:07:11 +020044#include <linux/idr.h>
Tejun Heo29c91e92013-03-12 11:30:03 -070045#include <linux/jhash.h>
Sasha Levin42f85702012-12-17 10:01:23 -050046#include <linux/hashtable.h>
Tejun Heo76af4d92013-03-12 11:30:00 -070047#include <linux/rculist.h>
Tejun Heobce90382013-04-01 11:23:32 -070048#include <linux/nodemask.h>
Tejun Heo4c16bd32013-04-01 11:23:36 -070049#include <linux/moduleparam.h>
Tejun Heo3d1cb202013-04-30 15:27:22 -070050#include <linux/uaccess.h>
Tejun Heoe22bee72010-06-29 10:07:14 +020051
Tejun Heoea138442013-01-18 14:05:55 -080052#include "workqueue_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Tejun Heoc8e55f32010-06-29 10:07:12 +020054enum {
Tejun Heobc2ae0f2012-07-17 12:39:27 -070055 /*
Tejun Heo24647572013-01-24 11:01:33 -080056 * worker_pool flags
Tejun Heobc2ae0f2012-07-17 12:39:27 -070057 *
Tejun Heo24647572013-01-24 11:01:33 -080058 * A bound pool is either associated or disassociated with its CPU.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070059 * While associated (!DISASSOCIATED), all workers are bound to the
60 * CPU and none has %WORKER_UNBOUND set and concurrency management
61 * is in effect.
62 *
63 * While DISASSOCIATED, the cpu may be offline and all workers have
64 * %WORKER_UNBOUND set and concurrency management disabled, and may
Tejun Heo24647572013-01-24 11:01:33 -080065 * be executing on any CPU. The pool behaves as an unbound one.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070066 *
Tejun Heobc3a1af2013-03-13 19:47:39 -070067 * Note that DISASSOCIATED should be flipped only while holding
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +080068 * attach_mutex to avoid changing binding state while
Lai Jiangshan4736cbf2014-05-20 17:46:35 +080069 * worker_attach_to_pool() is in progress.
Tejun Heobc2ae0f2012-07-17 12:39:27 -070070 */
Tejun Heo24647572013-01-24 11:01:33 -080071 POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */
Tejun Heodb7bccf2010-06-29 10:07:12 +020072
Tejun Heoc8e55f32010-06-29 10:07:12 +020073 /* worker flags */
Tejun Heoc8e55f32010-06-29 10:07:12 +020074 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
Dongsheng Yang8698a742014-03-11 18:09:12 +0800100 * all cpus. Give MIN_NICE.
Tejun Heoe22bee72010-06-29 10:07:14 +0200101 */
Dongsheng Yang8698a742014-03-11 18:09:12 +0800102 RESCUER_NICE_LEVEL = MIN_NICE,
103 HIGHPRI_NICE_LEVEL = MIN_NICE,
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 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800124 * A: pool->attach_mutex protected.
Tejun Heo822d8402013-03-19 13:45:21 -0700125 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700126 * PL: wq_pool_mutex protected.
Tejun Heo76af4d92013-03-12 11:30:00 -0700127 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700128 * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo5bcab332013-03-13 19:47:40 -0700129 *
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700130 * WQ: wq->mutex protected.
131 *
Lai Jiangshanb5927602013-03-25 16:57:19 -0700132 * WR: wq->mutex protected for writes. Sched-RCU protected for reads.
Tejun Heo2e109a22013-03-13 19:47:40 -0700133 *
134 * MD: wq_mayday_lock protected.
Tejun Heo4690c4a2010-06-29 10:07:10 +0200135 */
136
Tejun Heo2eaebdb2013-01-18 14:05:55 -0800137/* struct worker is defined in workqueue_internal.h */
Tejun Heoc34056a2010-06-29 10:07:11 +0200138
Tejun Heobd7bdd42012-07-12 14:46:37 -0700139struct worker_pool {
Tejun Heod565ed62013-01-24 11:01:33 -0800140 spinlock_t lock; /* the pool lock */
Tejun Heod84ff052013-03-12 11:29:59 -0700141 int cpu; /* I: the associated cpu */
Tejun Heof3f90ad2013-04-01 11:23:34 -0700142 int node; /* I: the associated node ID */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800143 int id; /* I: pool ID */
Tejun Heo11ebea52012-07-12 14:46:37 -0700144 unsigned int flags; /* X: flags */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700145
146 struct list_head worklist; /* L: list of pending works */
147 int nr_workers; /* L: total number of workers */
Lai Jiangshanea1abd62012-09-18 09:59:22 -0700148
149 /* nr_idle includes the ones off idle_list for rebinding */
Tejun Heobd7bdd42012-07-12 14:46:37 -0700150 int nr_idle; /* L: currently idle ones */
151
152 struct list_head idle_list; /* X: list of idle workers */
153 struct timer_list idle_timer; /* L: worker idle timeout */
154 struct timer_list mayday_timer; /* L: SOS timer for workers */
155
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700156 /* a workers is either on busy_hash or idle_list, or the manager */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800157 DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
158 /* L: hash of busy workers */
159
Tejun Heobc3a1af2013-03-13 19:47:39 -0700160 /* see manage_workers() for details on the two manager mutexes */
Tejun Heo34a06bd2013-03-12 11:30:00 -0700161 struct mutex manager_arb; /* manager arbitration */
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800162 struct mutex attach_mutex; /* attach/detach exclusion */
163 struct list_head workers; /* A: attached workers */
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +0800164 struct completion *detach_completion; /* all workers detached */
Tejun Heoe19e3972013-01-24 11:39:44 -0800165
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +0800166 struct ida worker_ida; /* worker IDs for task name */
Tejun Heoe19e3972013-01-24 11:39:44 -0800167
Tejun Heo7a4e3442013-03-12 11:30:00 -0700168 struct workqueue_attrs *attrs; /* I: worker attributes */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700169 struct hlist_node hash_node; /* PL: unbound_pool_hash node */
170 int refcnt; /* PL: refcnt for unbound pools */
Tejun Heo7a4e3442013-03-12 11:30:00 -0700171
Tejun Heoe19e3972013-01-24 11:39:44 -0800172 /*
173 * The current concurrency level. As it's likely to be accessed
174 * from other CPUs during try_to_wake_up(), put it in a separate
175 * cacheline.
176 */
177 atomic_t nr_running ____cacheline_aligned_in_smp;
Tejun Heo29c91e92013-03-12 11:30:03 -0700178
179 /*
180 * Destruction of pool is sched-RCU protected to allow dereferences
181 * from get_work_pool().
182 */
183 struct rcu_head rcu;
Tejun Heo8b03ae32010-06-29 10:07:12 +0200184} ____cacheline_aligned_in_smp;
185
186/*
Tejun Heo112202d2013-02-13 19:29:12 -0800187 * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS
188 * of work_struct->data are used for flags and the remaining high bits
189 * point to the pwq; thus, pwqs need to be aligned at two's power of the
190 * number of flag bits.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 */
Tejun Heo112202d2013-02-13 19:29:12 -0800192struct pool_workqueue {
Tejun Heobd7bdd42012-07-12 14:46:37 -0700193 struct worker_pool *pool; /* I: the associated pool */
Tejun Heo4690c4a2010-06-29 10:07:10 +0200194 struct workqueue_struct *wq; /* I: the owning workqueue */
Tejun Heo73f53c42010-06-29 10:07:11 +0200195 int work_color; /* L: current color */
196 int flush_color; /* L: flushing color */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700197 int refcnt; /* L: reference count */
Tejun Heo73f53c42010-06-29 10:07:11 +0200198 int nr_in_flight[WORK_NR_COLORS];
199 /* L: nr of in_flight works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200200 int nr_active; /* L: nr of active works */
Tejun Heoa0a1a5f2010-06-29 10:07:12 +0200201 int max_active; /* L: max active works */
Tejun Heo1e19ffc2010-06-29 10:07:12 +0200202 struct list_head delayed_works; /* L: delayed works */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700203 struct list_head pwqs_node; /* WR: node on wq->pwqs */
Tejun Heo2e109a22013-03-13 19:47:40 -0700204 struct list_head mayday_node; /* MD: node on wq->maydays */
Tejun Heo8864b4e2013-03-12 11:30:04 -0700205
206 /*
207 * Release of unbound pwq is punted to system_wq. See put_pwq()
208 * and pwq_unbound_release_workfn() for details. pool_workqueue
209 * itself is also sched-RCU protected so that the first pwq can be
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700210 * determined without grabbing wq->mutex.
Tejun Heo8864b4e2013-03-12 11:30:04 -0700211 */
212 struct work_struct unbound_release_work;
213 struct rcu_head rcu;
Tejun Heoe904e6c2013-03-12 11:29:57 -0700214} __aligned(1 << WORK_STRUCT_FLAG_BITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216/*
Tejun Heo73f53c42010-06-29 10:07:11 +0200217 * Structure used to wait for workqueue flush.
218 */
219struct wq_flusher {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700220 struct list_head list; /* WQ: list of flushers */
221 int flush_color; /* WQ: flush color waiting for */
Tejun Heo73f53c42010-06-29 10:07:11 +0200222 struct completion done; /* flush completion */
223};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Tejun Heo226223a2013-03-12 11:30:05 -0700225struct wq_device;
226
Tejun Heo73f53c42010-06-29 10:07:11 +0200227/*
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700228 * The externally visible workqueue. It relays the issued work items to
229 * the appropriate worker_pool through its pool_workqueues.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 */
231struct workqueue_struct {
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700232 struct list_head pwqs; /* WR: all pwqs of this wq */
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700233 struct list_head list; /* PL: list of all workqueues */
Tejun Heo73f53c42010-06-29 10:07:11 +0200234
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700235 struct mutex mutex; /* protects this wq */
236 int work_color; /* WQ: current work color */
237 int flush_color; /* WQ: current flush color */
Tejun Heo112202d2013-02-13 19:29:12 -0800238 atomic_t nr_pwqs_to_flush; /* flush in progress */
Lai Jiangshan3c25a552013-03-25 16:57:17 -0700239 struct wq_flusher *first_flusher; /* WQ: first flusher */
240 struct list_head flusher_queue; /* WQ: flush waiters */
241 struct list_head flusher_overflow; /* WQ: flush overflow list */
Tejun Heo73f53c42010-06-29 10:07:11 +0200242
Tejun Heo2e109a22013-03-13 19:47:40 -0700243 struct list_head maydays; /* MD: pwqs requesting rescue */
Tejun Heoe22bee72010-06-29 10:07:14 +0200244 struct worker *rescuer; /* I: rescue worker */
245
Lai Jiangshan87fc7412013-03-25 16:57:18 -0700246 int nr_drainers; /* WQ: drain in progress */
Lai Jiangshana357fc02013-03-25 16:57:19 -0700247 int saved_max_active; /* WQ: saved pwq max_active */
Tejun Heo226223a2013-03-12 11:30:05 -0700248
Tejun Heo6029a912013-04-01 11:23:34 -0700249 struct workqueue_attrs *unbound_attrs; /* WQ: only for unbound wqs */
Tejun Heo4c16bd32013-04-01 11:23:36 -0700250 struct pool_workqueue *dfl_pwq; /* WQ: only for unbound wqs */
Tejun Heo6029a912013-04-01 11:23:34 -0700251
Tejun Heo226223a2013-03-12 11:30:05 -0700252#ifdef CONFIG_SYSFS
253 struct wq_device *wq_dev; /* I: for sysfs interface */
254#endif
Johannes Berg4e6045f2007-10-18 23:39:55 -0700255#ifdef CONFIG_LOCKDEP
Tejun Heo4690c4a2010-06-29 10:07:10 +0200256 struct lockdep_map lockdep_map;
Johannes Berg4e6045f2007-10-18 23:39:55 -0700257#endif
Tejun Heoecf68812013-04-01 11:23:34 -0700258 char name[WQ_NAME_LEN]; /* I: workqueue name */
Tejun Heo2728fd22013-04-01 11:23:35 -0700259
260 /* hot fields used during command issue, aligned to cacheline */
261 unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */
262 struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700263 struct pool_workqueue __rcu *numa_pwq_tbl[]; /* FR: unbound pwqs indexed by node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264};
265
Tejun Heoe904e6c2013-03-12 11:29:57 -0700266static struct kmem_cache *pwq_cache;
267
Tejun Heobce90382013-04-01 11:23:32 -0700268static int wq_numa_tbl_len; /* highest possible NUMA node id + 1 */
269static cpumask_var_t *wq_numa_possible_cpumask;
270 /* possible CPUs of each node */
271
Tejun Heod55262c2013-04-01 11:23:38 -0700272static bool wq_disable_numa;
273module_param_named(disable_numa, wq_disable_numa, bool, 0444);
274
Viresh Kumarcee22a12013-04-08 16:45:40 +0530275/* see the comment above the definition of WQ_POWER_EFFICIENT */
276#ifdef CONFIG_WQ_POWER_EFFICIENT_DEFAULT
277static bool wq_power_efficient = true;
278#else
279static bool wq_power_efficient;
280#endif
281
282module_param_named(power_efficient, wq_power_efficient, bool, 0444);
283
Tejun Heobce90382013-04-01 11:23:32 -0700284static bool wq_numa_enabled; /* unbound NUMA affinity enabled */
285
Tejun Heo4c16bd32013-04-01 11:23:36 -0700286/* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
287static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
288
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700289static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */
Tejun Heo2e109a22013-03-13 19:47:40 -0700290static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
Tejun Heo5bcab332013-03-13 19:47:40 -0700291
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700292static LIST_HEAD(workqueues); /* PL: list of all workqueues */
293static bool workqueue_freezing; /* PL: have wqs started freezing? */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700294
295/* the per-cpu worker pools */
296static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS],
297 cpu_worker_pools);
298
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700299static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700300
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700301/* PL: hash of all unbound pools keyed by pool->attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -0700302static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
303
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700304/* I: attributes used when instantiating standard unbound pools on demand */
Tejun Heo29c91e92013-03-12 11:30:03 -0700305static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
306
Tejun Heo8a2b7532013-09-05 12:30:04 -0400307/* I: attributes used when instantiating ordered pools on demand */
308static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
309
Tejun Heod320c032010-06-29 10:07:14 +0200310struct workqueue_struct *system_wq __read_mostly;
Marc Dionnead7b1f82013-05-06 17:44:55 -0400311EXPORT_SYMBOL(system_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300312struct workqueue_struct *system_highpri_wq __read_mostly;
Joonsoo Kim1aabe902012-08-15 23:25:39 +0900313EXPORT_SYMBOL_GPL(system_highpri_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300314struct workqueue_struct *system_long_wq __read_mostly;
Tejun Heod320c032010-06-29 10:07:14 +0200315EXPORT_SYMBOL_GPL(system_long_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300316struct workqueue_struct *system_unbound_wq __read_mostly;
Tejun Heof3421792010-07-02 10:03:51 +0200317EXPORT_SYMBOL_GPL(system_unbound_wq);
Valentin Ilie044c7822012-08-19 00:52:42 +0300318struct workqueue_struct *system_freezable_wq __read_mostly;
Tejun Heo24d51ad2011-02-21 09:52:50 +0100319EXPORT_SYMBOL_GPL(system_freezable_wq);
Viresh Kumar06681062013-04-24 17:12:54 +0530320struct workqueue_struct *system_power_efficient_wq __read_mostly;
321EXPORT_SYMBOL_GPL(system_power_efficient_wq);
322struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
323EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
Tejun Heod320c032010-06-29 10:07:14 +0200324
Tejun Heo7d19c5c2013-03-13 19:47:40 -0700325static int worker_thread(void *__worker);
326static void copy_workqueue_attrs(struct workqueue_attrs *to,
327 const struct workqueue_attrs *from);
328
Tejun Heo97bd2342010-10-05 10:41:14 +0200329#define CREATE_TRACE_POINTS
330#include <trace/events/workqueue.h>
331
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700332#define assert_rcu_or_pool_mutex() \
Tejun Heo5bcab332013-03-13 19:47:40 -0700333 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700334 lockdep_is_held(&wq_pool_mutex), \
335 "sched RCU or wq_pool_mutex should be held")
Tejun Heo5bcab332013-03-13 19:47:40 -0700336
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700337#define assert_rcu_or_wq_mutex(wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700338 rcu_lockdep_assert(rcu_read_lock_sched_held() || \
Lai Jiangshanb5927602013-03-25 16:57:19 -0700339 lockdep_is_held(&wq->mutex), \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700340 "sched RCU or wq->mutex should be held")
Tejun Heo76af4d92013-03-12 11:30:00 -0700341
Tejun Heof02ae732013-03-12 11:30:03 -0700342#define for_each_cpu_worker_pool(pool, cpu) \
343 for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \
344 (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
Tejun Heo7a62c2c2013-03-12 11:30:03 -0700345 (pool)++)
Tejun Heo4ce62e92012-07-13 22:16:44 -0700346
Tejun Heo49e3cf42013-03-12 11:29:58 -0700347/**
Tejun Heo17116962013-03-12 11:29:58 -0700348 * for_each_pool - iterate through all worker_pools in the system
349 * @pool: iteration cursor
Tejun Heo611c92a2013-03-13 16:51:36 -0700350 * @pi: integer used for iteration
Tejun Heofa1b54e2013-03-12 11:30:00 -0700351 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700352 * This must be called either with wq_pool_mutex held or sched RCU read
353 * locked. If the pool needs to be used beyond the locking in effect, the
354 * caller is responsible for guaranteeing that the pool stays online.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700355 *
356 * The if/else clause exists only for the lockdep assertion and can be
357 * ignored.
Tejun Heo17116962013-03-12 11:29:58 -0700358 */
Tejun Heo611c92a2013-03-13 16:51:36 -0700359#define for_each_pool(pool, pi) \
360 idr_for_each_entry(&worker_pool_idr, pool, pi) \
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700361 if (({ assert_rcu_or_pool_mutex(); false; })) { } \
Tejun Heofa1b54e2013-03-12 11:30:00 -0700362 else
Tejun Heo17116962013-03-12 11:29:58 -0700363
364/**
Tejun Heo822d8402013-03-19 13:45:21 -0700365 * for_each_pool_worker - iterate through all workers of a worker_pool
366 * @worker: iteration cursor
Tejun Heo822d8402013-03-19 13:45:21 -0700367 * @pool: worker_pool to iterate workers of
368 *
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800369 * This must be called with @pool->attach_mutex.
Tejun Heo822d8402013-03-19 13:45:21 -0700370 *
371 * The if/else clause exists only for the lockdep assertion and can be
372 * ignored.
373 */
Lai Jiangshanda028462014-05-20 17:46:31 +0800374#define for_each_pool_worker(worker, pool) \
375 list_for_each_entry((worker), &(pool)->workers, node) \
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +0800376 if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \
Tejun Heo822d8402013-03-19 13:45:21 -0700377 else
378
379/**
Tejun Heo49e3cf42013-03-12 11:29:58 -0700380 * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
381 * @pwq: iteration cursor
382 * @wq: the target workqueue
Tejun Heo76af4d92013-03-12 11:30:00 -0700383 *
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700384 * This must be called either with wq->mutex held or sched RCU read locked.
Tejun Heo794b18b2013-03-13 19:47:40 -0700385 * If the pwq needs to be used beyond the locking in effect, the caller is
386 * responsible for guaranteeing that the pwq stays online.
Tejun Heo76af4d92013-03-12 11:30:00 -0700387 *
388 * The if/else clause exists only for the lockdep assertion and can be
389 * ignored.
Tejun Heo49e3cf42013-03-12 11:29:58 -0700390 */
391#define for_each_pwq(pwq, wq) \
Tejun Heo76af4d92013-03-12 11:30:00 -0700392 list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -0700393 if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \
Tejun Heo76af4d92013-03-12 11:30:00 -0700394 else
Tejun Heof3421792010-07-02 10:03:51 +0200395
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900396#ifdef CONFIG_DEBUG_OBJECTS_WORK
397
398static struct debug_obj_descr work_debug_descr;
399
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100400static void *work_debug_hint(void *addr)
401{
402 return ((struct work_struct *) addr)->func;
403}
404
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900405/*
406 * fixup_init is called when:
407 * - an active object is initialized
408 */
409static int work_fixup_init(void *addr, enum debug_obj_state state)
410{
411 struct work_struct *work = addr;
412
413 switch (state) {
414 case ODEBUG_STATE_ACTIVE:
415 cancel_work_sync(work);
416 debug_object_init(work, &work_debug_descr);
417 return 1;
418 default:
419 return 0;
420 }
421}
422
423/*
424 * fixup_activate is called when:
425 * - an active object is activated
426 * - an unknown object is activated (might be a statically initialized object)
427 */
428static int work_fixup_activate(void *addr, enum debug_obj_state state)
429{
430 struct work_struct *work = addr;
431
432 switch (state) {
433
434 case ODEBUG_STATE_NOTAVAILABLE:
435 /*
436 * This is not really a fixup. The work struct was
437 * statically initialized. We just make sure that it
438 * is tracked in the object tracker.
439 */
Tejun Heo22df02b2010-06-29 10:07:10 +0200440 if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) {
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900441 debug_object_init(work, &work_debug_descr);
442 debug_object_activate(work, &work_debug_descr);
443 return 0;
444 }
445 WARN_ON_ONCE(1);
446 return 0;
447
448 case ODEBUG_STATE_ACTIVE:
449 WARN_ON(1);
450
451 default:
452 return 0;
453 }
454}
455
456/*
457 * fixup_free is called when:
458 * - an active object is freed
459 */
460static int work_fixup_free(void *addr, enum debug_obj_state state)
461{
462 struct work_struct *work = addr;
463
464 switch (state) {
465 case ODEBUG_STATE_ACTIVE:
466 cancel_work_sync(work);
467 debug_object_free(work, &work_debug_descr);
468 return 1;
469 default:
470 return 0;
471 }
472}
473
474static struct debug_obj_descr work_debug_descr = {
475 .name = "work_struct",
Stanislaw Gruszka99777282011-03-07 09:58:33 +0100476 .debug_hint = work_debug_hint,
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900477 .fixup_init = work_fixup_init,
478 .fixup_activate = work_fixup_activate,
479 .fixup_free = work_fixup_free,
480};
481
482static inline void debug_work_activate(struct work_struct *work)
483{
484 debug_object_activate(work, &work_debug_descr);
485}
486
487static inline void debug_work_deactivate(struct work_struct *work)
488{
489 debug_object_deactivate(work, &work_debug_descr);
490}
491
492void __init_work(struct work_struct *work, int onstack)
493{
494 if (onstack)
495 debug_object_init_on_stack(work, &work_debug_descr);
496 else
497 debug_object_init(work, &work_debug_descr);
498}
499EXPORT_SYMBOL_GPL(__init_work);
500
501void destroy_work_on_stack(struct work_struct *work)
502{
503 debug_object_free(work, &work_debug_descr);
504}
505EXPORT_SYMBOL_GPL(destroy_work_on_stack);
506
Thomas Gleixnerea2e64f2014-03-23 14:20:44 +0000507void destroy_delayed_work_on_stack(struct delayed_work *work)
508{
509 destroy_timer_on_stack(&work->timer);
510 debug_object_free(&work->work, &work_debug_descr);
511}
512EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
513
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900514#else
515static inline void debug_work_activate(struct work_struct *work) { }
516static inline void debug_work_deactivate(struct work_struct *work) { }
517#endif
518
Li Bin4e8b22b2013-09-10 09:52:35 +0800519/**
520 * worker_pool_assign_id - allocate ID and assing it to @pool
521 * @pool: the pool pointer of interest
522 *
523 * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
524 * successfully, -errno on failure.
525 */
Tejun Heo9daf9e62013-01-24 11:01:33 -0800526static int worker_pool_assign_id(struct worker_pool *pool)
527{
528 int ret;
529
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700530 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo5bcab332013-03-13 19:47:40 -0700531
Li Bin4e8b22b2013-09-10 09:52:35 +0800532 ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
533 GFP_KERNEL);
Tejun Heo229641a2013-04-01 17:08:13 -0700534 if (ret >= 0) {
Tejun Heoe68035f2013-03-13 14:59:38 -0700535 pool->id = ret;
Tejun Heo229641a2013-04-01 17:08:13 -0700536 return 0;
537 }
Tejun Heo9daf9e62013-01-24 11:01:33 -0800538 return ret;
539}
540
Tejun Heo76af4d92013-03-12 11:30:00 -0700541/**
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700542 * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
543 * @wq: the target workqueue
544 * @node: the node ID
545 *
546 * This must be called either with pwq_lock held or sched RCU read locked.
547 * If the pwq needs to be used beyond the locking in effect, the caller is
548 * responsible for guaranteeing that the pwq stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700549 *
550 * Return: The unbound pool_workqueue for @node.
Tejun Heodf2d5ae2013-04-01 11:23:35 -0700551 */
552static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
553 int node)
554{
555 assert_rcu_or_wq_mutex(wq);
556 return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
557}
558
Tejun Heo73f53c42010-06-29 10:07:11 +0200559static unsigned int work_color_to_flags(int color)
560{
561 return color << WORK_STRUCT_COLOR_SHIFT;
562}
563
564static int get_work_color(struct work_struct *work)
565{
566 return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
567 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
568}
569
570static int work_next_color(int color)
571{
572 return (color + 1) % WORK_NR_COLORS;
Oleg Nesterova848e3b2007-05-09 02:34:17 -0700573}
574
David Howells4594bf12006-12-07 11:33:26 +0000575/*
Tejun Heo112202d2013-02-13 19:29:12 -0800576 * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
577 * contain the pointer to the queued pwq. Once execution starts, the flag
Tejun Heo7c3eed52013-01-24 11:01:33 -0800578 * is cleared and the high bits contain OFFQ flags and pool ID.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200579 *
Tejun Heo112202d2013-02-13 19:29:12 -0800580 * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
581 * and clear_work_data() can be used to set the pwq, pool or clear
Tejun Heobbb68df2012-08-03 10:30:46 -0700582 * work->data. These functions should only be called while the work is
583 * owned - ie. while the PENDING bit is set.
Tejun Heo7a22ad72010-06-29 10:07:13 +0200584 *
Tejun Heo112202d2013-02-13 19:29:12 -0800585 * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
Tejun Heo7c3eed52013-01-24 11:01:33 -0800586 * corresponding to a work. Pool is available once the work has been
Tejun Heo112202d2013-02-13 19:29:12 -0800587 * queued anywhere after initialization until it is sync canceled. pwq is
Tejun Heo7c3eed52013-01-24 11:01:33 -0800588 * available only while the work item is queued.
Tejun Heobbb68df2012-08-03 10:30:46 -0700589 *
590 * %WORK_OFFQ_CANCELING is used to mark a work item which is being
591 * canceled. While being canceled, a work item may have its PENDING set
592 * but stay off timer and worklist for arbitrarily long and nobody should
593 * try to steal the PENDING bit.
David Howells4594bf12006-12-07 11:33:26 +0000594 */
Tejun Heo7a22ad72010-06-29 10:07:13 +0200595static inline void set_work_data(struct work_struct *work, unsigned long data,
596 unsigned long flags)
David Howells365970a2006-11-22 14:54:49 +0000597{
Tejun Heo6183c002013-03-12 11:29:57 -0700598 WARN_ON_ONCE(!work_pending(work));
Tejun Heo7a22ad72010-06-29 10:07:13 +0200599 atomic_long_set(&work->data, data | flags | work_static(work));
David Howells365970a2006-11-22 14:54:49 +0000600}
David Howells365970a2006-11-22 14:54:49 +0000601
Tejun Heo112202d2013-02-13 19:29:12 -0800602static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
Tejun Heo7a22ad72010-06-29 10:07:13 +0200603 unsigned long extra_flags)
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200604{
Tejun Heo112202d2013-02-13 19:29:12 -0800605 set_work_data(work, (unsigned long)pwq,
606 WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
Oleg Nesterov4d707b92010-04-23 17:40:40 +0200607}
608
Lai Jiangshan4468a002013-02-06 18:04:53 -0800609static void set_work_pool_and_keep_pending(struct work_struct *work,
610 int pool_id)
611{
612 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
613 WORK_STRUCT_PENDING);
614}
615
Tejun Heo7c3eed52013-01-24 11:01:33 -0800616static void set_work_pool_and_clear_pending(struct work_struct *work,
617 int pool_id)
David Howells365970a2006-11-22 14:54:49 +0000618{
Tejun Heo23657bb2012-08-13 17:08:19 -0700619 /*
620 * The following wmb is paired with the implied mb in
621 * test_and_set_bit(PENDING) and ensures all updates to @work made
622 * here are visible to and precede any updates by the next PENDING
623 * owner.
624 */
625 smp_wmb();
Tejun Heo7c3eed52013-01-24 11:01:33 -0800626 set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200627}
628
629static void clear_work_data(struct work_struct *work)
630{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800631 smp_wmb(); /* see set_work_pool_and_clear_pending() */
632 set_work_data(work, WORK_STRUCT_NO_POOL, 0);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200633}
634
Tejun Heo112202d2013-02-13 19:29:12 -0800635static struct pool_workqueue *get_work_pwq(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200636{
Tejun Heoe1201532010-07-22 14:14:25 +0200637 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7a22ad72010-06-29 10:07:13 +0200638
Tejun Heo112202d2013-02-13 19:29:12 -0800639 if (data & WORK_STRUCT_PWQ)
Tejun Heoe1201532010-07-22 14:14:25 +0200640 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
641 else
642 return NULL;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200643}
644
Tejun Heo7c3eed52013-01-24 11:01:33 -0800645/**
646 * get_work_pool - return the worker_pool a given work was associated with
647 * @work: the work item of interest
648 *
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700649 * Pools are created and destroyed under wq_pool_mutex, and allows read
650 * access under sched-RCU read lock. As such, this function should be
651 * called under wq_pool_mutex or with preemption disabled.
Tejun Heofa1b54e2013-03-12 11:30:00 -0700652 *
653 * All fields of the returned pool are accessible as long as the above
654 * mentioned locking is in effect. If the returned pool needs to be used
655 * beyond the critical section, the caller is responsible for ensuring the
656 * returned pool is and stays online.
Yacine Belkadid185af32013-07-31 14:59:24 -0700657 *
658 * Return: The worker_pool @work was last associated with. %NULL if none.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800659 */
660static struct worker_pool *get_work_pool(struct work_struct *work)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200661{
Tejun Heoe1201532010-07-22 14:14:25 +0200662 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800663 int pool_id;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200664
Lai Jiangshan68e13a62013-03-25 16:57:17 -0700665 assert_rcu_or_pool_mutex();
Tejun Heofa1b54e2013-03-12 11:30:00 -0700666
Tejun Heo112202d2013-02-13 19:29:12 -0800667 if (data & WORK_STRUCT_PWQ)
668 return ((struct pool_workqueue *)
Tejun Heo7c3eed52013-01-24 11:01:33 -0800669 (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
Tejun Heo7a22ad72010-06-29 10:07:13 +0200670
Tejun Heo7c3eed52013-01-24 11:01:33 -0800671 pool_id = data >> WORK_OFFQ_POOL_SHIFT;
672 if (pool_id == WORK_OFFQ_POOL_NONE)
Tejun Heo7a22ad72010-06-29 10:07:13 +0200673 return NULL;
674
Tejun Heofa1b54e2013-03-12 11:30:00 -0700675 return idr_find(&worker_pool_idr, pool_id);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800676}
677
678/**
679 * get_work_pool_id - return the worker pool ID a given work is associated with
680 * @work: the work item of interest
681 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700682 * Return: The worker_pool ID @work was last associated with.
Tejun Heo7c3eed52013-01-24 11:01:33 -0800683 * %WORK_OFFQ_POOL_NONE if none.
684 */
685static int get_work_pool_id(struct work_struct *work)
686{
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800687 unsigned long data = atomic_long_read(&work->data);
Tejun Heo7c3eed52013-01-24 11:01:33 -0800688
Tejun Heo112202d2013-02-13 19:29:12 -0800689 if (data & WORK_STRUCT_PWQ)
690 return ((struct pool_workqueue *)
Lai Jiangshan54d5b7d2013-02-07 13:14:20 -0800691 (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
692
693 return data >> WORK_OFFQ_POOL_SHIFT;
Tejun Heo7c3eed52013-01-24 11:01:33 -0800694}
695
Tejun Heobbb68df2012-08-03 10:30:46 -0700696static void mark_work_canceling(struct work_struct *work)
697{
Tejun Heo7c3eed52013-01-24 11:01:33 -0800698 unsigned long pool_id = get_work_pool_id(work);
Tejun Heobbb68df2012-08-03 10:30:46 -0700699
Tejun Heo7c3eed52013-01-24 11:01:33 -0800700 pool_id <<= WORK_OFFQ_POOL_SHIFT;
701 set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700702}
703
704static bool work_is_canceling(struct work_struct *work)
705{
706 unsigned long data = atomic_long_read(&work->data);
707
Tejun Heo112202d2013-02-13 19:29:12 -0800708 return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
Tejun Heobbb68df2012-08-03 10:30:46 -0700709}
710
David Howells365970a2006-11-22 14:54:49 +0000711/*
Tejun Heo32704762012-07-13 22:16:45 -0700712 * Policy functions. These define the policies on how the global worker
713 * pools are managed. Unless noted otherwise, these functions assume that
Tejun Heod565ed62013-01-24 11:01:33 -0800714 * they're being called with pool->lock held.
David Howells365970a2006-11-22 14:54:49 +0000715 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200716
Tejun Heo63d95a92012-07-12 14:46:37 -0700717static bool __need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000718{
Tejun Heoe19e3972013-01-24 11:39:44 -0800719 return !atomic_read(&pool->nr_running);
David Howells365970a2006-11-22 14:54:49 +0000720}
721
Tejun Heoe22bee72010-06-29 10:07:14 +0200722/*
723 * Need to wake up a worker? Called from anything but currently
724 * running workers.
Tejun Heo974271c2012-07-12 14:46:37 -0700725 *
726 * Note that, because unbound workers never contribute to nr_running, this
Tejun Heo706026c2013-01-24 11:01:34 -0800727 * function will always return %true for unbound pools as long as the
Tejun Heo974271c2012-07-12 14:46:37 -0700728 * worklist isn't empty.
Tejun Heoe22bee72010-06-29 10:07:14 +0200729 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700730static bool need_more_worker(struct worker_pool *pool)
David Howells365970a2006-11-22 14:54:49 +0000731{
Tejun Heo63d95a92012-07-12 14:46:37 -0700732 return !list_empty(&pool->worklist) && __need_more_worker(pool);
David Howells365970a2006-11-22 14:54:49 +0000733}
734
Tejun Heoe22bee72010-06-29 10:07:14 +0200735/* Can I start working? Called from busy but !running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700736static bool may_start_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200737{
Tejun Heo63d95a92012-07-12 14:46:37 -0700738 return pool->nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200739}
740
741/* Do I need to keep working? Called from currently running workers. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700742static bool keep_working(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200743{
Tejun Heoe19e3972013-01-24 11:39:44 -0800744 return !list_empty(&pool->worklist) &&
745 atomic_read(&pool->nr_running) <= 1;
Tejun Heoe22bee72010-06-29 10:07:14 +0200746}
747
748/* Do we need a new worker? Called from manager. */
Tejun Heo63d95a92012-07-12 14:46:37 -0700749static bool need_to_create_worker(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200750{
Tejun Heo63d95a92012-07-12 14:46:37 -0700751 return need_more_worker(pool) && !may_start_working(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200752}
753
Tejun Heoe22bee72010-06-29 10:07:14 +0200754/* Do we have too many workers and should some go away? */
Tejun Heo63d95a92012-07-12 14:46:37 -0700755static bool too_many_workers(struct worker_pool *pool)
Tejun Heoe22bee72010-06-29 10:07:14 +0200756{
Tejun Heo34a06bd2013-03-12 11:30:00 -0700757 bool managing = mutex_is_locked(&pool->manager_arb);
Tejun Heo63d95a92012-07-12 14:46:37 -0700758 int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
759 int nr_busy = pool->nr_workers - nr_idle;
Tejun Heoe22bee72010-06-29 10:07:14 +0200760
761 return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
762}
763
764/*
765 * Wake up functions.
766 */
767
Lai Jiangshan1037de32014-05-22 16:44:07 +0800768/* Return the first idle worker. Safe with preemption disabled */
769static struct worker *first_idle_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200770{
Tejun Heo63d95a92012-07-12 14:46:37 -0700771 if (unlikely(list_empty(&pool->idle_list)))
Tejun Heo7e116292010-06-29 10:07:13 +0200772 return NULL;
773
Tejun Heo63d95a92012-07-12 14:46:37 -0700774 return list_first_entry(&pool->idle_list, struct worker, entry);
Tejun Heo7e116292010-06-29 10:07:13 +0200775}
776
777/**
778 * wake_up_worker - wake up an idle worker
Tejun Heo63d95a92012-07-12 14:46:37 -0700779 * @pool: worker pool to wake worker from
Tejun Heo7e116292010-06-29 10:07:13 +0200780 *
Tejun Heo63d95a92012-07-12 14:46:37 -0700781 * Wake up the first idle worker of @pool.
Tejun Heo7e116292010-06-29 10:07:13 +0200782 *
783 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800784 * spin_lock_irq(pool->lock).
Tejun Heo7e116292010-06-29 10:07:13 +0200785 */
Tejun Heo63d95a92012-07-12 14:46:37 -0700786static void wake_up_worker(struct worker_pool *pool)
Tejun Heo7e116292010-06-29 10:07:13 +0200787{
Lai Jiangshan1037de32014-05-22 16:44:07 +0800788 struct worker *worker = first_idle_worker(pool);
Tejun Heo7e116292010-06-29 10:07:13 +0200789
790 if (likely(worker))
791 wake_up_process(worker->task);
792}
793
Tejun Heo4690c4a2010-06-29 10:07:10 +0200794/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200795 * wq_worker_waking_up - a worker is waking up
796 * @task: task waking up
797 * @cpu: CPU @task is waking up to
798 *
799 * This function is called during try_to_wake_up() when a worker is
800 * being awoken.
801 *
802 * CONTEXT:
803 * spin_lock_irq(rq->lock)
804 */
Tejun Heod84ff052013-03-12 11:29:59 -0700805void wq_worker_waking_up(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200806{
807 struct worker *worker = kthread_data(task);
808
Joonsoo Kim36576002012-10-26 23:03:49 +0900809 if (!(worker->flags & WORKER_NOT_RUNNING)) {
Tejun Heoec22ca52013-01-24 11:01:33 -0800810 WARN_ON_ONCE(worker->pool->cpu != cpu);
Tejun Heoe19e3972013-01-24 11:39:44 -0800811 atomic_inc(&worker->pool->nr_running);
Joonsoo Kim36576002012-10-26 23:03:49 +0900812 }
Tejun Heoe22bee72010-06-29 10:07:14 +0200813}
814
815/**
816 * wq_worker_sleeping - a worker is going to sleep
817 * @task: task going to sleep
818 * @cpu: CPU in question, must be the current CPU number
819 *
820 * This function is called during schedule() when a busy worker is
821 * going to sleep. Worker on the same cpu can be woken up by
822 * returning pointer to its task.
823 *
824 * CONTEXT:
825 * spin_lock_irq(rq->lock)
826 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700827 * Return:
Tejun Heoe22bee72010-06-29 10:07:14 +0200828 * Worker task on @cpu to wake up, %NULL if none.
829 */
Tejun Heod84ff052013-03-12 11:29:59 -0700830struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu)
Tejun Heoe22bee72010-06-29 10:07:14 +0200831{
832 struct worker *worker = kthread_data(task), *to_wakeup = NULL;
Tejun Heo111c2252013-01-17 17:16:24 -0800833 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200834
Tejun Heo111c2252013-01-17 17:16:24 -0800835 /*
836 * Rescuers, which may not have all the fields set up like normal
837 * workers, also reach here, let's not access anything before
838 * checking NOT_RUNNING.
839 */
Steven Rostedt2d646722010-12-03 23:12:33 -0500840 if (worker->flags & WORKER_NOT_RUNNING)
Tejun Heoe22bee72010-06-29 10:07:14 +0200841 return NULL;
842
Tejun Heo111c2252013-01-17 17:16:24 -0800843 pool = worker->pool;
Tejun Heo111c2252013-01-17 17:16:24 -0800844
Tejun Heoe22bee72010-06-29 10:07:14 +0200845 /* this can only happen on the local cpu */
Lai Jiangshan92b69f52014-06-03 15:33:08 +0800846 if (WARN_ON_ONCE(cpu != raw_smp_processor_id() || pool->cpu != cpu))
Tejun Heo6183c002013-03-12 11:29:57 -0700847 return NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +0200848
849 /*
850 * The counterpart of the following dec_and_test, implied mb,
851 * worklist not empty test sequence is in insert_work().
852 * Please read comment there.
853 *
Tejun Heo628c78e2012-07-17 12:39:27 -0700854 * NOT_RUNNING is clear. This means that we're bound to and
855 * running on the local cpu w/ rq lock held and preemption
856 * disabled, which in turn means that none else could be
Tejun Heod565ed62013-01-24 11:01:33 -0800857 * manipulating idle_list, so dereferencing idle_list without pool
Tejun Heo628c78e2012-07-17 12:39:27 -0700858 * lock is safe.
Tejun Heoe22bee72010-06-29 10:07:14 +0200859 */
Tejun Heoe19e3972013-01-24 11:39:44 -0800860 if (atomic_dec_and_test(&pool->nr_running) &&
861 !list_empty(&pool->worklist))
Lai Jiangshan1037de32014-05-22 16:44:07 +0800862 to_wakeup = first_idle_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +0200863 return to_wakeup ? to_wakeup->task : NULL;
864}
865
866/**
867 * worker_set_flags - set worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200868 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200869 * @flags: flags to set
Tejun Heod302f012010-06-29 10:07:13 +0200870 *
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800871 * Set @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200872 *
Tejun Heocb444762010-07-02 10:03:50 +0200873 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800874 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200875 */
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800876static inline void worker_set_flags(struct worker *worker, unsigned int flags)
Tejun Heod302f012010-06-29 10:07:13 +0200877{
Tejun Heobd7bdd42012-07-12 14:46:37 -0700878 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200879
Tejun Heocb444762010-07-02 10:03:50 +0200880 WARN_ON_ONCE(worker->task != current);
881
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800882 /* If transitioning into NOT_RUNNING, adjust nr_running. */
Tejun Heoe22bee72010-06-29 10:07:14 +0200883 if ((flags & WORKER_NOT_RUNNING) &&
884 !(worker->flags & WORKER_NOT_RUNNING)) {
Lai Jiangshan228f1d02014-07-22 13:02:00 +0800885 atomic_dec(&pool->nr_running);
Tejun Heoe22bee72010-06-29 10:07:14 +0200886 }
887
Tejun Heod302f012010-06-29 10:07:13 +0200888 worker->flags |= flags;
889}
890
891/**
Tejun Heoe22bee72010-06-29 10:07:14 +0200892 * worker_clr_flags - clear worker flags and adjust nr_running accordingly
Tejun Heocb444762010-07-02 10:03:50 +0200893 * @worker: self
Tejun Heod302f012010-06-29 10:07:13 +0200894 * @flags: flags to clear
895 *
Tejun Heoe22bee72010-06-29 10:07:14 +0200896 * Clear @flags in @worker->flags and adjust nr_running accordingly.
Tejun Heod302f012010-06-29 10:07:13 +0200897 *
Tejun Heocb444762010-07-02 10:03:50 +0200898 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800899 * spin_lock_irq(pool->lock)
Tejun Heod302f012010-06-29 10:07:13 +0200900 */
901static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
902{
Tejun Heo63d95a92012-07-12 14:46:37 -0700903 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +0200904 unsigned int oflags = worker->flags;
905
Tejun Heocb444762010-07-02 10:03:50 +0200906 WARN_ON_ONCE(worker->task != current);
907
Tejun Heod302f012010-06-29 10:07:13 +0200908 worker->flags &= ~flags;
Tejun Heoe22bee72010-06-29 10:07:14 +0200909
Tejun Heo42c025f2011-01-11 15:58:49 +0100910 /*
911 * If transitioning out of NOT_RUNNING, increment nr_running. Note
912 * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask
913 * of multiple flags, not a single flag.
914 */
Tejun Heoe22bee72010-06-29 10:07:14 +0200915 if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
916 if (!(worker->flags & WORKER_NOT_RUNNING))
Tejun Heoe19e3972013-01-24 11:39:44 -0800917 atomic_inc(&pool->nr_running);
Tejun Heod302f012010-06-29 10:07:13 +0200918}
919
920/**
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200921 * find_worker_executing_work - find worker which is executing a work
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800922 * @pool: pool of interest
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200923 * @work: work to find worker for
924 *
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800925 * Find a worker which is executing @work on @pool by searching
926 * @pool->busy_hash which is keyed by the address of @work. For a worker
Tejun Heoa2c1c572012-12-18 10:35:02 -0800927 * to match, its current execution should match the address of @work and
928 * its work function. This is to avoid unwanted dependency between
929 * unrelated work executions through a work item being recycled while still
930 * being executed.
931 *
932 * This is a bit tricky. A work item may be freed once its execution
933 * starts and nothing prevents the freed area from being recycled for
934 * another work item. If the same work item address ends up being reused
935 * before the original execution finishes, workqueue will identify the
936 * recycled work item as currently executing and make it wait until the
937 * current execution finishes, introducing an unwanted dependency.
938 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -0700939 * This function checks the work item address and work function to avoid
940 * false positives. Note that this isn't complete as one may construct a
941 * work function which can introduce dependency onto itself through a
942 * recycled work item. Well, if somebody wants to shoot oneself in the
943 * foot that badly, there's only so much we can do, and if such deadlock
944 * actually occurs, it should be easy to locate the culprit work function.
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200945 *
946 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800947 * spin_lock_irq(pool->lock).
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200948 *
Yacine Belkadid185af32013-07-31 14:59:24 -0700949 * Return:
950 * Pointer to worker which is executing @work if found, %NULL
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200951 * otherwise.
952 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -0800953static struct worker *find_worker_executing_work(struct worker_pool *pool,
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200954 struct work_struct *work)
955{
Sasha Levin42f85702012-12-17 10:01:23 -0500956 struct worker *worker;
Sasha Levin42f85702012-12-17 10:01:23 -0500957
Sasha Levinb67bfe02013-02-27 17:06:00 -0800958 hash_for_each_possible(pool->busy_hash, worker, hentry,
Tejun Heoa2c1c572012-12-18 10:35:02 -0800959 (unsigned long)work)
960 if (worker->current_work == work &&
961 worker->current_func == work->func)
Sasha Levin42f85702012-12-17 10:01:23 -0500962 return worker;
963
964 return NULL;
Tejun Heo8cca0ee2010-06-29 10:07:13 +0200965}
966
967/**
Tejun Heobf4ede02012-08-03 10:30:46 -0700968 * move_linked_works - move linked works to a list
969 * @work: start of series of works to be scheduled
970 * @head: target list to append @work to
971 * @nextp: out paramter for nested worklist walking
972 *
973 * Schedule linked works starting from @work to @head. Work series to
974 * be scheduled starts at @work and includes any consecutive work with
975 * WORK_STRUCT_LINKED set in its predecessor.
976 *
977 * If @nextp is not NULL, it's updated to point to the next work of
978 * the last scheduled work. This allows move_linked_works() to be
979 * nested inside outer list_for_each_entry_safe().
980 *
981 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -0800982 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -0700983 */
984static void move_linked_works(struct work_struct *work, struct list_head *head,
985 struct work_struct **nextp)
986{
987 struct work_struct *n;
988
989 /*
990 * Linked worklist will always end before the end of the list,
991 * use NULL for list head.
992 */
993 list_for_each_entry_safe_from(work, n, NULL, entry) {
994 list_move_tail(&work->entry, head);
995 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
996 break;
997 }
998
999 /*
1000 * If we're already inside safe list traversal and have moved
1001 * multiple works to the scheduled queue, the next position
1002 * needs to be updated.
1003 */
1004 if (nextp)
1005 *nextp = n;
1006}
1007
Tejun Heo8864b4e2013-03-12 11:30:04 -07001008/**
1009 * get_pwq - get an extra reference on the specified pool_workqueue
1010 * @pwq: pool_workqueue to get
1011 *
1012 * Obtain an extra reference on @pwq. The caller should guarantee that
1013 * @pwq has positive refcnt and be holding the matching pool->lock.
1014 */
1015static void get_pwq(struct pool_workqueue *pwq)
1016{
1017 lockdep_assert_held(&pwq->pool->lock);
1018 WARN_ON_ONCE(pwq->refcnt <= 0);
1019 pwq->refcnt++;
1020}
1021
1022/**
1023 * put_pwq - put a pool_workqueue reference
1024 * @pwq: pool_workqueue to put
1025 *
1026 * Drop a reference of @pwq. If its refcnt reaches zero, schedule its
1027 * destruction. The caller should be holding the matching pool->lock.
1028 */
1029static void put_pwq(struct pool_workqueue *pwq)
1030{
1031 lockdep_assert_held(&pwq->pool->lock);
1032 if (likely(--pwq->refcnt))
1033 return;
1034 if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1035 return;
1036 /*
1037 * @pwq can't be released under pool->lock, bounce to
1038 * pwq_unbound_release_workfn(). This never recurses on the same
1039 * pool->lock as this path is taken only for unbound workqueues and
1040 * the release work item is scheduled on a per-cpu workqueue. To
1041 * avoid lockdep warning, unbound pool->locks are given lockdep
1042 * subclass of 1 in get_unbound_pool().
1043 */
1044 schedule_work(&pwq->unbound_release_work);
1045}
1046
Tejun Heodce90d42013-04-01 11:23:35 -07001047/**
1048 * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1049 * @pwq: pool_workqueue to put (can be %NULL)
1050 *
1051 * put_pwq() with locking. This function also allows %NULL @pwq.
1052 */
1053static void put_pwq_unlocked(struct pool_workqueue *pwq)
1054{
1055 if (pwq) {
1056 /*
1057 * As both pwqs and pools are sched-RCU protected, the
1058 * following lock operations are safe.
1059 */
1060 spin_lock_irq(&pwq->pool->lock);
1061 put_pwq(pwq);
1062 spin_unlock_irq(&pwq->pool->lock);
1063 }
1064}
1065
Tejun Heo112202d2013-02-13 19:29:12 -08001066static void pwq_activate_delayed_work(struct work_struct *work)
Tejun Heobf4ede02012-08-03 10:30:46 -07001067{
Tejun Heo112202d2013-02-13 19:29:12 -08001068 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobf4ede02012-08-03 10:30:46 -07001069
1070 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001071 move_linked_works(work, &pwq->pool->worklist, NULL);
Tejun Heobf4ede02012-08-03 10:30:46 -07001072 __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
Tejun Heo112202d2013-02-13 19:29:12 -08001073 pwq->nr_active++;
Tejun Heobf4ede02012-08-03 10:30:46 -07001074}
1075
Tejun Heo112202d2013-02-13 19:29:12 -08001076static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001077{
Tejun Heo112202d2013-02-13 19:29:12 -08001078 struct work_struct *work = list_first_entry(&pwq->delayed_works,
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001079 struct work_struct, entry);
1080
Tejun Heo112202d2013-02-13 19:29:12 -08001081 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001082}
1083
Tejun Heobf4ede02012-08-03 10:30:46 -07001084/**
Tejun Heo112202d2013-02-13 19:29:12 -08001085 * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1086 * @pwq: pwq of interest
Tejun Heobf4ede02012-08-03 10:30:46 -07001087 * @color: color of work which left the queue
Tejun Heobf4ede02012-08-03 10:30:46 -07001088 *
1089 * A work either has completed or is removed from pending queue,
Tejun Heo112202d2013-02-13 19:29:12 -08001090 * decrement nr_in_flight of its pwq and handle workqueue flushing.
Tejun Heobf4ede02012-08-03 10:30:46 -07001091 *
1092 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001093 * spin_lock_irq(pool->lock).
Tejun Heobf4ede02012-08-03 10:30:46 -07001094 */
Tejun Heo112202d2013-02-13 19:29:12 -08001095static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
Tejun Heobf4ede02012-08-03 10:30:46 -07001096{
Tejun Heo8864b4e2013-03-12 11:30:04 -07001097 /* uncolored work items don't participate in flushing or nr_active */
Tejun Heobf4ede02012-08-03 10:30:46 -07001098 if (color == WORK_NO_COLOR)
Tejun Heo8864b4e2013-03-12 11:30:04 -07001099 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001100
Tejun Heo112202d2013-02-13 19:29:12 -08001101 pwq->nr_in_flight[color]--;
Tejun Heobf4ede02012-08-03 10:30:46 -07001102
Tejun Heo112202d2013-02-13 19:29:12 -08001103 pwq->nr_active--;
1104 if (!list_empty(&pwq->delayed_works)) {
Lai Jiangshanb3f9f402012-09-18 10:40:00 -07001105 /* one down, submit a delayed one */
Tejun Heo112202d2013-02-13 19:29:12 -08001106 if (pwq->nr_active < pwq->max_active)
1107 pwq_activate_first_delayed(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001108 }
1109
1110 /* is flush in progress and are we at the flushing tip? */
Tejun Heo112202d2013-02-13 19:29:12 -08001111 if (likely(pwq->flush_color != color))
Tejun Heo8864b4e2013-03-12 11:30:04 -07001112 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001113
1114 /* are there still in-flight works? */
Tejun Heo112202d2013-02-13 19:29:12 -08001115 if (pwq->nr_in_flight[color])
Tejun Heo8864b4e2013-03-12 11:30:04 -07001116 goto out_put;
Tejun Heobf4ede02012-08-03 10:30:46 -07001117
Tejun Heo112202d2013-02-13 19:29:12 -08001118 /* this pwq is done, clear flush_color */
1119 pwq->flush_color = -1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001120
1121 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001122 * If this was the last pwq, wake up the first flusher. It
Tejun Heobf4ede02012-08-03 10:30:46 -07001123 * will handle the rest.
1124 */
Tejun Heo112202d2013-02-13 19:29:12 -08001125 if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1126 complete(&pwq->wq->first_flusher->done);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001127out_put:
1128 put_pwq(pwq);
Tejun Heobf4ede02012-08-03 10:30:46 -07001129}
1130
Tejun Heo36e227d2012-08-03 10:30:46 -07001131/**
Tejun Heobbb68df2012-08-03 10:30:46 -07001132 * try_to_grab_pending - steal work item from worklist and disable irq
Tejun Heo36e227d2012-08-03 10:30:46 -07001133 * @work: work item to steal
1134 * @is_dwork: @work is a delayed_work
Tejun Heobbb68df2012-08-03 10:30:46 -07001135 * @flags: place to store irq state
Tejun Heo36e227d2012-08-03 10:30:46 -07001136 *
1137 * Try to grab PENDING bit of @work. This function can handle @work in any
Yacine Belkadid185af32013-07-31 14:59:24 -07001138 * stable state - idle, on timer or on worklist.
Tejun Heo36e227d2012-08-03 10:30:46 -07001139 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001140 * Return:
Tejun Heo36e227d2012-08-03 10:30:46 -07001141 * 1 if @work was pending and we successfully stole PENDING
1142 * 0 if @work was idle and we claimed PENDING
1143 * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry
Tejun Heobbb68df2012-08-03 10:30:46 -07001144 * -ENOENT if someone else is canceling @work, this state may persist
1145 * for arbitrarily long
Tejun Heo36e227d2012-08-03 10:30:46 -07001146 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001147 * Note:
Tejun Heobbb68df2012-08-03 10:30:46 -07001148 * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001149 * interrupted while holding PENDING and @work off queue, irq must be
1150 * disabled on entry. This, combined with delayed_work->timer being
1151 * irqsafe, ensures that we return -EAGAIN for finite short period of time.
Tejun Heobbb68df2012-08-03 10:30:46 -07001152 *
1153 * On successful return, >= 0, irq is disabled and the caller is
1154 * responsible for releasing it using local_irq_restore(*@flags).
1155 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001156 * This function is safe to call from any context including IRQ handler.
Tejun Heobf4ede02012-08-03 10:30:46 -07001157 */
Tejun Heobbb68df2012-08-03 10:30:46 -07001158static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1159 unsigned long *flags)
Tejun Heobf4ede02012-08-03 10:30:46 -07001160{
Tejun Heod565ed62013-01-24 11:01:33 -08001161 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001162 struct pool_workqueue *pwq;
Tejun Heobf4ede02012-08-03 10:30:46 -07001163
Tejun Heobbb68df2012-08-03 10:30:46 -07001164 local_irq_save(*flags);
1165
Tejun Heo36e227d2012-08-03 10:30:46 -07001166 /* try to steal the timer if it exists */
1167 if (is_dwork) {
1168 struct delayed_work *dwork = to_delayed_work(work);
1169
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001170 /*
1171 * dwork->timer is irqsafe. If del_timer() fails, it's
1172 * guaranteed that the timer is not queued anywhere and not
1173 * running on the local CPU.
1174 */
Tejun Heo36e227d2012-08-03 10:30:46 -07001175 if (likely(del_timer(&dwork->timer)))
1176 return 1;
1177 }
1178
1179 /* try to claim PENDING the normal way */
Tejun Heobf4ede02012-08-03 10:30:46 -07001180 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1181 return 0;
1182
1183 /*
1184 * The queueing is in progress, or it is already queued. Try to
1185 * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1186 */
Tejun Heod565ed62013-01-24 11:01:33 -08001187 pool = get_work_pool(work);
1188 if (!pool)
Tejun Heobbb68df2012-08-03 10:30:46 -07001189 goto fail;
Tejun Heobf4ede02012-08-03 10:30:46 -07001190
Tejun Heod565ed62013-01-24 11:01:33 -08001191 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001192 /*
Tejun Heo112202d2013-02-13 19:29:12 -08001193 * work->data is guaranteed to point to pwq only while the work
1194 * item is queued on pwq->wq, and both updating work->data to point
1195 * to pwq on queueing and to pool on dequeueing are done under
1196 * pwq->pool->lock. This in turn guarantees that, if work->data
1197 * points to pwq which is associated with a locked pool, the work
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08001198 * item is currently queued on that pool.
1199 */
Tejun Heo112202d2013-02-13 19:29:12 -08001200 pwq = get_work_pwq(work);
1201 if (pwq && pwq->pool == pool) {
Tejun Heo16062832013-02-06 18:04:53 -08001202 debug_work_deactivate(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001203
Tejun Heo16062832013-02-06 18:04:53 -08001204 /*
1205 * A delayed work item cannot be grabbed directly because
1206 * it might have linked NO_COLOR work items which, if left
Tejun Heo112202d2013-02-13 19:29:12 -08001207 * on the delayed_list, will confuse pwq->nr_active
Tejun Heo16062832013-02-06 18:04:53 -08001208 * management later on and cause stall. Make sure the work
1209 * item is activated before grabbing.
1210 */
1211 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
Tejun Heo112202d2013-02-13 19:29:12 -08001212 pwq_activate_delayed_work(work);
Lai Jiangshan3aa62492012-09-18 10:40:00 -07001213
Tejun Heo16062832013-02-06 18:04:53 -08001214 list_del_init(&work->entry);
Lai Jiangshan9c34a702014-07-11 00:11:13 +08001215 pwq_dec_nr_in_flight(pwq, get_work_color(work));
Tejun Heo36e227d2012-08-03 10:30:46 -07001216
Tejun Heo112202d2013-02-13 19:29:12 -08001217 /* work->data points to pwq iff queued, point to pool */
Tejun Heo16062832013-02-06 18:04:53 -08001218 set_work_pool_and_keep_pending(work, pool->id);
Lai Jiangshan4468a002013-02-06 18:04:53 -08001219
Tejun Heo16062832013-02-06 18:04:53 -08001220 spin_unlock(&pool->lock);
1221 return 1;
Tejun Heobf4ede02012-08-03 10:30:46 -07001222 }
Tejun Heod565ed62013-01-24 11:01:33 -08001223 spin_unlock(&pool->lock);
Tejun Heobbb68df2012-08-03 10:30:46 -07001224fail:
1225 local_irq_restore(*flags);
1226 if (work_is_canceling(work))
1227 return -ENOENT;
1228 cpu_relax();
Tejun Heo36e227d2012-08-03 10:30:46 -07001229 return -EAGAIN;
Tejun Heobf4ede02012-08-03 10:30:46 -07001230}
1231
1232/**
Tejun Heo706026c2013-01-24 11:01:34 -08001233 * insert_work - insert a work into a pool
Tejun Heo112202d2013-02-13 19:29:12 -08001234 * @pwq: pwq @work belongs to
Tejun Heo4690c4a2010-06-29 10:07:10 +02001235 * @work: work to insert
1236 * @head: insertion point
1237 * @extra_flags: extra WORK_STRUCT_* flags to set
1238 *
Tejun Heo112202d2013-02-13 19:29:12 -08001239 * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to
Tejun Heo706026c2013-01-24 11:01:34 -08001240 * work_struct flags.
Tejun Heo4690c4a2010-06-29 10:07:10 +02001241 *
1242 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001243 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02001244 */
Tejun Heo112202d2013-02-13 19:29:12 -08001245static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1246 struct list_head *head, unsigned int extra_flags)
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001247{
Tejun Heo112202d2013-02-13 19:29:12 -08001248 struct worker_pool *pool = pwq->pool;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01001249
Tejun Heo4690c4a2010-06-29 10:07:10 +02001250 /* we own @work, set data and link */
Tejun Heo112202d2013-02-13 19:29:12 -08001251 set_work_pwq(work, pwq, extra_flags);
Oleg Nesterov1a4d9b02008-07-25 01:47:47 -07001252 list_add_tail(&work->entry, head);
Tejun Heo8864b4e2013-03-12 11:30:04 -07001253 get_pwq(pwq);
Tejun Heoe22bee72010-06-29 10:07:14 +02001254
1255 /*
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001256 * Ensure either wq_worker_sleeping() sees the above
1257 * list_add_tail() or we see zero nr_running to avoid workers lying
1258 * around lazily while there are works to be processed.
Tejun Heoe22bee72010-06-29 10:07:14 +02001259 */
1260 smp_mb();
1261
Tejun Heo63d95a92012-07-12 14:46:37 -07001262 if (__need_more_worker(pool))
1263 wake_up_worker(pool);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07001264}
1265
Tejun Heoc8efcc22010-12-20 19:32:04 +01001266/*
1267 * Test whether @work is being queued from another work executing on the
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001268 * same workqueue.
Tejun Heoc8efcc22010-12-20 19:32:04 +01001269 */
1270static bool is_chained_work(struct workqueue_struct *wq)
1271{
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001272 struct worker *worker;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001273
Tejun Heo8d03ecf2013-02-13 19:29:10 -08001274 worker = current_wq_worker();
1275 /*
1276 * Return %true iff I'm a worker execuing a work item on @wq. If
1277 * I'm @worker, it's safe to dereference it without locking.
1278 */
Tejun Heo112202d2013-02-13 19:29:12 -08001279 return worker && worker->current_pwq->wq == wq;
Tejun Heoc8efcc22010-12-20 19:32:04 +01001280}
1281
Tejun Heod84ff052013-03-12 11:29:59 -07001282static void __queue_work(int cpu, struct workqueue_struct *wq,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 struct work_struct *work)
1284{
Tejun Heo112202d2013-02-13 19:29:12 -08001285 struct pool_workqueue *pwq;
Tejun Heoc9178082013-03-12 11:30:04 -07001286 struct worker_pool *last_pool;
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001287 struct list_head *worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001288 unsigned int work_flags;
Joonsoo Kimb75cac92012-08-15 23:25:37 +09001289 unsigned int req_cpu = cpu;
Tejun Heo8930cab2012-08-03 10:30:45 -07001290
1291 /*
1292 * While a work item is PENDING && off queue, a task trying to
1293 * steal the PENDING will busy-loop waiting for it to either get
1294 * queued or lose PENDING. Grabbing PENDING and queueing should
1295 * happen with IRQ disabled.
1296 */
1297 WARN_ON_ONCE(!irqs_disabled());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09001299 debug_work_activate(work);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001300
Li Bin9ef28a72013-09-09 13:13:58 +08001301 /* if draining, only works from the same workqueue are allowed */
Tejun Heo618b01e2013-03-12 11:30:04 -07001302 if (unlikely(wq->flags & __WQ_DRAINING) &&
Tejun Heoc8efcc22010-12-20 19:32:04 +01001303 WARN_ON_ONCE(!is_chained_work(wq)))
Tejun Heoe41e7042010-08-24 14:22:47 +02001304 return;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001305retry:
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001306 if (req_cpu == WORK_CPU_UNBOUND)
1307 cpu = raw_smp_processor_id();
1308
Tejun Heoc9178082013-03-12 11:30:04 -07001309 /* pwq which will be used unless @work is executing elsewhere */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001310 if (!(wq->flags & WQ_UNBOUND))
Tejun Heo7fb98ea2013-03-12 11:30:00 -07001311 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001312 else
1313 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodbf25762012-08-20 14:51:23 -07001314
Tejun Heoc9178082013-03-12 11:30:04 -07001315 /*
1316 * If @work was previously on a different pool, it might still be
1317 * running there, in which case the work needs to be queued on that
1318 * pool to guarantee non-reentrancy.
1319 */
1320 last_pool = get_work_pool(work);
1321 if (last_pool && last_pool != pwq->pool) {
1322 struct worker *worker;
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001323
Tejun Heoc9178082013-03-12 11:30:04 -07001324 spin_lock(&last_pool->lock);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001325
Tejun Heoc9178082013-03-12 11:30:04 -07001326 worker = find_worker_executing_work(last_pool, work);
Tejun Heo18aa9ef2010-06-29 10:07:13 +02001327
Tejun Heoc9178082013-03-12 11:30:04 -07001328 if (worker && worker->current_pwq->wq == wq) {
1329 pwq = worker->current_pwq;
Tejun Heo8930cab2012-08-03 10:30:45 -07001330 } else {
Tejun Heoc9178082013-03-12 11:30:04 -07001331 /* meh... not running there, queue here */
1332 spin_unlock(&last_pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08001333 spin_lock(&pwq->pool->lock);
Tejun Heo8930cab2012-08-03 10:30:45 -07001334 }
Tejun Heof3421792010-07-02 10:03:51 +02001335 } else {
Tejun Heo112202d2013-02-13 19:29:12 -08001336 spin_lock(&pwq->pool->lock);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001337 }
1338
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001339 /*
1340 * pwq is determined and locked. For unbound pools, we could have
1341 * raced with pwq release and it could already be dead. If its
1342 * refcnt is zero, repeat pwq selection. Note that pwqs never die
Tejun Heodf2d5ae2013-04-01 11:23:35 -07001343 * without another pwq replacing it in the numa_pwq_tbl or while
1344 * work items are executing on it, so the retrying is guaranteed to
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07001345 * make forward-progress.
1346 */
1347 if (unlikely(!pwq->refcnt)) {
1348 if (wq->flags & WQ_UNBOUND) {
1349 spin_unlock(&pwq->pool->lock);
1350 cpu_relax();
1351 goto retry;
1352 }
1353 /* oops */
1354 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1355 wq->name, cpu);
1356 }
1357
Tejun Heo112202d2013-02-13 19:29:12 -08001358 /* pwq determined, queue */
1359 trace_workqueue_queue_work(req_cpu, pwq, work);
Tejun Heo502ca9d2010-06-29 10:07:13 +02001360
Dan Carpenterf5b25522012-04-13 22:06:58 +03001361 if (WARN_ON(!list_empty(&work->entry))) {
Tejun Heo112202d2013-02-13 19:29:12 -08001362 spin_unlock(&pwq->pool->lock);
Dan Carpenterf5b25522012-04-13 22:06:58 +03001363 return;
1364 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001365
Tejun Heo112202d2013-02-13 19:29:12 -08001366 pwq->nr_in_flight[pwq->work_color]++;
1367 work_flags = work_color_to_flags(pwq->work_color);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001368
Tejun Heo112202d2013-02-13 19:29:12 -08001369 if (likely(pwq->nr_active < pwq->max_active)) {
Tejun Heocdadf002010-10-05 10:49:55 +02001370 trace_workqueue_activate_work(work);
Tejun Heo112202d2013-02-13 19:29:12 -08001371 pwq->nr_active++;
1372 worklist = &pwq->pool->worklist;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001373 } else {
1374 work_flags |= WORK_STRUCT_DELAYED;
Tejun Heo112202d2013-02-13 19:29:12 -08001375 worklist = &pwq->delayed_works;
Tejun Heo8a2e8e5d2010-08-25 10:33:56 +02001376 }
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001377
Tejun Heo112202d2013-02-13 19:29:12 -08001378 insert_work(pwq, work, worklist, work_flags);
Tejun Heo1e19ffc2010-06-29 10:07:12 +02001379
Tejun Heo112202d2013-02-13 19:29:12 -08001380 spin_unlock(&pwq->pool->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381}
1382
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001383/**
Zhang Ruic1a220e2008-07-23 21:28:39 -07001384 * queue_work_on - queue work on specific cpu
1385 * @cpu: CPU number to execute work on
1386 * @wq: workqueue to use
1387 * @work: work to queue
1388 *
Zhang Ruic1a220e2008-07-23 21:28:39 -07001389 * We queue the work to a specific CPU, the caller must ensure it
1390 * can't go away.
Yacine Belkadid185af32013-07-31 14:59:24 -07001391 *
1392 * Return: %false if @work was already on a queue, %true otherwise.
Zhang Ruic1a220e2008-07-23 21:28:39 -07001393 */
Tejun Heod4283e92012-08-03 10:30:44 -07001394bool queue_work_on(int cpu, struct workqueue_struct *wq,
1395 struct work_struct *work)
Zhang Ruic1a220e2008-07-23 21:28:39 -07001396{
Tejun Heod4283e92012-08-03 10:30:44 -07001397 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001398 unsigned long flags;
1399
1400 local_irq_save(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001401
Tejun Heo22df02b2010-06-29 10:07:10 +02001402 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo4690c4a2010-06-29 10:07:10 +02001403 __queue_work(cpu, wq, work);
Tejun Heod4283e92012-08-03 10:30:44 -07001404 ret = true;
Zhang Ruic1a220e2008-07-23 21:28:39 -07001405 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001406
1407 local_irq_restore(flags);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001408 return ret;
1409}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001410EXPORT_SYMBOL(queue_work_on);
Zhang Ruic1a220e2008-07-23 21:28:39 -07001411
Tejun Heod8e794d2012-08-03 10:30:45 -07001412void delayed_work_timer_fn(unsigned long __data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413{
David Howells52bad642006-11-22 14:54:01 +00001414 struct delayed_work *dwork = (struct delayed_work *)__data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001416 /* should have been called from irqsafe timer with irq already off */
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001417 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418}
Konstantin Khlebnikov1438ade52013-01-24 16:36:31 +04001419EXPORT_SYMBOL(delayed_work_timer_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001421static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1422 struct delayed_work *dwork, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423{
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001424 struct timer_list *timer = &dwork->timer;
1425 struct work_struct *work = &dwork->work;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001427 WARN_ON_ONCE(timer->function != delayed_work_timer_fn ||
1428 timer->data != (unsigned long)dwork);
Tejun Heofc4b5142012-12-04 07:40:39 -08001429 WARN_ON_ONCE(timer_pending(timer));
1430 WARN_ON_ONCE(!list_empty(&work->entry));
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001431
Tejun Heo8852aac2012-12-01 16:23:42 -08001432 /*
1433 * If @delay is 0, queue @dwork->work immediately. This is for
1434 * both optimization and correctness. The earliest @timer can
1435 * expire is on the closest next tick and delayed_work users depend
1436 * on that there's no such delay when @delay is 0.
1437 */
1438 if (!delay) {
1439 __queue_work(cpu, wq, &dwork->work);
1440 return;
1441 }
1442
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001443 timer_stats_timer_set_start_info(&dwork->timer);
1444
Lai Jiangshan60c057b2013-02-06 18:04:53 -08001445 dwork->wq = wq;
Tejun Heo12650572012-08-08 09:38:42 -07001446 dwork->cpu = cpu;
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001447 timer->expires = jiffies + delay;
1448
1449 if (unlikely(cpu != WORK_CPU_UNBOUND))
1450 add_timer_on(timer, cpu);
1451 else
1452 add_timer(timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453}
1454
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001455/**
1456 * queue_delayed_work_on - queue work on specific CPU after delay
1457 * @cpu: CPU number to execute work on
1458 * @wq: workqueue to use
Randy Dunlapaf9997e2006-12-22 01:06:52 -08001459 * @dwork: work to queue
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001460 * @delay: number of jiffies to wait before queueing
1461 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001462 * Return: %false if @work was already on a queue, %true otherwise. If
Tejun Heo715f1302012-08-03 10:30:46 -07001463 * @delay is zero and @dwork is idle, it will be scheduled for immediate
1464 * execution.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07001465 */
Tejun Heod4283e92012-08-03 10:30:44 -07001466bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1467 struct delayed_work *dwork, unsigned long delay)
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001468{
David Howells52bad642006-11-22 14:54:01 +00001469 struct work_struct *work = &dwork->work;
Tejun Heod4283e92012-08-03 10:30:44 -07001470 bool ret = false;
Tejun Heo8930cab2012-08-03 10:30:45 -07001471 unsigned long flags;
1472
1473 /* read the comment in __queue_work() */
1474 local_irq_save(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001475
Tejun Heo22df02b2010-06-29 10:07:10 +02001476 if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
Tejun Heo7beb2ed2012-08-03 10:30:46 -07001477 __queue_delayed_work(cpu, wq, dwork, delay);
Tejun Heod4283e92012-08-03 10:30:44 -07001478 ret = true;
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001479 }
Tejun Heo8930cab2012-08-03 10:30:45 -07001480
1481 local_irq_restore(flags);
Venkatesh Pallipadi7a6bc1c2006-06-28 13:50:33 -07001482 return ret;
1483}
Marc Dionnead7b1f82013-05-06 17:44:55 -04001484EXPORT_SYMBOL(queue_delayed_work_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485
Tejun Heoc8e55f32010-06-29 10:07:12 +02001486/**
Tejun Heo8376fe22012-08-03 10:30:47 -07001487 * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1488 * @cpu: CPU number to execute work on
1489 * @wq: workqueue to use
1490 * @dwork: work to queue
1491 * @delay: number of jiffies to wait before queueing
1492 *
1493 * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1494 * modify @dwork's timer so that it expires after @delay. If @delay is
1495 * zero, @work is guaranteed to be scheduled immediately regardless of its
1496 * current state.
1497 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001498 * Return: %false if @dwork was idle and queued, %true if @dwork was
Tejun Heo8376fe22012-08-03 10:30:47 -07001499 * pending and its timer was modified.
1500 *
Tejun Heoe0aecdd2012-08-21 13:18:24 -07001501 * This function is safe to call from any context including IRQ handler.
Tejun Heo8376fe22012-08-03 10:30:47 -07001502 * See try_to_grab_pending() for details.
1503 */
1504bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1505 struct delayed_work *dwork, unsigned long delay)
1506{
1507 unsigned long flags;
1508 int ret;
1509
1510 do {
1511 ret = try_to_grab_pending(&dwork->work, true, &flags);
1512 } while (unlikely(ret == -EAGAIN));
1513
1514 if (likely(ret >= 0)) {
1515 __queue_delayed_work(cpu, wq, dwork, delay);
1516 local_irq_restore(flags);
1517 }
1518
1519 /* -ENOENT from try_to_grab_pending() becomes %true */
1520 return ret;
1521}
1522EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1523
1524/**
Tejun Heoc8e55f32010-06-29 10:07:12 +02001525 * worker_enter_idle - enter idle state
1526 * @worker: worker which is entering idle state
1527 *
1528 * @worker is entering idle state. Update stats and idle timer if
1529 * necessary.
1530 *
1531 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001532 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001533 */
1534static void worker_enter_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001536 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537
Tejun Heo6183c002013-03-12 11:29:57 -07001538 if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1539 WARN_ON_ONCE(!list_empty(&worker->entry) &&
1540 (worker->hentry.next || worker->hentry.pprev)))
1541 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
Lai Jiangshan051e1852014-07-22 13:03:02 +08001543 /* can't use worker_set_flags(), also called from create_worker() */
Tejun Heocb444762010-07-02 10:03:50 +02001544 worker->flags |= WORKER_IDLE;
Tejun Heobd7bdd42012-07-12 14:46:37 -07001545 pool->nr_idle++;
Tejun Heoe22bee72010-06-29 10:07:14 +02001546 worker->last_active = jiffies;
Peter Zijlstrad5abe662006-12-06 20:37:26 -08001547
Tejun Heoc8e55f32010-06-29 10:07:12 +02001548 /* idle_list is LIFO */
Tejun Heobd7bdd42012-07-12 14:46:37 -07001549 list_add(&worker->entry, &pool->idle_list);
Tejun Heodb7bccf2010-06-29 10:07:12 +02001550
Tejun Heo628c78e2012-07-17 12:39:27 -07001551 if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1552 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
Tejun Heocb444762010-07-02 10:03:50 +02001553
Tejun Heo544ecf32012-05-14 15:04:50 -07001554 /*
Tejun Heo706026c2013-01-24 11:01:34 -08001555 * Sanity check nr_running. Because wq_unbind_fn() releases
Tejun Heod565ed62013-01-24 11:01:33 -08001556 * pool->lock between setting %WORKER_UNBOUND and zapping
Tejun Heo628c78e2012-07-17 12:39:27 -07001557 * nr_running, the warning may trigger spuriously. Check iff
1558 * unbind is not in progress.
Tejun Heo544ecf32012-05-14 15:04:50 -07001559 */
Tejun Heo24647572013-01-24 11:01:33 -08001560 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heobd7bdd42012-07-12 14:46:37 -07001561 pool->nr_workers == pool->nr_idle &&
Tejun Heoe19e3972013-01-24 11:39:44 -08001562 atomic_read(&pool->nr_running));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563}
1564
Tejun Heoc8e55f32010-06-29 10:07:12 +02001565/**
1566 * worker_leave_idle - leave idle state
1567 * @worker: worker which is leaving idle state
1568 *
1569 * @worker is leaving idle state. Update stats.
1570 *
1571 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001572 * spin_lock_irq(pool->lock).
Tejun Heoc8e55f32010-06-29 10:07:12 +02001573 */
1574static void worker_leave_idle(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001576 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577
Tejun Heo6183c002013-03-12 11:29:57 -07001578 if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1579 return;
Tejun Heod302f012010-06-29 10:07:13 +02001580 worker_clr_flags(worker, WORKER_IDLE);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001581 pool->nr_idle--;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001582 list_del_init(&worker->entry);
1583}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001585static struct worker *alloc_worker(int node)
Tejun Heoc34056a2010-06-29 10:07:11 +02001586{
1587 struct worker *worker;
1588
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001589 worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
Tejun Heoc8e55f32010-06-29 10:07:12 +02001590 if (worker) {
1591 INIT_LIST_HEAD(&worker->entry);
Tejun Heoaffee4b2010-06-29 10:07:12 +02001592 INIT_LIST_HEAD(&worker->scheduled);
Lai Jiangshanda028462014-05-20 17:46:31 +08001593 INIT_LIST_HEAD(&worker->node);
Tejun Heoe22bee72010-06-29 10:07:14 +02001594 /* on creation a worker is in !idle && prep state */
1595 worker->flags = WORKER_PREP;
Tejun Heoc8e55f32010-06-29 10:07:12 +02001596 }
Tejun Heoc34056a2010-06-29 10:07:11 +02001597 return worker;
1598}
1599
1600/**
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001601 * worker_attach_to_pool() - attach a worker to a pool
1602 * @worker: worker to be attached
1603 * @pool: the target pool
1604 *
1605 * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and
1606 * cpu-binding of @worker are kept coordinated with the pool across
1607 * cpu-[un]hotplugs.
1608 */
1609static void worker_attach_to_pool(struct worker *worker,
1610 struct worker_pool *pool)
1611{
1612 mutex_lock(&pool->attach_mutex);
1613
1614 /*
1615 * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1616 * online CPUs. It'll be re-applied when any of the CPUs come up.
1617 */
1618 set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1619
1620 /*
1621 * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains
1622 * stable across this function. See the comments above the
1623 * flag definition for details.
1624 */
1625 if (pool->flags & POOL_DISASSOCIATED)
1626 worker->flags |= WORKER_UNBOUND;
1627
1628 list_add_tail(&worker->node, &pool->workers);
1629
1630 mutex_unlock(&pool->attach_mutex);
1631}
1632
1633/**
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001634 * worker_detach_from_pool() - detach a worker from its pool
1635 * @worker: worker which is attached to its pool
1636 * @pool: the pool @worker is attached to
1637 *
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001638 * Undo the attaching which had been done in worker_attach_to_pool(). The
1639 * caller worker shouldn't access to the pool after detached except it has
1640 * other reference to the pool.
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001641 */
1642static void worker_detach_from_pool(struct worker *worker,
1643 struct worker_pool *pool)
1644{
1645 struct completion *detach_completion = NULL;
1646
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001647 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08001648 list_del(&worker->node);
1649 if (list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001650 detach_completion = pool->detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08001651 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001652
Lai Jiangshanb62c0752014-06-03 15:32:52 +08001653 /* clear leftover flags without pool->lock after it is detached */
1654 worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1655
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001656 if (detach_completion)
1657 complete(detach_completion);
1658}
1659
1660/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001661 * create_worker - create a new workqueue worker
Tejun Heo63d95a92012-07-12 14:46:37 -07001662 * @pool: pool the new worker will belong to
Tejun Heoc34056a2010-06-29 10:07:11 +02001663 *
Lai Jiangshan051e1852014-07-22 13:03:02 +08001664 * Create and start a new worker which is attached to @pool.
Tejun Heoc34056a2010-06-29 10:07:11 +02001665 *
1666 * CONTEXT:
1667 * Might sleep. Does GFP_KERNEL allocations.
1668 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001669 * Return:
Tejun Heoc34056a2010-06-29 10:07:11 +02001670 * Pointer to the newly created worker.
1671 */
Tejun Heobc2ae0f2012-07-17 12:39:27 -07001672static struct worker *create_worker(struct worker_pool *pool)
Tejun Heoc34056a2010-06-29 10:07:11 +02001673{
Tejun Heoc34056a2010-06-29 10:07:11 +02001674 struct worker *worker = NULL;
Tejun Heof3421792010-07-02 10:03:51 +02001675 int id = -1;
Tejun Heoe3c916a2013-04-01 11:23:32 -07001676 char id_buf[16];
Tejun Heoc34056a2010-06-29 10:07:11 +02001677
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001678 /* ID is needed to determine kthread name */
1679 id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
Tejun Heo822d8402013-03-19 13:45:21 -07001680 if (id < 0)
1681 goto fail;
Tejun Heoc34056a2010-06-29 10:07:11 +02001682
Lai Jiangshanf7537df2014-07-15 17:24:15 +08001683 worker = alloc_worker(pool->node);
Tejun Heoc34056a2010-06-29 10:07:11 +02001684 if (!worker)
1685 goto fail;
1686
Tejun Heobd7bdd42012-07-12 14:46:37 -07001687 worker->pool = pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001688 worker->id = id;
1689
Tejun Heo29c91e92013-03-12 11:30:03 -07001690 if (pool->cpu >= 0)
Tejun Heoe3c916a2013-04-01 11:23:32 -07001691 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1692 pool->attrs->nice < 0 ? "H" : "");
Tejun Heof3421792010-07-02 10:03:51 +02001693 else
Tejun Heoe3c916a2013-04-01 11:23:32 -07001694 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1695
Tejun Heof3f90ad2013-04-01 11:23:34 -07001696 worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
Tejun Heoe3c916a2013-04-01 11:23:32 -07001697 "kworker/%s", id_buf);
Tejun Heoc34056a2010-06-29 10:07:11 +02001698 if (IS_ERR(worker->task))
1699 goto fail;
1700
Oleg Nesterov91151222013-11-14 12:56:18 +01001701 set_user_nice(worker->task, pool->attrs->nice);
1702
1703 /* prevent userland from meddling with cpumask of workqueue workers */
1704 worker->task->flags |= PF_NO_SETAFFINITY;
1705
Lai Jiangshanda028462014-05-20 17:46:31 +08001706 /* successful, attach the worker to the pool */
Lai Jiangshan4736cbf2014-05-20 17:46:35 +08001707 worker_attach_to_pool(worker, pool);
Tejun Heo822d8402013-03-19 13:45:21 -07001708
Lai Jiangshan051e1852014-07-22 13:03:02 +08001709 /* start the newly created worker */
1710 spin_lock_irq(&pool->lock);
1711 worker->pool->nr_workers++;
1712 worker_enter_idle(worker);
1713 wake_up_process(worker->task);
1714 spin_unlock_irq(&pool->lock);
1715
Tejun Heoc34056a2010-06-29 10:07:11 +02001716 return worker;
Tejun Heo822d8402013-03-19 13:45:21 -07001717
Tejun Heoc34056a2010-06-29 10:07:11 +02001718fail:
Lai Jiangshan9625ab12014-05-20 17:46:27 +08001719 if (id >= 0)
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08001720 ida_simple_remove(&pool->worker_ida, id);
Tejun Heoc34056a2010-06-29 10:07:11 +02001721 kfree(worker);
1722 return NULL;
1723}
1724
1725/**
Tejun Heoc34056a2010-06-29 10:07:11 +02001726 * destroy_worker - destroy a workqueue worker
1727 * @worker: worker to be destroyed
1728 *
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001729 * Destroy @worker and adjust @pool stats accordingly. The worker should
1730 * be idle.
Tejun Heoc8e55f32010-06-29 10:07:12 +02001731 *
1732 * CONTEXT:
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001733 * spin_lock_irq(pool->lock).
Tejun Heoc34056a2010-06-29 10:07:11 +02001734 */
1735static void destroy_worker(struct worker *worker)
1736{
Tejun Heobd7bdd42012-07-12 14:46:37 -07001737 struct worker_pool *pool = worker->pool;
Tejun Heoc34056a2010-06-29 10:07:11 +02001738
Tejun Heocd549682013-03-13 19:47:39 -07001739 lockdep_assert_held(&pool->lock);
1740
Tejun Heoc34056a2010-06-29 10:07:11 +02001741 /* sanity check frenzy */
Tejun Heo6183c002013-03-12 11:29:57 -07001742 if (WARN_ON(worker->current_work) ||
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001743 WARN_ON(!list_empty(&worker->scheduled)) ||
1744 WARN_ON(!(worker->flags & WORKER_IDLE)))
Tejun Heo6183c002013-03-12 11:29:57 -07001745 return;
Tejun Heoc34056a2010-06-29 10:07:11 +02001746
Lai Jiangshan73eb7fe2014-05-20 17:46:28 +08001747 pool->nr_workers--;
1748 pool->nr_idle--;
Lai Jiangshan5bdfff92014-02-15 22:02:28 +08001749
Tejun Heoc8e55f32010-06-29 10:07:12 +02001750 list_del_init(&worker->entry);
Tejun Heocb444762010-07-02 10:03:50 +02001751 worker->flags |= WORKER_DIE;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08001752 wake_up_process(worker->task);
Tejun Heoc34056a2010-06-29 10:07:11 +02001753}
1754
Tejun Heo63d95a92012-07-12 14:46:37 -07001755static void idle_worker_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001756{
Tejun Heo63d95a92012-07-12 14:46:37 -07001757 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001758
Tejun Heod565ed62013-01-24 11:01:33 -08001759 spin_lock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001760
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001761 while (too_many_workers(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001762 struct worker *worker;
1763 unsigned long expires;
1764
1765 /* idle_list is kept in LIFO order, check the last one */
Tejun Heo63d95a92012-07-12 14:46:37 -07001766 worker = list_entry(pool->idle_list.prev, struct worker, entry);
Tejun Heoe22bee72010-06-29 10:07:14 +02001767 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1768
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001769 if (time_before(jiffies, expires)) {
Tejun Heo63d95a92012-07-12 14:46:37 -07001770 mod_timer(&pool->idle_timer, expires);
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001771 break;
Tejun Heoe22bee72010-06-29 10:07:14 +02001772 }
Lai Jiangshan3347fc92014-05-20 17:46:30 +08001773
1774 destroy_worker(worker);
Tejun Heoe22bee72010-06-29 10:07:14 +02001775 }
1776
Tejun Heod565ed62013-01-24 11:01:33 -08001777 spin_unlock_irq(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001778}
1779
Tejun Heo493a1722013-03-12 11:29:59 -07001780static void send_mayday(struct work_struct *work)
Tejun Heoe22bee72010-06-29 10:07:14 +02001781{
Tejun Heo112202d2013-02-13 19:29:12 -08001782 struct pool_workqueue *pwq = get_work_pwq(work);
1783 struct workqueue_struct *wq = pwq->wq;
Tejun Heo493a1722013-03-12 11:29:59 -07001784
Tejun Heo2e109a22013-03-13 19:47:40 -07001785 lockdep_assert_held(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001786
Tejun Heo493008a2013-03-12 11:30:03 -07001787 if (!wq->rescuer)
Tejun Heo493a1722013-03-12 11:29:59 -07001788 return;
Tejun Heoe22bee72010-06-29 10:07:14 +02001789
1790 /* mayday mayday mayday */
Tejun Heo493a1722013-03-12 11:29:59 -07001791 if (list_empty(&pwq->mayday_node)) {
Lai Jiangshan77668c82014-04-18 11:04:16 -04001792 /*
1793 * If @pwq is for an unbound wq, its base ref may be put at
1794 * any time due to an attribute change. Pin @pwq until the
1795 * rescuer is done with it.
1796 */
1797 get_pwq(pwq);
Tejun Heo493a1722013-03-12 11:29:59 -07001798 list_add_tail(&pwq->mayday_node, &wq->maydays);
Tejun Heoe22bee72010-06-29 10:07:14 +02001799 wake_up_process(wq->rescuer->task);
Tejun Heo493a1722013-03-12 11:29:59 -07001800 }
Tejun Heoe22bee72010-06-29 10:07:14 +02001801}
1802
Tejun Heo706026c2013-01-24 11:01:34 -08001803static void pool_mayday_timeout(unsigned long __pool)
Tejun Heoe22bee72010-06-29 10:07:14 +02001804{
Tejun Heo63d95a92012-07-12 14:46:37 -07001805 struct worker_pool *pool = (void *)__pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001806 struct work_struct *work;
1807
Tejun Heo2e109a22013-03-13 19:47:40 -07001808 spin_lock_irq(&wq_mayday_lock); /* for wq->maydays */
Tejun Heo493a1722013-03-12 11:29:59 -07001809 spin_lock(&pool->lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001810
Tejun Heo63d95a92012-07-12 14:46:37 -07001811 if (need_to_create_worker(pool)) {
Tejun Heoe22bee72010-06-29 10:07:14 +02001812 /*
1813 * We've been trying to create a new worker but
1814 * haven't been successful. We might be hitting an
1815 * allocation deadlock. Send distress signals to
1816 * rescuers.
1817 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001818 list_for_each_entry(work, &pool->worklist, entry)
Tejun Heoe22bee72010-06-29 10:07:14 +02001819 send_mayday(work);
1820 }
1821
Tejun Heo493a1722013-03-12 11:29:59 -07001822 spin_unlock(&pool->lock);
Tejun Heo2e109a22013-03-13 19:47:40 -07001823 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02001824
Tejun Heo63d95a92012-07-12 14:46:37 -07001825 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
Tejun Heoe22bee72010-06-29 10:07:14 +02001826}
1827
1828/**
1829 * maybe_create_worker - create a new worker if necessary
Tejun Heo63d95a92012-07-12 14:46:37 -07001830 * @pool: pool to create a new worker for
Tejun Heoe22bee72010-06-29 10:07:14 +02001831 *
Tejun Heo63d95a92012-07-12 14:46:37 -07001832 * Create a new worker for @pool if necessary. @pool is guaranteed to
Tejun Heoe22bee72010-06-29 10:07:14 +02001833 * have at least one idle worker on return from this function. If
1834 * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
Tejun Heo63d95a92012-07-12 14:46:37 -07001835 * sent to all rescuers with works scheduled on @pool to resolve
Tejun Heoe22bee72010-06-29 10:07:14 +02001836 * possible allocation deadlock.
1837 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001838 * On return, need_to_create_worker() is guaranteed to be %false and
1839 * may_start_working() %true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001840 *
1841 * LOCKING:
Tejun Heod565ed62013-01-24 11:01:33 -08001842 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001843 * multiple times. Does GFP_KERNEL allocations. Called only from
1844 * manager.
1845 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001846 * Return:
Tejun Heoc5aa87b2013-03-13 16:51:36 -07001847 * %false if no action was taken and pool->lock stayed locked, %true
Tejun Heoe22bee72010-06-29 10:07:14 +02001848 * otherwise.
1849 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001850static bool maybe_create_worker(struct worker_pool *pool)
Tejun Heod565ed62013-01-24 11:01:33 -08001851__releases(&pool->lock)
1852__acquires(&pool->lock)
Tejun Heoe22bee72010-06-29 10:07:14 +02001853{
Tejun Heo63d95a92012-07-12 14:46:37 -07001854 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001855 return false;
1856restart:
Tejun Heod565ed62013-01-24 11:01:33 -08001857 spin_unlock_irq(&pool->lock);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001858
Tejun Heoe22bee72010-06-29 10:07:14 +02001859 /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
Tejun Heo63d95a92012-07-12 14:46:37 -07001860 mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
Tejun Heoe22bee72010-06-29 10:07:14 +02001861
1862 while (true) {
Lai Jiangshan051e1852014-07-22 13:03:02 +08001863 if (create_worker(pool) || !need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001864 break;
1865
Lai Jiangshane212f362014-06-03 15:32:17 +08001866 schedule_timeout_interruptible(CREATE_COOLDOWN);
Tejun Heo9f9c2362010-07-14 11:31:20 +02001867
Tejun Heo63d95a92012-07-12 14:46:37 -07001868 if (!need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001869 break;
1870 }
1871
Tejun Heo63d95a92012-07-12 14:46:37 -07001872 del_timer_sync(&pool->mayday_timer);
Tejun Heod565ed62013-01-24 11:01:33 -08001873 spin_lock_irq(&pool->lock);
Lai Jiangshan051e1852014-07-22 13:03:02 +08001874 /*
1875 * This is necessary even after a new worker was just successfully
1876 * created as @pool->lock was dropped and the new worker might have
1877 * already become busy.
1878 */
Tejun Heo63d95a92012-07-12 14:46:37 -07001879 if (need_to_create_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02001880 goto restart;
1881 return true;
1882}
1883
1884/**
Tejun Heoe22bee72010-06-29 10:07:14 +02001885 * manage_workers - manage worker pool
1886 * @worker: self
1887 *
Tejun Heo706026c2013-01-24 11:01:34 -08001888 * Assume the manager role and manage the worker pool @worker belongs
Tejun Heoe22bee72010-06-29 10:07:14 +02001889 * to. At any given time, there can be only zero or one manager per
Tejun Heo706026c2013-01-24 11:01:34 -08001890 * pool. The exclusion is handled automatically by this function.
Tejun Heoe22bee72010-06-29 10:07:14 +02001891 *
1892 * The caller can safely start processing works on false return. On
1893 * true return, it's guaranteed that need_to_create_worker() is false
1894 * and may_start_working() is true.
1895 *
1896 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001897 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoe22bee72010-06-29 10:07:14 +02001898 * multiple times. Does GFP_KERNEL allocations.
1899 *
Yacine Belkadid185af32013-07-31 14:59:24 -07001900 * Return:
Libin2d498db2013-08-21 08:50:40 +08001901 * %false if the pool don't need management and the caller can safely start
1902 * processing works, %true indicates that the function released pool->lock
1903 * and reacquired it to perform some management function and that the
1904 * conditions that the caller verified while holding the lock before
1905 * calling the function might no longer be true.
Tejun Heoe22bee72010-06-29 10:07:14 +02001906 */
1907static bool manage_workers(struct worker *worker)
1908{
Tejun Heo63d95a92012-07-12 14:46:37 -07001909 struct worker_pool *pool = worker->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02001910 bool ret = false;
1911
Tejun Heobc3a1af2013-03-13 19:47:39 -07001912 /*
Tejun Heobc3a1af2013-03-13 19:47:39 -07001913 * Anyone who successfully grabs manager_arb wins the arbitration
1914 * and becomes the manager. mutex_trylock() on pool->manager_arb
1915 * failure while holding pool->lock reliably indicates that someone
1916 * else is managing the pool and the worker which failed trylock
1917 * can proceed to executing work items. This means that anyone
1918 * grabbing manager_arb is responsible for actually performing
1919 * manager duties. If manager_arb is grabbed and released without
1920 * actual management, the pool may stall indefinitely.
Tejun Heobc3a1af2013-03-13 19:47:39 -07001921 */
Tejun Heo34a06bd2013-03-12 11:30:00 -07001922 if (!mutex_trylock(&pool->manager_arb))
Tejun Heoe22bee72010-06-29 10:07:14 +02001923 return ret;
1924
Tejun Heo63d95a92012-07-12 14:46:37 -07001925 ret |= maybe_create_worker(pool);
Tejun Heoe22bee72010-06-29 10:07:14 +02001926
Tejun Heo34a06bd2013-03-12 11:30:00 -07001927 mutex_unlock(&pool->manager_arb);
Tejun Heoe22bee72010-06-29 10:07:14 +02001928 return ret;
1929}
1930
Tejun Heoa62428c2010-06-29 10:07:10 +02001931/**
1932 * process_one_work - process single work
Tejun Heoc34056a2010-06-29 10:07:11 +02001933 * @worker: self
Tejun Heoa62428c2010-06-29 10:07:10 +02001934 * @work: work to process
1935 *
1936 * Process @work. This function contains all the logics necessary to
1937 * process a single work including synchronization against and
1938 * interaction with other workers on the same cpu, queueing and
1939 * flushing. As long as context requirement is met, any worker can
1940 * call this function to process a work.
1941 *
1942 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08001943 * spin_lock_irq(pool->lock) which is released and regrabbed.
Tejun Heoa62428c2010-06-29 10:07:10 +02001944 */
Tejun Heoc34056a2010-06-29 10:07:11 +02001945static void process_one_work(struct worker *worker, struct work_struct *work)
Tejun Heod565ed62013-01-24 11:01:33 -08001946__releases(&pool->lock)
1947__acquires(&pool->lock)
Tejun Heoa62428c2010-06-29 10:07:10 +02001948{
Tejun Heo112202d2013-02-13 19:29:12 -08001949 struct pool_workqueue *pwq = get_work_pwq(work);
Tejun Heobd7bdd42012-07-12 14:46:37 -07001950 struct worker_pool *pool = worker->pool;
Tejun Heo112202d2013-02-13 19:29:12 -08001951 bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
Tejun Heo73f53c42010-06-29 10:07:11 +02001952 int work_color;
Tejun Heo7e116292010-06-29 10:07:13 +02001953 struct worker *collision;
Tejun Heoa62428c2010-06-29 10:07:10 +02001954#ifdef CONFIG_LOCKDEP
1955 /*
1956 * It is permissible to free the struct work_struct from
1957 * inside the function that is called from it, this we need to
1958 * take into account for lockdep too. To avoid bogus "held
1959 * lock freed" warnings as well as problems when looking into
1960 * work->lockdep_map, make a copy and use that here.
1961 */
Peter Zijlstra4d82a1d2012-05-15 08:06:19 -07001962 struct lockdep_map lockdep_map;
1963
1964 lockdep_copy_map(&lockdep_map, &work->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02001965#endif
Lai Jiangshan85327af2014-06-03 15:33:28 +08001966 WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
Tejun Heoec22ca52013-01-24 11:01:33 -08001967 raw_smp_processor_id() != pool->cpu);
Tejun Heo25511a42012-07-17 12:39:27 -07001968
Tejun Heo7e116292010-06-29 10:07:13 +02001969 /*
1970 * A single work shouldn't be executed concurrently by
1971 * multiple workers on a single cpu. Check whether anyone is
1972 * already processing the work. If so, defer the work to the
1973 * currently executing one.
1974 */
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001975 collision = find_worker_executing_work(pool, work);
Tejun Heo7e116292010-06-29 10:07:13 +02001976 if (unlikely(collision)) {
1977 move_linked_works(work, &collision->scheduled, NULL);
1978 return;
1979 }
1980
Tejun Heo8930cab2012-08-03 10:30:45 -07001981 /* claim and dequeue */
Tejun Heoa62428c2010-06-29 10:07:10 +02001982 debug_work_deactivate(work);
Tejun Heoc9e7cf22013-01-24 11:01:33 -08001983 hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
Tejun Heoc34056a2010-06-29 10:07:11 +02001984 worker->current_work = work;
Tejun Heoa2c1c572012-12-18 10:35:02 -08001985 worker->current_func = work->func;
Tejun Heo112202d2013-02-13 19:29:12 -08001986 worker->current_pwq = pwq;
Tejun Heo73f53c42010-06-29 10:07:11 +02001987 work_color = get_work_color(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02001988
Tejun Heoa62428c2010-06-29 10:07:10 +02001989 list_del_init(&work->entry);
1990
Tejun Heo649027d2010-06-29 10:07:14 +02001991 /*
Lai Jiangshan228f1d02014-07-22 13:02:00 +08001992 * CPU intensive works don't participate in concurrency management.
1993 * They're the scheduler's responsibility. This takes @worker out
1994 * of concurrency management and the next code block will chain
1995 * execution of the pending work items.
Tejun Heofb0e7be2010-06-29 10:07:15 +02001996 */
1997 if (unlikely(cpu_intensive))
Lai Jiangshan228f1d02014-07-22 13:02:00 +08001998 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
Tejun Heofb0e7be2010-06-29 10:07:15 +02001999
Tejun Heo974271c2012-07-12 14:46:37 -07002000 /*
Lai Jiangshana489a032014-07-22 13:01:59 +08002001 * Wake up another worker if necessary. The condition is always
2002 * false for normal per-cpu workers since nr_running would always
2003 * be >= 1 at this point. This is used to chain execution of the
2004 * pending work items for WORKER_NOT_RUNNING workers such as the
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002005 * UNBOUND and CPU_INTENSIVE ones.
Tejun Heo974271c2012-07-12 14:46:37 -07002006 */
Lai Jiangshana489a032014-07-22 13:01:59 +08002007 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002008 wake_up_worker(pool);
Tejun Heo974271c2012-07-12 14:46:37 -07002009
Tejun Heo8930cab2012-08-03 10:30:45 -07002010 /*
Tejun Heo7c3eed52013-01-24 11:01:33 -08002011 * Record the last pool and clear PENDING which should be the last
Tejun Heod565ed62013-01-24 11:01:33 -08002012 * update to @work. Also, do this inside @pool->lock so that
Tejun Heo23657bb2012-08-13 17:08:19 -07002013 * PENDING and queued state changes happen together while IRQ is
2014 * disabled.
Tejun Heo8930cab2012-08-03 10:30:45 -07002015 */
Tejun Heo7c3eed52013-01-24 11:01:33 -08002016 set_work_pool_and_clear_pending(work, pool->id);
Tejun Heoa62428c2010-06-29 10:07:10 +02002017
Tejun Heod565ed62013-01-24 11:01:33 -08002018 spin_unlock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002019
Tejun Heo112202d2013-02-13 19:29:12 -08002020 lock_map_acquire_read(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002021 lock_map_acquire(&lockdep_map);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002022 trace_workqueue_execute_start(work);
Tejun Heoa2c1c572012-12-18 10:35:02 -08002023 worker->current_func(work);
Arjan van de Vene36c8862010-08-21 13:07:26 -07002024 /*
2025 * While we must be careful to not use "work" after this, the trace
2026 * point will only record its address.
2027 */
2028 trace_workqueue_execute_end(work);
Tejun Heoa62428c2010-06-29 10:07:10 +02002029 lock_map_release(&lockdep_map);
Tejun Heo112202d2013-02-13 19:29:12 -08002030 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoa62428c2010-06-29 10:07:10 +02002031
2032 if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
Valentin Ilie044c7822012-08-19 00:52:42 +03002033 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2034 " last function: %pf\n",
Tejun Heoa2c1c572012-12-18 10:35:02 -08002035 current->comm, preempt_count(), task_pid_nr(current),
2036 worker->current_func);
Tejun Heoa62428c2010-06-29 10:07:10 +02002037 debug_show_held_locks(current);
2038 dump_stack();
2039 }
2040
Tejun Heob22ce272013-08-28 17:33:37 -04002041 /*
2042 * The following prevents a kworker from hogging CPU on !PREEMPT
2043 * kernels, where a requeueing work item waiting for something to
2044 * happen could deadlock with stop_machine as such work item could
2045 * indefinitely requeue itself while all other CPUs are trapped in
2046 * stop_machine.
2047 */
2048 cond_resched();
2049
Tejun Heod565ed62013-01-24 11:01:33 -08002050 spin_lock_irq(&pool->lock);
Tejun Heoa62428c2010-06-29 10:07:10 +02002051
Tejun Heofb0e7be2010-06-29 10:07:15 +02002052 /* clear cpu intensive status */
2053 if (unlikely(cpu_intensive))
2054 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2055
Tejun Heoa62428c2010-06-29 10:07:10 +02002056 /* we're done with it, release */
Sasha Levin42f85702012-12-17 10:01:23 -05002057 hash_del(&worker->hentry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002058 worker->current_work = NULL;
Tejun Heoa2c1c572012-12-18 10:35:02 -08002059 worker->current_func = NULL;
Tejun Heo112202d2013-02-13 19:29:12 -08002060 worker->current_pwq = NULL;
Tejun Heo3d1cb202013-04-30 15:27:22 -07002061 worker->desc_valid = false;
Tejun Heo112202d2013-02-13 19:29:12 -08002062 pwq_dec_nr_in_flight(pwq, work_color);
Tejun Heoa62428c2010-06-29 10:07:10 +02002063}
2064
Tejun Heoaffee4b2010-06-29 10:07:12 +02002065/**
2066 * process_scheduled_works - process scheduled works
2067 * @worker: self
2068 *
2069 * Process all scheduled works. Please note that the scheduled list
2070 * may change while processing a work, so this function repeatedly
2071 * fetches a work from the top and executes it.
2072 *
2073 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002074 * spin_lock_irq(pool->lock) which may be released and regrabbed
Tejun Heoaffee4b2010-06-29 10:07:12 +02002075 * multiple times.
2076 */
2077static void process_scheduled_works(struct worker *worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002079 while (!list_empty(&worker->scheduled)) {
2080 struct work_struct *work = list_first_entry(&worker->scheduled,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 struct work_struct, entry);
Tejun Heoc34056a2010-06-29 10:07:11 +02002082 process_one_work(worker, work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084}
2085
Tejun Heo4690c4a2010-06-29 10:07:10 +02002086/**
2087 * worker_thread - the worker thread function
Tejun Heoc34056a2010-06-29 10:07:11 +02002088 * @__worker: self
Tejun Heo4690c4a2010-06-29 10:07:10 +02002089 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002090 * The worker thread function. All workers belong to a worker_pool -
2091 * either a per-cpu one or dynamic unbound one. These workers process all
2092 * work items regardless of their specific target workqueue. The only
2093 * exception is work items which belong to workqueues with a rescuer which
2094 * will be explained in rescuer_thread().
Yacine Belkadid185af32013-07-31 14:59:24 -07002095 *
2096 * Return: 0
Tejun Heo4690c4a2010-06-29 10:07:10 +02002097 */
Tejun Heoc34056a2010-06-29 10:07:11 +02002098static int worker_thread(void *__worker)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099{
Tejun Heoc34056a2010-06-29 10:07:11 +02002100 struct worker *worker = __worker;
Tejun Heobd7bdd42012-07-12 14:46:37 -07002101 struct worker_pool *pool = worker->pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102
Tejun Heoe22bee72010-06-29 10:07:14 +02002103 /* tell the scheduler that this is a workqueue worker */
2104 worker->task->flags |= PF_WQ_WORKER;
Tejun Heoc8e55f32010-06-29 10:07:12 +02002105woke_up:
Tejun Heod565ed62013-01-24 11:01:33 -08002106 spin_lock_irq(&pool->lock);
Oleg Nesterov3af244332007-05-09 02:34:09 -07002107
Tejun Heoa9ab7752013-03-19 13:45:21 -07002108 /* am I supposed to die? */
2109 if (unlikely(worker->flags & WORKER_DIE)) {
Tejun Heod565ed62013-01-24 11:01:33 -08002110 spin_unlock_irq(&pool->lock);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002111 WARN_ON_ONCE(!list_empty(&worker->entry));
2112 worker->task->flags &= ~PF_WQ_WORKER;
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002113
2114 set_task_comm(worker->task, "kworker/dying");
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08002115 ida_simple_remove(&pool->worker_ida, worker->id);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08002116 worker_detach_from_pool(worker, pool);
2117 kfree(worker);
Tejun Heoa9ab7752013-03-19 13:45:21 -07002118 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07002120
Tejun Heoc8e55f32010-06-29 10:07:12 +02002121 worker_leave_idle(worker);
Tejun Heodb7bccf2010-06-29 10:07:12 +02002122recheck:
Tejun Heoe22bee72010-06-29 10:07:14 +02002123 /* no more worker necessary? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002124 if (!need_more_worker(pool))
Tejun Heoe22bee72010-06-29 10:07:14 +02002125 goto sleep;
2126
2127 /* do we need to manage? */
Tejun Heo63d95a92012-07-12 14:46:37 -07002128 if (unlikely(!may_start_working(pool)) && manage_workers(worker))
Tejun Heoe22bee72010-06-29 10:07:14 +02002129 goto recheck;
2130
Tejun Heoc8e55f32010-06-29 10:07:12 +02002131 /*
2132 * ->scheduled list can only be filled while a worker is
2133 * preparing to process a work or actually processing it.
2134 * Make sure nobody diddled with it while I was sleeping.
2135 */
Tejun Heo6183c002013-03-12 11:29:57 -07002136 WARN_ON_ONCE(!list_empty(&worker->scheduled));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002137
Tejun Heoe22bee72010-06-29 10:07:14 +02002138 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07002139 * Finish PREP stage. We're guaranteed to have at least one idle
2140 * worker or that someone else has already assumed the manager
2141 * role. This is where @worker starts participating in concurrency
2142 * management if applicable and concurrency management is restored
2143 * after being rebound. See rebind_workers() for details.
Tejun Heoe22bee72010-06-29 10:07:14 +02002144 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07002145 worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
Tejun Heoe22bee72010-06-29 10:07:14 +02002146
2147 do {
Tejun Heoc8e55f32010-06-29 10:07:12 +02002148 struct work_struct *work =
Tejun Heobd7bdd42012-07-12 14:46:37 -07002149 list_first_entry(&pool->worklist,
Tejun Heoc8e55f32010-06-29 10:07:12 +02002150 struct work_struct, entry);
2151
2152 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2153 /* optimization path, not strictly necessary */
2154 process_one_work(worker, work);
2155 if (unlikely(!list_empty(&worker->scheduled)))
2156 process_scheduled_works(worker);
2157 } else {
2158 move_linked_works(work, &worker->scheduled, NULL);
2159 process_scheduled_works(worker);
2160 }
Tejun Heo63d95a92012-07-12 14:46:37 -07002161 } while (keep_working(pool));
Tejun Heoc8e55f32010-06-29 10:07:12 +02002162
Lai Jiangshan228f1d02014-07-22 13:02:00 +08002163 worker_set_flags(worker, WORKER_PREP);
Tejun Heod313dd82010-07-02 10:03:51 +02002164sleep:
Tejun Heoc8e55f32010-06-29 10:07:12 +02002165 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002166 * pool->lock is held and there's no work to process and no need to
2167 * manage, sleep. Workers are woken up only while holding
2168 * pool->lock or from local cpu, so setting the current state
2169 * before releasing pool->lock is enough to prevent losing any
2170 * event.
Tejun Heoc8e55f32010-06-29 10:07:12 +02002171 */
2172 worker_enter_idle(worker);
2173 __set_current_state(TASK_INTERRUPTIBLE);
Tejun Heod565ed62013-01-24 11:01:33 -08002174 spin_unlock_irq(&pool->lock);
Tejun Heoc8e55f32010-06-29 10:07:12 +02002175 schedule();
2176 goto woke_up;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177}
2178
Tejun Heoe22bee72010-06-29 10:07:14 +02002179/**
2180 * rescuer_thread - the rescuer thread function
Tejun Heo111c2252013-01-17 17:16:24 -08002181 * @__rescuer: self
Tejun Heoe22bee72010-06-29 10:07:14 +02002182 *
2183 * Workqueue rescuer thread function. There's one rescuer for each
Tejun Heo493008a2013-03-12 11:30:03 -07002184 * workqueue which has WQ_MEM_RECLAIM set.
Tejun Heoe22bee72010-06-29 10:07:14 +02002185 *
Tejun Heo706026c2013-01-24 11:01:34 -08002186 * Regular work processing on a pool may block trying to create a new
Tejun Heoe22bee72010-06-29 10:07:14 +02002187 * worker which uses GFP_KERNEL allocation which has slight chance of
2188 * developing into deadlock if some works currently on the same queue
2189 * need to be processed to satisfy the GFP_KERNEL allocation. This is
2190 * the problem rescuer solves.
2191 *
Tejun Heo706026c2013-01-24 11:01:34 -08002192 * When such condition is possible, the pool summons rescuers of all
2193 * workqueues which have works queued on the pool and let them process
Tejun Heoe22bee72010-06-29 10:07:14 +02002194 * those works so that forward progress can be guaranteed.
2195 *
2196 * This should happen rarely.
Yacine Belkadid185af32013-07-31 14:59:24 -07002197 *
2198 * Return: 0
Tejun Heoe22bee72010-06-29 10:07:14 +02002199 */
Tejun Heo111c2252013-01-17 17:16:24 -08002200static int rescuer_thread(void *__rescuer)
Tejun Heoe22bee72010-06-29 10:07:14 +02002201{
Tejun Heo111c2252013-01-17 17:16:24 -08002202 struct worker *rescuer = __rescuer;
2203 struct workqueue_struct *wq = rescuer->rescue_wq;
Tejun Heoe22bee72010-06-29 10:07:14 +02002204 struct list_head *scheduled = &rescuer->scheduled;
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002205 bool should_stop;
Tejun Heoe22bee72010-06-29 10:07:14 +02002206
2207 set_user_nice(current, RESCUER_NICE_LEVEL);
Tejun Heo111c2252013-01-17 17:16:24 -08002208
2209 /*
2210 * Mark rescuer as worker too. As WORKER_PREP is never cleared, it
2211 * doesn't participate in concurrency management.
2212 */
2213 rescuer->task->flags |= PF_WQ_WORKER;
Tejun Heoe22bee72010-06-29 10:07:14 +02002214repeat:
2215 set_current_state(TASK_INTERRUPTIBLE);
2216
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002217 /*
2218 * By the time the rescuer is requested to stop, the workqueue
2219 * shouldn't have any work pending, but @wq->maydays may still have
2220 * pwq(s) queued. This can happen by non-rescuer workers consuming
2221 * all the work items before the rescuer got to them. Go through
2222 * @wq->maydays processing before acting on should_stop so that the
2223 * list is always empty on exit.
2224 */
2225 should_stop = kthread_should_stop();
Tejun Heoe22bee72010-06-29 10:07:14 +02002226
Tejun Heo493a1722013-03-12 11:29:59 -07002227 /* see whether any pwq is asking for help */
Tejun Heo2e109a22013-03-13 19:47:40 -07002228 spin_lock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002229
2230 while (!list_empty(&wq->maydays)) {
2231 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2232 struct pool_workqueue, mayday_node);
Tejun Heo112202d2013-02-13 19:29:12 -08002233 struct worker_pool *pool = pwq->pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002234 struct work_struct *work, *n;
2235
2236 __set_current_state(TASK_RUNNING);
Tejun Heo493a1722013-03-12 11:29:59 -07002237 list_del_init(&pwq->mayday_node);
2238
Tejun Heo2e109a22013-03-13 19:47:40 -07002239 spin_unlock_irq(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002240
Lai Jiangshan51697d392014-05-20 17:46:36 +08002241 worker_attach_to_pool(rescuer, pool);
2242
2243 spin_lock_irq(&pool->lock);
Lai Jiangshanb3104102013-02-19 12:17:02 -08002244 rescuer->pool = pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02002245
2246 /*
2247 * Slurp in all works issued via this workqueue and
2248 * process'em.
2249 */
Tejun Heo6183c002013-03-12 11:29:57 -07002250 WARN_ON_ONCE(!list_empty(&rescuer->scheduled));
Tejun Heobd7bdd42012-07-12 14:46:37 -07002251 list_for_each_entry_safe(work, n, &pool->worklist, entry)
Tejun Heo112202d2013-02-13 19:29:12 -08002252 if (get_work_pwq(work) == pwq)
Tejun Heoe22bee72010-06-29 10:07:14 +02002253 move_linked_works(work, scheduled, &n);
2254
2255 process_scheduled_works(rescuer);
Lai Jiangshan51697d392014-05-20 17:46:36 +08002256 spin_unlock_irq(&pool->lock);
2257
2258 worker_detach_from_pool(rescuer, pool);
2259
2260 spin_lock_irq(&pool->lock);
Tejun Heo75769582011-02-14 14:04:46 +01002261
2262 /*
Lai Jiangshan77668c82014-04-18 11:04:16 -04002263 * Put the reference grabbed by send_mayday(). @pool won't
2264 * go away while we're holding its lock.
2265 */
2266 put_pwq(pwq);
2267
2268 /*
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002269 * Leave this pool. If need_more_worker() is %true, notify a
Tejun Heo75769582011-02-14 14:04:46 +01002270 * regular worker; otherwise, we end up with 0 concurrency
2271 * and stalling the execution.
2272 */
Lai Jiangshand8ca83e2014-07-16 14:56:36 +08002273 if (need_more_worker(pool))
Tejun Heo63d95a92012-07-12 14:46:37 -07002274 wake_up_worker(pool);
Tejun Heo75769582011-02-14 14:04:46 +01002275
Lai Jiangshanb3104102013-02-19 12:17:02 -08002276 rescuer->pool = NULL;
Tejun Heo493a1722013-03-12 11:29:59 -07002277 spin_unlock(&pool->lock);
Tejun Heo2e109a22013-03-13 19:47:40 -07002278 spin_lock(&wq_mayday_lock);
Tejun Heoe22bee72010-06-29 10:07:14 +02002279 }
2280
Tejun Heo2e109a22013-03-13 19:47:40 -07002281 spin_unlock_irq(&wq_mayday_lock);
Tejun Heo493a1722013-03-12 11:29:59 -07002282
Lai Jiangshan4d595b82014-04-18 11:04:16 -04002283 if (should_stop) {
2284 __set_current_state(TASK_RUNNING);
2285 rescuer->task->flags &= ~PF_WQ_WORKER;
2286 return 0;
2287 }
2288
Tejun Heo111c2252013-01-17 17:16:24 -08002289 /* rescuers should never participate in concurrency management */
2290 WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
Tejun Heoe22bee72010-06-29 10:07:14 +02002291 schedule();
2292 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293}
2294
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002295struct wq_barrier {
2296 struct work_struct work;
2297 struct completion done;
2298};
2299
2300static void wq_barrier_func(struct work_struct *work)
2301{
2302 struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2303 complete(&barr->done);
2304}
2305
Tejun Heo4690c4a2010-06-29 10:07:10 +02002306/**
2307 * insert_wq_barrier - insert a barrier work
Tejun Heo112202d2013-02-13 19:29:12 -08002308 * @pwq: pwq to insert barrier into
Tejun Heo4690c4a2010-06-29 10:07:10 +02002309 * @barr: wq_barrier to insert
Tejun Heoaffee4b2010-06-29 10:07:12 +02002310 * @target: target work to attach @barr to
2311 * @worker: worker currently executing @target, NULL if @target is not executing
Tejun Heo4690c4a2010-06-29 10:07:10 +02002312 *
Tejun Heoaffee4b2010-06-29 10:07:12 +02002313 * @barr is linked to @target such that @barr is completed only after
2314 * @target finishes execution. Please note that the ordering
2315 * guarantee is observed only with respect to @target and on the local
2316 * cpu.
2317 *
2318 * Currently, a queued barrier can't be canceled. This is because
2319 * try_to_grab_pending() can't determine whether the work to be
2320 * grabbed is at the head of the queue and thus can't clear LINKED
2321 * flag of the previous work while there must be a valid next work
2322 * after a work with LINKED flag set.
2323 *
2324 * Note that when @worker is non-NULL, @target may be modified
Tejun Heo112202d2013-02-13 19:29:12 -08002325 * underneath us, so we can't reliably determine pwq from @target.
Tejun Heo4690c4a2010-06-29 10:07:10 +02002326 *
2327 * CONTEXT:
Tejun Heod565ed62013-01-24 11:01:33 -08002328 * spin_lock_irq(pool->lock).
Tejun Heo4690c4a2010-06-29 10:07:10 +02002329 */
Tejun Heo112202d2013-02-13 19:29:12 -08002330static void insert_wq_barrier(struct pool_workqueue *pwq,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002331 struct wq_barrier *barr,
2332 struct work_struct *target, struct worker *worker)
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002333{
Tejun Heoaffee4b2010-06-29 10:07:12 +02002334 struct list_head *head;
2335 unsigned int linked = 0;
2336
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002337 /*
Tejun Heod565ed62013-01-24 11:01:33 -08002338 * debugobject calls are safe here even with pool->lock locked
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002339 * as we know for sure that this will not trigger any of the
2340 * checks and call back into the fixup functions where we
2341 * might deadlock.
2342 */
Andrew Mortonca1cab32010-10-26 14:22:34 -07002343 INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
Tejun Heo22df02b2010-06-29 10:07:10 +02002344 __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002345 init_completion(&barr->done);
Oleg Nesterov83c22522007-05-09 02:33:54 -07002346
Tejun Heoaffee4b2010-06-29 10:07:12 +02002347 /*
2348 * If @target is currently being executed, schedule the
2349 * barrier to the worker; otherwise, put it after @target.
2350 */
2351 if (worker)
2352 head = worker->scheduled.next;
2353 else {
2354 unsigned long *bits = work_data_bits(target);
2355
2356 head = target->entry.next;
2357 /* there can already be other linked works, inherit and set */
2358 linked = *bits & WORK_STRUCT_LINKED;
2359 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2360 }
2361
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002362 debug_work_activate(&barr->work);
Tejun Heo112202d2013-02-13 19:29:12 -08002363 insert_work(pwq, &barr->work, head,
Tejun Heoaffee4b2010-06-29 10:07:12 +02002364 work_color_to_flags(WORK_NO_COLOR) | linked);
Oleg Nesterovfc2e4d72007-05-09 02:33:51 -07002365}
2366
Tejun Heo73f53c42010-06-29 10:07:11 +02002367/**
Tejun Heo112202d2013-02-13 19:29:12 -08002368 * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
Tejun Heo73f53c42010-06-29 10:07:11 +02002369 * @wq: workqueue being flushed
2370 * @flush_color: new flush color, < 0 for no-op
2371 * @work_color: new work color, < 0 for no-op
2372 *
Tejun Heo112202d2013-02-13 19:29:12 -08002373 * Prepare pwqs for workqueue flushing.
Tejun Heo73f53c42010-06-29 10:07:11 +02002374 *
Tejun Heo112202d2013-02-13 19:29:12 -08002375 * If @flush_color is non-negative, flush_color on all pwqs should be
2376 * -1. If no pwq has in-flight commands at the specified color, all
2377 * pwq->flush_color's stay at -1 and %false is returned. If any pwq
2378 * has in flight commands, its pwq->flush_color is set to
2379 * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
Tejun Heo73f53c42010-06-29 10:07:11 +02002380 * wakeup logic is armed and %true is returned.
2381 *
2382 * The caller should have initialized @wq->first_flusher prior to
2383 * calling this function with non-negative @flush_color. If
2384 * @flush_color is negative, no flush color update is done and %false
2385 * is returned.
2386 *
Tejun Heo112202d2013-02-13 19:29:12 -08002387 * If @work_color is non-negative, all pwqs should have the same
Tejun Heo73f53c42010-06-29 10:07:11 +02002388 * work_color which is previous to @work_color and all will be
2389 * advanced to @work_color.
2390 *
2391 * CONTEXT:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002392 * mutex_lock(wq->mutex).
Tejun Heo73f53c42010-06-29 10:07:11 +02002393 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002394 * Return:
Tejun Heo73f53c42010-06-29 10:07:11 +02002395 * %true if @flush_color >= 0 and there's something to flush. %false
2396 * otherwise.
2397 */
Tejun Heo112202d2013-02-13 19:29:12 -08002398static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
Tejun Heo73f53c42010-06-29 10:07:11 +02002399 int flush_color, int work_color)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400{
Tejun Heo73f53c42010-06-29 10:07:11 +02002401 bool wait = false;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002402 struct pool_workqueue *pwq;
Oleg Nesterov14441962007-05-23 13:57:57 -07002403
Tejun Heo73f53c42010-06-29 10:07:11 +02002404 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002405 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
Tejun Heo112202d2013-02-13 19:29:12 -08002406 atomic_set(&wq->nr_pwqs_to_flush, 1);
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +09002407 }
Oleg Nesterov14441962007-05-23 13:57:57 -07002408
Tejun Heo49e3cf42013-03-12 11:29:58 -07002409 for_each_pwq(pwq, wq) {
Tejun Heo112202d2013-02-13 19:29:12 -08002410 struct worker_pool *pool = pwq->pool;
Tejun Heo73f53c42010-06-29 10:07:11 +02002411
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002412 spin_lock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002413
2414 if (flush_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002415 WARN_ON_ONCE(pwq->flush_color != -1);
Tejun Heo73f53c42010-06-29 10:07:11 +02002416
Tejun Heo112202d2013-02-13 19:29:12 -08002417 if (pwq->nr_in_flight[flush_color]) {
2418 pwq->flush_color = flush_color;
2419 atomic_inc(&wq->nr_pwqs_to_flush);
Tejun Heo73f53c42010-06-29 10:07:11 +02002420 wait = true;
2421 }
2422 }
2423
2424 if (work_color >= 0) {
Tejun Heo6183c002013-03-12 11:29:57 -07002425 WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
Tejun Heo112202d2013-02-13 19:29:12 -08002426 pwq->work_color = work_color;
Tejun Heo73f53c42010-06-29 10:07:11 +02002427 }
2428
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002429 spin_unlock_irq(&pool->lock);
Tejun Heo73f53c42010-06-29 10:07:11 +02002430 }
2431
Tejun Heo112202d2013-02-13 19:29:12 -08002432 if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
Tejun Heo73f53c42010-06-29 10:07:11 +02002433 complete(&wq->first_flusher->done);
2434
2435 return wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436}
2437
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002438/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 * flush_workqueue - ensure that any scheduled work has run to completion.
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002440 * @wq: workqueue to flush
Linus Torvalds1da177e2005-04-16 15:20:36 -07002441 *
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002442 * This function sleeps until all work items which were queued on entry
2443 * have finished execution, but it is not livelocked by new incoming ones.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 */
Harvey Harrison7ad5b3a2008-02-08 04:19:53 -08002445void flush_workqueue(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446{
Tejun Heo73f53c42010-06-29 10:07:11 +02002447 struct wq_flusher this_flusher = {
2448 .list = LIST_HEAD_INIT(this_flusher.list),
2449 .flush_color = -1,
2450 .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done),
2451 };
2452 int next_color;
Oleg Nesterovb1f4ec12007-05-09 02:34:12 -07002453
Ingo Molnar3295f0e2008-08-11 10:30:30 +02002454 lock_map_acquire(&wq->lockdep_map);
2455 lock_map_release(&wq->lockdep_map);
Tejun Heo73f53c42010-06-29 10:07:11 +02002456
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002457 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002458
2459 /*
2460 * Start-to-wait phase
2461 */
2462 next_color = work_next_color(wq->work_color);
2463
2464 if (next_color != wq->flush_color) {
2465 /*
2466 * Color space is not full. The current work_color
2467 * becomes our flush_color and work_color is advanced
2468 * by one.
2469 */
Tejun Heo6183c002013-03-12 11:29:57 -07002470 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
Tejun Heo73f53c42010-06-29 10:07:11 +02002471 this_flusher.flush_color = wq->work_color;
2472 wq->work_color = next_color;
2473
2474 if (!wq->first_flusher) {
2475 /* no flush in progress, become the first flusher */
Tejun Heo6183c002013-03-12 11:29:57 -07002476 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002477
2478 wq->first_flusher = &this_flusher;
2479
Tejun Heo112202d2013-02-13 19:29:12 -08002480 if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
Tejun Heo73f53c42010-06-29 10:07:11 +02002481 wq->work_color)) {
2482 /* nothing to flush, done */
2483 wq->flush_color = next_color;
2484 wq->first_flusher = NULL;
2485 goto out_unlock;
2486 }
2487 } else {
2488 /* wait in queue */
Tejun Heo6183c002013-03-12 11:29:57 -07002489 WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002490 list_add_tail(&this_flusher.list, &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002491 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002492 }
2493 } else {
2494 /*
2495 * Oops, color space is full, wait on overflow queue.
2496 * The next flush completion will assign us
2497 * flush_color and transfer to flusher_queue.
2498 */
2499 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2500 }
2501
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002502 mutex_unlock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002503
2504 wait_for_completion(&this_flusher.done);
2505
2506 /*
2507 * Wake-up-and-cascade phase
2508 *
2509 * First flushers are responsible for cascading flushes and
2510 * handling overflow. Non-first flushers can simply return.
2511 */
2512 if (wq->first_flusher != &this_flusher)
2513 return;
2514
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002515 mutex_lock(&wq->mutex);
Tejun Heo73f53c42010-06-29 10:07:11 +02002516
Tejun Heo4ce48b32010-07-02 10:03:51 +02002517 /* we might have raced, check again with mutex held */
2518 if (wq->first_flusher != &this_flusher)
2519 goto out_unlock;
2520
Tejun Heo73f53c42010-06-29 10:07:11 +02002521 wq->first_flusher = NULL;
2522
Tejun Heo6183c002013-03-12 11:29:57 -07002523 WARN_ON_ONCE(!list_empty(&this_flusher.list));
2524 WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002525
2526 while (true) {
2527 struct wq_flusher *next, *tmp;
2528
2529 /* complete all the flushers sharing the current flush color */
2530 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2531 if (next->flush_color != wq->flush_color)
2532 break;
2533 list_del_init(&next->list);
2534 complete(&next->done);
2535 }
2536
Tejun Heo6183c002013-03-12 11:29:57 -07002537 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2538 wq->flush_color != work_next_color(wq->work_color));
Tejun Heo73f53c42010-06-29 10:07:11 +02002539
2540 /* this flush_color is finished, advance by one */
2541 wq->flush_color = work_next_color(wq->flush_color);
2542
2543 /* one color has been freed, handle overflow queue */
2544 if (!list_empty(&wq->flusher_overflow)) {
2545 /*
2546 * Assign the same color to all overflowed
2547 * flushers, advance work_color and append to
2548 * flusher_queue. This is the start-to-wait
2549 * phase for these overflowed flushers.
2550 */
2551 list_for_each_entry(tmp, &wq->flusher_overflow, list)
2552 tmp->flush_color = wq->work_color;
2553
2554 wq->work_color = work_next_color(wq->work_color);
2555
2556 list_splice_tail_init(&wq->flusher_overflow,
2557 &wq->flusher_queue);
Tejun Heo112202d2013-02-13 19:29:12 -08002558 flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002559 }
2560
2561 if (list_empty(&wq->flusher_queue)) {
Tejun Heo6183c002013-03-12 11:29:57 -07002562 WARN_ON_ONCE(wq->flush_color != wq->work_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002563 break;
2564 }
2565
2566 /*
2567 * Need to flush more colors. Make the next flusher
Tejun Heo112202d2013-02-13 19:29:12 -08002568 * the new first flusher and arm pwqs.
Tejun Heo73f53c42010-06-29 10:07:11 +02002569 */
Tejun Heo6183c002013-03-12 11:29:57 -07002570 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2571 WARN_ON_ONCE(wq->flush_color != next->flush_color);
Tejun Heo73f53c42010-06-29 10:07:11 +02002572
2573 list_del_init(&next->list);
2574 wq->first_flusher = next;
2575
Tejun Heo112202d2013-02-13 19:29:12 -08002576 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
Tejun Heo73f53c42010-06-29 10:07:11 +02002577 break;
2578
2579 /*
2580 * Meh... this color is already done, clear first
2581 * flusher and repeat cascading.
2582 */
2583 wq->first_flusher = NULL;
2584 }
2585
2586out_unlock:
Lai Jiangshan3c25a552013-03-25 16:57:17 -07002587 mutex_unlock(&wq->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588}
Dave Jonesae90dd52006-06-30 01:40:45 -04002589EXPORT_SYMBOL_GPL(flush_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002591/**
2592 * drain_workqueue - drain a workqueue
2593 * @wq: workqueue to drain
2594 *
2595 * Wait until the workqueue becomes empty. While draining is in progress,
2596 * only chain queueing is allowed. IOW, only currently pending or running
2597 * work items on @wq can queue further work items on it. @wq is flushed
2598 * repeatedly until it becomes empty. The number of flushing is detemined
2599 * by the depth of chaining and should be relatively short. Whine if it
2600 * takes too long.
2601 */
2602void drain_workqueue(struct workqueue_struct *wq)
2603{
2604 unsigned int flush_cnt = 0;
Tejun Heo49e3cf42013-03-12 11:29:58 -07002605 struct pool_workqueue *pwq;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002606
2607 /*
2608 * __queue_work() needs to test whether there are drainers, is much
2609 * hotter than drain_workqueue() and already looks at @wq->flags.
Tejun Heo618b01e2013-03-12 11:30:04 -07002610 * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002611 */
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002612 mutex_lock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002613 if (!wq->nr_drainers++)
Tejun Heo618b01e2013-03-12 11:30:04 -07002614 wq->flags |= __WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002615 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002616reflush:
2617 flush_workqueue(wq);
2618
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002619 mutex_lock(&wq->mutex);
Tejun Heo76af4d92013-03-12 11:30:00 -07002620
Tejun Heo49e3cf42013-03-12 11:29:58 -07002621 for_each_pwq(pwq, wq) {
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002622 bool drained;
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002623
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002624 spin_lock_irq(&pwq->pool->lock);
Tejun Heo112202d2013-02-13 19:29:12 -08002625 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002626 spin_unlock_irq(&pwq->pool->lock);
Thomas Tuttlefa2563e2011-09-14 16:22:28 -07002627
2628 if (drained)
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002629 continue;
2630
2631 if (++flush_cnt == 10 ||
2632 (flush_cnt % 100 == 0 && flush_cnt <= 1000))
Tejun Heoc5aa87b2013-03-13 16:51:36 -07002633 pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
Valentin Ilie044c7822012-08-19 00:52:42 +03002634 wq->name, flush_cnt);
Tejun Heo76af4d92013-03-12 11:30:00 -07002635
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07002636 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002637 goto reflush;
2638 }
2639
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002640 if (!--wq->nr_drainers)
Tejun Heo618b01e2013-03-12 11:30:04 -07002641 wq->flags &= ~__WQ_DRAINING;
Lai Jiangshan87fc7412013-03-25 16:57:18 -07002642 mutex_unlock(&wq->mutex);
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02002643}
2644EXPORT_SYMBOL_GPL(drain_workqueue);
2645
Tejun Heo606a5022012-08-20 14:51:23 -07002646static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr)
Tejun Heobaf59022010-09-16 10:42:16 +02002647{
2648 struct worker *worker = NULL;
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002649 struct worker_pool *pool;
Tejun Heo112202d2013-02-13 19:29:12 -08002650 struct pool_workqueue *pwq;
Tejun Heobaf59022010-09-16 10:42:16 +02002651
2652 might_sleep();
Tejun Heobaf59022010-09-16 10:42:16 +02002653
Tejun Heofa1b54e2013-03-12 11:30:00 -07002654 local_irq_disable();
2655 pool = get_work_pool(work);
2656 if (!pool) {
2657 local_irq_enable();
2658 return false;
2659 }
2660
2661 spin_lock(&pool->lock);
Lai Jiangshan0b3dae62013-02-06 18:04:53 -08002662 /* see the comment in try_to_grab_pending() with the same code */
Tejun Heo112202d2013-02-13 19:29:12 -08002663 pwq = get_work_pwq(work);
2664 if (pwq) {
2665 if (unlikely(pwq->pool != pool))
Tejun Heobaf59022010-09-16 10:42:16 +02002666 goto already_gone;
Tejun Heo606a5022012-08-20 14:51:23 -07002667 } else {
Tejun Heoc9e7cf22013-01-24 11:01:33 -08002668 worker = find_worker_executing_work(pool, work);
Tejun Heobaf59022010-09-16 10:42:16 +02002669 if (!worker)
2670 goto already_gone;
Tejun Heo112202d2013-02-13 19:29:12 -08002671 pwq = worker->current_pwq;
Tejun Heo606a5022012-08-20 14:51:23 -07002672 }
Tejun Heobaf59022010-09-16 10:42:16 +02002673
Tejun Heo112202d2013-02-13 19:29:12 -08002674 insert_wq_barrier(pwq, barr, work, worker);
Tejun Heod565ed62013-01-24 11:01:33 -08002675 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002676
Tejun Heoe1594892011-01-09 23:32:15 +01002677 /*
2678 * If @max_active is 1 or rescuer is in use, flushing another work
2679 * item on the same workqueue may lead to deadlock. Make sure the
2680 * flusher is not running on the same workqueue by verifying write
2681 * access.
2682 */
Tejun Heo493008a2013-03-12 11:30:03 -07002683 if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)
Tejun Heo112202d2013-02-13 19:29:12 -08002684 lock_map_acquire(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002685 else
Tejun Heo112202d2013-02-13 19:29:12 -08002686 lock_map_acquire_read(&pwq->wq->lockdep_map);
2687 lock_map_release(&pwq->wq->lockdep_map);
Tejun Heoe1594892011-01-09 23:32:15 +01002688
Tejun Heobaf59022010-09-16 10:42:16 +02002689 return true;
2690already_gone:
Tejun Heod565ed62013-01-24 11:01:33 -08002691 spin_unlock_irq(&pool->lock);
Tejun Heobaf59022010-09-16 10:42:16 +02002692 return false;
2693}
2694
Oleg Nesterovdb700892008-07-25 01:47:49 -07002695/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002696 * flush_work - wait for a work to finish executing the last queueing instance
2697 * @work: the work to flush
Oleg Nesterovdb700892008-07-25 01:47:49 -07002698 *
Tejun Heo606a5022012-08-20 14:51:23 -07002699 * Wait until @work has finished execution. @work is guaranteed to be idle
2700 * on return if it hasn't been requeued since flush started.
Tejun Heo401a8d02010-09-16 10:36:00 +02002701 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002702 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002703 * %true if flush_work() waited for the work to finish execution,
2704 * %false if it was already idle.
Oleg Nesterovdb700892008-07-25 01:47:49 -07002705 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002706bool flush_work(struct work_struct *work)
Oleg Nesterovdb700892008-07-25 01:47:49 -07002707{
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002708 struct wq_barrier barr;
2709
Stephen Boyd0976dfc2012-04-20 17:28:50 -07002710 lock_map_acquire(&work->lockdep_map);
2711 lock_map_release(&work->lockdep_map);
2712
Bjorn Helgaas12997d12013-11-18 11:00:29 -07002713 if (start_flush_work(work, &barr)) {
2714 wait_for_completion(&barr.done);
2715 destroy_work_on_stack(&barr.work);
2716 return true;
2717 } else {
2718 return false;
2719 }
Oleg Nesterovdb700892008-07-25 01:47:49 -07002720}
2721EXPORT_SYMBOL_GPL(flush_work);
2722
Tejun Heo36e227d2012-08-03 10:30:46 -07002723static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
Tejun Heo401a8d02010-09-16 10:36:00 +02002724{
Tejun Heobbb68df2012-08-03 10:30:46 -07002725 unsigned long flags;
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002726 int ret;
2727
2728 do {
Tejun Heobbb68df2012-08-03 10:30:46 -07002729 ret = try_to_grab_pending(work, is_dwork, &flags);
2730 /*
2731 * If someone else is canceling, wait for the same event it
2732 * would be waiting for before retrying.
2733 */
2734 if (unlikely(ret == -ENOENT))
Tejun Heo606a5022012-08-20 14:51:23 -07002735 flush_work(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002736 } while (unlikely(ret < 0));
2737
Tejun Heobbb68df2012-08-03 10:30:46 -07002738 /* tell other tasks trying to grab @work to back off */
2739 mark_work_canceling(work);
2740 local_irq_restore(flags);
2741
Tejun Heo606a5022012-08-20 14:51:23 -07002742 flush_work(work);
Tejun Heo7a22ad72010-06-29 10:07:13 +02002743 clear_work_data(work);
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002744 return ret;
2745}
2746
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002747/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002748 * cancel_work_sync - cancel a work and wait for it to finish
2749 * @work: the work to cancel
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002750 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002751 * Cancel @work and wait for its execution to finish. This function
2752 * can be used even if the work re-queues itself or migrates to
2753 * another workqueue. On return from this function, @work is
2754 * guaranteed to be not pending or executing on any CPU.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002755 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002756 * cancel_work_sync(&delayed_work->work) must not be used for
2757 * delayed_work's. Use cancel_delayed_work_sync() instead.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002758 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002759 * The caller must ensure that the workqueue on which @work was last
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002760 * queued can't be destroyed before this function returns.
Tejun Heo401a8d02010-09-16 10:36:00 +02002761 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002762 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002763 * %true if @work was pending, %false otherwise.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002764 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002765bool cancel_work_sync(struct work_struct *work)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002766{
Tejun Heo36e227d2012-08-03 10:30:46 -07002767 return __cancel_work_timer(work, false);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002768}
Oleg Nesterov28e53bd2007-05-09 02:34:22 -07002769EXPORT_SYMBOL_GPL(cancel_work_sync);
Oleg Nesterovb89deed2007-05-09 02:33:52 -07002770
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002771/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002772 * flush_delayed_work - wait for a dwork to finish executing the last queueing
2773 * @dwork: the delayed work to flush
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002774 *
Tejun Heo401a8d02010-09-16 10:36:00 +02002775 * Delayed timer is cancelled and the pending work is queued for
2776 * immediate execution. Like flush_work(), this function only
2777 * considers the last queueing instance of @dwork.
Oleg Nesterov1f1f6422007-07-15 23:41:44 -07002778 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002779 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002780 * %true if flush_work() waited for the work to finish execution,
2781 * %false if it was already idle.
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002782 */
Tejun Heo401a8d02010-09-16 10:36:00 +02002783bool flush_delayed_work(struct delayed_work *dwork)
2784{
Tejun Heo8930cab2012-08-03 10:30:45 -07002785 local_irq_disable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002786 if (del_timer_sync(&dwork->timer))
Lai Jiangshan60c057b2013-02-06 18:04:53 -08002787 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
Tejun Heo8930cab2012-08-03 10:30:45 -07002788 local_irq_enable();
Tejun Heo401a8d02010-09-16 10:36:00 +02002789 return flush_work(&dwork->work);
2790}
2791EXPORT_SYMBOL(flush_delayed_work);
2792
2793/**
Tejun Heo57b30ae2012-08-21 13:18:24 -07002794 * cancel_delayed_work - cancel a delayed work
2795 * @dwork: delayed_work to cancel
Tejun Heo09383492010-09-16 10:48:29 +02002796 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002797 * Kill off a pending delayed_work.
2798 *
2799 * Return: %true if @dwork was pending and canceled; %false if it wasn't
2800 * pending.
2801 *
2802 * Note:
2803 * The work callback function may still be running on return, unless
2804 * it returns %true and the work doesn't re-arm itself. Explicitly flush or
2805 * use cancel_delayed_work_sync() to wait on it.
Tejun Heo09383492010-09-16 10:48:29 +02002806 *
Tejun Heo57b30ae2012-08-21 13:18:24 -07002807 * This function is safe to call from any context including IRQ handler.
Tejun Heo09383492010-09-16 10:48:29 +02002808 */
Tejun Heo57b30ae2012-08-21 13:18:24 -07002809bool cancel_delayed_work(struct delayed_work *dwork)
Tejun Heo09383492010-09-16 10:48:29 +02002810{
Tejun Heo57b30ae2012-08-21 13:18:24 -07002811 unsigned long flags;
2812 int ret;
2813
2814 do {
2815 ret = try_to_grab_pending(&dwork->work, true, &flags);
2816 } while (unlikely(ret == -EAGAIN));
2817
2818 if (unlikely(ret < 0))
2819 return false;
2820
Tejun Heo7c3eed52013-01-24 11:01:33 -08002821 set_work_pool_and_clear_pending(&dwork->work,
2822 get_work_pool_id(&dwork->work));
Tejun Heo57b30ae2012-08-21 13:18:24 -07002823 local_irq_restore(flags);
Dan Magenheimerc0158ca2012-10-18 16:31:37 -07002824 return ret;
Tejun Heo09383492010-09-16 10:48:29 +02002825}
Tejun Heo57b30ae2012-08-21 13:18:24 -07002826EXPORT_SYMBOL(cancel_delayed_work);
Tejun Heo09383492010-09-16 10:48:29 +02002827
2828/**
Tejun Heo401a8d02010-09-16 10:36:00 +02002829 * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
2830 * @dwork: the delayed work cancel
2831 *
2832 * This is cancel_work_sync() for delayed works.
2833 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002834 * Return:
Tejun Heo401a8d02010-09-16 10:36:00 +02002835 * %true if @dwork was pending, %false otherwise.
2836 */
2837bool cancel_delayed_work_sync(struct delayed_work *dwork)
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002838{
Tejun Heo36e227d2012-08-03 10:30:46 -07002839 return __cancel_work_timer(&dwork->work, true);
Oleg Nesterov6e84d642007-05-09 02:34:46 -07002840}
Oleg Nesterovf5a421a2007-07-15 23:41:44 -07002841EXPORT_SYMBOL(cancel_delayed_work_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002842
Rolf Eike Beer0fcb78c2006-07-30 03:03:42 -07002843/**
Tejun Heo31ddd872010-10-19 11:14:49 +02002844 * schedule_on_each_cpu - execute a function synchronously on each online CPU
Andrew Mortonb6136772006-06-25 05:47:49 -07002845 * @func: the function to call
Andrew Mortonb6136772006-06-25 05:47:49 -07002846 *
Tejun Heo31ddd872010-10-19 11:14:49 +02002847 * schedule_on_each_cpu() executes @func on each online CPU using the
2848 * system workqueue and blocks until all CPUs have completed.
Andrew Mortonb6136772006-06-25 05:47:49 -07002849 * schedule_on_each_cpu() is very slow.
Tejun Heo31ddd872010-10-19 11:14:49 +02002850 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002851 * Return:
Tejun Heo31ddd872010-10-19 11:14:49 +02002852 * 0 on success, -errno on failure.
Andrew Mortonb6136772006-06-25 05:47:49 -07002853 */
David Howells65f27f32006-11-22 14:55:48 +00002854int schedule_on_each_cpu(work_func_t func)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002855{
2856 int cpu;
Namhyung Kim38f51562010-08-08 14:24:09 +02002857 struct work_struct __percpu *works;
Christoph Lameter15316ba2006-01-08 01:00:43 -08002858
Andrew Mortonb6136772006-06-25 05:47:49 -07002859 works = alloc_percpu(struct work_struct);
2860 if (!works)
Christoph Lameter15316ba2006-01-08 01:00:43 -08002861 return -ENOMEM;
Andrew Mortonb6136772006-06-25 05:47:49 -07002862
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002863 get_online_cpus();
Tejun Heo93981802009-11-17 14:06:20 -08002864
Christoph Lameter15316ba2006-01-08 01:00:43 -08002865 for_each_online_cpu(cpu) {
Ingo Molnar9bfb1832006-12-18 20:05:09 +01002866 struct work_struct *work = per_cpu_ptr(works, cpu);
2867
2868 INIT_WORK(work, func);
Tejun Heob71ab8c2010-06-29 10:07:14 +02002869 schedule_work_on(cpu, work);
Andi Kleen65a64462009-10-14 06:22:47 +02002870 }
Tejun Heo93981802009-11-17 14:06:20 -08002871
2872 for_each_online_cpu(cpu)
2873 flush_work(per_cpu_ptr(works, cpu));
2874
Gautham R Shenoy95402b32008-01-25 21:08:02 +01002875 put_online_cpus();
Andrew Mortonb6136772006-06-25 05:47:49 -07002876 free_percpu(works);
Christoph Lameter15316ba2006-01-08 01:00:43 -08002877 return 0;
2878}
2879
Alan Sterneef6a7d2010-02-12 17:39:21 +09002880/**
2881 * flush_scheduled_work - ensure that any scheduled work has run to completion.
2882 *
2883 * Forces execution of the kernel-global workqueue and blocks until its
2884 * completion.
2885 *
2886 * Think twice before calling this function! It's very easy to get into
2887 * trouble if you don't take great care. Either of the following situations
2888 * will lead to deadlock:
2889 *
2890 * One of the work items currently on the workqueue needs to acquire
2891 * a lock held by your code or its caller.
2892 *
2893 * Your code is running in the context of a work routine.
2894 *
2895 * They will be detected by lockdep when they occur, but the first might not
2896 * occur very often. It depends on what work items are on the workqueue and
2897 * what locks they need, which you have no control over.
2898 *
2899 * In most situations flushing the entire workqueue is overkill; you merely
2900 * need to know that a particular work item isn't queued and isn't running.
2901 * In such cases you should use cancel_delayed_work_sync() or
2902 * cancel_work_sync() instead.
2903 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904void flush_scheduled_work(void)
2905{
Tejun Heod320c032010-06-29 10:07:14 +02002906 flush_workqueue(system_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002907}
Dave Jonesae90dd52006-06-30 01:40:45 -04002908EXPORT_SYMBOL(flush_scheduled_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002909
2910/**
James Bottomley1fa44ec2006-02-23 12:43:43 -06002911 * execute_in_process_context - reliably execute the routine with user context
2912 * @fn: the function to execute
James Bottomley1fa44ec2006-02-23 12:43:43 -06002913 * @ew: guaranteed storage for the execute work structure (must
2914 * be available when the work executes)
2915 *
2916 * Executes the function immediately if process context is available,
2917 * otherwise schedules the function for delayed execution.
2918 *
Yacine Belkadid185af32013-07-31 14:59:24 -07002919 * Return: 0 - function was executed
James Bottomley1fa44ec2006-02-23 12:43:43 -06002920 * 1 - function was scheduled for execution
2921 */
David Howells65f27f32006-11-22 14:55:48 +00002922int execute_in_process_context(work_func_t fn, struct execute_work *ew)
James Bottomley1fa44ec2006-02-23 12:43:43 -06002923{
2924 if (!in_interrupt()) {
David Howells65f27f32006-11-22 14:55:48 +00002925 fn(&ew->work);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002926 return 0;
2927 }
2928
David Howells65f27f32006-11-22 14:55:48 +00002929 INIT_WORK(&ew->work, fn);
James Bottomley1fa44ec2006-02-23 12:43:43 -06002930 schedule_work(&ew->work);
2931
2932 return 1;
2933}
2934EXPORT_SYMBOL_GPL(execute_in_process_context);
2935
Tejun Heo226223a2013-03-12 11:30:05 -07002936#ifdef CONFIG_SYSFS
2937/*
2938 * Workqueues with WQ_SYSFS flag set is visible to userland via
2939 * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the
2940 * following attributes.
2941 *
2942 * per_cpu RO bool : whether the workqueue is per-cpu or unbound
2943 * max_active RW int : maximum number of in-flight work items
2944 *
2945 * Unbound workqueues have the following extra attributes.
2946 *
2947 * id RO int : the associated pool ID
2948 * nice RW int : nice value of the workers
2949 * cpumask RW mask : bitmask of allowed CPUs for the workers
2950 */
2951struct wq_device {
2952 struct workqueue_struct *wq;
2953 struct device dev;
2954};
2955
2956static struct workqueue_struct *dev_to_wq(struct device *dev)
2957{
2958 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
2959
2960 return wq_dev->wq;
2961}
2962
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07002963static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr,
2964 char *buf)
Tejun Heo226223a2013-03-12 11:30:05 -07002965{
2966 struct workqueue_struct *wq = dev_to_wq(dev);
2967
2968 return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND));
2969}
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07002970static DEVICE_ATTR_RO(per_cpu);
Tejun Heo226223a2013-03-12 11:30:05 -07002971
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07002972static ssize_t max_active_show(struct device *dev,
2973 struct device_attribute *attr, char *buf)
Tejun Heo226223a2013-03-12 11:30:05 -07002974{
2975 struct workqueue_struct *wq = dev_to_wq(dev);
2976
2977 return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active);
2978}
2979
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07002980static ssize_t max_active_store(struct device *dev,
2981 struct device_attribute *attr, const char *buf,
2982 size_t count)
Tejun Heo226223a2013-03-12 11:30:05 -07002983{
2984 struct workqueue_struct *wq = dev_to_wq(dev);
2985 int val;
2986
2987 if (sscanf(buf, "%d", &val) != 1 || val <= 0)
2988 return -EINVAL;
2989
2990 workqueue_set_max_active(wq, val);
2991 return count;
2992}
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07002993static DEVICE_ATTR_RW(max_active);
Tejun Heo226223a2013-03-12 11:30:05 -07002994
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07002995static struct attribute *wq_sysfs_attrs[] = {
2996 &dev_attr_per_cpu.attr,
2997 &dev_attr_max_active.attr,
2998 NULL,
Tejun Heo226223a2013-03-12 11:30:05 -07002999};
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003000ATTRIBUTE_GROUPS(wq_sysfs);
Tejun Heo226223a2013-03-12 11:30:05 -07003001
Tejun Heod55262c2013-04-01 11:23:38 -07003002static ssize_t wq_pool_ids_show(struct device *dev,
3003 struct device_attribute *attr, char *buf)
Tejun Heo226223a2013-03-12 11:30:05 -07003004{
3005 struct workqueue_struct *wq = dev_to_wq(dev);
Tejun Heod55262c2013-04-01 11:23:38 -07003006 const char *delim = "";
3007 int node, written = 0;
Tejun Heo226223a2013-03-12 11:30:05 -07003008
3009 rcu_read_lock_sched();
Tejun Heod55262c2013-04-01 11:23:38 -07003010 for_each_node(node) {
3011 written += scnprintf(buf + written, PAGE_SIZE - written,
3012 "%s%d:%d", delim, node,
3013 unbound_pwq_by_node(wq, node)->pool->id);
3014 delim = " ";
3015 }
3016 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
Tejun Heo226223a2013-03-12 11:30:05 -07003017 rcu_read_unlock_sched();
3018
3019 return written;
3020}
3021
3022static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr,
3023 char *buf)
3024{
3025 struct workqueue_struct *wq = dev_to_wq(dev);
3026 int written;
3027
Tejun Heo6029a912013-04-01 11:23:34 -07003028 mutex_lock(&wq->mutex);
3029 written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice);
3030 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003031
3032 return written;
3033}
3034
3035/* prepare workqueue_attrs for sysfs store operations */
3036static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq)
3037{
3038 struct workqueue_attrs *attrs;
3039
3040 attrs = alloc_workqueue_attrs(GFP_KERNEL);
3041 if (!attrs)
3042 return NULL;
3043
Tejun Heo6029a912013-04-01 11:23:34 -07003044 mutex_lock(&wq->mutex);
3045 copy_workqueue_attrs(attrs, wq->unbound_attrs);
3046 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003047 return attrs;
3048}
3049
3050static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr,
3051 const char *buf, size_t count)
3052{
3053 struct workqueue_struct *wq = dev_to_wq(dev);
3054 struct workqueue_attrs *attrs;
3055 int ret;
3056
3057 attrs = wq_sysfs_prep_attrs(wq);
3058 if (!attrs)
3059 return -ENOMEM;
3060
3061 if (sscanf(buf, "%d", &attrs->nice) == 1 &&
Dongsheng Yang14481842014-02-11 15:34:52 +08003062 attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE)
Tejun Heo226223a2013-03-12 11:30:05 -07003063 ret = apply_workqueue_attrs(wq, attrs);
3064 else
3065 ret = -EINVAL;
3066
3067 free_workqueue_attrs(attrs);
3068 return ret ?: count;
3069}
3070
3071static ssize_t wq_cpumask_show(struct device *dev,
3072 struct device_attribute *attr, char *buf)
3073{
3074 struct workqueue_struct *wq = dev_to_wq(dev);
3075 int written;
3076
Tejun Heo6029a912013-04-01 11:23:34 -07003077 mutex_lock(&wq->mutex);
3078 written = cpumask_scnprintf(buf, PAGE_SIZE, wq->unbound_attrs->cpumask);
3079 mutex_unlock(&wq->mutex);
Tejun Heo226223a2013-03-12 11:30:05 -07003080
3081 written += scnprintf(buf + written, PAGE_SIZE - written, "\n");
3082 return written;
3083}
3084
3085static ssize_t wq_cpumask_store(struct device *dev,
3086 struct device_attribute *attr,
3087 const char *buf, size_t count)
3088{
3089 struct workqueue_struct *wq = dev_to_wq(dev);
3090 struct workqueue_attrs *attrs;
3091 int ret;
3092
3093 attrs = wq_sysfs_prep_attrs(wq);
3094 if (!attrs)
3095 return -ENOMEM;
3096
3097 ret = cpumask_parse(buf, attrs->cpumask);
3098 if (!ret)
3099 ret = apply_workqueue_attrs(wq, attrs);
3100
3101 free_workqueue_attrs(attrs);
3102 return ret ?: count;
3103}
3104
Tejun Heod55262c2013-04-01 11:23:38 -07003105static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr,
3106 char *buf)
3107{
3108 struct workqueue_struct *wq = dev_to_wq(dev);
3109 int written;
3110
3111 mutex_lock(&wq->mutex);
3112 written = scnprintf(buf, PAGE_SIZE, "%d\n",
3113 !wq->unbound_attrs->no_numa);
3114 mutex_unlock(&wq->mutex);
3115
3116 return written;
3117}
3118
3119static ssize_t wq_numa_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 v, ret;
3125
3126 attrs = wq_sysfs_prep_attrs(wq);
3127 if (!attrs)
3128 return -ENOMEM;
3129
3130 ret = -EINVAL;
3131 if (sscanf(buf, "%d", &v) == 1) {
3132 attrs->no_numa = !v;
3133 ret = apply_workqueue_attrs(wq, attrs);
3134 }
3135
3136 free_workqueue_attrs(attrs);
3137 return ret ?: count;
3138}
3139
Tejun Heo226223a2013-03-12 11:30:05 -07003140static struct device_attribute wq_sysfs_unbound_attrs[] = {
Tejun Heod55262c2013-04-01 11:23:38 -07003141 __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL),
Tejun Heo226223a2013-03-12 11:30:05 -07003142 __ATTR(nice, 0644, wq_nice_show, wq_nice_store),
3143 __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store),
Tejun Heod55262c2013-04-01 11:23:38 -07003144 __ATTR(numa, 0644, wq_numa_show, wq_numa_store),
Tejun Heo226223a2013-03-12 11:30:05 -07003145 __ATTR_NULL,
3146};
3147
3148static struct bus_type wq_subsys = {
3149 .name = "workqueue",
Greg Kroah-Hartman1a6661d2013-08-23 14:24:41 -07003150 .dev_groups = wq_sysfs_groups,
Tejun Heo226223a2013-03-12 11:30:05 -07003151};
3152
3153static int __init wq_sysfs_init(void)
3154{
3155 return subsys_virtual_register(&wq_subsys, NULL);
3156}
3157core_initcall(wq_sysfs_init);
3158
3159static void wq_device_release(struct device *dev)
3160{
3161 struct wq_device *wq_dev = container_of(dev, struct wq_device, dev);
3162
3163 kfree(wq_dev);
3164}
3165
3166/**
3167 * workqueue_sysfs_register - make a workqueue visible in sysfs
3168 * @wq: the workqueue to register
3169 *
3170 * Expose @wq in sysfs under /sys/bus/workqueue/devices.
3171 * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set
3172 * which is the preferred method.
3173 *
3174 * Workqueue user should use this function directly iff it wants to apply
3175 * workqueue_attrs before making the workqueue visible in sysfs; otherwise,
3176 * apply_workqueue_attrs() may race against userland updating the
3177 * attributes.
3178 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003179 * Return: 0 on success, -errno on failure.
Tejun Heo226223a2013-03-12 11:30:05 -07003180 */
3181int workqueue_sysfs_register(struct workqueue_struct *wq)
3182{
3183 struct wq_device *wq_dev;
3184 int ret;
3185
3186 /*
3187 * Adjusting max_active or creating new pwqs by applyting
3188 * attributes breaks ordering guarantee. Disallow exposing ordered
3189 * workqueues.
3190 */
3191 if (WARN_ON(wq->flags & __WQ_ORDERED))
3192 return -EINVAL;
3193
3194 wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL);
3195 if (!wq_dev)
3196 return -ENOMEM;
3197
3198 wq_dev->wq = wq;
3199 wq_dev->dev.bus = &wq_subsys;
3200 wq_dev->dev.init_name = wq->name;
3201 wq_dev->dev.release = wq_device_release;
3202
3203 /*
3204 * unbound_attrs are created separately. Suppress uevent until
3205 * everything is ready.
3206 */
3207 dev_set_uevent_suppress(&wq_dev->dev, true);
3208
3209 ret = device_register(&wq_dev->dev);
3210 if (ret) {
3211 kfree(wq_dev);
3212 wq->wq_dev = NULL;
3213 return ret;
3214 }
3215
3216 if (wq->flags & WQ_UNBOUND) {
3217 struct device_attribute *attr;
3218
3219 for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) {
3220 ret = device_create_file(&wq_dev->dev, attr);
3221 if (ret) {
3222 device_unregister(&wq_dev->dev);
3223 wq->wq_dev = NULL;
3224 return ret;
3225 }
3226 }
3227 }
3228
3229 kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD);
3230 return 0;
3231}
3232
3233/**
3234 * workqueue_sysfs_unregister - undo workqueue_sysfs_register()
3235 * @wq: the workqueue to unregister
3236 *
3237 * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister.
3238 */
3239static void workqueue_sysfs_unregister(struct workqueue_struct *wq)
3240{
3241 struct wq_device *wq_dev = wq->wq_dev;
3242
3243 if (!wq->wq_dev)
3244 return;
3245
3246 wq->wq_dev = NULL;
3247 device_unregister(&wq_dev->dev);
3248}
3249#else /* CONFIG_SYSFS */
3250static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { }
3251#endif /* CONFIG_SYSFS */
3252
Tejun Heo7a4e3442013-03-12 11:30:00 -07003253/**
3254 * free_workqueue_attrs - free a workqueue_attrs
3255 * @attrs: workqueue_attrs to free
3256 *
3257 * Undo alloc_workqueue_attrs().
3258 */
3259void free_workqueue_attrs(struct workqueue_attrs *attrs)
3260{
3261 if (attrs) {
3262 free_cpumask_var(attrs->cpumask);
3263 kfree(attrs);
3264 }
3265}
3266
3267/**
3268 * alloc_workqueue_attrs - allocate a workqueue_attrs
3269 * @gfp_mask: allocation mask to use
3270 *
3271 * Allocate a new workqueue_attrs, initialize with default settings and
Yacine Belkadid185af32013-07-31 14:59:24 -07003272 * return it.
3273 *
3274 * Return: The allocated new workqueue_attr on success. %NULL on failure.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003275 */
3276struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3277{
3278 struct workqueue_attrs *attrs;
3279
3280 attrs = kzalloc(sizeof(*attrs), gfp_mask);
3281 if (!attrs)
3282 goto fail;
3283 if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3284 goto fail;
3285
Tejun Heo13e2e552013-04-01 11:23:31 -07003286 cpumask_copy(attrs->cpumask, cpu_possible_mask);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003287 return attrs;
3288fail:
3289 free_workqueue_attrs(attrs);
3290 return NULL;
3291}
3292
Tejun Heo29c91e92013-03-12 11:30:03 -07003293static void copy_workqueue_attrs(struct workqueue_attrs *to,
3294 const struct workqueue_attrs *from)
3295{
3296 to->nice = from->nice;
3297 cpumask_copy(to->cpumask, from->cpumask);
Shaohua Li2865a8f2013-08-01 09:56:36 +08003298 /*
3299 * Unlike hash and equality test, this function doesn't ignore
3300 * ->no_numa as it is used for both pool and wq attrs. Instead,
3301 * get_unbound_pool() explicitly clears ->no_numa after copying.
3302 */
3303 to->no_numa = from->no_numa;
Tejun Heo29c91e92013-03-12 11:30:03 -07003304}
3305
Tejun Heo29c91e92013-03-12 11:30:03 -07003306/* hash value of the content of @attr */
3307static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3308{
3309 u32 hash = 0;
3310
3311 hash = jhash_1word(attrs->nice, hash);
Tejun Heo13e2e552013-04-01 11:23:31 -07003312 hash = jhash(cpumask_bits(attrs->cpumask),
3313 BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
Tejun Heo29c91e92013-03-12 11:30:03 -07003314 return hash;
3315}
3316
3317/* content equality test */
3318static bool wqattrs_equal(const struct workqueue_attrs *a,
3319 const struct workqueue_attrs *b)
3320{
3321 if (a->nice != b->nice)
3322 return false;
3323 if (!cpumask_equal(a->cpumask, b->cpumask))
3324 return false;
3325 return true;
3326}
3327
Tejun Heo7a4e3442013-03-12 11:30:00 -07003328/**
3329 * init_worker_pool - initialize a newly zalloc'd worker_pool
3330 * @pool: worker_pool to initialize
3331 *
3332 * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs.
Yacine Belkadid185af32013-07-31 14:59:24 -07003333 *
3334 * Return: 0 on success, -errno on failure. Even on failure, all fields
Tejun Heo29c91e92013-03-12 11:30:03 -07003335 * inside @pool proper are initialized and put_unbound_pool() can be called
3336 * on @pool safely to release it.
Tejun Heo7a4e3442013-03-12 11:30:00 -07003337 */
3338static int init_worker_pool(struct worker_pool *pool)
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003339{
3340 spin_lock_init(&pool->lock);
Tejun Heo29c91e92013-03-12 11:30:03 -07003341 pool->id = -1;
3342 pool->cpu = -1;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003343 pool->node = NUMA_NO_NODE;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003344 pool->flags |= POOL_DISASSOCIATED;
3345 INIT_LIST_HEAD(&pool->worklist);
3346 INIT_LIST_HEAD(&pool->idle_list);
3347 hash_init(pool->busy_hash);
3348
3349 init_timer_deferrable(&pool->idle_timer);
3350 pool->idle_timer.function = idle_worker_timeout;
3351 pool->idle_timer.data = (unsigned long)pool;
3352
3353 setup_timer(&pool->mayday_timer, pool_mayday_timeout,
3354 (unsigned long)pool);
3355
3356 mutex_init(&pool->manager_arb);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003357 mutex_init(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003358 INIT_LIST_HEAD(&pool->workers);
Tejun Heo7a4e3442013-03-12 11:30:00 -07003359
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003360 ida_init(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003361 INIT_HLIST_NODE(&pool->hash_node);
3362 pool->refcnt = 1;
3363
3364 /* shouldn't fail above this point */
Tejun Heo7a4e3442013-03-12 11:30:00 -07003365 pool->attrs = alloc_workqueue_attrs(GFP_KERNEL);
3366 if (!pool->attrs)
3367 return -ENOMEM;
3368 return 0;
Tejun Heo4e1a1f92013-03-12 11:30:00 -07003369}
3370
Tejun Heo29c91e92013-03-12 11:30:03 -07003371static void rcu_free_pool(struct rcu_head *rcu)
3372{
3373 struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu);
3374
Lai Jiangshan7cda9aa2014-05-20 17:46:32 +08003375 ida_destroy(&pool->worker_ida);
Tejun Heo29c91e92013-03-12 11:30:03 -07003376 free_workqueue_attrs(pool->attrs);
3377 kfree(pool);
3378}
3379
3380/**
3381 * put_unbound_pool - put a worker_pool
3382 * @pool: worker_pool to put
3383 *
3384 * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003385 * safe manner. get_unbound_pool() calls this function on its failure path
3386 * and this function should be able to release pools which went through,
3387 * successfully or not, init_worker_pool().
Tejun Heoa892cac2013-04-01 11:23:32 -07003388 *
3389 * Should be called with wq_pool_mutex held.
Tejun Heo29c91e92013-03-12 11:30:03 -07003390 */
3391static void put_unbound_pool(struct worker_pool *pool)
3392{
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003393 DECLARE_COMPLETION_ONSTACK(detach_completion);
Tejun Heo29c91e92013-03-12 11:30:03 -07003394 struct worker *worker;
3395
Tejun Heoa892cac2013-04-01 11:23:32 -07003396 lockdep_assert_held(&wq_pool_mutex);
3397
3398 if (--pool->refcnt)
Tejun Heo29c91e92013-03-12 11:30:03 -07003399 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003400
3401 /* sanity checks */
Lai Jiangshan61d0fbb2014-06-03 15:31:45 +08003402 if (WARN_ON(!(pool->cpu < 0)) ||
Tejun Heoa892cac2013-04-01 11:23:32 -07003403 WARN_ON(!list_empty(&pool->worklist)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003404 return;
Tejun Heo29c91e92013-03-12 11:30:03 -07003405
3406 /* release id and unhash */
3407 if (pool->id >= 0)
3408 idr_remove(&worker_pool_idr, pool->id);
3409 hash_del(&pool->hash_node);
3410
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003411 /*
3412 * Become the manager and destroy all workers. Grabbing
3413 * manager_arb prevents @pool's workers from blocking on
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003414 * attach_mutex.
Tejun Heoc5aa87b2013-03-13 16:51:36 -07003415 */
Tejun Heo29c91e92013-03-12 11:30:03 -07003416 mutex_lock(&pool->manager_arb);
Tejun Heo29c91e92013-03-12 11:30:03 -07003417
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003418 spin_lock_irq(&pool->lock);
Lai Jiangshan1037de32014-05-22 16:44:07 +08003419 while ((worker = first_idle_worker(pool)))
Tejun Heo29c91e92013-03-12 11:30:03 -07003420 destroy_worker(worker);
3421 WARN_ON(pool->nr_workers || pool->nr_idle);
Tejun Heo29c91e92013-03-12 11:30:03 -07003422 spin_unlock_irq(&pool->lock);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003423
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003424 mutex_lock(&pool->attach_mutex);
Lai Jiangshanda028462014-05-20 17:46:31 +08003425 if (!list_empty(&pool->workers))
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003426 pool->detach_completion = &detach_completion;
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08003427 mutex_unlock(&pool->attach_mutex);
Lai Jiangshan60f5a4b2014-05-20 17:46:29 +08003428
3429 if (pool->detach_completion)
3430 wait_for_completion(pool->detach_completion);
3431
Tejun Heo29c91e92013-03-12 11:30:03 -07003432 mutex_unlock(&pool->manager_arb);
3433
3434 /* shut down the timers */
3435 del_timer_sync(&pool->idle_timer);
3436 del_timer_sync(&pool->mayday_timer);
3437
3438 /* sched-RCU protected to allow dereferences from get_work_pool() */
3439 call_rcu_sched(&pool->rcu, rcu_free_pool);
3440}
3441
3442/**
3443 * get_unbound_pool - get a worker_pool with the specified attributes
3444 * @attrs: the attributes of the worker_pool to get
3445 *
3446 * Obtain a worker_pool which has the same attributes as @attrs, bump the
3447 * reference count and return it. If there already is a matching
3448 * worker_pool, it will be used; otherwise, this function attempts to
Yacine Belkadid185af32013-07-31 14:59:24 -07003449 * create a new one.
Tejun Heoa892cac2013-04-01 11:23:32 -07003450 *
3451 * Should be called with wq_pool_mutex held.
Yacine Belkadid185af32013-07-31 14:59:24 -07003452 *
3453 * Return: On success, a worker_pool with the same attributes as @attrs.
3454 * On failure, %NULL.
Tejun Heo29c91e92013-03-12 11:30:03 -07003455 */
3456static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs)
3457{
Tejun Heo29c91e92013-03-12 11:30:03 -07003458 u32 hash = wqattrs_hash(attrs);
3459 struct worker_pool *pool;
Tejun Heof3f90ad2013-04-01 11:23:34 -07003460 int node;
Tejun Heo29c91e92013-03-12 11:30:03 -07003461
Tejun Heoa892cac2013-04-01 11:23:32 -07003462 lockdep_assert_held(&wq_pool_mutex);
Tejun Heo29c91e92013-03-12 11:30:03 -07003463
3464 /* do we already have a matching pool? */
Tejun Heo29c91e92013-03-12 11:30:03 -07003465 hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) {
3466 if (wqattrs_equal(pool->attrs, attrs)) {
3467 pool->refcnt++;
3468 goto out_unlock;
3469 }
3470 }
Tejun Heo29c91e92013-03-12 11:30:03 -07003471
3472 /* nope, create a new one */
3473 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
3474 if (!pool || init_worker_pool(pool) < 0)
3475 goto fail;
3476
Tejun Heo8864b4e2013-03-12 11:30:04 -07003477 lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */
Tejun Heo29c91e92013-03-12 11:30:03 -07003478 copy_workqueue_attrs(pool->attrs, attrs);
3479
Shaohua Li2865a8f2013-08-01 09:56:36 +08003480 /*
3481 * no_numa isn't a worker_pool attribute, always clear it. See
3482 * 'struct workqueue_attrs' comments for detail.
3483 */
3484 pool->attrs->no_numa = false;
3485
Tejun Heof3f90ad2013-04-01 11:23:34 -07003486 /* if cpumask is contained inside a NUMA node, we belong to that node */
3487 if (wq_numa_enabled) {
3488 for_each_node(node) {
3489 if (cpumask_subset(pool->attrs->cpumask,
3490 wq_numa_possible_cpumask[node])) {
3491 pool->node = node;
3492 break;
3493 }
3494 }
3495 }
3496
Tejun Heo29c91e92013-03-12 11:30:03 -07003497 if (worker_pool_assign_id(pool) < 0)
3498 goto fail;
3499
3500 /* create and start the initial worker */
Lai Jiangshan051e1852014-07-22 13:03:02 +08003501 if (!create_worker(pool))
Tejun Heo29c91e92013-03-12 11:30:03 -07003502 goto fail;
3503
Tejun Heo29c91e92013-03-12 11:30:03 -07003504 /* install */
Tejun Heo29c91e92013-03-12 11:30:03 -07003505 hash_add(unbound_pool_hash, &pool->hash_node, hash);
3506out_unlock:
Tejun Heo29c91e92013-03-12 11:30:03 -07003507 return pool;
3508fail:
Tejun Heo29c91e92013-03-12 11:30:03 -07003509 if (pool)
3510 put_unbound_pool(pool);
3511 return NULL;
3512}
3513
Tejun Heo8864b4e2013-03-12 11:30:04 -07003514static void rcu_free_pwq(struct rcu_head *rcu)
3515{
3516 kmem_cache_free(pwq_cache,
3517 container_of(rcu, struct pool_workqueue, rcu));
3518}
3519
3520/*
3521 * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt
3522 * and needs to be destroyed.
3523 */
3524static void pwq_unbound_release_workfn(struct work_struct *work)
3525{
3526 struct pool_workqueue *pwq = container_of(work, struct pool_workqueue,
3527 unbound_release_work);
3528 struct workqueue_struct *wq = pwq->wq;
3529 struct worker_pool *pool = pwq->pool;
Tejun Heobc0caf02013-04-01 11:23:31 -07003530 bool is_last;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003531
3532 if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)))
3533 return;
3534
Tejun Heo75ccf592013-03-12 11:30:04 -07003535 /*
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003536 * Unlink @pwq. Synchronization against wq->mutex isn't strictly
Tejun Heo75ccf592013-03-12 11:30:04 -07003537 * necessary on release but do it anyway. It's easier to verify
3538 * and consistent with the linking path.
3539 */
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003540 mutex_lock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003541 list_del_rcu(&pwq->pwqs_node);
Tejun Heobc0caf02013-04-01 11:23:31 -07003542 is_last = list_empty(&wq->pwqs);
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003543 mutex_unlock(&wq->mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003544
Tejun Heoa892cac2013-04-01 11:23:32 -07003545 mutex_lock(&wq_pool_mutex);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003546 put_unbound_pool(pool);
Tejun Heoa892cac2013-04-01 11:23:32 -07003547 mutex_unlock(&wq_pool_mutex);
3548
Tejun Heo8864b4e2013-03-12 11:30:04 -07003549 call_rcu_sched(&pwq->rcu, rcu_free_pwq);
3550
3551 /*
3552 * If we're the last pwq going away, @wq is already dead and no one
3553 * is gonna access it anymore. Free it.
3554 */
Tejun Heo6029a912013-04-01 11:23:34 -07003555 if (is_last) {
3556 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003557 kfree(wq);
Tejun Heo6029a912013-04-01 11:23:34 -07003558 }
Tejun Heo8864b4e2013-03-12 11:30:04 -07003559}
3560
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003561/**
Tejun Heo699ce092013-03-13 16:51:35 -07003562 * pwq_adjust_max_active - update a pwq's max_active to the current setting
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003563 * @pwq: target pool_workqueue
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003564 *
Tejun Heo699ce092013-03-13 16:51:35 -07003565 * If @pwq isn't freezing, set @pwq->max_active to the associated
3566 * workqueue's saved_max_active and activate delayed work items
3567 * accordingly. If @pwq is freezing, clear @pwq->max_active to zero.
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003568 */
Tejun Heo699ce092013-03-13 16:51:35 -07003569static void pwq_adjust_max_active(struct pool_workqueue *pwq)
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003570{
Tejun Heo699ce092013-03-13 16:51:35 -07003571 struct workqueue_struct *wq = pwq->wq;
3572 bool freezable = wq->flags & WQ_FREEZABLE;
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003573
Tejun Heo699ce092013-03-13 16:51:35 -07003574 /* for @wq->saved_max_active */
Lai Jiangshana357fc02013-03-25 16:57:19 -07003575 lockdep_assert_held(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07003576
3577 /* fast exit for non-freezable wqs */
3578 if (!freezable && pwq->max_active == wq->saved_max_active)
3579 return;
3580
Lai Jiangshana357fc02013-03-25 16:57:19 -07003581 spin_lock_irq(&pwq->pool->lock);
Tejun Heo699ce092013-03-13 16:51:35 -07003582
Lai Jiangshan74b414e2014-05-22 19:01:16 +08003583 /*
3584 * During [un]freezing, the caller is responsible for ensuring that
3585 * this function is called at least once after @workqueue_freezing
3586 * is updated and visible.
3587 */
3588 if (!freezable || !workqueue_freezing) {
Tejun Heo699ce092013-03-13 16:51:35 -07003589 pwq->max_active = wq->saved_max_active;
3590
3591 while (!list_empty(&pwq->delayed_works) &&
3592 pwq->nr_active < pwq->max_active)
3593 pwq_activate_first_delayed(pwq);
Lai Jiangshan951a0782013-03-20 10:52:30 -07003594
3595 /*
3596 * Need to kick a worker after thawed or an unbound wq's
3597 * max_active is bumped. It's a slow path. Do it always.
3598 */
3599 wake_up_worker(pwq->pool);
Tejun Heo699ce092013-03-13 16:51:35 -07003600 } else {
3601 pwq->max_active = 0;
3602 }
3603
Lai Jiangshana357fc02013-03-25 16:57:19 -07003604 spin_unlock_irq(&pwq->pool->lock);
Tejun Heo0fbd95a2013-03-13 16:51:35 -07003605}
3606
Tejun Heoe50aba92013-04-01 11:23:35 -07003607/* initialize newly alloced @pwq which is associated with @wq and @pool */
Tejun Heof147f292013-04-01 11:23:35 -07003608static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq,
3609 struct worker_pool *pool)
Tejun Heod2c1d402013-03-12 11:30:04 -07003610{
3611 BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK);
3612
Tejun Heoe50aba92013-04-01 11:23:35 -07003613 memset(pwq, 0, sizeof(*pwq));
3614
Tejun Heod2c1d402013-03-12 11:30:04 -07003615 pwq->pool = pool;
3616 pwq->wq = wq;
3617 pwq->flush_color = -1;
Tejun Heo8864b4e2013-03-12 11:30:04 -07003618 pwq->refcnt = 1;
Tejun Heod2c1d402013-03-12 11:30:04 -07003619 INIT_LIST_HEAD(&pwq->delayed_works);
Tejun Heo1befcf32013-04-01 11:23:35 -07003620 INIT_LIST_HEAD(&pwq->pwqs_node);
Tejun Heod2c1d402013-03-12 11:30:04 -07003621 INIT_LIST_HEAD(&pwq->mayday_node);
Tejun Heo8864b4e2013-03-12 11:30:04 -07003622 INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn);
Tejun Heof147f292013-04-01 11:23:35 -07003623}
Tejun Heod2c1d402013-03-12 11:30:04 -07003624
Tejun Heof147f292013-04-01 11:23:35 -07003625/* sync @pwq with the current state of its associated wq and link it */
Tejun Heo1befcf32013-04-01 11:23:35 -07003626static void link_pwq(struct pool_workqueue *pwq)
Tejun Heof147f292013-04-01 11:23:35 -07003627{
3628 struct workqueue_struct *wq = pwq->wq;
3629
3630 lockdep_assert_held(&wq->mutex);
Tejun Heo75ccf592013-03-12 11:30:04 -07003631
Tejun Heo1befcf32013-04-01 11:23:35 -07003632 /* may be called multiple times, ignore if already linked */
3633 if (!list_empty(&pwq->pwqs_node))
3634 return;
3635
Tejun Heo983ca252013-03-13 16:51:35 -07003636 /*
3637 * Set the matching work_color. This is synchronized with
Lai Jiangshan3c25a552013-03-25 16:57:17 -07003638 * wq->mutex to avoid confusing flush_workqueue().
Tejun Heo983ca252013-03-13 16:51:35 -07003639 */
Tejun Heo75ccf592013-03-12 11:30:04 -07003640 pwq->work_color = wq->work_color;
Tejun Heo983ca252013-03-13 16:51:35 -07003641
3642 /* sync max_active to the current setting */
3643 pwq_adjust_max_active(pwq);
3644
3645 /* link in @pwq */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003646 list_add_rcu(&pwq->pwqs_node, &wq->pwqs);
Tejun Heof147f292013-04-01 11:23:35 -07003647}
Lai Jiangshana357fc02013-03-25 16:57:19 -07003648
Tejun Heof147f292013-04-01 11:23:35 -07003649/* obtain a pool matching @attr and create a pwq associating the pool and @wq */
3650static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq,
3651 const struct workqueue_attrs *attrs)
3652{
3653 struct worker_pool *pool;
3654 struct pool_workqueue *pwq;
3655
3656 lockdep_assert_held(&wq_pool_mutex);
3657
3658 pool = get_unbound_pool(attrs);
3659 if (!pool)
3660 return NULL;
3661
Tejun Heoe50aba92013-04-01 11:23:35 -07003662 pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node);
Tejun Heof147f292013-04-01 11:23:35 -07003663 if (!pwq) {
3664 put_unbound_pool(pool);
3665 return NULL;
Tejun Heodf2d5ae2013-04-01 11:23:35 -07003666 }
Tejun Heo6029a912013-04-01 11:23:34 -07003667
Tejun Heof147f292013-04-01 11:23:35 -07003668 init_pwq(pwq, wq, pool);
3669 return pwq;
Tejun Heod2c1d402013-03-12 11:30:04 -07003670}
3671
Tejun Heo4c16bd32013-04-01 11:23:36 -07003672/* undo alloc_unbound_pwq(), used only in the error path */
3673static void free_unbound_pwq(struct pool_workqueue *pwq)
3674{
3675 lockdep_assert_held(&wq_pool_mutex);
3676
3677 if (pwq) {
3678 put_unbound_pool(pwq->pool);
Wei Yongjuncece95d2013-04-09 14:29:11 +08003679 kmem_cache_free(pwq_cache, pwq);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003680 }
3681}
3682
3683/**
3684 * wq_calc_node_mask - calculate a wq_attrs' cpumask for the specified node
3685 * @attrs: the wq_attrs of interest
3686 * @node: the target NUMA node
3687 * @cpu_going_down: if >= 0, the CPU to consider as offline
3688 * @cpumask: outarg, the resulting cpumask
3689 *
3690 * Calculate the cpumask a workqueue with @attrs should use on @node. If
3691 * @cpu_going_down is >= 0, that cpu is considered offline during
Yacine Belkadid185af32013-07-31 14:59:24 -07003692 * calculation. The result is stored in @cpumask.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003693 *
3694 * If NUMA affinity is not enabled, @attrs->cpumask is always used. If
3695 * enabled and @node has online CPUs requested by @attrs, the returned
3696 * cpumask is the intersection of the possible CPUs of @node and
3697 * @attrs->cpumask.
3698 *
3699 * The caller is responsible for ensuring that the cpumask of @node stays
3700 * stable.
Yacine Belkadid185af32013-07-31 14:59:24 -07003701 *
3702 * Return: %true if the resulting @cpumask is different from @attrs->cpumask,
3703 * %false if equal.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003704 */
3705static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node,
3706 int cpu_going_down, cpumask_t *cpumask)
3707{
Tejun Heod55262c2013-04-01 11:23:38 -07003708 if (!wq_numa_enabled || attrs->no_numa)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003709 goto use_dfl;
3710
3711 /* does @node have any online CPUs @attrs wants? */
3712 cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask);
3713 if (cpu_going_down >= 0)
3714 cpumask_clear_cpu(cpu_going_down, cpumask);
3715
3716 if (cpumask_empty(cpumask))
3717 goto use_dfl;
3718
3719 /* yeap, return possible CPUs in @node that @attrs wants */
3720 cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]);
3721 return !cpumask_equal(cpumask, attrs->cpumask);
3722
3723use_dfl:
3724 cpumask_copy(cpumask, attrs->cpumask);
3725 return false;
3726}
3727
Tejun Heo1befcf32013-04-01 11:23:35 -07003728/* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */
3729static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq,
3730 int node,
3731 struct pool_workqueue *pwq)
3732{
3733 struct pool_workqueue *old_pwq;
3734
3735 lockdep_assert_held(&wq->mutex);
3736
3737 /* link_pwq() can handle duplicate calls */
3738 link_pwq(pwq);
3739
3740 old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
3741 rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq);
3742 return old_pwq;
3743}
3744
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003745/**
3746 * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue
3747 * @wq: the target workqueue
3748 * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs()
3749 *
Tejun Heo4c16bd32013-04-01 11:23:36 -07003750 * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA
3751 * machines, this function maps a separate pwq to each NUMA node with
3752 * possibles CPUs in @attrs->cpumask so that work items are affine to the
3753 * NUMA node it was issued on. Older pwqs are released as in-flight work
3754 * items finish. Note that a work item which repeatedly requeues itself
3755 * back-to-back will stay on its current pwq.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003756 *
Yacine Belkadid185af32013-07-31 14:59:24 -07003757 * Performs GFP_KERNEL allocations.
3758 *
3759 * Return: 0 on success and -errno on failure.
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003760 */
3761int apply_workqueue_attrs(struct workqueue_struct *wq,
3762 const struct workqueue_attrs *attrs)
3763{
Tejun Heo4c16bd32013-04-01 11:23:36 -07003764 struct workqueue_attrs *new_attrs, *tmp_attrs;
3765 struct pool_workqueue **pwq_tbl, *dfl_pwq;
Tejun Heof147f292013-04-01 11:23:35 -07003766 int node, ret;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003767
Tejun Heo8719dce2013-03-12 11:30:04 -07003768 /* only unbound workqueues can change attributes */
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003769 if (WARN_ON(!(wq->flags & WQ_UNBOUND)))
3770 return -EINVAL;
3771
Tejun Heo8719dce2013-03-12 11:30:04 -07003772 /* creating multiple pwqs breaks ordering guarantee */
3773 if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)))
3774 return -EINVAL;
3775
Tejun Heo4c16bd32013-04-01 11:23:36 -07003776 pwq_tbl = kzalloc(wq_numa_tbl_len * sizeof(pwq_tbl[0]), GFP_KERNEL);
Tejun Heo13e2e552013-04-01 11:23:31 -07003777 new_attrs = alloc_workqueue_attrs(GFP_KERNEL);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003778 tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL);
3779 if (!pwq_tbl || !new_attrs || !tmp_attrs)
Tejun Heo13e2e552013-04-01 11:23:31 -07003780 goto enomem;
3781
Tejun Heo4c16bd32013-04-01 11:23:36 -07003782 /* make a copy of @attrs and sanitize it */
Tejun Heo13e2e552013-04-01 11:23:31 -07003783 copy_workqueue_attrs(new_attrs, attrs);
3784 cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask);
3785
Tejun Heo4c16bd32013-04-01 11:23:36 -07003786 /*
3787 * We may create multiple pwqs with differing cpumasks. Make a
3788 * copy of @new_attrs which will be modified and used to obtain
3789 * pools.
3790 */
3791 copy_workqueue_attrs(tmp_attrs, new_attrs);
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003792
Tejun Heo4c16bd32013-04-01 11:23:36 -07003793 /*
3794 * CPUs should stay stable across pwq creations and installations.
3795 * Pin CPUs, determine the target cpumask for each node and create
3796 * pwqs accordingly.
3797 */
3798 get_online_cpus();
3799
3800 mutex_lock(&wq_pool_mutex);
3801
3802 /*
3803 * If something goes wrong during CPU up/down, we'll fall back to
3804 * the default pwq covering whole @attrs->cpumask. Always create
3805 * it even if we don't use it immediately.
3806 */
3807 dfl_pwq = alloc_unbound_pwq(wq, new_attrs);
3808 if (!dfl_pwq)
3809 goto enomem_pwq;
3810
3811 for_each_node(node) {
3812 if (wq_calc_node_cpumask(attrs, node, -1, tmp_attrs->cpumask)) {
3813 pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs);
3814 if (!pwq_tbl[node])
3815 goto enomem_pwq;
3816 } else {
3817 dfl_pwq->refcnt++;
3818 pwq_tbl[node] = dfl_pwq;
3819 }
3820 }
3821
3822 mutex_unlock(&wq_pool_mutex);
3823
3824 /* all pwqs have been created successfully, let's install'em */
Tejun Heof147f292013-04-01 11:23:35 -07003825 mutex_lock(&wq->mutex);
3826
Tejun Heof147f292013-04-01 11:23:35 -07003827 copy_workqueue_attrs(wq->unbound_attrs, new_attrs);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003828
3829 /* save the previous pwq and install the new one */
Tejun Heof147f292013-04-01 11:23:35 -07003830 for_each_node(node)
Tejun Heo4c16bd32013-04-01 11:23:36 -07003831 pwq_tbl[node] = numa_pwq_tbl_install(wq, node, pwq_tbl[node]);
3832
3833 /* @dfl_pwq might not have been used, ensure it's linked */
3834 link_pwq(dfl_pwq);
3835 swap(wq->dfl_pwq, dfl_pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003836
3837 mutex_unlock(&wq->mutex);
3838
Tejun Heo4c16bd32013-04-01 11:23:36 -07003839 /* put the old pwqs */
3840 for_each_node(node)
3841 put_pwq_unlocked(pwq_tbl[node]);
3842 put_pwq_unlocked(dfl_pwq);
3843
3844 put_online_cpus();
Tejun Heo48621252013-04-01 11:23:31 -07003845 ret = 0;
3846 /* fall through */
3847out_free:
Tejun Heo4c16bd32013-04-01 11:23:36 -07003848 free_workqueue_attrs(tmp_attrs);
Tejun Heo48621252013-04-01 11:23:31 -07003849 free_workqueue_attrs(new_attrs);
Tejun Heo4c16bd32013-04-01 11:23:36 -07003850 kfree(pwq_tbl);
Tejun Heo48621252013-04-01 11:23:31 -07003851 return ret;
Tejun Heo13e2e552013-04-01 11:23:31 -07003852
Tejun Heo4c16bd32013-04-01 11:23:36 -07003853enomem_pwq:
3854 free_unbound_pwq(dfl_pwq);
3855 for_each_node(node)
3856 if (pwq_tbl && pwq_tbl[node] != dfl_pwq)
3857 free_unbound_pwq(pwq_tbl[node]);
3858 mutex_unlock(&wq_pool_mutex);
3859 put_online_cpus();
Tejun Heo13e2e552013-04-01 11:23:31 -07003860enomem:
Tejun Heo48621252013-04-01 11:23:31 -07003861 ret = -ENOMEM;
3862 goto out_free;
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003863}
3864
Tejun Heo4c16bd32013-04-01 11:23:36 -07003865/**
3866 * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug
3867 * @wq: the target workqueue
3868 * @cpu: the CPU coming up or going down
3869 * @online: whether @cpu is coming up or going down
3870 *
3871 * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and
3872 * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of
3873 * @wq accordingly.
3874 *
3875 * If NUMA affinity can't be adjusted due to memory allocation failure, it
3876 * falls back to @wq->dfl_pwq which may not be optimal but is always
3877 * correct.
3878 *
3879 * Note that when the last allowed CPU of a NUMA node goes offline for a
3880 * workqueue with a cpumask spanning multiple nodes, the workers which were
3881 * already executing the work items for the workqueue will lose their CPU
3882 * affinity and may execute on any CPU. This is similar to how per-cpu
3883 * workqueues behave on CPU_DOWN. If a workqueue user wants strict
3884 * affinity, it's the user's responsibility to flush the work item from
3885 * CPU_DOWN_PREPARE.
3886 */
3887static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu,
3888 bool online)
3889{
3890 int node = cpu_to_node(cpu);
3891 int cpu_off = online ? -1 : cpu;
3892 struct pool_workqueue *old_pwq = NULL, *pwq;
3893 struct workqueue_attrs *target_attrs;
3894 cpumask_t *cpumask;
3895
3896 lockdep_assert_held(&wq_pool_mutex);
3897
3898 if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND))
3899 return;
3900
3901 /*
3902 * We don't wanna alloc/free wq_attrs for each wq for each CPU.
3903 * Let's use a preallocated one. The following buf is protected by
3904 * CPU hotplug exclusion.
3905 */
3906 target_attrs = wq_update_unbound_numa_attrs_buf;
3907 cpumask = target_attrs->cpumask;
3908
3909 mutex_lock(&wq->mutex);
Tejun Heod55262c2013-04-01 11:23:38 -07003910 if (wq->unbound_attrs->no_numa)
3911 goto out_unlock;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003912
3913 copy_workqueue_attrs(target_attrs, wq->unbound_attrs);
3914 pwq = unbound_pwq_by_node(wq, node);
3915
3916 /*
3917 * Let's determine what needs to be done. If the target cpumask is
3918 * different from wq's, we need to compare it to @pwq's and create
3919 * a new one if they don't match. If the target cpumask equals
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003920 * wq's, the default pwq should be used.
Tejun Heo4c16bd32013-04-01 11:23:36 -07003921 */
3922 if (wq_calc_node_cpumask(wq->unbound_attrs, node, cpu_off, cpumask)) {
3923 if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask))
3924 goto out_unlock;
3925 } else {
Daeseok Youn534a3fb2014-04-18 09:08:14 +09003926 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003927 }
3928
3929 mutex_unlock(&wq->mutex);
3930
3931 /* create a new pwq */
3932 pwq = alloc_unbound_pwq(wq, target_attrs);
3933 if (!pwq) {
Fabian Frederick2d916032014-05-12 13:59:35 -04003934 pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n",
3935 wq->name);
Daeseok Youn77f300b2014-04-16 14:32:29 +09003936 mutex_lock(&wq->mutex);
3937 goto use_dfl_pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07003938 }
3939
3940 /*
3941 * Install the new pwq. As this function is called only from CPU
3942 * hotplug callbacks and applying a new attrs is wrapped with
3943 * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed
3944 * inbetween.
3945 */
3946 mutex_lock(&wq->mutex);
3947 old_pwq = numa_pwq_tbl_install(wq, node, pwq);
3948 goto out_unlock;
3949
3950use_dfl_pwq:
3951 spin_lock_irq(&wq->dfl_pwq->pool->lock);
3952 get_pwq(wq->dfl_pwq);
3953 spin_unlock_irq(&wq->dfl_pwq->pool->lock);
3954 old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq);
3955out_unlock:
3956 mutex_unlock(&wq->mutex);
3957 put_pwq_unlocked(old_pwq);
3958}
3959
Tejun Heo30cdf242013-03-12 11:29:57 -07003960static int alloc_and_link_pwqs(struct workqueue_struct *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003961{
Tejun Heo49e3cf42013-03-12 11:29:58 -07003962 bool highpri = wq->flags & WQ_HIGHPRI;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003963 int cpu, ret;
Frederic Weisbeckere1d8aa92009-01-12 23:15:46 +01003964
Tejun Heo30cdf242013-03-12 11:29:57 -07003965 if (!(wq->flags & WQ_UNBOUND)) {
Tejun Heo420c0dd2013-03-12 11:29:59 -07003966 wq->cpu_pwqs = alloc_percpu(struct pool_workqueue);
3967 if (!wq->cpu_pwqs)
Tejun Heo30cdf242013-03-12 11:29:57 -07003968 return -ENOMEM;
3969
3970 for_each_possible_cpu(cpu) {
Tejun Heo7fb98ea2013-03-12 11:30:00 -07003971 struct pool_workqueue *pwq =
3972 per_cpu_ptr(wq->cpu_pwqs, cpu);
Tejun Heo7a62c2c2013-03-12 11:30:03 -07003973 struct worker_pool *cpu_pools =
Tejun Heof02ae732013-03-12 11:30:03 -07003974 per_cpu(cpu_worker_pools, cpu);
Tejun Heo30cdf242013-03-12 11:29:57 -07003975
Tejun Heof147f292013-04-01 11:23:35 -07003976 init_pwq(pwq, wq, &cpu_pools[highpri]);
3977
3978 mutex_lock(&wq->mutex);
Tejun Heo1befcf32013-04-01 11:23:35 -07003979 link_pwq(pwq);
Tejun Heof147f292013-04-01 11:23:35 -07003980 mutex_unlock(&wq->mutex);
Tejun Heo30cdf242013-03-12 11:29:57 -07003981 }
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003982 return 0;
Tejun Heo8a2b7532013-09-05 12:30:04 -04003983 } else if (wq->flags & __WQ_ORDERED) {
3984 ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]);
3985 /* there should only be single pwq for ordering guarantee */
3986 WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node ||
3987 wq->pwqs.prev != &wq->dfl_pwq->pwqs_node),
3988 "ordering guarantee broken for workqueue %s\n", wq->name);
3989 return ret;
Tejun Heo30cdf242013-03-12 11:29:57 -07003990 } else {
Tejun Heo9e8cd2f2013-03-12 11:30:04 -07003991 return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]);
Tejun Heo30cdf242013-03-12 11:29:57 -07003992 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07003993}
3994
Tejun Heof3421792010-07-02 10:03:51 +02003995static int wq_clamp_max_active(int max_active, unsigned int flags,
3996 const char *name)
Tejun Heob71ab8c2010-06-29 10:07:14 +02003997{
Tejun Heof3421792010-07-02 10:03:51 +02003998 int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE;
3999
4000 if (max_active < 1 || max_active > lim)
Valentin Ilie044c7822012-08-19 00:52:42 +03004001 pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n",
4002 max_active, name, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004003
Tejun Heof3421792010-07-02 10:03:51 +02004004 return clamp_val(max_active, 1, lim);
Tejun Heob71ab8c2010-06-29 10:07:14 +02004005}
4006
Tejun Heob196be82012-01-10 15:11:35 -08004007struct workqueue_struct *__alloc_workqueue_key(const char *fmt,
Tejun Heod320c032010-06-29 10:07:14 +02004008 unsigned int flags,
4009 int max_active,
4010 struct lock_class_key *key,
Tejun Heob196be82012-01-10 15:11:35 -08004011 const char *lock_name, ...)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004012{
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004013 size_t tbl_size = 0;
Tejun Heoecf68812013-04-01 11:23:34 -07004014 va_list args;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004015 struct workqueue_struct *wq;
Tejun Heo49e3cf42013-03-12 11:29:58 -07004016 struct pool_workqueue *pwq;
Tejun Heob196be82012-01-10 15:11:35 -08004017
Viresh Kumarcee22a12013-04-08 16:45:40 +05304018 /* see the comment above the definition of WQ_POWER_EFFICIENT */
4019 if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient)
4020 flags |= WQ_UNBOUND;
4021
Tejun Heoecf68812013-04-01 11:23:34 -07004022 /* allocate wq and format name */
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004023 if (flags & WQ_UNBOUND)
4024 tbl_size = wq_numa_tbl_len * sizeof(wq->numa_pwq_tbl[0]);
4025
4026 wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL);
Tejun Heob196be82012-01-10 15:11:35 -08004027 if (!wq)
Tejun Heod2c1d402013-03-12 11:30:04 -07004028 return NULL;
Tejun Heob196be82012-01-10 15:11:35 -08004029
Tejun Heo6029a912013-04-01 11:23:34 -07004030 if (flags & WQ_UNBOUND) {
4031 wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL);
4032 if (!wq->unbound_attrs)
4033 goto err_free_wq;
4034 }
4035
Tejun Heoecf68812013-04-01 11:23:34 -07004036 va_start(args, lock_name);
4037 vsnprintf(wq->name, sizeof(wq->name), fmt, args);
Tejun Heob196be82012-01-10 15:11:35 -08004038 va_end(args);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004039
Tejun Heod320c032010-06-29 10:07:14 +02004040 max_active = max_active ?: WQ_DFL_ACTIVE;
Tejun Heob196be82012-01-10 15:11:35 -08004041 max_active = wq_clamp_max_active(max_active, flags, wq->name);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004042
Tejun Heob196be82012-01-10 15:11:35 -08004043 /* init wq */
Tejun Heo97e37d72010-06-29 10:07:10 +02004044 wq->flags = flags;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004045 wq->saved_max_active = max_active;
Lai Jiangshan3c25a552013-03-25 16:57:17 -07004046 mutex_init(&wq->mutex);
Tejun Heo112202d2013-02-13 19:29:12 -08004047 atomic_set(&wq->nr_pwqs_to_flush, 0);
Tejun Heo30cdf242013-03-12 11:29:57 -07004048 INIT_LIST_HEAD(&wq->pwqs);
Tejun Heo73f53c42010-06-29 10:07:11 +02004049 INIT_LIST_HEAD(&wq->flusher_queue);
4050 INIT_LIST_HEAD(&wq->flusher_overflow);
Tejun Heo493a1722013-03-12 11:29:59 -07004051 INIT_LIST_HEAD(&wq->maydays);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004052
Johannes Bergeb13ba82008-01-16 09:51:58 +01004053 lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);
Oleg Nesterovcce1a162007-05-09 02:34:13 -07004054 INIT_LIST_HEAD(&wq->list);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004055
Tejun Heo30cdf242013-03-12 11:29:57 -07004056 if (alloc_and_link_pwqs(wq) < 0)
Tejun Heod2c1d402013-03-12 11:30:04 -07004057 goto err_free_wq;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004058
Tejun Heo493008a2013-03-12 11:30:03 -07004059 /*
4060 * Workqueues which may be used during memory reclaim should
4061 * have a rescuer to guarantee forward progress.
4062 */
4063 if (flags & WQ_MEM_RECLAIM) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004064 struct worker *rescuer;
4065
Lai Jiangshanf7537df2014-07-15 17:24:15 +08004066 rescuer = alloc_worker(NUMA_NO_NODE);
Tejun Heoe22bee72010-06-29 10:07:14 +02004067 if (!rescuer)
Tejun Heod2c1d402013-03-12 11:30:04 -07004068 goto err_destroy;
Tejun Heoe22bee72010-06-29 10:07:14 +02004069
Tejun Heo111c2252013-01-17 17:16:24 -08004070 rescuer->rescue_wq = wq;
4071 rescuer->task = kthread_create(rescuer_thread, rescuer, "%s",
Tejun Heob196be82012-01-10 15:11:35 -08004072 wq->name);
Tejun Heod2c1d402013-03-12 11:30:04 -07004073 if (IS_ERR(rescuer->task)) {
4074 kfree(rescuer);
4075 goto err_destroy;
4076 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004077
Tejun Heod2c1d402013-03-12 11:30:04 -07004078 wq->rescuer = rescuer;
Tejun Heo14a40ff2013-03-19 13:45:20 -07004079 rescuer->task->flags |= PF_NO_SETAFFINITY;
Tejun Heoe22bee72010-06-29 10:07:14 +02004080 wake_up_process(rescuer->task);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004081 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004082
Tejun Heo226223a2013-03-12 11:30:05 -07004083 if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq))
4084 goto err_destroy;
4085
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004086 /*
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004087 * wq_pool_mutex protects global freeze state and workqueues list.
4088 * Grab it, adjust max_active and add the new @wq to workqueues
4089 * list.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004090 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004091 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004092
Lai Jiangshana357fc02013-03-25 16:57:19 -07004093 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004094 for_each_pwq(pwq, wq)
4095 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004096 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004097
Tejun Heo15376632010-06-29 10:07:11 +02004098 list_add(&wq->list, &workqueues);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004099
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004100 mutex_unlock(&wq_pool_mutex);
Tejun Heo15376632010-06-29 10:07:11 +02004101
Oleg Nesterov3af244332007-05-09 02:34:09 -07004102 return wq;
Tejun Heod2c1d402013-03-12 11:30:04 -07004103
4104err_free_wq:
Tejun Heo6029a912013-04-01 11:23:34 -07004105 free_workqueue_attrs(wq->unbound_attrs);
Tejun Heod2c1d402013-03-12 11:30:04 -07004106 kfree(wq);
4107 return NULL;
4108err_destroy:
4109 destroy_workqueue(wq);
Tejun Heo4690c4a2010-06-29 10:07:10 +02004110 return NULL;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004111}
Tejun Heod320c032010-06-29 10:07:14 +02004112EXPORT_SYMBOL_GPL(__alloc_workqueue_key);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004113
4114/**
4115 * destroy_workqueue - safely terminate a workqueue
4116 * @wq: target workqueue
4117 *
4118 * Safely destroy a workqueue. All work currently pending will be done first.
4119 */
4120void destroy_workqueue(struct workqueue_struct *wq)
4121{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004122 struct pool_workqueue *pwq;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004123 int node;
Oleg Nesterov3af244332007-05-09 02:34:09 -07004124
Tejun Heo9c5a2ba2011-04-05 18:01:44 +02004125 /* drain it before proceeding with destruction */
4126 drain_workqueue(wq);
Tejun Heoc8efcc22010-12-20 19:32:04 +01004127
Tejun Heo6183c002013-03-12 11:29:57 -07004128 /* sanity checks */
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004129 mutex_lock(&wq->mutex);
Tejun Heo49e3cf42013-03-12 11:29:58 -07004130 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004131 int i;
4132
Tejun Heo76af4d92013-03-12 11:30:00 -07004133 for (i = 0; i < WORK_NR_COLORS; i++) {
4134 if (WARN_ON(pwq->nr_in_flight[i])) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004135 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004136 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004137 }
4138 }
4139
Lai Jiangshan5c529592013-04-04 10:05:38 +08004140 if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) ||
Tejun Heo8864b4e2013-03-12 11:30:04 -07004141 WARN_ON(pwq->nr_active) ||
Tejun Heo76af4d92013-03-12 11:30:00 -07004142 WARN_ON(!list_empty(&pwq->delayed_works))) {
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004143 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004144 return;
Tejun Heo76af4d92013-03-12 11:30:00 -07004145 }
Tejun Heo6183c002013-03-12 11:29:57 -07004146 }
Lai Jiangshanb09f4fd2013-03-25 16:57:18 -07004147 mutex_unlock(&wq->mutex);
Tejun Heo6183c002013-03-12 11:29:57 -07004148
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004149 /*
4150 * wq list is used to freeze wq, remove from list after
4151 * flushing is complete in case freeze races us.
4152 */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004153 mutex_lock(&wq_pool_mutex);
Tejun Heod2c1d402013-03-12 11:30:04 -07004154 list_del_init(&wq->list);
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004155 mutex_unlock(&wq_pool_mutex);
Oleg Nesterov3af244332007-05-09 02:34:09 -07004156
Tejun Heo226223a2013-03-12 11:30:05 -07004157 workqueue_sysfs_unregister(wq);
4158
Tejun Heo493008a2013-03-12 11:30:03 -07004159 if (wq->rescuer) {
Tejun Heoe22bee72010-06-29 10:07:14 +02004160 kthread_stop(wq->rescuer->task);
Xiaotian Feng8d9df9f2010-08-16 09:54:28 +02004161 kfree(wq->rescuer);
Tejun Heo493008a2013-03-12 11:30:03 -07004162 wq->rescuer = NULL;
Tejun Heoe22bee72010-06-29 10:07:14 +02004163 }
4164
Tejun Heo8864b4e2013-03-12 11:30:04 -07004165 if (!(wq->flags & WQ_UNBOUND)) {
4166 /*
4167 * The base ref is never dropped on per-cpu pwqs. Directly
4168 * free the pwqs and wq.
4169 */
4170 free_percpu(wq->cpu_pwqs);
4171 kfree(wq);
4172 } else {
4173 /*
4174 * We're the sole accessor of @wq at this point. Directly
Tejun Heo4c16bd32013-04-01 11:23:36 -07004175 * access numa_pwq_tbl[] and dfl_pwq to put the base refs.
4176 * @wq will be freed when the last pwq is released.
Tejun Heo8864b4e2013-03-12 11:30:04 -07004177 */
Tejun Heo4c16bd32013-04-01 11:23:36 -07004178 for_each_node(node) {
4179 pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]);
4180 RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL);
4181 put_pwq_unlocked(pwq);
4182 }
4183
4184 /*
4185 * Put dfl_pwq. @wq may be freed any time after dfl_pwq is
4186 * put. Don't access it afterwards.
4187 */
4188 pwq = wq->dfl_pwq;
4189 wq->dfl_pwq = NULL;
Tejun Heodce90d42013-04-01 11:23:35 -07004190 put_pwq_unlocked(pwq);
Tejun Heo29c91e92013-03-12 11:30:03 -07004191 }
Oleg Nesterov3af244332007-05-09 02:34:09 -07004192}
4193EXPORT_SYMBOL_GPL(destroy_workqueue);
4194
Tejun Heodcd989c2010-06-29 10:07:14 +02004195/**
4196 * workqueue_set_max_active - adjust max_active of a workqueue
4197 * @wq: target workqueue
4198 * @max_active: new max_active value.
4199 *
4200 * Set max_active of @wq to @max_active.
4201 *
4202 * CONTEXT:
4203 * Don't call from IRQ context.
4204 */
4205void workqueue_set_max_active(struct workqueue_struct *wq, int max_active)
4206{
Tejun Heo49e3cf42013-03-12 11:29:58 -07004207 struct pool_workqueue *pwq;
Tejun Heodcd989c2010-06-29 10:07:14 +02004208
Tejun Heo8719dce2013-03-12 11:30:04 -07004209 /* disallow meddling with max_active for ordered workqueues */
4210 if (WARN_ON(wq->flags & __WQ_ORDERED))
4211 return;
4212
Tejun Heof3421792010-07-02 10:03:51 +02004213 max_active = wq_clamp_max_active(max_active, wq->flags, wq->name);
Tejun Heodcd989c2010-06-29 10:07:14 +02004214
Lai Jiangshana357fc02013-03-25 16:57:19 -07004215 mutex_lock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004216
4217 wq->saved_max_active = max_active;
4218
Tejun Heo699ce092013-03-13 16:51:35 -07004219 for_each_pwq(pwq, wq)
4220 pwq_adjust_max_active(pwq);
Tejun Heodcd989c2010-06-29 10:07:14 +02004221
Lai Jiangshana357fc02013-03-25 16:57:19 -07004222 mutex_unlock(&wq->mutex);
Tejun Heodcd989c2010-06-29 10:07:14 +02004223}
4224EXPORT_SYMBOL_GPL(workqueue_set_max_active);
4225
4226/**
Tejun Heoe6267612013-03-12 17:41:37 -07004227 * current_is_workqueue_rescuer - is %current workqueue rescuer?
4228 *
4229 * Determine whether %current is a workqueue rescuer. Can be used from
4230 * work functions to determine whether it's being run off the rescuer task.
Yacine Belkadid185af32013-07-31 14:59:24 -07004231 *
4232 * Return: %true if %current is a workqueue rescuer. %false otherwise.
Tejun Heoe6267612013-03-12 17:41:37 -07004233 */
4234bool current_is_workqueue_rescuer(void)
4235{
4236 struct worker *worker = current_wq_worker();
4237
Lai Jiangshan6a092df2013-03-20 03:28:03 +08004238 return worker && worker->rescue_wq;
Tejun Heoe6267612013-03-12 17:41:37 -07004239}
4240
4241/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004242 * workqueue_congested - test whether a workqueue is congested
4243 * @cpu: CPU in question
4244 * @wq: target workqueue
4245 *
4246 * Test whether @wq's cpu workqueue for @cpu is congested. There is
4247 * no synchronization around this function and the test result is
4248 * unreliable and only useful as advisory hints or for debugging.
4249 *
Tejun Heod3251852013-05-10 11:10:17 -07004250 * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU.
4251 * Note that both per-cpu and unbound workqueues may be associated with
4252 * multiple pool_workqueues which have separate congested states. A
4253 * workqueue being congested on one CPU doesn't mean the workqueue is also
4254 * contested on other CPUs / NUMA nodes.
4255 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004256 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004257 * %true if congested, %false otherwise.
4258 */
Tejun Heod84ff052013-03-12 11:29:59 -07004259bool workqueue_congested(int cpu, struct workqueue_struct *wq)
Tejun Heodcd989c2010-06-29 10:07:14 +02004260{
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004261 struct pool_workqueue *pwq;
Tejun Heo76af4d92013-03-12 11:30:00 -07004262 bool ret;
4263
Lai Jiangshan88109452013-03-20 03:28:10 +08004264 rcu_read_lock_sched();
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004265
Tejun Heod3251852013-05-10 11:10:17 -07004266 if (cpu == WORK_CPU_UNBOUND)
4267 cpu = smp_processor_id();
4268
Tejun Heo7fb98ea2013-03-12 11:30:00 -07004269 if (!(wq->flags & WQ_UNBOUND))
4270 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
4271 else
Tejun Heodf2d5ae2013-04-01 11:23:35 -07004272 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
Tejun Heodcd989c2010-06-29 10:07:14 +02004273
Tejun Heo76af4d92013-03-12 11:30:00 -07004274 ret = !list_empty(&pwq->delayed_works);
Lai Jiangshan88109452013-03-20 03:28:10 +08004275 rcu_read_unlock_sched();
Tejun Heo76af4d92013-03-12 11:30:00 -07004276
4277 return ret;
Tejun Heodcd989c2010-06-29 10:07:14 +02004278}
4279EXPORT_SYMBOL_GPL(workqueue_congested);
4280
4281/**
Tejun Heodcd989c2010-06-29 10:07:14 +02004282 * work_busy - test whether a work is currently pending or running
4283 * @work: the work to be tested
4284 *
4285 * Test whether @work is currently pending or running. There is no
4286 * synchronization around this function and the test result is
4287 * unreliable and only useful as advisory hints or for debugging.
Tejun Heodcd989c2010-06-29 10:07:14 +02004288 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004289 * Return:
Tejun Heodcd989c2010-06-29 10:07:14 +02004290 * OR'd bitmask of WORK_BUSY_* bits.
4291 */
4292unsigned int work_busy(struct work_struct *work)
4293{
Tejun Heofa1b54e2013-03-12 11:30:00 -07004294 struct worker_pool *pool;
Tejun Heodcd989c2010-06-29 10:07:14 +02004295 unsigned long flags;
4296 unsigned int ret = 0;
4297
Tejun Heodcd989c2010-06-29 10:07:14 +02004298 if (work_pending(work))
4299 ret |= WORK_BUSY_PENDING;
Tejun Heodcd989c2010-06-29 10:07:14 +02004300
Tejun Heofa1b54e2013-03-12 11:30:00 -07004301 local_irq_save(flags);
4302 pool = get_work_pool(work);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004303 if (pool) {
Tejun Heofa1b54e2013-03-12 11:30:00 -07004304 spin_lock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004305 if (find_worker_executing_work(pool, work))
4306 ret |= WORK_BUSY_RUNNING;
Tejun Heofa1b54e2013-03-12 11:30:00 -07004307 spin_unlock(&pool->lock);
Lai Jiangshan038366c2013-02-06 18:04:53 -08004308 }
Tejun Heofa1b54e2013-03-12 11:30:00 -07004309 local_irq_restore(flags);
Tejun Heodcd989c2010-06-29 10:07:14 +02004310
4311 return ret;
4312}
4313EXPORT_SYMBOL_GPL(work_busy);
4314
Tejun Heo3d1cb202013-04-30 15:27:22 -07004315/**
4316 * set_worker_desc - set description for the current work item
4317 * @fmt: printf-style format string
4318 * @...: arguments for the format string
4319 *
4320 * This function can be called by a running work function to describe what
4321 * the work item is about. If the worker task gets dumped, this
4322 * information will be printed out together to help debugging. The
4323 * description can be at most WORKER_DESC_LEN including the trailing '\0'.
4324 */
4325void set_worker_desc(const char *fmt, ...)
4326{
4327 struct worker *worker = current_wq_worker();
4328 va_list args;
4329
4330 if (worker) {
4331 va_start(args, fmt);
4332 vsnprintf(worker->desc, sizeof(worker->desc), fmt, args);
4333 va_end(args);
4334 worker->desc_valid = true;
4335 }
4336}
4337
4338/**
4339 * print_worker_info - print out worker information and description
4340 * @log_lvl: the log level to use when printing
4341 * @task: target task
4342 *
4343 * If @task is a worker and currently executing a work item, print out the
4344 * name of the workqueue being serviced and worker description set with
4345 * set_worker_desc() by the currently executing work item.
4346 *
4347 * This function can be safely called on any task as long as the
4348 * task_struct itself is accessible. While safe, this function isn't
4349 * synchronized and may print out mixups or garbages of limited length.
4350 */
4351void print_worker_info(const char *log_lvl, struct task_struct *task)
4352{
4353 work_func_t *fn = NULL;
4354 char name[WQ_NAME_LEN] = { };
4355 char desc[WORKER_DESC_LEN] = { };
4356 struct pool_workqueue *pwq = NULL;
4357 struct workqueue_struct *wq = NULL;
4358 bool desc_valid = false;
4359 struct worker *worker;
4360
4361 if (!(task->flags & PF_WQ_WORKER))
4362 return;
4363
4364 /*
4365 * This function is called without any synchronization and @task
4366 * could be in any state. Be careful with dereferences.
4367 */
4368 worker = probe_kthread_data(task);
4369
4370 /*
4371 * Carefully copy the associated workqueue's workfn and name. Keep
4372 * the original last '\0' in case the original contains garbage.
4373 */
4374 probe_kernel_read(&fn, &worker->current_func, sizeof(fn));
4375 probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq));
4376 probe_kernel_read(&wq, &pwq->wq, sizeof(wq));
4377 probe_kernel_read(name, wq->name, sizeof(name) - 1);
4378
4379 /* copy worker description */
4380 probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid));
4381 if (desc_valid)
4382 probe_kernel_read(desc, worker->desc, sizeof(desc) - 1);
4383
4384 if (fn || name[0] || desc[0]) {
4385 printk("%sWorkqueue: %s %pf", log_lvl, name, fn);
4386 if (desc[0])
4387 pr_cont(" (%s)", desc);
4388 pr_cont("\n");
4389 }
4390}
4391
Tejun Heodb7bccf2010-06-29 10:07:12 +02004392/*
4393 * CPU hotplug.
4394 *
Tejun Heoe22bee72010-06-29 10:07:14 +02004395 * There are two challenges in supporting CPU hotplug. Firstly, there
Tejun Heo112202d2013-02-13 19:29:12 -08004396 * are a lot of assumptions on strong associations among work, pwq and
Tejun Heo706026c2013-01-24 11:01:34 -08004397 * pool which make migrating pending and scheduled works very
Tejun Heoe22bee72010-06-29 10:07:14 +02004398 * difficult to implement without impacting hot paths. Secondly,
Tejun Heo94cf58b2013-01-24 11:01:33 -08004399 * worker pools serve mix of short, long and very long running works making
Tejun Heoe22bee72010-06-29 10:07:14 +02004400 * blocked draining impractical.
4401 *
Tejun Heo24647572013-01-24 11:01:33 -08004402 * This is solved by allowing the pools to be disassociated from the CPU
Tejun Heo628c78e2012-07-17 12:39:27 -07004403 * running as an unbound one and allowing it to be reattached later if the
4404 * cpu comes back online.
Tejun Heodb7bccf2010-06-29 10:07:12 +02004405 */
4406
Tejun Heo706026c2013-01-24 11:01:34 -08004407static void wq_unbind_fn(struct work_struct *work)
Tejun Heodb7bccf2010-06-29 10:07:12 +02004408{
Tejun Heo38db41d2013-01-24 11:01:34 -08004409 int cpu = smp_processor_id();
Tejun Heo4ce62e92012-07-13 22:16:44 -07004410 struct worker_pool *pool;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004411 struct worker *worker;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004412
Tejun Heof02ae732013-03-12 11:30:03 -07004413 for_each_cpu_worker_pool(pool, cpu) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004414 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004415 spin_lock_irq(&pool->lock);
4416
4417 /*
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004418 * We've blocked all attach/detach operations. Make all workers
Tejun Heo94cf58b2013-01-24 11:01:33 -08004419 * unbound and set DISASSOCIATED. Before this, all workers
4420 * except for the ones which are still executing works from
4421 * before the last CPU down must be on the cpu. After
4422 * this, they may become diasporas.
4423 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004424 for_each_pool_worker(worker, pool)
Tejun Heoc9e7cf22013-01-24 11:01:33 -08004425 worker->flags |= WORKER_UNBOUND;
Tejun Heodb7bccf2010-06-29 10:07:12 +02004426
Tejun Heo24647572013-01-24 11:01:33 -08004427 pool->flags |= POOL_DISASSOCIATED;
Tejun Heof2d5a0e2012-07-17 12:39:26 -07004428
Tejun Heo94cf58b2013-01-24 11:01:33 -08004429 spin_unlock_irq(&pool->lock);
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004430 mutex_unlock(&pool->attach_mutex);
Tejun Heoe22bee72010-06-29 10:07:14 +02004431
Lai Jiangshaneb283422013-03-08 15:18:28 -08004432 /*
4433 * Call schedule() so that we cross rq->lock and thus can
4434 * guarantee sched callbacks see the %WORKER_UNBOUND flag.
4435 * This is necessary as scheduler callbacks may be invoked
4436 * from other cpus.
4437 */
4438 schedule();
Tejun Heo628c78e2012-07-17 12:39:27 -07004439
Lai Jiangshaneb283422013-03-08 15:18:28 -08004440 /*
4441 * Sched callbacks are disabled now. Zap nr_running.
4442 * After this, nr_running stays zero and need_more_worker()
4443 * and keep_working() are always true as long as the
4444 * worklist is not empty. This pool now behaves as an
4445 * unbound (in terms of concurrency management) pool which
4446 * are served by workers tied to the pool.
4447 */
Tejun Heoe19e3972013-01-24 11:39:44 -08004448 atomic_set(&pool->nr_running, 0);
Lai Jiangshaneb283422013-03-08 15:18:28 -08004449
4450 /*
4451 * With concurrency management just turned off, a busy
4452 * worker blocking could lead to lengthy stalls. Kick off
4453 * unbound chain execution of currently pending work items.
4454 */
4455 spin_lock_irq(&pool->lock);
4456 wake_up_worker(pool);
4457 spin_unlock_irq(&pool->lock);
4458 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004459}
4460
Tejun Heobd7c0892013-03-19 13:45:21 -07004461/**
4462 * rebind_workers - rebind all workers of a pool to the associated CPU
4463 * @pool: pool of interest
4464 *
Tejun Heoa9ab7752013-03-19 13:45:21 -07004465 * @pool->cpu is coming online. Rebind all workers to the CPU.
Tejun Heobd7c0892013-03-19 13:45:21 -07004466 */
4467static void rebind_workers(struct worker_pool *pool)
4468{
Tejun Heoa9ab7752013-03-19 13:45:21 -07004469 struct worker *worker;
Tejun Heobd7c0892013-03-19 13:45:21 -07004470
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004471 lockdep_assert_held(&pool->attach_mutex);
Tejun Heobd7c0892013-03-19 13:45:21 -07004472
Tejun Heoa9ab7752013-03-19 13:45:21 -07004473 /*
4474 * Restore CPU affinity of all workers. As all idle workers should
4475 * be on the run-queue of the associated CPU before any local
4476 * wake-ups for concurrency management happen, restore CPU affinty
4477 * of all workers first and then clear UNBOUND. As we're called
4478 * from CPU_ONLINE, the following shouldn't fail.
4479 */
Lai Jiangshanda028462014-05-20 17:46:31 +08004480 for_each_pool_worker(worker, pool)
Tejun Heoa9ab7752013-03-19 13:45:21 -07004481 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4482 pool->attrs->cpumask) < 0);
4483
4484 spin_lock_irq(&pool->lock);
Lai Jiangshan3de5e882014-06-03 15:33:27 +08004485 pool->flags &= ~POOL_DISASSOCIATED;
Tejun Heoa9ab7752013-03-19 13:45:21 -07004486
Lai Jiangshanda028462014-05-20 17:46:31 +08004487 for_each_pool_worker(worker, pool) {
Tejun Heoa9ab7752013-03-19 13:45:21 -07004488 unsigned int worker_flags = worker->flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004489
4490 /*
Tejun Heoa9ab7752013-03-19 13:45:21 -07004491 * A bound idle worker should actually be on the runqueue
4492 * of the associated CPU for local wake-ups targeting it to
4493 * work. Kick all idle workers so that they migrate to the
4494 * associated CPU. Doing this in the same loop as
4495 * replacing UNBOUND with REBOUND is safe as no worker will
4496 * be bound before @pool->lock is released.
Tejun Heobd7c0892013-03-19 13:45:21 -07004497 */
Tejun Heoa9ab7752013-03-19 13:45:21 -07004498 if (worker_flags & WORKER_IDLE)
4499 wake_up_process(worker->task);
4500
4501 /*
4502 * We want to clear UNBOUND but can't directly call
4503 * worker_clr_flags() or adjust nr_running. Atomically
4504 * replace UNBOUND with another NOT_RUNNING flag REBOUND.
4505 * @worker will clear REBOUND using worker_clr_flags() when
4506 * it initiates the next execution cycle thus restoring
4507 * concurrency management. Note that when or whether
4508 * @worker clears REBOUND doesn't affect correctness.
4509 *
4510 * ACCESS_ONCE() is necessary because @worker->flags may be
4511 * tested without holding any lock in
4512 * wq_worker_waking_up(). Without it, NOT_RUNNING test may
4513 * fail incorrectly leading to premature concurrency
4514 * management operations.
4515 */
4516 WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND));
4517 worker_flags |= WORKER_REBOUND;
4518 worker_flags &= ~WORKER_UNBOUND;
4519 ACCESS_ONCE(worker->flags) = worker_flags;
Tejun Heobd7c0892013-03-19 13:45:21 -07004520 }
4521
Tejun Heoa9ab7752013-03-19 13:45:21 -07004522 spin_unlock_irq(&pool->lock);
Tejun Heobd7c0892013-03-19 13:45:21 -07004523}
4524
Tejun Heo7dbc7252013-03-19 13:45:21 -07004525/**
4526 * restore_unbound_workers_cpumask - restore cpumask of unbound workers
4527 * @pool: unbound pool of interest
4528 * @cpu: the CPU which is coming up
4529 *
4530 * An unbound pool may end up with a cpumask which doesn't have any online
4531 * CPUs. When a worker of such pool get scheduled, the scheduler resets
4532 * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any
4533 * online CPU before, cpus_allowed of all its workers should be restored.
4534 */
4535static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu)
4536{
4537 static cpumask_t cpumask;
4538 struct worker *worker;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004539
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004540 lockdep_assert_held(&pool->attach_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004541
4542 /* is @cpu allowed for @pool? */
4543 if (!cpumask_test_cpu(cpu, pool->attrs->cpumask))
4544 return;
4545
4546 /* is @cpu the only online CPU? */
4547 cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask);
4548 if (cpumask_weight(&cpumask) != 1)
4549 return;
4550
4551 /* as we're called from CPU_ONLINE, the following shouldn't fail */
Lai Jiangshanda028462014-05-20 17:46:31 +08004552 for_each_pool_worker(worker, pool)
Tejun Heo7dbc7252013-03-19 13:45:21 -07004553 WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task,
4554 pool->attrs->cpumask) < 0);
4555}
4556
Tejun Heo8db25e72012-07-17 12:39:28 -07004557/*
4558 * Workqueues should be brought up before normal priority CPU notifiers.
4559 * This will be registered high priority CPU notifier.
4560 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004561static int workqueue_cpu_up_callback(struct notifier_block *nfb,
Tejun Heo8db25e72012-07-17 12:39:28 -07004562 unsigned long action,
4563 void *hcpu)
Oleg Nesterov3af244332007-05-09 02:34:09 -07004564{
Tejun Heod84ff052013-03-12 11:29:59 -07004565 int cpu = (unsigned long)hcpu;
Tejun Heo4ce62e92012-07-13 22:16:44 -07004566 struct worker_pool *pool;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004567 struct workqueue_struct *wq;
Tejun Heo7dbc7252013-03-19 13:45:21 -07004568 int pi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004569
Tejun Heo8db25e72012-07-17 12:39:28 -07004570 switch (action & ~CPU_TASKS_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004571 case CPU_UP_PREPARE:
Tejun Heof02ae732013-03-12 11:30:03 -07004572 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo3ce63372012-07-17 12:39:27 -07004573 if (pool->nr_workers)
4574 continue;
Lai Jiangshan051e1852014-07-22 13:03:02 +08004575 if (!create_worker(pool))
Tejun Heo3ce63372012-07-17 12:39:27 -07004576 return NOTIFY_BAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004577 }
Tejun Heodb7bccf2010-06-29 10:07:12 +02004578 break;
Oleg Nesterov00dfcaf2008-04-29 01:00:27 -07004579
Tejun Heo65758202012-07-17 12:39:26 -07004580 case CPU_DOWN_FAILED:
4581 case CPU_ONLINE:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004582 mutex_lock(&wq_pool_mutex);
Tejun Heo7dbc7252013-03-19 13:45:21 -07004583
4584 for_each_pool(pool, pi) {
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004585 mutex_lock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004586
Tejun Heo7dbc7252013-03-19 13:45:21 -07004587 if (pool->cpu == cpu) {
Tejun Heo7dbc7252013-03-19 13:45:21 -07004588 rebind_workers(pool);
4589 } else if (pool->cpu < 0) {
4590 restore_unbound_workers_cpumask(pool, cpu);
4591 }
Tejun Heo94cf58b2013-01-24 11:01:33 -08004592
Lai Jiangshan92f9c5c2014-05-20 17:46:34 +08004593 mutex_unlock(&pool->attach_mutex);
Tejun Heo94cf58b2013-01-24 11:01:33 -08004594 }
Tejun Heo7dbc7252013-03-19 13:45:21 -07004595
Tejun Heo4c16bd32013-04-01 11:23:36 -07004596 /* update NUMA affinity of unbound workqueues */
4597 list_for_each_entry(wq, &workqueues, list)
4598 wq_update_unbound_numa(wq, cpu, true);
4599
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004600 mutex_unlock(&wq_pool_mutex);
Tejun Heo8db25e72012-07-17 12:39:28 -07004601 break;
Tejun Heo65758202012-07-17 12:39:26 -07004602 }
4603 return NOTIFY_OK;
4604}
4605
4606/*
4607 * Workqueues should be brought down after normal priority CPU notifiers.
4608 * This will be registered as low priority CPU notifier.
4609 */
Paul Gortmaker0db06282013-06-19 14:53:51 -04004610static int workqueue_cpu_down_callback(struct notifier_block *nfb,
Tejun Heo65758202012-07-17 12:39:26 -07004611 unsigned long action,
4612 void *hcpu)
4613{
Tejun Heod84ff052013-03-12 11:29:59 -07004614 int cpu = (unsigned long)hcpu;
Tejun Heo8db25e72012-07-17 12:39:28 -07004615 struct work_struct unbind_work;
Tejun Heo4c16bd32013-04-01 11:23:36 -07004616 struct workqueue_struct *wq;
Tejun Heo8db25e72012-07-17 12:39:28 -07004617
Tejun Heo65758202012-07-17 12:39:26 -07004618 switch (action & ~CPU_TASKS_FROZEN) {
4619 case CPU_DOWN_PREPARE:
Tejun Heo4c16bd32013-04-01 11:23:36 -07004620 /* unbinding per-cpu workers should happen on the local CPU */
Tejun Heo706026c2013-01-24 11:01:34 -08004621 INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn);
Joonsoo Kim7635d2f2012-08-15 23:25:41 +09004622 queue_work_on(cpu, system_highpri_wq, &unbind_work);
Tejun Heo4c16bd32013-04-01 11:23:36 -07004623
4624 /* update NUMA affinity of unbound workqueues */
4625 mutex_lock(&wq_pool_mutex);
4626 list_for_each_entry(wq, &workqueues, list)
4627 wq_update_unbound_numa(wq, cpu, false);
4628 mutex_unlock(&wq_pool_mutex);
4629
4630 /* wait for per-cpu unbinding to finish */
Tejun Heo8db25e72012-07-17 12:39:28 -07004631 flush_work(&unbind_work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004632 destroy_work_on_stack(&unbind_work);
Tejun Heo8db25e72012-07-17 12:39:28 -07004633 break;
Tejun Heo65758202012-07-17 12:39:26 -07004634 }
4635 return NOTIFY_OK;
4636}
4637
Rusty Russell2d3854a2008-11-05 13:39:10 +11004638#ifdef CONFIG_SMP
Rusty Russell8ccad402009-01-16 15:31:15 -08004639
Rusty Russell2d3854a2008-11-05 13:39:10 +11004640struct work_for_cpu {
Tejun Heoed48ece2012-09-18 12:48:43 -07004641 struct work_struct work;
Rusty Russell2d3854a2008-11-05 13:39:10 +11004642 long (*fn)(void *);
4643 void *arg;
4644 long ret;
4645};
4646
Tejun Heoed48ece2012-09-18 12:48:43 -07004647static void work_for_cpu_fn(struct work_struct *work)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004648{
Tejun Heoed48ece2012-09-18 12:48:43 -07004649 struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work);
4650
Rusty Russell2d3854a2008-11-05 13:39:10 +11004651 wfc->ret = wfc->fn(wfc->arg);
4652}
4653
4654/**
4655 * work_on_cpu - run a function in user context on a particular cpu
4656 * @cpu: the cpu to run on
4657 * @fn: the function to run
4658 * @arg: the function arg
4659 *
Rusty Russell31ad9082009-01-16 15:31:15 -08004660 * It is up to the caller to ensure that the cpu doesn't go offline.
Andrew Morton6b440032009-04-09 09:50:37 -06004661 * The caller must not hold any locks which would prevent @fn from completing.
Yacine Belkadid185af32013-07-31 14:59:24 -07004662 *
4663 * Return: The value @fn returns.
Rusty Russell2d3854a2008-11-05 13:39:10 +11004664 */
Tejun Heod84ff052013-03-12 11:29:59 -07004665long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
Rusty Russell2d3854a2008-11-05 13:39:10 +11004666{
Tejun Heoed48ece2012-09-18 12:48:43 -07004667 struct work_for_cpu wfc = { .fn = fn, .arg = arg };
Rusty Russell2d3854a2008-11-05 13:39:10 +11004668
Tejun Heoed48ece2012-09-18 12:48:43 -07004669 INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn);
4670 schedule_work_on(cpu, &wfc.work);
Bjorn Helgaas12997d12013-11-18 11:00:29 -07004671 flush_work(&wfc.work);
Chuansheng Liu440a1132014-01-11 22:26:33 -05004672 destroy_work_on_stack(&wfc.work);
Rusty Russell2d3854a2008-11-05 13:39:10 +11004673 return wfc.ret;
4674}
4675EXPORT_SYMBOL_GPL(work_on_cpu);
4676#endif /* CONFIG_SMP */
4677
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004678#ifdef CONFIG_FREEZER
Rusty Russelle7577c52009-01-01 10:12:25 +10304679
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004680/**
4681 * freeze_workqueues_begin - begin freezing workqueues
4682 *
Tejun Heo58a69cb2011-02-16 09:25:31 +01004683 * Start freezing workqueues. After this function returns, all freezable
Tejun Heoc5aa87b2013-03-13 16:51:36 -07004684 * workqueues will queue new works to their delayed_works list instead of
Tejun Heo706026c2013-01-24 11:01:34 -08004685 * pool->worklist.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004686 *
4687 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004688 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004689 */
4690void freeze_workqueues_begin(void)
4691{
Tejun Heo24b8a842013-03-12 11:29:58 -07004692 struct workqueue_struct *wq;
4693 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004694
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004695 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004696
Tejun Heo6183c002013-03-12 11:29:57 -07004697 WARN_ON_ONCE(workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004698 workqueue_freezing = true;
4699
Tejun Heo24b8a842013-03-12 11:29:58 -07004700 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004701 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004702 for_each_pwq(pwq, wq)
4703 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004704 mutex_unlock(&wq->mutex);
Tejun Heo24b8a842013-03-12 11:29:58 -07004705 }
Tejun Heo5bcab332013-03-13 19:47:40 -07004706
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004707 mutex_unlock(&wq_pool_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004708}
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004709
4710/**
Tejun Heo58a69cb2011-02-16 09:25:31 +01004711 * freeze_workqueues_busy - are freezable workqueues still busy?
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004712 *
4713 * Check whether freezing is complete. This function must be called
4714 * between freeze_workqueues_begin() and thaw_workqueues().
4715 *
4716 * CONTEXT:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004717 * Grabs and releases wq_pool_mutex.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004718 *
Yacine Belkadid185af32013-07-31 14:59:24 -07004719 * Return:
Tejun Heo58a69cb2011-02-16 09:25:31 +01004720 * %true if some freezable workqueues are still busy. %false if freezing
4721 * is complete.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004722 */
4723bool freeze_workqueues_busy(void)
4724{
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004725 bool busy = false;
Tejun Heo24b8a842013-03-12 11:29:58 -07004726 struct workqueue_struct *wq;
4727 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004728
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004729 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004730
Tejun Heo6183c002013-03-12 11:29:57 -07004731 WARN_ON_ONCE(!workqueue_freezing);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004732
Tejun Heo24b8a842013-03-12 11:29:58 -07004733 list_for_each_entry(wq, &workqueues, list) {
4734 if (!(wq->flags & WQ_FREEZABLE))
4735 continue;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004736 /*
4737 * nr_active is monotonically decreasing. It's safe
4738 * to peek without lock.
4739 */
Lai Jiangshan88109452013-03-20 03:28:10 +08004740 rcu_read_lock_sched();
Tejun Heo24b8a842013-03-12 11:29:58 -07004741 for_each_pwq(pwq, wq) {
Tejun Heo6183c002013-03-12 11:29:57 -07004742 WARN_ON_ONCE(pwq->nr_active < 0);
Tejun Heo112202d2013-02-13 19:29:12 -08004743 if (pwq->nr_active) {
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004744 busy = true;
Lai Jiangshan88109452013-03-20 03:28:10 +08004745 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004746 goto out_unlock;
4747 }
4748 }
Lai Jiangshan88109452013-03-20 03:28:10 +08004749 rcu_read_unlock_sched();
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004750 }
4751out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004752 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004753 return busy;
4754}
4755
4756/**
4757 * thaw_workqueues - thaw workqueues
4758 *
4759 * Thaw workqueues. Normal queueing is restored and all collected
Tejun Heo706026c2013-01-24 11:01:34 -08004760 * frozen works are transferred to their respective pool worklists.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004761 *
4762 * CONTEXT:
Lai Jiangshana357fc02013-03-25 16:57:19 -07004763 * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's.
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004764 */
4765void thaw_workqueues(void)
4766{
Tejun Heo24b8a842013-03-12 11:29:58 -07004767 struct workqueue_struct *wq;
4768 struct pool_workqueue *pwq;
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004769
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004770 mutex_lock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004771
4772 if (!workqueue_freezing)
4773 goto out_unlock;
4774
Lai Jiangshan74b414e2014-05-22 19:01:16 +08004775 workqueue_freezing = false;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004776
Tejun Heo24b8a842013-03-12 11:29:58 -07004777 /* restore max_active and repopulate worklist */
4778 list_for_each_entry(wq, &workqueues, list) {
Lai Jiangshana357fc02013-03-25 16:57:19 -07004779 mutex_lock(&wq->mutex);
Tejun Heo699ce092013-03-13 16:51:35 -07004780 for_each_pwq(pwq, wq)
4781 pwq_adjust_max_active(pwq);
Lai Jiangshana357fc02013-03-25 16:57:19 -07004782 mutex_unlock(&wq->mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004783 }
4784
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004785out_unlock:
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004786 mutex_unlock(&wq_pool_mutex);
Tejun Heoa0a1a5f2010-06-29 10:07:12 +02004787}
4788#endif /* CONFIG_FREEZER */
4789
Tejun Heobce90382013-04-01 11:23:32 -07004790static void __init wq_numa_init(void)
4791{
4792 cpumask_var_t *tbl;
4793 int node, cpu;
4794
4795 /* determine NUMA pwq table len - highest node id + 1 */
4796 for_each_node(node)
4797 wq_numa_tbl_len = max(wq_numa_tbl_len, node + 1);
4798
4799 if (num_possible_nodes() <= 1)
4800 return;
4801
Tejun Heod55262c2013-04-01 11:23:38 -07004802 if (wq_disable_numa) {
4803 pr_info("workqueue: NUMA affinity support disabled\n");
4804 return;
4805 }
4806
Tejun Heo4c16bd32013-04-01 11:23:36 -07004807 wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL);
4808 BUG_ON(!wq_update_unbound_numa_attrs_buf);
4809
Tejun Heobce90382013-04-01 11:23:32 -07004810 /*
4811 * We want masks of possible CPUs of each node which isn't readily
4812 * available. Build one from cpu_to_node() which should have been
4813 * fully initialized by now.
4814 */
4815 tbl = kzalloc(wq_numa_tbl_len * sizeof(tbl[0]), GFP_KERNEL);
4816 BUG_ON(!tbl);
4817
4818 for_each_node(node)
Tejun Heo1be0c252013-05-15 14:24:24 -07004819 BUG_ON(!alloc_cpumask_var_node(&tbl[node], GFP_KERNEL,
4820 node_online(node) ? node : NUMA_NO_NODE));
Tejun Heobce90382013-04-01 11:23:32 -07004821
4822 for_each_possible_cpu(cpu) {
4823 node = cpu_to_node(cpu);
4824 if (WARN_ON(node == NUMA_NO_NODE)) {
4825 pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu);
4826 /* happens iff arch is bonkers, let's just proceed */
4827 return;
4828 }
4829 cpumask_set_cpu(cpu, tbl[node]);
4830 }
4831
4832 wq_numa_possible_cpumask = tbl;
4833 wq_numa_enabled = true;
4834}
4835
Suresh Siddha6ee05782010-07-30 14:57:37 -07004836static int __init init_workqueues(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004837{
Tejun Heo7a4e3442013-03-12 11:30:00 -07004838 int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL };
4839 int i, cpu;
Tejun Heoc34056a2010-06-29 10:07:11 +02004840
Tejun Heoe904e6c2013-03-12 11:29:57 -07004841 WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long));
4842
4843 pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC);
4844
Tejun Heo65758202012-07-17 12:39:26 -07004845 cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP);
Lai Jiangshana5b4e572012-09-18 09:59:23 -07004846 hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN);
Tejun Heo8b03ae32010-06-29 10:07:12 +02004847
Tejun Heobce90382013-04-01 11:23:32 -07004848 wq_numa_init();
4849
Tejun Heo706026c2013-01-24 11:01:34 -08004850 /* initialize CPU pools */
Tejun Heo29c91e92013-03-12 11:30:03 -07004851 for_each_possible_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07004852 struct worker_pool *pool;
Tejun Heo8b03ae32010-06-29 10:07:12 +02004853
Tejun Heo7a4e3442013-03-12 11:30:00 -07004854 i = 0;
Tejun Heof02ae732013-03-12 11:30:03 -07004855 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo7a4e3442013-03-12 11:30:00 -07004856 BUG_ON(init_worker_pool(pool));
Tejun Heoec22ca52013-01-24 11:01:33 -08004857 pool->cpu = cpu;
Tejun Heo29c91e92013-03-12 11:30:03 -07004858 cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu));
Tejun Heo7a4e3442013-03-12 11:30:00 -07004859 pool->attrs->nice = std_nice[i++];
Tejun Heof3f90ad2013-04-01 11:23:34 -07004860 pool->node = cpu_to_node(cpu);
Tejun Heo7a4e3442013-03-12 11:30:00 -07004861
Tejun Heo9daf9e62013-01-24 11:01:33 -08004862 /* alloc pool ID */
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004863 mutex_lock(&wq_pool_mutex);
Tejun Heo9daf9e62013-01-24 11:01:33 -08004864 BUG_ON(worker_pool_assign_id(pool));
Lai Jiangshan68e13a62013-03-25 16:57:17 -07004865 mutex_unlock(&wq_pool_mutex);
Tejun Heo4ce62e92012-07-13 22:16:44 -07004866 }
Tejun Heo8b03ae32010-06-29 10:07:12 +02004867 }
4868
Tejun Heoe22bee72010-06-29 10:07:14 +02004869 /* create the initial worker */
Tejun Heo29c91e92013-03-12 11:30:03 -07004870 for_each_online_cpu(cpu) {
Tejun Heo4ce62e92012-07-13 22:16:44 -07004871 struct worker_pool *pool;
Tejun Heoe22bee72010-06-29 10:07:14 +02004872
Tejun Heof02ae732013-03-12 11:30:03 -07004873 for_each_cpu_worker_pool(pool, cpu) {
Tejun Heo29c91e92013-03-12 11:30:03 -07004874 pool->flags &= ~POOL_DISASSOCIATED;
Lai Jiangshan051e1852014-07-22 13:03:02 +08004875 BUG_ON(!create_worker(pool));
Tejun Heo4ce62e92012-07-13 22:16:44 -07004876 }
Tejun Heoe22bee72010-06-29 10:07:14 +02004877 }
4878
Tejun Heo8a2b7532013-09-05 12:30:04 -04004879 /* create default unbound and ordered wq attrs */
Tejun Heo29c91e92013-03-12 11:30:03 -07004880 for (i = 0; i < NR_STD_WORKER_POOLS; i++) {
4881 struct workqueue_attrs *attrs;
4882
4883 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
Tejun Heo29c91e92013-03-12 11:30:03 -07004884 attrs->nice = std_nice[i];
Tejun Heo29c91e92013-03-12 11:30:03 -07004885 unbound_std_wq_attrs[i] = attrs;
Tejun Heo8a2b7532013-09-05 12:30:04 -04004886
4887 /*
4888 * An ordered wq should have only one pwq as ordering is
4889 * guaranteed by max_active which is enforced by pwqs.
4890 * Turn off NUMA so that dfl_pwq is used for all nodes.
4891 */
4892 BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL)));
4893 attrs->nice = std_nice[i];
4894 attrs->no_numa = true;
4895 ordered_wq_attrs[i] = attrs;
Tejun Heo29c91e92013-03-12 11:30:03 -07004896 }
4897
Tejun Heod320c032010-06-29 10:07:14 +02004898 system_wq = alloc_workqueue("events", 0, 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09004899 system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0);
Tejun Heod320c032010-06-29 10:07:14 +02004900 system_long_wq = alloc_workqueue("events_long", 0, 0);
Tejun Heof3421792010-07-02 10:03:51 +02004901 system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND,
4902 WQ_UNBOUND_MAX_ACTIVE);
Tejun Heo24d51ad2011-02-21 09:52:50 +01004903 system_freezable_wq = alloc_workqueue("events_freezable",
4904 WQ_FREEZABLE, 0);
Viresh Kumar06681062013-04-24 17:12:54 +05304905 system_power_efficient_wq = alloc_workqueue("events_power_efficient",
4906 WQ_POWER_EFFICIENT, 0);
4907 system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient",
4908 WQ_FREEZABLE | WQ_POWER_EFFICIENT,
4909 0);
Joonsoo Kim1aabe902012-08-15 23:25:39 +09004910 BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq ||
Viresh Kumar06681062013-04-24 17:12:54 +05304911 !system_unbound_wq || !system_freezable_wq ||
4912 !system_power_efficient_wq ||
4913 !system_freezable_power_efficient_wq);
Suresh Siddha6ee05782010-07-30 14:57:37 -07004914 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004915}
Suresh Siddha6ee05782010-07-30 14:57:37 -07004916early_initcall(init_workqueues);