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