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