Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
c54fce6e | 2 | * kernel/workqueue.c - generic async execution with shared worker pool |
1da177e4 | 3 | * |
c54fce6e | 4 | * Copyright (C) 2002 Ingo Molnar |
1da177e4 | 5 | * |
c54fce6e TH |
6 | * 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> | |
1da177e4 | 11 | * |
c54fce6e | 12 | * Made to use alloc_percpu by Christoph Lameter. |
1da177e4 | 13 | * |
c54fce6e TH |
14 | * Copyright (C) 2010 SUSE Linux Products GmbH |
15 | * Copyright (C) 2010 Tejun Heo <tj@kernel.org> | |
89ada679 | 16 | * |
c54fce6e TH |
17 | * This is the generic async execution mechanism. Work items as are |
18 | * executed in process context. The worker pool is shared and | |
b11895c4 L |
19 | * 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. | |
c54fce6e TH |
23 | * |
24 | * Please read Documentation/workqueue.txt for details. | |
1da177e4 LT |
25 | */ |
26 | ||
9984de1a | 27 | #include <linux/export.h> |
1da177e4 LT |
28 | #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> | |
1fa44eca | 38 | #include <linux/hardirq.h> |
46934023 | 39 | #include <linux/mempolicy.h> |
341a5958 | 40 | #include <linux/freezer.h> |
d5abe669 PZ |
41 | #include <linux/kallsyms.h> |
42 | #include <linux/debug_locks.h> | |
4e6045f1 | 43 | #include <linux/lockdep.h> |
c34056a3 | 44 | #include <linux/idr.h> |
29c91e99 | 45 | #include <linux/jhash.h> |
42f8570f | 46 | #include <linux/hashtable.h> |
76af4d93 | 47 | #include <linux/rculist.h> |
bce90380 | 48 | #include <linux/nodemask.h> |
4c16bd32 | 49 | #include <linux/moduleparam.h> |
3d1cb205 | 50 | #include <linux/uaccess.h> |
e22bee78 | 51 | |
ea138446 | 52 | #include "workqueue_internal.h" |
1da177e4 | 53 | |
c8e55f36 | 54 | enum { |
24647570 TH |
55 | /* |
56 | * worker_pool flags | |
bc2ae0f5 | 57 | * |
24647570 | 58 | * A bound pool is either associated or disassociated with its CPU. |
bc2ae0f5 TH |
59 | * 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 | |
24647570 | 65 | * be executing on any CPU. The pool behaves as an unbound one. |
bc2ae0f5 | 66 | * |
bc3a1afc | 67 | * Note that DISASSOCIATED should be flipped only while holding |
92f9c5c4 | 68 | * attach_mutex to avoid changing binding state while |
4736cbf7 | 69 | * worker_attach_to_pool() is in progress. |
bc2ae0f5 | 70 | */ |
24647570 | 71 | POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */ |
35b6bb63 | 72 | POOL_FREEZING = 1 << 3, /* freeze in progress */ |
db7bccf4 | 73 | |
c8e55f36 | 74 | /* worker flags */ |
c8e55f36 TH |
75 | WORKER_DIE = 1 << 1, /* die die die */ |
76 | WORKER_IDLE = 1 << 2, /* is idle */ | |
e22bee78 | 77 | WORKER_PREP = 1 << 3, /* preparing to run works */ |
fb0e7beb | 78 | WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */ |
f3421797 | 79 | WORKER_UNBOUND = 1 << 7, /* worker is unbound */ |
a9ab775b | 80 | WORKER_REBOUND = 1 << 8, /* worker was rebound */ |
e22bee78 | 81 | |
a9ab775b TH |
82 | WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE | |
83 | WORKER_UNBOUND | WORKER_REBOUND, | |
db7bccf4 | 84 | |
e34cdddb | 85 | NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */ |
4ce62e9e | 86 | |
29c91e99 | 87 | UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */ |
c8e55f36 | 88 | BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */ |
db7bccf4 | 89 | |
e22bee78 TH |
90 | MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */ |
91 | IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */ | |
92 | ||
3233cdbd TH |
93 | MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2, |
94 | /* call for help after 10ms | |
95 | (min two ticks) */ | |
e22bee78 TH |
96 | MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */ |
97 | CREATE_COOLDOWN = HZ, /* time to breath after fail */ | |
e22bee78 TH |
98 | |
99 | /* | |
100 | * Rescue workers are used only on emergencies and shared by | |
101 | * all cpus. Give -20. | |
102 | */ | |
103 | RESCUER_NICE_LEVEL = -20, | |
3270476a | 104 | HIGHPRI_NICE_LEVEL = -20, |
ecf6881f TH |
105 | |
106 | WQ_NAME_LEN = 24, | |
c8e55f36 | 107 | }; |
1da177e4 LT |
108 | |
109 | /* | |
4690c4ab TH |
110 | * Structure fields follow one of the following exclusion rules. |
111 | * | |
e41e704b TH |
112 | * I: Modifiable by initialization/destruction paths and read-only for |
113 | * everyone else. | |
4690c4ab | 114 | * |
e22bee78 TH |
115 | * P: Preemption protected. Disabling preemption is enough and should |
116 | * only be modified and accessed from the local cpu. | |
117 | * | |
d565ed63 | 118 | * L: pool->lock protected. Access with pool->lock held. |
4690c4ab | 119 | * |
d565ed63 TH |
120 | * X: During normal operation, modification requires pool->lock and should |
121 | * be done only from local cpu. Either disabling preemption on local | |
122 | * cpu or grabbing pool->lock is enough for read access. If | |
123 | * POOL_DISASSOCIATED is set, it's identical to L. | |
e22bee78 | 124 | * |
92f9c5c4 | 125 | * A: pool->attach_mutex protected. |
822d8405 | 126 | * |
68e13a67 | 127 | * PL: wq_pool_mutex protected. |
5bcab335 | 128 | * |
68e13a67 | 129 | * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads. |
76af4d93 | 130 | * |
3c25a55d LJ |
131 | * WQ: wq->mutex protected. |
132 | * | |
b5927605 | 133 | * WR: wq->mutex protected for writes. Sched-RCU protected for reads. |
2e109a28 TH |
134 | * |
135 | * MD: wq_mayday_lock protected. | |
1da177e4 | 136 | */ |
1da177e4 | 137 | |
2eaebdb3 | 138 | /* struct worker is defined in workqueue_internal.h */ |
c34056a3 | 139 | |
bd7bdd43 | 140 | struct worker_pool { |
d565ed63 | 141 | spinlock_t lock; /* the pool lock */ |
d84ff051 | 142 | int cpu; /* I: the associated cpu */ |
f3f90ad4 | 143 | int node; /* I: the associated node ID */ |
9daf9e67 | 144 | int id; /* I: pool ID */ |
11ebea50 | 145 | unsigned int flags; /* X: flags */ |
bd7bdd43 TH |
146 | |
147 | struct list_head worklist; /* L: list of pending works */ | |
148 | int nr_workers; /* L: total number of workers */ | |
ea1abd61 LJ |
149 | |
150 | /* nr_idle includes the ones off idle_list for rebinding */ | |
bd7bdd43 TH |
151 | int nr_idle; /* L: currently idle ones */ |
152 | ||
153 | struct list_head idle_list; /* X: list of idle workers */ | |
154 | struct timer_list idle_timer; /* L: worker idle timeout */ | |
155 | struct timer_list mayday_timer; /* L: SOS timer for workers */ | |
156 | ||
c5aa87bb | 157 | /* a workers is either on busy_hash or idle_list, or the manager */ |
c9e7cf27 TH |
158 | DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER); |
159 | /* L: hash of busy workers */ | |
160 | ||
bc3a1afc | 161 | /* see manage_workers() for details on the two manager mutexes */ |
34a06bd6 | 162 | struct mutex manager_arb; /* manager arbitration */ |
92f9c5c4 LJ |
163 | struct mutex attach_mutex; /* attach/detach exclusion */ |
164 | struct list_head workers; /* A: attached workers */ | |
60f5a4bc | 165 | struct completion *detach_completion; /* all workers detached */ |
e19e397a | 166 | |
7cda9aae LJ |
167 | struct ida worker_ida; /* worker IDs for task name */ |
168 | ||
7a4e344c | 169 | struct workqueue_attrs *attrs; /* I: worker attributes */ |
68e13a67 LJ |
170 | struct hlist_node hash_node; /* PL: unbound_pool_hash node */ |
171 | int refcnt; /* PL: refcnt for unbound pools */ | |
7a4e344c | 172 | |
e19e397a TH |
173 | /* |
174 | * The current concurrency level. As it's likely to be accessed | |
175 | * from other CPUs during try_to_wake_up(), put it in a separate | |
176 | * cacheline. | |
177 | */ | |
178 | atomic_t nr_running ____cacheline_aligned_in_smp; | |
29c91e99 TH |
179 | |
180 | /* | |
181 | * Destruction of pool is sched-RCU protected to allow dereferences | |
182 | * from get_work_pool(). | |
183 | */ | |
184 | struct rcu_head rcu; | |
8b03ae3c TH |
185 | } ____cacheline_aligned_in_smp; |
186 | ||
1da177e4 | 187 | /* |
112202d9 TH |
188 | * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS |
189 | * of work_struct->data are used for flags and the remaining high bits | |
190 | * point to the pwq; thus, pwqs need to be aligned at two's power of the | |
191 | * number of flag bits. | |
1da177e4 | 192 | */ |
112202d9 | 193 | struct pool_workqueue { |
bd7bdd43 | 194 | struct worker_pool *pool; /* I: the associated pool */ |
4690c4ab | 195 | struct workqueue_struct *wq; /* I: the owning workqueue */ |
73f53c4a TH |
196 | int work_color; /* L: current color */ |
197 | int flush_color; /* L: flushing color */ | |
8864b4e5 | 198 | int refcnt; /* L: reference count */ |
73f53c4a TH |
199 | int nr_in_flight[WORK_NR_COLORS]; |
200 | /* L: nr of in_flight works */ | |
1e19ffc6 | 201 | int nr_active; /* L: nr of active works */ |
a0a1a5fd | 202 | int max_active; /* L: max active works */ |
1e19ffc6 | 203 | struct list_head delayed_works; /* L: delayed works */ |
3c25a55d | 204 | struct list_head pwqs_node; /* WR: node on wq->pwqs */ |
2e109a28 | 205 | struct list_head mayday_node; /* MD: node on wq->maydays */ |
8864b4e5 TH |
206 | |
207 | /* | |
208 | * Release of unbound pwq is punted to system_wq. See put_pwq() | |
209 | * and pwq_unbound_release_workfn() for details. pool_workqueue | |
210 | * itself is also sched-RCU protected so that the first pwq can be | |
b09f4fd3 | 211 | * determined without grabbing wq->mutex. |
8864b4e5 TH |
212 | */ |
213 | struct work_struct unbound_release_work; | |
214 | struct rcu_head rcu; | |
e904e6c2 | 215 | } __aligned(1 << WORK_STRUCT_FLAG_BITS); |
1da177e4 | 216 | |
73f53c4a TH |
217 | /* |
218 | * Structure used to wait for workqueue flush. | |
219 | */ | |
220 | struct wq_flusher { | |
3c25a55d LJ |
221 | struct list_head list; /* WQ: list of flushers */ |
222 | int flush_color; /* WQ: flush color waiting for */ | |
73f53c4a TH |
223 | struct completion done; /* flush completion */ |
224 | }; | |
225 | ||
226223ab TH |
226 | struct wq_device; |
227 | ||
1da177e4 | 228 | /* |
c5aa87bb TH |
229 | * The externally visible workqueue. It relays the issued work items to |
230 | * the appropriate worker_pool through its pool_workqueues. | |
1da177e4 LT |
231 | */ |
232 | struct workqueue_struct { | |
3c25a55d | 233 | struct list_head pwqs; /* WR: all pwqs of this wq */ |
68e13a67 | 234 | struct list_head list; /* PL: list of all workqueues */ |
73f53c4a | 235 | |
3c25a55d LJ |
236 | struct mutex mutex; /* protects this wq */ |
237 | int work_color; /* WQ: current work color */ | |
238 | int flush_color; /* WQ: current flush color */ | |
112202d9 | 239 | atomic_t nr_pwqs_to_flush; /* flush in progress */ |
3c25a55d LJ |
240 | struct wq_flusher *first_flusher; /* WQ: first flusher */ |
241 | struct list_head flusher_queue; /* WQ: flush waiters */ | |
242 | struct list_head flusher_overflow; /* WQ: flush overflow list */ | |
73f53c4a | 243 | |
2e109a28 | 244 | struct list_head maydays; /* MD: pwqs requesting rescue */ |
e22bee78 TH |
245 | struct worker *rescuer; /* I: rescue worker */ |
246 | ||
87fc741e | 247 | int nr_drainers; /* WQ: drain in progress */ |
a357fc03 | 248 | int saved_max_active; /* WQ: saved pwq max_active */ |
226223ab | 249 | |
6029a918 | 250 | struct workqueue_attrs *unbound_attrs; /* WQ: only for unbound wqs */ |
4c16bd32 | 251 | struct pool_workqueue *dfl_pwq; /* WQ: only for unbound wqs */ |
6029a918 | 252 | |
226223ab TH |
253 | #ifdef CONFIG_SYSFS |
254 | struct wq_device *wq_dev; /* I: for sysfs interface */ | |
255 | #endif | |
4e6045f1 | 256 | #ifdef CONFIG_LOCKDEP |
4690c4ab | 257 | struct lockdep_map lockdep_map; |
4e6045f1 | 258 | #endif |
ecf6881f | 259 | char name[WQ_NAME_LEN]; /* I: workqueue name */ |
2728fd2f TH |
260 | |
261 | /* hot fields used during command issue, aligned to cacheline */ | |
262 | unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */ | |
263 | struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */ | |
df2d5ae4 | 264 | struct pool_workqueue __rcu *numa_pwq_tbl[]; /* FR: unbound pwqs indexed by node */ |
1da177e4 LT |
265 | }; |
266 | ||
e904e6c2 TH |
267 | static struct kmem_cache *pwq_cache; |
268 | ||
bce90380 TH |
269 | static int wq_numa_tbl_len; /* highest possible NUMA node id + 1 */ |
270 | static cpumask_var_t *wq_numa_possible_cpumask; | |
271 | /* possible CPUs of each node */ | |
272 | ||
d55262c4 TH |
273 | static bool wq_disable_numa; |
274 | module_param_named(disable_numa, wq_disable_numa, bool, 0444); | |
275 | ||
cee22a15 VK |
276 | /* see the comment above the definition of WQ_POWER_EFFICIENT */ |
277 | #ifdef CONFIG_WQ_POWER_EFFICIENT_DEFAULT | |
278 | static bool wq_power_efficient = true; | |
279 | #else | |
280 | static bool wq_power_efficient; | |
281 | #endif | |
282 | ||
283 | module_param_named(power_efficient, wq_power_efficient, bool, 0444); | |
284 | ||
bce90380 TH |
285 | static bool wq_numa_enabled; /* unbound NUMA affinity enabled */ |
286 | ||
4c16bd32 TH |
287 | /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */ |
288 | static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf; | |
289 | ||
68e13a67 | 290 | static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */ |
2e109a28 | 291 | static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */ |
5bcab335 | 292 | |
68e13a67 LJ |
293 | static LIST_HEAD(workqueues); /* PL: list of all workqueues */ |
294 | static bool workqueue_freezing; /* PL: have wqs started freezing? */ | |
7d19c5ce TH |
295 | |
296 | /* the per-cpu worker pools */ | |
297 | static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], | |
298 | cpu_worker_pools); | |
299 | ||
68e13a67 | 300 | static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */ |
7d19c5ce | 301 | |
68e13a67 | 302 | /* PL: hash of all unbound pools keyed by pool->attrs */ |
29c91e99 TH |
303 | static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER); |
304 | ||
c5aa87bb | 305 | /* I: attributes used when instantiating standard unbound pools on demand */ |
29c91e99 TH |
306 | static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS]; |
307 | ||
8a2b7538 TH |
308 | /* I: attributes used when instantiating ordered pools on demand */ |
309 | static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS]; | |
310 | ||
d320c038 | 311 | struct workqueue_struct *system_wq __read_mostly; |
ad7b1f84 | 312 | EXPORT_SYMBOL(system_wq); |
044c782c | 313 | struct workqueue_struct *system_highpri_wq __read_mostly; |
1aabe902 | 314 | EXPORT_SYMBOL_GPL(system_highpri_wq); |
044c782c | 315 | struct workqueue_struct *system_long_wq __read_mostly; |
d320c038 | 316 | EXPORT_SYMBOL_GPL(system_long_wq); |
044c782c | 317 | struct workqueue_struct *system_unbound_wq __read_mostly; |
f3421797 | 318 | EXPORT_SYMBOL_GPL(system_unbound_wq); |
044c782c | 319 | struct workqueue_struct *system_freezable_wq __read_mostly; |
24d51add | 320 | EXPORT_SYMBOL_GPL(system_freezable_wq); |
0668106c VK |
321 | struct workqueue_struct *system_power_efficient_wq __read_mostly; |
322 | EXPORT_SYMBOL_GPL(system_power_efficient_wq); | |
323 | struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly; | |
324 | EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq); | |
d320c038 | 325 | |
7d19c5ce TH |
326 | static int worker_thread(void *__worker); |
327 | static void copy_workqueue_attrs(struct workqueue_attrs *to, | |
328 | const struct workqueue_attrs *from); | |
329 | ||
97bd2347 TH |
330 | #define CREATE_TRACE_POINTS |
331 | #include <trace/events/workqueue.h> | |
332 | ||
68e13a67 | 333 | #define assert_rcu_or_pool_mutex() \ |
5bcab335 | 334 | rcu_lockdep_assert(rcu_read_lock_sched_held() || \ |
68e13a67 LJ |
335 | lockdep_is_held(&wq_pool_mutex), \ |
336 | "sched RCU or wq_pool_mutex should be held") | |
5bcab335 | 337 | |
b09f4fd3 | 338 | #define assert_rcu_or_wq_mutex(wq) \ |
76af4d93 | 339 | rcu_lockdep_assert(rcu_read_lock_sched_held() || \ |
b5927605 | 340 | lockdep_is_held(&wq->mutex), \ |
b09f4fd3 | 341 | "sched RCU or wq->mutex should be held") |
76af4d93 | 342 | |
f02ae73a TH |
343 | #define for_each_cpu_worker_pool(pool, cpu) \ |
344 | for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \ | |
345 | (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \ | |
7a62c2c8 | 346 | (pool)++) |
4ce62e9e | 347 | |
17116969 TH |
348 | /** |
349 | * for_each_pool - iterate through all worker_pools in the system | |
350 | * @pool: iteration cursor | |
611c92a0 | 351 | * @pi: integer used for iteration |
fa1b54e6 | 352 | * |
68e13a67 LJ |
353 | * This must be called either with wq_pool_mutex held or sched RCU read |
354 | * locked. If the pool needs to be used beyond the locking in effect, the | |
355 | * caller is responsible for guaranteeing that the pool stays online. | |
fa1b54e6 TH |
356 | * |
357 | * The if/else clause exists only for the lockdep assertion and can be | |
358 | * ignored. | |
17116969 | 359 | */ |
611c92a0 TH |
360 | #define for_each_pool(pool, pi) \ |
361 | idr_for_each_entry(&worker_pool_idr, pool, pi) \ | |
68e13a67 | 362 | if (({ assert_rcu_or_pool_mutex(); false; })) { } \ |
fa1b54e6 | 363 | else |
17116969 | 364 | |
822d8405 TH |
365 | /** |
366 | * for_each_pool_worker - iterate through all workers of a worker_pool | |
367 | * @worker: iteration cursor | |
822d8405 TH |
368 | * @pool: worker_pool to iterate workers of |
369 | * | |
92f9c5c4 | 370 | * This must be called with @pool->attach_mutex. |
822d8405 TH |
371 | * |
372 | * The if/else clause exists only for the lockdep assertion and can be | |
373 | * ignored. | |
374 | */ | |
da028469 LJ |
375 | #define for_each_pool_worker(worker, pool) \ |
376 | list_for_each_entry((worker), &(pool)->workers, node) \ | |
92f9c5c4 | 377 | if (({ lockdep_assert_held(&pool->attach_mutex); false; })) { } \ |
822d8405 TH |
378 | else |
379 | ||
49e3cf44 TH |
380 | /** |
381 | * for_each_pwq - iterate through all pool_workqueues of the specified workqueue | |
382 | * @pwq: iteration cursor | |
383 | * @wq: the target workqueue | |
76af4d93 | 384 | * |
b09f4fd3 | 385 | * This must be called either with wq->mutex held or sched RCU read locked. |
794b18bc TH |
386 | * If the pwq needs to be used beyond the locking in effect, the caller is |
387 | * responsible for guaranteeing that the pwq stays online. | |
76af4d93 TH |
388 | * |
389 | * The if/else clause exists only for the lockdep assertion and can be | |
390 | * ignored. | |
49e3cf44 TH |
391 | */ |
392 | #define for_each_pwq(pwq, wq) \ | |
76af4d93 | 393 | list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \ |
b09f4fd3 | 394 | if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \ |
76af4d93 | 395 | else |
f3421797 | 396 | |
dc186ad7 TG |
397 | #ifdef CONFIG_DEBUG_OBJECTS_WORK |
398 | ||
399 | static struct debug_obj_descr work_debug_descr; | |
400 | ||
99777288 SG |
401 | static void *work_debug_hint(void *addr) |
402 | { | |
403 | return ((struct work_struct *) addr)->func; | |
404 | } | |
405 | ||
dc186ad7 TG |
406 | /* |
407 | * fixup_init is called when: | |
408 | * - an active object is initialized | |
409 | */ | |
410 | static int work_fixup_init(void *addr, enum debug_obj_state state) | |
411 | { | |
412 | struct work_struct *work = addr; | |
413 | ||
414 | switch (state) { | |
415 | case ODEBUG_STATE_ACTIVE: | |
416 | cancel_work_sync(work); | |
417 | debug_object_init(work, &work_debug_descr); | |
418 | return 1; | |
419 | default: | |
420 | return 0; | |
421 | } | |
422 | } | |
423 | ||
424 | /* | |
425 | * fixup_activate is called when: | |
426 | * - an active object is activated | |
427 | * - an unknown object is activated (might be a statically initialized object) | |
428 | */ | |
429 | static int work_fixup_activate(void *addr, enum debug_obj_state state) | |
430 | { | |
431 | struct work_struct *work = addr; | |
432 | ||
433 | switch (state) { | |
434 | ||
435 | case ODEBUG_STATE_NOTAVAILABLE: | |
436 | /* | |
437 | * This is not really a fixup. The work struct was | |
438 | * statically initialized. We just make sure that it | |
439 | * is tracked in the object tracker. | |
440 | */ | |
22df02bb | 441 | if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) { |
dc186ad7 TG |
442 | debug_object_init(work, &work_debug_descr); |
443 | debug_object_activate(work, &work_debug_descr); | |
444 | return 0; | |
445 | } | |
446 | WARN_ON_ONCE(1); | |
447 | return 0; | |
448 | ||
449 | case ODEBUG_STATE_ACTIVE: | |
450 | WARN_ON(1); | |
451 | ||
452 | default: | |
453 | return 0; | |
454 | } | |
455 | } | |
456 | ||
457 | /* | |
458 | * fixup_free is called when: | |
459 | * - an active object is freed | |
460 | */ | |
461 | static int work_fixup_free(void *addr, enum debug_obj_state state) | |
462 | { | |
463 | struct work_struct *work = addr; | |
464 | ||
465 | switch (state) { | |
466 | case ODEBUG_STATE_ACTIVE: | |
467 | cancel_work_sync(work); | |
468 | debug_object_free(work, &work_debug_descr); | |
469 | return 1; | |
470 | default: | |
471 | return 0; | |
472 | } | |
473 | } | |
474 | ||
475 | static struct debug_obj_descr work_debug_descr = { | |
476 | .name = "work_struct", | |
99777288 | 477 | .debug_hint = work_debug_hint, |
dc186ad7 TG |
478 | .fixup_init = work_fixup_init, |
479 | .fixup_activate = work_fixup_activate, | |
480 | .fixup_free = work_fixup_free, | |
481 | }; | |
482 | ||
483 | static inline void debug_work_activate(struct work_struct *work) | |
484 | { | |
485 | debug_object_activate(work, &work_debug_descr); | |
486 | } | |
487 | ||
488 | static inline void debug_work_deactivate(struct work_struct *work) | |
489 | { | |
490 | debug_object_deactivate(work, &work_debug_descr); | |
491 | } | |
492 | ||
493 | void __init_work(struct work_struct *work, int onstack) | |
494 | { | |
495 | if (onstack) | |
496 | debug_object_init_on_stack(work, &work_debug_descr); | |
497 | else | |
498 | debug_object_init(work, &work_debug_descr); | |
499 | } | |
500 | EXPORT_SYMBOL_GPL(__init_work); | |
501 | ||
502 | void destroy_work_on_stack(struct work_struct *work) | |
503 | { | |
504 | debug_object_free(work, &work_debug_descr); | |
505 | } | |
506 | EXPORT_SYMBOL_GPL(destroy_work_on_stack); | |
507 | ||
ea2e64f2 TG |
508 | void destroy_delayed_work_on_stack(struct delayed_work *work) |
509 | { | |
510 | destroy_timer_on_stack(&work->timer); | |
511 | debug_object_free(&work->work, &work_debug_descr); | |
512 | } | |
513 | EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack); | |
514 | ||
dc186ad7 TG |
515 | #else |
516 | static inline void debug_work_activate(struct work_struct *work) { } | |
517 | static inline void debug_work_deactivate(struct work_struct *work) { } | |
518 | #endif | |
519 | ||
4e8b22bd LB |
520 | /** |
521 | * worker_pool_assign_id - allocate ID and assing it to @pool | |
522 | * @pool: the pool pointer of interest | |
523 | * | |
524 | * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned | |
525 | * successfully, -errno on failure. | |
526 | */ | |
9daf9e67 TH |
527 | static int worker_pool_assign_id(struct worker_pool *pool) |
528 | { | |
529 | int ret; | |
530 | ||
68e13a67 | 531 | lockdep_assert_held(&wq_pool_mutex); |
5bcab335 | 532 | |
4e8b22bd LB |
533 | ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE, |
534 | GFP_KERNEL); | |
229641a6 | 535 | if (ret >= 0) { |
e68035fb | 536 | pool->id = ret; |
229641a6 TH |
537 | return 0; |
538 | } | |
fa1b54e6 | 539 | return ret; |
7c3eed5c TH |
540 | } |
541 | ||
df2d5ae4 TH |
542 | /** |
543 | * unbound_pwq_by_node - return the unbound pool_workqueue for the given node | |
544 | * @wq: the target workqueue | |
545 | * @node: the node ID | |
546 | * | |
547 | * This must be called either with pwq_lock held or sched RCU read locked. | |
548 | * If the pwq needs to be used beyond the locking in effect, the caller is | |
549 | * responsible for guaranteeing that the pwq stays online. | |
d185af30 YB |
550 | * |
551 | * Return: The unbound pool_workqueue for @node. | |
df2d5ae4 TH |
552 | */ |
553 | static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq, | |
554 | int node) | |
555 | { | |
556 | assert_rcu_or_wq_mutex(wq); | |
557 | return rcu_dereference_raw(wq->numa_pwq_tbl[node]); | |
558 | } | |
559 | ||
73f53c4a TH |
560 | static unsigned int work_color_to_flags(int color) |
561 | { | |
562 | return color << WORK_STRUCT_COLOR_SHIFT; | |
563 | } | |
564 | ||
565 | static int get_work_color(struct work_struct *work) | |
566 | { | |
567 | return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) & | |
568 | ((1 << WORK_STRUCT_COLOR_BITS) - 1); | |
569 | } | |
570 | ||
571 | static int work_next_color(int color) | |
572 | { | |
573 | return (color + 1) % WORK_NR_COLORS; | |
574 | } | |
1da177e4 | 575 | |
14441960 | 576 | /* |
112202d9 TH |
577 | * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data |
578 | * contain the pointer to the queued pwq. Once execution starts, the flag | |
7c3eed5c | 579 | * is cleared and the high bits contain OFFQ flags and pool ID. |
7a22ad75 | 580 | * |
112202d9 TH |
581 | * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling() |
582 | * and clear_work_data() can be used to set the pwq, pool or clear | |
bbb68dfa TH |
583 | * work->data. These functions should only be called while the work is |
584 | * owned - ie. while the PENDING bit is set. | |
7a22ad75 | 585 | * |
112202d9 | 586 | * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq |
7c3eed5c | 587 | * corresponding to a work. Pool is available once the work has been |
112202d9 | 588 | * queued anywhere after initialization until it is sync canceled. pwq is |
7c3eed5c | 589 | * available only while the work item is queued. |
7a22ad75 | 590 | * |
bbb68dfa TH |
591 | * %WORK_OFFQ_CANCELING is used to mark a work item which is being |
592 | * canceled. While being canceled, a work item may have its PENDING set | |
593 | * but stay off timer and worklist for arbitrarily long and nobody should | |
594 | * try to steal the PENDING bit. | |
14441960 | 595 | */ |
7a22ad75 TH |
596 | static inline void set_work_data(struct work_struct *work, unsigned long data, |
597 | unsigned long flags) | |
365970a1 | 598 | { |
6183c009 | 599 | WARN_ON_ONCE(!work_pending(work)); |
7a22ad75 TH |
600 | atomic_long_set(&work->data, data | flags | work_static(work)); |
601 | } | |
365970a1 | 602 | |
112202d9 | 603 | static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq, |
7a22ad75 TH |
604 | unsigned long extra_flags) |
605 | { | |
112202d9 TH |
606 | set_work_data(work, (unsigned long)pwq, |
607 | WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags); | |
365970a1 DH |
608 | } |
609 | ||
4468a00f LJ |
610 | static void set_work_pool_and_keep_pending(struct work_struct *work, |
611 | int pool_id) | |
612 | { | |
613 | set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, | |
614 | WORK_STRUCT_PENDING); | |
615 | } | |
616 | ||
7c3eed5c TH |
617 | static void set_work_pool_and_clear_pending(struct work_struct *work, |
618 | int pool_id) | |
7a22ad75 | 619 | { |
23657bb1 TH |
620 | /* |
621 | * The following wmb is paired with the implied mb in | |
622 | * test_and_set_bit(PENDING) and ensures all updates to @work made | |
623 | * here are visible to and precede any updates by the next PENDING | |
624 | * owner. | |
625 | */ | |
626 | smp_wmb(); | |
7c3eed5c | 627 | set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0); |
7a22ad75 | 628 | } |
f756d5e2 | 629 | |
7a22ad75 | 630 | static void clear_work_data(struct work_struct *work) |
1da177e4 | 631 | { |
7c3eed5c TH |
632 | smp_wmb(); /* see set_work_pool_and_clear_pending() */ |
633 | set_work_data(work, WORK_STRUCT_NO_POOL, 0); | |
1da177e4 LT |
634 | } |
635 | ||
112202d9 | 636 | static struct pool_workqueue *get_work_pwq(struct work_struct *work) |
b1f4ec17 | 637 | { |
e120153d | 638 | unsigned long data = atomic_long_read(&work->data); |
7a22ad75 | 639 | |
112202d9 | 640 | if (data & WORK_STRUCT_PWQ) |
e120153d TH |
641 | return (void *)(data & WORK_STRUCT_WQ_DATA_MASK); |
642 | else | |
643 | return NULL; | |
4d707b9f ON |
644 | } |
645 | ||
7c3eed5c TH |
646 | /** |
647 | * get_work_pool - return the worker_pool a given work was associated with | |
648 | * @work: the work item of interest | |
649 | * | |
68e13a67 LJ |
650 | * Pools are created and destroyed under wq_pool_mutex, and allows read |
651 | * access under sched-RCU read lock. As such, this function should be | |
652 | * called under wq_pool_mutex or with preemption disabled. | |
fa1b54e6 TH |
653 | * |
654 | * All fields of the returned pool are accessible as long as the above | |
655 | * mentioned locking is in effect. If the returned pool needs to be used | |
656 | * beyond the critical section, the caller is responsible for ensuring the | |
657 | * returned pool is and stays online. | |
d185af30 YB |
658 | * |
659 | * Return: The worker_pool @work was last associated with. %NULL if none. | |
7c3eed5c TH |
660 | */ |
661 | static struct worker_pool *get_work_pool(struct work_struct *work) | |
365970a1 | 662 | { |
e120153d | 663 | unsigned long data = atomic_long_read(&work->data); |
7c3eed5c | 664 | int pool_id; |
7a22ad75 | 665 | |
68e13a67 | 666 | assert_rcu_or_pool_mutex(); |
fa1b54e6 | 667 | |
112202d9 TH |
668 | if (data & WORK_STRUCT_PWQ) |
669 | return ((struct pool_workqueue *) | |
7c3eed5c | 670 | (data & WORK_STRUCT_WQ_DATA_MASK))->pool; |
7a22ad75 | 671 | |
7c3eed5c TH |
672 | pool_id = data >> WORK_OFFQ_POOL_SHIFT; |
673 | if (pool_id == WORK_OFFQ_POOL_NONE) | |
7a22ad75 TH |
674 | return NULL; |
675 | ||
fa1b54e6 | 676 | return idr_find(&worker_pool_idr, pool_id); |
7c3eed5c TH |
677 | } |
678 | ||
679 | /** | |
680 | * get_work_pool_id - return the worker pool ID a given work is associated with | |
681 | * @work: the work item of interest | |
682 | * | |
d185af30 | 683 | * Return: The worker_pool ID @work was last associated with. |
7c3eed5c TH |
684 | * %WORK_OFFQ_POOL_NONE if none. |
685 | */ | |
686 | static int get_work_pool_id(struct work_struct *work) | |
687 | { | |
54d5b7d0 LJ |
688 | unsigned long data = atomic_long_read(&work->data); |
689 | ||
112202d9 TH |
690 | if (data & WORK_STRUCT_PWQ) |
691 | return ((struct pool_workqueue *) | |
54d5b7d0 | 692 | (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id; |
7c3eed5c | 693 | |
54d5b7d0 | 694 | return data >> WORK_OFFQ_POOL_SHIFT; |
7c3eed5c TH |
695 | } |
696 | ||
bbb68dfa TH |
697 | static void mark_work_canceling(struct work_struct *work) |
698 | { | |
7c3eed5c | 699 | unsigned long pool_id = get_work_pool_id(work); |
bbb68dfa | 700 | |
7c3eed5c TH |
701 | pool_id <<= WORK_OFFQ_POOL_SHIFT; |
702 | set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING); | |
bbb68dfa TH |
703 | } |
704 | ||
705 | static bool work_is_canceling(struct work_struct *work) | |
706 | { | |
707 | unsigned long data = atomic_long_read(&work->data); | |
708 | ||
112202d9 | 709 | return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING); |
bbb68dfa TH |
710 | } |
711 | ||
e22bee78 | 712 | /* |
3270476a TH |
713 | * Policy functions. These define the policies on how the global worker |
714 | * pools are managed. Unless noted otherwise, these functions assume that | |
d565ed63 | 715 | * they're being called with pool->lock held. |
e22bee78 TH |
716 | */ |
717 | ||
63d95a91 | 718 | static bool __need_more_worker(struct worker_pool *pool) |
a848e3b6 | 719 | { |
e19e397a | 720 | return !atomic_read(&pool->nr_running); |
a848e3b6 ON |
721 | } |
722 | ||
4594bf15 | 723 | /* |
e22bee78 TH |
724 | * Need to wake up a worker? Called from anything but currently |
725 | * running workers. | |
974271c4 TH |
726 | * |
727 | * Note that, because unbound workers never contribute to nr_running, this | |
706026c2 | 728 | * function will always return %true for unbound pools as long as the |
974271c4 | 729 | * worklist isn't empty. |
4594bf15 | 730 | */ |
63d95a91 | 731 | static bool need_more_worker(struct worker_pool *pool) |
365970a1 | 732 | { |
63d95a91 | 733 | return !list_empty(&pool->worklist) && __need_more_worker(pool); |
e22bee78 | 734 | } |
4594bf15 | 735 | |
e22bee78 | 736 | /* Can I start working? Called from busy but !running workers. */ |
63d95a91 | 737 | static bool may_start_working(struct worker_pool *pool) |
e22bee78 | 738 | { |
63d95a91 | 739 | return pool->nr_idle; |
e22bee78 TH |
740 | } |
741 | ||
742 | /* Do I need to keep working? Called from currently running workers. */ | |
63d95a91 | 743 | static bool keep_working(struct worker_pool *pool) |
e22bee78 | 744 | { |
e19e397a TH |
745 | return !list_empty(&pool->worklist) && |
746 | atomic_read(&pool->nr_running) <= 1; | |
e22bee78 TH |
747 | } |
748 | ||
749 | /* Do we need a new worker? Called from manager. */ | |
63d95a91 | 750 | static bool need_to_create_worker(struct worker_pool *pool) |
e22bee78 | 751 | { |
63d95a91 | 752 | return need_more_worker(pool) && !may_start_working(pool); |
e22bee78 | 753 | } |
365970a1 | 754 | |
e22bee78 | 755 | /* Do we have too many workers and should some go away? */ |
63d95a91 | 756 | static bool too_many_workers(struct worker_pool *pool) |
e22bee78 | 757 | { |
34a06bd6 | 758 | bool managing = mutex_is_locked(&pool->manager_arb); |
63d95a91 TH |
759 | int nr_idle = pool->nr_idle + managing; /* manager is considered idle */ |
760 | int nr_busy = pool->nr_workers - nr_idle; | |
e22bee78 | 761 | |
ea1abd61 LJ |
762 | /* |
763 | * nr_idle and idle_list may disagree if idle rebinding is in | |
764 | * progress. Never return %true if idle_list is empty. | |
765 | */ | |
766 | if (list_empty(&pool->idle_list)) | |
767 | return false; | |
768 | ||
e22bee78 | 769 | return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; |
365970a1 DH |
770 | } |
771 | ||
4d707b9f | 772 | /* |
e22bee78 TH |
773 | * Wake up functions. |
774 | */ | |
775 | ||
1037de36 LJ |
776 | /* Return the first idle worker. Safe with preemption disabled */ |
777 | static struct worker *first_idle_worker(struct worker_pool *pool) | |
7e11629d | 778 | { |
63d95a91 | 779 | if (unlikely(list_empty(&pool->idle_list))) |
7e11629d TH |
780 | return NULL; |
781 | ||
63d95a91 | 782 | return list_first_entry(&pool->idle_list, struct worker, entry); |
7e11629d TH |
783 | } |
784 | ||
785 | /** | |
786 | * wake_up_worker - wake up an idle worker | |
63d95a91 | 787 | * @pool: worker pool to wake worker from |
7e11629d | 788 | * |
63d95a91 | 789 | * Wake up the first idle worker of @pool. |
7e11629d TH |
790 | * |
791 | * CONTEXT: | |
d565ed63 | 792 | * spin_lock_irq(pool->lock). |
7e11629d | 793 | */ |
63d95a91 | 794 | static void wake_up_worker(struct worker_pool *pool) |
7e11629d | 795 | { |
1037de36 | 796 | struct worker *worker = first_idle_worker(pool); |
7e11629d TH |
797 | |
798 | if (likely(worker)) | |
799 | wake_up_process(worker->task); | |
800 | } | |
801 | ||
d302f017 | 802 | /** |
e22bee78 TH |
803 | * wq_worker_waking_up - a worker is waking up |
804 | * @task: task waking up | |
805 | * @cpu: CPU @task is waking up to | |
806 | * | |
807 | * This function is called during try_to_wake_up() when a worker is | |
808 | * being awoken. | |
809 | * | |
810 | * CONTEXT: | |
811 | * spin_lock_irq(rq->lock) | |
812 | */ | |
d84ff051 | 813 | void wq_worker_waking_up(struct task_struct *task, int cpu) |
e22bee78 TH |
814 | { |
815 | struct worker *worker = kthread_data(task); | |
816 | ||
36576000 | 817 | if (!(worker->flags & WORKER_NOT_RUNNING)) { |
ec22ca5e | 818 | WARN_ON_ONCE(worker->pool->cpu != cpu); |
e19e397a | 819 | atomic_inc(&worker->pool->nr_running); |
36576000 | 820 | } |
e22bee78 TH |
821 | } |
822 | ||
823 | /** | |
824 | * wq_worker_sleeping - a worker is going to sleep | |
825 | * @task: task going to sleep | |
826 | * @cpu: CPU in question, must be the current CPU number | |
827 | * | |
828 | * This function is called during schedule() when a busy worker is | |
829 | * going to sleep. Worker on the same cpu can be woken up by | |
830 | * returning pointer to its task. | |
831 | * | |
832 | * CONTEXT: | |
833 | * spin_lock_irq(rq->lock) | |
834 | * | |
d185af30 | 835 | * Return: |
e22bee78 TH |
836 | * Worker task on @cpu to wake up, %NULL if none. |
837 | */ | |
d84ff051 | 838 | struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu) |
e22bee78 TH |
839 | { |
840 | struct worker *worker = kthread_data(task), *to_wakeup = NULL; | |
111c225a | 841 | struct worker_pool *pool; |
e22bee78 | 842 | |
111c225a TH |
843 | /* |
844 | * Rescuers, which may not have all the fields set up like normal | |
845 | * workers, also reach here, let's not access anything before | |
846 | * checking NOT_RUNNING. | |
847 | */ | |
2d64672e | 848 | if (worker->flags & WORKER_NOT_RUNNING) |
e22bee78 TH |
849 | return NULL; |
850 | ||
111c225a | 851 | pool = worker->pool; |
111c225a | 852 | |
e22bee78 | 853 | /* this can only happen on the local cpu */ |
6183c009 TH |
854 | if (WARN_ON_ONCE(cpu != raw_smp_processor_id())) |
855 | return NULL; | |
e22bee78 TH |
856 | |
857 | /* | |
858 | * The counterpart of the following dec_and_test, implied mb, | |
859 | * worklist not empty test sequence is in insert_work(). | |
860 | * Please read comment there. | |
861 | * | |
628c78e7 TH |
862 | * NOT_RUNNING is clear. This means that we're bound to and |
863 | * running on the local cpu w/ rq lock held and preemption | |
864 | * disabled, which in turn means that none else could be | |
d565ed63 | 865 | * manipulating idle_list, so dereferencing idle_list without pool |
628c78e7 | 866 | * lock is safe. |
e22bee78 | 867 | */ |
e19e397a TH |
868 | if (atomic_dec_and_test(&pool->nr_running) && |
869 | !list_empty(&pool->worklist)) | |
1037de36 | 870 | to_wakeup = first_idle_worker(pool); |
e22bee78 TH |
871 | return to_wakeup ? to_wakeup->task : NULL; |
872 | } | |
873 | ||
874 | /** | |
875 | * worker_set_flags - set worker flags and adjust nr_running accordingly | |
cb444766 | 876 | * @worker: self |
d302f017 TH |
877 | * @flags: flags to set |
878 | * @wakeup: wakeup an idle worker if necessary | |
879 | * | |
e22bee78 TH |
880 | * Set @flags in @worker->flags and adjust nr_running accordingly. If |
881 | * nr_running becomes zero and @wakeup is %true, an idle worker is | |
882 | * woken up. | |
d302f017 | 883 | * |
cb444766 | 884 | * CONTEXT: |
d565ed63 | 885 | * spin_lock_irq(pool->lock) |
d302f017 TH |
886 | */ |
887 | static inline void worker_set_flags(struct worker *worker, unsigned int flags, | |
888 | bool wakeup) | |
889 | { | |
bd7bdd43 | 890 | struct worker_pool *pool = worker->pool; |
e22bee78 | 891 | |
cb444766 TH |
892 | WARN_ON_ONCE(worker->task != current); |
893 | ||
e22bee78 TH |
894 | /* |
895 | * If transitioning into NOT_RUNNING, adjust nr_running and | |
896 | * wake up an idle worker as necessary if requested by | |
897 | * @wakeup. | |
898 | */ | |
899 | if ((flags & WORKER_NOT_RUNNING) && | |
900 | !(worker->flags & WORKER_NOT_RUNNING)) { | |
e22bee78 | 901 | if (wakeup) { |
e19e397a | 902 | if (atomic_dec_and_test(&pool->nr_running) && |
bd7bdd43 | 903 | !list_empty(&pool->worklist)) |
63d95a91 | 904 | wake_up_worker(pool); |
e22bee78 | 905 | } else |
e19e397a | 906 | atomic_dec(&pool->nr_running); |
e22bee78 TH |
907 | } |
908 | ||
d302f017 TH |
909 | worker->flags |= flags; |
910 | } | |
911 | ||
912 | /** | |
e22bee78 | 913 | * worker_clr_flags - clear worker flags and adjust nr_running accordingly |
cb444766 | 914 | * @worker: self |
d302f017 TH |
915 | * @flags: flags to clear |
916 | * | |
e22bee78 | 917 | * Clear @flags in @worker->flags and adjust nr_running accordingly. |
d302f017 | 918 | * |
cb444766 | 919 | * CONTEXT: |
d565ed63 | 920 | * spin_lock_irq(pool->lock) |
d302f017 TH |
921 | */ |
922 | static inline void worker_clr_flags(struct worker *worker, unsigned int flags) | |
923 | { | |
63d95a91 | 924 | struct worker_pool *pool = worker->pool; |
e22bee78 TH |
925 | unsigned int oflags = worker->flags; |
926 | ||
cb444766 TH |
927 | WARN_ON_ONCE(worker->task != current); |
928 | ||
d302f017 | 929 | worker->flags &= ~flags; |
e22bee78 | 930 | |
42c025f3 TH |
931 | /* |
932 | * If transitioning out of NOT_RUNNING, increment nr_running. Note | |
933 | * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask | |
934 | * of multiple flags, not a single flag. | |
935 | */ | |
e22bee78 TH |
936 | if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) |
937 | if (!(worker->flags & WORKER_NOT_RUNNING)) | |
e19e397a | 938 | atomic_inc(&pool->nr_running); |
d302f017 TH |
939 | } |
940 | ||
8cca0eea TH |
941 | /** |
942 | * find_worker_executing_work - find worker which is executing a work | |
c9e7cf27 | 943 | * @pool: pool of interest |
8cca0eea TH |
944 | * @work: work to find worker for |
945 | * | |
c9e7cf27 TH |
946 | * Find a worker which is executing @work on @pool by searching |
947 | * @pool->busy_hash which is keyed by the address of @work. For a worker | |
a2c1c57b TH |
948 | * to match, its current execution should match the address of @work and |
949 | * its work function. This is to avoid unwanted dependency between | |
950 | * unrelated work executions through a work item being recycled while still | |
951 | * being executed. | |
952 | * | |
953 | * This is a bit tricky. A work item may be freed once its execution | |
954 | * starts and nothing prevents the freed area from being recycled for | |
955 | * another work item. If the same work item address ends up being reused | |
956 | * before the original execution finishes, workqueue will identify the | |
957 | * recycled work item as currently executing and make it wait until the | |
958 | * current execution finishes, introducing an unwanted dependency. | |
959 | * | |
c5aa87bb TH |
960 | * This function checks the work item address and work function to avoid |
961 | * false positives. Note that this isn't complete as one may construct a | |
962 | * work function which can introduce dependency onto itself through a | |
963 | * recycled work item. Well, if somebody wants to shoot oneself in the | |
964 | * foot that badly, there's only so much we can do, and if such deadlock | |
965 | * actually occurs, it should be easy to locate the culprit work function. | |
8cca0eea TH |
966 | * |
967 | * CONTEXT: | |
d565ed63 | 968 | * spin_lock_irq(pool->lock). |
8cca0eea | 969 | * |
d185af30 YB |
970 | * Return: |
971 | * Pointer to worker which is executing @work if found, %NULL | |
8cca0eea | 972 | * otherwise. |
4d707b9f | 973 | */ |
c9e7cf27 | 974 | static struct worker *find_worker_executing_work(struct worker_pool *pool, |
8cca0eea | 975 | struct work_struct *work) |
4d707b9f | 976 | { |
42f8570f | 977 | struct worker *worker; |
42f8570f | 978 | |
b67bfe0d | 979 | hash_for_each_possible(pool->busy_hash, worker, hentry, |
a2c1c57b TH |
980 | (unsigned long)work) |
981 | if (worker->current_work == work && | |
982 | worker->current_func == work->func) | |
42f8570f SL |
983 | return worker; |
984 | ||
985 | return NULL; | |
4d707b9f ON |
986 | } |
987 | ||
bf4ede01 TH |
988 | /** |
989 | * move_linked_works - move linked works to a list | |
990 | * @work: start of series of works to be scheduled | |
991 | * @head: target list to append @work to | |
992 | * @nextp: out paramter for nested worklist walking | |
993 | * | |
994 | * Schedule linked works starting from @work to @head. Work series to | |
995 | * be scheduled starts at @work and includes any consecutive work with | |
996 | * WORK_STRUCT_LINKED set in its predecessor. | |
997 | * | |
998 | * If @nextp is not NULL, it's updated to point to the next work of | |
999 | * the last scheduled work. This allows move_linked_works() to be | |
1000 | * nested inside outer list_for_each_entry_safe(). | |
1001 | * | |
1002 | * CONTEXT: | |
d565ed63 | 1003 | * spin_lock_irq(pool->lock). |
bf4ede01 TH |
1004 | */ |
1005 | static void move_linked_works(struct work_struct *work, struct list_head *head, | |
1006 | struct work_struct **nextp) | |
1007 | { | |
1008 | struct work_struct *n; | |
1009 | ||
1010 | /* | |
1011 | * Linked worklist will always end before the end of the list, | |
1012 | * use NULL for list head. | |
1013 | */ | |
1014 | list_for_each_entry_safe_from(work, n, NULL, entry) { | |
1015 | list_move_tail(&work->entry, head); | |
1016 | if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) | |
1017 | break; | |
1018 | } | |
1019 | ||
1020 | /* | |
1021 | * If we're already inside safe list traversal and have moved | |
1022 | * multiple works to the scheduled queue, the next position | |
1023 | * needs to be updated. | |
1024 | */ | |
1025 | if (nextp) | |
1026 | *nextp = n; | |
1027 | } | |
1028 | ||
8864b4e5 TH |
1029 | /** |
1030 | * get_pwq - get an extra reference on the specified pool_workqueue | |
1031 | * @pwq: pool_workqueue to get | |
1032 | * | |
1033 | * Obtain an extra reference on @pwq. The caller should guarantee that | |
1034 | * @pwq has positive refcnt and be holding the matching pool->lock. | |
1035 | */ | |
1036 | static void get_pwq(struct pool_workqueue *pwq) | |
1037 | { | |
1038 | lockdep_assert_held(&pwq->pool->lock); | |
1039 | WARN_ON_ONCE(pwq->refcnt <= 0); | |
1040 | pwq->refcnt++; | |
1041 | } | |
1042 | ||
1043 | /** | |
1044 | * put_pwq - put a pool_workqueue reference | |
1045 | * @pwq: pool_workqueue to put | |
1046 | * | |
1047 | * Drop a reference of @pwq. If its refcnt reaches zero, schedule its | |
1048 | * destruction. The caller should be holding the matching pool->lock. | |
1049 | */ | |
1050 | static void put_pwq(struct pool_workqueue *pwq) | |
1051 | { | |
1052 | lockdep_assert_held(&pwq->pool->lock); | |
1053 | if (likely(--pwq->refcnt)) | |
1054 | return; | |
1055 | if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND))) | |
1056 | return; | |
1057 | /* | |
1058 | * @pwq can't be released under pool->lock, bounce to | |
1059 | * pwq_unbound_release_workfn(). This never recurses on the same | |
1060 | * pool->lock as this path is taken only for unbound workqueues and | |
1061 | * the release work item is scheduled on a per-cpu workqueue. To | |
1062 | * avoid lockdep warning, unbound pool->locks are given lockdep | |
1063 | * subclass of 1 in get_unbound_pool(). | |
1064 | */ | |
1065 | schedule_work(&pwq->unbound_release_work); | |
1066 | } | |
1067 | ||
dce90d47 TH |
1068 | /** |
1069 | * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock | |
1070 | * @pwq: pool_workqueue to put (can be %NULL) | |
1071 | * | |
1072 | * put_pwq() with locking. This function also allows %NULL @pwq. | |
1073 | */ | |
1074 | static void put_pwq_unlocked(struct pool_workqueue *pwq) | |
1075 | { | |
1076 | if (pwq) { | |
1077 | /* | |
1078 | * As both pwqs and pools are sched-RCU protected, the | |
1079 | * following lock operations are safe. | |
1080 | */ | |
1081 | spin_lock_irq(&pwq->pool->lock); | |
1082 | put_pwq(pwq); | |
1083 | spin_unlock_irq(&pwq->pool->lock); | |
1084 | } | |
1085 | } | |
1086 | ||
112202d9 | 1087 | static void pwq_activate_delayed_work(struct work_struct *work) |
bf4ede01 | 1088 | { |
112202d9 | 1089 | struct pool_workqueue *pwq = get_work_pwq(work); |
bf4ede01 TH |
1090 | |
1091 | trace_workqueue_activate_work(work); | |
112202d9 | 1092 | move_linked_works(work, &pwq->pool->worklist, NULL); |
bf4ede01 | 1093 | __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work)); |
112202d9 | 1094 | pwq->nr_active++; |
bf4ede01 TH |
1095 | } |
1096 | ||
112202d9 | 1097 | static void pwq_activate_first_delayed(struct pool_workqueue *pwq) |
3aa62497 | 1098 | { |
112202d9 | 1099 | struct work_struct *work = list_first_entry(&pwq->delayed_works, |
3aa62497 LJ |
1100 | struct work_struct, entry); |
1101 | ||
112202d9 | 1102 | pwq_activate_delayed_work(work); |
3aa62497 LJ |
1103 | } |
1104 | ||
bf4ede01 | 1105 | /** |
112202d9 TH |
1106 | * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight |
1107 | * @pwq: pwq of interest | |
bf4ede01 | 1108 | * @color: color of work which left the queue |
bf4ede01 TH |
1109 | * |
1110 | * A work either has completed or is removed from pending queue, | |
112202d9 | 1111 | * decrement nr_in_flight of its pwq and handle workqueue flushing. |
bf4ede01 TH |
1112 | * |
1113 | * CONTEXT: | |
d565ed63 | 1114 | * spin_lock_irq(pool->lock). |
bf4ede01 | 1115 | */ |
112202d9 | 1116 | static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color) |
bf4ede01 | 1117 | { |
8864b4e5 | 1118 | /* uncolored work items don't participate in flushing or nr_active */ |
bf4ede01 | 1119 | if (color == WORK_NO_COLOR) |
8864b4e5 | 1120 | goto out_put; |
bf4ede01 | 1121 | |
112202d9 | 1122 | pwq->nr_in_flight[color]--; |
bf4ede01 | 1123 | |
112202d9 TH |
1124 | pwq->nr_active--; |
1125 | if (!list_empty(&pwq->delayed_works)) { | |
b3f9f405 | 1126 | /* one down, submit a delayed one */ |
112202d9 TH |
1127 | if (pwq->nr_active < pwq->max_active) |
1128 | pwq_activate_first_delayed(pwq); | |
bf4ede01 TH |
1129 | } |
1130 | ||
1131 | /* is flush in progress and are we at the flushing tip? */ | |
112202d9 | 1132 | if (likely(pwq->flush_color != color)) |
8864b4e5 | 1133 | goto out_put; |
bf4ede01 TH |
1134 | |
1135 | /* are there still in-flight works? */ | |
112202d9 | 1136 | if (pwq->nr_in_flight[color]) |
8864b4e5 | 1137 | goto out_put; |
bf4ede01 | 1138 | |
112202d9 TH |
1139 | /* this pwq is done, clear flush_color */ |
1140 | pwq->flush_color = -1; | |
bf4ede01 TH |
1141 | |
1142 | /* | |
112202d9 | 1143 | * If this was the last pwq, wake up the first flusher. It |
bf4ede01 TH |
1144 | * will handle the rest. |
1145 | */ | |
112202d9 TH |
1146 | if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush)) |
1147 | complete(&pwq->wq->first_flusher->done); | |
8864b4e5 TH |
1148 | out_put: |
1149 | put_pwq(pwq); | |
bf4ede01 TH |
1150 | } |
1151 | ||
36e227d2 | 1152 | /** |
bbb68dfa | 1153 | * try_to_grab_pending - steal work item from worklist and disable irq |
36e227d2 TH |
1154 | * @work: work item to steal |
1155 | * @is_dwork: @work is a delayed_work | |
bbb68dfa | 1156 | * @flags: place to store irq state |
36e227d2 TH |
1157 | * |
1158 | * Try to grab PENDING bit of @work. This function can handle @work in any | |
d185af30 | 1159 | * stable state - idle, on timer or on worklist. |
36e227d2 | 1160 | * |
d185af30 | 1161 | * Return: |
36e227d2 TH |
1162 | * 1 if @work was pending and we successfully stole PENDING |
1163 | * 0 if @work was idle and we claimed PENDING | |
1164 | * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry | |
bbb68dfa TH |
1165 | * -ENOENT if someone else is canceling @work, this state may persist |
1166 | * for arbitrarily long | |
36e227d2 | 1167 | * |
d185af30 | 1168 | * Note: |
bbb68dfa | 1169 | * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting |
e0aecdd8 TH |
1170 | * interrupted while holding PENDING and @work off queue, irq must be |
1171 | * disabled on entry. This, combined with delayed_work->timer being | |
1172 | * irqsafe, ensures that we return -EAGAIN for finite short period of time. | |
bbb68dfa TH |
1173 | * |
1174 | * On successful return, >= 0, irq is disabled and the caller is | |
1175 | * responsible for releasing it using local_irq_restore(*@flags). | |
1176 | * | |
e0aecdd8 | 1177 | * This function is safe to call from any context including IRQ handler. |
bf4ede01 | 1178 | */ |
bbb68dfa TH |
1179 | static int try_to_grab_pending(struct work_struct *work, bool is_dwork, |
1180 | unsigned long *flags) | |
bf4ede01 | 1181 | { |
d565ed63 | 1182 | struct worker_pool *pool; |
112202d9 | 1183 | struct pool_workqueue *pwq; |
bf4ede01 | 1184 | |
bbb68dfa TH |
1185 | local_irq_save(*flags); |
1186 | ||
36e227d2 TH |
1187 | /* try to steal the timer if it exists */ |
1188 | if (is_dwork) { | |
1189 | struct delayed_work *dwork = to_delayed_work(work); | |
1190 | ||
e0aecdd8 TH |
1191 | /* |
1192 | * dwork->timer is irqsafe. If del_timer() fails, it's | |
1193 | * guaranteed that the timer is not queued anywhere and not | |
1194 | * running on the local CPU. | |
1195 | */ | |
36e227d2 TH |
1196 | if (likely(del_timer(&dwork->timer))) |
1197 | return 1; | |
1198 | } | |
1199 | ||
1200 | /* try to claim PENDING the normal way */ | |
bf4ede01 TH |
1201 | if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) |
1202 | return 0; | |
1203 | ||
1204 | /* | |
1205 | * The queueing is in progress, or it is already queued. Try to | |
1206 | * steal it from ->worklist without clearing WORK_STRUCT_PENDING. | |
1207 | */ | |
d565ed63 TH |
1208 | pool = get_work_pool(work); |
1209 | if (!pool) | |
bbb68dfa | 1210 | goto fail; |
bf4ede01 | 1211 | |
d565ed63 | 1212 | spin_lock(&pool->lock); |
0b3dae68 | 1213 | /* |
112202d9 TH |
1214 | * work->data is guaranteed to point to pwq only while the work |
1215 | * item is queued on pwq->wq, and both updating work->data to point | |
1216 | * to pwq on queueing and to pool on dequeueing are done under | |
1217 | * pwq->pool->lock. This in turn guarantees that, if work->data | |
1218 | * points to pwq which is associated with a locked pool, the work | |
0b3dae68 LJ |
1219 | * item is currently queued on that pool. |
1220 | */ | |
112202d9 TH |
1221 | pwq = get_work_pwq(work); |
1222 | if (pwq && pwq->pool == pool) { | |
16062836 TH |
1223 | debug_work_deactivate(work); |
1224 | ||
1225 | /* | |
1226 | * A delayed work item cannot be grabbed directly because | |
1227 | * it might have linked NO_COLOR work items which, if left | |
112202d9 | 1228 | * on the delayed_list, will confuse pwq->nr_active |
16062836 TH |
1229 | * management later on and cause stall. Make sure the work |
1230 | * item is activated before grabbing. | |
1231 | */ | |
1232 | if (*work_data_bits(work) & WORK_STRUCT_DELAYED) | |
112202d9 | 1233 | pwq_activate_delayed_work(work); |
16062836 TH |
1234 | |
1235 | list_del_init(&work->entry); | |
112202d9 | 1236 | pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work)); |
16062836 | 1237 | |
112202d9 | 1238 | /* work->data points to pwq iff queued, point to pool */ |
16062836 TH |
1239 | set_work_pool_and_keep_pending(work, pool->id); |
1240 | ||
1241 | spin_unlock(&pool->lock); | |
1242 | return 1; | |
bf4ede01 | 1243 | } |
d565ed63 | 1244 | spin_unlock(&pool->lock); |
bbb68dfa TH |
1245 | fail: |
1246 | local_irq_restore(*flags); | |
1247 | if (work_is_canceling(work)) | |
1248 | return -ENOENT; | |
1249 | cpu_relax(); | |
36e227d2 | 1250 | return -EAGAIN; |
bf4ede01 TH |
1251 | } |
1252 | ||
4690c4ab | 1253 | /** |
706026c2 | 1254 | * insert_work - insert a work into a pool |
112202d9 | 1255 | * @pwq: pwq @work belongs to |
4690c4ab TH |
1256 | * @work: work to insert |
1257 | * @head: insertion point | |
1258 | * @extra_flags: extra WORK_STRUCT_* flags to set | |
1259 | * | |
112202d9 | 1260 | * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to |
706026c2 | 1261 | * work_struct flags. |
4690c4ab TH |
1262 | * |
1263 | * CONTEXT: | |
d565ed63 | 1264 | * spin_lock_irq(pool->lock). |
4690c4ab | 1265 | */ |
112202d9 TH |
1266 | static void insert_work(struct pool_workqueue *pwq, struct work_struct *work, |
1267 | struct list_head *head, unsigned int extra_flags) | |
b89deed3 | 1268 | { |
112202d9 | 1269 | struct worker_pool *pool = pwq->pool; |
e22bee78 | 1270 | |
4690c4ab | 1271 | /* we own @work, set data and link */ |
112202d9 | 1272 | set_work_pwq(work, pwq, extra_flags); |
1a4d9b0a | 1273 | list_add_tail(&work->entry, head); |
8864b4e5 | 1274 | get_pwq(pwq); |
e22bee78 TH |
1275 | |
1276 | /* | |
c5aa87bb TH |
1277 | * Ensure either wq_worker_sleeping() sees the above |
1278 | * list_add_tail() or we see zero nr_running to avoid workers lying | |
1279 | * around lazily while there are works to be processed. | |
e22bee78 TH |
1280 | */ |
1281 | smp_mb(); | |
1282 | ||
63d95a91 TH |
1283 | if (__need_more_worker(pool)) |
1284 | wake_up_worker(pool); | |
b89deed3 ON |
1285 | } |
1286 | ||
c8efcc25 TH |
1287 | /* |
1288 | * Test whether @work is being queued from another work executing on the | |
8d03ecfe | 1289 | * same workqueue. |
c8efcc25 TH |
1290 | */ |
1291 | static bool is_chained_work(struct workqueue_struct *wq) | |
1292 | { | |
8d03ecfe TH |
1293 | struct worker *worker; |
1294 | ||
1295 | worker = current_wq_worker(); | |
1296 | /* | |
1297 | * Return %true iff I'm a worker execuing a work item on @wq. If | |
1298 | * I'm @worker, it's safe to dereference it without locking. | |
1299 | */ | |
112202d9 | 1300 | return worker && worker->current_pwq->wq == wq; |
c8efcc25 TH |
1301 | } |
1302 | ||
d84ff051 | 1303 | static void __queue_work(int cpu, struct workqueue_struct *wq, |
1da177e4 LT |
1304 | struct work_struct *work) |
1305 | { | |
112202d9 | 1306 | struct pool_workqueue *pwq; |
c9178087 | 1307 | struct worker_pool *last_pool; |
1e19ffc6 | 1308 | struct list_head *worklist; |
8a2e8e5d | 1309 | unsigned int work_flags; |
b75cac93 | 1310 | unsigned int req_cpu = cpu; |
8930caba TH |
1311 | |
1312 | /* | |
1313 | * While a work item is PENDING && off queue, a task trying to | |
1314 | * steal the PENDING will busy-loop waiting for it to either get | |
1315 | * queued or lose PENDING. Grabbing PENDING and queueing should | |
1316 | * happen with IRQ disabled. | |
1317 | */ | |
1318 | WARN_ON_ONCE(!irqs_disabled()); | |
1da177e4 | 1319 | |
dc186ad7 | 1320 | debug_work_activate(work); |
1e19ffc6 | 1321 | |
9ef28a73 | 1322 | /* if draining, only works from the same workqueue are allowed */ |
618b01eb | 1323 | if (unlikely(wq->flags & __WQ_DRAINING) && |
c8efcc25 | 1324 | WARN_ON_ONCE(!is_chained_work(wq))) |
e41e704b | 1325 | return; |
9e8cd2f5 | 1326 | retry: |
df2d5ae4 TH |
1327 | if (req_cpu == WORK_CPU_UNBOUND) |
1328 | cpu = raw_smp_processor_id(); | |
1329 | ||
c9178087 | 1330 | /* pwq which will be used unless @work is executing elsewhere */ |
df2d5ae4 | 1331 | if (!(wq->flags & WQ_UNBOUND)) |
7fb98ea7 | 1332 | pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); |
df2d5ae4 TH |
1333 | else |
1334 | pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu)); | |
dbf2576e | 1335 | |
c9178087 TH |
1336 | /* |
1337 | * If @work was previously on a different pool, it might still be | |
1338 | * running there, in which case the work needs to be queued on that | |
1339 | * pool to guarantee non-reentrancy. | |
1340 | */ | |
1341 | last_pool = get_work_pool(work); | |
1342 | if (last_pool && last_pool != pwq->pool) { | |
1343 | struct worker *worker; | |
18aa9eff | 1344 | |
c9178087 | 1345 | spin_lock(&last_pool->lock); |
18aa9eff | 1346 | |
c9178087 | 1347 | worker = find_worker_executing_work(last_pool, work); |
18aa9eff | 1348 | |
c9178087 TH |
1349 | if (worker && worker->current_pwq->wq == wq) { |
1350 | pwq = worker->current_pwq; | |
8930caba | 1351 | } else { |
c9178087 TH |
1352 | /* meh... not running there, queue here */ |
1353 | spin_unlock(&last_pool->lock); | |
112202d9 | 1354 | spin_lock(&pwq->pool->lock); |
8930caba | 1355 | } |
f3421797 | 1356 | } else { |
112202d9 | 1357 | spin_lock(&pwq->pool->lock); |
502ca9d8 TH |
1358 | } |
1359 | ||
9e8cd2f5 TH |
1360 | /* |
1361 | * pwq is determined and locked. For unbound pools, we could have | |
1362 | * raced with pwq release and it could already be dead. If its | |
1363 | * refcnt is zero, repeat pwq selection. Note that pwqs never die | |
df2d5ae4 TH |
1364 | * without another pwq replacing it in the numa_pwq_tbl or while |
1365 | * work items are executing on it, so the retrying is guaranteed to | |
9e8cd2f5 TH |
1366 | * make forward-progress. |
1367 | */ | |
1368 | if (unlikely(!pwq->refcnt)) { | |
1369 | if (wq->flags & WQ_UNBOUND) { | |
1370 | spin_unlock(&pwq->pool->lock); | |
1371 | cpu_relax(); | |
1372 | goto retry; | |
1373 | } | |
1374 | /* oops */ | |
1375 | WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt", | |
1376 | wq->name, cpu); | |
1377 | } | |
1378 | ||
112202d9 TH |
1379 | /* pwq determined, queue */ |
1380 | trace_workqueue_queue_work(req_cpu, pwq, work); | |
502ca9d8 | 1381 | |
f5b2552b | 1382 | if (WARN_ON(!list_empty(&work->entry))) { |
112202d9 | 1383 | spin_unlock(&pwq->pool->lock); |
f5b2552b DC |
1384 | return; |
1385 | } | |
1e19ffc6 | 1386 | |
112202d9 TH |
1387 | pwq->nr_in_flight[pwq->work_color]++; |
1388 | work_flags = work_color_to_flags(pwq->work_color); | |
1e19ffc6 | 1389 | |
112202d9 | 1390 | if (likely(pwq->nr_active < pwq->max_active)) { |
cdadf009 | 1391 | trace_workqueue_activate_work(work); |
112202d9 TH |
1392 | pwq->nr_active++; |
1393 | worklist = &pwq->pool->worklist; | |
8a2e8e5d TH |
1394 | } else { |
1395 | work_flags |= WORK_STRUCT_DELAYED; | |
112202d9 | 1396 | worklist = &pwq->delayed_works; |
8a2e8e5d | 1397 | } |
1e19ffc6 | 1398 | |
112202d9 | 1399 | insert_work(pwq, work, worklist, work_flags); |
1e19ffc6 | 1400 | |
112202d9 | 1401 | spin_unlock(&pwq->pool->lock); |
1da177e4 LT |
1402 | } |
1403 | ||
0fcb78c2 | 1404 | /** |
c1a220e7 ZR |
1405 | * queue_work_on - queue work on specific cpu |
1406 | * @cpu: CPU number to execute work on | |
0fcb78c2 REB |
1407 | * @wq: workqueue to use |
1408 | * @work: work to queue | |
1409 | * | |
c1a220e7 ZR |
1410 | * We queue the work to a specific CPU, the caller must ensure it |
1411 | * can't go away. | |
d185af30 YB |
1412 | * |
1413 | * Return: %false if @work was already on a queue, %true otherwise. | |
1da177e4 | 1414 | */ |
d4283e93 TH |
1415 | bool queue_work_on(int cpu, struct workqueue_struct *wq, |
1416 | struct work_struct *work) | |
1da177e4 | 1417 | { |
d4283e93 | 1418 | bool ret = false; |
8930caba | 1419 | unsigned long flags; |
ef1ca236 | 1420 | |
8930caba | 1421 | local_irq_save(flags); |
c1a220e7 | 1422 | |
22df02bb | 1423 | if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { |
4690c4ab | 1424 | __queue_work(cpu, wq, work); |
d4283e93 | 1425 | ret = true; |
c1a220e7 | 1426 | } |
ef1ca236 | 1427 | |
8930caba | 1428 | local_irq_restore(flags); |
1da177e4 LT |
1429 | return ret; |
1430 | } | |
ad7b1f84 | 1431 | EXPORT_SYMBOL(queue_work_on); |
1da177e4 | 1432 | |
d8e794df | 1433 | void delayed_work_timer_fn(unsigned long __data) |
1da177e4 | 1434 | { |
52bad64d | 1435 | struct delayed_work *dwork = (struct delayed_work *)__data; |
1da177e4 | 1436 | |
e0aecdd8 | 1437 | /* should have been called from irqsafe timer with irq already off */ |
60c057bc | 1438 | __queue_work(dwork->cpu, dwork->wq, &dwork->work); |
1da177e4 | 1439 | } |
1438ade5 | 1440 | EXPORT_SYMBOL(delayed_work_timer_fn); |
1da177e4 | 1441 | |
7beb2edf TH |
1442 | static void __queue_delayed_work(int cpu, struct workqueue_struct *wq, |
1443 | struct delayed_work *dwork, unsigned long delay) | |
1da177e4 | 1444 | { |
7beb2edf TH |
1445 | struct timer_list *timer = &dwork->timer; |
1446 | struct work_struct *work = &dwork->work; | |
7beb2edf TH |
1447 | |
1448 | WARN_ON_ONCE(timer->function != delayed_work_timer_fn || | |
1449 | timer->data != (unsigned long)dwork); | |
fc4b514f TH |
1450 | WARN_ON_ONCE(timer_pending(timer)); |
1451 | WARN_ON_ONCE(!list_empty(&work->entry)); | |
7beb2edf | 1452 | |
8852aac2 TH |
1453 | /* |
1454 | * If @delay is 0, queue @dwork->work immediately. This is for | |
1455 | * both optimization and correctness. The earliest @timer can | |
1456 | * expire is on the closest next tick and delayed_work users depend | |
1457 | * on that there's no such delay when @delay is 0. | |
1458 | */ | |
1459 | if (!delay) { | |
1460 | __queue_work(cpu, wq, &dwork->work); | |
1461 | return; | |
1462 | } | |
1463 | ||
7beb2edf | 1464 | timer_stats_timer_set_start_info(&dwork->timer); |
1da177e4 | 1465 | |
60c057bc | 1466 | dwork->wq = wq; |
1265057f | 1467 | dwork->cpu = cpu; |
7beb2edf TH |
1468 | timer->expires = jiffies + delay; |
1469 | ||
1470 | if (unlikely(cpu != WORK_CPU_UNBOUND)) | |
1471 | add_timer_on(timer, cpu); | |
1472 | else | |
1473 | add_timer(timer); | |
1da177e4 LT |
1474 | } |
1475 | ||
0fcb78c2 REB |
1476 | /** |
1477 | * queue_delayed_work_on - queue work on specific CPU after delay | |
1478 | * @cpu: CPU number to execute work on | |
1479 | * @wq: workqueue to use | |
af9997e4 | 1480 | * @dwork: work to queue |
0fcb78c2 REB |
1481 | * @delay: number of jiffies to wait before queueing |
1482 | * | |
d185af30 | 1483 | * Return: %false if @work was already on a queue, %true otherwise. If |
715f1300 TH |
1484 | * @delay is zero and @dwork is idle, it will be scheduled for immediate |
1485 | * execution. | |
0fcb78c2 | 1486 | */ |
d4283e93 TH |
1487 | bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, |
1488 | struct delayed_work *dwork, unsigned long delay) | |
7a6bc1cd | 1489 | { |
52bad64d | 1490 | struct work_struct *work = &dwork->work; |
d4283e93 | 1491 | bool ret = false; |
8930caba | 1492 | unsigned long flags; |
7a6bc1cd | 1493 | |
8930caba TH |
1494 | /* read the comment in __queue_work() */ |
1495 | local_irq_save(flags); | |
7a6bc1cd | 1496 | |
22df02bb | 1497 | if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { |
7beb2edf | 1498 | __queue_delayed_work(cpu, wq, dwork, delay); |
d4283e93 | 1499 | ret = true; |
7a6bc1cd | 1500 | } |
8a3e77cc | 1501 | |
8930caba | 1502 | local_irq_restore(flags); |
7a6bc1cd VP |
1503 | return ret; |
1504 | } | |
ad7b1f84 | 1505 | EXPORT_SYMBOL(queue_delayed_work_on); |
c7fc77f7 | 1506 | |
8376fe22 TH |
1507 | /** |
1508 | * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU | |
1509 | * @cpu: CPU number to execute work on | |
1510 | * @wq: workqueue to use | |
1511 | * @dwork: work to queue | |
1512 | * @delay: number of jiffies to wait before queueing | |
1513 | * | |
1514 | * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise, | |
1515 | * modify @dwork's timer so that it expires after @delay. If @delay is | |
1516 | * zero, @work is guaranteed to be scheduled immediately regardless of its | |
1517 | * current state. | |
1518 | * | |
d185af30 | 1519 | * Return: %false if @dwork was idle and queued, %true if @dwork was |
8376fe22 TH |
1520 | * pending and its timer was modified. |
1521 | * | |
e0aecdd8 | 1522 | * This function is safe to call from any context including IRQ handler. |
8376fe22 TH |
1523 | * See try_to_grab_pending() for details. |
1524 | */ | |
1525 | bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, | |
1526 | struct delayed_work *dwork, unsigned long delay) | |
1527 | { | |
1528 | unsigned long flags; | |
1529 | int ret; | |
c7fc77f7 | 1530 | |
8376fe22 TH |
1531 | do { |
1532 | ret = try_to_grab_pending(&dwork->work, true, &flags); | |
1533 | } while (unlikely(ret == -EAGAIN)); | |
63bc0362 | 1534 | |
8376fe22 TH |
1535 | if (likely(ret >= 0)) { |
1536 | __queue_delayed_work(cpu, wq, dwork, delay); | |
1537 | local_irq_restore(flags); | |
7a6bc1cd | 1538 | } |
8376fe22 TH |
1539 | |
1540 | /* -ENOENT from try_to_grab_pending() becomes %true */ | |
7a6bc1cd VP |
1541 | return ret; |
1542 | } | |
8376fe22 TH |
1543 | EXPORT_SYMBOL_GPL(mod_delayed_work_on); |
1544 | ||
c8e55f36 TH |
1545 | /** |
1546 | * worker_enter_idle - enter idle state | |
1547 | * @worker: worker which is entering idle state | |
1548 | * | |
1549 | * @worker is entering idle state. Update stats and idle timer if | |
1550 | * necessary. | |
1551 | * | |
1552 | * LOCKING: | |
d565ed63 | 1553 | * spin_lock_irq(pool->lock). |
c8e55f36 TH |
1554 | */ |
1555 | static void worker_enter_idle(struct worker *worker) | |
1da177e4 | 1556 | { |
bd7bdd43 | 1557 | struct worker_pool *pool = worker->pool; |
c8e55f36 | 1558 | |
6183c009 TH |
1559 | if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) || |
1560 | WARN_ON_ONCE(!list_empty(&worker->entry) && | |
1561 | (worker->hentry.next || worker->hentry.pprev))) | |
1562 | return; | |
c8e55f36 | 1563 | |
cb444766 TH |
1564 | /* can't use worker_set_flags(), also called from start_worker() */ |
1565 | worker->flags |= WORKER_IDLE; | |
bd7bdd43 | 1566 | pool->nr_idle++; |
e22bee78 | 1567 | worker->last_active = jiffies; |
c8e55f36 TH |
1568 | |
1569 | /* idle_list is LIFO */ | |
bd7bdd43 | 1570 | list_add(&worker->entry, &pool->idle_list); |
db7bccf4 | 1571 | |
628c78e7 TH |
1572 | if (too_many_workers(pool) && !timer_pending(&pool->idle_timer)) |
1573 | mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT); | |
cb444766 | 1574 | |
544ecf31 | 1575 | /* |
706026c2 | 1576 | * Sanity check nr_running. Because wq_unbind_fn() releases |
d565ed63 | 1577 | * pool->lock between setting %WORKER_UNBOUND and zapping |
628c78e7 TH |
1578 | * nr_running, the warning may trigger spuriously. Check iff |
1579 | * unbind is not in progress. | |
544ecf31 | 1580 | */ |
24647570 | 1581 | WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && |
bd7bdd43 | 1582 | pool->nr_workers == pool->nr_idle && |
e19e397a | 1583 | atomic_read(&pool->nr_running)); |
c8e55f36 TH |
1584 | } |
1585 | ||
1586 | /** | |
1587 | * worker_leave_idle - leave idle state | |
1588 | * @worker: worker which is leaving idle state | |
1589 | * | |
1590 | * @worker is leaving idle state. Update stats. | |
1591 | * | |
1592 | * LOCKING: | |
d565ed63 | 1593 | * spin_lock_irq(pool->lock). |
c8e55f36 TH |
1594 | */ |
1595 | static void worker_leave_idle(struct worker *worker) | |
1596 | { | |
bd7bdd43 | 1597 | struct worker_pool *pool = worker->pool; |
c8e55f36 | 1598 | |
6183c009 TH |
1599 | if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE))) |
1600 | return; | |
d302f017 | 1601 | worker_clr_flags(worker, WORKER_IDLE); |
bd7bdd43 | 1602 | pool->nr_idle--; |
c8e55f36 TH |
1603 | list_del_init(&worker->entry); |
1604 | } | |
1605 | ||
c34056a3 TH |
1606 | static struct worker *alloc_worker(void) |
1607 | { | |
1608 | struct worker *worker; | |
1609 | ||
1610 | worker = kzalloc(sizeof(*worker), GFP_KERNEL); | |
c8e55f36 TH |
1611 | if (worker) { |
1612 | INIT_LIST_HEAD(&worker->entry); | |
affee4b2 | 1613 | INIT_LIST_HEAD(&worker->scheduled); |
da028469 | 1614 | INIT_LIST_HEAD(&worker->node); |
e22bee78 TH |
1615 | /* on creation a worker is in !idle && prep state */ |
1616 | worker->flags = WORKER_PREP; | |
c8e55f36 | 1617 | } |
c34056a3 TH |
1618 | return worker; |
1619 | } | |
1620 | ||
4736cbf7 LJ |
1621 | /** |
1622 | * worker_attach_to_pool() - attach a worker to a pool | |
1623 | * @worker: worker to be attached | |
1624 | * @pool: the target pool | |
1625 | * | |
1626 | * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and | |
1627 | * cpu-binding of @worker are kept coordinated with the pool across | |
1628 | * cpu-[un]hotplugs. | |
1629 | */ | |
1630 | static void worker_attach_to_pool(struct worker *worker, | |
1631 | struct worker_pool *pool) | |
1632 | { | |
1633 | mutex_lock(&pool->attach_mutex); | |
1634 | ||
1635 | /* | |
1636 | * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any | |
1637 | * online CPUs. It'll be re-applied when any of the CPUs come up. | |
1638 | */ | |
1639 | set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask); | |
1640 | ||
1641 | /* | |
1642 | * The pool->attach_mutex ensures %POOL_DISASSOCIATED remains | |
1643 | * stable across this function. See the comments above the | |
1644 | * flag definition for details. | |
1645 | */ | |
1646 | if (pool->flags & POOL_DISASSOCIATED) | |
1647 | worker->flags |= WORKER_UNBOUND; | |
1648 | ||
1649 | list_add_tail(&worker->node, &pool->workers); | |
1650 | ||
1651 | mutex_unlock(&pool->attach_mutex); | |
1652 | } | |
1653 | ||
60f5a4bc LJ |
1654 | /** |
1655 | * worker_detach_from_pool() - detach a worker from its pool | |
1656 | * @worker: worker which is attached to its pool | |
1657 | * @pool: the pool @worker is attached to | |
1658 | * | |
4736cbf7 LJ |
1659 | * Undo the attaching which had been done in worker_attach_to_pool(). The |
1660 | * caller worker shouldn't access to the pool after detached except it has | |
1661 | * other reference to the pool. | |
60f5a4bc LJ |
1662 | */ |
1663 | static void worker_detach_from_pool(struct worker *worker, | |
1664 | struct worker_pool *pool) | |
1665 | { | |
1666 | struct completion *detach_completion = NULL; | |
1667 | ||
92f9c5c4 | 1668 | mutex_lock(&pool->attach_mutex); |
da028469 LJ |
1669 | list_del(&worker->node); |
1670 | if (list_empty(&pool->workers)) | |
60f5a4bc | 1671 | detach_completion = pool->detach_completion; |
92f9c5c4 | 1672 | mutex_unlock(&pool->attach_mutex); |
60f5a4bc LJ |
1673 | |
1674 | if (detach_completion) | |
1675 | complete(detach_completion); | |
1676 | } | |
1677 | ||
c34056a3 TH |
1678 | /** |
1679 | * create_worker - create a new workqueue worker | |
63d95a91 | 1680 | * @pool: pool the new worker will belong to |
c34056a3 | 1681 | * |
73eb7fe7 LJ |
1682 | * Create a new worker which is attached to @pool. The new worker must be |
1683 | * started by start_worker(). | |
c34056a3 TH |
1684 | * |
1685 | * CONTEXT: | |
1686 | * Might sleep. Does GFP_KERNEL allocations. | |
1687 | * | |
d185af30 | 1688 | * Return: |
c34056a3 TH |
1689 | * Pointer to the newly created worker. |
1690 | */ | |
bc2ae0f5 | 1691 | static struct worker *create_worker(struct worker_pool *pool) |
c34056a3 | 1692 | { |
c34056a3 | 1693 | struct worker *worker = NULL; |
f3421797 | 1694 | int id = -1; |
e3c916a4 | 1695 | char id_buf[16]; |
c34056a3 | 1696 | |
7cda9aae LJ |
1697 | /* ID is needed to determine kthread name */ |
1698 | id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL); | |
822d8405 TH |
1699 | if (id < 0) |
1700 | goto fail; | |
c34056a3 TH |
1701 | |
1702 | worker = alloc_worker(); | |
1703 | if (!worker) | |
1704 | goto fail; | |
1705 | ||
bd7bdd43 | 1706 | worker->pool = pool; |
c34056a3 TH |
1707 | worker->id = id; |
1708 | ||
29c91e99 | 1709 | if (pool->cpu >= 0) |
e3c916a4 TH |
1710 | snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id, |
1711 | pool->attrs->nice < 0 ? "H" : ""); | |
f3421797 | 1712 | else |
e3c916a4 TH |
1713 | snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id); |
1714 | ||
f3f90ad4 | 1715 | worker->task = kthread_create_on_node(worker_thread, worker, pool->node, |
e3c916a4 | 1716 | "kworker/%s", id_buf); |
c34056a3 TH |
1717 | if (IS_ERR(worker->task)) |
1718 | goto fail; | |
1719 | ||
91151228 ON |
1720 | set_user_nice(worker->task, pool->attrs->nice); |
1721 | ||
1722 | /* prevent userland from meddling with cpumask of workqueue workers */ | |
1723 | worker->task->flags |= PF_NO_SETAFFINITY; | |
1724 | ||
da028469 | 1725 | /* successful, attach the worker to the pool */ |
4736cbf7 | 1726 | worker_attach_to_pool(worker, pool); |
4d757c5c | 1727 | |
c34056a3 | 1728 | return worker; |
822d8405 | 1729 | |
c34056a3 | 1730 | fail: |
9625ab17 | 1731 | if (id >= 0) |
7cda9aae | 1732 | ida_simple_remove(&pool->worker_ida, id); |
c34056a3 TH |
1733 | kfree(worker); |
1734 | return NULL; | |
1735 | } | |
1736 | ||
1737 | /** | |
1738 | * start_worker - start a newly created worker | |
1739 | * @worker: worker to start | |
1740 | * | |
706026c2 | 1741 | * Make the pool aware of @worker and start it. |
c34056a3 TH |
1742 | * |
1743 | * CONTEXT: | |
d565ed63 | 1744 | * spin_lock_irq(pool->lock). |
c34056a3 TH |
1745 | */ |
1746 | static void start_worker(struct worker *worker) | |
1747 | { | |
bd7bdd43 | 1748 | worker->pool->nr_workers++; |
c8e55f36 | 1749 | worker_enter_idle(worker); |
c34056a3 TH |
1750 | wake_up_process(worker->task); |
1751 | } | |
1752 | ||
ebf44d16 TH |
1753 | /** |
1754 | * create_and_start_worker - create and start a worker for a pool | |
1755 | * @pool: the target pool | |
1756 | * | |
cd549687 | 1757 | * Grab the managership of @pool and create and start a new worker for it. |
d185af30 YB |
1758 | * |
1759 | * Return: 0 on success. A negative error code otherwise. | |
ebf44d16 TH |
1760 | */ |
1761 | static int create_and_start_worker(struct worker_pool *pool) | |
1762 | { | |
1763 | struct worker *worker; | |
1764 | ||
1765 | worker = create_worker(pool); | |
1766 | if (worker) { | |
1767 | spin_lock_irq(&pool->lock); | |
1768 | start_worker(worker); | |
1769 | spin_unlock_irq(&pool->lock); | |
1770 | } | |
1771 | ||
1772 | return worker ? 0 : -ENOMEM; | |
1773 | } | |
1774 | ||
c34056a3 TH |
1775 | /** |
1776 | * destroy_worker - destroy a workqueue worker | |
1777 | * @worker: worker to be destroyed | |
1778 | * | |
73eb7fe7 LJ |
1779 | * Destroy @worker and adjust @pool stats accordingly. The worker should |
1780 | * be idle. | |
c8e55f36 TH |
1781 | * |
1782 | * CONTEXT: | |
60f5a4bc | 1783 | * spin_lock_irq(pool->lock). |
c34056a3 TH |
1784 | */ |
1785 | static void destroy_worker(struct worker *worker) | |
1786 | { | |
bd7bdd43 | 1787 | struct worker_pool *pool = worker->pool; |
c34056a3 | 1788 | |
cd549687 TH |
1789 | lockdep_assert_held(&pool->lock); |
1790 | ||
c34056a3 | 1791 | /* sanity check frenzy */ |
6183c009 | 1792 | if (WARN_ON(worker->current_work) || |
73eb7fe7 LJ |
1793 | WARN_ON(!list_empty(&worker->scheduled)) || |
1794 | WARN_ON(!(worker->flags & WORKER_IDLE))) | |
6183c009 | 1795 | return; |
c34056a3 | 1796 | |
73eb7fe7 LJ |
1797 | pool->nr_workers--; |
1798 | pool->nr_idle--; | |
c8e55f36 TH |
1799 | |
1800 | list_del_init(&worker->entry); | |
cb444766 | 1801 | worker->flags |= WORKER_DIE; |
60f5a4bc | 1802 | wake_up_process(worker->task); |
c34056a3 TH |
1803 | } |
1804 | ||
63d95a91 | 1805 | static void idle_worker_timeout(unsigned long __pool) |
e22bee78 | 1806 | { |
63d95a91 | 1807 | struct worker_pool *pool = (void *)__pool; |
e22bee78 | 1808 | |
d565ed63 | 1809 | spin_lock_irq(&pool->lock); |
e22bee78 | 1810 | |
3347fc9f | 1811 | while (too_many_workers(pool)) { |
e22bee78 TH |
1812 | struct worker *worker; |
1813 | unsigned long expires; | |
1814 | ||
1815 | /* idle_list is kept in LIFO order, check the last one */ | |
63d95a91 | 1816 | worker = list_entry(pool->idle_list.prev, struct worker, entry); |
e22bee78 TH |
1817 | expires = worker->last_active + IDLE_WORKER_TIMEOUT; |
1818 | ||
3347fc9f | 1819 | if (time_before(jiffies, expires)) { |
63d95a91 | 1820 | mod_timer(&pool->idle_timer, expires); |
3347fc9f | 1821 | break; |
d5abe669 | 1822 | } |
3347fc9f LJ |
1823 | |
1824 | destroy_worker(worker); | |
e22bee78 TH |
1825 | } |
1826 | ||
d565ed63 | 1827 | spin_unlock_irq(&pool->lock); |
e22bee78 | 1828 | } |
d5abe669 | 1829 | |
493a1724 | 1830 | static void send_mayday(struct work_struct *work) |
e22bee78 | 1831 | { |
112202d9 TH |
1832 | struct pool_workqueue *pwq = get_work_pwq(work); |
1833 | struct workqueue_struct *wq = pwq->wq; | |
493a1724 | 1834 | |
2e109a28 | 1835 | lockdep_assert_held(&wq_mayday_lock); |
e22bee78 | 1836 | |
493008a8 | 1837 | if (!wq->rescuer) |
493a1724 | 1838 | return; |
e22bee78 TH |
1839 | |
1840 | /* mayday mayday mayday */ | |
493a1724 | 1841 | if (list_empty(&pwq->mayday_node)) { |
77668c8b LJ |
1842 | /* |
1843 | * If @pwq is for an unbound wq, its base ref may be put at | |
1844 | * any time due to an attribute change. Pin @pwq until the | |
1845 | * rescuer is done with it. | |
1846 | */ | |
1847 | get_pwq(pwq); | |
493a1724 | 1848 | list_add_tail(&pwq->mayday_node, &wq->maydays); |
e22bee78 | 1849 | wake_up_process(wq->rescuer->task); |
493a1724 | 1850 | } |
e22bee78 TH |
1851 | } |
1852 | ||
706026c2 | 1853 | static void pool_mayday_timeout(unsigned long __pool) |
e22bee78 | 1854 | { |
63d95a91 | 1855 | struct worker_pool *pool = (void *)__pool; |
e22bee78 TH |
1856 | struct work_struct *work; |
1857 | ||
2e109a28 | 1858 | spin_lock_irq(&wq_mayday_lock); /* for wq->maydays */ |
493a1724 | 1859 | spin_lock(&pool->lock); |
e22bee78 | 1860 | |
63d95a91 | 1861 | if (need_to_create_worker(pool)) { |
e22bee78 TH |
1862 | /* |
1863 | * We've been trying to create a new worker but | |
1864 | * haven't been successful. We might be hitting an | |
1865 | * allocation deadlock. Send distress signals to | |
1866 | * rescuers. | |
1867 | */ | |
63d95a91 | 1868 | list_for_each_entry(work, &pool->worklist, entry) |
e22bee78 | 1869 | send_mayday(work); |
1da177e4 | 1870 | } |
e22bee78 | 1871 | |
493a1724 | 1872 | spin_unlock(&pool->lock); |
2e109a28 | 1873 | spin_unlock_irq(&wq_mayday_lock); |
e22bee78 | 1874 | |
63d95a91 | 1875 | mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL); |
1da177e4 LT |
1876 | } |
1877 | ||
e22bee78 TH |
1878 | /** |
1879 | * maybe_create_worker - create a new worker if necessary | |
63d95a91 | 1880 | * @pool: pool to create a new worker for |
e22bee78 | 1881 | * |
63d95a91 | 1882 | * Create a new worker for @pool if necessary. @pool is guaranteed to |
e22bee78 TH |
1883 | * have at least one idle worker on return from this function. If |
1884 | * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is | |
63d95a91 | 1885 | * sent to all rescuers with works scheduled on @pool to resolve |
e22bee78 TH |
1886 | * possible allocation deadlock. |
1887 | * | |
c5aa87bb TH |
1888 | * On return, need_to_create_worker() is guaranteed to be %false and |
1889 | * may_start_working() %true. | |
e22bee78 TH |
1890 | * |
1891 | * LOCKING: | |
d565ed63 | 1892 | * spin_lock_irq(pool->lock) which may be released and regrabbed |
e22bee78 TH |
1893 | * multiple times. Does GFP_KERNEL allocations. Called only from |
1894 | * manager. | |
1895 | * | |
d185af30 | 1896 | * Return: |
c5aa87bb | 1897 | * %false if no action was taken and pool->lock stayed locked, %true |
e22bee78 TH |
1898 | * otherwise. |
1899 | */ | |
63d95a91 | 1900 | static bool maybe_create_worker(struct worker_pool *pool) |
d565ed63 TH |
1901 | __releases(&pool->lock) |
1902 | __acquires(&pool->lock) | |
1da177e4 | 1903 | { |
63d95a91 | 1904 | if (!need_to_create_worker(pool)) |
e22bee78 TH |
1905 | return false; |
1906 | restart: | |
d565ed63 | 1907 | spin_unlock_irq(&pool->lock); |
9f9c2364 | 1908 | |
e22bee78 | 1909 | /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ |
63d95a91 | 1910 | mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); |
e22bee78 TH |
1911 | |
1912 | while (true) { | |
1913 | struct worker *worker; | |
1914 | ||
bc2ae0f5 | 1915 | worker = create_worker(pool); |
e22bee78 | 1916 | if (worker) { |
63d95a91 | 1917 | del_timer_sync(&pool->mayday_timer); |
d565ed63 | 1918 | spin_lock_irq(&pool->lock); |
e22bee78 | 1919 | start_worker(worker); |
6183c009 TH |
1920 | if (WARN_ON_ONCE(need_to_create_worker(pool))) |
1921 | goto restart; | |
e22bee78 TH |
1922 | return true; |
1923 | } | |
1924 | ||
63d95a91 | 1925 | if (!need_to_create_worker(pool)) |
e22bee78 | 1926 | break; |
1da177e4 | 1927 | |
e22bee78 TH |
1928 | __set_current_state(TASK_INTERRUPTIBLE); |
1929 | schedule_timeout(CREATE_COOLDOWN); | |
9f9c2364 | 1930 | |
63d95a91 | 1931 | if (!need_to_create_worker(pool)) |
e22bee78 TH |
1932 | break; |
1933 | } | |
1934 | ||
63d95a91 | 1935 | del_timer_sync(&pool->mayday_timer); |
d565ed63 | 1936 | spin_lock_irq(&pool->lock); |
63d95a91 | 1937 | if (need_to_create_worker(pool)) |
e22bee78 TH |
1938 | goto restart; |
1939 | return true; | |
1940 | } | |
1941 | ||
73f53c4a | 1942 | /** |
e22bee78 TH |
1943 | * manage_workers - manage worker pool |
1944 | * @worker: self | |
73f53c4a | 1945 | * |
706026c2 | 1946 | * Assume the manager role and manage the worker pool @worker belongs |
e22bee78 | 1947 | * to. At any given time, there can be only zero or one manager per |
706026c2 | 1948 | * pool. The exclusion is handled automatically by this function. |
e22bee78 TH |
1949 | * |
1950 | * The caller can safely start processing works on false return. On | |
1951 | * true return, it's guaranteed that need_to_create_worker() is false | |
1952 | * and may_start_working() is true. | |
73f53c4a TH |
1953 | * |
1954 | * CONTEXT: | |
d565ed63 | 1955 | * spin_lock_irq(pool->lock) which may be released and regrabbed |
e22bee78 TH |
1956 | * multiple times. Does GFP_KERNEL allocations. |
1957 | * | |
d185af30 | 1958 | * Return: |
2d498db9 L |
1959 | * %false if the pool don't need management and the caller can safely start |
1960 | * processing works, %true indicates that the function released pool->lock | |
1961 | * and reacquired it to perform some management function and that the | |
1962 | * conditions that the caller verified while holding the lock before | |
1963 | * calling the function might no longer be true. | |
73f53c4a | 1964 | */ |
e22bee78 | 1965 | static bool manage_workers(struct worker *worker) |
73f53c4a | 1966 | { |
63d95a91 | 1967 | struct worker_pool *pool = worker->pool; |
e22bee78 | 1968 | bool ret = false; |
73f53c4a | 1969 | |
bc3a1afc | 1970 | /* |
bc3a1afc TH |
1971 | * Anyone who successfully grabs manager_arb wins the arbitration |
1972 | * and becomes the manager. mutex_trylock() on pool->manager_arb | |
1973 | * failure while holding pool->lock reliably indicates that someone | |
1974 | * else is managing the pool and the worker which failed trylock | |
1975 | * can proceed to executing work items. This means that anyone | |
1976 | * grabbing manager_arb is responsible for actually performing | |
1977 | * manager duties. If manager_arb is grabbed and released without | |
1978 | * actual management, the pool may stall indefinitely. | |
bc3a1afc | 1979 | */ |
34a06bd6 | 1980 | if (!mutex_trylock(&pool->manager_arb)) |
e22bee78 | 1981 | return ret; |
1e19ffc6 | 1982 | |
63d95a91 | 1983 | ret |= maybe_create_worker(pool); |
e22bee78 | 1984 | |
34a06bd6 | 1985 | mutex_unlock(&pool->manager_arb); |
e22bee78 | 1986 | return ret; |
73f53c4a TH |
1987 | } |
1988 | ||
a62428c0 TH |
1989 | /** |
1990 | * process_one_work - process single work | |
c34056a3 | 1991 | * @worker: self |
a62428c0 TH |
1992 | * @work: work to process |
1993 | * | |
1994 | * Process @work. This function contains all the logics necessary to | |
1995 | * process a single work including synchronization against and | |
1996 | * interaction with other workers on the same cpu, queueing and | |
1997 | * flushing. As long as context requirement is met, any worker can | |
1998 | * call this function to process a work. | |
1999 | * | |
2000 | * CONTEXT: | |
d565ed63 | 2001 | * spin_lock_irq(pool->lock) which is released and regrabbed. |
a62428c0 | 2002 | */ |
c34056a3 | 2003 | static void process_one_work(struct worker *worker, struct work_struct *work) |
d565ed63 TH |
2004 | __releases(&pool->lock) |
2005 | __acquires(&pool->lock) | |
a62428c0 | 2006 | { |
112202d9 | 2007 | struct pool_workqueue *pwq = get_work_pwq(work); |
bd7bdd43 | 2008 | struct worker_pool *pool = worker->pool; |
112202d9 | 2009 | bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE; |
73f53c4a | 2010 | int work_color; |
7e11629d | 2011 | struct worker *collision; |
a62428c0 TH |
2012 | #ifdef CONFIG_LOCKDEP |
2013 | /* | |
2014 | * It is permissible to free the struct work_struct from | |
2015 | * inside the function that is called from it, this we need to | |
2016 | * take into account for lockdep too. To avoid bogus "held | |
2017 | * lock freed" warnings as well as problems when looking into | |
2018 | * work->lockdep_map, make a copy and use that here. | |
2019 | */ | |
4d82a1de PZ |
2020 | struct lockdep_map lockdep_map; |
2021 | ||
2022 | lockdep_copy_map(&lockdep_map, &work->lockdep_map); | |
a62428c0 | 2023 | #endif |
6fec10a1 TH |
2024 | /* |
2025 | * Ensure we're on the correct CPU. DISASSOCIATED test is | |
2026 | * necessary to avoid spurious warnings from rescuers servicing the | |
24647570 | 2027 | * unbound or a disassociated pool. |
6fec10a1 | 2028 | */ |
5f7dabfd | 2029 | WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) && |
24647570 | 2030 | !(pool->flags & POOL_DISASSOCIATED) && |
ec22ca5e | 2031 | raw_smp_processor_id() != pool->cpu); |
25511a47 | 2032 | |
7e11629d TH |
2033 | /* |
2034 | * A single work shouldn't be executed concurrently by | |
2035 | * multiple workers on a single cpu. Check whether anyone is | |
2036 | * already processing the work. If so, defer the work to the | |
2037 | * currently executing one. | |
2038 | */ | |
c9e7cf27 | 2039 | collision = find_worker_executing_work(pool, work); |
7e11629d TH |
2040 | if (unlikely(collision)) { |
2041 | move_linked_works(work, &collision->scheduled, NULL); | |
2042 | return; | |
2043 | } | |
2044 | ||
8930caba | 2045 | /* claim and dequeue */ |
a62428c0 | 2046 | debug_work_deactivate(work); |
c9e7cf27 | 2047 | hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work); |
c34056a3 | 2048 | worker->current_work = work; |
a2c1c57b | 2049 | worker->current_func = work->func; |
112202d9 | 2050 | worker->current_pwq = pwq; |
73f53c4a | 2051 | work_color = get_work_color(work); |
7a22ad75 | 2052 | |
a62428c0 TH |
2053 | list_del_init(&work->entry); |
2054 | ||
fb0e7beb TH |
2055 | /* |
2056 | * CPU intensive works don't participate in concurrency | |
2057 | * management. They're the scheduler's responsibility. | |
2058 | */ | |
2059 | if (unlikely(cpu_intensive)) | |
2060 | worker_set_flags(worker, WORKER_CPU_INTENSIVE, true); | |
2061 | ||
974271c4 | 2062 | /* |
d565ed63 | 2063 | * Unbound pool isn't concurrency managed and work items should be |
974271c4 TH |
2064 | * executed ASAP. Wake up another worker if necessary. |
2065 | */ | |
63d95a91 TH |
2066 | if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool)) |
2067 | wake_up_worker(pool); | |
974271c4 | 2068 | |
8930caba | 2069 | /* |
7c3eed5c | 2070 | * Record the last pool and clear PENDING which should be the last |
d565ed63 | 2071 | * update to @work. Also, do this inside @pool->lock so that |
23657bb1 TH |
2072 | * PENDING and queued state changes happen together while IRQ is |
2073 | * disabled. | |
8930caba | 2074 | */ |
7c3eed5c | 2075 | set_work_pool_and_clear_pending(work, pool->id); |
a62428c0 | 2076 | |
d565ed63 | 2077 | spin_unlock_irq(&pool->lock); |
a62428c0 | 2078 | |
112202d9 | 2079 | lock_map_acquire_read(&pwq->wq->lockdep_map); |
a62428c0 | 2080 | lock_map_acquire(&lockdep_map); |
e36c886a | 2081 | trace_workqueue_execute_start(work); |
a2c1c57b | 2082 | worker->current_func(work); |
e36c886a AV |
2083 | /* |
2084 | * While we must be careful to not use "work" after this, the trace | |
2085 | * point will only record its address. | |
2086 | */ | |
2087 | trace_workqueue_execute_end(work); | |
a62428c0 | 2088 | lock_map_release(&lockdep_map); |
112202d9 | 2089 | lock_map_release(&pwq->wq->lockdep_map); |
a62428c0 TH |
2090 | |
2091 | if (unlikely(in_atomic() || lockdep_depth(current) > 0)) { | |
044c782c VI |
2092 | pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n" |
2093 | " last function: %pf\n", | |
a2c1c57b TH |
2094 | current->comm, preempt_count(), task_pid_nr(current), |
2095 | worker->current_func); | |
a62428c0 TH |
2096 | debug_show_held_locks(current); |
2097 | dump_stack(); | |
2098 | } | |
2099 | ||
b22ce278 TH |
2100 | /* |
2101 | * The following prevents a kworker from hogging CPU on !PREEMPT | |
2102 | * kernels, where a requeueing work item waiting for something to | |
2103 | * happen could deadlock with stop_machine as such work item could | |
2104 | * indefinitely requeue itself while all other CPUs are trapped in | |
2105 | * stop_machine. | |
2106 | */ | |
2107 | cond_resched(); | |
2108 | ||
d565ed63 | 2109 | spin_lock_irq(&pool->lock); |
a62428c0 | 2110 | |
fb0e7beb TH |
2111 | /* clear cpu intensive status */ |
2112 | if (unlikely(cpu_intensive)) | |
2113 | worker_clr_flags(worker, WORKER_CPU_INTENSIVE); | |
2114 | ||
a62428c0 | 2115 | /* we're done with it, release */ |
42f8570f | 2116 | hash_del(&worker->hentry); |
c34056a3 | 2117 | worker->current_work = NULL; |
a2c1c57b | 2118 | worker->current_func = NULL; |
112202d9 | 2119 | worker->current_pwq = NULL; |
3d1cb205 | 2120 | worker->desc_valid = false; |
112202d9 | 2121 | pwq_dec_nr_in_flight(pwq, work_color); |
a62428c0 TH |
2122 | } |
2123 | ||
affee4b2 TH |
2124 | /** |
2125 | * process_scheduled_works - process scheduled works | |
2126 | * @worker: self | |
2127 | * | |
2128 | * Process all scheduled works. Please note that the scheduled list | |
2129 | * may change while processing a work, so this function repeatedly | |
2130 | * fetches a work from the top and executes it. | |
2131 | * | |
2132 | * CONTEXT: | |
d565ed63 | 2133 | * spin_lock_irq(pool->lock) which may be released and regrabbed |
affee4b2 TH |
2134 | * multiple times. |
2135 | */ | |
2136 | static void process_scheduled_works(struct worker *worker) | |
1da177e4 | 2137 | { |
affee4b2 TH |
2138 | while (!list_empty(&worker->scheduled)) { |
2139 | struct work_struct *work = list_first_entry(&worker->scheduled, | |
1da177e4 | 2140 | struct work_struct, entry); |
c34056a3 | 2141 | process_one_work(worker, work); |
1da177e4 | 2142 | } |
1da177e4 LT |
2143 | } |
2144 | ||
4690c4ab TH |
2145 | /** |
2146 | * worker_thread - the worker thread function | |
c34056a3 | 2147 | * @__worker: self |
4690c4ab | 2148 | * |
c5aa87bb TH |
2149 | * The worker thread function. All workers belong to a worker_pool - |
2150 | * either a per-cpu one or dynamic unbound one. These workers process all | |
2151 | * work items regardless of their specific target workqueue. The only | |
2152 | * exception is work items which belong to workqueues with a rescuer which | |
2153 | * will be explained in rescuer_thread(). | |
d185af30 YB |
2154 | * |
2155 | * Return: 0 | |
4690c4ab | 2156 | */ |
c34056a3 | 2157 | static int worker_thread(void *__worker) |
1da177e4 | 2158 | { |
c34056a3 | 2159 | struct worker *worker = __worker; |
bd7bdd43 | 2160 | struct worker_pool *pool = worker->pool; |
1da177e4 | 2161 | |
e22bee78 TH |
2162 | /* tell the scheduler that this is a workqueue worker */ |
2163 | worker->task->flags |= PF_WQ_WORKER; | |
c8e55f36 | 2164 | woke_up: |
d565ed63 | 2165 | spin_lock_irq(&pool->lock); |
1da177e4 | 2166 | |
a9ab775b TH |
2167 | /* am I supposed to die? */ |
2168 | if (unlikely(worker->flags & WORKER_DIE)) { | |
d565ed63 | 2169 | spin_unlock_irq(&pool->lock); |
a9ab775b TH |
2170 | WARN_ON_ONCE(!list_empty(&worker->entry)); |
2171 | worker->task->flags &= ~PF_WQ_WORKER; | |
60f5a4bc LJ |
2172 | |
2173 | set_task_comm(worker->task, "kworker/dying"); | |
7cda9aae | 2174 | ida_simple_remove(&pool->worker_ida, worker->id); |
60f5a4bc LJ |
2175 | worker_detach_from_pool(worker, pool); |
2176 | kfree(worker); | |
a9ab775b | 2177 | return 0; |
c8e55f36 | 2178 | } |
affee4b2 | 2179 | |
c8e55f36 | 2180 | worker_leave_idle(worker); |
db7bccf4 | 2181 | recheck: |
e22bee78 | 2182 | /* no more worker necessary? */ |
63d95a91 | 2183 | if (!need_more_worker(pool)) |
e22bee78 TH |
2184 | goto sleep; |
2185 | ||
2186 | /* do we need to manage? */ | |
63d95a91 | 2187 | if (unlikely(!may_start_working(pool)) && manage_workers(worker)) |
e22bee78 TH |
2188 | goto recheck; |
2189 | ||
c8e55f36 TH |
2190 | /* |
2191 | * ->scheduled list can only be filled while a worker is | |
2192 | * preparing to process a work or actually processing it. | |
2193 | * Make sure nobody diddled with it while I was sleeping. | |
2194 | */ | |
6183c009 | 2195 | WARN_ON_ONCE(!list_empty(&worker->scheduled)); |
c8e55f36 | 2196 | |
e22bee78 | 2197 | /* |
a9ab775b TH |
2198 | * Finish PREP stage. We're guaranteed to have at least one idle |
2199 | * worker or that someone else has already assumed the manager | |
2200 | * role. This is where @worker starts participating in concurrency | |
2201 | * management if applicable and concurrency management is restored | |
2202 | * after being rebound. See rebind_workers() for details. | |
e22bee78 | 2203 | */ |
a9ab775b | 2204 | worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND); |
e22bee78 TH |
2205 | |
2206 | do { | |
c8e55f36 | 2207 | struct work_struct *work = |
bd7bdd43 | 2208 | list_first_entry(&pool->worklist, |
c8e55f36 TH |
2209 | struct work_struct, entry); |
2210 | ||
2211 | if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) { | |
2212 | /* optimization path, not strictly necessary */ | |
2213 | process_one_work(worker, work); | |
2214 | if (unlikely(!list_empty(&worker->scheduled))) | |
affee4b2 | 2215 | process_scheduled_works(worker); |
c8e55f36 TH |
2216 | } else { |
2217 | move_linked_works(work, &worker->scheduled, NULL); | |
2218 | process_scheduled_works(worker); | |
affee4b2 | 2219 | } |
63d95a91 | 2220 | } while (keep_working(pool)); |
e22bee78 TH |
2221 | |
2222 | worker_set_flags(worker, WORKER_PREP, false); | |
d313dd85 | 2223 | sleep: |
c8e55f36 | 2224 | /* |
d565ed63 TH |
2225 | * pool->lock is held and there's no work to process and no need to |
2226 | * manage, sleep. Workers are woken up only while holding | |
2227 | * pool->lock or from local cpu, so setting the current state | |
2228 | * before releasing pool->lock is enough to prevent losing any | |
2229 | * event. | |
c8e55f36 TH |
2230 | */ |
2231 | worker_enter_idle(worker); | |
2232 | __set_current_state(TASK_INTERRUPTIBLE); | |
d565ed63 | 2233 | spin_unlock_irq(&pool->lock); |
c8e55f36 TH |
2234 | schedule(); |
2235 | goto woke_up; | |
1da177e4 LT |
2236 | } |
2237 | ||
e22bee78 TH |
2238 | /** |
2239 | * rescuer_thread - the rescuer thread function | |
111c225a | 2240 | * @__rescuer: self |
e22bee78 TH |
2241 | * |
2242 | * Workqueue rescuer thread function. There's one rescuer for each | |
493008a8 | 2243 | * workqueue which has WQ_MEM_RECLAIM set. |
e22bee78 | 2244 | * |
706026c2 | 2245 | * Regular work processing on a pool may block trying to create a new |
e22bee78 TH |
2246 | * worker which uses GFP_KERNEL allocation which has slight chance of |
2247 | * developing into deadlock if some works currently on the same queue | |
2248 | * need to be processed to satisfy the GFP_KERNEL allocation. This is | |
2249 | * the problem rescuer solves. | |
2250 | * | |
706026c2 TH |
2251 | * When such condition is possible, the pool summons rescuers of all |
2252 | * workqueues which have works queued on the pool and let them process | |
e22bee78 TH |
2253 | * those works so that forward progress can be guaranteed. |
2254 | * | |
2255 | * This should happen rarely. | |
d185af30 YB |
2256 | * |
2257 | * Return: 0 | |
e22bee78 | 2258 | */ |
111c225a | 2259 | static int rescuer_thread(void *__rescuer) |
e22bee78 | 2260 | { |
111c225a TH |
2261 | struct worker *rescuer = __rescuer; |
2262 | struct workqueue_struct *wq = rescuer->rescue_wq; | |
e22bee78 | 2263 | struct list_head *scheduled = &rescuer->scheduled; |
4d595b86 | 2264 | bool should_stop; |
e22bee78 TH |
2265 | |
2266 | set_user_nice(current, RESCUER_NICE_LEVEL); | |
111c225a TH |
2267 | |
2268 | /* | |
2269 | * Mark rescuer as worker too. As WORKER_PREP is never cleared, it | |
2270 | * doesn't participate in concurrency management. | |
2271 | */ | |
2272 | rescuer->task->flags |= PF_WQ_WORKER; | |
e22bee78 TH |
2273 | repeat: |
2274 | set_current_state(TASK_INTERRUPTIBLE); | |
2275 | ||
4d595b86 LJ |
2276 | /* |
2277 | * By the time the rescuer is requested to stop, the workqueue | |
2278 | * shouldn't have any work pending, but @wq->maydays may still have | |
2279 | * pwq(s) queued. This can happen by non-rescuer workers consuming | |
2280 | * all the work items before the rescuer got to them. Go through | |
2281 | * @wq->maydays processing before acting on should_stop so that the | |
2282 | * list is always empty on exit. | |
2283 | */ | |
2284 | should_stop = kthread_should_stop(); | |
e22bee78 | 2285 | |
493a1724 | 2286 | /* see whether any pwq is asking for help */ |
2e109a28 | 2287 | spin_lock_irq(&wq_mayday_lock); |
493a1724 TH |
2288 | |
2289 | while (!list_empty(&wq->maydays)) { | |
2290 | struct pool_workqueue *pwq = list_first_entry(&wq->maydays, | |
2291 | struct pool_workqueue, mayday_node); | |
112202d9 | 2292 | struct worker_pool *pool = pwq->pool; |
e22bee78 TH |
2293 | struct work_struct *work, *n; |
2294 | ||
2295 | __set_current_state(TASK_RUNNING); | |
493a1724 TH |
2296 | list_del_init(&pwq->mayday_node); |
2297 | ||
2e109a28 | 2298 | spin_unlock_irq(&wq_mayday_lock); |
e22bee78 | 2299 | |
51697d39 LJ |
2300 | worker_attach_to_pool(rescuer, pool); |
2301 | ||
2302 | spin_lock_irq(&pool->lock); | |
b3104104 | 2303 | rescuer->pool = pool; |
e22bee78 TH |
2304 | |
2305 | /* | |
2306 | * Slurp in all works issued via this workqueue and | |
2307 | * process'em. | |
2308 | */ | |
6183c009 | 2309 | WARN_ON_ONCE(!list_empty(&rescuer->scheduled)); |
bd7bdd43 | 2310 | list_for_each_entry_safe(work, n, &pool->worklist, entry) |
112202d9 | 2311 | if (get_work_pwq(work) == pwq) |
e22bee78 TH |
2312 | move_linked_works(work, scheduled, &n); |
2313 | ||
2314 | process_scheduled_works(rescuer); | |
51697d39 LJ |
2315 | spin_unlock_irq(&pool->lock); |
2316 | ||
2317 | worker_detach_from_pool(rescuer, pool); | |
2318 | ||
2319 | spin_lock_irq(&pool->lock); | |
7576958a | 2320 | |
77668c8b LJ |
2321 | /* |
2322 | * Put the reference grabbed by send_mayday(). @pool won't | |
2323 | * go away while we're holding its lock. | |
2324 | */ | |
2325 | put_pwq(pwq); | |
2326 | ||
7576958a | 2327 | /* |
d565ed63 | 2328 | * Leave this pool. If keep_working() is %true, notify a |
7576958a TH |
2329 | * regular worker; otherwise, we end up with 0 concurrency |
2330 | * and stalling the execution. | |
2331 | */ | |
63d95a91 TH |
2332 | if (keep_working(pool)) |
2333 | wake_up_worker(pool); | |
7576958a | 2334 | |
b3104104 | 2335 | rescuer->pool = NULL; |
493a1724 | 2336 | spin_unlock(&pool->lock); |
2e109a28 | 2337 | spin_lock(&wq_mayday_lock); |
e22bee78 TH |
2338 | } |
2339 | ||
2e109a28 | 2340 | spin_unlock_irq(&wq_mayday_lock); |
493a1724 | 2341 | |
4d595b86 LJ |
2342 | if (should_stop) { |
2343 | __set_current_state(TASK_RUNNING); | |
2344 | rescuer->task->flags &= ~PF_WQ_WORKER; | |
2345 | return 0; | |
2346 | } | |
2347 | ||
111c225a TH |
2348 | /* rescuers should never participate in concurrency management */ |
2349 | WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING)); | |
e22bee78 TH |
2350 | schedule(); |
2351 | goto repeat; | |
1da177e4 LT |
2352 | } |
2353 | ||
fc2e4d70 ON |
2354 | struct wq_barrier { |
2355 | struct work_struct work; | |
2356 | struct completion done; | |
2357 | }; | |
2358 | ||
2359 | static void wq_barrier_func(struct work_struct *work) | |
2360 | { | |
2361 | struct wq_barrier *barr = container_of(work, struct wq_barrier, work); | |
2362 | complete(&barr->done); | |
2363 | } | |
2364 | ||
4690c4ab TH |
2365 | /** |
2366 | * insert_wq_barrier - insert a barrier work | |
112202d9 | 2367 | * @pwq: pwq to insert barrier into |
4690c4ab | 2368 | * @barr: wq_barrier to insert |
affee4b2 TH |
2369 | * @target: target work to attach @barr to |
2370 | * @worker: worker currently executing @target, NULL if @target is not executing | |
4690c4ab | 2371 | * |
affee4b2 TH |
2372 | * @barr is linked to @target such that @barr is completed only after |
2373 | * @target finishes execution. Please note that the ordering | |
2374 | * guarantee is observed only with respect to @target and on the local | |
2375 | * cpu. | |
2376 | * | |
2377 | * Currently, a queued barrier can't be canceled. This is because | |
2378 | * try_to_grab_pending() can't determine whether the work to be | |
2379 | * grabbed is at the head of the queue and thus can't clear LINKED | |
2380 | * flag of the previous work while there must be a valid next work | |
2381 | * after a work with LINKED flag set. | |
2382 | * | |
2383 | * Note that when @worker is non-NULL, @target may be modified | |
112202d9 | 2384 | * underneath us, so we can't reliably determine pwq from @target. |
4690c4ab TH |
2385 | * |
2386 | * CONTEXT: | |
d565ed63 | 2387 | * spin_lock_irq(pool->lock). |
4690c4ab | 2388 | */ |
112202d9 | 2389 | static void insert_wq_barrier(struct pool_workqueue *pwq, |
affee4b2 TH |
2390 | struct wq_barrier *barr, |
2391 | struct work_struct *target, struct worker *worker) | |
fc2e4d70 | 2392 | { |
affee4b2 TH |
2393 | struct list_head *head; |
2394 | unsigned int linked = 0; | |
2395 | ||
dc186ad7 | 2396 | /* |
d565ed63 | 2397 | * debugobject calls are safe here even with pool->lock locked |
dc186ad7 TG |
2398 | * as we know for sure that this will not trigger any of the |
2399 | * checks and call back into the fixup functions where we | |
2400 | * might deadlock. | |
2401 | */ | |
ca1cab37 | 2402 | INIT_WORK_ONSTACK(&barr->work, wq_barrier_func); |
22df02bb | 2403 | __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); |
fc2e4d70 | 2404 | init_completion(&barr->done); |
83c22520 | 2405 | |
affee4b2 TH |
2406 | /* |
2407 | * If @target is currently being executed, schedule the | |
2408 | * barrier to the worker; otherwise, put it after @target. | |
2409 | */ | |
2410 | if (worker) | |
2411 | head = worker->scheduled.next; | |
2412 | else { | |
2413 | unsigned long *bits = work_data_bits(target); | |
2414 | ||
2415 | head = target->entry.next; | |
2416 | /* there can already be other linked works, inherit and set */ | |
2417 | linked = *bits & WORK_STRUCT_LINKED; | |
2418 | __set_bit(WORK_STRUCT_LINKED_BIT, bits); | |
2419 | } | |
2420 | ||
dc186ad7 | 2421 | debug_work_activate(&barr->work); |
112202d9 | 2422 | insert_work(pwq, &barr->work, head, |
affee4b2 | 2423 | work_color_to_flags(WORK_NO_COLOR) | linked); |
fc2e4d70 ON |
2424 | } |
2425 | ||
73f53c4a | 2426 | /** |
112202d9 | 2427 | * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing |
73f53c4a TH |
2428 | * @wq: workqueue being flushed |
2429 | * @flush_color: new flush color, < 0 for no-op | |
2430 | * @work_color: new work color, < 0 for no-op | |
2431 | * | |
112202d9 | 2432 | * Prepare pwqs for workqueue flushing. |
73f53c4a | 2433 | * |
112202d9 TH |
2434 | * If @flush_color is non-negative, flush_color on all pwqs should be |
2435 | * -1. If no pwq has in-flight commands at the specified color, all | |
2436 | * pwq->flush_color's stay at -1 and %false is returned. If any pwq | |
2437 | * has in flight commands, its pwq->flush_color is set to | |
2438 | * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq | |
73f53c4a TH |
2439 | * wakeup logic is armed and %true is returned. |
2440 | * | |
2441 | * The caller should have initialized @wq->first_flusher prior to | |
2442 | * calling this function with non-negative @flush_color. If | |
2443 | * @flush_color is negative, no flush color update is done and %false | |
2444 | * is returned. | |
2445 | * | |
112202d9 | 2446 | * If @work_color is non-negative, all pwqs should have the same |
73f53c4a TH |
2447 | * work_color which is previous to @work_color and all will be |
2448 | * advanced to @work_color. | |
2449 | * | |
2450 | * CONTEXT: | |
3c25a55d | 2451 | * mutex_lock(wq->mutex). |
73f53c4a | 2452 | * |
d185af30 | 2453 | * Return: |
73f53c4a TH |
2454 | * %true if @flush_color >= 0 and there's something to flush. %false |
2455 | * otherwise. | |
2456 | */ | |
112202d9 | 2457 | static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq, |
73f53c4a | 2458 | int flush_color, int work_color) |
1da177e4 | 2459 | { |
73f53c4a | 2460 | bool wait = false; |
49e3cf44 | 2461 | struct pool_workqueue *pwq; |
1da177e4 | 2462 | |
73f53c4a | 2463 | if (flush_color >= 0) { |
6183c009 | 2464 | WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush)); |
112202d9 | 2465 | atomic_set(&wq->nr_pwqs_to_flush, 1); |
1da177e4 | 2466 | } |
2355b70f | 2467 | |
49e3cf44 | 2468 | for_each_pwq(pwq, wq) { |
112202d9 | 2469 | struct worker_pool *pool = pwq->pool; |
fc2e4d70 | 2470 | |
b09f4fd3 | 2471 | spin_lock_irq(&pool->lock); |
83c22520 | 2472 | |
73f53c4a | 2473 | if (flush_color >= 0) { |
6183c009 | 2474 | WARN_ON_ONCE(pwq->flush_color != -1); |
fc2e4d70 | 2475 | |
112202d9 TH |
2476 | if (pwq->nr_in_flight[flush_color]) { |
2477 | pwq->flush_color = flush_color; | |
2478 | atomic_inc(&wq->nr_pwqs_to_flush); | |
73f53c4a TH |
2479 | wait = true; |
2480 | } | |
2481 | } | |
1da177e4 | 2482 | |
73f53c4a | 2483 | if (work_color >= 0) { |
6183c009 | 2484 | WARN_ON_ONCE(work_color != work_next_color(pwq->work_color)); |
112202d9 | 2485 | pwq->work_color = work_color; |
73f53c4a | 2486 | } |
1da177e4 | 2487 | |
b09f4fd3 | 2488 | spin_unlock_irq(&pool->lock); |
1da177e4 | 2489 | } |
2355b70f | 2490 | |
112202d9 | 2491 | if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush)) |
73f53c4a | 2492 | complete(&wq->first_flusher->done); |
14441960 | 2493 | |
73f53c4a | 2494 | return wait; |
1da177e4 LT |
2495 | } |
2496 | ||
0fcb78c2 | 2497 | /** |
1da177e4 | 2498 | * flush_workqueue - ensure that any scheduled work has run to completion. |
0fcb78c2 | 2499 | * @wq: workqueue to flush |
1da177e4 | 2500 | * |
c5aa87bb TH |
2501 | * This function sleeps until all work items which were queued on entry |
2502 | * have finished execution, but it is not livelocked by new incoming ones. | |
1da177e4 | 2503 | */ |
7ad5b3a5 | 2504 | void flush_workqueue(struct workqueue_struct *wq) |
1da177e4 | 2505 | { |
73f53c4a TH |
2506 | struct wq_flusher this_flusher = { |
2507 | .list = LIST_HEAD_INIT(this_flusher.list), | |
2508 | .flush_color = -1, | |
2509 | .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done), | |
2510 | }; | |
2511 | int next_color; | |
1da177e4 | 2512 | |
3295f0ef IM |
2513 | lock_map_acquire(&wq->lockdep_map); |
2514 | lock_map_release(&wq->lockdep_map); | |
73f53c4a | 2515 | |
3c25a55d | 2516 | mutex_lock(&wq->mutex); |
73f53c4a TH |
2517 | |
2518 | /* | |
2519 | * Start-to-wait phase | |
2520 | */ | |
2521 | next_color = work_next_color(wq->work_color); | |
2522 | ||
2523 | if (next_color != wq->flush_color) { | |
2524 | /* | |
2525 | * Color space is not full. The current work_color | |
2526 | * becomes our flush_color and work_color is advanced | |
2527 | * by one. | |
2528 | */ | |
6183c009 | 2529 | WARN_ON_ONCE(!list_empty(&wq->flusher_overflow)); |
73f53c4a TH |
2530 | this_flusher.flush_color = wq->work_color; |
2531 | wq->work_color = next_color; | |
2532 | ||
2533 | if (!wq->first_flusher) { | |
2534 | /* no flush in progress, become the first flusher */ | |
6183c009 | 2535 | WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); |
73f53c4a TH |
2536 | |
2537 | wq->first_flusher = &this_flusher; | |
2538 | ||
112202d9 | 2539 | if (!flush_workqueue_prep_pwqs(wq, wq->flush_color, |
73f53c4a TH |
2540 | wq->work_color)) { |
2541 | /* nothing to flush, done */ | |
2542 | wq->flush_color = next_color; | |
2543 | wq->first_flusher = NULL; | |
2544 | goto out_unlock; | |
2545 | } | |
2546 | } else { | |
2547 | /* wait in queue */ | |
6183c009 | 2548 | WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color); |
73f53c4a | 2549 | list_add_tail(&this_flusher.list, &wq->flusher_queue); |
112202d9 | 2550 | flush_workqueue_prep_pwqs(wq, -1, wq->work_color); |
73f53c4a TH |
2551 | } |
2552 | } else { | |
2553 | /* | |
2554 | * Oops, color space is full, wait on overflow queue. | |
2555 | * The next flush completion will assign us | |
2556 | * flush_color and transfer to flusher_queue. | |
2557 | */ | |
2558 | list_add_tail(&this_flusher.list, &wq->flusher_overflow); | |
2559 | } | |
2560 | ||
3c25a55d | 2561 | mutex_unlock(&wq->mutex); |
73f53c4a TH |
2562 | |
2563 | wait_for_completion(&this_flusher.done); | |
2564 | ||
2565 | /* | |
2566 | * Wake-up-and-cascade phase | |
2567 | * | |
2568 | * First flushers are responsible for cascading flushes and | |
2569 | * handling overflow. Non-first flushers can simply return. | |
2570 | */ | |
2571 | if (wq->first_flusher != &this_flusher) | |
2572 | return; | |
2573 | ||
3c25a55d | 2574 | mutex_lock(&wq->mutex); |
73f53c4a | 2575 | |
4ce48b37 TH |
2576 | /* we might have raced, check again with mutex held */ |
2577 | if (wq->first_flusher != &this_flusher) | |
2578 | goto out_unlock; | |
2579 | ||
73f53c4a TH |
2580 | wq->first_flusher = NULL; |
2581 | ||
6183c009 TH |
2582 | WARN_ON_ONCE(!list_empty(&this_flusher.list)); |
2583 | WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); | |
73f53c4a TH |
2584 | |
2585 | while (true) { | |
2586 | struct wq_flusher *next, *tmp; | |
2587 | ||
2588 | /* complete all the flushers sharing the current flush color */ | |
2589 | list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { | |
2590 | if (next->flush_color != wq->flush_color) | |
2591 | break; | |
2592 | list_del_init(&next->list); | |
2593 | complete(&next->done); | |
2594 | } | |
2595 | ||
6183c009 TH |
2596 | WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) && |
2597 | wq->flush_color != work_next_color(wq->work_color)); | |
73f53c4a TH |
2598 | |
2599 | /* this flush_color is finished, advance by one */ | |
2600 | wq->flush_color = work_next_color(wq->flush_color); | |
2601 | ||
2602 | /* one color has been freed, handle overflow queue */ | |
2603 | if (!list_empty(&wq->flusher_overflow)) { | |
2604 | /* | |
2605 | * Assign the same color to all overflowed | |
2606 | * flushers, advance work_color and append to | |
2607 | * flusher_queue. This is the start-to-wait | |
2608 | * phase for these overflowed flushers. | |
2609 | */ | |
2610 | list_for_each_entry(tmp, &wq->flusher_overflow, list) | |
2611 | tmp->flush_color = wq->work_color; | |
2612 | ||
2613 | wq->work_color = work_next_color(wq->work_color); | |
2614 | ||
2615 | list_splice_tail_init(&wq->flusher_overflow, | |
2616 | &wq->flusher_queue); | |
112202d9 | 2617 | flush_workqueue_prep_pwqs(wq, -1, wq->work_color); |
73f53c4a TH |
2618 | } |
2619 | ||
2620 | if (list_empty(&wq->flusher_queue)) { | |
6183c009 | 2621 | WARN_ON_ONCE(wq->flush_color != wq->work_color); |
73f53c4a TH |
2622 | break; |
2623 | } | |
2624 | ||
2625 | /* | |
2626 | * Need to flush more colors. Make the next flusher | |
112202d9 | 2627 | * the new first flusher and arm pwqs. |
73f53c4a | 2628 | */ |
6183c009 TH |
2629 | WARN_ON_ONCE(wq->flush_color == wq->work_color); |
2630 | WARN_ON_ONCE(wq->flush_color != next->flush_color); | |
73f53c4a TH |
2631 | |
2632 | list_del_init(&next->list); | |
2633 | wq->first_flusher = next; | |
2634 | ||
112202d9 | 2635 | if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1)) |
73f53c4a TH |
2636 | break; |
2637 | ||
2638 | /* | |
2639 | * Meh... this color is already done, clear first | |
2640 | * flusher and repeat cascading. | |
2641 | */ | |
2642 | wq->first_flusher = NULL; | |
2643 | } | |
2644 | ||
2645 | out_unlock: | |
3c25a55d | 2646 | mutex_unlock(&wq->mutex); |
1da177e4 | 2647 | } |
ae90dd5d | 2648 | EXPORT_SYMBOL_GPL(flush_workqueue); |
1da177e4 | 2649 | |
9c5a2ba7 TH |
2650 | /** |
2651 | * drain_workqueue - drain a workqueue | |
2652 | * @wq: workqueue to drain | |
2653 | * | |
2654 | * Wait until the workqueue becomes empty. While draining is in progress, | |
2655 | * only chain queueing is allowed. IOW, only currently pending or running | |
2656 | * work items on @wq can queue further work items on it. @wq is flushed | |
2657 | * repeatedly until it becomes empty. The number of flushing is detemined | |
2658 | * by the depth of chaining and should be relatively short. Whine if it | |
2659 | * takes too long. | |
2660 | */ | |
2661 | void drain_workqueue(struct workqueue_struct *wq) | |
2662 | { | |
2663 | unsigned int flush_cnt = 0; | |
49e3cf44 | 2664 | struct pool_workqueue *pwq; |
9c5a2ba7 TH |
2665 | |
2666 | /* | |
2667 | * __queue_work() needs to test whether there are drainers, is much | |
2668 | * hotter than drain_workqueue() and already looks at @wq->flags. | |
618b01eb | 2669 | * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers. |
9c5a2ba7 | 2670 | */ |
87fc741e | 2671 | mutex_lock(&wq->mutex); |
9c5a2ba7 | 2672 | if (!wq->nr_drainers++) |
618b01eb | 2673 | wq->flags |= __WQ_DRAINING; |
87fc741e | 2674 | mutex_unlock(&wq->mutex); |
9c5a2ba7 TH |
2675 | reflush: |
2676 | flush_workqueue(wq); | |
2677 | ||
b09f4fd3 | 2678 | mutex_lock(&wq->mutex); |
76af4d93 | 2679 | |
49e3cf44 | 2680 | for_each_pwq(pwq, wq) { |
fa2563e4 | 2681 | bool drained; |
9c5a2ba7 | 2682 | |
b09f4fd3 | 2683 | spin_lock_irq(&pwq->pool->lock); |
112202d9 | 2684 | drained = !pwq->nr_active && list_empty(&pwq->delayed_works); |
b09f4fd3 | 2685 | spin_unlock_irq(&pwq->pool->lock); |
fa2563e4 TT |
2686 | |
2687 | if (drained) | |
9c5a2ba7 TH |
2688 | continue; |
2689 | ||
2690 | if (++flush_cnt == 10 || | |
2691 | (flush_cnt % 100 == 0 && flush_cnt <= 1000)) | |
c5aa87bb | 2692 | pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n", |
044c782c | 2693 | wq->name, flush_cnt); |
76af4d93 | 2694 | |
b09f4fd3 | 2695 | mutex_unlock(&wq->mutex); |
9c5a2ba7 TH |
2696 | goto reflush; |
2697 | } | |
2698 | ||
9c5a2ba7 | 2699 | if (!--wq->nr_drainers) |
618b01eb | 2700 | wq->flags &= ~__WQ_DRAINING; |
87fc741e | 2701 | mutex_unlock(&wq->mutex); |
9c5a2ba7 TH |
2702 | } |
2703 | EXPORT_SYMBOL_GPL(drain_workqueue); | |
2704 | ||
606a5020 | 2705 | static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr) |
db700897 | 2706 | { |
affee4b2 | 2707 | struct worker *worker = NULL; |
c9e7cf27 | 2708 | struct worker_pool *pool; |
112202d9 | 2709 | struct pool_workqueue *pwq; |
db700897 ON |
2710 | |
2711 | might_sleep(); | |
fa1b54e6 TH |
2712 | |
2713 | local_irq_disable(); | |
c9e7cf27 | 2714 | pool = get_work_pool(work); |
fa1b54e6 TH |
2715 | if (!pool) { |
2716 | local_irq_enable(); | |
baf59022 | 2717 | return false; |
fa1b54e6 | 2718 | } |
db700897 | 2719 | |
fa1b54e6 | 2720 | spin_lock(&pool->lock); |
0b3dae68 | 2721 | /* see the comment in try_to_grab_pending() with the same code */ |
112202d9 TH |
2722 | pwq = get_work_pwq(work); |
2723 | if (pwq) { | |
2724 | if (unlikely(pwq->pool != pool)) | |
4690c4ab | 2725 | goto already_gone; |
606a5020 | 2726 | } else { |
c9e7cf27 | 2727 | worker = find_worker_executing_work(pool, work); |
affee4b2 | 2728 | if (!worker) |
4690c4ab | 2729 | goto already_gone; |
112202d9 | 2730 | pwq = worker->current_pwq; |
606a5020 | 2731 | } |
db700897 | 2732 | |
112202d9 | 2733 | insert_wq_barrier(pwq, barr, work, worker); |
d565ed63 | 2734 | spin_unlock_irq(&pool->lock); |
7a22ad75 | 2735 | |
e159489b TH |
2736 | /* |
2737 | * If @max_active is 1 or rescuer is in use, flushing another work | |
2738 | * item on the same workqueue may lead to deadlock. Make sure the | |
2739 | * flusher is not running on the same workqueue by verifying write | |
2740 | * access. | |
2741 | */ | |
493008a8 | 2742 | if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer) |
112202d9 | 2743 | lock_map_acquire(&pwq->wq->lockdep_map); |
e159489b | 2744 | else |
112202d9 TH |
2745 | lock_map_acquire_read(&pwq->wq->lockdep_map); |
2746 | lock_map_release(&pwq->wq->lockdep_map); | |
e159489b | 2747 | |
401a8d04 | 2748 | return true; |
4690c4ab | 2749 | already_gone: |
d565ed63 | 2750 | spin_unlock_irq(&pool->lock); |
401a8d04 | 2751 | return false; |
db700897 | 2752 | } |
baf59022 TH |
2753 | |
2754 | /** | |
2755 | * flush_work - wait for a work to finish executing the last queueing instance | |
2756 | * @work: the work to flush | |
2757 | * | |
606a5020 TH |
2758 | * Wait until @work has finished execution. @work is guaranteed to be idle |
2759 | * on return if it hasn't been requeued since flush started. | |
baf59022 | 2760 | * |
d185af30 | 2761 | * Return: |
baf59022 TH |
2762 | * %true if flush_work() waited for the work to finish execution, |
2763 | * %false if it was already idle. | |
2764 | */ | |
2765 | bool flush_work(struct work_struct *work) | |
2766 | { | |
12997d1a BH |
2767 | struct wq_barrier barr; |
2768 | ||
0976dfc1 SB |
2769 | lock_map_acquire(&work->lockdep_map); |
2770 | lock_map_release(&work->lockdep_map); | |
2771 | ||
12997d1a BH |
2772 | if (start_flush_work(work, &barr)) { |
2773 | wait_for_completion(&barr.done); | |
2774 | destroy_work_on_stack(&barr.work); | |
2775 | return true; | |
2776 | } else { | |
2777 | return false; | |
2778 | } | |
6e84d644 | 2779 | } |
606a5020 | 2780 | EXPORT_SYMBOL_GPL(flush_work); |
6e84d644 | 2781 | |
36e227d2 | 2782 | static bool __cancel_work_timer(struct work_struct *work, bool is_dwork) |
1f1f642e | 2783 | { |
bbb68dfa | 2784 | unsigned long flags; |
1f1f642e ON |
2785 | int ret; |
2786 | ||
2787 | do { | |
bbb68dfa TH |
2788 | ret = try_to_grab_pending(work, is_dwork, &flags); |
2789 | /* | |
2790 | * If someone else is canceling, wait for the same event it | |
2791 | * would be waiting for before retrying. | |
2792 | */ | |
2793 | if (unlikely(ret == -ENOENT)) | |
606a5020 | 2794 | flush_work(work); |
1f1f642e ON |
2795 | } while (unlikely(ret < 0)); |
2796 | ||
bbb68dfa TH |
2797 | /* tell other tasks trying to grab @work to back off */ |
2798 | mark_work_canceling(work); | |
2799 | local_irq_restore(flags); | |
2800 | ||
606a5020 | 2801 | flush_work(work); |
7a22ad75 | 2802 | clear_work_data(work); |
1f1f642e ON |
2803 | return ret; |
2804 | } | |
2805 | ||
6e84d644 | 2806 | /** |
401a8d04 TH |
2807 | * cancel_work_sync - cancel a work and wait for it to finish |
2808 | * @work: the work to cancel | |
6e84d644 | 2809 | * |
401a8d04 TH |
2810 | * Cancel @work and wait for its execution to finish. This function |
2811 | * can be used even if the work re-queues itself or migrates to | |
2812 | * another workqueue. On return from this function, @work is | |
2813 | * guaranteed to be not pending or executing on any CPU. | |
1f1f642e | 2814 | * |
401a8d04 TH |
2815 | * cancel_work_sync(&delayed_work->work) must not be used for |
2816 | * delayed_work's. Use cancel_delayed_work_sync() instead. | |
6e84d644 | 2817 | * |
401a8d04 | 2818 | * The caller must ensure that the workqueue on which @work was last |
6e84d644 | 2819 | * queued can't be destroyed before this function returns. |
401a8d04 | 2820 | * |
d185af30 | 2821 | * Return: |
401a8d04 | 2822 | * %true if @work was pending, %false otherwise. |
6e84d644 | 2823 | */ |
401a8d04 | 2824 | bool cancel_work_sync(struct work_struct *work) |
6e84d644 | 2825 | { |
36e227d2 | 2826 | return __cancel_work_timer(work, false); |
b89deed3 | 2827 | } |
28e53bdd | 2828 | EXPORT_SYMBOL_GPL(cancel_work_sync); |
b89deed3 | 2829 | |
6e84d644 | 2830 | /** |
401a8d04 TH |
2831 | * flush_delayed_work - wait for a dwork to finish executing the last queueing |
2832 | * @dwork: the delayed work to flush | |
6e84d644 | 2833 | * |
401a8d04 TH |
2834 | * Delayed timer is cancelled and the pending work is queued for |
2835 | * immediate execution. Like flush_work(), this function only | |
2836 | * considers the last queueing instance of @dwork. | |
1f1f642e | 2837 | * |
d185af30 | 2838 | * Return: |
401a8d04 TH |
2839 | * %true if flush_work() waited for the work to finish execution, |
2840 | * %false if it was already idle. | |
6e84d644 | 2841 | */ |
401a8d04 TH |
2842 | bool flush_delayed_work(struct delayed_work *dwork) |
2843 | { | |
8930caba | 2844 | local_irq_disable(); |
401a8d04 | 2845 | if (del_timer_sync(&dwork->timer)) |
60c057bc | 2846 | __queue_work(dwork->cpu, dwork->wq, &dwork->work); |
8930caba | 2847 | local_irq_enable(); |
401a8d04 TH |
2848 | return flush_work(&dwork->work); |
2849 | } | |
2850 | EXPORT_SYMBOL(flush_delayed_work); | |
2851 | ||
09383498 | 2852 | /** |
57b30ae7 TH |
2853 | * cancel_delayed_work - cancel a delayed work |
2854 | * @dwork: delayed_work to cancel | |
09383498 | 2855 | * |
d185af30 YB |
2856 | * Kill off a pending delayed_work. |
2857 | * | |
2858 | * Return: %true if @dwork was pending and canceled; %false if it wasn't | |
2859 | * pending. | |
2860 | * | |
2861 | * Note: | |
2862 | * The work callback function may still be running on return, unless | |
2863 | * it returns %true and the work doesn't re-arm itself. Explicitly flush or | |
2864 | * use cancel_delayed_work_sync() to wait on it. | |
09383498 | 2865 | * |
57b30ae7 | 2866 | * This function is safe to call from any context including IRQ handler. |
09383498 | 2867 | */ |
57b30ae7 | 2868 | bool cancel_delayed_work(struct delayed_work *dwork) |
09383498 | 2869 | { |
57b30ae7 TH |
2870 | unsigned long flags; |
2871 | int ret; | |
2872 | ||
2873 | do { | |
2874 | ret = try_to_grab_pending(&dwork->work, true, &flags); | |
2875 | } while (unlikely(ret == -EAGAIN)); | |
2876 | ||
2877 | if (unlikely(ret < 0)) | |
2878 | return false; | |
2879 | ||
7c3eed5c TH |
2880 | set_work_pool_and_clear_pending(&dwork->work, |
2881 | get_work_pool_id(&dwork->work)); | |
57b30ae7 | 2882 | local_irq_restore(flags); |
c0158ca6 | 2883 | return ret; |
09383498 | 2884 | } |
57b30ae7 | 2885 | EXPORT_SYMBOL(cancel_delayed_work); |
09383498 | 2886 | |
401a8d04 TH |
2887 | /** |
2888 | * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish | |
2889 | * @dwork: the delayed work cancel | |
2890 | * | |
2891 | * This is cancel_work_sync() for delayed works. | |
2892 | * | |
d185af30 | 2893 | * Return: |
401a8d04 TH |
2894 | * %true if @dwork was pending, %false otherwise. |
2895 | */ | |
2896 | bool cancel_delayed_work_sync(struct delayed_work *dwork) | |
6e84d644 | 2897 | { |
36e227d2 | 2898 | return __cancel_work_timer(&dwork->work, true); |
6e84d644 | 2899 | } |
f5a421a4 | 2900 | EXPORT_SYMBOL(cancel_delayed_work_sync); |
1da177e4 | 2901 | |
b6136773 | 2902 | /** |
31ddd871 | 2903 | * schedule_on_each_cpu - execute a function synchronously on each online CPU |
b6136773 | 2904 | * @func: the function to call |
b6136773 | 2905 | * |
31ddd871 TH |
2906 | * schedule_on_each_cpu() executes @func on each online CPU using the |
2907 | * system workqueue and blocks until all CPUs have completed. | |
b6136773 | 2908 | * schedule_on_each_cpu() is very slow. |
31ddd871 | 2909 | * |
d185af30 | 2910 | * Return: |
31ddd871 | 2911 | * 0 on success, -errno on failure. |
b6136773 | 2912 | */ |
65f27f38 | 2913 | int schedule_on_each_cpu(work_func_t func) |
15316ba8 CL |
2914 | { |
2915 | int cpu; | |
38f51568 | 2916 | struct work_struct __percpu *works; |
15316ba8 | 2917 | |
b6136773 AM |
2918 | works = alloc_percpu(struct work_struct); |
2919 | if (!works) | |
15316ba8 | 2920 | return -ENOMEM; |
b6136773 | 2921 | |
93981800 TH |
2922 | get_online_cpus(); |
2923 | ||
15316ba8 | 2924 | for_each_online_cpu(cpu) { |
9bfb1839 IM |
2925 | struct work_struct *work = per_cpu_ptr(works, cpu); |
2926 | ||
2927 | INIT_WORK(work, func); | |
b71ab8c2 | 2928 | schedule_work_on(cpu, work); |
65a64464 | 2929 | } |
93981800 TH |
2930 | |
2931 | for_each_online_cpu(cpu) | |
2932 | flush_work(per_cpu_ptr(works, cpu)); | |
2933 | ||
95402b38 | 2934 | put_online_cpus(); |
b6136773 | 2935 | free_percpu(works); |
15316ba8 CL |
2936 | return 0; |
2937 | } | |
2938 | ||
eef6a7d5 AS |
2939 | /** |
2940 | * flush_scheduled_work - ensure that any scheduled work has run to completion. | |
2941 | * | |
2942 | * Forces execution of the kernel-global workqueue and blocks until its | |
2943 | * completion. | |
2944 | * | |
2945 | * Think twice before calling this function! It's very easy to get into | |
2946 | * trouble if you don't take great care. Either of the following situations | |
2947 | * will lead to deadlock: | |
2948 | * | |
2949 | * One of the work items currently on the workqueue needs to acquire | |
2950 | * a lock held by your code or its caller. | |
2951 | * | |
2952 | * Your code is running in the context of a work routine. | |
2953 | * | |
2954 | * They will be detected by lockdep when they occur, but the first might not | |
2955 | * occur very often. It depends on what work items are on the workqueue and | |
2956 | * what locks they need, which you have no control over. | |
2957 | * | |
2958 | * In most situations flushing the entire workqueue is overkill; you merely | |
2959 | * need to know that a particular work item isn't queued and isn't running. | |
2960 | * In such cases you should use cancel_delayed_work_sync() or | |
2961 | * cancel_work_sync() instead. | |
2962 | */ | |
1da177e4 LT |
2963 | void flush_scheduled_work(void) |
2964 | { | |
d320c038 | 2965 | flush_workqueue(system_wq); |
1da177e4 | 2966 | } |
ae90dd5d | 2967 | EXPORT_SYMBOL(flush_scheduled_work); |
1da177e4 | 2968 | |
1fa44eca JB |
2969 | /** |
2970 | * execute_in_process_context - reliably execute the routine with user context | |
2971 | * @fn: the function to execute | |
1fa44eca JB |
2972 | * @ew: guaranteed storage for the execute work structure (must |
2973 | * be available when the work executes) | |
2974 | * | |
2975 | * Executes the function immediately if process context is available, | |
2976 | * otherwise schedules the function for delayed execution. | |
2977 | * | |
d185af30 | 2978 | * Return: 0 - function was executed |
1fa44eca JB |
2979 | * 1 - function was scheduled for execution |
2980 | */ | |
65f27f38 | 2981 | int execute_in_process_context(work_func_t fn, struct execute_work *ew) |
1fa44eca JB |
2982 | { |
2983 | if (!in_interrupt()) { | |
65f27f38 | 2984 | fn(&ew->work); |
1fa44eca JB |
2985 | return 0; |
2986 | } | |
2987 | ||
65f27f38 | 2988 | INIT_WORK(&ew->work, fn); |
1fa44eca JB |
2989 | schedule_work(&ew->work); |
2990 | ||
2991 | return 1; | |
2992 | } | |
2993 | EXPORT_SYMBOL_GPL(execute_in_process_context); | |
2994 | ||
226223ab TH |
2995 | #ifdef CONFIG_SYSFS |
2996 | /* | |
2997 | * Workqueues with WQ_SYSFS flag set is visible to userland via | |
2998 | * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the | |
2999 | * following attributes. | |
3000 | * | |
3001 | * per_cpu RO bool : whether the workqueue is per-cpu or unbound | |
3002 | * max_active RW int : maximum number of in-flight work items | |
3003 | * | |
3004 | * Unbound workqueues have the following extra attributes. | |
3005 | * | |
3006 | * id RO int : the associated pool ID | |
3007 | * nice RW int : nice value of the workers | |
3008 | * cpumask RW mask : bitmask of allowed CPUs for the workers | |
3009 | */ | |
3010 | struct wq_device { | |
3011 | struct workqueue_struct *wq; | |
3012 | struct device dev; | |
3013 | }; | |
3014 | ||
3015 | static struct workqueue_struct *dev_to_wq(struct device *dev) | |
3016 | { | |
3017 | struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); | |
3018 | ||
3019 | return wq_dev->wq; | |
3020 | } | |
3021 | ||
1a6661da GKH |
3022 | static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr, |
3023 | char *buf) | |
226223ab TH |
3024 | { |
3025 | struct workqueue_struct *wq = dev_to_wq(dev); | |
3026 | ||
3027 | return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND)); | |
3028 | } | |
1a6661da | 3029 | static DEVICE_ATTR_RO(per_cpu); |
226223ab | 3030 | |
1a6661da GKH |
3031 | static ssize_t max_active_show(struct device *dev, |
3032 | struct device_attribute *attr, char *buf) | |
226223ab TH |
3033 | { |
3034 | struct workqueue_struct *wq = dev_to_wq(dev); | |
3035 | ||
3036 | return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active); | |
3037 | } | |
3038 | ||
1a6661da GKH |
3039 | static ssize_t max_active_store(struct device *dev, |
3040 | struct device_attribute *attr, const char *buf, | |
3041 | size_t count) | |
226223ab TH |
3042 | { |
3043 | struct workqueue_struct *wq = dev_to_wq(dev); | |
3044 | int val; | |
3045 | ||
3046 | if (sscanf(buf, "%d", &val) != 1 || val <= 0) | |
3047 | return -EINVAL; | |
3048 | ||
3049 | workqueue_set_max_active(wq, val); | |
3050 | return count; | |
3051 | } | |
1a6661da | 3052 | static DEVICE_ATTR_RW(max_active); |
226223ab | 3053 | |
1a6661da GKH |
3054 | static struct attribute *wq_sysfs_attrs[] = { |
3055 | &dev_attr_per_cpu.attr, | |
3056 | &dev_attr_max_active.attr, | |
3057 | NULL, | |
226223ab | 3058 | }; |
1a6661da | 3059 | ATTRIBUTE_GROUPS(wq_sysfs); |
226223ab | 3060 | |
d55262c4 TH |
3061 | static ssize_t wq_pool_ids_show(struct device *dev, |
3062 | struct device_attribute *attr, char *buf) | |
226223ab TH |
3063 | { |
3064 | struct workqueue_struct *wq = dev_to_wq(dev); | |
d55262c4 TH |
3065 | const char *delim = ""; |
3066 | int node, written = 0; | |
226223ab TH |
3067 | |
3068 | rcu_read_lock_sched(); | |
d55262c4 TH |
3069 | for_each_node(node) { |
3070 | written += scnprintf(buf + written, PAGE_SIZE - written, | |
3071 | "%s%d:%d", delim, node, | |
3072 | unbound_pwq_by_node(wq, node)->pool->id); | |
3073 | delim = " "; | |
3074 | } | |
3075 | written += scnprintf(buf + written, PAGE_SIZE - written, "\n"); | |
226223ab TH |
3076 | rcu_read_unlock_sched(); |
3077 | ||
3078 | return written; | |
3079 | } | |
3080 | ||
3081 | static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr, | |
3082 | char *buf) | |
3083 | { | |
3084 | struct workqueue_struct *wq = dev_to_wq(dev); | |
3085 | int written; | |
3086 | ||
6029a918 TH |
3087 | mutex_lock(&wq->mutex); |
3088 | written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice); | |
3089 | mutex_unlock(&wq->mutex); | |
226223ab TH |
3090 | |
3091 | return written; | |
3092 | } | |
3093 | ||
3094 | /* prepare workqueue_attrs for sysfs store operations */ | |
3095 | static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq) | |
3096 | { | |
3097 | struct workqueue_attrs *attrs; | |
3098 | ||
3099 | attrs = alloc_workqueue_attrs(GFP_KERNEL); | |
3100 | if (!attrs) | |
3101 | return NULL; | |
3102 | ||
6029a918 TH |
3103 | mutex_lock(&wq->mutex); |
3104 | copy_workqueue_attrs(attrs, wq->unbound_attrs); | |
3105 | mutex_unlock(&wq->mutex); | |
226223ab TH |
3106 | return attrs; |
3107 | } | |
3108 | ||
3109 | static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr, | |
3110 | const char *buf, size_t count) | |
3111 | { | |
3112 | struct workqueue_struct *wq = dev_to_wq(dev); | |
3113 | struct workqueue_attrs *attrs; | |
3114 | int ret; | |
3115 | ||
3116 | attrs = wq_sysfs_prep_attrs(wq); | |
3117 | if (!attrs) | |
3118 | return -ENOMEM; | |
3119 | ||
3120 | if (sscanf(buf, "%d", &attrs->nice) == 1 && | |
14481842 | 3121 | attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE) |
226223ab TH |
3122 | ret = apply_workqueue_attrs(wq, attrs); |
3123 | else | |
3124 | ret = -EINVAL; | |
3125 | ||
3126 | free_workqueue_attrs(attrs); | |
3127 | return ret ?: count; | |
3128 | } | |
3129 | ||
3130 | static ssize_t wq_cpumask_show(struct device *dev, | |
3131 | struct device_attribute *attr, char *buf) | |
3132 | { | |
3133 | struct workqueue_struct *wq = dev_to_wq(dev); | |
3134 | int written; | |
3135 | ||
6029a918 TH |
3136 | mutex_lock(&wq->mutex); |
3137 | written = cpumask_scnprintf(buf, PAGE_SIZE, wq->unbound_attrs->cpumask); | |
3138 | mutex_unlock(&wq->mutex); | |
226223ab TH |
3139 | |
3140 | written += scnprintf(buf + written, PAGE_SIZE - written, "\n"); | |
3141 | return written; | |
3142 | } | |
3143 | ||
3144 | static ssize_t wq_cpumask_store(struct device *dev, | |
3145 | struct device_attribute *attr, | |
3146 | const char *buf, size_t count) | |
3147 | { | |
3148 | struct workqueue_struct *wq = dev_to_wq(dev); | |
3149 | struct workqueue_attrs *attrs; | |
3150 | int ret; | |
3151 | ||
3152 | attrs = wq_sysfs_prep_attrs(wq); | |
3153 | if (!attrs) | |
3154 | return -ENOMEM; | |
3155 | ||
3156 | ret = cpumask_parse(buf, attrs->cpumask); | |
3157 | if (!ret) | |
3158 | ret = apply_workqueue_attrs(wq, attrs); | |
3159 | ||
3160 | free_workqueue_attrs(attrs); | |
3161 | return ret ?: count; | |
3162 | } | |
3163 | ||
d55262c4 TH |
3164 | static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr, |
3165 | char *buf) | |
3166 | { | |
3167 | struct workqueue_struct *wq = dev_to_wq(dev); | |
3168 | int written; | |
3169 | ||
3170 | mutex_lock(&wq->mutex); | |
3171 | written = scnprintf(buf, PAGE_SIZE, "%d\n", | |
3172 | !wq->unbound_attrs->no_numa); | |
3173 | mutex_unlock(&wq->mutex); | |
3174 | ||
3175 | return written; | |
3176 | } | |
3177 | ||
3178 | static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr, | |
3179 | const char *buf, size_t count) | |
3180 | { | |
3181 | struct workqueue_struct *wq = dev_to_wq(dev); | |
3182 | struct workqueue_attrs *attrs; | |
3183 | int v, ret; | |
3184 | ||
3185 | attrs = wq_sysfs_prep_attrs(wq); | |
3186 | if (!attrs) | |
3187 | return -ENOMEM; | |
3188 | ||
3189 | ret = -EINVAL; | |
3190 | if (sscanf(buf, "%d", &v) == 1) { | |
3191 | attrs->no_numa = !v; | |
3192 | ret = apply_workqueue_attrs(wq, attrs); | |
3193 | } | |
3194 | ||
3195 | free_workqueue_attrs(attrs); | |
3196 | return ret ?: count; | |
3197 | } | |
3198 | ||
226223ab | 3199 | static struct device_attribute wq_sysfs_unbound_attrs[] = { |
d55262c4 | 3200 | __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL), |
226223ab TH |
3201 | __ATTR(nice, 0644, wq_nice_show, wq_nice_store), |
3202 | __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store), | |
d55262c4 | 3203 | __ATTR(numa, 0644, wq_numa_show, wq_numa_store), |
226223ab TH |
3204 | __ATTR_NULL, |
3205 | }; | |
3206 | ||
3207 | static struct bus_type wq_subsys = { | |
3208 | .name = "workqueue", | |
1a6661da | 3209 | .dev_groups = wq_sysfs_groups, |
226223ab TH |
3210 | }; |
3211 | ||
3212 | static int __init wq_sysfs_init(void) | |
3213 | { | |
3214 | return subsys_virtual_register(&wq_subsys, NULL); | |
3215 | } | |
3216 | core_initcall(wq_sysfs_init); | |
3217 | ||
3218 | static void wq_device_release(struct device *dev) | |
3219 | { | |
3220 | struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); | |
3221 | ||
3222 | kfree(wq_dev); | |
3223 | } | |
3224 | ||
3225 | /** | |
3226 | * workqueue_sysfs_register - make a workqueue visible in sysfs | |
3227 | * @wq: the workqueue to register | |
3228 | * | |
3229 | * Expose @wq in sysfs under /sys/bus/workqueue/devices. | |
3230 | * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set | |
3231 | * which is the preferred method. | |
3232 | * | |
3233 | * Workqueue user should use this function directly iff it wants to apply | |
3234 | * workqueue_attrs before making the workqueue visible in sysfs; otherwise, | |
3235 | * apply_workqueue_attrs() may race against userland updating the | |
3236 | * attributes. | |
3237 | * | |
d185af30 | 3238 | * Return: 0 on success, -errno on failure. |
226223ab TH |
3239 | */ |
3240 | int workqueue_sysfs_register(struct workqueue_struct *wq) | |
3241 | { | |
3242 | struct wq_device *wq_dev; | |
3243 | int ret; | |
3244 | ||
3245 | /* | |
3246 | * Adjusting max_active or creating new pwqs by applyting | |
3247 | * attributes breaks ordering guarantee. Disallow exposing ordered | |
3248 | * workqueues. | |
3249 | */ | |
3250 | if (WARN_ON(wq->flags & __WQ_ORDERED)) | |
3251 | return -EINVAL; | |
3252 | ||
3253 | wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL); | |
3254 | if (!wq_dev) | |
3255 | return -ENOMEM; | |
3256 | ||
3257 | wq_dev->wq = wq; | |
3258 | wq_dev->dev.bus = &wq_subsys; | |
3259 | wq_dev->dev.init_name = wq->name; | |
3260 | wq_dev->dev.release = wq_device_release; | |
3261 | ||
3262 | /* | |
3263 | * unbound_attrs are created separately. Suppress uevent until | |
3264 | * everything is ready. | |
3265 | */ | |
3266 | dev_set_uevent_suppress(&wq_dev->dev, true); | |
3267 | ||
3268 | ret = device_register(&wq_dev->dev); | |
3269 | if (ret) { | |
3270 | kfree(wq_dev); | |
3271 | wq->wq_dev = NULL; | |
3272 | return ret; | |
3273 | } | |
3274 | ||
3275 | if (wq->flags & WQ_UNBOUND) { | |
3276 | struct device_attribute *attr; | |
3277 | ||
3278 | for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) { | |
3279 | ret = device_create_file(&wq_dev->dev, attr); | |
3280 | if (ret) { | |
3281 | device_unregister(&wq_dev->dev); | |
3282 | wq->wq_dev = NULL; | |
3283 | return ret; | |
3284 | } | |
3285 | } | |
3286 | } | |
3287 | ||
3288 | kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD); | |
3289 | return 0; | |
3290 | } | |
3291 | ||
3292 | /** | |
3293 | * workqueue_sysfs_unregister - undo workqueue_sysfs_register() | |
3294 | * @wq: the workqueue to unregister | |
3295 | * | |
3296 | * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister. | |
3297 | */ | |
3298 | static void workqueue_sysfs_unregister(struct workqueue_struct *wq) | |
3299 | { | |
3300 | struct wq_device *wq_dev = wq->wq_dev; | |
3301 | ||
3302 | if (!wq->wq_dev) | |
3303 | return; | |
3304 | ||
3305 | wq->wq_dev = NULL; | |
3306 | device_unregister(&wq_dev->dev); | |
3307 | } | |
3308 | #else /* CONFIG_SYSFS */ | |
3309 | static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { } | |
3310 | #endif /* CONFIG_SYSFS */ | |
3311 | ||
7a4e344c TH |
3312 | /** |
3313 | * free_workqueue_attrs - free a workqueue_attrs | |
3314 | * @attrs: workqueue_attrs to free | |
3315 | * | |
3316 | * Undo alloc_workqueue_attrs(). | |
3317 | */ | |
3318 | void free_workqueue_attrs(struct workqueue_attrs *attrs) | |
3319 | { | |
3320 | if (attrs) { | |
3321 | free_cpumask_var(attrs->cpumask); | |
3322 | kfree(attrs); | |
3323 | } | |
3324 | } | |
3325 | ||
3326 | /** | |
3327 | * alloc_workqueue_attrs - allocate a workqueue_attrs | |
3328 | * @gfp_mask: allocation mask to use | |
3329 | * | |
3330 | * Allocate a new workqueue_attrs, initialize with default settings and | |
d185af30 YB |
3331 | * return it. |
3332 | * | |
3333 | * Return: The allocated new workqueue_attr on success. %NULL on failure. | |
7a4e344c TH |
3334 | */ |
3335 | struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask) | |
3336 | { | |
3337 | struct workqueue_attrs *attrs; | |
3338 | ||
3339 | attrs = kzalloc(sizeof(*attrs), gfp_mask); | |
3340 | if (!attrs) | |
3341 | goto fail; | |
3342 | if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask)) | |
3343 | goto fail; | |
3344 | ||
13e2e556 | 3345 | cpumask_copy(attrs->cpumask, cpu_possible_mask); |
7a4e344c TH |
3346 | return attrs; |
3347 | fail: | |
3348 | free_workqueue_attrs(attrs); | |
3349 | return NULL; | |
3350 | } | |
3351 | ||
29c91e99 TH |
3352 | static void copy_workqueue_attrs(struct workqueue_attrs *to, |
3353 | const struct workqueue_attrs *from) | |
3354 | { | |
3355 | to->nice = from->nice; | |
3356 | cpumask_copy(to->cpumask, from->cpumask); | |
2865a8fb SL |
3357 | /* |
3358 | * Unlike hash and equality test, this function doesn't ignore | |
3359 | * ->no_numa as it is used for both pool and wq attrs. Instead, | |
3360 | * get_unbound_pool() explicitly clears ->no_numa after copying. | |
3361 | */ | |
3362 | to->no_numa = from->no_numa; | |
29c91e99 TH |
3363 | } |
3364 | ||
29c91e99 TH |
3365 | /* hash value of the content of @attr */ |
3366 | static u32 wqattrs_hash(const struct workqueue_attrs *attrs) | |
3367 | { | |
3368 | u32 hash = 0; | |
3369 | ||
3370 | hash = jhash_1word(attrs->nice, hash); | |
13e2e556 TH |
3371 | hash = jhash(cpumask_bits(attrs->cpumask), |
3372 | BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); | |
29c91e99 TH |
3373 | return hash; |
3374 | } | |
3375 | ||
3376 | /* content equality test */ | |
3377 | static bool wqattrs_equal(const struct workqueue_attrs *a, | |
3378 | const struct workqueue_attrs *b) | |
3379 | { | |
3380 | if (a->nice != b->nice) | |
3381 | return false; | |
3382 | if (!cpumask_equal(a->cpumask, b->cpumask)) | |
3383 | return false; | |
3384 | return true; | |
3385 | } | |
3386 | ||
7a4e344c TH |
3387 | /** |
3388 | * init_worker_pool - initialize a newly zalloc'd worker_pool | |
3389 | * @pool: worker_pool to initialize | |
3390 | * | |
3391 | * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs. | |
d185af30 YB |
3392 | * |
3393 | * Return: 0 on success, -errno on failure. Even on failure, all fields | |
29c91e99 TH |
3394 | * inside @pool proper are initialized and put_unbound_pool() can be called |
3395 | * on @pool safely to release it. | |
7a4e344c TH |
3396 | */ |
3397 | static int init_worker_pool(struct worker_pool *pool) | |
4e1a1f9a TH |
3398 | { |
3399 | spin_lock_init(&pool->lock); | |
29c91e99 TH |
3400 | pool->id = -1; |
3401 | pool->cpu = -1; | |
f3f90ad4 | 3402 | pool->node = NUMA_NO_NODE; |
4e1a1f9a TH |
3403 | pool->flags |= POOL_DISASSOCIATED; |
3404 | INIT_LIST_HEAD(&pool->worklist); | |
3405 | INIT_LIST_HEAD(&pool->idle_list); | |
3406 | hash_init(pool->busy_hash); | |
3407 | ||
3408 | init_timer_deferrable(&pool->idle_timer); | |
3409 | pool->idle_timer.function = idle_worker_timeout; | |
3410 | pool->idle_timer.data = (unsigned long)pool; | |
3411 | ||
3412 | setup_timer(&pool->mayday_timer, pool_mayday_timeout, | |
3413 | (unsigned long)pool); | |
3414 | ||
3415 | mutex_init(&pool->manager_arb); | |
92f9c5c4 | 3416 | mutex_init(&pool->attach_mutex); |
da028469 | 3417 | INIT_LIST_HEAD(&pool->workers); |
7a4e344c | 3418 | |
7cda9aae | 3419 | ida_init(&pool->worker_ida); |
29c91e99 TH |
3420 | INIT_HLIST_NODE(&pool->hash_node); |
3421 | pool->refcnt = 1; | |
3422 | ||
3423 | /* shouldn't fail above this point */ | |
7a4e344c TH |
3424 | pool->attrs = alloc_workqueue_attrs(GFP_KERNEL); |
3425 | if (!pool->attrs) | |
3426 | return -ENOMEM; | |
3427 | return 0; | |
4e1a1f9a TH |
3428 | } |
3429 | ||
29c91e99 TH |
3430 | static void rcu_free_pool(struct rcu_head *rcu) |
3431 | { | |
3432 | struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu); | |
3433 | ||
7cda9aae | 3434 | ida_destroy(&pool->worker_ida); |
29c91e99 TH |
3435 | free_workqueue_attrs(pool->attrs); |
3436 | kfree(pool); | |
3437 | } | |
3438 | ||
3439 | /** | |
3440 | * put_unbound_pool - put a worker_pool | |
3441 | * @pool: worker_pool to put | |
3442 | * | |
3443 | * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU | |
c5aa87bb TH |
3444 | * safe manner. get_unbound_pool() calls this function on its failure path |
3445 | * and this function should be able to release pools which went through, | |
3446 | * successfully or not, init_worker_pool(). | |
a892cacc TH |
3447 | * |
3448 | * Should be called with wq_pool_mutex held. | |
29c91e99 TH |
3449 | */ |
3450 | static void put_unbound_pool(struct worker_pool *pool) | |
3451 | { | |
60f5a4bc | 3452 | DECLARE_COMPLETION_ONSTACK(detach_completion); |
29c91e99 TH |
3453 | struct worker *worker; |
3454 | ||
a892cacc TH |
3455 | lockdep_assert_held(&wq_pool_mutex); |
3456 | ||
3457 | if (--pool->refcnt) | |
29c91e99 | 3458 | return; |
29c91e99 TH |
3459 | |
3460 | /* sanity checks */ | |
3461 | if (WARN_ON(!(pool->flags & POOL_DISASSOCIATED)) || | |
a892cacc | 3462 | WARN_ON(!list_empty(&pool->worklist))) |
29c91e99 | 3463 | return; |
29c91e99 TH |
3464 | |
3465 | /* release id and unhash */ | |
3466 | if (pool->id >= 0) | |
3467 | idr_remove(&worker_pool_idr, pool->id); | |
3468 | hash_del(&pool->hash_node); | |
3469 | ||
c5aa87bb TH |
3470 | /* |
3471 | * Become the manager and destroy all workers. Grabbing | |
3472 | * manager_arb prevents @pool's workers from blocking on | |
92f9c5c4 | 3473 | * attach_mutex. |
c5aa87bb | 3474 | */ |
29c91e99 | 3475 | mutex_lock(&pool->manager_arb); |
29c91e99 | 3476 | |
60f5a4bc | 3477 | spin_lock_irq(&pool->lock); |
1037de36 | 3478 | while ((worker = first_idle_worker(pool))) |
29c91e99 TH |
3479 | destroy_worker(worker); |
3480 | WARN_ON(pool->nr_workers || pool->nr_idle); | |
29c91e99 | 3481 | spin_unlock_irq(&pool->lock); |
60f5a4bc | 3482 | |
92f9c5c4 | 3483 | mutex_lock(&pool->attach_mutex); |
da028469 | 3484 | if (!list_empty(&pool->workers)) |
60f5a4bc | 3485 | pool->detach_completion = &detach_completion; |
92f9c5c4 | 3486 | mutex_unlock(&pool->attach_mutex); |
60f5a4bc LJ |
3487 | |
3488 | if (pool->detach_completion) | |
3489 | wait_for_completion(pool->detach_completion); | |
3490 | ||
29c91e99 TH |
3491 | mutex_unlock(&pool->manager_arb); |
3492 | ||
3493 | /* shut down the timers */ | |
3494 | del_timer_sync(&pool->idle_timer); | |
3495 | del_timer_sync(&pool->mayday_timer); | |
3496 | ||
3497 | /* sched-RCU protected to allow dereferences from get_work_pool() */ | |
3498 | call_rcu_sched(&pool->rcu, rcu_free_pool); | |
3499 | } | |
3500 | ||
3501 | /** | |
3502 | * get_unbound_pool - get a worker_pool with the specified attributes | |
3503 | * @attrs: the attributes of the worker_pool to get | |
3504 | * | |
3505 | * Obtain a worker_pool which has the same attributes as @attrs, bump the | |
3506 | * reference count and return it. If there already is a matching | |
3507 | * worker_pool, it will be used; otherwise, this function attempts to | |
d185af30 | 3508 | * create a new one. |
a892cacc TH |
3509 | * |
3510 | * Should be called with wq_pool_mutex held. | |
d185af30 YB |
3511 | * |
3512 | * Return: On success, a worker_pool with the same attributes as @attrs. | |
3513 | * On failure, %NULL. | |
29c91e99 TH |
3514 | */ |
3515 | static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs) | |
3516 | { | |
29c91e99 TH |
3517 | u32 hash = wqattrs_hash(attrs); |
3518 | struct worker_pool *pool; | |
f3f90ad4 | 3519 | int node; |
29c91e99 | 3520 | |
a892cacc | 3521 | lockdep_assert_held(&wq_pool_mutex); |
29c91e99 TH |
3522 | |
3523 | /* do we already have a matching pool? */ | |
29c91e99 TH |
3524 | hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) { |
3525 | if (wqattrs_equal(pool->attrs, attrs)) { | |
3526 | pool->refcnt++; | |
3527 | goto out_unlock; | |
3528 | } | |
3529 | } | |
29c91e99 TH |
3530 | |
3531 | /* nope, create a new one */ | |
3532 | pool = kzalloc(sizeof(*pool), GFP_KERNEL); | |
3533 | if (!pool || init_worker_pool(pool) < 0) | |
3534 | goto fail; | |
3535 | ||
12ee4fc6 LJ |
3536 | if (workqueue_freezing) |
3537 | pool->flags |= POOL_FREEZING; | |
3538 | ||
8864b4e5 | 3539 | lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */ |
29c91e99 TH |
3540 | copy_workqueue_attrs(pool->attrs, attrs); |
3541 | ||
2865a8fb SL |
3542 | /* |
3543 | * no_numa isn't a worker_pool attribute, always clear it. See | |
3544 | * 'struct workqueue_attrs' comments for detail. | |
3545 | */ | |
3546 | pool->attrs->no_numa = false; | |
3547 | ||
f3f90ad4 TH |
3548 | /* if cpumask is contained inside a NUMA node, we belong to that node */ |
3549 | if (wq_numa_enabled) { | |
3550 | for_each_node(node) { | |
3551 | if (cpumask_subset(pool->attrs->cpumask, | |
3552 | wq_numa_possible_cpumask[node])) { | |
3553 | pool->node = node; | |
3554 | break; | |
3555 | } | |
3556 | } | |
3557 | } | |
3558 | ||
29c91e99 TH |
3559 | if (worker_pool_assign_id(pool) < 0) |
3560 | goto fail; | |
3561 | ||
3562 | /* create and start the initial worker */ | |
ebf44d16 | 3563 | if (create_and_start_worker(pool) < 0) |
29c91e99 TH |
3564 | goto fail; |
3565 | ||
29c91e99 | 3566 | /* install */ |
29c91e99 TH |
3567 | hash_add(unbound_pool_hash, &pool->hash_node, hash); |
3568 | out_unlock: | |
29c91e99 TH |
3569 | return pool; |
3570 | fail: | |
29c91e99 TH |
3571 | if (pool) |
3572 | put_unbound_pool(pool); | |
3573 | return NULL; | |
3574 | } | |
3575 | ||
8864b4e5 TH |
3576 | static void rcu_free_pwq(struct rcu_head *rcu) |
3577 | { | |
3578 | kmem_cache_free(pwq_cache, | |
3579 | container_of(rcu, struct pool_workqueue, rcu)); | |
3580 | } | |
3581 | ||
3582 | /* | |
3583 | * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt | |
3584 | * and needs to be destroyed. | |
3585 | */ | |
3586 | static void pwq_unbound_release_workfn(struct work_struct *work) | |
3587 | { | |
3588 | struct pool_workqueue *pwq = container_of(work, struct pool_workqueue, | |
3589 | unbound_release_work); | |
3590 | struct workqueue_struct *wq = pwq->wq; | |
3591 | struct worker_pool *pool = pwq->pool; | |
bc0caf09 | 3592 | bool is_last; |
8864b4e5 TH |
3593 | |
3594 | if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND))) | |
3595 | return; | |
3596 | ||
75ccf595 | 3597 | /* |
3c25a55d | 3598 | * Unlink @pwq. Synchronization against wq->mutex isn't strictly |
75ccf595 TH |
3599 | * necessary on release but do it anyway. It's easier to verify |
3600 | * and consistent with the linking path. | |
3601 | */ | |
3c25a55d | 3602 | mutex_lock(&wq->mutex); |
8864b4e5 | 3603 | list_del_rcu(&pwq->pwqs_node); |
bc0caf09 | 3604 | is_last = list_empty(&wq->pwqs); |
3c25a55d | 3605 | mutex_unlock(&wq->mutex); |
8864b4e5 | 3606 | |
a892cacc | 3607 | mutex_lock(&wq_pool_mutex); |
8864b4e5 | 3608 | put_unbound_pool(pool); |
a892cacc TH |
3609 | mutex_unlock(&wq_pool_mutex); |
3610 | ||
8864b4e5 TH |
3611 | call_rcu_sched(&pwq->rcu, rcu_free_pwq); |
3612 | ||
3613 | /* | |
3614 | * If we're the last pwq going away, @wq is already dead and no one | |
3615 | * is gonna access it anymore. Free it. | |
3616 | */ | |
6029a918 TH |
3617 | if (is_last) { |
3618 | free_workqueue_attrs(wq->unbound_attrs); | |
8864b4e5 | 3619 | kfree(wq); |
6029a918 | 3620 | } |
8864b4e5 TH |
3621 | } |
3622 | ||
0fbd95aa | 3623 | /** |
699ce097 | 3624 | * pwq_adjust_max_active - update a pwq's max_active to the current setting |
0fbd95aa | 3625 | * @pwq: target pool_workqueue |
0fbd95aa | 3626 | * |
699ce097 TH |
3627 | * If @pwq isn't freezing, set @pwq->max_active to the associated |
3628 | * workqueue's saved_max_active and activate delayed work items | |
3629 | * accordingly. If @pwq is freezing, clear @pwq->max_active to zero. | |
0fbd95aa | 3630 | */ |
699ce097 | 3631 | static void pwq_adjust_max_active(struct pool_workqueue *pwq) |
0fbd95aa | 3632 | { |
699ce097 TH |
3633 | struct workqueue_struct *wq = pwq->wq; |
3634 | bool freezable = wq->flags & WQ_FREEZABLE; | |
3635 | ||
3636 | /* for @wq->saved_max_active */ | |
a357fc03 | 3637 | lockdep_assert_held(&wq->mutex); |
699ce097 TH |
3638 | |
3639 | /* fast exit for non-freezable wqs */ | |
3640 | if (!freezable && pwq->max_active == wq->saved_max_active) | |
3641 | return; | |
3642 | ||
a357fc03 | 3643 | spin_lock_irq(&pwq->pool->lock); |
699ce097 TH |
3644 | |
3645 | if (!freezable || !(pwq->pool->flags & POOL_FREEZING)) { | |
3646 | pwq->max_active = wq->saved_max_active; | |
0fbd95aa | 3647 | |
699ce097 TH |
3648 | while (!list_empty(&pwq->delayed_works) && |
3649 | pwq->nr_active < pwq->max_active) | |
3650 | pwq_activate_first_delayed(pwq); | |
951a078a LJ |
3651 | |
3652 | /* | |
3653 | * Need to kick a worker after thawed or an unbound wq's | |
3654 | * max_active is bumped. It's a slow path. Do it always. | |
3655 | */ | |
3656 | wake_up_worker(pwq->pool); | |
699ce097 TH |
3657 | } else { |
3658 | pwq->max_active = 0; | |
3659 | } | |
3660 | ||
a357fc03 | 3661 | spin_unlock_irq(&pwq->pool->lock); |
0fbd95aa TH |
3662 | } |
3663 | ||
e50aba9a | 3664 | /* initialize newly alloced @pwq which is associated with @wq and @pool */ |
f147f29e TH |
3665 | static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq, |
3666 | struct worker_pool *pool) | |
d2c1d404 TH |
3667 | { |
3668 | BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK); | |
3669 | ||
e50aba9a TH |
3670 | memset(pwq, 0, sizeof(*pwq)); |
3671 | ||
d2c1d404 TH |
3672 | pwq->pool = pool; |
3673 | pwq->wq = wq; | |
3674 | pwq->flush_color = -1; | |
8864b4e5 | 3675 | pwq->refcnt = 1; |
d2c1d404 | 3676 | INIT_LIST_HEAD(&pwq->delayed_works); |
1befcf30 | 3677 | INIT_LIST_HEAD(&pwq->pwqs_node); |
d2c1d404 | 3678 | INIT_LIST_HEAD(&pwq->mayday_node); |
8864b4e5 | 3679 | INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn); |
f147f29e | 3680 | } |
d2c1d404 | 3681 | |
f147f29e | 3682 | /* sync @pwq with the current state of its associated wq and link it */ |
1befcf30 | 3683 | static void link_pwq(struct pool_workqueue *pwq) |
f147f29e TH |
3684 | { |
3685 | struct workqueue_struct *wq = pwq->wq; | |
3686 | ||
3687 | lockdep_assert_held(&wq->mutex); | |
75ccf595 | 3688 | |
1befcf30 TH |
3689 | /* may be called multiple times, ignore if already linked */ |
3690 | if (!list_empty(&pwq->pwqs_node)) | |
3691 | return; | |
3692 | ||
983ca25e TH |
3693 | /* |
3694 | * Set the matching work_color. This is synchronized with | |
3c25a55d | 3695 | * wq->mutex to avoid confusing flush_workqueue(). |
983ca25e | 3696 | */ |
75ccf595 | 3697 | pwq->work_color = wq->work_color; |
983ca25e TH |
3698 | |
3699 | /* sync max_active to the current setting */ | |
3700 | pwq_adjust_max_active(pwq); | |
3701 | ||
3702 | /* link in @pwq */ | |
9e8cd2f5 | 3703 | list_add_rcu(&pwq->pwqs_node, &wq->pwqs); |
f147f29e | 3704 | } |
a357fc03 | 3705 | |
f147f29e TH |
3706 | /* obtain a pool matching @attr and create a pwq associating the pool and @wq */ |
3707 | static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq, | |
3708 | const struct workqueue_attrs *attrs) | |
3709 | { | |
3710 | struct worker_pool *pool; | |
3711 | struct pool_workqueue *pwq; | |
3712 | ||
3713 | lockdep_assert_held(&wq_pool_mutex); | |
3714 | ||
3715 | pool = get_unbound_pool(attrs); | |
3716 | if (!pool) | |
3717 | return NULL; | |
3718 | ||
e50aba9a | 3719 | pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node); |
f147f29e TH |
3720 | if (!pwq) { |
3721 | put_unbound_pool(pool); | |
3722 | return NULL; | |
df2d5ae4 | 3723 | } |
6029a918 | 3724 | |
f147f29e TH |
3725 | init_pwq(pwq, wq, pool); |
3726 | return pwq; | |
d2c1d404 TH |
3727 | } |
3728 | ||
4c16bd32 TH |
3729 | /* undo alloc_unbound_pwq(), used only in the error path */ |
3730 | static void free_unbound_pwq(struct pool_workqueue *pwq) | |
3731 | { | |
3732 | lockdep_assert_held(&wq_pool_mutex); | |
3733 | ||
3734 | if (pwq) { | |
3735 | put_unbound_pool(pwq->pool); | |
cece95df | 3736 | kmem_cache_free(pwq_cache, pwq); |
4c16bd32 TH |
3737 | } |
3738 | } | |
3739 | ||
3740 | /** | |
3741 | * wq_calc_node_mask - calculate a wq_attrs' cpumask for the specified node | |
3742 | * @attrs: the wq_attrs of interest | |
3743 | * @node: the target NUMA node | |
3744 | * @cpu_going_down: if >= 0, the CPU to consider as offline | |
3745 | * @cpumask: outarg, the resulting cpumask | |
3746 | * | |
3747 | * Calculate the cpumask a workqueue with @attrs should use on @node. If | |
3748 | * @cpu_going_down is >= 0, that cpu is considered offline during | |
d185af30 | 3749 | * calculation. The result is stored in @cpumask. |
4c16bd32 TH |
3750 | * |
3751 | * If NUMA affinity is not enabled, @attrs->cpumask is always used. If | |
3752 | * enabled and @node has online CPUs requested by @attrs, the returned | |
3753 | * cpumask is the intersection of the possible CPUs of @node and | |
3754 | * @attrs->cpumask. | |
3755 | * | |
3756 | * The caller is responsible for ensuring that the cpumask of @node stays | |
3757 | * stable. | |
d185af30 YB |
3758 | * |
3759 | * Return: %true if the resulting @cpumask is different from @attrs->cpumask, | |
3760 | * %false if equal. | |
4c16bd32 TH |
3761 | */ |
3762 | static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node, | |
3763 | int cpu_going_down, cpumask_t *cpumask) | |
3764 | { | |
d55262c4 | 3765 | if (!wq_numa_enabled || attrs->no_numa) |
4c16bd32 TH |
3766 | goto use_dfl; |
3767 | ||
3768 | /* does @node have any online CPUs @attrs wants? */ | |
3769 | cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask); | |
3770 | if (cpu_going_down >= 0) | |
3771 | cpumask_clear_cpu(cpu_going_down, cpumask); | |
3772 | ||
3773 | if (cpumask_empty(cpumask)) | |
3774 | goto use_dfl; | |
3775 | ||
3776 | /* yeap, return possible CPUs in @node that @attrs wants */ | |
3777 | cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]); | |
3778 | return !cpumask_equal(cpumask, attrs->cpumask); | |
3779 | ||
3780 | use_dfl: | |
3781 | cpumask_copy(cpumask, attrs->cpumask); | |
3782 | return false; | |
3783 | } | |
3784 | ||
1befcf30 TH |
3785 | /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */ |
3786 | static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq, | |
3787 | int node, | |
3788 | struct pool_workqueue *pwq) | |
3789 | { | |
3790 | struct pool_workqueue *old_pwq; | |
3791 | ||
3792 | lockdep_assert_held(&wq->mutex); | |
3793 | ||
3794 | /* link_pwq() can handle duplicate calls */ | |
3795 | link_pwq(pwq); | |
3796 | ||
3797 | old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]); | |
3798 | rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq); | |
3799 | return old_pwq; | |
3800 | } | |
3801 | ||
9e8cd2f5 TH |
3802 | /** |
3803 | * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue | |
3804 | * @wq: the target workqueue | |
3805 | * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs() | |
3806 | * | |
4c16bd32 TH |
3807 | * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA |
3808 | * machines, this function maps a separate pwq to each NUMA node with | |
3809 | * possibles CPUs in @attrs->cpumask so that work items are affine to the | |
3810 | * NUMA node it was issued on. Older pwqs are released as in-flight work | |
3811 | * items finish. Note that a work item which repeatedly requeues itself | |
3812 | * back-to-back will stay on its current pwq. | |
9e8cd2f5 | 3813 | * |
d185af30 YB |
3814 | * Performs GFP_KERNEL allocations. |
3815 | * | |
3816 | * Return: 0 on success and -errno on failure. | |
9e8cd2f5 TH |
3817 | */ |
3818 | int apply_workqueue_attrs(struct workqueue_struct *wq, | |
3819 | const struct workqueue_attrs *attrs) | |
3820 | { | |
4c16bd32 TH |
3821 | struct workqueue_attrs *new_attrs, *tmp_attrs; |
3822 | struct pool_workqueue **pwq_tbl, *dfl_pwq; | |
f147f29e | 3823 | int node, ret; |
9e8cd2f5 | 3824 | |
8719dcea | 3825 | /* only unbound workqueues can change attributes */ |
9e8cd2f5 TH |
3826 | if (WARN_ON(!(wq->flags & WQ_UNBOUND))) |
3827 | return -EINVAL; | |
3828 | ||
8719dcea TH |
3829 | /* creating multiple pwqs breaks ordering guarantee */ |
3830 | if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs))) | |
3831 | return -EINVAL; | |
3832 | ||
4c16bd32 | 3833 | pwq_tbl = kzalloc(wq_numa_tbl_len * sizeof(pwq_tbl[0]), GFP_KERNEL); |
13e2e556 | 3834 | new_attrs = alloc_workqueue_attrs(GFP_KERNEL); |
4c16bd32 TH |
3835 | tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL); |
3836 | if (!pwq_tbl || !new_attrs || !tmp_attrs) | |
13e2e556 TH |
3837 | goto enomem; |
3838 | ||
4c16bd32 | 3839 | /* make a copy of @attrs and sanitize it */ |
13e2e556 TH |
3840 | copy_workqueue_attrs(new_attrs, attrs); |
3841 | cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask); | |
3842 | ||
4c16bd32 TH |
3843 | /* |
3844 | * We may create multiple pwqs with differing cpumasks. Make a | |
3845 | * copy of @new_attrs which will be modified and used to obtain | |
3846 | * pools. | |
3847 | */ | |
3848 | copy_workqueue_attrs(tmp_attrs, new_attrs); | |
3849 | ||
3850 | /* | |
3851 | * CPUs should stay stable across pwq creations and installations. | |
3852 | * Pin CPUs, determine the target cpumask for each node and create | |
3853 | * pwqs accordingly. | |
3854 | */ | |
3855 | get_online_cpus(); | |
3856 | ||
a892cacc | 3857 | mutex_lock(&wq_pool_mutex); |
4c16bd32 TH |
3858 | |
3859 | /* | |
3860 | * If something goes wrong during CPU up/down, we'll fall back to | |
3861 | * the default pwq covering whole @attrs->cpumask. Always create | |
3862 | * it even if we don't use it immediately. | |
3863 | */ | |
3864 | dfl_pwq = alloc_unbound_pwq(wq, new_attrs); | |
3865 | if (!dfl_pwq) | |
3866 | goto enomem_pwq; | |
3867 | ||
3868 | for_each_node(node) { | |
3869 | if (wq_calc_node_cpumask(attrs, node, -1, tmp_attrs->cpumask)) { | |
3870 | pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs); | |
3871 | if (!pwq_tbl[node]) | |
3872 | goto enomem_pwq; | |
3873 | } else { | |
3874 | dfl_pwq->refcnt++; | |
3875 | pwq_tbl[node] = dfl_pwq; | |
3876 | } | |
3877 | } | |
3878 | ||
f147f29e | 3879 | mutex_unlock(&wq_pool_mutex); |
9e8cd2f5 | 3880 | |
4c16bd32 | 3881 | /* all pwqs have been created successfully, let's install'em */ |
f147f29e | 3882 | mutex_lock(&wq->mutex); |
a892cacc | 3883 | |
f147f29e | 3884 | copy_workqueue_attrs(wq->unbound_attrs, new_attrs); |
4c16bd32 TH |
3885 | |
3886 | /* save the previous pwq and install the new one */ | |
f147f29e | 3887 | for_each_node(node) |
4c16bd32 TH |
3888 | pwq_tbl[node] = numa_pwq_tbl_install(wq, node, pwq_tbl[node]); |
3889 | ||
3890 | /* @dfl_pwq might not have been used, ensure it's linked */ | |
3891 | link_pwq(dfl_pwq); | |
3892 | swap(wq->dfl_pwq, dfl_pwq); | |
f147f29e TH |
3893 | |
3894 | mutex_unlock(&wq->mutex); | |
9e8cd2f5 | 3895 | |
4c16bd32 TH |
3896 | /* put the old pwqs */ |
3897 | for_each_node(node) | |
3898 | put_pwq_unlocked(pwq_tbl[node]); | |
3899 | put_pwq_unlocked(dfl_pwq); | |
3900 | ||
3901 | put_online_cpus(); | |
4862125b TH |
3902 | ret = 0; |
3903 | /* fall through */ | |
3904 | out_free: | |
4c16bd32 | 3905 | free_workqueue_attrs(tmp_attrs); |
4862125b | 3906 | free_workqueue_attrs(new_attrs); |
4c16bd32 | 3907 | kfree(pwq_tbl); |
4862125b | 3908 | return ret; |
13e2e556 | 3909 | |
4c16bd32 TH |
3910 | enomem_pwq: |
3911 | free_unbound_pwq(dfl_pwq); | |
3912 | for_each_node(node) | |
3913 | if (pwq_tbl && pwq_tbl[node] != dfl_pwq) | |
3914 | free_unbound_pwq(pwq_tbl[node]); | |
3915 | mutex_unlock(&wq_pool_mutex); | |
3916 | put_online_cpus(); | |
13e2e556 | 3917 | enomem: |
4862125b TH |
3918 | ret = -ENOMEM; |
3919 | goto out_free; | |
9e8cd2f5 TH |
3920 | } |
3921 | ||
4c16bd32 TH |
3922 | /** |
3923 | * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug | |
3924 | * @wq: the target workqueue | |
3925 | * @cpu: the CPU coming up or going down | |
3926 | * @online: whether @cpu is coming up or going down | |
3927 | * | |
3928 | * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and | |
3929 | * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of | |
3930 | * @wq accordingly. | |
3931 | * | |
3932 | * If NUMA affinity can't be adjusted due to memory allocation failure, it | |
3933 | * falls back to @wq->dfl_pwq which may not be optimal but is always | |
3934 | * correct. | |
3935 | * | |
3936 | * Note that when the last allowed CPU of a NUMA node goes offline for a | |
3937 | * workqueue with a cpumask spanning multiple nodes, the workers which were | |
3938 | * already executing the work items for the workqueue will lose their CPU | |
3939 | * affinity and may execute on any CPU. This is similar to how per-cpu | |
3940 | * workqueues behave on CPU_DOWN. If a workqueue user wants strict | |
3941 | * affinity, it's the user's responsibility to flush the work item from | |
3942 | * CPU_DOWN_PREPARE. | |
3943 | */ | |
3944 | static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu, | |
3945 | bool online) | |
3946 | { | |
3947 | int node = cpu_to_node(cpu); | |
3948 | int cpu_off = online ? -1 : cpu; | |
3949 | struct pool_workqueue *old_pwq = NULL, *pwq; | |
3950 | struct workqueue_attrs *target_attrs; | |
3951 | cpumask_t *cpumask; | |
3952 | ||
3953 | lockdep_assert_held(&wq_pool_mutex); | |
3954 | ||
3955 | if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND)) | |
3956 | return; | |
3957 | ||
3958 | /* | |
3959 | * We don't wanna alloc/free wq_attrs for each wq for each CPU. | |
3960 | * Let's use a preallocated one. The following buf is protected by | |
3961 | * CPU hotplug exclusion. | |
3962 | */ | |
3963 | target_attrs = wq_update_unbound_numa_attrs_buf; | |
3964 | cpumask = target_attrs->cpumask; | |
3965 | ||
3966 | mutex_lock(&wq->mutex); | |
d55262c4 TH |
3967 | if (wq->unbound_attrs->no_numa) |
3968 | goto out_unlock; | |
4c16bd32 TH |
3969 | |
3970 | copy_workqueue_attrs(target_attrs, wq->unbound_attrs); | |
3971 | pwq = unbound_pwq_by_node(wq, node); | |
3972 | ||
3973 | /* | |
3974 | * Let's determine what needs to be done. If the target cpumask is | |
3975 | * different from wq's, we need to compare it to @pwq's and create | |
3976 | * a new one if they don't match. If the target cpumask equals | |
534a3fbb | 3977 | * wq's, the default pwq should be used. |
4c16bd32 TH |
3978 | */ |
3979 | if (wq_calc_node_cpumask(wq->unbound_attrs, node, cpu_off, cpumask)) { | |
3980 | if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask)) | |
3981 | goto out_unlock; | |
3982 | } else { | |
534a3fbb | 3983 | goto use_dfl_pwq; |
4c16bd32 TH |
3984 | } |
3985 | ||
3986 | mutex_unlock(&wq->mutex); | |
3987 | ||
3988 | /* create a new pwq */ | |
3989 | pwq = alloc_unbound_pwq(wq, target_attrs); | |
3990 | if (!pwq) { | |
2d916033 FF |
3991 | pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n", |
3992 | wq->name); | |
77f300b1 DY |
3993 | mutex_lock(&wq->mutex); |
3994 | goto use_dfl_pwq; | |
4c16bd32 TH |
3995 | } |
3996 | ||
3997 | /* | |
3998 | * Install the new pwq. As this function is called only from CPU | |
3999 | * hotplug callbacks and applying a new attrs is wrapped with | |
4000 | * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed | |
4001 | * inbetween. | |
4002 | */ | |
4003 | mutex_lock(&wq->mutex); | |
4004 | old_pwq = numa_pwq_tbl_install(wq, node, pwq); | |
4005 | goto out_unlock; | |
4006 | ||
4007 | use_dfl_pwq: | |
4008 | spin_lock_irq(&wq->dfl_pwq->pool->lock); | |
4009 | get_pwq(wq->dfl_pwq); | |
4010 | spin_unlock_irq(&wq->dfl_pwq->pool->lock); | |
4011 | old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq); | |
4012 | out_unlock: | |
4013 | mutex_unlock(&wq->mutex); | |
4014 | put_pwq_unlocked(old_pwq); | |
4015 | } | |
4016 | ||
30cdf249 | 4017 | static int alloc_and_link_pwqs(struct workqueue_struct *wq) |
0f900049 | 4018 | { |
49e3cf44 | 4019 | bool highpri = wq->flags & WQ_HIGHPRI; |
8a2b7538 | 4020 | int cpu, ret; |
30cdf249 TH |
4021 | |
4022 | if (!(wq->flags & WQ_UNBOUND)) { | |
420c0ddb TH |
4023 | wq->cpu_pwqs = alloc_percpu(struct pool_workqueue); |
4024 | if (!wq->cpu_pwqs) | |
30cdf249 TH |
4025 | return -ENOMEM; |
4026 | ||
4027 | for_each_possible_cpu(cpu) { | |
7fb98ea7 TH |
4028 | struct pool_workqueue *pwq = |
4029 | per_cpu_ptr(wq->cpu_pwqs, cpu); | |
7a62c2c8 | 4030 | struct worker_pool *cpu_pools = |
f02ae73a | 4031 | per_cpu(cpu_worker_pools, cpu); |
f3421797 | 4032 | |
f147f29e TH |
4033 | init_pwq(pwq, wq, &cpu_pools[highpri]); |
4034 | ||
4035 | mutex_lock(&wq->mutex); | |
1befcf30 | 4036 | link_pwq(pwq); |
f147f29e | 4037 | mutex_unlock(&wq->mutex); |
30cdf249 | 4038 | } |
9e8cd2f5 | 4039 | return 0; |
8a2b7538 TH |
4040 | } else if (wq->flags & __WQ_ORDERED) { |
4041 | ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]); | |
4042 | /* there should only be single pwq for ordering guarantee */ | |
4043 | WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node || | |
4044 | wq->pwqs.prev != &wq->dfl_pwq->pwqs_node), | |
4045 | "ordering guarantee broken for workqueue %s\n", wq->name); | |
4046 | return ret; | |
30cdf249 | 4047 | } else { |
9e8cd2f5 | 4048 | return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]); |
30cdf249 | 4049 | } |
0f900049 TH |
4050 | } |
4051 | ||
f3421797 TH |
4052 | static int wq_clamp_max_active(int max_active, unsigned int flags, |
4053 | const char *name) | |
b71ab8c2 | 4054 | { |
f3421797 TH |
4055 | int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE; |
4056 | ||
4057 | if (max_active < 1 || max_active > lim) | |
044c782c VI |
4058 | pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n", |
4059 | max_active, name, 1, lim); | |
b71ab8c2 | 4060 | |
f3421797 | 4061 | return clamp_val(max_active, 1, lim); |
b71ab8c2 TH |
4062 | } |
4063 | ||
b196be89 | 4064 | struct workqueue_struct *__alloc_workqueue_key(const char *fmt, |
d320c038 TH |
4065 | unsigned int flags, |
4066 | int max_active, | |
4067 | struct lock_class_key *key, | |
b196be89 | 4068 | const char *lock_name, ...) |
1da177e4 | 4069 | { |
df2d5ae4 | 4070 | size_t tbl_size = 0; |
ecf6881f | 4071 | va_list args; |
1da177e4 | 4072 | struct workqueue_struct *wq; |
49e3cf44 | 4073 | struct pool_workqueue *pwq; |
b196be89 | 4074 | |
cee22a15 VK |
4075 | /* see the comment above the definition of WQ_POWER_EFFICIENT */ |
4076 | if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient) | |
4077 | flags |= WQ_UNBOUND; | |
4078 | ||
ecf6881f | 4079 | /* allocate wq and format name */ |
df2d5ae4 TH |
4080 | if (flags & WQ_UNBOUND) |
4081 | tbl_size = wq_numa_tbl_len * sizeof(wq->numa_pwq_tbl[0]); | |
4082 | ||
4083 | wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL); | |
b196be89 | 4084 | if (!wq) |
d2c1d404 | 4085 | return NULL; |
b196be89 | 4086 | |
6029a918 TH |
4087 | if (flags & WQ_UNBOUND) { |
4088 | wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL); | |
4089 | if (!wq->unbound_attrs) | |
4090 | goto err_free_wq; | |
4091 | } | |
4092 | ||
ecf6881f TH |
4093 | va_start(args, lock_name); |
4094 | vsnprintf(wq->name, sizeof(wq->name), fmt, args); | |
b196be89 | 4095 | va_end(args); |
1da177e4 | 4096 | |
d320c038 | 4097 | max_active = max_active ?: WQ_DFL_ACTIVE; |
b196be89 | 4098 | max_active = wq_clamp_max_active(max_active, flags, wq->name); |
3af24433 | 4099 | |
b196be89 | 4100 | /* init wq */ |
97e37d7b | 4101 | wq->flags = flags; |
a0a1a5fd | 4102 | wq->saved_max_active = max_active; |
3c25a55d | 4103 | mutex_init(&wq->mutex); |
112202d9 | 4104 | atomic_set(&wq->nr_pwqs_to_flush, 0); |
30cdf249 | 4105 | INIT_LIST_HEAD(&wq->pwqs); |
73f53c4a TH |
4106 | INIT_LIST_HEAD(&wq->flusher_queue); |
4107 | INIT_LIST_HEAD(&wq->flusher_overflow); | |
493a1724 | 4108 | INIT_LIST_HEAD(&wq->maydays); |
502ca9d8 | 4109 | |
eb13ba87 | 4110 | lockdep_init_map(&wq->lockdep_map, lock_name, key, 0); |
cce1a165 | 4111 | INIT_LIST_HEAD(&wq->list); |
3af24433 | 4112 | |
30cdf249 | 4113 | if (alloc_and_link_pwqs(wq) < 0) |
d2c1d404 | 4114 | goto err_free_wq; |
1537663f | 4115 | |
493008a8 TH |
4116 | /* |
4117 | * Workqueues which may be used during memory reclaim should | |
4118 | * have a rescuer to guarantee forward progress. | |
4119 | */ | |
4120 | if (flags & WQ_MEM_RECLAIM) { | |
e22bee78 TH |
4121 | struct worker *rescuer; |
4122 | ||
d2c1d404 | 4123 | rescuer = alloc_worker(); |
e22bee78 | 4124 | if (!rescuer) |
d2c1d404 | 4125 | goto err_destroy; |
e22bee78 | 4126 | |
111c225a TH |
4127 | rescuer->rescue_wq = wq; |
4128 | rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", | |
b196be89 | 4129 | wq->name); |
d2c1d404 TH |
4130 | if (IS_ERR(rescuer->task)) { |
4131 | kfree(rescuer); | |
4132 | goto err_destroy; | |
4133 | } | |
e22bee78 | 4134 | |
d2c1d404 | 4135 | wq->rescuer = rescuer; |
14a40ffc | 4136 | rescuer->task->flags |= PF_NO_SETAFFINITY; |
e22bee78 | 4137 | wake_up_process(rescuer->task); |
3af24433 ON |
4138 | } |
4139 | ||
226223ab TH |
4140 | if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq)) |
4141 | goto err_destroy; | |
4142 | ||
a0a1a5fd | 4143 | /* |
68e13a67 LJ |
4144 | * wq_pool_mutex protects global freeze state and workqueues list. |
4145 | * Grab it, adjust max_active and add the new @wq to workqueues | |
4146 | * list. | |
a0a1a5fd | 4147 | */ |
68e13a67 | 4148 | mutex_lock(&wq_pool_mutex); |
a0a1a5fd | 4149 | |
a357fc03 | 4150 | mutex_lock(&wq->mutex); |
699ce097 TH |
4151 | for_each_pwq(pwq, wq) |
4152 | pwq_adjust_max_active(pwq); | |
a357fc03 | 4153 | mutex_unlock(&wq->mutex); |
a0a1a5fd | 4154 | |
1537663f | 4155 | list_add(&wq->list, &workqueues); |
a0a1a5fd | 4156 | |
68e13a67 | 4157 | mutex_unlock(&wq_pool_mutex); |
1537663f | 4158 | |
3af24433 | 4159 | return wq; |
d2c1d404 TH |
4160 | |
4161 | err_free_wq: | |
6029a918 | 4162 | free_workqueue_attrs(wq->unbound_attrs); |
d2c1d404 TH |
4163 | kfree(wq); |
4164 | return NULL; | |
4165 | err_destroy: | |
4166 | destroy_workqueue(wq); | |
4690c4ab | 4167 | return NULL; |
3af24433 | 4168 | } |
d320c038 | 4169 | EXPORT_SYMBOL_GPL(__alloc_workqueue_key); |
1da177e4 | 4170 | |
3af24433 ON |
4171 | /** |
4172 | * destroy_workqueue - safely terminate a workqueue | |
4173 | * @wq: target workqueue | |
4174 | * | |
4175 | * Safely destroy a workqueue. All work currently pending will be done first. | |
4176 | */ | |
4177 | void destroy_workqueue(struct workqueue_struct *wq) | |
4178 | { | |
49e3cf44 | 4179 | struct pool_workqueue *pwq; |
4c16bd32 | 4180 | int node; |
3af24433 | 4181 | |
9c5a2ba7 TH |
4182 | /* drain it before proceeding with destruction */ |
4183 | drain_workqueue(wq); | |
c8efcc25 | 4184 | |
6183c009 | 4185 | /* sanity checks */ |
b09f4fd3 | 4186 | mutex_lock(&wq->mutex); |
49e3cf44 | 4187 | for_each_pwq(pwq, wq) { |
6183c009 TH |
4188 | int i; |
4189 | ||
76af4d93 TH |
4190 | for (i = 0; i < WORK_NR_COLORS; i++) { |
4191 | if (WARN_ON(pwq->nr_in_flight[i])) { | |
b09f4fd3 | 4192 | mutex_unlock(&wq->mutex); |
6183c009 | 4193 | return; |
76af4d93 TH |
4194 | } |
4195 | } | |
4196 | ||
5c529597 | 4197 | if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) || |
8864b4e5 | 4198 | WARN_ON(pwq->nr_active) || |
76af4d93 | 4199 | WARN_ON(!list_empty(&pwq->delayed_works))) { |
b09f4fd3 | 4200 | mutex_unlock(&wq->mutex); |
6183c009 | 4201 | return; |
76af4d93 | 4202 | } |
6183c009 | 4203 | } |
b09f4fd3 | 4204 | mutex_unlock(&wq->mutex); |
6183c009 | 4205 | |
a0a1a5fd TH |
4206 | /* |
4207 | * wq list is used to freeze wq, remove from list after | |
4208 | * flushing is complete in case freeze races us. | |
4209 | */ | |
68e13a67 | 4210 | mutex_lock(&wq_pool_mutex); |
d2c1d404 | 4211 | list_del_init(&wq->list); |
68e13a67 | 4212 | mutex_unlock(&wq_pool_mutex); |
3af24433 | 4213 | |
226223ab TH |
4214 | workqueue_sysfs_unregister(wq); |
4215 | ||
493008a8 | 4216 | if (wq->rescuer) { |
e22bee78 | 4217 | kthread_stop(wq->rescuer->task); |
8d9df9f0 | 4218 | kfree(wq->rescuer); |
493008a8 | 4219 | wq->rescuer = NULL; |
e22bee78 TH |
4220 | } |
4221 | ||
8864b4e5 TH |
4222 | if (!(wq->flags & WQ_UNBOUND)) { |
4223 | /* | |
4224 | * The base ref is never dropped on per-cpu pwqs. Directly | |
4225 | * free the pwqs and wq. | |
4226 | */ | |
4227 | free_percpu(wq->cpu_pwqs); | |
4228 | kfree(wq); | |
4229 | } else { | |
4230 | /* | |
4231 | * We're the sole accessor of @wq at this point. Directly | |
4c16bd32 TH |
4232 | * access numa_pwq_tbl[] and dfl_pwq to put the base refs. |
4233 | * @wq will be freed when the last pwq is released. | |
8864b4e5 | 4234 | */ |
4c16bd32 TH |
4235 | for_each_node(node) { |
4236 | pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]); | |
4237 | RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL); | |
4238 | put_pwq_unlocked(pwq); | |
4239 | } | |
4240 | ||
4241 | /* | |
4242 | * Put dfl_pwq. @wq may be freed any time after dfl_pwq is | |
4243 | * put. Don't access it afterwards. | |
4244 | */ | |
4245 | pwq = wq->dfl_pwq; | |
4246 | wq->dfl_pwq = NULL; | |
dce90d47 | 4247 | put_pwq_unlocked(pwq); |
29c91e99 | 4248 | } |
3af24433 ON |
4249 | } |
4250 | EXPORT_SYMBOL_GPL(destroy_workqueue); | |
4251 | ||
dcd989cb TH |
4252 | /** |
4253 | * workqueue_set_max_active - adjust max_active of a workqueue | |
4254 | * @wq: target workqueue | |
4255 | * @max_active: new max_active value. | |
4256 | * | |
4257 | * Set max_active of @wq to @max_active. | |
4258 | * | |
4259 | * CONTEXT: | |
4260 | * Don't call from IRQ context. | |
4261 | */ | |
4262 | void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) | |
4263 | { | |
49e3cf44 | 4264 | struct pool_workqueue *pwq; |
dcd989cb | 4265 | |
8719dcea TH |
4266 | /* disallow meddling with max_active for ordered workqueues */ |
4267 | if (WARN_ON(wq->flags & __WQ_ORDERED)) | |
4268 | return; | |
4269 | ||
f3421797 | 4270 | max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); |
dcd989cb | 4271 | |
a357fc03 | 4272 | mutex_lock(&wq->mutex); |
dcd989cb TH |
4273 | |
4274 | wq->saved_max_active = max_active; | |
4275 | ||
699ce097 TH |
4276 | for_each_pwq(pwq, wq) |
4277 | pwq_adjust_max_active(pwq); | |
93981800 | 4278 | |
a357fc03 | 4279 | mutex_unlock(&wq->mutex); |
15316ba8 | 4280 | } |
dcd989cb | 4281 | EXPORT_SYMBOL_GPL(workqueue_set_max_active); |
15316ba8 | 4282 | |
e6267616 TH |
4283 | /** |
4284 | * current_is_workqueue_rescuer - is %current workqueue rescuer? | |
4285 | * | |
4286 | * Determine whether %current is a workqueue rescuer. Can be used from | |
4287 | * work functions to determine whether it's being run off the rescuer task. | |
d185af30 YB |
4288 | * |
4289 | * Return: %true if %current is a workqueue rescuer. %false otherwise. | |
e6267616 TH |
4290 | */ |
4291 | bool current_is_workqueue_rescuer(void) | |
4292 | { | |
4293 | struct worker *worker = current_wq_worker(); | |
4294 | ||
6a092dfd | 4295 | return worker && worker->rescue_wq; |
e6267616 TH |
4296 | } |
4297 | ||
eef6a7d5 | 4298 | /** |
dcd989cb TH |
4299 | * workqueue_congested - test whether a workqueue is congested |
4300 | * @cpu: CPU in question | |
4301 | * @wq: target workqueue | |
eef6a7d5 | 4302 | * |
dcd989cb TH |
4303 | * Test whether @wq's cpu workqueue for @cpu is congested. There is |
4304 | * no synchronization around this function and the test result is | |
4305 | * unreliable and only useful as advisory hints or for debugging. | |
eef6a7d5 | 4306 | * |
d3251859 TH |
4307 | * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU. |
4308 | * Note that both per-cpu and unbound workqueues may be associated with | |
4309 | * multiple pool_workqueues which have separate congested states. A | |
4310 | * workqueue being congested on one CPU doesn't mean the workqueue is also | |
4311 | * contested on other CPUs / NUMA nodes. | |
4312 | * | |
d185af30 | 4313 | * Return: |
dcd989cb | 4314 | * %true if congested, %false otherwise. |
eef6a7d5 | 4315 | */ |
d84ff051 | 4316 | bool workqueue_congested(int cpu, struct workqueue_struct *wq) |
1da177e4 | 4317 | { |
7fb98ea7 | 4318 | struct pool_workqueue *pwq; |
76af4d93 TH |
4319 | bool ret; |
4320 | ||
88109453 | 4321 | rcu_read_lock_sched(); |
7fb98ea7 | 4322 | |
d3251859 TH |
4323 | if (cpu == WORK_CPU_UNBOUND) |
4324 | cpu = smp_processor_id(); | |
4325 | ||
7fb98ea7 TH |
4326 | if (!(wq->flags & WQ_UNBOUND)) |
4327 | pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); | |
4328 | else | |
df2d5ae4 | 4329 | pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu)); |
dcd989cb | 4330 | |
76af4d93 | 4331 | ret = !list_empty(&pwq->delayed_works); |
88109453 | 4332 | rcu_read_unlock_sched(); |
76af4d93 TH |
4333 | |
4334 | return ret; | |
1da177e4 | 4335 | } |
dcd989cb | 4336 | EXPORT_SYMBOL_GPL(workqueue_congested); |
1da177e4 | 4337 | |
dcd989cb TH |
4338 | /** |
4339 | * work_busy - test whether a work is currently pending or running | |
4340 | * @work: the work to be tested | |
4341 | * | |
4342 | * Test whether @work is currently pending or running. There is no | |
4343 | * synchronization around this function and the test result is | |
4344 | * unreliable and only useful as advisory hints or for debugging. | |
dcd989cb | 4345 | * |
d185af30 | 4346 | * Return: |
dcd989cb TH |
4347 | * OR'd bitmask of WORK_BUSY_* bits. |
4348 | */ | |
4349 | unsigned int work_busy(struct work_struct *work) | |
1da177e4 | 4350 | { |
fa1b54e6 | 4351 | struct worker_pool *pool; |
dcd989cb TH |
4352 | unsigned long flags; |
4353 | unsigned int ret = 0; | |
1da177e4 | 4354 | |
dcd989cb TH |
4355 | if (work_pending(work)) |
4356 | ret |= WORK_BUSY_PENDING; | |
1da177e4 | 4357 | |
fa1b54e6 TH |
4358 | local_irq_save(flags); |
4359 | pool = get_work_pool(work); | |
038366c5 | 4360 | if (pool) { |
fa1b54e6 | 4361 | spin_lock(&pool->lock); |
038366c5 LJ |
4362 | if (find_worker_executing_work(pool, work)) |
4363 | ret |= WORK_BUSY_RUNNING; | |
fa1b54e6 | 4364 | spin_unlock(&pool->lock); |
038366c5 | 4365 | } |
fa1b54e6 | 4366 | local_irq_restore(flags); |
1da177e4 | 4367 | |
dcd989cb | 4368 | return ret; |
1da177e4 | 4369 | } |
dcd989cb | 4370 | EXPORT_SYMBOL_GPL(work_busy); |
1da177e4 | 4371 | |
3d1cb205 TH |
4372 | /** |
4373 | * set_worker_desc - set description for the current work item | |
4374 | * @fmt: printf-style format string | |
4375 | * @...: arguments for the format string | |
4376 | * | |
4377 | * This function can be called by a running work function to describe what | |
4378 | * the work item is about. If the worker task gets dumped, this | |
4379 | * information will be printed out together to help debugging. The | |
4380 | * description can be at most WORKER_DESC_LEN including the trailing '\0'. | |
4381 | */ | |
4382 | void set_worker_desc(const char *fmt, ...) | |
4383 | { | |
4384 | struct worker *worker = current_wq_worker(); | |
4385 | va_list args; | |
4386 | ||
4387 | if (worker) { | |
4388 | va_start(args, fmt); | |
4389 | vsnprintf(worker->desc, sizeof(worker->desc), fmt, args); | |
4390 | va_end(args); | |
4391 | worker->desc_valid = true; | |
4392 | } | |
4393 | } | |
4394 | ||
4395 | /** | |
4396 | * print_worker_info - print out worker information and description | |
4397 | * @log_lvl: the log level to use when printing | |
4398 | * @task: target task | |
4399 | * | |
4400 | * If @task is a worker and currently executing a work item, print out the | |
4401 | * name of the workqueue being serviced and worker description set with | |
4402 | * set_worker_desc() by the currently executing work item. | |
4403 | * | |
4404 | * This function can be safely called on any task as long as the | |
4405 | * task_struct itself is accessible. While safe, this function isn't | |
4406 | * synchronized and may print out mixups or garbages of limited length. | |
4407 | */ | |
4408 | void print_worker_info(const char *log_lvl, struct task_struct *task) | |
4409 | { | |
4410 | work_func_t *fn = NULL; | |
4411 | char name[WQ_NAME_LEN] = { }; | |
4412 | char desc[WORKER_DESC_LEN] = { }; | |
4413 | struct pool_workqueue *pwq = NULL; | |
4414 | struct workqueue_struct *wq = NULL; | |
4415 | bool desc_valid = false; | |
4416 | struct worker *worker; | |
4417 | ||
4418 | if (!(task->flags & PF_WQ_WORKER)) | |
4419 | return; | |
4420 | ||
4421 | /* | |
4422 | * This function is called without any synchronization and @task | |
4423 | * could be in any state. Be careful with dereferences. | |
4424 | */ | |
4425 | worker = probe_kthread_data(task); | |
4426 | ||
4427 | /* | |
4428 | * Carefully copy the associated workqueue's workfn and name. Keep | |
4429 | * the original last '\0' in case the original contains garbage. | |
4430 | */ | |
4431 | probe_kernel_read(&fn, &worker->current_func, sizeof(fn)); | |
4432 | probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq)); | |
4433 | probe_kernel_read(&wq, &pwq->wq, sizeof(wq)); | |
4434 | probe_kernel_read(name, wq->name, sizeof(name) - 1); | |
4435 | ||
4436 | /* copy worker description */ | |
4437 | probe_kernel_read(&desc_valid, &worker->desc_valid, sizeof(desc_valid)); | |
4438 | if (desc_valid) | |
4439 | probe_kernel_read(desc, worker->desc, sizeof(desc) - 1); | |
4440 | ||
4441 | if (fn || name[0] || desc[0]) { | |
2d916033 | 4442 | pr_info("%sWorkqueue: %s %pf", log_lvl, name, fn); |
3d1cb205 TH |
4443 | if (desc[0]) |
4444 | pr_cont(" (%s)", desc); | |
4445 | pr_cont("\n"); | |
4446 | } | |
4447 | } | |
4448 | ||
db7bccf4 TH |
4449 | /* |
4450 | * CPU hotplug. | |
4451 | * | |
e22bee78 | 4452 | * There are two challenges in supporting CPU hotplug. Firstly, there |
112202d9 | 4453 | * are a lot of assumptions on strong associations among work, pwq and |
706026c2 | 4454 | * pool which make migrating pending and scheduled works very |
e22bee78 | 4455 | * difficult to implement without impacting hot paths. Secondly, |
94cf58bb | 4456 | * worker pools serve mix of short, long and very long running works making |
e22bee78 TH |
4457 | * blocked draining impractical. |
4458 | * | |
24647570 | 4459 | * This is solved by allowing the pools to be disassociated from the CPU |
628c78e7 TH |
4460 | * running as an unbound one and allowing it to be reattached later if the |
4461 | * cpu comes back online. | |
db7bccf4 | 4462 | */ |
1da177e4 | 4463 | |
706026c2 | 4464 | static void wq_unbind_fn(struct work_struct *work) |
3af24433 | 4465 | { |
38db41d9 | 4466 | int cpu = smp_processor_id(); |
4ce62e9e | 4467 | struct worker_pool *pool; |
db7bccf4 | 4468 | struct worker *worker; |
3af24433 | 4469 | |
f02ae73a | 4470 | for_each_cpu_worker_pool(pool, cpu) { |
6183c009 | 4471 | WARN_ON_ONCE(cpu != smp_processor_id()); |
db7bccf4 | 4472 | |
92f9c5c4 | 4473 | mutex_lock(&pool->attach_mutex); |
94cf58bb | 4474 | spin_lock_irq(&pool->lock); |
3af24433 | 4475 | |
94cf58bb | 4476 | /* |
92f9c5c4 | 4477 | * We've blocked all attach/detach operations. Make all workers |
94cf58bb TH |
4478 | * unbound and set DISASSOCIATED. Before this, all workers |
4479 | * except for the ones which are still executing works from | |
4480 | * before the last CPU down must be on the cpu. After | |
4481 | * this, they may become diasporas. | |
4482 | */ | |
da028469 | 4483 | for_each_pool_worker(worker, pool) |
c9e7cf27 | 4484 | worker->flags |= WORKER_UNBOUND; |
06ba38a9 | 4485 | |
24647570 | 4486 | pool->flags |= POOL_DISASSOCIATED; |
f2d5a0ee | 4487 | |
94cf58bb | 4488 | spin_unlock_irq(&pool->lock); |
92f9c5c4 | 4489 | mutex_unlock(&pool->attach_mutex); |
628c78e7 | 4490 | |
eb283428 LJ |
4491 | /* |
4492 | * Call schedule() so that we cross rq->lock and thus can | |
4493 | * guarantee sched callbacks see the %WORKER_UNBOUND flag. | |
4494 | * This is necessary as scheduler callbacks may be invoked | |
4495 | * from other cpus. | |
4496 | */ | |
4497 | schedule(); | |
06ba38a9 | 4498 | |
eb283428 LJ |
4499 | /* |
4500 | * Sched callbacks are disabled now. Zap nr_running. | |
4501 | * After this, nr_running stays zero and need_more_worker() | |
4502 | * and keep_working() are always true as long as the | |
4503 | * worklist is not empty. This pool now behaves as an | |
4504 | * unbound (in terms of concurrency management) pool which | |
4505 | * are served by workers tied to the pool. | |
4506 | */ | |
e19e397a | 4507 | atomic_set(&pool->nr_running, 0); |
eb283428 LJ |
4508 | |
4509 | /* | |
4510 | * With concurrency management just turned off, a busy | |
4511 | * worker blocking could lead to lengthy stalls. Kick off | |
4512 | * unbound chain execution of currently pending work items. | |
4513 | */ | |
4514 | spin_lock_irq(&pool->lock); | |
4515 | wake_up_worker(pool); | |
4516 | spin_unlock_irq(&pool->lock); | |
4517 | } | |
3af24433 | 4518 | } |
3af24433 | 4519 | |
bd7c089e TH |
4520 | /** |
4521 | * rebind_workers - rebind all workers of a pool to the associated CPU | |
4522 | * @pool: pool of interest | |
4523 | * | |
a9ab775b | 4524 | * @pool->cpu is coming online. Rebind all workers to the CPU. |
bd7c089e TH |
4525 | */ |
4526 | static void rebind_workers(struct worker_pool *pool) | |
4527 | { | |
a9ab775b | 4528 | struct worker *worker; |
bd7c089e | 4529 | |
92f9c5c4 | 4530 | lockdep_assert_held(&pool->attach_mutex); |
bd7c089e | 4531 | |
a9ab775b TH |
4532 | /* |
4533 | * Restore CPU affinity of all workers. As all idle workers should | |
4534 | * be on the run-queue of the associated CPU before any local | |
4535 | * wake-ups for concurrency management happen, restore CPU affinty | |
4536 | * of all workers first and then clear UNBOUND. As we're called | |
4537 | * from CPU_ONLINE, the following shouldn't fail. | |
4538 | */ | |
da028469 | 4539 | for_each_pool_worker(worker, pool) |
a9ab775b TH |
4540 | WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, |
4541 | pool->attrs->cpumask) < 0); | |
bd7c089e | 4542 | |
a9ab775b | 4543 | spin_lock_irq(&pool->lock); |
bd7c089e | 4544 | |
da028469 | 4545 | for_each_pool_worker(worker, pool) { |
a9ab775b | 4546 | unsigned int worker_flags = worker->flags; |
bd7c089e TH |
4547 | |
4548 | /* | |
a9ab775b TH |
4549 | * A bound idle worker should actually be on the runqueue |
4550 | * of the associated CPU for local wake-ups targeting it to | |
4551 | * work. Kick all idle workers so that they migrate to the | |
4552 | * associated CPU. Doing this in the same loop as | |
4553 | * replacing UNBOUND with REBOUND is safe as no worker will | |
4554 | * be bound before @pool->lock is released. | |
bd7c089e | 4555 | */ |
a9ab775b TH |
4556 | if (worker_flags & WORKER_IDLE) |
4557 | wake_up_process(worker->task); | |
bd7c089e | 4558 | |
a9ab775b TH |
4559 | /* |
4560 | * We want to clear UNBOUND but can't directly call | |
4561 | * worker_clr_flags() or adjust nr_running. Atomically | |
4562 | * replace UNBOUND with another NOT_RUNNING flag REBOUND. | |
4563 | * @worker will clear REBOUND using worker_clr_flags() when | |
4564 | * it initiates the next execution cycle thus restoring | |
4565 | * concurrency management. Note that when or whether | |
4566 | * @worker clears REBOUND doesn't affect correctness. | |
4567 | * | |
4568 | * ACCESS_ONCE() is necessary because @worker->flags may be | |
4569 | * tested without holding any lock in | |
4570 | * wq_worker_waking_up(). Without it, NOT_RUNNING test may | |
4571 | * fail incorrectly leading to premature concurrency | |
4572 | * management operations. | |
4573 | */ | |
4574 | WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND)); | |
4575 | worker_flags |= WORKER_REBOUND; | |
4576 | worker_flags &= ~WORKER_UNBOUND; | |
4577 | ACCESS_ONCE(worker->flags) = worker_flags; | |
bd7c089e | 4578 | } |
a9ab775b TH |
4579 | |
4580 | spin_unlock_irq(&pool->lock); | |
bd7c089e TH |
4581 | } |
4582 | ||
7dbc725e TH |
4583 | /** |
4584 | * restore_unbound_workers_cpumask - restore cpumask of unbound workers | |
4585 | * @pool: unbound pool of interest | |
4586 | * @cpu: the CPU which is coming up | |
4587 | * | |
4588 | * An unbound pool may end up with a cpumask which doesn't have any online | |
4589 | * CPUs. When a worker of such pool get scheduled, the scheduler resets | |
4590 | * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any | |
4591 | * online CPU before, cpus_allowed of all its workers should be restored. | |
4592 | */ | |
4593 | static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu) | |
4594 | { | |
4595 | static cpumask_t cpumask; | |
4596 | struct worker *worker; | |
7dbc725e | 4597 | |
92f9c5c4 | 4598 | lockdep_assert_held(&pool->attach_mutex); |
7dbc725e TH |
4599 | |
4600 | /* is @cpu allowed for @pool? */ | |
4601 | if (!cpumask_test_cpu(cpu, pool->attrs->cpumask)) | |
4602 | return; | |
4603 | ||
4604 | /* is @cpu the only online CPU? */ | |
4605 | cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask); | |
4606 | if (cpumask_weight(&cpumask) != 1) | |
4607 | return; | |
4608 | ||
4609 | /* as we're called from CPU_ONLINE, the following shouldn't fail */ | |
da028469 | 4610 | for_each_pool_worker(worker, pool) |
7dbc725e TH |
4611 | WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, |
4612 | pool->attrs->cpumask) < 0); | |
4613 | } | |
4614 | ||
8db25e78 TH |
4615 | /* |
4616 | * Workqueues should be brought up before normal priority CPU notifiers. | |
4617 | * This will be registered high priority CPU notifier. | |
4618 | */ | |
0db0628d | 4619 | static int workqueue_cpu_up_callback(struct notifier_block *nfb, |
8db25e78 TH |
4620 | unsigned long action, |
4621 | void *hcpu) | |
3af24433 | 4622 | { |
d84ff051 | 4623 | int cpu = (unsigned long)hcpu; |
4ce62e9e | 4624 | struct worker_pool *pool; |
4c16bd32 | 4625 | struct workqueue_struct *wq; |
7dbc725e | 4626 | int pi; |
3ce63377 | 4627 | |
8db25e78 | 4628 | switch (action & ~CPU_TASKS_FROZEN) { |
3af24433 | 4629 | case CPU_UP_PREPARE: |
f02ae73a | 4630 | for_each_cpu_worker_pool(pool, cpu) { |
3ce63377 TH |
4631 | if (pool->nr_workers) |
4632 | continue; | |
ebf44d16 | 4633 | if (create_and_start_worker(pool) < 0) |
3ce63377 | 4634 | return NOTIFY_BAD; |
3af24433 | 4635 | } |
8db25e78 | 4636 | break; |
3af24433 | 4637 | |
db7bccf4 TH |
4638 | case CPU_DOWN_FAILED: |
4639 | case CPU_ONLINE: | |
68e13a67 | 4640 | mutex_lock(&wq_pool_mutex); |
7dbc725e TH |
4641 | |
4642 | for_each_pool(pool, pi) { | |
92f9c5c4 | 4643 | mutex_lock(&pool->attach_mutex); |
94cf58bb | 4644 | |
7dbc725e TH |
4645 | if (pool->cpu == cpu) { |
4646 | spin_lock_irq(&pool->lock); | |
4647 | pool->flags &= ~POOL_DISASSOCIATED; | |
4648 | spin_unlock_irq(&pool->lock); | |
a9ab775b | 4649 | |
7dbc725e TH |
4650 | rebind_workers(pool); |
4651 | } else if (pool->cpu < 0) { | |
4652 | restore_unbound_workers_cpumask(pool, cpu); | |
4653 | } | |
94cf58bb | 4654 | |
92f9c5c4 | 4655 | mutex_unlock(&pool->attach_mutex); |
94cf58bb | 4656 | } |
7dbc725e | 4657 | |
4c16bd32 TH |
4658 | /* update NUMA affinity of unbound workqueues */ |
4659 | list_for_each_entry(wq, &workqueues, list) | |
4660 | wq_update_unbound_numa(wq, cpu, true); | |
4661 | ||
68e13a67 | 4662 | mutex_unlock(&wq_pool_mutex); |
db7bccf4 | 4663 | break; |
00dfcaf7 | 4664 | } |
65758202 TH |
4665 | return NOTIFY_OK; |
4666 | } | |
4667 | ||
4668 | /* | |
4669 | * Workqueues should be brought down after normal priority CPU notifiers. | |
4670 | * This will be registered as low priority CPU notifier. | |
4671 | */ | |
0db0628d | 4672 | static int workqueue_cpu_down_callback(struct notifier_block *nfb, |
65758202 TH |
4673 | unsigned long action, |
4674 | void *hcpu) | |
4675 | { | |
d84ff051 | 4676 | int cpu = (unsigned long)hcpu; |
8db25e78 | 4677 | struct work_struct unbind_work; |
4c16bd32 | 4678 | struct workqueue_struct *wq; |
8db25e78 | 4679 | |
65758202 TH |
4680 | switch (action & ~CPU_TASKS_FROZEN) { |
4681 | case CPU_DOWN_PREPARE: | |
4c16bd32 | 4682 | /* unbinding per-cpu workers should happen on the local CPU */ |
706026c2 | 4683 | INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn); |
7635d2fd | 4684 | queue_work_on(cpu, system_highpri_wq, &unbind_work); |
4c16bd32 TH |
4685 | |
4686 | /* update NUMA affinity of unbound workqueues */ | |
4687 | mutex_lock(&wq_pool_mutex); | |
4688 | list_for_each_entry(wq, &workqueues, list) | |
4689 | wq_update_unbound_numa(wq, cpu, false); | |
4690 | mutex_unlock(&wq_pool_mutex); | |
4691 | ||
4692 | /* wait for per-cpu unbinding to finish */ | |
8db25e78 | 4693 | flush_work(&unbind_work); |
440a1136 | 4694 | destroy_work_on_stack(&unbind_work); |
8db25e78 | 4695 | break; |
65758202 TH |
4696 | } |
4697 | return NOTIFY_OK; | |
4698 | } | |
4699 | ||
2d3854a3 | 4700 | #ifdef CONFIG_SMP |
8ccad40d | 4701 | |
2d3854a3 | 4702 | struct work_for_cpu { |
ed48ece2 | 4703 | struct work_struct work; |
2d3854a3 RR |
4704 | long (*fn)(void *); |
4705 | void *arg; | |
4706 | long ret; | |
4707 | }; | |
4708 | ||
ed48ece2 | 4709 | static void work_for_cpu_fn(struct work_struct *work) |
2d3854a3 | 4710 | { |
ed48ece2 TH |
4711 | struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work); |
4712 | ||
2d3854a3 RR |
4713 | wfc->ret = wfc->fn(wfc->arg); |
4714 | } | |
4715 | ||
4716 | /** | |
4717 | * work_on_cpu - run a function in user context on a particular cpu | |
4718 | * @cpu: the cpu to run on | |
4719 | * @fn: the function to run | |
4720 | * @arg: the function arg | |
4721 | * | |
31ad9081 | 4722 | * It is up to the caller to ensure that the cpu doesn't go offline. |
6b44003e | 4723 | * The caller must not hold any locks which would prevent @fn from completing. |
d185af30 YB |
4724 | * |
4725 | * Return: The value @fn returns. | |
2d3854a3 | 4726 | */ |
d84ff051 | 4727 | long work_on_cpu(int cpu, long (*fn)(void *), void *arg) |
2d3854a3 | 4728 | { |
ed48ece2 | 4729 | struct work_for_cpu wfc = { .fn = fn, .arg = arg }; |
6b44003e | 4730 | |
ed48ece2 TH |
4731 | INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn); |
4732 | schedule_work_on(cpu, &wfc.work); | |
12997d1a | 4733 | flush_work(&wfc.work); |
440a1136 | 4734 | destroy_work_on_stack(&wfc.work); |
2d3854a3 RR |
4735 | return wfc.ret; |
4736 | } | |
4737 | EXPORT_SYMBOL_GPL(work_on_cpu); | |
4738 | #endif /* CONFIG_SMP */ | |
4739 | ||
a0a1a5fd TH |
4740 | #ifdef CONFIG_FREEZER |
4741 | ||
4742 | /** | |
4743 | * freeze_workqueues_begin - begin freezing workqueues | |
4744 | * | |
58a69cb4 | 4745 | * Start freezing workqueues. After this function returns, all freezable |
c5aa87bb | 4746 | * workqueues will queue new works to their delayed_works list instead of |
706026c2 | 4747 | * pool->worklist. |
a0a1a5fd TH |
4748 | * |
4749 | * CONTEXT: | |
a357fc03 | 4750 | * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. |
a0a1a5fd TH |
4751 | */ |
4752 | void freeze_workqueues_begin(void) | |
4753 | { | |
17116969 | 4754 | struct worker_pool *pool; |
24b8a847 TH |
4755 | struct workqueue_struct *wq; |
4756 | struct pool_workqueue *pwq; | |
611c92a0 | 4757 | int pi; |
a0a1a5fd | 4758 | |
68e13a67 | 4759 | mutex_lock(&wq_pool_mutex); |
a0a1a5fd | 4760 | |
6183c009 | 4761 | WARN_ON_ONCE(workqueue_freezing); |
a0a1a5fd TH |
4762 | workqueue_freezing = true; |
4763 | ||
24b8a847 | 4764 | /* set FREEZING */ |
611c92a0 | 4765 | for_each_pool(pool, pi) { |
5bcab335 | 4766 | spin_lock_irq(&pool->lock); |
17116969 TH |
4767 | WARN_ON_ONCE(pool->flags & POOL_FREEZING); |
4768 | pool->flags |= POOL_FREEZING; | |
5bcab335 | 4769 | spin_unlock_irq(&pool->lock); |
24b8a847 | 4770 | } |
a0a1a5fd | 4771 | |
24b8a847 | 4772 | list_for_each_entry(wq, &workqueues, list) { |
a357fc03 | 4773 | mutex_lock(&wq->mutex); |
699ce097 TH |
4774 | for_each_pwq(pwq, wq) |
4775 | pwq_adjust_max_active(pwq); | |
a357fc03 | 4776 | mutex_unlock(&wq->mutex); |
a0a1a5fd | 4777 | } |
5bcab335 | 4778 | |
68e13a67 | 4779 | mutex_unlock(&wq_pool_mutex); |
a0a1a5fd TH |
4780 | } |
4781 | ||
4782 | /** | |
58a69cb4 | 4783 | * freeze_workqueues_busy - are freezable workqueues still busy? |
a0a1a5fd TH |
4784 | * |
4785 | * Check whether freezing is complete. This function must be called | |
4786 | * between freeze_workqueues_begin() and thaw_workqueues(). | |
4787 | * | |
4788 | * CONTEXT: | |
68e13a67 | 4789 | * Grabs and releases wq_pool_mutex. |
a0a1a5fd | 4790 | * |
d185af30 | 4791 | * Return: |
58a69cb4 TH |
4792 | * %true if some freezable workqueues are still busy. %false if freezing |
4793 | * is complete. | |
a0a1a5fd TH |
4794 | */ |
4795 | bool freeze_workqueues_busy(void) | |
4796 | { | |
a0a1a5fd | 4797 | bool busy = false; |
24b8a847 TH |
4798 | struct workqueue_struct *wq; |
4799 | struct pool_workqueue *pwq; | |
a0a1a5fd | 4800 | |
68e13a67 | 4801 | mutex_lock(&wq_pool_mutex); |
a0a1a5fd | 4802 | |
6183c009 | 4803 | WARN_ON_ONCE(!workqueue_freezing); |
a0a1a5fd | 4804 | |
24b8a847 TH |
4805 | list_for_each_entry(wq, &workqueues, list) { |
4806 | if (!(wq->flags & WQ_FREEZABLE)) | |
4807 | continue; | |
a0a1a5fd TH |
4808 | /* |
4809 | * nr_active is monotonically decreasing. It's safe | |
4810 | * to peek without lock. | |
4811 | */ | |
88109453 | 4812 | rcu_read_lock_sched(); |
24b8a847 | 4813 | for_each_pwq(pwq, wq) { |
6183c009 | 4814 | WARN_ON_ONCE(pwq->nr_active < 0); |
112202d9 | 4815 | if (pwq->nr_active) { |
a0a1a5fd | 4816 | busy = true; |
88109453 | 4817 | rcu_read_unlock_sched(); |
a0a1a5fd TH |
4818 | goto out_unlock; |
4819 | } | |
4820 | } | |
88109453 | 4821 | rcu_read_unlock_sched(); |
a0a1a5fd TH |
4822 | } |
4823 | out_unlock: | |
68e13a67 | 4824 | mutex_unlock(&wq_pool_mutex); |
a0a1a5fd TH |
4825 | return busy; |
4826 | } | |
4827 | ||
4828 | /** | |
4829 | * thaw_workqueues - thaw workqueues | |
4830 | * | |
4831 | * Thaw workqueues. Normal queueing is restored and all collected | |
706026c2 | 4832 | * frozen works are transferred to their respective pool worklists. |
a0a1a5fd TH |
4833 | * |
4834 | * CONTEXT: | |
a357fc03 | 4835 | * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. |
a0a1a5fd TH |
4836 | */ |
4837 | void thaw_workqueues(void) | |
4838 | { | |
24b8a847 TH |
4839 | struct workqueue_struct *wq; |
4840 | struct pool_workqueue *pwq; | |
4841 | struct worker_pool *pool; | |
611c92a0 | 4842 | int pi; |
a0a1a5fd | 4843 | |
68e13a67 | 4844 | mutex_lock(&wq_pool_mutex); |
a0a1a5fd TH |
4845 | |
4846 | if (!workqueue_freezing) | |
4847 | goto out_unlock; | |
4848 | ||
24b8a847 | 4849 | /* clear FREEZING */ |
611c92a0 | 4850 | for_each_pool(pool, pi) { |
5bcab335 | 4851 | spin_lock_irq(&pool->lock); |
24b8a847 TH |
4852 | WARN_ON_ONCE(!(pool->flags & POOL_FREEZING)); |
4853 | pool->flags &= ~POOL_FREEZING; | |
5bcab335 | 4854 | spin_unlock_irq(&pool->lock); |
24b8a847 | 4855 | } |
8b03ae3c | 4856 | |
24b8a847 TH |
4857 | /* restore max_active and repopulate worklist */ |
4858 | list_for_each_entry(wq, &workqueues, list) { | |
a357fc03 | 4859 | mutex_lock(&wq->mutex); |
699ce097 TH |
4860 | for_each_pwq(pwq, wq) |
4861 | pwq_adjust_max_active(pwq); | |
a357fc03 | 4862 | mutex_unlock(&wq->mutex); |
a0a1a5fd TH |
4863 | } |
4864 | ||
4865 | workqueue_freezing = false; | |
4866 | out_unlock: | |
68e13a67 | 4867 | mutex_unlock(&wq_pool_mutex); |
a0a1a5fd TH |
4868 | } |
4869 | #endif /* CONFIG_FREEZER */ | |
4870 | ||
bce90380 TH |
4871 | static void __init wq_numa_init(void) |
4872 | { | |
4873 | cpumask_var_t *tbl; | |
4874 | int node, cpu; | |
4875 | ||
4876 | /* determine NUMA pwq table len - highest node id + 1 */ | |
4877 | for_each_node(node) | |
4878 | wq_numa_tbl_len = max(wq_numa_tbl_len, node + 1); | |
4879 | ||
4880 | if (num_possible_nodes() <= 1) | |
4881 | return; | |
4882 | ||
d55262c4 TH |
4883 | if (wq_disable_numa) { |
4884 | pr_info("workqueue: NUMA affinity support disabled\n"); | |
4885 | return; | |
4886 | } | |
4887 | ||
4c16bd32 TH |
4888 | wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL); |
4889 | BUG_ON(!wq_update_unbound_numa_attrs_buf); | |
4890 | ||
bce90380 TH |
4891 | /* |
4892 | * We want masks of possible CPUs of each node which isn't readily | |
4893 | * available. Build one from cpu_to_node() which should have been | |
4894 | * fully initialized by now. | |
4895 | */ | |
4896 | tbl = kzalloc(wq_numa_tbl_len * sizeof(tbl[0]), GFP_KERNEL); | |
4897 | BUG_ON(!tbl); | |
4898 | ||
4899 | for_each_node(node) | |
1be0c25d TH |
4900 | BUG_ON(!alloc_cpumask_var_node(&tbl[node], GFP_KERNEL, |
4901 | node_online(node) ? node : NUMA_NO_NODE)); | |
bce90380 TH |
4902 | |
4903 | for_each_possible_cpu(cpu) { | |
4904 | node = cpu_to_node(cpu); | |
4905 | if (WARN_ON(node == NUMA_NO_NODE)) { | |
4906 | pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu); | |
4907 | /* happens iff arch is bonkers, let's just proceed */ | |
4908 | return; | |
4909 | } | |
4910 | cpumask_set_cpu(cpu, tbl[node]); | |
4911 | } | |
4912 | ||
4913 | wq_numa_possible_cpumask = tbl; | |
4914 | wq_numa_enabled = true; | |
4915 | } | |
4916 | ||
6ee0578b | 4917 | static int __init init_workqueues(void) |
1da177e4 | 4918 | { |
7a4e344c TH |
4919 | int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL }; |
4920 | int i, cpu; | |
c34056a3 | 4921 | |
e904e6c2 TH |
4922 | WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long)); |
4923 | ||
4924 | pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC); | |
4925 | ||
65758202 | 4926 | cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP); |
a5b4e57d | 4927 | hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN); |
8b03ae3c | 4928 | |
bce90380 TH |
4929 | wq_numa_init(); |
4930 | ||
706026c2 | 4931 | /* initialize CPU pools */ |
29c91e99 | 4932 | for_each_possible_cpu(cpu) { |
4ce62e9e | 4933 | struct worker_pool *pool; |
8b03ae3c | 4934 | |
7a4e344c | 4935 | i = 0; |
f02ae73a | 4936 | for_each_cpu_worker_pool(pool, cpu) { |
7a4e344c | 4937 | BUG_ON(init_worker_pool(pool)); |
ec22ca5e | 4938 | pool->cpu = cpu; |
29c91e99 | 4939 | cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu)); |
7a4e344c | 4940 | pool->attrs->nice = std_nice[i++]; |
f3f90ad4 | 4941 | pool->node = cpu_to_node(cpu); |
7a4e344c | 4942 | |
9daf9e67 | 4943 | /* alloc pool ID */ |
68e13a67 | 4944 | mutex_lock(&wq_pool_mutex); |
9daf9e67 | 4945 | BUG_ON(worker_pool_assign_id(pool)); |
68e13a67 | 4946 | mutex_unlock(&wq_pool_mutex); |
4ce62e9e | 4947 | } |
8b03ae3c TH |
4948 | } |
4949 | ||
e22bee78 | 4950 | /* create the initial worker */ |
29c91e99 | 4951 | for_each_online_cpu(cpu) { |
4ce62e9e | 4952 | struct worker_pool *pool; |
e22bee78 | 4953 | |
f02ae73a | 4954 | for_each_cpu_worker_pool(pool, cpu) { |
29c91e99 | 4955 | pool->flags &= ~POOL_DISASSOCIATED; |
ebf44d16 | 4956 | BUG_ON(create_and_start_worker(pool) < 0); |
4ce62e9e | 4957 | } |
e22bee78 TH |
4958 | } |
4959 | ||
8a2b7538 | 4960 | /* create default unbound and ordered wq attrs */ |
29c91e99 TH |
4961 | for (i = 0; i < NR_STD_WORKER_POOLS; i++) { |
4962 | struct workqueue_attrs *attrs; | |
4963 | ||
4964 | BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL))); | |
29c91e99 | 4965 | attrs->nice = std_nice[i]; |
29c91e99 | 4966 | unbound_std_wq_attrs[i] = attrs; |
8a2b7538 TH |
4967 | |
4968 | /* | |
4969 | * An ordered wq should have only one pwq as ordering is | |
4970 | * guaranteed by max_active which is enforced by pwqs. | |
4971 | * Turn off NUMA so that dfl_pwq is used for all nodes. | |
4972 | */ | |
4973 | BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL))); | |
4974 | attrs->nice = std_nice[i]; | |
4975 | attrs->no_numa = true; | |
4976 | ordered_wq_attrs[i] = attrs; | |
29c91e99 TH |
4977 | } |
4978 | ||
d320c038 | 4979 | system_wq = alloc_workqueue("events", 0, 0); |
1aabe902 | 4980 | system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0); |
d320c038 | 4981 | system_long_wq = alloc_workqueue("events_long", 0, 0); |
f3421797 TH |
4982 | system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, |
4983 | WQ_UNBOUND_MAX_ACTIVE); | |
24d51add TH |
4984 | system_freezable_wq = alloc_workqueue("events_freezable", |
4985 | WQ_FREEZABLE, 0); | |
0668106c VK |
4986 | system_power_efficient_wq = alloc_workqueue("events_power_efficient", |
4987 | WQ_POWER_EFFICIENT, 0); | |
4988 | system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient", | |
4989 | WQ_FREEZABLE | WQ_POWER_EFFICIENT, | |
4990 | 0); | |
1aabe902 | 4991 | BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq || |
0668106c VK |
4992 | !system_unbound_wq || !system_freezable_wq || |
4993 | !system_power_efficient_wq || | |
4994 | !system_freezable_power_efficient_wq); | |
6ee0578b | 4995 | return 0; |
1da177e4 | 4996 | } |
6ee0578b | 4997 | early_initcall(init_workqueues); |