11da177e4SLinus Torvalds /* 2c54fce6eSTejun Heo * kernel/workqueue.c - generic async execution with shared worker pool 31da177e4SLinus Torvalds * 4c54fce6eSTejun Heo * Copyright (C) 2002 Ingo Molnar 51da177e4SLinus Torvalds * 61da177e4SLinus Torvalds * Derived from the taskqueue/keventd code by: 71da177e4SLinus Torvalds * David Woodhouse <[email protected]> 8e1f8e874SFrancois Cami * Andrew Morton 91da177e4SLinus Torvalds * Kai Petzke <[email protected]> 101da177e4SLinus Torvalds * Theodore Ts'o <[email protected]> 1189ada679SChristoph Lameter * 12cde53535SChristoph Lameter * Made to use alloc_percpu by Christoph Lameter. 13c54fce6eSTejun Heo * 14c54fce6eSTejun Heo * Copyright (C) 2010 SUSE Linux Products GmbH 15c54fce6eSTejun Heo * Copyright (C) 2010 Tejun Heo <[email protected]> 16c54fce6eSTejun Heo * 17c54fce6eSTejun Heo * This is the generic async execution mechanism. Work items as are 18c54fce6eSTejun Heo * executed in process context. The worker pool is shared and 19c54fce6eSTejun Heo * automatically managed. There is one worker pool for each CPU and 20c54fce6eSTejun Heo * one extra for works which are better served by workers which are 21c54fce6eSTejun Heo * not bound to any specific CPU. 22c54fce6eSTejun Heo * 23c54fce6eSTejun Heo * Please read Documentation/workqueue.txt for details. 241da177e4SLinus Torvalds */ 251da177e4SLinus Torvalds 261da177e4SLinus Torvalds #include <linux/module.h> 271da177e4SLinus Torvalds #include <linux/kernel.h> 281da177e4SLinus Torvalds #include <linux/sched.h> 291da177e4SLinus Torvalds #include <linux/init.h> 301da177e4SLinus Torvalds #include <linux/signal.h> 311da177e4SLinus Torvalds #include <linux/completion.h> 321da177e4SLinus Torvalds #include <linux/workqueue.h> 331da177e4SLinus Torvalds #include <linux/slab.h> 341da177e4SLinus Torvalds #include <linux/cpu.h> 351da177e4SLinus Torvalds #include <linux/notifier.h> 361da177e4SLinus Torvalds #include <linux/kthread.h> 371fa44ecaSJames Bottomley #include <linux/hardirq.h> 3846934023SChristoph Lameter #include <linux/mempolicy.h> 39341a5958SRafael J. Wysocki #include <linux/freezer.h> 40d5abe669SPeter Zijlstra #include <linux/kallsyms.h> 41d5abe669SPeter Zijlstra #include <linux/debug_locks.h> 424e6045f1SJohannes Berg #include <linux/lockdep.h> 43c34056a3STejun Heo #include <linux/idr.h> 44e22bee78STejun Heo 45e22bee78STejun Heo #include "workqueue_sched.h" 461da177e4SLinus Torvalds 47c8e55f36STejun Heo enum { 48db7bccf4STejun Heo /* global_cwq flags */ 49e22bee78STejun Heo GCWQ_MANAGE_WORKERS = 1 << 0, /* need to manage workers */ 50e22bee78STejun Heo GCWQ_MANAGING_WORKERS = 1 << 1, /* managing workers */ 51e22bee78STejun Heo GCWQ_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */ 52db7bccf4STejun Heo GCWQ_FREEZING = 1 << 3, /* freeze in progress */ 53649027d7STejun Heo GCWQ_HIGHPRI_PENDING = 1 << 4, /* highpri works on queue */ 54db7bccf4STejun Heo 55c8e55f36STejun Heo /* worker flags */ 56c8e55f36STejun Heo WORKER_STARTED = 1 << 0, /* started */ 57c8e55f36STejun Heo WORKER_DIE = 1 << 1, /* die die die */ 58c8e55f36STejun Heo WORKER_IDLE = 1 << 2, /* is idle */ 59e22bee78STejun Heo WORKER_PREP = 1 << 3, /* preparing to run works */ 60db7bccf4STejun Heo WORKER_ROGUE = 1 << 4, /* not bound to any cpu */ 61e22bee78STejun Heo WORKER_REBIND = 1 << 5, /* mom is home, come back */ 62fb0e7bebSTejun Heo WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */ 63f3421797STejun Heo WORKER_UNBOUND = 1 << 7, /* worker is unbound */ 64e22bee78STejun Heo 65fb0e7bebSTejun Heo WORKER_NOT_RUNNING = WORKER_PREP | WORKER_ROGUE | WORKER_REBIND | 66f3421797STejun Heo WORKER_CPU_INTENSIVE | WORKER_UNBOUND, 67db7bccf4STejun Heo 68db7bccf4STejun Heo /* gcwq->trustee_state */ 69db7bccf4STejun Heo TRUSTEE_START = 0, /* start */ 70db7bccf4STejun Heo TRUSTEE_IN_CHARGE = 1, /* trustee in charge of gcwq */ 71db7bccf4STejun Heo TRUSTEE_BUTCHER = 2, /* butcher workers */ 72db7bccf4STejun Heo TRUSTEE_RELEASE = 3, /* release workers */ 73db7bccf4STejun Heo TRUSTEE_DONE = 4, /* trustee is done */ 74c8e55f36STejun Heo 75c8e55f36STejun Heo BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */ 76c8e55f36STejun Heo BUSY_WORKER_HASH_SIZE = 1 << BUSY_WORKER_HASH_ORDER, 77c8e55f36STejun Heo BUSY_WORKER_HASH_MASK = BUSY_WORKER_HASH_SIZE - 1, 78db7bccf4STejun Heo 79e22bee78STejun Heo MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */ 80e22bee78STejun Heo IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */ 81e22bee78STejun Heo 82*3233cdbdSTejun Heo MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2, 83*3233cdbdSTejun Heo /* call for help after 10ms 84*3233cdbdSTejun Heo (min two ticks) */ 85e22bee78STejun Heo MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */ 86e22bee78STejun Heo CREATE_COOLDOWN = HZ, /* time to breath after fail */ 87db7bccf4STejun Heo TRUSTEE_COOLDOWN = HZ / 10, /* for trustee draining */ 881da177e4SLinus Torvalds 891da177e4SLinus Torvalds /* 90e22bee78STejun Heo * Rescue workers are used only on emergencies and shared by 91e22bee78STejun Heo * all cpus. Give -20. 92e22bee78STejun Heo */ 93e22bee78STejun Heo RESCUER_NICE_LEVEL = -20, 94c8e55f36STejun Heo }; 95c8e55f36STejun Heo 961da177e4SLinus Torvalds /* 974690c4abSTejun Heo * Structure fields follow one of the following exclusion rules. 984690c4abSTejun Heo * 99e41e704bSTejun Heo * I: Modifiable by initialization/destruction paths and read-only for 100e41e704bSTejun Heo * everyone else. 1014690c4abSTejun Heo * 102e22bee78STejun Heo * P: Preemption protected. Disabling preemption is enough and should 103e22bee78STejun Heo * only be modified and accessed from the local cpu. 104e22bee78STejun Heo * 1058b03ae3cSTejun Heo * L: gcwq->lock protected. Access with gcwq->lock held. 1064690c4abSTejun Heo * 107e22bee78STejun Heo * X: During normal operation, modification requires gcwq->lock and 108e22bee78STejun Heo * should be done only from local cpu. Either disabling preemption 109e22bee78STejun Heo * on local cpu or grabbing gcwq->lock is enough for read access. 110f3421797STejun Heo * If GCWQ_DISASSOCIATED is set, it's identical to L. 111e22bee78STejun Heo * 11273f53c4aSTejun Heo * F: wq->flush_mutex protected. 11373f53c4aSTejun Heo * 1144690c4abSTejun Heo * W: workqueue_lock protected. 1154690c4abSTejun Heo */ 1164690c4abSTejun Heo 1178b03ae3cSTejun Heo struct global_cwq; 118c34056a3STejun Heo 119e22bee78STejun Heo /* 120e22bee78STejun Heo * The poor guys doing the actual heavy lifting. All on-duty workers 121e22bee78STejun Heo * are either serving the manager role, on idle list or on busy hash. 122e22bee78STejun Heo */ 123c34056a3STejun Heo struct worker { 124c8e55f36STejun Heo /* on idle list while idle, on busy hash table while busy */ 125c8e55f36STejun Heo union { 126c8e55f36STejun Heo struct list_head entry; /* L: while idle */ 127c8e55f36STejun Heo struct hlist_node hentry; /* L: while busy */ 128c8e55f36STejun Heo }; 129c8e55f36STejun Heo 130c34056a3STejun Heo struct work_struct *current_work; /* L: work being processed */ 1318cca0eeaSTejun Heo struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */ 132affee4b2STejun Heo struct list_head scheduled; /* L: scheduled works */ 133c34056a3STejun Heo struct task_struct *task; /* I: worker task */ 1348b03ae3cSTejun Heo struct global_cwq *gcwq; /* I: the associated gcwq */ 135e22bee78STejun Heo /* 64 bytes boundary on 64bit, 32 on 32bit */ 136e22bee78STejun Heo unsigned long last_active; /* L: last active timestamp */ 137e22bee78STejun Heo unsigned int flags; /* X: flags */ 138c34056a3STejun Heo int id; /* I: worker id */ 139e22bee78STejun Heo struct work_struct rebind_work; /* L: rebind worker to cpu */ 140c34056a3STejun Heo }; 141c34056a3STejun Heo 1424690c4abSTejun Heo /* 143e22bee78STejun Heo * Global per-cpu workqueue. There's one and only one for each cpu 144e22bee78STejun Heo * and all works are queued and processed here regardless of their 145e22bee78STejun Heo * target workqueues. 1468b03ae3cSTejun Heo */ 1478b03ae3cSTejun Heo struct global_cwq { 1488b03ae3cSTejun Heo spinlock_t lock; /* the gcwq lock */ 1497e11629dSTejun Heo struct list_head worklist; /* L: list of pending works */ 1508b03ae3cSTejun Heo unsigned int cpu; /* I: the associated cpu */ 151db7bccf4STejun Heo unsigned int flags; /* L: GCWQ_* flags */ 152c8e55f36STejun Heo 153c8e55f36STejun Heo int nr_workers; /* L: total number of workers */ 154c8e55f36STejun Heo int nr_idle; /* L: currently idle ones */ 155c8e55f36STejun Heo 156c8e55f36STejun Heo /* workers are chained either in the idle_list or busy_hash */ 157e22bee78STejun Heo struct list_head idle_list; /* X: list of idle workers */ 158c8e55f36STejun Heo struct hlist_head busy_hash[BUSY_WORKER_HASH_SIZE]; 159c8e55f36STejun Heo /* L: hash of busy workers */ 160c8e55f36STejun Heo 161e22bee78STejun Heo struct timer_list idle_timer; /* L: worker idle timeout */ 162e22bee78STejun Heo struct timer_list mayday_timer; /* L: SOS timer for dworkers */ 163e22bee78STejun Heo 1648b03ae3cSTejun Heo struct ida worker_ida; /* L: for worker IDs */ 165db7bccf4STejun Heo 166db7bccf4STejun Heo struct task_struct *trustee; /* L: for gcwq shutdown */ 167db7bccf4STejun Heo unsigned int trustee_state; /* L: trustee state */ 168db7bccf4STejun Heo wait_queue_head_t trustee_wait; /* trustee wait */ 169e22bee78STejun Heo struct worker *first_idle; /* L: first idle worker */ 1708b03ae3cSTejun Heo } ____cacheline_aligned_in_smp; 1718b03ae3cSTejun Heo 1728b03ae3cSTejun Heo /* 173502ca9d8STejun Heo * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of 1740f900049STejun Heo * work_struct->data are used for flags and thus cwqs need to be 1750f900049STejun Heo * aligned at two's power of the number of flag bits. 1761da177e4SLinus Torvalds */ 1771da177e4SLinus Torvalds struct cpu_workqueue_struct { 1788b03ae3cSTejun Heo struct global_cwq *gcwq; /* I: the associated gcwq */ 1794690c4abSTejun Heo struct workqueue_struct *wq; /* I: the owning workqueue */ 18073f53c4aSTejun Heo int work_color; /* L: current color */ 18173f53c4aSTejun Heo int flush_color; /* L: flushing color */ 18273f53c4aSTejun Heo int nr_in_flight[WORK_NR_COLORS]; 18373f53c4aSTejun Heo /* L: nr of in_flight works */ 1841e19ffc6STejun Heo int nr_active; /* L: nr of active works */ 185a0a1a5fdSTejun Heo int max_active; /* L: max active works */ 1861e19ffc6STejun Heo struct list_head delayed_works; /* L: delayed works */ 1870f900049STejun Heo }; 1881da177e4SLinus Torvalds 1891da177e4SLinus Torvalds /* 19073f53c4aSTejun Heo * Structure used to wait for workqueue flush. 19173f53c4aSTejun Heo */ 19273f53c4aSTejun Heo struct wq_flusher { 19373f53c4aSTejun Heo struct list_head list; /* F: list of flushers */ 19473f53c4aSTejun Heo int flush_color; /* F: flush color waiting for */ 19573f53c4aSTejun Heo struct completion done; /* flush completion */ 19673f53c4aSTejun Heo }; 1971da177e4SLinus Torvalds 19873f53c4aSTejun Heo /* 199f2e005aaSTejun Heo * All cpumasks are assumed to be always set on UP and thus can't be 200f2e005aaSTejun Heo * used to determine whether there's something to be done. 201f2e005aaSTejun Heo */ 202f2e005aaSTejun Heo #ifdef CONFIG_SMP 203f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t; 204f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask) \ 205f2e005aaSTejun Heo cpumask_test_and_set_cpu((cpu), (mask)) 206f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask)) 207f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask)) 2089c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp)) 209f2e005aaSTejun Heo #define free_mayday_mask(mask) free_cpumask_var((mask)) 210f2e005aaSTejun Heo #else 211f2e005aaSTejun Heo typedef unsigned long mayday_mask_t; 212f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask)) 213f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask)) 214f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask)) 215f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp) true 216f2e005aaSTejun Heo #define free_mayday_mask(mask) do { } while (0) 217f2e005aaSTejun Heo #endif 2181da177e4SLinus Torvalds 2191da177e4SLinus Torvalds /* 2201da177e4SLinus Torvalds * The externally visible workqueue abstraction is an array of 2211da177e4SLinus Torvalds * per-CPU workqueues: 2221da177e4SLinus Torvalds */ 2231da177e4SLinus Torvalds struct workqueue_struct { 22497e37d7bSTejun Heo unsigned int flags; /* I: WQ_* flags */ 225bdbc5dd7STejun Heo union { 226bdbc5dd7STejun Heo struct cpu_workqueue_struct __percpu *pcpu; 227bdbc5dd7STejun Heo struct cpu_workqueue_struct *single; 228bdbc5dd7STejun Heo unsigned long v; 229bdbc5dd7STejun Heo } cpu_wq; /* I: cwq's */ 2304690c4abSTejun Heo struct list_head list; /* W: list of all workqueues */ 23173f53c4aSTejun Heo 23273f53c4aSTejun Heo struct mutex flush_mutex; /* protects wq flushing */ 23373f53c4aSTejun Heo int work_color; /* F: current work color */ 23473f53c4aSTejun Heo int flush_color; /* F: current flush color */ 23573f53c4aSTejun Heo atomic_t nr_cwqs_to_flush; /* flush in progress */ 23673f53c4aSTejun Heo struct wq_flusher *first_flusher; /* F: first flusher */ 23773f53c4aSTejun Heo struct list_head flusher_queue; /* F: flush waiters */ 23873f53c4aSTejun Heo struct list_head flusher_overflow; /* F: flush overflow list */ 23973f53c4aSTejun Heo 240f2e005aaSTejun Heo mayday_mask_t mayday_mask; /* cpus requesting rescue */ 241e22bee78STejun Heo struct worker *rescuer; /* I: rescue worker */ 242e22bee78STejun Heo 243dcd989cbSTejun Heo int saved_max_active; /* W: saved cwq max_active */ 2444690c4abSTejun Heo const char *name; /* I: workqueue name */ 2454e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 2464e6045f1SJohannes Berg struct lockdep_map lockdep_map; 2474e6045f1SJohannes Berg #endif 2481da177e4SLinus Torvalds }; 2491da177e4SLinus Torvalds 250d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly; 251d320c038STejun Heo struct workqueue_struct *system_long_wq __read_mostly; 252d320c038STejun Heo struct workqueue_struct *system_nrt_wq __read_mostly; 253f3421797STejun Heo struct workqueue_struct *system_unbound_wq __read_mostly; 254d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq); 255d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq); 256d320c038STejun Heo EXPORT_SYMBOL_GPL(system_nrt_wq); 257f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq); 258d320c038STejun Heo 25997bd2347STejun Heo #define CREATE_TRACE_POINTS 26097bd2347STejun Heo #include <trace/events/workqueue.h> 26197bd2347STejun Heo 262db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq) \ 263db7bccf4STejun Heo for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \ 264db7bccf4STejun Heo hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry) 265db7bccf4STejun Heo 266f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask, 267f3421797STejun Heo unsigned int sw) 268f3421797STejun Heo { 269f3421797STejun Heo if (cpu < nr_cpu_ids) { 270f3421797STejun Heo if (sw & 1) { 271f3421797STejun Heo cpu = cpumask_next(cpu, mask); 272f3421797STejun Heo if (cpu < nr_cpu_ids) 273f3421797STejun Heo return cpu; 274f3421797STejun Heo } 275f3421797STejun Heo if (sw & 2) 276f3421797STejun Heo return WORK_CPU_UNBOUND; 277f3421797STejun Heo } 278f3421797STejun Heo return WORK_CPU_NONE; 279f3421797STejun Heo } 280f3421797STejun Heo 281f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask, 282f3421797STejun Heo struct workqueue_struct *wq) 283f3421797STejun Heo { 284f3421797STejun Heo return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2); 285f3421797STejun Heo } 286f3421797STejun Heo 28709884951STejun Heo /* 28809884951STejun Heo * CPU iterators 28909884951STejun Heo * 29009884951STejun Heo * An extra gcwq is defined for an invalid cpu number 29109884951STejun Heo * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any 29209884951STejun Heo * specific CPU. The following iterators are similar to 29309884951STejun Heo * for_each_*_cpu() iterators but also considers the unbound gcwq. 29409884951STejun Heo * 29509884951STejun Heo * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND 29609884951STejun Heo * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND 29709884951STejun Heo * for_each_cwq_cpu() : possible CPUs for bound workqueues, 29809884951STejun Heo * WORK_CPU_UNBOUND for unbound workqueues 29909884951STejun Heo */ 300f3421797STejun Heo #define for_each_gcwq_cpu(cpu) \ 301f3421797STejun Heo for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \ 302f3421797STejun Heo (cpu) < WORK_CPU_NONE; \ 303f3421797STejun Heo (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3)) 304f3421797STejun Heo 305f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu) \ 306f3421797STejun Heo for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \ 307f3421797STejun Heo (cpu) < WORK_CPU_NONE; \ 308f3421797STejun Heo (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3)) 309f3421797STejun Heo 310f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq) \ 311f3421797STejun Heo for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \ 312f3421797STejun Heo (cpu) < WORK_CPU_NONE; \ 313f3421797STejun Heo (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq))) 314f3421797STejun Heo 315dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 316dc186ad7SThomas Gleixner 317dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr; 318dc186ad7SThomas Gleixner 319dc186ad7SThomas Gleixner /* 320dc186ad7SThomas Gleixner * fixup_init is called when: 321dc186ad7SThomas Gleixner * - an active object is initialized 322dc186ad7SThomas Gleixner */ 323dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state) 324dc186ad7SThomas Gleixner { 325dc186ad7SThomas Gleixner struct work_struct *work = addr; 326dc186ad7SThomas Gleixner 327dc186ad7SThomas Gleixner switch (state) { 328dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 329dc186ad7SThomas Gleixner cancel_work_sync(work); 330dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 331dc186ad7SThomas Gleixner return 1; 332dc186ad7SThomas Gleixner default: 333dc186ad7SThomas Gleixner return 0; 334dc186ad7SThomas Gleixner } 335dc186ad7SThomas Gleixner } 336dc186ad7SThomas Gleixner 337dc186ad7SThomas Gleixner /* 338dc186ad7SThomas Gleixner * fixup_activate is called when: 339dc186ad7SThomas Gleixner * - an active object is activated 340dc186ad7SThomas Gleixner * - an unknown object is activated (might be a statically initialized object) 341dc186ad7SThomas Gleixner */ 342dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state) 343dc186ad7SThomas Gleixner { 344dc186ad7SThomas Gleixner struct work_struct *work = addr; 345dc186ad7SThomas Gleixner 346dc186ad7SThomas Gleixner switch (state) { 347dc186ad7SThomas Gleixner 348dc186ad7SThomas Gleixner case ODEBUG_STATE_NOTAVAILABLE: 349dc186ad7SThomas Gleixner /* 350dc186ad7SThomas Gleixner * This is not really a fixup. The work struct was 351dc186ad7SThomas Gleixner * statically initialized. We just make sure that it 352dc186ad7SThomas Gleixner * is tracked in the object tracker. 353dc186ad7SThomas Gleixner */ 35422df02bbSTejun Heo if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) { 355dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 356dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 357dc186ad7SThomas Gleixner return 0; 358dc186ad7SThomas Gleixner } 359dc186ad7SThomas Gleixner WARN_ON_ONCE(1); 360dc186ad7SThomas Gleixner return 0; 361dc186ad7SThomas Gleixner 362dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 363dc186ad7SThomas Gleixner WARN_ON(1); 364dc186ad7SThomas Gleixner 365dc186ad7SThomas Gleixner default: 366dc186ad7SThomas Gleixner return 0; 367dc186ad7SThomas Gleixner } 368dc186ad7SThomas Gleixner } 369dc186ad7SThomas Gleixner 370dc186ad7SThomas Gleixner /* 371dc186ad7SThomas Gleixner * fixup_free is called when: 372dc186ad7SThomas Gleixner * - an active object is freed 373dc186ad7SThomas Gleixner */ 374dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state) 375dc186ad7SThomas Gleixner { 376dc186ad7SThomas Gleixner struct work_struct *work = addr; 377dc186ad7SThomas Gleixner 378dc186ad7SThomas Gleixner switch (state) { 379dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 380dc186ad7SThomas Gleixner cancel_work_sync(work); 381dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 382dc186ad7SThomas Gleixner return 1; 383dc186ad7SThomas Gleixner default: 384dc186ad7SThomas Gleixner return 0; 385dc186ad7SThomas Gleixner } 386dc186ad7SThomas Gleixner } 387dc186ad7SThomas Gleixner 388dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = { 389dc186ad7SThomas Gleixner .name = "work_struct", 390dc186ad7SThomas Gleixner .fixup_init = work_fixup_init, 391dc186ad7SThomas Gleixner .fixup_activate = work_fixup_activate, 392dc186ad7SThomas Gleixner .fixup_free = work_fixup_free, 393dc186ad7SThomas Gleixner }; 394dc186ad7SThomas Gleixner 395dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) 396dc186ad7SThomas Gleixner { 397dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 398dc186ad7SThomas Gleixner } 399dc186ad7SThomas Gleixner 400dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) 401dc186ad7SThomas Gleixner { 402dc186ad7SThomas Gleixner debug_object_deactivate(work, &work_debug_descr); 403dc186ad7SThomas Gleixner } 404dc186ad7SThomas Gleixner 405dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack) 406dc186ad7SThomas Gleixner { 407dc186ad7SThomas Gleixner if (onstack) 408dc186ad7SThomas Gleixner debug_object_init_on_stack(work, &work_debug_descr); 409dc186ad7SThomas Gleixner else 410dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 411dc186ad7SThomas Gleixner } 412dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work); 413dc186ad7SThomas Gleixner 414dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work) 415dc186ad7SThomas Gleixner { 416dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 417dc186ad7SThomas Gleixner } 418dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack); 419dc186ad7SThomas Gleixner 420dc186ad7SThomas Gleixner #else 421dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { } 422dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { } 423dc186ad7SThomas Gleixner #endif 424dc186ad7SThomas Gleixner 42595402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */ 42695402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock); 4271da177e4SLinus Torvalds static LIST_HEAD(workqueues); 428a0a1a5fdSTejun Heo static bool workqueue_freezing; /* W: have wqs started freezing? */ 4291da177e4SLinus Torvalds 43014441960SOleg Nesterov /* 431e22bee78STejun Heo * The almighty global cpu workqueues. nr_running is the only field 432e22bee78STejun Heo * which is expected to be used frequently by other cpus via 433e22bee78STejun Heo * try_to_wake_up(). Put it in a separate cacheline. 43414441960SOleg Nesterov */ 4358b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq); 436e22bee78STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, gcwq_nr_running); 437f756d5e2SNathan Lynch 438f3421797STejun Heo /* 439f3421797STejun Heo * Global cpu workqueue and nr_running counter for unbound gcwq. The 440f3421797STejun Heo * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its 441f3421797STejun Heo * workers have WORKER_UNBOUND set. 442f3421797STejun Heo */ 443f3421797STejun Heo static struct global_cwq unbound_global_cwq; 444f3421797STejun Heo static atomic_t unbound_gcwq_nr_running = ATOMIC_INIT(0); /* always 0 */ 445f3421797STejun Heo 446c34056a3STejun Heo static int worker_thread(void *__worker); 4471da177e4SLinus Torvalds 4488b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu) 4491da177e4SLinus Torvalds { 450f3421797STejun Heo if (cpu != WORK_CPU_UNBOUND) 4518b03ae3cSTejun Heo return &per_cpu(global_cwq, cpu); 452f3421797STejun Heo else 453f3421797STejun Heo return &unbound_global_cwq; 4541da177e4SLinus Torvalds } 4551da177e4SLinus Torvalds 456e22bee78STejun Heo static atomic_t *get_gcwq_nr_running(unsigned int cpu) 457b1f4ec17SOleg Nesterov { 458f3421797STejun Heo if (cpu != WORK_CPU_UNBOUND) 459e22bee78STejun Heo return &per_cpu(gcwq_nr_running, cpu); 460f3421797STejun Heo else 461f3421797STejun Heo return &unbound_gcwq_nr_running; 462b1f4ec17SOleg Nesterov } 463b1f4ec17SOleg Nesterov 4644690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu, 4654690c4abSTejun Heo struct workqueue_struct *wq) 466a848e3b6SOleg Nesterov { 467f3421797STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 468f3421797STejun Heo if (likely(cpu < nr_cpu_ids)) { 469f3421797STejun Heo #ifdef CONFIG_SMP 470bdbc5dd7STejun Heo return per_cpu_ptr(wq->cpu_wq.pcpu, cpu); 471f3421797STejun Heo #else 472f3421797STejun Heo return wq->cpu_wq.single; 473bdbc5dd7STejun Heo #endif 474a848e3b6SOleg Nesterov } 475f3421797STejun Heo } else if (likely(cpu == WORK_CPU_UNBOUND)) 476f3421797STejun Heo return wq->cpu_wq.single; 477f3421797STejun Heo return NULL; 478f3421797STejun Heo } 479a848e3b6SOleg Nesterov 48073f53c4aSTejun Heo static unsigned int work_color_to_flags(int color) 48173f53c4aSTejun Heo { 48273f53c4aSTejun Heo return color << WORK_STRUCT_COLOR_SHIFT; 48373f53c4aSTejun Heo } 48473f53c4aSTejun Heo 48573f53c4aSTejun Heo static int get_work_color(struct work_struct *work) 48673f53c4aSTejun Heo { 48773f53c4aSTejun Heo return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) & 48873f53c4aSTejun Heo ((1 << WORK_STRUCT_COLOR_BITS) - 1); 48973f53c4aSTejun Heo } 49073f53c4aSTejun Heo 49173f53c4aSTejun Heo static int work_next_color(int color) 49273f53c4aSTejun Heo { 49373f53c4aSTejun Heo return (color + 1) % WORK_NR_COLORS; 4941da177e4SLinus Torvalds } 4951da177e4SLinus Torvalds 4964594bf15SDavid Howells /* 497e120153dSTejun Heo * A work's data points to the cwq with WORK_STRUCT_CWQ set while the 498e120153dSTejun Heo * work is on queue. Once execution starts, WORK_STRUCT_CWQ is 499e120153dSTejun Heo * cleared and the work data contains the cpu number it was last on. 5007a22ad75STejun Heo * 5017a22ad75STejun Heo * set_work_{cwq|cpu}() and clear_work_data() can be used to set the 5027a22ad75STejun Heo * cwq, cpu or clear work->data. These functions should only be 5037a22ad75STejun Heo * called while the work is owned - ie. while the PENDING bit is set. 5047a22ad75STejun Heo * 5057a22ad75STejun Heo * get_work_[g]cwq() can be used to obtain the gcwq or cwq 5067a22ad75STejun Heo * corresponding to a work. gcwq is available once the work has been 5077a22ad75STejun Heo * queued anywhere after initialization. cwq is available only from 5087a22ad75STejun Heo * queueing until execution starts. 5094594bf15SDavid Howells */ 5107a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data, 5117a22ad75STejun Heo unsigned long flags) 5127a22ad75STejun Heo { 5137a22ad75STejun Heo BUG_ON(!work_pending(work)); 5147a22ad75STejun Heo atomic_long_set(&work->data, data | flags | work_static(work)); 5157a22ad75STejun Heo } 5167a22ad75STejun Heo 5177a22ad75STejun Heo static void set_work_cwq(struct work_struct *work, 5184690c4abSTejun Heo struct cpu_workqueue_struct *cwq, 5194690c4abSTejun Heo unsigned long extra_flags) 520365970a1SDavid Howells { 5217a22ad75STejun Heo set_work_data(work, (unsigned long)cwq, 522e120153dSTejun Heo WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags); 523365970a1SDavid Howells } 524365970a1SDavid Howells 5257a22ad75STejun Heo static void set_work_cpu(struct work_struct *work, unsigned int cpu) 5264d707b9fSOleg Nesterov { 5277a22ad75STejun Heo set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING); 5284d707b9fSOleg Nesterov } 5294d707b9fSOleg Nesterov 5307a22ad75STejun Heo static void clear_work_data(struct work_struct *work) 531365970a1SDavid Howells { 5327a22ad75STejun Heo set_work_data(work, WORK_STRUCT_NO_CPU, 0); 5337a22ad75STejun Heo } 5347a22ad75STejun Heo 5357a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work) 5367a22ad75STejun Heo { 537e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 5387a22ad75STejun Heo 539e120153dSTejun Heo if (data & WORK_STRUCT_CWQ) 540e120153dSTejun Heo return (void *)(data & WORK_STRUCT_WQ_DATA_MASK); 541e120153dSTejun Heo else 542e120153dSTejun Heo return NULL; 5437a22ad75STejun Heo } 5447a22ad75STejun Heo 5457a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work) 5467a22ad75STejun Heo { 547e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 5487a22ad75STejun Heo unsigned int cpu; 5497a22ad75STejun Heo 550e120153dSTejun Heo if (data & WORK_STRUCT_CWQ) 551e120153dSTejun Heo return ((struct cpu_workqueue_struct *) 552e120153dSTejun Heo (data & WORK_STRUCT_WQ_DATA_MASK))->gcwq; 5537a22ad75STejun Heo 5547a22ad75STejun Heo cpu = data >> WORK_STRUCT_FLAG_BITS; 555bdbc5dd7STejun Heo if (cpu == WORK_CPU_NONE) 5567a22ad75STejun Heo return NULL; 5577a22ad75STejun Heo 558f3421797STejun Heo BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND); 5597a22ad75STejun Heo return get_gcwq(cpu); 560365970a1SDavid Howells } 561365970a1SDavid Howells 562e22bee78STejun Heo /* 563e22bee78STejun Heo * Policy functions. These define the policies on how the global 564e22bee78STejun Heo * worker pool is managed. Unless noted otherwise, these functions 565e22bee78STejun Heo * assume that they're being called with gcwq->lock held. 566e22bee78STejun Heo */ 567e22bee78STejun Heo 568649027d7STejun Heo static bool __need_more_worker(struct global_cwq *gcwq) 569649027d7STejun Heo { 570649027d7STejun Heo return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) || 571649027d7STejun Heo gcwq->flags & GCWQ_HIGHPRI_PENDING; 572649027d7STejun Heo } 573649027d7STejun Heo 574e22bee78STejun Heo /* 575e22bee78STejun Heo * Need to wake up a worker? Called from anything but currently 576e22bee78STejun Heo * running workers. 577e22bee78STejun Heo */ 578e22bee78STejun Heo static bool need_more_worker(struct global_cwq *gcwq) 579e22bee78STejun Heo { 580649027d7STejun Heo return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq); 581e22bee78STejun Heo } 582e22bee78STejun Heo 583e22bee78STejun Heo /* Can I start working? Called from busy but !running workers. */ 584e22bee78STejun Heo static bool may_start_working(struct global_cwq *gcwq) 585e22bee78STejun Heo { 586e22bee78STejun Heo return gcwq->nr_idle; 587e22bee78STejun Heo } 588e22bee78STejun Heo 589e22bee78STejun Heo /* Do I need to keep working? Called from currently running workers. */ 590e22bee78STejun Heo static bool keep_working(struct global_cwq *gcwq) 591e22bee78STejun Heo { 592e22bee78STejun Heo atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu); 593e22bee78STejun Heo 59430310045STejun Heo return !list_empty(&gcwq->worklist) && 59530310045STejun Heo (atomic_read(nr_running) <= 1 || 59630310045STejun Heo gcwq->flags & GCWQ_HIGHPRI_PENDING); 597e22bee78STejun Heo } 598e22bee78STejun Heo 599e22bee78STejun Heo /* Do we need a new worker? Called from manager. */ 600e22bee78STejun Heo static bool need_to_create_worker(struct global_cwq *gcwq) 601e22bee78STejun Heo { 602e22bee78STejun Heo return need_more_worker(gcwq) && !may_start_working(gcwq); 603e22bee78STejun Heo } 604e22bee78STejun Heo 605e22bee78STejun Heo /* Do I need to be the manager? */ 606e22bee78STejun Heo static bool need_to_manage_workers(struct global_cwq *gcwq) 607e22bee78STejun Heo { 608e22bee78STejun Heo return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS; 609e22bee78STejun Heo } 610e22bee78STejun Heo 611e22bee78STejun Heo /* Do we have too many workers and should some go away? */ 612e22bee78STejun Heo static bool too_many_workers(struct global_cwq *gcwq) 613e22bee78STejun Heo { 614e22bee78STejun Heo bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS; 615e22bee78STejun Heo int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */ 616e22bee78STejun Heo int nr_busy = gcwq->nr_workers - nr_idle; 617e22bee78STejun Heo 618e22bee78STejun Heo return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; 619e22bee78STejun Heo } 620e22bee78STejun Heo 621e22bee78STejun Heo /* 622e22bee78STejun Heo * Wake up functions. 623e22bee78STejun Heo */ 624e22bee78STejun Heo 6257e11629dSTejun Heo /* Return the first worker. Safe with preemption disabled */ 6267e11629dSTejun Heo static struct worker *first_worker(struct global_cwq *gcwq) 6277e11629dSTejun Heo { 6287e11629dSTejun Heo if (unlikely(list_empty(&gcwq->idle_list))) 6297e11629dSTejun Heo return NULL; 6307e11629dSTejun Heo 6317e11629dSTejun Heo return list_first_entry(&gcwq->idle_list, struct worker, entry); 6327e11629dSTejun Heo } 6337e11629dSTejun Heo 6347e11629dSTejun Heo /** 6357e11629dSTejun Heo * wake_up_worker - wake up an idle worker 6367e11629dSTejun Heo * @gcwq: gcwq to wake worker for 6377e11629dSTejun Heo * 6387e11629dSTejun Heo * Wake up the first idle worker of @gcwq. 6397e11629dSTejun Heo * 6407e11629dSTejun Heo * CONTEXT: 6417e11629dSTejun Heo * spin_lock_irq(gcwq->lock). 6427e11629dSTejun Heo */ 6437e11629dSTejun Heo static void wake_up_worker(struct global_cwq *gcwq) 6447e11629dSTejun Heo { 6457e11629dSTejun Heo struct worker *worker = first_worker(gcwq); 6467e11629dSTejun Heo 6477e11629dSTejun Heo if (likely(worker)) 6487e11629dSTejun Heo wake_up_process(worker->task); 6497e11629dSTejun Heo } 6507e11629dSTejun Heo 6514690c4abSTejun Heo /** 652e22bee78STejun Heo * wq_worker_waking_up - a worker is waking up 653e22bee78STejun Heo * @task: task waking up 654e22bee78STejun Heo * @cpu: CPU @task is waking up to 655e22bee78STejun Heo * 656e22bee78STejun Heo * This function is called during try_to_wake_up() when a worker is 657e22bee78STejun Heo * being awoken. 658e22bee78STejun Heo * 659e22bee78STejun Heo * CONTEXT: 660e22bee78STejun Heo * spin_lock_irq(rq->lock) 661e22bee78STejun Heo */ 662e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu) 663e22bee78STejun Heo { 664e22bee78STejun Heo struct worker *worker = kthread_data(task); 665e22bee78STejun Heo 6662d64672eSSteven Rostedt if (!(worker->flags & WORKER_NOT_RUNNING)) 667e22bee78STejun Heo atomic_inc(get_gcwq_nr_running(cpu)); 668e22bee78STejun Heo } 669e22bee78STejun Heo 670e22bee78STejun Heo /** 671e22bee78STejun Heo * wq_worker_sleeping - a worker is going to sleep 672e22bee78STejun Heo * @task: task going to sleep 673e22bee78STejun Heo * @cpu: CPU in question, must be the current CPU number 674e22bee78STejun Heo * 675e22bee78STejun Heo * This function is called during schedule() when a busy worker is 676e22bee78STejun Heo * going to sleep. Worker on the same cpu can be woken up by 677e22bee78STejun Heo * returning pointer to its task. 678e22bee78STejun Heo * 679e22bee78STejun Heo * CONTEXT: 680e22bee78STejun Heo * spin_lock_irq(rq->lock) 681e22bee78STejun Heo * 682e22bee78STejun Heo * RETURNS: 683e22bee78STejun Heo * Worker task on @cpu to wake up, %NULL if none. 684e22bee78STejun Heo */ 685e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task, 686e22bee78STejun Heo unsigned int cpu) 687e22bee78STejun Heo { 688e22bee78STejun Heo struct worker *worker = kthread_data(task), *to_wakeup = NULL; 689e22bee78STejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 690e22bee78STejun Heo atomic_t *nr_running = get_gcwq_nr_running(cpu); 691e22bee78STejun Heo 6922d64672eSSteven Rostedt if (worker->flags & WORKER_NOT_RUNNING) 693e22bee78STejun Heo return NULL; 694e22bee78STejun Heo 695e22bee78STejun Heo /* this can only happen on the local cpu */ 696e22bee78STejun Heo BUG_ON(cpu != raw_smp_processor_id()); 697e22bee78STejun Heo 698e22bee78STejun Heo /* 699e22bee78STejun Heo * The counterpart of the following dec_and_test, implied mb, 700e22bee78STejun Heo * worklist not empty test sequence is in insert_work(). 701e22bee78STejun Heo * Please read comment there. 702e22bee78STejun Heo * 703e22bee78STejun Heo * NOT_RUNNING is clear. This means that trustee is not in 704e22bee78STejun Heo * charge and we're running on the local cpu w/ rq lock held 705e22bee78STejun Heo * and preemption disabled, which in turn means that none else 706e22bee78STejun Heo * could be manipulating idle_list, so dereferencing idle_list 707e22bee78STejun Heo * without gcwq lock is safe. 708e22bee78STejun Heo */ 709e22bee78STejun Heo if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist)) 710e22bee78STejun Heo to_wakeup = first_worker(gcwq); 711e22bee78STejun Heo return to_wakeup ? to_wakeup->task : NULL; 712e22bee78STejun Heo } 713e22bee78STejun Heo 714e22bee78STejun Heo /** 715e22bee78STejun Heo * worker_set_flags - set worker flags and adjust nr_running accordingly 716cb444766STejun Heo * @worker: self 717d302f017STejun Heo * @flags: flags to set 718d302f017STejun Heo * @wakeup: wakeup an idle worker if necessary 719d302f017STejun Heo * 720e22bee78STejun Heo * Set @flags in @worker->flags and adjust nr_running accordingly. If 721e22bee78STejun Heo * nr_running becomes zero and @wakeup is %true, an idle worker is 722e22bee78STejun Heo * woken up. 723d302f017STejun Heo * 724cb444766STejun Heo * CONTEXT: 725cb444766STejun Heo * spin_lock_irq(gcwq->lock) 726d302f017STejun Heo */ 727d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags, 728d302f017STejun Heo bool wakeup) 729d302f017STejun Heo { 730e22bee78STejun Heo struct global_cwq *gcwq = worker->gcwq; 731e22bee78STejun Heo 732cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 733cb444766STejun Heo 734e22bee78STejun Heo /* 735e22bee78STejun Heo * If transitioning into NOT_RUNNING, adjust nr_running and 736e22bee78STejun Heo * wake up an idle worker as necessary if requested by 737e22bee78STejun Heo * @wakeup. 738e22bee78STejun Heo */ 739e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && 740e22bee78STejun Heo !(worker->flags & WORKER_NOT_RUNNING)) { 741e22bee78STejun Heo atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu); 742e22bee78STejun Heo 743e22bee78STejun Heo if (wakeup) { 744e22bee78STejun Heo if (atomic_dec_and_test(nr_running) && 745e22bee78STejun Heo !list_empty(&gcwq->worklist)) 746e22bee78STejun Heo wake_up_worker(gcwq); 747e22bee78STejun Heo } else 748e22bee78STejun Heo atomic_dec(nr_running); 749e22bee78STejun Heo } 750e22bee78STejun Heo 751d302f017STejun Heo worker->flags |= flags; 752d302f017STejun Heo } 753d302f017STejun Heo 754d302f017STejun Heo /** 755e22bee78STejun Heo * worker_clr_flags - clear worker flags and adjust nr_running accordingly 756cb444766STejun Heo * @worker: self 757d302f017STejun Heo * @flags: flags to clear 758d302f017STejun Heo * 759e22bee78STejun Heo * Clear @flags in @worker->flags and adjust nr_running accordingly. 760d302f017STejun Heo * 761cb444766STejun Heo * CONTEXT: 762cb444766STejun Heo * spin_lock_irq(gcwq->lock) 763d302f017STejun Heo */ 764d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags) 765d302f017STejun Heo { 766e22bee78STejun Heo struct global_cwq *gcwq = worker->gcwq; 767e22bee78STejun Heo unsigned int oflags = worker->flags; 768e22bee78STejun Heo 769cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 770cb444766STejun Heo 771d302f017STejun Heo worker->flags &= ~flags; 772e22bee78STejun Heo 77342c025f3STejun Heo /* 77442c025f3STejun Heo * If transitioning out of NOT_RUNNING, increment nr_running. Note 77542c025f3STejun Heo * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask 77642c025f3STejun Heo * of multiple flags, not a single flag. 77742c025f3STejun Heo */ 778e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) 779e22bee78STejun Heo if (!(worker->flags & WORKER_NOT_RUNNING)) 780e22bee78STejun Heo atomic_inc(get_gcwq_nr_running(gcwq->cpu)); 781d302f017STejun Heo } 782d302f017STejun Heo 783d302f017STejun Heo /** 784c8e55f36STejun Heo * busy_worker_head - return the busy hash head for a work 785c8e55f36STejun Heo * @gcwq: gcwq of interest 786c8e55f36STejun Heo * @work: work to be hashed 787c8e55f36STejun Heo * 788c8e55f36STejun Heo * Return hash head of @gcwq for @work. 789c8e55f36STejun Heo * 790c8e55f36STejun Heo * CONTEXT: 791c8e55f36STejun Heo * spin_lock_irq(gcwq->lock). 792c8e55f36STejun Heo * 793c8e55f36STejun Heo * RETURNS: 794c8e55f36STejun Heo * Pointer to the hash head. 795c8e55f36STejun Heo */ 796c8e55f36STejun Heo static struct hlist_head *busy_worker_head(struct global_cwq *gcwq, 797c8e55f36STejun Heo struct work_struct *work) 798c8e55f36STejun Heo { 799c8e55f36STejun Heo const int base_shift = ilog2(sizeof(struct work_struct)); 800c8e55f36STejun Heo unsigned long v = (unsigned long)work; 801c8e55f36STejun Heo 802c8e55f36STejun Heo /* simple shift and fold hash, do we need something better? */ 803c8e55f36STejun Heo v >>= base_shift; 804c8e55f36STejun Heo v += v >> BUSY_WORKER_HASH_ORDER; 805c8e55f36STejun Heo v &= BUSY_WORKER_HASH_MASK; 806c8e55f36STejun Heo 807c8e55f36STejun Heo return &gcwq->busy_hash[v]; 808c8e55f36STejun Heo } 809c8e55f36STejun Heo 810c8e55f36STejun Heo /** 8118cca0eeaSTejun Heo * __find_worker_executing_work - find worker which is executing a work 8128cca0eeaSTejun Heo * @gcwq: gcwq of interest 8138cca0eeaSTejun Heo * @bwh: hash head as returned by busy_worker_head() 8148cca0eeaSTejun Heo * @work: work to find worker for 8158cca0eeaSTejun Heo * 8168cca0eeaSTejun Heo * Find a worker which is executing @work on @gcwq. @bwh should be 8178cca0eeaSTejun Heo * the hash head obtained by calling busy_worker_head() with the same 8188cca0eeaSTejun Heo * work. 8198cca0eeaSTejun Heo * 8208cca0eeaSTejun Heo * CONTEXT: 8218cca0eeaSTejun Heo * spin_lock_irq(gcwq->lock). 8228cca0eeaSTejun Heo * 8238cca0eeaSTejun Heo * RETURNS: 8248cca0eeaSTejun Heo * Pointer to worker which is executing @work if found, NULL 8258cca0eeaSTejun Heo * otherwise. 8268cca0eeaSTejun Heo */ 8278cca0eeaSTejun Heo static struct worker *__find_worker_executing_work(struct global_cwq *gcwq, 8288cca0eeaSTejun Heo struct hlist_head *bwh, 8298cca0eeaSTejun Heo struct work_struct *work) 8308cca0eeaSTejun Heo { 8318cca0eeaSTejun Heo struct worker *worker; 8328cca0eeaSTejun Heo struct hlist_node *tmp; 8338cca0eeaSTejun Heo 8348cca0eeaSTejun Heo hlist_for_each_entry(worker, tmp, bwh, hentry) 8358cca0eeaSTejun Heo if (worker->current_work == work) 8368cca0eeaSTejun Heo return worker; 8378cca0eeaSTejun Heo return NULL; 8388cca0eeaSTejun Heo } 8398cca0eeaSTejun Heo 8408cca0eeaSTejun Heo /** 8418cca0eeaSTejun Heo * find_worker_executing_work - find worker which is executing a work 8428cca0eeaSTejun Heo * @gcwq: gcwq of interest 8438cca0eeaSTejun Heo * @work: work to find worker for 8448cca0eeaSTejun Heo * 8458cca0eeaSTejun Heo * Find a worker which is executing @work on @gcwq. This function is 8468cca0eeaSTejun Heo * identical to __find_worker_executing_work() except that this 8478cca0eeaSTejun Heo * function calculates @bwh itself. 8488cca0eeaSTejun Heo * 8498cca0eeaSTejun Heo * CONTEXT: 8508cca0eeaSTejun Heo * spin_lock_irq(gcwq->lock). 8518cca0eeaSTejun Heo * 8528cca0eeaSTejun Heo * RETURNS: 8538cca0eeaSTejun Heo * Pointer to worker which is executing @work if found, NULL 8548cca0eeaSTejun Heo * otherwise. 8558cca0eeaSTejun Heo */ 8568cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq, 8578cca0eeaSTejun Heo struct work_struct *work) 8588cca0eeaSTejun Heo { 8598cca0eeaSTejun Heo return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work), 8608cca0eeaSTejun Heo work); 8618cca0eeaSTejun Heo } 8628cca0eeaSTejun Heo 8638cca0eeaSTejun Heo /** 864649027d7STejun Heo * gcwq_determine_ins_pos - find insertion position 865649027d7STejun Heo * @gcwq: gcwq of interest 866649027d7STejun Heo * @cwq: cwq a work is being queued for 867649027d7STejun Heo * 868649027d7STejun Heo * A work for @cwq is about to be queued on @gcwq, determine insertion 869649027d7STejun Heo * position for the work. If @cwq is for HIGHPRI wq, the work is 870649027d7STejun Heo * queued at the head of the queue but in FIFO order with respect to 871649027d7STejun Heo * other HIGHPRI works; otherwise, at the end of the queue. This 872649027d7STejun Heo * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that 873649027d7STejun Heo * there are HIGHPRI works pending. 874649027d7STejun Heo * 875649027d7STejun Heo * CONTEXT: 876649027d7STejun Heo * spin_lock_irq(gcwq->lock). 877649027d7STejun Heo * 878649027d7STejun Heo * RETURNS: 879649027d7STejun Heo * Pointer to inserstion position. 880649027d7STejun Heo */ 881649027d7STejun Heo static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq, 8821da177e4SLinus Torvalds struct cpu_workqueue_struct *cwq) 8831da177e4SLinus Torvalds { 884649027d7STejun Heo struct work_struct *twork; 8851da177e4SLinus Torvalds 886649027d7STejun Heo if (likely(!(cwq->wq->flags & WQ_HIGHPRI))) 887649027d7STejun Heo return &gcwq->worklist; 8881da177e4SLinus Torvalds 889649027d7STejun Heo list_for_each_entry(twork, &gcwq->worklist, entry) { 890649027d7STejun Heo struct cpu_workqueue_struct *tcwq = get_work_cwq(twork); 891649027d7STejun Heo 892649027d7STejun Heo if (!(tcwq->wq->flags & WQ_HIGHPRI)) 893649027d7STejun Heo break; 8941da177e4SLinus Torvalds } 8951da177e4SLinus Torvalds 896649027d7STejun Heo gcwq->flags |= GCWQ_HIGHPRI_PENDING; 897649027d7STejun Heo return &twork->entry; 898649027d7STejun Heo } 899649027d7STejun Heo 900649027d7STejun Heo /** 9017e11629dSTejun Heo * insert_work - insert a work into gcwq 9024690c4abSTejun Heo * @cwq: cwq @work belongs to 9034690c4abSTejun Heo * @work: work to insert 9044690c4abSTejun Heo * @head: insertion point 9054690c4abSTejun Heo * @extra_flags: extra WORK_STRUCT_* flags to set 9064690c4abSTejun Heo * 9077e11629dSTejun Heo * Insert @work which belongs to @cwq into @gcwq after @head. 9087e11629dSTejun Heo * @extra_flags is or'd to work_struct flags. 9094690c4abSTejun Heo * 9104690c4abSTejun Heo * CONTEXT: 9118b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock). 9121da177e4SLinus Torvalds */ 913b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq, 9144690c4abSTejun Heo struct work_struct *work, struct list_head *head, 9154690c4abSTejun Heo unsigned int extra_flags) 916b89deed3SOleg Nesterov { 917e22bee78STejun Heo struct global_cwq *gcwq = cwq->gcwq; 918e1d8aa9fSFrederic Weisbecker 9194690c4abSTejun Heo /* we own @work, set data and link */ 9207a22ad75STejun Heo set_work_cwq(work, cwq, extra_flags); 9214690c4abSTejun Heo 9226e84d644SOleg Nesterov /* 9236e84d644SOleg Nesterov * Ensure that we get the right work->data if we see the 9246e84d644SOleg Nesterov * result of list_add() below, see try_to_grab_pending(). 9256e84d644SOleg Nesterov */ 9266e84d644SOleg Nesterov smp_wmb(); 9274690c4abSTejun Heo 9281a4d9b0aSOleg Nesterov list_add_tail(&work->entry, head); 929e22bee78STejun Heo 930e22bee78STejun Heo /* 931e22bee78STejun Heo * Ensure either worker_sched_deactivated() sees the above 932e22bee78STejun Heo * list_add_tail() or we see zero nr_running to avoid workers 933e22bee78STejun Heo * lying around lazily while there are works to be processed. 934e22bee78STejun Heo */ 935e22bee78STejun Heo smp_mb(); 936e22bee78STejun Heo 937649027d7STejun Heo if (__need_more_worker(gcwq)) 938e22bee78STejun Heo wake_up_worker(gcwq); 939b89deed3SOleg Nesterov } 940b89deed3SOleg Nesterov 941c8efcc25STejun Heo /* 942c8efcc25STejun Heo * Test whether @work is being queued from another work executing on the 943c8efcc25STejun Heo * same workqueue. This is rather expensive and should only be used from 944c8efcc25STejun Heo * cold paths. 945c8efcc25STejun Heo */ 946c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq) 947c8efcc25STejun Heo { 948c8efcc25STejun Heo unsigned long flags; 949c8efcc25STejun Heo unsigned int cpu; 950c8efcc25STejun Heo 951c8efcc25STejun Heo for_each_gcwq_cpu(cpu) { 952c8efcc25STejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 953c8efcc25STejun Heo struct worker *worker; 954c8efcc25STejun Heo struct hlist_node *pos; 955c8efcc25STejun Heo int i; 956c8efcc25STejun Heo 957c8efcc25STejun Heo spin_lock_irqsave(&gcwq->lock, flags); 958c8efcc25STejun Heo for_each_busy_worker(worker, i, pos, gcwq) { 959c8efcc25STejun Heo if (worker->task != current) 960c8efcc25STejun Heo continue; 961c8efcc25STejun Heo spin_unlock_irqrestore(&gcwq->lock, flags); 962c8efcc25STejun Heo /* 963c8efcc25STejun Heo * I'm @worker, no locking necessary. See if @work 964c8efcc25STejun Heo * is headed to the same workqueue. 965c8efcc25STejun Heo */ 966c8efcc25STejun Heo return worker->current_cwq->wq == wq; 967c8efcc25STejun Heo } 968c8efcc25STejun Heo spin_unlock_irqrestore(&gcwq->lock, flags); 969c8efcc25STejun Heo } 970c8efcc25STejun Heo return false; 971c8efcc25STejun Heo } 972c8efcc25STejun Heo 9734690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq, 9741da177e4SLinus Torvalds struct work_struct *work) 9751da177e4SLinus Torvalds { 976502ca9d8STejun Heo struct global_cwq *gcwq; 977502ca9d8STejun Heo struct cpu_workqueue_struct *cwq; 9781e19ffc6STejun Heo struct list_head *worklist; 9798a2e8e5dSTejun Heo unsigned int work_flags; 9801da177e4SLinus Torvalds unsigned long flags; 9811da177e4SLinus Torvalds 982dc186ad7SThomas Gleixner debug_work_activate(work); 9831e19ffc6STejun Heo 984c8efcc25STejun Heo /* if dying, only works from the same workqueue are allowed */ 985c8efcc25STejun Heo if (unlikely(wq->flags & WQ_DYING) && 986c8efcc25STejun Heo WARN_ON_ONCE(!is_chained_work(wq))) 987e41e704bSTejun Heo return; 988e41e704bSTejun Heo 989c7fc77f7STejun Heo /* determine gcwq to use */ 990c7fc77f7STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 991c7fc77f7STejun Heo struct global_cwq *last_gcwq; 992c7fc77f7STejun Heo 993f3421797STejun Heo if (unlikely(cpu == WORK_CPU_UNBOUND)) 994f3421797STejun Heo cpu = raw_smp_processor_id(); 995f3421797STejun Heo 99618aa9effSTejun Heo /* 99718aa9effSTejun Heo * It's multi cpu. If @wq is non-reentrant and @work 99818aa9effSTejun Heo * was previously on a different cpu, it might still 99918aa9effSTejun Heo * be running there, in which case the work needs to 100018aa9effSTejun Heo * be queued on that cpu to guarantee non-reentrance. 100118aa9effSTejun Heo */ 1002502ca9d8STejun Heo gcwq = get_gcwq(cpu); 100318aa9effSTejun Heo if (wq->flags & WQ_NON_REENTRANT && 100418aa9effSTejun Heo (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) { 100518aa9effSTejun Heo struct worker *worker; 100618aa9effSTejun Heo 100718aa9effSTejun Heo spin_lock_irqsave(&last_gcwq->lock, flags); 100818aa9effSTejun Heo 100918aa9effSTejun Heo worker = find_worker_executing_work(last_gcwq, work); 101018aa9effSTejun Heo 101118aa9effSTejun Heo if (worker && worker->current_cwq->wq == wq) 101218aa9effSTejun Heo gcwq = last_gcwq; 101318aa9effSTejun Heo else { 101418aa9effSTejun Heo /* meh... not running there, queue here */ 101518aa9effSTejun Heo spin_unlock_irqrestore(&last_gcwq->lock, flags); 101618aa9effSTejun Heo spin_lock_irqsave(&gcwq->lock, flags); 101718aa9effSTejun Heo } 101818aa9effSTejun Heo } else 10198b03ae3cSTejun Heo spin_lock_irqsave(&gcwq->lock, flags); 1020f3421797STejun Heo } else { 1021f3421797STejun Heo gcwq = get_gcwq(WORK_CPU_UNBOUND); 1022f3421797STejun Heo spin_lock_irqsave(&gcwq->lock, flags); 1023502ca9d8STejun Heo } 1024502ca9d8STejun Heo 1025502ca9d8STejun Heo /* gcwq determined, get cwq and queue */ 1026502ca9d8STejun Heo cwq = get_cwq(gcwq->cpu, wq); 1027cdadf009STejun Heo trace_workqueue_queue_work(cpu, cwq, work); 1028502ca9d8STejun Heo 10294690c4abSTejun Heo BUG_ON(!list_empty(&work->entry)); 10301e19ffc6STejun Heo 103173f53c4aSTejun Heo cwq->nr_in_flight[cwq->work_color]++; 10328a2e8e5dSTejun Heo work_flags = work_color_to_flags(cwq->work_color); 10331e19ffc6STejun Heo 10341e19ffc6STejun Heo if (likely(cwq->nr_active < cwq->max_active)) { 1035cdadf009STejun Heo trace_workqueue_activate_work(work); 10361e19ffc6STejun Heo cwq->nr_active++; 1037649027d7STejun Heo worklist = gcwq_determine_ins_pos(gcwq, cwq); 10388a2e8e5dSTejun Heo } else { 10398a2e8e5dSTejun Heo work_flags |= WORK_STRUCT_DELAYED; 10401e19ffc6STejun Heo worklist = &cwq->delayed_works; 10418a2e8e5dSTejun Heo } 10421e19ffc6STejun Heo 10438a2e8e5dSTejun Heo insert_work(cwq, work, worklist, work_flags); 10441e19ffc6STejun Heo 10458b03ae3cSTejun Heo spin_unlock_irqrestore(&gcwq->lock, flags); 10461da177e4SLinus Torvalds } 10471da177e4SLinus Torvalds 10480fcb78c2SRolf Eike Beer /** 10490fcb78c2SRolf Eike Beer * queue_work - queue work on a workqueue 10500fcb78c2SRolf Eike Beer * @wq: workqueue to use 10510fcb78c2SRolf Eike Beer * @work: work to queue 10520fcb78c2SRolf Eike Beer * 1053057647fcSAlan Stern * Returns 0 if @work was already on a queue, non-zero otherwise. 10541da177e4SLinus Torvalds * 105500dfcaf7SOleg Nesterov * We queue the work to the CPU on which it was submitted, but if the CPU dies 105600dfcaf7SOleg Nesterov * it can be processed by another CPU. 10571da177e4SLinus Torvalds */ 10587ad5b3a5SHarvey Harrison int queue_work(struct workqueue_struct *wq, struct work_struct *work) 10591da177e4SLinus Torvalds { 1060ef1ca236SOleg Nesterov int ret; 10611da177e4SLinus Torvalds 1062ef1ca236SOleg Nesterov ret = queue_work_on(get_cpu(), wq, work); 1063a848e3b6SOleg Nesterov put_cpu(); 1064ef1ca236SOleg Nesterov 10651da177e4SLinus Torvalds return ret; 10661da177e4SLinus Torvalds } 1067ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_work); 10681da177e4SLinus Torvalds 1069c1a220e7SZhang Rui /** 1070c1a220e7SZhang Rui * queue_work_on - queue work on specific cpu 1071c1a220e7SZhang Rui * @cpu: CPU number to execute work on 1072c1a220e7SZhang Rui * @wq: workqueue to use 1073c1a220e7SZhang Rui * @work: work to queue 1074c1a220e7SZhang Rui * 1075c1a220e7SZhang Rui * Returns 0 if @work was already on a queue, non-zero otherwise. 1076c1a220e7SZhang Rui * 1077c1a220e7SZhang Rui * We queue the work to a specific CPU, the caller must ensure it 1078c1a220e7SZhang Rui * can't go away. 1079c1a220e7SZhang Rui */ 1080c1a220e7SZhang Rui int 1081c1a220e7SZhang Rui queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work) 1082c1a220e7SZhang Rui { 1083c1a220e7SZhang Rui int ret = 0; 1084c1a220e7SZhang Rui 108522df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 10864690c4abSTejun Heo __queue_work(cpu, wq, work); 1087c1a220e7SZhang Rui ret = 1; 1088c1a220e7SZhang Rui } 1089c1a220e7SZhang Rui return ret; 1090c1a220e7SZhang Rui } 1091c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on); 1092c1a220e7SZhang Rui 10936d141c3fSLi Zefan static void delayed_work_timer_fn(unsigned long __data) 10941da177e4SLinus Torvalds { 109552bad64dSDavid Howells struct delayed_work *dwork = (struct delayed_work *)__data; 10967a22ad75STejun Heo struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work); 10971da177e4SLinus Torvalds 10984690c4abSTejun Heo __queue_work(smp_processor_id(), cwq->wq, &dwork->work); 10991da177e4SLinus Torvalds } 11001da177e4SLinus Torvalds 11010fcb78c2SRolf Eike Beer /** 11020fcb78c2SRolf Eike Beer * queue_delayed_work - queue work on a workqueue after delay 11030fcb78c2SRolf Eike Beer * @wq: workqueue to use 1104af9997e4SRandy Dunlap * @dwork: delayable work to queue 11050fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 11060fcb78c2SRolf Eike Beer * 1107057647fcSAlan Stern * Returns 0 if @work was already on a queue, non-zero otherwise. 11080fcb78c2SRolf Eike Beer */ 11097ad5b3a5SHarvey Harrison int queue_delayed_work(struct workqueue_struct *wq, 111052bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 11111da177e4SLinus Torvalds { 111252bad64dSDavid Howells if (delay == 0) 111363bc0362SOleg Nesterov return queue_work(wq, &dwork->work); 11141da177e4SLinus Torvalds 111563bc0362SOleg Nesterov return queue_delayed_work_on(-1, wq, dwork, delay); 11161da177e4SLinus Torvalds } 1117ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work); 11181da177e4SLinus Torvalds 11190fcb78c2SRolf Eike Beer /** 11200fcb78c2SRolf Eike Beer * queue_delayed_work_on - queue work on specific CPU after delay 11210fcb78c2SRolf Eike Beer * @cpu: CPU number to execute work on 11220fcb78c2SRolf Eike Beer * @wq: workqueue to use 1123af9997e4SRandy Dunlap * @dwork: work to queue 11240fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 11250fcb78c2SRolf Eike Beer * 1126057647fcSAlan Stern * Returns 0 if @work was already on a queue, non-zero otherwise. 11270fcb78c2SRolf Eike Beer */ 11287a6bc1cdSVenkatesh Pallipadi int queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 112952bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 11307a6bc1cdSVenkatesh Pallipadi { 11317a6bc1cdSVenkatesh Pallipadi int ret = 0; 113252bad64dSDavid Howells struct timer_list *timer = &dwork->timer; 113352bad64dSDavid Howells struct work_struct *work = &dwork->work; 11347a6bc1cdSVenkatesh Pallipadi 113522df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 1136c7fc77f7STejun Heo unsigned int lcpu; 11377a22ad75STejun Heo 11387a6bc1cdSVenkatesh Pallipadi BUG_ON(timer_pending(timer)); 11397a6bc1cdSVenkatesh Pallipadi BUG_ON(!list_empty(&work->entry)); 11407a6bc1cdSVenkatesh Pallipadi 11418a3e77ccSAndrew Liu timer_stats_timer_set_start_info(&dwork->timer); 11428a3e77ccSAndrew Liu 11437a22ad75STejun Heo /* 11447a22ad75STejun Heo * This stores cwq for the moment, for the timer_fn. 11457a22ad75STejun Heo * Note that the work's gcwq is preserved to allow 11467a22ad75STejun Heo * reentrance detection for delayed works. 11477a22ad75STejun Heo */ 1148c7fc77f7STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 1149c7fc77f7STejun Heo struct global_cwq *gcwq = get_work_gcwq(work); 1150c7fc77f7STejun Heo 1151c7fc77f7STejun Heo if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND) 1152c7fc77f7STejun Heo lcpu = gcwq->cpu; 1153c7fc77f7STejun Heo else 1154c7fc77f7STejun Heo lcpu = raw_smp_processor_id(); 1155c7fc77f7STejun Heo } else 1156c7fc77f7STejun Heo lcpu = WORK_CPU_UNBOUND; 1157c7fc77f7STejun Heo 11587a22ad75STejun Heo set_work_cwq(work, get_cwq(lcpu, wq), 0); 1159c7fc77f7STejun Heo 11607a6bc1cdSVenkatesh Pallipadi timer->expires = jiffies + delay; 116152bad64dSDavid Howells timer->data = (unsigned long)dwork; 11627a6bc1cdSVenkatesh Pallipadi timer->function = delayed_work_timer_fn; 116363bc0362SOleg Nesterov 116463bc0362SOleg Nesterov if (unlikely(cpu >= 0)) 11657a6bc1cdSVenkatesh Pallipadi add_timer_on(timer, cpu); 116663bc0362SOleg Nesterov else 116763bc0362SOleg Nesterov add_timer(timer); 11687a6bc1cdSVenkatesh Pallipadi ret = 1; 11697a6bc1cdSVenkatesh Pallipadi } 11707a6bc1cdSVenkatesh Pallipadi return ret; 11717a6bc1cdSVenkatesh Pallipadi } 1172ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on); 11731da177e4SLinus Torvalds 1174c8e55f36STejun Heo /** 1175c8e55f36STejun Heo * worker_enter_idle - enter idle state 1176c8e55f36STejun Heo * @worker: worker which is entering idle state 1177c8e55f36STejun Heo * 1178c8e55f36STejun Heo * @worker is entering idle state. Update stats and idle timer if 1179c8e55f36STejun Heo * necessary. 1180c8e55f36STejun Heo * 1181c8e55f36STejun Heo * LOCKING: 1182c8e55f36STejun Heo * spin_lock_irq(gcwq->lock). 1183c8e55f36STejun Heo */ 1184c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker) 11851da177e4SLinus Torvalds { 1186c8e55f36STejun Heo struct global_cwq *gcwq = worker->gcwq; 1187c8e55f36STejun Heo 1188c8e55f36STejun Heo BUG_ON(worker->flags & WORKER_IDLE); 1189c8e55f36STejun Heo BUG_ON(!list_empty(&worker->entry) && 1190c8e55f36STejun Heo (worker->hentry.next || worker->hentry.pprev)); 1191c8e55f36STejun Heo 1192cb444766STejun Heo /* can't use worker_set_flags(), also called from start_worker() */ 1193cb444766STejun Heo worker->flags |= WORKER_IDLE; 1194c8e55f36STejun Heo gcwq->nr_idle++; 1195e22bee78STejun Heo worker->last_active = jiffies; 1196c8e55f36STejun Heo 1197c8e55f36STejun Heo /* idle_list is LIFO */ 1198c8e55f36STejun Heo list_add(&worker->entry, &gcwq->idle_list); 1199db7bccf4STejun Heo 1200e22bee78STejun Heo if (likely(!(worker->flags & WORKER_ROGUE))) { 1201e22bee78STejun Heo if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer)) 1202e22bee78STejun Heo mod_timer(&gcwq->idle_timer, 1203e22bee78STejun Heo jiffies + IDLE_WORKER_TIMEOUT); 1204e22bee78STejun Heo } else 1205db7bccf4STejun Heo wake_up_all(&gcwq->trustee_wait); 1206cb444766STejun Heo 1207cb444766STejun Heo /* sanity check nr_running */ 1208cb444766STejun Heo WARN_ON_ONCE(gcwq->nr_workers == gcwq->nr_idle && 1209cb444766STejun Heo atomic_read(get_gcwq_nr_running(gcwq->cpu))); 1210c8e55f36STejun Heo } 1211c8e55f36STejun Heo 1212c8e55f36STejun Heo /** 1213c8e55f36STejun Heo * worker_leave_idle - leave idle state 1214c8e55f36STejun Heo * @worker: worker which is leaving idle state 1215c8e55f36STejun Heo * 1216c8e55f36STejun Heo * @worker is leaving idle state. Update stats. 1217c8e55f36STejun Heo * 1218c8e55f36STejun Heo * LOCKING: 1219c8e55f36STejun Heo * spin_lock_irq(gcwq->lock). 1220c8e55f36STejun Heo */ 1221c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker) 1222c8e55f36STejun Heo { 1223c8e55f36STejun Heo struct global_cwq *gcwq = worker->gcwq; 1224c8e55f36STejun Heo 1225c8e55f36STejun Heo BUG_ON(!(worker->flags & WORKER_IDLE)); 1226d302f017STejun Heo worker_clr_flags(worker, WORKER_IDLE); 1227c8e55f36STejun Heo gcwq->nr_idle--; 1228c8e55f36STejun Heo list_del_init(&worker->entry); 1229c8e55f36STejun Heo } 1230c8e55f36STejun Heo 1231e22bee78STejun Heo /** 1232e22bee78STejun Heo * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq 1233e22bee78STejun Heo * @worker: self 1234e22bee78STejun Heo * 1235e22bee78STejun Heo * Works which are scheduled while the cpu is online must at least be 1236e22bee78STejun Heo * scheduled to a worker which is bound to the cpu so that if they are 1237e22bee78STejun Heo * flushed from cpu callbacks while cpu is going down, they are 1238e22bee78STejun Heo * guaranteed to execute on the cpu. 1239e22bee78STejun Heo * 1240e22bee78STejun Heo * This function is to be used by rogue workers and rescuers to bind 1241e22bee78STejun Heo * themselves to the target cpu and may race with cpu going down or 1242e22bee78STejun Heo * coming online. kthread_bind() can't be used because it may put the 1243e22bee78STejun Heo * worker to already dead cpu and set_cpus_allowed_ptr() can't be used 1244e22bee78STejun Heo * verbatim as it's best effort and blocking and gcwq may be 1245e22bee78STejun Heo * [dis]associated in the meantime. 1246e22bee78STejun Heo * 1247e22bee78STejun Heo * This function tries set_cpus_allowed() and locks gcwq and verifies 1248e22bee78STejun Heo * the binding against GCWQ_DISASSOCIATED which is set during 1249e22bee78STejun Heo * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters 1250e22bee78STejun Heo * idle state or fetches works without dropping lock, it can guarantee 1251e22bee78STejun Heo * the scheduling requirement described in the first paragraph. 1252e22bee78STejun Heo * 1253e22bee78STejun Heo * CONTEXT: 1254e22bee78STejun Heo * Might sleep. Called without any lock but returns with gcwq->lock 1255e22bee78STejun Heo * held. 1256e22bee78STejun Heo * 1257e22bee78STejun Heo * RETURNS: 1258e22bee78STejun Heo * %true if the associated gcwq is online (@worker is successfully 1259e22bee78STejun Heo * bound), %false if offline. 1260e22bee78STejun Heo */ 1261e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker) 1262972fa1c5SNamhyung Kim __acquires(&gcwq->lock) 1263e22bee78STejun Heo { 1264e22bee78STejun Heo struct global_cwq *gcwq = worker->gcwq; 1265e22bee78STejun Heo struct task_struct *task = worker->task; 1266e22bee78STejun Heo 1267e22bee78STejun Heo while (true) { 1268e22bee78STejun Heo /* 1269e22bee78STejun Heo * The following call may fail, succeed or succeed 1270e22bee78STejun Heo * without actually migrating the task to the cpu if 1271e22bee78STejun Heo * it races with cpu hotunplug operation. Verify 1272e22bee78STejun Heo * against GCWQ_DISASSOCIATED. 1273e22bee78STejun Heo */ 1274f3421797STejun Heo if (!(gcwq->flags & GCWQ_DISASSOCIATED)) 1275e22bee78STejun Heo set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu)); 1276e22bee78STejun Heo 1277e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 1278e22bee78STejun Heo if (gcwq->flags & GCWQ_DISASSOCIATED) 1279e22bee78STejun Heo return false; 1280e22bee78STejun Heo if (task_cpu(task) == gcwq->cpu && 1281e22bee78STejun Heo cpumask_equal(¤t->cpus_allowed, 1282e22bee78STejun Heo get_cpu_mask(gcwq->cpu))) 1283e22bee78STejun Heo return true; 1284e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 1285e22bee78STejun Heo 1286e22bee78STejun Heo /* CPU has come up inbetween, retry migration */ 1287e22bee78STejun Heo cpu_relax(); 1288e22bee78STejun Heo } 1289e22bee78STejun Heo } 1290e22bee78STejun Heo 1291e22bee78STejun Heo /* 1292e22bee78STejun Heo * Function for worker->rebind_work used to rebind rogue busy workers 1293e22bee78STejun Heo * to the associated cpu which is coming back online. This is 1294e22bee78STejun Heo * scheduled by cpu up but can race with other cpu hotplug operations 1295e22bee78STejun Heo * and may be executed twice without intervening cpu down. 1296e22bee78STejun Heo */ 1297e22bee78STejun Heo static void worker_rebind_fn(struct work_struct *work) 1298e22bee78STejun Heo { 1299e22bee78STejun Heo struct worker *worker = container_of(work, struct worker, rebind_work); 1300e22bee78STejun Heo struct global_cwq *gcwq = worker->gcwq; 1301e22bee78STejun Heo 1302e22bee78STejun Heo if (worker_maybe_bind_and_lock(worker)) 1303e22bee78STejun Heo worker_clr_flags(worker, WORKER_REBIND); 1304e22bee78STejun Heo 1305e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 1306e22bee78STejun Heo } 1307e22bee78STejun Heo 1308c34056a3STejun Heo static struct worker *alloc_worker(void) 1309c34056a3STejun Heo { 1310c34056a3STejun Heo struct worker *worker; 1311c34056a3STejun Heo 1312c34056a3STejun Heo worker = kzalloc(sizeof(*worker), GFP_KERNEL); 1313c8e55f36STejun Heo if (worker) { 1314c8e55f36STejun Heo INIT_LIST_HEAD(&worker->entry); 1315affee4b2STejun Heo INIT_LIST_HEAD(&worker->scheduled); 1316e22bee78STejun Heo INIT_WORK(&worker->rebind_work, worker_rebind_fn); 1317e22bee78STejun Heo /* on creation a worker is in !idle && prep state */ 1318e22bee78STejun Heo worker->flags = WORKER_PREP; 1319c8e55f36STejun Heo } 1320c34056a3STejun Heo return worker; 1321c34056a3STejun Heo } 1322c34056a3STejun Heo 1323c34056a3STejun Heo /** 1324c34056a3STejun Heo * create_worker - create a new workqueue worker 13257e11629dSTejun Heo * @gcwq: gcwq the new worker will belong to 1326c34056a3STejun Heo * @bind: whether to set affinity to @cpu or not 1327c34056a3STejun Heo * 13287e11629dSTejun Heo * Create a new worker which is bound to @gcwq. The returned worker 1329c34056a3STejun Heo * can be started by calling start_worker() or destroyed using 1330c34056a3STejun Heo * destroy_worker(). 1331c34056a3STejun Heo * 1332c34056a3STejun Heo * CONTEXT: 1333c34056a3STejun Heo * Might sleep. Does GFP_KERNEL allocations. 1334c34056a3STejun Heo * 1335c34056a3STejun Heo * RETURNS: 1336c34056a3STejun Heo * Pointer to the newly created worker. 1337c34056a3STejun Heo */ 13387e11629dSTejun Heo static struct worker *create_worker(struct global_cwq *gcwq, bool bind) 1339c34056a3STejun Heo { 1340f3421797STejun Heo bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND; 1341c34056a3STejun Heo struct worker *worker = NULL; 1342f3421797STejun Heo int id = -1; 1343c34056a3STejun Heo 13448b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 13458b03ae3cSTejun Heo while (ida_get_new(&gcwq->worker_ida, &id)) { 13468b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 13478b03ae3cSTejun Heo if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL)) 1348c34056a3STejun Heo goto fail; 13498b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 1350c34056a3STejun Heo } 13518b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 1352c34056a3STejun Heo 1353c34056a3STejun Heo worker = alloc_worker(); 1354c34056a3STejun Heo if (!worker) 1355c34056a3STejun Heo goto fail; 1356c34056a3STejun Heo 13578b03ae3cSTejun Heo worker->gcwq = gcwq; 1358c34056a3STejun Heo worker->id = id; 1359c34056a3STejun Heo 1360f3421797STejun Heo if (!on_unbound_cpu) 1361f3421797STejun Heo worker->task = kthread_create(worker_thread, worker, 1362f3421797STejun Heo "kworker/%u:%d", gcwq->cpu, id); 1363f3421797STejun Heo else 1364f3421797STejun Heo worker->task = kthread_create(worker_thread, worker, 1365f3421797STejun Heo "kworker/u:%d", id); 1366c34056a3STejun Heo if (IS_ERR(worker->task)) 1367c34056a3STejun Heo goto fail; 1368c34056a3STejun Heo 1369db7bccf4STejun Heo /* 1370db7bccf4STejun Heo * A rogue worker will become a regular one if CPU comes 1371db7bccf4STejun Heo * online later on. Make sure every worker has 1372db7bccf4STejun Heo * PF_THREAD_BOUND set. 1373db7bccf4STejun Heo */ 1374f3421797STejun Heo if (bind && !on_unbound_cpu) 13758b03ae3cSTejun Heo kthread_bind(worker->task, gcwq->cpu); 1376f3421797STejun Heo else { 1377db7bccf4STejun Heo worker->task->flags |= PF_THREAD_BOUND; 1378f3421797STejun Heo if (on_unbound_cpu) 1379f3421797STejun Heo worker->flags |= WORKER_UNBOUND; 1380f3421797STejun Heo } 1381c34056a3STejun Heo 1382c34056a3STejun Heo return worker; 1383c34056a3STejun Heo fail: 1384c34056a3STejun Heo if (id >= 0) { 13858b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 13868b03ae3cSTejun Heo ida_remove(&gcwq->worker_ida, id); 13878b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 1388c34056a3STejun Heo } 1389c34056a3STejun Heo kfree(worker); 1390c34056a3STejun Heo return NULL; 1391c34056a3STejun Heo } 1392c34056a3STejun Heo 1393c34056a3STejun Heo /** 1394c34056a3STejun Heo * start_worker - start a newly created worker 1395c34056a3STejun Heo * @worker: worker to start 1396c34056a3STejun Heo * 1397c8e55f36STejun Heo * Make the gcwq aware of @worker and start it. 1398c34056a3STejun Heo * 1399c34056a3STejun Heo * CONTEXT: 14008b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock). 1401c34056a3STejun Heo */ 1402c34056a3STejun Heo static void start_worker(struct worker *worker) 1403c34056a3STejun Heo { 1404cb444766STejun Heo worker->flags |= WORKER_STARTED; 1405c8e55f36STejun Heo worker->gcwq->nr_workers++; 1406c8e55f36STejun Heo worker_enter_idle(worker); 1407c34056a3STejun Heo wake_up_process(worker->task); 1408c34056a3STejun Heo } 1409c34056a3STejun Heo 1410c34056a3STejun Heo /** 1411c34056a3STejun Heo * destroy_worker - destroy a workqueue worker 1412c34056a3STejun Heo * @worker: worker to be destroyed 1413c34056a3STejun Heo * 1414c8e55f36STejun Heo * Destroy @worker and adjust @gcwq stats accordingly. 1415c8e55f36STejun Heo * 1416c8e55f36STejun Heo * CONTEXT: 1417c8e55f36STejun Heo * spin_lock_irq(gcwq->lock) which is released and regrabbed. 1418c34056a3STejun Heo */ 1419c34056a3STejun Heo static void destroy_worker(struct worker *worker) 1420c34056a3STejun Heo { 14218b03ae3cSTejun Heo struct global_cwq *gcwq = worker->gcwq; 1422c34056a3STejun Heo int id = worker->id; 1423c34056a3STejun Heo 1424c34056a3STejun Heo /* sanity check frenzy */ 1425c34056a3STejun Heo BUG_ON(worker->current_work); 1426affee4b2STejun Heo BUG_ON(!list_empty(&worker->scheduled)); 1427c34056a3STejun Heo 1428c8e55f36STejun Heo if (worker->flags & WORKER_STARTED) 1429c8e55f36STejun Heo gcwq->nr_workers--; 1430c8e55f36STejun Heo if (worker->flags & WORKER_IDLE) 1431c8e55f36STejun Heo gcwq->nr_idle--; 1432c8e55f36STejun Heo 1433c8e55f36STejun Heo list_del_init(&worker->entry); 1434cb444766STejun Heo worker->flags |= WORKER_DIE; 1435c8e55f36STejun Heo 1436c8e55f36STejun Heo spin_unlock_irq(&gcwq->lock); 1437c8e55f36STejun Heo 1438c34056a3STejun Heo kthread_stop(worker->task); 1439c34056a3STejun Heo kfree(worker); 1440c34056a3STejun Heo 14418b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 14428b03ae3cSTejun Heo ida_remove(&gcwq->worker_ida, id); 1443c34056a3STejun Heo } 1444c34056a3STejun Heo 1445e22bee78STejun Heo static void idle_worker_timeout(unsigned long __gcwq) 1446e22bee78STejun Heo { 1447e22bee78STejun Heo struct global_cwq *gcwq = (void *)__gcwq; 1448e22bee78STejun Heo 1449e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 1450e22bee78STejun Heo 1451e22bee78STejun Heo if (too_many_workers(gcwq)) { 1452e22bee78STejun Heo struct worker *worker; 1453e22bee78STejun Heo unsigned long expires; 1454e22bee78STejun Heo 1455e22bee78STejun Heo /* idle_list is kept in LIFO order, check the last one */ 1456e22bee78STejun Heo worker = list_entry(gcwq->idle_list.prev, struct worker, entry); 1457e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 1458e22bee78STejun Heo 1459e22bee78STejun Heo if (time_before(jiffies, expires)) 1460e22bee78STejun Heo mod_timer(&gcwq->idle_timer, expires); 1461e22bee78STejun Heo else { 1462e22bee78STejun Heo /* it's been idle for too long, wake up manager */ 1463e22bee78STejun Heo gcwq->flags |= GCWQ_MANAGE_WORKERS; 1464e22bee78STejun Heo wake_up_worker(gcwq); 1465e22bee78STejun Heo } 1466e22bee78STejun Heo } 1467e22bee78STejun Heo 1468e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 1469e22bee78STejun Heo } 1470e22bee78STejun Heo 1471e22bee78STejun Heo static bool send_mayday(struct work_struct *work) 1472e22bee78STejun Heo { 1473e22bee78STejun Heo struct cpu_workqueue_struct *cwq = get_work_cwq(work); 1474e22bee78STejun Heo struct workqueue_struct *wq = cwq->wq; 1475f3421797STejun Heo unsigned int cpu; 1476e22bee78STejun Heo 1477e22bee78STejun Heo if (!(wq->flags & WQ_RESCUER)) 1478e22bee78STejun Heo return false; 1479e22bee78STejun Heo 1480e22bee78STejun Heo /* mayday mayday mayday */ 1481f3421797STejun Heo cpu = cwq->gcwq->cpu; 1482f3421797STejun Heo /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */ 1483f3421797STejun Heo if (cpu == WORK_CPU_UNBOUND) 1484f3421797STejun Heo cpu = 0; 1485f2e005aaSTejun Heo if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask)) 1486e22bee78STejun Heo wake_up_process(wq->rescuer->task); 1487e22bee78STejun Heo return true; 1488e22bee78STejun Heo } 1489e22bee78STejun Heo 1490e22bee78STejun Heo static void gcwq_mayday_timeout(unsigned long __gcwq) 1491e22bee78STejun Heo { 1492e22bee78STejun Heo struct global_cwq *gcwq = (void *)__gcwq; 1493e22bee78STejun Heo struct work_struct *work; 1494e22bee78STejun Heo 1495e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 1496e22bee78STejun Heo 1497e22bee78STejun Heo if (need_to_create_worker(gcwq)) { 1498e22bee78STejun Heo /* 1499e22bee78STejun Heo * We've been trying to create a new worker but 1500e22bee78STejun Heo * haven't been successful. We might be hitting an 1501e22bee78STejun Heo * allocation deadlock. Send distress signals to 1502e22bee78STejun Heo * rescuers. 1503e22bee78STejun Heo */ 1504e22bee78STejun Heo list_for_each_entry(work, &gcwq->worklist, entry) 1505e22bee78STejun Heo send_mayday(work); 1506e22bee78STejun Heo } 1507e22bee78STejun Heo 1508e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 1509e22bee78STejun Heo 1510e22bee78STejun Heo mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL); 1511e22bee78STejun Heo } 1512e22bee78STejun Heo 1513e22bee78STejun Heo /** 1514e22bee78STejun Heo * maybe_create_worker - create a new worker if necessary 1515e22bee78STejun Heo * @gcwq: gcwq to create a new worker for 1516e22bee78STejun Heo * 1517e22bee78STejun Heo * Create a new worker for @gcwq if necessary. @gcwq is guaranteed to 1518e22bee78STejun Heo * have at least one idle worker on return from this function. If 1519e22bee78STejun Heo * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is 1520e22bee78STejun Heo * sent to all rescuers with works scheduled on @gcwq to resolve 1521e22bee78STejun Heo * possible allocation deadlock. 1522e22bee78STejun Heo * 1523e22bee78STejun Heo * On return, need_to_create_worker() is guaranteed to be false and 1524e22bee78STejun Heo * may_start_working() true. 1525e22bee78STejun Heo * 1526e22bee78STejun Heo * LOCKING: 1527e22bee78STejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 1528e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. Called only from 1529e22bee78STejun Heo * manager. 1530e22bee78STejun Heo * 1531e22bee78STejun Heo * RETURNS: 1532e22bee78STejun Heo * false if no action was taken and gcwq->lock stayed locked, true 1533e22bee78STejun Heo * otherwise. 1534e22bee78STejun Heo */ 1535e22bee78STejun Heo static bool maybe_create_worker(struct global_cwq *gcwq) 153606bd6ebfSNamhyung Kim __releases(&gcwq->lock) 153706bd6ebfSNamhyung Kim __acquires(&gcwq->lock) 1538e22bee78STejun Heo { 1539e22bee78STejun Heo if (!need_to_create_worker(gcwq)) 1540e22bee78STejun Heo return false; 1541e22bee78STejun Heo restart: 15429f9c2364STejun Heo spin_unlock_irq(&gcwq->lock); 15439f9c2364STejun Heo 1544e22bee78STejun Heo /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ 1545e22bee78STejun Heo mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); 1546e22bee78STejun Heo 1547e22bee78STejun Heo while (true) { 1548e22bee78STejun Heo struct worker *worker; 1549e22bee78STejun Heo 1550e22bee78STejun Heo worker = create_worker(gcwq, true); 1551e22bee78STejun Heo if (worker) { 1552e22bee78STejun Heo del_timer_sync(&gcwq->mayday_timer); 1553e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 1554e22bee78STejun Heo start_worker(worker); 1555e22bee78STejun Heo BUG_ON(need_to_create_worker(gcwq)); 1556e22bee78STejun Heo return true; 1557e22bee78STejun Heo } 1558e22bee78STejun Heo 1559e22bee78STejun Heo if (!need_to_create_worker(gcwq)) 1560e22bee78STejun Heo break; 1561e22bee78STejun Heo 1562e22bee78STejun Heo __set_current_state(TASK_INTERRUPTIBLE); 1563e22bee78STejun Heo schedule_timeout(CREATE_COOLDOWN); 15649f9c2364STejun Heo 1565e22bee78STejun Heo if (!need_to_create_worker(gcwq)) 1566e22bee78STejun Heo break; 1567e22bee78STejun Heo } 1568e22bee78STejun Heo 1569e22bee78STejun Heo del_timer_sync(&gcwq->mayday_timer); 1570e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 1571e22bee78STejun Heo if (need_to_create_worker(gcwq)) 1572e22bee78STejun Heo goto restart; 1573e22bee78STejun Heo return true; 1574e22bee78STejun Heo } 1575e22bee78STejun Heo 1576e22bee78STejun Heo /** 1577e22bee78STejun Heo * maybe_destroy_worker - destroy workers which have been idle for a while 1578e22bee78STejun Heo * @gcwq: gcwq to destroy workers for 1579e22bee78STejun Heo * 1580e22bee78STejun Heo * Destroy @gcwq workers which have been idle for longer than 1581e22bee78STejun Heo * IDLE_WORKER_TIMEOUT. 1582e22bee78STejun Heo * 1583e22bee78STejun Heo * LOCKING: 1584e22bee78STejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 1585e22bee78STejun Heo * multiple times. Called only from manager. 1586e22bee78STejun Heo * 1587e22bee78STejun Heo * RETURNS: 1588e22bee78STejun Heo * false if no action was taken and gcwq->lock stayed locked, true 1589e22bee78STejun Heo * otherwise. 1590e22bee78STejun Heo */ 1591e22bee78STejun Heo static bool maybe_destroy_workers(struct global_cwq *gcwq) 1592e22bee78STejun Heo { 1593e22bee78STejun Heo bool ret = false; 1594e22bee78STejun Heo 1595e22bee78STejun Heo while (too_many_workers(gcwq)) { 1596e22bee78STejun Heo struct worker *worker; 1597e22bee78STejun Heo unsigned long expires; 1598e22bee78STejun Heo 1599e22bee78STejun Heo worker = list_entry(gcwq->idle_list.prev, struct worker, entry); 1600e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 1601e22bee78STejun Heo 1602e22bee78STejun Heo if (time_before(jiffies, expires)) { 1603e22bee78STejun Heo mod_timer(&gcwq->idle_timer, expires); 1604e22bee78STejun Heo break; 1605e22bee78STejun Heo } 1606e22bee78STejun Heo 1607e22bee78STejun Heo destroy_worker(worker); 1608e22bee78STejun Heo ret = true; 1609e22bee78STejun Heo } 1610e22bee78STejun Heo 1611e22bee78STejun Heo return ret; 1612e22bee78STejun Heo } 1613e22bee78STejun Heo 1614e22bee78STejun Heo /** 1615e22bee78STejun Heo * manage_workers - manage worker pool 1616e22bee78STejun Heo * @worker: self 1617e22bee78STejun Heo * 1618e22bee78STejun Heo * Assume the manager role and manage gcwq worker pool @worker belongs 1619e22bee78STejun Heo * to. At any given time, there can be only zero or one manager per 1620e22bee78STejun Heo * gcwq. The exclusion is handled automatically by this function. 1621e22bee78STejun Heo * 1622e22bee78STejun Heo * The caller can safely start processing works on false return. On 1623e22bee78STejun Heo * true return, it's guaranteed that need_to_create_worker() is false 1624e22bee78STejun Heo * and may_start_working() is true. 1625e22bee78STejun Heo * 1626e22bee78STejun Heo * CONTEXT: 1627e22bee78STejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 1628e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. 1629e22bee78STejun Heo * 1630e22bee78STejun Heo * RETURNS: 1631e22bee78STejun Heo * false if no action was taken and gcwq->lock stayed locked, true if 1632e22bee78STejun Heo * some action was taken. 1633e22bee78STejun Heo */ 1634e22bee78STejun Heo static bool manage_workers(struct worker *worker) 1635e22bee78STejun Heo { 1636e22bee78STejun Heo struct global_cwq *gcwq = worker->gcwq; 1637e22bee78STejun Heo bool ret = false; 1638e22bee78STejun Heo 1639e22bee78STejun Heo if (gcwq->flags & GCWQ_MANAGING_WORKERS) 1640e22bee78STejun Heo return ret; 1641e22bee78STejun Heo 1642e22bee78STejun Heo gcwq->flags &= ~GCWQ_MANAGE_WORKERS; 1643e22bee78STejun Heo gcwq->flags |= GCWQ_MANAGING_WORKERS; 1644e22bee78STejun Heo 1645e22bee78STejun Heo /* 1646e22bee78STejun Heo * Destroy and then create so that may_start_working() is true 1647e22bee78STejun Heo * on return. 1648e22bee78STejun Heo */ 1649e22bee78STejun Heo ret |= maybe_destroy_workers(gcwq); 1650e22bee78STejun Heo ret |= maybe_create_worker(gcwq); 1651e22bee78STejun Heo 1652e22bee78STejun Heo gcwq->flags &= ~GCWQ_MANAGING_WORKERS; 1653e22bee78STejun Heo 1654e22bee78STejun Heo /* 1655e22bee78STejun Heo * The trustee might be waiting to take over the manager 1656e22bee78STejun Heo * position, tell it we're done. 1657e22bee78STejun Heo */ 1658e22bee78STejun Heo if (unlikely(gcwq->trustee)) 1659e22bee78STejun Heo wake_up_all(&gcwq->trustee_wait); 1660e22bee78STejun Heo 1661e22bee78STejun Heo return ret; 1662e22bee78STejun Heo } 1663e22bee78STejun Heo 1664a62428c0STejun Heo /** 1665affee4b2STejun Heo * move_linked_works - move linked works to a list 1666affee4b2STejun Heo * @work: start of series of works to be scheduled 1667affee4b2STejun Heo * @head: target list to append @work to 1668affee4b2STejun Heo * @nextp: out paramter for nested worklist walking 1669affee4b2STejun Heo * 1670affee4b2STejun Heo * Schedule linked works starting from @work to @head. Work series to 1671affee4b2STejun Heo * be scheduled starts at @work and includes any consecutive work with 1672affee4b2STejun Heo * WORK_STRUCT_LINKED set in its predecessor. 1673affee4b2STejun Heo * 1674affee4b2STejun Heo * If @nextp is not NULL, it's updated to point to the next work of 1675affee4b2STejun Heo * the last scheduled work. This allows move_linked_works() to be 1676affee4b2STejun Heo * nested inside outer list_for_each_entry_safe(). 1677affee4b2STejun Heo * 1678affee4b2STejun Heo * CONTEXT: 16798b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock). 1680affee4b2STejun Heo */ 1681affee4b2STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head, 1682affee4b2STejun Heo struct work_struct **nextp) 1683affee4b2STejun Heo { 1684affee4b2STejun Heo struct work_struct *n; 1685affee4b2STejun Heo 1686affee4b2STejun Heo /* 1687affee4b2STejun Heo * Linked worklist will always end before the end of the list, 1688affee4b2STejun Heo * use NULL for list head. 1689affee4b2STejun Heo */ 1690affee4b2STejun Heo list_for_each_entry_safe_from(work, n, NULL, entry) { 1691affee4b2STejun Heo list_move_tail(&work->entry, head); 1692affee4b2STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) 1693affee4b2STejun Heo break; 1694affee4b2STejun Heo } 1695affee4b2STejun Heo 1696affee4b2STejun Heo /* 1697affee4b2STejun Heo * If we're already inside safe list traversal and have moved 1698affee4b2STejun Heo * multiple works to the scheduled queue, the next position 1699affee4b2STejun Heo * needs to be updated. 1700affee4b2STejun Heo */ 1701affee4b2STejun Heo if (nextp) 1702affee4b2STejun Heo *nextp = n; 1703affee4b2STejun Heo } 1704affee4b2STejun Heo 17051e19ffc6STejun Heo static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq) 17061e19ffc6STejun Heo { 17071e19ffc6STejun Heo struct work_struct *work = list_first_entry(&cwq->delayed_works, 17081da177e4SLinus Torvalds struct work_struct, entry); 1709649027d7STejun Heo struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq); 17101e19ffc6STejun Heo 1711cdadf009STejun Heo trace_workqueue_activate_work(work); 1712649027d7STejun Heo move_linked_works(work, pos, NULL); 17138a2e8e5dSTejun Heo __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work)); 17141e19ffc6STejun Heo cwq->nr_active++; 17151e19ffc6STejun Heo } 17161e19ffc6STejun Heo 1717affee4b2STejun Heo /** 171873f53c4aSTejun Heo * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight 171973f53c4aSTejun Heo * @cwq: cwq of interest 172073f53c4aSTejun Heo * @color: color of work which left the queue 17218a2e8e5dSTejun Heo * @delayed: for a delayed work 172273f53c4aSTejun Heo * 172373f53c4aSTejun Heo * A work either has completed or is removed from pending queue, 172473f53c4aSTejun Heo * decrement nr_in_flight of its cwq and handle workqueue flushing. 172573f53c4aSTejun Heo * 172673f53c4aSTejun Heo * CONTEXT: 17278b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock). 172873f53c4aSTejun Heo */ 17298a2e8e5dSTejun Heo static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color, 17308a2e8e5dSTejun Heo bool delayed) 173173f53c4aSTejun Heo { 173273f53c4aSTejun Heo /* ignore uncolored works */ 173373f53c4aSTejun Heo if (color == WORK_NO_COLOR) 173473f53c4aSTejun Heo return; 173573f53c4aSTejun Heo 173673f53c4aSTejun Heo cwq->nr_in_flight[color]--; 17371e19ffc6STejun Heo 17388a2e8e5dSTejun Heo if (!delayed) { 17398a2e8e5dSTejun Heo cwq->nr_active--; 1740502ca9d8STejun Heo if (!list_empty(&cwq->delayed_works)) { 17411e19ffc6STejun Heo /* one down, submit a delayed one */ 1742502ca9d8STejun Heo if (cwq->nr_active < cwq->max_active) 17431e19ffc6STejun Heo cwq_activate_first_delayed(cwq); 1744502ca9d8STejun Heo } 17458a2e8e5dSTejun Heo } 174673f53c4aSTejun Heo 174773f53c4aSTejun Heo /* is flush in progress and are we at the flushing tip? */ 174873f53c4aSTejun Heo if (likely(cwq->flush_color != color)) 174973f53c4aSTejun Heo return; 175073f53c4aSTejun Heo 175173f53c4aSTejun Heo /* are there still in-flight works? */ 175273f53c4aSTejun Heo if (cwq->nr_in_flight[color]) 175373f53c4aSTejun Heo return; 175473f53c4aSTejun Heo 175573f53c4aSTejun Heo /* this cwq is done, clear flush_color */ 175673f53c4aSTejun Heo cwq->flush_color = -1; 175773f53c4aSTejun Heo 175873f53c4aSTejun Heo /* 175973f53c4aSTejun Heo * If this was the last cwq, wake up the first flusher. It 176073f53c4aSTejun Heo * will handle the rest. 176173f53c4aSTejun Heo */ 176273f53c4aSTejun Heo if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush)) 176373f53c4aSTejun Heo complete(&cwq->wq->first_flusher->done); 176473f53c4aSTejun Heo } 176573f53c4aSTejun Heo 176673f53c4aSTejun Heo /** 1767a62428c0STejun Heo * process_one_work - process single work 1768c34056a3STejun Heo * @worker: self 1769a62428c0STejun Heo * @work: work to process 1770a62428c0STejun Heo * 1771a62428c0STejun Heo * Process @work. This function contains all the logics necessary to 1772a62428c0STejun Heo * process a single work including synchronization against and 1773a62428c0STejun Heo * interaction with other workers on the same cpu, queueing and 1774a62428c0STejun Heo * flushing. As long as context requirement is met, any worker can 1775a62428c0STejun Heo * call this function to process a work. 1776a62428c0STejun Heo * 1777a62428c0STejun Heo * CONTEXT: 17788b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock) which is released and regrabbed. 1779a62428c0STejun Heo */ 1780c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work) 178106bd6ebfSNamhyung Kim __releases(&gcwq->lock) 178206bd6ebfSNamhyung Kim __acquires(&gcwq->lock) 17831da177e4SLinus Torvalds { 17847e11629dSTejun Heo struct cpu_workqueue_struct *cwq = get_work_cwq(work); 17858b03ae3cSTejun Heo struct global_cwq *gcwq = cwq->gcwq; 1786c8e55f36STejun Heo struct hlist_head *bwh = busy_worker_head(gcwq, work); 1787fb0e7bebSTejun Heo bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE; 17886bb49e59SDavid Howells work_func_t f = work->func; 178973f53c4aSTejun Heo int work_color; 17907e11629dSTejun Heo struct worker *collision; 17914e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 17924e6045f1SJohannes Berg /* 1793a62428c0STejun Heo * It is permissible to free the struct work_struct from 1794a62428c0STejun Heo * inside the function that is called from it, this we need to 1795a62428c0STejun Heo * take into account for lockdep too. To avoid bogus "held 1796a62428c0STejun Heo * lock freed" warnings as well as problems when looking into 1797a62428c0STejun Heo * work->lockdep_map, make a copy and use that here. 17984e6045f1SJohannes Berg */ 17994e6045f1SJohannes Berg struct lockdep_map lockdep_map = work->lockdep_map; 18004e6045f1SJohannes Berg #endif 18017e11629dSTejun Heo /* 18027e11629dSTejun Heo * A single work shouldn't be executed concurrently by 18037e11629dSTejun Heo * multiple workers on a single cpu. Check whether anyone is 18047e11629dSTejun Heo * already processing the work. If so, defer the work to the 18057e11629dSTejun Heo * currently executing one. 18067e11629dSTejun Heo */ 18077e11629dSTejun Heo collision = __find_worker_executing_work(gcwq, bwh, work); 18087e11629dSTejun Heo if (unlikely(collision)) { 18097e11629dSTejun Heo move_linked_works(work, &collision->scheduled, NULL); 18107e11629dSTejun Heo return; 18117e11629dSTejun Heo } 18121da177e4SLinus Torvalds 1813a62428c0STejun Heo /* claim and process */ 18141da177e4SLinus Torvalds debug_work_deactivate(work); 1815c8e55f36STejun Heo hlist_add_head(&worker->hentry, bwh); 1816c34056a3STejun Heo worker->current_work = work; 18178cca0eeaSTejun Heo worker->current_cwq = cwq; 181873f53c4aSTejun Heo work_color = get_work_color(work); 18197a22ad75STejun Heo 18207a22ad75STejun Heo /* record the current cpu number in the work data and dequeue */ 18217a22ad75STejun Heo set_work_cpu(work, gcwq->cpu); 1822a62428c0STejun Heo list_del_init(&work->entry); 1823a62428c0STejun Heo 1824649027d7STejun Heo /* 1825649027d7STejun Heo * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI, 1826649027d7STejun Heo * wake up another worker; otherwise, clear HIGHPRI_PENDING. 1827649027d7STejun Heo */ 1828649027d7STejun Heo if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) { 1829649027d7STejun Heo struct work_struct *nwork = list_first_entry(&gcwq->worklist, 1830649027d7STejun Heo struct work_struct, entry); 1831649027d7STejun Heo 1832649027d7STejun Heo if (!list_empty(&gcwq->worklist) && 1833649027d7STejun Heo get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI) 1834649027d7STejun Heo wake_up_worker(gcwq); 1835649027d7STejun Heo else 1836649027d7STejun Heo gcwq->flags &= ~GCWQ_HIGHPRI_PENDING; 1837649027d7STejun Heo } 1838649027d7STejun Heo 1839fb0e7bebSTejun Heo /* 1840fb0e7bebSTejun Heo * CPU intensive works don't participate in concurrency 1841fb0e7bebSTejun Heo * management. They're the scheduler's responsibility. 1842fb0e7bebSTejun Heo */ 1843fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 1844fb0e7bebSTejun Heo worker_set_flags(worker, WORKER_CPU_INTENSIVE, true); 1845fb0e7bebSTejun Heo 18468b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 18471da177e4SLinus Torvalds 184823b2e599SOleg Nesterov work_clear_pending(work); 1849e159489bSTejun Heo lock_map_acquire_read(&cwq->wq->lockdep_map); 18503295f0efSIngo Molnar lock_map_acquire(&lockdep_map); 1851e36c886aSArjan van de Ven trace_workqueue_execute_start(work); 185265f27f38SDavid Howells f(work); 1853e36c886aSArjan van de Ven /* 1854e36c886aSArjan van de Ven * While we must be careful to not use "work" after this, the trace 1855e36c886aSArjan van de Ven * point will only record its address. 1856e36c886aSArjan van de Ven */ 1857e36c886aSArjan van de Ven trace_workqueue_execute_end(work); 18583295f0efSIngo Molnar lock_map_release(&lockdep_map); 18593295f0efSIngo Molnar lock_map_release(&cwq->wq->lockdep_map); 18601da177e4SLinus Torvalds 1861d5abe669SPeter Zijlstra if (unlikely(in_atomic() || lockdep_depth(current) > 0)) { 1862d5abe669SPeter Zijlstra printk(KERN_ERR "BUG: workqueue leaked lock or atomic: " 1863d5abe669SPeter Zijlstra "%s/0x%08x/%d\n", 1864a62428c0STejun Heo current->comm, preempt_count(), task_pid_nr(current)); 1865d5abe669SPeter Zijlstra printk(KERN_ERR " last function: "); 1866d5abe669SPeter Zijlstra print_symbol("%s\n", (unsigned long)f); 1867d5abe669SPeter Zijlstra debug_show_held_locks(current); 1868d5abe669SPeter Zijlstra dump_stack(); 1869d5abe669SPeter Zijlstra } 1870d5abe669SPeter Zijlstra 18718b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 1872a62428c0STejun Heo 1873fb0e7bebSTejun Heo /* clear cpu intensive status */ 1874fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 1875fb0e7bebSTejun Heo worker_clr_flags(worker, WORKER_CPU_INTENSIVE); 1876fb0e7bebSTejun Heo 1877a62428c0STejun Heo /* we're done with it, release */ 1878c8e55f36STejun Heo hlist_del_init(&worker->hentry); 1879c34056a3STejun Heo worker->current_work = NULL; 18808cca0eeaSTejun Heo worker->current_cwq = NULL; 18818a2e8e5dSTejun Heo cwq_dec_nr_in_flight(cwq, work_color, false); 18821da177e4SLinus Torvalds } 18831da177e4SLinus Torvalds 1884affee4b2STejun Heo /** 1885affee4b2STejun Heo * process_scheduled_works - process scheduled works 1886affee4b2STejun Heo * @worker: self 1887affee4b2STejun Heo * 1888affee4b2STejun Heo * Process all scheduled works. Please note that the scheduled list 1889affee4b2STejun Heo * may change while processing a work, so this function repeatedly 1890affee4b2STejun Heo * fetches a work from the top and executes it. 1891affee4b2STejun Heo * 1892affee4b2STejun Heo * CONTEXT: 18938b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 1894affee4b2STejun Heo * multiple times. 1895affee4b2STejun Heo */ 1896affee4b2STejun Heo static void process_scheduled_works(struct worker *worker) 18971da177e4SLinus Torvalds { 1898affee4b2STejun Heo while (!list_empty(&worker->scheduled)) { 1899affee4b2STejun Heo struct work_struct *work = list_first_entry(&worker->scheduled, 1900a62428c0STejun Heo struct work_struct, entry); 1901c34056a3STejun Heo process_one_work(worker, work); 1902a62428c0STejun Heo } 19031da177e4SLinus Torvalds } 19041da177e4SLinus Torvalds 19054690c4abSTejun Heo /** 19064690c4abSTejun Heo * worker_thread - the worker thread function 1907c34056a3STejun Heo * @__worker: self 19084690c4abSTejun Heo * 1909e22bee78STejun Heo * The gcwq worker thread function. There's a single dynamic pool of 1910e22bee78STejun Heo * these per each cpu. These workers process all works regardless of 1911e22bee78STejun Heo * their specific target workqueue. The only exception is works which 1912e22bee78STejun Heo * belong to workqueues with a rescuer which will be explained in 1913e22bee78STejun Heo * rescuer_thread(). 19144690c4abSTejun Heo */ 1915c34056a3STejun Heo static int worker_thread(void *__worker) 19161da177e4SLinus Torvalds { 1917c34056a3STejun Heo struct worker *worker = __worker; 19188b03ae3cSTejun Heo struct global_cwq *gcwq = worker->gcwq; 19191da177e4SLinus Torvalds 1920e22bee78STejun Heo /* tell the scheduler that this is a workqueue worker */ 1921e22bee78STejun Heo worker->task->flags |= PF_WQ_WORKER; 1922c8e55f36STejun Heo woke_up: 19238b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 1924affee4b2STejun Heo 1925c8e55f36STejun Heo /* DIE can be set only while we're idle, checking here is enough */ 1926c8e55f36STejun Heo if (worker->flags & WORKER_DIE) { 1927c8e55f36STejun Heo spin_unlock_irq(&gcwq->lock); 1928e22bee78STejun Heo worker->task->flags &= ~PF_WQ_WORKER; 1929c8e55f36STejun Heo return 0; 1930c8e55f36STejun Heo } 1931c8e55f36STejun Heo 1932c8e55f36STejun Heo worker_leave_idle(worker); 1933db7bccf4STejun Heo recheck: 1934e22bee78STejun Heo /* no more worker necessary? */ 1935e22bee78STejun Heo if (!need_more_worker(gcwq)) 1936e22bee78STejun Heo goto sleep; 1937e22bee78STejun Heo 1938e22bee78STejun Heo /* do we need to manage? */ 1939e22bee78STejun Heo if (unlikely(!may_start_working(gcwq)) && manage_workers(worker)) 1940e22bee78STejun Heo goto recheck; 1941e22bee78STejun Heo 1942c8e55f36STejun Heo /* 1943c8e55f36STejun Heo * ->scheduled list can only be filled while a worker is 1944c8e55f36STejun Heo * preparing to process a work or actually processing it. 1945c8e55f36STejun Heo * Make sure nobody diddled with it while I was sleeping. 1946c8e55f36STejun Heo */ 1947c8e55f36STejun Heo BUG_ON(!list_empty(&worker->scheduled)); 1948c8e55f36STejun Heo 1949e22bee78STejun Heo /* 1950e22bee78STejun Heo * When control reaches this point, we're guaranteed to have 1951e22bee78STejun Heo * at least one idle worker or that someone else has already 1952e22bee78STejun Heo * assumed the manager role. 1953e22bee78STejun Heo */ 1954e22bee78STejun Heo worker_clr_flags(worker, WORKER_PREP); 1955e22bee78STejun Heo 1956e22bee78STejun Heo do { 1957affee4b2STejun Heo struct work_struct *work = 19587e11629dSTejun Heo list_first_entry(&gcwq->worklist, 1959affee4b2STejun Heo struct work_struct, entry); 1960affee4b2STejun Heo 1961c8e55f36STejun Heo if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) { 1962affee4b2STejun Heo /* optimization path, not strictly necessary */ 1963affee4b2STejun Heo process_one_work(worker, work); 1964affee4b2STejun Heo if (unlikely(!list_empty(&worker->scheduled))) 1965affee4b2STejun Heo process_scheduled_works(worker); 1966affee4b2STejun Heo } else { 1967c8e55f36STejun Heo move_linked_works(work, &worker->scheduled, NULL); 1968affee4b2STejun Heo process_scheduled_works(worker); 1969affee4b2STejun Heo } 1970e22bee78STejun Heo } while (keep_working(gcwq)); 1971affee4b2STejun Heo 1972e22bee78STejun Heo worker_set_flags(worker, WORKER_PREP, false); 1973d313dd85STejun Heo sleep: 1974e22bee78STejun Heo if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker)) 1975e22bee78STejun Heo goto recheck; 1976d313dd85STejun Heo 1977c8e55f36STejun Heo /* 1978e22bee78STejun Heo * gcwq->lock is held and there's no work to process and no 1979e22bee78STejun Heo * need to manage, sleep. Workers are woken up only while 1980e22bee78STejun Heo * holding gcwq->lock or from local cpu, so setting the 1981e22bee78STejun Heo * current state before releasing gcwq->lock is enough to 1982e22bee78STejun Heo * prevent losing any event. 1983c8e55f36STejun Heo */ 1984c8e55f36STejun Heo worker_enter_idle(worker); 1985c8e55f36STejun Heo __set_current_state(TASK_INTERRUPTIBLE); 19868b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 19871da177e4SLinus Torvalds schedule(); 1988c8e55f36STejun Heo goto woke_up; 19891da177e4SLinus Torvalds } 19901da177e4SLinus Torvalds 1991e22bee78STejun Heo /** 1992e22bee78STejun Heo * rescuer_thread - the rescuer thread function 1993e22bee78STejun Heo * @__wq: the associated workqueue 1994e22bee78STejun Heo * 1995e22bee78STejun Heo * Workqueue rescuer thread function. There's one rescuer for each 1996e22bee78STejun Heo * workqueue which has WQ_RESCUER set. 1997e22bee78STejun Heo * 1998e22bee78STejun Heo * Regular work processing on a gcwq may block trying to create a new 1999e22bee78STejun Heo * worker which uses GFP_KERNEL allocation which has slight chance of 2000e22bee78STejun Heo * developing into deadlock if some works currently on the same queue 2001e22bee78STejun Heo * need to be processed to satisfy the GFP_KERNEL allocation. This is 2002e22bee78STejun Heo * the problem rescuer solves. 2003e22bee78STejun Heo * 2004e22bee78STejun Heo * When such condition is possible, the gcwq summons rescuers of all 2005e22bee78STejun Heo * workqueues which have works queued on the gcwq and let them process 2006e22bee78STejun Heo * those works so that forward progress can be guaranteed. 2007e22bee78STejun Heo * 2008e22bee78STejun Heo * This should happen rarely. 2009e22bee78STejun Heo */ 2010e22bee78STejun Heo static int rescuer_thread(void *__wq) 2011e22bee78STejun Heo { 2012e22bee78STejun Heo struct workqueue_struct *wq = __wq; 2013e22bee78STejun Heo struct worker *rescuer = wq->rescuer; 2014e22bee78STejun Heo struct list_head *scheduled = &rescuer->scheduled; 2015f3421797STejun Heo bool is_unbound = wq->flags & WQ_UNBOUND; 2016e22bee78STejun Heo unsigned int cpu; 2017e22bee78STejun Heo 2018e22bee78STejun Heo set_user_nice(current, RESCUER_NICE_LEVEL); 2019e22bee78STejun Heo repeat: 2020e22bee78STejun Heo set_current_state(TASK_INTERRUPTIBLE); 20211da177e4SLinus Torvalds 20221da177e4SLinus Torvalds if (kthread_should_stop()) 2023e22bee78STejun Heo return 0; 20241da177e4SLinus Torvalds 2025f3421797STejun Heo /* 2026f3421797STejun Heo * See whether any cpu is asking for help. Unbounded 2027f3421797STejun Heo * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND. 2028f3421797STejun Heo */ 2029f2e005aaSTejun Heo for_each_mayday_cpu(cpu, wq->mayday_mask) { 2030f3421797STejun Heo unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu; 2031f3421797STejun Heo struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq); 2032e22bee78STejun Heo struct global_cwq *gcwq = cwq->gcwq; 2033e22bee78STejun Heo struct work_struct *work, *n; 2034e22bee78STejun Heo 2035e22bee78STejun Heo __set_current_state(TASK_RUNNING); 2036f2e005aaSTejun Heo mayday_clear_cpu(cpu, wq->mayday_mask); 2037e22bee78STejun Heo 2038e22bee78STejun Heo /* migrate to the target cpu if possible */ 2039e22bee78STejun Heo rescuer->gcwq = gcwq; 2040e22bee78STejun Heo worker_maybe_bind_and_lock(rescuer); 2041e22bee78STejun Heo 2042e22bee78STejun Heo /* 2043e22bee78STejun Heo * Slurp in all works issued via this workqueue and 2044e22bee78STejun Heo * process'em. 2045e22bee78STejun Heo */ 2046e22bee78STejun Heo BUG_ON(!list_empty(&rescuer->scheduled)); 2047e22bee78STejun Heo list_for_each_entry_safe(work, n, &gcwq->worklist, entry) 2048e22bee78STejun Heo if (get_work_cwq(work) == cwq) 2049e22bee78STejun Heo move_linked_works(work, scheduled, &n); 2050e22bee78STejun Heo 2051e22bee78STejun Heo process_scheduled_works(rescuer); 20527576958aSTejun Heo 20537576958aSTejun Heo /* 20547576958aSTejun Heo * Leave this gcwq. If keep_working() is %true, notify a 20557576958aSTejun Heo * regular worker; otherwise, we end up with 0 concurrency 20567576958aSTejun Heo * and stalling the execution. 20577576958aSTejun Heo */ 20587576958aSTejun Heo if (keep_working(gcwq)) 20597576958aSTejun Heo wake_up_worker(gcwq); 20607576958aSTejun Heo 2061e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 20621da177e4SLinus Torvalds } 20631da177e4SLinus Torvalds 2064e22bee78STejun Heo schedule(); 2065e22bee78STejun Heo goto repeat; 20661da177e4SLinus Torvalds } 20671da177e4SLinus Torvalds 2068fc2e4d70SOleg Nesterov struct wq_barrier { 2069fc2e4d70SOleg Nesterov struct work_struct work; 2070fc2e4d70SOleg Nesterov struct completion done; 2071fc2e4d70SOleg Nesterov }; 2072fc2e4d70SOleg Nesterov 2073fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work) 2074fc2e4d70SOleg Nesterov { 2075fc2e4d70SOleg Nesterov struct wq_barrier *barr = container_of(work, struct wq_barrier, work); 2076fc2e4d70SOleg Nesterov complete(&barr->done); 2077fc2e4d70SOleg Nesterov } 2078fc2e4d70SOleg Nesterov 20794690c4abSTejun Heo /** 20804690c4abSTejun Heo * insert_wq_barrier - insert a barrier work 20814690c4abSTejun Heo * @cwq: cwq to insert barrier into 20824690c4abSTejun Heo * @barr: wq_barrier to insert 2083affee4b2STejun Heo * @target: target work to attach @barr to 2084affee4b2STejun Heo * @worker: worker currently executing @target, NULL if @target is not executing 20854690c4abSTejun Heo * 2086affee4b2STejun Heo * @barr is linked to @target such that @barr is completed only after 2087affee4b2STejun Heo * @target finishes execution. Please note that the ordering 2088affee4b2STejun Heo * guarantee is observed only with respect to @target and on the local 2089affee4b2STejun Heo * cpu. 2090affee4b2STejun Heo * 2091affee4b2STejun Heo * Currently, a queued barrier can't be canceled. This is because 2092affee4b2STejun Heo * try_to_grab_pending() can't determine whether the work to be 2093affee4b2STejun Heo * grabbed is at the head of the queue and thus can't clear LINKED 2094affee4b2STejun Heo * flag of the previous work while there must be a valid next work 2095affee4b2STejun Heo * after a work with LINKED flag set. 2096affee4b2STejun Heo * 2097affee4b2STejun Heo * Note that when @worker is non-NULL, @target may be modified 2098affee4b2STejun Heo * underneath us, so we can't reliably determine cwq from @target. 20994690c4abSTejun Heo * 21004690c4abSTejun Heo * CONTEXT: 21018b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock). 21024690c4abSTejun Heo */ 210383c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq, 2104affee4b2STejun Heo struct wq_barrier *barr, 2105affee4b2STejun Heo struct work_struct *target, struct worker *worker) 2106fc2e4d70SOleg Nesterov { 2107affee4b2STejun Heo struct list_head *head; 2108affee4b2STejun Heo unsigned int linked = 0; 2109affee4b2STejun Heo 2110dc186ad7SThomas Gleixner /* 21118b03ae3cSTejun Heo * debugobject calls are safe here even with gcwq->lock locked 2112dc186ad7SThomas Gleixner * as we know for sure that this will not trigger any of the 2113dc186ad7SThomas Gleixner * checks and call back into the fixup functions where we 2114dc186ad7SThomas Gleixner * might deadlock. 2115dc186ad7SThomas Gleixner */ 2116ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&barr->work, wq_barrier_func); 211722df02bbSTejun Heo __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); 2118fc2e4d70SOleg Nesterov init_completion(&barr->done); 211983c22520SOleg Nesterov 2120affee4b2STejun Heo /* 2121affee4b2STejun Heo * If @target is currently being executed, schedule the 2122affee4b2STejun Heo * barrier to the worker; otherwise, put it after @target. 2123affee4b2STejun Heo */ 2124affee4b2STejun Heo if (worker) 2125affee4b2STejun Heo head = worker->scheduled.next; 2126affee4b2STejun Heo else { 2127affee4b2STejun Heo unsigned long *bits = work_data_bits(target); 2128affee4b2STejun Heo 2129affee4b2STejun Heo head = target->entry.next; 2130affee4b2STejun Heo /* there can already be other linked works, inherit and set */ 2131affee4b2STejun Heo linked = *bits & WORK_STRUCT_LINKED; 2132affee4b2STejun Heo __set_bit(WORK_STRUCT_LINKED_BIT, bits); 2133affee4b2STejun Heo } 2134affee4b2STejun Heo 2135dc186ad7SThomas Gleixner debug_work_activate(&barr->work); 2136affee4b2STejun Heo insert_work(cwq, &barr->work, head, 2137affee4b2STejun Heo work_color_to_flags(WORK_NO_COLOR) | linked); 2138fc2e4d70SOleg Nesterov } 2139fc2e4d70SOleg Nesterov 214073f53c4aSTejun Heo /** 214173f53c4aSTejun Heo * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing 214273f53c4aSTejun Heo * @wq: workqueue being flushed 214373f53c4aSTejun Heo * @flush_color: new flush color, < 0 for no-op 214473f53c4aSTejun Heo * @work_color: new work color, < 0 for no-op 214573f53c4aSTejun Heo * 214673f53c4aSTejun Heo * Prepare cwqs for workqueue flushing. 214773f53c4aSTejun Heo * 214873f53c4aSTejun Heo * If @flush_color is non-negative, flush_color on all cwqs should be 214973f53c4aSTejun Heo * -1. If no cwq has in-flight commands at the specified color, all 215073f53c4aSTejun Heo * cwq->flush_color's stay at -1 and %false is returned. If any cwq 215173f53c4aSTejun Heo * has in flight commands, its cwq->flush_color is set to 215273f53c4aSTejun Heo * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq 215373f53c4aSTejun Heo * wakeup logic is armed and %true is returned. 215473f53c4aSTejun Heo * 215573f53c4aSTejun Heo * The caller should have initialized @wq->first_flusher prior to 215673f53c4aSTejun Heo * calling this function with non-negative @flush_color. If 215773f53c4aSTejun Heo * @flush_color is negative, no flush color update is done and %false 215873f53c4aSTejun Heo * is returned. 215973f53c4aSTejun Heo * 216073f53c4aSTejun Heo * If @work_color is non-negative, all cwqs should have the same 216173f53c4aSTejun Heo * work_color which is previous to @work_color and all will be 216273f53c4aSTejun Heo * advanced to @work_color. 216373f53c4aSTejun Heo * 216473f53c4aSTejun Heo * CONTEXT: 216573f53c4aSTejun Heo * mutex_lock(wq->flush_mutex). 216673f53c4aSTejun Heo * 216773f53c4aSTejun Heo * RETURNS: 216873f53c4aSTejun Heo * %true if @flush_color >= 0 and there's something to flush. %false 216973f53c4aSTejun Heo * otherwise. 217073f53c4aSTejun Heo */ 217173f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq, 217273f53c4aSTejun Heo int flush_color, int work_color) 21731da177e4SLinus Torvalds { 217473f53c4aSTejun Heo bool wait = false; 217573f53c4aSTejun Heo unsigned int cpu; 21761da177e4SLinus Torvalds 217773f53c4aSTejun Heo if (flush_color >= 0) { 217873f53c4aSTejun Heo BUG_ON(atomic_read(&wq->nr_cwqs_to_flush)); 217973f53c4aSTejun Heo atomic_set(&wq->nr_cwqs_to_flush, 1); 2180dc186ad7SThomas Gleixner } 218114441960SOleg Nesterov 2182f3421797STejun Heo for_each_cwq_cpu(cpu, wq) { 218373f53c4aSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 21848b03ae3cSTejun Heo struct global_cwq *gcwq = cwq->gcwq; 21851da177e4SLinus Torvalds 21868b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 218773f53c4aSTejun Heo 218873f53c4aSTejun Heo if (flush_color >= 0) { 218973f53c4aSTejun Heo BUG_ON(cwq->flush_color != -1); 219073f53c4aSTejun Heo 219173f53c4aSTejun Heo if (cwq->nr_in_flight[flush_color]) { 219273f53c4aSTejun Heo cwq->flush_color = flush_color; 219373f53c4aSTejun Heo atomic_inc(&wq->nr_cwqs_to_flush); 219473f53c4aSTejun Heo wait = true; 21951da177e4SLinus Torvalds } 219673f53c4aSTejun Heo } 219773f53c4aSTejun Heo 219873f53c4aSTejun Heo if (work_color >= 0) { 219973f53c4aSTejun Heo BUG_ON(work_color != work_next_color(cwq->work_color)); 220073f53c4aSTejun Heo cwq->work_color = work_color; 220173f53c4aSTejun Heo } 220273f53c4aSTejun Heo 22038b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 22041da177e4SLinus Torvalds } 22051da177e4SLinus Torvalds 220673f53c4aSTejun Heo if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush)) 220773f53c4aSTejun Heo complete(&wq->first_flusher->done); 220873f53c4aSTejun Heo 220973f53c4aSTejun Heo return wait; 221083c22520SOleg Nesterov } 22111da177e4SLinus Torvalds 22120fcb78c2SRolf Eike Beer /** 22131da177e4SLinus Torvalds * flush_workqueue - ensure that any scheduled work has run to completion. 22140fcb78c2SRolf Eike Beer * @wq: workqueue to flush 22151da177e4SLinus Torvalds * 22161da177e4SLinus Torvalds * Forces execution of the workqueue and blocks until its completion. 22171da177e4SLinus Torvalds * This is typically used in driver shutdown handlers. 22181da177e4SLinus Torvalds * 2219fc2e4d70SOleg Nesterov * We sleep until all works which were queued on entry have been handled, 2220fc2e4d70SOleg Nesterov * but we are not livelocked by new incoming ones. 22211da177e4SLinus Torvalds */ 22227ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq) 22231da177e4SLinus Torvalds { 222473f53c4aSTejun Heo struct wq_flusher this_flusher = { 222573f53c4aSTejun Heo .list = LIST_HEAD_INIT(this_flusher.list), 222673f53c4aSTejun Heo .flush_color = -1, 222773f53c4aSTejun Heo .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done), 222873f53c4aSTejun Heo }; 222973f53c4aSTejun Heo int next_color; 2230b1f4ec17SOleg Nesterov 22313295f0efSIngo Molnar lock_map_acquire(&wq->lockdep_map); 22323295f0efSIngo Molnar lock_map_release(&wq->lockdep_map); 223373f53c4aSTejun Heo 223473f53c4aSTejun Heo mutex_lock(&wq->flush_mutex); 223573f53c4aSTejun Heo 223673f53c4aSTejun Heo /* 223773f53c4aSTejun Heo * Start-to-wait phase 223873f53c4aSTejun Heo */ 223973f53c4aSTejun Heo next_color = work_next_color(wq->work_color); 224073f53c4aSTejun Heo 224173f53c4aSTejun Heo if (next_color != wq->flush_color) { 224273f53c4aSTejun Heo /* 224373f53c4aSTejun Heo * Color space is not full. The current work_color 224473f53c4aSTejun Heo * becomes our flush_color and work_color is advanced 224573f53c4aSTejun Heo * by one. 224673f53c4aSTejun Heo */ 224773f53c4aSTejun Heo BUG_ON(!list_empty(&wq->flusher_overflow)); 224873f53c4aSTejun Heo this_flusher.flush_color = wq->work_color; 224973f53c4aSTejun Heo wq->work_color = next_color; 225073f53c4aSTejun Heo 225173f53c4aSTejun Heo if (!wq->first_flusher) { 225273f53c4aSTejun Heo /* no flush in progress, become the first flusher */ 225373f53c4aSTejun Heo BUG_ON(wq->flush_color != this_flusher.flush_color); 225473f53c4aSTejun Heo 225573f53c4aSTejun Heo wq->first_flusher = &this_flusher; 225673f53c4aSTejun Heo 225773f53c4aSTejun Heo if (!flush_workqueue_prep_cwqs(wq, wq->flush_color, 225873f53c4aSTejun Heo wq->work_color)) { 225973f53c4aSTejun Heo /* nothing to flush, done */ 226073f53c4aSTejun Heo wq->flush_color = next_color; 226173f53c4aSTejun Heo wq->first_flusher = NULL; 226273f53c4aSTejun Heo goto out_unlock; 226373f53c4aSTejun Heo } 226473f53c4aSTejun Heo } else { 226573f53c4aSTejun Heo /* wait in queue */ 226673f53c4aSTejun Heo BUG_ON(wq->flush_color == this_flusher.flush_color); 226773f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_queue); 226873f53c4aSTejun Heo flush_workqueue_prep_cwqs(wq, -1, wq->work_color); 226973f53c4aSTejun Heo } 227073f53c4aSTejun Heo } else { 227173f53c4aSTejun Heo /* 227273f53c4aSTejun Heo * Oops, color space is full, wait on overflow queue. 227373f53c4aSTejun Heo * The next flush completion will assign us 227473f53c4aSTejun Heo * flush_color and transfer to flusher_queue. 227573f53c4aSTejun Heo */ 227673f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_overflow); 227773f53c4aSTejun Heo } 227873f53c4aSTejun Heo 227973f53c4aSTejun Heo mutex_unlock(&wq->flush_mutex); 228073f53c4aSTejun Heo 228173f53c4aSTejun Heo wait_for_completion(&this_flusher.done); 228273f53c4aSTejun Heo 228373f53c4aSTejun Heo /* 228473f53c4aSTejun Heo * Wake-up-and-cascade phase 228573f53c4aSTejun Heo * 228673f53c4aSTejun Heo * First flushers are responsible for cascading flushes and 228773f53c4aSTejun Heo * handling overflow. Non-first flushers can simply return. 228873f53c4aSTejun Heo */ 228973f53c4aSTejun Heo if (wq->first_flusher != &this_flusher) 229073f53c4aSTejun Heo return; 229173f53c4aSTejun Heo 229273f53c4aSTejun Heo mutex_lock(&wq->flush_mutex); 229373f53c4aSTejun Heo 22944ce48b37STejun Heo /* we might have raced, check again with mutex held */ 22954ce48b37STejun Heo if (wq->first_flusher != &this_flusher) 22964ce48b37STejun Heo goto out_unlock; 22974ce48b37STejun Heo 229873f53c4aSTejun Heo wq->first_flusher = NULL; 229973f53c4aSTejun Heo 230073f53c4aSTejun Heo BUG_ON(!list_empty(&this_flusher.list)); 230173f53c4aSTejun Heo BUG_ON(wq->flush_color != this_flusher.flush_color); 230273f53c4aSTejun Heo 230373f53c4aSTejun Heo while (true) { 230473f53c4aSTejun Heo struct wq_flusher *next, *tmp; 230573f53c4aSTejun Heo 230673f53c4aSTejun Heo /* complete all the flushers sharing the current flush color */ 230773f53c4aSTejun Heo list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { 230873f53c4aSTejun Heo if (next->flush_color != wq->flush_color) 230973f53c4aSTejun Heo break; 231073f53c4aSTejun Heo list_del_init(&next->list); 231173f53c4aSTejun Heo complete(&next->done); 231273f53c4aSTejun Heo } 231373f53c4aSTejun Heo 231473f53c4aSTejun Heo BUG_ON(!list_empty(&wq->flusher_overflow) && 231573f53c4aSTejun Heo wq->flush_color != work_next_color(wq->work_color)); 231673f53c4aSTejun Heo 231773f53c4aSTejun Heo /* this flush_color is finished, advance by one */ 231873f53c4aSTejun Heo wq->flush_color = work_next_color(wq->flush_color); 231973f53c4aSTejun Heo 232073f53c4aSTejun Heo /* one color has been freed, handle overflow queue */ 232173f53c4aSTejun Heo if (!list_empty(&wq->flusher_overflow)) { 232273f53c4aSTejun Heo /* 232373f53c4aSTejun Heo * Assign the same color to all overflowed 232473f53c4aSTejun Heo * flushers, advance work_color and append to 232573f53c4aSTejun Heo * flusher_queue. This is the start-to-wait 232673f53c4aSTejun Heo * phase for these overflowed flushers. 232773f53c4aSTejun Heo */ 232873f53c4aSTejun Heo list_for_each_entry(tmp, &wq->flusher_overflow, list) 232973f53c4aSTejun Heo tmp->flush_color = wq->work_color; 233073f53c4aSTejun Heo 233173f53c4aSTejun Heo wq->work_color = work_next_color(wq->work_color); 233273f53c4aSTejun Heo 233373f53c4aSTejun Heo list_splice_tail_init(&wq->flusher_overflow, 233473f53c4aSTejun Heo &wq->flusher_queue); 233573f53c4aSTejun Heo flush_workqueue_prep_cwqs(wq, -1, wq->work_color); 233673f53c4aSTejun Heo } 233773f53c4aSTejun Heo 233873f53c4aSTejun Heo if (list_empty(&wq->flusher_queue)) { 233973f53c4aSTejun Heo BUG_ON(wq->flush_color != wq->work_color); 234073f53c4aSTejun Heo break; 234173f53c4aSTejun Heo } 234273f53c4aSTejun Heo 234373f53c4aSTejun Heo /* 234473f53c4aSTejun Heo * Need to flush more colors. Make the next flusher 234573f53c4aSTejun Heo * the new first flusher and arm cwqs. 234673f53c4aSTejun Heo */ 234773f53c4aSTejun Heo BUG_ON(wq->flush_color == wq->work_color); 234873f53c4aSTejun Heo BUG_ON(wq->flush_color != next->flush_color); 234973f53c4aSTejun Heo 235073f53c4aSTejun Heo list_del_init(&next->list); 235173f53c4aSTejun Heo wq->first_flusher = next; 235273f53c4aSTejun Heo 235373f53c4aSTejun Heo if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1)) 235473f53c4aSTejun Heo break; 235573f53c4aSTejun Heo 235673f53c4aSTejun Heo /* 235773f53c4aSTejun Heo * Meh... this color is already done, clear first 235873f53c4aSTejun Heo * flusher and repeat cascading. 235973f53c4aSTejun Heo */ 236073f53c4aSTejun Heo wq->first_flusher = NULL; 236173f53c4aSTejun Heo } 236273f53c4aSTejun Heo 236373f53c4aSTejun Heo out_unlock: 236473f53c4aSTejun Heo mutex_unlock(&wq->flush_mutex); 23651da177e4SLinus Torvalds } 2366ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue); 23671da177e4SLinus Torvalds 2368baf59022STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr, 2369baf59022STejun Heo bool wait_executing) 2370baf59022STejun Heo { 2371baf59022STejun Heo struct worker *worker = NULL; 2372baf59022STejun Heo struct global_cwq *gcwq; 2373baf59022STejun Heo struct cpu_workqueue_struct *cwq; 2374baf59022STejun Heo 2375baf59022STejun Heo might_sleep(); 2376baf59022STejun Heo gcwq = get_work_gcwq(work); 2377baf59022STejun Heo if (!gcwq) 2378baf59022STejun Heo return false; 2379baf59022STejun Heo 2380baf59022STejun Heo spin_lock_irq(&gcwq->lock); 2381baf59022STejun Heo if (!list_empty(&work->entry)) { 2382baf59022STejun Heo /* 2383baf59022STejun Heo * See the comment near try_to_grab_pending()->smp_rmb(). 2384baf59022STejun Heo * If it was re-queued to a different gcwq under us, we 2385baf59022STejun Heo * are not going to wait. 2386baf59022STejun Heo */ 2387baf59022STejun Heo smp_rmb(); 2388baf59022STejun Heo cwq = get_work_cwq(work); 2389baf59022STejun Heo if (unlikely(!cwq || gcwq != cwq->gcwq)) 2390baf59022STejun Heo goto already_gone; 2391baf59022STejun Heo } else if (wait_executing) { 2392baf59022STejun Heo worker = find_worker_executing_work(gcwq, work); 2393baf59022STejun Heo if (!worker) 2394baf59022STejun Heo goto already_gone; 2395baf59022STejun Heo cwq = worker->current_cwq; 2396baf59022STejun Heo } else 2397baf59022STejun Heo goto already_gone; 2398baf59022STejun Heo 2399baf59022STejun Heo insert_wq_barrier(cwq, barr, work, worker); 2400baf59022STejun Heo spin_unlock_irq(&gcwq->lock); 2401baf59022STejun Heo 2402e159489bSTejun Heo /* 2403e159489bSTejun Heo * If @max_active is 1 or rescuer is in use, flushing another work 2404e159489bSTejun Heo * item on the same workqueue may lead to deadlock. Make sure the 2405e159489bSTejun Heo * flusher is not running on the same workqueue by verifying write 2406e159489bSTejun Heo * access. 2407e159489bSTejun Heo */ 2408e159489bSTejun Heo if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER) 2409baf59022STejun Heo lock_map_acquire(&cwq->wq->lockdep_map); 2410e159489bSTejun Heo else 2411e159489bSTejun Heo lock_map_acquire_read(&cwq->wq->lockdep_map); 2412baf59022STejun Heo lock_map_release(&cwq->wq->lockdep_map); 2413e159489bSTejun Heo 2414baf59022STejun Heo return true; 2415baf59022STejun Heo already_gone: 2416baf59022STejun Heo spin_unlock_irq(&gcwq->lock); 2417baf59022STejun Heo return false; 2418baf59022STejun Heo } 2419baf59022STejun Heo 2420db700897SOleg Nesterov /** 2421401a8d04STejun Heo * flush_work - wait for a work to finish executing the last queueing instance 2422401a8d04STejun Heo * @work: the work to flush 2423db700897SOleg Nesterov * 2424401a8d04STejun Heo * Wait until @work has finished execution. This function considers 2425401a8d04STejun Heo * only the last queueing instance of @work. If @work has been 2426401a8d04STejun Heo * enqueued across different CPUs on a non-reentrant workqueue or on 2427401a8d04STejun Heo * multiple workqueues, @work might still be executing on return on 2428401a8d04STejun Heo * some of the CPUs from earlier queueing. 2429a67da70dSOleg Nesterov * 2430401a8d04STejun Heo * If @work was queued only on a non-reentrant, ordered or unbound 2431401a8d04STejun Heo * workqueue, @work is guaranteed to be idle on return if it hasn't 2432401a8d04STejun Heo * been requeued since flush started. 2433401a8d04STejun Heo * 2434401a8d04STejun Heo * RETURNS: 2435401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2436401a8d04STejun Heo * %false if it was already idle. 2437db700897SOleg Nesterov */ 2438401a8d04STejun Heo bool flush_work(struct work_struct *work) 2439db700897SOleg Nesterov { 2440db700897SOleg Nesterov struct wq_barrier barr; 2441db700897SOleg Nesterov 2442baf59022STejun Heo if (start_flush_work(work, &barr, true)) { 2443db700897SOleg Nesterov wait_for_completion(&barr.done); 2444dc186ad7SThomas Gleixner destroy_work_on_stack(&barr.work); 2445401a8d04STejun Heo return true; 2446baf59022STejun Heo } else 2447401a8d04STejun Heo return false; 2448db700897SOleg Nesterov } 2449db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work); 2450db700897SOleg Nesterov 2451401a8d04STejun Heo static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work) 2452401a8d04STejun Heo { 2453401a8d04STejun Heo struct wq_barrier barr; 2454401a8d04STejun Heo struct worker *worker; 2455401a8d04STejun Heo 2456401a8d04STejun Heo spin_lock_irq(&gcwq->lock); 2457401a8d04STejun Heo 2458401a8d04STejun Heo worker = find_worker_executing_work(gcwq, work); 2459401a8d04STejun Heo if (unlikely(worker)) 2460401a8d04STejun Heo insert_wq_barrier(worker->current_cwq, &barr, work, worker); 2461401a8d04STejun Heo 2462401a8d04STejun Heo spin_unlock_irq(&gcwq->lock); 2463401a8d04STejun Heo 2464401a8d04STejun Heo if (unlikely(worker)) { 2465401a8d04STejun Heo wait_for_completion(&barr.done); 2466401a8d04STejun Heo destroy_work_on_stack(&barr.work); 2467401a8d04STejun Heo return true; 2468401a8d04STejun Heo } else 2469401a8d04STejun Heo return false; 2470401a8d04STejun Heo } 2471401a8d04STejun Heo 2472401a8d04STejun Heo static bool wait_on_work(struct work_struct *work) 2473401a8d04STejun Heo { 2474401a8d04STejun Heo bool ret = false; 2475401a8d04STejun Heo int cpu; 2476401a8d04STejun Heo 2477401a8d04STejun Heo might_sleep(); 2478401a8d04STejun Heo 2479401a8d04STejun Heo lock_map_acquire(&work->lockdep_map); 2480401a8d04STejun Heo lock_map_release(&work->lockdep_map); 2481401a8d04STejun Heo 2482401a8d04STejun Heo for_each_gcwq_cpu(cpu) 2483401a8d04STejun Heo ret |= wait_on_cpu_work(get_gcwq(cpu), work); 2484401a8d04STejun Heo return ret; 2485401a8d04STejun Heo } 2486401a8d04STejun Heo 248709383498STejun Heo /** 248809383498STejun Heo * flush_work_sync - wait until a work has finished execution 248909383498STejun Heo * @work: the work to flush 249009383498STejun Heo * 249109383498STejun Heo * Wait until @work has finished execution. On return, it's 249209383498STejun Heo * guaranteed that all queueing instances of @work which happened 249309383498STejun Heo * before this function is called are finished. In other words, if 249409383498STejun Heo * @work hasn't been requeued since this function was called, @work is 249509383498STejun Heo * guaranteed to be idle on return. 249609383498STejun Heo * 249709383498STejun Heo * RETURNS: 249809383498STejun Heo * %true if flush_work_sync() waited for the work to finish execution, 249909383498STejun Heo * %false if it was already idle. 250009383498STejun Heo */ 250109383498STejun Heo bool flush_work_sync(struct work_struct *work) 250209383498STejun Heo { 250309383498STejun Heo struct wq_barrier barr; 250409383498STejun Heo bool pending, waited; 250509383498STejun Heo 250609383498STejun Heo /* we'll wait for executions separately, queue barr only if pending */ 250709383498STejun Heo pending = start_flush_work(work, &barr, false); 250809383498STejun Heo 250909383498STejun Heo /* wait for executions to finish */ 251009383498STejun Heo waited = wait_on_work(work); 251109383498STejun Heo 251209383498STejun Heo /* wait for the pending one */ 251309383498STejun Heo if (pending) { 251409383498STejun Heo wait_for_completion(&barr.done); 251509383498STejun Heo destroy_work_on_stack(&barr.work); 251609383498STejun Heo } 251709383498STejun Heo 251809383498STejun Heo return pending || waited; 251909383498STejun Heo } 252009383498STejun Heo EXPORT_SYMBOL_GPL(flush_work_sync); 252109383498STejun Heo 25226e84d644SOleg Nesterov /* 25231f1f642eSOleg Nesterov * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit, 25246e84d644SOleg Nesterov * so this work can't be re-armed in any way. 25256e84d644SOleg Nesterov */ 25266e84d644SOleg Nesterov static int try_to_grab_pending(struct work_struct *work) 25276e84d644SOleg Nesterov { 25288b03ae3cSTejun Heo struct global_cwq *gcwq; 25291f1f642eSOleg Nesterov int ret = -1; 25306e84d644SOleg Nesterov 253122df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) 25321f1f642eSOleg Nesterov return 0; 25336e84d644SOleg Nesterov 25346e84d644SOleg Nesterov /* 25356e84d644SOleg Nesterov * The queueing is in progress, or it is already queued. Try to 25366e84d644SOleg Nesterov * steal it from ->worklist without clearing WORK_STRUCT_PENDING. 25376e84d644SOleg Nesterov */ 25387a22ad75STejun Heo gcwq = get_work_gcwq(work); 25397a22ad75STejun Heo if (!gcwq) 25406e84d644SOleg Nesterov return ret; 25416e84d644SOleg Nesterov 25428b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 25436e84d644SOleg Nesterov if (!list_empty(&work->entry)) { 25446e84d644SOleg Nesterov /* 25457a22ad75STejun Heo * This work is queued, but perhaps we locked the wrong gcwq. 25466e84d644SOleg Nesterov * In that case we must see the new value after rmb(), see 25476e84d644SOleg Nesterov * insert_work()->wmb(). 25486e84d644SOleg Nesterov */ 25496e84d644SOleg Nesterov smp_rmb(); 25507a22ad75STejun Heo if (gcwq == get_work_gcwq(work)) { 2551dc186ad7SThomas Gleixner debug_work_deactivate(work); 25526e84d644SOleg Nesterov list_del_init(&work->entry); 25537a22ad75STejun Heo cwq_dec_nr_in_flight(get_work_cwq(work), 25548a2e8e5dSTejun Heo get_work_color(work), 25558a2e8e5dSTejun Heo *work_data_bits(work) & WORK_STRUCT_DELAYED); 25566e84d644SOleg Nesterov ret = 1; 25576e84d644SOleg Nesterov } 25586e84d644SOleg Nesterov } 25598b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 25606e84d644SOleg Nesterov 25616e84d644SOleg Nesterov return ret; 25626e84d644SOleg Nesterov } 25636e84d644SOleg Nesterov 2564401a8d04STejun Heo static bool __cancel_work_timer(struct work_struct *work, 25651f1f642eSOleg Nesterov struct timer_list* timer) 25661f1f642eSOleg Nesterov { 25671f1f642eSOleg Nesterov int ret; 25681f1f642eSOleg Nesterov 25691f1f642eSOleg Nesterov do { 25701f1f642eSOleg Nesterov ret = (timer && likely(del_timer(timer))); 25711f1f642eSOleg Nesterov if (!ret) 25721f1f642eSOleg Nesterov ret = try_to_grab_pending(work); 25731f1f642eSOleg Nesterov wait_on_work(work); 25741f1f642eSOleg Nesterov } while (unlikely(ret < 0)); 25751f1f642eSOleg Nesterov 25767a22ad75STejun Heo clear_work_data(work); 25771f1f642eSOleg Nesterov return ret; 25781f1f642eSOleg Nesterov } 25791f1f642eSOleg Nesterov 25806e84d644SOleg Nesterov /** 2581401a8d04STejun Heo * cancel_work_sync - cancel a work and wait for it to finish 2582401a8d04STejun Heo * @work: the work to cancel 25836e84d644SOleg Nesterov * 2584401a8d04STejun Heo * Cancel @work and wait for its execution to finish. This function 2585401a8d04STejun Heo * can be used even if the work re-queues itself or migrates to 2586401a8d04STejun Heo * another workqueue. On return from this function, @work is 2587401a8d04STejun Heo * guaranteed to be not pending or executing on any CPU. 25881f1f642eSOleg Nesterov * 2589401a8d04STejun Heo * cancel_work_sync(&delayed_work->work) must not be used for 2590401a8d04STejun Heo * delayed_work's. Use cancel_delayed_work_sync() instead. 25916e84d644SOleg Nesterov * 2592401a8d04STejun Heo * The caller must ensure that the workqueue on which @work was last 25936e84d644SOleg Nesterov * queued can't be destroyed before this function returns. 2594401a8d04STejun Heo * 2595401a8d04STejun Heo * RETURNS: 2596401a8d04STejun Heo * %true if @work was pending, %false otherwise. 25976e84d644SOleg Nesterov */ 2598401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work) 25996e84d644SOleg Nesterov { 26001f1f642eSOleg Nesterov return __cancel_work_timer(work, NULL); 2601b89deed3SOleg Nesterov } 260228e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync); 2603b89deed3SOleg Nesterov 26046e84d644SOleg Nesterov /** 2605401a8d04STejun Heo * flush_delayed_work - wait for a dwork to finish executing the last queueing 2606401a8d04STejun Heo * @dwork: the delayed work to flush 26076e84d644SOleg Nesterov * 2608401a8d04STejun Heo * Delayed timer is cancelled and the pending work is queued for 2609401a8d04STejun Heo * immediate execution. Like flush_work(), this function only 2610401a8d04STejun Heo * considers the last queueing instance of @dwork. 26111f1f642eSOleg Nesterov * 2612401a8d04STejun Heo * RETURNS: 2613401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2614401a8d04STejun Heo * %false if it was already idle. 26156e84d644SOleg Nesterov */ 2616401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork) 2617401a8d04STejun Heo { 2618401a8d04STejun Heo if (del_timer_sync(&dwork->timer)) 2619401a8d04STejun Heo __queue_work(raw_smp_processor_id(), 2620401a8d04STejun Heo get_work_cwq(&dwork->work)->wq, &dwork->work); 2621401a8d04STejun Heo return flush_work(&dwork->work); 2622401a8d04STejun Heo } 2623401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work); 2624401a8d04STejun Heo 2625401a8d04STejun Heo /** 262609383498STejun Heo * flush_delayed_work_sync - wait for a dwork to finish 262709383498STejun Heo * @dwork: the delayed work to flush 262809383498STejun Heo * 262909383498STejun Heo * Delayed timer is cancelled and the pending work is queued for 263009383498STejun Heo * execution immediately. Other than timer handling, its behavior 263109383498STejun Heo * is identical to flush_work_sync(). 263209383498STejun Heo * 263309383498STejun Heo * RETURNS: 263409383498STejun Heo * %true if flush_work_sync() waited for the work to finish execution, 263509383498STejun Heo * %false if it was already idle. 263609383498STejun Heo */ 263709383498STejun Heo bool flush_delayed_work_sync(struct delayed_work *dwork) 263809383498STejun Heo { 263909383498STejun Heo if (del_timer_sync(&dwork->timer)) 264009383498STejun Heo __queue_work(raw_smp_processor_id(), 264109383498STejun Heo get_work_cwq(&dwork->work)->wq, &dwork->work); 264209383498STejun Heo return flush_work_sync(&dwork->work); 264309383498STejun Heo } 264409383498STejun Heo EXPORT_SYMBOL(flush_delayed_work_sync); 264509383498STejun Heo 264609383498STejun Heo /** 2647401a8d04STejun Heo * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish 2648401a8d04STejun Heo * @dwork: the delayed work cancel 2649401a8d04STejun Heo * 2650401a8d04STejun Heo * This is cancel_work_sync() for delayed works. 2651401a8d04STejun Heo * 2652401a8d04STejun Heo * RETURNS: 2653401a8d04STejun Heo * %true if @dwork was pending, %false otherwise. 2654401a8d04STejun Heo */ 2655401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork) 26566e84d644SOleg Nesterov { 26571f1f642eSOleg Nesterov return __cancel_work_timer(&dwork->work, &dwork->timer); 26586e84d644SOleg Nesterov } 2659f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync); 26601da177e4SLinus Torvalds 26610fcb78c2SRolf Eike Beer /** 26620fcb78c2SRolf Eike Beer * schedule_work - put work task in global workqueue 26630fcb78c2SRolf Eike Beer * @work: job to be done 26640fcb78c2SRolf Eike Beer * 26655b0f437dSBart Van Assche * Returns zero if @work was already on the kernel-global workqueue and 26665b0f437dSBart Van Assche * non-zero otherwise. 26675b0f437dSBart Van Assche * 26685b0f437dSBart Van Assche * This puts a job in the kernel-global workqueue if it was not already 26695b0f437dSBart Van Assche * queued and leaves it in the same position on the kernel-global 26705b0f437dSBart Van Assche * workqueue otherwise. 26710fcb78c2SRolf Eike Beer */ 26727ad5b3a5SHarvey Harrison int schedule_work(struct work_struct *work) 26731da177e4SLinus Torvalds { 2674d320c038STejun Heo return queue_work(system_wq, work); 26751da177e4SLinus Torvalds } 2676ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_work); 26771da177e4SLinus Torvalds 2678c1a220e7SZhang Rui /* 2679c1a220e7SZhang Rui * schedule_work_on - put work task on a specific cpu 2680c1a220e7SZhang Rui * @cpu: cpu to put the work task on 2681c1a220e7SZhang Rui * @work: job to be done 2682c1a220e7SZhang Rui * 2683c1a220e7SZhang Rui * This puts a job on a specific cpu 2684c1a220e7SZhang Rui */ 2685c1a220e7SZhang Rui int schedule_work_on(int cpu, struct work_struct *work) 2686c1a220e7SZhang Rui { 2687d320c038STejun Heo return queue_work_on(cpu, system_wq, work); 2688c1a220e7SZhang Rui } 2689c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on); 2690c1a220e7SZhang Rui 26910fcb78c2SRolf Eike Beer /** 26920fcb78c2SRolf Eike Beer * schedule_delayed_work - put work task in global workqueue after delay 269352bad64dSDavid Howells * @dwork: job to be done 269452bad64dSDavid Howells * @delay: number of jiffies to wait or 0 for immediate execution 26950fcb78c2SRolf Eike Beer * 26960fcb78c2SRolf Eike Beer * After waiting for a given time this puts a job in the kernel-global 26970fcb78c2SRolf Eike Beer * workqueue. 26980fcb78c2SRolf Eike Beer */ 26997ad5b3a5SHarvey Harrison int schedule_delayed_work(struct delayed_work *dwork, 270082f67cd9SIngo Molnar unsigned long delay) 27011da177e4SLinus Torvalds { 2702d320c038STejun Heo return queue_delayed_work(system_wq, dwork, delay); 27031da177e4SLinus Torvalds } 2704ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work); 27051da177e4SLinus Torvalds 27060fcb78c2SRolf Eike Beer /** 27070fcb78c2SRolf Eike Beer * schedule_delayed_work_on - queue work in global workqueue on CPU after delay 27080fcb78c2SRolf Eike Beer * @cpu: cpu to use 270952bad64dSDavid Howells * @dwork: job to be done 27100fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait 27110fcb78c2SRolf Eike Beer * 27120fcb78c2SRolf Eike Beer * After waiting for a given time this puts a job in the kernel-global 27130fcb78c2SRolf Eike Beer * workqueue on the specified CPU. 27140fcb78c2SRolf Eike Beer */ 27151da177e4SLinus Torvalds int schedule_delayed_work_on(int cpu, 271652bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 27171da177e4SLinus Torvalds { 2718d320c038STejun Heo return queue_delayed_work_on(cpu, system_wq, dwork, delay); 27191da177e4SLinus Torvalds } 2720ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on); 27211da177e4SLinus Torvalds 2722b6136773SAndrew Morton /** 272331ddd871STejun Heo * schedule_on_each_cpu - execute a function synchronously on each online CPU 2724b6136773SAndrew Morton * @func: the function to call 2725b6136773SAndrew Morton * 272631ddd871STejun Heo * schedule_on_each_cpu() executes @func on each online CPU using the 272731ddd871STejun Heo * system workqueue and blocks until all CPUs have completed. 2728b6136773SAndrew Morton * schedule_on_each_cpu() is very slow. 272931ddd871STejun Heo * 273031ddd871STejun Heo * RETURNS: 273131ddd871STejun Heo * 0 on success, -errno on failure. 2732b6136773SAndrew Morton */ 273365f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func) 273415316ba8SChristoph Lameter { 273515316ba8SChristoph Lameter int cpu; 273638f51568SNamhyung Kim struct work_struct __percpu *works; 273715316ba8SChristoph Lameter 2738b6136773SAndrew Morton works = alloc_percpu(struct work_struct); 2739b6136773SAndrew Morton if (!works) 274015316ba8SChristoph Lameter return -ENOMEM; 2741b6136773SAndrew Morton 274295402b38SGautham R Shenoy get_online_cpus(); 274393981800STejun Heo 274415316ba8SChristoph Lameter for_each_online_cpu(cpu) { 27459bfb1839SIngo Molnar struct work_struct *work = per_cpu_ptr(works, cpu); 27469bfb1839SIngo Molnar 27479bfb1839SIngo Molnar INIT_WORK(work, func); 27488de6d308SOleg Nesterov schedule_work_on(cpu, work); 274915316ba8SChristoph Lameter } 275093981800STejun Heo 275193981800STejun Heo for_each_online_cpu(cpu) 27528616a89aSOleg Nesterov flush_work(per_cpu_ptr(works, cpu)); 275393981800STejun Heo 275495402b38SGautham R Shenoy put_online_cpus(); 2755b6136773SAndrew Morton free_percpu(works); 275615316ba8SChristoph Lameter return 0; 275715316ba8SChristoph Lameter } 275815316ba8SChristoph Lameter 2759eef6a7d5SAlan Stern /** 2760eef6a7d5SAlan Stern * flush_scheduled_work - ensure that any scheduled work has run to completion. 2761eef6a7d5SAlan Stern * 2762eef6a7d5SAlan Stern * Forces execution of the kernel-global workqueue and blocks until its 2763eef6a7d5SAlan Stern * completion. 2764eef6a7d5SAlan Stern * 2765eef6a7d5SAlan Stern * Think twice before calling this function! It's very easy to get into 2766eef6a7d5SAlan Stern * trouble if you don't take great care. Either of the following situations 2767eef6a7d5SAlan Stern * will lead to deadlock: 2768eef6a7d5SAlan Stern * 2769eef6a7d5SAlan Stern * One of the work items currently on the workqueue needs to acquire 2770eef6a7d5SAlan Stern * a lock held by your code or its caller. 2771eef6a7d5SAlan Stern * 2772eef6a7d5SAlan Stern * Your code is running in the context of a work routine. 2773eef6a7d5SAlan Stern * 2774eef6a7d5SAlan Stern * They will be detected by lockdep when they occur, but the first might not 2775eef6a7d5SAlan Stern * occur very often. It depends on what work items are on the workqueue and 2776eef6a7d5SAlan Stern * what locks they need, which you have no control over. 2777eef6a7d5SAlan Stern * 2778eef6a7d5SAlan Stern * In most situations flushing the entire workqueue is overkill; you merely 2779eef6a7d5SAlan Stern * need to know that a particular work item isn't queued and isn't running. 2780eef6a7d5SAlan Stern * In such cases you should use cancel_delayed_work_sync() or 2781eef6a7d5SAlan Stern * cancel_work_sync() instead. 2782eef6a7d5SAlan Stern */ 27831da177e4SLinus Torvalds void flush_scheduled_work(void) 27841da177e4SLinus Torvalds { 2785d320c038STejun Heo flush_workqueue(system_wq); 27861da177e4SLinus Torvalds } 2787ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work); 27881da177e4SLinus Torvalds 27891da177e4SLinus Torvalds /** 27901fa44ecaSJames Bottomley * execute_in_process_context - reliably execute the routine with user context 27911fa44ecaSJames Bottomley * @fn: the function to execute 27921fa44ecaSJames Bottomley * @ew: guaranteed storage for the execute work structure (must 27931fa44ecaSJames Bottomley * be available when the work executes) 27941fa44ecaSJames Bottomley * 27951fa44ecaSJames Bottomley * Executes the function immediately if process context is available, 27961fa44ecaSJames Bottomley * otherwise schedules the function for delayed execution. 27971fa44ecaSJames Bottomley * 27981fa44ecaSJames Bottomley * Returns: 0 - function was executed 27991fa44ecaSJames Bottomley * 1 - function was scheduled for execution 28001fa44ecaSJames Bottomley */ 280165f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew) 28021fa44ecaSJames Bottomley { 28031fa44ecaSJames Bottomley if (!in_interrupt()) { 280465f27f38SDavid Howells fn(&ew->work); 28051fa44ecaSJames Bottomley return 0; 28061fa44ecaSJames Bottomley } 28071fa44ecaSJames Bottomley 280865f27f38SDavid Howells INIT_WORK(&ew->work, fn); 28091fa44ecaSJames Bottomley schedule_work(&ew->work); 28101fa44ecaSJames Bottomley 28111fa44ecaSJames Bottomley return 1; 28121fa44ecaSJames Bottomley } 28131fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context); 28141fa44ecaSJames Bottomley 28151da177e4SLinus Torvalds int keventd_up(void) 28161da177e4SLinus Torvalds { 2817d320c038STejun Heo return system_wq != NULL; 28181da177e4SLinus Torvalds } 28191da177e4SLinus Torvalds 2820bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq) 28211da177e4SLinus Torvalds { 28223af24433SOleg Nesterov /* 28230f900049STejun Heo * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS. 28240f900049STejun Heo * Make sure that the alignment isn't lower than that of 28250f900049STejun Heo * unsigned long long. 28263af24433SOleg Nesterov */ 28270f900049STejun Heo const size_t size = sizeof(struct cpu_workqueue_struct); 28280f900049STejun Heo const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS, 28290f900049STejun Heo __alignof__(unsigned long long)); 2830931ac77eSTejun Heo #ifdef CONFIG_SMP 2831931ac77eSTejun Heo bool percpu = !(wq->flags & WQ_UNBOUND); 2832931ac77eSTejun Heo #else 2833931ac77eSTejun Heo bool percpu = false; 2834931ac77eSTejun Heo #endif 28353af24433SOleg Nesterov 2836931ac77eSTejun Heo if (percpu) 2837f3421797STejun Heo wq->cpu_wq.pcpu = __alloc_percpu(size, align); 2838931ac77eSTejun Heo else { 28390f900049STejun Heo void *ptr; 2840e1d8aa9fSFrederic Weisbecker 28410f900049STejun Heo /* 2842f3421797STejun Heo * Allocate enough room to align cwq and put an extra 2843f3421797STejun Heo * pointer at the end pointing back to the originally 2844f3421797STejun Heo * allocated pointer which will be used for free. 28450f900049STejun Heo */ 2846bdbc5dd7STejun Heo ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL); 2847bdbc5dd7STejun Heo if (ptr) { 2848bdbc5dd7STejun Heo wq->cpu_wq.single = PTR_ALIGN(ptr, align); 2849bdbc5dd7STejun Heo *(void **)(wq->cpu_wq.single + 1) = ptr; 2850bdbc5dd7STejun Heo } 28513af24433SOleg Nesterov } 28523af24433SOleg Nesterov 285352605627SDavid Howells /* just in case, make sure it's actually aligned 285452605627SDavid Howells * - this is affected by PERCPU() alignment in vmlinux.lds.S 285552605627SDavid Howells */ 2856bdbc5dd7STejun Heo BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align)); 2857bdbc5dd7STejun Heo return wq->cpu_wq.v ? 0 : -ENOMEM; 28580f900049STejun Heo } 28590f900049STejun Heo 2860bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq) 286106ba38a9SOleg Nesterov { 2862931ac77eSTejun Heo #ifdef CONFIG_SMP 2863931ac77eSTejun Heo bool percpu = !(wq->flags & WQ_UNBOUND); 2864931ac77eSTejun Heo #else 2865931ac77eSTejun Heo bool percpu = false; 2866931ac77eSTejun Heo #endif 286706ba38a9SOleg Nesterov 2868931ac77eSTejun Heo if (percpu) 2869bdbc5dd7STejun Heo free_percpu(wq->cpu_wq.pcpu); 2870f3421797STejun Heo else if (wq->cpu_wq.single) { 2871f3421797STejun Heo /* the pointer to free is stored right after the cwq */ 2872f3421797STejun Heo kfree(*(void **)(wq->cpu_wq.single + 1)); 287306ba38a9SOleg Nesterov } 287406ba38a9SOleg Nesterov } 287506ba38a9SOleg Nesterov 2876f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags, 2877f3421797STejun Heo const char *name) 2878b71ab8c2STejun Heo { 2879f3421797STejun Heo int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE; 2880f3421797STejun Heo 2881f3421797STejun Heo if (max_active < 1 || max_active > lim) 2882b71ab8c2STejun Heo printk(KERN_WARNING "workqueue: max_active %d requested for %s " 2883b71ab8c2STejun Heo "is out of range, clamping between %d and %d\n", 2884f3421797STejun Heo max_active, name, 1, lim); 2885b71ab8c2STejun Heo 2886f3421797STejun Heo return clamp_val(max_active, 1, lim); 2887b71ab8c2STejun Heo } 2888b71ab8c2STejun Heo 2889d320c038STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *name, 289097e37d7bSTejun Heo unsigned int flags, 28911e19ffc6STejun Heo int max_active, 2892eb13ba87SJohannes Berg struct lock_class_key *key, 2893eb13ba87SJohannes Berg const char *lock_name) 28943af24433SOleg Nesterov { 28953af24433SOleg Nesterov struct workqueue_struct *wq; 2896c34056a3STejun Heo unsigned int cpu; 28973af24433SOleg Nesterov 2898f3421797STejun Heo /* 28996370a6adSTejun Heo * Workqueues which may be used during memory reclaim should 29006370a6adSTejun Heo * have a rescuer to guarantee forward progress. 29016370a6adSTejun Heo */ 29026370a6adSTejun Heo if (flags & WQ_MEM_RECLAIM) 29036370a6adSTejun Heo flags |= WQ_RESCUER; 29046370a6adSTejun Heo 29056370a6adSTejun Heo /* 2906f3421797STejun Heo * Unbound workqueues aren't concurrency managed and should be 2907f3421797STejun Heo * dispatched to workers immediately. 2908f3421797STejun Heo */ 2909f3421797STejun Heo if (flags & WQ_UNBOUND) 2910f3421797STejun Heo flags |= WQ_HIGHPRI; 2911f3421797STejun Heo 2912d320c038STejun Heo max_active = max_active ?: WQ_DFL_ACTIVE; 2913f3421797STejun Heo max_active = wq_clamp_max_active(max_active, flags, name); 29143af24433SOleg Nesterov 29153af24433SOleg Nesterov wq = kzalloc(sizeof(*wq), GFP_KERNEL); 29163af24433SOleg Nesterov if (!wq) 29174690c4abSTejun Heo goto err; 29183af24433SOleg Nesterov 291997e37d7bSTejun Heo wq->flags = flags; 2920a0a1a5fdSTejun Heo wq->saved_max_active = max_active; 292173f53c4aSTejun Heo mutex_init(&wq->flush_mutex); 292273f53c4aSTejun Heo atomic_set(&wq->nr_cwqs_to_flush, 0); 292373f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_queue); 292473f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_overflow); 29253af24433SOleg Nesterov 29263af24433SOleg Nesterov wq->name = name; 2927eb13ba87SJohannes Berg lockdep_init_map(&wq->lockdep_map, lock_name, key, 0); 2928cce1a165SOleg Nesterov INIT_LIST_HEAD(&wq->list); 29293af24433SOleg Nesterov 2930bdbc5dd7STejun Heo if (alloc_cwqs(wq) < 0) 2931bdbc5dd7STejun Heo goto err; 2932bdbc5dd7STejun Heo 2933f3421797STejun Heo for_each_cwq_cpu(cpu, wq) { 29341537663fSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 29358b03ae3cSTejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 29361537663fSTejun Heo 29370f900049STejun Heo BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK); 29388b03ae3cSTejun Heo cwq->gcwq = gcwq; 2939c34056a3STejun Heo cwq->wq = wq; 294073f53c4aSTejun Heo cwq->flush_color = -1; 29411e19ffc6STejun Heo cwq->max_active = max_active; 29421e19ffc6STejun Heo INIT_LIST_HEAD(&cwq->delayed_works); 2943e22bee78STejun Heo } 29441537663fSTejun Heo 2945e22bee78STejun Heo if (flags & WQ_RESCUER) { 2946e22bee78STejun Heo struct worker *rescuer; 2947e22bee78STejun Heo 2948f2e005aaSTejun Heo if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL)) 2949e22bee78STejun Heo goto err; 2950e22bee78STejun Heo 2951e22bee78STejun Heo wq->rescuer = rescuer = alloc_worker(); 2952e22bee78STejun Heo if (!rescuer) 2953e22bee78STejun Heo goto err; 2954e22bee78STejun Heo 2955e22bee78STejun Heo rescuer->task = kthread_create(rescuer_thread, wq, "%s", name); 2956e22bee78STejun Heo if (IS_ERR(rescuer->task)) 2957e22bee78STejun Heo goto err; 2958e22bee78STejun Heo 2959e22bee78STejun Heo rescuer->task->flags |= PF_THREAD_BOUND; 2960e22bee78STejun Heo wake_up_process(rescuer->task); 29613af24433SOleg Nesterov } 29621537663fSTejun Heo 29633af24433SOleg Nesterov /* 2964a0a1a5fdSTejun Heo * workqueue_lock protects global freeze state and workqueues 2965a0a1a5fdSTejun Heo * list. Grab it, set max_active accordingly and add the new 2966a0a1a5fdSTejun Heo * workqueue to workqueues list. 29673af24433SOleg Nesterov */ 29683af24433SOleg Nesterov spin_lock(&workqueue_lock); 2969a0a1a5fdSTejun Heo 297058a69cb4STejun Heo if (workqueue_freezing && wq->flags & WQ_FREEZABLE) 2971f3421797STejun Heo for_each_cwq_cpu(cpu, wq) 2972a0a1a5fdSTejun Heo get_cwq(cpu, wq)->max_active = 0; 2973a0a1a5fdSTejun Heo 29743af24433SOleg Nesterov list_add(&wq->list, &workqueues); 2975a0a1a5fdSTejun Heo 29763af24433SOleg Nesterov spin_unlock(&workqueue_lock); 29773af24433SOleg Nesterov 29783af24433SOleg Nesterov return wq; 29794690c4abSTejun Heo err: 29804690c4abSTejun Heo if (wq) { 2981bdbc5dd7STejun Heo free_cwqs(wq); 2982f2e005aaSTejun Heo free_mayday_mask(wq->mayday_mask); 2983e22bee78STejun Heo kfree(wq->rescuer); 29844690c4abSTejun Heo kfree(wq); 29853af24433SOleg Nesterov } 29864690c4abSTejun Heo return NULL; 29871da177e4SLinus Torvalds } 2988d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key); 29891da177e4SLinus Torvalds 29903af24433SOleg Nesterov /** 29913af24433SOleg Nesterov * destroy_workqueue - safely terminate a workqueue 29923af24433SOleg Nesterov * @wq: target workqueue 29933af24433SOleg Nesterov * 29943af24433SOleg Nesterov * Safely destroy a workqueue. All work currently pending will be done first. 29953af24433SOleg Nesterov */ 29963af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq) 29973af24433SOleg Nesterov { 2998c8efcc25STejun Heo unsigned int flush_cnt = 0; 2999c8e55f36STejun Heo unsigned int cpu; 30003af24433SOleg Nesterov 3001c8efcc25STejun Heo /* 3002c8efcc25STejun Heo * Mark @wq dying and drain all pending works. Once WQ_DYING is 3003c8efcc25STejun Heo * set, only chain queueing is allowed. IOW, only currently 3004c8efcc25STejun Heo * pending or running work items on @wq can queue further work 3005c8efcc25STejun Heo * items on it. @wq is flushed repeatedly until it becomes empty. 3006c8efcc25STejun Heo * The number of flushing is detemined by the depth of chaining and 3007c8efcc25STejun Heo * should be relatively short. Whine if it takes too long. 3008c8efcc25STejun Heo */ 3009e41e704bSTejun Heo wq->flags |= WQ_DYING; 3010c8efcc25STejun Heo reflush: 3011a0a1a5fdSTejun Heo flush_workqueue(wq); 3012a0a1a5fdSTejun Heo 3013c8efcc25STejun Heo for_each_cwq_cpu(cpu, wq) { 3014c8efcc25STejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 3015c8efcc25STejun Heo 3016c8efcc25STejun Heo if (!cwq->nr_active && list_empty(&cwq->delayed_works)) 3017c8efcc25STejun Heo continue; 3018c8efcc25STejun Heo 3019c8efcc25STejun Heo if (++flush_cnt == 10 || 3020c8efcc25STejun Heo (flush_cnt % 100 == 0 && flush_cnt <= 1000)) 3021c8efcc25STejun Heo printk(KERN_WARNING "workqueue %s: flush on " 3022c8efcc25STejun Heo "destruction isn't complete after %u tries\n", 3023c8efcc25STejun Heo wq->name, flush_cnt); 3024c8efcc25STejun Heo goto reflush; 3025c8efcc25STejun Heo } 3026c8efcc25STejun Heo 3027a0a1a5fdSTejun Heo /* 3028a0a1a5fdSTejun Heo * wq list is used to freeze wq, remove from list after 3029a0a1a5fdSTejun Heo * flushing is complete in case freeze races us. 3030a0a1a5fdSTejun Heo */ 303195402b38SGautham R Shenoy spin_lock(&workqueue_lock); 30323af24433SOleg Nesterov list_del(&wq->list); 303395402b38SGautham R Shenoy spin_unlock(&workqueue_lock); 30343af24433SOleg Nesterov 3035e22bee78STejun Heo /* sanity check */ 3036f3421797STejun Heo for_each_cwq_cpu(cpu, wq) { 303773f53c4aSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 303873f53c4aSTejun Heo int i; 30393af24433SOleg Nesterov 304073f53c4aSTejun Heo for (i = 0; i < WORK_NR_COLORS; i++) 304173f53c4aSTejun Heo BUG_ON(cwq->nr_in_flight[i]); 30421e19ffc6STejun Heo BUG_ON(cwq->nr_active); 30431e19ffc6STejun Heo BUG_ON(!list_empty(&cwq->delayed_works)); 304473f53c4aSTejun Heo } 30451537663fSTejun Heo 3046e22bee78STejun Heo if (wq->flags & WQ_RESCUER) { 3047e22bee78STejun Heo kthread_stop(wq->rescuer->task); 3048f2e005aaSTejun Heo free_mayday_mask(wq->mayday_mask); 30498d9df9f0SXiaotian Feng kfree(wq->rescuer); 3050e22bee78STejun Heo } 3051e22bee78STejun Heo 3052bdbc5dd7STejun Heo free_cwqs(wq); 30533af24433SOleg Nesterov kfree(wq); 30543af24433SOleg Nesterov } 30553af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue); 30563af24433SOleg Nesterov 3057dcd989cbSTejun Heo /** 3058dcd989cbSTejun Heo * workqueue_set_max_active - adjust max_active of a workqueue 3059dcd989cbSTejun Heo * @wq: target workqueue 3060dcd989cbSTejun Heo * @max_active: new max_active value. 3061dcd989cbSTejun Heo * 3062dcd989cbSTejun Heo * Set max_active of @wq to @max_active. 3063dcd989cbSTejun Heo * 3064dcd989cbSTejun Heo * CONTEXT: 3065dcd989cbSTejun Heo * Don't call from IRQ context. 3066dcd989cbSTejun Heo */ 3067dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) 3068dcd989cbSTejun Heo { 3069dcd989cbSTejun Heo unsigned int cpu; 3070dcd989cbSTejun Heo 3071f3421797STejun Heo max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); 3072dcd989cbSTejun Heo 3073dcd989cbSTejun Heo spin_lock(&workqueue_lock); 3074dcd989cbSTejun Heo 3075dcd989cbSTejun Heo wq->saved_max_active = max_active; 3076dcd989cbSTejun Heo 3077f3421797STejun Heo for_each_cwq_cpu(cpu, wq) { 3078dcd989cbSTejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 3079dcd989cbSTejun Heo 3080dcd989cbSTejun Heo spin_lock_irq(&gcwq->lock); 3081dcd989cbSTejun Heo 308258a69cb4STejun Heo if (!(wq->flags & WQ_FREEZABLE) || 3083dcd989cbSTejun Heo !(gcwq->flags & GCWQ_FREEZING)) 3084dcd989cbSTejun Heo get_cwq(gcwq->cpu, wq)->max_active = max_active; 3085dcd989cbSTejun Heo 3086dcd989cbSTejun Heo spin_unlock_irq(&gcwq->lock); 3087dcd989cbSTejun Heo } 3088dcd989cbSTejun Heo 3089dcd989cbSTejun Heo spin_unlock(&workqueue_lock); 3090dcd989cbSTejun Heo } 3091dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active); 3092dcd989cbSTejun Heo 3093dcd989cbSTejun Heo /** 3094dcd989cbSTejun Heo * workqueue_congested - test whether a workqueue is congested 3095dcd989cbSTejun Heo * @cpu: CPU in question 3096dcd989cbSTejun Heo * @wq: target workqueue 3097dcd989cbSTejun Heo * 3098dcd989cbSTejun Heo * Test whether @wq's cpu workqueue for @cpu is congested. There is 3099dcd989cbSTejun Heo * no synchronization around this function and the test result is 3100dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 3101dcd989cbSTejun Heo * 3102dcd989cbSTejun Heo * RETURNS: 3103dcd989cbSTejun Heo * %true if congested, %false otherwise. 3104dcd989cbSTejun Heo */ 3105dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq) 3106dcd989cbSTejun Heo { 3107dcd989cbSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 3108dcd989cbSTejun Heo 3109dcd989cbSTejun Heo return !list_empty(&cwq->delayed_works); 3110dcd989cbSTejun Heo } 3111dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested); 3112dcd989cbSTejun Heo 3113dcd989cbSTejun Heo /** 3114dcd989cbSTejun Heo * work_cpu - return the last known associated cpu for @work 3115dcd989cbSTejun Heo * @work: the work of interest 3116dcd989cbSTejun Heo * 3117dcd989cbSTejun Heo * RETURNS: 3118bdbc5dd7STejun Heo * CPU number if @work was ever queued. WORK_CPU_NONE otherwise. 3119dcd989cbSTejun Heo */ 3120dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work) 3121dcd989cbSTejun Heo { 3122dcd989cbSTejun Heo struct global_cwq *gcwq = get_work_gcwq(work); 3123dcd989cbSTejun Heo 3124bdbc5dd7STejun Heo return gcwq ? gcwq->cpu : WORK_CPU_NONE; 3125dcd989cbSTejun Heo } 3126dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu); 3127dcd989cbSTejun Heo 3128dcd989cbSTejun Heo /** 3129dcd989cbSTejun Heo * work_busy - test whether a work is currently pending or running 3130dcd989cbSTejun Heo * @work: the work to be tested 3131dcd989cbSTejun Heo * 3132dcd989cbSTejun Heo * Test whether @work is currently pending or running. There is no 3133dcd989cbSTejun Heo * synchronization around this function and the test result is 3134dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 3135dcd989cbSTejun Heo * Especially for reentrant wqs, the pending state might hide the 3136dcd989cbSTejun Heo * running state. 3137dcd989cbSTejun Heo * 3138dcd989cbSTejun Heo * RETURNS: 3139dcd989cbSTejun Heo * OR'd bitmask of WORK_BUSY_* bits. 3140dcd989cbSTejun Heo */ 3141dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work) 3142dcd989cbSTejun Heo { 3143dcd989cbSTejun Heo struct global_cwq *gcwq = get_work_gcwq(work); 3144dcd989cbSTejun Heo unsigned long flags; 3145dcd989cbSTejun Heo unsigned int ret = 0; 3146dcd989cbSTejun Heo 3147dcd989cbSTejun Heo if (!gcwq) 3148dcd989cbSTejun Heo return false; 3149dcd989cbSTejun Heo 3150dcd989cbSTejun Heo spin_lock_irqsave(&gcwq->lock, flags); 3151dcd989cbSTejun Heo 3152dcd989cbSTejun Heo if (work_pending(work)) 3153dcd989cbSTejun Heo ret |= WORK_BUSY_PENDING; 3154dcd989cbSTejun Heo if (find_worker_executing_work(gcwq, work)) 3155dcd989cbSTejun Heo ret |= WORK_BUSY_RUNNING; 3156dcd989cbSTejun Heo 3157dcd989cbSTejun Heo spin_unlock_irqrestore(&gcwq->lock, flags); 3158dcd989cbSTejun Heo 3159dcd989cbSTejun Heo return ret; 3160dcd989cbSTejun Heo } 3161dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy); 3162dcd989cbSTejun Heo 3163db7bccf4STejun Heo /* 3164db7bccf4STejun Heo * CPU hotplug. 3165db7bccf4STejun Heo * 3166e22bee78STejun Heo * There are two challenges in supporting CPU hotplug. Firstly, there 3167e22bee78STejun Heo * are a lot of assumptions on strong associations among work, cwq and 3168e22bee78STejun Heo * gcwq which make migrating pending and scheduled works very 3169e22bee78STejun Heo * difficult to implement without impacting hot paths. Secondly, 3170e22bee78STejun Heo * gcwqs serve mix of short, long and very long running works making 3171e22bee78STejun Heo * blocked draining impractical. 3172e22bee78STejun Heo * 3173e22bee78STejun Heo * This is solved by allowing a gcwq to be detached from CPU, running 3174e22bee78STejun Heo * it with unbound (rogue) workers and allowing it to be reattached 3175e22bee78STejun Heo * later if the cpu comes back online. A separate thread is created 3176e22bee78STejun Heo * to govern a gcwq in such state and is called the trustee of the 3177e22bee78STejun Heo * gcwq. 3178db7bccf4STejun Heo * 3179db7bccf4STejun Heo * Trustee states and their descriptions. 3180db7bccf4STejun Heo * 3181db7bccf4STejun Heo * START Command state used on startup. On CPU_DOWN_PREPARE, a 3182db7bccf4STejun Heo * new trustee is started with this state. 3183db7bccf4STejun Heo * 3184db7bccf4STejun Heo * IN_CHARGE Once started, trustee will enter this state after 3185e22bee78STejun Heo * assuming the manager role and making all existing 3186e22bee78STejun Heo * workers rogue. DOWN_PREPARE waits for trustee to 3187e22bee78STejun Heo * enter this state. After reaching IN_CHARGE, trustee 3188e22bee78STejun Heo * tries to execute the pending worklist until it's empty 3189e22bee78STejun Heo * and the state is set to BUTCHER, or the state is set 3190e22bee78STejun Heo * to RELEASE. 3191db7bccf4STejun Heo * 3192db7bccf4STejun Heo * BUTCHER Command state which is set by the cpu callback after 3193db7bccf4STejun Heo * the cpu has went down. Once this state is set trustee 3194db7bccf4STejun Heo * knows that there will be no new works on the worklist 3195db7bccf4STejun Heo * and once the worklist is empty it can proceed to 3196db7bccf4STejun Heo * killing idle workers. 3197db7bccf4STejun Heo * 3198db7bccf4STejun Heo * RELEASE Command state which is set by the cpu callback if the 3199db7bccf4STejun Heo * cpu down has been canceled or it has come online 3200db7bccf4STejun Heo * again. After recognizing this state, trustee stops 3201e22bee78STejun Heo * trying to drain or butcher and clears ROGUE, rebinds 3202e22bee78STejun Heo * all remaining workers back to the cpu and releases 3203e22bee78STejun Heo * manager role. 3204db7bccf4STejun Heo * 3205db7bccf4STejun Heo * DONE Trustee will enter this state after BUTCHER or RELEASE 3206db7bccf4STejun Heo * is complete. 3207db7bccf4STejun Heo * 3208db7bccf4STejun Heo * trustee CPU draining 3209db7bccf4STejun Heo * took over down complete 3210db7bccf4STejun Heo * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE 3211db7bccf4STejun Heo * | | ^ 3212db7bccf4STejun Heo * | CPU is back online v return workers | 3213db7bccf4STejun Heo * ----------------> RELEASE -------------- 3214db7bccf4STejun Heo */ 3215db7bccf4STejun Heo 3216db7bccf4STejun Heo /** 3217db7bccf4STejun Heo * trustee_wait_event_timeout - timed event wait for trustee 3218db7bccf4STejun Heo * @cond: condition to wait for 3219db7bccf4STejun Heo * @timeout: timeout in jiffies 3220db7bccf4STejun Heo * 3221db7bccf4STejun Heo * wait_event_timeout() for trustee to use. Handles locking and 3222db7bccf4STejun Heo * checks for RELEASE request. 3223db7bccf4STejun Heo * 3224db7bccf4STejun Heo * CONTEXT: 3225db7bccf4STejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 3226db7bccf4STejun Heo * multiple times. To be used by trustee. 3227db7bccf4STejun Heo * 3228db7bccf4STejun Heo * RETURNS: 3229db7bccf4STejun Heo * Positive indicating left time if @cond is satisfied, 0 if timed 3230db7bccf4STejun Heo * out, -1 if canceled. 3231db7bccf4STejun Heo */ 3232db7bccf4STejun Heo #define trustee_wait_event_timeout(cond, timeout) ({ \ 3233db7bccf4STejun Heo long __ret = (timeout); \ 3234db7bccf4STejun Heo while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \ 3235db7bccf4STejun Heo __ret) { \ 3236db7bccf4STejun Heo spin_unlock_irq(&gcwq->lock); \ 3237db7bccf4STejun Heo __wait_event_timeout(gcwq->trustee_wait, (cond) || \ 3238db7bccf4STejun Heo (gcwq->trustee_state == TRUSTEE_RELEASE), \ 3239db7bccf4STejun Heo __ret); \ 3240db7bccf4STejun Heo spin_lock_irq(&gcwq->lock); \ 3241db7bccf4STejun Heo } \ 3242db7bccf4STejun Heo gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret); \ 3243db7bccf4STejun Heo }) 3244db7bccf4STejun Heo 3245db7bccf4STejun Heo /** 3246db7bccf4STejun Heo * trustee_wait_event - event wait for trustee 3247db7bccf4STejun Heo * @cond: condition to wait for 3248db7bccf4STejun Heo * 3249db7bccf4STejun Heo * wait_event() for trustee to use. Automatically handles locking and 3250db7bccf4STejun Heo * checks for CANCEL request. 3251db7bccf4STejun Heo * 3252db7bccf4STejun Heo * CONTEXT: 3253db7bccf4STejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 3254db7bccf4STejun Heo * multiple times. To be used by trustee. 3255db7bccf4STejun Heo * 3256db7bccf4STejun Heo * RETURNS: 3257db7bccf4STejun Heo * 0 if @cond is satisfied, -1 if canceled. 3258db7bccf4STejun Heo */ 3259db7bccf4STejun Heo #define trustee_wait_event(cond) ({ \ 3260db7bccf4STejun Heo long __ret1; \ 3261db7bccf4STejun Heo __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\ 3262db7bccf4STejun Heo __ret1 < 0 ? -1 : 0; \ 3263db7bccf4STejun Heo }) 3264db7bccf4STejun Heo 3265db7bccf4STejun Heo static int __cpuinit trustee_thread(void *__gcwq) 3266db7bccf4STejun Heo { 3267db7bccf4STejun Heo struct global_cwq *gcwq = __gcwq; 3268db7bccf4STejun Heo struct worker *worker; 3269e22bee78STejun Heo struct work_struct *work; 3270db7bccf4STejun Heo struct hlist_node *pos; 3271e22bee78STejun Heo long rc; 3272db7bccf4STejun Heo int i; 3273db7bccf4STejun Heo 3274db7bccf4STejun Heo BUG_ON(gcwq->cpu != smp_processor_id()); 3275db7bccf4STejun Heo 3276db7bccf4STejun Heo spin_lock_irq(&gcwq->lock); 3277db7bccf4STejun Heo /* 3278e22bee78STejun Heo * Claim the manager position and make all workers rogue. 3279e22bee78STejun Heo * Trustee must be bound to the target cpu and can't be 3280e22bee78STejun Heo * cancelled. 3281db7bccf4STejun Heo */ 3282db7bccf4STejun Heo BUG_ON(gcwq->cpu != smp_processor_id()); 3283e22bee78STejun Heo rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS)); 3284e22bee78STejun Heo BUG_ON(rc < 0); 3285e22bee78STejun Heo 3286e22bee78STejun Heo gcwq->flags |= GCWQ_MANAGING_WORKERS; 3287db7bccf4STejun Heo 3288db7bccf4STejun Heo list_for_each_entry(worker, &gcwq->idle_list, entry) 3289cb444766STejun Heo worker->flags |= WORKER_ROGUE; 3290db7bccf4STejun Heo 3291db7bccf4STejun Heo for_each_busy_worker(worker, i, pos, gcwq) 3292cb444766STejun Heo worker->flags |= WORKER_ROGUE; 3293db7bccf4STejun Heo 3294db7bccf4STejun Heo /* 3295e22bee78STejun Heo * Call schedule() so that we cross rq->lock and thus can 3296e22bee78STejun Heo * guarantee sched callbacks see the rogue flag. This is 3297e22bee78STejun Heo * necessary as scheduler callbacks may be invoked from other 3298e22bee78STejun Heo * cpus. 3299e22bee78STejun Heo */ 3300e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 3301e22bee78STejun Heo schedule(); 3302e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 3303e22bee78STejun Heo 3304e22bee78STejun Heo /* 3305cb444766STejun Heo * Sched callbacks are disabled now. Zap nr_running. After 3306cb444766STejun Heo * this, nr_running stays zero and need_more_worker() and 3307cb444766STejun Heo * keep_working() are always true as long as the worklist is 3308cb444766STejun Heo * not empty. 3309e22bee78STejun Heo */ 3310cb444766STejun Heo atomic_set(get_gcwq_nr_running(gcwq->cpu), 0); 3311e22bee78STejun Heo 3312e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 3313e22bee78STejun Heo del_timer_sync(&gcwq->idle_timer); 3314e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 3315e22bee78STejun Heo 3316e22bee78STejun Heo /* 3317db7bccf4STejun Heo * We're now in charge. Notify and proceed to drain. We need 3318db7bccf4STejun Heo * to keep the gcwq running during the whole CPU down 3319db7bccf4STejun Heo * procedure as other cpu hotunplug callbacks may need to 3320db7bccf4STejun Heo * flush currently running tasks. 3321db7bccf4STejun Heo */ 3322db7bccf4STejun Heo gcwq->trustee_state = TRUSTEE_IN_CHARGE; 3323db7bccf4STejun Heo wake_up_all(&gcwq->trustee_wait); 3324db7bccf4STejun Heo 3325db7bccf4STejun Heo /* 3326db7bccf4STejun Heo * The original cpu is in the process of dying and may go away 3327db7bccf4STejun Heo * anytime now. When that happens, we and all workers would 3328e22bee78STejun Heo * be migrated to other cpus. Try draining any left work. We 3329e22bee78STejun Heo * want to get it over with ASAP - spam rescuers, wake up as 3330e22bee78STejun Heo * many idlers as necessary and create new ones till the 3331e22bee78STejun Heo * worklist is empty. Note that if the gcwq is frozen, there 333258a69cb4STejun Heo * may be frozen works in freezable cwqs. Don't declare 3333e22bee78STejun Heo * completion while frozen. 3334db7bccf4STejun Heo */ 3335db7bccf4STejun Heo while (gcwq->nr_workers != gcwq->nr_idle || 3336db7bccf4STejun Heo gcwq->flags & GCWQ_FREEZING || 3337db7bccf4STejun Heo gcwq->trustee_state == TRUSTEE_IN_CHARGE) { 3338e22bee78STejun Heo int nr_works = 0; 3339e22bee78STejun Heo 3340e22bee78STejun Heo list_for_each_entry(work, &gcwq->worklist, entry) { 3341e22bee78STejun Heo send_mayday(work); 3342e22bee78STejun Heo nr_works++; 3343e22bee78STejun Heo } 3344e22bee78STejun Heo 3345e22bee78STejun Heo list_for_each_entry(worker, &gcwq->idle_list, entry) { 3346e22bee78STejun Heo if (!nr_works--) 3347e22bee78STejun Heo break; 3348e22bee78STejun Heo wake_up_process(worker->task); 3349e22bee78STejun Heo } 3350e22bee78STejun Heo 3351e22bee78STejun Heo if (need_to_create_worker(gcwq)) { 3352e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 3353e22bee78STejun Heo worker = create_worker(gcwq, false); 3354e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 3355e22bee78STejun Heo if (worker) { 3356cb444766STejun Heo worker->flags |= WORKER_ROGUE; 3357e22bee78STejun Heo start_worker(worker); 3358e22bee78STejun Heo } 3359e22bee78STejun Heo } 3360e22bee78STejun Heo 3361db7bccf4STejun Heo /* give a breather */ 3362db7bccf4STejun Heo if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0) 3363db7bccf4STejun Heo break; 3364db7bccf4STejun Heo } 3365db7bccf4STejun Heo 3366e22bee78STejun Heo /* 3367e22bee78STejun Heo * Either all works have been scheduled and cpu is down, or 3368e22bee78STejun Heo * cpu down has already been canceled. Wait for and butcher 3369e22bee78STejun Heo * all workers till we're canceled. 3370e22bee78STejun Heo */ 3371e22bee78STejun Heo do { 3372e22bee78STejun Heo rc = trustee_wait_event(!list_empty(&gcwq->idle_list)); 3373e22bee78STejun Heo while (!list_empty(&gcwq->idle_list)) 3374e22bee78STejun Heo destroy_worker(list_first_entry(&gcwq->idle_list, 3375e22bee78STejun Heo struct worker, entry)); 3376e22bee78STejun Heo } while (gcwq->nr_workers && rc >= 0); 3377e22bee78STejun Heo 3378e22bee78STejun Heo /* 3379e22bee78STejun Heo * At this point, either draining has completed and no worker 3380e22bee78STejun Heo * is left, or cpu down has been canceled or the cpu is being 3381e22bee78STejun Heo * brought back up. There shouldn't be any idle one left. 3382e22bee78STejun Heo * Tell the remaining busy ones to rebind once it finishes the 3383e22bee78STejun Heo * currently scheduled works by scheduling the rebind_work. 3384e22bee78STejun Heo */ 3385e22bee78STejun Heo WARN_ON(!list_empty(&gcwq->idle_list)); 3386e22bee78STejun Heo 3387e22bee78STejun Heo for_each_busy_worker(worker, i, pos, gcwq) { 3388e22bee78STejun Heo struct work_struct *rebind_work = &worker->rebind_work; 3389e22bee78STejun Heo 3390e22bee78STejun Heo /* 3391e22bee78STejun Heo * Rebind_work may race with future cpu hotplug 3392e22bee78STejun Heo * operations. Use a separate flag to mark that 3393e22bee78STejun Heo * rebinding is scheduled. 3394e22bee78STejun Heo */ 3395cb444766STejun Heo worker->flags |= WORKER_REBIND; 3396cb444766STejun Heo worker->flags &= ~WORKER_ROGUE; 3397e22bee78STejun Heo 3398e22bee78STejun Heo /* queue rebind_work, wq doesn't matter, use the default one */ 3399e22bee78STejun Heo if (test_and_set_bit(WORK_STRUCT_PENDING_BIT, 3400e22bee78STejun Heo work_data_bits(rebind_work))) 3401e22bee78STejun Heo continue; 3402e22bee78STejun Heo 3403e22bee78STejun Heo debug_work_activate(rebind_work); 3404d320c038STejun Heo insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work, 3405e22bee78STejun Heo worker->scheduled.next, 3406e22bee78STejun Heo work_color_to_flags(WORK_NO_COLOR)); 3407e22bee78STejun Heo } 3408e22bee78STejun Heo 3409e22bee78STejun Heo /* relinquish manager role */ 3410e22bee78STejun Heo gcwq->flags &= ~GCWQ_MANAGING_WORKERS; 3411e22bee78STejun Heo 3412db7bccf4STejun Heo /* notify completion */ 3413db7bccf4STejun Heo gcwq->trustee = NULL; 3414db7bccf4STejun Heo gcwq->trustee_state = TRUSTEE_DONE; 3415db7bccf4STejun Heo wake_up_all(&gcwq->trustee_wait); 3416db7bccf4STejun Heo spin_unlock_irq(&gcwq->lock); 3417db7bccf4STejun Heo return 0; 3418db7bccf4STejun Heo } 3419db7bccf4STejun Heo 3420db7bccf4STejun Heo /** 3421db7bccf4STejun Heo * wait_trustee_state - wait for trustee to enter the specified state 3422db7bccf4STejun Heo * @gcwq: gcwq the trustee of interest belongs to 3423db7bccf4STejun Heo * @state: target state to wait for 3424db7bccf4STejun Heo * 3425db7bccf4STejun Heo * Wait for the trustee to reach @state. DONE is already matched. 3426db7bccf4STejun Heo * 3427db7bccf4STejun Heo * CONTEXT: 3428db7bccf4STejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 3429db7bccf4STejun Heo * multiple times. To be used by cpu_callback. 3430db7bccf4STejun Heo */ 3431db7bccf4STejun Heo static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state) 343206bd6ebfSNamhyung Kim __releases(&gcwq->lock) 343306bd6ebfSNamhyung Kim __acquires(&gcwq->lock) 3434db7bccf4STejun Heo { 3435db7bccf4STejun Heo if (!(gcwq->trustee_state == state || 3436db7bccf4STejun Heo gcwq->trustee_state == TRUSTEE_DONE)) { 3437db7bccf4STejun Heo spin_unlock_irq(&gcwq->lock); 3438db7bccf4STejun Heo __wait_event(gcwq->trustee_wait, 3439db7bccf4STejun Heo gcwq->trustee_state == state || 3440db7bccf4STejun Heo gcwq->trustee_state == TRUSTEE_DONE); 3441db7bccf4STejun Heo spin_lock_irq(&gcwq->lock); 3442db7bccf4STejun Heo } 3443db7bccf4STejun Heo } 3444db7bccf4STejun Heo 34459c7b216dSChandra Seetharaman static int __devinit workqueue_cpu_callback(struct notifier_block *nfb, 34461da177e4SLinus Torvalds unsigned long action, 34471da177e4SLinus Torvalds void *hcpu) 34481da177e4SLinus Torvalds { 34493af24433SOleg Nesterov unsigned int cpu = (unsigned long)hcpu; 3450db7bccf4STejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 3451db7bccf4STejun Heo struct task_struct *new_trustee = NULL; 3452e22bee78STejun Heo struct worker *uninitialized_var(new_worker); 3453db7bccf4STejun Heo unsigned long flags; 34541da177e4SLinus Torvalds 34558bb78442SRafael J. Wysocki action &= ~CPU_TASKS_FROZEN; 34568bb78442SRafael J. Wysocki 34571da177e4SLinus Torvalds switch (action) { 3458db7bccf4STejun Heo case CPU_DOWN_PREPARE: 3459db7bccf4STejun Heo new_trustee = kthread_create(trustee_thread, gcwq, 3460db7bccf4STejun Heo "workqueue_trustee/%d\n", cpu); 3461db7bccf4STejun Heo if (IS_ERR(new_trustee)) 3462db7bccf4STejun Heo return notifier_from_errno(PTR_ERR(new_trustee)); 3463db7bccf4STejun Heo kthread_bind(new_trustee, cpu); 3464e22bee78STejun Heo /* fall through */ 34653af24433SOleg Nesterov case CPU_UP_PREPARE: 3466e22bee78STejun Heo BUG_ON(gcwq->first_idle); 3467e22bee78STejun Heo new_worker = create_worker(gcwq, false); 3468e22bee78STejun Heo if (!new_worker) { 3469e22bee78STejun Heo if (new_trustee) 3470e22bee78STejun Heo kthread_stop(new_trustee); 3471e22bee78STejun Heo return NOTIFY_BAD; 34723af24433SOleg Nesterov } 3473db7bccf4STejun Heo } 34741537663fSTejun Heo 3475db7bccf4STejun Heo /* some are called w/ irq disabled, don't disturb irq status */ 3476db7bccf4STejun Heo spin_lock_irqsave(&gcwq->lock, flags); 34773af24433SOleg Nesterov 34783af24433SOleg Nesterov switch (action) { 3479db7bccf4STejun Heo case CPU_DOWN_PREPARE: 3480db7bccf4STejun Heo /* initialize trustee and tell it to acquire the gcwq */ 3481db7bccf4STejun Heo BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE); 3482db7bccf4STejun Heo gcwq->trustee = new_trustee; 3483db7bccf4STejun Heo gcwq->trustee_state = TRUSTEE_START; 3484db7bccf4STejun Heo wake_up_process(gcwq->trustee); 3485db7bccf4STejun Heo wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE); 3486e22bee78STejun Heo /* fall through */ 34873af24433SOleg Nesterov case CPU_UP_PREPARE: 3488e22bee78STejun Heo BUG_ON(gcwq->first_idle); 3489e22bee78STejun Heo gcwq->first_idle = new_worker; 34901da177e4SLinus Torvalds break; 34911da177e4SLinus Torvalds 3492e22bee78STejun Heo case CPU_DYING: 3493e22bee78STejun Heo /* 3494e22bee78STejun Heo * Before this, the trustee and all workers except for 3495e22bee78STejun Heo * the ones which are still executing works from 3496e22bee78STejun Heo * before the last CPU down must be on the cpu. After 3497e22bee78STejun Heo * this, they'll all be diasporas. 3498e22bee78STejun Heo */ 3499e22bee78STejun Heo gcwq->flags |= GCWQ_DISASSOCIATED; 3500db7bccf4STejun Heo break; 3501db7bccf4STejun Heo 35023da1c84cSOleg Nesterov case CPU_POST_DEAD: 3503db7bccf4STejun Heo gcwq->trustee_state = TRUSTEE_BUTCHER; 3504e22bee78STejun Heo /* fall through */ 3505e22bee78STejun Heo case CPU_UP_CANCELED: 3506e22bee78STejun Heo destroy_worker(gcwq->first_idle); 3507e22bee78STejun Heo gcwq->first_idle = NULL; 3508db7bccf4STejun Heo break; 3509db7bccf4STejun Heo 3510db7bccf4STejun Heo case CPU_DOWN_FAILED: 35111da177e4SLinus Torvalds case CPU_ONLINE: 3512e22bee78STejun Heo gcwq->flags &= ~GCWQ_DISASSOCIATED; 3513db7bccf4STejun Heo if (gcwq->trustee_state != TRUSTEE_DONE) { 3514db7bccf4STejun Heo gcwq->trustee_state = TRUSTEE_RELEASE; 3515db7bccf4STejun Heo wake_up_process(gcwq->trustee); 3516db7bccf4STejun Heo wait_trustee_state(gcwq, TRUSTEE_DONE); 3517db7bccf4STejun Heo } 35181da177e4SLinus Torvalds 3519e22bee78STejun Heo /* 3520e22bee78STejun Heo * Trustee is done and there might be no worker left. 3521e22bee78STejun Heo * Put the first_idle in and request a real manager to 3522e22bee78STejun Heo * take a look. 3523e22bee78STejun Heo */ 3524e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 3525e22bee78STejun Heo kthread_bind(gcwq->first_idle->task, cpu); 3526e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 3527e22bee78STejun Heo gcwq->flags |= GCWQ_MANAGE_WORKERS; 3528e22bee78STejun Heo start_worker(gcwq->first_idle); 3529e22bee78STejun Heo gcwq->first_idle = NULL; 35301da177e4SLinus Torvalds break; 35311da177e4SLinus Torvalds } 35321da177e4SLinus Torvalds 3533db7bccf4STejun Heo spin_unlock_irqrestore(&gcwq->lock, flags); 353400dfcaf7SOleg Nesterov 35351537663fSTejun Heo return notifier_from_errno(0); 35361da177e4SLinus Torvalds } 35371da177e4SLinus Torvalds 35382d3854a3SRusty Russell #ifdef CONFIG_SMP 35398ccad40dSRusty Russell 35402d3854a3SRusty Russell struct work_for_cpu { 35416b44003eSAndrew Morton struct completion completion; 35422d3854a3SRusty Russell long (*fn)(void *); 35432d3854a3SRusty Russell void *arg; 35442d3854a3SRusty Russell long ret; 35452d3854a3SRusty Russell }; 35462d3854a3SRusty Russell 35476b44003eSAndrew Morton static int do_work_for_cpu(void *_wfc) 35482d3854a3SRusty Russell { 35496b44003eSAndrew Morton struct work_for_cpu *wfc = _wfc; 35502d3854a3SRusty Russell wfc->ret = wfc->fn(wfc->arg); 35516b44003eSAndrew Morton complete(&wfc->completion); 35526b44003eSAndrew Morton return 0; 35532d3854a3SRusty Russell } 35542d3854a3SRusty Russell 35552d3854a3SRusty Russell /** 35562d3854a3SRusty Russell * work_on_cpu - run a function in user context on a particular cpu 35572d3854a3SRusty Russell * @cpu: the cpu to run on 35582d3854a3SRusty Russell * @fn: the function to run 35592d3854a3SRusty Russell * @arg: the function arg 35602d3854a3SRusty Russell * 356131ad9081SRusty Russell * This will return the value @fn returns. 356231ad9081SRusty Russell * It is up to the caller to ensure that the cpu doesn't go offline. 35636b44003eSAndrew Morton * The caller must not hold any locks which would prevent @fn from completing. 35642d3854a3SRusty Russell */ 35652d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg) 35662d3854a3SRusty Russell { 35676b44003eSAndrew Morton struct task_struct *sub_thread; 35686b44003eSAndrew Morton struct work_for_cpu wfc = { 35696b44003eSAndrew Morton .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion), 35706b44003eSAndrew Morton .fn = fn, 35716b44003eSAndrew Morton .arg = arg, 35726b44003eSAndrew Morton }; 35732d3854a3SRusty Russell 35746b44003eSAndrew Morton sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu"); 35756b44003eSAndrew Morton if (IS_ERR(sub_thread)) 35766b44003eSAndrew Morton return PTR_ERR(sub_thread); 35776b44003eSAndrew Morton kthread_bind(sub_thread, cpu); 35786b44003eSAndrew Morton wake_up_process(sub_thread); 35796b44003eSAndrew Morton wait_for_completion(&wfc.completion); 35802d3854a3SRusty Russell return wfc.ret; 35812d3854a3SRusty Russell } 35822d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu); 35832d3854a3SRusty Russell #endif /* CONFIG_SMP */ 35842d3854a3SRusty Russell 3585a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 3586e7577c50SRusty Russell 3587a0a1a5fdSTejun Heo /** 3588a0a1a5fdSTejun Heo * freeze_workqueues_begin - begin freezing workqueues 3589a0a1a5fdSTejun Heo * 359058a69cb4STejun Heo * Start freezing workqueues. After this function returns, all freezable 359158a69cb4STejun Heo * workqueues will queue new works to their frozen_works list instead of 359258a69cb4STejun Heo * gcwq->worklist. 3593a0a1a5fdSTejun Heo * 3594a0a1a5fdSTejun Heo * CONTEXT: 35958b03ae3cSTejun Heo * Grabs and releases workqueue_lock and gcwq->lock's. 3596a0a1a5fdSTejun Heo */ 3597a0a1a5fdSTejun Heo void freeze_workqueues_begin(void) 3598a0a1a5fdSTejun Heo { 3599a0a1a5fdSTejun Heo unsigned int cpu; 3600a0a1a5fdSTejun Heo 3601a0a1a5fdSTejun Heo spin_lock(&workqueue_lock); 3602a0a1a5fdSTejun Heo 3603a0a1a5fdSTejun Heo BUG_ON(workqueue_freezing); 3604a0a1a5fdSTejun Heo workqueue_freezing = true; 3605a0a1a5fdSTejun Heo 3606f3421797STejun Heo for_each_gcwq_cpu(cpu) { 36078b03ae3cSTejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 3608bdbc5dd7STejun Heo struct workqueue_struct *wq; 36098b03ae3cSTejun Heo 36108b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 36118b03ae3cSTejun Heo 3612db7bccf4STejun Heo BUG_ON(gcwq->flags & GCWQ_FREEZING); 3613db7bccf4STejun Heo gcwq->flags |= GCWQ_FREEZING; 3614db7bccf4STejun Heo 3615a0a1a5fdSTejun Heo list_for_each_entry(wq, &workqueues, list) { 3616a0a1a5fdSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 3617a0a1a5fdSTejun Heo 361858a69cb4STejun Heo if (cwq && wq->flags & WQ_FREEZABLE) 3619a0a1a5fdSTejun Heo cwq->max_active = 0; 36201da177e4SLinus Torvalds } 36218b03ae3cSTejun Heo 36228b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 3623a0a1a5fdSTejun Heo } 3624a0a1a5fdSTejun Heo 3625a0a1a5fdSTejun Heo spin_unlock(&workqueue_lock); 3626a0a1a5fdSTejun Heo } 3627a0a1a5fdSTejun Heo 3628a0a1a5fdSTejun Heo /** 362958a69cb4STejun Heo * freeze_workqueues_busy - are freezable workqueues still busy? 3630a0a1a5fdSTejun Heo * 3631a0a1a5fdSTejun Heo * Check whether freezing is complete. This function must be called 3632a0a1a5fdSTejun Heo * between freeze_workqueues_begin() and thaw_workqueues(). 3633a0a1a5fdSTejun Heo * 3634a0a1a5fdSTejun Heo * CONTEXT: 3635a0a1a5fdSTejun Heo * Grabs and releases workqueue_lock. 3636a0a1a5fdSTejun Heo * 3637a0a1a5fdSTejun Heo * RETURNS: 363858a69cb4STejun Heo * %true if some freezable workqueues are still busy. %false if freezing 363958a69cb4STejun Heo * is complete. 3640a0a1a5fdSTejun Heo */ 3641a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void) 3642a0a1a5fdSTejun Heo { 3643a0a1a5fdSTejun Heo unsigned int cpu; 3644a0a1a5fdSTejun Heo bool busy = false; 3645a0a1a5fdSTejun Heo 3646a0a1a5fdSTejun Heo spin_lock(&workqueue_lock); 3647a0a1a5fdSTejun Heo 3648a0a1a5fdSTejun Heo BUG_ON(!workqueue_freezing); 3649a0a1a5fdSTejun Heo 3650f3421797STejun Heo for_each_gcwq_cpu(cpu) { 3651bdbc5dd7STejun Heo struct workqueue_struct *wq; 3652a0a1a5fdSTejun Heo /* 3653a0a1a5fdSTejun Heo * nr_active is monotonically decreasing. It's safe 3654a0a1a5fdSTejun Heo * to peek without lock. 3655a0a1a5fdSTejun Heo */ 3656a0a1a5fdSTejun Heo list_for_each_entry(wq, &workqueues, list) { 3657a0a1a5fdSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 3658a0a1a5fdSTejun Heo 365958a69cb4STejun Heo if (!cwq || !(wq->flags & WQ_FREEZABLE)) 3660a0a1a5fdSTejun Heo continue; 3661a0a1a5fdSTejun Heo 3662a0a1a5fdSTejun Heo BUG_ON(cwq->nr_active < 0); 3663a0a1a5fdSTejun Heo if (cwq->nr_active) { 3664a0a1a5fdSTejun Heo busy = true; 3665a0a1a5fdSTejun Heo goto out_unlock; 3666a0a1a5fdSTejun Heo } 3667a0a1a5fdSTejun Heo } 3668a0a1a5fdSTejun Heo } 3669a0a1a5fdSTejun Heo out_unlock: 3670a0a1a5fdSTejun Heo spin_unlock(&workqueue_lock); 3671a0a1a5fdSTejun Heo return busy; 3672a0a1a5fdSTejun Heo } 3673a0a1a5fdSTejun Heo 3674a0a1a5fdSTejun Heo /** 3675a0a1a5fdSTejun Heo * thaw_workqueues - thaw workqueues 3676a0a1a5fdSTejun Heo * 3677a0a1a5fdSTejun Heo * Thaw workqueues. Normal queueing is restored and all collected 36787e11629dSTejun Heo * frozen works are transferred to their respective gcwq worklists. 3679a0a1a5fdSTejun Heo * 3680a0a1a5fdSTejun Heo * CONTEXT: 36818b03ae3cSTejun Heo * Grabs and releases workqueue_lock and gcwq->lock's. 3682a0a1a5fdSTejun Heo */ 3683a0a1a5fdSTejun Heo void thaw_workqueues(void) 3684a0a1a5fdSTejun Heo { 3685a0a1a5fdSTejun Heo unsigned int cpu; 3686a0a1a5fdSTejun Heo 3687a0a1a5fdSTejun Heo spin_lock(&workqueue_lock); 3688a0a1a5fdSTejun Heo 3689a0a1a5fdSTejun Heo if (!workqueue_freezing) 3690a0a1a5fdSTejun Heo goto out_unlock; 3691a0a1a5fdSTejun Heo 3692f3421797STejun Heo for_each_gcwq_cpu(cpu) { 36938b03ae3cSTejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 3694bdbc5dd7STejun Heo struct workqueue_struct *wq; 36958b03ae3cSTejun Heo 36968b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 36978b03ae3cSTejun Heo 3698db7bccf4STejun Heo BUG_ON(!(gcwq->flags & GCWQ_FREEZING)); 3699db7bccf4STejun Heo gcwq->flags &= ~GCWQ_FREEZING; 3700db7bccf4STejun Heo 3701a0a1a5fdSTejun Heo list_for_each_entry(wq, &workqueues, list) { 3702a0a1a5fdSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 3703a0a1a5fdSTejun Heo 370458a69cb4STejun Heo if (!cwq || !(wq->flags & WQ_FREEZABLE)) 3705a0a1a5fdSTejun Heo continue; 3706a0a1a5fdSTejun Heo 3707a0a1a5fdSTejun Heo /* restore max_active and repopulate worklist */ 3708a0a1a5fdSTejun Heo cwq->max_active = wq->saved_max_active; 3709a0a1a5fdSTejun Heo 3710a0a1a5fdSTejun Heo while (!list_empty(&cwq->delayed_works) && 3711a0a1a5fdSTejun Heo cwq->nr_active < cwq->max_active) 3712a0a1a5fdSTejun Heo cwq_activate_first_delayed(cwq); 3713a0a1a5fdSTejun Heo } 37148b03ae3cSTejun Heo 3715e22bee78STejun Heo wake_up_worker(gcwq); 3716e22bee78STejun Heo 37178b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 3718a0a1a5fdSTejun Heo } 3719a0a1a5fdSTejun Heo 3720a0a1a5fdSTejun Heo workqueue_freezing = false; 3721a0a1a5fdSTejun Heo out_unlock: 3722a0a1a5fdSTejun Heo spin_unlock(&workqueue_lock); 3723a0a1a5fdSTejun Heo } 3724a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 3725a0a1a5fdSTejun Heo 37266ee0578bSSuresh Siddha static int __init init_workqueues(void) 37271da177e4SLinus Torvalds { 3728c34056a3STejun Heo unsigned int cpu; 3729c8e55f36STejun Heo int i; 3730c34056a3STejun Heo 3731f6500947STejun Heo cpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE); 37328b03ae3cSTejun Heo 37338b03ae3cSTejun Heo /* initialize gcwqs */ 3734f3421797STejun Heo for_each_gcwq_cpu(cpu) { 37358b03ae3cSTejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 37368b03ae3cSTejun Heo 37378b03ae3cSTejun Heo spin_lock_init(&gcwq->lock); 37387e11629dSTejun Heo INIT_LIST_HEAD(&gcwq->worklist); 37398b03ae3cSTejun Heo gcwq->cpu = cpu; 3740f3421797STejun Heo gcwq->flags |= GCWQ_DISASSOCIATED; 37418b03ae3cSTejun Heo 3742c8e55f36STejun Heo INIT_LIST_HEAD(&gcwq->idle_list); 3743c8e55f36STejun Heo for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) 3744c8e55f36STejun Heo INIT_HLIST_HEAD(&gcwq->busy_hash[i]); 3745c8e55f36STejun Heo 3746e22bee78STejun Heo init_timer_deferrable(&gcwq->idle_timer); 3747e22bee78STejun Heo gcwq->idle_timer.function = idle_worker_timeout; 3748e22bee78STejun Heo gcwq->idle_timer.data = (unsigned long)gcwq; 3749e22bee78STejun Heo 3750e22bee78STejun Heo setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout, 3751e22bee78STejun Heo (unsigned long)gcwq); 3752e22bee78STejun Heo 37538b03ae3cSTejun Heo ida_init(&gcwq->worker_ida); 3754db7bccf4STejun Heo 3755db7bccf4STejun Heo gcwq->trustee_state = TRUSTEE_DONE; 3756db7bccf4STejun Heo init_waitqueue_head(&gcwq->trustee_wait); 37578b03ae3cSTejun Heo } 37588b03ae3cSTejun Heo 3759e22bee78STejun Heo /* create the initial worker */ 3760f3421797STejun Heo for_each_online_gcwq_cpu(cpu) { 3761e22bee78STejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 3762e22bee78STejun Heo struct worker *worker; 3763e22bee78STejun Heo 3764477a3c33STejun Heo if (cpu != WORK_CPU_UNBOUND) 3765477a3c33STejun Heo gcwq->flags &= ~GCWQ_DISASSOCIATED; 3766e22bee78STejun Heo worker = create_worker(gcwq, true); 3767e22bee78STejun Heo BUG_ON(!worker); 3768e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 3769e22bee78STejun Heo start_worker(worker); 3770e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 3771e22bee78STejun Heo } 3772e22bee78STejun Heo 3773d320c038STejun Heo system_wq = alloc_workqueue("events", 0, 0); 3774d320c038STejun Heo system_long_wq = alloc_workqueue("events_long", 0, 0); 3775d320c038STejun Heo system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0); 3776f3421797STejun Heo system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, 3777f3421797STejun Heo WQ_UNBOUND_MAX_ACTIVE); 3778e5cba24eSHitoshi Mitake BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq || 3779e5cba24eSHitoshi Mitake !system_unbound_wq); 37806ee0578bSSuresh Siddha return 0; 37811da177e4SLinus Torvalds } 37826ee0578bSSuresh Siddha early_initcall(init_workqueues); 3783