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 82e22bee78STejun Heo MAYDAY_INITIAL_TIMEOUT = HZ / 100, /* call for help after 10ms */ 83e22bee78STejun Heo MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */ 84e22bee78STejun Heo CREATE_COOLDOWN = HZ, /* time to breath after fail */ 85db7bccf4STejun Heo TRUSTEE_COOLDOWN = HZ / 10, /* for trustee draining */ 861da177e4SLinus Torvalds 871da177e4SLinus Torvalds /* 88e22bee78STejun Heo * Rescue workers are used only on emergencies and shared by 89e22bee78STejun Heo * all cpus. Give -20. 90e22bee78STejun Heo */ 91e22bee78STejun Heo RESCUER_NICE_LEVEL = -20, 92c8e55f36STejun Heo }; 93c8e55f36STejun Heo 941da177e4SLinus Torvalds /* 954690c4abSTejun Heo * Structure fields follow one of the following exclusion rules. 964690c4abSTejun Heo * 97e41e704bSTejun Heo * I: Modifiable by initialization/destruction paths and read-only for 98e41e704bSTejun Heo * everyone else. 994690c4abSTejun Heo * 100e22bee78STejun Heo * P: Preemption protected. Disabling preemption is enough and should 101e22bee78STejun Heo * only be modified and accessed from the local cpu. 102e22bee78STejun Heo * 1038b03ae3cSTejun Heo * L: gcwq->lock protected. Access with gcwq->lock held. 1044690c4abSTejun Heo * 105e22bee78STejun Heo * X: During normal operation, modification requires gcwq->lock and 106e22bee78STejun Heo * should be done only from local cpu. Either disabling preemption 107e22bee78STejun Heo * on local cpu or grabbing gcwq->lock is enough for read access. 108f3421797STejun Heo * If GCWQ_DISASSOCIATED is set, it's identical to L. 109e22bee78STejun Heo * 11073f53c4aSTejun Heo * F: wq->flush_mutex protected. 11173f53c4aSTejun Heo * 1124690c4abSTejun Heo * W: workqueue_lock protected. 1134690c4abSTejun Heo */ 1144690c4abSTejun Heo 1158b03ae3cSTejun Heo struct global_cwq; 116c34056a3STejun Heo 117e22bee78STejun Heo /* 118e22bee78STejun Heo * The poor guys doing the actual heavy lifting. All on-duty workers 119e22bee78STejun Heo * are either serving the manager role, on idle list or on busy hash. 120e22bee78STejun Heo */ 121c34056a3STejun Heo struct worker { 122c8e55f36STejun Heo /* on idle list while idle, on busy hash table while busy */ 123c8e55f36STejun Heo union { 124c8e55f36STejun Heo struct list_head entry; /* L: while idle */ 125c8e55f36STejun Heo struct hlist_node hentry; /* L: while busy */ 126c8e55f36STejun Heo }; 127c8e55f36STejun Heo 128c34056a3STejun Heo struct work_struct *current_work; /* L: work being processed */ 1298cca0eeaSTejun Heo struct cpu_workqueue_struct *current_cwq; /* L: current_work's cwq */ 130affee4b2STejun Heo struct list_head scheduled; /* L: scheduled works */ 131c34056a3STejun Heo struct task_struct *task; /* I: worker task */ 1328b03ae3cSTejun Heo struct global_cwq *gcwq; /* I: the associated gcwq */ 133e22bee78STejun Heo /* 64 bytes boundary on 64bit, 32 on 32bit */ 134e22bee78STejun Heo unsigned long last_active; /* L: last active timestamp */ 135e22bee78STejun Heo unsigned int flags; /* X: flags */ 136c34056a3STejun Heo int id; /* I: worker id */ 137e22bee78STejun Heo struct work_struct rebind_work; /* L: rebind worker to cpu */ 138c34056a3STejun Heo }; 139c34056a3STejun Heo 1404690c4abSTejun Heo /* 141e22bee78STejun Heo * Global per-cpu workqueue. There's one and only one for each cpu 142e22bee78STejun Heo * and all works are queued and processed here regardless of their 143e22bee78STejun Heo * target workqueues. 1448b03ae3cSTejun Heo */ 1458b03ae3cSTejun Heo struct global_cwq { 1468b03ae3cSTejun Heo spinlock_t lock; /* the gcwq lock */ 1477e11629dSTejun Heo struct list_head worklist; /* L: list of pending works */ 1488b03ae3cSTejun Heo unsigned int cpu; /* I: the associated cpu */ 149db7bccf4STejun Heo unsigned int flags; /* L: GCWQ_* flags */ 150c8e55f36STejun Heo 151c8e55f36STejun Heo int nr_workers; /* L: total number of workers */ 152c8e55f36STejun Heo int nr_idle; /* L: currently idle ones */ 153c8e55f36STejun Heo 154c8e55f36STejun Heo /* workers are chained either in the idle_list or busy_hash */ 155e22bee78STejun Heo struct list_head idle_list; /* X: list of idle workers */ 156c8e55f36STejun Heo struct hlist_head busy_hash[BUSY_WORKER_HASH_SIZE]; 157c8e55f36STejun Heo /* L: hash of busy workers */ 158c8e55f36STejun Heo 159e22bee78STejun Heo struct timer_list idle_timer; /* L: worker idle timeout */ 160e22bee78STejun Heo struct timer_list mayday_timer; /* L: SOS timer for dworkers */ 161e22bee78STejun Heo 1628b03ae3cSTejun Heo struct ida worker_ida; /* L: for worker IDs */ 163db7bccf4STejun Heo 164db7bccf4STejun Heo struct task_struct *trustee; /* L: for gcwq shutdown */ 165db7bccf4STejun Heo unsigned int trustee_state; /* L: trustee state */ 166db7bccf4STejun Heo wait_queue_head_t trustee_wait; /* trustee wait */ 167e22bee78STejun Heo struct worker *first_idle; /* L: first idle worker */ 1688b03ae3cSTejun Heo } ____cacheline_aligned_in_smp; 1698b03ae3cSTejun Heo 1708b03ae3cSTejun Heo /* 171502ca9d8STejun Heo * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of 1720f900049STejun Heo * work_struct->data are used for flags and thus cwqs need to be 1730f900049STejun Heo * aligned at two's power of the number of flag bits. 1741da177e4SLinus Torvalds */ 1751da177e4SLinus Torvalds struct cpu_workqueue_struct { 1768b03ae3cSTejun Heo struct global_cwq *gcwq; /* I: the associated gcwq */ 1774690c4abSTejun Heo struct workqueue_struct *wq; /* I: the owning workqueue */ 17873f53c4aSTejun Heo int work_color; /* L: current color */ 17973f53c4aSTejun Heo int flush_color; /* L: flushing color */ 18073f53c4aSTejun Heo int nr_in_flight[WORK_NR_COLORS]; 18173f53c4aSTejun Heo /* L: nr of in_flight works */ 1821e19ffc6STejun Heo int nr_active; /* L: nr of active works */ 183a0a1a5fdSTejun Heo int max_active; /* L: max active works */ 1841e19ffc6STejun Heo struct list_head delayed_works; /* L: delayed works */ 1850f900049STejun Heo }; 1861da177e4SLinus Torvalds 1871da177e4SLinus Torvalds /* 18873f53c4aSTejun Heo * Structure used to wait for workqueue flush. 18973f53c4aSTejun Heo */ 19073f53c4aSTejun Heo struct wq_flusher { 19173f53c4aSTejun Heo struct list_head list; /* F: list of flushers */ 19273f53c4aSTejun Heo int flush_color; /* F: flush color waiting for */ 19373f53c4aSTejun Heo struct completion done; /* flush completion */ 19473f53c4aSTejun Heo }; 1951da177e4SLinus Torvalds 19673f53c4aSTejun Heo /* 197f2e005aaSTejun Heo * All cpumasks are assumed to be always set on UP and thus can't be 198f2e005aaSTejun Heo * used to determine whether there's something to be done. 199f2e005aaSTejun Heo */ 200f2e005aaSTejun Heo #ifdef CONFIG_SMP 201f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t; 202f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask) \ 203f2e005aaSTejun Heo cpumask_test_and_set_cpu((cpu), (mask)) 204f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask)) 205f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask)) 2069c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp)) 207f2e005aaSTejun Heo #define free_mayday_mask(mask) free_cpumask_var((mask)) 208f2e005aaSTejun Heo #else 209f2e005aaSTejun Heo typedef unsigned long mayday_mask_t; 210f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask)) 211f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask)) 212f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask)) 213f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp) true 214f2e005aaSTejun Heo #define free_mayday_mask(mask) do { } while (0) 215f2e005aaSTejun Heo #endif 2161da177e4SLinus Torvalds 2171da177e4SLinus Torvalds /* 2181da177e4SLinus Torvalds * The externally visible workqueue abstraction is an array of 2191da177e4SLinus Torvalds * per-CPU workqueues: 2201da177e4SLinus Torvalds */ 2211da177e4SLinus Torvalds struct workqueue_struct { 22297e37d7bSTejun Heo unsigned int flags; /* I: WQ_* flags */ 223bdbc5dd7STejun Heo union { 224bdbc5dd7STejun Heo struct cpu_workqueue_struct __percpu *pcpu; 225bdbc5dd7STejun Heo struct cpu_workqueue_struct *single; 226bdbc5dd7STejun Heo unsigned long v; 227bdbc5dd7STejun Heo } cpu_wq; /* I: cwq's */ 2284690c4abSTejun Heo struct list_head list; /* W: list of all workqueues */ 22973f53c4aSTejun Heo 23073f53c4aSTejun Heo struct mutex flush_mutex; /* protects wq flushing */ 23173f53c4aSTejun Heo int work_color; /* F: current work color */ 23273f53c4aSTejun Heo int flush_color; /* F: current flush color */ 23373f53c4aSTejun Heo atomic_t nr_cwqs_to_flush; /* flush in progress */ 23473f53c4aSTejun Heo struct wq_flusher *first_flusher; /* F: first flusher */ 23573f53c4aSTejun Heo struct list_head flusher_queue; /* F: flush waiters */ 23673f53c4aSTejun Heo struct list_head flusher_overflow; /* F: flush overflow list */ 23773f53c4aSTejun Heo 238f2e005aaSTejun Heo mayday_mask_t mayday_mask; /* cpus requesting rescue */ 239e22bee78STejun Heo struct worker *rescuer; /* I: rescue worker */ 240e22bee78STejun Heo 241dcd989cbSTejun Heo int saved_max_active; /* W: saved cwq max_active */ 2424690c4abSTejun Heo const char *name; /* I: workqueue name */ 2434e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 2444e6045f1SJohannes Berg struct lockdep_map lockdep_map; 2454e6045f1SJohannes Berg #endif 2461da177e4SLinus Torvalds }; 2471da177e4SLinus Torvalds 248d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly; 249d320c038STejun Heo struct workqueue_struct *system_long_wq __read_mostly; 250d320c038STejun Heo struct workqueue_struct *system_nrt_wq __read_mostly; 251f3421797STejun Heo struct workqueue_struct *system_unbound_wq __read_mostly; 252d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq); 253d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq); 254d320c038STejun Heo EXPORT_SYMBOL_GPL(system_nrt_wq); 255f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq); 256d320c038STejun Heo 25797bd2347STejun Heo #define CREATE_TRACE_POINTS 25897bd2347STejun Heo #include <trace/events/workqueue.h> 25997bd2347STejun Heo 260db7bccf4STejun Heo #define for_each_busy_worker(worker, i, pos, gcwq) \ 261db7bccf4STejun Heo for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) \ 262db7bccf4STejun Heo hlist_for_each_entry(worker, pos, &gcwq->busy_hash[i], hentry) 263db7bccf4STejun Heo 264f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask, 265f3421797STejun Heo unsigned int sw) 266f3421797STejun Heo { 267f3421797STejun Heo if (cpu < nr_cpu_ids) { 268f3421797STejun Heo if (sw & 1) { 269f3421797STejun Heo cpu = cpumask_next(cpu, mask); 270f3421797STejun Heo if (cpu < nr_cpu_ids) 271f3421797STejun Heo return cpu; 272f3421797STejun Heo } 273f3421797STejun Heo if (sw & 2) 274f3421797STejun Heo return WORK_CPU_UNBOUND; 275f3421797STejun Heo } 276f3421797STejun Heo return WORK_CPU_NONE; 277f3421797STejun Heo } 278f3421797STejun Heo 279f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask, 280f3421797STejun Heo struct workqueue_struct *wq) 281f3421797STejun Heo { 282f3421797STejun Heo return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2); 283f3421797STejun Heo } 284f3421797STejun Heo 28509884951STejun Heo /* 28609884951STejun Heo * CPU iterators 28709884951STejun Heo * 28809884951STejun Heo * An extra gcwq is defined for an invalid cpu number 28909884951STejun Heo * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any 29009884951STejun Heo * specific CPU. The following iterators are similar to 29109884951STejun Heo * for_each_*_cpu() iterators but also considers the unbound gcwq. 29209884951STejun Heo * 29309884951STejun Heo * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND 29409884951STejun Heo * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND 29509884951STejun Heo * for_each_cwq_cpu() : possible CPUs for bound workqueues, 29609884951STejun Heo * WORK_CPU_UNBOUND for unbound workqueues 29709884951STejun Heo */ 298f3421797STejun Heo #define for_each_gcwq_cpu(cpu) \ 299f3421797STejun Heo for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \ 300f3421797STejun Heo (cpu) < WORK_CPU_NONE; \ 301f3421797STejun Heo (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3)) 302f3421797STejun Heo 303f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu) \ 304f3421797STejun Heo for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \ 305f3421797STejun Heo (cpu) < WORK_CPU_NONE; \ 306f3421797STejun Heo (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3)) 307f3421797STejun Heo 308f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq) \ 309f3421797STejun Heo for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \ 310f3421797STejun Heo (cpu) < WORK_CPU_NONE; \ 311f3421797STejun Heo (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq))) 312f3421797STejun Heo 313dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 314dc186ad7SThomas Gleixner 315dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr; 316dc186ad7SThomas Gleixner 317dc186ad7SThomas Gleixner /* 318dc186ad7SThomas Gleixner * fixup_init is called when: 319dc186ad7SThomas Gleixner * - an active object is initialized 320dc186ad7SThomas Gleixner */ 321dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state) 322dc186ad7SThomas Gleixner { 323dc186ad7SThomas Gleixner struct work_struct *work = addr; 324dc186ad7SThomas Gleixner 325dc186ad7SThomas Gleixner switch (state) { 326dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 327dc186ad7SThomas Gleixner cancel_work_sync(work); 328dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 329dc186ad7SThomas Gleixner return 1; 330dc186ad7SThomas Gleixner default: 331dc186ad7SThomas Gleixner return 0; 332dc186ad7SThomas Gleixner } 333dc186ad7SThomas Gleixner } 334dc186ad7SThomas Gleixner 335dc186ad7SThomas Gleixner /* 336dc186ad7SThomas Gleixner * fixup_activate is called when: 337dc186ad7SThomas Gleixner * - an active object is activated 338dc186ad7SThomas Gleixner * - an unknown object is activated (might be a statically initialized object) 339dc186ad7SThomas Gleixner */ 340dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state) 341dc186ad7SThomas Gleixner { 342dc186ad7SThomas Gleixner struct work_struct *work = addr; 343dc186ad7SThomas Gleixner 344dc186ad7SThomas Gleixner switch (state) { 345dc186ad7SThomas Gleixner 346dc186ad7SThomas Gleixner case ODEBUG_STATE_NOTAVAILABLE: 347dc186ad7SThomas Gleixner /* 348dc186ad7SThomas Gleixner * This is not really a fixup. The work struct was 349dc186ad7SThomas Gleixner * statically initialized. We just make sure that it 350dc186ad7SThomas Gleixner * is tracked in the object tracker. 351dc186ad7SThomas Gleixner */ 35222df02bbSTejun Heo if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) { 353dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 354dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 355dc186ad7SThomas Gleixner return 0; 356dc186ad7SThomas Gleixner } 357dc186ad7SThomas Gleixner WARN_ON_ONCE(1); 358dc186ad7SThomas Gleixner return 0; 359dc186ad7SThomas Gleixner 360dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 361dc186ad7SThomas Gleixner WARN_ON(1); 362dc186ad7SThomas Gleixner 363dc186ad7SThomas Gleixner default: 364dc186ad7SThomas Gleixner return 0; 365dc186ad7SThomas Gleixner } 366dc186ad7SThomas Gleixner } 367dc186ad7SThomas Gleixner 368dc186ad7SThomas Gleixner /* 369dc186ad7SThomas Gleixner * fixup_free is called when: 370dc186ad7SThomas Gleixner * - an active object is freed 371dc186ad7SThomas Gleixner */ 372dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state) 373dc186ad7SThomas Gleixner { 374dc186ad7SThomas Gleixner struct work_struct *work = addr; 375dc186ad7SThomas Gleixner 376dc186ad7SThomas Gleixner switch (state) { 377dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 378dc186ad7SThomas Gleixner cancel_work_sync(work); 379dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 380dc186ad7SThomas Gleixner return 1; 381dc186ad7SThomas Gleixner default: 382dc186ad7SThomas Gleixner return 0; 383dc186ad7SThomas Gleixner } 384dc186ad7SThomas Gleixner } 385dc186ad7SThomas Gleixner 386dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = { 387dc186ad7SThomas Gleixner .name = "work_struct", 388dc186ad7SThomas Gleixner .fixup_init = work_fixup_init, 389dc186ad7SThomas Gleixner .fixup_activate = work_fixup_activate, 390dc186ad7SThomas Gleixner .fixup_free = work_fixup_free, 391dc186ad7SThomas Gleixner }; 392dc186ad7SThomas Gleixner 393dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) 394dc186ad7SThomas Gleixner { 395dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 396dc186ad7SThomas Gleixner } 397dc186ad7SThomas Gleixner 398dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) 399dc186ad7SThomas Gleixner { 400dc186ad7SThomas Gleixner debug_object_deactivate(work, &work_debug_descr); 401dc186ad7SThomas Gleixner } 402dc186ad7SThomas Gleixner 403dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack) 404dc186ad7SThomas Gleixner { 405dc186ad7SThomas Gleixner if (onstack) 406dc186ad7SThomas Gleixner debug_object_init_on_stack(work, &work_debug_descr); 407dc186ad7SThomas Gleixner else 408dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 409dc186ad7SThomas Gleixner } 410dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work); 411dc186ad7SThomas Gleixner 412dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work) 413dc186ad7SThomas Gleixner { 414dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 415dc186ad7SThomas Gleixner } 416dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack); 417dc186ad7SThomas Gleixner 418dc186ad7SThomas Gleixner #else 419dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { } 420dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { } 421dc186ad7SThomas Gleixner #endif 422dc186ad7SThomas Gleixner 42395402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */ 42495402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock); 4251da177e4SLinus Torvalds static LIST_HEAD(workqueues); 426a0a1a5fdSTejun Heo static bool workqueue_freezing; /* W: have wqs started freezing? */ 4271da177e4SLinus Torvalds 42814441960SOleg Nesterov /* 429e22bee78STejun Heo * The almighty global cpu workqueues. nr_running is the only field 430e22bee78STejun Heo * which is expected to be used frequently by other cpus via 431e22bee78STejun Heo * try_to_wake_up(). Put it in a separate cacheline. 43214441960SOleg Nesterov */ 4338b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq); 434e22bee78STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, gcwq_nr_running); 435f756d5e2SNathan Lynch 436f3421797STejun Heo /* 437f3421797STejun Heo * Global cpu workqueue and nr_running counter for unbound gcwq. The 438f3421797STejun Heo * gcwq is always online, has GCWQ_DISASSOCIATED set, and all its 439f3421797STejun Heo * workers have WORKER_UNBOUND set. 440f3421797STejun Heo */ 441f3421797STejun Heo static struct global_cwq unbound_global_cwq; 442f3421797STejun Heo static atomic_t unbound_gcwq_nr_running = ATOMIC_INIT(0); /* always 0 */ 443f3421797STejun Heo 444c34056a3STejun Heo static int worker_thread(void *__worker); 4451da177e4SLinus Torvalds 4468b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu) 4471da177e4SLinus Torvalds { 448f3421797STejun Heo if (cpu != WORK_CPU_UNBOUND) 4498b03ae3cSTejun Heo return &per_cpu(global_cwq, cpu); 450f3421797STejun Heo else 451f3421797STejun Heo return &unbound_global_cwq; 4521da177e4SLinus Torvalds } 4531da177e4SLinus Torvalds 454e22bee78STejun Heo static atomic_t *get_gcwq_nr_running(unsigned int cpu) 455b1f4ec17SOleg Nesterov { 456f3421797STejun Heo if (cpu != WORK_CPU_UNBOUND) 457e22bee78STejun Heo return &per_cpu(gcwq_nr_running, cpu); 458f3421797STejun Heo else 459f3421797STejun Heo return &unbound_gcwq_nr_running; 460b1f4ec17SOleg Nesterov } 461b1f4ec17SOleg Nesterov 4624690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu, 4634690c4abSTejun Heo struct workqueue_struct *wq) 464a848e3b6SOleg Nesterov { 465f3421797STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 466f3421797STejun Heo if (likely(cpu < nr_cpu_ids)) { 467f3421797STejun Heo #ifdef CONFIG_SMP 468bdbc5dd7STejun Heo return per_cpu_ptr(wq->cpu_wq.pcpu, cpu); 469f3421797STejun Heo #else 470f3421797STejun Heo return wq->cpu_wq.single; 471bdbc5dd7STejun Heo #endif 472a848e3b6SOleg Nesterov } 473f3421797STejun Heo } else if (likely(cpu == WORK_CPU_UNBOUND)) 474f3421797STejun Heo return wq->cpu_wq.single; 475f3421797STejun Heo return NULL; 476f3421797STejun Heo } 477a848e3b6SOleg Nesterov 47873f53c4aSTejun Heo static unsigned int work_color_to_flags(int color) 47973f53c4aSTejun Heo { 48073f53c4aSTejun Heo return color << WORK_STRUCT_COLOR_SHIFT; 48173f53c4aSTejun Heo } 48273f53c4aSTejun Heo 48373f53c4aSTejun Heo static int get_work_color(struct work_struct *work) 48473f53c4aSTejun Heo { 48573f53c4aSTejun Heo return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) & 48673f53c4aSTejun Heo ((1 << WORK_STRUCT_COLOR_BITS) - 1); 48773f53c4aSTejun Heo } 48873f53c4aSTejun Heo 48973f53c4aSTejun Heo static int work_next_color(int color) 49073f53c4aSTejun Heo { 49173f53c4aSTejun Heo return (color + 1) % WORK_NR_COLORS; 4921da177e4SLinus Torvalds } 4931da177e4SLinus Torvalds 4944594bf15SDavid Howells /* 495e120153dSTejun Heo * A work's data points to the cwq with WORK_STRUCT_CWQ set while the 496e120153dSTejun Heo * work is on queue. Once execution starts, WORK_STRUCT_CWQ is 497e120153dSTejun Heo * cleared and the work data contains the cpu number it was last on. 4987a22ad75STejun Heo * 4997a22ad75STejun Heo * set_work_{cwq|cpu}() and clear_work_data() can be used to set the 5007a22ad75STejun Heo * cwq, cpu or clear work->data. These functions should only be 5017a22ad75STejun Heo * called while the work is owned - ie. while the PENDING bit is set. 5027a22ad75STejun Heo * 5037a22ad75STejun Heo * get_work_[g]cwq() can be used to obtain the gcwq or cwq 5047a22ad75STejun Heo * corresponding to a work. gcwq is available once the work has been 5057a22ad75STejun Heo * queued anywhere after initialization. cwq is available only from 5067a22ad75STejun Heo * queueing until execution starts. 5074594bf15SDavid Howells */ 5087a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data, 5097a22ad75STejun Heo unsigned long flags) 5107a22ad75STejun Heo { 5117a22ad75STejun Heo BUG_ON(!work_pending(work)); 5127a22ad75STejun Heo atomic_long_set(&work->data, data | flags | work_static(work)); 5137a22ad75STejun Heo } 5147a22ad75STejun Heo 5157a22ad75STejun Heo static void set_work_cwq(struct work_struct *work, 5164690c4abSTejun Heo struct cpu_workqueue_struct *cwq, 5174690c4abSTejun Heo unsigned long extra_flags) 518365970a1SDavid Howells { 5197a22ad75STejun Heo set_work_data(work, (unsigned long)cwq, 520e120153dSTejun Heo WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags); 521365970a1SDavid Howells } 522365970a1SDavid Howells 5237a22ad75STejun Heo static void set_work_cpu(struct work_struct *work, unsigned int cpu) 5244d707b9fSOleg Nesterov { 5257a22ad75STejun Heo set_work_data(work, cpu << WORK_STRUCT_FLAG_BITS, WORK_STRUCT_PENDING); 5264d707b9fSOleg Nesterov } 5274d707b9fSOleg Nesterov 5287a22ad75STejun Heo static void clear_work_data(struct work_struct *work) 529365970a1SDavid Howells { 5307a22ad75STejun Heo set_work_data(work, WORK_STRUCT_NO_CPU, 0); 5317a22ad75STejun Heo } 5327a22ad75STejun Heo 5337a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work) 5347a22ad75STejun Heo { 535e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 5367a22ad75STejun Heo 537e120153dSTejun Heo if (data & WORK_STRUCT_CWQ) 538e120153dSTejun Heo return (void *)(data & WORK_STRUCT_WQ_DATA_MASK); 539e120153dSTejun Heo else 540e120153dSTejun Heo return NULL; 5417a22ad75STejun Heo } 5427a22ad75STejun Heo 5437a22ad75STejun Heo static struct global_cwq *get_work_gcwq(struct work_struct *work) 5447a22ad75STejun Heo { 545e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 5467a22ad75STejun Heo unsigned int cpu; 5477a22ad75STejun Heo 548e120153dSTejun Heo if (data & WORK_STRUCT_CWQ) 549e120153dSTejun Heo return ((struct cpu_workqueue_struct *) 550e120153dSTejun Heo (data & WORK_STRUCT_WQ_DATA_MASK))->gcwq; 5517a22ad75STejun Heo 5527a22ad75STejun Heo cpu = data >> WORK_STRUCT_FLAG_BITS; 553bdbc5dd7STejun Heo if (cpu == WORK_CPU_NONE) 5547a22ad75STejun Heo return NULL; 5557a22ad75STejun Heo 556f3421797STejun Heo BUG_ON(cpu >= nr_cpu_ids && cpu != WORK_CPU_UNBOUND); 5577a22ad75STejun Heo return get_gcwq(cpu); 558365970a1SDavid Howells } 559365970a1SDavid Howells 560e22bee78STejun Heo /* 561e22bee78STejun Heo * Policy functions. These define the policies on how the global 562e22bee78STejun Heo * worker pool is managed. Unless noted otherwise, these functions 563e22bee78STejun Heo * assume that they're being called with gcwq->lock held. 564e22bee78STejun Heo */ 565e22bee78STejun Heo 566649027d7STejun Heo static bool __need_more_worker(struct global_cwq *gcwq) 567649027d7STejun Heo { 568649027d7STejun Heo return !atomic_read(get_gcwq_nr_running(gcwq->cpu)) || 569649027d7STejun Heo gcwq->flags & GCWQ_HIGHPRI_PENDING; 570649027d7STejun Heo } 571649027d7STejun Heo 572e22bee78STejun Heo /* 573e22bee78STejun Heo * Need to wake up a worker? Called from anything but currently 574e22bee78STejun Heo * running workers. 575e22bee78STejun Heo */ 576e22bee78STejun Heo static bool need_more_worker(struct global_cwq *gcwq) 577e22bee78STejun Heo { 578649027d7STejun Heo return !list_empty(&gcwq->worklist) && __need_more_worker(gcwq); 579e22bee78STejun Heo } 580e22bee78STejun Heo 581e22bee78STejun Heo /* Can I start working? Called from busy but !running workers. */ 582e22bee78STejun Heo static bool may_start_working(struct global_cwq *gcwq) 583e22bee78STejun Heo { 584e22bee78STejun Heo return gcwq->nr_idle; 585e22bee78STejun Heo } 586e22bee78STejun Heo 587e22bee78STejun Heo /* Do I need to keep working? Called from currently running workers. */ 588e22bee78STejun Heo static bool keep_working(struct global_cwq *gcwq) 589e22bee78STejun Heo { 590e22bee78STejun Heo atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu); 591e22bee78STejun Heo 59230310045STejun Heo return !list_empty(&gcwq->worklist) && 59330310045STejun Heo (atomic_read(nr_running) <= 1 || 59430310045STejun Heo gcwq->flags & GCWQ_HIGHPRI_PENDING); 595e22bee78STejun Heo } 596e22bee78STejun Heo 597e22bee78STejun Heo /* Do we need a new worker? Called from manager. */ 598e22bee78STejun Heo static bool need_to_create_worker(struct global_cwq *gcwq) 599e22bee78STejun Heo { 600e22bee78STejun Heo return need_more_worker(gcwq) && !may_start_working(gcwq); 601e22bee78STejun Heo } 602e22bee78STejun Heo 603e22bee78STejun Heo /* Do I need to be the manager? */ 604e22bee78STejun Heo static bool need_to_manage_workers(struct global_cwq *gcwq) 605e22bee78STejun Heo { 606e22bee78STejun Heo return need_to_create_worker(gcwq) || gcwq->flags & GCWQ_MANAGE_WORKERS; 607e22bee78STejun Heo } 608e22bee78STejun Heo 609e22bee78STejun Heo /* Do we have too many workers and should some go away? */ 610e22bee78STejun Heo static bool too_many_workers(struct global_cwq *gcwq) 611e22bee78STejun Heo { 612e22bee78STejun Heo bool managing = gcwq->flags & GCWQ_MANAGING_WORKERS; 613e22bee78STejun Heo int nr_idle = gcwq->nr_idle + managing; /* manager is considered idle */ 614e22bee78STejun Heo int nr_busy = gcwq->nr_workers - nr_idle; 615e22bee78STejun Heo 616e22bee78STejun Heo return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; 617e22bee78STejun Heo } 618e22bee78STejun Heo 619e22bee78STejun Heo /* 620e22bee78STejun Heo * Wake up functions. 621e22bee78STejun Heo */ 622e22bee78STejun Heo 6237e11629dSTejun Heo /* Return the first worker. Safe with preemption disabled */ 6247e11629dSTejun Heo static struct worker *first_worker(struct global_cwq *gcwq) 6257e11629dSTejun Heo { 6267e11629dSTejun Heo if (unlikely(list_empty(&gcwq->idle_list))) 6277e11629dSTejun Heo return NULL; 6287e11629dSTejun Heo 6297e11629dSTejun Heo return list_first_entry(&gcwq->idle_list, struct worker, entry); 6307e11629dSTejun Heo } 6317e11629dSTejun Heo 6327e11629dSTejun Heo /** 6337e11629dSTejun Heo * wake_up_worker - wake up an idle worker 6347e11629dSTejun Heo * @gcwq: gcwq to wake worker for 6357e11629dSTejun Heo * 6367e11629dSTejun Heo * Wake up the first idle worker of @gcwq. 6377e11629dSTejun Heo * 6387e11629dSTejun Heo * CONTEXT: 6397e11629dSTejun Heo * spin_lock_irq(gcwq->lock). 6407e11629dSTejun Heo */ 6417e11629dSTejun Heo static void wake_up_worker(struct global_cwq *gcwq) 6427e11629dSTejun Heo { 6437e11629dSTejun Heo struct worker *worker = first_worker(gcwq); 6447e11629dSTejun Heo 6457e11629dSTejun Heo if (likely(worker)) 6467e11629dSTejun Heo wake_up_process(worker->task); 6477e11629dSTejun Heo } 6487e11629dSTejun Heo 6494690c4abSTejun Heo /** 650e22bee78STejun Heo * wq_worker_waking_up - a worker is waking up 651e22bee78STejun Heo * @task: task waking up 652e22bee78STejun Heo * @cpu: CPU @task is waking up to 653e22bee78STejun Heo * 654e22bee78STejun Heo * This function is called during try_to_wake_up() when a worker is 655e22bee78STejun Heo * being awoken. 656e22bee78STejun Heo * 657e22bee78STejun Heo * CONTEXT: 658e22bee78STejun Heo * spin_lock_irq(rq->lock) 659e22bee78STejun Heo */ 660e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu) 661e22bee78STejun Heo { 662e22bee78STejun Heo struct worker *worker = kthread_data(task); 663e22bee78STejun Heo 664*2d64672eSSteven Rostedt if (!(worker->flags & WORKER_NOT_RUNNING)) 665e22bee78STejun Heo atomic_inc(get_gcwq_nr_running(cpu)); 666e22bee78STejun Heo } 667e22bee78STejun Heo 668e22bee78STejun Heo /** 669e22bee78STejun Heo * wq_worker_sleeping - a worker is going to sleep 670e22bee78STejun Heo * @task: task going to sleep 671e22bee78STejun Heo * @cpu: CPU in question, must be the current CPU number 672e22bee78STejun Heo * 673e22bee78STejun Heo * This function is called during schedule() when a busy worker is 674e22bee78STejun Heo * going to sleep. Worker on the same cpu can be woken up by 675e22bee78STejun Heo * returning pointer to its task. 676e22bee78STejun Heo * 677e22bee78STejun Heo * CONTEXT: 678e22bee78STejun Heo * spin_lock_irq(rq->lock) 679e22bee78STejun Heo * 680e22bee78STejun Heo * RETURNS: 681e22bee78STejun Heo * Worker task on @cpu to wake up, %NULL if none. 682e22bee78STejun Heo */ 683e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task, 684e22bee78STejun Heo unsigned int cpu) 685e22bee78STejun Heo { 686e22bee78STejun Heo struct worker *worker = kthread_data(task), *to_wakeup = NULL; 687e22bee78STejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 688e22bee78STejun Heo atomic_t *nr_running = get_gcwq_nr_running(cpu); 689e22bee78STejun Heo 690*2d64672eSSteven Rostedt if (worker->flags & WORKER_NOT_RUNNING) 691e22bee78STejun Heo return NULL; 692e22bee78STejun Heo 693e22bee78STejun Heo /* this can only happen on the local cpu */ 694e22bee78STejun Heo BUG_ON(cpu != raw_smp_processor_id()); 695e22bee78STejun Heo 696e22bee78STejun Heo /* 697e22bee78STejun Heo * The counterpart of the following dec_and_test, implied mb, 698e22bee78STejun Heo * worklist not empty test sequence is in insert_work(). 699e22bee78STejun Heo * Please read comment there. 700e22bee78STejun Heo * 701e22bee78STejun Heo * NOT_RUNNING is clear. This means that trustee is not in 702e22bee78STejun Heo * charge and we're running on the local cpu w/ rq lock held 703e22bee78STejun Heo * and preemption disabled, which in turn means that none else 704e22bee78STejun Heo * could be manipulating idle_list, so dereferencing idle_list 705e22bee78STejun Heo * without gcwq lock is safe. 706e22bee78STejun Heo */ 707e22bee78STejun Heo if (atomic_dec_and_test(nr_running) && !list_empty(&gcwq->worklist)) 708e22bee78STejun Heo to_wakeup = first_worker(gcwq); 709e22bee78STejun Heo return to_wakeup ? to_wakeup->task : NULL; 710e22bee78STejun Heo } 711e22bee78STejun Heo 712e22bee78STejun Heo /** 713e22bee78STejun Heo * worker_set_flags - set worker flags and adjust nr_running accordingly 714cb444766STejun Heo * @worker: self 715d302f017STejun Heo * @flags: flags to set 716d302f017STejun Heo * @wakeup: wakeup an idle worker if necessary 717d302f017STejun Heo * 718e22bee78STejun Heo * Set @flags in @worker->flags and adjust nr_running accordingly. If 719e22bee78STejun Heo * nr_running becomes zero and @wakeup is %true, an idle worker is 720e22bee78STejun Heo * woken up. 721d302f017STejun Heo * 722cb444766STejun Heo * CONTEXT: 723cb444766STejun Heo * spin_lock_irq(gcwq->lock) 724d302f017STejun Heo */ 725d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags, 726d302f017STejun Heo bool wakeup) 727d302f017STejun Heo { 728e22bee78STejun Heo struct global_cwq *gcwq = worker->gcwq; 729e22bee78STejun Heo 730cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 731cb444766STejun Heo 732e22bee78STejun Heo /* 733e22bee78STejun Heo * If transitioning into NOT_RUNNING, adjust nr_running and 734e22bee78STejun Heo * wake up an idle worker as necessary if requested by 735e22bee78STejun Heo * @wakeup. 736e22bee78STejun Heo */ 737e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && 738e22bee78STejun Heo !(worker->flags & WORKER_NOT_RUNNING)) { 739e22bee78STejun Heo atomic_t *nr_running = get_gcwq_nr_running(gcwq->cpu); 740e22bee78STejun Heo 741e22bee78STejun Heo if (wakeup) { 742e22bee78STejun Heo if (atomic_dec_and_test(nr_running) && 743e22bee78STejun Heo !list_empty(&gcwq->worklist)) 744e22bee78STejun Heo wake_up_worker(gcwq); 745e22bee78STejun Heo } else 746e22bee78STejun Heo atomic_dec(nr_running); 747e22bee78STejun Heo } 748e22bee78STejun Heo 749d302f017STejun Heo worker->flags |= flags; 750d302f017STejun Heo } 751d302f017STejun Heo 752d302f017STejun Heo /** 753e22bee78STejun Heo * worker_clr_flags - clear worker flags and adjust nr_running accordingly 754cb444766STejun Heo * @worker: self 755d302f017STejun Heo * @flags: flags to clear 756d302f017STejun Heo * 757e22bee78STejun Heo * Clear @flags in @worker->flags and adjust nr_running accordingly. 758d302f017STejun Heo * 759cb444766STejun Heo * CONTEXT: 760cb444766STejun Heo * spin_lock_irq(gcwq->lock) 761d302f017STejun Heo */ 762d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags) 763d302f017STejun Heo { 764e22bee78STejun Heo struct global_cwq *gcwq = worker->gcwq; 765e22bee78STejun Heo unsigned int oflags = worker->flags; 766e22bee78STejun Heo 767cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 768cb444766STejun Heo 769d302f017STejun Heo worker->flags &= ~flags; 770e22bee78STejun Heo 771e22bee78STejun Heo /* if transitioning out of NOT_RUNNING, increment nr_running */ 772e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) 773e22bee78STejun Heo if (!(worker->flags & WORKER_NOT_RUNNING)) 774e22bee78STejun Heo atomic_inc(get_gcwq_nr_running(gcwq->cpu)); 775d302f017STejun Heo } 776d302f017STejun Heo 777d302f017STejun Heo /** 778c8e55f36STejun Heo * busy_worker_head - return the busy hash head for a work 779c8e55f36STejun Heo * @gcwq: gcwq of interest 780c8e55f36STejun Heo * @work: work to be hashed 781c8e55f36STejun Heo * 782c8e55f36STejun Heo * Return hash head of @gcwq for @work. 783c8e55f36STejun Heo * 784c8e55f36STejun Heo * CONTEXT: 785c8e55f36STejun Heo * spin_lock_irq(gcwq->lock). 786c8e55f36STejun Heo * 787c8e55f36STejun Heo * RETURNS: 788c8e55f36STejun Heo * Pointer to the hash head. 789c8e55f36STejun Heo */ 790c8e55f36STejun Heo static struct hlist_head *busy_worker_head(struct global_cwq *gcwq, 791c8e55f36STejun Heo struct work_struct *work) 792c8e55f36STejun Heo { 793c8e55f36STejun Heo const int base_shift = ilog2(sizeof(struct work_struct)); 794c8e55f36STejun Heo unsigned long v = (unsigned long)work; 795c8e55f36STejun Heo 796c8e55f36STejun Heo /* simple shift and fold hash, do we need something better? */ 797c8e55f36STejun Heo v >>= base_shift; 798c8e55f36STejun Heo v += v >> BUSY_WORKER_HASH_ORDER; 799c8e55f36STejun Heo v &= BUSY_WORKER_HASH_MASK; 800c8e55f36STejun Heo 801c8e55f36STejun Heo return &gcwq->busy_hash[v]; 802c8e55f36STejun Heo } 803c8e55f36STejun Heo 804c8e55f36STejun Heo /** 8058cca0eeaSTejun Heo * __find_worker_executing_work - find worker which is executing a work 8068cca0eeaSTejun Heo * @gcwq: gcwq of interest 8078cca0eeaSTejun Heo * @bwh: hash head as returned by busy_worker_head() 8088cca0eeaSTejun Heo * @work: work to find worker for 8098cca0eeaSTejun Heo * 8108cca0eeaSTejun Heo * Find a worker which is executing @work on @gcwq. @bwh should be 8118cca0eeaSTejun Heo * the hash head obtained by calling busy_worker_head() with the same 8128cca0eeaSTejun Heo * work. 8138cca0eeaSTejun Heo * 8148cca0eeaSTejun Heo * CONTEXT: 8158cca0eeaSTejun Heo * spin_lock_irq(gcwq->lock). 8168cca0eeaSTejun Heo * 8178cca0eeaSTejun Heo * RETURNS: 8188cca0eeaSTejun Heo * Pointer to worker which is executing @work if found, NULL 8198cca0eeaSTejun Heo * otherwise. 8208cca0eeaSTejun Heo */ 8218cca0eeaSTejun Heo static struct worker *__find_worker_executing_work(struct global_cwq *gcwq, 8228cca0eeaSTejun Heo struct hlist_head *bwh, 8238cca0eeaSTejun Heo struct work_struct *work) 8248cca0eeaSTejun Heo { 8258cca0eeaSTejun Heo struct worker *worker; 8268cca0eeaSTejun Heo struct hlist_node *tmp; 8278cca0eeaSTejun Heo 8288cca0eeaSTejun Heo hlist_for_each_entry(worker, tmp, bwh, hentry) 8298cca0eeaSTejun Heo if (worker->current_work == work) 8308cca0eeaSTejun Heo return worker; 8318cca0eeaSTejun Heo return NULL; 8328cca0eeaSTejun Heo } 8338cca0eeaSTejun Heo 8348cca0eeaSTejun Heo /** 8358cca0eeaSTejun Heo * find_worker_executing_work - find worker which is executing a work 8368cca0eeaSTejun Heo * @gcwq: gcwq of interest 8378cca0eeaSTejun Heo * @work: work to find worker for 8388cca0eeaSTejun Heo * 8398cca0eeaSTejun Heo * Find a worker which is executing @work on @gcwq. This function is 8408cca0eeaSTejun Heo * identical to __find_worker_executing_work() except that this 8418cca0eeaSTejun Heo * function calculates @bwh itself. 8428cca0eeaSTejun Heo * 8438cca0eeaSTejun Heo * CONTEXT: 8448cca0eeaSTejun Heo * spin_lock_irq(gcwq->lock). 8458cca0eeaSTejun Heo * 8468cca0eeaSTejun Heo * RETURNS: 8478cca0eeaSTejun Heo * Pointer to worker which is executing @work if found, NULL 8488cca0eeaSTejun Heo * otherwise. 8498cca0eeaSTejun Heo */ 8508cca0eeaSTejun Heo static struct worker *find_worker_executing_work(struct global_cwq *gcwq, 8518cca0eeaSTejun Heo struct work_struct *work) 8528cca0eeaSTejun Heo { 8538cca0eeaSTejun Heo return __find_worker_executing_work(gcwq, busy_worker_head(gcwq, work), 8548cca0eeaSTejun Heo work); 8558cca0eeaSTejun Heo } 8568cca0eeaSTejun Heo 8578cca0eeaSTejun Heo /** 858649027d7STejun Heo * gcwq_determine_ins_pos - find insertion position 859649027d7STejun Heo * @gcwq: gcwq of interest 860649027d7STejun Heo * @cwq: cwq a work is being queued for 861649027d7STejun Heo * 862649027d7STejun Heo * A work for @cwq is about to be queued on @gcwq, determine insertion 863649027d7STejun Heo * position for the work. If @cwq is for HIGHPRI wq, the work is 864649027d7STejun Heo * queued at the head of the queue but in FIFO order with respect to 865649027d7STejun Heo * other HIGHPRI works; otherwise, at the end of the queue. This 866649027d7STejun Heo * function also sets GCWQ_HIGHPRI_PENDING flag to hint @gcwq that 867649027d7STejun Heo * there are HIGHPRI works pending. 868649027d7STejun Heo * 869649027d7STejun Heo * CONTEXT: 870649027d7STejun Heo * spin_lock_irq(gcwq->lock). 871649027d7STejun Heo * 872649027d7STejun Heo * RETURNS: 873649027d7STejun Heo * Pointer to inserstion position. 874649027d7STejun Heo */ 875649027d7STejun Heo static inline struct list_head *gcwq_determine_ins_pos(struct global_cwq *gcwq, 8761da177e4SLinus Torvalds struct cpu_workqueue_struct *cwq) 8771da177e4SLinus Torvalds { 878649027d7STejun Heo struct work_struct *twork; 8791da177e4SLinus Torvalds 880649027d7STejun Heo if (likely(!(cwq->wq->flags & WQ_HIGHPRI))) 881649027d7STejun Heo return &gcwq->worklist; 8821da177e4SLinus Torvalds 883649027d7STejun Heo list_for_each_entry(twork, &gcwq->worklist, entry) { 884649027d7STejun Heo struct cpu_workqueue_struct *tcwq = get_work_cwq(twork); 885649027d7STejun Heo 886649027d7STejun Heo if (!(tcwq->wq->flags & WQ_HIGHPRI)) 887649027d7STejun Heo break; 8881da177e4SLinus Torvalds } 8891da177e4SLinus Torvalds 890649027d7STejun Heo gcwq->flags |= GCWQ_HIGHPRI_PENDING; 891649027d7STejun Heo return &twork->entry; 892649027d7STejun Heo } 893649027d7STejun Heo 894649027d7STejun Heo /** 8957e11629dSTejun Heo * insert_work - insert a work into gcwq 8964690c4abSTejun Heo * @cwq: cwq @work belongs to 8974690c4abSTejun Heo * @work: work to insert 8984690c4abSTejun Heo * @head: insertion point 8994690c4abSTejun Heo * @extra_flags: extra WORK_STRUCT_* flags to set 9004690c4abSTejun Heo * 9017e11629dSTejun Heo * Insert @work which belongs to @cwq into @gcwq after @head. 9027e11629dSTejun Heo * @extra_flags is or'd to work_struct flags. 9034690c4abSTejun Heo * 9044690c4abSTejun Heo * CONTEXT: 9058b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock). 9061da177e4SLinus Torvalds */ 907b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq, 9084690c4abSTejun Heo struct work_struct *work, struct list_head *head, 9094690c4abSTejun Heo unsigned int extra_flags) 910b89deed3SOleg Nesterov { 911e22bee78STejun Heo struct global_cwq *gcwq = cwq->gcwq; 912e1d8aa9fSFrederic Weisbecker 9134690c4abSTejun Heo /* we own @work, set data and link */ 9147a22ad75STejun Heo set_work_cwq(work, cwq, extra_flags); 9154690c4abSTejun Heo 9166e84d644SOleg Nesterov /* 9176e84d644SOleg Nesterov * Ensure that we get the right work->data if we see the 9186e84d644SOleg Nesterov * result of list_add() below, see try_to_grab_pending(). 9196e84d644SOleg Nesterov */ 9206e84d644SOleg Nesterov smp_wmb(); 9214690c4abSTejun Heo 9221a4d9b0aSOleg Nesterov list_add_tail(&work->entry, head); 923e22bee78STejun Heo 924e22bee78STejun Heo /* 925e22bee78STejun Heo * Ensure either worker_sched_deactivated() sees the above 926e22bee78STejun Heo * list_add_tail() or we see zero nr_running to avoid workers 927e22bee78STejun Heo * lying around lazily while there are works to be processed. 928e22bee78STejun Heo */ 929e22bee78STejun Heo smp_mb(); 930e22bee78STejun Heo 931649027d7STejun Heo if (__need_more_worker(gcwq)) 932e22bee78STejun Heo wake_up_worker(gcwq); 933b89deed3SOleg Nesterov } 934b89deed3SOleg Nesterov 9354690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq, 9361da177e4SLinus Torvalds struct work_struct *work) 9371da177e4SLinus Torvalds { 938502ca9d8STejun Heo struct global_cwq *gcwq; 939502ca9d8STejun Heo struct cpu_workqueue_struct *cwq; 9401e19ffc6STejun Heo struct list_head *worklist; 9418a2e8e5dSTejun Heo unsigned int work_flags; 9421da177e4SLinus Torvalds unsigned long flags; 9431da177e4SLinus Torvalds 944dc186ad7SThomas Gleixner debug_work_activate(work); 9451e19ffc6STejun Heo 946e41e704bSTejun Heo if (WARN_ON_ONCE(wq->flags & WQ_DYING)) 947e41e704bSTejun Heo return; 948e41e704bSTejun Heo 949c7fc77f7STejun Heo /* determine gcwq to use */ 950c7fc77f7STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 951c7fc77f7STejun Heo struct global_cwq *last_gcwq; 952c7fc77f7STejun Heo 953f3421797STejun Heo if (unlikely(cpu == WORK_CPU_UNBOUND)) 954f3421797STejun Heo cpu = raw_smp_processor_id(); 955f3421797STejun Heo 95618aa9effSTejun Heo /* 95718aa9effSTejun Heo * It's multi cpu. If @wq is non-reentrant and @work 95818aa9effSTejun Heo * was previously on a different cpu, it might still 95918aa9effSTejun Heo * be running there, in which case the work needs to 96018aa9effSTejun Heo * be queued on that cpu to guarantee non-reentrance. 96118aa9effSTejun Heo */ 962502ca9d8STejun Heo gcwq = get_gcwq(cpu); 96318aa9effSTejun Heo if (wq->flags & WQ_NON_REENTRANT && 96418aa9effSTejun Heo (last_gcwq = get_work_gcwq(work)) && last_gcwq != gcwq) { 96518aa9effSTejun Heo struct worker *worker; 96618aa9effSTejun Heo 96718aa9effSTejun Heo spin_lock_irqsave(&last_gcwq->lock, flags); 96818aa9effSTejun Heo 96918aa9effSTejun Heo worker = find_worker_executing_work(last_gcwq, work); 97018aa9effSTejun Heo 97118aa9effSTejun Heo if (worker && worker->current_cwq->wq == wq) 97218aa9effSTejun Heo gcwq = last_gcwq; 97318aa9effSTejun Heo else { 97418aa9effSTejun Heo /* meh... not running there, queue here */ 97518aa9effSTejun Heo spin_unlock_irqrestore(&last_gcwq->lock, flags); 97618aa9effSTejun Heo spin_lock_irqsave(&gcwq->lock, flags); 97718aa9effSTejun Heo } 97818aa9effSTejun Heo } else 9798b03ae3cSTejun Heo spin_lock_irqsave(&gcwq->lock, flags); 980f3421797STejun Heo } else { 981f3421797STejun Heo gcwq = get_gcwq(WORK_CPU_UNBOUND); 982f3421797STejun Heo spin_lock_irqsave(&gcwq->lock, flags); 983502ca9d8STejun Heo } 984502ca9d8STejun Heo 985502ca9d8STejun Heo /* gcwq determined, get cwq and queue */ 986502ca9d8STejun Heo cwq = get_cwq(gcwq->cpu, wq); 987cdadf009STejun Heo trace_workqueue_queue_work(cpu, cwq, work); 988502ca9d8STejun Heo 9894690c4abSTejun Heo BUG_ON(!list_empty(&work->entry)); 9901e19ffc6STejun Heo 99173f53c4aSTejun Heo cwq->nr_in_flight[cwq->work_color]++; 9928a2e8e5dSTejun Heo work_flags = work_color_to_flags(cwq->work_color); 9931e19ffc6STejun Heo 9941e19ffc6STejun Heo if (likely(cwq->nr_active < cwq->max_active)) { 995cdadf009STejun Heo trace_workqueue_activate_work(work); 9961e19ffc6STejun Heo cwq->nr_active++; 997649027d7STejun Heo worklist = gcwq_determine_ins_pos(gcwq, cwq); 9988a2e8e5dSTejun Heo } else { 9998a2e8e5dSTejun Heo work_flags |= WORK_STRUCT_DELAYED; 10001e19ffc6STejun Heo worklist = &cwq->delayed_works; 10018a2e8e5dSTejun Heo } 10021e19ffc6STejun Heo 10038a2e8e5dSTejun Heo insert_work(cwq, work, worklist, work_flags); 10041e19ffc6STejun Heo 10058b03ae3cSTejun Heo spin_unlock_irqrestore(&gcwq->lock, flags); 10061da177e4SLinus Torvalds } 10071da177e4SLinus Torvalds 10080fcb78c2SRolf Eike Beer /** 10090fcb78c2SRolf Eike Beer * queue_work - queue work on a workqueue 10100fcb78c2SRolf Eike Beer * @wq: workqueue to use 10110fcb78c2SRolf Eike Beer * @work: work to queue 10120fcb78c2SRolf Eike Beer * 1013057647fcSAlan Stern * Returns 0 if @work was already on a queue, non-zero otherwise. 10141da177e4SLinus Torvalds * 101500dfcaf7SOleg Nesterov * We queue the work to the CPU on which it was submitted, but if the CPU dies 101600dfcaf7SOleg Nesterov * it can be processed by another CPU. 10171da177e4SLinus Torvalds */ 10187ad5b3a5SHarvey Harrison int queue_work(struct workqueue_struct *wq, struct work_struct *work) 10191da177e4SLinus Torvalds { 1020ef1ca236SOleg Nesterov int ret; 10211da177e4SLinus Torvalds 1022ef1ca236SOleg Nesterov ret = queue_work_on(get_cpu(), wq, work); 1023a848e3b6SOleg Nesterov put_cpu(); 1024ef1ca236SOleg Nesterov 10251da177e4SLinus Torvalds return ret; 10261da177e4SLinus Torvalds } 1027ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_work); 10281da177e4SLinus Torvalds 1029c1a220e7SZhang Rui /** 1030c1a220e7SZhang Rui * queue_work_on - queue work on specific cpu 1031c1a220e7SZhang Rui * @cpu: CPU number to execute work on 1032c1a220e7SZhang Rui * @wq: workqueue to use 1033c1a220e7SZhang Rui * @work: work to queue 1034c1a220e7SZhang Rui * 1035c1a220e7SZhang Rui * Returns 0 if @work was already on a queue, non-zero otherwise. 1036c1a220e7SZhang Rui * 1037c1a220e7SZhang Rui * We queue the work to a specific CPU, the caller must ensure it 1038c1a220e7SZhang Rui * can't go away. 1039c1a220e7SZhang Rui */ 1040c1a220e7SZhang Rui int 1041c1a220e7SZhang Rui queue_work_on(int cpu, struct workqueue_struct *wq, struct work_struct *work) 1042c1a220e7SZhang Rui { 1043c1a220e7SZhang Rui int ret = 0; 1044c1a220e7SZhang Rui 104522df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 10464690c4abSTejun Heo __queue_work(cpu, wq, work); 1047c1a220e7SZhang Rui ret = 1; 1048c1a220e7SZhang Rui } 1049c1a220e7SZhang Rui return ret; 1050c1a220e7SZhang Rui } 1051c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on); 1052c1a220e7SZhang Rui 10536d141c3fSLi Zefan static void delayed_work_timer_fn(unsigned long __data) 10541da177e4SLinus Torvalds { 105552bad64dSDavid Howells struct delayed_work *dwork = (struct delayed_work *)__data; 10567a22ad75STejun Heo struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work); 10571da177e4SLinus Torvalds 10584690c4abSTejun Heo __queue_work(smp_processor_id(), cwq->wq, &dwork->work); 10591da177e4SLinus Torvalds } 10601da177e4SLinus Torvalds 10610fcb78c2SRolf Eike Beer /** 10620fcb78c2SRolf Eike Beer * queue_delayed_work - queue work on a workqueue after delay 10630fcb78c2SRolf Eike Beer * @wq: workqueue to use 1064af9997e4SRandy Dunlap * @dwork: delayable work to queue 10650fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 10660fcb78c2SRolf Eike Beer * 1067057647fcSAlan Stern * Returns 0 if @work was already on a queue, non-zero otherwise. 10680fcb78c2SRolf Eike Beer */ 10697ad5b3a5SHarvey Harrison int queue_delayed_work(struct workqueue_struct *wq, 107052bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 10711da177e4SLinus Torvalds { 107252bad64dSDavid Howells if (delay == 0) 107363bc0362SOleg Nesterov return queue_work(wq, &dwork->work); 10741da177e4SLinus Torvalds 107563bc0362SOleg Nesterov return queue_delayed_work_on(-1, wq, dwork, delay); 10761da177e4SLinus Torvalds } 1077ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work); 10781da177e4SLinus Torvalds 10790fcb78c2SRolf Eike Beer /** 10800fcb78c2SRolf Eike Beer * queue_delayed_work_on - queue work on specific CPU after delay 10810fcb78c2SRolf Eike Beer * @cpu: CPU number to execute work on 10820fcb78c2SRolf Eike Beer * @wq: workqueue to use 1083af9997e4SRandy Dunlap * @dwork: work to queue 10840fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 10850fcb78c2SRolf Eike Beer * 1086057647fcSAlan Stern * Returns 0 if @work was already on a queue, non-zero otherwise. 10870fcb78c2SRolf Eike Beer */ 10887a6bc1cdSVenkatesh Pallipadi int queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 108952bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 10907a6bc1cdSVenkatesh Pallipadi { 10917a6bc1cdSVenkatesh Pallipadi int ret = 0; 109252bad64dSDavid Howells struct timer_list *timer = &dwork->timer; 109352bad64dSDavid Howells struct work_struct *work = &dwork->work; 10947a6bc1cdSVenkatesh Pallipadi 109522df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 1096c7fc77f7STejun Heo unsigned int lcpu; 10977a22ad75STejun Heo 10987a6bc1cdSVenkatesh Pallipadi BUG_ON(timer_pending(timer)); 10997a6bc1cdSVenkatesh Pallipadi BUG_ON(!list_empty(&work->entry)); 11007a6bc1cdSVenkatesh Pallipadi 11018a3e77ccSAndrew Liu timer_stats_timer_set_start_info(&dwork->timer); 11028a3e77ccSAndrew Liu 11037a22ad75STejun Heo /* 11047a22ad75STejun Heo * This stores cwq for the moment, for the timer_fn. 11057a22ad75STejun Heo * Note that the work's gcwq is preserved to allow 11067a22ad75STejun Heo * reentrance detection for delayed works. 11077a22ad75STejun Heo */ 1108c7fc77f7STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 1109c7fc77f7STejun Heo struct global_cwq *gcwq = get_work_gcwq(work); 1110c7fc77f7STejun Heo 1111c7fc77f7STejun Heo if (gcwq && gcwq->cpu != WORK_CPU_UNBOUND) 1112c7fc77f7STejun Heo lcpu = gcwq->cpu; 1113c7fc77f7STejun Heo else 1114c7fc77f7STejun Heo lcpu = raw_smp_processor_id(); 1115c7fc77f7STejun Heo } else 1116c7fc77f7STejun Heo lcpu = WORK_CPU_UNBOUND; 1117c7fc77f7STejun Heo 11187a22ad75STejun Heo set_work_cwq(work, get_cwq(lcpu, wq), 0); 1119c7fc77f7STejun Heo 11207a6bc1cdSVenkatesh Pallipadi timer->expires = jiffies + delay; 112152bad64dSDavid Howells timer->data = (unsigned long)dwork; 11227a6bc1cdSVenkatesh Pallipadi timer->function = delayed_work_timer_fn; 112363bc0362SOleg Nesterov 112463bc0362SOleg Nesterov if (unlikely(cpu >= 0)) 11257a6bc1cdSVenkatesh Pallipadi add_timer_on(timer, cpu); 112663bc0362SOleg Nesterov else 112763bc0362SOleg Nesterov add_timer(timer); 11287a6bc1cdSVenkatesh Pallipadi ret = 1; 11297a6bc1cdSVenkatesh Pallipadi } 11307a6bc1cdSVenkatesh Pallipadi return ret; 11317a6bc1cdSVenkatesh Pallipadi } 1132ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on); 11331da177e4SLinus Torvalds 1134c8e55f36STejun Heo /** 1135c8e55f36STejun Heo * worker_enter_idle - enter idle state 1136c8e55f36STejun Heo * @worker: worker which is entering idle state 1137c8e55f36STejun Heo * 1138c8e55f36STejun Heo * @worker is entering idle state. Update stats and idle timer if 1139c8e55f36STejun Heo * necessary. 1140c8e55f36STejun Heo * 1141c8e55f36STejun Heo * LOCKING: 1142c8e55f36STejun Heo * spin_lock_irq(gcwq->lock). 1143c8e55f36STejun Heo */ 1144c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker) 11451da177e4SLinus Torvalds { 1146c8e55f36STejun Heo struct global_cwq *gcwq = worker->gcwq; 1147c8e55f36STejun Heo 1148c8e55f36STejun Heo BUG_ON(worker->flags & WORKER_IDLE); 1149c8e55f36STejun Heo BUG_ON(!list_empty(&worker->entry) && 1150c8e55f36STejun Heo (worker->hentry.next || worker->hentry.pprev)); 1151c8e55f36STejun Heo 1152cb444766STejun Heo /* can't use worker_set_flags(), also called from start_worker() */ 1153cb444766STejun Heo worker->flags |= WORKER_IDLE; 1154c8e55f36STejun Heo gcwq->nr_idle++; 1155e22bee78STejun Heo worker->last_active = jiffies; 1156c8e55f36STejun Heo 1157c8e55f36STejun Heo /* idle_list is LIFO */ 1158c8e55f36STejun Heo list_add(&worker->entry, &gcwq->idle_list); 1159db7bccf4STejun Heo 1160e22bee78STejun Heo if (likely(!(worker->flags & WORKER_ROGUE))) { 1161e22bee78STejun Heo if (too_many_workers(gcwq) && !timer_pending(&gcwq->idle_timer)) 1162e22bee78STejun Heo mod_timer(&gcwq->idle_timer, 1163e22bee78STejun Heo jiffies + IDLE_WORKER_TIMEOUT); 1164e22bee78STejun Heo } else 1165db7bccf4STejun Heo wake_up_all(&gcwq->trustee_wait); 1166cb444766STejun Heo 1167cb444766STejun Heo /* sanity check nr_running */ 1168cb444766STejun Heo WARN_ON_ONCE(gcwq->nr_workers == gcwq->nr_idle && 1169cb444766STejun Heo atomic_read(get_gcwq_nr_running(gcwq->cpu))); 1170c8e55f36STejun Heo } 1171c8e55f36STejun Heo 1172c8e55f36STejun Heo /** 1173c8e55f36STejun Heo * worker_leave_idle - leave idle state 1174c8e55f36STejun Heo * @worker: worker which is leaving idle state 1175c8e55f36STejun Heo * 1176c8e55f36STejun Heo * @worker is leaving idle state. Update stats. 1177c8e55f36STejun Heo * 1178c8e55f36STejun Heo * LOCKING: 1179c8e55f36STejun Heo * spin_lock_irq(gcwq->lock). 1180c8e55f36STejun Heo */ 1181c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker) 1182c8e55f36STejun Heo { 1183c8e55f36STejun Heo struct global_cwq *gcwq = worker->gcwq; 1184c8e55f36STejun Heo 1185c8e55f36STejun Heo BUG_ON(!(worker->flags & WORKER_IDLE)); 1186d302f017STejun Heo worker_clr_flags(worker, WORKER_IDLE); 1187c8e55f36STejun Heo gcwq->nr_idle--; 1188c8e55f36STejun Heo list_del_init(&worker->entry); 1189c8e55f36STejun Heo } 1190c8e55f36STejun Heo 1191e22bee78STejun Heo /** 1192e22bee78STejun Heo * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq 1193e22bee78STejun Heo * @worker: self 1194e22bee78STejun Heo * 1195e22bee78STejun Heo * Works which are scheduled while the cpu is online must at least be 1196e22bee78STejun Heo * scheduled to a worker which is bound to the cpu so that if they are 1197e22bee78STejun Heo * flushed from cpu callbacks while cpu is going down, they are 1198e22bee78STejun Heo * guaranteed to execute on the cpu. 1199e22bee78STejun Heo * 1200e22bee78STejun Heo * This function is to be used by rogue workers and rescuers to bind 1201e22bee78STejun Heo * themselves to the target cpu and may race with cpu going down or 1202e22bee78STejun Heo * coming online. kthread_bind() can't be used because it may put the 1203e22bee78STejun Heo * worker to already dead cpu and set_cpus_allowed_ptr() can't be used 1204e22bee78STejun Heo * verbatim as it's best effort and blocking and gcwq may be 1205e22bee78STejun Heo * [dis]associated in the meantime. 1206e22bee78STejun Heo * 1207e22bee78STejun Heo * This function tries set_cpus_allowed() and locks gcwq and verifies 1208e22bee78STejun Heo * the binding against GCWQ_DISASSOCIATED which is set during 1209e22bee78STejun Heo * CPU_DYING and cleared during CPU_ONLINE, so if the worker enters 1210e22bee78STejun Heo * idle state or fetches works without dropping lock, it can guarantee 1211e22bee78STejun Heo * the scheduling requirement described in the first paragraph. 1212e22bee78STejun Heo * 1213e22bee78STejun Heo * CONTEXT: 1214e22bee78STejun Heo * Might sleep. Called without any lock but returns with gcwq->lock 1215e22bee78STejun Heo * held. 1216e22bee78STejun Heo * 1217e22bee78STejun Heo * RETURNS: 1218e22bee78STejun Heo * %true if the associated gcwq is online (@worker is successfully 1219e22bee78STejun Heo * bound), %false if offline. 1220e22bee78STejun Heo */ 1221e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker) 1222972fa1c5SNamhyung Kim __acquires(&gcwq->lock) 1223e22bee78STejun Heo { 1224e22bee78STejun Heo struct global_cwq *gcwq = worker->gcwq; 1225e22bee78STejun Heo struct task_struct *task = worker->task; 1226e22bee78STejun Heo 1227e22bee78STejun Heo while (true) { 1228e22bee78STejun Heo /* 1229e22bee78STejun Heo * The following call may fail, succeed or succeed 1230e22bee78STejun Heo * without actually migrating the task to the cpu if 1231e22bee78STejun Heo * it races with cpu hotunplug operation. Verify 1232e22bee78STejun Heo * against GCWQ_DISASSOCIATED. 1233e22bee78STejun Heo */ 1234f3421797STejun Heo if (!(gcwq->flags & GCWQ_DISASSOCIATED)) 1235e22bee78STejun Heo set_cpus_allowed_ptr(task, get_cpu_mask(gcwq->cpu)); 1236e22bee78STejun Heo 1237e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 1238e22bee78STejun Heo if (gcwq->flags & GCWQ_DISASSOCIATED) 1239e22bee78STejun Heo return false; 1240e22bee78STejun Heo if (task_cpu(task) == gcwq->cpu && 1241e22bee78STejun Heo cpumask_equal(¤t->cpus_allowed, 1242e22bee78STejun Heo get_cpu_mask(gcwq->cpu))) 1243e22bee78STejun Heo return true; 1244e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 1245e22bee78STejun Heo 1246e22bee78STejun Heo /* CPU has come up inbetween, retry migration */ 1247e22bee78STejun Heo cpu_relax(); 1248e22bee78STejun Heo } 1249e22bee78STejun Heo } 1250e22bee78STejun Heo 1251e22bee78STejun Heo /* 1252e22bee78STejun Heo * Function for worker->rebind_work used to rebind rogue busy workers 1253e22bee78STejun Heo * to the associated cpu which is coming back online. This is 1254e22bee78STejun Heo * scheduled by cpu up but can race with other cpu hotplug operations 1255e22bee78STejun Heo * and may be executed twice without intervening cpu down. 1256e22bee78STejun Heo */ 1257e22bee78STejun Heo static void worker_rebind_fn(struct work_struct *work) 1258e22bee78STejun Heo { 1259e22bee78STejun Heo struct worker *worker = container_of(work, struct worker, rebind_work); 1260e22bee78STejun Heo struct global_cwq *gcwq = worker->gcwq; 1261e22bee78STejun Heo 1262e22bee78STejun Heo if (worker_maybe_bind_and_lock(worker)) 1263e22bee78STejun Heo worker_clr_flags(worker, WORKER_REBIND); 1264e22bee78STejun Heo 1265e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 1266e22bee78STejun Heo } 1267e22bee78STejun Heo 1268c34056a3STejun Heo static struct worker *alloc_worker(void) 1269c34056a3STejun Heo { 1270c34056a3STejun Heo struct worker *worker; 1271c34056a3STejun Heo 1272c34056a3STejun Heo worker = kzalloc(sizeof(*worker), GFP_KERNEL); 1273c8e55f36STejun Heo if (worker) { 1274c8e55f36STejun Heo INIT_LIST_HEAD(&worker->entry); 1275affee4b2STejun Heo INIT_LIST_HEAD(&worker->scheduled); 1276e22bee78STejun Heo INIT_WORK(&worker->rebind_work, worker_rebind_fn); 1277e22bee78STejun Heo /* on creation a worker is in !idle && prep state */ 1278e22bee78STejun Heo worker->flags = WORKER_PREP; 1279c8e55f36STejun Heo } 1280c34056a3STejun Heo return worker; 1281c34056a3STejun Heo } 1282c34056a3STejun Heo 1283c34056a3STejun Heo /** 1284c34056a3STejun Heo * create_worker - create a new workqueue worker 12857e11629dSTejun Heo * @gcwq: gcwq the new worker will belong to 1286c34056a3STejun Heo * @bind: whether to set affinity to @cpu or not 1287c34056a3STejun Heo * 12887e11629dSTejun Heo * Create a new worker which is bound to @gcwq. The returned worker 1289c34056a3STejun Heo * can be started by calling start_worker() or destroyed using 1290c34056a3STejun Heo * destroy_worker(). 1291c34056a3STejun Heo * 1292c34056a3STejun Heo * CONTEXT: 1293c34056a3STejun Heo * Might sleep. Does GFP_KERNEL allocations. 1294c34056a3STejun Heo * 1295c34056a3STejun Heo * RETURNS: 1296c34056a3STejun Heo * Pointer to the newly created worker. 1297c34056a3STejun Heo */ 12987e11629dSTejun Heo static struct worker *create_worker(struct global_cwq *gcwq, bool bind) 1299c34056a3STejun Heo { 1300f3421797STejun Heo bool on_unbound_cpu = gcwq->cpu == WORK_CPU_UNBOUND; 1301c34056a3STejun Heo struct worker *worker = NULL; 1302f3421797STejun Heo int id = -1; 1303c34056a3STejun Heo 13048b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 13058b03ae3cSTejun Heo while (ida_get_new(&gcwq->worker_ida, &id)) { 13068b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 13078b03ae3cSTejun Heo if (!ida_pre_get(&gcwq->worker_ida, GFP_KERNEL)) 1308c34056a3STejun Heo goto fail; 13098b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 1310c34056a3STejun Heo } 13118b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 1312c34056a3STejun Heo 1313c34056a3STejun Heo worker = alloc_worker(); 1314c34056a3STejun Heo if (!worker) 1315c34056a3STejun Heo goto fail; 1316c34056a3STejun Heo 13178b03ae3cSTejun Heo worker->gcwq = gcwq; 1318c34056a3STejun Heo worker->id = id; 1319c34056a3STejun Heo 1320f3421797STejun Heo if (!on_unbound_cpu) 1321f3421797STejun Heo worker->task = kthread_create(worker_thread, worker, 1322f3421797STejun Heo "kworker/%u:%d", gcwq->cpu, id); 1323f3421797STejun Heo else 1324f3421797STejun Heo worker->task = kthread_create(worker_thread, worker, 1325f3421797STejun Heo "kworker/u:%d", id); 1326c34056a3STejun Heo if (IS_ERR(worker->task)) 1327c34056a3STejun Heo goto fail; 1328c34056a3STejun Heo 1329db7bccf4STejun Heo /* 1330db7bccf4STejun Heo * A rogue worker will become a regular one if CPU comes 1331db7bccf4STejun Heo * online later on. Make sure every worker has 1332db7bccf4STejun Heo * PF_THREAD_BOUND set. 1333db7bccf4STejun Heo */ 1334f3421797STejun Heo if (bind && !on_unbound_cpu) 13358b03ae3cSTejun Heo kthread_bind(worker->task, gcwq->cpu); 1336f3421797STejun Heo else { 1337db7bccf4STejun Heo worker->task->flags |= PF_THREAD_BOUND; 1338f3421797STejun Heo if (on_unbound_cpu) 1339f3421797STejun Heo worker->flags |= WORKER_UNBOUND; 1340f3421797STejun Heo } 1341c34056a3STejun Heo 1342c34056a3STejun Heo return worker; 1343c34056a3STejun Heo fail: 1344c34056a3STejun Heo if (id >= 0) { 13458b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 13468b03ae3cSTejun Heo ida_remove(&gcwq->worker_ida, id); 13478b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 1348c34056a3STejun Heo } 1349c34056a3STejun Heo kfree(worker); 1350c34056a3STejun Heo return NULL; 1351c34056a3STejun Heo } 1352c34056a3STejun Heo 1353c34056a3STejun Heo /** 1354c34056a3STejun Heo * start_worker - start a newly created worker 1355c34056a3STejun Heo * @worker: worker to start 1356c34056a3STejun Heo * 1357c8e55f36STejun Heo * Make the gcwq aware of @worker and start it. 1358c34056a3STejun Heo * 1359c34056a3STejun Heo * CONTEXT: 13608b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock). 1361c34056a3STejun Heo */ 1362c34056a3STejun Heo static void start_worker(struct worker *worker) 1363c34056a3STejun Heo { 1364cb444766STejun Heo worker->flags |= WORKER_STARTED; 1365c8e55f36STejun Heo worker->gcwq->nr_workers++; 1366c8e55f36STejun Heo worker_enter_idle(worker); 1367c34056a3STejun Heo wake_up_process(worker->task); 1368c34056a3STejun Heo } 1369c34056a3STejun Heo 1370c34056a3STejun Heo /** 1371c34056a3STejun Heo * destroy_worker - destroy a workqueue worker 1372c34056a3STejun Heo * @worker: worker to be destroyed 1373c34056a3STejun Heo * 1374c8e55f36STejun Heo * Destroy @worker and adjust @gcwq stats accordingly. 1375c8e55f36STejun Heo * 1376c8e55f36STejun Heo * CONTEXT: 1377c8e55f36STejun Heo * spin_lock_irq(gcwq->lock) which is released and regrabbed. 1378c34056a3STejun Heo */ 1379c34056a3STejun Heo static void destroy_worker(struct worker *worker) 1380c34056a3STejun Heo { 13818b03ae3cSTejun Heo struct global_cwq *gcwq = worker->gcwq; 1382c34056a3STejun Heo int id = worker->id; 1383c34056a3STejun Heo 1384c34056a3STejun Heo /* sanity check frenzy */ 1385c34056a3STejun Heo BUG_ON(worker->current_work); 1386affee4b2STejun Heo BUG_ON(!list_empty(&worker->scheduled)); 1387c34056a3STejun Heo 1388c8e55f36STejun Heo if (worker->flags & WORKER_STARTED) 1389c8e55f36STejun Heo gcwq->nr_workers--; 1390c8e55f36STejun Heo if (worker->flags & WORKER_IDLE) 1391c8e55f36STejun Heo gcwq->nr_idle--; 1392c8e55f36STejun Heo 1393c8e55f36STejun Heo list_del_init(&worker->entry); 1394cb444766STejun Heo worker->flags |= WORKER_DIE; 1395c8e55f36STejun Heo 1396c8e55f36STejun Heo spin_unlock_irq(&gcwq->lock); 1397c8e55f36STejun Heo 1398c34056a3STejun Heo kthread_stop(worker->task); 1399c34056a3STejun Heo kfree(worker); 1400c34056a3STejun Heo 14018b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 14028b03ae3cSTejun Heo ida_remove(&gcwq->worker_ida, id); 1403c34056a3STejun Heo } 1404c34056a3STejun Heo 1405e22bee78STejun Heo static void idle_worker_timeout(unsigned long __gcwq) 1406e22bee78STejun Heo { 1407e22bee78STejun Heo struct global_cwq *gcwq = (void *)__gcwq; 1408e22bee78STejun Heo 1409e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 1410e22bee78STejun Heo 1411e22bee78STejun Heo if (too_many_workers(gcwq)) { 1412e22bee78STejun Heo struct worker *worker; 1413e22bee78STejun Heo unsigned long expires; 1414e22bee78STejun Heo 1415e22bee78STejun Heo /* idle_list is kept in LIFO order, check the last one */ 1416e22bee78STejun Heo worker = list_entry(gcwq->idle_list.prev, struct worker, entry); 1417e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 1418e22bee78STejun Heo 1419e22bee78STejun Heo if (time_before(jiffies, expires)) 1420e22bee78STejun Heo mod_timer(&gcwq->idle_timer, expires); 1421e22bee78STejun Heo else { 1422e22bee78STejun Heo /* it's been idle for too long, wake up manager */ 1423e22bee78STejun Heo gcwq->flags |= GCWQ_MANAGE_WORKERS; 1424e22bee78STejun Heo wake_up_worker(gcwq); 1425e22bee78STejun Heo } 1426e22bee78STejun Heo } 1427e22bee78STejun Heo 1428e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 1429e22bee78STejun Heo } 1430e22bee78STejun Heo 1431e22bee78STejun Heo static bool send_mayday(struct work_struct *work) 1432e22bee78STejun Heo { 1433e22bee78STejun Heo struct cpu_workqueue_struct *cwq = get_work_cwq(work); 1434e22bee78STejun Heo struct workqueue_struct *wq = cwq->wq; 1435f3421797STejun Heo unsigned int cpu; 1436e22bee78STejun Heo 1437e22bee78STejun Heo if (!(wq->flags & WQ_RESCUER)) 1438e22bee78STejun Heo return false; 1439e22bee78STejun Heo 1440e22bee78STejun Heo /* mayday mayday mayday */ 1441f3421797STejun Heo cpu = cwq->gcwq->cpu; 1442f3421797STejun Heo /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */ 1443f3421797STejun Heo if (cpu == WORK_CPU_UNBOUND) 1444f3421797STejun Heo cpu = 0; 1445f2e005aaSTejun Heo if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask)) 1446e22bee78STejun Heo wake_up_process(wq->rescuer->task); 1447e22bee78STejun Heo return true; 1448e22bee78STejun Heo } 1449e22bee78STejun Heo 1450e22bee78STejun Heo static void gcwq_mayday_timeout(unsigned long __gcwq) 1451e22bee78STejun Heo { 1452e22bee78STejun Heo struct global_cwq *gcwq = (void *)__gcwq; 1453e22bee78STejun Heo struct work_struct *work; 1454e22bee78STejun Heo 1455e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 1456e22bee78STejun Heo 1457e22bee78STejun Heo if (need_to_create_worker(gcwq)) { 1458e22bee78STejun Heo /* 1459e22bee78STejun Heo * We've been trying to create a new worker but 1460e22bee78STejun Heo * haven't been successful. We might be hitting an 1461e22bee78STejun Heo * allocation deadlock. Send distress signals to 1462e22bee78STejun Heo * rescuers. 1463e22bee78STejun Heo */ 1464e22bee78STejun Heo list_for_each_entry(work, &gcwq->worklist, entry) 1465e22bee78STejun Heo send_mayday(work); 1466e22bee78STejun Heo } 1467e22bee78STejun Heo 1468e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 1469e22bee78STejun Heo 1470e22bee78STejun Heo mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INTERVAL); 1471e22bee78STejun Heo } 1472e22bee78STejun Heo 1473e22bee78STejun Heo /** 1474e22bee78STejun Heo * maybe_create_worker - create a new worker if necessary 1475e22bee78STejun Heo * @gcwq: gcwq to create a new worker for 1476e22bee78STejun Heo * 1477e22bee78STejun Heo * Create a new worker for @gcwq if necessary. @gcwq is guaranteed to 1478e22bee78STejun Heo * have at least one idle worker on return from this function. If 1479e22bee78STejun Heo * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is 1480e22bee78STejun Heo * sent to all rescuers with works scheduled on @gcwq to resolve 1481e22bee78STejun Heo * possible allocation deadlock. 1482e22bee78STejun Heo * 1483e22bee78STejun Heo * On return, need_to_create_worker() is guaranteed to be false and 1484e22bee78STejun Heo * may_start_working() true. 1485e22bee78STejun Heo * 1486e22bee78STejun Heo * LOCKING: 1487e22bee78STejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 1488e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. Called only from 1489e22bee78STejun Heo * manager. 1490e22bee78STejun Heo * 1491e22bee78STejun Heo * RETURNS: 1492e22bee78STejun Heo * false if no action was taken and gcwq->lock stayed locked, true 1493e22bee78STejun Heo * otherwise. 1494e22bee78STejun Heo */ 1495e22bee78STejun Heo static bool maybe_create_worker(struct global_cwq *gcwq) 149606bd6ebfSNamhyung Kim __releases(&gcwq->lock) 149706bd6ebfSNamhyung Kim __acquires(&gcwq->lock) 1498e22bee78STejun Heo { 1499e22bee78STejun Heo if (!need_to_create_worker(gcwq)) 1500e22bee78STejun Heo return false; 1501e22bee78STejun Heo restart: 15029f9c2364STejun Heo spin_unlock_irq(&gcwq->lock); 15039f9c2364STejun Heo 1504e22bee78STejun Heo /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ 1505e22bee78STejun Heo mod_timer(&gcwq->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); 1506e22bee78STejun Heo 1507e22bee78STejun Heo while (true) { 1508e22bee78STejun Heo struct worker *worker; 1509e22bee78STejun Heo 1510e22bee78STejun Heo worker = create_worker(gcwq, true); 1511e22bee78STejun Heo if (worker) { 1512e22bee78STejun Heo del_timer_sync(&gcwq->mayday_timer); 1513e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 1514e22bee78STejun Heo start_worker(worker); 1515e22bee78STejun Heo BUG_ON(need_to_create_worker(gcwq)); 1516e22bee78STejun Heo return true; 1517e22bee78STejun Heo } 1518e22bee78STejun Heo 1519e22bee78STejun Heo if (!need_to_create_worker(gcwq)) 1520e22bee78STejun Heo break; 1521e22bee78STejun Heo 1522e22bee78STejun Heo __set_current_state(TASK_INTERRUPTIBLE); 1523e22bee78STejun Heo schedule_timeout(CREATE_COOLDOWN); 15249f9c2364STejun Heo 1525e22bee78STejun Heo if (!need_to_create_worker(gcwq)) 1526e22bee78STejun Heo break; 1527e22bee78STejun Heo } 1528e22bee78STejun Heo 1529e22bee78STejun Heo del_timer_sync(&gcwq->mayday_timer); 1530e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 1531e22bee78STejun Heo if (need_to_create_worker(gcwq)) 1532e22bee78STejun Heo goto restart; 1533e22bee78STejun Heo return true; 1534e22bee78STejun Heo } 1535e22bee78STejun Heo 1536e22bee78STejun Heo /** 1537e22bee78STejun Heo * maybe_destroy_worker - destroy workers which have been idle for a while 1538e22bee78STejun Heo * @gcwq: gcwq to destroy workers for 1539e22bee78STejun Heo * 1540e22bee78STejun Heo * Destroy @gcwq workers which have been idle for longer than 1541e22bee78STejun Heo * IDLE_WORKER_TIMEOUT. 1542e22bee78STejun Heo * 1543e22bee78STejun Heo * LOCKING: 1544e22bee78STejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 1545e22bee78STejun Heo * multiple times. Called only from manager. 1546e22bee78STejun Heo * 1547e22bee78STejun Heo * RETURNS: 1548e22bee78STejun Heo * false if no action was taken and gcwq->lock stayed locked, true 1549e22bee78STejun Heo * otherwise. 1550e22bee78STejun Heo */ 1551e22bee78STejun Heo static bool maybe_destroy_workers(struct global_cwq *gcwq) 1552e22bee78STejun Heo { 1553e22bee78STejun Heo bool ret = false; 1554e22bee78STejun Heo 1555e22bee78STejun Heo while (too_many_workers(gcwq)) { 1556e22bee78STejun Heo struct worker *worker; 1557e22bee78STejun Heo unsigned long expires; 1558e22bee78STejun Heo 1559e22bee78STejun Heo worker = list_entry(gcwq->idle_list.prev, struct worker, entry); 1560e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 1561e22bee78STejun Heo 1562e22bee78STejun Heo if (time_before(jiffies, expires)) { 1563e22bee78STejun Heo mod_timer(&gcwq->idle_timer, expires); 1564e22bee78STejun Heo break; 1565e22bee78STejun Heo } 1566e22bee78STejun Heo 1567e22bee78STejun Heo destroy_worker(worker); 1568e22bee78STejun Heo ret = true; 1569e22bee78STejun Heo } 1570e22bee78STejun Heo 1571e22bee78STejun Heo return ret; 1572e22bee78STejun Heo } 1573e22bee78STejun Heo 1574e22bee78STejun Heo /** 1575e22bee78STejun Heo * manage_workers - manage worker pool 1576e22bee78STejun Heo * @worker: self 1577e22bee78STejun Heo * 1578e22bee78STejun Heo * Assume the manager role and manage gcwq worker pool @worker belongs 1579e22bee78STejun Heo * to. At any given time, there can be only zero or one manager per 1580e22bee78STejun Heo * gcwq. The exclusion is handled automatically by this function. 1581e22bee78STejun Heo * 1582e22bee78STejun Heo * The caller can safely start processing works on false return. On 1583e22bee78STejun Heo * true return, it's guaranteed that need_to_create_worker() is false 1584e22bee78STejun Heo * and may_start_working() is true. 1585e22bee78STejun Heo * 1586e22bee78STejun Heo * CONTEXT: 1587e22bee78STejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 1588e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. 1589e22bee78STejun Heo * 1590e22bee78STejun Heo * RETURNS: 1591e22bee78STejun Heo * false if no action was taken and gcwq->lock stayed locked, true if 1592e22bee78STejun Heo * some action was taken. 1593e22bee78STejun Heo */ 1594e22bee78STejun Heo static bool manage_workers(struct worker *worker) 1595e22bee78STejun Heo { 1596e22bee78STejun Heo struct global_cwq *gcwq = worker->gcwq; 1597e22bee78STejun Heo bool ret = false; 1598e22bee78STejun Heo 1599e22bee78STejun Heo if (gcwq->flags & GCWQ_MANAGING_WORKERS) 1600e22bee78STejun Heo return ret; 1601e22bee78STejun Heo 1602e22bee78STejun Heo gcwq->flags &= ~GCWQ_MANAGE_WORKERS; 1603e22bee78STejun Heo gcwq->flags |= GCWQ_MANAGING_WORKERS; 1604e22bee78STejun Heo 1605e22bee78STejun Heo /* 1606e22bee78STejun Heo * Destroy and then create so that may_start_working() is true 1607e22bee78STejun Heo * on return. 1608e22bee78STejun Heo */ 1609e22bee78STejun Heo ret |= maybe_destroy_workers(gcwq); 1610e22bee78STejun Heo ret |= maybe_create_worker(gcwq); 1611e22bee78STejun Heo 1612e22bee78STejun Heo gcwq->flags &= ~GCWQ_MANAGING_WORKERS; 1613e22bee78STejun Heo 1614e22bee78STejun Heo /* 1615e22bee78STejun Heo * The trustee might be waiting to take over the manager 1616e22bee78STejun Heo * position, tell it we're done. 1617e22bee78STejun Heo */ 1618e22bee78STejun Heo if (unlikely(gcwq->trustee)) 1619e22bee78STejun Heo wake_up_all(&gcwq->trustee_wait); 1620e22bee78STejun Heo 1621e22bee78STejun Heo return ret; 1622e22bee78STejun Heo } 1623e22bee78STejun Heo 1624a62428c0STejun Heo /** 1625affee4b2STejun Heo * move_linked_works - move linked works to a list 1626affee4b2STejun Heo * @work: start of series of works to be scheduled 1627affee4b2STejun Heo * @head: target list to append @work to 1628affee4b2STejun Heo * @nextp: out paramter for nested worklist walking 1629affee4b2STejun Heo * 1630affee4b2STejun Heo * Schedule linked works starting from @work to @head. Work series to 1631affee4b2STejun Heo * be scheduled starts at @work and includes any consecutive work with 1632affee4b2STejun Heo * WORK_STRUCT_LINKED set in its predecessor. 1633affee4b2STejun Heo * 1634affee4b2STejun Heo * If @nextp is not NULL, it's updated to point to the next work of 1635affee4b2STejun Heo * the last scheduled work. This allows move_linked_works() to be 1636affee4b2STejun Heo * nested inside outer list_for_each_entry_safe(). 1637affee4b2STejun Heo * 1638affee4b2STejun Heo * CONTEXT: 16398b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock). 1640affee4b2STejun Heo */ 1641affee4b2STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head, 1642affee4b2STejun Heo struct work_struct **nextp) 1643affee4b2STejun Heo { 1644affee4b2STejun Heo struct work_struct *n; 1645affee4b2STejun Heo 1646affee4b2STejun Heo /* 1647affee4b2STejun Heo * Linked worklist will always end before the end of the list, 1648affee4b2STejun Heo * use NULL for list head. 1649affee4b2STejun Heo */ 1650affee4b2STejun Heo list_for_each_entry_safe_from(work, n, NULL, entry) { 1651affee4b2STejun Heo list_move_tail(&work->entry, head); 1652affee4b2STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) 1653affee4b2STejun Heo break; 1654affee4b2STejun Heo } 1655affee4b2STejun Heo 1656affee4b2STejun Heo /* 1657affee4b2STejun Heo * If we're already inside safe list traversal and have moved 1658affee4b2STejun Heo * multiple works to the scheduled queue, the next position 1659affee4b2STejun Heo * needs to be updated. 1660affee4b2STejun Heo */ 1661affee4b2STejun Heo if (nextp) 1662affee4b2STejun Heo *nextp = n; 1663affee4b2STejun Heo } 1664affee4b2STejun Heo 16651e19ffc6STejun Heo static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq) 16661e19ffc6STejun Heo { 16671e19ffc6STejun Heo struct work_struct *work = list_first_entry(&cwq->delayed_works, 16681da177e4SLinus Torvalds struct work_struct, entry); 1669649027d7STejun Heo struct list_head *pos = gcwq_determine_ins_pos(cwq->gcwq, cwq); 16701e19ffc6STejun Heo 1671cdadf009STejun Heo trace_workqueue_activate_work(work); 1672649027d7STejun Heo move_linked_works(work, pos, NULL); 16738a2e8e5dSTejun Heo __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work)); 16741e19ffc6STejun Heo cwq->nr_active++; 16751e19ffc6STejun Heo } 16761e19ffc6STejun Heo 1677affee4b2STejun Heo /** 167873f53c4aSTejun Heo * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight 167973f53c4aSTejun Heo * @cwq: cwq of interest 168073f53c4aSTejun Heo * @color: color of work which left the queue 16818a2e8e5dSTejun Heo * @delayed: for a delayed work 168273f53c4aSTejun Heo * 168373f53c4aSTejun Heo * A work either has completed or is removed from pending queue, 168473f53c4aSTejun Heo * decrement nr_in_flight of its cwq and handle workqueue flushing. 168573f53c4aSTejun Heo * 168673f53c4aSTejun Heo * CONTEXT: 16878b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock). 168873f53c4aSTejun Heo */ 16898a2e8e5dSTejun Heo static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color, 16908a2e8e5dSTejun Heo bool delayed) 169173f53c4aSTejun Heo { 169273f53c4aSTejun Heo /* ignore uncolored works */ 169373f53c4aSTejun Heo if (color == WORK_NO_COLOR) 169473f53c4aSTejun Heo return; 169573f53c4aSTejun Heo 169673f53c4aSTejun Heo cwq->nr_in_flight[color]--; 16971e19ffc6STejun Heo 16988a2e8e5dSTejun Heo if (!delayed) { 16998a2e8e5dSTejun Heo cwq->nr_active--; 1700502ca9d8STejun Heo if (!list_empty(&cwq->delayed_works)) { 17011e19ffc6STejun Heo /* one down, submit a delayed one */ 1702502ca9d8STejun Heo if (cwq->nr_active < cwq->max_active) 17031e19ffc6STejun Heo cwq_activate_first_delayed(cwq); 1704502ca9d8STejun Heo } 17058a2e8e5dSTejun Heo } 170673f53c4aSTejun Heo 170773f53c4aSTejun Heo /* is flush in progress and are we at the flushing tip? */ 170873f53c4aSTejun Heo if (likely(cwq->flush_color != color)) 170973f53c4aSTejun Heo return; 171073f53c4aSTejun Heo 171173f53c4aSTejun Heo /* are there still in-flight works? */ 171273f53c4aSTejun Heo if (cwq->nr_in_flight[color]) 171373f53c4aSTejun Heo return; 171473f53c4aSTejun Heo 171573f53c4aSTejun Heo /* this cwq is done, clear flush_color */ 171673f53c4aSTejun Heo cwq->flush_color = -1; 171773f53c4aSTejun Heo 171873f53c4aSTejun Heo /* 171973f53c4aSTejun Heo * If this was the last cwq, wake up the first flusher. It 172073f53c4aSTejun Heo * will handle the rest. 172173f53c4aSTejun Heo */ 172273f53c4aSTejun Heo if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush)) 172373f53c4aSTejun Heo complete(&cwq->wq->first_flusher->done); 172473f53c4aSTejun Heo } 172573f53c4aSTejun Heo 172673f53c4aSTejun Heo /** 1727a62428c0STejun Heo * process_one_work - process single work 1728c34056a3STejun Heo * @worker: self 1729a62428c0STejun Heo * @work: work to process 1730a62428c0STejun Heo * 1731a62428c0STejun Heo * Process @work. This function contains all the logics necessary to 1732a62428c0STejun Heo * process a single work including synchronization against and 1733a62428c0STejun Heo * interaction with other workers on the same cpu, queueing and 1734a62428c0STejun Heo * flushing. As long as context requirement is met, any worker can 1735a62428c0STejun Heo * call this function to process a work. 1736a62428c0STejun Heo * 1737a62428c0STejun Heo * CONTEXT: 17388b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock) which is released and regrabbed. 1739a62428c0STejun Heo */ 1740c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work) 174106bd6ebfSNamhyung Kim __releases(&gcwq->lock) 174206bd6ebfSNamhyung Kim __acquires(&gcwq->lock) 17431da177e4SLinus Torvalds { 17447e11629dSTejun Heo struct cpu_workqueue_struct *cwq = get_work_cwq(work); 17458b03ae3cSTejun Heo struct global_cwq *gcwq = cwq->gcwq; 1746c8e55f36STejun Heo struct hlist_head *bwh = busy_worker_head(gcwq, work); 1747fb0e7bebSTejun Heo bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE; 17486bb49e59SDavid Howells work_func_t f = work->func; 174973f53c4aSTejun Heo int work_color; 17507e11629dSTejun Heo struct worker *collision; 17514e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 17524e6045f1SJohannes Berg /* 1753a62428c0STejun Heo * It is permissible to free the struct work_struct from 1754a62428c0STejun Heo * inside the function that is called from it, this we need to 1755a62428c0STejun Heo * take into account for lockdep too. To avoid bogus "held 1756a62428c0STejun Heo * lock freed" warnings as well as problems when looking into 1757a62428c0STejun Heo * work->lockdep_map, make a copy and use that here. 17584e6045f1SJohannes Berg */ 17594e6045f1SJohannes Berg struct lockdep_map lockdep_map = work->lockdep_map; 17604e6045f1SJohannes Berg #endif 17617e11629dSTejun Heo /* 17627e11629dSTejun Heo * A single work shouldn't be executed concurrently by 17637e11629dSTejun Heo * multiple workers on a single cpu. Check whether anyone is 17647e11629dSTejun Heo * already processing the work. If so, defer the work to the 17657e11629dSTejun Heo * currently executing one. 17667e11629dSTejun Heo */ 17677e11629dSTejun Heo collision = __find_worker_executing_work(gcwq, bwh, work); 17687e11629dSTejun Heo if (unlikely(collision)) { 17697e11629dSTejun Heo move_linked_works(work, &collision->scheduled, NULL); 17707e11629dSTejun Heo return; 17717e11629dSTejun Heo } 17721da177e4SLinus Torvalds 1773a62428c0STejun Heo /* claim and process */ 17741da177e4SLinus Torvalds debug_work_deactivate(work); 1775c8e55f36STejun Heo hlist_add_head(&worker->hentry, bwh); 1776c34056a3STejun Heo worker->current_work = work; 17778cca0eeaSTejun Heo worker->current_cwq = cwq; 177873f53c4aSTejun Heo work_color = get_work_color(work); 17797a22ad75STejun Heo 17807a22ad75STejun Heo /* record the current cpu number in the work data and dequeue */ 17817a22ad75STejun Heo set_work_cpu(work, gcwq->cpu); 1782a62428c0STejun Heo list_del_init(&work->entry); 1783a62428c0STejun Heo 1784649027d7STejun Heo /* 1785649027d7STejun Heo * If HIGHPRI_PENDING, check the next work, and, if HIGHPRI, 1786649027d7STejun Heo * wake up another worker; otherwise, clear HIGHPRI_PENDING. 1787649027d7STejun Heo */ 1788649027d7STejun Heo if (unlikely(gcwq->flags & GCWQ_HIGHPRI_PENDING)) { 1789649027d7STejun Heo struct work_struct *nwork = list_first_entry(&gcwq->worklist, 1790649027d7STejun Heo struct work_struct, entry); 1791649027d7STejun Heo 1792649027d7STejun Heo if (!list_empty(&gcwq->worklist) && 1793649027d7STejun Heo get_work_cwq(nwork)->wq->flags & WQ_HIGHPRI) 1794649027d7STejun Heo wake_up_worker(gcwq); 1795649027d7STejun Heo else 1796649027d7STejun Heo gcwq->flags &= ~GCWQ_HIGHPRI_PENDING; 1797649027d7STejun Heo } 1798649027d7STejun Heo 1799fb0e7bebSTejun Heo /* 1800fb0e7bebSTejun Heo * CPU intensive works don't participate in concurrency 1801fb0e7bebSTejun Heo * management. They're the scheduler's responsibility. 1802fb0e7bebSTejun Heo */ 1803fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 1804fb0e7bebSTejun Heo worker_set_flags(worker, WORKER_CPU_INTENSIVE, true); 1805fb0e7bebSTejun Heo 18068b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 18071da177e4SLinus Torvalds 180823b2e599SOleg Nesterov work_clear_pending(work); 18093295f0efSIngo Molnar lock_map_acquire(&cwq->wq->lockdep_map); 18103295f0efSIngo Molnar lock_map_acquire(&lockdep_map); 1811e36c886aSArjan van de Ven trace_workqueue_execute_start(work); 181265f27f38SDavid Howells f(work); 1813e36c886aSArjan van de Ven /* 1814e36c886aSArjan van de Ven * While we must be careful to not use "work" after this, the trace 1815e36c886aSArjan van de Ven * point will only record its address. 1816e36c886aSArjan van de Ven */ 1817e36c886aSArjan van de Ven trace_workqueue_execute_end(work); 18183295f0efSIngo Molnar lock_map_release(&lockdep_map); 18193295f0efSIngo Molnar lock_map_release(&cwq->wq->lockdep_map); 18201da177e4SLinus Torvalds 1821d5abe669SPeter Zijlstra if (unlikely(in_atomic() || lockdep_depth(current) > 0)) { 1822d5abe669SPeter Zijlstra printk(KERN_ERR "BUG: workqueue leaked lock or atomic: " 1823d5abe669SPeter Zijlstra "%s/0x%08x/%d\n", 1824a62428c0STejun Heo current->comm, preempt_count(), task_pid_nr(current)); 1825d5abe669SPeter Zijlstra printk(KERN_ERR " last function: "); 1826d5abe669SPeter Zijlstra print_symbol("%s\n", (unsigned long)f); 1827d5abe669SPeter Zijlstra debug_show_held_locks(current); 1828d5abe669SPeter Zijlstra dump_stack(); 1829d5abe669SPeter Zijlstra } 1830d5abe669SPeter Zijlstra 18318b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 1832a62428c0STejun Heo 1833fb0e7bebSTejun Heo /* clear cpu intensive status */ 1834fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 1835fb0e7bebSTejun Heo worker_clr_flags(worker, WORKER_CPU_INTENSIVE); 1836fb0e7bebSTejun Heo 1837a62428c0STejun Heo /* we're done with it, release */ 1838c8e55f36STejun Heo hlist_del_init(&worker->hentry); 1839c34056a3STejun Heo worker->current_work = NULL; 18408cca0eeaSTejun Heo worker->current_cwq = NULL; 18418a2e8e5dSTejun Heo cwq_dec_nr_in_flight(cwq, work_color, false); 18421da177e4SLinus Torvalds } 18431da177e4SLinus Torvalds 1844affee4b2STejun Heo /** 1845affee4b2STejun Heo * process_scheduled_works - process scheduled works 1846affee4b2STejun Heo * @worker: self 1847affee4b2STejun Heo * 1848affee4b2STejun Heo * Process all scheduled works. Please note that the scheduled list 1849affee4b2STejun Heo * may change while processing a work, so this function repeatedly 1850affee4b2STejun Heo * fetches a work from the top and executes it. 1851affee4b2STejun Heo * 1852affee4b2STejun Heo * CONTEXT: 18538b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 1854affee4b2STejun Heo * multiple times. 1855affee4b2STejun Heo */ 1856affee4b2STejun Heo static void process_scheduled_works(struct worker *worker) 18571da177e4SLinus Torvalds { 1858affee4b2STejun Heo while (!list_empty(&worker->scheduled)) { 1859affee4b2STejun Heo struct work_struct *work = list_first_entry(&worker->scheduled, 1860a62428c0STejun Heo struct work_struct, entry); 1861c34056a3STejun Heo process_one_work(worker, work); 1862a62428c0STejun Heo } 18631da177e4SLinus Torvalds } 18641da177e4SLinus Torvalds 18654690c4abSTejun Heo /** 18664690c4abSTejun Heo * worker_thread - the worker thread function 1867c34056a3STejun Heo * @__worker: self 18684690c4abSTejun Heo * 1869e22bee78STejun Heo * The gcwq worker thread function. There's a single dynamic pool of 1870e22bee78STejun Heo * these per each cpu. These workers process all works regardless of 1871e22bee78STejun Heo * their specific target workqueue. The only exception is works which 1872e22bee78STejun Heo * belong to workqueues with a rescuer which will be explained in 1873e22bee78STejun Heo * rescuer_thread(). 18744690c4abSTejun Heo */ 1875c34056a3STejun Heo static int worker_thread(void *__worker) 18761da177e4SLinus Torvalds { 1877c34056a3STejun Heo struct worker *worker = __worker; 18788b03ae3cSTejun Heo struct global_cwq *gcwq = worker->gcwq; 18791da177e4SLinus Torvalds 1880e22bee78STejun Heo /* tell the scheduler that this is a workqueue worker */ 1881e22bee78STejun Heo worker->task->flags |= PF_WQ_WORKER; 1882c8e55f36STejun Heo woke_up: 18838b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 1884affee4b2STejun Heo 1885c8e55f36STejun Heo /* DIE can be set only while we're idle, checking here is enough */ 1886c8e55f36STejun Heo if (worker->flags & WORKER_DIE) { 1887c8e55f36STejun Heo spin_unlock_irq(&gcwq->lock); 1888e22bee78STejun Heo worker->task->flags &= ~PF_WQ_WORKER; 1889c8e55f36STejun Heo return 0; 1890c8e55f36STejun Heo } 1891c8e55f36STejun Heo 1892c8e55f36STejun Heo worker_leave_idle(worker); 1893db7bccf4STejun Heo recheck: 1894e22bee78STejun Heo /* no more worker necessary? */ 1895e22bee78STejun Heo if (!need_more_worker(gcwq)) 1896e22bee78STejun Heo goto sleep; 1897e22bee78STejun Heo 1898e22bee78STejun Heo /* do we need to manage? */ 1899e22bee78STejun Heo if (unlikely(!may_start_working(gcwq)) && manage_workers(worker)) 1900e22bee78STejun Heo goto recheck; 1901e22bee78STejun Heo 1902c8e55f36STejun Heo /* 1903c8e55f36STejun Heo * ->scheduled list can only be filled while a worker is 1904c8e55f36STejun Heo * preparing to process a work or actually processing it. 1905c8e55f36STejun Heo * Make sure nobody diddled with it while I was sleeping. 1906c8e55f36STejun Heo */ 1907c8e55f36STejun Heo BUG_ON(!list_empty(&worker->scheduled)); 1908c8e55f36STejun Heo 1909e22bee78STejun Heo /* 1910e22bee78STejun Heo * When control reaches this point, we're guaranteed to have 1911e22bee78STejun Heo * at least one idle worker or that someone else has already 1912e22bee78STejun Heo * assumed the manager role. 1913e22bee78STejun Heo */ 1914e22bee78STejun Heo worker_clr_flags(worker, WORKER_PREP); 1915e22bee78STejun Heo 1916e22bee78STejun Heo do { 1917affee4b2STejun Heo struct work_struct *work = 19187e11629dSTejun Heo list_first_entry(&gcwq->worklist, 1919affee4b2STejun Heo struct work_struct, entry); 1920affee4b2STejun Heo 1921c8e55f36STejun Heo if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) { 1922affee4b2STejun Heo /* optimization path, not strictly necessary */ 1923affee4b2STejun Heo process_one_work(worker, work); 1924affee4b2STejun Heo if (unlikely(!list_empty(&worker->scheduled))) 1925affee4b2STejun Heo process_scheduled_works(worker); 1926affee4b2STejun Heo } else { 1927c8e55f36STejun Heo move_linked_works(work, &worker->scheduled, NULL); 1928affee4b2STejun Heo process_scheduled_works(worker); 1929affee4b2STejun Heo } 1930e22bee78STejun Heo } while (keep_working(gcwq)); 1931affee4b2STejun Heo 1932e22bee78STejun Heo worker_set_flags(worker, WORKER_PREP, false); 1933d313dd85STejun Heo sleep: 1934e22bee78STejun Heo if (unlikely(need_to_manage_workers(gcwq)) && manage_workers(worker)) 1935e22bee78STejun Heo goto recheck; 1936d313dd85STejun Heo 1937c8e55f36STejun Heo /* 1938e22bee78STejun Heo * gcwq->lock is held and there's no work to process and no 1939e22bee78STejun Heo * need to manage, sleep. Workers are woken up only while 1940e22bee78STejun Heo * holding gcwq->lock or from local cpu, so setting the 1941e22bee78STejun Heo * current state before releasing gcwq->lock is enough to 1942e22bee78STejun Heo * prevent losing any event. 1943c8e55f36STejun Heo */ 1944c8e55f36STejun Heo worker_enter_idle(worker); 1945c8e55f36STejun Heo __set_current_state(TASK_INTERRUPTIBLE); 19468b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 19471da177e4SLinus Torvalds schedule(); 1948c8e55f36STejun Heo goto woke_up; 19491da177e4SLinus Torvalds } 19501da177e4SLinus Torvalds 1951e22bee78STejun Heo /** 1952e22bee78STejun Heo * rescuer_thread - the rescuer thread function 1953e22bee78STejun Heo * @__wq: the associated workqueue 1954e22bee78STejun Heo * 1955e22bee78STejun Heo * Workqueue rescuer thread function. There's one rescuer for each 1956e22bee78STejun Heo * workqueue which has WQ_RESCUER set. 1957e22bee78STejun Heo * 1958e22bee78STejun Heo * Regular work processing on a gcwq may block trying to create a new 1959e22bee78STejun Heo * worker which uses GFP_KERNEL allocation which has slight chance of 1960e22bee78STejun Heo * developing into deadlock if some works currently on the same queue 1961e22bee78STejun Heo * need to be processed to satisfy the GFP_KERNEL allocation. This is 1962e22bee78STejun Heo * the problem rescuer solves. 1963e22bee78STejun Heo * 1964e22bee78STejun Heo * When such condition is possible, the gcwq summons rescuers of all 1965e22bee78STejun Heo * workqueues which have works queued on the gcwq and let them process 1966e22bee78STejun Heo * those works so that forward progress can be guaranteed. 1967e22bee78STejun Heo * 1968e22bee78STejun Heo * This should happen rarely. 1969e22bee78STejun Heo */ 1970e22bee78STejun Heo static int rescuer_thread(void *__wq) 1971e22bee78STejun Heo { 1972e22bee78STejun Heo struct workqueue_struct *wq = __wq; 1973e22bee78STejun Heo struct worker *rescuer = wq->rescuer; 1974e22bee78STejun Heo struct list_head *scheduled = &rescuer->scheduled; 1975f3421797STejun Heo bool is_unbound = wq->flags & WQ_UNBOUND; 1976e22bee78STejun Heo unsigned int cpu; 1977e22bee78STejun Heo 1978e22bee78STejun Heo set_user_nice(current, RESCUER_NICE_LEVEL); 1979e22bee78STejun Heo repeat: 1980e22bee78STejun Heo set_current_state(TASK_INTERRUPTIBLE); 19811da177e4SLinus Torvalds 19821da177e4SLinus Torvalds if (kthread_should_stop()) 1983e22bee78STejun Heo return 0; 19841da177e4SLinus Torvalds 1985f3421797STejun Heo /* 1986f3421797STejun Heo * See whether any cpu is asking for help. Unbounded 1987f3421797STejun Heo * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND. 1988f3421797STejun Heo */ 1989f2e005aaSTejun Heo for_each_mayday_cpu(cpu, wq->mayday_mask) { 1990f3421797STejun Heo unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu; 1991f3421797STejun Heo struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq); 1992e22bee78STejun Heo struct global_cwq *gcwq = cwq->gcwq; 1993e22bee78STejun Heo struct work_struct *work, *n; 1994e22bee78STejun Heo 1995e22bee78STejun Heo __set_current_state(TASK_RUNNING); 1996f2e005aaSTejun Heo mayday_clear_cpu(cpu, wq->mayday_mask); 1997e22bee78STejun Heo 1998e22bee78STejun Heo /* migrate to the target cpu if possible */ 1999e22bee78STejun Heo rescuer->gcwq = gcwq; 2000e22bee78STejun Heo worker_maybe_bind_and_lock(rescuer); 2001e22bee78STejun Heo 2002e22bee78STejun Heo /* 2003e22bee78STejun Heo * Slurp in all works issued via this workqueue and 2004e22bee78STejun Heo * process'em. 2005e22bee78STejun Heo */ 2006e22bee78STejun Heo BUG_ON(!list_empty(&rescuer->scheduled)); 2007e22bee78STejun Heo list_for_each_entry_safe(work, n, &gcwq->worklist, entry) 2008e22bee78STejun Heo if (get_work_cwq(work) == cwq) 2009e22bee78STejun Heo move_linked_works(work, scheduled, &n); 2010e22bee78STejun Heo 2011e22bee78STejun Heo process_scheduled_works(rescuer); 2012e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 20131da177e4SLinus Torvalds } 20141da177e4SLinus Torvalds 2015e22bee78STejun Heo schedule(); 2016e22bee78STejun Heo goto repeat; 20171da177e4SLinus Torvalds } 20181da177e4SLinus Torvalds 2019fc2e4d70SOleg Nesterov struct wq_barrier { 2020fc2e4d70SOleg Nesterov struct work_struct work; 2021fc2e4d70SOleg Nesterov struct completion done; 2022fc2e4d70SOleg Nesterov }; 2023fc2e4d70SOleg Nesterov 2024fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work) 2025fc2e4d70SOleg Nesterov { 2026fc2e4d70SOleg Nesterov struct wq_barrier *barr = container_of(work, struct wq_barrier, work); 2027fc2e4d70SOleg Nesterov complete(&barr->done); 2028fc2e4d70SOleg Nesterov } 2029fc2e4d70SOleg Nesterov 20304690c4abSTejun Heo /** 20314690c4abSTejun Heo * insert_wq_barrier - insert a barrier work 20324690c4abSTejun Heo * @cwq: cwq to insert barrier into 20334690c4abSTejun Heo * @barr: wq_barrier to insert 2034affee4b2STejun Heo * @target: target work to attach @barr to 2035affee4b2STejun Heo * @worker: worker currently executing @target, NULL if @target is not executing 20364690c4abSTejun Heo * 2037affee4b2STejun Heo * @barr is linked to @target such that @barr is completed only after 2038affee4b2STejun Heo * @target finishes execution. Please note that the ordering 2039affee4b2STejun Heo * guarantee is observed only with respect to @target and on the local 2040affee4b2STejun Heo * cpu. 2041affee4b2STejun Heo * 2042affee4b2STejun Heo * Currently, a queued barrier can't be canceled. This is because 2043affee4b2STejun Heo * try_to_grab_pending() can't determine whether the work to be 2044affee4b2STejun Heo * grabbed is at the head of the queue and thus can't clear LINKED 2045affee4b2STejun Heo * flag of the previous work while there must be a valid next work 2046affee4b2STejun Heo * after a work with LINKED flag set. 2047affee4b2STejun Heo * 2048affee4b2STejun Heo * Note that when @worker is non-NULL, @target may be modified 2049affee4b2STejun Heo * underneath us, so we can't reliably determine cwq from @target. 20504690c4abSTejun Heo * 20514690c4abSTejun Heo * CONTEXT: 20528b03ae3cSTejun Heo * spin_lock_irq(gcwq->lock). 20534690c4abSTejun Heo */ 205483c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq, 2055affee4b2STejun Heo struct wq_barrier *barr, 2056affee4b2STejun Heo struct work_struct *target, struct worker *worker) 2057fc2e4d70SOleg Nesterov { 2058affee4b2STejun Heo struct list_head *head; 2059affee4b2STejun Heo unsigned int linked = 0; 2060affee4b2STejun Heo 2061dc186ad7SThomas Gleixner /* 20628b03ae3cSTejun Heo * debugobject calls are safe here even with gcwq->lock locked 2063dc186ad7SThomas Gleixner * as we know for sure that this will not trigger any of the 2064dc186ad7SThomas Gleixner * checks and call back into the fixup functions where we 2065dc186ad7SThomas Gleixner * might deadlock. 2066dc186ad7SThomas Gleixner */ 2067ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&barr->work, wq_barrier_func); 206822df02bbSTejun Heo __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); 2069fc2e4d70SOleg Nesterov init_completion(&barr->done); 207083c22520SOleg Nesterov 2071affee4b2STejun Heo /* 2072affee4b2STejun Heo * If @target is currently being executed, schedule the 2073affee4b2STejun Heo * barrier to the worker; otherwise, put it after @target. 2074affee4b2STejun Heo */ 2075affee4b2STejun Heo if (worker) 2076affee4b2STejun Heo head = worker->scheduled.next; 2077affee4b2STejun Heo else { 2078affee4b2STejun Heo unsigned long *bits = work_data_bits(target); 2079affee4b2STejun Heo 2080affee4b2STejun Heo head = target->entry.next; 2081affee4b2STejun Heo /* there can already be other linked works, inherit and set */ 2082affee4b2STejun Heo linked = *bits & WORK_STRUCT_LINKED; 2083affee4b2STejun Heo __set_bit(WORK_STRUCT_LINKED_BIT, bits); 2084affee4b2STejun Heo } 2085affee4b2STejun Heo 2086dc186ad7SThomas Gleixner debug_work_activate(&barr->work); 2087affee4b2STejun Heo insert_work(cwq, &barr->work, head, 2088affee4b2STejun Heo work_color_to_flags(WORK_NO_COLOR) | linked); 2089fc2e4d70SOleg Nesterov } 2090fc2e4d70SOleg Nesterov 209173f53c4aSTejun Heo /** 209273f53c4aSTejun Heo * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing 209373f53c4aSTejun Heo * @wq: workqueue being flushed 209473f53c4aSTejun Heo * @flush_color: new flush color, < 0 for no-op 209573f53c4aSTejun Heo * @work_color: new work color, < 0 for no-op 209673f53c4aSTejun Heo * 209773f53c4aSTejun Heo * Prepare cwqs for workqueue flushing. 209873f53c4aSTejun Heo * 209973f53c4aSTejun Heo * If @flush_color is non-negative, flush_color on all cwqs should be 210073f53c4aSTejun Heo * -1. If no cwq has in-flight commands at the specified color, all 210173f53c4aSTejun Heo * cwq->flush_color's stay at -1 and %false is returned. If any cwq 210273f53c4aSTejun Heo * has in flight commands, its cwq->flush_color is set to 210373f53c4aSTejun Heo * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq 210473f53c4aSTejun Heo * wakeup logic is armed and %true is returned. 210573f53c4aSTejun Heo * 210673f53c4aSTejun Heo * The caller should have initialized @wq->first_flusher prior to 210773f53c4aSTejun Heo * calling this function with non-negative @flush_color. If 210873f53c4aSTejun Heo * @flush_color is negative, no flush color update is done and %false 210973f53c4aSTejun Heo * is returned. 211073f53c4aSTejun Heo * 211173f53c4aSTejun Heo * If @work_color is non-negative, all cwqs should have the same 211273f53c4aSTejun Heo * work_color which is previous to @work_color and all will be 211373f53c4aSTejun Heo * advanced to @work_color. 211473f53c4aSTejun Heo * 211573f53c4aSTejun Heo * CONTEXT: 211673f53c4aSTejun Heo * mutex_lock(wq->flush_mutex). 211773f53c4aSTejun Heo * 211873f53c4aSTejun Heo * RETURNS: 211973f53c4aSTejun Heo * %true if @flush_color >= 0 and there's something to flush. %false 212073f53c4aSTejun Heo * otherwise. 212173f53c4aSTejun Heo */ 212273f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq, 212373f53c4aSTejun Heo int flush_color, int work_color) 21241da177e4SLinus Torvalds { 212573f53c4aSTejun Heo bool wait = false; 212673f53c4aSTejun Heo unsigned int cpu; 21271da177e4SLinus Torvalds 212873f53c4aSTejun Heo if (flush_color >= 0) { 212973f53c4aSTejun Heo BUG_ON(atomic_read(&wq->nr_cwqs_to_flush)); 213073f53c4aSTejun Heo atomic_set(&wq->nr_cwqs_to_flush, 1); 2131dc186ad7SThomas Gleixner } 213214441960SOleg Nesterov 2133f3421797STejun Heo for_each_cwq_cpu(cpu, wq) { 213473f53c4aSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 21358b03ae3cSTejun Heo struct global_cwq *gcwq = cwq->gcwq; 21361da177e4SLinus Torvalds 21378b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 213873f53c4aSTejun Heo 213973f53c4aSTejun Heo if (flush_color >= 0) { 214073f53c4aSTejun Heo BUG_ON(cwq->flush_color != -1); 214173f53c4aSTejun Heo 214273f53c4aSTejun Heo if (cwq->nr_in_flight[flush_color]) { 214373f53c4aSTejun Heo cwq->flush_color = flush_color; 214473f53c4aSTejun Heo atomic_inc(&wq->nr_cwqs_to_flush); 214573f53c4aSTejun Heo wait = true; 21461da177e4SLinus Torvalds } 214773f53c4aSTejun Heo } 214873f53c4aSTejun Heo 214973f53c4aSTejun Heo if (work_color >= 0) { 215073f53c4aSTejun Heo BUG_ON(work_color != work_next_color(cwq->work_color)); 215173f53c4aSTejun Heo cwq->work_color = work_color; 215273f53c4aSTejun Heo } 215373f53c4aSTejun Heo 21548b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 21551da177e4SLinus Torvalds } 21561da177e4SLinus Torvalds 215773f53c4aSTejun Heo if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush)) 215873f53c4aSTejun Heo complete(&wq->first_flusher->done); 215973f53c4aSTejun Heo 216073f53c4aSTejun Heo return wait; 216183c22520SOleg Nesterov } 21621da177e4SLinus Torvalds 21630fcb78c2SRolf Eike Beer /** 21641da177e4SLinus Torvalds * flush_workqueue - ensure that any scheduled work has run to completion. 21650fcb78c2SRolf Eike Beer * @wq: workqueue to flush 21661da177e4SLinus Torvalds * 21671da177e4SLinus Torvalds * Forces execution of the workqueue and blocks until its completion. 21681da177e4SLinus Torvalds * This is typically used in driver shutdown handlers. 21691da177e4SLinus Torvalds * 2170fc2e4d70SOleg Nesterov * We sleep until all works which were queued on entry have been handled, 2171fc2e4d70SOleg Nesterov * but we are not livelocked by new incoming ones. 21721da177e4SLinus Torvalds */ 21737ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq) 21741da177e4SLinus Torvalds { 217573f53c4aSTejun Heo struct wq_flusher this_flusher = { 217673f53c4aSTejun Heo .list = LIST_HEAD_INIT(this_flusher.list), 217773f53c4aSTejun Heo .flush_color = -1, 217873f53c4aSTejun Heo .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done), 217973f53c4aSTejun Heo }; 218073f53c4aSTejun Heo int next_color; 2181b1f4ec17SOleg Nesterov 21823295f0efSIngo Molnar lock_map_acquire(&wq->lockdep_map); 21833295f0efSIngo Molnar lock_map_release(&wq->lockdep_map); 218473f53c4aSTejun Heo 218573f53c4aSTejun Heo mutex_lock(&wq->flush_mutex); 218673f53c4aSTejun Heo 218773f53c4aSTejun Heo /* 218873f53c4aSTejun Heo * Start-to-wait phase 218973f53c4aSTejun Heo */ 219073f53c4aSTejun Heo next_color = work_next_color(wq->work_color); 219173f53c4aSTejun Heo 219273f53c4aSTejun Heo if (next_color != wq->flush_color) { 219373f53c4aSTejun Heo /* 219473f53c4aSTejun Heo * Color space is not full. The current work_color 219573f53c4aSTejun Heo * becomes our flush_color and work_color is advanced 219673f53c4aSTejun Heo * by one. 219773f53c4aSTejun Heo */ 219873f53c4aSTejun Heo BUG_ON(!list_empty(&wq->flusher_overflow)); 219973f53c4aSTejun Heo this_flusher.flush_color = wq->work_color; 220073f53c4aSTejun Heo wq->work_color = next_color; 220173f53c4aSTejun Heo 220273f53c4aSTejun Heo if (!wq->first_flusher) { 220373f53c4aSTejun Heo /* no flush in progress, become the first flusher */ 220473f53c4aSTejun Heo BUG_ON(wq->flush_color != this_flusher.flush_color); 220573f53c4aSTejun Heo 220673f53c4aSTejun Heo wq->first_flusher = &this_flusher; 220773f53c4aSTejun Heo 220873f53c4aSTejun Heo if (!flush_workqueue_prep_cwqs(wq, wq->flush_color, 220973f53c4aSTejun Heo wq->work_color)) { 221073f53c4aSTejun Heo /* nothing to flush, done */ 221173f53c4aSTejun Heo wq->flush_color = next_color; 221273f53c4aSTejun Heo wq->first_flusher = NULL; 221373f53c4aSTejun Heo goto out_unlock; 221473f53c4aSTejun Heo } 221573f53c4aSTejun Heo } else { 221673f53c4aSTejun Heo /* wait in queue */ 221773f53c4aSTejun Heo BUG_ON(wq->flush_color == this_flusher.flush_color); 221873f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_queue); 221973f53c4aSTejun Heo flush_workqueue_prep_cwqs(wq, -1, wq->work_color); 222073f53c4aSTejun Heo } 222173f53c4aSTejun Heo } else { 222273f53c4aSTejun Heo /* 222373f53c4aSTejun Heo * Oops, color space is full, wait on overflow queue. 222473f53c4aSTejun Heo * The next flush completion will assign us 222573f53c4aSTejun Heo * flush_color and transfer to flusher_queue. 222673f53c4aSTejun Heo */ 222773f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_overflow); 222873f53c4aSTejun Heo } 222973f53c4aSTejun Heo 223073f53c4aSTejun Heo mutex_unlock(&wq->flush_mutex); 223173f53c4aSTejun Heo 223273f53c4aSTejun Heo wait_for_completion(&this_flusher.done); 223373f53c4aSTejun Heo 223473f53c4aSTejun Heo /* 223573f53c4aSTejun Heo * Wake-up-and-cascade phase 223673f53c4aSTejun Heo * 223773f53c4aSTejun Heo * First flushers are responsible for cascading flushes and 223873f53c4aSTejun Heo * handling overflow. Non-first flushers can simply return. 223973f53c4aSTejun Heo */ 224073f53c4aSTejun Heo if (wq->first_flusher != &this_flusher) 224173f53c4aSTejun Heo return; 224273f53c4aSTejun Heo 224373f53c4aSTejun Heo mutex_lock(&wq->flush_mutex); 224473f53c4aSTejun Heo 22454ce48b37STejun Heo /* we might have raced, check again with mutex held */ 22464ce48b37STejun Heo if (wq->first_flusher != &this_flusher) 22474ce48b37STejun Heo goto out_unlock; 22484ce48b37STejun Heo 224973f53c4aSTejun Heo wq->first_flusher = NULL; 225073f53c4aSTejun Heo 225173f53c4aSTejun Heo BUG_ON(!list_empty(&this_flusher.list)); 225273f53c4aSTejun Heo BUG_ON(wq->flush_color != this_flusher.flush_color); 225373f53c4aSTejun Heo 225473f53c4aSTejun Heo while (true) { 225573f53c4aSTejun Heo struct wq_flusher *next, *tmp; 225673f53c4aSTejun Heo 225773f53c4aSTejun Heo /* complete all the flushers sharing the current flush color */ 225873f53c4aSTejun Heo list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { 225973f53c4aSTejun Heo if (next->flush_color != wq->flush_color) 226073f53c4aSTejun Heo break; 226173f53c4aSTejun Heo list_del_init(&next->list); 226273f53c4aSTejun Heo complete(&next->done); 226373f53c4aSTejun Heo } 226473f53c4aSTejun Heo 226573f53c4aSTejun Heo BUG_ON(!list_empty(&wq->flusher_overflow) && 226673f53c4aSTejun Heo wq->flush_color != work_next_color(wq->work_color)); 226773f53c4aSTejun Heo 226873f53c4aSTejun Heo /* this flush_color is finished, advance by one */ 226973f53c4aSTejun Heo wq->flush_color = work_next_color(wq->flush_color); 227073f53c4aSTejun Heo 227173f53c4aSTejun Heo /* one color has been freed, handle overflow queue */ 227273f53c4aSTejun Heo if (!list_empty(&wq->flusher_overflow)) { 227373f53c4aSTejun Heo /* 227473f53c4aSTejun Heo * Assign the same color to all overflowed 227573f53c4aSTejun Heo * flushers, advance work_color and append to 227673f53c4aSTejun Heo * flusher_queue. This is the start-to-wait 227773f53c4aSTejun Heo * phase for these overflowed flushers. 227873f53c4aSTejun Heo */ 227973f53c4aSTejun Heo list_for_each_entry(tmp, &wq->flusher_overflow, list) 228073f53c4aSTejun Heo tmp->flush_color = wq->work_color; 228173f53c4aSTejun Heo 228273f53c4aSTejun Heo wq->work_color = work_next_color(wq->work_color); 228373f53c4aSTejun Heo 228473f53c4aSTejun Heo list_splice_tail_init(&wq->flusher_overflow, 228573f53c4aSTejun Heo &wq->flusher_queue); 228673f53c4aSTejun Heo flush_workqueue_prep_cwqs(wq, -1, wq->work_color); 228773f53c4aSTejun Heo } 228873f53c4aSTejun Heo 228973f53c4aSTejun Heo if (list_empty(&wq->flusher_queue)) { 229073f53c4aSTejun Heo BUG_ON(wq->flush_color != wq->work_color); 229173f53c4aSTejun Heo break; 229273f53c4aSTejun Heo } 229373f53c4aSTejun Heo 229473f53c4aSTejun Heo /* 229573f53c4aSTejun Heo * Need to flush more colors. Make the next flusher 229673f53c4aSTejun Heo * the new first flusher and arm cwqs. 229773f53c4aSTejun Heo */ 229873f53c4aSTejun Heo BUG_ON(wq->flush_color == wq->work_color); 229973f53c4aSTejun Heo BUG_ON(wq->flush_color != next->flush_color); 230073f53c4aSTejun Heo 230173f53c4aSTejun Heo list_del_init(&next->list); 230273f53c4aSTejun Heo wq->first_flusher = next; 230373f53c4aSTejun Heo 230473f53c4aSTejun Heo if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1)) 230573f53c4aSTejun Heo break; 230673f53c4aSTejun Heo 230773f53c4aSTejun Heo /* 230873f53c4aSTejun Heo * Meh... this color is already done, clear first 230973f53c4aSTejun Heo * flusher and repeat cascading. 231073f53c4aSTejun Heo */ 231173f53c4aSTejun Heo wq->first_flusher = NULL; 231273f53c4aSTejun Heo } 231373f53c4aSTejun Heo 231473f53c4aSTejun Heo out_unlock: 231573f53c4aSTejun Heo mutex_unlock(&wq->flush_mutex); 23161da177e4SLinus Torvalds } 2317ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue); 23181da177e4SLinus Torvalds 2319baf59022STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr, 2320baf59022STejun Heo bool wait_executing) 2321baf59022STejun Heo { 2322baf59022STejun Heo struct worker *worker = NULL; 2323baf59022STejun Heo struct global_cwq *gcwq; 2324baf59022STejun Heo struct cpu_workqueue_struct *cwq; 2325baf59022STejun Heo 2326baf59022STejun Heo might_sleep(); 2327baf59022STejun Heo gcwq = get_work_gcwq(work); 2328baf59022STejun Heo if (!gcwq) 2329baf59022STejun Heo return false; 2330baf59022STejun Heo 2331baf59022STejun Heo spin_lock_irq(&gcwq->lock); 2332baf59022STejun Heo if (!list_empty(&work->entry)) { 2333baf59022STejun Heo /* 2334baf59022STejun Heo * See the comment near try_to_grab_pending()->smp_rmb(). 2335baf59022STejun Heo * If it was re-queued to a different gcwq under us, we 2336baf59022STejun Heo * are not going to wait. 2337baf59022STejun Heo */ 2338baf59022STejun Heo smp_rmb(); 2339baf59022STejun Heo cwq = get_work_cwq(work); 2340baf59022STejun Heo if (unlikely(!cwq || gcwq != cwq->gcwq)) 2341baf59022STejun Heo goto already_gone; 2342baf59022STejun Heo } else if (wait_executing) { 2343baf59022STejun Heo worker = find_worker_executing_work(gcwq, work); 2344baf59022STejun Heo if (!worker) 2345baf59022STejun Heo goto already_gone; 2346baf59022STejun Heo cwq = worker->current_cwq; 2347baf59022STejun Heo } else 2348baf59022STejun Heo goto already_gone; 2349baf59022STejun Heo 2350baf59022STejun Heo insert_wq_barrier(cwq, barr, work, worker); 2351baf59022STejun Heo spin_unlock_irq(&gcwq->lock); 2352baf59022STejun Heo 2353baf59022STejun Heo lock_map_acquire(&cwq->wq->lockdep_map); 2354baf59022STejun Heo lock_map_release(&cwq->wq->lockdep_map); 2355baf59022STejun Heo return true; 2356baf59022STejun Heo already_gone: 2357baf59022STejun Heo spin_unlock_irq(&gcwq->lock); 2358baf59022STejun Heo return false; 2359baf59022STejun Heo } 2360baf59022STejun Heo 2361db700897SOleg Nesterov /** 2362401a8d04STejun Heo * flush_work - wait for a work to finish executing the last queueing instance 2363401a8d04STejun Heo * @work: the work to flush 2364db700897SOleg Nesterov * 2365401a8d04STejun Heo * Wait until @work has finished execution. This function considers 2366401a8d04STejun Heo * only the last queueing instance of @work. If @work has been 2367401a8d04STejun Heo * enqueued across different CPUs on a non-reentrant workqueue or on 2368401a8d04STejun Heo * multiple workqueues, @work might still be executing on return on 2369401a8d04STejun Heo * some of the CPUs from earlier queueing. 2370a67da70dSOleg Nesterov * 2371401a8d04STejun Heo * If @work was queued only on a non-reentrant, ordered or unbound 2372401a8d04STejun Heo * workqueue, @work is guaranteed to be idle on return if it hasn't 2373401a8d04STejun Heo * been requeued since flush started. 2374401a8d04STejun Heo * 2375401a8d04STejun Heo * RETURNS: 2376401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2377401a8d04STejun Heo * %false if it was already idle. 2378db700897SOleg Nesterov */ 2379401a8d04STejun Heo bool flush_work(struct work_struct *work) 2380db700897SOleg Nesterov { 2381db700897SOleg Nesterov struct wq_barrier barr; 2382db700897SOleg Nesterov 2383baf59022STejun Heo if (start_flush_work(work, &barr, true)) { 2384db700897SOleg Nesterov wait_for_completion(&barr.done); 2385dc186ad7SThomas Gleixner destroy_work_on_stack(&barr.work); 2386401a8d04STejun Heo return true; 2387baf59022STejun Heo } else 2388401a8d04STejun Heo return false; 2389db700897SOleg Nesterov } 2390db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work); 2391db700897SOleg Nesterov 2392401a8d04STejun Heo static bool wait_on_cpu_work(struct global_cwq *gcwq, struct work_struct *work) 2393401a8d04STejun Heo { 2394401a8d04STejun Heo struct wq_barrier barr; 2395401a8d04STejun Heo struct worker *worker; 2396401a8d04STejun Heo 2397401a8d04STejun Heo spin_lock_irq(&gcwq->lock); 2398401a8d04STejun Heo 2399401a8d04STejun Heo worker = find_worker_executing_work(gcwq, work); 2400401a8d04STejun Heo if (unlikely(worker)) 2401401a8d04STejun Heo insert_wq_barrier(worker->current_cwq, &barr, work, worker); 2402401a8d04STejun Heo 2403401a8d04STejun Heo spin_unlock_irq(&gcwq->lock); 2404401a8d04STejun Heo 2405401a8d04STejun Heo if (unlikely(worker)) { 2406401a8d04STejun Heo wait_for_completion(&barr.done); 2407401a8d04STejun Heo destroy_work_on_stack(&barr.work); 2408401a8d04STejun Heo return true; 2409401a8d04STejun Heo } else 2410401a8d04STejun Heo return false; 2411401a8d04STejun Heo } 2412401a8d04STejun Heo 2413401a8d04STejun Heo static bool wait_on_work(struct work_struct *work) 2414401a8d04STejun Heo { 2415401a8d04STejun Heo bool ret = false; 2416401a8d04STejun Heo int cpu; 2417401a8d04STejun Heo 2418401a8d04STejun Heo might_sleep(); 2419401a8d04STejun Heo 2420401a8d04STejun Heo lock_map_acquire(&work->lockdep_map); 2421401a8d04STejun Heo lock_map_release(&work->lockdep_map); 2422401a8d04STejun Heo 2423401a8d04STejun Heo for_each_gcwq_cpu(cpu) 2424401a8d04STejun Heo ret |= wait_on_cpu_work(get_gcwq(cpu), work); 2425401a8d04STejun Heo return ret; 2426401a8d04STejun Heo } 2427401a8d04STejun Heo 242809383498STejun Heo /** 242909383498STejun Heo * flush_work_sync - wait until a work has finished execution 243009383498STejun Heo * @work: the work to flush 243109383498STejun Heo * 243209383498STejun Heo * Wait until @work has finished execution. On return, it's 243309383498STejun Heo * guaranteed that all queueing instances of @work which happened 243409383498STejun Heo * before this function is called are finished. In other words, if 243509383498STejun Heo * @work hasn't been requeued since this function was called, @work is 243609383498STejun Heo * guaranteed to be idle on return. 243709383498STejun Heo * 243809383498STejun Heo * RETURNS: 243909383498STejun Heo * %true if flush_work_sync() waited for the work to finish execution, 244009383498STejun Heo * %false if it was already idle. 244109383498STejun Heo */ 244209383498STejun Heo bool flush_work_sync(struct work_struct *work) 244309383498STejun Heo { 244409383498STejun Heo struct wq_barrier barr; 244509383498STejun Heo bool pending, waited; 244609383498STejun Heo 244709383498STejun Heo /* we'll wait for executions separately, queue barr only if pending */ 244809383498STejun Heo pending = start_flush_work(work, &barr, false); 244909383498STejun Heo 245009383498STejun Heo /* wait for executions to finish */ 245109383498STejun Heo waited = wait_on_work(work); 245209383498STejun Heo 245309383498STejun Heo /* wait for the pending one */ 245409383498STejun Heo if (pending) { 245509383498STejun Heo wait_for_completion(&barr.done); 245609383498STejun Heo destroy_work_on_stack(&barr.work); 245709383498STejun Heo } 245809383498STejun Heo 245909383498STejun Heo return pending || waited; 246009383498STejun Heo } 246109383498STejun Heo EXPORT_SYMBOL_GPL(flush_work_sync); 246209383498STejun Heo 24636e84d644SOleg Nesterov /* 24641f1f642eSOleg Nesterov * Upon a successful return (>= 0), the caller "owns" WORK_STRUCT_PENDING bit, 24656e84d644SOleg Nesterov * so this work can't be re-armed in any way. 24666e84d644SOleg Nesterov */ 24676e84d644SOleg Nesterov static int try_to_grab_pending(struct work_struct *work) 24686e84d644SOleg Nesterov { 24698b03ae3cSTejun Heo struct global_cwq *gcwq; 24701f1f642eSOleg Nesterov int ret = -1; 24716e84d644SOleg Nesterov 247222df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) 24731f1f642eSOleg Nesterov return 0; 24746e84d644SOleg Nesterov 24756e84d644SOleg Nesterov /* 24766e84d644SOleg Nesterov * The queueing is in progress, or it is already queued. Try to 24776e84d644SOleg Nesterov * steal it from ->worklist without clearing WORK_STRUCT_PENDING. 24786e84d644SOleg Nesterov */ 24797a22ad75STejun Heo gcwq = get_work_gcwq(work); 24807a22ad75STejun Heo if (!gcwq) 24816e84d644SOleg Nesterov return ret; 24826e84d644SOleg Nesterov 24838b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 24846e84d644SOleg Nesterov if (!list_empty(&work->entry)) { 24856e84d644SOleg Nesterov /* 24867a22ad75STejun Heo * This work is queued, but perhaps we locked the wrong gcwq. 24876e84d644SOleg Nesterov * In that case we must see the new value after rmb(), see 24886e84d644SOleg Nesterov * insert_work()->wmb(). 24896e84d644SOleg Nesterov */ 24906e84d644SOleg Nesterov smp_rmb(); 24917a22ad75STejun Heo if (gcwq == get_work_gcwq(work)) { 2492dc186ad7SThomas Gleixner debug_work_deactivate(work); 24936e84d644SOleg Nesterov list_del_init(&work->entry); 24947a22ad75STejun Heo cwq_dec_nr_in_flight(get_work_cwq(work), 24958a2e8e5dSTejun Heo get_work_color(work), 24968a2e8e5dSTejun Heo *work_data_bits(work) & WORK_STRUCT_DELAYED); 24976e84d644SOleg Nesterov ret = 1; 24986e84d644SOleg Nesterov } 24996e84d644SOleg Nesterov } 25008b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 25016e84d644SOleg Nesterov 25026e84d644SOleg Nesterov return ret; 25036e84d644SOleg Nesterov } 25046e84d644SOleg Nesterov 2505401a8d04STejun Heo static bool __cancel_work_timer(struct work_struct *work, 25061f1f642eSOleg Nesterov struct timer_list* timer) 25071f1f642eSOleg Nesterov { 25081f1f642eSOleg Nesterov int ret; 25091f1f642eSOleg Nesterov 25101f1f642eSOleg Nesterov do { 25111f1f642eSOleg Nesterov ret = (timer && likely(del_timer(timer))); 25121f1f642eSOleg Nesterov if (!ret) 25131f1f642eSOleg Nesterov ret = try_to_grab_pending(work); 25141f1f642eSOleg Nesterov wait_on_work(work); 25151f1f642eSOleg Nesterov } while (unlikely(ret < 0)); 25161f1f642eSOleg Nesterov 25177a22ad75STejun Heo clear_work_data(work); 25181f1f642eSOleg Nesterov return ret; 25191f1f642eSOleg Nesterov } 25201f1f642eSOleg Nesterov 25216e84d644SOleg Nesterov /** 2522401a8d04STejun Heo * cancel_work_sync - cancel a work and wait for it to finish 2523401a8d04STejun Heo * @work: the work to cancel 25246e84d644SOleg Nesterov * 2525401a8d04STejun Heo * Cancel @work and wait for its execution to finish. This function 2526401a8d04STejun Heo * can be used even if the work re-queues itself or migrates to 2527401a8d04STejun Heo * another workqueue. On return from this function, @work is 2528401a8d04STejun Heo * guaranteed to be not pending or executing on any CPU. 25291f1f642eSOleg Nesterov * 2530401a8d04STejun Heo * cancel_work_sync(&delayed_work->work) must not be used for 2531401a8d04STejun Heo * delayed_work's. Use cancel_delayed_work_sync() instead. 25326e84d644SOleg Nesterov * 2533401a8d04STejun Heo * The caller must ensure that the workqueue on which @work was last 25346e84d644SOleg Nesterov * queued can't be destroyed before this function returns. 2535401a8d04STejun Heo * 2536401a8d04STejun Heo * RETURNS: 2537401a8d04STejun Heo * %true if @work was pending, %false otherwise. 25386e84d644SOleg Nesterov */ 2539401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work) 25406e84d644SOleg Nesterov { 25411f1f642eSOleg Nesterov return __cancel_work_timer(work, NULL); 2542b89deed3SOleg Nesterov } 254328e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync); 2544b89deed3SOleg Nesterov 25456e84d644SOleg Nesterov /** 2546401a8d04STejun Heo * flush_delayed_work - wait for a dwork to finish executing the last queueing 2547401a8d04STejun Heo * @dwork: the delayed work to flush 25486e84d644SOleg Nesterov * 2549401a8d04STejun Heo * Delayed timer is cancelled and the pending work is queued for 2550401a8d04STejun Heo * immediate execution. Like flush_work(), this function only 2551401a8d04STejun Heo * considers the last queueing instance of @dwork. 25521f1f642eSOleg Nesterov * 2553401a8d04STejun Heo * RETURNS: 2554401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2555401a8d04STejun Heo * %false if it was already idle. 25566e84d644SOleg Nesterov */ 2557401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork) 2558401a8d04STejun Heo { 2559401a8d04STejun Heo if (del_timer_sync(&dwork->timer)) 2560401a8d04STejun Heo __queue_work(raw_smp_processor_id(), 2561401a8d04STejun Heo get_work_cwq(&dwork->work)->wq, &dwork->work); 2562401a8d04STejun Heo return flush_work(&dwork->work); 2563401a8d04STejun Heo } 2564401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work); 2565401a8d04STejun Heo 2566401a8d04STejun Heo /** 256709383498STejun Heo * flush_delayed_work_sync - wait for a dwork to finish 256809383498STejun Heo * @dwork: the delayed work to flush 256909383498STejun Heo * 257009383498STejun Heo * Delayed timer is cancelled and the pending work is queued for 257109383498STejun Heo * execution immediately. Other than timer handling, its behavior 257209383498STejun Heo * is identical to flush_work_sync(). 257309383498STejun Heo * 257409383498STejun Heo * RETURNS: 257509383498STejun Heo * %true if flush_work_sync() waited for the work to finish execution, 257609383498STejun Heo * %false if it was already idle. 257709383498STejun Heo */ 257809383498STejun Heo bool flush_delayed_work_sync(struct delayed_work *dwork) 257909383498STejun Heo { 258009383498STejun Heo if (del_timer_sync(&dwork->timer)) 258109383498STejun Heo __queue_work(raw_smp_processor_id(), 258209383498STejun Heo get_work_cwq(&dwork->work)->wq, &dwork->work); 258309383498STejun Heo return flush_work_sync(&dwork->work); 258409383498STejun Heo } 258509383498STejun Heo EXPORT_SYMBOL(flush_delayed_work_sync); 258609383498STejun Heo 258709383498STejun Heo /** 2588401a8d04STejun Heo * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish 2589401a8d04STejun Heo * @dwork: the delayed work cancel 2590401a8d04STejun Heo * 2591401a8d04STejun Heo * This is cancel_work_sync() for delayed works. 2592401a8d04STejun Heo * 2593401a8d04STejun Heo * RETURNS: 2594401a8d04STejun Heo * %true if @dwork was pending, %false otherwise. 2595401a8d04STejun Heo */ 2596401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork) 25976e84d644SOleg Nesterov { 25981f1f642eSOleg Nesterov return __cancel_work_timer(&dwork->work, &dwork->timer); 25996e84d644SOleg Nesterov } 2600f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync); 26011da177e4SLinus Torvalds 26020fcb78c2SRolf Eike Beer /** 26030fcb78c2SRolf Eike Beer * schedule_work - put work task in global workqueue 26040fcb78c2SRolf Eike Beer * @work: job to be done 26050fcb78c2SRolf Eike Beer * 26065b0f437dSBart Van Assche * Returns zero if @work was already on the kernel-global workqueue and 26075b0f437dSBart Van Assche * non-zero otherwise. 26085b0f437dSBart Van Assche * 26095b0f437dSBart Van Assche * This puts a job in the kernel-global workqueue if it was not already 26105b0f437dSBart Van Assche * queued and leaves it in the same position on the kernel-global 26115b0f437dSBart Van Assche * workqueue otherwise. 26120fcb78c2SRolf Eike Beer */ 26137ad5b3a5SHarvey Harrison int schedule_work(struct work_struct *work) 26141da177e4SLinus Torvalds { 2615d320c038STejun Heo return queue_work(system_wq, work); 26161da177e4SLinus Torvalds } 2617ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_work); 26181da177e4SLinus Torvalds 2619c1a220e7SZhang Rui /* 2620c1a220e7SZhang Rui * schedule_work_on - put work task on a specific cpu 2621c1a220e7SZhang Rui * @cpu: cpu to put the work task on 2622c1a220e7SZhang Rui * @work: job to be done 2623c1a220e7SZhang Rui * 2624c1a220e7SZhang Rui * This puts a job on a specific cpu 2625c1a220e7SZhang Rui */ 2626c1a220e7SZhang Rui int schedule_work_on(int cpu, struct work_struct *work) 2627c1a220e7SZhang Rui { 2628d320c038STejun Heo return queue_work_on(cpu, system_wq, work); 2629c1a220e7SZhang Rui } 2630c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on); 2631c1a220e7SZhang Rui 26320fcb78c2SRolf Eike Beer /** 26330fcb78c2SRolf Eike Beer * schedule_delayed_work - put work task in global workqueue after delay 263452bad64dSDavid Howells * @dwork: job to be done 263552bad64dSDavid Howells * @delay: number of jiffies to wait or 0 for immediate execution 26360fcb78c2SRolf Eike Beer * 26370fcb78c2SRolf Eike Beer * After waiting for a given time this puts a job in the kernel-global 26380fcb78c2SRolf Eike Beer * workqueue. 26390fcb78c2SRolf Eike Beer */ 26407ad5b3a5SHarvey Harrison int schedule_delayed_work(struct delayed_work *dwork, 264182f67cd9SIngo Molnar unsigned long delay) 26421da177e4SLinus Torvalds { 2643d320c038STejun Heo return queue_delayed_work(system_wq, dwork, delay); 26441da177e4SLinus Torvalds } 2645ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work); 26461da177e4SLinus Torvalds 26470fcb78c2SRolf Eike Beer /** 26480fcb78c2SRolf Eike Beer * schedule_delayed_work_on - queue work in global workqueue on CPU after delay 26490fcb78c2SRolf Eike Beer * @cpu: cpu to use 265052bad64dSDavid Howells * @dwork: job to be done 26510fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait 26520fcb78c2SRolf Eike Beer * 26530fcb78c2SRolf Eike Beer * After waiting for a given time this puts a job in the kernel-global 26540fcb78c2SRolf Eike Beer * workqueue on the specified CPU. 26550fcb78c2SRolf Eike Beer */ 26561da177e4SLinus Torvalds int schedule_delayed_work_on(int cpu, 265752bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 26581da177e4SLinus Torvalds { 2659d320c038STejun Heo return queue_delayed_work_on(cpu, system_wq, dwork, delay); 26601da177e4SLinus Torvalds } 2661ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on); 26621da177e4SLinus Torvalds 2663b6136773SAndrew Morton /** 266431ddd871STejun Heo * schedule_on_each_cpu - execute a function synchronously on each online CPU 2665b6136773SAndrew Morton * @func: the function to call 2666b6136773SAndrew Morton * 266731ddd871STejun Heo * schedule_on_each_cpu() executes @func on each online CPU using the 266831ddd871STejun Heo * system workqueue and blocks until all CPUs have completed. 2669b6136773SAndrew Morton * schedule_on_each_cpu() is very slow. 267031ddd871STejun Heo * 267131ddd871STejun Heo * RETURNS: 267231ddd871STejun Heo * 0 on success, -errno on failure. 2673b6136773SAndrew Morton */ 267465f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func) 267515316ba8SChristoph Lameter { 267615316ba8SChristoph Lameter int cpu; 267738f51568SNamhyung Kim struct work_struct __percpu *works; 267815316ba8SChristoph Lameter 2679b6136773SAndrew Morton works = alloc_percpu(struct work_struct); 2680b6136773SAndrew Morton if (!works) 268115316ba8SChristoph Lameter return -ENOMEM; 2682b6136773SAndrew Morton 268395402b38SGautham R Shenoy get_online_cpus(); 268493981800STejun Heo 268515316ba8SChristoph Lameter for_each_online_cpu(cpu) { 26869bfb1839SIngo Molnar struct work_struct *work = per_cpu_ptr(works, cpu); 26879bfb1839SIngo Molnar 26889bfb1839SIngo Molnar INIT_WORK(work, func); 26898de6d308SOleg Nesterov schedule_work_on(cpu, work); 269015316ba8SChristoph Lameter } 269193981800STejun Heo 269293981800STejun Heo for_each_online_cpu(cpu) 26938616a89aSOleg Nesterov flush_work(per_cpu_ptr(works, cpu)); 269493981800STejun Heo 269595402b38SGautham R Shenoy put_online_cpus(); 2696b6136773SAndrew Morton free_percpu(works); 269715316ba8SChristoph Lameter return 0; 269815316ba8SChristoph Lameter } 269915316ba8SChristoph Lameter 2700eef6a7d5SAlan Stern /** 2701eef6a7d5SAlan Stern * flush_scheduled_work - ensure that any scheduled work has run to completion. 2702eef6a7d5SAlan Stern * 2703eef6a7d5SAlan Stern * Forces execution of the kernel-global workqueue and blocks until its 2704eef6a7d5SAlan Stern * completion. 2705eef6a7d5SAlan Stern * 2706eef6a7d5SAlan Stern * Think twice before calling this function! It's very easy to get into 2707eef6a7d5SAlan Stern * trouble if you don't take great care. Either of the following situations 2708eef6a7d5SAlan Stern * will lead to deadlock: 2709eef6a7d5SAlan Stern * 2710eef6a7d5SAlan Stern * One of the work items currently on the workqueue needs to acquire 2711eef6a7d5SAlan Stern * a lock held by your code or its caller. 2712eef6a7d5SAlan Stern * 2713eef6a7d5SAlan Stern * Your code is running in the context of a work routine. 2714eef6a7d5SAlan Stern * 2715eef6a7d5SAlan Stern * They will be detected by lockdep when they occur, but the first might not 2716eef6a7d5SAlan Stern * occur very often. It depends on what work items are on the workqueue and 2717eef6a7d5SAlan Stern * what locks they need, which you have no control over. 2718eef6a7d5SAlan Stern * 2719eef6a7d5SAlan Stern * In most situations flushing the entire workqueue is overkill; you merely 2720eef6a7d5SAlan Stern * need to know that a particular work item isn't queued and isn't running. 2721eef6a7d5SAlan Stern * In such cases you should use cancel_delayed_work_sync() or 2722eef6a7d5SAlan Stern * cancel_work_sync() instead. 2723eef6a7d5SAlan Stern */ 27241da177e4SLinus Torvalds void flush_scheduled_work(void) 27251da177e4SLinus Torvalds { 2726d320c038STejun Heo flush_workqueue(system_wq); 27271da177e4SLinus Torvalds } 2728ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work); 27291da177e4SLinus Torvalds 27301da177e4SLinus Torvalds /** 27311fa44ecaSJames Bottomley * execute_in_process_context - reliably execute the routine with user context 27321fa44ecaSJames Bottomley * @fn: the function to execute 27331fa44ecaSJames Bottomley * @ew: guaranteed storage for the execute work structure (must 27341fa44ecaSJames Bottomley * be available when the work executes) 27351fa44ecaSJames Bottomley * 27361fa44ecaSJames Bottomley * Executes the function immediately if process context is available, 27371fa44ecaSJames Bottomley * otherwise schedules the function for delayed execution. 27381fa44ecaSJames Bottomley * 27391fa44ecaSJames Bottomley * Returns: 0 - function was executed 27401fa44ecaSJames Bottomley * 1 - function was scheduled for execution 27411fa44ecaSJames Bottomley */ 274265f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew) 27431fa44ecaSJames Bottomley { 27441fa44ecaSJames Bottomley if (!in_interrupt()) { 274565f27f38SDavid Howells fn(&ew->work); 27461fa44ecaSJames Bottomley return 0; 27471fa44ecaSJames Bottomley } 27481fa44ecaSJames Bottomley 274965f27f38SDavid Howells INIT_WORK(&ew->work, fn); 27501fa44ecaSJames Bottomley schedule_work(&ew->work); 27511fa44ecaSJames Bottomley 27521fa44ecaSJames Bottomley return 1; 27531fa44ecaSJames Bottomley } 27541fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context); 27551fa44ecaSJames Bottomley 27561da177e4SLinus Torvalds int keventd_up(void) 27571da177e4SLinus Torvalds { 2758d320c038STejun Heo return system_wq != NULL; 27591da177e4SLinus Torvalds } 27601da177e4SLinus Torvalds 2761bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq) 27621da177e4SLinus Torvalds { 27633af24433SOleg Nesterov /* 27640f900049STejun Heo * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS. 27650f900049STejun Heo * Make sure that the alignment isn't lower than that of 27660f900049STejun Heo * unsigned long long. 27673af24433SOleg Nesterov */ 27680f900049STejun Heo const size_t size = sizeof(struct cpu_workqueue_struct); 27690f900049STejun Heo const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS, 27700f900049STejun Heo __alignof__(unsigned long long)); 2771931ac77eSTejun Heo #ifdef CONFIG_SMP 2772931ac77eSTejun Heo bool percpu = !(wq->flags & WQ_UNBOUND); 2773931ac77eSTejun Heo #else 2774931ac77eSTejun Heo bool percpu = false; 2775931ac77eSTejun Heo #endif 27763af24433SOleg Nesterov 2777931ac77eSTejun Heo if (percpu) 2778f3421797STejun Heo wq->cpu_wq.pcpu = __alloc_percpu(size, align); 2779931ac77eSTejun Heo else { 27800f900049STejun Heo void *ptr; 2781e1d8aa9fSFrederic Weisbecker 27820f900049STejun Heo /* 2783f3421797STejun Heo * Allocate enough room to align cwq and put an extra 2784f3421797STejun Heo * pointer at the end pointing back to the originally 2785f3421797STejun Heo * allocated pointer which will be used for free. 27860f900049STejun Heo */ 2787bdbc5dd7STejun Heo ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL); 2788bdbc5dd7STejun Heo if (ptr) { 2789bdbc5dd7STejun Heo wq->cpu_wq.single = PTR_ALIGN(ptr, align); 2790bdbc5dd7STejun Heo *(void **)(wq->cpu_wq.single + 1) = ptr; 2791bdbc5dd7STejun Heo } 27923af24433SOleg Nesterov } 27933af24433SOleg Nesterov 279452605627SDavid Howells /* just in case, make sure it's actually aligned 279552605627SDavid Howells * - this is affected by PERCPU() alignment in vmlinux.lds.S 279652605627SDavid Howells */ 2797bdbc5dd7STejun Heo BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align)); 2798bdbc5dd7STejun Heo return wq->cpu_wq.v ? 0 : -ENOMEM; 27990f900049STejun Heo } 28000f900049STejun Heo 2801bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq) 280206ba38a9SOleg Nesterov { 2803931ac77eSTejun Heo #ifdef CONFIG_SMP 2804931ac77eSTejun Heo bool percpu = !(wq->flags & WQ_UNBOUND); 2805931ac77eSTejun Heo #else 2806931ac77eSTejun Heo bool percpu = false; 2807931ac77eSTejun Heo #endif 280806ba38a9SOleg Nesterov 2809931ac77eSTejun Heo if (percpu) 2810bdbc5dd7STejun Heo free_percpu(wq->cpu_wq.pcpu); 2811f3421797STejun Heo else if (wq->cpu_wq.single) { 2812f3421797STejun Heo /* the pointer to free is stored right after the cwq */ 2813f3421797STejun Heo kfree(*(void **)(wq->cpu_wq.single + 1)); 281406ba38a9SOleg Nesterov } 281506ba38a9SOleg Nesterov } 281606ba38a9SOleg Nesterov 2817f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags, 2818f3421797STejun Heo const char *name) 2819b71ab8c2STejun Heo { 2820f3421797STejun Heo int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE; 2821f3421797STejun Heo 2822f3421797STejun Heo if (max_active < 1 || max_active > lim) 2823b71ab8c2STejun Heo printk(KERN_WARNING "workqueue: max_active %d requested for %s " 2824b71ab8c2STejun Heo "is out of range, clamping between %d and %d\n", 2825f3421797STejun Heo max_active, name, 1, lim); 2826b71ab8c2STejun Heo 2827f3421797STejun Heo return clamp_val(max_active, 1, lim); 2828b71ab8c2STejun Heo } 2829b71ab8c2STejun Heo 2830d320c038STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *name, 283197e37d7bSTejun Heo unsigned int flags, 28321e19ffc6STejun Heo int max_active, 2833eb13ba87SJohannes Berg struct lock_class_key *key, 2834eb13ba87SJohannes Berg const char *lock_name) 28353af24433SOleg Nesterov { 28363af24433SOleg Nesterov struct workqueue_struct *wq; 2837c34056a3STejun Heo unsigned int cpu; 28383af24433SOleg Nesterov 2839f3421797STejun Heo /* 28406370a6adSTejun Heo * Workqueues which may be used during memory reclaim should 28416370a6adSTejun Heo * have a rescuer to guarantee forward progress. 28426370a6adSTejun Heo */ 28436370a6adSTejun Heo if (flags & WQ_MEM_RECLAIM) 28446370a6adSTejun Heo flags |= WQ_RESCUER; 28456370a6adSTejun Heo 28466370a6adSTejun Heo /* 2847f3421797STejun Heo * Unbound workqueues aren't concurrency managed and should be 2848f3421797STejun Heo * dispatched to workers immediately. 2849f3421797STejun Heo */ 2850f3421797STejun Heo if (flags & WQ_UNBOUND) 2851f3421797STejun Heo flags |= WQ_HIGHPRI; 2852f3421797STejun Heo 2853d320c038STejun Heo max_active = max_active ?: WQ_DFL_ACTIVE; 2854f3421797STejun Heo max_active = wq_clamp_max_active(max_active, flags, name); 28553af24433SOleg Nesterov 28563af24433SOleg Nesterov wq = kzalloc(sizeof(*wq), GFP_KERNEL); 28573af24433SOleg Nesterov if (!wq) 28584690c4abSTejun Heo goto err; 28593af24433SOleg Nesterov 286097e37d7bSTejun Heo wq->flags = flags; 2861a0a1a5fdSTejun Heo wq->saved_max_active = max_active; 286273f53c4aSTejun Heo mutex_init(&wq->flush_mutex); 286373f53c4aSTejun Heo atomic_set(&wq->nr_cwqs_to_flush, 0); 286473f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_queue); 286573f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_overflow); 28663af24433SOleg Nesterov 28673af24433SOleg Nesterov wq->name = name; 2868eb13ba87SJohannes Berg lockdep_init_map(&wq->lockdep_map, lock_name, key, 0); 2869cce1a165SOleg Nesterov INIT_LIST_HEAD(&wq->list); 28703af24433SOleg Nesterov 2871bdbc5dd7STejun Heo if (alloc_cwqs(wq) < 0) 2872bdbc5dd7STejun Heo goto err; 2873bdbc5dd7STejun Heo 2874f3421797STejun Heo for_each_cwq_cpu(cpu, wq) { 28751537663fSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 28768b03ae3cSTejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 28771537663fSTejun Heo 28780f900049STejun Heo BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK); 28798b03ae3cSTejun Heo cwq->gcwq = gcwq; 2880c34056a3STejun Heo cwq->wq = wq; 288173f53c4aSTejun Heo cwq->flush_color = -1; 28821e19ffc6STejun Heo cwq->max_active = max_active; 28831e19ffc6STejun Heo INIT_LIST_HEAD(&cwq->delayed_works); 2884e22bee78STejun Heo } 28851537663fSTejun Heo 2886e22bee78STejun Heo if (flags & WQ_RESCUER) { 2887e22bee78STejun Heo struct worker *rescuer; 2888e22bee78STejun Heo 2889f2e005aaSTejun Heo if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL)) 2890e22bee78STejun Heo goto err; 2891e22bee78STejun Heo 2892e22bee78STejun Heo wq->rescuer = rescuer = alloc_worker(); 2893e22bee78STejun Heo if (!rescuer) 2894e22bee78STejun Heo goto err; 2895e22bee78STejun Heo 2896e22bee78STejun Heo rescuer->task = kthread_create(rescuer_thread, wq, "%s", name); 2897e22bee78STejun Heo if (IS_ERR(rescuer->task)) 2898e22bee78STejun Heo goto err; 2899e22bee78STejun Heo 2900e22bee78STejun Heo rescuer->task->flags |= PF_THREAD_BOUND; 2901e22bee78STejun Heo wake_up_process(rescuer->task); 29023af24433SOleg Nesterov } 29031537663fSTejun Heo 29043af24433SOleg Nesterov /* 2905a0a1a5fdSTejun Heo * workqueue_lock protects global freeze state and workqueues 2906a0a1a5fdSTejun Heo * list. Grab it, set max_active accordingly and add the new 2907a0a1a5fdSTejun Heo * workqueue to workqueues list. 29083af24433SOleg Nesterov */ 29093af24433SOleg Nesterov spin_lock(&workqueue_lock); 2910a0a1a5fdSTejun Heo 2911a0a1a5fdSTejun Heo if (workqueue_freezing && wq->flags & WQ_FREEZEABLE) 2912f3421797STejun Heo for_each_cwq_cpu(cpu, wq) 2913a0a1a5fdSTejun Heo get_cwq(cpu, wq)->max_active = 0; 2914a0a1a5fdSTejun Heo 29153af24433SOleg Nesterov list_add(&wq->list, &workqueues); 2916a0a1a5fdSTejun Heo 29173af24433SOleg Nesterov spin_unlock(&workqueue_lock); 29183af24433SOleg Nesterov 29193af24433SOleg Nesterov return wq; 29204690c4abSTejun Heo err: 29214690c4abSTejun Heo if (wq) { 2922bdbc5dd7STejun Heo free_cwqs(wq); 2923f2e005aaSTejun Heo free_mayday_mask(wq->mayday_mask); 2924e22bee78STejun Heo kfree(wq->rescuer); 29254690c4abSTejun Heo kfree(wq); 29263af24433SOleg Nesterov } 29274690c4abSTejun Heo return NULL; 29281da177e4SLinus Torvalds } 2929d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key); 29301da177e4SLinus Torvalds 29313af24433SOleg Nesterov /** 29323af24433SOleg Nesterov * destroy_workqueue - safely terminate a workqueue 29333af24433SOleg Nesterov * @wq: target workqueue 29343af24433SOleg Nesterov * 29353af24433SOleg Nesterov * Safely destroy a workqueue. All work currently pending will be done first. 29363af24433SOleg Nesterov */ 29373af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq) 29383af24433SOleg Nesterov { 2939c8e55f36STejun Heo unsigned int cpu; 29403af24433SOleg Nesterov 2941e41e704bSTejun Heo wq->flags |= WQ_DYING; 2942a0a1a5fdSTejun Heo flush_workqueue(wq); 2943a0a1a5fdSTejun Heo 2944a0a1a5fdSTejun Heo /* 2945a0a1a5fdSTejun Heo * wq list is used to freeze wq, remove from list after 2946a0a1a5fdSTejun Heo * flushing is complete in case freeze races us. 2947a0a1a5fdSTejun Heo */ 294895402b38SGautham R Shenoy spin_lock(&workqueue_lock); 29493af24433SOleg Nesterov list_del(&wq->list); 295095402b38SGautham R Shenoy spin_unlock(&workqueue_lock); 29513af24433SOleg Nesterov 2952e22bee78STejun Heo /* sanity check */ 2953f3421797STejun Heo for_each_cwq_cpu(cpu, wq) { 295473f53c4aSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 295573f53c4aSTejun Heo int i; 29563af24433SOleg Nesterov 295773f53c4aSTejun Heo for (i = 0; i < WORK_NR_COLORS; i++) 295873f53c4aSTejun Heo BUG_ON(cwq->nr_in_flight[i]); 29591e19ffc6STejun Heo BUG_ON(cwq->nr_active); 29601e19ffc6STejun Heo BUG_ON(!list_empty(&cwq->delayed_works)); 296173f53c4aSTejun Heo } 29621537663fSTejun Heo 2963e22bee78STejun Heo if (wq->flags & WQ_RESCUER) { 2964e22bee78STejun Heo kthread_stop(wq->rescuer->task); 2965f2e005aaSTejun Heo free_mayday_mask(wq->mayday_mask); 29668d9df9f0SXiaotian Feng kfree(wq->rescuer); 2967e22bee78STejun Heo } 2968e22bee78STejun Heo 2969bdbc5dd7STejun Heo free_cwqs(wq); 29703af24433SOleg Nesterov kfree(wq); 29713af24433SOleg Nesterov } 29723af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue); 29733af24433SOleg Nesterov 2974dcd989cbSTejun Heo /** 2975dcd989cbSTejun Heo * workqueue_set_max_active - adjust max_active of a workqueue 2976dcd989cbSTejun Heo * @wq: target workqueue 2977dcd989cbSTejun Heo * @max_active: new max_active value. 2978dcd989cbSTejun Heo * 2979dcd989cbSTejun Heo * Set max_active of @wq to @max_active. 2980dcd989cbSTejun Heo * 2981dcd989cbSTejun Heo * CONTEXT: 2982dcd989cbSTejun Heo * Don't call from IRQ context. 2983dcd989cbSTejun Heo */ 2984dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) 2985dcd989cbSTejun Heo { 2986dcd989cbSTejun Heo unsigned int cpu; 2987dcd989cbSTejun Heo 2988f3421797STejun Heo max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); 2989dcd989cbSTejun Heo 2990dcd989cbSTejun Heo spin_lock(&workqueue_lock); 2991dcd989cbSTejun Heo 2992dcd989cbSTejun Heo wq->saved_max_active = max_active; 2993dcd989cbSTejun Heo 2994f3421797STejun Heo for_each_cwq_cpu(cpu, wq) { 2995dcd989cbSTejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 2996dcd989cbSTejun Heo 2997dcd989cbSTejun Heo spin_lock_irq(&gcwq->lock); 2998dcd989cbSTejun Heo 2999dcd989cbSTejun Heo if (!(wq->flags & WQ_FREEZEABLE) || 3000dcd989cbSTejun Heo !(gcwq->flags & GCWQ_FREEZING)) 3001dcd989cbSTejun Heo get_cwq(gcwq->cpu, wq)->max_active = max_active; 3002dcd989cbSTejun Heo 3003dcd989cbSTejun Heo spin_unlock_irq(&gcwq->lock); 3004dcd989cbSTejun Heo } 3005dcd989cbSTejun Heo 3006dcd989cbSTejun Heo spin_unlock(&workqueue_lock); 3007dcd989cbSTejun Heo } 3008dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active); 3009dcd989cbSTejun Heo 3010dcd989cbSTejun Heo /** 3011dcd989cbSTejun Heo * workqueue_congested - test whether a workqueue is congested 3012dcd989cbSTejun Heo * @cpu: CPU in question 3013dcd989cbSTejun Heo * @wq: target workqueue 3014dcd989cbSTejun Heo * 3015dcd989cbSTejun Heo * Test whether @wq's cpu workqueue for @cpu is congested. There is 3016dcd989cbSTejun Heo * no synchronization around this function and the test result is 3017dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 3018dcd989cbSTejun Heo * 3019dcd989cbSTejun Heo * RETURNS: 3020dcd989cbSTejun Heo * %true if congested, %false otherwise. 3021dcd989cbSTejun Heo */ 3022dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq) 3023dcd989cbSTejun Heo { 3024dcd989cbSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 3025dcd989cbSTejun Heo 3026dcd989cbSTejun Heo return !list_empty(&cwq->delayed_works); 3027dcd989cbSTejun Heo } 3028dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested); 3029dcd989cbSTejun Heo 3030dcd989cbSTejun Heo /** 3031dcd989cbSTejun Heo * work_cpu - return the last known associated cpu for @work 3032dcd989cbSTejun Heo * @work: the work of interest 3033dcd989cbSTejun Heo * 3034dcd989cbSTejun Heo * RETURNS: 3035bdbc5dd7STejun Heo * CPU number if @work was ever queued. WORK_CPU_NONE otherwise. 3036dcd989cbSTejun Heo */ 3037dcd989cbSTejun Heo unsigned int work_cpu(struct work_struct *work) 3038dcd989cbSTejun Heo { 3039dcd989cbSTejun Heo struct global_cwq *gcwq = get_work_gcwq(work); 3040dcd989cbSTejun Heo 3041bdbc5dd7STejun Heo return gcwq ? gcwq->cpu : WORK_CPU_NONE; 3042dcd989cbSTejun Heo } 3043dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_cpu); 3044dcd989cbSTejun Heo 3045dcd989cbSTejun Heo /** 3046dcd989cbSTejun Heo * work_busy - test whether a work is currently pending or running 3047dcd989cbSTejun Heo * @work: the work to be tested 3048dcd989cbSTejun Heo * 3049dcd989cbSTejun Heo * Test whether @work is currently pending or running. There is no 3050dcd989cbSTejun Heo * synchronization around this function and the test result is 3051dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 3052dcd989cbSTejun Heo * Especially for reentrant wqs, the pending state might hide the 3053dcd989cbSTejun Heo * running state. 3054dcd989cbSTejun Heo * 3055dcd989cbSTejun Heo * RETURNS: 3056dcd989cbSTejun Heo * OR'd bitmask of WORK_BUSY_* bits. 3057dcd989cbSTejun Heo */ 3058dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work) 3059dcd989cbSTejun Heo { 3060dcd989cbSTejun Heo struct global_cwq *gcwq = get_work_gcwq(work); 3061dcd989cbSTejun Heo unsigned long flags; 3062dcd989cbSTejun Heo unsigned int ret = 0; 3063dcd989cbSTejun Heo 3064dcd989cbSTejun Heo if (!gcwq) 3065dcd989cbSTejun Heo return false; 3066dcd989cbSTejun Heo 3067dcd989cbSTejun Heo spin_lock_irqsave(&gcwq->lock, flags); 3068dcd989cbSTejun Heo 3069dcd989cbSTejun Heo if (work_pending(work)) 3070dcd989cbSTejun Heo ret |= WORK_BUSY_PENDING; 3071dcd989cbSTejun Heo if (find_worker_executing_work(gcwq, work)) 3072dcd989cbSTejun Heo ret |= WORK_BUSY_RUNNING; 3073dcd989cbSTejun Heo 3074dcd989cbSTejun Heo spin_unlock_irqrestore(&gcwq->lock, flags); 3075dcd989cbSTejun Heo 3076dcd989cbSTejun Heo return ret; 3077dcd989cbSTejun Heo } 3078dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy); 3079dcd989cbSTejun Heo 3080db7bccf4STejun Heo /* 3081db7bccf4STejun Heo * CPU hotplug. 3082db7bccf4STejun Heo * 3083e22bee78STejun Heo * There are two challenges in supporting CPU hotplug. Firstly, there 3084e22bee78STejun Heo * are a lot of assumptions on strong associations among work, cwq and 3085e22bee78STejun Heo * gcwq which make migrating pending and scheduled works very 3086e22bee78STejun Heo * difficult to implement without impacting hot paths. Secondly, 3087e22bee78STejun Heo * gcwqs serve mix of short, long and very long running works making 3088e22bee78STejun Heo * blocked draining impractical. 3089e22bee78STejun Heo * 3090e22bee78STejun Heo * This is solved by allowing a gcwq to be detached from CPU, running 3091e22bee78STejun Heo * it with unbound (rogue) workers and allowing it to be reattached 3092e22bee78STejun Heo * later if the cpu comes back online. A separate thread is created 3093e22bee78STejun Heo * to govern a gcwq in such state and is called the trustee of the 3094e22bee78STejun Heo * gcwq. 3095db7bccf4STejun Heo * 3096db7bccf4STejun Heo * Trustee states and their descriptions. 3097db7bccf4STejun Heo * 3098db7bccf4STejun Heo * START Command state used on startup. On CPU_DOWN_PREPARE, a 3099db7bccf4STejun Heo * new trustee is started with this state. 3100db7bccf4STejun Heo * 3101db7bccf4STejun Heo * IN_CHARGE Once started, trustee will enter this state after 3102e22bee78STejun Heo * assuming the manager role and making all existing 3103e22bee78STejun Heo * workers rogue. DOWN_PREPARE waits for trustee to 3104e22bee78STejun Heo * enter this state. After reaching IN_CHARGE, trustee 3105e22bee78STejun Heo * tries to execute the pending worklist until it's empty 3106e22bee78STejun Heo * and the state is set to BUTCHER, or the state is set 3107e22bee78STejun Heo * to RELEASE. 3108db7bccf4STejun Heo * 3109db7bccf4STejun Heo * BUTCHER Command state which is set by the cpu callback after 3110db7bccf4STejun Heo * the cpu has went down. Once this state is set trustee 3111db7bccf4STejun Heo * knows that there will be no new works on the worklist 3112db7bccf4STejun Heo * and once the worklist is empty it can proceed to 3113db7bccf4STejun Heo * killing idle workers. 3114db7bccf4STejun Heo * 3115db7bccf4STejun Heo * RELEASE Command state which is set by the cpu callback if the 3116db7bccf4STejun Heo * cpu down has been canceled or it has come online 3117db7bccf4STejun Heo * again. After recognizing this state, trustee stops 3118e22bee78STejun Heo * trying to drain or butcher and clears ROGUE, rebinds 3119e22bee78STejun Heo * all remaining workers back to the cpu and releases 3120e22bee78STejun Heo * manager role. 3121db7bccf4STejun Heo * 3122db7bccf4STejun Heo * DONE Trustee will enter this state after BUTCHER or RELEASE 3123db7bccf4STejun Heo * is complete. 3124db7bccf4STejun Heo * 3125db7bccf4STejun Heo * trustee CPU draining 3126db7bccf4STejun Heo * took over down complete 3127db7bccf4STejun Heo * START -----------> IN_CHARGE -----------> BUTCHER -----------> DONE 3128db7bccf4STejun Heo * | | ^ 3129db7bccf4STejun Heo * | CPU is back online v return workers | 3130db7bccf4STejun Heo * ----------------> RELEASE -------------- 3131db7bccf4STejun Heo */ 3132db7bccf4STejun Heo 3133db7bccf4STejun Heo /** 3134db7bccf4STejun Heo * trustee_wait_event_timeout - timed event wait for trustee 3135db7bccf4STejun Heo * @cond: condition to wait for 3136db7bccf4STejun Heo * @timeout: timeout in jiffies 3137db7bccf4STejun Heo * 3138db7bccf4STejun Heo * wait_event_timeout() for trustee to use. Handles locking and 3139db7bccf4STejun Heo * checks for RELEASE request. 3140db7bccf4STejun Heo * 3141db7bccf4STejun Heo * CONTEXT: 3142db7bccf4STejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 3143db7bccf4STejun Heo * multiple times. To be used by trustee. 3144db7bccf4STejun Heo * 3145db7bccf4STejun Heo * RETURNS: 3146db7bccf4STejun Heo * Positive indicating left time if @cond is satisfied, 0 if timed 3147db7bccf4STejun Heo * out, -1 if canceled. 3148db7bccf4STejun Heo */ 3149db7bccf4STejun Heo #define trustee_wait_event_timeout(cond, timeout) ({ \ 3150db7bccf4STejun Heo long __ret = (timeout); \ 3151db7bccf4STejun Heo while (!((cond) || (gcwq->trustee_state == TRUSTEE_RELEASE)) && \ 3152db7bccf4STejun Heo __ret) { \ 3153db7bccf4STejun Heo spin_unlock_irq(&gcwq->lock); \ 3154db7bccf4STejun Heo __wait_event_timeout(gcwq->trustee_wait, (cond) || \ 3155db7bccf4STejun Heo (gcwq->trustee_state == TRUSTEE_RELEASE), \ 3156db7bccf4STejun Heo __ret); \ 3157db7bccf4STejun Heo spin_lock_irq(&gcwq->lock); \ 3158db7bccf4STejun Heo } \ 3159db7bccf4STejun Heo gcwq->trustee_state == TRUSTEE_RELEASE ? -1 : (__ret); \ 3160db7bccf4STejun Heo }) 3161db7bccf4STejun Heo 3162db7bccf4STejun Heo /** 3163db7bccf4STejun Heo * trustee_wait_event - event wait for trustee 3164db7bccf4STejun Heo * @cond: condition to wait for 3165db7bccf4STejun Heo * 3166db7bccf4STejun Heo * wait_event() for trustee to use. Automatically handles locking and 3167db7bccf4STejun Heo * checks for CANCEL request. 3168db7bccf4STejun Heo * 3169db7bccf4STejun Heo * CONTEXT: 3170db7bccf4STejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 3171db7bccf4STejun Heo * multiple times. To be used by trustee. 3172db7bccf4STejun Heo * 3173db7bccf4STejun Heo * RETURNS: 3174db7bccf4STejun Heo * 0 if @cond is satisfied, -1 if canceled. 3175db7bccf4STejun Heo */ 3176db7bccf4STejun Heo #define trustee_wait_event(cond) ({ \ 3177db7bccf4STejun Heo long __ret1; \ 3178db7bccf4STejun Heo __ret1 = trustee_wait_event_timeout(cond, MAX_SCHEDULE_TIMEOUT);\ 3179db7bccf4STejun Heo __ret1 < 0 ? -1 : 0; \ 3180db7bccf4STejun Heo }) 3181db7bccf4STejun Heo 3182db7bccf4STejun Heo static int __cpuinit trustee_thread(void *__gcwq) 3183db7bccf4STejun Heo { 3184db7bccf4STejun Heo struct global_cwq *gcwq = __gcwq; 3185db7bccf4STejun Heo struct worker *worker; 3186e22bee78STejun Heo struct work_struct *work; 3187db7bccf4STejun Heo struct hlist_node *pos; 3188e22bee78STejun Heo long rc; 3189db7bccf4STejun Heo int i; 3190db7bccf4STejun Heo 3191db7bccf4STejun Heo BUG_ON(gcwq->cpu != smp_processor_id()); 3192db7bccf4STejun Heo 3193db7bccf4STejun Heo spin_lock_irq(&gcwq->lock); 3194db7bccf4STejun Heo /* 3195e22bee78STejun Heo * Claim the manager position and make all workers rogue. 3196e22bee78STejun Heo * Trustee must be bound to the target cpu and can't be 3197e22bee78STejun Heo * cancelled. 3198db7bccf4STejun Heo */ 3199db7bccf4STejun Heo BUG_ON(gcwq->cpu != smp_processor_id()); 3200e22bee78STejun Heo rc = trustee_wait_event(!(gcwq->flags & GCWQ_MANAGING_WORKERS)); 3201e22bee78STejun Heo BUG_ON(rc < 0); 3202e22bee78STejun Heo 3203e22bee78STejun Heo gcwq->flags |= GCWQ_MANAGING_WORKERS; 3204db7bccf4STejun Heo 3205db7bccf4STejun Heo list_for_each_entry(worker, &gcwq->idle_list, entry) 3206cb444766STejun Heo worker->flags |= WORKER_ROGUE; 3207db7bccf4STejun Heo 3208db7bccf4STejun Heo for_each_busy_worker(worker, i, pos, gcwq) 3209cb444766STejun Heo worker->flags |= WORKER_ROGUE; 3210db7bccf4STejun Heo 3211db7bccf4STejun Heo /* 3212e22bee78STejun Heo * Call schedule() so that we cross rq->lock and thus can 3213e22bee78STejun Heo * guarantee sched callbacks see the rogue flag. This is 3214e22bee78STejun Heo * necessary as scheduler callbacks may be invoked from other 3215e22bee78STejun Heo * cpus. 3216e22bee78STejun Heo */ 3217e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 3218e22bee78STejun Heo schedule(); 3219e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 3220e22bee78STejun Heo 3221e22bee78STejun Heo /* 3222cb444766STejun Heo * Sched callbacks are disabled now. Zap nr_running. After 3223cb444766STejun Heo * this, nr_running stays zero and need_more_worker() and 3224cb444766STejun Heo * keep_working() are always true as long as the worklist is 3225cb444766STejun Heo * not empty. 3226e22bee78STejun Heo */ 3227cb444766STejun Heo atomic_set(get_gcwq_nr_running(gcwq->cpu), 0); 3228e22bee78STejun Heo 3229e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 3230e22bee78STejun Heo del_timer_sync(&gcwq->idle_timer); 3231e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 3232e22bee78STejun Heo 3233e22bee78STejun Heo /* 3234db7bccf4STejun Heo * We're now in charge. Notify and proceed to drain. We need 3235db7bccf4STejun Heo * to keep the gcwq running during the whole CPU down 3236db7bccf4STejun Heo * procedure as other cpu hotunplug callbacks may need to 3237db7bccf4STejun Heo * flush currently running tasks. 3238db7bccf4STejun Heo */ 3239db7bccf4STejun Heo gcwq->trustee_state = TRUSTEE_IN_CHARGE; 3240db7bccf4STejun Heo wake_up_all(&gcwq->trustee_wait); 3241db7bccf4STejun Heo 3242db7bccf4STejun Heo /* 3243db7bccf4STejun Heo * The original cpu is in the process of dying and may go away 3244db7bccf4STejun Heo * anytime now. When that happens, we and all workers would 3245e22bee78STejun Heo * be migrated to other cpus. Try draining any left work. We 3246e22bee78STejun Heo * want to get it over with ASAP - spam rescuers, wake up as 3247e22bee78STejun Heo * many idlers as necessary and create new ones till the 3248e22bee78STejun Heo * worklist is empty. Note that if the gcwq is frozen, there 3249e22bee78STejun Heo * may be frozen works in freezeable cwqs. Don't declare 3250e22bee78STejun Heo * completion while frozen. 3251db7bccf4STejun Heo */ 3252db7bccf4STejun Heo while (gcwq->nr_workers != gcwq->nr_idle || 3253db7bccf4STejun Heo gcwq->flags & GCWQ_FREEZING || 3254db7bccf4STejun Heo gcwq->trustee_state == TRUSTEE_IN_CHARGE) { 3255e22bee78STejun Heo int nr_works = 0; 3256e22bee78STejun Heo 3257e22bee78STejun Heo list_for_each_entry(work, &gcwq->worklist, entry) { 3258e22bee78STejun Heo send_mayday(work); 3259e22bee78STejun Heo nr_works++; 3260e22bee78STejun Heo } 3261e22bee78STejun Heo 3262e22bee78STejun Heo list_for_each_entry(worker, &gcwq->idle_list, entry) { 3263e22bee78STejun Heo if (!nr_works--) 3264e22bee78STejun Heo break; 3265e22bee78STejun Heo wake_up_process(worker->task); 3266e22bee78STejun Heo } 3267e22bee78STejun Heo 3268e22bee78STejun Heo if (need_to_create_worker(gcwq)) { 3269e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 3270e22bee78STejun Heo worker = create_worker(gcwq, false); 3271e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 3272e22bee78STejun Heo if (worker) { 3273cb444766STejun Heo worker->flags |= WORKER_ROGUE; 3274e22bee78STejun Heo start_worker(worker); 3275e22bee78STejun Heo } 3276e22bee78STejun Heo } 3277e22bee78STejun Heo 3278db7bccf4STejun Heo /* give a breather */ 3279db7bccf4STejun Heo if (trustee_wait_event_timeout(false, TRUSTEE_COOLDOWN) < 0) 3280db7bccf4STejun Heo break; 3281db7bccf4STejun Heo } 3282db7bccf4STejun Heo 3283e22bee78STejun Heo /* 3284e22bee78STejun Heo * Either all works have been scheduled and cpu is down, or 3285e22bee78STejun Heo * cpu down has already been canceled. Wait for and butcher 3286e22bee78STejun Heo * all workers till we're canceled. 3287e22bee78STejun Heo */ 3288e22bee78STejun Heo do { 3289e22bee78STejun Heo rc = trustee_wait_event(!list_empty(&gcwq->idle_list)); 3290e22bee78STejun Heo while (!list_empty(&gcwq->idle_list)) 3291e22bee78STejun Heo destroy_worker(list_first_entry(&gcwq->idle_list, 3292e22bee78STejun Heo struct worker, entry)); 3293e22bee78STejun Heo } while (gcwq->nr_workers && rc >= 0); 3294e22bee78STejun Heo 3295e22bee78STejun Heo /* 3296e22bee78STejun Heo * At this point, either draining has completed and no worker 3297e22bee78STejun Heo * is left, or cpu down has been canceled or the cpu is being 3298e22bee78STejun Heo * brought back up. There shouldn't be any idle one left. 3299e22bee78STejun Heo * Tell the remaining busy ones to rebind once it finishes the 3300e22bee78STejun Heo * currently scheduled works by scheduling the rebind_work. 3301e22bee78STejun Heo */ 3302e22bee78STejun Heo WARN_ON(!list_empty(&gcwq->idle_list)); 3303e22bee78STejun Heo 3304e22bee78STejun Heo for_each_busy_worker(worker, i, pos, gcwq) { 3305e22bee78STejun Heo struct work_struct *rebind_work = &worker->rebind_work; 3306e22bee78STejun Heo 3307e22bee78STejun Heo /* 3308e22bee78STejun Heo * Rebind_work may race with future cpu hotplug 3309e22bee78STejun Heo * operations. Use a separate flag to mark that 3310e22bee78STejun Heo * rebinding is scheduled. 3311e22bee78STejun Heo */ 3312cb444766STejun Heo worker->flags |= WORKER_REBIND; 3313cb444766STejun Heo worker->flags &= ~WORKER_ROGUE; 3314e22bee78STejun Heo 3315e22bee78STejun Heo /* queue rebind_work, wq doesn't matter, use the default one */ 3316e22bee78STejun Heo if (test_and_set_bit(WORK_STRUCT_PENDING_BIT, 3317e22bee78STejun Heo work_data_bits(rebind_work))) 3318e22bee78STejun Heo continue; 3319e22bee78STejun Heo 3320e22bee78STejun Heo debug_work_activate(rebind_work); 3321d320c038STejun Heo insert_work(get_cwq(gcwq->cpu, system_wq), rebind_work, 3322e22bee78STejun Heo worker->scheduled.next, 3323e22bee78STejun Heo work_color_to_flags(WORK_NO_COLOR)); 3324e22bee78STejun Heo } 3325e22bee78STejun Heo 3326e22bee78STejun Heo /* relinquish manager role */ 3327e22bee78STejun Heo gcwq->flags &= ~GCWQ_MANAGING_WORKERS; 3328e22bee78STejun Heo 3329db7bccf4STejun Heo /* notify completion */ 3330db7bccf4STejun Heo gcwq->trustee = NULL; 3331db7bccf4STejun Heo gcwq->trustee_state = TRUSTEE_DONE; 3332db7bccf4STejun Heo wake_up_all(&gcwq->trustee_wait); 3333db7bccf4STejun Heo spin_unlock_irq(&gcwq->lock); 3334db7bccf4STejun Heo return 0; 3335db7bccf4STejun Heo } 3336db7bccf4STejun Heo 3337db7bccf4STejun Heo /** 3338db7bccf4STejun Heo * wait_trustee_state - wait for trustee to enter the specified state 3339db7bccf4STejun Heo * @gcwq: gcwq the trustee of interest belongs to 3340db7bccf4STejun Heo * @state: target state to wait for 3341db7bccf4STejun Heo * 3342db7bccf4STejun Heo * Wait for the trustee to reach @state. DONE is already matched. 3343db7bccf4STejun Heo * 3344db7bccf4STejun Heo * CONTEXT: 3345db7bccf4STejun Heo * spin_lock_irq(gcwq->lock) which may be released and regrabbed 3346db7bccf4STejun Heo * multiple times. To be used by cpu_callback. 3347db7bccf4STejun Heo */ 3348db7bccf4STejun Heo static void __cpuinit wait_trustee_state(struct global_cwq *gcwq, int state) 334906bd6ebfSNamhyung Kim __releases(&gcwq->lock) 335006bd6ebfSNamhyung Kim __acquires(&gcwq->lock) 3351db7bccf4STejun Heo { 3352db7bccf4STejun Heo if (!(gcwq->trustee_state == state || 3353db7bccf4STejun Heo gcwq->trustee_state == TRUSTEE_DONE)) { 3354db7bccf4STejun Heo spin_unlock_irq(&gcwq->lock); 3355db7bccf4STejun Heo __wait_event(gcwq->trustee_wait, 3356db7bccf4STejun Heo gcwq->trustee_state == state || 3357db7bccf4STejun Heo gcwq->trustee_state == TRUSTEE_DONE); 3358db7bccf4STejun Heo spin_lock_irq(&gcwq->lock); 3359db7bccf4STejun Heo } 3360db7bccf4STejun Heo } 3361db7bccf4STejun Heo 33629c7b216dSChandra Seetharaman static int __devinit workqueue_cpu_callback(struct notifier_block *nfb, 33631da177e4SLinus Torvalds unsigned long action, 33641da177e4SLinus Torvalds void *hcpu) 33651da177e4SLinus Torvalds { 33663af24433SOleg Nesterov unsigned int cpu = (unsigned long)hcpu; 3367db7bccf4STejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 3368db7bccf4STejun Heo struct task_struct *new_trustee = NULL; 3369e22bee78STejun Heo struct worker *uninitialized_var(new_worker); 3370db7bccf4STejun Heo unsigned long flags; 33711da177e4SLinus Torvalds 33728bb78442SRafael J. Wysocki action &= ~CPU_TASKS_FROZEN; 33738bb78442SRafael J. Wysocki 33741da177e4SLinus Torvalds switch (action) { 3375db7bccf4STejun Heo case CPU_DOWN_PREPARE: 3376db7bccf4STejun Heo new_trustee = kthread_create(trustee_thread, gcwq, 3377db7bccf4STejun Heo "workqueue_trustee/%d\n", cpu); 3378db7bccf4STejun Heo if (IS_ERR(new_trustee)) 3379db7bccf4STejun Heo return notifier_from_errno(PTR_ERR(new_trustee)); 3380db7bccf4STejun Heo kthread_bind(new_trustee, cpu); 3381e22bee78STejun Heo /* fall through */ 33823af24433SOleg Nesterov case CPU_UP_PREPARE: 3383e22bee78STejun Heo BUG_ON(gcwq->first_idle); 3384e22bee78STejun Heo new_worker = create_worker(gcwq, false); 3385e22bee78STejun Heo if (!new_worker) { 3386e22bee78STejun Heo if (new_trustee) 3387e22bee78STejun Heo kthread_stop(new_trustee); 3388e22bee78STejun Heo return NOTIFY_BAD; 33893af24433SOleg Nesterov } 3390db7bccf4STejun Heo } 33911537663fSTejun Heo 3392db7bccf4STejun Heo /* some are called w/ irq disabled, don't disturb irq status */ 3393db7bccf4STejun Heo spin_lock_irqsave(&gcwq->lock, flags); 33943af24433SOleg Nesterov 33953af24433SOleg Nesterov switch (action) { 3396db7bccf4STejun Heo case CPU_DOWN_PREPARE: 3397db7bccf4STejun Heo /* initialize trustee and tell it to acquire the gcwq */ 3398db7bccf4STejun Heo BUG_ON(gcwq->trustee || gcwq->trustee_state != TRUSTEE_DONE); 3399db7bccf4STejun Heo gcwq->trustee = new_trustee; 3400db7bccf4STejun Heo gcwq->trustee_state = TRUSTEE_START; 3401db7bccf4STejun Heo wake_up_process(gcwq->trustee); 3402db7bccf4STejun Heo wait_trustee_state(gcwq, TRUSTEE_IN_CHARGE); 3403e22bee78STejun Heo /* fall through */ 34043af24433SOleg Nesterov case CPU_UP_PREPARE: 3405e22bee78STejun Heo BUG_ON(gcwq->first_idle); 3406e22bee78STejun Heo gcwq->first_idle = new_worker; 34071da177e4SLinus Torvalds break; 34081da177e4SLinus Torvalds 3409e22bee78STejun Heo case CPU_DYING: 3410e22bee78STejun Heo /* 3411e22bee78STejun Heo * Before this, the trustee and all workers except for 3412e22bee78STejun Heo * the ones which are still executing works from 3413e22bee78STejun Heo * before the last CPU down must be on the cpu. After 3414e22bee78STejun Heo * this, they'll all be diasporas. 3415e22bee78STejun Heo */ 3416e22bee78STejun Heo gcwq->flags |= GCWQ_DISASSOCIATED; 3417db7bccf4STejun Heo break; 3418db7bccf4STejun Heo 34193da1c84cSOleg Nesterov case CPU_POST_DEAD: 3420db7bccf4STejun Heo gcwq->trustee_state = TRUSTEE_BUTCHER; 3421e22bee78STejun Heo /* fall through */ 3422e22bee78STejun Heo case CPU_UP_CANCELED: 3423e22bee78STejun Heo destroy_worker(gcwq->first_idle); 3424e22bee78STejun Heo gcwq->first_idle = NULL; 3425db7bccf4STejun Heo break; 3426db7bccf4STejun Heo 3427db7bccf4STejun Heo case CPU_DOWN_FAILED: 34281da177e4SLinus Torvalds case CPU_ONLINE: 3429e22bee78STejun Heo gcwq->flags &= ~GCWQ_DISASSOCIATED; 3430db7bccf4STejun Heo if (gcwq->trustee_state != TRUSTEE_DONE) { 3431db7bccf4STejun Heo gcwq->trustee_state = TRUSTEE_RELEASE; 3432db7bccf4STejun Heo wake_up_process(gcwq->trustee); 3433db7bccf4STejun Heo wait_trustee_state(gcwq, TRUSTEE_DONE); 3434db7bccf4STejun Heo } 34351da177e4SLinus Torvalds 3436e22bee78STejun Heo /* 3437e22bee78STejun Heo * Trustee is done and there might be no worker left. 3438e22bee78STejun Heo * Put the first_idle in and request a real manager to 3439e22bee78STejun Heo * take a look. 3440e22bee78STejun Heo */ 3441e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 3442e22bee78STejun Heo kthread_bind(gcwq->first_idle->task, cpu); 3443e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 3444e22bee78STejun Heo gcwq->flags |= GCWQ_MANAGE_WORKERS; 3445e22bee78STejun Heo start_worker(gcwq->first_idle); 3446e22bee78STejun Heo gcwq->first_idle = NULL; 34471da177e4SLinus Torvalds break; 34481da177e4SLinus Torvalds } 34491da177e4SLinus Torvalds 3450db7bccf4STejun Heo spin_unlock_irqrestore(&gcwq->lock, flags); 345100dfcaf7SOleg Nesterov 34521537663fSTejun Heo return notifier_from_errno(0); 34531da177e4SLinus Torvalds } 34541da177e4SLinus Torvalds 34552d3854a3SRusty Russell #ifdef CONFIG_SMP 34568ccad40dSRusty Russell 34572d3854a3SRusty Russell struct work_for_cpu { 34586b44003eSAndrew Morton struct completion completion; 34592d3854a3SRusty Russell long (*fn)(void *); 34602d3854a3SRusty Russell void *arg; 34612d3854a3SRusty Russell long ret; 34622d3854a3SRusty Russell }; 34632d3854a3SRusty Russell 34646b44003eSAndrew Morton static int do_work_for_cpu(void *_wfc) 34652d3854a3SRusty Russell { 34666b44003eSAndrew Morton struct work_for_cpu *wfc = _wfc; 34672d3854a3SRusty Russell wfc->ret = wfc->fn(wfc->arg); 34686b44003eSAndrew Morton complete(&wfc->completion); 34696b44003eSAndrew Morton return 0; 34702d3854a3SRusty Russell } 34712d3854a3SRusty Russell 34722d3854a3SRusty Russell /** 34732d3854a3SRusty Russell * work_on_cpu - run a function in user context on a particular cpu 34742d3854a3SRusty Russell * @cpu: the cpu to run on 34752d3854a3SRusty Russell * @fn: the function to run 34762d3854a3SRusty Russell * @arg: the function arg 34772d3854a3SRusty Russell * 347831ad9081SRusty Russell * This will return the value @fn returns. 347931ad9081SRusty Russell * It is up to the caller to ensure that the cpu doesn't go offline. 34806b44003eSAndrew Morton * The caller must not hold any locks which would prevent @fn from completing. 34812d3854a3SRusty Russell */ 34822d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg) 34832d3854a3SRusty Russell { 34846b44003eSAndrew Morton struct task_struct *sub_thread; 34856b44003eSAndrew Morton struct work_for_cpu wfc = { 34866b44003eSAndrew Morton .completion = COMPLETION_INITIALIZER_ONSTACK(wfc.completion), 34876b44003eSAndrew Morton .fn = fn, 34886b44003eSAndrew Morton .arg = arg, 34896b44003eSAndrew Morton }; 34902d3854a3SRusty Russell 34916b44003eSAndrew Morton sub_thread = kthread_create(do_work_for_cpu, &wfc, "work_for_cpu"); 34926b44003eSAndrew Morton if (IS_ERR(sub_thread)) 34936b44003eSAndrew Morton return PTR_ERR(sub_thread); 34946b44003eSAndrew Morton kthread_bind(sub_thread, cpu); 34956b44003eSAndrew Morton wake_up_process(sub_thread); 34966b44003eSAndrew Morton wait_for_completion(&wfc.completion); 34972d3854a3SRusty Russell return wfc.ret; 34982d3854a3SRusty Russell } 34992d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu); 35002d3854a3SRusty Russell #endif /* CONFIG_SMP */ 35012d3854a3SRusty Russell 3502a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 3503e7577c50SRusty Russell 3504a0a1a5fdSTejun Heo /** 3505a0a1a5fdSTejun Heo * freeze_workqueues_begin - begin freezing workqueues 3506a0a1a5fdSTejun Heo * 3507a0a1a5fdSTejun Heo * Start freezing workqueues. After this function returns, all 3508a0a1a5fdSTejun Heo * freezeable workqueues will queue new works to their frozen_works 35097e11629dSTejun Heo * list instead of gcwq->worklist. 3510a0a1a5fdSTejun Heo * 3511a0a1a5fdSTejun Heo * CONTEXT: 35128b03ae3cSTejun Heo * Grabs and releases workqueue_lock and gcwq->lock's. 3513a0a1a5fdSTejun Heo */ 3514a0a1a5fdSTejun Heo void freeze_workqueues_begin(void) 3515a0a1a5fdSTejun Heo { 3516a0a1a5fdSTejun Heo unsigned int cpu; 3517a0a1a5fdSTejun Heo 3518a0a1a5fdSTejun Heo spin_lock(&workqueue_lock); 3519a0a1a5fdSTejun Heo 3520a0a1a5fdSTejun Heo BUG_ON(workqueue_freezing); 3521a0a1a5fdSTejun Heo workqueue_freezing = true; 3522a0a1a5fdSTejun Heo 3523f3421797STejun Heo for_each_gcwq_cpu(cpu) { 35248b03ae3cSTejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 3525bdbc5dd7STejun Heo struct workqueue_struct *wq; 35268b03ae3cSTejun Heo 35278b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 35288b03ae3cSTejun Heo 3529db7bccf4STejun Heo BUG_ON(gcwq->flags & GCWQ_FREEZING); 3530db7bccf4STejun Heo gcwq->flags |= GCWQ_FREEZING; 3531db7bccf4STejun Heo 3532a0a1a5fdSTejun Heo list_for_each_entry(wq, &workqueues, list) { 3533a0a1a5fdSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 3534a0a1a5fdSTejun Heo 3535f3421797STejun Heo if (cwq && wq->flags & WQ_FREEZEABLE) 3536a0a1a5fdSTejun Heo cwq->max_active = 0; 35371da177e4SLinus Torvalds } 35388b03ae3cSTejun Heo 35398b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 3540a0a1a5fdSTejun Heo } 3541a0a1a5fdSTejun Heo 3542a0a1a5fdSTejun Heo spin_unlock(&workqueue_lock); 3543a0a1a5fdSTejun Heo } 3544a0a1a5fdSTejun Heo 3545a0a1a5fdSTejun Heo /** 3546a0a1a5fdSTejun Heo * freeze_workqueues_busy - are freezeable workqueues still busy? 3547a0a1a5fdSTejun Heo * 3548a0a1a5fdSTejun Heo * Check whether freezing is complete. This function must be called 3549a0a1a5fdSTejun Heo * between freeze_workqueues_begin() and thaw_workqueues(). 3550a0a1a5fdSTejun Heo * 3551a0a1a5fdSTejun Heo * CONTEXT: 3552a0a1a5fdSTejun Heo * Grabs and releases workqueue_lock. 3553a0a1a5fdSTejun Heo * 3554a0a1a5fdSTejun Heo * RETURNS: 3555a0a1a5fdSTejun Heo * %true if some freezeable workqueues are still busy. %false if 3556a0a1a5fdSTejun Heo * freezing is complete. 3557a0a1a5fdSTejun Heo */ 3558a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void) 3559a0a1a5fdSTejun Heo { 3560a0a1a5fdSTejun Heo unsigned int cpu; 3561a0a1a5fdSTejun Heo bool busy = false; 3562a0a1a5fdSTejun Heo 3563a0a1a5fdSTejun Heo spin_lock(&workqueue_lock); 3564a0a1a5fdSTejun Heo 3565a0a1a5fdSTejun Heo BUG_ON(!workqueue_freezing); 3566a0a1a5fdSTejun Heo 3567f3421797STejun Heo for_each_gcwq_cpu(cpu) { 3568bdbc5dd7STejun Heo struct workqueue_struct *wq; 3569a0a1a5fdSTejun Heo /* 3570a0a1a5fdSTejun Heo * nr_active is monotonically decreasing. It's safe 3571a0a1a5fdSTejun Heo * to peek without lock. 3572a0a1a5fdSTejun Heo */ 3573a0a1a5fdSTejun Heo list_for_each_entry(wq, &workqueues, list) { 3574a0a1a5fdSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 3575a0a1a5fdSTejun Heo 3576f3421797STejun Heo if (!cwq || !(wq->flags & WQ_FREEZEABLE)) 3577a0a1a5fdSTejun Heo continue; 3578a0a1a5fdSTejun Heo 3579a0a1a5fdSTejun Heo BUG_ON(cwq->nr_active < 0); 3580a0a1a5fdSTejun Heo if (cwq->nr_active) { 3581a0a1a5fdSTejun Heo busy = true; 3582a0a1a5fdSTejun Heo goto out_unlock; 3583a0a1a5fdSTejun Heo } 3584a0a1a5fdSTejun Heo } 3585a0a1a5fdSTejun Heo } 3586a0a1a5fdSTejun Heo out_unlock: 3587a0a1a5fdSTejun Heo spin_unlock(&workqueue_lock); 3588a0a1a5fdSTejun Heo return busy; 3589a0a1a5fdSTejun Heo } 3590a0a1a5fdSTejun Heo 3591a0a1a5fdSTejun Heo /** 3592a0a1a5fdSTejun Heo * thaw_workqueues - thaw workqueues 3593a0a1a5fdSTejun Heo * 3594a0a1a5fdSTejun Heo * Thaw workqueues. Normal queueing is restored and all collected 35957e11629dSTejun Heo * frozen works are transferred to their respective gcwq worklists. 3596a0a1a5fdSTejun Heo * 3597a0a1a5fdSTejun Heo * CONTEXT: 35988b03ae3cSTejun Heo * Grabs and releases workqueue_lock and gcwq->lock's. 3599a0a1a5fdSTejun Heo */ 3600a0a1a5fdSTejun Heo void thaw_workqueues(void) 3601a0a1a5fdSTejun Heo { 3602a0a1a5fdSTejun Heo unsigned int cpu; 3603a0a1a5fdSTejun Heo 3604a0a1a5fdSTejun Heo spin_lock(&workqueue_lock); 3605a0a1a5fdSTejun Heo 3606a0a1a5fdSTejun Heo if (!workqueue_freezing) 3607a0a1a5fdSTejun Heo goto out_unlock; 3608a0a1a5fdSTejun Heo 3609f3421797STejun Heo for_each_gcwq_cpu(cpu) { 36108b03ae3cSTejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 3611bdbc5dd7STejun Heo struct workqueue_struct *wq; 36128b03ae3cSTejun Heo 36138b03ae3cSTejun Heo spin_lock_irq(&gcwq->lock); 36148b03ae3cSTejun Heo 3615db7bccf4STejun Heo BUG_ON(!(gcwq->flags & GCWQ_FREEZING)); 3616db7bccf4STejun Heo gcwq->flags &= ~GCWQ_FREEZING; 3617db7bccf4STejun Heo 3618a0a1a5fdSTejun Heo list_for_each_entry(wq, &workqueues, list) { 3619a0a1a5fdSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 3620a0a1a5fdSTejun Heo 3621f3421797STejun Heo if (!cwq || !(wq->flags & WQ_FREEZEABLE)) 3622a0a1a5fdSTejun Heo continue; 3623a0a1a5fdSTejun Heo 3624a0a1a5fdSTejun Heo /* restore max_active and repopulate worklist */ 3625a0a1a5fdSTejun Heo cwq->max_active = wq->saved_max_active; 3626a0a1a5fdSTejun Heo 3627a0a1a5fdSTejun Heo while (!list_empty(&cwq->delayed_works) && 3628a0a1a5fdSTejun Heo cwq->nr_active < cwq->max_active) 3629a0a1a5fdSTejun Heo cwq_activate_first_delayed(cwq); 3630a0a1a5fdSTejun Heo } 36318b03ae3cSTejun Heo 3632e22bee78STejun Heo wake_up_worker(gcwq); 3633e22bee78STejun Heo 36348b03ae3cSTejun Heo spin_unlock_irq(&gcwq->lock); 3635a0a1a5fdSTejun Heo } 3636a0a1a5fdSTejun Heo 3637a0a1a5fdSTejun Heo workqueue_freezing = false; 3638a0a1a5fdSTejun Heo out_unlock: 3639a0a1a5fdSTejun Heo spin_unlock(&workqueue_lock); 3640a0a1a5fdSTejun Heo } 3641a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 3642a0a1a5fdSTejun Heo 36436ee0578bSSuresh Siddha static int __init init_workqueues(void) 36441da177e4SLinus Torvalds { 3645c34056a3STejun Heo unsigned int cpu; 3646c8e55f36STejun Heo int i; 3647c34056a3STejun Heo 3648f6500947STejun Heo cpu_notifier(workqueue_cpu_callback, CPU_PRI_WORKQUEUE); 36498b03ae3cSTejun Heo 36508b03ae3cSTejun Heo /* initialize gcwqs */ 3651f3421797STejun Heo for_each_gcwq_cpu(cpu) { 36528b03ae3cSTejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 36538b03ae3cSTejun Heo 36548b03ae3cSTejun Heo spin_lock_init(&gcwq->lock); 36557e11629dSTejun Heo INIT_LIST_HEAD(&gcwq->worklist); 36568b03ae3cSTejun Heo gcwq->cpu = cpu; 3657f3421797STejun Heo gcwq->flags |= GCWQ_DISASSOCIATED; 36588b03ae3cSTejun Heo 3659c8e55f36STejun Heo INIT_LIST_HEAD(&gcwq->idle_list); 3660c8e55f36STejun Heo for (i = 0; i < BUSY_WORKER_HASH_SIZE; i++) 3661c8e55f36STejun Heo INIT_HLIST_HEAD(&gcwq->busy_hash[i]); 3662c8e55f36STejun Heo 3663e22bee78STejun Heo init_timer_deferrable(&gcwq->idle_timer); 3664e22bee78STejun Heo gcwq->idle_timer.function = idle_worker_timeout; 3665e22bee78STejun Heo gcwq->idle_timer.data = (unsigned long)gcwq; 3666e22bee78STejun Heo 3667e22bee78STejun Heo setup_timer(&gcwq->mayday_timer, gcwq_mayday_timeout, 3668e22bee78STejun Heo (unsigned long)gcwq); 3669e22bee78STejun Heo 36708b03ae3cSTejun Heo ida_init(&gcwq->worker_ida); 3671db7bccf4STejun Heo 3672db7bccf4STejun Heo gcwq->trustee_state = TRUSTEE_DONE; 3673db7bccf4STejun Heo init_waitqueue_head(&gcwq->trustee_wait); 36748b03ae3cSTejun Heo } 36758b03ae3cSTejun Heo 3676e22bee78STejun Heo /* create the initial worker */ 3677f3421797STejun Heo for_each_online_gcwq_cpu(cpu) { 3678e22bee78STejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 3679e22bee78STejun Heo struct worker *worker; 3680e22bee78STejun Heo 3681477a3c33STejun Heo if (cpu != WORK_CPU_UNBOUND) 3682477a3c33STejun Heo gcwq->flags &= ~GCWQ_DISASSOCIATED; 3683e22bee78STejun Heo worker = create_worker(gcwq, true); 3684e22bee78STejun Heo BUG_ON(!worker); 3685e22bee78STejun Heo spin_lock_irq(&gcwq->lock); 3686e22bee78STejun Heo start_worker(worker); 3687e22bee78STejun Heo spin_unlock_irq(&gcwq->lock); 3688e22bee78STejun Heo } 3689e22bee78STejun Heo 3690d320c038STejun Heo system_wq = alloc_workqueue("events", 0, 0); 3691d320c038STejun Heo system_long_wq = alloc_workqueue("events_long", 0, 0); 3692d320c038STejun Heo system_nrt_wq = alloc_workqueue("events_nrt", WQ_NON_REENTRANT, 0); 3693f3421797STejun Heo system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, 3694f3421797STejun Heo WQ_UNBOUND_MAX_ACTIVE); 3695e5cba24eSHitoshi Mitake BUG_ON(!system_wq || !system_long_wq || !system_nrt_wq || 3696e5cba24eSHitoshi Mitake !system_unbound_wq); 36976ee0578bSSuresh Siddha return 0; 36981da177e4SLinus Torvalds } 36996ee0578bSSuresh Siddha early_initcall(init_workqueues); 3700