]>
Commit | Line | Data |
---|---|---|
457c8996 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
1da177e4 | 2 | /* |
c54fce6e | 3 | * kernel/workqueue.c - generic async execution with shared worker pool |
1da177e4 | 4 | * |
c54fce6e | 5 | * Copyright (C) 2002 Ingo Molnar |
1da177e4 | 6 | * |
c54fce6e TH |
7 | * Derived from the taskqueue/keventd code by: |
8 | * David Woodhouse <dwmw2@infradead.org> | |
9 | * Andrew Morton | |
10 | * Kai Petzke <wpp@marie.physik.tu-berlin.de> | |
11 | * Theodore Ts'o <tytso@mit.edu> | |
1da177e4 | 12 | * |
c54fce6e | 13 | * Made to use alloc_percpu by Christoph Lameter. |
1da177e4 | 14 | * |
c54fce6e TH |
15 | * Copyright (C) 2010 SUSE Linux Products GmbH |
16 | * Copyright (C) 2010 Tejun Heo <tj@kernel.org> | |
89ada679 | 17 | * |
c54fce6e TH |
18 | * This is the generic async execution mechanism. Work items as are |
19 | * executed in process context. The worker pool is shared and | |
b11895c4 L |
20 | * automatically managed. There are two worker pools for each CPU (one for |
21 | * normal work items and the other for high priority ones) and some extra | |
22 | * pools for workqueues which are not bound to any specific CPU - the | |
23 | * number of these backing pools is dynamic. | |
c54fce6e | 24 | * |
9a261491 | 25 | * Please read Documentation/core-api/workqueue.rst for details. |
1da177e4 LT |
26 | */ |
27 | ||
9984de1a | 28 | #include <linux/export.h> |
1da177e4 LT |
29 | #include <linux/kernel.h> |
30 | #include <linux/sched.h> | |
31 | #include <linux/init.h> | |
32 | #include <linux/signal.h> | |
33 | #include <linux/completion.h> | |
34 | #include <linux/workqueue.h> | |
35 | #include <linux/slab.h> | |
36 | #include <linux/cpu.h> | |
37 | #include <linux/notifier.h> | |
38 | #include <linux/kthread.h> | |
1fa44eca | 39 | #include <linux/hardirq.h> |
46934023 | 40 | #include <linux/mempolicy.h> |
341a5958 | 41 | #include <linux/freezer.h> |
d5abe669 | 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> |
c98a9805 | 51 | #include <linux/sched/isolation.h> |
62635ea8 | 52 | #include <linux/nmi.h> |
e22bee78 | 53 | |
ea138446 | 54 | #include "workqueue_internal.h" |
1da177e4 | 55 | |
c8e55f36 | 56 | enum { |
24647570 TH |
57 | /* |
58 | * worker_pool flags | |
bc2ae0f5 | 59 | * |
24647570 | 60 | * A bound pool is either associated or disassociated with its CPU. |
bc2ae0f5 TH |
61 | * While associated (!DISASSOCIATED), all workers are bound to the |
62 | * CPU and none has %WORKER_UNBOUND set and concurrency management | |
63 | * is in effect. | |
64 | * | |
65 | * While DISASSOCIATED, the cpu may be offline and all workers have | |
66 | * %WORKER_UNBOUND set and concurrency management disabled, and may | |
24647570 | 67 | * be executing on any CPU. The pool behaves as an unbound one. |
bc2ae0f5 | 68 | * |
bc3a1afc | 69 | * Note that DISASSOCIATED should be flipped only while holding |
1258fae7 | 70 | * wq_pool_attach_mutex to avoid changing binding state while |
4736cbf7 | 71 | * worker_attach_to_pool() is in progress. |
bc2ae0f5 | 72 | */ |
692b4825 | 73 | POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */ |
24647570 | 74 | POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */ |
db7bccf4 | 75 | |
c8e55f36 | 76 | /* worker flags */ |
c8e55f36 TH |
77 | WORKER_DIE = 1 << 1, /* die die die */ |
78 | WORKER_IDLE = 1 << 2, /* is idle */ | |
e22bee78 | 79 | WORKER_PREP = 1 << 3, /* preparing to run works */ |
fb0e7beb | 80 | WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */ |
f3421797 | 81 | WORKER_UNBOUND = 1 << 7, /* worker is unbound */ |
a9ab775b | 82 | WORKER_REBOUND = 1 << 8, /* worker was rebound */ |
e22bee78 | 83 | |
a9ab775b TH |
84 | WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE | |
85 | WORKER_UNBOUND | WORKER_REBOUND, | |
db7bccf4 | 86 | |
e34cdddb | 87 | NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */ |
4ce62e9e | 88 | |
29c91e99 | 89 | UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */ |
c8e55f36 | 90 | BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */ |
db7bccf4 | 91 | |
e22bee78 TH |
92 | MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */ |
93 | IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */ | |
94 | ||
3233cdbd TH |
95 | MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2, |
96 | /* call for help after 10ms | |
97 | (min two ticks) */ | |
e22bee78 TH |
98 | MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */ |
99 | CREATE_COOLDOWN = HZ, /* time to breath after fail */ | |
e22bee78 TH |
100 | |
101 | /* | |
102 | * Rescue workers are used only on emergencies and shared by | |
8698a745 | 103 | * all cpus. Give MIN_NICE. |
e22bee78 | 104 | */ |
8698a745 DY |
105 | RESCUER_NICE_LEVEL = MIN_NICE, |
106 | HIGHPRI_NICE_LEVEL = MIN_NICE, | |
ecf6881f TH |
107 | |
108 | WQ_NAME_LEN = 24, | |
c8e55f36 | 109 | }; |
1da177e4 LT |
110 | |
111 | /* | |
4690c4ab TH |
112 | * Structure fields follow one of the following exclusion rules. |
113 | * | |
e41e704b TH |
114 | * I: Modifiable by initialization/destruction paths and read-only for |
115 | * everyone else. | |
4690c4ab | 116 | * |
e22bee78 TH |
117 | * P: Preemption protected. Disabling preemption is enough and should |
118 | * only be modified and accessed from the local cpu. | |
119 | * | |
d565ed63 | 120 | * L: pool->lock protected. Access with pool->lock held. |
4690c4ab | 121 | * |
d565ed63 TH |
122 | * X: During normal operation, modification requires pool->lock and should |
123 | * be done only from local cpu. Either disabling preemption on local | |
124 | * cpu or grabbing pool->lock is enough for read access. If | |
125 | * POOL_DISASSOCIATED is set, it's identical to L. | |
e22bee78 | 126 | * |
1258fae7 | 127 | * A: wq_pool_attach_mutex protected. |
822d8405 | 128 | * |
68e13a67 | 129 | * PL: wq_pool_mutex protected. |
5bcab335 | 130 | * |
24acfb71 | 131 | * PR: wq_pool_mutex protected for writes. RCU protected for reads. |
76af4d93 | 132 | * |
5b95e1af LJ |
133 | * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads. |
134 | * | |
135 | * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or | |
24acfb71 | 136 | * RCU for reads. |
5b95e1af | 137 | * |
3c25a55d LJ |
138 | * WQ: wq->mutex protected. |
139 | * | |
24acfb71 | 140 | * WR: wq->mutex protected for writes. RCU protected for reads. |
2e109a28 TH |
141 | * |
142 | * MD: wq_mayday_lock protected. | |
1da177e4 | 143 | */ |
1da177e4 | 144 | |
2eaebdb3 | 145 | /* struct worker is defined in workqueue_internal.h */ |
c34056a3 | 146 | |
bd7bdd43 | 147 | struct worker_pool { |
d565ed63 | 148 | spinlock_t lock; /* the pool lock */ |
d84ff051 | 149 | int cpu; /* I: the associated cpu */ |
f3f90ad4 | 150 | int node; /* I: the associated node ID */ |
9daf9e67 | 151 | int id; /* I: pool ID */ |
11ebea50 | 152 | unsigned int flags; /* X: flags */ |
bd7bdd43 | 153 | |
82607adc TH |
154 | unsigned long watchdog_ts; /* L: watchdog timestamp */ |
155 | ||
bd7bdd43 | 156 | struct list_head worklist; /* L: list of pending works */ |
ea1abd61 | 157 | |
5826cc8f LJ |
158 | int nr_workers; /* L: total number of workers */ |
159 | int nr_idle; /* L: currently idle workers */ | |
bd7bdd43 TH |
160 | |
161 | struct list_head idle_list; /* X: list of idle workers */ | |
162 | struct timer_list idle_timer; /* L: worker idle timeout */ | |
163 | struct timer_list mayday_timer; /* L: SOS timer for workers */ | |
164 | ||
c5aa87bb | 165 | /* a workers is either on busy_hash or idle_list, or the manager */ |
c9e7cf27 TH |
166 | DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER); |
167 | /* L: hash of busy workers */ | |
168 | ||
2607d7a6 | 169 | struct worker *manager; /* L: purely informational */ |
92f9c5c4 | 170 | struct list_head workers; /* A: attached workers */ |
60f5a4bc | 171 | struct completion *detach_completion; /* all workers detached */ |
e19e397a | 172 | |
7cda9aae | 173 | struct ida worker_ida; /* worker IDs for task name */ |
e19e397a | 174 | |
7a4e344c | 175 | struct workqueue_attrs *attrs; /* I: worker attributes */ |
68e13a67 LJ |
176 | struct hlist_node hash_node; /* PL: unbound_pool_hash node */ |
177 | int refcnt; /* PL: refcnt for unbound pools */ | |
7a4e344c | 178 | |
e19e397a TH |
179 | /* |
180 | * The current concurrency level. As it's likely to be accessed | |
181 | * from other CPUs during try_to_wake_up(), put it in a separate | |
182 | * cacheline. | |
183 | */ | |
184 | atomic_t nr_running ____cacheline_aligned_in_smp; | |
29c91e99 TH |
185 | |
186 | /* | |
24acfb71 | 187 | * Destruction of pool is RCU protected to allow dereferences |
29c91e99 TH |
188 | * from get_work_pool(). |
189 | */ | |
190 | struct rcu_head rcu; | |
8b03ae3c TH |
191 | } ____cacheline_aligned_in_smp; |
192 | ||
1da177e4 | 193 | /* |
112202d9 TH |
194 | * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS |
195 | * of work_struct->data are used for flags and the remaining high bits | |
196 | * point to the pwq; thus, pwqs need to be aligned at two's power of the | |
197 | * number of flag bits. | |
1da177e4 | 198 | */ |
112202d9 | 199 | struct pool_workqueue { |
bd7bdd43 | 200 | struct worker_pool *pool; /* I: the associated pool */ |
4690c4ab | 201 | struct workqueue_struct *wq; /* I: the owning workqueue */ |
73f53c4a TH |
202 | int work_color; /* L: current color */ |
203 | int flush_color; /* L: flushing color */ | |
8864b4e5 | 204 | int refcnt; /* L: reference count */ |
73f53c4a TH |
205 | int nr_in_flight[WORK_NR_COLORS]; |
206 | /* L: nr of in_flight works */ | |
1e19ffc6 | 207 | int nr_active; /* L: nr of active works */ |
a0a1a5fd | 208 | int max_active; /* L: max active works */ |
1e19ffc6 | 209 | struct list_head delayed_works; /* L: delayed works */ |
3c25a55d | 210 | struct list_head pwqs_node; /* WR: node on wq->pwqs */ |
2e109a28 | 211 | struct list_head mayday_node; /* MD: node on wq->maydays */ |
8864b4e5 TH |
212 | |
213 | /* | |
214 | * Release of unbound pwq is punted to system_wq. See put_pwq() | |
215 | * and pwq_unbound_release_workfn() for details. pool_workqueue | |
24acfb71 | 216 | * itself is also RCU protected so that the first pwq can be |
b09f4fd3 | 217 | * determined without grabbing wq->mutex. |
8864b4e5 TH |
218 | */ |
219 | struct work_struct unbound_release_work; | |
220 | struct rcu_head rcu; | |
e904e6c2 | 221 | } __aligned(1 << WORK_STRUCT_FLAG_BITS); |
1da177e4 | 222 | |
73f53c4a TH |
223 | /* |
224 | * Structure used to wait for workqueue flush. | |
225 | */ | |
226 | struct wq_flusher { | |
3c25a55d LJ |
227 | struct list_head list; /* WQ: list of flushers */ |
228 | int flush_color; /* WQ: flush color waiting for */ | |
73f53c4a TH |
229 | struct completion done; /* flush completion */ |
230 | }; | |
231 | ||
226223ab TH |
232 | struct wq_device; |
233 | ||
1da177e4 | 234 | /* |
c5aa87bb TH |
235 | * The externally visible workqueue. It relays the issued work items to |
236 | * the appropriate worker_pool through its pool_workqueues. | |
1da177e4 LT |
237 | */ |
238 | struct workqueue_struct { | |
3c25a55d | 239 | struct list_head pwqs; /* WR: all pwqs of this wq */ |
e2dca7ad | 240 | struct list_head list; /* PR: list of all workqueues */ |
73f53c4a | 241 | |
3c25a55d LJ |
242 | struct mutex mutex; /* protects this wq */ |
243 | int work_color; /* WQ: current work color */ | |
244 | int flush_color; /* WQ: current flush color */ | |
112202d9 | 245 | atomic_t nr_pwqs_to_flush; /* flush in progress */ |
3c25a55d LJ |
246 | struct wq_flusher *first_flusher; /* WQ: first flusher */ |
247 | struct list_head flusher_queue; /* WQ: flush waiters */ | |
248 | struct list_head flusher_overflow; /* WQ: flush overflow list */ | |
73f53c4a | 249 | |
2e109a28 | 250 | struct list_head maydays; /* MD: pwqs requesting rescue */ |
e22bee78 TH |
251 | struct worker *rescuer; /* I: rescue worker */ |
252 | ||
87fc741e | 253 | int nr_drainers; /* WQ: drain in progress */ |
a357fc03 | 254 | int saved_max_active; /* WQ: saved pwq max_active */ |
226223ab | 255 | |
5b95e1af LJ |
256 | struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */ |
257 | struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */ | |
6029a918 | 258 | |
226223ab TH |
259 | #ifdef CONFIG_SYSFS |
260 | struct wq_device *wq_dev; /* I: for sysfs interface */ | |
261 | #endif | |
4e6045f1 | 262 | #ifdef CONFIG_LOCKDEP |
669de8bd BVA |
263 | char *lock_name; |
264 | struct lock_class_key key; | |
4690c4ab | 265 | struct lockdep_map lockdep_map; |
4e6045f1 | 266 | #endif |
ecf6881f | 267 | char name[WQ_NAME_LEN]; /* I: workqueue name */ |
2728fd2f | 268 | |
e2dca7ad | 269 | /* |
24acfb71 TG |
270 | * Destruction of workqueue_struct is RCU protected to allow walking |
271 | * the workqueues list without grabbing wq_pool_mutex. | |
e2dca7ad TH |
272 | * This is used to dump all workqueues from sysrq. |
273 | */ | |
274 | struct rcu_head rcu; | |
275 | ||
2728fd2f TH |
276 | /* hot fields used during command issue, aligned to cacheline */ |
277 | unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */ | |
278 | struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */ | |
5b95e1af | 279 | struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */ |
1da177e4 LT |
280 | }; |
281 | ||
e904e6c2 TH |
282 | static struct kmem_cache *pwq_cache; |
283 | ||
bce90380 TH |
284 | static cpumask_var_t *wq_numa_possible_cpumask; |
285 | /* possible CPUs of each node */ | |
286 | ||
d55262c4 TH |
287 | static bool wq_disable_numa; |
288 | module_param_named(disable_numa, wq_disable_numa, bool, 0444); | |
289 | ||
cee22a15 | 290 | /* see the comment above the definition of WQ_POWER_EFFICIENT */ |
552f530c | 291 | static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT); |
cee22a15 VK |
292 | module_param_named(power_efficient, wq_power_efficient, bool, 0444); |
293 | ||
863b710b | 294 | static bool wq_online; /* can kworkers be created yet? */ |
3347fa09 | 295 | |
bce90380 TH |
296 | static bool wq_numa_enabled; /* unbound NUMA affinity enabled */ |
297 | ||
4c16bd32 TH |
298 | /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */ |
299 | static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf; | |
300 | ||
68e13a67 | 301 | static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */ |
1258fae7 | 302 | static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */ |
2e109a28 | 303 | static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */ |
692b4825 | 304 | static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */ |
5bcab335 | 305 | |
e2dca7ad | 306 | static LIST_HEAD(workqueues); /* PR: list of all workqueues */ |
68e13a67 | 307 | static bool workqueue_freezing; /* PL: have wqs started freezing? */ |
7d19c5ce | 308 | |
ef557180 MG |
309 | /* PL: allowable cpus for unbound wqs and work items */ |
310 | static cpumask_var_t wq_unbound_cpumask; | |
311 | ||
312 | /* CPU where unbound work was last round robin scheduled from this CPU */ | |
313 | static DEFINE_PER_CPU(int, wq_rr_cpu_last); | |
b05a7928 | 314 | |
f303fccb TH |
315 | /* |
316 | * Local execution of unbound work items is no longer guaranteed. The | |
317 | * following always forces round-robin CPU selection on unbound work items | |
318 | * to uncover usages which depend on it. | |
319 | */ | |
320 | #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU | |
321 | static bool wq_debug_force_rr_cpu = true; | |
322 | #else | |
323 | static bool wq_debug_force_rr_cpu = false; | |
324 | #endif | |
325 | module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644); | |
326 | ||
7d19c5ce | 327 | /* the per-cpu worker pools */ |
25528213 | 328 | static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools); |
7d19c5ce | 329 | |
68e13a67 | 330 | static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */ |
7d19c5ce | 331 | |
68e13a67 | 332 | /* PL: hash of all unbound pools keyed by pool->attrs */ |
29c91e99 TH |
333 | static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER); |
334 | ||
c5aa87bb | 335 | /* I: attributes used when instantiating standard unbound pools on demand */ |
29c91e99 TH |
336 | static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS]; |
337 | ||
8a2b7538 TH |
338 | /* I: attributes used when instantiating ordered pools on demand */ |
339 | static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS]; | |
340 | ||
d320c038 | 341 | struct workqueue_struct *system_wq __read_mostly; |
ad7b1f84 | 342 | EXPORT_SYMBOL(system_wq); |
044c782c | 343 | struct workqueue_struct *system_highpri_wq __read_mostly; |
1aabe902 | 344 | EXPORT_SYMBOL_GPL(system_highpri_wq); |
044c782c | 345 | struct workqueue_struct *system_long_wq __read_mostly; |
d320c038 | 346 | EXPORT_SYMBOL_GPL(system_long_wq); |
044c782c | 347 | struct workqueue_struct *system_unbound_wq __read_mostly; |
f3421797 | 348 | EXPORT_SYMBOL_GPL(system_unbound_wq); |
044c782c | 349 | struct workqueue_struct *system_freezable_wq __read_mostly; |
24d51add | 350 | EXPORT_SYMBOL_GPL(system_freezable_wq); |
0668106c VK |
351 | struct workqueue_struct *system_power_efficient_wq __read_mostly; |
352 | EXPORT_SYMBOL_GPL(system_power_efficient_wq); | |
353 | struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly; | |
354 | EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq); | |
d320c038 | 355 | |
7d19c5ce | 356 | static int worker_thread(void *__worker); |
6ba94429 | 357 | static void workqueue_sysfs_unregister(struct workqueue_struct *wq); |
7d19c5ce | 358 | |
97bd2347 TH |
359 | #define CREATE_TRACE_POINTS |
360 | #include <trace/events/workqueue.h> | |
361 | ||
68e13a67 | 362 | #define assert_rcu_or_pool_mutex() \ |
24acfb71 | 363 | RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \ |
f78f5b90 | 364 | !lockdep_is_held(&wq_pool_mutex), \ |
24acfb71 | 365 | "RCU or wq_pool_mutex should be held") |
5bcab335 | 366 | |
b09f4fd3 | 367 | #define assert_rcu_or_wq_mutex(wq) \ |
24acfb71 | 368 | RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \ |
f78f5b90 | 369 | !lockdep_is_held(&wq->mutex), \ |
24acfb71 | 370 | "RCU or wq->mutex should be held") |
76af4d93 | 371 | |
5b95e1af | 372 | #define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \ |
24acfb71 | 373 | RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \ |
f78f5b90 PM |
374 | !lockdep_is_held(&wq->mutex) && \ |
375 | !lockdep_is_held(&wq_pool_mutex), \ | |
24acfb71 | 376 | "RCU, wq->mutex or wq_pool_mutex should be held") |
5b95e1af | 377 | |
f02ae73a TH |
378 | #define for_each_cpu_worker_pool(pool, cpu) \ |
379 | for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \ | |
380 | (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \ | |
7a62c2c8 | 381 | (pool)++) |
4ce62e9e | 382 | |
17116969 TH |
383 | /** |
384 | * for_each_pool - iterate through all worker_pools in the system | |
385 | * @pool: iteration cursor | |
611c92a0 | 386 | * @pi: integer used for iteration |
fa1b54e6 | 387 | * |
24acfb71 | 388 | * This must be called either with wq_pool_mutex held or RCU read |
68e13a67 LJ |
389 | * locked. If the pool needs to be used beyond the locking in effect, the |
390 | * caller is responsible for guaranteeing that the pool stays online. | |
fa1b54e6 TH |
391 | * |
392 | * The if/else clause exists only for the lockdep assertion and can be | |
393 | * ignored. | |
17116969 | 394 | */ |
611c92a0 TH |
395 | #define for_each_pool(pool, pi) \ |
396 | idr_for_each_entry(&worker_pool_idr, pool, pi) \ | |
68e13a67 | 397 | if (({ assert_rcu_or_pool_mutex(); false; })) { } \ |
fa1b54e6 | 398 | else |
17116969 | 399 | |
822d8405 TH |
400 | /** |
401 | * for_each_pool_worker - iterate through all workers of a worker_pool | |
402 | * @worker: iteration cursor | |
822d8405 TH |
403 | * @pool: worker_pool to iterate workers of |
404 | * | |
1258fae7 | 405 | * This must be called with wq_pool_attach_mutex. |
822d8405 TH |
406 | * |
407 | * The if/else clause exists only for the lockdep assertion and can be | |
408 | * ignored. | |
409 | */ | |
da028469 LJ |
410 | #define for_each_pool_worker(worker, pool) \ |
411 | list_for_each_entry((worker), &(pool)->workers, node) \ | |
1258fae7 | 412 | if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \ |
822d8405 TH |
413 | else |
414 | ||
49e3cf44 TH |
415 | /** |
416 | * for_each_pwq - iterate through all pool_workqueues of the specified workqueue | |
417 | * @pwq: iteration cursor | |
418 | * @wq: the target workqueue | |
76af4d93 | 419 | * |
24acfb71 | 420 | * This must be called either with wq->mutex held or RCU read locked. |
794b18bc TH |
421 | * If the pwq needs to be used beyond the locking in effect, the caller is |
422 | * responsible for guaranteeing that the pwq stays online. | |
76af4d93 TH |
423 | * |
424 | * The if/else clause exists only for the lockdep assertion and can be | |
425 | * ignored. | |
49e3cf44 TH |
426 | */ |
427 | #define for_each_pwq(pwq, wq) \ | |
60e0c8af SAS |
428 | list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \ |
429 | lockdep_is_held(&wq->mutex)) \ | |
b09f4fd3 | 430 | if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \ |
76af4d93 | 431 | else |
f3421797 | 432 | |
dc186ad7 TG |
433 | #ifdef CONFIG_DEBUG_OBJECTS_WORK |
434 | ||
435 | static struct debug_obj_descr work_debug_descr; | |
436 | ||
99777288 SG |
437 | static void *work_debug_hint(void *addr) |
438 | { | |
439 | return ((struct work_struct *) addr)->func; | |
440 | } | |
441 | ||
b9fdac7f CD |
442 | static bool work_is_static_object(void *addr) |
443 | { | |
444 | struct work_struct *work = addr; | |
445 | ||
446 | return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work)); | |
447 | } | |
448 | ||
dc186ad7 TG |
449 | /* |
450 | * fixup_init is called when: | |
451 | * - an active object is initialized | |
452 | */ | |
02a982a6 | 453 | static bool work_fixup_init(void *addr, enum debug_obj_state state) |
dc186ad7 TG |
454 | { |
455 | struct work_struct *work = addr; | |
456 | ||
457 | switch (state) { | |
458 | case ODEBUG_STATE_ACTIVE: | |
459 | cancel_work_sync(work); | |
460 | debug_object_init(work, &work_debug_descr); | |
02a982a6 | 461 | return true; |
dc186ad7 | 462 | default: |
02a982a6 | 463 | return false; |
dc186ad7 TG |
464 | } |
465 | } | |
466 | ||
dc186ad7 TG |
467 | /* |
468 | * fixup_free is called when: | |
469 | * - an active object is freed | |
470 | */ | |
02a982a6 | 471 | static bool work_fixup_free(void *addr, enum debug_obj_state state) |
dc186ad7 TG |
472 | { |
473 | struct work_struct *work = addr; | |
474 | ||
475 | switch (state) { | |
476 | case ODEBUG_STATE_ACTIVE: | |
477 | cancel_work_sync(work); | |
478 | debug_object_free(work, &work_debug_descr); | |
02a982a6 | 479 | return true; |
dc186ad7 | 480 | default: |
02a982a6 | 481 | return false; |
dc186ad7 TG |
482 | } |
483 | } | |
484 | ||
485 | static struct debug_obj_descr work_debug_descr = { | |
486 | .name = "work_struct", | |
99777288 | 487 | .debug_hint = work_debug_hint, |
b9fdac7f | 488 | .is_static_object = work_is_static_object, |
dc186ad7 | 489 | .fixup_init = work_fixup_init, |
dc186ad7 TG |
490 | .fixup_free = work_fixup_free, |
491 | }; | |
492 | ||
493 | static inline void debug_work_activate(struct work_struct *work) | |
494 | { | |
495 | debug_object_activate(work, &work_debug_descr); | |
496 | } | |
497 | ||
498 | static inline void debug_work_deactivate(struct work_struct *work) | |
499 | { | |
500 | debug_object_deactivate(work, &work_debug_descr); | |
501 | } | |
502 | ||
503 | void __init_work(struct work_struct *work, int onstack) | |
504 | { | |
505 | if (onstack) | |
506 | debug_object_init_on_stack(work, &work_debug_descr); | |
507 | else | |
508 | debug_object_init(work, &work_debug_descr); | |
509 | } | |
510 | EXPORT_SYMBOL_GPL(__init_work); | |
511 | ||
512 | void destroy_work_on_stack(struct work_struct *work) | |
513 | { | |
514 | debug_object_free(work, &work_debug_descr); | |
515 | } | |
516 | EXPORT_SYMBOL_GPL(destroy_work_on_stack); | |
517 | ||
ea2e64f2 TG |
518 | void destroy_delayed_work_on_stack(struct delayed_work *work) |
519 | { | |
520 | destroy_timer_on_stack(&work->timer); | |
521 | debug_object_free(&work->work, &work_debug_descr); | |
522 | } | |
523 | EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack); | |
524 | ||
dc186ad7 TG |
525 | #else |
526 | static inline void debug_work_activate(struct work_struct *work) { } | |
527 | static inline void debug_work_deactivate(struct work_struct *work) { } | |
528 | #endif | |
529 | ||
4e8b22bd LB |
530 | /** |
531 | * worker_pool_assign_id - allocate ID and assing it to @pool | |
532 | * @pool: the pool pointer of interest | |
533 | * | |
534 | * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned | |
535 | * successfully, -errno on failure. | |
536 | */ | |
9daf9e67 TH |
537 | static int worker_pool_assign_id(struct worker_pool *pool) |
538 | { | |
539 | int ret; | |
540 | ||
68e13a67 | 541 | lockdep_assert_held(&wq_pool_mutex); |
5bcab335 | 542 | |
4e8b22bd LB |
543 | ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE, |
544 | GFP_KERNEL); | |
229641a6 | 545 | if (ret >= 0) { |
e68035fb | 546 | pool->id = ret; |
229641a6 TH |
547 | return 0; |
548 | } | |
fa1b54e6 | 549 | return ret; |
7c3eed5c TH |
550 | } |
551 | ||
df2d5ae4 TH |
552 | /** |
553 | * unbound_pwq_by_node - return the unbound pool_workqueue for the given node | |
554 | * @wq: the target workqueue | |
555 | * @node: the node ID | |
556 | * | |
24acfb71 | 557 | * This must be called with any of wq_pool_mutex, wq->mutex or RCU |
5b95e1af | 558 | * read locked. |
df2d5ae4 TH |
559 | * If the pwq needs to be used beyond the locking in effect, the caller is |
560 | * responsible for guaranteeing that the pwq stays online. | |
d185af30 YB |
561 | * |
562 | * Return: The unbound pool_workqueue for @node. | |
df2d5ae4 TH |
563 | */ |
564 | static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq, | |
565 | int node) | |
566 | { | |
5b95e1af | 567 | assert_rcu_or_wq_mutex_or_pool_mutex(wq); |
d6e022f1 TH |
568 | |
569 | /* | |
570 | * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a | |
571 | * delayed item is pending. The plan is to keep CPU -> NODE | |
572 | * mapping valid and stable across CPU on/offlines. Once that | |
573 | * happens, this workaround can be removed. | |
574 | */ | |
575 | if (unlikely(node == NUMA_NO_NODE)) | |
576 | return wq->dfl_pwq; | |
577 | ||
df2d5ae4 TH |
578 | return rcu_dereference_raw(wq->numa_pwq_tbl[node]); |
579 | } | |
580 | ||
73f53c4a TH |
581 | static unsigned int work_color_to_flags(int color) |
582 | { | |
583 | return color << WORK_STRUCT_COLOR_SHIFT; | |
584 | } | |
585 | ||
586 | static int get_work_color(struct work_struct *work) | |
587 | { | |
588 | return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) & | |
589 | ((1 << WORK_STRUCT_COLOR_BITS) - 1); | |
590 | } | |
591 | ||
592 | static int work_next_color(int color) | |
593 | { | |
594 | return (color + 1) % WORK_NR_COLORS; | |
595 | } | |
1da177e4 | 596 | |
14441960 | 597 | /* |
112202d9 TH |
598 | * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data |
599 | * contain the pointer to the queued pwq. Once execution starts, the flag | |
7c3eed5c | 600 | * is cleared and the high bits contain OFFQ flags and pool ID. |
7a22ad75 | 601 | * |
112202d9 TH |
602 | * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling() |
603 | * and clear_work_data() can be used to set the pwq, pool or clear | |
bbb68dfa TH |
604 | * work->data. These functions should only be called while the work is |
605 | * owned - ie. while the PENDING bit is set. | |
7a22ad75 | 606 | * |
112202d9 | 607 | * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq |
7c3eed5c | 608 | * corresponding to a work. Pool is available once the work has been |
112202d9 | 609 | * queued anywhere after initialization until it is sync canceled. pwq is |
7c3eed5c | 610 | * available only while the work item is queued. |
7a22ad75 | 611 | * |
bbb68dfa TH |
612 | * %WORK_OFFQ_CANCELING is used to mark a work item which is being |
613 | * canceled. While being canceled, a work item may have its PENDING set | |
614 | * but stay off timer and worklist for arbitrarily long and nobody should | |
615 | * try to steal the PENDING bit. | |
14441960 | 616 | */ |
7a22ad75 TH |
617 | static inline void set_work_data(struct work_struct *work, unsigned long data, |
618 | unsigned long flags) | |
365970a1 | 619 | { |
6183c009 | 620 | WARN_ON_ONCE(!work_pending(work)); |
7a22ad75 TH |
621 | atomic_long_set(&work->data, data | flags | work_static(work)); |
622 | } | |
365970a1 | 623 | |
112202d9 | 624 | static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq, |
7a22ad75 TH |
625 | unsigned long extra_flags) |
626 | { | |
112202d9 TH |
627 | set_work_data(work, (unsigned long)pwq, |
628 | WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags); | |
365970a1 DH |
629 | } |
630 | ||
4468a00f LJ |
631 | static void set_work_pool_and_keep_pending(struct work_struct *work, |
632 | int pool_id) | |
633 | { | |
634 | set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, | |
635 | WORK_STRUCT_PENDING); | |
636 | } | |
637 | ||
7c3eed5c TH |
638 | static void set_work_pool_and_clear_pending(struct work_struct *work, |
639 | int pool_id) | |
7a22ad75 | 640 | { |
23657bb1 TH |
641 | /* |
642 | * The following wmb is paired with the implied mb in | |
643 | * test_and_set_bit(PENDING) and ensures all updates to @work made | |
644 | * here are visible to and precede any updates by the next PENDING | |
645 | * owner. | |
646 | */ | |
647 | smp_wmb(); | |
7c3eed5c | 648 | set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0); |
346c09f8 RP |
649 | /* |
650 | * The following mb guarantees that previous clear of a PENDING bit | |
651 | * will not be reordered with any speculative LOADS or STORES from | |
652 | * work->current_func, which is executed afterwards. This possible | |
8bdc6201 | 653 | * reordering can lead to a missed execution on attempt to queue |
346c09f8 RP |
654 | * the same @work. E.g. consider this case: |
655 | * | |
656 | * CPU#0 CPU#1 | |
657 | * ---------------------------- -------------------------------- | |
658 | * | |
659 | * 1 STORE event_indicated | |
660 | * 2 queue_work_on() { | |
661 | * 3 test_and_set_bit(PENDING) | |
662 | * 4 } set_..._and_clear_pending() { | |
663 | * 5 set_work_data() # clear bit | |
664 | * 6 smp_mb() | |
665 | * 7 work->current_func() { | |
666 | * 8 LOAD event_indicated | |
667 | * } | |
668 | * | |
669 | * Without an explicit full barrier speculative LOAD on line 8 can | |
670 | * be executed before CPU#0 does STORE on line 1. If that happens, | |
671 | * CPU#0 observes the PENDING bit is still set and new execution of | |
672 | * a @work is not queued in a hope, that CPU#1 will eventually | |
673 | * finish the queued @work. Meanwhile CPU#1 does not see | |
674 | * event_indicated is set, because speculative LOAD was executed | |
675 | * before actual STORE. | |
676 | */ | |
677 | smp_mb(); | |
7a22ad75 | 678 | } |
f756d5e2 | 679 | |
7a22ad75 | 680 | static void clear_work_data(struct work_struct *work) |
1da177e4 | 681 | { |
7c3eed5c TH |
682 | smp_wmb(); /* see set_work_pool_and_clear_pending() */ |
683 | set_work_data(work, WORK_STRUCT_NO_POOL, 0); | |
1da177e4 LT |
684 | } |
685 | ||
112202d9 | 686 | static struct pool_workqueue *get_work_pwq(struct work_struct *work) |
b1f4ec17 | 687 | { |
e120153d | 688 | unsigned long data = atomic_long_read(&work->data); |
7a22ad75 | 689 | |
112202d9 | 690 | if (data & WORK_STRUCT_PWQ) |
e120153d TH |
691 | return (void *)(data & WORK_STRUCT_WQ_DATA_MASK); |
692 | else | |
693 | return NULL; | |
4d707b9f ON |
694 | } |
695 | ||
7c3eed5c TH |
696 | /** |
697 | * get_work_pool - return the worker_pool a given work was associated with | |
698 | * @work: the work item of interest | |
699 | * | |
68e13a67 | 700 | * Pools are created and destroyed under wq_pool_mutex, and allows read |
24acfb71 TG |
701 | * access under RCU read lock. As such, this function should be |
702 | * called under wq_pool_mutex or inside of a rcu_read_lock() region. | |
fa1b54e6 TH |
703 | * |
704 | * All fields of the returned pool are accessible as long as the above | |
705 | * mentioned locking is in effect. If the returned pool needs to be used | |
706 | * beyond the critical section, the caller is responsible for ensuring the | |
707 | * returned pool is and stays online. | |
d185af30 YB |
708 | * |
709 | * Return: The worker_pool @work was last associated with. %NULL if none. | |
7c3eed5c TH |
710 | */ |
711 | static struct worker_pool *get_work_pool(struct work_struct *work) | |
365970a1 | 712 | { |
e120153d | 713 | unsigned long data = atomic_long_read(&work->data); |
7c3eed5c | 714 | int pool_id; |
7a22ad75 | 715 | |
68e13a67 | 716 | assert_rcu_or_pool_mutex(); |
fa1b54e6 | 717 | |
112202d9 TH |
718 | if (data & WORK_STRUCT_PWQ) |
719 | return ((struct pool_workqueue *) | |
7c3eed5c | 720 | (data & WORK_STRUCT_WQ_DATA_MASK))->pool; |
7a22ad75 | 721 | |
7c3eed5c TH |
722 | pool_id = data >> WORK_OFFQ_POOL_SHIFT; |
723 | if (pool_id == WORK_OFFQ_POOL_NONE) | |
7a22ad75 TH |
724 | return NULL; |
725 | ||
fa1b54e6 | 726 | return idr_find(&worker_pool_idr, pool_id); |
7c3eed5c TH |
727 | } |
728 | ||
729 | /** | |
730 | * get_work_pool_id - return the worker pool ID a given work is associated with | |
731 | * @work: the work item of interest | |
732 | * | |
d185af30 | 733 | * Return: The worker_pool ID @work was last associated with. |
7c3eed5c TH |
734 | * %WORK_OFFQ_POOL_NONE if none. |
735 | */ | |
736 | static int get_work_pool_id(struct work_struct *work) | |
737 | { | |
54d5b7d0 LJ |
738 | unsigned long data = atomic_long_read(&work->data); |
739 | ||
112202d9 TH |
740 | if (data & WORK_STRUCT_PWQ) |
741 | return ((struct pool_workqueue *) | |
54d5b7d0 | 742 | (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id; |
7c3eed5c | 743 | |
54d5b7d0 | 744 | return data >> WORK_OFFQ_POOL_SHIFT; |
7c3eed5c TH |
745 | } |
746 | ||
bbb68dfa TH |
747 | static void mark_work_canceling(struct work_struct *work) |
748 | { | |
7c3eed5c | 749 | unsigned long pool_id = get_work_pool_id(work); |
bbb68dfa | 750 | |
7c3eed5c TH |
751 | pool_id <<= WORK_OFFQ_POOL_SHIFT; |
752 | set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING); | |
bbb68dfa TH |
753 | } |
754 | ||
755 | static bool work_is_canceling(struct work_struct *work) | |
756 | { | |
757 | unsigned long data = atomic_long_read(&work->data); | |
758 | ||
112202d9 | 759 | return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING); |
bbb68dfa TH |
760 | } |
761 | ||
e22bee78 | 762 | /* |
3270476a TH |
763 | * Policy functions. These define the policies on how the global worker |
764 | * pools are managed. Unless noted otherwise, these functions assume that | |
d565ed63 | 765 | * they're being called with pool->lock held. |
e22bee78 TH |
766 | */ |
767 | ||
63d95a91 | 768 | static bool __need_more_worker(struct worker_pool *pool) |
a848e3b6 | 769 | { |
e19e397a | 770 | return !atomic_read(&pool->nr_running); |
a848e3b6 ON |
771 | } |
772 | ||
4594bf15 | 773 | /* |
e22bee78 TH |
774 | * Need to wake up a worker? Called from anything but currently |
775 | * running workers. | |
974271c4 TH |
776 | * |
777 | * Note that, because unbound workers never contribute to nr_running, this | |
706026c2 | 778 | * function will always return %true for unbound pools as long as the |
974271c4 | 779 | * worklist isn't empty. |
4594bf15 | 780 | */ |
63d95a91 | 781 | static bool need_more_worker(struct worker_pool *pool) |
365970a1 | 782 | { |
63d95a91 | 783 | return !list_empty(&pool->worklist) && __need_more_worker(pool); |
e22bee78 | 784 | } |
4594bf15 | 785 | |
e22bee78 | 786 | /* Can I start working? Called from busy but !running workers. */ |
63d95a91 | 787 | static bool may_start_working(struct worker_pool *pool) |
e22bee78 | 788 | { |
63d95a91 | 789 | return pool->nr_idle; |
e22bee78 TH |
790 | } |
791 | ||
792 | /* Do I need to keep working? Called from currently running workers. */ | |
63d95a91 | 793 | static bool keep_working(struct worker_pool *pool) |
e22bee78 | 794 | { |
e19e397a TH |
795 | return !list_empty(&pool->worklist) && |
796 | atomic_read(&pool->nr_running) <= 1; | |
e22bee78 TH |
797 | } |
798 | ||
799 | /* Do we need a new worker? Called from manager. */ | |
63d95a91 | 800 | static bool need_to_create_worker(struct worker_pool *pool) |
e22bee78 | 801 | { |
63d95a91 | 802 | return need_more_worker(pool) && !may_start_working(pool); |
e22bee78 | 803 | } |
365970a1 | 804 | |
e22bee78 | 805 | /* Do we have too many workers and should some go away? */ |
63d95a91 | 806 | static bool too_many_workers(struct worker_pool *pool) |
e22bee78 | 807 | { |
692b4825 | 808 | bool managing = pool->flags & POOL_MANAGER_ACTIVE; |
63d95a91 TH |
809 | int nr_idle = pool->nr_idle + managing; /* manager is considered idle */ |
810 | int nr_busy = pool->nr_workers - nr_idle; | |
e22bee78 TH |
811 | |
812 | return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; | |
365970a1 DH |
813 | } |
814 | ||
4d707b9f | 815 | /* |
e22bee78 TH |
816 | * Wake up functions. |
817 | */ | |
818 | ||
1037de36 LJ |
819 | /* Return the first idle worker. Safe with preemption disabled */ |
820 | static struct worker *first_idle_worker(struct worker_pool *pool) | |
7e11629d | 821 | { |
63d95a91 | 822 | if (unlikely(list_empty(&pool->idle_list))) |
7e11629d TH |
823 | return NULL; |
824 | ||
63d95a91 | 825 | return list_first_entry(&pool->idle_list, struct worker, entry); |
7e11629d TH |
826 | } |
827 | ||
828 | /** | |
829 | * wake_up_worker - wake up an idle worker | |
63d95a91 | 830 | * @pool: worker pool to wake worker from |
7e11629d | 831 | * |
63d95a91 | 832 | * Wake up the first idle worker of @pool. |
7e11629d TH |
833 | * |
834 | * CONTEXT: | |
d565ed63 | 835 | * spin_lock_irq(pool->lock). |
7e11629d | 836 | */ |
63d95a91 | 837 | static void wake_up_worker(struct worker_pool *pool) |
7e11629d | 838 | { |
1037de36 | 839 | struct worker *worker = first_idle_worker(pool); |
7e11629d TH |
840 | |
841 | if (likely(worker)) | |
842 | wake_up_process(worker->task); | |
843 | } | |
844 | ||
d302f017 | 845 | /** |
6d25be57 | 846 | * wq_worker_running - a worker is running again |
e22bee78 | 847 | * @task: task waking up |
e22bee78 | 848 | * |
6d25be57 | 849 | * This function is called when a worker returns from schedule() |
e22bee78 | 850 | */ |
6d25be57 | 851 | void wq_worker_running(struct task_struct *task) |
e22bee78 TH |
852 | { |
853 | struct worker *worker = kthread_data(task); | |
854 | ||
6d25be57 TG |
855 | if (!worker->sleeping) |
856 | return; | |
857 | if (!(worker->flags & WORKER_NOT_RUNNING)) | |
e19e397a | 858 | atomic_inc(&worker->pool->nr_running); |
6d25be57 | 859 | worker->sleeping = 0; |
e22bee78 TH |
860 | } |
861 | ||
862 | /** | |
863 | * wq_worker_sleeping - a worker is going to sleep | |
864 | * @task: task going to sleep | |
e22bee78 | 865 | * |
6d25be57 TG |
866 | * This function is called from schedule() when a busy worker is |
867 | * going to sleep. | |
e22bee78 | 868 | */ |
6d25be57 | 869 | void wq_worker_sleeping(struct task_struct *task) |
e22bee78 | 870 | { |
6d25be57 | 871 | struct worker *next, *worker = kthread_data(task); |
111c225a | 872 | struct worker_pool *pool; |
e22bee78 | 873 | |
111c225a TH |
874 | /* |
875 | * Rescuers, which may not have all the fields set up like normal | |
876 | * workers, also reach here, let's not access anything before | |
877 | * checking NOT_RUNNING. | |
878 | */ | |
2d64672e | 879 | if (worker->flags & WORKER_NOT_RUNNING) |
6d25be57 | 880 | return; |
e22bee78 | 881 | |
111c225a | 882 | pool = worker->pool; |
111c225a | 883 | |
6d25be57 TG |
884 | if (WARN_ON_ONCE(worker->sleeping)) |
885 | return; | |
886 | ||
887 | worker->sleeping = 1; | |
888 | spin_lock_irq(&pool->lock); | |
e22bee78 TH |
889 | |
890 | /* | |
891 | * The counterpart of the following dec_and_test, implied mb, | |
892 | * worklist not empty test sequence is in insert_work(). | |
893 | * Please read comment there. | |
894 | * | |
628c78e7 TH |
895 | * NOT_RUNNING is clear. This means that we're bound to and |
896 | * running on the local cpu w/ rq lock held and preemption | |
897 | * disabled, which in turn means that none else could be | |
d565ed63 | 898 | * manipulating idle_list, so dereferencing idle_list without pool |
628c78e7 | 899 | * lock is safe. |
e22bee78 | 900 | */ |
e19e397a | 901 | if (atomic_dec_and_test(&pool->nr_running) && |
6d25be57 TG |
902 | !list_empty(&pool->worklist)) { |
903 | next = first_idle_worker(pool); | |
904 | if (next) | |
905 | wake_up_process(next->task); | |
906 | } | |
907 | spin_unlock_irq(&pool->lock); | |
e22bee78 TH |
908 | } |
909 | ||
1b69ac6b JW |
910 | /** |
911 | * wq_worker_last_func - retrieve worker's last work function | |
8194fe94 | 912 | * @task: Task to retrieve last work function of. |
1b69ac6b JW |
913 | * |
914 | * Determine the last function a worker executed. This is called from | |
915 | * the scheduler to get a worker's last known identity. | |
916 | * | |
917 | * CONTEXT: | |
918 | * spin_lock_irq(rq->lock) | |
919 | * | |
4b047002 JW |
920 | * This function is called during schedule() when a kworker is going |
921 | * to sleep. It's used by psi to identify aggregation workers during | |
922 | * dequeuing, to allow periodic aggregation to shut-off when that | |
923 | * worker is the last task in the system or cgroup to go to sleep. | |
924 | * | |
925 | * As this function doesn't involve any workqueue-related locking, it | |
926 | * only returns stable values when called from inside the scheduler's | |
927 | * queuing and dequeuing paths, when @task, which must be a kworker, | |
928 | * is guaranteed to not be processing any works. | |
929 | * | |
1b69ac6b JW |
930 | * Return: |
931 | * The last work function %current executed as a worker, NULL if it | |
932 | * hasn't executed any work yet. | |
933 | */ | |
934 | work_func_t wq_worker_last_func(struct task_struct *task) | |
935 | { | |
936 | struct worker *worker = kthread_data(task); | |
937 | ||
938 | return worker->last_func; | |
939 | } | |
940 | ||
e22bee78 TH |
941 | /** |
942 | * worker_set_flags - set worker flags and adjust nr_running accordingly | |
cb444766 | 943 | * @worker: self |
d302f017 | 944 | * @flags: flags to set |
d302f017 | 945 | * |
228f1d00 | 946 | * Set @flags in @worker->flags and adjust nr_running accordingly. |
d302f017 | 947 | * |
cb444766 | 948 | * CONTEXT: |
d565ed63 | 949 | * spin_lock_irq(pool->lock) |
d302f017 | 950 | */ |
228f1d00 | 951 | static inline void worker_set_flags(struct worker *worker, unsigned int flags) |
d302f017 | 952 | { |
bd7bdd43 | 953 | struct worker_pool *pool = worker->pool; |
e22bee78 | 954 | |
cb444766 TH |
955 | WARN_ON_ONCE(worker->task != current); |
956 | ||
228f1d00 | 957 | /* If transitioning into NOT_RUNNING, adjust nr_running. */ |
e22bee78 TH |
958 | if ((flags & WORKER_NOT_RUNNING) && |
959 | !(worker->flags & WORKER_NOT_RUNNING)) { | |
228f1d00 | 960 | atomic_dec(&pool->nr_running); |
e22bee78 TH |
961 | } |
962 | ||
d302f017 TH |
963 | worker->flags |= flags; |
964 | } | |
965 | ||
966 | /** | |
e22bee78 | 967 | * worker_clr_flags - clear worker flags and adjust nr_running accordingly |
cb444766 | 968 | * @worker: self |
d302f017 TH |
969 | * @flags: flags to clear |
970 | * | |
e22bee78 | 971 | * Clear @flags in @worker->flags and adjust nr_running accordingly. |
d302f017 | 972 | * |
cb444766 | 973 | * CONTEXT: |
d565ed63 | 974 | * spin_lock_irq(pool->lock) |
d302f017 TH |
975 | */ |
976 | static inline void worker_clr_flags(struct worker *worker, unsigned int flags) | |
977 | { | |
63d95a91 | 978 | struct worker_pool *pool = worker->pool; |
e22bee78 TH |
979 | unsigned int oflags = worker->flags; |
980 | ||
cb444766 TH |
981 | WARN_ON_ONCE(worker->task != current); |
982 | ||
d302f017 | 983 | worker->flags &= ~flags; |
e22bee78 | 984 | |
42c025f3 TH |
985 | /* |
986 | * If transitioning out of NOT_RUNNING, increment nr_running. Note | |
987 | * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask | |
988 | * of multiple flags, not a single flag. | |
989 | */ | |
e22bee78 TH |
990 | if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) |
991 | if (!(worker->flags & WORKER_NOT_RUNNING)) | |
e19e397a | 992 | atomic_inc(&pool->nr_running); |
d302f017 TH |
993 | } |
994 | ||
8cca0eea TH |
995 | /** |
996 | * find_worker_executing_work - find worker which is executing a work | |
c9e7cf27 | 997 | * @pool: pool of interest |
8cca0eea TH |
998 | * @work: work to find worker for |
999 | * | |
c9e7cf27 TH |
1000 | * Find a worker which is executing @work on @pool by searching |
1001 | * @pool->busy_hash which is keyed by the address of @work. For a worker | |
a2c1c57b TH |
1002 | * to match, its current execution should match the address of @work and |
1003 | * its work function. This is to avoid unwanted dependency between | |
1004 | * unrelated work executions through a work item being recycled while still | |
1005 | * being executed. | |
1006 | * | |
1007 | * This is a bit tricky. A work item may be freed once its execution | |
1008 | * starts and nothing prevents the freed area from being recycled for | |
1009 | * another work item. If the same work item address ends up being reused | |
1010 | * before the original execution finishes, workqueue will identify the | |
1011 | * recycled work item as currently executing and make it wait until the | |
1012 | * current execution finishes, introducing an unwanted dependency. | |
1013 | * | |
c5aa87bb TH |
1014 | * This function checks the work item address and work function to avoid |
1015 | * false positives. Note that this isn't complete as one may construct a | |
1016 | * work function which can introduce dependency onto itself through a | |
1017 | * recycled work item. Well, if somebody wants to shoot oneself in the | |
1018 | * foot that badly, there's only so much we can do, and if such deadlock | |
1019 | * actually occurs, it should be easy to locate the culprit work function. | |
8cca0eea TH |
1020 | * |
1021 | * CONTEXT: | |
d565ed63 | 1022 | * spin_lock_irq(pool->lock). |
8cca0eea | 1023 | * |
d185af30 YB |
1024 | * Return: |
1025 | * Pointer to worker which is executing @work if found, %NULL | |
8cca0eea | 1026 | * otherwise. |
4d707b9f | 1027 | */ |
c9e7cf27 | 1028 | static struct worker *find_worker_executing_work(struct worker_pool *pool, |
8cca0eea | 1029 | struct work_struct *work) |
4d707b9f | 1030 | { |
42f8570f | 1031 | struct worker *worker; |
42f8570f | 1032 | |
b67bfe0d | 1033 | hash_for_each_possible(pool->busy_hash, worker, hentry, |
a2c1c57b TH |
1034 | (unsigned long)work) |
1035 | if (worker->current_work == work && | |
1036 | worker->current_func == work->func) | |
42f8570f SL |
1037 | return worker; |
1038 | ||
1039 | return NULL; | |
4d707b9f ON |
1040 | } |
1041 | ||
bf4ede01 TH |
1042 | /** |
1043 | * move_linked_works - move linked works to a list | |
1044 | * @work: start of series of works to be scheduled | |
1045 | * @head: target list to append @work to | |
402dd89d | 1046 | * @nextp: out parameter for nested worklist walking |
bf4ede01 TH |
1047 | * |
1048 | * Schedule linked works starting from @work to @head. Work series to | |
1049 | * be scheduled starts at @work and includes any consecutive work with | |
1050 | * WORK_STRUCT_LINKED set in its predecessor. | |
1051 | * | |
1052 | * If @nextp is not NULL, it's updated to point to the next work of | |
1053 | * the last scheduled work. This allows move_linked_works() to be | |
1054 | * nested inside outer list_for_each_entry_safe(). | |
1055 | * | |
1056 | * CONTEXT: | |
d565ed63 | 1057 | * spin_lock_irq(pool->lock). |
bf4ede01 TH |
1058 | */ |
1059 | static void move_linked_works(struct work_struct *work, struct list_head *head, | |
1060 | struct work_struct **nextp) | |
1061 | { | |
1062 | struct work_struct *n; | |
1063 | ||
1064 | /* | |
1065 | * Linked worklist will always end before the end of the list, | |
1066 | * use NULL for list head. | |
1067 | */ | |
1068 | list_for_each_entry_safe_from(work, n, NULL, entry) { | |
1069 | list_move_tail(&work->entry, head); | |
1070 | if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) | |
1071 | break; | |
1072 | } | |
1073 | ||
1074 | /* | |
1075 | * If we're already inside safe list traversal and have moved | |
1076 | * multiple works to the scheduled queue, the next position | |
1077 | * needs to be updated. | |
1078 | */ | |
1079 | if (nextp) | |
1080 | *nextp = n; | |
1081 | } | |
1082 | ||
8864b4e5 TH |
1083 | /** |
1084 | * get_pwq - get an extra reference on the specified pool_workqueue | |
1085 | * @pwq: pool_workqueue to get | |
1086 | * | |
1087 | * Obtain an extra reference on @pwq. The caller should guarantee that | |
1088 | * @pwq has positive refcnt and be holding the matching pool->lock. | |
1089 | */ | |
1090 | static void get_pwq(struct pool_workqueue *pwq) | |
1091 | { | |
1092 | lockdep_assert_held(&pwq->pool->lock); | |
1093 | WARN_ON_ONCE(pwq->refcnt <= 0); | |
1094 | pwq->refcnt++; | |
1095 | } | |
1096 | ||
1097 | /** | |
1098 | * put_pwq - put a pool_workqueue reference | |
1099 | * @pwq: pool_workqueue to put | |
1100 | * | |
1101 | * Drop a reference of @pwq. If its refcnt reaches zero, schedule its | |
1102 | * destruction. The caller should be holding the matching pool->lock. | |
1103 | */ | |
1104 | static void put_pwq(struct pool_workqueue *pwq) | |
1105 | { | |
1106 | lockdep_assert_held(&pwq->pool->lock); | |
1107 | if (likely(--pwq->refcnt)) | |
1108 | return; | |
1109 | if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND))) | |
1110 | return; | |
1111 | /* | |
1112 | * @pwq can't be released under pool->lock, bounce to | |
1113 | * pwq_unbound_release_workfn(). This never recurses on the same | |
1114 | * pool->lock as this path is taken only for unbound workqueues and | |
1115 | * the release work item is scheduled on a per-cpu workqueue. To | |
1116 | * avoid lockdep warning, unbound pool->locks are given lockdep | |
1117 | * subclass of 1 in get_unbound_pool(). | |
1118 | */ | |
1119 | schedule_work(&pwq->unbound_release_work); | |
1120 | } | |
1121 | ||
dce90d47 TH |
1122 | /** |
1123 | * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock | |
1124 | * @pwq: pool_workqueue to put (can be %NULL) | |
1125 | * | |
1126 | * put_pwq() with locking. This function also allows %NULL @pwq. | |
1127 | */ | |
1128 | static void put_pwq_unlocked(struct pool_workqueue *pwq) | |
1129 | { | |
1130 | if (pwq) { | |
1131 | /* | |
24acfb71 | 1132 | * As both pwqs and pools are RCU protected, the |
dce90d47 TH |
1133 | * following lock operations are safe. |
1134 | */ | |
1135 | spin_lock_irq(&pwq->pool->lock); | |
1136 | put_pwq(pwq); | |
1137 | spin_unlock_irq(&pwq->pool->lock); | |
1138 | } | |
1139 | } | |
1140 | ||
112202d9 | 1141 | static void pwq_activate_delayed_work(struct work_struct *work) |
bf4ede01 | 1142 | { |
112202d9 | 1143 | struct pool_workqueue *pwq = get_work_pwq(work); |
bf4ede01 TH |
1144 | |
1145 | trace_workqueue_activate_work(work); | |
82607adc TH |
1146 | if (list_empty(&pwq->pool->worklist)) |
1147 | pwq->pool->watchdog_ts = jiffies; | |
112202d9 | 1148 | move_linked_works(work, &pwq->pool->worklist, NULL); |
bf4ede01 | 1149 | __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work)); |
112202d9 | 1150 | pwq->nr_active++; |
bf4ede01 TH |
1151 | } |
1152 | ||
112202d9 | 1153 | static void pwq_activate_first_delayed(struct pool_workqueue *pwq) |
3aa62497 | 1154 | { |
112202d9 | 1155 | struct work_struct *work = list_first_entry(&pwq->delayed_works, |
3aa62497 LJ |
1156 | struct work_struct, entry); |
1157 | ||
112202d9 | 1158 | pwq_activate_delayed_work(work); |
3aa62497 LJ |
1159 | } |
1160 | ||
bf4ede01 | 1161 | /** |
112202d9 TH |
1162 | * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight |
1163 | * @pwq: pwq of interest | |
bf4ede01 | 1164 | * @color: color of work which left the queue |
bf4ede01 TH |
1165 | * |
1166 | * A work either has completed or is removed from pending queue, | |
112202d9 | 1167 | * decrement nr_in_flight of its pwq and handle workqueue flushing. |
bf4ede01 TH |
1168 | * |
1169 | * CONTEXT: | |
d565ed63 | 1170 | * spin_lock_irq(pool->lock). |
bf4ede01 | 1171 | */ |
112202d9 | 1172 | static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color) |
bf4ede01 | 1173 | { |
8864b4e5 | 1174 | /* uncolored work items don't participate in flushing or nr_active */ |
bf4ede01 | 1175 | if (color == WORK_NO_COLOR) |
8864b4e5 | 1176 | goto out_put; |
bf4ede01 | 1177 | |
112202d9 | 1178 | pwq->nr_in_flight[color]--; |
bf4ede01 | 1179 | |
112202d9 TH |
1180 | pwq->nr_active--; |
1181 | if (!list_empty(&pwq->delayed_works)) { | |
b3f9f405 | 1182 | /* one down, submit a delayed one */ |
112202d9 TH |
1183 | if (pwq->nr_active < pwq->max_active) |
1184 | pwq_activate_first_delayed(pwq); | |
bf4ede01 TH |
1185 | } |
1186 | ||
1187 | /* is flush in progress and are we at the flushing tip? */ | |
112202d9 | 1188 | if (likely(pwq->flush_color != color)) |
8864b4e5 | 1189 | goto out_put; |
bf4ede01 TH |
1190 | |
1191 | /* are there still in-flight works? */ | |
112202d9 | 1192 | if (pwq->nr_in_flight[color]) |
8864b4e5 | 1193 | goto out_put; |
bf4ede01 | 1194 | |
112202d9 TH |
1195 | /* this pwq is done, clear flush_color */ |
1196 | pwq->flush_color = -1; | |
bf4ede01 TH |
1197 | |
1198 | /* | |
112202d9 | 1199 | * If this was the last pwq, wake up the first flusher. It |
bf4ede01 TH |
1200 | * will handle the rest. |
1201 | */ | |
112202d9 TH |
1202 | if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush)) |
1203 | complete(&pwq->wq->first_flusher->done); | |
8864b4e5 TH |
1204 | out_put: |
1205 | put_pwq(pwq); | |
bf4ede01 TH |
1206 | } |
1207 | ||
36e227d2 | 1208 | /** |
bbb68dfa | 1209 | * try_to_grab_pending - steal work item from worklist and disable irq |
36e227d2 TH |
1210 | * @work: work item to steal |
1211 | * @is_dwork: @work is a delayed_work | |
bbb68dfa | 1212 | * @flags: place to store irq state |
36e227d2 TH |
1213 | * |
1214 | * Try to grab PENDING bit of @work. This function can handle @work in any | |
d185af30 | 1215 | * stable state - idle, on timer or on worklist. |
36e227d2 | 1216 | * |
d185af30 | 1217 | * Return: |
36e227d2 TH |
1218 | * 1 if @work was pending and we successfully stole PENDING |
1219 | * 0 if @work was idle and we claimed PENDING | |
1220 | * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry | |
bbb68dfa TH |
1221 | * -ENOENT if someone else is canceling @work, this state may persist |
1222 | * for arbitrarily long | |
36e227d2 | 1223 | * |
d185af30 | 1224 | * Note: |
bbb68dfa | 1225 | * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting |
e0aecdd8 TH |
1226 | * interrupted while holding PENDING and @work off queue, irq must be |
1227 | * disabled on entry. This, combined with delayed_work->timer being | |
1228 | * irqsafe, ensures that we return -EAGAIN for finite short period of time. | |
bbb68dfa TH |
1229 | * |
1230 | * On successful return, >= 0, irq is disabled and the caller is | |
1231 | * responsible for releasing it using local_irq_restore(*@flags). | |
1232 | * | |
e0aecdd8 | 1233 | * This function is safe to call from any context including IRQ handler. |
bf4ede01 | 1234 | */ |
bbb68dfa TH |
1235 | static int try_to_grab_pending(struct work_struct *work, bool is_dwork, |
1236 | unsigned long *flags) | |
bf4ede01 | 1237 | { |
d565ed63 | 1238 | struct worker_pool *pool; |
112202d9 | 1239 | struct pool_workqueue *pwq; |
bf4ede01 | 1240 | |
bbb68dfa TH |
1241 | local_irq_save(*flags); |
1242 | ||
36e227d2 TH |
1243 | /* try to steal the timer if it exists */ |
1244 | if (is_dwork) { | |
1245 | struct delayed_work *dwork = to_delayed_work(work); | |
1246 | ||
e0aecdd8 TH |
1247 | /* |
1248 | * dwork->timer is irqsafe. If del_timer() fails, it's | |
1249 | * guaranteed that the timer is not queued anywhere and not | |
1250 | * running on the local CPU. | |
1251 | */ | |
36e227d2 TH |
1252 | if (likely(del_timer(&dwork->timer))) |
1253 | return 1; | |
1254 | } | |
1255 | ||
1256 | /* try to claim PENDING the normal way */ | |
bf4ede01 TH |
1257 | if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) |
1258 | return 0; | |
1259 | ||
24acfb71 | 1260 | rcu_read_lock(); |
bf4ede01 TH |
1261 | /* |
1262 | * The queueing is in progress, or it is already queued. Try to | |
1263 | * steal it from ->worklist without clearing WORK_STRUCT_PENDING. | |
1264 | */ | |
d565ed63 TH |
1265 | pool = get_work_pool(work); |
1266 | if (!pool) | |
bbb68dfa | 1267 | goto fail; |
bf4ede01 | 1268 | |
d565ed63 | 1269 | spin_lock(&pool->lock); |
0b3dae68 | 1270 | /* |
112202d9 TH |
1271 | * work->data is guaranteed to point to pwq only while the work |
1272 | * item is queued on pwq->wq, and both updating work->data to point | |
1273 | * to pwq on queueing and to pool on dequeueing are done under | |
1274 | * pwq->pool->lock. This in turn guarantees that, if work->data | |
1275 | * points to pwq which is associated with a locked pool, the work | |
0b3dae68 LJ |
1276 | * item is currently queued on that pool. |
1277 | */ | |
112202d9 TH |
1278 | pwq = get_work_pwq(work); |
1279 | if (pwq && pwq->pool == pool) { | |
16062836 TH |
1280 | debug_work_deactivate(work); |
1281 | ||
1282 | /* | |
1283 | * A delayed work item cannot be grabbed directly because | |
1284 | * it might have linked NO_COLOR work items which, if left | |
112202d9 | 1285 | * on the delayed_list, will confuse pwq->nr_active |
16062836 TH |
1286 | * management later on and cause stall. Make sure the work |
1287 | * item is activated before grabbing. | |
1288 | */ | |
1289 | if (*work_data_bits(work) & WORK_STRUCT_DELAYED) | |
112202d9 | 1290 | pwq_activate_delayed_work(work); |
16062836 TH |
1291 | |
1292 | list_del_init(&work->entry); | |
9c34a704 | 1293 | pwq_dec_nr_in_flight(pwq, get_work_color(work)); |
16062836 | 1294 | |
112202d9 | 1295 | /* work->data points to pwq iff queued, point to pool */ |
16062836 TH |
1296 | set_work_pool_and_keep_pending(work, pool->id); |
1297 | ||
1298 | spin_unlock(&pool->lock); | |
24acfb71 | 1299 | rcu_read_unlock(); |
16062836 | 1300 | return 1; |
bf4ede01 | 1301 | } |
d565ed63 | 1302 | spin_unlock(&pool->lock); |
bbb68dfa | 1303 | fail: |
24acfb71 | 1304 | rcu_read_unlock(); |
bbb68dfa TH |
1305 | local_irq_restore(*flags); |
1306 | if (work_is_canceling(work)) | |
1307 | return -ENOENT; | |
1308 | cpu_relax(); | |
36e227d2 | 1309 | return -EAGAIN; |
bf4ede01 TH |
1310 | } |
1311 | ||
4690c4ab | 1312 | /** |
706026c2 | 1313 | * insert_work - insert a work into a pool |
112202d9 | 1314 | * @pwq: pwq @work belongs to |
4690c4ab TH |
1315 | * @work: work to insert |
1316 | * @head: insertion point | |
1317 | * @extra_flags: extra WORK_STRUCT_* flags to set | |
1318 | * | |
112202d9 | 1319 | * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to |
706026c2 | 1320 | * work_struct flags. |
4690c4ab TH |
1321 | * |
1322 | * CONTEXT: | |
d565ed63 | 1323 | * spin_lock_irq(pool->lock). |
4690c4ab | 1324 | */ |
112202d9 TH |
1325 | static void insert_work(struct pool_workqueue *pwq, struct work_struct *work, |
1326 | struct list_head *head, unsigned int extra_flags) | |
b89deed3 | 1327 | { |
112202d9 | 1328 | struct worker_pool *pool = pwq->pool; |
e22bee78 | 1329 | |
4690c4ab | 1330 | /* we own @work, set data and link */ |
112202d9 | 1331 | set_work_pwq(work, pwq, extra_flags); |
1a4d9b0a | 1332 | list_add_tail(&work->entry, head); |
8864b4e5 | 1333 | get_pwq(pwq); |
e22bee78 TH |
1334 | |
1335 | /* | |
c5aa87bb TH |
1336 | * Ensure either wq_worker_sleeping() sees the above |
1337 | * list_add_tail() or we see zero nr_running to avoid workers lying | |
1338 | * around lazily while there are works to be processed. | |
e22bee78 TH |
1339 | */ |
1340 | smp_mb(); | |
1341 | ||
63d95a91 TH |
1342 | if (__need_more_worker(pool)) |
1343 | wake_up_worker(pool); | |
b89deed3 ON |
1344 | } |
1345 | ||
c8efcc25 TH |
1346 | /* |
1347 | * Test whether @work is being queued from another work executing on the | |
8d03ecfe | 1348 | * same workqueue. |
c8efcc25 TH |
1349 | */ |
1350 | static bool is_chained_work(struct workqueue_struct *wq) | |
1351 | { | |
8d03ecfe TH |
1352 | struct worker *worker; |
1353 | ||
1354 | worker = current_wq_worker(); | |
1355 | /* | |
bf393fd4 | 1356 | * Return %true iff I'm a worker executing a work item on @wq. If |
8d03ecfe TH |
1357 | * I'm @worker, it's safe to dereference it without locking. |
1358 | */ | |
112202d9 | 1359 | return worker && worker->current_pwq->wq == wq; |
c8efcc25 TH |
1360 | } |
1361 | ||
ef557180 MG |
1362 | /* |
1363 | * When queueing an unbound work item to a wq, prefer local CPU if allowed | |
1364 | * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to | |
1365 | * avoid perturbing sensitive tasks. | |
1366 | */ | |
1367 | static int wq_select_unbound_cpu(int cpu) | |
1368 | { | |
f303fccb | 1369 | static bool printed_dbg_warning; |
ef557180 MG |
1370 | int new_cpu; |
1371 | ||
f303fccb TH |
1372 | if (likely(!wq_debug_force_rr_cpu)) { |
1373 | if (cpumask_test_cpu(cpu, wq_unbound_cpumask)) | |
1374 | return cpu; | |
1375 | } else if (!printed_dbg_warning) { | |
1376 | pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n"); | |
1377 | printed_dbg_warning = true; | |
1378 | } | |
1379 | ||
ef557180 MG |
1380 | if (cpumask_empty(wq_unbound_cpumask)) |
1381 | return cpu; | |
1382 | ||
1383 | new_cpu = __this_cpu_read(wq_rr_cpu_last); | |
1384 | new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask); | |
1385 | if (unlikely(new_cpu >= nr_cpu_ids)) { | |
1386 | new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask); | |
1387 | if (unlikely(new_cpu >= nr_cpu_ids)) | |
1388 | return cpu; | |
1389 | } | |
1390 | __this_cpu_write(wq_rr_cpu_last, new_cpu); | |
1391 | ||
1392 | return new_cpu; | |
1393 | } | |
1394 | ||
d84ff051 | 1395 | static void __queue_work(int cpu, struct workqueue_struct *wq, |
1da177e4 LT |
1396 | struct work_struct *work) |
1397 | { | |
112202d9 | 1398 | struct pool_workqueue *pwq; |
c9178087 | 1399 | struct worker_pool *last_pool; |
1e19ffc6 | 1400 | struct list_head *worklist; |
8a2e8e5d | 1401 | unsigned int work_flags; |
b75cac93 | 1402 | unsigned int req_cpu = cpu; |
8930caba TH |
1403 | |
1404 | /* | |
1405 | * While a work item is PENDING && off queue, a task trying to | |
1406 | * steal the PENDING will busy-loop waiting for it to either get | |
1407 | * queued or lose PENDING. Grabbing PENDING and queueing should | |
1408 | * happen with IRQ disabled. | |
1409 | */ | |
8e8eb730 | 1410 | lockdep_assert_irqs_disabled(); |
1da177e4 | 1411 | |
dc186ad7 | 1412 | debug_work_activate(work); |
1e19ffc6 | 1413 | |
9ef28a73 | 1414 | /* if draining, only works from the same workqueue are allowed */ |
618b01eb | 1415 | if (unlikely(wq->flags & __WQ_DRAINING) && |
c8efcc25 | 1416 | WARN_ON_ONCE(!is_chained_work(wq))) |
e41e704b | 1417 | return; |
24acfb71 | 1418 | rcu_read_lock(); |
9e8cd2f5 | 1419 | retry: |
c9178087 | 1420 | /* pwq which will be used unless @work is executing elsewhere */ |
17a1d7b7 HD |
1421 | if (wq->flags & WQ_UNBOUND) { |
1422 | if (req_cpu == WORK_CPU_UNBOUND) | |
1423 | cpu = wq_select_unbound_cpu(raw_smp_processor_id()); | |
df2d5ae4 | 1424 | pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu)); |
17a1d7b7 HD |
1425 | } else { |
1426 | if (req_cpu == WORK_CPU_UNBOUND) | |
1427 | cpu = raw_smp_processor_id(); | |
1428 | pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); | |
1429 | } | |
dbf2576e | 1430 | |
c9178087 TH |
1431 | /* |
1432 | * If @work was previously on a different pool, it might still be | |
1433 | * running there, in which case the work needs to be queued on that | |
1434 | * pool to guarantee non-reentrancy. | |
1435 | */ | |
1436 | last_pool = get_work_pool(work); | |
1437 | if (last_pool && last_pool != pwq->pool) { | |
1438 | struct worker *worker; | |
18aa9eff | 1439 | |
c9178087 | 1440 | spin_lock(&last_pool->lock); |
18aa9eff | 1441 | |
c9178087 | 1442 | worker = find_worker_executing_work(last_pool, work); |
18aa9eff | 1443 | |
c9178087 TH |
1444 | if (worker && worker->current_pwq->wq == wq) { |
1445 | pwq = worker->current_pwq; | |
8930caba | 1446 | } else { |
c9178087 TH |
1447 | /* meh... not running there, queue here */ |
1448 | spin_unlock(&last_pool->lock); | |
112202d9 | 1449 | spin_lock(&pwq->pool->lock); |
8930caba | 1450 | } |
f3421797 | 1451 | } else { |
112202d9 | 1452 | spin_lock(&pwq->pool->lock); |
502ca9d8 TH |
1453 | } |
1454 | ||
9e8cd2f5 TH |
1455 | /* |
1456 | * pwq is determined and locked. For unbound pools, we could have | |
1457 | * raced with pwq release and it could already be dead. If its | |
1458 | * refcnt is zero, repeat pwq selection. Note that pwqs never die | |
df2d5ae4 TH |
1459 | * without another pwq replacing it in the numa_pwq_tbl or while |
1460 | * work items are executing on it, so the retrying is guaranteed to | |
9e8cd2f5 TH |
1461 | * make forward-progress. |
1462 | */ | |
1463 | if (unlikely(!pwq->refcnt)) { | |
1464 | if (wq->flags & WQ_UNBOUND) { | |
1465 | spin_unlock(&pwq->pool->lock); | |
1466 | cpu_relax(); | |
1467 | goto retry; | |
1468 | } | |
1469 | /* oops */ | |
1470 | WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt", | |
1471 | wq->name, cpu); | |
1472 | } | |
1473 | ||
112202d9 TH |
1474 | /* pwq determined, queue */ |
1475 | trace_workqueue_queue_work(req_cpu, pwq, work); | |
502ca9d8 | 1476 | |
24acfb71 TG |
1477 | if (WARN_ON(!list_empty(&work->entry))) |
1478 | goto out; | |
1e19ffc6 | 1479 | |
112202d9 TH |
1480 | pwq->nr_in_flight[pwq->work_color]++; |
1481 | work_flags = work_color_to_flags(pwq->work_color); | |
1e19ffc6 | 1482 | |
112202d9 | 1483 | if (likely(pwq->nr_active < pwq->max_active)) { |
cdadf009 | 1484 | trace_workqueue_activate_work(work); |
112202d9 TH |
1485 | pwq->nr_active++; |
1486 | worklist = &pwq->pool->worklist; | |
82607adc TH |
1487 | if (list_empty(worklist)) |
1488 | pwq->pool->watchdog_ts = jiffies; | |
8a2e8e5d TH |
1489 | } else { |
1490 | work_flags |= WORK_STRUCT_DELAYED; | |
112202d9 | 1491 | worklist = &pwq->delayed_works; |
8a2e8e5d | 1492 | } |
1e19ffc6 | 1493 | |
112202d9 | 1494 | insert_work(pwq, work, worklist, work_flags); |
1e19ffc6 | 1495 | |
24acfb71 | 1496 | out: |
112202d9 | 1497 | spin_unlock(&pwq->pool->lock); |
24acfb71 | 1498 | rcu_read_unlock(); |
1da177e4 LT |
1499 | } |
1500 | ||
0fcb78c2 | 1501 | /** |
c1a220e7 ZR |
1502 | * queue_work_on - queue work on specific cpu |
1503 | * @cpu: CPU number to execute work on | |
0fcb78c2 REB |
1504 | * @wq: workqueue to use |
1505 | * @work: work to queue | |
1506 | * | |
c1a220e7 ZR |
1507 | * We queue the work to a specific CPU, the caller must ensure it |
1508 | * can't go away. | |
d185af30 YB |
1509 | * |
1510 | * Return: %false if @work was already on a queue, %true otherwise. | |
1da177e4 | 1511 | */ |
d4283e93 TH |
1512 | bool queue_work_on(int cpu, struct workqueue_struct *wq, |
1513 | struct work_struct *work) | |
1da177e4 | 1514 | { |
d4283e93 | 1515 | bool ret = false; |
8930caba | 1516 | unsigned long flags; |
ef1ca236 | 1517 | |
8930caba | 1518 | local_irq_save(flags); |
c1a220e7 | 1519 | |
22df02bb | 1520 | if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { |
4690c4ab | 1521 | __queue_work(cpu, wq, work); |
d4283e93 | 1522 | ret = true; |
c1a220e7 | 1523 | } |
ef1ca236 | 1524 | |
8930caba | 1525 | local_irq_restore(flags); |
1da177e4 LT |
1526 | return ret; |
1527 | } | |
ad7b1f84 | 1528 | EXPORT_SYMBOL(queue_work_on); |
1da177e4 | 1529 | |
8204e0c1 AD |
1530 | /** |
1531 | * workqueue_select_cpu_near - Select a CPU based on NUMA node | |
1532 | * @node: NUMA node ID that we want to select a CPU from | |
1533 | * | |
1534 | * This function will attempt to find a "random" cpu available on a given | |
1535 | * node. If there are no CPUs available on the given node it will return | |
1536 | * WORK_CPU_UNBOUND indicating that we should just schedule to any | |
1537 | * available CPU if we need to schedule this work. | |
1538 | */ | |
1539 | static int workqueue_select_cpu_near(int node) | |
1540 | { | |
1541 | int cpu; | |
1542 | ||
1543 | /* No point in doing this if NUMA isn't enabled for workqueues */ | |
1544 | if (!wq_numa_enabled) | |
1545 | return WORK_CPU_UNBOUND; | |
1546 | ||
1547 | /* Delay binding to CPU if node is not valid or online */ | |
1548 | if (node < 0 || node >= MAX_NUMNODES || !node_online(node)) | |
1549 | return WORK_CPU_UNBOUND; | |
1550 | ||
1551 | /* Use local node/cpu if we are already there */ | |
1552 | cpu = raw_smp_processor_id(); | |
1553 | if (node == cpu_to_node(cpu)) | |
1554 | return cpu; | |
1555 | ||
1556 | /* Use "random" otherwise know as "first" online CPU of node */ | |
1557 | cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask); | |
1558 | ||
1559 | /* If CPU is valid return that, otherwise just defer */ | |
1560 | return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND; | |
1561 | } | |
1562 | ||
1563 | /** | |
1564 | * queue_work_node - queue work on a "random" cpu for a given NUMA node | |
1565 | * @node: NUMA node that we are targeting the work for | |
1566 | * @wq: workqueue to use | |
1567 | * @work: work to queue | |
1568 | * | |
1569 | * We queue the work to a "random" CPU within a given NUMA node. The basic | |
1570 | * idea here is to provide a way to somehow associate work with a given | |
1571 | * NUMA node. | |
1572 | * | |
1573 | * This function will only make a best effort attempt at getting this onto | |
1574 | * the right NUMA node. If no node is requested or the requested node is | |
1575 | * offline then we just fall back to standard queue_work behavior. | |
1576 | * | |
1577 | * Currently the "random" CPU ends up being the first available CPU in the | |
1578 | * intersection of cpu_online_mask and the cpumask of the node, unless we | |
1579 | * are running on the node. In that case we just use the current CPU. | |
1580 | * | |
1581 | * Return: %false if @work was already on a queue, %true otherwise. | |
1582 | */ | |
1583 | bool queue_work_node(int node, struct workqueue_struct *wq, | |
1584 | struct work_struct *work) | |
1585 | { | |
1586 | unsigned long flags; | |
1587 | bool ret = false; | |
1588 | ||
1589 | /* | |
1590 | * This current implementation is specific to unbound workqueues. | |
1591 | * Specifically we only return the first available CPU for a given | |
1592 | * node instead of cycling through individual CPUs within the node. | |
1593 | * | |
1594 | * If this is used with a per-cpu workqueue then the logic in | |
1595 | * workqueue_select_cpu_near would need to be updated to allow for | |
1596 | * some round robin type logic. | |
1597 | */ | |
1598 | WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)); | |
1599 | ||
1600 | local_irq_save(flags); | |
1601 | ||
1602 | if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { | |
1603 | int cpu = workqueue_select_cpu_near(node); | |
1604 | ||
1605 | __queue_work(cpu, wq, work); | |
1606 | ret = true; | |
1607 | } | |
1608 | ||
1609 | local_irq_restore(flags); | |
1610 | return ret; | |
1611 | } | |
1612 | EXPORT_SYMBOL_GPL(queue_work_node); | |
1613 | ||
8c20feb6 | 1614 | void delayed_work_timer_fn(struct timer_list *t) |
1da177e4 | 1615 | { |
8c20feb6 | 1616 | struct delayed_work *dwork = from_timer(dwork, t, timer); |
1da177e4 | 1617 | |
e0aecdd8 | 1618 | /* should have been called from irqsafe timer with irq already off */ |
60c057bc | 1619 | __queue_work(dwork->cpu, dwork->wq, &dwork->work); |
1da177e4 | 1620 | } |
1438ade5 | 1621 | EXPORT_SYMBOL(delayed_work_timer_fn); |
1da177e4 | 1622 | |
7beb2edf TH |
1623 | static void __queue_delayed_work(int cpu, struct workqueue_struct *wq, |
1624 | struct delayed_work *dwork, unsigned long delay) | |
1da177e4 | 1625 | { |
7beb2edf TH |
1626 | struct timer_list *timer = &dwork->timer; |
1627 | struct work_struct *work = &dwork->work; | |
7beb2edf | 1628 | |
637fdbae | 1629 | WARN_ON_ONCE(!wq); |
841b86f3 | 1630 | WARN_ON_ONCE(timer->function != delayed_work_timer_fn); |
fc4b514f TH |
1631 | WARN_ON_ONCE(timer_pending(timer)); |
1632 | WARN_ON_ONCE(!list_empty(&work->entry)); | |
7beb2edf | 1633 | |
8852aac2 TH |
1634 | /* |
1635 | * If @delay is 0, queue @dwork->work immediately. This is for | |
1636 | * both optimization and correctness. The earliest @timer can | |
1637 | * expire is on the closest next tick and delayed_work users depend | |
1638 | * on that there's no such delay when @delay is 0. | |
1639 | */ | |
1640 | if (!delay) { | |
1641 | __queue_work(cpu, wq, &dwork->work); | |
1642 | return; | |
1643 | } | |
1644 | ||
60c057bc | 1645 | dwork->wq = wq; |
1265057f | 1646 | dwork->cpu = cpu; |
7beb2edf TH |
1647 | timer->expires = jiffies + delay; |
1648 | ||
041bd12e TH |
1649 | if (unlikely(cpu != WORK_CPU_UNBOUND)) |
1650 | add_timer_on(timer, cpu); | |
1651 | else | |
1652 | add_timer(timer); | |
1da177e4 LT |
1653 | } |
1654 | ||
0fcb78c2 REB |
1655 | /** |
1656 | * queue_delayed_work_on - queue work on specific CPU after delay | |
1657 | * @cpu: CPU number to execute work on | |
1658 | * @wq: workqueue to use | |
af9997e4 | 1659 | * @dwork: work to queue |
0fcb78c2 REB |
1660 | * @delay: number of jiffies to wait before queueing |
1661 | * | |
d185af30 | 1662 | * Return: %false if @work was already on a queue, %true otherwise. If |
715f1300 TH |
1663 | * @delay is zero and @dwork is idle, it will be scheduled for immediate |
1664 | * execution. | |
0fcb78c2 | 1665 | */ |
d4283e93 TH |
1666 | bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, |
1667 | struct delayed_work *dwork, unsigned long delay) | |
7a6bc1cd | 1668 | { |
52bad64d | 1669 | struct work_struct *work = &dwork->work; |
d4283e93 | 1670 | bool ret = false; |
8930caba | 1671 | unsigned long flags; |
7a6bc1cd | 1672 | |
8930caba TH |
1673 | /* read the comment in __queue_work() */ |
1674 | local_irq_save(flags); | |
7a6bc1cd | 1675 | |
22df02bb | 1676 | if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { |
7beb2edf | 1677 | __queue_delayed_work(cpu, wq, dwork, delay); |
d4283e93 | 1678 | ret = true; |
7a6bc1cd | 1679 | } |
8a3e77cc | 1680 | |
8930caba | 1681 | local_irq_restore(flags); |
7a6bc1cd VP |
1682 | return ret; |
1683 | } | |
ad7b1f84 | 1684 | EXPORT_SYMBOL(queue_delayed_work_on); |
c7fc77f7 | 1685 | |
8376fe22 TH |
1686 | /** |
1687 | * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU | |
1688 | * @cpu: CPU number to execute work on | |
1689 | * @wq: workqueue to use | |
1690 | * @dwork: work to queue | |
1691 | * @delay: number of jiffies to wait before queueing | |
1692 | * | |
1693 | * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise, | |
1694 | * modify @dwork's timer so that it expires after @delay. If @delay is | |
1695 | * zero, @work is guaranteed to be scheduled immediately regardless of its | |
1696 | * current state. | |
1697 | * | |
d185af30 | 1698 | * Return: %false if @dwork was idle and queued, %true if @dwork was |
8376fe22 TH |
1699 | * pending and its timer was modified. |
1700 | * | |
e0aecdd8 | 1701 | * This function is safe to call from any context including IRQ handler. |
8376fe22 TH |
1702 | * See try_to_grab_pending() for details. |
1703 | */ | |
1704 | bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, | |
1705 | struct delayed_work *dwork, unsigned long delay) | |
1706 | { | |
1707 | unsigned long flags; | |
1708 | int ret; | |
c7fc77f7 | 1709 | |
8376fe22 TH |
1710 | do { |
1711 | ret = try_to_grab_pending(&dwork->work, true, &flags); | |
1712 | } while (unlikely(ret == -EAGAIN)); | |
63bc0362 | 1713 | |
8376fe22 TH |
1714 | if (likely(ret >= 0)) { |
1715 | __queue_delayed_work(cpu, wq, dwork, delay); | |
1716 | local_irq_restore(flags); | |
7a6bc1cd | 1717 | } |
8376fe22 TH |
1718 | |
1719 | /* -ENOENT from try_to_grab_pending() becomes %true */ | |
7a6bc1cd VP |
1720 | return ret; |
1721 | } | |
8376fe22 TH |
1722 | EXPORT_SYMBOL_GPL(mod_delayed_work_on); |
1723 | ||
05f0fe6b TH |
1724 | static void rcu_work_rcufn(struct rcu_head *rcu) |
1725 | { | |
1726 | struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu); | |
1727 | ||
1728 | /* read the comment in __queue_work() */ | |
1729 | local_irq_disable(); | |
1730 | __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work); | |
1731 | local_irq_enable(); | |
1732 | } | |
1733 | ||
1734 | /** | |
1735 | * queue_rcu_work - queue work after a RCU grace period | |
1736 | * @wq: workqueue to use | |
1737 | * @rwork: work to queue | |
1738 | * | |
1739 | * Return: %false if @rwork was already pending, %true otherwise. Note | |
1740 | * that a full RCU grace period is guaranteed only after a %true return. | |
bf393fd4 | 1741 | * While @rwork is guaranteed to be executed after a %false return, the |
05f0fe6b TH |
1742 | * execution may happen before a full RCU grace period has passed. |
1743 | */ | |
1744 | bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork) | |
1745 | { | |
1746 | struct work_struct *work = &rwork->work; | |
1747 | ||
1748 | if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { | |
1749 | rwork->wq = wq; | |
1750 | call_rcu(&rwork->rcu, rcu_work_rcufn); | |
1751 | return true; | |
1752 | } | |
1753 | ||
1754 | return false; | |
1755 | } | |
1756 | EXPORT_SYMBOL(queue_rcu_work); | |
1757 | ||
c8e55f36 TH |
1758 | /** |
1759 | * worker_enter_idle - enter idle state | |
1760 | * @worker: worker which is entering idle state | |
1761 | * | |
1762 | * @worker is entering idle state. Update stats and idle timer if | |
1763 | * necessary. | |
1764 | * | |
1765 | * LOCKING: | |
d565ed63 | 1766 | * spin_lock_irq(pool->lock). |
c8e55f36 TH |
1767 | */ |
1768 | static void worker_enter_idle(struct worker *worker) | |
1da177e4 | 1769 | { |
bd7bdd43 | 1770 | struct worker_pool *pool = worker->pool; |
c8e55f36 | 1771 | |
6183c009 TH |
1772 | if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) || |
1773 | WARN_ON_ONCE(!list_empty(&worker->entry) && | |
1774 | (worker->hentry.next || worker->hentry.pprev))) | |
1775 | return; | |
c8e55f36 | 1776 | |
051e1850 | 1777 | /* can't use worker_set_flags(), also called from create_worker() */ |
cb444766 | 1778 | worker->flags |= WORKER_IDLE; |
bd7bdd43 | 1779 | pool->nr_idle++; |
e22bee78 | 1780 | worker->last_active = jiffies; |
c8e55f36 TH |
1781 | |
1782 | /* idle_list is LIFO */ | |
bd7bdd43 | 1783 | list_add(&worker->entry, &pool->idle_list); |
db7bccf4 | 1784 | |
628c78e7 TH |
1785 | if (too_many_workers(pool) && !timer_pending(&pool->idle_timer)) |
1786 | mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT); | |
cb444766 | 1787 | |
544ecf31 | 1788 | /* |
e8b3f8db | 1789 | * Sanity check nr_running. Because unbind_workers() releases |
d565ed63 | 1790 | * pool->lock between setting %WORKER_UNBOUND and zapping |
628c78e7 TH |
1791 | * nr_running, the warning may trigger spuriously. Check iff |
1792 | * unbind is not in progress. | |
544ecf31 | 1793 | */ |
24647570 | 1794 | WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && |
bd7bdd43 | 1795 | pool->nr_workers == pool->nr_idle && |
e19e397a | 1796 | atomic_read(&pool->nr_running)); |
c8e55f36 TH |
1797 | } |
1798 | ||
1799 | /** | |
1800 | * worker_leave_idle - leave idle state | |
1801 | * @worker: worker which is leaving idle state | |
1802 | * | |
1803 | * @worker is leaving idle state. Update stats. | |
1804 | * | |
1805 | * LOCKING: | |
d565ed63 | 1806 | * spin_lock_irq(pool->lock). |
c8e55f36 TH |
1807 | */ |
1808 | static void worker_leave_idle(struct worker *worker) | |
1809 | { | |
bd7bdd43 | 1810 | struct worker_pool *pool = worker->pool; |
c8e55f36 | 1811 | |
6183c009 TH |
1812 | if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE))) |
1813 | return; | |
d302f017 | 1814 | worker_clr_flags(worker, WORKER_IDLE); |
bd7bdd43 | 1815 | pool->nr_idle--; |
c8e55f36 TH |
1816 | list_del_init(&worker->entry); |
1817 | } | |
1818 | ||
f7537df5 | 1819 | static struct worker *alloc_worker(int node) |
c34056a3 TH |
1820 | { |
1821 | struct worker *worker; | |
1822 | ||
f7537df5 | 1823 | worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node); |
c8e55f36 TH |
1824 | if (worker) { |
1825 | INIT_LIST_HEAD(&worker->entry); | |
affee4b2 | 1826 | INIT_LIST_HEAD(&worker->scheduled); |
da028469 | 1827 | INIT_LIST_HEAD(&worker->node); |
e22bee78 TH |
1828 | /* on creation a worker is in !idle && prep state */ |
1829 | worker->flags = WORKER_PREP; | |
c8e55f36 | 1830 | } |
c34056a3 TH |
1831 | return worker; |
1832 | } | |
1833 | ||
4736cbf7 LJ |
1834 | /** |
1835 | * worker_attach_to_pool() - attach a worker to a pool | |
1836 | * @worker: worker to be attached | |
1837 | * @pool: the target pool | |
1838 | * | |
1839 | * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and | |
1840 | * cpu-binding of @worker are kept coordinated with the pool across | |
1841 | * cpu-[un]hotplugs. | |
1842 | */ | |
1843 | static void worker_attach_to_pool(struct worker *worker, | |
1844 | struct worker_pool *pool) | |
1845 | { | |
1258fae7 | 1846 | mutex_lock(&wq_pool_attach_mutex); |
4736cbf7 LJ |
1847 | |
1848 | /* | |
1849 | * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any | |
1850 | * online CPUs. It'll be re-applied when any of the CPUs come up. | |
1851 | */ | |
1852 | set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask); | |
1853 | ||
1854 | /* | |
1258fae7 TH |
1855 | * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains |
1856 | * stable across this function. See the comments above the flag | |
1857 | * definition for details. | |
4736cbf7 LJ |
1858 | */ |
1859 | if (pool->flags & POOL_DISASSOCIATED) | |
1860 | worker->flags |= WORKER_UNBOUND; | |
1861 | ||
1862 | list_add_tail(&worker->node, &pool->workers); | |
a2d812a2 | 1863 | worker->pool = pool; |
4736cbf7 | 1864 | |
1258fae7 | 1865 | mutex_unlock(&wq_pool_attach_mutex); |
4736cbf7 LJ |
1866 | } |
1867 | ||
60f5a4bc LJ |
1868 | /** |
1869 | * worker_detach_from_pool() - detach a worker from its pool | |
1870 | * @worker: worker which is attached to its pool | |
60f5a4bc | 1871 | * |
4736cbf7 LJ |
1872 | * Undo the attaching which had been done in worker_attach_to_pool(). The |
1873 | * caller worker shouldn't access to the pool after detached except it has | |
1874 | * other reference to the pool. | |
60f5a4bc | 1875 | */ |
a2d812a2 | 1876 | static void worker_detach_from_pool(struct worker *worker) |
60f5a4bc | 1877 | { |
a2d812a2 | 1878 | struct worker_pool *pool = worker->pool; |
60f5a4bc LJ |
1879 | struct completion *detach_completion = NULL; |
1880 | ||
1258fae7 | 1881 | mutex_lock(&wq_pool_attach_mutex); |
a2d812a2 | 1882 | |
da028469 | 1883 | list_del(&worker->node); |
a2d812a2 TH |
1884 | worker->pool = NULL; |
1885 | ||
da028469 | 1886 | if (list_empty(&pool->workers)) |
60f5a4bc | 1887 | detach_completion = pool->detach_completion; |
1258fae7 | 1888 | mutex_unlock(&wq_pool_attach_mutex); |
60f5a4bc | 1889 | |
b62c0751 LJ |
1890 | /* clear leftover flags without pool->lock after it is detached */ |
1891 | worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND); | |
1892 | ||
60f5a4bc LJ |
1893 | if (detach_completion) |
1894 | complete(detach_completion); | |
1895 | } | |
1896 | ||
c34056a3 TH |
1897 | /** |
1898 | * create_worker - create a new workqueue worker | |
63d95a91 | 1899 | * @pool: pool the new worker will belong to |
c34056a3 | 1900 | * |
051e1850 | 1901 | * Create and start a new worker which is attached to @pool. |
c34056a3 TH |
1902 | * |
1903 | * CONTEXT: | |
1904 | * Might sleep. Does GFP_KERNEL allocations. | |
1905 | * | |
d185af30 | 1906 | * Return: |
c34056a3 TH |
1907 | * Pointer to the newly created worker. |
1908 | */ | |
bc2ae0f5 | 1909 | static struct worker *create_worker(struct worker_pool *pool) |
c34056a3 | 1910 | { |
c34056a3 | 1911 | struct worker *worker = NULL; |
f3421797 | 1912 | int id = -1; |
e3c916a4 | 1913 | char id_buf[16]; |
c34056a3 | 1914 | |
7cda9aae LJ |
1915 | /* ID is needed to determine kthread name */ |
1916 | id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL); | |
822d8405 TH |
1917 | if (id < 0) |
1918 | goto fail; | |
c34056a3 | 1919 | |
f7537df5 | 1920 | worker = alloc_worker(pool->node); |
c34056a3 TH |
1921 | if (!worker) |
1922 | goto fail; | |
1923 | ||
c34056a3 TH |
1924 | worker->id = id; |
1925 | ||
29c91e99 | 1926 | if (pool->cpu >= 0) |
e3c916a4 TH |
1927 | snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id, |
1928 | pool->attrs->nice < 0 ? "H" : ""); | |
f3421797 | 1929 | else |
e3c916a4 TH |
1930 | snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id); |
1931 | ||
f3f90ad4 | 1932 | worker->task = kthread_create_on_node(worker_thread, worker, pool->node, |
e3c916a4 | 1933 | "kworker/%s", id_buf); |
c34056a3 TH |
1934 | if (IS_ERR(worker->task)) |
1935 | goto fail; | |
1936 | ||
91151228 | 1937 | set_user_nice(worker->task, pool->attrs->nice); |
25834c73 | 1938 | kthread_bind_mask(worker->task, pool->attrs->cpumask); |
91151228 | 1939 | |
da028469 | 1940 | /* successful, attach the worker to the pool */ |
4736cbf7 | 1941 | worker_attach_to_pool(worker, pool); |
822d8405 | 1942 | |
051e1850 LJ |
1943 | /* start the newly created worker */ |
1944 | spin_lock_irq(&pool->lock); | |
1945 | worker->pool->nr_workers++; | |
1946 | worker_enter_idle(worker); | |
1947 | wake_up_process(worker->task); | |
1948 | spin_unlock_irq(&pool->lock); | |
1949 | ||
c34056a3 | 1950 | return worker; |
822d8405 | 1951 | |
c34056a3 | 1952 | fail: |
9625ab17 | 1953 | if (id >= 0) |
7cda9aae | 1954 | ida_simple_remove(&pool->worker_ida, id); |
c34056a3 TH |
1955 | kfree(worker); |
1956 | return NULL; | |
1957 | } | |
1958 | ||
c34056a3 TH |
1959 | /** |
1960 | * destroy_worker - destroy a workqueue worker | |
1961 | * @worker: worker to be destroyed | |
1962 | * | |
73eb7fe7 LJ |
1963 | * Destroy @worker and adjust @pool stats accordingly. The worker should |
1964 | * be idle. | |
c8e55f36 TH |
1965 | * |
1966 | * CONTEXT: | |
60f5a4bc | 1967 | * spin_lock_irq(pool->lock). |
c34056a3 TH |
1968 | */ |
1969 | static void destroy_worker(struct worker *worker) | |
1970 | { | |
bd7bdd43 | 1971 | struct worker_pool *pool = worker->pool; |
c34056a3 | 1972 | |
cd549687 TH |
1973 | lockdep_assert_held(&pool->lock); |
1974 | ||
c34056a3 | 1975 | /* sanity check frenzy */ |
6183c009 | 1976 | if (WARN_ON(worker->current_work) || |
73eb7fe7 LJ |
1977 | WARN_ON(!list_empty(&worker->scheduled)) || |
1978 | WARN_ON(!(worker->flags & WORKER_IDLE))) | |
6183c009 | 1979 | return; |
c34056a3 | 1980 | |
73eb7fe7 LJ |
1981 | pool->nr_workers--; |
1982 | pool->nr_idle--; | |
5bdfff96 | 1983 | |
c8e55f36 | 1984 | list_del_init(&worker->entry); |
cb444766 | 1985 | worker->flags |= WORKER_DIE; |
60f5a4bc | 1986 | wake_up_process(worker->task); |
c34056a3 TH |
1987 | } |
1988 | ||
32a6c723 | 1989 | static void idle_worker_timeout(struct timer_list *t) |
e22bee78 | 1990 | { |
32a6c723 | 1991 | struct worker_pool *pool = from_timer(pool, t, idle_timer); |
e22bee78 | 1992 | |
d565ed63 | 1993 | spin_lock_irq(&pool->lock); |
e22bee78 | 1994 | |
3347fc9f | 1995 | while (too_many_workers(pool)) { |
e22bee78 TH |
1996 | struct worker *worker; |
1997 | unsigned long expires; | |
1998 | ||
1999 | /* idle_list is kept in LIFO order, check the last one */ | |
63d95a91 | 2000 | worker = list_entry(pool->idle_list.prev, struct worker, entry); |
e22bee78 TH |
2001 | expires = worker->last_active + IDLE_WORKER_TIMEOUT; |
2002 | ||
3347fc9f | 2003 | if (time_before(jiffies, expires)) { |
63d95a91 | 2004 | mod_timer(&pool->idle_timer, expires); |
3347fc9f | 2005 | break; |
d5abe669 | 2006 | } |
3347fc9f LJ |
2007 | |
2008 | destroy_worker(worker); | |
e22bee78 TH |
2009 | } |
2010 | ||
d565ed63 | 2011 | spin_unlock_irq(&pool->lock); |
e22bee78 | 2012 | } |
d5abe669 | 2013 | |
493a1724 | 2014 | static void send_mayday(struct work_struct *work) |
e22bee78 | 2015 | { |
112202d9 TH |
2016 | struct pool_workqueue *pwq = get_work_pwq(work); |
2017 | struct workqueue_struct *wq = pwq->wq; | |
493a1724 | 2018 | |
2e109a28 | 2019 | lockdep_assert_held(&wq_mayday_lock); |
e22bee78 | 2020 | |
493008a8 | 2021 | if (!wq->rescuer) |
493a1724 | 2022 | return; |
e22bee78 TH |
2023 | |
2024 | /* mayday mayday mayday */ | |
493a1724 | 2025 | if (list_empty(&pwq->mayday_node)) { |
77668c8b LJ |
2026 | /* |
2027 | * If @pwq is for an unbound wq, its base ref may be put at | |
2028 | * any time due to an attribute change. Pin @pwq until the | |
2029 | * rescuer is done with it. | |
2030 | */ | |
2031 | get_pwq(pwq); | |
493a1724 | 2032 | list_add_tail(&pwq->mayday_node, &wq->maydays); |
e22bee78 | 2033 | wake_up_process(wq->rescuer->task); |
493a1724 | 2034 | } |
e22bee78 TH |
2035 | } |
2036 | ||
32a6c723 | 2037 | static void pool_mayday_timeout(struct timer_list *t) |
e22bee78 | 2038 | { |
32a6c723 | 2039 | struct worker_pool *pool = from_timer(pool, t, mayday_timer); |
e22bee78 TH |
2040 | struct work_struct *work; |
2041 | ||
b2d82909 TH |
2042 | spin_lock_irq(&pool->lock); |
2043 | spin_lock(&wq_mayday_lock); /* for wq->maydays */ | |
e22bee78 | 2044 | |
63d95a91 | 2045 | if (need_to_create_worker(pool)) { |
e22bee78 TH |
2046 | /* |
2047 | * We've been trying to create a new worker but | |
2048 | * haven't been successful. We might be hitting an | |
2049 | * allocation deadlock. Send distress signals to | |
2050 | * rescuers. | |
2051 | */ | |
63d95a91 | 2052 | list_for_each_entry(work, &pool->worklist, entry) |
e22bee78 | 2053 | send_mayday(work); |
1da177e4 | 2054 | } |
e22bee78 | 2055 | |
b2d82909 TH |
2056 | spin_unlock(&wq_mayday_lock); |
2057 | spin_unlock_irq(&pool->lock); | |
e22bee78 | 2058 | |
63d95a91 | 2059 | mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL); |
1da177e4 LT |
2060 | } |
2061 | ||
e22bee78 TH |
2062 | /** |
2063 | * maybe_create_worker - create a new worker if necessary | |
63d95a91 | 2064 | * @pool: pool to create a new worker for |
e22bee78 | 2065 | * |
63d95a91 | 2066 | * Create a new worker for @pool if necessary. @pool is guaranteed to |
e22bee78 TH |
2067 | * have at least one idle worker on return from this function. If |
2068 | * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is | |
63d95a91 | 2069 | * sent to all rescuers with works scheduled on @pool to resolve |
e22bee78 TH |
2070 | * possible allocation deadlock. |
2071 | * | |
c5aa87bb TH |
2072 | * On return, need_to_create_worker() is guaranteed to be %false and |
2073 | * may_start_working() %true. | |
e22bee78 TH |
2074 | * |
2075 | * LOCKING: | |
d565ed63 | 2076 | * spin_lock_irq(pool->lock) which may be released and regrabbed |
e22bee78 TH |
2077 | * multiple times. Does GFP_KERNEL allocations. Called only from |
2078 | * manager. | |
e22bee78 | 2079 | */ |
29187a9e | 2080 | static void maybe_create_worker(struct worker_pool *pool) |
d565ed63 TH |
2081 | __releases(&pool->lock) |
2082 | __acquires(&pool->lock) | |
1da177e4 | 2083 | { |
e22bee78 | 2084 | restart: |
d565ed63 | 2085 | spin_unlock_irq(&pool->lock); |
9f9c2364 | 2086 | |
e22bee78 | 2087 | /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ |
63d95a91 | 2088 | mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); |
e22bee78 TH |
2089 | |
2090 | while (true) { | |
051e1850 | 2091 | if (create_worker(pool) || !need_to_create_worker(pool)) |
e22bee78 | 2092 | break; |
1da177e4 | 2093 | |
e212f361 | 2094 | schedule_timeout_interruptible(CREATE_COOLDOWN); |
9f9c2364 | 2095 | |
63d95a91 | 2096 | if (!need_to_create_worker(pool)) |
e22bee78 TH |
2097 | break; |
2098 | } | |
2099 | ||
63d95a91 | 2100 | del_timer_sync(&pool->mayday_timer); |
d565ed63 | 2101 | spin_lock_irq(&pool->lock); |
051e1850 LJ |
2102 | /* |
2103 | * This is necessary even after a new worker was just successfully | |
2104 | * created as @pool->lock was dropped and the new worker might have | |
2105 | * already become busy. | |
2106 | */ | |
63d95a91 | 2107 | if (need_to_create_worker(pool)) |
e22bee78 | 2108 | goto restart; |
e22bee78 TH |
2109 | } |
2110 | ||
73f53c4a | 2111 | /** |
e22bee78 TH |
2112 | * manage_workers - manage worker pool |
2113 | * @worker: self | |
73f53c4a | 2114 | * |
706026c2 | 2115 | * Assume the manager role and manage the worker pool @worker belongs |
e22bee78 | 2116 | * to. At any given time, there can be only zero or one manager per |
706026c2 | 2117 | * pool. The exclusion is handled automatically by this function. |
e22bee78 TH |
2118 | * |
2119 | * The caller can safely start processing works on false return. On | |
2120 | * true return, it's guaranteed that need_to_create_worker() is false | |
2121 | * and may_start_working() is true. | |
73f53c4a TH |
2122 | * |
2123 | * CONTEXT: | |
d565ed63 | 2124 | * spin_lock_irq(pool->lock) which may be released and regrabbed |
e22bee78 TH |
2125 | * multiple times. Does GFP_KERNEL allocations. |
2126 | * | |
d185af30 | 2127 | * Return: |
29187a9e TH |
2128 | * %false if the pool doesn't need management and the caller can safely |
2129 | * start processing works, %true if management function was performed and | |
2130 | * the conditions that the caller verified before calling the function may | |
2131 | * no longer be true. | |
73f53c4a | 2132 | */ |
e22bee78 | 2133 | static bool manage_workers(struct worker *worker) |
73f53c4a | 2134 | { |
63d95a91 | 2135 | struct worker_pool *pool = worker->pool; |
73f53c4a | 2136 | |
692b4825 | 2137 | if (pool->flags & POOL_MANAGER_ACTIVE) |
29187a9e | 2138 | return false; |
692b4825 TH |
2139 | |
2140 | pool->flags |= POOL_MANAGER_ACTIVE; | |
2607d7a6 | 2141 | pool->manager = worker; |
1e19ffc6 | 2142 | |
29187a9e | 2143 | maybe_create_worker(pool); |
e22bee78 | 2144 | |
2607d7a6 | 2145 | pool->manager = NULL; |
692b4825 TH |
2146 | pool->flags &= ~POOL_MANAGER_ACTIVE; |
2147 | wake_up(&wq_manager_wait); | |
29187a9e | 2148 | return true; |
73f53c4a TH |
2149 | } |
2150 | ||
a62428c0 TH |
2151 | /** |
2152 | * process_one_work - process single work | |
c34056a3 | 2153 | * @worker: self |
a62428c0 TH |
2154 | * @work: work to process |
2155 | * | |
2156 | * Process @work. This function contains all the logics necessary to | |
2157 | * process a single work including synchronization against and | |
2158 | * interaction with other workers on the same cpu, queueing and | |
2159 | * flushing. As long as context requirement is met, any worker can | |
2160 | * call this function to process a work. | |
2161 | * | |
2162 | * CONTEXT: | |
d565ed63 | 2163 | * spin_lock_irq(pool->lock) which is released and regrabbed. |
a62428c0 | 2164 | */ |
c34056a3 | 2165 | static void process_one_work(struct worker *worker, struct work_struct *work) |
d565ed63 TH |
2166 | __releases(&pool->lock) |
2167 | __acquires(&pool->lock) | |
a62428c0 | 2168 | { |
112202d9 | 2169 | struct pool_workqueue *pwq = get_work_pwq(work); |
bd7bdd43 | 2170 | struct worker_pool *pool = worker->pool; |
112202d9 | 2171 | bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE; |
73f53c4a | 2172 | int work_color; |
7e11629d | 2173 | struct worker *collision; |
a62428c0 TH |
2174 | #ifdef CONFIG_LOCKDEP |
2175 | /* | |
2176 | * It is permissible to free the struct work_struct from | |
2177 | * inside the function that is called from it, this we need to | |
2178 | * take into account for lockdep too. To avoid bogus "held | |
2179 | * lock freed" warnings as well as problems when looking into | |
2180 | * work->lockdep_map, make a copy and use that here. | |
2181 | */ | |
4d82a1de PZ |
2182 | struct lockdep_map lockdep_map; |
2183 | ||
2184 | lockdep_copy_map(&lockdep_map, &work->lockdep_map); | |
a62428c0 | 2185 | #endif |
807407c0 | 2186 | /* ensure we're on the correct CPU */ |
85327af6 | 2187 | WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && |
ec22ca5e | 2188 | raw_smp_processor_id() != pool->cpu); |
25511a47 | 2189 | |
7e11629d TH |
2190 | /* |
2191 | * A single work shouldn't be executed concurrently by | |
2192 | * multiple workers on a single cpu. Check whether anyone is | |
2193 | * already processing the work. If so, defer the work to the | |
2194 | * currently executing one. | |
2195 | */ | |
c9e7cf27 | 2196 | collision = find_worker_executing_work(pool, work); |
7e11629d TH |
2197 | if (unlikely(collision)) { |
2198 | move_linked_works(work, &collision->scheduled, NULL); | |
2199 | return; | |
2200 | } | |
2201 | ||
8930caba | 2202 | /* claim and dequeue */ |
a62428c0 | 2203 | debug_work_deactivate(work); |
c9e7cf27 | 2204 | hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work); |
c34056a3 | 2205 | worker->current_work = work; |
a2c1c57b | 2206 | worker->current_func = work->func; |
112202d9 | 2207 | worker->current_pwq = pwq; |
73f53c4a | 2208 | work_color = get_work_color(work); |
7a22ad75 | 2209 | |
8bf89593 TH |
2210 | /* |
2211 | * Record wq name for cmdline and debug reporting, may get | |
2212 | * overridden through set_worker_desc(). | |
2213 | */ | |
2214 | strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN); | |
2215 | ||
a62428c0 TH |
2216 | list_del_init(&work->entry); |
2217 | ||
fb0e7beb | 2218 | /* |
228f1d00 LJ |
2219 | * CPU intensive works don't participate in concurrency management. |
2220 | * They're the scheduler's responsibility. This takes @worker out | |
2221 | * of concurrency management and the next code block will chain | |
2222 | * execution of the pending work items. | |
fb0e7beb TH |
2223 | */ |
2224 | if (unlikely(cpu_intensive)) | |
228f1d00 | 2225 | worker_set_flags(worker, WORKER_CPU_INTENSIVE); |
fb0e7beb | 2226 | |
974271c4 | 2227 | /* |
a489a03e LJ |
2228 | * Wake up another worker if necessary. The condition is always |
2229 | * false for normal per-cpu workers since nr_running would always | |
2230 | * be >= 1 at this point. This is used to chain execution of the | |
2231 | * pending work items for WORKER_NOT_RUNNING workers such as the | |
228f1d00 | 2232 | * UNBOUND and CPU_INTENSIVE ones. |
974271c4 | 2233 | */ |
a489a03e | 2234 | if (need_more_worker(pool)) |
63d95a91 | 2235 | wake_up_worker(pool); |
974271c4 | 2236 | |
8930caba | 2237 | /* |
7c3eed5c | 2238 | * Record the last pool and clear PENDING which should be the last |
d565ed63 | 2239 | * update to @work. Also, do this inside @pool->lock so that |
23657bb1 TH |
2240 | * PENDING and queued state changes happen together while IRQ is |
2241 | * disabled. | |
8930caba | 2242 | */ |
7c3eed5c | 2243 | set_work_pool_and_clear_pending(work, pool->id); |
a62428c0 | 2244 | |
d565ed63 | 2245 | spin_unlock_irq(&pool->lock); |
a62428c0 | 2246 | |
a1d14934 | 2247 | lock_map_acquire(&pwq->wq->lockdep_map); |
a62428c0 | 2248 | lock_map_acquire(&lockdep_map); |
e6f3faa7 | 2249 | /* |
f52be570 PZ |
2250 | * Strictly speaking we should mark the invariant state without holding |
2251 | * any locks, that is, before these two lock_map_acquire()'s. | |
e6f3faa7 PZ |
2252 | * |
2253 | * However, that would result in: | |
2254 | * | |
2255 | * A(W1) | |
2256 | * WFC(C) | |
2257 | * A(W1) | |
2258 | * C(C) | |
2259 | * | |
2260 | * Which would create W1->C->W1 dependencies, even though there is no | |
2261 | * actual deadlock possible. There are two solutions, using a | |
2262 | * read-recursive acquire on the work(queue) 'locks', but this will then | |
f52be570 | 2263 | * hit the lockdep limitation on recursive locks, or simply discard |
e6f3faa7 PZ |
2264 | * these locks. |
2265 | * | |
2266 | * AFAICT there is no possible deadlock scenario between the | |
2267 | * flush_work() and complete() primitives (except for single-threaded | |
2268 | * workqueues), so hiding them isn't a problem. | |
2269 | */ | |
f52be570 | 2270 | lockdep_invariant_state(true); |
e36c886a | 2271 | trace_workqueue_execute_start(work); |
a2c1c57b | 2272 | worker->current_func(work); |
e36c886a AV |
2273 | /* |
2274 | * While we must be careful to not use "work" after this, the trace | |
2275 | * point will only record its address. | |
2276 | */ | |
2277 | trace_workqueue_execute_end(work); | |
a62428c0 | 2278 | lock_map_release(&lockdep_map); |
112202d9 | 2279 | lock_map_release(&pwq->wq->lockdep_map); |
a62428c0 TH |
2280 | |
2281 | if (unlikely(in_atomic() || lockdep_depth(current) > 0)) { | |
044c782c | 2282 | pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n" |
d75f773c | 2283 | " last function: %ps\n", |
a2c1c57b TH |
2284 | current->comm, preempt_count(), task_pid_nr(current), |
2285 | worker->current_func); | |
a62428c0 TH |
2286 | debug_show_held_locks(current); |
2287 | dump_stack(); | |
2288 | } | |
2289 | ||
b22ce278 TH |
2290 | /* |
2291 | * The following prevents a kworker from hogging CPU on !PREEMPT | |
2292 | * kernels, where a requeueing work item waiting for something to | |
2293 | * happen could deadlock with stop_machine as such work item could | |
2294 | * indefinitely requeue itself while all other CPUs are trapped in | |
789cbbec JL |
2295 | * stop_machine. At the same time, report a quiescent RCU state so |
2296 | * the same condition doesn't freeze RCU. | |
b22ce278 | 2297 | */ |
a7e6425e | 2298 | cond_resched(); |
b22ce278 | 2299 | |
d565ed63 | 2300 | spin_lock_irq(&pool->lock); |
a62428c0 | 2301 | |
fb0e7beb TH |
2302 | /* clear cpu intensive status */ |
2303 | if (unlikely(cpu_intensive)) | |
2304 | worker_clr_flags(worker, WORKER_CPU_INTENSIVE); | |
2305 | ||
1b69ac6b JW |
2306 | /* tag the worker for identification in schedule() */ |
2307 | worker->last_func = worker->current_func; | |
2308 | ||
a62428c0 | 2309 | /* we're done with it, release */ |
42f8570f | 2310 | hash_del(&worker->hentry); |
c34056a3 | 2311 | worker->current_work = NULL; |
a2c1c57b | 2312 | worker->current_func = NULL; |
112202d9 TH |
2313 | worker->current_pwq = NULL; |
2314 | pwq_dec_nr_in_flight(pwq, work_color); | |
a62428c0 TH |
2315 | } |
2316 | ||
affee4b2 TH |
2317 | /** |
2318 | * process_scheduled_works - process scheduled works | |
2319 | * @worker: self | |
2320 | * | |
2321 | * Process all scheduled works. Please note that the scheduled list | |
2322 | * may change while processing a work, so this function repeatedly | |
2323 | * fetches a work from the top and executes it. | |
2324 | * | |
2325 | * CONTEXT: | |
d565ed63 | 2326 | * spin_lock_irq(pool->lock) which may be released and regrabbed |
affee4b2 TH |
2327 | * multiple times. |
2328 | */ | |
2329 | static void process_scheduled_works(struct worker *worker) | |
1da177e4 | 2330 | { |
affee4b2 TH |
2331 | while (!list_empty(&worker->scheduled)) { |
2332 | struct work_struct *work = list_first_entry(&worker->scheduled, | |
1da177e4 | 2333 | struct work_struct, entry); |
c34056a3 | 2334 | process_one_work(worker, work); |
1da177e4 | 2335 | } |
1da177e4 LT |
2336 | } |
2337 | ||
197f6acc TH |
2338 | static void set_pf_worker(bool val) |
2339 | { | |
2340 | mutex_lock(&wq_pool_attach_mutex); | |
2341 | if (val) | |
2342 | current->flags |= PF_WQ_WORKER; | |
2343 | else | |
2344 | current->flags &= ~PF_WQ_WORKER; | |
2345 | mutex_unlock(&wq_pool_attach_mutex); | |
2346 | } | |
2347 | ||
4690c4ab TH |
2348 | /** |
2349 | * worker_thread - the worker thread function | |
c34056a3 | 2350 | * @__worker: self |
4690c4ab | 2351 | * |
c5aa87bb TH |
2352 | * The worker thread function. All workers belong to a worker_pool - |
2353 | * either a per-cpu one or dynamic unbound one. These workers process all | |
2354 | * work items regardless of their specific target workqueue. The only | |
2355 | * exception is work items which belong to workqueues with a rescuer which | |
2356 | * will be explained in rescuer_thread(). | |
d185af30 YB |
2357 | * |
2358 | * Return: 0 | |
4690c4ab | 2359 | */ |
c34056a3 | 2360 | static int worker_thread(void *__worker) |
1da177e4 | 2361 | { |
c34056a3 | 2362 | struct worker *worker = __worker; |
bd7bdd43 | 2363 | struct worker_pool *pool = worker->pool; |
1da177e4 | 2364 | |
e22bee78 | 2365 | /* tell the scheduler that this is a workqueue worker */ |
197f6acc | 2366 | set_pf_worker(true); |
c8e55f36 | 2367 | woke_up: |
d565ed63 | 2368 | spin_lock_irq(&pool->lock); |
1da177e4 | 2369 | |
a9ab775b TH |
2370 | /* am I supposed to die? */ |
2371 | if (unlikely(worker->flags & WORKER_DIE)) { | |
d565ed63 | 2372 | spin_unlock_irq(&pool->lock); |
a9ab775b | 2373 | WARN_ON_ONCE(!list_empty(&worker->entry)); |
197f6acc | 2374 | set_pf_worker(false); |
60f5a4bc LJ |
2375 | |
2376 | set_task_comm(worker->task, "kworker/dying"); | |
7cda9aae | 2377 | ida_simple_remove(&pool->worker_ida, worker->id); |
a2d812a2 | 2378 | worker_detach_from_pool(worker); |
60f5a4bc | 2379 | kfree(worker); |
a9ab775b | 2380 | return 0; |
c8e55f36 | 2381 | } |
affee4b2 | 2382 | |
c8e55f36 | 2383 | worker_leave_idle(worker); |
db7bccf4 | 2384 | recheck: |
e22bee78 | 2385 | /* no more worker necessary? */ |
63d95a91 | 2386 | if (!need_more_worker(pool)) |
e22bee78 TH |
2387 | goto sleep; |
2388 | ||
2389 | /* do we need to manage? */ | |
63d95a91 | 2390 | if (unlikely(!may_start_working(pool)) && manage_workers(worker)) |
e22bee78 TH |
2391 | goto recheck; |
2392 | ||
c8e55f36 TH |
2393 | /* |
2394 | * ->scheduled list can only be filled while a worker is | |
2395 | * preparing to process a work or actually processing it. | |
2396 | * Make sure nobody diddled with it while I was sleeping. | |
2397 | */ | |
6183c009 | 2398 | WARN_ON_ONCE(!list_empty(&worker->scheduled)); |
c8e55f36 | 2399 | |
e22bee78 | 2400 | /* |
a9ab775b TH |
2401 | * Finish PREP stage. We're guaranteed to have at least one idle |
2402 | * worker or that someone else has already assumed the manager | |
2403 | * role. This is where @worker starts participating in concurrency | |
2404 | * management if applicable and concurrency management is restored | |
2405 | * after being rebound. See rebind_workers() for details. | |
e22bee78 | 2406 | */ |
a9ab775b | 2407 | worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND); |
e22bee78 TH |
2408 | |
2409 | do { | |
c8e55f36 | 2410 | struct work_struct *work = |
bd7bdd43 | 2411 | list_first_entry(&pool->worklist, |
c8e55f36 TH |
2412 | struct work_struct, entry); |
2413 | ||
82607adc TH |
2414 | pool->watchdog_ts = jiffies; |
2415 | ||
c8e55f36 TH |
2416 | if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) { |
2417 | /* optimization path, not strictly necessary */ | |
2418 | process_one_work(worker, work); | |
2419 | if (unlikely(!list_empty(&worker->scheduled))) | |
affee4b2 | 2420 | process_scheduled_works(worker); |
c8e55f36 TH |
2421 | } else { |
2422 | move_linked_works(work, &worker->scheduled, NULL); | |
2423 | process_scheduled_works(worker); | |
affee4b2 | 2424 | } |
63d95a91 | 2425 | } while (keep_working(pool)); |
e22bee78 | 2426 | |
228f1d00 | 2427 | worker_set_flags(worker, WORKER_PREP); |
d313dd85 | 2428 | sleep: |
c8e55f36 | 2429 | /* |
d565ed63 TH |
2430 | * pool->lock is held and there's no work to process and no need to |
2431 | * manage, sleep. Workers are woken up only while holding | |
2432 | * pool->lock or from local cpu, so setting the current state | |
2433 | * before releasing pool->lock is enough to prevent losing any | |
2434 | * event. | |
c8e55f36 TH |
2435 | */ |
2436 | worker_enter_idle(worker); | |
c5a94a61 | 2437 | __set_current_state(TASK_IDLE); |
d565ed63 | 2438 | spin_unlock_irq(&pool->lock); |
c8e55f36 TH |
2439 | schedule(); |
2440 | goto woke_up; | |
1da177e4 LT |
2441 | } |
2442 | ||
e22bee78 TH |
2443 | /** |
2444 | * rescuer_thread - the rescuer thread function | |
111c225a | 2445 | * @__rescuer: self |
e22bee78 TH |
2446 | * |
2447 | * Workqueue rescuer thread function. There's one rescuer for each | |
493008a8 | 2448 | * workqueue which has WQ_MEM_RECLAIM set. |
e22bee78 | 2449 | * |
706026c2 | 2450 | * Regular work processing on a pool may block trying to create a new |
e22bee78 TH |
2451 | * worker which uses GFP_KERNEL allocation which has slight chance of |
2452 | * developing into deadlock if some works currently on the same queue | |
2453 | * need to be processed to satisfy the GFP_KERNEL allocation. This is | |
2454 | * the problem rescuer solves. | |
2455 | * | |
706026c2 TH |
2456 | * When such condition is possible, the pool summons rescuers of all |
2457 | * workqueues which have works queued on the pool and let them process | |
e22bee78 TH |
2458 | * those works so that forward progress can be guaranteed. |
2459 | * | |
2460 | * This should happen rarely. | |
d185af30 YB |
2461 | * |
2462 | * Return: 0 | |
e22bee78 | 2463 | */ |
111c225a | 2464 | static int rescuer_thread(void *__rescuer) |
e22bee78 | 2465 | { |
111c225a TH |
2466 | struct worker *rescuer = __rescuer; |
2467 | struct workqueue_struct *wq = rescuer->rescue_wq; | |
e22bee78 | 2468 | struct list_head *scheduled = &rescuer->scheduled; |
4d595b86 | 2469 | bool should_stop; |
e22bee78 TH |
2470 | |
2471 | set_user_nice(current, RESCUER_NICE_LEVEL); | |
111c225a TH |
2472 | |
2473 | /* | |
2474 | * Mark rescuer as worker too. As WORKER_PREP is never cleared, it | |
2475 | * doesn't participate in concurrency management. | |
2476 | */ | |
197f6acc | 2477 | set_pf_worker(true); |
e22bee78 | 2478 | repeat: |
c5a94a61 | 2479 | set_current_state(TASK_IDLE); |
e22bee78 | 2480 | |
4d595b86 LJ |
2481 | /* |
2482 | * By the time the rescuer is requested to stop, the workqueue | |
2483 | * shouldn't have any work pending, but @wq->maydays may still have | |
2484 | * pwq(s) queued. This can happen by non-rescuer workers consuming | |
2485 | * all the work items before the rescuer got to them. Go through | |
2486 | * @wq->maydays processing before acting on should_stop so that the | |
2487 | * list is always empty on exit. | |
2488 | */ | |
2489 | should_stop = kthread_should_stop(); | |
e22bee78 | 2490 | |
493a1724 | 2491 | /* see whether any pwq is asking for help */ |
2e109a28 | 2492 | spin_lock_irq(&wq_mayday_lock); |
493a1724 TH |
2493 | |
2494 | while (!list_empty(&wq->maydays)) { | |
2495 | struct pool_workqueue *pwq = list_first_entry(&wq->maydays, | |
2496 | struct pool_workqueue, mayday_node); | |
112202d9 | 2497 | struct worker_pool *pool = pwq->pool; |
e22bee78 | 2498 | struct work_struct *work, *n; |
82607adc | 2499 | bool first = true; |
e22bee78 TH |
2500 | |
2501 | __set_current_state(TASK_RUNNING); | |
493a1724 TH |
2502 | list_del_init(&pwq->mayday_node); |
2503 | ||
2e109a28 | 2504 | spin_unlock_irq(&wq_mayday_lock); |
e22bee78 | 2505 | |
51697d39 LJ |
2506 | worker_attach_to_pool(rescuer, pool); |
2507 | ||
2508 | spin_lock_irq(&pool->lock); | |
e22bee78 TH |
2509 | |
2510 | /* | |
2511 | * Slurp in all works issued via this workqueue and | |
2512 | * process'em. | |
2513 | */ | |
0479c8c5 | 2514 | WARN_ON_ONCE(!list_empty(scheduled)); |
82607adc TH |
2515 | list_for_each_entry_safe(work, n, &pool->worklist, entry) { |
2516 | if (get_work_pwq(work) == pwq) { | |
2517 | if (first) | |
2518 | pool->watchdog_ts = jiffies; | |
e22bee78 | 2519 | move_linked_works(work, scheduled, &n); |
82607adc TH |
2520 | } |
2521 | first = false; | |
2522 | } | |
e22bee78 | 2523 | |
008847f6 N |
2524 | if (!list_empty(scheduled)) { |
2525 | process_scheduled_works(rescuer); | |
2526 | ||
2527 | /* | |
2528 | * The above execution of rescued work items could | |
2529 | * have created more to rescue through | |
2530 | * pwq_activate_first_delayed() or chained | |
2531 | * queueing. Let's put @pwq back on mayday list so | |
2532 | * that such back-to-back work items, which may be | |
2533 | * being used to relieve memory pressure, don't | |
2534 | * incur MAYDAY_INTERVAL delay inbetween. | |
2535 | */ | |
2536 | if (need_to_create_worker(pool)) { | |
2537 | spin_lock(&wq_mayday_lock); | |
63567df7 TH |
2538 | /* |
2539 | * Queue iff we aren't racing destruction | |
2540 | * and somebody else hasn't queued it already. | |
2541 | */ | |
2542 | if (wq->rescuer && list_empty(&pwq->mayday_node)) { | |
2543 | get_pwq(pwq); | |
2544 | list_add_tail(&pwq->mayday_node, &wq->maydays); | |
2545 | } | |
008847f6 N |
2546 | spin_unlock(&wq_mayday_lock); |
2547 | } | |
2548 | } | |
7576958a | 2549 | |
77668c8b LJ |
2550 | /* |
2551 | * Put the reference grabbed by send_mayday(). @pool won't | |
13b1d625 | 2552 | * go away while we're still attached to it. |
77668c8b LJ |
2553 | */ |
2554 | put_pwq(pwq); | |
2555 | ||
7576958a | 2556 | /* |
d8ca83e6 | 2557 | * Leave this pool. If need_more_worker() is %true, notify a |
7576958a TH |
2558 | * regular worker; otherwise, we end up with 0 concurrency |
2559 | * and stalling the execution. | |
2560 | */ | |
d8ca83e6 | 2561 | if (need_more_worker(pool)) |
63d95a91 | 2562 | wake_up_worker(pool); |
7576958a | 2563 | |
13b1d625 LJ |
2564 | spin_unlock_irq(&pool->lock); |
2565 | ||
a2d812a2 | 2566 | worker_detach_from_pool(rescuer); |
13b1d625 LJ |
2567 | |
2568 | spin_lock_irq(&wq_mayday_lock); | |
e22bee78 TH |
2569 | } |
2570 | ||
2e109a28 | 2571 | spin_unlock_irq(&wq_mayday_lock); |
493a1724 | 2572 | |
4d595b86 LJ |
2573 | if (should_stop) { |
2574 | __set_current_state(TASK_RUNNING); | |
197f6acc | 2575 | set_pf_worker(false); |
4d595b86 LJ |
2576 | return 0; |
2577 | } | |
2578 | ||
111c225a TH |
2579 | /* rescuers should never participate in concurrency management */ |
2580 | WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING)); | |
e22bee78 TH |
2581 | schedule(); |
2582 | goto repeat; | |
1da177e4 LT |
2583 | } |
2584 | ||
fca839c0 TH |
2585 | /** |
2586 | * check_flush_dependency - check for flush dependency sanity | |
2587 | * @target_wq: workqueue being flushed | |
2588 | * @target_work: work item being flushed (NULL for workqueue flushes) | |
2589 | * | |
2590 | * %current is trying to flush the whole @target_wq or @target_work on it. | |
2591 | * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not | |
2592 | * reclaiming memory or running on a workqueue which doesn't have | |
2593 | * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to | |
2594 | * a deadlock. | |
2595 | */ | |
2596 | static void check_flush_dependency(struct workqueue_struct *target_wq, | |
2597 | struct work_struct *target_work) | |
2598 | { | |
2599 | work_func_t target_func = target_work ? target_work->func : NULL; | |
2600 | struct worker *worker; | |
2601 | ||
2602 | if (target_wq->flags & WQ_MEM_RECLAIM) | |
2603 | return; | |
2604 | ||
2605 | worker = current_wq_worker(); | |
2606 | ||
2607 | WARN_ONCE(current->flags & PF_MEMALLOC, | |
d75f773c | 2608 | "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps", |
fca839c0 | 2609 | current->pid, current->comm, target_wq->name, target_func); |
23d11a58 TH |
2610 | WARN_ONCE(worker && ((worker->current_pwq->wq->flags & |
2611 | (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM), | |
d75f773c | 2612 | "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps", |
fca839c0 TH |
2613 | worker->current_pwq->wq->name, worker->current_func, |
2614 | target_wq->name, target_func); | |
2615 | } | |
2616 | ||
fc2e4d70 ON |
2617 | struct wq_barrier { |
2618 | struct work_struct work; | |
2619 | struct completion done; | |
2607d7a6 | 2620 | struct task_struct *task; /* purely informational */ |
fc2e4d70 ON |
2621 | }; |
2622 | ||
2623 | static void wq_barrier_func(struct work_struct *work) | |
2624 | { | |
2625 | struct wq_barrier *barr = container_of(work, struct wq_barrier, work); | |
2626 | complete(&barr->done); | |
2627 | } | |
2628 | ||
4690c4ab TH |
2629 | /** |
2630 | * insert_wq_barrier - insert a barrier work | |
112202d9 | 2631 | * @pwq: pwq to insert barrier into |
4690c4ab | 2632 | * @barr: wq_barrier to insert |
affee4b2 TH |
2633 | * @target: target work to attach @barr to |
2634 | * @worker: worker currently executing @target, NULL if @target is not executing | |
4690c4ab | 2635 | * |
affee4b2 TH |
2636 | * @barr is linked to @target such that @barr is completed only after |
2637 | * @target finishes execution. Please note that the ordering | |
2638 | * guarantee is observed only with respect to @target and on the local | |
2639 | * cpu. | |
2640 | * | |
2641 | * Currently, a queued barrier can't be canceled. This is because | |
2642 | * try_to_grab_pending() can't determine whether the work to be | |
2643 | * grabbed is at the head of the queue and thus can't clear LINKED | |
2644 | * flag of the previous work while there must be a valid next work | |
2645 | * after a work with LINKED flag set. | |
2646 | * | |
2647 | * Note that when @worker is non-NULL, @target may be modified | |
112202d9 | 2648 | * underneath us, so we can't reliably determine pwq from @target. |
4690c4ab TH |
2649 | * |
2650 | * CONTEXT: | |
d565ed63 | 2651 | * spin_lock_irq(pool->lock). |
4690c4ab | 2652 | */ |
112202d9 | 2653 | static void insert_wq_barrier(struct pool_workqueue *pwq, |
affee4b2 TH |
2654 | struct wq_barrier *barr, |
2655 | struct work_struct *target, struct worker *worker) | |
fc2e4d70 | 2656 | { |
affee4b2 TH |
2657 | struct list_head *head; |
2658 | unsigned int linked = 0; | |
2659 | ||
dc186ad7 | 2660 | /* |
d565ed63 | 2661 | * debugobject calls are safe here even with pool->lock locked |
dc186ad7 TG |
2662 | * as we know for sure that this will not trigger any of the |
2663 | * checks and call back into the fixup functions where we | |
2664 | * might deadlock. | |
2665 | */ | |
ca1cab37 | 2666 | INIT_WORK_ONSTACK(&barr->work, wq_barrier_func); |
22df02bb | 2667 | __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); |
52fa5bc5 | 2668 | |
fd1a5b04 BP |
2669 | init_completion_map(&barr->done, &target->lockdep_map); |
2670 | ||
2607d7a6 | 2671 | barr->task = current; |
83c22520 | 2672 | |
affee4b2 TH |
2673 | /* |
2674 | * If @target is currently being executed, schedule the | |
2675 | * barrier to the worker; otherwise, put it after @target. | |
2676 | */ | |
2677 | if (worker) | |
2678 | head = worker->scheduled.next; | |
2679 | else { | |
2680 | unsigned long *bits = work_data_bits(target); | |
2681 | ||
2682 | head = target->entry.next; | |
2683 | /* there can already be other linked works, inherit and set */ | |
2684 | linked = *bits & WORK_STRUCT_LINKED; | |
2685 | __set_bit(WORK_STRUCT_LINKED_BIT, bits); | |
2686 | } | |
2687 | ||
dc186ad7 | 2688 | debug_work_activate(&barr->work); |
112202d9 | 2689 | insert_work(pwq, &barr->work, head, |
affee4b2 | 2690 | work_color_to_flags(WORK_NO_COLOR) | linked); |
fc2e4d70 ON |
2691 | } |
2692 | ||
73f53c4a | 2693 | /** |
112202d9 | 2694 | * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing |
73f53c4a TH |
2695 | * @wq: workqueue being flushed |
2696 | * @flush_color: new flush color, < 0 for no-op | |
2697 | * @work_color: new work color, < 0 for no-op | |
2698 | * | |
112202d9 | 2699 | * Prepare pwqs for workqueue flushing. |
73f53c4a | 2700 | * |
112202d9 TH |
2701 | * If @flush_color is non-negative, flush_color on all pwqs should be |
2702 | * -1. If no pwq has in-flight commands at the specified color, all | |
2703 | * pwq->flush_color's stay at -1 and %false is returned. If any pwq | |
2704 | * has in flight commands, its pwq->flush_color is set to | |
2705 | * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq | |
73f53c4a TH |
2706 | * wakeup logic is armed and %true is returned. |
2707 | * | |
2708 | * The caller should have initialized @wq->first_flusher prior to | |
2709 | * calling this function with non-negative @flush_color. If | |
2710 | * @flush_color is negative, no flush color update is done and %false | |
2711 | * is returned. | |
2712 | * | |
112202d9 | 2713 | * If @work_color is non-negative, all pwqs should have the same |
73f53c4a TH |
2714 | * work_color which is previous to @work_color and all will be |
2715 | * advanced to @work_color. | |
2716 | * | |
2717 | * CONTEXT: | |
3c25a55d | 2718 | * mutex_lock(wq->mutex). |
73f53c4a | 2719 | * |
d185af30 | 2720 | * Return: |
73f53c4a TH |
2721 | * %true if @flush_color >= 0 and there's something to flush. %false |
2722 | * otherwise. | |
2723 | */ | |
112202d9 | 2724 | static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq, |
73f53c4a | 2725 | int flush_color, int work_color) |
1da177e4 | 2726 | { |
73f53c4a | 2727 | bool wait = false; |
49e3cf44 | 2728 | struct pool_workqueue *pwq; |
1da177e4 | 2729 | |
73f53c4a | 2730 | if (flush_color >= 0) { |
6183c009 | 2731 | WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush)); |
112202d9 | 2732 | atomic_set(&wq->nr_pwqs_to_flush, 1); |
1da177e4 | 2733 | } |
2355b70f | 2734 | |
49e3cf44 | 2735 | for_each_pwq(pwq, wq) { |
112202d9 | 2736 | struct worker_pool *pool = pwq->pool; |
fc2e4d70 | 2737 | |
b09f4fd3 | 2738 | spin_lock_irq(&pool->lock); |
83c22520 | 2739 | |
73f53c4a | 2740 | if (flush_color >= 0) { |
6183c009 | 2741 | WARN_ON_ONCE(pwq->flush_color != -1); |
fc2e4d70 | 2742 | |
112202d9 TH |
2743 | if (pwq->nr_in_flight[flush_color]) { |
2744 | pwq->flush_color = flush_color; | |
2745 | atomic_inc(&wq->nr_pwqs_to_flush); | |
73f53c4a TH |
2746 | wait = true; |
2747 | } | |
2748 | } | |
1da177e4 | 2749 | |
73f53c4a | 2750 | if (work_color >= 0) { |
6183c009 | 2751 | WARN_ON_ONCE(work_color != work_next_color(pwq->work_color)); |
112202d9 | 2752 | pwq->work_color = work_color; |
73f53c4a | 2753 | } |
1da177e4 | 2754 | |
b09f4fd3 | 2755 | spin_unlock_irq(&pool->lock); |
1da177e4 | 2756 | } |
2355b70f | 2757 | |
112202d9 | 2758 | if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush)) |
73f53c4a | 2759 | complete(&wq->first_flusher->done); |
14441960 | 2760 | |
73f53c4a | 2761 | return wait; |
1da177e4 LT |
2762 | } |
2763 | ||
0fcb78c2 | 2764 | /** |
1da177e4 | 2765 | * flush_workqueue - ensure that any scheduled work has run to completion. |
0fcb78c2 | 2766 | * @wq: workqueue to flush |
1da177e4 | 2767 | * |
c5aa87bb TH |
2768 | * This function sleeps until all work items which were queued on entry |
2769 | * have finished execution, but it is not livelocked by new incoming ones. | |
1da177e4 | 2770 | */ |
7ad5b3a5 | 2771 | void flush_workqueue(struct workqueue_struct *wq) |
1da177e4 | 2772 | { |
73f53c4a TH |
2773 | struct wq_flusher this_flusher = { |
2774 | .list = LIST_HEAD_INIT(this_flusher.list), | |
2775 | .flush_color = -1, | |
fd1a5b04 | 2776 | .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map), |
73f53c4a TH |
2777 | }; |
2778 | int next_color; | |
1da177e4 | 2779 | |
3347fa09 TH |
2780 | if (WARN_ON(!wq_online)) |
2781 | return; | |
2782 | ||
87915adc JB |
2783 | lock_map_acquire(&wq->lockdep_map); |
2784 | lock_map_release(&wq->lockdep_map); | |
2785 | ||
3c25a55d | 2786 | mutex_lock(&wq->mutex); |
73f53c4a TH |
2787 | |
2788 | /* | |
2789 | * Start-to-wait phase | |
2790 | */ | |
2791 | next_color = work_next_color(wq->work_color); | |
2792 | ||
2793 | if (next_color != wq->flush_color) { | |
2794 | /* | |
2795 | * Color space is not full. The current work_color | |
2796 | * becomes our flush_color and work_color is advanced | |
2797 | * by one. | |
2798 | */ | |
6183c009 | 2799 | WARN_ON_ONCE(!list_empty(&wq->flusher_overflow)); |
73f53c4a TH |
2800 | this_flusher.flush_color = wq->work_color; |
2801 | wq->work_color = next_color; | |
2802 | ||
2803 | if (!wq->first_flusher) { | |
2804 | /* no flush in progress, become the first flusher */ | |
6183c009 | 2805 | WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); |
73f53c4a TH |
2806 | |
2807 | wq->first_flusher = &this_flusher; | |
2808 | ||
112202d9 | 2809 | if (!flush_workqueue_prep_pwqs(wq, wq->flush_color, |
73f53c4a TH |
2810 | wq->work_color)) { |
2811 | /* nothing to flush, done */ | |
2812 | wq->flush_color = next_color; | |
2813 | wq->first_flusher = NULL; | |
2814 | goto out_unlock; | |
2815 | } | |
2816 | } else { | |
2817 | /* wait in queue */ | |
6183c009 | 2818 | WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color); |
73f53c4a | 2819 | list_add_tail(&this_flusher.list, &wq->flusher_queue); |
112202d9 | 2820 | flush_workqueue_prep_pwqs(wq, -1, wq->work_color); |
73f53c4a TH |
2821 | } |
2822 | } else { | |
2823 | /* | |
2824 | * Oops, color space is full, wait on overflow queue. | |
2825 | * The next flush completion will assign us | |
2826 | * flush_color and transfer to flusher_queue. | |
2827 | */ | |
2828 | list_add_tail(&this_flusher.list, &wq->flusher_overflow); | |
2829 | } | |
2830 | ||
fca839c0 TH |
2831 | check_flush_dependency(wq, NULL); |
2832 | ||
3c25a55d | 2833 | mutex_unlock(&wq->mutex); |
73f53c4a TH |
2834 | |
2835 | wait_for_completion(&this_flusher.done); | |
2836 | ||
2837 | /* | |
2838 | * Wake-up-and-cascade phase | |
2839 | * | |
2840 | * First flushers are responsible for cascading flushes and | |
2841 | * handling overflow. Non-first flushers can simply return. | |
2842 | */ | |
2843 | if (wq->first_flusher != &this_flusher) | |
2844 | return; | |
2845 | ||
3c25a55d | 2846 | mutex_lock(&wq->mutex); |
73f53c4a | 2847 | |
4ce48b37 TH |
2848 | /* we might have raced, check again with mutex held */ |
2849 | if (wq->first_flusher != &this_flusher) | |
2850 | goto out_unlock; | |
2851 | ||
73f53c4a TH |
2852 | wq->first_flusher = NULL; |
2853 | ||
6183c009 TH |
2854 | WARN_ON_ONCE(!list_empty(&this_flusher.list)); |
2855 | WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); | |
73f53c4a TH |
2856 | |
2857 | while (true) { | |
2858 | struct wq_flusher *next, *tmp; | |
2859 | ||
2860 | /* complete all the flushers sharing the current flush color */ | |
2861 | list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { | |
2862 | if (next->flush_color != wq->flush_color) | |
2863 | break; | |
2864 | list_del_init(&next->list); | |
2865 | complete(&next->done); | |
2866 | } | |
2867 | ||
6183c009 TH |
2868 | WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) && |
2869 | wq->flush_color != work_next_color(wq->work_color)); | |
73f53c4a TH |
2870 | |
2871 | /* this flush_color is finished, advance by one */ | |
2872 | wq->flush_color = work_next_color(wq->flush_color); | |
2873 | ||
2874 | /* one color has been freed, handle overflow queue */ | |
2875 | if (!list_empty(&wq->flusher_overflow)) { | |
2876 | /* | |
2877 | * Assign the same color to all overflowed | |
2878 | * flushers, advance work_color and append to | |
2879 | * flusher_queue. This is the start-to-wait | |
2880 | * phase for these overflowed flushers. | |
2881 | */ | |
2882 | list_for_each_entry(tmp, &wq->flusher_overflow, list) | |
2883 | tmp->flush_color = wq->work_color; | |
2884 | ||
2885 | wq->work_color = work_next_color(wq->work_color); | |
2886 | ||
2887 | list_splice_tail_init(&wq->flusher_overflow, | |
2888 | &wq->flusher_queue); | |
112202d9 | 2889 | flush_workqueue_prep_pwqs(wq, -1, wq->work_color); |
73f53c4a TH |
2890 | } |
2891 | ||
2892 | if (list_empty(&wq->flusher_queue)) { | |
6183c009 | 2893 | WARN_ON_ONCE(wq->flush_color != wq->work_color); |
73f53c4a TH |
2894 | break; |
2895 | } | |
2896 | ||
2897 | /* | |
2898 | * Need to flush more colors. Make the next flusher | |
112202d9 | 2899 | * the new first flusher and arm pwqs. |
73f53c4a | 2900 | */ |
6183c009 TH |
2901 | WARN_ON_ONCE(wq->flush_color == wq->work_color); |
2902 | WARN_ON_ONCE(wq->flush_color != next->flush_color); | |
73f53c4a TH |
2903 | |
2904 | list_del_init(&next->list); | |
2905 | wq->first_flusher = next; | |
2906 | ||
112202d9 | 2907 | if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1)) |
73f53c4a TH |
2908 | break; |
2909 | ||
2910 | /* | |
2911 | * Meh... this color is already done, clear first | |
2912 | * flusher and repeat cascading. | |
2913 | */ | |
2914 | wq->first_flusher = NULL; | |
2915 | } | |
2916 | ||
2917 | out_unlock: | |
3c25a55d | 2918 | mutex_unlock(&wq->mutex); |
1da177e4 | 2919 | } |
1dadafa8 | 2920 | EXPORT_SYMBOL(flush_workqueue); |
1da177e4 | 2921 | |
9c5a2ba7 TH |
2922 | /** |
2923 | * drain_workqueue - drain a workqueue | |
2924 | * @wq: workqueue to drain | |
2925 | * | |
2926 | * Wait until the workqueue becomes empty. While draining is in progress, | |
2927 | * only chain queueing is allowed. IOW, only currently pending or running | |
2928 | * work items on @wq can queue further work items on it. @wq is flushed | |
b749b1b6 | 2929 | * repeatedly until it becomes empty. The number of flushing is determined |
9c5a2ba7 TH |
2930 | * by the depth of chaining and should be relatively short. Whine if it |
2931 | * takes too long. | |
2932 | */ | |
2933 | void drain_workqueue(struct workqueue_struct *wq) | |
2934 | { | |
2935 | unsigned int flush_cnt = 0; | |
49e3cf44 | 2936 | struct pool_workqueue *pwq; |
9c5a2ba7 TH |
2937 | |
2938 | /* | |
2939 | * __queue_work() needs to test whether there are drainers, is much | |
2940 | * hotter than drain_workqueue() and already looks at @wq->flags. | |
618b01eb | 2941 | * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers. |
9c5a2ba7 | 2942 | */ |
87fc741e | 2943 | mutex_lock(&wq->mutex); |
9c5a2ba7 | 2944 | if (!wq->nr_drainers++) |
618b01eb | 2945 | wq->flags |= __WQ_DRAINING; |
87fc741e | 2946 | mutex_unlock(&wq->mutex); |
9c5a2ba7 TH |
2947 | reflush: |
2948 | flush_workqueue(wq); | |
2949 | ||
b09f4fd3 | 2950 | mutex_lock(&wq->mutex); |
76af4d93 | 2951 | |
49e3cf44 | 2952 | for_each_pwq(pwq, wq) { |
fa2563e4 | 2953 | bool drained; |
9c5a2ba7 | 2954 | |
b09f4fd3 | 2955 | spin_lock_irq(&pwq->pool->lock); |
112202d9 | 2956 | drained = !pwq->nr_active && list_empty(&pwq->delayed_works); |
b09f4fd3 | 2957 | spin_unlock_irq(&pwq->pool->lock); |
fa2563e4 TT |
2958 | |
2959 | if (drained) | |
9c5a2ba7 TH |
2960 | continue; |
2961 | ||
2962 | if (++flush_cnt == 10 || | |
2963 | (flush_cnt % 100 == 0 && flush_cnt <= 1000)) | |
c5aa87bb | 2964 | pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n", |
044c782c | 2965 | wq->name, flush_cnt); |
76af4d93 | 2966 | |
b09f4fd3 | 2967 | mutex_unlock(&wq->mutex); |
9c5a2ba7 TH |
2968 | goto reflush; |
2969 | } | |
2970 | ||
9c5a2ba7 | 2971 | if (!--wq->nr_drainers) |
618b01eb | 2972 | wq->flags &= ~__WQ_DRAINING; |
87fc741e | 2973 | mutex_unlock(&wq->mutex); |
9c5a2ba7 TH |
2974 | } |
2975 | EXPORT_SYMBOL_GPL(drain_workqueue); | |
2976 | ||
d6e89786 JB |
2977 | static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr, |
2978 | bool from_cancel) | |
db700897 | 2979 | { |
affee4b2 | 2980 | struct worker *worker = NULL; |
c9e7cf27 | 2981 | struct worker_pool *pool; |
112202d9 | 2982 | struct pool_workqueue *pwq; |
db700897 ON |
2983 | |
2984 | might_sleep(); | |
fa1b54e6 | 2985 | |
24acfb71 | 2986 | rcu_read_lock(); |
c9e7cf27 | 2987 | pool = get_work_pool(work); |
fa1b54e6 | 2988 | if (!pool) { |
24acfb71 | 2989 | rcu_read_unlock(); |
baf59022 | 2990 | return false; |
fa1b54e6 | 2991 | } |
db700897 | 2992 | |
24acfb71 | 2993 | spin_lock_irq(&pool->lock); |
0b3dae68 | 2994 | /* see the comment in try_to_grab_pending() with the same code */ |
112202d9 TH |
2995 | pwq = get_work_pwq(work); |
2996 | if (pwq) { | |
2997 | if (unlikely(pwq->pool != pool)) | |
4690c4ab | 2998 | goto already_gone; |
606a5020 | 2999 | } else { |
c9e7cf27 | 3000 | worker = find_worker_executing_work(pool, work); |
affee4b2 | 3001 | if (!worker) |
4690c4ab | 3002 | goto already_gone; |
112202d9 | 3003 | pwq = worker->current_pwq; |
606a5020 | 3004 | } |
db700897 | 3005 | |
fca839c0 TH |
3006 | check_flush_dependency(pwq->wq, work); |
3007 | ||
112202d9 | 3008 | insert_wq_barrier(pwq, barr, work, worker); |
d565ed63 | 3009 | spin_unlock_irq(&pool->lock); |
7a22ad75 | 3010 | |
e159489b | 3011 | /* |
a1d14934 PZ |
3012 | * Force a lock recursion deadlock when using flush_work() inside a |
3013 | * single-threaded or rescuer equipped workqueue. | |
3014 | * | |
3015 | * For single threaded workqueues the deadlock happens when the work | |
3016 | * is after the work issuing the flush_work(). For rescuer equipped | |
3017 | * workqueues the deadlock happens when the rescuer stalls, blocking | |
3018 | * forward progress. | |
e159489b | 3019 | */ |
d6e89786 JB |
3020 | if (!from_cancel && |
3021 | (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) { | |
112202d9 | 3022 | lock_map_acquire(&pwq->wq->lockdep_map); |
a1d14934 PZ |
3023 | lock_map_release(&pwq->wq->lockdep_map); |
3024 | } | |
24acfb71 | 3025 | rcu_read_unlock(); |
401a8d04 | 3026 | return true; |
4690c4ab | 3027 | already_gone: |
d565ed63 | 3028 | spin_unlock_irq(&pool->lock); |
24acfb71 | 3029 | rcu_read_unlock(); |
401a8d04 | 3030 | return false; |
db700897 | 3031 | } |
baf59022 | 3032 | |
d6e89786 JB |
3033 | static bool __flush_work(struct work_struct *work, bool from_cancel) |
3034 | { | |
3035 | struct wq_barrier barr; | |
3036 | ||
3037 | if (WARN_ON(!wq_online)) | |
3038 | return false; | |
3039 | ||
4d43d395 TH |
3040 | if (WARN_ON(!work->func)) |
3041 | return false; | |
3042 | ||
87915adc JB |
3043 | if (!from_cancel) { |
3044 | lock_map_acquire(&work->lockdep_map); | |
3045 | lock_map_release(&work->lockdep_map); | |
3046 | } | |
3047 | ||
d6e89786 JB |
3048 | if (start_flush_work(work, &barr, from_cancel)) { |
3049 | wait_for_completion(&barr.done); | |
3050 | destroy_work_on_stack(&barr.work); | |
3051 | return true; | |
3052 | } else { | |
3053 | return false; | |
3054 | } | |
3055 | } | |
3056 | ||
baf59022 TH |
3057 | /** |
3058 | * flush_work - wait for a work to finish executing the last queueing instance | |
3059 | * @work: the work to flush | |
3060 | * | |
606a5020 TH |
3061 | * Wait until @work has finished execution. @work is guaranteed to be idle |
3062 | * on return if it hasn't been requeued since flush started. | |
baf59022 | 3063 | * |
d185af30 | 3064 | * Return: |
baf59022 TH |
3065 | * %true if flush_work() waited for the work to finish execution, |
3066 | * %false if it was already idle. | |
3067 | */ | |
3068 | bool flush_work(struct work_struct *work) | |
3069 | { | |
d6e89786 | 3070 | return __flush_work(work, false); |
6e84d644 | 3071 | } |
606a5020 | 3072 | EXPORT_SYMBOL_GPL(flush_work); |
6e84d644 | 3073 | |
8603e1b3 | 3074 | struct cwt_wait { |
ac6424b9 | 3075 | wait_queue_entry_t wait; |
8603e1b3 TH |
3076 | struct work_struct *work; |
3077 | }; | |
3078 | ||
ac6424b9 | 3079 | static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key) |
8603e1b3 TH |
3080 | { |
3081 | struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait); | |
3082 | ||
3083 | if (cwait->work != key) | |
3084 | return 0; | |
3085 | return autoremove_wake_function(wait, mode, sync, key); | |
3086 | } | |
3087 | ||
36e227d2 | 3088 | static bool __cancel_work_timer(struct work_struct *work, bool is_dwork) |
1f1f642e | 3089 | { |
8603e1b3 | 3090 | static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq); |
bbb68dfa | 3091 | unsigned long flags; |
1f1f642e ON |
3092 | int ret; |
3093 | ||
3094 | do { | |
bbb68dfa TH |
3095 | ret = try_to_grab_pending(work, is_dwork, &flags); |
3096 | /* | |
8603e1b3 TH |
3097 | * If someone else is already canceling, wait for it to |
3098 | * finish. flush_work() doesn't work for PREEMPT_NONE | |
3099 | * because we may get scheduled between @work's completion | |
3100 | * and the other canceling task resuming and clearing | |
3101 | * CANCELING - flush_work() will return false immediately | |
3102 | * as @work is no longer busy, try_to_grab_pending() will | |
3103 | * return -ENOENT as @work is still being canceled and the | |
3104 | * other canceling task won't be able to clear CANCELING as | |
3105 | * we're hogging the CPU. | |
3106 | * | |
3107 | * Let's wait for completion using a waitqueue. As this | |
3108 | * may lead to the thundering herd problem, use a custom | |
3109 | * wake function which matches @work along with exclusive | |
3110 | * wait and wakeup. | |
bbb68dfa | 3111 | */ |
8603e1b3 TH |
3112 | if (unlikely(ret == -ENOENT)) { |
3113 | struct cwt_wait cwait; | |
3114 | ||
3115 | init_wait(&cwait.wait); | |
3116 | cwait.wait.func = cwt_wakefn; | |
3117 | cwait.work = work; | |
3118 | ||
3119 | prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait, | |
3120 | TASK_UNINTERRUPTIBLE); | |
3121 | if (work_is_canceling(work)) | |
3122 | schedule(); | |
3123 | finish_wait(&cancel_waitq, &cwait.wait); | |
3124 | } | |
1f1f642e ON |
3125 | } while (unlikely(ret < 0)); |
3126 | ||
bbb68dfa TH |
3127 | /* tell other tasks trying to grab @work to back off */ |
3128 | mark_work_canceling(work); | |
3129 | local_irq_restore(flags); | |
3130 | ||
3347fa09 TH |
3131 | /* |
3132 | * This allows canceling during early boot. We know that @work | |
3133 | * isn't executing. | |
3134 | */ | |
3135 | if (wq_online) | |
d6e89786 | 3136 | __flush_work(work, true); |
3347fa09 | 3137 | |
7a22ad75 | 3138 | clear_work_data(work); |
8603e1b3 TH |
3139 | |
3140 | /* | |
3141 | * Paired with prepare_to_wait() above so that either | |
3142 | * waitqueue_active() is visible here or !work_is_canceling() is | |
3143 | * visible there. | |
3144 | */ | |
3145 | smp_mb(); | |
3146 | if (waitqueue_active(&cancel_waitq)) | |
3147 | __wake_up(&cancel_waitq, TASK_NORMAL, 1, work); | |
3148 | ||
1f1f642e ON |
3149 | return ret; |
3150 | } | |
3151 | ||
6e84d644 | 3152 | /** |
401a8d04 TH |
3153 | * cancel_work_sync - cancel a work and wait for it to finish |
3154 | * @work: the work to cancel | |
6e84d644 | 3155 | * |
401a8d04 TH |
3156 | * Cancel @work and wait for its execution to finish. This function |
3157 | * can be used even if the work re-queues itself or migrates to | |
3158 | * another workqueue. On return from this function, @work is | |
3159 | * guaranteed to be not pending or executing on any CPU. | |
1f1f642e | 3160 | * |
401a8d04 TH |
3161 | * cancel_work_sync(&delayed_work->work) must not be used for |
3162 | * delayed_work's. Use cancel_delayed_work_sync() instead. | |
6e84d644 | 3163 | * |
401a8d04 | 3164 | * The caller must ensure that the workqueue on which @work was last |
6e84d644 | 3165 | * queued can't be destroyed before this function returns. |
401a8d04 | 3166 | * |
d185af30 | 3167 | * Return: |
401a8d04 | 3168 | * %true if @work was pending, %false otherwise. |
6e84d644 | 3169 | */ |
401a8d04 | 3170 | bool cancel_work_sync(struct work_struct *work) |
6e84d644 | 3171 | { |
36e227d2 | 3172 | return __cancel_work_timer(work, false); |
b89deed3 | 3173 | } |
28e53bdd | 3174 | EXPORT_SYMBOL_GPL(cancel_work_sync); |
b89deed3 | 3175 | |
6e84d644 | 3176 | /** |
401a8d04 TH |
3177 | * flush_delayed_work - wait for a dwork to finish executing the last queueing |
3178 | * @dwork: the delayed work to flush | |
6e84d644 | 3179 | * |
401a8d04 TH |
3180 | * Delayed timer is cancelled and the pending work is queued for |
3181 | * immediate execution. Like flush_work(), this function only | |
3182 | * considers the last queueing instance of @dwork. | |
1f1f642e | 3183 | * |
d185af30 | 3184 | * Return: |
401a8d04 TH |
3185 | * %true if flush_work() waited for the work to finish execution, |
3186 | * %false if it was already idle. | |
6e84d644 | 3187 | */ |
401a8d04 TH |
3188 | bool flush_delayed_work(struct delayed_work *dwork) |
3189 | { | |
8930caba | 3190 | local_irq_disable(); |
401a8d04 | 3191 | if (del_timer_sync(&dwork->timer)) |
60c057bc | 3192 | __queue_work(dwork->cpu, dwork->wq, &dwork->work); |
8930caba | 3193 | local_irq_enable(); |
401a8d04 TH |
3194 | return flush_work(&dwork->work); |
3195 | } | |
3196 | EXPORT_SYMBOL(flush_delayed_work); | |
3197 | ||
05f0fe6b TH |
3198 | /** |
3199 | * flush_rcu_work - wait for a rwork to finish executing the last queueing | |
3200 | * @rwork: the rcu work to flush | |
3201 | * | |
3202 | * Return: | |
3203 | * %true if flush_rcu_work() waited for the work to finish execution, | |
3204 | * %false if it was already idle. | |
3205 | */ | |
3206 | bool flush_rcu_work(struct rcu_work *rwork) | |
3207 | { | |
3208 | if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) { | |
3209 | rcu_barrier(); | |
3210 | flush_work(&rwork->work); | |
3211 | return true; | |
3212 | } else { | |
3213 | return flush_work(&rwork->work); | |
3214 | } | |
3215 | } | |
3216 | EXPORT_SYMBOL(flush_rcu_work); | |
3217 | ||
f72b8792 JA |
3218 | static bool __cancel_work(struct work_struct *work, bool is_dwork) |
3219 | { | |
3220 | unsigned long flags; | |
3221 | int ret; | |
3222 | ||
3223 | do { | |
3224 | ret = try_to_grab_pending(work, is_dwork, &flags); | |
3225 | } while (unlikely(ret == -EAGAIN)); | |
3226 | ||
3227 | if (unlikely(ret < 0)) | |
3228 | return false; | |
3229 | ||
3230 | set_work_pool_and_clear_pending(work, get_work_pool_id(work)); | |
3231 | local_irq_restore(flags); | |
3232 | return ret; | |
3233 | } | |
3234 | ||
09383498 | 3235 | /** |
57b30ae7 TH |
3236 | * cancel_delayed_work - cancel a delayed work |
3237 | * @dwork: delayed_work to cancel | |
09383498 | 3238 | * |
d185af30 YB |
3239 | * Kill off a pending delayed_work. |
3240 | * | |
3241 | * Return: %true if @dwork was pending and canceled; %false if it wasn't | |
3242 | * pending. | |
3243 | * | |
3244 | * Note: | |
3245 | * The work callback function may still be running on return, unless | |
3246 | * it returns %true and the work doesn't re-arm itself. Explicitly flush or | |
3247 | * use cancel_delayed_work_sync() to wait on it. | |
09383498 | 3248 | * |
57b30ae7 | 3249 | * This function is safe to call from any context including IRQ handler. |
09383498 | 3250 | */ |
57b30ae7 | 3251 | bool cancel_delayed_work(struct delayed_work *dwork) |
09383498 | 3252 | { |
f72b8792 | 3253 | return __cancel_work(&dwork->work, true); |
09383498 | 3254 | } |
57b30ae7 | 3255 | EXPORT_SYMBOL(cancel_delayed_work); |
09383498 | 3256 | |
401a8d04 TH |
3257 | /** |
3258 | * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish | |
3259 | * @dwork: the delayed work cancel | |
3260 | * | |
3261 | * This is cancel_work_sync() for delayed works. | |
3262 | * | |
d185af30 | 3263 | * Return: |
401a8d04 TH |
3264 | * %true if @dwork was pending, %false otherwise. |
3265 | */ | |
3266 | bool cancel_delayed_work_sync(struct delayed_work *dwork) | |
6e84d644 | 3267 | { |
36e227d2 | 3268 | return __cancel_work_timer(&dwork->work, true); |
6e84d644 | 3269 | } |
f5a421a4 | 3270 | EXPORT_SYMBOL(cancel_delayed_work_sync); |
1da177e4 | 3271 | |
b6136773 | 3272 | /** |
31ddd871 | 3273 | * schedule_on_each_cpu - execute a function synchronously on each online CPU |
b6136773 | 3274 | * @func: the function to call |
b6136773 | 3275 | * |
31ddd871 TH |
3276 | * schedule_on_each_cpu() executes @func on each online CPU using the |
3277 | * system workqueue and blocks until all CPUs have completed. | |
b6136773 | 3278 | * schedule_on_each_cpu() is very slow. |
31ddd871 | 3279 | * |
d185af30 | 3280 | * Return: |
31ddd871 | 3281 | * 0 on success, -errno on failure. |
b6136773 | 3282 | */ |
65f27f38 | 3283 | int schedule_on_each_cpu(work_func_t func) |
15316ba8 CL |
3284 | { |
3285 | int cpu; | |
38f51568 | 3286 | struct work_struct __percpu *works; |
15316ba8 | 3287 | |
b6136773 AM |
3288 | works = alloc_percpu(struct work_struct); |
3289 | if (!works) | |
15316ba8 | 3290 | return -ENOMEM; |
b6136773 | 3291 | |
93981800 TH |
3292 | get_online_cpus(); |
3293 | ||
15316ba8 | 3294 | for_each_online_cpu(cpu) { |
9bfb1839 IM |
3295 | struct work_struct *work = per_cpu_ptr(works, cpu); |
3296 | ||
3297 | INIT_WORK(work, func); | |
b71ab8c2 | 3298 | schedule_work_on(cpu, work); |
65a64464 | 3299 | } |
93981800 TH |
3300 | |
3301 | for_each_online_cpu(cpu) | |
3302 | flush_work(per_cpu_ptr(works, cpu)); | |
3303 | ||
95402b38 | 3304 | put_online_cpus(); |
b6136773 | 3305 | free_percpu(works); |
15316ba8 CL |
3306 | return 0; |
3307 | } | |
3308 | ||
1fa44eca JB |
3309 | /** |
3310 | * execute_in_process_context - reliably execute the routine with user context | |
3311 | * @fn: the function to execute | |
1fa44eca JB |
3312 | * @ew: guaranteed storage for the execute work structure (must |
3313 | * be available when the work executes) | |
3314 | * | |
3315 | * Executes the function immediately if process context is available, | |
3316 | * otherwise schedules the function for delayed execution. | |
3317 | * | |
d185af30 | 3318 | * Return: 0 - function was executed |
1fa44eca JB |
3319 | * 1 - function was scheduled for execution |
3320 | */ | |
65f27f38 | 3321 | int execute_in_process_context(work_func_t fn, struct execute_work *ew) |
1fa44eca JB |
3322 | { |
3323 | if (!in_interrupt()) { | |
65f27f38 | 3324 | fn(&ew->work); |
1fa44eca JB |
3325 | return 0; |
3326 | } | |
3327 | ||
65f27f38 | 3328 | INIT_WORK(&ew->work, fn); |
1fa44eca JB |
3329 | schedule_work(&ew->work); |
3330 | ||
3331 | return 1; | |
3332 | } | |
3333 | EXPORT_SYMBOL_GPL(execute_in_process_context); | |
3334 | ||
6ba94429 FW |
3335 | /** |
3336 | * free_workqueue_attrs - free a workqueue_attrs | |
3337 | * @attrs: workqueue_attrs to free | |
226223ab | 3338 | * |
6ba94429 | 3339 | * Undo alloc_workqueue_attrs(). |
226223ab | 3340 | */ |
513c98d0 | 3341 | void free_workqueue_attrs(struct workqueue_attrs *attrs) |
226223ab | 3342 | { |
6ba94429 FW |
3343 | if (attrs) { |
3344 | free_cpumask_var(attrs->cpumask); | |
3345 | kfree(attrs); | |
3346 | } | |
226223ab TH |
3347 | } |
3348 | ||
6ba94429 FW |
3349 | /** |
3350 | * alloc_workqueue_attrs - allocate a workqueue_attrs | |
6ba94429 FW |
3351 | * |
3352 | * Allocate a new workqueue_attrs, initialize with default settings and | |
3353 | * return it. | |
3354 | * | |
3355 | * Return: The allocated new workqueue_attr on success. %NULL on failure. | |
3356 | */ | |
513c98d0 | 3357 | struct workqueue_attrs *alloc_workqueue_attrs(void) |
226223ab | 3358 | { |
6ba94429 | 3359 | struct workqueue_attrs *attrs; |
226223ab | 3360 | |
be69d00d | 3361 | attrs = kzalloc(sizeof(*attrs), GFP_KERNEL); |
6ba94429 FW |
3362 | if (!attrs) |
3363 | goto fail; | |
be69d00d | 3364 | if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL)) |
6ba94429 FW |
3365 | goto fail; |
3366 | ||
3367 | cpumask_copy(attrs->cpumask, cpu_possible_mask); | |
3368 | return attrs; | |
3369 | fail: | |
3370 | free_workqueue_attrs(attrs); | |
3371 | return NULL; | |
226223ab TH |
3372 | } |
3373 | ||
6ba94429 FW |
3374 | static void copy_workqueue_attrs(struct workqueue_attrs *to, |
3375 | const struct workqueue_attrs *from) | |
226223ab | 3376 | { |
6ba94429 FW |
3377 | to->nice = from->nice; |
3378 | cpumask_copy(to->cpumask, from->cpumask); | |
3379 | /* | |
3380 | * Unlike hash and equality test, this function doesn't ignore | |
3381 | * ->no_numa as it is used for both pool and wq attrs. Instead, | |
3382 | * get_unbound_pool() explicitly clears ->no_numa after copying. | |
3383 | */ | |
3384 | to->no_numa = from->no_numa; | |
226223ab TH |
3385 | } |
3386 | ||
6ba94429 FW |
3387 | /* hash value of the content of @attr */ |
3388 | static u32 wqattrs_hash(const struct workqueue_attrs *attrs) | |
226223ab | 3389 | { |
6ba94429 | 3390 | u32 hash = 0; |
226223ab | 3391 | |
6ba94429 FW |
3392 | hash = jhash_1word(attrs->nice, hash); |
3393 | hash = jhash(cpumask_bits(attrs->cpumask), | |
3394 | BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); | |
3395 | return hash; | |
226223ab | 3396 | } |
226223ab | 3397 | |
6ba94429 FW |
3398 | /* content equality test */ |
3399 | static bool wqattrs_equal(const struct workqueue_attrs *a, | |
3400 | const struct workqueue_attrs *b) | |
226223ab | 3401 | { |
6ba94429 FW |
3402 | if (a->nice != b->nice) |
3403 | return false; | |
3404 | if (!cpumask_equal(a->cpumask, b->cpumask)) | |
3405 | return false; | |
3406 | return true; | |
226223ab TH |
3407 | } |
3408 | ||
6ba94429 FW |
3409 | /** |
3410 | * init_worker_pool - initialize a newly zalloc'd worker_pool | |
3411 | * @pool: worker_pool to initialize | |
3412 | * | |
402dd89d | 3413 | * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs. |
6ba94429 FW |
3414 | * |
3415 | * Return: 0 on success, -errno on failure. Even on failure, all fields | |
3416 | * inside @pool proper are initialized and put_unbound_pool() can be called | |
3417 | * on @pool safely to release it. | |
3418 | */ | |
3419 | static int init_worker_pool(struct worker_pool *pool) | |
226223ab | 3420 | { |
6ba94429 FW |
3421 | spin_lock_init(&pool->lock); |
3422 | pool->id = -1; | |
3423 | pool->cpu = -1; | |
3424 | pool->node = NUMA_NO_NODE; | |
3425 | pool->flags |= POOL_DISASSOCIATED; | |
82607adc | 3426 | pool->watchdog_ts = jiffies; |
6ba94429 FW |
3427 | INIT_LIST_HEAD(&pool->worklist); |
3428 | INIT_LIST_HEAD(&pool->idle_list); | |
3429 | hash_init(pool->busy_hash); | |
226223ab | 3430 | |
32a6c723 | 3431 | timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE); |
226223ab | 3432 | |
32a6c723 | 3433 | timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0); |
226223ab | 3434 | |
6ba94429 | 3435 | INIT_LIST_HEAD(&pool->workers); |
226223ab | 3436 | |
6ba94429 FW |
3437 | ida_init(&pool->worker_ida); |
3438 | INIT_HLIST_NODE(&pool->hash_node); | |
3439 | pool->refcnt = 1; | |
226223ab | 3440 | |
6ba94429 | 3441 | /* shouldn't fail above this point */ |
be69d00d | 3442 | pool->attrs = alloc_workqueue_attrs(); |
6ba94429 FW |
3443 | if (!pool->attrs) |
3444 | return -ENOMEM; | |
3445 | return 0; | |
226223ab TH |
3446 | } |
3447 | ||
669de8bd BVA |
3448 | #ifdef CONFIG_LOCKDEP |
3449 | static void wq_init_lockdep(struct workqueue_struct *wq) | |
3450 | { | |
3451 | char *lock_name; | |
3452 | ||
3453 | lockdep_register_key(&wq->key); | |
3454 | lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name); | |
3455 | if (!lock_name) | |
3456 | lock_name = wq->name; | |
69a106c0 QC |
3457 | |
3458 | wq->lock_name = lock_name; | |
669de8bd BVA |
3459 | lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0); |
3460 | } | |
3461 | ||
3462 | static void wq_unregister_lockdep(struct workqueue_struct *wq) | |
3463 | { | |
3464 | lockdep_unregister_key(&wq->key); | |
3465 | } | |
3466 | ||
3467 | static void wq_free_lockdep(struct workqueue_struct *wq) | |
3468 | { | |
3469 | if (wq->lock_name != wq->name) | |
3470 | kfree(wq->lock_name); | |
3471 | } | |
3472 | #else | |
3473 | static void wq_init_lockdep(struct workqueue_struct *wq) | |
3474 | { | |
3475 | } | |
3476 | ||
3477 | static void wq_unregister_lockdep(struct workqueue_struct *wq) | |
3478 | { | |
3479 | } | |
3480 | ||
3481 | static void wq_free_lockdep(struct workqueue_struct *wq) | |
3482 | { | |
3483 | } | |
3484 | #endif | |
3485 | ||
6ba94429 | 3486 | static void rcu_free_wq(struct rcu_head *rcu) |
226223ab | 3487 | { |
6ba94429 FW |
3488 | struct workqueue_struct *wq = |
3489 | container_of(rcu, struct workqueue_struct, rcu); | |
226223ab | 3490 | |
669de8bd BVA |
3491 | wq_free_lockdep(wq); |
3492 | ||
6ba94429 FW |
3493 | if (!(wq->flags & WQ_UNBOUND)) |
3494 | free_percpu(wq->cpu_pwqs); | |
226223ab | 3495 | else |
6ba94429 | 3496 | free_workqueue_attrs(wq->unbound_attrs); |
226223ab | 3497 | |
6ba94429 FW |
3498 | kfree(wq->rescuer); |
3499 | kfree(wq); | |
226223ab TH |
3500 | } |
3501 | ||
6ba94429 | 3502 | static void rcu_free_pool(struct rcu_head *rcu) |
226223ab | 3503 | { |
6ba94429 | 3504 | struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu); |
226223ab | 3505 | |
6ba94429 FW |
3506 | ida_destroy(&pool->worker_ida); |
3507 | free_workqueue_attrs(pool->attrs); | |
3508 | kfree(pool); | |
226223ab TH |
3509 | } |
3510 | ||
6ba94429 FW |
3511 | /** |
3512 | * put_unbound_pool - put a worker_pool | |
3513 | * @pool: worker_pool to put | |
3514 | * | |
24acfb71 | 3515 | * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU |
6ba94429 FW |
3516 | * safe manner. get_unbound_pool() calls this function on its failure path |
3517 | * and this function should be able to release pools which went through, | |
3518 | * successfully or not, init_worker_pool(). | |
3519 | * | |
3520 | * Should be called with wq_pool_mutex held. | |
3521 | */ | |
3522 | static void put_unbound_pool(struct worker_pool *pool) | |
226223ab | 3523 | { |
6ba94429 FW |
3524 | DECLARE_COMPLETION_ONSTACK(detach_completion); |
3525 | struct worker *worker; | |
226223ab | 3526 | |
6ba94429 | 3527 | lockdep_assert_held(&wq_pool_mutex); |
226223ab | 3528 | |
6ba94429 FW |
3529 | if (--pool->refcnt) |
3530 | return; | |
226223ab | 3531 | |
6ba94429 FW |
3532 | /* sanity checks */ |
3533 | if (WARN_ON(!(pool->cpu < 0)) || | |
3534 | WARN_ON(!list_empty(&pool->worklist))) | |
3535 | return; | |
226223ab | 3536 | |
6ba94429 FW |
3537 | /* release id and unhash */ |
3538 | if (pool->id >= 0) | |
3539 | idr_remove(&worker_pool_idr, pool->id); | |
3540 | hash_del(&pool->hash_node); | |
d55262c4 | 3541 | |
6ba94429 | 3542 | /* |
692b4825 TH |
3543 | * Become the manager and destroy all workers. This prevents |
3544 | * @pool's workers from blocking on attach_mutex. We're the last | |
3545 | * manager and @pool gets freed with the flag set. | |
6ba94429 | 3546 | */ |
6ba94429 | 3547 | spin_lock_irq(&pool->lock); |
692b4825 TH |
3548 | wait_event_lock_irq(wq_manager_wait, |
3549 | !(pool->flags & POOL_MANAGER_ACTIVE), pool->lock); | |
3550 | pool->flags |= POOL_MANAGER_ACTIVE; | |
3551 | ||
6ba94429 FW |
3552 | while ((worker = first_idle_worker(pool))) |
3553 | destroy_worker(worker); | |
3554 | WARN_ON(pool->nr_workers || pool->nr_idle); | |
3555 | spin_unlock_irq(&pool->lock); | |
d55262c4 | 3556 | |
1258fae7 | 3557 | mutex_lock(&wq_pool_attach_mutex); |
6ba94429 FW |
3558 | if (!list_empty(&pool->workers)) |
3559 | pool->detach_completion = &detach_completion; | |
1258fae7 | 3560 | mutex_unlock(&wq_pool_attach_mutex); |
226223ab | 3561 | |
6ba94429 FW |
3562 | if (pool->detach_completion) |
3563 | wait_for_completion(pool->detach_completion); | |
226223ab | 3564 | |
6ba94429 FW |
3565 | /* shut down the timers */ |
3566 | del_timer_sync(&pool->idle_timer); | |
3567 | del_timer_sync(&pool->mayday_timer); | |
226223ab | 3568 | |
24acfb71 | 3569 | /* RCU protected to allow dereferences from get_work_pool() */ |
25b00775 | 3570 | call_rcu(&pool->rcu, rcu_free_pool); |
226223ab TH |
3571 | } |
3572 | ||
3573 | /** | |
6ba94429 FW |
3574 | * get_unbound_pool - get a worker_pool with the specified attributes |
3575 | * @attrs: the attributes of the worker_pool to get | |
226223ab | 3576 | * |
6ba94429 FW |
3577 | * Obtain a worker_pool which has the same attributes as @attrs, bump the |
3578 | * reference count and return it. If there already is a matching | |
3579 | * worker_pool, it will be used; otherwise, this function attempts to | |
3580 | * create a new one. | |
226223ab | 3581 | * |
6ba94429 | 3582 | * Should be called with wq_pool_mutex held. |
226223ab | 3583 | * |
6ba94429 FW |
3584 | * Return: On success, a worker_pool with the same attributes as @attrs. |
3585 | * On failure, %NULL. | |
226223ab | 3586 | */ |
6ba94429 | 3587 | static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs) |
226223ab | 3588 | { |
6ba94429 FW |
3589 | u32 hash = wqattrs_hash(attrs); |
3590 | struct worker_pool *pool; | |
3591 | int node; | |
e2273584 | 3592 | int target_node = NUMA_NO_NODE; |
226223ab | 3593 | |
6ba94429 | 3594 | lockdep_assert_held(&wq_pool_mutex); |
226223ab | 3595 | |
6ba94429 FW |
3596 | /* do we already have a matching pool? */ |
3597 | hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) { | |
3598 | if (wqattrs_equal(pool->attrs, attrs)) { | |
3599 | pool->refcnt++; | |
3600 | return pool; | |
3601 | } | |
3602 | } | |
226223ab | 3603 | |
e2273584 XP |
3604 | /* if cpumask is contained inside a NUMA node, we belong to that node */ |
3605 | if (wq_numa_enabled) { | |
3606 | for_each_node(node) { | |
3607 | if (cpumask_subset(attrs->cpumask, | |
3608 | wq_numa_possible_cpumask[node])) { | |
3609 | target_node = node; | |
3610 | break; | |
3611 | } | |
3612 | } | |
3613 | } | |
3614 | ||
6ba94429 | 3615 | /* nope, create a new one */ |
e2273584 | 3616 | pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node); |
6ba94429 FW |
3617 | if (!pool || init_worker_pool(pool) < 0) |
3618 | goto fail; | |
3619 | ||
3620 | lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */ | |
3621 | copy_workqueue_attrs(pool->attrs, attrs); | |
e2273584 | 3622 | pool->node = target_node; |
226223ab TH |
3623 | |
3624 | /* | |
6ba94429 FW |
3625 | * no_numa isn't a worker_pool attribute, always clear it. See |
3626 | * 'struct workqueue_attrs' comments for detail. | |
226223ab | 3627 | */ |
6ba94429 | 3628 | pool->attrs->no_numa = false; |
226223ab | 3629 | |
6ba94429 FW |
3630 | if (worker_pool_assign_id(pool) < 0) |
3631 | goto fail; | |
226223ab | 3632 | |
6ba94429 | 3633 | /* create and start the initial worker */ |
3347fa09 | 3634 | if (wq_online && !create_worker(pool)) |
6ba94429 | 3635 | goto fail; |
226223ab | 3636 | |
6ba94429 FW |
3637 | /* install */ |
3638 | hash_add(unbound_pool_hash, &pool->hash_node, hash); | |
226223ab | 3639 | |
6ba94429 FW |
3640 | return pool; |
3641 | fail: | |
3642 | if (pool) | |
3643 | put_unbound_pool(pool); | |
3644 | return NULL; | |
226223ab | 3645 | } |
226223ab | 3646 | |
6ba94429 | 3647 | static void rcu_free_pwq(struct rcu_head *rcu) |
7a4e344c | 3648 | { |
6ba94429 FW |
3649 | kmem_cache_free(pwq_cache, |
3650 | container_of(rcu, struct pool_workqueue, rcu)); | |
7a4e344c TH |
3651 | } |
3652 | ||
6ba94429 FW |
3653 | /* |
3654 | * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt | |
3655 | * and needs to be destroyed. | |
7a4e344c | 3656 | */ |
6ba94429 | 3657 | static void pwq_unbound_release_workfn(struct work_struct *work) |
7a4e344c | 3658 | { |
6ba94429 FW |
3659 | struct pool_workqueue *pwq = container_of(work, struct pool_workqueue, |
3660 | unbound_release_work); | |
3661 | struct workqueue_struct *wq = pwq->wq; | |
3662 | struct worker_pool *pool = pwq->pool; | |
3663 | bool is_last; | |
7a4e344c | 3664 | |
6ba94429 FW |
3665 | if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND))) |
3666 | return; | |
7a4e344c | 3667 | |
6ba94429 FW |
3668 | mutex_lock(&wq->mutex); |
3669 | list_del_rcu(&pwq->pwqs_node); | |
3670 | is_last = list_empty(&wq->pwqs); | |
3671 | mutex_unlock(&wq->mutex); | |
3672 | ||
3673 | mutex_lock(&wq_pool_mutex); | |
3674 | put_unbound_pool(pool); | |
3675 | mutex_unlock(&wq_pool_mutex); | |
3676 | ||
25b00775 | 3677 | call_rcu(&pwq->rcu, rcu_free_pwq); |
7a4e344c | 3678 | |
2865a8fb | 3679 | /* |
6ba94429 FW |
3680 | * If we're the last pwq going away, @wq is already dead and no one |
3681 | * is gonna access it anymore. Schedule RCU free. | |
2865a8fb | 3682 | */ |
669de8bd BVA |
3683 | if (is_last) { |
3684 | wq_unregister_lockdep(wq); | |
25b00775 | 3685 | call_rcu(&wq->rcu, rcu_free_wq); |
669de8bd | 3686 | } |
29c91e99 TH |
3687 | } |
3688 | ||
7a4e344c | 3689 | /** |
6ba94429 FW |
3690 | * pwq_adjust_max_active - update a pwq's max_active to the current setting |
3691 | * @pwq: target pool_workqueue | |
d185af30 | 3692 | * |
6ba94429 FW |
3693 | * If @pwq isn't freezing, set @pwq->max_active to the associated |
3694 | * workqueue's saved_max_active and activate delayed work items | |
3695 | * accordingly. If @pwq is freezing, clear @pwq->max_active to zero. | |
7a4e344c | 3696 | */ |
6ba94429 | 3697 | static void pwq_adjust_max_active(struct pool_workqueue *pwq) |
4e1a1f9a | 3698 | { |
6ba94429 FW |
3699 | struct workqueue_struct *wq = pwq->wq; |
3700 | bool freezable = wq->flags & WQ_FREEZABLE; | |
3347fa09 | 3701 | unsigned long flags; |
4e1a1f9a | 3702 | |
6ba94429 FW |
3703 | /* for @wq->saved_max_active */ |
3704 | lockdep_assert_held(&wq->mutex); | |
4e1a1f9a | 3705 | |
6ba94429 FW |
3706 | /* fast exit for non-freezable wqs */ |
3707 | if (!freezable && pwq->max_active == wq->saved_max_active) | |
3708 | return; | |
7a4e344c | 3709 | |
3347fa09 TH |
3710 | /* this function can be called during early boot w/ irq disabled */ |
3711 | spin_lock_irqsave(&pwq->pool->lock, flags); | |
29c91e99 | 3712 | |
6ba94429 FW |
3713 | /* |
3714 | * During [un]freezing, the caller is responsible for ensuring that | |
3715 | * this function is called at least once after @workqueue_freezing | |
3716 | * is updated and visible. | |
3717 | */ | |
3718 | if (!freezable || !workqueue_freezing) { | |
3719 | pwq->max_active = wq->saved_max_active; | |
4e1a1f9a | 3720 | |
6ba94429 FW |
3721 | while (!list_empty(&pwq->delayed_works) && |
3722 | pwq->nr_active < pwq->max_active) | |
3723 | pwq_activate_first_delayed(pwq); | |
e2dca7ad | 3724 | |
6ba94429 FW |
3725 | /* |
3726 | * Need to kick a worker after thawed or an unbound wq's | |
3727 | * max_active is bumped. It's a slow path. Do it always. | |
3728 | */ | |
3729 | wake_up_worker(pwq->pool); | |
3730 | } else { | |
3731 | pwq->max_active = 0; | |
3732 | } | |
e2dca7ad | 3733 | |
3347fa09 | 3734 | spin_unlock_irqrestore(&pwq->pool->lock, flags); |
e2dca7ad TH |
3735 | } |
3736 | ||
6ba94429 FW |
3737 | /* initialize newly alloced @pwq which is associated with @wq and @pool */ |
3738 | static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq, | |
3739 | struct worker_pool *pool) | |
29c91e99 | 3740 | { |
6ba94429 | 3741 | BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK); |
29c91e99 | 3742 | |
6ba94429 FW |
3743 | memset(pwq, 0, sizeof(*pwq)); |
3744 | ||
3745 | pwq->pool = pool; | |
3746 | pwq->wq = wq; | |
3747 | pwq->flush_color = -1; | |
3748 | pwq->refcnt = 1; | |
3749 | INIT_LIST_HEAD(&pwq->delayed_works); | |
3750 | INIT_LIST_HEAD(&pwq->pwqs_node); | |
3751 | INIT_LIST_HEAD(&pwq->mayday_node); | |
3752 | INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn); | |
29c91e99 TH |
3753 | } |
3754 | ||
6ba94429 FW |
3755 | /* sync @pwq with the current state of its associated wq and link it */ |
3756 | static void link_pwq(struct pool_workqueue *pwq) | |
29c91e99 | 3757 | { |
6ba94429 | 3758 | struct workqueue_struct *wq = pwq->wq; |
29c91e99 | 3759 | |
6ba94429 | 3760 | lockdep_assert_held(&wq->mutex); |
a892cacc | 3761 | |
6ba94429 FW |
3762 | /* may be called multiple times, ignore if already linked */ |
3763 | if (!list_empty(&pwq->pwqs_node)) | |
29c91e99 | 3764 | return; |
29c91e99 | 3765 | |
6ba94429 FW |
3766 | /* set the matching work_color */ |
3767 | pwq->work_color = wq->work_color; | |
29c91e99 | 3768 | |
6ba94429 FW |
3769 | /* sync max_active to the current setting */ |
3770 | pwq_adjust_max_active(pwq); | |
29c91e99 | 3771 | |
6ba94429 FW |
3772 | /* link in @pwq */ |
3773 | list_add_rcu(&pwq->pwqs_node, &wq->pwqs); | |
3774 | } | |
29c91e99 | 3775 | |
6ba94429 FW |
3776 | /* obtain a pool matching @attr and create a pwq associating the pool and @wq */ |
3777 | static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq, | |
3778 | const struct workqueue_attrs *attrs) | |
3779 | { | |
3780 | struct worker_pool *pool; | |
3781 | struct pool_workqueue *pwq; | |
60f5a4bc | 3782 | |
6ba94429 | 3783 | lockdep_assert_held(&wq_pool_mutex); |
60f5a4bc | 3784 | |
6ba94429 FW |
3785 | pool = get_unbound_pool(attrs); |
3786 | if (!pool) | |
3787 | return NULL; | |
60f5a4bc | 3788 | |
6ba94429 FW |
3789 | pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node); |
3790 | if (!pwq) { | |
3791 | put_unbound_pool(pool); | |
3792 | return NULL; | |
3793 | } | |
29c91e99 | 3794 | |
6ba94429 FW |
3795 | init_pwq(pwq, wq, pool); |
3796 | return pwq; | |
3797 | } | |
29c91e99 | 3798 | |
29c91e99 | 3799 | /** |
30186c6f | 3800 | * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node |
042f7df1 | 3801 | * @attrs: the wq_attrs of the default pwq of the target workqueue |
6ba94429 FW |
3802 | * @node: the target NUMA node |
3803 | * @cpu_going_down: if >= 0, the CPU to consider as offline | |
3804 | * @cpumask: outarg, the resulting cpumask | |
29c91e99 | 3805 | * |
6ba94429 FW |
3806 | * Calculate the cpumask a workqueue with @attrs should use on @node. If |
3807 | * @cpu_going_down is >= 0, that cpu is considered offline during | |
3808 | * calculation. The result is stored in @cpumask. | |
a892cacc | 3809 | * |
6ba94429 FW |
3810 | * If NUMA affinity is not enabled, @attrs->cpumask is always used. If |
3811 | * enabled and @node has online CPUs requested by @attrs, the returned | |
3812 | * cpumask is the intersection of the possible CPUs of @node and | |
3813 | * @attrs->cpumask. | |
d185af30 | 3814 | * |
6ba94429 FW |
3815 | * The caller is responsible for ensuring that the cpumask of @node stays |
3816 | * stable. | |
3817 | * | |
3818 | * Return: %true if the resulting @cpumask is different from @attrs->cpumask, | |
3819 | * %false if equal. | |
29c91e99 | 3820 | */ |
6ba94429 FW |
3821 | static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node, |
3822 | int cpu_going_down, cpumask_t *cpumask) | |
29c91e99 | 3823 | { |
6ba94429 FW |
3824 | if (!wq_numa_enabled || attrs->no_numa) |
3825 | goto use_dfl; | |
29c91e99 | 3826 | |
6ba94429 FW |
3827 | /* does @node have any online CPUs @attrs wants? */ |
3828 | cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask); | |
3829 | if (cpu_going_down >= 0) | |
3830 | cpumask_clear_cpu(cpu_going_down, cpumask); | |
29c91e99 | 3831 | |
6ba94429 FW |
3832 | if (cpumask_empty(cpumask)) |
3833 | goto use_dfl; | |
4c16bd32 TH |
3834 | |
3835 | /* yeap, return possible CPUs in @node that @attrs wants */ | |
3836 | cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]); | |
1ad0f0a7 MB |
3837 | |
3838 | if (cpumask_empty(cpumask)) { | |
3839 | pr_warn_once("WARNING: workqueue cpumask: online intersect > " | |
3840 | "possible intersect\n"); | |
3841 | return false; | |
3842 | } | |
3843 | ||
4c16bd32 TH |
3844 | return !cpumask_equal(cpumask, attrs->cpumask); |
3845 | ||
3846 | use_dfl: | |
3847 | cpumask_copy(cpumask, attrs->cpumask); | |
3848 | return false; | |
3849 | } | |
3850 | ||
1befcf30 TH |
3851 | /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */ |
3852 | static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq, | |
3853 | int node, | |
3854 | struct pool_workqueue *pwq) | |
3855 | { | |
3856 | struct pool_workqueue *old_pwq; | |
3857 | ||
5b95e1af | 3858 | lockdep_assert_held(&wq_pool_mutex); |
1befcf30 TH |
3859 | lockdep_assert_held(&wq->mutex); |
3860 | ||
3861 | /* link_pwq() can handle duplicate calls */ | |
3862 | link_pwq(pwq); | |
3863 | ||
3864 | old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]); | |
3865 | rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq); | |
3866 | return old_pwq; | |
3867 | } | |
3868 | ||
2d5f0764 LJ |
3869 | /* context to store the prepared attrs & pwqs before applying */ |
3870 | struct apply_wqattrs_ctx { | |
3871 | struct workqueue_struct *wq; /* target workqueue */ | |
3872 | struct workqueue_attrs *attrs; /* attrs to apply */ | |
042f7df1 | 3873 | struct list_head list; /* queued for batching commit */ |
2d5f0764 LJ |
3874 | struct pool_workqueue *dfl_pwq; |
3875 | struct pool_workqueue *pwq_tbl[]; | |
3876 | }; | |
3877 | ||
3878 | /* free the resources after success or abort */ | |
3879 | static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx) | |
3880 | { | |
3881 | if (ctx) { | |
3882 | int node; | |
3883 | ||
3884 | for_each_node(node) | |
3885 | put_pwq_unlocked(ctx->pwq_tbl[node]); | |
3886 | put_pwq_unlocked(ctx->dfl_pwq); | |
3887 | ||
3888 | free_workqueue_attrs(ctx->attrs); | |
3889 | ||
3890 | kfree(ctx); | |
3891 | } | |
3892 | } | |
3893 | ||
3894 | /* allocate the attrs and pwqs for later installation */ | |
3895 | static struct apply_wqattrs_ctx * | |
3896 | apply_wqattrs_prepare(struct workqueue_struct *wq, | |
3897 | const struct workqueue_attrs *attrs) | |
9e8cd2f5 | 3898 | { |
2d5f0764 | 3899 | struct apply_wqattrs_ctx *ctx; |
4c16bd32 | 3900 | struct workqueue_attrs *new_attrs, *tmp_attrs; |
2d5f0764 | 3901 | int node; |
9e8cd2f5 | 3902 | |
2d5f0764 | 3903 | lockdep_assert_held(&wq_pool_mutex); |
9e8cd2f5 | 3904 | |
acafe7e3 | 3905 | ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL); |
8719dcea | 3906 | |
be69d00d TG |
3907 | new_attrs = alloc_workqueue_attrs(); |
3908 | tmp_attrs = alloc_workqueue_attrs(); | |
2d5f0764 LJ |
3909 | if (!ctx || !new_attrs || !tmp_attrs) |
3910 | goto out_free; | |
13e2e556 | 3911 | |
042f7df1 LJ |
3912 | /* |
3913 | * Calculate the attrs of the default pwq. | |
3914 | * If the user configured cpumask doesn't overlap with the | |
3915 | * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask. | |
3916 | */ | |
13e2e556 | 3917 | copy_workqueue_attrs(new_attrs, attrs); |
b05a7928 | 3918 | cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask); |
042f7df1 LJ |
3919 | if (unlikely(cpumask_empty(new_attrs->cpumask))) |
3920 | cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask); | |
13e2e556 | 3921 | |
4c16bd32 TH |
3922 | /* |
3923 | * We may create multiple pwqs with differing cpumasks. Make a | |
3924 | * copy of @new_attrs which will be modified and used to obtain | |
3925 | * pools. | |
3926 | */ | |
3927 | copy_workqueue_attrs(tmp_attrs, new_attrs); | |
3928 | ||
4c16bd32 TH |
3929 | /* |
3930 | * If something goes wrong during CPU up/down, we'll fall back to | |
3931 | * the default pwq covering whole @attrs->cpumask. Always create | |
3932 | * it even if we don't use it immediately. | |
3933 | */ | |
2d5f0764 LJ |
3934 | ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs); |
3935 | if (!ctx->dfl_pwq) | |
3936 | goto out_free; | |
4c16bd32 TH |
3937 | |
3938 | for_each_node(node) { | |
042f7df1 | 3939 | if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) { |
2d5f0764 LJ |
3940 | ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs); |
3941 | if (!ctx->pwq_tbl[node]) | |
3942 | goto out_free; | |
4c16bd32 | 3943 | } else { |
2d5f0764 LJ |
3944 | ctx->dfl_pwq->refcnt++; |
3945 | ctx->pwq_tbl[node] = ctx->dfl_pwq; | |
4c16bd32 TH |
3946 | } |
3947 | } | |
3948 | ||
042f7df1 LJ |
3949 | /* save the user configured attrs and sanitize it. */ |
3950 | copy_workqueue_attrs(new_attrs, attrs); | |
3951 | cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask); | |
2d5f0764 | 3952 | ctx->attrs = new_attrs; |
042f7df1 | 3953 | |
2d5f0764 LJ |
3954 | ctx->wq = wq; |
3955 | free_workqueue_attrs(tmp_attrs); | |
3956 | return ctx; | |
3957 | ||
3958 | out_free: | |
3959 | free_workqueue_attrs(tmp_attrs); | |
3960 | free_workqueue_attrs(new_attrs); | |
3961 | apply_wqattrs_cleanup(ctx); | |
3962 | return NULL; | |
3963 | } | |
3964 | ||
3965 | /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */ | |
3966 | static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx) | |
3967 | { | |
3968 | int node; | |
9e8cd2f5 | 3969 | |
4c16bd32 | 3970 | /* all pwqs have been created successfully, let's install'em */ |
2d5f0764 | 3971 | mutex_lock(&ctx->wq->mutex); |
a892cacc | 3972 | |
2d5f0764 | 3973 | copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs); |
4c16bd32 TH |
3974 | |
3975 | /* save the previous pwq and install the new one */ | |
f147f29e | 3976 | for_each_node(node) |
2d5f0764 LJ |
3977 | ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node, |
3978 | ctx->pwq_tbl[node]); | |
4c16bd32 TH |
3979 | |
3980 | /* @dfl_pwq might not have been used, ensure it's linked */ | |
2d5f0764 LJ |
3981 | link_pwq(ctx->dfl_pwq); |
3982 | swap(ctx->wq->dfl_pwq, ctx->dfl_pwq); | |
f147f29e | 3983 | |
2d5f0764 LJ |
3984 | mutex_unlock(&ctx->wq->mutex); |
3985 | } | |
9e8cd2f5 | 3986 | |
a0111cf6 LJ |
3987 | static void apply_wqattrs_lock(void) |
3988 | { | |
3989 | /* CPUs should stay stable across pwq creations and installations */ | |
3990 | get_online_cpus(); | |
3991 | mutex_lock(&wq_pool_mutex); | |
3992 | } | |
3993 | ||
3994 | static void apply_wqattrs_unlock(void) | |
3995 | { | |
3996 | mutex_unlock(&wq_pool_mutex); | |
3997 | put_online_cpus(); | |
3998 | } | |
3999 | ||
4000 | static int apply_workqueue_attrs_locked(struct workqueue_struct *wq, | |
4001 | const struct workqueue_attrs *attrs) | |
2d5f0764 LJ |
4002 | { |
4003 | struct apply_wqattrs_ctx *ctx; | |
4c16bd32 | 4004 | |
2d5f0764 LJ |
4005 | /* only unbound workqueues can change attributes */ |
4006 | if (WARN_ON(!(wq->flags & WQ_UNBOUND))) | |
4007 | return -EINVAL; | |
13e2e556 | 4008 | |
2d5f0764 | 4009 | /* creating multiple pwqs breaks ordering guarantee */ |
0a94efb5 TH |
4010 | if (!list_empty(&wq->pwqs)) { |
4011 | if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) | |
4012 | return -EINVAL; | |
4013 | ||
4014 | wq->flags &= ~__WQ_ORDERED; | |
4015 | } | |
2d5f0764 | 4016 | |
2d5f0764 | 4017 | ctx = apply_wqattrs_prepare(wq, attrs); |
6201171e | 4018 | if (!ctx) |
4019 | return -ENOMEM; | |
2d5f0764 LJ |
4020 | |
4021 | /* the ctx has been prepared successfully, let's commit it */ | |
6201171e | 4022 | apply_wqattrs_commit(ctx); |
2d5f0764 LJ |
4023 | apply_wqattrs_cleanup(ctx); |
4024 | ||
6201171e | 4025 | return 0; |
9e8cd2f5 TH |
4026 | } |
4027 | ||
a0111cf6 LJ |
4028 | /** |
4029 | * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue | |
4030 | * @wq: the target workqueue | |
4031 | * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs() | |
4032 | * | |
4033 | * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA | |
4034 | * machines, this function maps a separate pwq to each NUMA node with | |
4035 | * possibles CPUs in @attrs->cpumask so that work items are affine to the | |
4036 | * NUMA node it was issued on. Older pwqs are released as in-flight work | |
4037 | * items finish. Note that a work item which repeatedly requeues itself | |
4038 | * back-to-back will stay on its current pwq. | |
4039 | * | |
4040 | * Performs GFP_KERNEL allocations. | |
4041 | * | |
509b3204 DJ |
4042 | * Assumes caller has CPU hotplug read exclusion, i.e. get_online_cpus(). |
4043 | * | |
a0111cf6 LJ |
4044 | * Return: 0 on success and -errno on failure. |
4045 | */ | |
513c98d0 | 4046 | int apply_workqueue_attrs(struct workqueue_struct *wq, |
a0111cf6 LJ |
4047 | const struct workqueue_attrs *attrs) |
4048 | { | |
4049 | int ret; | |
4050 | ||
509b3204 DJ |
4051 | lockdep_assert_cpus_held(); |
4052 | ||
4053 | mutex_lock(&wq_pool_mutex); | |
a0111cf6 | 4054 | ret = apply_workqueue_attrs_locked(wq, attrs); |
509b3204 | 4055 | mutex_unlock(&wq_pool_mutex); |
a0111cf6 LJ |
4056 | |
4057 | return ret; | |
4058 | } | |
4059 | ||
4c16bd32 TH |
4060 | /** |
4061 | * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug | |
4062 | * @wq: the target workqueue | |
4063 | * @cpu: the CPU coming up or going down | |
4064 | * @online: whether @cpu is coming up or going down | |
4065 | * | |
4066 | * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and | |
4067 | * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of | |
4068 | * @wq accordingly. | |
4069 | * | |
4070 | * If NUMA affinity can't be adjusted due to memory allocation failure, it | |
4071 | * falls back to @wq->dfl_pwq which may not be optimal but is always | |
4072 | * correct. | |
4073 | * | |
4074 | * Note that when the last allowed CPU of a NUMA node goes offline for a | |
4075 | * workqueue with a cpumask spanning multiple nodes, the workers which were | |
4076 | * already executing the work items for the workqueue will lose their CPU | |
4077 | * affinity and may execute on any CPU. This is similar to how per-cpu | |
4078 | * workqueues behave on CPU_DOWN. If a workqueue user wants strict | |
4079 | * affinity, it's the user's responsibility to flush the work item from | |
4080 | * CPU_DOWN_PREPARE. | |
4081 | */ | |
4082 | static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu, | |
4083 | bool online) | |
4084 | { | |
4085 | int node = cpu_to_node(cpu); | |
4086 | int cpu_off = online ? -1 : cpu; | |
4087 | struct pool_workqueue *old_pwq = NULL, *pwq; | |
4088 | struct workqueue_attrs *target_attrs; | |
4089 | cpumask_t *cpumask; | |
4090 | ||
4091 | lockdep_assert_held(&wq_pool_mutex); | |
4092 | ||
f7142ed4 LJ |
4093 | if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) || |
4094 | wq->unbound_attrs->no_numa) | |
4c16bd32 TH |
4095 | return; |
4096 | ||
4097 | /* | |
4098 | * We don't wanna alloc/free wq_attrs for each wq for each CPU. | |
4099 | * Let's use a preallocated one. The following buf is protected by | |
4100 | * CPU hotplug exclusion. | |
4101 | */ | |
4102 | target_attrs = wq_update_unbound_numa_attrs_buf; | |
4103 | cpumask = target_attrs->cpumask; | |
4104 | ||
4c16bd32 TH |
4105 | copy_workqueue_attrs(target_attrs, wq->unbound_attrs); |
4106 | pwq = unbound_pwq_by_node(wq, node); | |
4107 | ||
4108 | /* | |
4109 | * Let's determine what needs to be done. If the target cpumask is | |
042f7df1 LJ |
4110 | * different from the default pwq's, we need to compare it to @pwq's |
4111 | * and create a new one if they don't match. If the target cpumask | |
4112 | * equals the default pwq's, the default pwq should be used. | |
4c16bd32 | 4113 | */ |
042f7df1 | 4114 | if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) { |
4c16bd32 | 4115 | if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask)) |
f7142ed4 | 4116 | return; |
4c16bd32 | 4117 | } else { |
534a3fbb | 4118 | goto use_dfl_pwq; |
4c16bd32 TH |
4119 | } |
4120 | ||
4c16bd32 TH |
4121 | /* create a new pwq */ |
4122 | pwq = alloc_unbound_pwq(wq, target_attrs); | |
4123 | if (!pwq) { | |
2d916033 FF |
4124 | pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n", |
4125 | wq->name); | |
77f300b1 | 4126 | goto use_dfl_pwq; |
4c16bd32 TH |
4127 | } |
4128 | ||
f7142ed4 | 4129 | /* Install the new pwq. */ |
4c16bd32 TH |
4130 | mutex_lock(&wq->mutex); |
4131 | old_pwq = numa_pwq_tbl_install(wq, node, pwq); | |
4132 | goto out_unlock; | |
4133 | ||
4134 | use_dfl_pwq: | |
f7142ed4 | 4135 | mutex_lock(&wq->mutex); |
4c16bd32 TH |
4136 | spin_lock_irq(&wq->dfl_pwq->pool->lock); |
4137 | get_pwq(wq->dfl_pwq); | |
4138 | spin_unlock_irq(&wq->dfl_pwq->pool->lock); | |
4139 | old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq); | |
4140 | out_unlock: | |
4141 | mutex_unlock(&wq->mutex); | |
4142 | put_pwq_unlocked(old_pwq); | |
4143 | } | |
4144 | ||
30cdf249 | 4145 | static int alloc_and_link_pwqs(struct workqueue_struct *wq) |
0f900049 | 4146 | { |
49e3cf44 | 4147 | bool highpri = wq->flags & WQ_HIGHPRI; |
8a2b7538 | 4148 | int cpu, ret; |
30cdf249 TH |
4149 | |
4150 | if (!(wq->flags & WQ_UNBOUND)) { | |
420c0ddb TH |
4151 | wq->cpu_pwqs = alloc_percpu(struct pool_workqueue); |
4152 | if (!wq->cpu_pwqs) | |
30cdf249 TH |
4153 | return -ENOMEM; |
4154 | ||
4155 | for_each_possible_cpu(cpu) { | |
7fb98ea7 TH |
4156 | struct pool_workqueue *pwq = |
4157 | per_cpu_ptr(wq->cpu_pwqs, cpu); | |
7a62c2c8 | 4158 | struct worker_pool *cpu_pools = |
f02ae73a | 4159 | per_cpu(cpu_worker_pools, cpu); |
f3421797 | 4160 | |
f147f29e TH |
4161 | init_pwq(pwq, wq, &cpu_pools[highpri]); |
4162 | ||
4163 | mutex_lock(&wq->mutex); | |
1befcf30 | 4164 | link_pwq(pwq); |
f147f29e | 4165 | mutex_unlock(&wq->mutex); |
30cdf249 | 4166 | } |
9e8cd2f5 | 4167 | return 0; |
509b3204 DJ |
4168 | } |
4169 | ||
4170 | get_online_cpus(); | |
4171 | if (wq->flags & __WQ_ORDERED) { | |
8a2b7538 TH |
4172 | ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]); |
4173 | /* there should only be single pwq for ordering guarantee */ | |
4174 | WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node || | |
4175 | wq->pwqs.prev != &wq->dfl_pwq->pwqs_node), | |
4176 | "ordering guarantee broken for workqueue %s\n", wq->name); | |
30cdf249 | 4177 | } else { |
509b3204 | 4178 | ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]); |
30cdf249 | 4179 | } |
509b3204 DJ |
4180 | put_online_cpus(); |
4181 | ||
4182 | return ret; | |
0f900049 TH |
4183 | } |
4184 | ||
f3421797 TH |
4185 | static int wq_clamp_max_active(int max_active, unsigned int flags, |
4186 | const char *name) | |
b71ab8c2 | 4187 | { |
f3421797 TH |
4188 | int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE; |
4189 | ||
4190 | if (max_active < 1 || max_active > lim) | |
044c782c VI |
4191 | pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n", |
4192 | max_active, name, 1, lim); | |
b71ab8c2 | 4193 | |
f3421797 | 4194 | return clamp_val(max_active, 1, lim); |
b71ab8c2 TH |
4195 | } |
4196 | ||
983c7515 TH |
4197 | /* |
4198 | * Workqueues which may be used during memory reclaim should have a rescuer | |
4199 | * to guarantee forward progress. | |
4200 | */ | |
4201 | static int init_rescuer(struct workqueue_struct *wq) | |
4202 | { | |
4203 | struct worker *rescuer; | |
4204 | int ret; | |
4205 | ||
4206 | if (!(wq->flags & WQ_MEM_RECLAIM)) | |
4207 | return 0; | |
4208 | ||
4209 | rescuer = alloc_worker(NUMA_NO_NODE); | |
4210 | if (!rescuer) | |
4211 | return -ENOMEM; | |
4212 | ||
4213 | rescuer->rescue_wq = wq; | |
4214 | rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name); | |
4215 | ret = PTR_ERR_OR_ZERO(rescuer->task); | |
4216 | if (ret) { | |
4217 | kfree(rescuer); | |
4218 | return ret; | |
4219 | } | |
4220 | ||
4221 | wq->rescuer = rescuer; | |
4222 | kthread_bind_mask(rescuer->task, cpu_possible_mask); | |
4223 | wake_up_process(rescuer->task); | |
4224 | ||
4225 | return 0; | |
4226 | } | |
4227 | ||
a2775bbc | 4228 | __printf(1, 4) |
669de8bd BVA |
4229 | struct workqueue_struct *alloc_workqueue(const char *fmt, |
4230 | unsigned int flags, | |
4231 | int max_active, ...) | |
1da177e4 | 4232 | { |
df2d5ae4 | 4233 | size_t tbl_size = 0; |
ecf6881f | 4234 | va_list args; |
1da177e4 | 4235 | struct workqueue_struct *wq; |
49e3cf44 | 4236 | struct pool_workqueue *pwq; |
b196be89 | 4237 | |
5c0338c6 TH |
4238 | /* |
4239 | * Unbound && max_active == 1 used to imply ordered, which is no | |
4240 | * longer the case on NUMA machines due to per-node pools. While | |
4241 | * alloc_ordered_workqueue() is the right way to create an ordered | |
4242 | * workqueue, keep the previous behavior to avoid subtle breakages | |
4243 | * on NUMA. | |
4244 | */ | |
4245 | if ((flags & WQ_UNBOUND) && max_active == 1) | |
4246 | flags |= __WQ_ORDERED; | |
4247 | ||
cee22a15 VK |
4248 | /* see the comment above the definition of WQ_POWER_EFFICIENT */ |
4249 | if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient) | |
4250 | flags |= WQ_UNBOUND; | |
4251 | ||
ecf6881f | 4252 | /* allocate wq and format name */ |
df2d5ae4 | 4253 | if (flags & WQ_UNBOUND) |
ddcb57e2 | 4254 | tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]); |
df2d5ae4 TH |
4255 | |
4256 | wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL); | |
b196be89 | 4257 | if (!wq) |
d2c1d404 | 4258 | return NULL; |
b196be89 | 4259 | |
6029a918 | 4260 | if (flags & WQ_UNBOUND) { |
be69d00d | 4261 | wq->unbound_attrs = alloc_workqueue_attrs(); |
6029a918 TH |
4262 | if (!wq->unbound_attrs) |
4263 | goto err_free_wq; | |
4264 | } | |
4265 | ||
669de8bd | 4266 | va_start(args, max_active); |
ecf6881f | 4267 | vsnprintf(wq->name, sizeof(wq->name), fmt, args); |
b196be89 | 4268 | va_end(args); |
1da177e4 | 4269 | |
d320c038 | 4270 | max_active = max_active ?: WQ_DFL_ACTIVE; |
b196be89 | 4271 | max_active = wq_clamp_max_active(max_active, flags, wq->name); |
3af24433 | 4272 | |
b196be89 | 4273 | /* init wq */ |
97e37d7b | 4274 | wq->flags = flags; |
a0a1a5fd | 4275 | wq->saved_max_active = max_active; |
3c25a55d | 4276 | mutex_init(&wq->mutex); |
112202d9 | 4277 | atomic_set(&wq->nr_pwqs_to_flush, 0); |
30cdf249 | 4278 | INIT_LIST_HEAD(&wq->pwqs); |
73f53c4a TH |
4279 | INIT_LIST_HEAD(&wq->flusher_queue); |
4280 | INIT_LIST_HEAD(&wq->flusher_overflow); | |
493a1724 | 4281 | INIT_LIST_HEAD(&wq->maydays); |
502ca9d8 | 4282 | |
669de8bd | 4283 | wq_init_lockdep(wq); |
cce1a165 | 4284 | INIT_LIST_HEAD(&wq->list); |
3af24433 | 4285 | |
30cdf249 | 4286 | if (alloc_and_link_pwqs(wq) < 0) |
82efcab3 | 4287 | goto err_unreg_lockdep; |
1537663f | 4288 | |
40c17f75 | 4289 | if (wq_online && init_rescuer(wq) < 0) |
983c7515 | 4290 | goto err_destroy; |
3af24433 | 4291 | |
226223ab TH |
4292 | if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq)) |
4293 | goto err_destroy; | |
4294 | ||
a0a1a5fd | 4295 | /* |
68e13a67 LJ |
4296 | * wq_pool_mutex protects global freeze state and workqueues list. |
4297 | * Grab it, adjust max_active and add the new @wq to workqueues | |
4298 | * list. | |
a0a1a5fd | 4299 | */ |
68e13a67 | 4300 | mutex_lock(&wq_pool_mutex); |
a0a1a5fd | 4301 | |
a357fc03 | 4302 | mutex_lock(&wq->mutex); |
699ce097 TH |
4303 | for_each_pwq(pwq, wq) |
4304 | pwq_adjust_max_active(pwq); | |
a357fc03 | 4305 | mutex_unlock(&wq->mutex); |
a0a1a5fd | 4306 | |
e2dca7ad | 4307 | list_add_tail_rcu(&wq->list, &workqueues); |
a0a1a5fd | 4308 | |
68e13a67 | 4309 | mutex_unlock(&wq_pool_mutex); |
1537663f | 4310 | |
3af24433 | 4311 | return wq; |
d2c1d404 | 4312 | |
82efcab3 | 4313 | err_unreg_lockdep: |
009bb421 BVA |
4314 | wq_unregister_lockdep(wq); |
4315 | wq_free_lockdep(wq); | |
82efcab3 | 4316 | err_free_wq: |
6029a918 | 4317 | free_workqueue_attrs(wq->unbound_attrs); |
d2c1d404 TH |
4318 | kfree(wq); |
4319 | return NULL; | |
4320 | err_destroy: | |
4321 | destroy_workqueue(wq); | |
4690c4ab | 4322 | return NULL; |
3af24433 | 4323 | } |
669de8bd | 4324 | EXPORT_SYMBOL_GPL(alloc_workqueue); |
1da177e4 | 4325 | |
3af24433 ON |
4326 | /** |
4327 | * destroy_workqueue - safely terminate a workqueue | |
4328 | * @wq: target workqueue | |
4329 | * | |
4330 | * Safely destroy a workqueue. All work currently pending will be done first. | |
4331 | */ | |
4332 | void destroy_workqueue(struct workqueue_struct *wq) | |
4333 | { | |
49e3cf44 | 4334 | struct pool_workqueue *pwq; |
4c16bd32 | 4335 | int node; |
3af24433 | 4336 | |
dbcc6601 TH |
4337 | /* |
4338 | * Remove it from sysfs first so that sanity check failure doesn't | |
4339 | * lead to sysfs name conflicts. | |
4340 | */ | |
4341 | workqueue_sysfs_unregister(wq); | |
4342 | ||
9c5a2ba7 TH |
4343 | /* drain it before proceeding with destruction */ |
4344 | drain_workqueue(wq); | |
c8efcc25 | 4345 | |
dbcc6601 TH |
4346 | /* kill rescuer, if sanity checks fail, leave it w/o rescuer */ |
4347 | if (wq->rescuer) { | |
4348 | struct worker *rescuer = wq->rescuer; | |
4349 | ||
4350 | /* this prevents new queueing */ | |
4351 | spin_lock_irq(&wq_mayday_lock); | |
4352 | wq->rescuer = NULL; | |
4353 | spin_unlock_irq(&wq_mayday_lock); | |
4354 | ||
4355 | /* rescuer will empty maydays list before exiting */ | |
4356 | kthread_stop(rescuer->task); | |
57df7da5 | 4357 | kfree(rescuer); |
dbcc6601 TH |
4358 | } |
4359 | ||
6183c009 | 4360 | /* sanity checks */ |
b09f4fd3 | 4361 | mutex_lock(&wq->mutex); |
49e3cf44 | 4362 | for_each_pwq(pwq, wq) { |
6183c009 TH |
4363 | int i; |
4364 | ||
76af4d93 TH |
4365 | for (i = 0; i < WORK_NR_COLORS; i++) { |
4366 | if (WARN_ON(pwq->nr_in_flight[i])) { | |
b09f4fd3 | 4367 | mutex_unlock(&wq->mutex); |
fa07fb6a | 4368 | show_workqueue_state(); |
6183c009 | 4369 | return; |
76af4d93 TH |
4370 | } |
4371 | } | |
4372 | ||
5c529597 | 4373 | if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) || |
8864b4e5 | 4374 | WARN_ON(pwq->nr_active) || |
76af4d93 | 4375 | WARN_ON(!list_empty(&pwq->delayed_works))) { |
b09f4fd3 | 4376 | mutex_unlock(&wq->mutex); |
fa07fb6a | 4377 | show_workqueue_state(); |
6183c009 | 4378 | return; |
76af4d93 | 4379 | } |
6183c009 | 4380 | } |
b09f4fd3 | 4381 | mutex_unlock(&wq->mutex); |
6183c009 | 4382 | |
a0a1a5fd TH |
4383 | /* |
4384 | * wq list is used to freeze wq, remove from list after | |
4385 | * flushing is complete in case freeze races us. | |
4386 | */ | |
68e13a67 | 4387 | mutex_lock(&wq_pool_mutex); |
e2dca7ad | 4388 | list_del_rcu(&wq->list); |
68e13a67 | 4389 | mutex_unlock(&wq_pool_mutex); |
3af24433 | 4390 | |
8864b4e5 | 4391 | if (!(wq->flags & WQ_UNBOUND)) { |
669de8bd | 4392 | wq_unregister_lockdep(wq); |
8864b4e5 TH |
4393 | /* |
4394 | * The base ref is never dropped on per-cpu pwqs. Directly | |
e2dca7ad | 4395 | * schedule RCU free. |
8864b4e5 | 4396 | */ |
25b00775 | 4397 | call_rcu(&wq->rcu, rcu_free_wq); |
8864b4e5 TH |
4398 | } else { |
4399 | /* | |
4400 | * We're the sole accessor of @wq at this point. Directly | |
4c16bd32 TH |
4401 | * access numa_pwq_tbl[] and dfl_pwq to put the base refs. |
4402 | * @wq will be freed when the last pwq is released. | |
8864b4e5 | 4403 | */ |
4c16bd32 TH |
4404 | for_each_node(node) { |
4405 | pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]); | |
4406 | RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL); | |
4407 | put_pwq_unlocked(pwq); | |
4408 | } | |
4409 | ||
4410 | /* | |
4411 | * Put dfl_pwq. @wq may be freed any time after dfl_pwq is | |
4412 | * put. Don't access it afterwards. | |
4413 | */ | |
4414 | pwq = wq->dfl_pwq; | |
4415 | wq->dfl_pwq = NULL; | |
dce90d47 | 4416 | put_pwq_unlocked(pwq); |
29c91e99 | 4417 | } |
3af24433 ON |
4418 | } |
4419 | EXPORT_SYMBOL_GPL(destroy_workqueue); | |
4420 | ||
dcd989cb TH |
4421 | /** |
4422 | * workqueue_set_max_active - adjust max_active of a workqueue | |
4423 | * @wq: target workqueue | |
4424 | * @max_active: new max_active value. | |
4425 | * | |
4426 | * Set max_active of @wq to @max_active. | |
4427 | * | |
4428 | * CONTEXT: | |
4429 | * Don't call from IRQ context. | |
4430 | */ | |
4431 | void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) | |
4432 | { | |
49e3cf44 | 4433 | struct pool_workqueue *pwq; |
dcd989cb | 4434 | |
8719dcea | 4435 | /* disallow meddling with max_active for ordered workqueues */ |
0a94efb5 | 4436 | if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) |
8719dcea TH |
4437 | return; |
4438 | ||
f3421797 | 4439 | max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); |
dcd989cb | 4440 | |
a357fc03 | 4441 | mutex_lock(&wq->mutex); |
dcd989cb | 4442 | |
0a94efb5 | 4443 | wq->flags &= ~__WQ_ORDERED; |
dcd989cb TH |
4444 | wq->saved_max_active = max_active; |
4445 | ||
699ce097 TH |
4446 | for_each_pwq(pwq, wq) |
4447 | pwq_adjust_max_active(pwq); | |
93981800 | 4448 | |
a357fc03 | 4449 | mutex_unlock(&wq->mutex); |
15316ba8 | 4450 | } |
dcd989cb | 4451 | EXPORT_SYMBOL_GPL(workqueue_set_max_active); |
15316ba8 | 4452 | |
27d4ee03 LW |
4453 | /** |
4454 | * current_work - retrieve %current task's work struct | |
4455 | * | |
4456 | * Determine if %current task is a workqueue worker and what it's working on. | |
4457 | * Useful to find out the context that the %current task is running in. | |
4458 | * | |
4459 | * Return: work struct if %current task is a workqueue worker, %NULL otherwise. | |
4460 | */ | |
4461 | struct work_struct *current_work(void) | |
4462 | { | |
4463 | struct worker *worker = current_wq_worker(); | |
4464 | ||
4465 | return worker ? worker->current_work : NULL; | |
4466 | } | |
4467 | EXPORT_SYMBOL(current_work); | |
4468 | ||
e6267616 TH |
4469 | /** |
4470 | * current_is_workqueue_rescuer - is %current workqueue rescuer? | |
4471 | * | |
4472 | * Determine whether %current is a workqueue rescuer. Can be used from | |
4473 | * work functions to determine whether it's being run off the rescuer task. | |
d185af30 YB |
4474 | * |
4475 | * Return: %true if %current is a workqueue rescuer. %false otherwise. | |
e6267616 TH |
4476 | */ |
4477 | bool current_is_workqueue_rescuer(void) | |
4478 | { | |
4479 | struct worker *worker = current_wq_worker(); | |
4480 | ||
6a092dfd | 4481 | return worker && worker->rescue_wq; |
e6267616 TH |
4482 | } |
4483 | ||
eef6a7d5 | 4484 | /** |
dcd989cb TH |
4485 | * workqueue_congested - test whether a workqueue is congested |
4486 | * @cpu: CPU in question | |
4487 | * @wq: target workqueue | |
eef6a7d5 | 4488 | * |
dcd989cb TH |
4489 | * Test whether @wq's cpu workqueue for @cpu is congested. There is |
4490 | * no synchronization around this function and the test result is | |
4491 | * unreliable and only useful as advisory hints or for debugging. | |
eef6a7d5 | 4492 | * |
d3251859 TH |
4493 | * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU. |
4494 | * Note that both per-cpu and unbound workqueues may be associated with | |
4495 | * multiple pool_workqueues which have separate congested states. A | |
4496 | * workqueue being congested on one CPU doesn't mean the workqueue is also | |
4497 | * contested on other CPUs / NUMA nodes. | |
4498 | * | |
d185af30 | 4499 | * Return: |
dcd989cb | 4500 | * %true if congested, %false otherwise. |
eef6a7d5 | 4501 | */ |
d84ff051 | 4502 | bool workqueue_congested(int cpu, struct workqueue_struct *wq) |
1da177e4 | 4503 | { |
7fb98ea7 | 4504 | struct pool_workqueue *pwq; |
76af4d93 TH |
4505 | bool ret; |
4506 | ||
24acfb71 TG |
4507 | rcu_read_lock(); |
4508 | preempt_disable(); | |
7fb98ea7 | 4509 | |
d3251859 TH |
4510 | if (cpu == WORK_CPU_UNBOUND) |
4511 | cpu = smp_processor_id(); | |
4512 | ||
7fb98ea7 TH |
4513 | if (!(wq->flags & WQ_UNBOUND)) |
4514 | pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); | |
4515 | else | |
df2d5ae4 | 4516 | pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu)); |
dcd989cb | 4517 | |
76af4d93 | 4518 | ret = !list_empty(&pwq->delayed_works); |
24acfb71 TG |
4519 | preempt_enable(); |
4520 | rcu_read_unlock(); | |
76af4d93 TH |
4521 | |
4522 | return ret; | |
1da177e4 | 4523 | } |
dcd989cb | 4524 | EXPORT_SYMBOL_GPL(workqueue_congested); |
1da177e4 | 4525 | |
dcd989cb TH |
4526 | /** |
4527 | * work_busy - test whether a work is currently pending or running | |
4528 | * @work: the work to be tested | |
4529 | * | |
4530 | * Test whether @work is currently pending or running. There is no | |
4531 | * synchronization around this function and the test result is | |
4532 | * unreliable and only useful as advisory hints or for debugging. | |
dcd989cb | 4533 | * |
d185af30 | 4534 | * Return: |
dcd989cb TH |
4535 | * OR'd bitmask of WORK_BUSY_* bits. |
4536 | */ | |
4537 | unsigned int work_busy(struct work_struct *work) | |
1da177e4 | 4538 | { |
fa1b54e6 | 4539 | struct worker_pool *pool; |
dcd989cb TH |
4540 | unsigned long flags; |
4541 | unsigned int ret = 0; | |
1da177e4 | 4542 | |
dcd989cb TH |
4543 | if (work_pending(work)) |
4544 | ret |= WORK_BUSY_PENDING; | |
1da177e4 | 4545 | |
24acfb71 | 4546 | rcu_read_lock(); |
fa1b54e6 | 4547 | pool = get_work_pool(work); |
038366c5 | 4548 | if (pool) { |
24acfb71 | 4549 | spin_lock_irqsave(&pool->lock, flags); |
038366c5 LJ |
4550 | if (find_worker_executing_work(pool, work)) |
4551 | ret |= WORK_BUSY_RUNNING; | |
24acfb71 | 4552 | spin_unlock_irqrestore(&pool->lock, flags); |
038366c5 | 4553 | } |
24acfb71 | 4554 | rcu_read_unlock(); |
1da177e4 | 4555 | |
dcd989cb | 4556 | return ret; |
1da177e4 | 4557 | } |
dcd989cb | 4558 | EXPORT_SYMBOL_GPL(work_busy); |
1da177e4 | 4559 | |
3d1cb205 TH |
4560 | /** |
4561 | * set_worker_desc - set description for the current work item | |
4562 | * @fmt: printf-style format string | |
4563 | * @...: arguments for the format string | |
4564 | * | |
4565 | * This function can be called by a running work function to describe what | |
4566 | * the work item is about. If the worker task gets dumped, this | |
4567 | * information will be printed out together to help debugging. The | |
4568 | * description can be at most WORKER_DESC_LEN including the trailing '\0'. | |
4569 | */ | |
4570 | void set_worker_desc(const char *fmt, ...) | |
4571 | { | |
4572 | struct worker *worker = current_wq_worker(); | |
4573 | va_list args; | |
4574 | ||
4575 | if (worker) { | |
4576 | va_start(args, fmt); | |
4577 | vsnprintf(worker->desc, sizeof(worker->desc), fmt, args); | |
4578 | va_end(args); | |
3d1cb205 TH |
4579 | } |
4580 | } | |
5c750d58 | 4581 | EXPORT_SYMBOL_GPL(set_worker_desc); |
3d1cb205 TH |
4582 | |
4583 | /** | |
4584 | * print_worker_info - print out worker information and description | |
4585 | * @log_lvl: the log level to use when printing | |
4586 | * @task: target task | |
4587 | * | |
4588 | * If @task is a worker and currently executing a work item, print out the | |
4589 | * name of the workqueue being serviced and worker description set with | |
4590 | * set_worker_desc() by the currently executing work item. | |
4591 | * | |
4592 | * This function can be safely called on any task as long as the | |
4593 | * task_struct itself is accessible. While safe, this function isn't | |
4594 | * synchronized and may print out mixups or garbages of limited length. | |
4595 | */ | |
4596 | void print_worker_info(const char *log_lvl, struct task_struct *task) | |
4597 | { | |
4598 | work_func_t *fn = NULL; | |
4599 | char name[WQ_NAME_LEN] = { }; | |
4600 | char desc[WORKER_DESC_LEN] = { }; | |
4601 | struct pool_workqueue *pwq = NULL; | |
4602 | struct workqueue_struct *wq = NULL; | |
3d1cb205 TH |
4603 | struct worker *worker; |
4604 | ||
4605 | if (!(task->flags & PF_WQ_WORKER)) | |
4606 | return; | |
4607 | ||
4608 | /* | |
4609 | * This function is called without any synchronization and @task | |
4610 | * could be in any state. Be careful with dereferences. | |
4611 | */ | |
e700591a | 4612 | worker = kthread_probe_data(task); |
3d1cb205 TH |
4613 | |
4614 | /* | |
8bf89593 TH |
4615 | * Carefully copy the associated workqueue's workfn, name and desc. |
4616 | * Keep the original last '\0' in case the original is garbage. | |
3d1cb205 TH |
4617 | */ |
4618 | probe_kernel_read(&fn, &worker->current_func, sizeof(fn)); | |
4619 | probe_kernel_read(&pwq, &worker->current_pwq, sizeof(pwq)); | |
4620 | probe_kernel_read(&wq, &pwq->wq, sizeof(wq)); | |
4621 | probe_kernel_read(name, wq->name, sizeof(name) - 1); | |
8bf89593 | 4622 | probe_kernel_read(desc, worker->desc, sizeof(desc) - 1); |
3d1cb205 TH |
4623 | |
4624 | if (fn || name[0] || desc[0]) { | |
d75f773c | 4625 | printk("%sWorkqueue: %s %ps", log_lvl, name, fn); |
8bf89593 | 4626 | if (strcmp(name, desc)) |
3d1cb205 TH |
4627 | pr_cont(" (%s)", desc); |
4628 | pr_cont("\n"); | |
4629 | } | |
4630 | } | |
4631 | ||
3494fc30 TH |
4632 | static void pr_cont_pool_info(struct worker_pool *pool) |
4633 | { | |
4634 | pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask); | |
4635 | if (pool->node != NUMA_NO_NODE) | |
4636 | pr_cont(" node=%d", pool->node); | |
4637 | pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice); | |
4638 | } | |
4639 | ||
4640 | static void pr_cont_work(bool comma, struct work_struct *work) | |
4641 | { | |
4642 | if (work->func == wq_barrier_func) { | |
4643 | struct wq_barrier *barr; | |
4644 | ||
4645 | barr = container_of(work, struct wq_barrier, work); | |
4646 | ||
4647 | pr_cont("%s BAR(%d)", comma ? "," : "", | |
4648 | task_pid_nr(barr->task)); | |
4649 | } else { | |
d75f773c | 4650 | pr_cont("%s %ps", comma ? "," : "", work->func); |
3494fc30 TH |
4651 | } |
4652 | } | |
4653 | ||
4654 | static void show_pwq(struct pool_workqueue *pwq) | |
4655 | { | |
4656 | struct worker_pool *pool = pwq->pool; | |
4657 | struct work_struct *work; | |
4658 | struct worker *worker; | |
4659 | bool has_in_flight = false, has_pending = false; | |
4660 | int bkt; | |
4661 | ||
4662 | pr_info(" pwq %d:", pool->id); | |
4663 | pr_cont_pool_info(pool); | |
4664 | ||
63567df7 TH |
4665 | pr_cont(" active=%d/%d refcnt=%d%s\n", |
4666 | pwq->nr_active, pwq->max_active, pwq->refcnt, | |
3494fc30 TH |
4667 | !list_empty(&pwq->mayday_node) ? " MAYDAY" : ""); |
4668 | ||
4669 | hash_for_each(pool->busy_hash, bkt, worker, hentry) { | |
4670 | if (worker->current_pwq == pwq) { | |
4671 | has_in_flight = true; | |
4672 | break; | |
4673 | } | |
4674 | } | |
4675 | if (has_in_flight) { | |
4676 | bool comma = false; | |
4677 | ||
4678 | pr_info(" in-flight:"); | |
4679 | hash_for_each(pool->busy_hash, bkt, worker, hentry) { | |
4680 | if (worker->current_pwq != pwq) | |
4681 | continue; | |
4682 | ||
d75f773c | 4683 | pr_cont("%s %d%s:%ps", comma ? "," : "", |
3494fc30 TH |
4684 | task_pid_nr(worker->task), |
4685 | worker == pwq->wq->rescuer ? "(RESCUER)" : "", | |
4686 | worker->current_func); | |
4687 | list_for_each_entry(work, &worker->scheduled, entry) | |
4688 | pr_cont_work(false, work); | |
4689 | comma = true; | |
4690 | } | |
4691 | pr_cont("\n"); | |
4692 | } | |
4693 | ||
4694 | list_for_each_entry(work, &pool->worklist, entry) { | |
4695 | if (get_work_pwq(work) == pwq) { | |
4696 | has_pending = true; | |
4697 | break; | |
4698 | } | |
4699 | } | |
4700 | if (has_pending) { | |
4701 | bool comma = false; | |
4702 | ||
4703 | pr_info(" pending:"); | |
4704 | list_for_each_entry(work, &pool->worklist, entry) { | |
4705 | if (get_work_pwq(work) != pwq) | |
4706 | continue; | |
4707 | ||
4708 | pr_cont_work(comma, work); | |
4709 | comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); | |
4710 | } | |
4711 | pr_cont("\n"); | |
4712 | } | |
4713 | ||
4714 | if (!list_empty(&pwq->delayed_works)) { | |
4715 | bool comma = false; | |
4716 | ||
4717 | pr_info(" delayed:"); | |
4718 | list_for_each_entry(work, &pwq->delayed_works, entry) { | |
4719 | pr_cont_work(comma, work); | |
4720 | comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); | |
4721 | } | |
4722 | pr_cont("\n"); | |
4723 | } | |
4724 | } | |
4725 | ||
4726 | /** | |
4727 | * show_workqueue_state - dump workqueue state | |
4728 | * | |
7b776af6 RL |
4729 | * Called from a sysrq handler or try_to_freeze_tasks() and prints out |
4730 | * all busy workqueues and pools. | |
3494fc30 TH |
4731 | */ |
4732 | void show_workqueue_state(void) | |
4733 | { | |
4734 | struct workqueue_struct *wq; | |
4735 | struct worker_pool *pool; | |
4736 | unsigned long flags; | |
4737 | int pi; | |
4738 | ||
24acfb71 | 4739 | rcu_read_lock(); |
3494fc30 TH |
4740 | |
4741 | pr_info("Showing busy workqueues and worker pools:\n"); | |
4742 | ||
4743 | list_for_each_entry_rcu(wq, &workqueues, list) { | |
4744 | struct pool_workqueue *pwq; | |
4745 | bool idle = true; | |
4746 | ||
4747 | for_each_pwq(pwq, wq) { | |
4748 | if (pwq->nr_active || !list_empty(&pwq->delayed_works)) { | |
4749 | idle = false; | |
4750 | break; | |
4751 | } | |
4752 | } | |
4753 | if (idle) | |
4754 | continue; | |
4755 | ||
4756 | pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags); | |
4757 | ||
4758 | for_each_pwq(pwq, wq) { | |
4759 | spin_lock_irqsave(&pwq->pool->lock, flags); | |
4760 | if (pwq->nr_active || !list_empty(&pwq->delayed_works)) | |
4761 | show_pwq(pwq); | |
4762 | spin_unlock_irqrestore(&pwq->pool->lock, flags); | |
62635ea8 SS |
4763 | /* |
4764 | * We could be printing a lot from atomic context, e.g. | |
4765 | * sysrq-t -> show_workqueue_state(). Avoid triggering | |
4766 | * hard lockup. | |
4767 | */ | |
4768 | touch_nmi_watchdog(); | |
3494fc30 TH |
4769 | } |
4770 | } | |
4771 | ||
4772 | for_each_pool(pool, pi) { | |
4773 | struct worker *worker; | |
4774 | bool first = true; | |
4775 | ||
4776 | spin_lock_irqsave(&pool->lock, flags); | |
4777 | if (pool->nr_workers == pool->nr_idle) | |
4778 | goto next_pool; | |
4779 | ||
4780 | pr_info("pool %d:", pool->id); | |
4781 | pr_cont_pool_info(pool); | |
82607adc TH |
4782 | pr_cont(" hung=%us workers=%d", |
4783 | jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000, | |
4784 | pool->nr_workers); | |
3494fc30 TH |
4785 | if (pool->manager) |
4786 | pr_cont(" manager: %d", | |
4787 | task_pid_nr(pool->manager->task)); | |
4788 | list_for_each_entry(worker, &pool->idle_list, entry) { | |
4789 | pr_cont(" %s%d", first ? "idle: " : "", | |
4790 | task_pid_nr(worker->task)); | |
4791 | first = false; | |
4792 | } | |
4793 | pr_cont("\n"); | |
4794 | next_pool: | |
4795 | spin_unlock_irqrestore(&pool->lock, flags); | |
62635ea8 SS |
4796 | /* |
4797 | * We could be printing a lot from atomic context, e.g. | |
4798 | * sysrq-t -> show_workqueue_state(). Avoid triggering | |
4799 | * hard lockup. | |
4800 | */ | |
4801 | touch_nmi_watchdog(); | |
3494fc30 TH |
4802 | } |
4803 | ||
24acfb71 | 4804 | rcu_read_unlock(); |
3494fc30 TH |
4805 | } |
4806 | ||
6b59808b TH |
4807 | /* used to show worker information through /proc/PID/{comm,stat,status} */ |
4808 | void wq_worker_comm(char *buf, size_t size, struct task_struct *task) | |
4809 | { | |
6b59808b TH |
4810 | int off; |
4811 | ||
4812 | /* always show the actual comm */ | |
4813 | off = strscpy(buf, task->comm, size); | |
4814 | if (off < 0) | |
4815 | return; | |
4816 | ||
197f6acc | 4817 | /* stabilize PF_WQ_WORKER and worker pool association */ |
6b59808b TH |
4818 | mutex_lock(&wq_pool_attach_mutex); |
4819 | ||
197f6acc TH |
4820 | if (task->flags & PF_WQ_WORKER) { |
4821 | struct worker *worker = kthread_data(task); | |
4822 | struct worker_pool *pool = worker->pool; | |
6b59808b | 4823 | |
197f6acc TH |
4824 | if (pool) { |
4825 | spin_lock_irq(&pool->lock); | |
4826 | /* | |
4827 | * ->desc tracks information (wq name or | |
4828 | * set_worker_desc()) for the latest execution. If | |
4829 | * current, prepend '+', otherwise '-'. | |
4830 | */ | |
4831 | if (worker->desc[0] != '\0') { | |
4832 | if (worker->current_work) | |
4833 | scnprintf(buf + off, size - off, "+%s", | |
4834 | worker->desc); | |
4835 | else | |
4836 | scnprintf(buf + off, size - off, "-%s", | |
4837 | worker->desc); | |
4838 | } | |
4839 | spin_unlock_irq(&pool->lock); | |
6b59808b | 4840 | } |
6b59808b TH |
4841 | } |
4842 | ||
4843 | mutex_unlock(&wq_pool_attach_mutex); | |
4844 | } | |
4845 | ||
66448bc2 MM |
4846 | #ifdef CONFIG_SMP |
4847 | ||
db7bccf4 TH |
4848 | /* |
4849 | * CPU hotplug. | |
4850 | * | |
e22bee78 | 4851 | * There are two challenges in supporting CPU hotplug. Firstly, there |
112202d9 | 4852 | * are a lot of assumptions on strong associations among work, pwq and |
706026c2 | 4853 | * pool which make migrating pending and scheduled works very |
e22bee78 | 4854 | * difficult to implement without impacting hot paths. Secondly, |
94cf58bb | 4855 | * worker pools serve mix of short, long and very long running works making |
e22bee78 TH |
4856 | * blocked draining impractical. |
4857 | * | |
24647570 | 4858 | * This is solved by allowing the pools to be disassociated from the CPU |
628c78e7 TH |
4859 | * running as an unbound one and allowing it to be reattached later if the |
4860 | * cpu comes back online. | |
db7bccf4 | 4861 | */ |
1da177e4 | 4862 | |
e8b3f8db | 4863 | static void unbind_workers(int cpu) |
3af24433 | 4864 | { |
4ce62e9e | 4865 | struct worker_pool *pool; |
db7bccf4 | 4866 | struct worker *worker; |
3af24433 | 4867 | |
f02ae73a | 4868 | for_each_cpu_worker_pool(pool, cpu) { |
1258fae7 | 4869 | mutex_lock(&wq_pool_attach_mutex); |
94cf58bb | 4870 | spin_lock_irq(&pool->lock); |
3af24433 | 4871 | |
94cf58bb | 4872 | /* |
92f9c5c4 | 4873 | * We've blocked all attach/detach operations. Make all workers |
94cf58bb TH |
4874 | * unbound and set DISASSOCIATED. Before this, all workers |
4875 | * except for the ones which are still executing works from | |
4876 | * before the last CPU down must be on the cpu. After | |
4877 | * this, they may become diasporas. | |
4878 | */ | |
da028469 | 4879 | for_each_pool_worker(worker, pool) |
c9e7cf27 | 4880 | worker->flags |= WORKER_UNBOUND; |
06ba38a9 | 4881 | |
24647570 | 4882 | pool->flags |= POOL_DISASSOCIATED; |
f2d5a0ee | 4883 | |
94cf58bb | 4884 | spin_unlock_irq(&pool->lock); |
1258fae7 | 4885 | mutex_unlock(&wq_pool_attach_mutex); |
628c78e7 | 4886 | |
eb283428 LJ |
4887 | /* |
4888 | * Call schedule() so that we cross rq->lock and thus can | |
4889 | * guarantee sched callbacks see the %WORKER_UNBOUND flag. | |
4890 | * This is necessary as scheduler callbacks may be invoked | |
4891 | * from other cpus. | |
4892 | */ | |
4893 | schedule(); | |
06ba38a9 | 4894 | |
eb283428 LJ |
4895 | /* |
4896 | * Sched callbacks are disabled now. Zap nr_running. | |
4897 | * After this, nr_running stays zero and need_more_worker() | |
4898 | * and keep_working() are always true as long as the | |
4899 | * worklist is not empty. This pool now behaves as an | |
4900 | * unbound (in terms of concurrency management) pool which | |
4901 | * are served by workers tied to the pool. | |
4902 | */ | |
e19e397a | 4903 | atomic_set(&pool->nr_running, 0); |
eb283428 LJ |
4904 | |
4905 | /* | |
4906 | * With concurrency management just turned off, a busy | |
4907 | * worker blocking could lead to lengthy stalls. Kick off | |
4908 | * unbound chain execution of currently pending work items. | |
4909 | */ | |
4910 | spin_lock_irq(&pool->lock); | |
4911 | wake_up_worker(pool); | |
4912 | spin_unlock_irq(&pool->lock); | |
4913 | } | |
3af24433 | 4914 | } |
3af24433 | 4915 | |
bd7c089e TH |
4916 | /** |
4917 | * rebind_workers - rebind all workers of a pool to the associated CPU | |
4918 | * @pool: pool of interest | |
4919 | * | |
a9ab775b | 4920 | * @pool->cpu is coming online. Rebind all workers to the CPU. |
bd7c089e TH |
4921 | */ |
4922 | static void rebind_workers(struct worker_pool *pool) | |
4923 | { | |
a9ab775b | 4924 | struct worker *worker; |
bd7c089e | 4925 | |
1258fae7 | 4926 | lockdep_assert_held(&wq_pool_attach_mutex); |
bd7c089e | 4927 | |
a9ab775b TH |
4928 | /* |
4929 | * Restore CPU affinity of all workers. As all idle workers should | |
4930 | * be on the run-queue of the associated CPU before any local | |
402dd89d | 4931 | * wake-ups for concurrency management happen, restore CPU affinity |
a9ab775b TH |
4932 | * of all workers first and then clear UNBOUND. As we're called |
4933 | * from CPU_ONLINE, the following shouldn't fail. | |
4934 | */ | |
da028469 | 4935 | for_each_pool_worker(worker, pool) |
a9ab775b TH |
4936 | WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, |
4937 | pool->attrs->cpumask) < 0); | |
bd7c089e | 4938 | |
a9ab775b | 4939 | spin_lock_irq(&pool->lock); |
f7c17d26 | 4940 | |
3de5e884 | 4941 | pool->flags &= ~POOL_DISASSOCIATED; |
bd7c089e | 4942 | |
da028469 | 4943 | for_each_pool_worker(worker, pool) { |
a9ab775b | 4944 | unsigned int worker_flags = worker->flags; |
bd7c089e TH |
4945 | |
4946 | /* | |
a9ab775b TH |
4947 | * A bound idle worker should actually be on the runqueue |
4948 | * of the associated CPU for local wake-ups targeting it to | |
4949 | * work. Kick all idle workers so that they migrate to the | |
4950 | * associated CPU. Doing this in the same loop as | |
4951 | * replacing UNBOUND with REBOUND is safe as no worker will | |
4952 | * be bound before @pool->lock is released. | |
bd7c089e | 4953 | */ |
a9ab775b TH |
4954 | if (worker_flags & WORKER_IDLE) |
4955 | wake_up_process(worker->task); | |
bd7c089e | 4956 | |
a9ab775b TH |
4957 | /* |
4958 | * We want to clear UNBOUND but can't directly call | |
4959 | * worker_clr_flags() or adjust nr_running. Atomically | |
4960 | * replace UNBOUND with another NOT_RUNNING flag REBOUND. | |
4961 | * @worker will clear REBOUND using worker_clr_flags() when | |
4962 | * it initiates the next execution cycle thus restoring | |
4963 | * concurrency management. Note that when or whether | |
4964 | * @worker clears REBOUND doesn't affect correctness. | |
4965 | * | |
c95491ed | 4966 | * WRITE_ONCE() is necessary because @worker->flags may be |
a9ab775b | 4967 | * tested without holding any lock in |
6d25be57 | 4968 | * wq_worker_running(). Without it, NOT_RUNNING test may |
a9ab775b TH |
4969 | * fail incorrectly leading to premature concurrency |
4970 | * management operations. | |
4971 | */ | |
4972 | WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND)); | |
4973 | worker_flags |= WORKER_REBOUND; | |
4974 | worker_flags &= ~WORKER_UNBOUND; | |
c95491ed | 4975 | WRITE_ONCE(worker->flags, worker_flags); |
bd7c089e | 4976 | } |
a9ab775b TH |
4977 | |
4978 | spin_unlock_irq(&pool->lock); | |
bd7c089e TH |
4979 | } |
4980 | ||
7dbc725e TH |
4981 | /** |
4982 | * restore_unbound_workers_cpumask - restore cpumask of unbound workers | |
4983 | * @pool: unbound pool of interest | |
4984 | * @cpu: the CPU which is coming up | |
4985 | * | |
4986 | * An unbound pool may end up with a cpumask which doesn't have any online | |
4987 | * CPUs. When a worker of such pool get scheduled, the scheduler resets | |
4988 | * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any | |
4989 | * online CPU before, cpus_allowed of all its workers should be restored. | |
4990 | */ | |
4991 | static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu) | |
4992 | { | |
4993 | static cpumask_t cpumask; | |
4994 | struct worker *worker; | |
7dbc725e | 4995 | |
1258fae7 | 4996 | lockdep_assert_held(&wq_pool_attach_mutex); |
7dbc725e TH |
4997 | |
4998 | /* is @cpu allowed for @pool? */ | |
4999 | if (!cpumask_test_cpu(cpu, pool->attrs->cpumask)) | |
5000 | return; | |
5001 | ||
7dbc725e | 5002 | cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask); |
7dbc725e TH |
5003 | |
5004 | /* as we're called from CPU_ONLINE, the following shouldn't fail */ | |
da028469 | 5005 | for_each_pool_worker(worker, pool) |
d945b5e9 | 5006 | WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0); |
7dbc725e TH |
5007 | } |
5008 | ||
7ee681b2 TG |
5009 | int workqueue_prepare_cpu(unsigned int cpu) |
5010 | { | |
5011 | struct worker_pool *pool; | |
5012 | ||
5013 | for_each_cpu_worker_pool(pool, cpu) { | |
5014 | if (pool->nr_workers) | |
5015 | continue; | |
5016 | if (!create_worker(pool)) | |
5017 | return -ENOMEM; | |
5018 | } | |
5019 | return 0; | |
5020 | } | |
5021 | ||
5022 | int workqueue_online_cpu(unsigned int cpu) | |
3af24433 | 5023 | { |
4ce62e9e | 5024 | struct worker_pool *pool; |
4c16bd32 | 5025 | struct workqueue_struct *wq; |
7dbc725e | 5026 | int pi; |
3ce63377 | 5027 | |
7ee681b2 | 5028 | mutex_lock(&wq_pool_mutex); |
7dbc725e | 5029 | |
7ee681b2 | 5030 | for_each_pool(pool, pi) { |
1258fae7 | 5031 | mutex_lock(&wq_pool_attach_mutex); |
94cf58bb | 5032 | |
7ee681b2 TG |
5033 | if (pool->cpu == cpu) |
5034 | rebind_workers(pool); | |
5035 | else if (pool->cpu < 0) | |
5036 | restore_unbound_workers_cpumask(pool, cpu); | |
94cf58bb | 5037 | |
1258fae7 | 5038 | mutex_unlock(&wq_pool_attach_mutex); |
7ee681b2 | 5039 | } |
6ba94429 | 5040 | |
7ee681b2 TG |
5041 | /* update NUMA affinity of unbound workqueues */ |
5042 | list_for_each_entry(wq, &workqueues, list) | |
5043 | wq_update_unbound_numa(wq, cpu, true); | |
6ba94429 | 5044 | |
7ee681b2 TG |
5045 | mutex_unlock(&wq_pool_mutex); |
5046 | return 0; | |
6ba94429 FW |
5047 | } |
5048 | ||
7ee681b2 | 5049 | int workqueue_offline_cpu(unsigned int cpu) |
6ba94429 | 5050 | { |
6ba94429 FW |
5051 | struct workqueue_struct *wq; |
5052 | ||
7ee681b2 | 5053 | /* unbinding per-cpu workers should happen on the local CPU */ |
e8b3f8db LJ |
5054 | if (WARN_ON(cpu != smp_processor_id())) |
5055 | return -1; | |
5056 | ||
5057 | unbind_workers(cpu); | |
7ee681b2 TG |
5058 | |
5059 | /* update NUMA affinity of unbound workqueues */ | |
5060 | mutex_lock(&wq_pool_mutex); | |
5061 | list_for_each_entry(wq, &workqueues, list) | |
5062 | wq_update_unbound_numa(wq, cpu, false); | |
5063 | mutex_unlock(&wq_pool_mutex); | |
5064 | ||
7ee681b2 | 5065 | return 0; |
6ba94429 FW |
5066 | } |
5067 | ||
6ba94429 FW |
5068 | struct work_for_cpu { |
5069 | struct work_struct work; | |
5070 | long (*fn)(void *); | |
5071 | void *arg; | |
5072 | long ret; | |
5073 | }; | |
5074 | ||
5075 | static void work_for_cpu_fn(struct work_struct *work) | |
5076 | { | |
5077 | struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work); | |
5078 | ||
5079 | wfc->ret = wfc->fn(wfc->arg); | |
5080 | } | |
5081 | ||
5082 | /** | |
22aceb31 | 5083 | * work_on_cpu - run a function in thread context on a particular cpu |
6ba94429 FW |
5084 | * @cpu: the cpu to run on |
5085 | * @fn: the function to run | |
5086 | * @arg: the function arg | |
5087 | * | |
5088 | * It is up to the caller to ensure that the cpu doesn't go offline. | |
5089 | * The caller must not hold any locks which would prevent @fn from completing. | |
5090 | * | |
5091 | * Return: The value @fn returns. | |
5092 | */ | |
5093 | long work_on_cpu(int cpu, long (*fn)(void *), void *arg) | |
5094 | { | |
5095 | struct work_for_cpu wfc = { .fn = fn, .arg = arg }; | |
5096 | ||
5097 | INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn); | |
5098 | schedule_work_on(cpu, &wfc.work); | |
5099 | flush_work(&wfc.work); | |
5100 | destroy_work_on_stack(&wfc.work); | |
5101 | return wfc.ret; | |
5102 | } | |
5103 | EXPORT_SYMBOL_GPL(work_on_cpu); | |
0e8d6a93 TG |
5104 | |
5105 | /** | |
5106 | * work_on_cpu_safe - run a function in thread context on a particular cpu | |
5107 | * @cpu: the cpu to run on | |
5108 | * @fn: the function to run | |
5109 | * @arg: the function argument | |
5110 | * | |
5111 | * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold | |
5112 | * any locks which would prevent @fn from completing. | |
5113 | * | |
5114 | * Return: The value @fn returns. | |
5115 | */ | |
5116 | long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg) | |
5117 | { | |
5118 | long ret = -ENODEV; | |
5119 | ||
5120 | get_online_cpus(); | |
5121 | if (cpu_online(cpu)) | |
5122 | ret = work_on_cpu(cpu, fn, arg); | |
5123 | put_online_cpus(); | |
5124 | return ret; | |
5125 | } | |
5126 | EXPORT_SYMBOL_GPL(work_on_cpu_safe); | |
6ba94429 FW |
5127 | #endif /* CONFIG_SMP */ |
5128 | ||
5129 | #ifdef CONFIG_FREEZER | |
5130 | ||
5131 | /** | |
5132 | * freeze_workqueues_begin - begin freezing workqueues | |
5133 | * | |
5134 | * Start freezing workqueues. After this function returns, all freezable | |
5135 | * workqueues will queue new works to their delayed_works list instead of | |
5136 | * pool->worklist. | |
5137 | * | |
5138 | * CONTEXT: | |
5139 | * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. | |
5140 | */ | |
5141 | void freeze_workqueues_begin(void) | |
5142 | { | |
5143 | struct workqueue_struct *wq; | |
5144 | struct pool_workqueue *pwq; | |
5145 | ||
5146 | mutex_lock(&wq_pool_mutex); | |
5147 | ||
5148 | WARN_ON_ONCE(workqueue_freezing); | |
5149 | workqueue_freezing = true; | |
5150 | ||
5151 | list_for_each_entry(wq, &workqueues, list) { | |
5152 | mutex_lock(&wq->mutex); | |
5153 | for_each_pwq(pwq, wq) | |
5154 | pwq_adjust_max_active(pwq); | |
5155 | mutex_unlock(&wq->mutex); | |
5156 | } | |
5157 | ||
5158 | mutex_unlock(&wq_pool_mutex); | |
5159 | } | |
5160 | ||
5161 | /** | |
5162 | * freeze_workqueues_busy - are freezable workqueues still busy? | |
5163 | * | |
5164 | * Check whether freezing is complete. This function must be called | |
5165 | * between freeze_workqueues_begin() and thaw_workqueues(). | |
5166 | * | |
5167 | * CONTEXT: | |
5168 | * Grabs and releases wq_pool_mutex. | |
5169 | * | |
5170 | * Return: | |
5171 | * %true if some freezable workqueues are still busy. %false if freezing | |
5172 | * is complete. | |
5173 | */ | |
5174 | bool freeze_workqueues_busy(void) | |
5175 | { | |
5176 | bool busy = false; | |
5177 | struct workqueue_struct *wq; | |
5178 | struct pool_workqueue *pwq; | |
5179 | ||
5180 | mutex_lock(&wq_pool_mutex); | |
5181 | ||
5182 | WARN_ON_ONCE(!workqueue_freezing); | |
5183 | ||
5184 | list_for_each_entry(wq, &workqueues, list) { | |
5185 | if (!(wq->flags & WQ_FREEZABLE)) | |
5186 | continue; | |
5187 | /* | |
5188 | * nr_active is monotonically decreasing. It's safe | |
5189 | * to peek without lock. | |
5190 | */ | |
24acfb71 | 5191 | rcu_read_lock(); |
6ba94429 FW |
5192 | for_each_pwq(pwq, wq) { |
5193 | WARN_ON_ONCE(pwq->nr_active < 0); | |
5194 | if (pwq->nr_active) { | |
5195 | busy = true; | |
24acfb71 | 5196 | rcu_read_unlock(); |
6ba94429 FW |
5197 | goto out_unlock; |
5198 | } | |
5199 | } | |
24acfb71 | 5200 | rcu_read_unlock(); |
6ba94429 FW |
5201 | } |
5202 | out_unlock: | |
5203 | mutex_unlock(&wq_pool_mutex); | |
5204 | return busy; | |
5205 | } | |
5206 | ||
5207 | /** | |
5208 | * thaw_workqueues - thaw workqueues | |
5209 | * | |
5210 | * Thaw workqueues. Normal queueing is restored and all collected | |
5211 | * frozen works are transferred to their respective pool worklists. | |
5212 | * | |
5213 | * CONTEXT: | |
5214 | * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. | |
5215 | */ | |
5216 | void thaw_workqueues(void) | |
5217 | { | |
5218 | struct workqueue_struct *wq; | |
5219 | struct pool_workqueue *pwq; | |
5220 | ||
5221 | mutex_lock(&wq_pool_mutex); | |
5222 | ||
5223 | if (!workqueue_freezing) | |
5224 | goto out_unlock; | |
5225 | ||
5226 | workqueue_freezing = false; | |
5227 | ||
5228 | /* restore max_active and repopulate worklist */ | |
5229 | list_for_each_entry(wq, &workqueues, list) { | |
5230 | mutex_lock(&wq->mutex); | |
5231 | for_each_pwq(pwq, wq) | |
5232 | pwq_adjust_max_active(pwq); | |
5233 | mutex_unlock(&wq->mutex); | |
5234 | } | |
5235 | ||
5236 | out_unlock: | |
5237 | mutex_unlock(&wq_pool_mutex); | |
5238 | } | |
5239 | #endif /* CONFIG_FREEZER */ | |
5240 | ||
042f7df1 LJ |
5241 | static int workqueue_apply_unbound_cpumask(void) |
5242 | { | |
5243 | LIST_HEAD(ctxs); | |
5244 | int ret = 0; | |
5245 | struct workqueue_struct *wq; | |
5246 | struct apply_wqattrs_ctx *ctx, *n; | |
5247 | ||
5248 | lockdep_assert_held(&wq_pool_mutex); | |
5249 | ||
5250 | list_for_each_entry(wq, &workqueues, list) { | |
5251 | if (!(wq->flags & WQ_UNBOUND)) | |
5252 | continue; | |
5253 | /* creating multiple pwqs breaks ordering guarantee */ | |
5254 | if (wq->flags & __WQ_ORDERED) | |
5255 | continue; | |
5256 | ||
5257 | ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs); | |
5258 | if (!ctx) { | |
5259 | ret = -ENOMEM; | |
5260 | break; | |
5261 | } | |
5262 | ||
5263 | list_add_tail(&ctx->list, &ctxs); | |
5264 | } | |
5265 | ||
5266 | list_for_each_entry_safe(ctx, n, &ctxs, list) { | |
5267 | if (!ret) | |
5268 | apply_wqattrs_commit(ctx); | |
5269 | apply_wqattrs_cleanup(ctx); | |
5270 | } | |
5271 | ||
5272 | return ret; | |
5273 | } | |
5274 | ||
5275 | /** | |
5276 | * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask | |
5277 | * @cpumask: the cpumask to set | |
5278 | * | |
5279 | * The low-level workqueues cpumask is a global cpumask that limits | |
5280 | * the affinity of all unbound workqueues. This function check the @cpumask | |
5281 | * and apply it to all unbound workqueues and updates all pwqs of them. | |
5282 | * | |
5283 | * Retun: 0 - Success | |
5284 | * -EINVAL - Invalid @cpumask | |
5285 | * -ENOMEM - Failed to allocate memory for attrs or pwqs. | |
5286 | */ | |
5287 | int workqueue_set_unbound_cpumask(cpumask_var_t cpumask) | |
5288 | { | |
5289 | int ret = -EINVAL; | |
5290 | cpumask_var_t saved_cpumask; | |
5291 | ||
5292 | if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL)) | |
5293 | return -ENOMEM; | |
5294 | ||
c98a9805 TS |
5295 | /* |
5296 | * Not excluding isolated cpus on purpose. | |
5297 | * If the user wishes to include them, we allow that. | |
5298 | */ | |
042f7df1 LJ |
5299 | cpumask_and(cpumask, cpumask, cpu_possible_mask); |
5300 | if (!cpumask_empty(cpumask)) { | |
a0111cf6 | 5301 | apply_wqattrs_lock(); |
042f7df1 LJ |
5302 | |
5303 | /* save the old wq_unbound_cpumask. */ | |
5304 | cpumask_copy(saved_cpumask, wq_unbound_cpumask); | |
5305 | ||
5306 | /* update wq_unbound_cpumask at first and apply it to wqs. */ | |
5307 | cpumask_copy(wq_unbound_cpumask, cpumask); | |
5308 | ret = workqueue_apply_unbound_cpumask(); | |
5309 | ||
5310 | /* restore the wq_unbound_cpumask when failed. */ | |
5311 | if (ret < 0) | |
5312 | cpumask_copy(wq_unbound_cpumask, saved_cpumask); | |
5313 | ||
a0111cf6 | 5314 | apply_wqattrs_unlock(); |
042f7df1 | 5315 | } |
042f7df1 LJ |
5316 | |
5317 | free_cpumask_var(saved_cpumask); | |
5318 | return ret; | |
5319 | } | |
5320 | ||
6ba94429 FW |
5321 | #ifdef CONFIG_SYSFS |
5322 | /* | |
5323 | * Workqueues with WQ_SYSFS flag set is visible to userland via | |
5324 | * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the | |
5325 | * following attributes. | |
5326 | * | |
5327 | * per_cpu RO bool : whether the workqueue is per-cpu or unbound | |
5328 | * max_active RW int : maximum number of in-flight work items | |
5329 | * | |
5330 | * Unbound workqueues have the following extra attributes. | |
5331 | * | |
9a19b463 | 5332 | * pool_ids RO int : the associated pool IDs for each node |
6ba94429 FW |
5333 | * nice RW int : nice value of the workers |
5334 | * cpumask RW mask : bitmask of allowed CPUs for the workers | |
9a19b463 | 5335 | * numa RW bool : whether enable NUMA affinity |
6ba94429 FW |
5336 | */ |
5337 | struct wq_device { | |
5338 | struct workqueue_struct *wq; | |
5339 | struct device dev; | |
5340 | }; | |
5341 | ||
5342 | static struct workqueue_struct *dev_to_wq(struct device *dev) | |
5343 | { | |
5344 | struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); | |
5345 | ||
5346 | return wq_dev->wq; | |
5347 | } | |
5348 | ||
5349 | static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr, | |
5350 | char *buf) | |
5351 | { | |
5352 | struct workqueue_struct *wq = dev_to_wq(dev); | |
5353 | ||
5354 | return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND)); | |
5355 | } | |
5356 | static DEVICE_ATTR_RO(per_cpu); | |
5357 | ||
5358 | static ssize_t max_active_show(struct device *dev, | |
5359 | struct device_attribute *attr, char *buf) | |
5360 | { | |
5361 | struct workqueue_struct *wq = dev_to_wq(dev); | |
5362 | ||
5363 | return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active); | |
5364 | } | |
5365 | ||
5366 | static ssize_t max_active_store(struct device *dev, | |
5367 | struct device_attribute *attr, const char *buf, | |
5368 | size_t count) | |
5369 | { | |
5370 | struct workqueue_struct *wq = dev_to_wq(dev); | |
5371 | int val; | |
5372 | ||
5373 | if (sscanf(buf, "%d", &val) != 1 || val <= 0) | |
5374 | return -EINVAL; | |
5375 | ||
5376 | workqueue_set_max_active(wq, val); | |
5377 | return count; | |
5378 | } | |
5379 | static DEVICE_ATTR_RW(max_active); | |
5380 | ||
5381 | static struct attribute *wq_sysfs_attrs[] = { | |
5382 | &dev_attr_per_cpu.attr, | |
5383 | &dev_attr_max_active.attr, | |
5384 | NULL, | |
5385 | }; | |
5386 | ATTRIBUTE_GROUPS(wq_sysfs); | |
5387 | ||
5388 | static ssize_t wq_pool_ids_show(struct device *dev, | |
5389 | struct device_attribute *attr, char *buf) | |
5390 | { | |
5391 | struct workqueue_struct *wq = dev_to_wq(dev); | |
5392 | const char *delim = ""; | |
5393 | int node, written = 0; | |
5394 | ||
24acfb71 TG |
5395 | get_online_cpus(); |
5396 | rcu_read_lock(); | |
6ba94429 FW |
5397 | for_each_node(node) { |
5398 | written += scnprintf(buf + written, PAGE_SIZE - written, | |
5399 | "%s%d:%d", delim, node, | |
5400 | unbound_pwq_by_node(wq, node)->pool->id); | |
5401 | delim = " "; | |
5402 | } | |
5403 | written += scnprintf(buf + written, PAGE_SIZE - written, "\n"); | |
24acfb71 TG |
5404 | rcu_read_unlock(); |
5405 | put_online_cpus(); | |
6ba94429 FW |
5406 | |
5407 | return written; | |
5408 | } | |
5409 | ||
5410 | static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr, | |
5411 | char *buf) | |
5412 | { | |
5413 | struct workqueue_struct *wq = dev_to_wq(dev); | |
5414 | int written; | |
5415 | ||
5416 | mutex_lock(&wq->mutex); | |
5417 | written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice); | |
5418 | mutex_unlock(&wq->mutex); | |
5419 | ||
5420 | return written; | |
5421 | } | |
5422 | ||
5423 | /* prepare workqueue_attrs for sysfs store operations */ | |
5424 | static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq) | |
5425 | { | |
5426 | struct workqueue_attrs *attrs; | |
5427 | ||
899a94fe LJ |
5428 | lockdep_assert_held(&wq_pool_mutex); |
5429 | ||
be69d00d | 5430 | attrs = alloc_workqueue_attrs(); |
6ba94429 FW |
5431 | if (!attrs) |
5432 | return NULL; | |
5433 | ||
6ba94429 | 5434 | copy_workqueue_attrs(attrs, wq->unbound_attrs); |
6ba94429 FW |
5435 | return attrs; |
5436 | } | |
5437 | ||
5438 | static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr, | |
5439 | const char *buf, size_t count) | |
5440 | { | |
5441 | struct workqueue_struct *wq = dev_to_wq(dev); | |
5442 | struct workqueue_attrs *attrs; | |
d4d3e257 LJ |
5443 | int ret = -ENOMEM; |
5444 | ||
5445 | apply_wqattrs_lock(); | |
6ba94429 FW |
5446 | |
5447 | attrs = wq_sysfs_prep_attrs(wq); | |
5448 | if (!attrs) | |
d4d3e257 | 5449 | goto out_unlock; |
6ba94429 FW |
5450 | |
5451 | if (sscanf(buf, "%d", &attrs->nice) == 1 && | |
5452 | attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE) | |
d4d3e257 | 5453 | ret = apply_workqueue_attrs_locked(wq, attrs); |
6ba94429 FW |
5454 | else |
5455 | ret = -EINVAL; | |
5456 | ||
d4d3e257 LJ |
5457 | out_unlock: |
5458 | apply_wqattrs_unlock(); | |
6ba94429 FW |
5459 | free_workqueue_attrs(attrs); |
5460 | return ret ?: count; | |
5461 | } | |
5462 | ||
5463 | static ssize_t wq_cpumask_show(struct device *dev, | |
5464 | struct device_attribute *attr, char *buf) | |
5465 | { | |
5466 | struct workqueue_struct *wq = dev_to_wq(dev); | |
5467 | int written; | |
5468 | ||
5469 | mutex_lock(&wq->mutex); | |
5470 | written = scnprintf(buf, PAGE_SIZE, "%*pb\n", | |
5471 | cpumask_pr_args(wq->unbound_attrs->cpumask)); | |
5472 | mutex_unlock(&wq->mutex); | |
5473 | return written; | |
5474 | } | |
5475 | ||
5476 | static ssize_t wq_cpumask_store(struct device *dev, | |
5477 | struct device_attribute *attr, | |
5478 | const char *buf, size_t count) | |
5479 | { | |
5480 | struct workqueue_struct *wq = dev_to_wq(dev); | |
5481 | struct workqueue_attrs *attrs; | |
d4d3e257 LJ |
5482 | int ret = -ENOMEM; |
5483 | ||
5484 | apply_wqattrs_lock(); | |
6ba94429 FW |
5485 | |
5486 | attrs = wq_sysfs_prep_attrs(wq); | |
5487 | if (!attrs) | |
d4d3e257 | 5488 | goto out_unlock; |
6ba94429 FW |
5489 | |
5490 | ret = cpumask_parse(buf, attrs->cpumask); | |
5491 | if (!ret) | |
d4d3e257 | 5492 | ret = apply_workqueue_attrs_locked(wq, attrs); |
6ba94429 | 5493 | |
d4d3e257 LJ |
5494 | out_unlock: |
5495 | apply_wqattrs_unlock(); | |
6ba94429 FW |
5496 | free_workqueue_attrs(attrs); |
5497 | return ret ?: count; | |
5498 | } | |
5499 | ||
5500 | static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr, | |
5501 | char *buf) | |
5502 | { | |
5503 | struct workqueue_struct *wq = dev_to_wq(dev); | |
5504 | int written; | |
7dbc725e | 5505 | |
6ba94429 FW |
5506 | mutex_lock(&wq->mutex); |
5507 | written = scnprintf(buf, PAGE_SIZE, "%d\n", | |
5508 | !wq->unbound_attrs->no_numa); | |
5509 | mutex_unlock(&wq->mutex); | |
4c16bd32 | 5510 | |
6ba94429 | 5511 | return written; |
65758202 TH |
5512 | } |
5513 | ||
6ba94429 FW |
5514 | static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr, |
5515 | const char *buf, size_t count) | |
65758202 | 5516 | { |
6ba94429 FW |
5517 | struct workqueue_struct *wq = dev_to_wq(dev); |
5518 | struct workqueue_attrs *attrs; | |
d4d3e257 LJ |
5519 | int v, ret = -ENOMEM; |
5520 | ||
5521 | apply_wqattrs_lock(); | |
4c16bd32 | 5522 | |
6ba94429 FW |
5523 | attrs = wq_sysfs_prep_attrs(wq); |
5524 | if (!attrs) | |
d4d3e257 | 5525 | goto out_unlock; |
4c16bd32 | 5526 | |
6ba94429 FW |
5527 | ret = -EINVAL; |
5528 | if (sscanf(buf, "%d", &v) == 1) { | |
5529 | attrs->no_numa = !v; | |
d4d3e257 | 5530 | ret = apply_workqueue_attrs_locked(wq, attrs); |
65758202 | 5531 | } |
6ba94429 | 5532 | |
d4d3e257 LJ |
5533 | out_unlock: |
5534 | apply_wqattrs_unlock(); | |
6ba94429 FW |
5535 | free_workqueue_attrs(attrs); |
5536 | return ret ?: count; | |
65758202 TH |
5537 | } |
5538 | ||
6ba94429 FW |
5539 | static struct device_attribute wq_sysfs_unbound_attrs[] = { |
5540 | __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL), | |
5541 | __ATTR(nice, 0644, wq_nice_show, wq_nice_store), | |
5542 | __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store), | |
5543 | __ATTR(numa, 0644, wq_numa_show, wq_numa_store), | |
5544 | __ATTR_NULL, | |
5545 | }; | |
8ccad40d | 5546 | |
6ba94429 FW |
5547 | static struct bus_type wq_subsys = { |
5548 | .name = "workqueue", | |
5549 | .dev_groups = wq_sysfs_groups, | |
2d3854a3 RR |
5550 | }; |
5551 | ||
b05a7928 FW |
5552 | static ssize_t wq_unbound_cpumask_show(struct device *dev, |
5553 | struct device_attribute *attr, char *buf) | |
5554 | { | |
5555 | int written; | |
5556 | ||
042f7df1 | 5557 | mutex_lock(&wq_pool_mutex); |
b05a7928 FW |
5558 | written = scnprintf(buf, PAGE_SIZE, "%*pb\n", |
5559 | cpumask_pr_args(wq_unbound_cpumask)); | |
042f7df1 | 5560 | mutex_unlock(&wq_pool_mutex); |
b05a7928 FW |
5561 | |
5562 | return written; | |
5563 | } | |
5564 | ||
042f7df1 LJ |
5565 | static ssize_t wq_unbound_cpumask_store(struct device *dev, |
5566 | struct device_attribute *attr, const char *buf, size_t count) | |
5567 | { | |
5568 | cpumask_var_t cpumask; | |
5569 | int ret; | |
5570 | ||
5571 | if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL)) | |
5572 | return -ENOMEM; | |
5573 | ||
5574 | ret = cpumask_parse(buf, cpumask); | |
5575 | if (!ret) | |
5576 | ret = workqueue_set_unbound_cpumask(cpumask); | |
5577 | ||
5578 | free_cpumask_var(cpumask); | |
5579 | return ret ? ret : count; | |
5580 | } | |
5581 | ||
b05a7928 | 5582 | static struct device_attribute wq_sysfs_cpumask_attr = |
042f7df1 LJ |
5583 | __ATTR(cpumask, 0644, wq_unbound_cpumask_show, |
5584 | wq_unbound_cpumask_store); | |
b05a7928 | 5585 | |
6ba94429 | 5586 | static int __init wq_sysfs_init(void) |
2d3854a3 | 5587 | { |
b05a7928 FW |
5588 | int err; |
5589 | ||
5590 | err = subsys_virtual_register(&wq_subsys, NULL); | |
5591 | if (err) | |
5592 | return err; | |
5593 | ||
5594 | return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr); | |
2d3854a3 | 5595 | } |
6ba94429 | 5596 | core_initcall(wq_sysfs_init); |
2d3854a3 | 5597 | |
6ba94429 | 5598 | static void wq_device_release(struct device *dev) |
2d3854a3 | 5599 | { |
6ba94429 | 5600 | struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); |
6b44003e | 5601 | |
6ba94429 | 5602 | kfree(wq_dev); |
2d3854a3 | 5603 | } |
a0a1a5fd TH |
5604 | |
5605 | /** | |
6ba94429 FW |
5606 | * workqueue_sysfs_register - make a workqueue visible in sysfs |
5607 | * @wq: the workqueue to register | |
a0a1a5fd | 5608 | * |
6ba94429 FW |
5609 | * Expose @wq in sysfs under /sys/bus/workqueue/devices. |
5610 | * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set | |
5611 | * which is the preferred method. | |
a0a1a5fd | 5612 | * |
6ba94429 FW |
5613 | * Workqueue user should use this function directly iff it wants to apply |
5614 | * workqueue_attrs before making the workqueue visible in sysfs; otherwise, | |
5615 | * apply_workqueue_attrs() may race against userland updating the | |
5616 | * attributes. | |
5617 | * | |
5618 | * Return: 0 on success, -errno on failure. | |
a0a1a5fd | 5619 | */ |
6ba94429 | 5620 | int workqueue_sysfs_register(struct workqueue_struct *wq) |
a0a1a5fd | 5621 | { |
6ba94429 FW |
5622 | struct wq_device *wq_dev; |
5623 | int ret; | |
a0a1a5fd | 5624 | |
6ba94429 | 5625 | /* |
402dd89d | 5626 | * Adjusting max_active or creating new pwqs by applying |
6ba94429 FW |
5627 | * attributes breaks ordering guarantee. Disallow exposing ordered |
5628 | * workqueues. | |
5629 | */ | |
0a94efb5 | 5630 | if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) |
6ba94429 | 5631 | return -EINVAL; |
a0a1a5fd | 5632 | |
6ba94429 FW |
5633 | wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL); |
5634 | if (!wq_dev) | |
5635 | return -ENOMEM; | |
5bcab335 | 5636 | |
6ba94429 FW |
5637 | wq_dev->wq = wq; |
5638 | wq_dev->dev.bus = &wq_subsys; | |
6ba94429 | 5639 | wq_dev->dev.release = wq_device_release; |
23217b44 | 5640 | dev_set_name(&wq_dev->dev, "%s", wq->name); |
a0a1a5fd | 5641 | |
6ba94429 FW |
5642 | /* |
5643 | * unbound_attrs are created separately. Suppress uevent until | |
5644 | * everything is ready. | |
5645 | */ | |
5646 | dev_set_uevent_suppress(&wq_dev->dev, true); | |
a0a1a5fd | 5647 | |
6ba94429 FW |
5648 | ret = device_register(&wq_dev->dev); |
5649 | if (ret) { | |
537f4146 | 5650 | put_device(&wq_dev->dev); |
6ba94429 FW |
5651 | wq->wq_dev = NULL; |
5652 | return ret; | |
5653 | } | |
a0a1a5fd | 5654 | |
6ba94429 FW |
5655 | if (wq->flags & WQ_UNBOUND) { |
5656 | struct device_attribute *attr; | |
a0a1a5fd | 5657 | |
6ba94429 FW |
5658 | for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) { |
5659 | ret = device_create_file(&wq_dev->dev, attr); | |
5660 | if (ret) { | |
5661 | device_unregister(&wq_dev->dev); | |
5662 | wq->wq_dev = NULL; | |
5663 | return ret; | |
a0a1a5fd TH |
5664 | } |
5665 | } | |
5666 | } | |
6ba94429 FW |
5667 | |
5668 | dev_set_uevent_suppress(&wq_dev->dev, false); | |
5669 | kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD); | |
5670 | return 0; | |
a0a1a5fd TH |
5671 | } |
5672 | ||
5673 | /** | |
6ba94429 FW |
5674 | * workqueue_sysfs_unregister - undo workqueue_sysfs_register() |
5675 | * @wq: the workqueue to unregister | |
a0a1a5fd | 5676 | * |
6ba94429 | 5677 | * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister. |
a0a1a5fd | 5678 | */ |
6ba94429 | 5679 | static void workqueue_sysfs_unregister(struct workqueue_struct *wq) |
a0a1a5fd | 5680 | { |
6ba94429 | 5681 | struct wq_device *wq_dev = wq->wq_dev; |
8b03ae3c | 5682 | |
6ba94429 FW |
5683 | if (!wq->wq_dev) |
5684 | return; | |
a0a1a5fd | 5685 | |
6ba94429 FW |
5686 | wq->wq_dev = NULL; |
5687 | device_unregister(&wq_dev->dev); | |
a0a1a5fd | 5688 | } |
6ba94429 FW |
5689 | #else /* CONFIG_SYSFS */ |
5690 | static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { } | |
5691 | #endif /* CONFIG_SYSFS */ | |
a0a1a5fd | 5692 | |
82607adc TH |
5693 | /* |
5694 | * Workqueue watchdog. | |
5695 | * | |
5696 | * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal | |
5697 | * flush dependency, a concurrency managed work item which stays RUNNING | |
5698 | * indefinitely. Workqueue stalls can be very difficult to debug as the | |
5699 | * usual warning mechanisms don't trigger and internal workqueue state is | |
5700 | * largely opaque. | |
5701 | * | |
5702 | * Workqueue watchdog monitors all worker pools periodically and dumps | |
5703 | * state if some pools failed to make forward progress for a while where | |
5704 | * forward progress is defined as the first item on ->worklist changing. | |
5705 | * | |
5706 | * This mechanism is controlled through the kernel parameter | |
5707 | * "workqueue.watchdog_thresh" which can be updated at runtime through the | |
5708 | * corresponding sysfs parameter file. | |
5709 | */ | |
5710 | #ifdef CONFIG_WQ_WATCHDOG | |
5711 | ||
82607adc | 5712 | static unsigned long wq_watchdog_thresh = 30; |
5cd79d6a | 5713 | static struct timer_list wq_watchdog_timer; |
82607adc TH |
5714 | |
5715 | static unsigned long wq_watchdog_touched = INITIAL_JIFFIES; | |
5716 | static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES; | |
5717 | ||
5718 | static void wq_watchdog_reset_touched(void) | |
5719 | { | |
5720 | int cpu; | |
5721 | ||
5722 | wq_watchdog_touched = jiffies; | |
5723 | for_each_possible_cpu(cpu) | |
5724 | per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies; | |
5725 | } | |
5726 | ||
5cd79d6a | 5727 | static void wq_watchdog_timer_fn(struct timer_list *unused) |
82607adc TH |
5728 | { |
5729 | unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ; | |
5730 | bool lockup_detected = false; | |
5731 | struct worker_pool *pool; | |
5732 | int pi; | |
5733 | ||
5734 | if (!thresh) | |
5735 | return; | |
5736 | ||
5737 | rcu_read_lock(); | |
5738 | ||
5739 | for_each_pool(pool, pi) { | |
5740 | unsigned long pool_ts, touched, ts; | |
5741 | ||
5742 | if (list_empty(&pool->worklist)) | |
5743 | continue; | |
5744 | ||
5745 | /* get the latest of pool and touched timestamps */ | |
5746 | pool_ts = READ_ONCE(pool->watchdog_ts); | |
5747 | touched = READ_ONCE(wq_watchdog_touched); | |
5748 | ||
5749 | if (time_after(pool_ts, touched)) | |
5750 | ts = pool_ts; | |
5751 | else | |
5752 | ts = touched; | |
5753 | ||
5754 | if (pool->cpu >= 0) { | |
5755 | unsigned long cpu_touched = | |
5756 | READ_ONCE(per_cpu(wq_watchdog_touched_cpu, | |
5757 | pool->cpu)); | |
5758 | if (time_after(cpu_touched, ts)) | |
5759 | ts = cpu_touched; | |
5760 | } | |
5761 | ||
5762 | /* did we stall? */ | |
5763 | if (time_after(jiffies, ts + thresh)) { | |
5764 | lockup_detected = true; | |
5765 | pr_emerg("BUG: workqueue lockup - pool"); | |
5766 | pr_cont_pool_info(pool); | |
5767 | pr_cont(" stuck for %us!\n", | |
5768 | jiffies_to_msecs(jiffies - pool_ts) / 1000); | |
5769 | } | |
5770 | } | |
5771 | ||
5772 | rcu_read_unlock(); | |
5773 | ||
5774 | if (lockup_detected) | |
5775 | show_workqueue_state(); | |
5776 | ||
5777 | wq_watchdog_reset_touched(); | |
5778 | mod_timer(&wq_watchdog_timer, jiffies + thresh); | |
5779 | } | |
5780 | ||
cb9d7fd5 | 5781 | notrace void wq_watchdog_touch(int cpu) |
82607adc TH |
5782 | { |
5783 | if (cpu >= 0) | |
5784 | per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies; | |
5785 | else | |
5786 | wq_watchdog_touched = jiffies; | |
5787 | } | |
5788 | ||
5789 | static void wq_watchdog_set_thresh(unsigned long thresh) | |
5790 | { | |
5791 | wq_watchdog_thresh = 0; | |
5792 | del_timer_sync(&wq_watchdog_timer); | |
5793 | ||
5794 | if (thresh) { | |
5795 | wq_watchdog_thresh = thresh; | |
5796 | wq_watchdog_reset_touched(); | |
5797 | mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ); | |
5798 | } | |
5799 | } | |
5800 | ||
5801 | static int wq_watchdog_param_set_thresh(const char *val, | |
5802 | const struct kernel_param *kp) | |
5803 | { | |
5804 | unsigned long thresh; | |
5805 | int ret; | |
5806 | ||
5807 | ret = kstrtoul(val, 0, &thresh); | |
5808 | if (ret) | |
5809 | return ret; | |
5810 | ||
5811 | if (system_wq) | |
5812 | wq_watchdog_set_thresh(thresh); | |
5813 | else | |
5814 | wq_watchdog_thresh = thresh; | |
5815 | ||
5816 | return 0; | |
5817 | } | |
5818 | ||
5819 | static const struct kernel_param_ops wq_watchdog_thresh_ops = { | |
5820 | .set = wq_watchdog_param_set_thresh, | |
5821 | .get = param_get_ulong, | |
5822 | }; | |
5823 | ||
5824 | module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh, | |
5825 | 0644); | |
5826 | ||
5827 | static void wq_watchdog_init(void) | |
5828 | { | |
5cd79d6a | 5829 | timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE); |
82607adc TH |
5830 | wq_watchdog_set_thresh(wq_watchdog_thresh); |
5831 | } | |
5832 | ||
5833 | #else /* CONFIG_WQ_WATCHDOG */ | |
5834 | ||
5835 | static inline void wq_watchdog_init(void) { } | |
5836 | ||
5837 | #endif /* CONFIG_WQ_WATCHDOG */ | |
5838 | ||
bce90380 TH |
5839 | static void __init wq_numa_init(void) |
5840 | { | |
5841 | cpumask_var_t *tbl; | |
5842 | int node, cpu; | |
5843 | ||
bce90380 TH |
5844 | if (num_possible_nodes() <= 1) |
5845 | return; | |
5846 | ||
d55262c4 TH |
5847 | if (wq_disable_numa) { |
5848 | pr_info("workqueue: NUMA affinity support disabled\n"); | |
5849 | return; | |
5850 | } | |
5851 | ||
be69d00d | 5852 | wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(); |
4c16bd32 TH |
5853 | BUG_ON(!wq_update_unbound_numa_attrs_buf); |
5854 | ||
bce90380 TH |
5855 | /* |
5856 | * We want masks of possible CPUs of each node which isn't readily | |
5857 | * available. Build one from cpu_to_node() which should have been | |
5858 | * fully initialized by now. | |
5859 | */ | |
6396bb22 | 5860 | tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL); |
bce90380 TH |
5861 | BUG_ON(!tbl); |
5862 | ||
5863 | for_each_node(node) | |
5a6024f1 | 5864 | BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL, |
1be0c25d | 5865 | node_online(node) ? node : NUMA_NO_NODE)); |
bce90380 TH |
5866 | |
5867 | for_each_possible_cpu(cpu) { | |
5868 | node = cpu_to_node(cpu); | |
5869 | if (WARN_ON(node == NUMA_NO_NODE)) { | |
5870 | pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu); | |
5871 | /* happens iff arch is bonkers, let's just proceed */ | |
5872 | return; | |
5873 | } | |
5874 | cpumask_set_cpu(cpu, tbl[node]); | |
5875 | } | |
5876 | ||
5877 | wq_numa_possible_cpumask = tbl; | |
5878 | wq_numa_enabled = true; | |
5879 | } | |
5880 | ||
3347fa09 TH |
5881 | /** |
5882 | * workqueue_init_early - early init for workqueue subsystem | |
5883 | * | |
5884 | * This is the first half of two-staged workqueue subsystem initialization | |
5885 | * and invoked as soon as the bare basics - memory allocation, cpumasks and | |
5886 | * idr are up. It sets up all the data structures and system workqueues | |
5887 | * and allows early boot code to create workqueues and queue/cancel work | |
5888 | * items. Actual work item execution starts only after kthreads can be | |
5889 | * created and scheduled right before early initcalls. | |
5890 | */ | |
5891 | int __init workqueue_init_early(void) | |
1da177e4 | 5892 | { |
7a4e344c | 5893 | int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL }; |
1bda3f80 | 5894 | int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ; |
7a4e344c | 5895 | int i, cpu; |
c34056a3 | 5896 | |
e904e6c2 TH |
5897 | WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long)); |
5898 | ||
b05a7928 | 5899 | BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL)); |
1bda3f80 | 5900 | cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags)); |
b05a7928 | 5901 | |
e904e6c2 TH |
5902 | pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC); |
5903 | ||
706026c2 | 5904 | /* initialize CPU pools */ |
29c91e99 | 5905 | for_each_possible_cpu(cpu) { |
4ce62e9e | 5906 | struct worker_pool *pool; |
8b03ae3c | 5907 | |
7a4e344c | 5908 | i = 0; |
f02ae73a | 5909 | for_each_cpu_worker_pool(pool, cpu) { |
7a4e344c | 5910 | BUG_ON(init_worker_pool(pool)); |
ec22ca5e | 5911 | pool->cpu = cpu; |
29c91e99 | 5912 | cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu)); |
7a4e344c | 5913 | pool->attrs->nice = std_nice[i++]; |
f3f90ad4 | 5914 | pool->node = cpu_to_node(cpu); |
7a4e344c | 5915 | |
9daf9e67 | 5916 | /* alloc pool ID */ |
68e13a67 | 5917 | mutex_lock(&wq_pool_mutex); |
9daf9e67 | 5918 | BUG_ON(worker_pool_assign_id(pool)); |
68e13a67 | 5919 | mutex_unlock(&wq_pool_mutex); |
4ce62e9e | 5920 | } |
8b03ae3c TH |
5921 | } |
5922 | ||
8a2b7538 | 5923 | /* create default unbound and ordered wq attrs */ |
29c91e99 TH |
5924 | for (i = 0; i < NR_STD_WORKER_POOLS; i++) { |
5925 | struct workqueue_attrs *attrs; | |
5926 | ||
be69d00d | 5927 | BUG_ON(!(attrs = alloc_workqueue_attrs())); |
29c91e99 | 5928 | attrs->nice = std_nice[i]; |
29c91e99 | 5929 | unbound_std_wq_attrs[i] = attrs; |
8a2b7538 TH |
5930 | |
5931 | /* | |
5932 | * An ordered wq should have only one pwq as ordering is | |
5933 | * guaranteed by max_active which is enforced by pwqs. | |
5934 | * Turn off NUMA so that dfl_pwq is used for all nodes. | |
5935 | */ | |
be69d00d | 5936 | BUG_ON(!(attrs = alloc_workqueue_attrs())); |
8a2b7538 TH |
5937 | attrs->nice = std_nice[i]; |
5938 | attrs->no_numa = true; | |
5939 | ordered_wq_attrs[i] = attrs; | |
29c91e99 TH |
5940 | } |
5941 | ||
d320c038 | 5942 | system_wq = alloc_workqueue("events", 0, 0); |
1aabe902 | 5943 | system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0); |
d320c038 | 5944 | system_long_wq = alloc_workqueue("events_long", 0, 0); |
f3421797 TH |
5945 | system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, |
5946 | WQ_UNBOUND_MAX_ACTIVE); | |
24d51add TH |
5947 | system_freezable_wq = alloc_workqueue("events_freezable", |
5948 | WQ_FREEZABLE, 0); | |
0668106c VK |
5949 | system_power_efficient_wq = alloc_workqueue("events_power_efficient", |
5950 | WQ_POWER_EFFICIENT, 0); | |
5951 | system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient", | |
5952 | WQ_FREEZABLE | WQ_POWER_EFFICIENT, | |
5953 | 0); | |
1aabe902 | 5954 | BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq || |
0668106c VK |
5955 | !system_unbound_wq || !system_freezable_wq || |
5956 | !system_power_efficient_wq || | |
5957 | !system_freezable_power_efficient_wq); | |
82607adc | 5958 | |
3347fa09 TH |
5959 | return 0; |
5960 | } | |
5961 | ||
5962 | /** | |
5963 | * workqueue_init - bring workqueue subsystem fully online | |
5964 | * | |
5965 | * This is the latter half of two-staged workqueue subsystem initialization | |
5966 | * and invoked as soon as kthreads can be created and scheduled. | |
5967 | * Workqueues have been created and work items queued on them, but there | |
5968 | * are no kworkers executing the work items yet. Populate the worker pools | |
5969 | * with the initial workers and enable future kworker creations. | |
5970 | */ | |
5971 | int __init workqueue_init(void) | |
5972 | { | |
2186d9f9 | 5973 | struct workqueue_struct *wq; |
3347fa09 TH |
5974 | struct worker_pool *pool; |
5975 | int cpu, bkt; | |
5976 | ||
2186d9f9 TH |
5977 | /* |
5978 | * It'd be simpler to initialize NUMA in workqueue_init_early() but | |
5979 | * CPU to node mapping may not be available that early on some | |
5980 | * archs such as power and arm64. As per-cpu pools created | |
5981 | * previously could be missing node hint and unbound pools NUMA | |
5982 | * affinity, fix them up. | |
40c17f75 TH |
5983 | * |
5984 | * Also, while iterating workqueues, create rescuers if requested. | |
2186d9f9 TH |
5985 | */ |
5986 | wq_numa_init(); | |
5987 | ||
5988 | mutex_lock(&wq_pool_mutex); | |
5989 | ||
5990 | for_each_possible_cpu(cpu) { | |
5991 | for_each_cpu_worker_pool(pool, cpu) { | |
5992 | pool->node = cpu_to_node(cpu); | |
5993 | } | |
5994 | } | |
5995 | ||
40c17f75 | 5996 | list_for_each_entry(wq, &workqueues, list) { |
2186d9f9 | 5997 | wq_update_unbound_numa(wq, smp_processor_id(), true); |
40c17f75 TH |
5998 | WARN(init_rescuer(wq), |
5999 | "workqueue: failed to create early rescuer for %s", | |
6000 | wq->name); | |
6001 | } | |
2186d9f9 TH |
6002 | |
6003 | mutex_unlock(&wq_pool_mutex); | |
6004 | ||
3347fa09 TH |
6005 | /* create the initial workers */ |
6006 | for_each_online_cpu(cpu) { | |
6007 | for_each_cpu_worker_pool(pool, cpu) { | |
6008 | pool->flags &= ~POOL_DISASSOCIATED; | |
6009 | BUG_ON(!create_worker(pool)); | |
6010 | } | |
6011 | } | |
6012 | ||
6013 | hash_for_each(unbound_pool_hash, bkt, pool, hash_node) | |
6014 | BUG_ON(!create_worker(pool)); | |
6015 | ||
6016 | wq_online = true; | |
82607adc TH |
6017 | wq_watchdog_init(); |
6018 | ||
6ee0578b | 6019 | return 0; |
1da177e4 | 6020 | } |