69bd8083930c982b438d02ab1169925d62f5d95e
[sfrench/cifs-2.6.git] / kernel / workqueue.c
1 /*
2  * kernel/workqueue.c - generic async execution with shared worker pool
3  *
4  * Copyright (C) 2002           Ingo Molnar
5  *
6  *   Derived from the taskqueue/keventd code by:
7  *     David Woodhouse <dwmw2@infradead.org>
8  *     Andrew Morton
9  *     Kai Petzke <wpp@marie.physik.tu-berlin.de>
10  *     Theodore Ts'o <tytso@mit.edu>
11  *
12  * Made to use alloc_percpu by Christoph Lameter.
13  *
14  * Copyright (C) 2010           SUSE Linux Products GmbH
15  * Copyright (C) 2010           Tejun Heo <tj@kernel.org>
16  *
17  * This is the generic async execution mechanism.  Work items as are
18  * executed in process context.  The worker pool is shared and
19  * automatically managed.  There are two worker pools for each CPU (one for
20  * normal work items and the other for high priority ones) and some extra
21  * pools for workqueues which are not bound to any specific CPU - the
22  * number of these backing pools is dynamic.
23  *
24  * Please read Documentation/core-api/workqueue.rst for details.
25  */
26
27 #include <linux/export.h>
28 #include <linux/kernel.h>
29 #include <linux/sched.h>
30 #include <linux/init.h>
31 #include <linux/signal.h>
32 #include <linux/completion.h>
33 #include <linux/workqueue.h>
34 #include <linux/slab.h>
35 #include <linux/cpu.h>
36 #include <linux/notifier.h>
37 #include <linux/kthread.h>
38 #include <linux/hardirq.h>
39 #include <linux/mempolicy.h>
40 #include <linux/freezer.h>
41 #include <linux/debug_locks.h>
42 #include <linux/lockdep.h>
43 #include <linux/idr.h>
44 #include <linux/jhash.h>
45 #include <linux/hashtable.h>
46 #include <linux/rculist.h>
47 #include <linux/nodemask.h>
48 #include <linux/moduleparam.h>
49 #include <linux/uaccess.h>
50 #include <linux/sched/isolation.h>
51 #include <linux/nmi.h>
52
53 #include "workqueue_internal.h"
54
55 enum {
56         /*
57          * worker_pool flags
58          *
59          * A bound pool is either associated or disassociated with its CPU.
60          * While associated (!DISASSOCIATED), all workers are bound to the
61          * CPU and none has %WORKER_UNBOUND set and concurrency management
62          * is in effect.
63          *
64          * While DISASSOCIATED, the cpu may be offline and all workers have
65          * %WORKER_UNBOUND set and concurrency management disabled, and may
66          * be executing on any CPU.  The pool behaves as an unbound one.
67          *
68          * Note that DISASSOCIATED should be flipped only while holding
69          * wq_pool_attach_mutex to avoid changing binding state while
70          * worker_attach_to_pool() is in progress.
71          */
72         POOL_MANAGER_ACTIVE     = 1 << 0,       /* being managed */
73         POOL_DISASSOCIATED      = 1 << 2,       /* cpu can't serve workers */
74
75         /* worker flags */
76         WORKER_DIE              = 1 << 1,       /* die die die */
77         WORKER_IDLE             = 1 << 2,       /* is idle */
78         WORKER_PREP             = 1 << 3,       /* preparing to run works */
79         WORKER_CPU_INTENSIVE    = 1 << 6,       /* cpu intensive */
80         WORKER_UNBOUND          = 1 << 7,       /* worker is unbound */
81         WORKER_REBOUND          = 1 << 8,       /* worker was rebound */
82
83         WORKER_NOT_RUNNING      = WORKER_PREP | WORKER_CPU_INTENSIVE |
84                                   WORKER_UNBOUND | WORKER_REBOUND,
85
86         NR_STD_WORKER_POOLS     = 2,            /* # standard pools per cpu */
87
88         UNBOUND_POOL_HASH_ORDER = 6,            /* hashed by pool->attrs */
89         BUSY_WORKER_HASH_ORDER  = 6,            /* 64 pointers */
90
91         MAX_IDLE_WORKERS_RATIO  = 4,            /* 1/4 of busy can be idle */
92         IDLE_WORKER_TIMEOUT     = 300 * HZ,     /* keep idle ones for 5 mins */
93
94         MAYDAY_INITIAL_TIMEOUT  = HZ / 100 >= 2 ? HZ / 100 : 2,
95                                                 /* call for help after 10ms
96                                                    (min two ticks) */
97         MAYDAY_INTERVAL         = HZ / 10,      /* and then every 100ms */
98         CREATE_COOLDOWN         = HZ,           /* time to breath after fail */
99
100         /*
101          * Rescue workers are used only on emergencies and shared by
102          * all cpus.  Give MIN_NICE.
103          */
104         RESCUER_NICE_LEVEL      = MIN_NICE,
105         HIGHPRI_NICE_LEVEL      = MIN_NICE,
106
107         WQ_NAME_LEN             = 24,
108 };
109
110 /*
111  * Structure fields follow one of the following exclusion rules.
112  *
113  * I: Modifiable by initialization/destruction paths and read-only for
114  *    everyone else.
115  *
116  * P: Preemption protected.  Disabling preemption is enough and should
117  *    only be modified and accessed from the local cpu.
118  *
119  * L: pool->lock protected.  Access with pool->lock held.
120  *
121  * X: During normal operation, modification requires pool->lock and should
122  *    be done only from local cpu.  Either disabling preemption on local
123  *    cpu or grabbing pool->lock is enough for read access.  If
124  *    POOL_DISASSOCIATED is set, it's identical to L.
125  *
126  * A: wq_pool_attach_mutex protected.
127  *
128  * PL: wq_pool_mutex protected.
129  *
130  * PR: wq_pool_mutex protected for writes.  Sched-RCU protected for reads.
131  *
132  * PW: wq_pool_mutex and wq->mutex protected for writes.  Either for reads.
133  *
134  * PWR: wq_pool_mutex and wq->mutex protected for writes.  Either or
135  *      sched-RCU for reads.
136  *
137  * WQ: wq->mutex protected.
138  *
139  * WR: wq->mutex protected for writes.  Sched-RCU protected for reads.
140  *
141  * MD: wq_mayday_lock protected.
142  */
143
144 /* struct worker is defined in workqueue_internal.h */
145
146 struct worker_pool {
147         spinlock_t              lock;           /* the pool lock */
148         int                     cpu;            /* I: the associated cpu */
149         int                     node;           /* I: the associated node ID */
150         int                     id;             /* I: pool ID */
151         unsigned int            flags;          /* X: flags */
152
153         unsigned long           watchdog_ts;    /* L: watchdog timestamp */
154
155         struct list_head        worklist;       /* L: list of pending works */
156
157         int                     nr_workers;     /* L: total number of workers */
158         int                     nr_idle;        /* L: currently idle workers */
159
160         struct list_head        idle_list;      /* X: list of idle workers */
161         struct timer_list       idle_timer;     /* L: worker idle timeout */
162         struct timer_list       mayday_timer;   /* L: SOS timer for workers */
163
164         /* a workers is either on busy_hash or idle_list, or the manager */
165         DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER);
166                                                 /* L: hash of busy workers */
167
168         struct worker           *manager;       /* L: purely informational */
169         struct list_head        workers;        /* A: attached workers */
170         struct completion       *detach_completion; /* all workers detached */
171
172         struct ida              worker_ida;     /* worker IDs for task name */
173
174         struct workqueue_attrs  *attrs;         /* I: worker attributes */
175         struct hlist_node       hash_node;      /* PL: unbound_pool_hash node */
176         int                     refcnt;         /* PL: refcnt for unbound pools */
177
178         /*
179          * The current concurrency level.  As it's likely to be accessed
180          * from other CPUs during try_to_wake_up(), put it in a separate
181          * cacheline.
182          */
183         atomic_t                nr_running ____cacheline_aligned_in_smp;
184
185         /*
186          * Destruction of pool is sched-RCU protected to allow dereferences
187          * from get_work_pool().
188          */
189         struct rcu_head         rcu;
190 } ____cacheline_aligned_in_smp;
191
192 /*
193  * The per-pool workqueue.  While queued, the lower WORK_STRUCT_FLAG_BITS
194  * of work_struct->data are used for flags and the remaining high bits
195  * point to the pwq; thus, pwqs need to be aligned at two's power of the
196  * number of flag bits.
197  */
198 struct pool_workqueue {
199         struct worker_pool      *pool;          /* I: the associated pool */
200         struct workqueue_struct *wq;            /* I: the owning workqueue */
201         int                     work_color;     /* L: current color */
202         int                     flush_color;    /* L: flushing color */
203         int                     refcnt;         /* L: reference count */
204         int                     nr_in_flight[WORK_NR_COLORS];
205                                                 /* L: nr of in_flight works */
206         int                     nr_active;      /* L: nr of active works */
207         int                     max_active;     /* L: max active works */
208         struct list_head        delayed_works;  /* L: delayed works */
209         struct list_head        pwqs_node;      /* WR: node on wq->pwqs */
210         struct list_head        mayday_node;    /* MD: node on wq->maydays */
211
212         /*
213          * Release of unbound pwq is punted to system_wq.  See put_pwq()
214          * and pwq_unbound_release_workfn() for details.  pool_workqueue
215          * itself is also sched-RCU protected so that the first pwq can be
216          * determined without grabbing wq->mutex.
217          */
218         struct work_struct      unbound_release_work;
219         struct rcu_head         rcu;
220 } __aligned(1 << WORK_STRUCT_FLAG_BITS);
221
222 /*
223  * Structure used to wait for workqueue flush.
224  */
225 struct wq_flusher {
226         struct list_head        list;           /* WQ: list of flushers */
227         int                     flush_color;    /* WQ: flush color waiting for */
228         struct completion       done;           /* flush completion */
229 };
230
231 struct wq_device;
232
233 /*
234  * The externally visible workqueue.  It relays the issued work items to
235  * the appropriate worker_pool through its pool_workqueues.
236  */
237 struct workqueue_struct {
238         struct list_head        pwqs;           /* WR: all pwqs of this wq */
239         struct list_head        list;           /* PR: list of all workqueues */
240
241         struct mutex            mutex;          /* protects this wq */
242         int                     work_color;     /* WQ: current work color */
243         int                     flush_color;    /* WQ: current flush color */
244         atomic_t                nr_pwqs_to_flush; /* flush in progress */
245         struct wq_flusher       *first_flusher; /* WQ: first flusher */
246         struct list_head        flusher_queue;  /* WQ: flush waiters */
247         struct list_head        flusher_overflow; /* WQ: flush overflow list */
248
249         struct list_head        maydays;        /* MD: pwqs requesting rescue */
250         struct worker           *rescuer;       /* I: rescue worker */
251
252         int                     nr_drainers;    /* WQ: drain in progress */
253         int                     saved_max_active; /* WQ: saved pwq max_active */
254
255         struct workqueue_attrs  *unbound_attrs; /* PW: only for unbound wqs */
256         struct pool_workqueue   *dfl_pwq;       /* PW: only for unbound wqs */
257
258 #ifdef CONFIG_SYSFS
259         struct wq_device        *wq_dev;        /* I: for sysfs interface */
260 #endif
261 #ifdef CONFIG_LOCKDEP
262         char                    *lock_name;
263         struct lock_class_key   key;
264         struct lockdep_map      lockdep_map;
265 #endif
266         char                    name[WQ_NAME_LEN]; /* I: workqueue name */
267
268         /*
269          * Destruction of workqueue_struct is sched-RCU protected to allow
270          * walking the workqueues list without grabbing wq_pool_mutex.
271          * This is used to dump all workqueues from sysrq.
272          */
273         struct rcu_head         rcu;
274
275         /* hot fields used during command issue, aligned to cacheline */
276         unsigned int            flags ____cacheline_aligned; /* WQ: WQ_* flags */
277         struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */
278         struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */
279 };
280
281 static struct kmem_cache *pwq_cache;
282
283 static cpumask_var_t *wq_numa_possible_cpumask;
284                                         /* possible CPUs of each node */
285
286 static bool wq_disable_numa;
287 module_param_named(disable_numa, wq_disable_numa, bool, 0444);
288
289 /* see the comment above the definition of WQ_POWER_EFFICIENT */
290 static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT);
291 module_param_named(power_efficient, wq_power_efficient, bool, 0444);
292
293 static bool wq_online;                  /* can kworkers be created yet? */
294
295 static bool wq_numa_enabled;            /* unbound NUMA affinity enabled */
296
297 /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */
298 static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf;
299
300 static DEFINE_MUTEX(wq_pool_mutex);     /* protects pools and workqueues list */
301 static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */
302 static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */
303 static DECLARE_WAIT_QUEUE_HEAD(wq_manager_wait); /* wait for manager to go away */
304
305 static LIST_HEAD(workqueues);           /* PR: list of all workqueues */
306 static bool workqueue_freezing;         /* PL: have wqs started freezing? */
307
308 /* PL: allowable cpus for unbound wqs and work items */
309 static cpumask_var_t wq_unbound_cpumask;
310
311 /* CPU where unbound work was last round robin scheduled from this CPU */
312 static DEFINE_PER_CPU(int, wq_rr_cpu_last);
313
314 /*
315  * Local execution of unbound work items is no longer guaranteed.  The
316  * following always forces round-robin CPU selection on unbound work items
317  * to uncover usages which depend on it.
318  */
319 #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU
320 static bool wq_debug_force_rr_cpu = true;
321 #else
322 static bool wq_debug_force_rr_cpu = false;
323 #endif
324 module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644);
325
326 /* the per-cpu worker pools */
327 static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools);
328
329 static DEFINE_IDR(worker_pool_idr);     /* PR: idr of all pools */
330
331 /* PL: hash of all unbound pools keyed by pool->attrs */
332 static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER);
333
334 /* I: attributes used when instantiating standard unbound pools on demand */
335 static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS];
336
337 /* I: attributes used when instantiating ordered pools on demand */
338 static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS];
339
340 struct workqueue_struct *system_wq __read_mostly;
341 EXPORT_SYMBOL(system_wq);
342 struct workqueue_struct *system_highpri_wq __read_mostly;
343 EXPORT_SYMBOL_GPL(system_highpri_wq);
344 struct workqueue_struct *system_long_wq __read_mostly;
345 EXPORT_SYMBOL_GPL(system_long_wq);
346 struct workqueue_struct *system_unbound_wq __read_mostly;
347 EXPORT_SYMBOL_GPL(system_unbound_wq);
348 struct workqueue_struct *system_freezable_wq __read_mostly;
349 EXPORT_SYMBOL_GPL(system_freezable_wq);
350 struct workqueue_struct *system_power_efficient_wq __read_mostly;
351 EXPORT_SYMBOL_GPL(system_power_efficient_wq);
352 struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly;
353 EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq);
354
355 static int worker_thread(void *__worker);
356 static void workqueue_sysfs_unregister(struct workqueue_struct *wq);
357
358 #define CREATE_TRACE_POINTS
359 #include <trace/events/workqueue.h>
360
361 #define assert_rcu_or_pool_mutex()                                      \
362         RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() &&                 \
363                          !lockdep_is_held(&wq_pool_mutex),              \
364                          "sched RCU or wq_pool_mutex should be held")
365
366 #define assert_rcu_or_wq_mutex(wq)                                      \
367         RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() &&                 \
368                          !lockdep_is_held(&wq->mutex),                  \
369                          "sched RCU or wq->mutex should be held")
370
371 #define assert_rcu_or_wq_mutex_or_pool_mutex(wq)                        \
372         RCU_LOCKDEP_WARN(!rcu_read_lock_sched_held() &&                 \
373                          !lockdep_is_held(&wq->mutex) &&                \
374                          !lockdep_is_held(&wq_pool_mutex),              \
375                          "sched RCU, wq->mutex or wq_pool_mutex should be held")
376
377 #define for_each_cpu_worker_pool(pool, cpu)                             \
378         for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0];               \
379              (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \
380              (pool)++)
381
382 /**
383  * for_each_pool - iterate through all worker_pools in the system
384  * @pool: iteration cursor
385  * @pi: integer used for iteration
386  *
387  * This must be called either with wq_pool_mutex held or sched RCU read
388  * locked.  If the pool needs to be used beyond the locking in effect, the
389  * caller is responsible for guaranteeing that the pool stays online.
390  *
391  * The if/else clause exists only for the lockdep assertion and can be
392  * ignored.
393  */
394 #define for_each_pool(pool, pi)                                         \
395         idr_for_each_entry(&worker_pool_idr, pool, pi)                  \
396                 if (({ assert_rcu_or_pool_mutex(); false; })) { }       \
397                 else
398
399 /**
400  * for_each_pool_worker - iterate through all workers of a worker_pool
401  * @worker: iteration cursor
402  * @pool: worker_pool to iterate workers of
403  *
404  * This must be called with wq_pool_attach_mutex.
405  *
406  * The if/else clause exists only for the lockdep assertion and can be
407  * ignored.
408  */
409 #define for_each_pool_worker(worker, pool)                              \
410         list_for_each_entry((worker), &(pool)->workers, node)           \
411                 if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \
412                 else
413
414 /**
415  * for_each_pwq - iterate through all pool_workqueues of the specified workqueue
416  * @pwq: iteration cursor
417  * @wq: the target workqueue
418  *
419  * This must be called either with wq->mutex held or sched RCU read locked.
420  * If the pwq needs to be used beyond the locking in effect, the caller is
421  * responsible for guaranteeing that the pwq stays online.
422  *
423  * The if/else clause exists only for the lockdep assertion and can be
424  * ignored.
425  */
426 #define for_each_pwq(pwq, wq)                                           \
427         list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node)          \
428                 if (({ assert_rcu_or_wq_mutex(wq); false; })) { }       \
429                 else
430
431 #ifdef CONFIG_DEBUG_OBJECTS_WORK
432
433 static struct debug_obj_descr work_debug_descr;
434
435 static void *work_debug_hint(void *addr)
436 {
437         return ((struct work_struct *) addr)->func;
438 }
439
440 static bool work_is_static_object(void *addr)
441 {
442         struct work_struct *work = addr;
443
444         return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work));
445 }
446
447 /*
448  * fixup_init is called when:
449  * - an active object is initialized
450  */
451 static bool work_fixup_init(void *addr, enum debug_obj_state state)
452 {
453         struct work_struct *work = addr;
454
455         switch (state) {
456         case ODEBUG_STATE_ACTIVE:
457                 cancel_work_sync(work);
458                 debug_object_init(work, &work_debug_descr);
459                 return true;
460         default:
461                 return false;
462         }
463 }
464
465 /*
466  * fixup_free is called when:
467  * - an active object is freed
468  */
469 static bool work_fixup_free(void *addr, enum debug_obj_state state)
470 {
471         struct work_struct *work = addr;
472
473         switch (state) {
474         case ODEBUG_STATE_ACTIVE:
475                 cancel_work_sync(work);
476                 debug_object_free(work, &work_debug_descr);
477                 return true;
478         default:
479                 return false;
480         }
481 }
482
483 static struct debug_obj_descr work_debug_descr = {
484         .name           = "work_struct",
485         .debug_hint     = work_debug_hint,
486         .is_static_object = work_is_static_object,
487         .fixup_init     = work_fixup_init,
488         .fixup_free     = work_fixup_free,
489 };
490
491 static inline void debug_work_activate(struct work_struct *work)
492 {
493         debug_object_activate(work, &work_debug_descr);
494 }
495
496 static inline void debug_work_deactivate(struct work_struct *work)
497 {
498         debug_object_deactivate(work, &work_debug_descr);
499 }
500
501 void __init_work(struct work_struct *work, int onstack)
502 {
503         if (onstack)
504                 debug_object_init_on_stack(work, &work_debug_descr);
505         else
506                 debug_object_init(work, &work_debug_descr);
507 }
508 EXPORT_SYMBOL_GPL(__init_work);
509
510 void destroy_work_on_stack(struct work_struct *work)
511 {
512         debug_object_free(work, &work_debug_descr);
513 }
514 EXPORT_SYMBOL_GPL(destroy_work_on_stack);
515
516 void destroy_delayed_work_on_stack(struct delayed_work *work)
517 {
518         destroy_timer_on_stack(&work->timer);
519         debug_object_free(&work->work, &work_debug_descr);
520 }
521 EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack);
522
523 #else
524 static inline void debug_work_activate(struct work_struct *work) { }
525 static inline void debug_work_deactivate(struct work_struct *work) { }
526 #endif
527
528 /**
529  * worker_pool_assign_id - allocate ID and assing it to @pool
530  * @pool: the pool pointer of interest
531  *
532  * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned
533  * successfully, -errno on failure.
534  */
535 static int worker_pool_assign_id(struct worker_pool *pool)
536 {
537         int ret;
538
539         lockdep_assert_held(&wq_pool_mutex);
540
541         ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE,
542                         GFP_KERNEL);
543         if (ret >= 0) {
544                 pool->id = ret;
545                 return 0;
546         }
547         return ret;
548 }
549
550 /**
551  * unbound_pwq_by_node - return the unbound pool_workqueue for the given node
552  * @wq: the target workqueue
553  * @node: the node ID
554  *
555  * This must be called with any of wq_pool_mutex, wq->mutex or sched RCU
556  * read locked.
557  * If the pwq needs to be used beyond the locking in effect, the caller is
558  * responsible for guaranteeing that the pwq stays online.
559  *
560  * Return: The unbound pool_workqueue for @node.
561  */
562 static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq,
563                                                   int node)
564 {
565         assert_rcu_or_wq_mutex_or_pool_mutex(wq);
566
567         /*
568          * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a
569          * delayed item is pending.  The plan is to keep CPU -> NODE
570          * mapping valid and stable across CPU on/offlines.  Once that
571          * happens, this workaround can be removed.
572          */
573         if (unlikely(node == NUMA_NO_NODE))
574                 return wq->dfl_pwq;
575
576         return rcu_dereference_raw(wq->numa_pwq_tbl[node]);
577 }
578
579 static unsigned int work_color_to_flags(int color)
580 {
581         return color << WORK_STRUCT_COLOR_SHIFT;
582 }
583
584 static int get_work_color(struct work_struct *work)
585 {
586         return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) &
587                 ((1 << WORK_STRUCT_COLOR_BITS) - 1);
588 }
589
590 static int work_next_color(int color)
591 {
592         return (color + 1) % WORK_NR_COLORS;
593 }
594
595 /*
596  * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data
597  * contain the pointer to the queued pwq.  Once execution starts, the flag
598  * is cleared and the high bits contain OFFQ flags and pool ID.
599  *
600  * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling()
601  * and clear_work_data() can be used to set the pwq, pool or clear
602  * work->data.  These functions should only be called while the work is
603  * owned - ie. while the PENDING bit is set.
604  *
605  * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq
606  * corresponding to a work.  Pool is available once the work has been
607  * queued anywhere after initialization until it is sync canceled.  pwq is
608  * available only while the work item is queued.
609  *
610  * %WORK_OFFQ_CANCELING is used to mark a work item which is being
611  * canceled.  While being canceled, a work item may have its PENDING set
612  * but stay off timer and worklist for arbitrarily long and nobody should
613  * try to steal the PENDING bit.
614  */
615 static inline void set_work_data(struct work_struct *work, unsigned long data,
616                                  unsigned long flags)
617 {
618         WARN_ON_ONCE(!work_pending(work));
619         atomic_long_set(&work->data, data | flags | work_static(work));
620 }
621
622 static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq,
623                          unsigned long extra_flags)
624 {
625         set_work_data(work, (unsigned long)pwq,
626                       WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags);
627 }
628
629 static void set_work_pool_and_keep_pending(struct work_struct *work,
630                                            int pool_id)
631 {
632         set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT,
633                       WORK_STRUCT_PENDING);
634 }
635
636 static void set_work_pool_and_clear_pending(struct work_struct *work,
637                                             int pool_id)
638 {
639         /*
640          * The following wmb is paired with the implied mb in
641          * test_and_set_bit(PENDING) and ensures all updates to @work made
642          * here are visible to and precede any updates by the next PENDING
643          * owner.
644          */
645         smp_wmb();
646         set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0);
647         /*
648          * The following mb guarantees that previous clear of a PENDING bit
649          * will not be reordered with any speculative LOADS or STORES from
650          * work->current_func, which is executed afterwards.  This possible
651          * reordering can lead to a missed execution on attempt to queue
652          * the same @work.  E.g. consider this case:
653          *
654          *   CPU#0                         CPU#1
655          *   ----------------------------  --------------------------------
656          *
657          * 1  STORE event_indicated
658          * 2  queue_work_on() {
659          * 3    test_and_set_bit(PENDING)
660          * 4 }                             set_..._and_clear_pending() {
661          * 5                                 set_work_data() # clear bit
662          * 6                                 smp_mb()
663          * 7                               work->current_func() {
664          * 8                                  LOAD event_indicated
665          *                                 }
666          *
667          * Without an explicit full barrier speculative LOAD on line 8 can
668          * be executed before CPU#0 does STORE on line 1.  If that happens,
669          * CPU#0 observes the PENDING bit is still set and new execution of
670          * a @work is not queued in a hope, that CPU#1 will eventually
671          * finish the queued @work.  Meanwhile CPU#1 does not see
672          * event_indicated is set, because speculative LOAD was executed
673          * before actual STORE.
674          */
675         smp_mb();
676 }
677
678 static void clear_work_data(struct work_struct *work)
679 {
680         smp_wmb();      /* see set_work_pool_and_clear_pending() */
681         set_work_data(work, WORK_STRUCT_NO_POOL, 0);
682 }
683
684 static struct pool_workqueue *get_work_pwq(struct work_struct *work)
685 {
686         unsigned long data = atomic_long_read(&work->data);
687
688         if (data & WORK_STRUCT_PWQ)
689                 return (void *)(data & WORK_STRUCT_WQ_DATA_MASK);
690         else
691                 return NULL;
692 }
693
694 /**
695  * get_work_pool - return the worker_pool a given work was associated with
696  * @work: the work item of interest
697  *
698  * Pools are created and destroyed under wq_pool_mutex, and allows read
699  * access under sched-RCU read lock.  As such, this function should be
700  * called under wq_pool_mutex or with preemption disabled.
701  *
702  * All fields of the returned pool are accessible as long as the above
703  * mentioned locking is in effect.  If the returned pool needs to be used
704  * beyond the critical section, the caller is responsible for ensuring the
705  * returned pool is and stays online.
706  *
707  * Return: The worker_pool @work was last associated with.  %NULL if none.
708  */
709 static struct worker_pool *get_work_pool(struct work_struct *work)
710 {
711         unsigned long data = atomic_long_read(&work->data);
712         int pool_id;
713
714         assert_rcu_or_pool_mutex();
715
716         if (data & WORK_STRUCT_PWQ)
717                 return ((struct pool_workqueue *)
718                         (data & WORK_STRUCT_WQ_DATA_MASK))->pool;
719
720         pool_id = data >> WORK_OFFQ_POOL_SHIFT;
721         if (pool_id == WORK_OFFQ_POOL_NONE)
722                 return NULL;
723
724         return idr_find(&worker_pool_idr, pool_id);
725 }
726
727 /**
728  * get_work_pool_id - return the worker pool ID a given work is associated with
729  * @work: the work item of interest
730  *
731  * Return: The worker_pool ID @work was last associated with.
732  * %WORK_OFFQ_POOL_NONE if none.
733  */
734 static int get_work_pool_id(struct work_struct *work)
735 {
736         unsigned long data = atomic_long_read(&work->data);
737
738         if (data & WORK_STRUCT_PWQ)
739                 return ((struct pool_workqueue *)
740                         (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id;
741
742         return data >> WORK_OFFQ_POOL_SHIFT;
743 }
744
745 static void mark_work_canceling(struct work_struct *work)
746 {
747         unsigned long pool_id = get_work_pool_id(work);
748
749         pool_id <<= WORK_OFFQ_POOL_SHIFT;
750         set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING);
751 }
752
753 static bool work_is_canceling(struct work_struct *work)
754 {
755         unsigned long data = atomic_long_read(&work->data);
756
757         return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING);
758 }
759
760 /*
761  * Policy functions.  These define the policies on how the global worker
762  * pools are managed.  Unless noted otherwise, these functions assume that
763  * they're being called with pool->lock held.
764  */
765
766 static bool __need_more_worker(struct worker_pool *pool)
767 {
768         return !atomic_read(&pool->nr_running);
769 }
770
771 /*
772  * Need to wake up a worker?  Called from anything but currently
773  * running workers.
774  *
775  * Note that, because unbound workers never contribute to nr_running, this
776  * function will always return %true for unbound pools as long as the
777  * worklist isn't empty.
778  */
779 static bool need_more_worker(struct worker_pool *pool)
780 {
781         return !list_empty(&pool->worklist) && __need_more_worker(pool);
782 }
783
784 /* Can I start working?  Called from busy but !running workers. */
785 static bool may_start_working(struct worker_pool *pool)
786 {
787         return pool->nr_idle;
788 }
789
790 /* Do I need to keep working?  Called from currently running workers. */
791 static bool keep_working(struct worker_pool *pool)
792 {
793         return !list_empty(&pool->worklist) &&
794                 atomic_read(&pool->nr_running) <= 1;
795 }
796
797 /* Do we need a new worker?  Called from manager. */
798 static bool need_to_create_worker(struct worker_pool *pool)
799 {
800         return need_more_worker(pool) && !may_start_working(pool);
801 }
802
803 /* Do we have too many workers and should some go away? */
804 static bool too_many_workers(struct worker_pool *pool)
805 {
806         bool managing = pool->flags & POOL_MANAGER_ACTIVE;
807         int nr_idle = pool->nr_idle + managing; /* manager is considered idle */
808         int nr_busy = pool->nr_workers - nr_idle;
809
810         return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy;
811 }
812
813 /*
814  * Wake up functions.
815  */
816
817 /* Return the first idle worker.  Safe with preemption disabled */
818 static struct worker *first_idle_worker(struct worker_pool *pool)
819 {
820         if (unlikely(list_empty(&pool->idle_list)))
821                 return NULL;
822
823         return list_first_entry(&pool->idle_list, struct worker, entry);
824 }
825
826 /**
827  * wake_up_worker - wake up an idle worker
828  * @pool: worker pool to wake worker from
829  *
830  * Wake up the first idle worker of @pool.
831  *
832  * CONTEXT:
833  * spin_lock_irq(pool->lock).
834  */
835 static void wake_up_worker(struct worker_pool *pool)
836 {
837         struct worker *worker = first_idle_worker(pool);
838
839         if (likely(worker))
840                 wake_up_process(worker->task);
841 }
842
843 /**
844  * wq_worker_waking_up - a worker is waking up
845  * @task: task waking up
846  * @cpu: CPU @task is waking up to
847  *
848  * This function is called during try_to_wake_up() when a worker is
849  * being awoken.
850  *
851  * CONTEXT:
852  * spin_lock_irq(rq->lock)
853  */
854 void wq_worker_waking_up(struct task_struct *task, int cpu)
855 {
856         struct worker *worker = kthread_data(task);
857
858         if (!(worker->flags & WORKER_NOT_RUNNING)) {
859                 WARN_ON_ONCE(worker->pool->cpu != cpu);
860                 atomic_inc(&worker->pool->nr_running);
861         }
862 }
863
864 /**
865  * wq_worker_sleeping - a worker is going to sleep
866  * @task: task going to sleep
867  *
868  * This function is called during schedule() when a busy worker is
869  * going to sleep.  Worker on the same cpu can be woken up by
870  * returning pointer to its task.
871  *
872  * CONTEXT:
873  * spin_lock_irq(rq->lock)
874  *
875  * Return:
876  * Worker task on @cpu to wake up, %NULL if none.
877  */
878 struct task_struct *wq_worker_sleeping(struct task_struct *task)
879 {
880         struct worker *worker = kthread_data(task), *to_wakeup = NULL;
881         struct worker_pool *pool;
882
883         /*
884          * Rescuers, which may not have all the fields set up like normal
885          * workers, also reach here, let's not access anything before
886          * checking NOT_RUNNING.
887          */
888         if (worker->flags & WORKER_NOT_RUNNING)
889                 return NULL;
890
891         pool = worker->pool;
892
893         /* this can only happen on the local cpu */
894         if (WARN_ON_ONCE(pool->cpu != raw_smp_processor_id()))
895                 return NULL;
896
897         /*
898          * The counterpart of the following dec_and_test, implied mb,
899          * worklist not empty test sequence is in insert_work().
900          * Please read comment there.
901          *
902          * NOT_RUNNING is clear.  This means that we're bound to and
903          * running on the local cpu w/ rq lock held and preemption
904          * disabled, which in turn means that none else could be
905          * manipulating idle_list, so dereferencing idle_list without pool
906          * lock is safe.
907          */
908         if (atomic_dec_and_test(&pool->nr_running) &&
909             !list_empty(&pool->worklist))
910                 to_wakeup = first_idle_worker(pool);
911         return to_wakeup ? to_wakeup->task : NULL;
912 }
913
914 /**
915  * wq_worker_last_func - retrieve worker's last work function
916  *
917  * Determine the last function a worker executed. This is called from
918  * the scheduler to get a worker's last known identity.
919  *
920  * CONTEXT:
921  * spin_lock_irq(rq->lock)
922  *
923  * Return:
924  * The last work function %current executed as a worker, NULL if it
925  * hasn't executed any work yet.
926  */
927 work_func_t wq_worker_last_func(struct task_struct *task)
928 {
929         struct worker *worker = kthread_data(task);
930
931         return worker->last_func;
932 }
933
934 /**
935  * worker_set_flags - set worker flags and adjust nr_running accordingly
936  * @worker: self
937  * @flags: flags to set
938  *
939  * Set @flags in @worker->flags and adjust nr_running accordingly.
940  *
941  * CONTEXT:
942  * spin_lock_irq(pool->lock)
943  */
944 static inline void worker_set_flags(struct worker *worker, unsigned int flags)
945 {
946         struct worker_pool *pool = worker->pool;
947
948         WARN_ON_ONCE(worker->task != current);
949
950         /* If transitioning into NOT_RUNNING, adjust nr_running. */
951         if ((flags & WORKER_NOT_RUNNING) &&
952             !(worker->flags & WORKER_NOT_RUNNING)) {
953                 atomic_dec(&pool->nr_running);
954         }
955
956         worker->flags |= flags;
957 }
958
959 /**
960  * worker_clr_flags - clear worker flags and adjust nr_running accordingly
961  * @worker: self
962  * @flags: flags to clear
963  *
964  * Clear @flags in @worker->flags and adjust nr_running accordingly.
965  *
966  * CONTEXT:
967  * spin_lock_irq(pool->lock)
968  */
969 static inline void worker_clr_flags(struct worker *worker, unsigned int flags)
970 {
971         struct worker_pool *pool = worker->pool;
972         unsigned int oflags = worker->flags;
973
974         WARN_ON_ONCE(worker->task != current);
975
976         worker->flags &= ~flags;
977
978         /*
979          * If transitioning out of NOT_RUNNING, increment nr_running.  Note
980          * that the nested NOT_RUNNING is not a noop.  NOT_RUNNING is mask
981          * of multiple flags, not a single flag.
982          */
983         if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING))
984                 if (!(worker->flags & WORKER_NOT_RUNNING))
985                         atomic_inc(&pool->nr_running);
986 }
987
988 /**
989  * find_worker_executing_work - find worker which is executing a work
990  * @pool: pool of interest
991  * @work: work to find worker for
992  *
993  * Find a worker which is executing @work on @pool by searching
994  * @pool->busy_hash which is keyed by the address of @work.  For a worker
995  * to match, its current execution should match the address of @work and
996  * its work function.  This is to avoid unwanted dependency between
997  * unrelated work executions through a work item being recycled while still
998  * being executed.
999  *
1000  * This is a bit tricky.  A work item may be freed once its execution
1001  * starts and nothing prevents the freed area from being recycled for
1002  * another work item.  If the same work item address ends up being reused
1003  * before the original execution finishes, workqueue will identify the
1004  * recycled work item as currently executing and make it wait until the
1005  * current execution finishes, introducing an unwanted dependency.
1006  *
1007  * This function checks the work item address and work function to avoid
1008  * false positives.  Note that this isn't complete as one may construct a
1009  * work function which can introduce dependency onto itself through a
1010  * recycled work item.  Well, if somebody wants to shoot oneself in the
1011  * foot that badly, there's only so much we can do, and if such deadlock
1012  * actually occurs, it should be easy to locate the culprit work function.
1013  *
1014  * CONTEXT:
1015  * spin_lock_irq(pool->lock).
1016  *
1017  * Return:
1018  * Pointer to worker which is executing @work if found, %NULL
1019  * otherwise.
1020  */
1021 static struct worker *find_worker_executing_work(struct worker_pool *pool,
1022                                                  struct work_struct *work)
1023 {
1024         struct worker *worker;
1025
1026         hash_for_each_possible(pool->busy_hash, worker, hentry,
1027                                (unsigned long)work)
1028                 if (worker->current_work == work &&
1029                     worker->current_func == work->func)
1030                         return worker;
1031
1032         return NULL;
1033 }
1034
1035 /**
1036  * move_linked_works - move linked works to a list
1037  * @work: start of series of works to be scheduled
1038  * @head: target list to append @work to
1039  * @nextp: out parameter for nested worklist walking
1040  *
1041  * Schedule linked works starting from @work to @head.  Work series to
1042  * be scheduled starts at @work and includes any consecutive work with
1043  * WORK_STRUCT_LINKED set in its predecessor.
1044  *
1045  * If @nextp is not NULL, it's updated to point to the next work of
1046  * the last scheduled work.  This allows move_linked_works() to be
1047  * nested inside outer list_for_each_entry_safe().
1048  *
1049  * CONTEXT:
1050  * spin_lock_irq(pool->lock).
1051  */
1052 static void move_linked_works(struct work_struct *work, struct list_head *head,
1053                               struct work_struct **nextp)
1054 {
1055         struct work_struct *n;
1056
1057         /*
1058          * Linked worklist will always end before the end of the list,
1059          * use NULL for list head.
1060          */
1061         list_for_each_entry_safe_from(work, n, NULL, entry) {
1062                 list_move_tail(&work->entry, head);
1063                 if (!(*work_data_bits(work) & WORK_STRUCT_LINKED))
1064                         break;
1065         }
1066
1067         /*
1068          * If we're already inside safe list traversal and have moved
1069          * multiple works to the scheduled queue, the next position
1070          * needs to be updated.
1071          */
1072         if (nextp)
1073                 *nextp = n;
1074 }
1075
1076 /**
1077  * get_pwq - get an extra reference on the specified pool_workqueue
1078  * @pwq: pool_workqueue to get
1079  *
1080  * Obtain an extra reference on @pwq.  The caller should guarantee that
1081  * @pwq has positive refcnt and be holding the matching pool->lock.
1082  */
1083 static void get_pwq(struct pool_workqueue *pwq)
1084 {
1085         lockdep_assert_held(&pwq->pool->lock);
1086         WARN_ON_ONCE(pwq->refcnt <= 0);
1087         pwq->refcnt++;
1088 }
1089
1090 /**
1091  * put_pwq - put a pool_workqueue reference
1092  * @pwq: pool_workqueue to put
1093  *
1094  * Drop a reference of @pwq.  If its refcnt reaches zero, schedule its
1095  * destruction.  The caller should be holding the matching pool->lock.
1096  */
1097 static void put_pwq(struct pool_workqueue *pwq)
1098 {
1099         lockdep_assert_held(&pwq->pool->lock);
1100         if (likely(--pwq->refcnt))
1101                 return;
1102         if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND)))
1103                 return;
1104         /*
1105          * @pwq can't be released under pool->lock, bounce to
1106          * pwq_unbound_release_workfn().  This never recurses on the same
1107          * pool->lock as this path is taken only for unbound workqueues and
1108          * the release work item is scheduled on a per-cpu workqueue.  To
1109          * avoid lockdep warning, unbound pool->locks are given lockdep
1110          * subclass of 1 in get_unbound_pool().
1111          */
1112         schedule_work(&pwq->unbound_release_work);
1113 }
1114
1115 /**
1116  * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock
1117  * @pwq: pool_workqueue to put (can be %NULL)
1118  *
1119  * put_pwq() with locking.  This function also allows %NULL @pwq.
1120  */
1121 static void put_pwq_unlocked(struct pool_workqueue *pwq)
1122 {
1123         if (pwq) {
1124                 /*
1125                  * As both pwqs and pools are sched-RCU protected, the
1126                  * following lock operations are safe.
1127                  */
1128                 spin_lock_irq(&pwq->pool->lock);
1129                 put_pwq(pwq);
1130                 spin_unlock_irq(&pwq->pool->lock);
1131         }
1132 }
1133
1134 static void pwq_activate_delayed_work(struct work_struct *work)
1135 {
1136         struct pool_workqueue *pwq = get_work_pwq(work);
1137
1138         trace_workqueue_activate_work(work);
1139         if (list_empty(&pwq->pool->worklist))
1140                 pwq->pool->watchdog_ts = jiffies;
1141         move_linked_works(work, &pwq->pool->worklist, NULL);
1142         __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work));
1143         pwq->nr_active++;
1144 }
1145
1146 static void pwq_activate_first_delayed(struct pool_workqueue *pwq)
1147 {
1148         struct work_struct *work = list_first_entry(&pwq->delayed_works,
1149                                                     struct work_struct, entry);
1150
1151         pwq_activate_delayed_work(work);
1152 }
1153
1154 /**
1155  * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight
1156  * @pwq: pwq of interest
1157  * @color: color of work which left the queue
1158  *
1159  * A work either has completed or is removed from pending queue,
1160  * decrement nr_in_flight of its pwq and handle workqueue flushing.
1161  *
1162  * CONTEXT:
1163  * spin_lock_irq(pool->lock).
1164  */
1165 static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)
1166 {
1167         /* uncolored work items don't participate in flushing or nr_active */
1168         if (color == WORK_NO_COLOR)
1169                 goto out_put;
1170
1171         pwq->nr_in_flight[color]--;
1172
1173         pwq->nr_active--;
1174         if (!list_empty(&pwq->delayed_works)) {
1175                 /* one down, submit a delayed one */
1176                 if (pwq->nr_active < pwq->max_active)
1177                         pwq_activate_first_delayed(pwq);
1178         }
1179
1180         /* is flush in progress and are we at the flushing tip? */
1181         if (likely(pwq->flush_color != color))
1182                 goto out_put;
1183
1184         /* are there still in-flight works? */
1185         if (pwq->nr_in_flight[color])
1186                 goto out_put;
1187
1188         /* this pwq is done, clear flush_color */
1189         pwq->flush_color = -1;
1190
1191         /*
1192          * If this was the last pwq, wake up the first flusher.  It
1193          * will handle the rest.
1194          */
1195         if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush))
1196                 complete(&pwq->wq->first_flusher->done);
1197 out_put:
1198         put_pwq(pwq);
1199 }
1200
1201 /**
1202  * try_to_grab_pending - steal work item from worklist and disable irq
1203  * @work: work item to steal
1204  * @is_dwork: @work is a delayed_work
1205  * @flags: place to store irq state
1206  *
1207  * Try to grab PENDING bit of @work.  This function can handle @work in any
1208  * stable state - idle, on timer or on worklist.
1209  *
1210  * Return:
1211  *  1           if @work was pending and we successfully stole PENDING
1212  *  0           if @work was idle and we claimed PENDING
1213  *  -EAGAIN     if PENDING couldn't be grabbed at the moment, safe to busy-retry
1214  *  -ENOENT     if someone else is canceling @work, this state may persist
1215  *              for arbitrarily long
1216  *
1217  * Note:
1218  * On >= 0 return, the caller owns @work's PENDING bit.  To avoid getting
1219  * interrupted while holding PENDING and @work off queue, irq must be
1220  * disabled on entry.  This, combined with delayed_work->timer being
1221  * irqsafe, ensures that we return -EAGAIN for finite short period of time.
1222  *
1223  * On successful return, >= 0, irq is disabled and the caller is
1224  * responsible for releasing it using local_irq_restore(*@flags).
1225  *
1226  * This function is safe to call from any context including IRQ handler.
1227  */
1228 static int try_to_grab_pending(struct work_struct *work, bool is_dwork,
1229                                unsigned long *flags)
1230 {
1231         struct worker_pool *pool;
1232         struct pool_workqueue *pwq;
1233
1234         local_irq_save(*flags);
1235
1236         /* try to steal the timer if it exists */
1237         if (is_dwork) {
1238                 struct delayed_work *dwork = to_delayed_work(work);
1239
1240                 /*
1241                  * dwork->timer is irqsafe.  If del_timer() fails, it's
1242                  * guaranteed that the timer is not queued anywhere and not
1243                  * running on the local CPU.
1244                  */
1245                 if (likely(del_timer(&dwork->timer)))
1246                         return 1;
1247         }
1248
1249         /* try to claim PENDING the normal way */
1250         if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)))
1251                 return 0;
1252
1253         /*
1254          * The queueing is in progress, or it is already queued. Try to
1255          * steal it from ->worklist without clearing WORK_STRUCT_PENDING.
1256          */
1257         pool = get_work_pool(work);
1258         if (!pool)
1259                 goto fail;
1260
1261         spin_lock(&pool->lock);
1262         /*
1263          * work->data is guaranteed to point to pwq only while the work
1264          * item is queued on pwq->wq, and both updating work->data to point
1265          * to pwq on queueing and to pool on dequeueing are done under
1266          * pwq->pool->lock.  This in turn guarantees that, if work->data
1267          * points to pwq which is associated with a locked pool, the work
1268          * item is currently queued on that pool.
1269          */
1270         pwq = get_work_pwq(work);
1271         if (pwq && pwq->pool == pool) {
1272                 debug_work_deactivate(work);
1273
1274                 /*
1275                  * A delayed work item cannot be grabbed directly because
1276                  * it might have linked NO_COLOR work items which, if left
1277                  * on the delayed_list, will confuse pwq->nr_active
1278                  * management later on and cause stall.  Make sure the work
1279                  * item is activated before grabbing.
1280                  */
1281                 if (*work_data_bits(work) & WORK_STRUCT_DELAYED)
1282                         pwq_activate_delayed_work(work);
1283
1284                 list_del_init(&work->entry);
1285                 pwq_dec_nr_in_flight(pwq, get_work_color(work));
1286
1287                 /* work->data points to pwq iff queued, point to pool */
1288                 set_work_pool_and_keep_pending(work, pool->id);
1289
1290                 spin_unlock(&pool->lock);
1291                 return 1;
1292         }
1293         spin_unlock(&pool->lock);
1294 fail:
1295         local_irq_restore(*flags);
1296         if (work_is_canceling(work))
1297                 return -ENOENT;
1298         cpu_relax();
1299         return -EAGAIN;
1300 }
1301
1302 /**
1303  * insert_work - insert a work into a pool
1304  * @pwq: pwq @work belongs to
1305  * @work: work to insert
1306  * @head: insertion point
1307  * @extra_flags: extra WORK_STRUCT_* flags to set
1308  *
1309  * Insert @work which belongs to @pwq after @head.  @extra_flags is or'd to
1310  * work_struct flags.
1311  *
1312  * CONTEXT:
1313  * spin_lock_irq(pool->lock).
1314  */
1315 static void insert_work(struct pool_workqueue *pwq, struct work_struct *work,
1316                         struct list_head *head, unsigned int extra_flags)
1317 {
1318         struct worker_pool *pool = pwq->pool;
1319
1320         /* we own @work, set data and link */
1321         set_work_pwq(work, pwq, extra_flags);
1322         list_add_tail(&work->entry, head);
1323         get_pwq(pwq);
1324
1325         /*
1326          * Ensure either wq_worker_sleeping() sees the above
1327          * list_add_tail() or we see zero nr_running to avoid workers lying
1328          * around lazily while there are works to be processed.
1329          */
1330         smp_mb();
1331
1332         if (__need_more_worker(pool))
1333                 wake_up_worker(pool);
1334 }
1335
1336 /*
1337  * Test whether @work is being queued from another work executing on the
1338  * same workqueue.
1339  */
1340 static bool is_chained_work(struct workqueue_struct *wq)
1341 {
1342         struct worker *worker;
1343
1344         worker = current_wq_worker();
1345         /*
1346          * Return %true iff I'm a worker executing a work item on @wq.  If
1347          * I'm @worker, it's safe to dereference it without locking.
1348          */
1349         return worker && worker->current_pwq->wq == wq;
1350 }
1351
1352 /*
1353  * When queueing an unbound work item to a wq, prefer local CPU if allowed
1354  * by wq_unbound_cpumask.  Otherwise, round robin among the allowed ones to
1355  * avoid perturbing sensitive tasks.
1356  */
1357 static int wq_select_unbound_cpu(int cpu)
1358 {
1359         static bool printed_dbg_warning;
1360         int new_cpu;
1361
1362         if (likely(!wq_debug_force_rr_cpu)) {
1363                 if (cpumask_test_cpu(cpu, wq_unbound_cpumask))
1364                         return cpu;
1365         } else if (!printed_dbg_warning) {
1366                 pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n");
1367                 printed_dbg_warning = true;
1368         }
1369
1370         if (cpumask_empty(wq_unbound_cpumask))
1371                 return cpu;
1372
1373         new_cpu = __this_cpu_read(wq_rr_cpu_last);
1374         new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask);
1375         if (unlikely(new_cpu >= nr_cpu_ids)) {
1376                 new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask);
1377                 if (unlikely(new_cpu >= nr_cpu_ids))
1378                         return cpu;
1379         }
1380         __this_cpu_write(wq_rr_cpu_last, new_cpu);
1381
1382         return new_cpu;
1383 }
1384
1385 static void __queue_work(int cpu, struct workqueue_struct *wq,
1386                          struct work_struct *work)
1387 {
1388         struct pool_workqueue *pwq;
1389         struct worker_pool *last_pool;
1390         struct list_head *worklist;
1391         unsigned int work_flags;
1392         unsigned int req_cpu = cpu;
1393
1394         /*
1395          * While a work item is PENDING && off queue, a task trying to
1396          * steal the PENDING will busy-loop waiting for it to either get
1397          * queued or lose PENDING.  Grabbing PENDING and queueing should
1398          * happen with IRQ disabled.
1399          */
1400         lockdep_assert_irqs_disabled();
1401
1402         debug_work_activate(work);
1403
1404         /* if draining, only works from the same workqueue are allowed */
1405         if (unlikely(wq->flags & __WQ_DRAINING) &&
1406             WARN_ON_ONCE(!is_chained_work(wq)))
1407                 return;
1408 retry:
1409         if (req_cpu == WORK_CPU_UNBOUND)
1410                 cpu = wq_select_unbound_cpu(raw_smp_processor_id());
1411
1412         /* pwq which will be used unless @work is executing elsewhere */
1413         if (!(wq->flags & WQ_UNBOUND))
1414                 pwq = per_cpu_ptr(wq->cpu_pwqs, cpu);
1415         else
1416                 pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu));
1417
1418         /*
1419          * If @work was previously on a different pool, it might still be
1420          * running there, in which case the work needs to be queued on that
1421          * pool to guarantee non-reentrancy.
1422          */
1423         last_pool = get_work_pool(work);
1424         if (last_pool && last_pool != pwq->pool) {
1425                 struct worker *worker;
1426
1427                 spin_lock(&last_pool->lock);
1428
1429                 worker = find_worker_executing_work(last_pool, work);
1430
1431                 if (worker && worker->current_pwq->wq == wq) {
1432                         pwq = worker->current_pwq;
1433                 } else {
1434                         /* meh... not running there, queue here */
1435                         spin_unlock(&last_pool->lock);
1436                         spin_lock(&pwq->pool->lock);
1437                 }
1438         } else {
1439                 spin_lock(&pwq->pool->lock);
1440         }
1441
1442         /*
1443          * pwq is determined and locked.  For unbound pools, we could have
1444          * raced with pwq release and it could already be dead.  If its
1445          * refcnt is zero, repeat pwq selection.  Note that pwqs never die
1446          * without another pwq replacing it in the numa_pwq_tbl or while
1447          * work items are executing on it, so the retrying is guaranteed to
1448          * make forward-progress.
1449          */
1450         if (unlikely(!pwq->refcnt)) {
1451                 if (wq->flags & WQ_UNBOUND) {
1452                         spin_unlock(&pwq->pool->lock);
1453                         cpu_relax();
1454                         goto retry;
1455                 }
1456                 /* oops */
1457                 WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt",
1458                           wq->name, cpu);
1459         }
1460
1461         /* pwq determined, queue */
1462         trace_workqueue_queue_work(req_cpu, pwq, work);
1463
1464         if (WARN_ON(!list_empty(&work->entry))) {
1465                 spin_unlock(&pwq->pool->lock);
1466                 return;
1467         }
1468
1469         pwq->nr_in_flight[pwq->work_color]++;
1470         work_flags = work_color_to_flags(pwq->work_color);
1471
1472         if (likely(pwq->nr_active < pwq->max_active)) {
1473                 trace_workqueue_activate_work(work);
1474                 pwq->nr_active++;
1475                 worklist = &pwq->pool->worklist;
1476                 if (list_empty(worklist))
1477                         pwq->pool->watchdog_ts = jiffies;
1478         } else {
1479                 work_flags |= WORK_STRUCT_DELAYED;
1480                 worklist = &pwq->delayed_works;
1481         }
1482
1483         insert_work(pwq, work, worklist, work_flags);
1484
1485         spin_unlock(&pwq->pool->lock);
1486 }
1487
1488 /**
1489  * queue_work_on - queue work on specific cpu
1490  * @cpu: CPU number to execute work on
1491  * @wq: workqueue to use
1492  * @work: work to queue
1493  *
1494  * We queue the work to a specific CPU, the caller must ensure it
1495  * can't go away.
1496  *
1497  * Return: %false if @work was already on a queue, %true otherwise.
1498  */
1499 bool queue_work_on(int cpu, struct workqueue_struct *wq,
1500                    struct work_struct *work)
1501 {
1502         bool ret = false;
1503         unsigned long flags;
1504
1505         local_irq_save(flags);
1506
1507         if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1508                 __queue_work(cpu, wq, work);
1509                 ret = true;
1510         }
1511
1512         local_irq_restore(flags);
1513         return ret;
1514 }
1515 EXPORT_SYMBOL(queue_work_on);
1516
1517 /**
1518  * workqueue_select_cpu_near - Select a CPU based on NUMA node
1519  * @node: NUMA node ID that we want to select a CPU from
1520  *
1521  * This function will attempt to find a "random" cpu available on a given
1522  * node. If there are no CPUs available on the given node it will return
1523  * WORK_CPU_UNBOUND indicating that we should just schedule to any
1524  * available CPU if we need to schedule this work.
1525  */
1526 static int workqueue_select_cpu_near(int node)
1527 {
1528         int cpu;
1529
1530         /* No point in doing this if NUMA isn't enabled for workqueues */
1531         if (!wq_numa_enabled)
1532                 return WORK_CPU_UNBOUND;
1533
1534         /* Delay binding to CPU if node is not valid or online */
1535         if (node < 0 || node >= MAX_NUMNODES || !node_online(node))
1536                 return WORK_CPU_UNBOUND;
1537
1538         /* Use local node/cpu if we are already there */
1539         cpu = raw_smp_processor_id();
1540         if (node == cpu_to_node(cpu))
1541                 return cpu;
1542
1543         /* Use "random" otherwise know as "first" online CPU of node */
1544         cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
1545
1546         /* If CPU is valid return that, otherwise just defer */
1547         return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND;
1548 }
1549
1550 /**
1551  * queue_work_node - queue work on a "random" cpu for a given NUMA node
1552  * @node: NUMA node that we are targeting the work for
1553  * @wq: workqueue to use
1554  * @work: work to queue
1555  *
1556  * We queue the work to a "random" CPU within a given NUMA node. The basic
1557  * idea here is to provide a way to somehow associate work with a given
1558  * NUMA node.
1559  *
1560  * This function will only make a best effort attempt at getting this onto
1561  * the right NUMA node. If no node is requested or the requested node is
1562  * offline then we just fall back to standard queue_work behavior.
1563  *
1564  * Currently the "random" CPU ends up being the first available CPU in the
1565  * intersection of cpu_online_mask and the cpumask of the node, unless we
1566  * are running on the node. In that case we just use the current CPU.
1567  *
1568  * Return: %false if @work was already on a queue, %true otherwise.
1569  */
1570 bool queue_work_node(int node, struct workqueue_struct *wq,
1571                      struct work_struct *work)
1572 {
1573         unsigned long flags;
1574         bool ret = false;
1575
1576         /*
1577          * This current implementation is specific to unbound workqueues.
1578          * Specifically we only return the first available CPU for a given
1579          * node instead of cycling through individual CPUs within the node.
1580          *
1581          * If this is used with a per-cpu workqueue then the logic in
1582          * workqueue_select_cpu_near would need to be updated to allow for
1583          * some round robin type logic.
1584          */
1585         WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND));
1586
1587         local_irq_save(flags);
1588
1589         if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1590                 int cpu = workqueue_select_cpu_near(node);
1591
1592                 __queue_work(cpu, wq, work);
1593                 ret = true;
1594         }
1595
1596         local_irq_restore(flags);
1597         return ret;
1598 }
1599 EXPORT_SYMBOL_GPL(queue_work_node);
1600
1601 void delayed_work_timer_fn(struct timer_list *t)
1602 {
1603         struct delayed_work *dwork = from_timer(dwork, t, timer);
1604
1605         /* should have been called from irqsafe timer with irq already off */
1606         __queue_work(dwork->cpu, dwork->wq, &dwork->work);
1607 }
1608 EXPORT_SYMBOL(delayed_work_timer_fn);
1609
1610 static void __queue_delayed_work(int cpu, struct workqueue_struct *wq,
1611                                 struct delayed_work *dwork, unsigned long delay)
1612 {
1613         struct timer_list *timer = &dwork->timer;
1614         struct work_struct *work = &dwork->work;
1615
1616         WARN_ON_ONCE(!wq);
1617         WARN_ON_ONCE(timer->function != delayed_work_timer_fn);
1618         WARN_ON_ONCE(timer_pending(timer));
1619         WARN_ON_ONCE(!list_empty(&work->entry));
1620
1621         /*
1622          * If @delay is 0, queue @dwork->work immediately.  This is for
1623          * both optimization and correctness.  The earliest @timer can
1624          * expire is on the closest next tick and delayed_work users depend
1625          * on that there's no such delay when @delay is 0.
1626          */
1627         if (!delay) {
1628                 __queue_work(cpu, wq, &dwork->work);
1629                 return;
1630         }
1631
1632         dwork->wq = wq;
1633         dwork->cpu = cpu;
1634         timer->expires = jiffies + delay;
1635
1636         if (unlikely(cpu != WORK_CPU_UNBOUND))
1637                 add_timer_on(timer, cpu);
1638         else
1639                 add_timer(timer);
1640 }
1641
1642 /**
1643  * queue_delayed_work_on - queue work on specific CPU after delay
1644  * @cpu: CPU number to execute work on
1645  * @wq: workqueue to use
1646  * @dwork: work to queue
1647  * @delay: number of jiffies to wait before queueing
1648  *
1649  * Return: %false if @work was already on a queue, %true otherwise.  If
1650  * @delay is zero and @dwork is idle, it will be scheduled for immediate
1651  * execution.
1652  */
1653 bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
1654                            struct delayed_work *dwork, unsigned long delay)
1655 {
1656         struct work_struct *work = &dwork->work;
1657         bool ret = false;
1658         unsigned long flags;
1659
1660         /* read the comment in __queue_work() */
1661         local_irq_save(flags);
1662
1663         if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1664                 __queue_delayed_work(cpu, wq, dwork, delay);
1665                 ret = true;
1666         }
1667
1668         local_irq_restore(flags);
1669         return ret;
1670 }
1671 EXPORT_SYMBOL(queue_delayed_work_on);
1672
1673 /**
1674  * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU
1675  * @cpu: CPU number to execute work on
1676  * @wq: workqueue to use
1677  * @dwork: work to queue
1678  * @delay: number of jiffies to wait before queueing
1679  *
1680  * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise,
1681  * modify @dwork's timer so that it expires after @delay.  If @delay is
1682  * zero, @work is guaranteed to be scheduled immediately regardless of its
1683  * current state.
1684  *
1685  * Return: %false if @dwork was idle and queued, %true if @dwork was
1686  * pending and its timer was modified.
1687  *
1688  * This function is safe to call from any context including IRQ handler.
1689  * See try_to_grab_pending() for details.
1690  */
1691 bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
1692                          struct delayed_work *dwork, unsigned long delay)
1693 {
1694         unsigned long flags;
1695         int ret;
1696
1697         do {
1698                 ret = try_to_grab_pending(&dwork->work, true, &flags);
1699         } while (unlikely(ret == -EAGAIN));
1700
1701         if (likely(ret >= 0)) {
1702                 __queue_delayed_work(cpu, wq, dwork, delay);
1703                 local_irq_restore(flags);
1704         }
1705
1706         /* -ENOENT from try_to_grab_pending() becomes %true */
1707         return ret;
1708 }
1709 EXPORT_SYMBOL_GPL(mod_delayed_work_on);
1710
1711 static void rcu_work_rcufn(struct rcu_head *rcu)
1712 {
1713         struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu);
1714
1715         /* read the comment in __queue_work() */
1716         local_irq_disable();
1717         __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work);
1718         local_irq_enable();
1719 }
1720
1721 /**
1722  * queue_rcu_work - queue work after a RCU grace period
1723  * @wq: workqueue to use
1724  * @rwork: work to queue
1725  *
1726  * Return: %false if @rwork was already pending, %true otherwise.  Note
1727  * that a full RCU grace period is guaranteed only after a %true return.
1728  * While @rwork is guaranteed to be executed after a %false return, the
1729  * execution may happen before a full RCU grace period has passed.
1730  */
1731 bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork)
1732 {
1733         struct work_struct *work = &rwork->work;
1734
1735         if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) {
1736                 rwork->wq = wq;
1737                 call_rcu(&rwork->rcu, rcu_work_rcufn);
1738                 return true;
1739         }
1740
1741         return false;
1742 }
1743 EXPORT_SYMBOL(queue_rcu_work);
1744
1745 /**
1746  * worker_enter_idle - enter idle state
1747  * @worker: worker which is entering idle state
1748  *
1749  * @worker is entering idle state.  Update stats and idle timer if
1750  * necessary.
1751  *
1752  * LOCKING:
1753  * spin_lock_irq(pool->lock).
1754  */
1755 static void worker_enter_idle(struct worker *worker)
1756 {
1757         struct worker_pool *pool = worker->pool;
1758
1759         if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) ||
1760             WARN_ON_ONCE(!list_empty(&worker->entry) &&
1761                          (worker->hentry.next || worker->hentry.pprev)))
1762                 return;
1763
1764         /* can't use worker_set_flags(), also called from create_worker() */
1765         worker->flags |= WORKER_IDLE;
1766         pool->nr_idle++;
1767         worker->last_active = jiffies;
1768
1769         /* idle_list is LIFO */
1770         list_add(&worker->entry, &pool->idle_list);
1771
1772         if (too_many_workers(pool) && !timer_pending(&pool->idle_timer))
1773                 mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT);
1774
1775         /*
1776          * Sanity check nr_running.  Because unbind_workers() releases
1777          * pool->lock between setting %WORKER_UNBOUND and zapping
1778          * nr_running, the warning may trigger spuriously.  Check iff
1779          * unbind is not in progress.
1780          */
1781         WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
1782                      pool->nr_workers == pool->nr_idle &&
1783                      atomic_read(&pool->nr_running));
1784 }
1785
1786 /**
1787  * worker_leave_idle - leave idle state
1788  * @worker: worker which is leaving idle state
1789  *
1790  * @worker is leaving idle state.  Update stats.
1791  *
1792  * LOCKING:
1793  * spin_lock_irq(pool->lock).
1794  */
1795 static void worker_leave_idle(struct worker *worker)
1796 {
1797         struct worker_pool *pool = worker->pool;
1798
1799         if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE)))
1800                 return;
1801         worker_clr_flags(worker, WORKER_IDLE);
1802         pool->nr_idle--;
1803         list_del_init(&worker->entry);
1804 }
1805
1806 static struct worker *alloc_worker(int node)
1807 {
1808         struct worker *worker;
1809
1810         worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node);
1811         if (worker) {
1812                 INIT_LIST_HEAD(&worker->entry);
1813                 INIT_LIST_HEAD(&worker->scheduled);
1814                 INIT_LIST_HEAD(&worker->node);
1815                 /* on creation a worker is in !idle && prep state */
1816                 worker->flags = WORKER_PREP;
1817         }
1818         return worker;
1819 }
1820
1821 /**
1822  * worker_attach_to_pool() - attach a worker to a pool
1823  * @worker: worker to be attached
1824  * @pool: the target pool
1825  *
1826  * Attach @worker to @pool.  Once attached, the %WORKER_UNBOUND flag and
1827  * cpu-binding of @worker are kept coordinated with the pool across
1828  * cpu-[un]hotplugs.
1829  */
1830 static void worker_attach_to_pool(struct worker *worker,
1831                                    struct worker_pool *pool)
1832 {
1833         mutex_lock(&wq_pool_attach_mutex);
1834
1835         /*
1836          * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any
1837          * online CPUs.  It'll be re-applied when any of the CPUs come up.
1838          */
1839         set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask);
1840
1841         /*
1842          * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains
1843          * stable across this function.  See the comments above the flag
1844          * definition for details.
1845          */
1846         if (pool->flags & POOL_DISASSOCIATED)
1847                 worker->flags |= WORKER_UNBOUND;
1848
1849         list_add_tail(&worker->node, &pool->workers);
1850         worker->pool = pool;
1851
1852         mutex_unlock(&wq_pool_attach_mutex);
1853 }
1854
1855 /**
1856  * worker_detach_from_pool() - detach a worker from its pool
1857  * @worker: worker which is attached to its pool
1858  *
1859  * Undo the attaching which had been done in worker_attach_to_pool().  The
1860  * caller worker shouldn't access to the pool after detached except it has
1861  * other reference to the pool.
1862  */
1863 static void worker_detach_from_pool(struct worker *worker)
1864 {
1865         struct worker_pool *pool = worker->pool;
1866         struct completion *detach_completion = NULL;
1867
1868         mutex_lock(&wq_pool_attach_mutex);
1869
1870         list_del(&worker->node);
1871         worker->pool = NULL;
1872
1873         if (list_empty(&pool->workers))
1874                 detach_completion = pool->detach_completion;
1875         mutex_unlock(&wq_pool_attach_mutex);
1876
1877         /* clear leftover flags without pool->lock after it is detached */
1878         worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND);
1879
1880         if (detach_completion)
1881                 complete(detach_completion);
1882 }
1883
1884 /**
1885  * create_worker - create a new workqueue worker
1886  * @pool: pool the new worker will belong to
1887  *
1888  * Create and start a new worker which is attached to @pool.
1889  *
1890  * CONTEXT:
1891  * Might sleep.  Does GFP_KERNEL allocations.
1892  *
1893  * Return:
1894  * Pointer to the newly created worker.
1895  */
1896 static struct worker *create_worker(struct worker_pool *pool)
1897 {
1898         struct worker *worker = NULL;
1899         int id = -1;
1900         char id_buf[16];
1901
1902         /* ID is needed to determine kthread name */
1903         id = ida_simple_get(&pool->worker_ida, 0, 0, GFP_KERNEL);
1904         if (id < 0)
1905                 goto fail;
1906
1907         worker = alloc_worker(pool->node);
1908         if (!worker)
1909                 goto fail;
1910
1911         worker->id = id;
1912
1913         if (pool->cpu >= 0)
1914                 snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id,
1915                          pool->attrs->nice < 0  ? "H" : "");
1916         else
1917                 snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id);
1918
1919         worker->task = kthread_create_on_node(worker_thread, worker, pool->node,
1920                                               "kworker/%s", id_buf);
1921         if (IS_ERR(worker->task))
1922                 goto fail;
1923
1924         set_user_nice(worker->task, pool->attrs->nice);
1925         kthread_bind_mask(worker->task, pool->attrs->cpumask);
1926
1927         /* successful, attach the worker to the pool */
1928         worker_attach_to_pool(worker, pool);
1929
1930         /* start the newly created worker */
1931         spin_lock_irq(&pool->lock);
1932         worker->pool->nr_workers++;
1933         worker_enter_idle(worker);
1934         wake_up_process(worker->task);
1935         spin_unlock_irq(&pool->lock);
1936
1937         return worker;
1938
1939 fail:
1940         if (id >= 0)
1941                 ida_simple_remove(&pool->worker_ida, id);
1942         kfree(worker);
1943         return NULL;
1944 }
1945
1946 /**
1947  * destroy_worker - destroy a workqueue worker
1948  * @worker: worker to be destroyed
1949  *
1950  * Destroy @worker and adjust @pool stats accordingly.  The worker should
1951  * be idle.
1952  *
1953  * CONTEXT:
1954  * spin_lock_irq(pool->lock).
1955  */
1956 static void destroy_worker(struct worker *worker)
1957 {
1958         struct worker_pool *pool = worker->pool;
1959
1960         lockdep_assert_held(&pool->lock);
1961
1962         /* sanity check frenzy */
1963         if (WARN_ON(worker->current_work) ||
1964             WARN_ON(!list_empty(&worker->scheduled)) ||
1965             WARN_ON(!(worker->flags & WORKER_IDLE)))
1966                 return;
1967
1968         pool->nr_workers--;
1969         pool->nr_idle--;
1970
1971         list_del_init(&worker->entry);
1972         worker->flags |= WORKER_DIE;
1973         wake_up_process(worker->task);
1974 }
1975
1976 static void idle_worker_timeout(struct timer_list *t)
1977 {
1978         struct worker_pool *pool = from_timer(pool, t, idle_timer);
1979
1980         spin_lock_irq(&pool->lock);
1981
1982         while (too_many_workers(pool)) {
1983                 struct worker *worker;
1984                 unsigned long expires;
1985
1986                 /* idle_list is kept in LIFO order, check the last one */
1987                 worker = list_entry(pool->idle_list.prev, struct worker, entry);
1988                 expires = worker->last_active + IDLE_WORKER_TIMEOUT;
1989
1990                 if (time_before(jiffies, expires)) {
1991                         mod_timer(&pool->idle_timer, expires);
1992                         break;
1993                 }
1994
1995                 destroy_worker(worker);
1996         }
1997
1998         spin_unlock_irq(&pool->lock);
1999 }
2000
2001 static void send_mayday(struct work_struct *work)
2002 {
2003         struct pool_workqueue *pwq = get_work_pwq(work);
2004         struct workqueue_struct *wq = pwq->wq;
2005
2006         lockdep_assert_held(&wq_mayday_lock);
2007
2008         if (!wq->rescuer)
2009                 return;
2010
2011         /* mayday mayday mayday */
2012         if (list_empty(&pwq->mayday_node)) {
2013                 /*
2014                  * If @pwq is for an unbound wq, its base ref may be put at
2015                  * any time due to an attribute change.  Pin @pwq until the
2016                  * rescuer is done with it.
2017                  */
2018                 get_pwq(pwq);
2019                 list_add_tail(&pwq->mayday_node, &wq->maydays);
2020                 wake_up_process(wq->rescuer->task);
2021         }
2022 }
2023
2024 static void pool_mayday_timeout(struct timer_list *t)
2025 {
2026         struct worker_pool *pool = from_timer(pool, t, mayday_timer);
2027         struct work_struct *work;
2028
2029         spin_lock_irq(&pool->lock);
2030         spin_lock(&wq_mayday_lock);             /* for wq->maydays */
2031
2032         if (need_to_create_worker(pool)) {
2033                 /*
2034                  * We've been trying to create a new worker but
2035                  * haven't been successful.  We might be hitting an
2036                  * allocation deadlock.  Send distress signals to
2037                  * rescuers.
2038                  */
2039                 list_for_each_entry(work, &pool->worklist, entry)
2040                         send_mayday(work);
2041         }
2042
2043         spin_unlock(&wq_mayday_lock);
2044         spin_unlock_irq(&pool->lock);
2045
2046         mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL);
2047 }
2048
2049 /**
2050  * maybe_create_worker - create a new worker if necessary
2051  * @pool: pool to create a new worker for
2052  *
2053  * Create a new worker for @pool if necessary.  @pool is guaranteed to
2054  * have at least one idle worker on return from this function.  If
2055  * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is
2056  * sent to all rescuers with works scheduled on @pool to resolve
2057  * possible allocation deadlock.
2058  *
2059  * On return, need_to_create_worker() is guaranteed to be %false and
2060  * may_start_working() %true.
2061  *
2062  * LOCKING:
2063  * spin_lock_irq(pool->lock) which may be released and regrabbed
2064  * multiple times.  Does GFP_KERNEL allocations.  Called only from
2065  * manager.
2066  */
2067 static void maybe_create_worker(struct worker_pool *pool)
2068 __releases(&pool->lock)
2069 __acquires(&pool->lock)
2070 {
2071 restart:
2072         spin_unlock_irq(&pool->lock);
2073
2074         /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */
2075         mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT);
2076
2077         while (true) {
2078                 if (create_worker(pool) || !need_to_create_worker(pool))
2079                         break;
2080
2081                 schedule_timeout_interruptible(CREATE_COOLDOWN);
2082
2083                 if (!need_to_create_worker(pool))
2084                         break;
2085         }
2086
2087         del_timer_sync(&pool->mayday_timer);
2088         spin_lock_irq(&pool->lock);
2089         /*
2090          * This is necessary even after a new worker was just successfully
2091          * created as @pool->lock was dropped and the new worker might have
2092          * already become busy.
2093          */
2094         if (need_to_create_worker(pool))
2095                 goto restart;
2096 }
2097
2098 /**
2099  * manage_workers - manage worker pool
2100  * @worker: self
2101  *
2102  * Assume the manager role and manage the worker pool @worker belongs
2103  * to.  At any given time, there can be only zero or one manager per
2104  * pool.  The exclusion is handled automatically by this function.
2105  *
2106  * The caller can safely start processing works on false return.  On
2107  * true return, it's guaranteed that need_to_create_worker() is false
2108  * and may_start_working() is true.
2109  *
2110  * CONTEXT:
2111  * spin_lock_irq(pool->lock) which may be released and regrabbed
2112  * multiple times.  Does GFP_KERNEL allocations.
2113  *
2114  * Return:
2115  * %false if the pool doesn't need management and the caller can safely
2116  * start processing works, %true if management function was performed and
2117  * the conditions that the caller verified before calling the function may
2118  * no longer be true.
2119  */
2120 static bool manage_workers(struct worker *worker)
2121 {
2122         struct worker_pool *pool = worker->pool;
2123
2124         if (pool->flags & POOL_MANAGER_ACTIVE)
2125                 return false;
2126
2127         pool->flags |= POOL_MANAGER_ACTIVE;
2128         pool->manager = worker;
2129
2130         maybe_create_worker(pool);
2131
2132         pool->manager = NULL;
2133         pool->flags &= ~POOL_MANAGER_ACTIVE;
2134         wake_up(&wq_manager_wait);
2135         return true;
2136 }
2137
2138 /**
2139  * process_one_work - process single work
2140  * @worker: self
2141  * @work: work to process
2142  *
2143  * Process @work.  This function contains all the logics necessary to
2144  * process a single work including synchronization against and
2145  * interaction with other workers on the same cpu, queueing and
2146  * flushing.  As long as context requirement is met, any worker can
2147  * call this function to process a work.
2148  *
2149  * CONTEXT:
2150  * spin_lock_irq(pool->lock) which is released and regrabbed.
2151  */
2152 static void process_one_work(struct worker *worker, struct work_struct *work)
2153 __releases(&pool->lock)
2154 __acquires(&pool->lock)
2155 {
2156         struct pool_workqueue *pwq = get_work_pwq(work);
2157         struct worker_pool *pool = worker->pool;
2158         bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE;
2159         int work_color;
2160         struct worker *collision;
2161 #ifdef CONFIG_LOCKDEP
2162         /*
2163          * It is permissible to free the struct work_struct from
2164          * inside the function that is called from it, this we need to
2165          * take into account for lockdep too.  To avoid bogus "held
2166          * lock freed" warnings as well as problems when looking into
2167          * work->lockdep_map, make a copy and use that here.
2168          */
2169         struct lockdep_map lockdep_map;
2170
2171         lockdep_copy_map(&lockdep_map, &work->lockdep_map);
2172 #endif
2173         /* ensure we're on the correct CPU */
2174         WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) &&
2175                      raw_smp_processor_id() != pool->cpu);
2176
2177         /*
2178          * A single work shouldn't be executed concurrently by
2179          * multiple workers on a single cpu.  Check whether anyone is
2180          * already processing the work.  If so, defer the work to the
2181          * currently executing one.
2182          */
2183         collision = find_worker_executing_work(pool, work);
2184         if (unlikely(collision)) {
2185                 move_linked_works(work, &collision->scheduled, NULL);
2186                 return;
2187         }
2188
2189         /* claim and dequeue */
2190         debug_work_deactivate(work);
2191         hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work);
2192         worker->current_work = work;
2193         worker->current_func = work->func;
2194         worker->current_pwq = pwq;
2195         work_color = get_work_color(work);
2196
2197         /*
2198          * Record wq name for cmdline and debug reporting, may get
2199          * overridden through set_worker_desc().
2200          */
2201         strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN);
2202
2203         list_del_init(&work->entry);
2204
2205         /*
2206          * CPU intensive works don't participate in concurrency management.
2207          * They're the scheduler's responsibility.  This takes @worker out
2208          * of concurrency management and the next code block will chain
2209          * execution of the pending work items.
2210          */
2211         if (unlikely(cpu_intensive))
2212                 worker_set_flags(worker, WORKER_CPU_INTENSIVE);
2213
2214         /*
2215          * Wake up another worker if necessary.  The condition is always
2216          * false for normal per-cpu workers since nr_running would always
2217          * be >= 1 at this point.  This is used to chain execution of the
2218          * pending work items for WORKER_NOT_RUNNING workers such as the
2219          * UNBOUND and CPU_INTENSIVE ones.
2220          */
2221         if (need_more_worker(pool))
2222                 wake_up_worker(pool);
2223
2224         /*
2225          * Record the last pool and clear PENDING which should be the last
2226          * update to @work.  Also, do this inside @pool->lock so that
2227          * PENDING and queued state changes happen together while IRQ is
2228          * disabled.
2229          */
2230         set_work_pool_and_clear_pending(work, pool->id);
2231
2232         spin_unlock_irq(&pool->lock);
2233
2234         lock_map_acquire(&pwq->wq->lockdep_map);
2235         lock_map_acquire(&lockdep_map);
2236         /*
2237          * Strictly speaking we should mark the invariant state without holding
2238          * any locks, that is, before these two lock_map_acquire()'s.
2239          *
2240          * However, that would result in:
2241          *
2242          *   A(W1)
2243          *   WFC(C)
2244          *              A(W1)
2245          *              C(C)
2246          *
2247          * Which would create W1->C->W1 dependencies, even though there is no
2248          * actual deadlock possible. There are two solutions, using a
2249          * read-recursive acquire on the work(queue) 'locks', but this will then
2250          * hit the lockdep limitation on recursive locks, or simply discard
2251          * these locks.
2252          *
2253          * AFAICT there is no possible deadlock scenario between the
2254          * flush_work() and complete() primitives (except for single-threaded
2255          * workqueues), so hiding them isn't a problem.
2256          */
2257         lockdep_invariant_state(true);
2258         trace_workqueue_execute_start(work);
2259         worker->current_func(work);
2260         /*
2261          * While we must be careful to not use "work" after this, the trace
2262          * point will only record its address.
2263          */
2264         trace_workqueue_execute_end(work);
2265         lock_map_release(&lockdep_map);
2266         lock_map_release(&pwq->wq->lockdep_map);
2267
2268         if (unlikely(in_atomic() || lockdep_depth(current) > 0)) {
2269                 pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n"
2270                        "     last function: %pf\n",
2271                        current->comm, preempt_count(), task_pid_nr(current),
2272                        worker->current_func);
2273                 debug_show_held_locks(current);
2274                 dump_stack();
2275         }
2276
2277         /*
2278          * The following prevents a kworker from hogging CPU on !PREEMPT
2279          * kernels, where a requeueing work item waiting for something to
2280          * happen could deadlock with stop_machine as such work item could
2281          * indefinitely requeue itself while all other CPUs are trapped in
2282          * stop_machine. At the same time, report a quiescent RCU state so
2283          * the same condition doesn't freeze RCU.
2284          */
2285         cond_resched();
2286
2287         spin_lock_irq(&pool->lock);
2288
2289         /* clear cpu intensive status */
2290         if (unlikely(cpu_intensive))
2291                 worker_clr_flags(worker, WORKER_CPU_INTENSIVE);
2292
2293         /* tag the worker for identification in schedule() */
2294         worker->last_func = worker->current_func;
2295
2296         /* we're done with it, release */
2297         hash_del(&worker->hentry);
2298         worker->current_work = NULL;
2299         worker->current_func = NULL;
2300         worker->current_pwq = NULL;
2301         pwq_dec_nr_in_flight(pwq, work_color);
2302 }
2303
2304 /**
2305  * process_scheduled_works - process scheduled works
2306  * @worker: self
2307  *
2308  * Process all scheduled works.  Please note that the scheduled list
2309  * may change while processing a work, so this function repeatedly
2310  * fetches a work from the top and executes it.
2311  *
2312  * CONTEXT:
2313  * spin_lock_irq(pool->lock) which may be released and regrabbed
2314  * multiple times.
2315  */
2316 static void process_scheduled_works(struct worker *worker)
2317 {
2318         while (!list_empty(&worker->scheduled)) {
2319                 struct work_struct *work = list_first_entry(&worker->scheduled,
2320                                                 struct work_struct, entry);
2321                 process_one_work(worker, work);
2322         }
2323 }
2324
2325 static void set_pf_worker(bool val)
2326 {
2327         mutex_lock(&wq_pool_attach_mutex);
2328         if (val)
2329                 current->flags |= PF_WQ_WORKER;
2330         else
2331                 current->flags &= ~PF_WQ_WORKER;
2332         mutex_unlock(&wq_pool_attach_mutex);
2333 }
2334
2335 /**
2336  * worker_thread - the worker thread function
2337  * @__worker: self
2338  *
2339  * The worker thread function.  All workers belong to a worker_pool -
2340  * either a per-cpu one or dynamic unbound one.  These workers process all
2341  * work items regardless of their specific target workqueue.  The only
2342  * exception is work items which belong to workqueues with a rescuer which
2343  * will be explained in rescuer_thread().
2344  *
2345  * Return: 0
2346  */
2347 static int worker_thread(void *__worker)
2348 {
2349         struct worker *worker = __worker;
2350         struct worker_pool *pool = worker->pool;
2351
2352         /* tell the scheduler that this is a workqueue worker */
2353         set_pf_worker(true);
2354 woke_up:
2355         spin_lock_irq(&pool->lock);
2356
2357         /* am I supposed to die? */
2358         if (unlikely(worker->flags & WORKER_DIE)) {
2359                 spin_unlock_irq(&pool->lock);
2360                 WARN_ON_ONCE(!list_empty(&worker->entry));
2361                 set_pf_worker(false);
2362
2363                 set_task_comm(worker->task, "kworker/dying");
2364                 ida_simple_remove(&pool->worker_ida, worker->id);
2365                 worker_detach_from_pool(worker);
2366                 kfree(worker);
2367                 return 0;
2368         }
2369
2370         worker_leave_idle(worker);
2371 recheck:
2372         /* no more worker necessary? */
2373         if (!need_more_worker(pool))
2374                 goto sleep;
2375
2376         /* do we need to manage? */
2377         if (unlikely(!may_start_working(pool)) && manage_workers(worker))
2378                 goto recheck;
2379
2380         /*
2381          * ->scheduled list can only be filled while a worker is
2382          * preparing to process a work or actually processing it.
2383          * Make sure nobody diddled with it while I was sleeping.
2384          */
2385         WARN_ON_ONCE(!list_empty(&worker->scheduled));
2386
2387         /*
2388          * Finish PREP stage.  We're guaranteed to have at least one idle
2389          * worker or that someone else has already assumed the manager
2390          * role.  This is where @worker starts participating in concurrency
2391          * management if applicable and concurrency management is restored
2392          * after being rebound.  See rebind_workers() for details.
2393          */
2394         worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND);
2395
2396         do {
2397                 struct work_struct *work =
2398                         list_first_entry(&pool->worklist,
2399                                          struct work_struct, entry);
2400
2401                 pool->watchdog_ts = jiffies;
2402
2403                 if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) {
2404                         /* optimization path, not strictly necessary */
2405                         process_one_work(worker, work);
2406                         if (unlikely(!list_empty(&worker->scheduled)))
2407                                 process_scheduled_works(worker);
2408                 } else {
2409                         move_linked_works(work, &worker->scheduled, NULL);
2410                         process_scheduled_works(worker);
2411                 }
2412         } while (keep_working(pool));
2413
2414         worker_set_flags(worker, WORKER_PREP);
2415 sleep:
2416         /*
2417          * pool->lock is held and there's no work to process and no need to
2418          * manage, sleep.  Workers are woken up only while holding
2419          * pool->lock or from local cpu, so setting the current state
2420          * before releasing pool->lock is enough to prevent losing any
2421          * event.
2422          */
2423         worker_enter_idle(worker);
2424         __set_current_state(TASK_IDLE);
2425         spin_unlock_irq(&pool->lock);
2426         schedule();
2427         goto woke_up;
2428 }
2429
2430 /**
2431  * rescuer_thread - the rescuer thread function
2432  * @__rescuer: self
2433  *
2434  * Workqueue rescuer thread function.  There's one rescuer for each
2435  * workqueue which has WQ_MEM_RECLAIM set.
2436  *
2437  * Regular work processing on a pool may block trying to create a new
2438  * worker which uses GFP_KERNEL allocation which has slight chance of
2439  * developing into deadlock if some works currently on the same queue
2440  * need to be processed to satisfy the GFP_KERNEL allocation.  This is
2441  * the problem rescuer solves.
2442  *
2443  * When such condition is possible, the pool summons rescuers of all
2444  * workqueues which have works queued on the pool and let them process
2445  * those works so that forward progress can be guaranteed.
2446  *
2447  * This should happen rarely.
2448  *
2449  * Return: 0
2450  */
2451 static int rescuer_thread(void *__rescuer)
2452 {
2453         struct worker *rescuer = __rescuer;
2454         struct workqueue_struct *wq = rescuer->rescue_wq;
2455         struct list_head *scheduled = &rescuer->scheduled;
2456         bool should_stop;
2457
2458         set_user_nice(current, RESCUER_NICE_LEVEL);
2459
2460         /*
2461          * Mark rescuer as worker too.  As WORKER_PREP is never cleared, it
2462          * doesn't participate in concurrency management.
2463          */
2464         set_pf_worker(true);
2465 repeat:
2466         set_current_state(TASK_IDLE);
2467
2468         /*
2469          * By the time the rescuer is requested to stop, the workqueue
2470          * shouldn't have any work pending, but @wq->maydays may still have
2471          * pwq(s) queued.  This can happen by non-rescuer workers consuming
2472          * all the work items before the rescuer got to them.  Go through
2473          * @wq->maydays processing before acting on should_stop so that the
2474          * list is always empty on exit.
2475          */
2476         should_stop = kthread_should_stop();
2477
2478         /* see whether any pwq is asking for help */
2479         spin_lock_irq(&wq_mayday_lock);
2480
2481         while (!list_empty(&wq->maydays)) {
2482                 struct pool_workqueue *pwq = list_first_entry(&wq->maydays,
2483                                         struct pool_workqueue, mayday_node);
2484                 struct worker_pool *pool = pwq->pool;
2485                 struct work_struct *work, *n;
2486                 bool first = true;
2487
2488                 __set_current_state(TASK_RUNNING);
2489                 list_del_init(&pwq->mayday_node);
2490
2491                 spin_unlock_irq(&wq_mayday_lock);
2492
2493                 worker_attach_to_pool(rescuer, pool);
2494
2495                 spin_lock_irq(&pool->lock);
2496
2497                 /*
2498                  * Slurp in all works issued via this workqueue and
2499                  * process'em.
2500                  */
2501                 WARN_ON_ONCE(!list_empty(scheduled));
2502                 list_for_each_entry_safe(work, n, &pool->worklist, entry) {
2503                         if (get_work_pwq(work) == pwq) {
2504                                 if (first)
2505                                         pool->watchdog_ts = jiffies;
2506                                 move_linked_works(work, scheduled, &n);
2507                         }
2508                         first = false;
2509                 }
2510
2511                 if (!list_empty(scheduled)) {
2512                         process_scheduled_works(rescuer);
2513
2514                         /*
2515                          * The above execution of rescued work items could
2516                          * have created more to rescue through
2517                          * pwq_activate_first_delayed() or chained
2518                          * queueing.  Let's put @pwq back on mayday list so
2519                          * that such back-to-back work items, which may be
2520                          * being used to relieve memory pressure, don't
2521                          * incur MAYDAY_INTERVAL delay inbetween.
2522                          */
2523                         if (need_to_create_worker(pool)) {
2524                                 spin_lock(&wq_mayday_lock);
2525                                 get_pwq(pwq);
2526                                 list_move_tail(&pwq->mayday_node, &wq->maydays);
2527                                 spin_unlock(&wq_mayday_lock);
2528                         }
2529                 }
2530
2531                 /*
2532                  * Put the reference grabbed by send_mayday().  @pool won't
2533                  * go away while we're still attached to it.
2534                  */
2535                 put_pwq(pwq);
2536
2537                 /*
2538                  * Leave this pool.  If need_more_worker() is %true, notify a
2539                  * regular worker; otherwise, we end up with 0 concurrency
2540                  * and stalling the execution.
2541                  */
2542                 if (need_more_worker(pool))
2543                         wake_up_worker(pool);
2544
2545                 spin_unlock_irq(&pool->lock);
2546
2547                 worker_detach_from_pool(rescuer);
2548
2549                 spin_lock_irq(&wq_mayday_lock);
2550         }
2551
2552         spin_unlock_irq(&wq_mayday_lock);
2553
2554         if (should_stop) {
2555                 __set_current_state(TASK_RUNNING);
2556                 set_pf_worker(false);
2557                 return 0;
2558         }
2559
2560         /* rescuers should never participate in concurrency management */
2561         WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING));
2562         schedule();
2563         goto repeat;
2564 }
2565
2566 /**
2567  * check_flush_dependency - check for flush dependency sanity
2568  * @target_wq: workqueue being flushed
2569  * @target_work: work item being flushed (NULL for workqueue flushes)
2570  *
2571  * %current is trying to flush the whole @target_wq or @target_work on it.
2572  * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not
2573  * reclaiming memory or running on a workqueue which doesn't have
2574  * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to
2575  * a deadlock.
2576  */
2577 static void check_flush_dependency(struct workqueue_struct *target_wq,
2578                                    struct work_struct *target_work)
2579 {
2580         work_func_t target_func = target_work ? target_work->func : NULL;
2581         struct worker *worker;
2582
2583         if (target_wq->flags & WQ_MEM_RECLAIM)
2584                 return;
2585
2586         worker = current_wq_worker();
2587
2588         WARN_ONCE(current->flags & PF_MEMALLOC,
2589                   "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%pf",
2590                   current->pid, current->comm, target_wq->name, target_func);
2591         WARN_ONCE(worker && ((worker->current_pwq->wq->flags &
2592                               (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM),
2593                   "workqueue: WQ_MEM_RECLAIM %s:%pf is flushing !WQ_MEM_RECLAIM %s:%pf",
2594                   worker->current_pwq->wq->name, worker->current_func,
2595                   target_wq->name, target_func);
2596 }
2597
2598 struct wq_barrier {
2599         struct work_struct      work;
2600         struct completion       done;
2601         struct task_struct      *task;  /* purely informational */
2602 };
2603
2604 static void wq_barrier_func(struct work_struct *work)
2605 {
2606         struct wq_barrier *barr = container_of(work, struct wq_barrier, work);
2607         complete(&barr->done);
2608 }
2609
2610 /**
2611  * insert_wq_barrier - insert a barrier work
2612  * @pwq: pwq to insert barrier into
2613  * @barr: wq_barrier to insert
2614  * @target: target work to attach @barr to
2615  * @worker: worker currently executing @target, NULL if @target is not executing
2616  *
2617  * @barr is linked to @target such that @barr is completed only after
2618  * @target finishes execution.  Please note that the ordering
2619  * guarantee is observed only with respect to @target and on the local
2620  * cpu.
2621  *
2622  * Currently, a queued barrier can't be canceled.  This is because
2623  * try_to_grab_pending() can't determine whether the work to be
2624  * grabbed is at the head of the queue and thus can't clear LINKED
2625  * flag of the previous work while there must be a valid next work
2626  * after a work with LINKED flag set.
2627  *
2628  * Note that when @worker is non-NULL, @target may be modified
2629  * underneath us, so we can't reliably determine pwq from @target.
2630  *
2631  * CONTEXT:
2632  * spin_lock_irq(pool->lock).
2633  */
2634 static void insert_wq_barrier(struct pool_workqueue *pwq,
2635                               struct wq_barrier *barr,
2636                               struct work_struct *target, struct worker *worker)
2637 {
2638         struct list_head *head;
2639         unsigned int linked = 0;
2640
2641         /*
2642          * debugobject calls are safe here even with pool->lock locked
2643          * as we know for sure that this will not trigger any of the
2644          * checks and call back into the fixup functions where we
2645          * might deadlock.
2646          */
2647         INIT_WORK_ONSTACK(&barr->work, wq_barrier_func);
2648         __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work));
2649
2650         init_completion_map(&barr->done, &target->lockdep_map);
2651
2652         barr->task = current;
2653
2654         /*
2655          * If @target is currently being executed, schedule the
2656          * barrier to the worker; otherwise, put it after @target.
2657          */
2658         if (worker)
2659                 head = worker->scheduled.next;
2660         else {
2661                 unsigned long *bits = work_data_bits(target);
2662
2663                 head = target->entry.next;
2664                 /* there can already be other linked works, inherit and set */
2665                 linked = *bits & WORK_STRUCT_LINKED;
2666                 __set_bit(WORK_STRUCT_LINKED_BIT, bits);
2667         }
2668
2669         debug_work_activate(&barr->work);
2670         insert_work(pwq, &barr->work, head,
2671                     work_color_to_flags(WORK_NO_COLOR) | linked);
2672 }
2673
2674 /**
2675  * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing
2676  * @wq: workqueue being flushed
2677  * @flush_color: new flush color, < 0 for no-op
2678  * @work_color: new work color, < 0 for no-op
2679  *
2680  * Prepare pwqs for workqueue flushing.
2681  *
2682  * If @flush_color is non-negative, flush_color on all pwqs should be
2683  * -1.  If no pwq has in-flight commands at the specified color, all
2684  * pwq->flush_color's stay at -1 and %false is returned.  If any pwq
2685  * has in flight commands, its pwq->flush_color is set to
2686  * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq
2687  * wakeup logic is armed and %true is returned.
2688  *
2689  * The caller should have initialized @wq->first_flusher prior to
2690  * calling this function with non-negative @flush_color.  If
2691  * @flush_color is negative, no flush color update is done and %false
2692  * is returned.
2693  *
2694  * If @work_color is non-negative, all pwqs should have the same
2695  * work_color which is previous to @work_color and all will be
2696  * advanced to @work_color.
2697  *
2698  * CONTEXT:
2699  * mutex_lock(wq->mutex).
2700  *
2701  * Return:
2702  * %true if @flush_color >= 0 and there's something to flush.  %false
2703  * otherwise.
2704  */
2705 static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq,
2706                                       int flush_color, int work_color)
2707 {
2708         bool wait = false;
2709         struct pool_workqueue *pwq;
2710
2711         if (flush_color >= 0) {
2712                 WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush));
2713                 atomic_set(&wq->nr_pwqs_to_flush, 1);
2714         }
2715
2716         for_each_pwq(pwq, wq) {
2717                 struct worker_pool *pool = pwq->pool;
2718
2719                 spin_lock_irq(&pool->lock);
2720
2721                 if (flush_color >= 0) {
2722                         WARN_ON_ONCE(pwq->flush_color != -1);
2723
2724                         if (pwq->nr_in_flight[flush_color]) {
2725                                 pwq->flush_color = flush_color;
2726                                 atomic_inc(&wq->nr_pwqs_to_flush);
2727                                 wait = true;
2728                         }
2729                 }
2730
2731                 if (work_color >= 0) {
2732                         WARN_ON_ONCE(work_color != work_next_color(pwq->work_color));
2733                         pwq->work_color = work_color;
2734                 }
2735
2736                 spin_unlock_irq(&pool->lock);
2737         }
2738
2739         if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush))
2740                 complete(&wq->first_flusher->done);
2741
2742         return wait;
2743 }
2744
2745 /**
2746  * flush_workqueue - ensure that any scheduled work has run to completion.
2747  * @wq: workqueue to flush
2748  *
2749  * This function sleeps until all work items which were queued on entry
2750  * have finished execution, but it is not livelocked by new incoming ones.
2751  */
2752 void flush_workqueue(struct workqueue_struct *wq)
2753 {
2754         struct wq_flusher this_flusher = {
2755                 .list = LIST_HEAD_INIT(this_flusher.list),
2756                 .flush_color = -1,
2757                 .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map),
2758         };
2759         int next_color;
2760
2761         if (WARN_ON(!wq_online))
2762                 return;
2763
2764         lock_map_acquire(&wq->lockdep_map);
2765         lock_map_release(&wq->lockdep_map);
2766
2767         mutex_lock(&wq->mutex);
2768
2769         /*
2770          * Start-to-wait phase
2771          */
2772         next_color = work_next_color(wq->work_color);
2773
2774         if (next_color != wq->flush_color) {
2775                 /*
2776                  * Color space is not full.  The current work_color
2777                  * becomes our flush_color and work_color is advanced
2778                  * by one.
2779                  */
2780                 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow));
2781                 this_flusher.flush_color = wq->work_color;
2782                 wq->work_color = next_color;
2783
2784                 if (!wq->first_flusher) {
2785                         /* no flush in progress, become the first flusher */
2786                         WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
2787
2788                         wq->first_flusher = &this_flusher;
2789
2790                         if (!flush_workqueue_prep_pwqs(wq, wq->flush_color,
2791                                                        wq->work_color)) {
2792                                 /* nothing to flush, done */
2793                                 wq->flush_color = next_color;
2794                                 wq->first_flusher = NULL;
2795                                 goto out_unlock;
2796                         }
2797                 } else {
2798                         /* wait in queue */
2799                         WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color);
2800                         list_add_tail(&this_flusher.list, &wq->flusher_queue);
2801                         flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
2802                 }
2803         } else {
2804                 /*
2805                  * Oops, color space is full, wait on overflow queue.
2806                  * The next flush completion will assign us
2807                  * flush_color and transfer to flusher_queue.
2808                  */
2809                 list_add_tail(&this_flusher.list, &wq->flusher_overflow);
2810         }
2811
2812         check_flush_dependency(wq, NULL);
2813
2814         mutex_unlock(&wq->mutex);
2815
2816         wait_for_completion(&this_flusher.done);
2817
2818         /*
2819          * Wake-up-and-cascade phase
2820          *
2821          * First flushers are responsible for cascading flushes and
2822          * handling overflow.  Non-first flushers can simply return.
2823          */
2824         if (wq->first_flusher != &this_flusher)
2825                 return;
2826
2827         mutex_lock(&wq->mutex);
2828
2829         /* we might have raced, check again with mutex held */
2830         if (wq->first_flusher != &this_flusher)
2831                 goto out_unlock;
2832
2833         wq->first_flusher = NULL;
2834
2835         WARN_ON_ONCE(!list_empty(&this_flusher.list));
2836         WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color);
2837
2838         while (true) {
2839                 struct wq_flusher *next, *tmp;
2840
2841                 /* complete all the flushers sharing the current flush color */
2842                 list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) {
2843                         if (next->flush_color != wq->flush_color)
2844                                 break;
2845                         list_del_init(&next->list);
2846                         complete(&next->done);
2847                 }
2848
2849                 WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) &&
2850                              wq->flush_color != work_next_color(wq->work_color));
2851
2852                 /* this flush_color is finished, advance by one */
2853                 wq->flush_color = work_next_color(wq->flush_color);
2854
2855                 /* one color has been freed, handle overflow queue */
2856                 if (!list_empty(&wq->flusher_overflow)) {
2857                         /*
2858                          * Assign the same color to all overflowed
2859                          * flushers, advance work_color and append to
2860                          * flusher_queue.  This is the start-to-wait
2861                          * phase for these overflowed flushers.
2862                          */
2863                         list_for_each_entry(tmp, &wq->flusher_overflow, list)
2864                                 tmp->flush_color = wq->work_color;
2865
2866                         wq->work_color = work_next_color(wq->work_color);
2867
2868                         list_splice_tail_init(&wq->flusher_overflow,
2869                                               &wq->flusher_queue);
2870                         flush_workqueue_prep_pwqs(wq, -1, wq->work_color);
2871                 }
2872
2873                 if (list_empty(&wq->flusher_queue)) {
2874                         WARN_ON_ONCE(wq->flush_color != wq->work_color);
2875                         break;
2876                 }
2877
2878                 /*
2879                  * Need to flush more colors.  Make the next flusher
2880                  * the new first flusher and arm pwqs.
2881                  */
2882                 WARN_ON_ONCE(wq->flush_color == wq->work_color);
2883                 WARN_ON_ONCE(wq->flush_color != next->flush_color);
2884
2885                 list_del_init(&next->list);
2886                 wq->first_flusher = next;
2887
2888                 if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1))
2889                         break;
2890
2891                 /*
2892                  * Meh... this color is already done, clear first
2893                  * flusher and repeat cascading.
2894                  */
2895                 wq->first_flusher = NULL;
2896         }
2897
2898 out_unlock:
2899         mutex_unlock(&wq->mutex);
2900 }
2901 EXPORT_SYMBOL(flush_workqueue);
2902
2903 /**
2904  * drain_workqueue - drain a workqueue
2905  * @wq: workqueue to drain
2906  *
2907  * Wait until the workqueue becomes empty.  While draining is in progress,
2908  * only chain queueing is allowed.  IOW, only currently pending or running
2909  * work items on @wq can queue further work items on it.  @wq is flushed
2910  * repeatedly until it becomes empty.  The number of flushing is determined
2911  * by the depth of chaining and should be relatively short.  Whine if it
2912  * takes too long.
2913  */
2914 void drain_workqueue(struct workqueue_struct *wq)
2915 {
2916         unsigned int flush_cnt = 0;
2917         struct pool_workqueue *pwq;
2918
2919         /*
2920          * __queue_work() needs to test whether there are drainers, is much
2921          * hotter than drain_workqueue() and already looks at @wq->flags.
2922          * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers.
2923          */
2924         mutex_lock(&wq->mutex);
2925         if (!wq->nr_drainers++)
2926                 wq->flags |= __WQ_DRAINING;
2927         mutex_unlock(&wq->mutex);
2928 reflush:
2929         flush_workqueue(wq);
2930
2931         mutex_lock(&wq->mutex);
2932
2933         for_each_pwq(pwq, wq) {
2934                 bool drained;
2935
2936                 spin_lock_irq(&pwq->pool->lock);
2937                 drained = !pwq->nr_active && list_empty(&pwq->delayed_works);
2938                 spin_unlock_irq(&pwq->pool->lock);
2939
2940                 if (drained)
2941                         continue;
2942
2943                 if (++flush_cnt == 10 ||
2944                     (flush_cnt % 100 == 0 && flush_cnt <= 1000))
2945                         pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n",
2946                                 wq->name, flush_cnt);
2947
2948                 mutex_unlock(&wq->mutex);
2949                 goto reflush;
2950         }
2951
2952         if (!--wq->nr_drainers)
2953                 wq->flags &= ~__WQ_DRAINING;
2954         mutex_unlock(&wq->mutex);
2955 }
2956 EXPORT_SYMBOL_GPL(drain_workqueue);
2957
2958 static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr,
2959                              bool from_cancel)
2960 {
2961         struct worker *worker = NULL;
2962         struct worker_pool *pool;
2963         struct pool_workqueue *pwq;
2964
2965         might_sleep();
2966
2967         local_irq_disable();
2968         pool = get_work_pool(work);
2969         if (!pool) {
2970                 local_irq_enable();
2971                 return false;
2972         }
2973
2974         spin_lock(&pool->lock);
2975         /* see the comment in try_to_grab_pending() with the same code */
2976         pwq = get_work_pwq(work);
2977         if (pwq) {
2978                 if (unlikely(pwq->pool != pool))
2979                         goto already_gone;
2980         } else {
2981                 worker = find_worker_executing_work(pool, work);
2982                 if (!worker)
2983                         goto already_gone;
2984                 pwq = worker->current_pwq;
2985         }
2986
2987         check_flush_dependency(pwq->wq, work);
2988
2989         insert_wq_barrier(pwq, barr, work, worker);
2990         spin_unlock_irq(&pool->lock);
2991
2992         /*
2993          * Force a lock recursion deadlock when using flush_work() inside a
2994          * single-threaded or rescuer equipped workqueue.
2995          *
2996          * For single threaded workqueues the deadlock happens when the work
2997          * is after the work issuing the flush_work(). For rescuer equipped
2998          * workqueues the deadlock happens when the rescuer stalls, blocking
2999          * forward progress.
3000          */
3001         if (!from_cancel &&
3002             (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) {
3003                 lock_map_acquire(&pwq->wq->lockdep_map);
3004                 lock_map_release(&pwq->wq->lockdep_map);
3005         }
3006
3007         return true;
3008 already_gone:
3009         spin_unlock_irq(&pool->lock);
3010         return false;
3011 }
3012
3013 static bool __flush_work(struct work_struct *work, bool from_cancel)
3014 {
3015         struct wq_barrier barr;
3016
3017         if (WARN_ON(!wq_online))
3018                 return false;
3019
3020         if (WARN_ON(!work->func))
3021                 return false;
3022
3023         if (!from_cancel) {
3024                 lock_map_acquire(&work->lockdep_map);
3025                 lock_map_release(&work->lockdep_map);
3026         }
3027
3028         if (start_flush_work(work, &barr, from_cancel)) {
3029                 wait_for_completion(&barr.done);
3030                 destroy_work_on_stack(&barr.work);
3031                 return true;
3032         } else {
3033                 return false;
3034         }
3035 }
3036
3037 /**
3038  * flush_work - wait for a work to finish executing the last queueing instance
3039  * @work: the work to flush
3040  *
3041  * Wait until @work has finished execution.  @work is guaranteed to be idle
3042  * on return if it hasn't been requeued since flush started.
3043  *
3044  * Return:
3045  * %true if flush_work() waited for the work to finish execution,
3046  * %false if it was already idle.
3047  */
3048 bool flush_work(struct work_struct *work)
3049 {
3050         return __flush_work(work, false);
3051 }
3052 EXPORT_SYMBOL_GPL(flush_work);
3053
3054 struct cwt_wait {
3055         wait_queue_entry_t              wait;
3056         struct work_struct      *work;
3057 };
3058
3059 static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
3060 {
3061         struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait);
3062
3063         if (cwait->work != key)
3064                 return 0;
3065         return autoremove_wake_function(wait, mode, sync, key);
3066 }
3067
3068 static bool __cancel_work_timer(struct work_struct *work, bool is_dwork)
3069 {
3070         static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq);
3071         unsigned long flags;
3072         int ret;
3073
3074         do {
3075                 ret = try_to_grab_pending(work, is_dwork, &flags);
3076                 /*
3077                  * If someone else is already canceling, wait for it to
3078                  * finish.  flush_work() doesn't work for PREEMPT_NONE
3079                  * because we may get scheduled between @work's completion
3080                  * and the other canceling task resuming and clearing
3081                  * CANCELING - flush_work() will return false immediately
3082                  * as @work is no longer busy, try_to_grab_pending() will
3083                  * return -ENOENT as @work is still being canceled and the
3084                  * other canceling task won't be able to clear CANCELING as
3085                  * we're hogging the CPU.
3086                  *
3087                  * Let's wait for completion using a waitqueue.  As this
3088                  * may lead to the thundering herd problem, use a custom
3089                  * wake function which matches @work along with exclusive
3090                  * wait and wakeup.
3091                  */
3092                 if (unlikely(ret == -ENOENT)) {
3093                         struct cwt_wait cwait;
3094
3095                         init_wait(&cwait.wait);
3096                         cwait.wait.func = cwt_wakefn;
3097                         cwait.work = work;
3098
3099                         prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait,
3100                                                   TASK_UNINTERRUPTIBLE);
3101                         if (work_is_canceling(work))
3102                                 schedule();
3103                         finish_wait(&cancel_waitq, &cwait.wait);
3104                 }
3105         } while (unlikely(ret < 0));
3106
3107         /* tell other tasks trying to grab @work to back off */
3108         mark_work_canceling(work);
3109         local_irq_restore(flags);
3110
3111         /*
3112          * This allows canceling during early boot.  We know that @work
3113          * isn't executing.
3114          */
3115         if (wq_online)
3116                 __flush_work(work, true);
3117
3118         clear_work_data(work);
3119
3120         /*
3121          * Paired with prepare_to_wait() above so that either
3122          * waitqueue_active() is visible here or !work_is_canceling() is
3123          * visible there.
3124          */
3125         smp_mb();
3126         if (waitqueue_active(&cancel_waitq))
3127                 __wake_up(&cancel_waitq, TASK_NORMAL, 1, work);
3128
3129         return ret;
3130 }
3131
3132 /**
3133  * cancel_work_sync - cancel a work and wait for it to finish
3134  * @work: the work to cancel
3135  *
3136  * Cancel @work and wait for its execution to finish.  This function
3137  * can be used even if the work re-queues itself or migrates to
3138  * another workqueue.  On return from this function, @work is
3139  * guaranteed to be not pending or executing on any CPU.
3140  *
3141  * cancel_work_sync(&delayed_work->work) must not be used for
3142  * delayed_work's.  Use cancel_delayed_work_sync() instead.
3143  *
3144  * The caller must ensure that the workqueue on which @work was last
3145  * queued can't be destroyed before this function returns.
3146  *
3147  * Return:
3148  * %true if @work was pending, %false otherwise.
3149  */
3150 bool cancel_work_sync(struct work_struct *work)
3151 {
3152         return __cancel_work_timer(work, false);
3153 }
3154 EXPORT_SYMBOL_GPL(cancel_work_sync);
3155
3156 /**
3157  * flush_delayed_work - wait for a dwork to finish executing the last queueing
3158  * @dwork: the delayed work to flush
3159  *
3160  * Delayed timer is cancelled and the pending work is queued for
3161  * immediate execution.  Like flush_work(), this function only
3162  * considers the last queueing instance of @dwork.
3163  *
3164  * Return:
3165  * %true if flush_work() waited for the work to finish execution,
3166  * %false if it was already idle.
3167  */
3168 bool flush_delayed_work(struct delayed_work *dwork)
3169 {
3170         local_irq_disable();
3171         if (del_timer_sync(&dwork->timer))
3172                 __queue_work(dwork->cpu, dwork->wq, &dwork->work);
3173         local_irq_enable();
3174         return flush_work(&dwork->work);
3175 }
3176 EXPORT_SYMBOL(flush_delayed_work);
3177
3178 /**
3179  * flush_rcu_work - wait for a rwork to finish executing the last queueing
3180  * @rwork: the rcu work to flush
3181  *
3182  * Return:
3183  * %true if flush_rcu_work() waited for the work to finish execution,
3184  * %false if it was already idle.
3185  */
3186 bool flush_rcu_work(struct rcu_work *rwork)
3187 {
3188         if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) {
3189                 rcu_barrier();
3190                 flush_work(&rwork->work);
3191                 return true;
3192         } else {
3193                 return flush_work(&rwork->work);
3194         }
3195 }
3196 EXPORT_SYMBOL(flush_rcu_work);
3197
3198 static bool __cancel_work(struct work_struct *work, bool is_dwork)
3199 {
3200         unsigned long flags;
3201         int ret;
3202
3203         do {
3204                 ret = try_to_grab_pending(work, is_dwork, &flags);
3205         } while (unlikely(ret == -EAGAIN));
3206
3207         if (unlikely(ret < 0))
3208                 return false;
3209
3210         set_work_pool_and_clear_pending(work, get_work_pool_id(work));
3211         local_irq_restore(flags);
3212         return ret;
3213 }
3214
3215 /**
3216  * cancel_delayed_work - cancel a delayed work
3217  * @dwork: delayed_work to cancel
3218  *
3219  * Kill off a pending delayed_work.
3220  *
3221  * Return: %true if @dwork was pending and canceled; %false if it wasn't
3222  * pending.
3223  *
3224  * Note:
3225  * The work callback function may still be running on return, unless
3226  * it returns %true and the work doesn't re-arm itself.  Explicitly flush or
3227  * use cancel_delayed_work_sync() to wait on it.
3228  *
3229  * This function is safe to call from any context including IRQ handler.
3230  */
3231 bool cancel_delayed_work(struct delayed_work *dwork)
3232 {
3233         return __cancel_work(&dwork->work, true);
3234 }
3235 EXPORT_SYMBOL(cancel_delayed_work);
3236
3237 /**
3238  * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish
3239  * @dwork: the delayed work cancel
3240  *
3241  * This is cancel_work_sync() for delayed works.
3242  *
3243  * Return:
3244  * %true if @dwork was pending, %false otherwise.
3245  */
3246 bool cancel_delayed_work_sync(struct delayed_work *dwork)
3247 {
3248         return __cancel_work_timer(&dwork->work, true);
3249 }
3250 EXPORT_SYMBOL(cancel_delayed_work_sync);
3251
3252 /**
3253  * schedule_on_each_cpu - execute a function synchronously on each online CPU
3254  * @func: the function to call
3255  *
3256  * schedule_on_each_cpu() executes @func on each online CPU using the
3257  * system workqueue and blocks until all CPUs have completed.
3258  * schedule_on_each_cpu() is very slow.
3259  *
3260  * Return:
3261  * 0 on success, -errno on failure.
3262  */
3263 int schedule_on_each_cpu(work_func_t func)
3264 {
3265         int cpu;
3266         struct work_struct __percpu *works;
3267
3268         works = alloc_percpu(struct work_struct);
3269         if (!works)
3270                 return -ENOMEM;
3271
3272         get_online_cpus();
3273
3274         for_each_online_cpu(cpu) {
3275                 struct work_struct *work = per_cpu_ptr(works, cpu);
3276
3277                 INIT_WORK(work, func);
3278                 schedule_work_on(cpu, work);
3279         }
3280
3281         for_each_online_cpu(cpu)
3282                 flush_work(per_cpu_ptr(works, cpu));
3283
3284         put_online_cpus();
3285         free_percpu(works);
3286         return 0;
3287 }
3288
3289 /**
3290  * execute_in_process_context - reliably execute the routine with user context
3291  * @fn:         the function to execute
3292  * @ew:         guaranteed storage for the execute work structure (must
3293  *              be available when the work executes)
3294  *
3295  * Executes the function immediately if process context is available,
3296  * otherwise schedules the function for delayed execution.
3297  *
3298  * Return:      0 - function was executed
3299  *              1 - function was scheduled for execution
3300  */
3301 int execute_in_process_context(work_func_t fn, struct execute_work *ew)
3302 {
3303         if (!in_interrupt()) {
3304                 fn(&ew->work);
3305                 return 0;
3306         }
3307
3308         INIT_WORK(&ew->work, fn);
3309         schedule_work(&ew->work);
3310
3311         return 1;
3312 }
3313 EXPORT_SYMBOL_GPL(execute_in_process_context);
3314
3315 /**
3316  * free_workqueue_attrs - free a workqueue_attrs
3317  * @attrs: workqueue_attrs to free
3318  *
3319  * Undo alloc_workqueue_attrs().
3320  */
3321 void free_workqueue_attrs(struct workqueue_attrs *attrs)
3322 {
3323         if (attrs) {
3324                 free_cpumask_var(attrs->cpumask);
3325                 kfree(attrs);
3326         }
3327 }
3328
3329 /**
3330  * alloc_workqueue_attrs - allocate a workqueue_attrs
3331  * @gfp_mask: allocation mask to use
3332  *
3333  * Allocate a new workqueue_attrs, initialize with default settings and
3334  * return it.
3335  *
3336  * Return: The allocated new workqueue_attr on success. %NULL on failure.
3337  */
3338 struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask)
3339 {
3340         struct workqueue_attrs *attrs;
3341
3342         attrs = kzalloc(sizeof(*attrs), gfp_mask);
3343         if (!attrs)
3344                 goto fail;
3345         if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask))
3346                 goto fail;
3347
3348         cpumask_copy(attrs->cpumask, cpu_possible_mask);
3349         return attrs;
3350 fail:
3351         free_workqueue_attrs(attrs);
3352         return NULL;
3353 }
3354
3355 static void copy_workqueue_attrs(struct workqueue_attrs *to,
3356                                  const struct workqueue_attrs *from)
3357 {
3358         to->nice = from->nice;
3359         cpumask_copy(to->cpumask, from->cpumask);
3360         /*
3361          * Unlike hash and equality test, this function doesn't ignore
3362          * ->no_numa as it is used for both pool and wq attrs.  Instead,
3363          * get_unbound_pool() explicitly clears ->no_numa after copying.
3364          */
3365         to->no_numa = from->no_numa;
3366 }
3367
3368 /* hash value of the content of @attr */
3369 static u32 wqattrs_hash(const struct workqueue_attrs *attrs)
3370 {
3371         u32 hash = 0;
3372
3373         hash = jhash_1word(attrs->nice, hash);
3374         hash = jhash(cpumask_bits(attrs->cpumask),
3375                      BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash);
3376         return hash;
3377 }
3378
3379 /* content equality test */
3380 static bool wqattrs_equal(const struct workqueue_attrs *a,
3381                           const struct workqueue_attrs *b)
3382 {
3383         if (a->nice != b->nice)
3384                 return false;
3385         if (!cpumask_equal(a->cpumask, b->cpumask))
3386                 return false;
3387         return true;
3388 }
3389
3390 /**
3391  * init_worker_pool - initialize a newly zalloc'd worker_pool
3392  * @pool: worker_pool to initialize
3393  *
3394  * Initialize a newly zalloc'd @pool.  It also allocates @pool->attrs.
3395  *
3396  * Return: 0 on success, -errno on failure.  Even on fa