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