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