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 269984de1aSPaul Gortmaker #include <linux/export.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> 4442f8570fSSasha Levin #include <linux/hashtable.h> 45e22bee78STejun Heo 46ea138446STejun Heo #include "workqueue_internal.h" 471da177e4SLinus Torvalds 48c8e55f36STejun Heo enum { 49bc2ae0f5STejun Heo /* 5024647570STejun Heo * worker_pool flags 51bc2ae0f5STejun Heo * 5224647570STejun Heo * A bound pool is either associated or disassociated with its CPU. 53bc2ae0f5STejun Heo * While associated (!DISASSOCIATED), all workers are bound to the 54bc2ae0f5STejun Heo * CPU and none has %WORKER_UNBOUND set and concurrency management 55bc2ae0f5STejun Heo * is in effect. 56bc2ae0f5STejun Heo * 57bc2ae0f5STejun Heo * While DISASSOCIATED, the cpu may be offline and all workers have 58bc2ae0f5STejun Heo * %WORKER_UNBOUND set and concurrency management disabled, and may 5924647570STejun Heo * be executing on any CPU. The pool behaves as an unbound one. 60bc2ae0f5STejun Heo * 61bc2ae0f5STejun Heo * Note that DISASSOCIATED can be flipped only while holding 6224647570STejun Heo * assoc_mutex to avoid changing binding state while 6324647570STejun Heo * create_worker() is in progress. 64bc2ae0f5STejun Heo */ 6511ebea50STejun Heo POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */ 66552a37e9SLai Jiangshan POOL_MANAGING_WORKERS = 1 << 1, /* managing workers */ 6724647570STejun Heo POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */ 6835b6bb63STejun Heo POOL_FREEZING = 1 << 3, /* freeze in progress */ 69db7bccf4STejun Heo 70c8e55f36STejun Heo /* worker flags */ 71c8e55f36STejun Heo WORKER_STARTED = 1 << 0, /* started */ 72c8e55f36STejun Heo WORKER_DIE = 1 << 1, /* die die die */ 73c8e55f36STejun Heo WORKER_IDLE = 1 << 2, /* is idle */ 74e22bee78STejun Heo WORKER_PREP = 1 << 3, /* preparing to run works */ 75fb0e7bebSTejun Heo WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */ 76f3421797STejun Heo WORKER_UNBOUND = 1 << 7, /* worker is unbound */ 77e22bee78STejun Heo 785f7dabfdSLai Jiangshan WORKER_NOT_RUNNING = WORKER_PREP | WORKER_UNBOUND | 79403c821dSTejun Heo WORKER_CPU_INTENSIVE, 80db7bccf4STejun Heo 81e34cdddbSTejun Heo NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */ 824ce62e9eSTejun Heo 83c8e55f36STejun Heo BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */ 84db7bccf4STejun Heo 85e22bee78STejun Heo MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */ 86e22bee78STejun Heo IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */ 87e22bee78STejun Heo 883233cdbdSTejun Heo MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2, 893233cdbdSTejun Heo /* call for help after 10ms 903233cdbdSTejun Heo (min two ticks) */ 91e22bee78STejun Heo MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */ 92e22bee78STejun Heo CREATE_COOLDOWN = HZ, /* time to breath after fail */ 931da177e4SLinus Torvalds 941da177e4SLinus Torvalds /* 95e22bee78STejun Heo * Rescue workers are used only on emergencies and shared by 96e22bee78STejun Heo * all cpus. Give -20. 97e22bee78STejun Heo */ 98e22bee78STejun Heo RESCUER_NICE_LEVEL = -20, 993270476aSTejun Heo HIGHPRI_NICE_LEVEL = -20, 100c8e55f36STejun Heo }; 101c8e55f36STejun Heo 1021da177e4SLinus Torvalds /* 1034690c4abSTejun Heo * Structure fields follow one of the following exclusion rules. 1044690c4abSTejun Heo * 105e41e704bSTejun Heo * I: Modifiable by initialization/destruction paths and read-only for 106e41e704bSTejun Heo * everyone else. 1074690c4abSTejun Heo * 108e22bee78STejun Heo * P: Preemption protected. Disabling preemption is enough and should 109e22bee78STejun Heo * only be modified and accessed from the local cpu. 110e22bee78STejun Heo * 111d565ed63STejun Heo * L: pool->lock protected. Access with pool->lock held. 1124690c4abSTejun Heo * 113d565ed63STejun Heo * X: During normal operation, modification requires pool->lock and should 114d565ed63STejun Heo * be done only from local cpu. Either disabling preemption on local 115d565ed63STejun Heo * cpu or grabbing pool->lock is enough for read access. If 116d565ed63STejun Heo * POOL_DISASSOCIATED is set, it's identical to L. 117e22bee78STejun Heo * 11873f53c4aSTejun Heo * F: wq->flush_mutex protected. 11973f53c4aSTejun Heo * 1204690c4abSTejun Heo * W: workqueue_lock protected. 1214690c4abSTejun Heo */ 1224690c4abSTejun Heo 1232eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */ 124c34056a3STejun Heo 125bd7bdd43STejun Heo struct worker_pool { 126d565ed63STejun Heo spinlock_t lock; /* the pool lock */ 127ec22ca5eSTejun Heo unsigned int cpu; /* I: the associated cpu */ 1289daf9e67STejun Heo int id; /* I: pool ID */ 12911ebea50STejun Heo unsigned int flags; /* X: flags */ 130bd7bdd43STejun Heo 131bd7bdd43STejun Heo struct list_head worklist; /* L: list of pending works */ 132bd7bdd43STejun Heo int nr_workers; /* L: total number of workers */ 133ea1abd61SLai Jiangshan 134ea1abd61SLai Jiangshan /* nr_idle includes the ones off idle_list for rebinding */ 135bd7bdd43STejun Heo int nr_idle; /* L: currently idle ones */ 136bd7bdd43STejun Heo 137bd7bdd43STejun Heo struct list_head idle_list; /* X: list of idle workers */ 138bd7bdd43STejun Heo struct timer_list idle_timer; /* L: worker idle timeout */ 139bd7bdd43STejun Heo struct timer_list mayday_timer; /* L: SOS timer for workers */ 140bd7bdd43STejun Heo 141c9e7cf27STejun Heo /* workers are chained either in busy_hash or idle_list */ 142c9e7cf27STejun Heo DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER); 143c9e7cf27STejun Heo /* L: hash of busy workers */ 144c9e7cf27STejun Heo 14524647570STejun Heo struct mutex assoc_mutex; /* protect POOL_DISASSOCIATED */ 146bd7bdd43STejun Heo struct ida worker_ida; /* L: for worker IDs */ 147bd7bdd43STejun Heo }; 148bd7bdd43STejun Heo 1494690c4abSTejun Heo /* 150e22bee78STejun Heo * Global per-cpu workqueue. There's one and only one for each cpu 151e22bee78STejun Heo * and all works are queued and processed here regardless of their 152e22bee78STejun Heo * target workqueues. 1538b03ae3cSTejun Heo */ 1548b03ae3cSTejun Heo struct global_cwq { 155e34cdddbSTejun Heo struct worker_pool pools[NR_STD_WORKER_POOLS]; 156330dad5bSJoonsoo Kim /* normal and highpri pools */ 1578b03ae3cSTejun Heo } ____cacheline_aligned_in_smp; 1588b03ae3cSTejun Heo 1598b03ae3cSTejun Heo /* 160502ca9d8STejun Heo * The per-CPU workqueue. The lower WORK_STRUCT_FLAG_BITS of 1610f900049STejun Heo * work_struct->data are used for flags and thus cwqs need to be 1620f900049STejun Heo * aligned at two's power of the number of flag bits. 1631da177e4SLinus Torvalds */ 1641da177e4SLinus Torvalds struct cpu_workqueue_struct { 165bd7bdd43STejun Heo struct worker_pool *pool; /* I: the associated pool */ 1664690c4abSTejun Heo struct workqueue_struct *wq; /* I: the owning workqueue */ 16773f53c4aSTejun Heo int work_color; /* L: current color */ 16873f53c4aSTejun Heo int flush_color; /* L: flushing color */ 16973f53c4aSTejun Heo int nr_in_flight[WORK_NR_COLORS]; 17073f53c4aSTejun Heo /* L: nr of in_flight works */ 1711e19ffc6STejun Heo int nr_active; /* L: nr of active works */ 172a0a1a5fdSTejun Heo int max_active; /* L: max active works */ 1731e19ffc6STejun Heo struct list_head delayed_works; /* L: delayed works */ 1740f900049STejun Heo }; 1751da177e4SLinus Torvalds 1761da177e4SLinus Torvalds /* 17773f53c4aSTejun Heo * Structure used to wait for workqueue flush. 17873f53c4aSTejun Heo */ 17973f53c4aSTejun Heo struct wq_flusher { 18073f53c4aSTejun Heo struct list_head list; /* F: list of flushers */ 18173f53c4aSTejun Heo int flush_color; /* F: flush color waiting for */ 18273f53c4aSTejun Heo struct completion done; /* flush completion */ 18373f53c4aSTejun Heo }; 1841da177e4SLinus Torvalds 18573f53c4aSTejun Heo /* 186f2e005aaSTejun Heo * All cpumasks are assumed to be always set on UP and thus can't be 187f2e005aaSTejun Heo * used to determine whether there's something to be done. 188f2e005aaSTejun Heo */ 189f2e005aaSTejun Heo #ifdef CONFIG_SMP 190f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t; 191f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask) \ 192f2e005aaSTejun Heo cpumask_test_and_set_cpu((cpu), (mask)) 193f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask)) 194f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask)) 1959c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp)) 196f2e005aaSTejun Heo #define free_mayday_mask(mask) free_cpumask_var((mask)) 197f2e005aaSTejun Heo #else 198f2e005aaSTejun Heo typedef unsigned long mayday_mask_t; 199f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask)) 200f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask)) 201f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask)) 202f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp) true 203f2e005aaSTejun Heo #define free_mayday_mask(mask) do { } while (0) 204f2e005aaSTejun Heo #endif 2051da177e4SLinus Torvalds 2061da177e4SLinus Torvalds /* 2071da177e4SLinus Torvalds * The externally visible workqueue abstraction is an array of 2081da177e4SLinus Torvalds * per-CPU workqueues: 2091da177e4SLinus Torvalds */ 2101da177e4SLinus Torvalds struct workqueue_struct { 2119c5a2ba7STejun Heo unsigned int flags; /* W: WQ_* flags */ 212bdbc5dd7STejun Heo union { 213bdbc5dd7STejun Heo struct cpu_workqueue_struct __percpu *pcpu; 214bdbc5dd7STejun Heo struct cpu_workqueue_struct *single; 215bdbc5dd7STejun Heo unsigned long v; 216bdbc5dd7STejun Heo } cpu_wq; /* I: cwq's */ 2174690c4abSTejun Heo struct list_head list; /* W: list of all workqueues */ 21873f53c4aSTejun Heo 21973f53c4aSTejun Heo struct mutex flush_mutex; /* protects wq flushing */ 22073f53c4aSTejun Heo int work_color; /* F: current work color */ 22173f53c4aSTejun Heo int flush_color; /* F: current flush color */ 22273f53c4aSTejun Heo atomic_t nr_cwqs_to_flush; /* flush in progress */ 22373f53c4aSTejun Heo struct wq_flusher *first_flusher; /* F: first flusher */ 22473f53c4aSTejun Heo struct list_head flusher_queue; /* F: flush waiters */ 22573f53c4aSTejun Heo struct list_head flusher_overflow; /* F: flush overflow list */ 22673f53c4aSTejun Heo 227f2e005aaSTejun Heo mayday_mask_t mayday_mask; /* cpus requesting rescue */ 228e22bee78STejun Heo struct worker *rescuer; /* I: rescue worker */ 229e22bee78STejun Heo 2309c5a2ba7STejun Heo int nr_drainers; /* W: drain in progress */ 231dcd989cbSTejun Heo int saved_max_active; /* W: saved cwq max_active */ 2324e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 2334e6045f1SJohannes Berg struct lockdep_map lockdep_map; 2344e6045f1SJohannes Berg #endif 235b196be89STejun Heo char name[]; /* I: workqueue name */ 2361da177e4SLinus Torvalds }; 2371da177e4SLinus Torvalds 238d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly; 239d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq); 240044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly; 2411aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq); 242044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly; 243d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq); 244044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly; 245f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq); 246044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly; 24724d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq); 248d320c038STejun Heo 24997bd2347STejun Heo #define CREATE_TRACE_POINTS 25097bd2347STejun Heo #include <trace/events/workqueue.h> 25197bd2347STejun Heo 25238db41d9STejun Heo #define for_each_std_worker_pool(pool, cpu) \ 25338db41d9STejun Heo for ((pool) = &get_gcwq((cpu))->pools[0]; \ 25438db41d9STejun Heo (pool) < &get_gcwq((cpu))->pools[NR_STD_WORKER_POOLS]; (pool)++) 2554ce62e9eSTejun Heo 256c9e7cf27STejun Heo #define for_each_busy_worker(worker, i, pos, pool) \ 257c9e7cf27STejun Heo hash_for_each(pool->busy_hash, i, pos, worker, hentry) 258db7bccf4STejun Heo 259f3421797STejun Heo static inline int __next_gcwq_cpu(int cpu, const struct cpumask *mask, 260f3421797STejun Heo unsigned int sw) 261f3421797STejun Heo { 262f3421797STejun Heo if (cpu < nr_cpu_ids) { 263f3421797STejun Heo if (sw & 1) { 264f3421797STejun Heo cpu = cpumask_next(cpu, mask); 265f3421797STejun Heo if (cpu < nr_cpu_ids) 266f3421797STejun Heo return cpu; 267f3421797STejun Heo } 268f3421797STejun Heo if (sw & 2) 269f3421797STejun Heo return WORK_CPU_UNBOUND; 270f3421797STejun Heo } 271f3421797STejun Heo return WORK_CPU_NONE; 272f3421797STejun Heo } 273f3421797STejun Heo 274f3421797STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask, 275f3421797STejun Heo struct workqueue_struct *wq) 276f3421797STejun Heo { 277f3421797STejun Heo return __next_gcwq_cpu(cpu, mask, !(wq->flags & WQ_UNBOUND) ? 1 : 2); 278f3421797STejun Heo } 279f3421797STejun Heo 28009884951STejun Heo /* 28109884951STejun Heo * CPU iterators 28209884951STejun Heo * 28309884951STejun Heo * An extra gcwq is defined for an invalid cpu number 28409884951STejun Heo * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any 28509884951STejun Heo * specific CPU. The following iterators are similar to 28609884951STejun Heo * for_each_*_cpu() iterators but also considers the unbound gcwq. 28709884951STejun Heo * 28809884951STejun Heo * for_each_gcwq_cpu() : possible CPUs + WORK_CPU_UNBOUND 28909884951STejun Heo * for_each_online_gcwq_cpu() : online CPUs + WORK_CPU_UNBOUND 29009884951STejun Heo * for_each_cwq_cpu() : possible CPUs for bound workqueues, 29109884951STejun Heo * WORK_CPU_UNBOUND for unbound workqueues 29209884951STejun Heo */ 293f3421797STejun Heo #define for_each_gcwq_cpu(cpu) \ 294f3421797STejun Heo for ((cpu) = __next_gcwq_cpu(-1, cpu_possible_mask, 3); \ 295f3421797STejun Heo (cpu) < WORK_CPU_NONE; \ 296f3421797STejun Heo (cpu) = __next_gcwq_cpu((cpu), cpu_possible_mask, 3)) 297f3421797STejun Heo 298f3421797STejun Heo #define for_each_online_gcwq_cpu(cpu) \ 299f3421797STejun Heo for ((cpu) = __next_gcwq_cpu(-1, cpu_online_mask, 3); \ 300f3421797STejun Heo (cpu) < WORK_CPU_NONE; \ 301f3421797STejun Heo (cpu) = __next_gcwq_cpu((cpu), cpu_online_mask, 3)) 302f3421797STejun Heo 303f3421797STejun Heo #define for_each_cwq_cpu(cpu, wq) \ 304f3421797STejun Heo for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, (wq)); \ 305f3421797STejun Heo (cpu) < WORK_CPU_NONE; \ 306f3421797STejun Heo (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, (wq))) 307f3421797STejun Heo 308dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 309dc186ad7SThomas Gleixner 310dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr; 311dc186ad7SThomas Gleixner 31299777288SStanislaw Gruszka static void *work_debug_hint(void *addr) 31399777288SStanislaw Gruszka { 31499777288SStanislaw Gruszka return ((struct work_struct *) addr)->func; 31599777288SStanislaw Gruszka } 31699777288SStanislaw Gruszka 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", 38899777288SStanislaw Gruszka .debug_hint = work_debug_hint, 389dc186ad7SThomas Gleixner .fixup_init = work_fixup_init, 390dc186ad7SThomas Gleixner .fixup_activate = work_fixup_activate, 391dc186ad7SThomas Gleixner .fixup_free = work_fixup_free, 392dc186ad7SThomas Gleixner }; 393dc186ad7SThomas Gleixner 394dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) 395dc186ad7SThomas Gleixner { 396dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 397dc186ad7SThomas Gleixner } 398dc186ad7SThomas Gleixner 399dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) 400dc186ad7SThomas Gleixner { 401dc186ad7SThomas Gleixner debug_object_deactivate(work, &work_debug_descr); 402dc186ad7SThomas Gleixner } 403dc186ad7SThomas Gleixner 404dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack) 405dc186ad7SThomas Gleixner { 406dc186ad7SThomas Gleixner if (onstack) 407dc186ad7SThomas Gleixner debug_object_init_on_stack(work, &work_debug_descr); 408dc186ad7SThomas Gleixner else 409dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 410dc186ad7SThomas Gleixner } 411dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work); 412dc186ad7SThomas Gleixner 413dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work) 414dc186ad7SThomas Gleixner { 415dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 416dc186ad7SThomas Gleixner } 417dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack); 418dc186ad7SThomas Gleixner 419dc186ad7SThomas Gleixner #else 420dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { } 421dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { } 422dc186ad7SThomas Gleixner #endif 423dc186ad7SThomas Gleixner 42495402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */ 42595402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock); 4261da177e4SLinus Torvalds static LIST_HEAD(workqueues); 427a0a1a5fdSTejun Heo static bool workqueue_freezing; /* W: have wqs started freezing? */ 4281da177e4SLinus Torvalds 42914441960SOleg Nesterov /* 430e22bee78STejun Heo * The almighty global cpu workqueues. nr_running is the only field 431e22bee78STejun Heo * which is expected to be used frequently by other cpus via 432e22bee78STejun Heo * try_to_wake_up(). Put it in a separate cacheline. 43314441960SOleg Nesterov */ 4348b03ae3cSTejun Heo static DEFINE_PER_CPU(struct global_cwq, global_cwq); 435e34cdddbSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(atomic_t, pool_nr_running[NR_STD_WORKER_POOLS]); 436f756d5e2SNathan Lynch 437f3421797STejun Heo /* 43824647570STejun Heo * Global cpu workqueue and nr_running counter for unbound gcwq. The pools 43924647570STejun Heo * for online CPUs have POOL_DISASSOCIATED set, and all their workers have 44024647570STejun Heo * WORKER_UNBOUND set. 441f3421797STejun Heo */ 442f3421797STejun Heo static struct global_cwq unbound_global_cwq; 443e34cdddbSTejun Heo static atomic_t unbound_pool_nr_running[NR_STD_WORKER_POOLS] = { 444e34cdddbSTejun Heo [0 ... NR_STD_WORKER_POOLS - 1] = ATOMIC_INIT(0), /* always 0 */ 4454ce62e9eSTejun Heo }; 446f3421797STejun Heo 4479daf9e67STejun Heo /* idr of all pools */ 4489daf9e67STejun Heo static DEFINE_MUTEX(worker_pool_idr_mutex); 4499daf9e67STejun Heo static DEFINE_IDR(worker_pool_idr); 4509daf9e67STejun Heo 451c34056a3STejun Heo static int worker_thread(void *__worker); 4521da177e4SLinus Torvalds 4538b03ae3cSTejun Heo static struct global_cwq *get_gcwq(unsigned int cpu) 4541da177e4SLinus Torvalds { 455f3421797STejun Heo if (cpu != WORK_CPU_UNBOUND) 4568b03ae3cSTejun Heo return &per_cpu(global_cwq, cpu); 457f3421797STejun Heo else 458f3421797STejun Heo return &unbound_global_cwq; 4591da177e4SLinus Torvalds } 4601da177e4SLinus Torvalds 461*4e8f0a60STejun Heo static int std_worker_pool_pri(struct worker_pool *pool) 462*4e8f0a60STejun Heo { 463*4e8f0a60STejun Heo return pool - get_gcwq(pool->cpu)->pools; 464*4e8f0a60STejun Heo } 465*4e8f0a60STejun Heo 4669daf9e67STejun Heo /* allocate ID and assign it to @pool */ 4679daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool) 4689daf9e67STejun Heo { 4699daf9e67STejun Heo int ret; 4709daf9e67STejun Heo 4719daf9e67STejun Heo mutex_lock(&worker_pool_idr_mutex); 4729daf9e67STejun Heo idr_pre_get(&worker_pool_idr, GFP_KERNEL); 4739daf9e67STejun Heo ret = idr_get_new(&worker_pool_idr, pool, &pool->id); 4749daf9e67STejun Heo mutex_unlock(&worker_pool_idr_mutex); 4759daf9e67STejun Heo 4769daf9e67STejun Heo return ret; 4779daf9e67STejun Heo } 4789daf9e67STejun Heo 4797c3eed5cSTejun Heo /* 4807c3eed5cSTejun Heo * Lookup worker_pool by id. The idr currently is built during boot and 4817c3eed5cSTejun Heo * never modified. Don't worry about locking for now. 4827c3eed5cSTejun Heo */ 4837c3eed5cSTejun Heo static struct worker_pool *worker_pool_by_id(int pool_id) 4847c3eed5cSTejun Heo { 4857c3eed5cSTejun Heo return idr_find(&worker_pool_idr, pool_id); 4867c3eed5cSTejun Heo } 4877c3eed5cSTejun Heo 488d565ed63STejun Heo static struct worker_pool *get_std_worker_pool(int cpu, bool highpri) 489d565ed63STejun Heo { 490d565ed63STejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 491d565ed63STejun Heo 492d565ed63STejun Heo return &gcwq->pools[highpri]; 493d565ed63STejun Heo } 494d565ed63STejun Heo 49563d95a91STejun Heo static atomic_t *get_pool_nr_running(struct worker_pool *pool) 496b1f4ec17SOleg Nesterov { 497ec22ca5eSTejun Heo int cpu = pool->cpu; 498e34cdddbSTejun Heo int idx = std_worker_pool_pri(pool); 49963d95a91STejun Heo 500f3421797STejun Heo if (cpu != WORK_CPU_UNBOUND) 5014ce62e9eSTejun Heo return &per_cpu(pool_nr_running, cpu)[idx]; 502f3421797STejun Heo else 5034ce62e9eSTejun Heo return &unbound_pool_nr_running[idx]; 504b1f4ec17SOleg Nesterov } 505b1f4ec17SOleg Nesterov 5064690c4abSTejun Heo static struct cpu_workqueue_struct *get_cwq(unsigned int cpu, 5074690c4abSTejun Heo struct workqueue_struct *wq) 508a848e3b6SOleg Nesterov { 509f3421797STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 510e06ffa1eSLai Jiangshan if (likely(cpu < nr_cpu_ids)) 511bdbc5dd7STejun Heo return per_cpu_ptr(wq->cpu_wq.pcpu, cpu); 512f3421797STejun Heo } else if (likely(cpu == WORK_CPU_UNBOUND)) 513f3421797STejun Heo return wq->cpu_wq.single; 514f3421797STejun Heo return NULL; 515f3421797STejun Heo } 516a848e3b6SOleg Nesterov 51773f53c4aSTejun Heo static unsigned int work_color_to_flags(int color) 51873f53c4aSTejun Heo { 51973f53c4aSTejun Heo return color << WORK_STRUCT_COLOR_SHIFT; 52073f53c4aSTejun Heo } 52173f53c4aSTejun Heo 52273f53c4aSTejun Heo static int get_work_color(struct work_struct *work) 52373f53c4aSTejun Heo { 52473f53c4aSTejun Heo return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) & 52573f53c4aSTejun Heo ((1 << WORK_STRUCT_COLOR_BITS) - 1); 52673f53c4aSTejun Heo } 52773f53c4aSTejun Heo 52873f53c4aSTejun Heo static int work_next_color(int color) 52973f53c4aSTejun Heo { 53073f53c4aSTejun Heo return (color + 1) % WORK_NR_COLORS; 5311da177e4SLinus Torvalds } 5321da177e4SLinus Torvalds 5334594bf15SDavid Howells /* 534b5490077STejun Heo * While queued, %WORK_STRUCT_CWQ is set and non flag bits of a work's data 535b5490077STejun Heo * contain the pointer to the queued cwq. Once execution starts, the flag 5367c3eed5cSTejun Heo * is cleared and the high bits contain OFFQ flags and pool ID. 5377a22ad75STejun Heo * 5387c3eed5cSTejun Heo * set_work_cwq(), set_work_pool_and_clear_pending(), mark_work_canceling() 5397c3eed5cSTejun Heo * and clear_work_data() can be used to set the cwq, pool or clear 540bbb68dfaSTejun Heo * work->data. These functions should only be called while the work is 541bbb68dfaSTejun Heo * owned - ie. while the PENDING bit is set. 5427a22ad75STejun Heo * 5437c3eed5cSTejun Heo * get_work_pool() and get_work_cwq() can be used to obtain the pool or cwq 5447c3eed5cSTejun Heo * corresponding to a work. Pool is available once the work has been 5457c3eed5cSTejun Heo * queued anywhere after initialization until it is sync canceled. cwq is 5467c3eed5cSTejun Heo * available only while the work item is queued. 547bbb68dfaSTejun Heo * 548bbb68dfaSTejun Heo * %WORK_OFFQ_CANCELING is used to mark a work item which is being 549bbb68dfaSTejun Heo * canceled. While being canceled, a work item may have its PENDING set 550bbb68dfaSTejun Heo * but stay off timer and worklist for arbitrarily long and nobody should 551bbb68dfaSTejun Heo * try to steal the PENDING bit. 5524594bf15SDavid Howells */ 5537a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data, 5547a22ad75STejun Heo unsigned long flags) 5557a22ad75STejun Heo { 5567a22ad75STejun Heo BUG_ON(!work_pending(work)); 5577a22ad75STejun Heo atomic_long_set(&work->data, data | flags | work_static(work)); 5587a22ad75STejun Heo } 5597a22ad75STejun Heo 5607a22ad75STejun Heo static void set_work_cwq(struct work_struct *work, 5614690c4abSTejun Heo struct cpu_workqueue_struct *cwq, 5624690c4abSTejun Heo unsigned long extra_flags) 563365970a1SDavid Howells { 5647a22ad75STejun Heo set_work_data(work, (unsigned long)cwq, 565e120153dSTejun Heo WORK_STRUCT_PENDING | WORK_STRUCT_CWQ | extra_flags); 566365970a1SDavid Howells } 567365970a1SDavid Howells 5687c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work, 5697c3eed5cSTejun Heo int pool_id) 5704d707b9fSOleg Nesterov { 57123657bb1STejun Heo /* 57223657bb1STejun Heo * The following wmb is paired with the implied mb in 57323657bb1STejun Heo * test_and_set_bit(PENDING) and ensures all updates to @work made 57423657bb1STejun Heo * here are visible to and precede any updates by the next PENDING 57523657bb1STejun Heo * owner. 57623657bb1STejun Heo */ 57723657bb1STejun Heo smp_wmb(); 5787c3eed5cSTejun Heo set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0); 5794d707b9fSOleg Nesterov } 5804d707b9fSOleg Nesterov 5817a22ad75STejun Heo static void clear_work_data(struct work_struct *work) 582365970a1SDavid Howells { 5837c3eed5cSTejun Heo smp_wmb(); /* see set_work_pool_and_clear_pending() */ 5847c3eed5cSTejun Heo set_work_data(work, WORK_STRUCT_NO_POOL, 0); 5857a22ad75STejun Heo } 5867a22ad75STejun Heo 5877a22ad75STejun Heo static struct cpu_workqueue_struct *get_work_cwq(struct work_struct *work) 5887a22ad75STejun Heo { 589e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 5907a22ad75STejun Heo 591e120153dSTejun Heo if (data & WORK_STRUCT_CWQ) 592e120153dSTejun Heo return (void *)(data & WORK_STRUCT_WQ_DATA_MASK); 593e120153dSTejun Heo else 594e120153dSTejun Heo return NULL; 5957a22ad75STejun Heo } 5967a22ad75STejun Heo 5977c3eed5cSTejun Heo /** 5987c3eed5cSTejun Heo * get_work_pool - return the worker_pool a given work was associated with 5997c3eed5cSTejun Heo * @work: the work item of interest 6007c3eed5cSTejun Heo * 6017c3eed5cSTejun Heo * Return the worker_pool @work was last associated with. %NULL if none. 6027c3eed5cSTejun Heo */ 6037c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work) 6047a22ad75STejun Heo { 605e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 6067c3eed5cSTejun Heo struct worker_pool *pool; 6077c3eed5cSTejun Heo int pool_id; 6087a22ad75STejun Heo 609e120153dSTejun Heo if (data & WORK_STRUCT_CWQ) 610e120153dSTejun Heo return ((struct cpu_workqueue_struct *) 6117c3eed5cSTejun Heo (data & WORK_STRUCT_WQ_DATA_MASK))->pool; 6127a22ad75STejun Heo 6137c3eed5cSTejun Heo pool_id = data >> WORK_OFFQ_POOL_SHIFT; 6147c3eed5cSTejun Heo if (pool_id == WORK_OFFQ_POOL_NONE) 6157a22ad75STejun Heo return NULL; 6167a22ad75STejun Heo 6177c3eed5cSTejun Heo pool = worker_pool_by_id(pool_id); 6187c3eed5cSTejun Heo WARN_ON_ONCE(!pool); 6197c3eed5cSTejun Heo return pool; 6207c3eed5cSTejun Heo } 6217c3eed5cSTejun Heo 6227c3eed5cSTejun Heo /** 6237c3eed5cSTejun Heo * get_work_pool_id - return the worker pool ID a given work is associated with 6247c3eed5cSTejun Heo * @work: the work item of interest 6257c3eed5cSTejun Heo * 6267c3eed5cSTejun Heo * Return the worker_pool ID @work was last associated with. 6277c3eed5cSTejun Heo * %WORK_OFFQ_POOL_NONE if none. 6287c3eed5cSTejun Heo */ 6297c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work) 6307c3eed5cSTejun Heo { 6317c3eed5cSTejun Heo struct worker_pool *pool = get_work_pool(work); 6327c3eed5cSTejun Heo 6337c3eed5cSTejun Heo return pool ? pool->id : WORK_OFFQ_POOL_NONE; 6347c3eed5cSTejun Heo } 6357c3eed5cSTejun Heo 636bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work) 637bbb68dfaSTejun Heo { 6387c3eed5cSTejun Heo unsigned long pool_id = get_work_pool_id(work); 639bbb68dfaSTejun Heo 6407c3eed5cSTejun Heo pool_id <<= WORK_OFFQ_POOL_SHIFT; 6417c3eed5cSTejun Heo set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING); 642bbb68dfaSTejun Heo } 643bbb68dfaSTejun Heo 644bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work) 645bbb68dfaSTejun Heo { 646bbb68dfaSTejun Heo unsigned long data = atomic_long_read(&work->data); 647bbb68dfaSTejun Heo 648bbb68dfaSTejun Heo return !(data & WORK_STRUCT_CWQ) && (data & WORK_OFFQ_CANCELING); 649bbb68dfaSTejun Heo } 650bbb68dfaSTejun Heo 651e22bee78STejun Heo /* 6523270476aSTejun Heo * Policy functions. These define the policies on how the global worker 6533270476aSTejun Heo * pools are managed. Unless noted otherwise, these functions assume that 654d565ed63STejun Heo * they're being called with pool->lock held. 655e22bee78STejun Heo */ 656e22bee78STejun Heo 65763d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool) 658649027d7STejun Heo { 6593270476aSTejun Heo return !atomic_read(get_pool_nr_running(pool)); 660649027d7STejun Heo } 661649027d7STejun Heo 662e22bee78STejun Heo /* 663e22bee78STejun Heo * Need to wake up a worker? Called from anything but currently 664e22bee78STejun Heo * running workers. 665974271c4STejun Heo * 666974271c4STejun Heo * Note that, because unbound workers never contribute to nr_running, this 667974271c4STejun Heo * function will always return %true for unbound gcwq as long as the 668974271c4STejun Heo * worklist isn't empty. 669e22bee78STejun Heo */ 67063d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool) 671e22bee78STejun Heo { 67263d95a91STejun Heo return !list_empty(&pool->worklist) && __need_more_worker(pool); 673e22bee78STejun Heo } 674e22bee78STejun Heo 675e22bee78STejun Heo /* Can I start working? Called from busy but !running workers. */ 67663d95a91STejun Heo static bool may_start_working(struct worker_pool *pool) 677e22bee78STejun Heo { 67863d95a91STejun Heo return pool->nr_idle; 679e22bee78STejun Heo } 680e22bee78STejun Heo 681e22bee78STejun Heo /* Do I need to keep working? Called from currently running workers. */ 68263d95a91STejun Heo static bool keep_working(struct worker_pool *pool) 683e22bee78STejun Heo { 68463d95a91STejun Heo atomic_t *nr_running = get_pool_nr_running(pool); 685e22bee78STejun Heo 6863270476aSTejun Heo return !list_empty(&pool->worklist) && atomic_read(nr_running) <= 1; 687e22bee78STejun Heo } 688e22bee78STejun Heo 689e22bee78STejun Heo /* Do we need a new worker? Called from manager. */ 69063d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool) 691e22bee78STejun Heo { 69263d95a91STejun Heo return need_more_worker(pool) && !may_start_working(pool); 693e22bee78STejun Heo } 694e22bee78STejun Heo 695e22bee78STejun Heo /* Do I need to be the manager? */ 69663d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool) 697e22bee78STejun Heo { 69863d95a91STejun Heo return need_to_create_worker(pool) || 69911ebea50STejun Heo (pool->flags & POOL_MANAGE_WORKERS); 700e22bee78STejun Heo } 701e22bee78STejun Heo 702e22bee78STejun Heo /* Do we have too many workers and should some go away? */ 70363d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool) 704e22bee78STejun Heo { 705552a37e9SLai Jiangshan bool managing = pool->flags & POOL_MANAGING_WORKERS; 70663d95a91STejun Heo int nr_idle = pool->nr_idle + managing; /* manager is considered idle */ 70763d95a91STejun Heo int nr_busy = pool->nr_workers - nr_idle; 708e22bee78STejun Heo 709ea1abd61SLai Jiangshan /* 710ea1abd61SLai Jiangshan * nr_idle and idle_list may disagree if idle rebinding is in 711ea1abd61SLai Jiangshan * progress. Never return %true if idle_list is empty. 712ea1abd61SLai Jiangshan */ 713ea1abd61SLai Jiangshan if (list_empty(&pool->idle_list)) 714ea1abd61SLai Jiangshan return false; 715ea1abd61SLai Jiangshan 716e22bee78STejun Heo return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; 717e22bee78STejun Heo } 718e22bee78STejun Heo 719e22bee78STejun Heo /* 720e22bee78STejun Heo * Wake up functions. 721e22bee78STejun Heo */ 722e22bee78STejun Heo 7237e11629dSTejun Heo /* Return the first worker. Safe with preemption disabled */ 72463d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool) 7257e11629dSTejun Heo { 72663d95a91STejun Heo if (unlikely(list_empty(&pool->idle_list))) 7277e11629dSTejun Heo return NULL; 7287e11629dSTejun Heo 72963d95a91STejun Heo return list_first_entry(&pool->idle_list, struct worker, entry); 7307e11629dSTejun Heo } 7317e11629dSTejun Heo 7327e11629dSTejun Heo /** 7337e11629dSTejun Heo * wake_up_worker - wake up an idle worker 73463d95a91STejun Heo * @pool: worker pool to wake worker from 7357e11629dSTejun Heo * 73663d95a91STejun Heo * Wake up the first idle worker of @pool. 7377e11629dSTejun Heo * 7387e11629dSTejun Heo * CONTEXT: 739d565ed63STejun Heo * spin_lock_irq(pool->lock). 7407e11629dSTejun Heo */ 74163d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool) 7427e11629dSTejun Heo { 74363d95a91STejun Heo struct worker *worker = first_worker(pool); 7447e11629dSTejun Heo 7457e11629dSTejun Heo if (likely(worker)) 7467e11629dSTejun Heo wake_up_process(worker->task); 7477e11629dSTejun Heo } 7487e11629dSTejun Heo 7494690c4abSTejun Heo /** 750e22bee78STejun Heo * wq_worker_waking_up - a worker is waking up 751e22bee78STejun Heo * @task: task waking up 752e22bee78STejun Heo * @cpu: CPU @task is waking up to 753e22bee78STejun Heo * 754e22bee78STejun Heo * This function is called during try_to_wake_up() when a worker is 755e22bee78STejun Heo * being awoken. 756e22bee78STejun Heo * 757e22bee78STejun Heo * CONTEXT: 758e22bee78STejun Heo * spin_lock_irq(rq->lock) 759e22bee78STejun Heo */ 760e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu) 761e22bee78STejun Heo { 762e22bee78STejun Heo struct worker *worker = kthread_data(task); 763e22bee78STejun Heo 76436576000SJoonsoo Kim if (!(worker->flags & WORKER_NOT_RUNNING)) { 765ec22ca5eSTejun Heo WARN_ON_ONCE(worker->pool->cpu != cpu); 76663d95a91STejun Heo atomic_inc(get_pool_nr_running(worker->pool)); 767e22bee78STejun Heo } 76836576000SJoonsoo Kim } 769e22bee78STejun Heo 770e22bee78STejun Heo /** 771e22bee78STejun Heo * wq_worker_sleeping - a worker is going to sleep 772e22bee78STejun Heo * @task: task going to sleep 773e22bee78STejun Heo * @cpu: CPU in question, must be the current CPU number 774e22bee78STejun Heo * 775e22bee78STejun Heo * This function is called during schedule() when a busy worker is 776e22bee78STejun Heo * going to sleep. Worker on the same cpu can be woken up by 777e22bee78STejun Heo * returning pointer to its task. 778e22bee78STejun Heo * 779e22bee78STejun Heo * CONTEXT: 780e22bee78STejun Heo * spin_lock_irq(rq->lock) 781e22bee78STejun Heo * 782e22bee78STejun Heo * RETURNS: 783e22bee78STejun Heo * Worker task on @cpu to wake up, %NULL if none. 784e22bee78STejun Heo */ 785e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task, 786e22bee78STejun Heo unsigned int cpu) 787e22bee78STejun Heo { 788e22bee78STejun Heo struct worker *worker = kthread_data(task), *to_wakeup = NULL; 789111c225aSTejun Heo struct worker_pool *pool; 790111c225aSTejun Heo atomic_t *nr_running; 791e22bee78STejun Heo 792111c225aSTejun Heo /* 793111c225aSTejun Heo * Rescuers, which may not have all the fields set up like normal 794111c225aSTejun Heo * workers, also reach here, let's not access anything before 795111c225aSTejun Heo * checking NOT_RUNNING. 796111c225aSTejun Heo */ 7972d64672eSSteven Rostedt if (worker->flags & WORKER_NOT_RUNNING) 798e22bee78STejun Heo return NULL; 799e22bee78STejun Heo 800111c225aSTejun Heo pool = worker->pool; 801111c225aSTejun Heo nr_running = get_pool_nr_running(pool); 802111c225aSTejun Heo 803e22bee78STejun Heo /* this can only happen on the local cpu */ 804e22bee78STejun Heo BUG_ON(cpu != raw_smp_processor_id()); 805e22bee78STejun Heo 806e22bee78STejun Heo /* 807e22bee78STejun Heo * The counterpart of the following dec_and_test, implied mb, 808e22bee78STejun Heo * worklist not empty test sequence is in insert_work(). 809e22bee78STejun Heo * Please read comment there. 810e22bee78STejun Heo * 811628c78e7STejun Heo * NOT_RUNNING is clear. This means that we're bound to and 812628c78e7STejun Heo * running on the local cpu w/ rq lock held and preemption 813628c78e7STejun Heo * disabled, which in turn means that none else could be 814d565ed63STejun Heo * manipulating idle_list, so dereferencing idle_list without pool 815628c78e7STejun Heo * lock is safe. 816e22bee78STejun Heo */ 817bd7bdd43STejun Heo if (atomic_dec_and_test(nr_running) && !list_empty(&pool->worklist)) 81863d95a91STejun Heo to_wakeup = first_worker(pool); 819e22bee78STejun Heo return to_wakeup ? to_wakeup->task : NULL; 820e22bee78STejun Heo } 821e22bee78STejun Heo 822e22bee78STejun Heo /** 823e22bee78STejun Heo * worker_set_flags - set worker flags and adjust nr_running accordingly 824cb444766STejun Heo * @worker: self 825d302f017STejun Heo * @flags: flags to set 826d302f017STejun Heo * @wakeup: wakeup an idle worker if necessary 827d302f017STejun Heo * 828e22bee78STejun Heo * Set @flags in @worker->flags and adjust nr_running accordingly. If 829e22bee78STejun Heo * nr_running becomes zero and @wakeup is %true, an idle worker is 830e22bee78STejun Heo * woken up. 831d302f017STejun Heo * 832cb444766STejun Heo * CONTEXT: 833d565ed63STejun Heo * spin_lock_irq(pool->lock) 834d302f017STejun Heo */ 835d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags, 836d302f017STejun Heo bool wakeup) 837d302f017STejun Heo { 838bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 839e22bee78STejun Heo 840cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 841cb444766STejun Heo 842e22bee78STejun Heo /* 843e22bee78STejun Heo * If transitioning into NOT_RUNNING, adjust nr_running and 844e22bee78STejun Heo * wake up an idle worker as necessary if requested by 845e22bee78STejun Heo * @wakeup. 846e22bee78STejun Heo */ 847e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && 848e22bee78STejun Heo !(worker->flags & WORKER_NOT_RUNNING)) { 84963d95a91STejun Heo atomic_t *nr_running = get_pool_nr_running(pool); 850e22bee78STejun Heo 851e22bee78STejun Heo if (wakeup) { 852e22bee78STejun Heo if (atomic_dec_and_test(nr_running) && 853bd7bdd43STejun Heo !list_empty(&pool->worklist)) 85463d95a91STejun Heo wake_up_worker(pool); 855e22bee78STejun Heo } else 856e22bee78STejun Heo atomic_dec(nr_running); 857e22bee78STejun Heo } 858e22bee78STejun Heo 859d302f017STejun Heo worker->flags |= flags; 860d302f017STejun Heo } 861d302f017STejun Heo 862d302f017STejun Heo /** 863e22bee78STejun Heo * worker_clr_flags - clear worker flags and adjust nr_running accordingly 864cb444766STejun Heo * @worker: self 865d302f017STejun Heo * @flags: flags to clear 866d302f017STejun Heo * 867e22bee78STejun Heo * Clear @flags in @worker->flags and adjust nr_running accordingly. 868d302f017STejun Heo * 869cb444766STejun Heo * CONTEXT: 870d565ed63STejun Heo * spin_lock_irq(pool->lock) 871d302f017STejun Heo */ 872d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags) 873d302f017STejun Heo { 87463d95a91STejun Heo struct worker_pool *pool = worker->pool; 875e22bee78STejun Heo unsigned int oflags = worker->flags; 876e22bee78STejun Heo 877cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 878cb444766STejun Heo 879d302f017STejun Heo worker->flags &= ~flags; 880e22bee78STejun Heo 88142c025f3STejun Heo /* 88242c025f3STejun Heo * If transitioning out of NOT_RUNNING, increment nr_running. Note 88342c025f3STejun Heo * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask 88442c025f3STejun Heo * of multiple flags, not a single flag. 88542c025f3STejun Heo */ 886e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) 887e22bee78STejun Heo if (!(worker->flags & WORKER_NOT_RUNNING)) 88863d95a91STejun Heo atomic_inc(get_pool_nr_running(pool)); 889d302f017STejun Heo } 890d302f017STejun Heo 891d302f017STejun Heo /** 8928cca0eeaSTejun Heo * find_worker_executing_work - find worker which is executing a work 893c9e7cf27STejun Heo * @pool: pool of interest 8948cca0eeaSTejun Heo * @work: work to find worker for 8958cca0eeaSTejun Heo * 896c9e7cf27STejun Heo * Find a worker which is executing @work on @pool by searching 897c9e7cf27STejun Heo * @pool->busy_hash which is keyed by the address of @work. For a worker 898a2c1c57bSTejun Heo * to match, its current execution should match the address of @work and 899a2c1c57bSTejun Heo * its work function. This is to avoid unwanted dependency between 900a2c1c57bSTejun Heo * unrelated work executions through a work item being recycled while still 901a2c1c57bSTejun Heo * being executed. 902a2c1c57bSTejun Heo * 903a2c1c57bSTejun Heo * This is a bit tricky. A work item may be freed once its execution 904a2c1c57bSTejun Heo * starts and nothing prevents the freed area from being recycled for 905a2c1c57bSTejun Heo * another work item. If the same work item address ends up being reused 906a2c1c57bSTejun Heo * before the original execution finishes, workqueue will identify the 907a2c1c57bSTejun Heo * recycled work item as currently executing and make it wait until the 908a2c1c57bSTejun Heo * current execution finishes, introducing an unwanted dependency. 909a2c1c57bSTejun Heo * 910a2c1c57bSTejun Heo * This function checks the work item address, work function and workqueue 911a2c1c57bSTejun Heo * to avoid false positives. Note that this isn't complete as one may 912a2c1c57bSTejun Heo * construct a work function which can introduce dependency onto itself 913a2c1c57bSTejun Heo * through a recycled work item. Well, if somebody wants to shoot oneself 914a2c1c57bSTejun Heo * in the foot that badly, there's only so much we can do, and if such 915a2c1c57bSTejun Heo * deadlock actually occurs, it should be easy to locate the culprit work 916a2c1c57bSTejun Heo * function. 9178cca0eeaSTejun Heo * 9188cca0eeaSTejun Heo * CONTEXT: 919d565ed63STejun Heo * spin_lock_irq(pool->lock). 9208cca0eeaSTejun Heo * 9218cca0eeaSTejun Heo * RETURNS: 9228cca0eeaSTejun Heo * Pointer to worker which is executing @work if found, NULL 9238cca0eeaSTejun Heo * otherwise. 9248cca0eeaSTejun Heo */ 925c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool, 9268cca0eeaSTejun Heo struct work_struct *work) 9278cca0eeaSTejun Heo { 92842f8570fSSasha Levin struct worker *worker; 92942f8570fSSasha Levin struct hlist_node *tmp; 93042f8570fSSasha Levin 931c9e7cf27STejun Heo hash_for_each_possible(pool->busy_hash, worker, tmp, hentry, 932a2c1c57bSTejun Heo (unsigned long)work) 933a2c1c57bSTejun Heo if (worker->current_work == work && 934a2c1c57bSTejun Heo worker->current_func == work->func) 93542f8570fSSasha Levin return worker; 93642f8570fSSasha Levin 93742f8570fSSasha Levin return NULL; 9388cca0eeaSTejun Heo } 9398cca0eeaSTejun Heo 9408cca0eeaSTejun Heo /** 941bf4ede01STejun Heo * move_linked_works - move linked works to a list 942bf4ede01STejun Heo * @work: start of series of works to be scheduled 943bf4ede01STejun Heo * @head: target list to append @work to 944bf4ede01STejun Heo * @nextp: out paramter for nested worklist walking 945bf4ede01STejun Heo * 946bf4ede01STejun Heo * Schedule linked works starting from @work to @head. Work series to 947bf4ede01STejun Heo * be scheduled starts at @work and includes any consecutive work with 948bf4ede01STejun Heo * WORK_STRUCT_LINKED set in its predecessor. 949bf4ede01STejun Heo * 950bf4ede01STejun Heo * If @nextp is not NULL, it's updated to point to the next work of 951bf4ede01STejun Heo * the last scheduled work. This allows move_linked_works() to be 952bf4ede01STejun Heo * nested inside outer list_for_each_entry_safe(). 953bf4ede01STejun Heo * 954bf4ede01STejun Heo * CONTEXT: 955d565ed63STejun Heo * spin_lock_irq(pool->lock). 956bf4ede01STejun Heo */ 957bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head, 958bf4ede01STejun Heo struct work_struct **nextp) 959bf4ede01STejun Heo { 960bf4ede01STejun Heo struct work_struct *n; 961bf4ede01STejun Heo 962bf4ede01STejun Heo /* 963bf4ede01STejun Heo * Linked worklist will always end before the end of the list, 964bf4ede01STejun Heo * use NULL for list head. 965bf4ede01STejun Heo */ 966bf4ede01STejun Heo list_for_each_entry_safe_from(work, n, NULL, entry) { 967bf4ede01STejun Heo list_move_tail(&work->entry, head); 968bf4ede01STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) 969bf4ede01STejun Heo break; 970bf4ede01STejun Heo } 971bf4ede01STejun Heo 972bf4ede01STejun Heo /* 973bf4ede01STejun Heo * If we're already inside safe list traversal and have moved 974bf4ede01STejun Heo * multiple works to the scheduled queue, the next position 975bf4ede01STejun Heo * needs to be updated. 976bf4ede01STejun Heo */ 977bf4ede01STejun Heo if (nextp) 978bf4ede01STejun Heo *nextp = n; 979bf4ede01STejun Heo } 980bf4ede01STejun Heo 9813aa62497SLai Jiangshan static void cwq_activate_delayed_work(struct work_struct *work) 982bf4ede01STejun Heo { 9833aa62497SLai Jiangshan struct cpu_workqueue_struct *cwq = get_work_cwq(work); 984bf4ede01STejun Heo 985bf4ede01STejun Heo trace_workqueue_activate_work(work); 986bf4ede01STejun Heo move_linked_works(work, &cwq->pool->worklist, NULL); 987bf4ede01STejun Heo __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work)); 988bf4ede01STejun Heo cwq->nr_active++; 989bf4ede01STejun Heo } 990bf4ede01STejun Heo 9913aa62497SLai Jiangshan static void cwq_activate_first_delayed(struct cpu_workqueue_struct *cwq) 9923aa62497SLai Jiangshan { 9933aa62497SLai Jiangshan struct work_struct *work = list_first_entry(&cwq->delayed_works, 9943aa62497SLai Jiangshan struct work_struct, entry); 9953aa62497SLai Jiangshan 9963aa62497SLai Jiangshan cwq_activate_delayed_work(work); 9973aa62497SLai Jiangshan } 9983aa62497SLai Jiangshan 999bf4ede01STejun Heo /** 1000bf4ede01STejun Heo * cwq_dec_nr_in_flight - decrement cwq's nr_in_flight 1001bf4ede01STejun Heo * @cwq: cwq of interest 1002bf4ede01STejun Heo * @color: color of work which left the queue 1003bf4ede01STejun Heo * 1004bf4ede01STejun Heo * A work either has completed or is removed from pending queue, 1005bf4ede01STejun Heo * decrement nr_in_flight of its cwq and handle workqueue flushing. 1006bf4ede01STejun Heo * 1007bf4ede01STejun Heo * CONTEXT: 1008d565ed63STejun Heo * spin_lock_irq(pool->lock). 1009bf4ede01STejun Heo */ 1010b3f9f405SLai Jiangshan static void cwq_dec_nr_in_flight(struct cpu_workqueue_struct *cwq, int color) 1011bf4ede01STejun Heo { 1012bf4ede01STejun Heo /* ignore uncolored works */ 1013bf4ede01STejun Heo if (color == WORK_NO_COLOR) 1014bf4ede01STejun Heo return; 1015bf4ede01STejun Heo 1016bf4ede01STejun Heo cwq->nr_in_flight[color]--; 1017bf4ede01STejun Heo 1018bf4ede01STejun Heo cwq->nr_active--; 1019bf4ede01STejun Heo if (!list_empty(&cwq->delayed_works)) { 1020bf4ede01STejun Heo /* one down, submit a delayed one */ 1021bf4ede01STejun Heo if (cwq->nr_active < cwq->max_active) 1022bf4ede01STejun Heo cwq_activate_first_delayed(cwq); 1023bf4ede01STejun Heo } 1024bf4ede01STejun Heo 1025bf4ede01STejun Heo /* is flush in progress and are we at the flushing tip? */ 1026bf4ede01STejun Heo if (likely(cwq->flush_color != color)) 1027bf4ede01STejun Heo return; 1028bf4ede01STejun Heo 1029bf4ede01STejun Heo /* are there still in-flight works? */ 1030bf4ede01STejun Heo if (cwq->nr_in_flight[color]) 1031bf4ede01STejun Heo return; 1032bf4ede01STejun Heo 1033bf4ede01STejun Heo /* this cwq is done, clear flush_color */ 1034bf4ede01STejun Heo cwq->flush_color = -1; 1035bf4ede01STejun Heo 1036bf4ede01STejun Heo /* 1037bf4ede01STejun Heo * If this was the last cwq, wake up the first flusher. It 1038bf4ede01STejun Heo * will handle the rest. 1039bf4ede01STejun Heo */ 1040bf4ede01STejun Heo if (atomic_dec_and_test(&cwq->wq->nr_cwqs_to_flush)) 1041bf4ede01STejun Heo complete(&cwq->wq->first_flusher->done); 1042bf4ede01STejun Heo } 1043bf4ede01STejun Heo 104436e227d2STejun Heo /** 1045bbb68dfaSTejun Heo * try_to_grab_pending - steal work item from worklist and disable irq 104636e227d2STejun Heo * @work: work item to steal 104736e227d2STejun Heo * @is_dwork: @work is a delayed_work 1048bbb68dfaSTejun Heo * @flags: place to store irq state 104936e227d2STejun Heo * 105036e227d2STejun Heo * Try to grab PENDING bit of @work. This function can handle @work in any 105136e227d2STejun Heo * stable state - idle, on timer or on worklist. Return values are 105236e227d2STejun Heo * 105336e227d2STejun Heo * 1 if @work was pending and we successfully stole PENDING 105436e227d2STejun Heo * 0 if @work was idle and we claimed PENDING 105536e227d2STejun Heo * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry 1056bbb68dfaSTejun Heo * -ENOENT if someone else is canceling @work, this state may persist 1057bbb68dfaSTejun Heo * for arbitrarily long 105836e227d2STejun Heo * 1059bbb68dfaSTejun Heo * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting 1060e0aecdd8STejun Heo * interrupted while holding PENDING and @work off queue, irq must be 1061e0aecdd8STejun Heo * disabled on entry. This, combined with delayed_work->timer being 1062e0aecdd8STejun Heo * irqsafe, ensures that we return -EAGAIN for finite short period of time. 1063bbb68dfaSTejun Heo * 1064bbb68dfaSTejun Heo * On successful return, >= 0, irq is disabled and the caller is 1065bbb68dfaSTejun Heo * responsible for releasing it using local_irq_restore(*@flags). 1066bbb68dfaSTejun Heo * 1067e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 1068bf4ede01STejun Heo */ 1069bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork, 1070bbb68dfaSTejun Heo unsigned long *flags) 1071bf4ede01STejun Heo { 1072d565ed63STejun Heo struct worker_pool *pool; 1073bf4ede01STejun Heo 1074bbb68dfaSTejun Heo local_irq_save(*flags); 1075bbb68dfaSTejun Heo 107636e227d2STejun Heo /* try to steal the timer if it exists */ 107736e227d2STejun Heo if (is_dwork) { 107836e227d2STejun Heo struct delayed_work *dwork = to_delayed_work(work); 107936e227d2STejun Heo 1080e0aecdd8STejun Heo /* 1081e0aecdd8STejun Heo * dwork->timer is irqsafe. If del_timer() fails, it's 1082e0aecdd8STejun Heo * guaranteed that the timer is not queued anywhere and not 1083e0aecdd8STejun Heo * running on the local CPU. 1084e0aecdd8STejun Heo */ 108536e227d2STejun Heo if (likely(del_timer(&dwork->timer))) 108636e227d2STejun Heo return 1; 108736e227d2STejun Heo } 108836e227d2STejun Heo 108936e227d2STejun Heo /* try to claim PENDING the normal way */ 1090bf4ede01STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) 1091bf4ede01STejun Heo return 0; 1092bf4ede01STejun Heo 1093bf4ede01STejun Heo /* 1094bf4ede01STejun Heo * The queueing is in progress, or it is already queued. Try to 1095bf4ede01STejun Heo * steal it from ->worklist without clearing WORK_STRUCT_PENDING. 1096bf4ede01STejun Heo */ 1097d565ed63STejun Heo pool = get_work_pool(work); 1098d565ed63STejun Heo if (!pool) 1099bbb68dfaSTejun Heo goto fail; 1100bf4ede01STejun Heo 1101d565ed63STejun Heo spin_lock(&pool->lock); 1102bf4ede01STejun Heo if (!list_empty(&work->entry)) { 1103bf4ede01STejun Heo /* 1104d565ed63STejun Heo * This work is queued, but perhaps we locked the wrong 1105d565ed63STejun Heo * pool. In that case we must see the new value after 1106d565ed63STejun Heo * rmb(), see insert_work()->wmb(). 1107bf4ede01STejun Heo */ 1108bf4ede01STejun Heo smp_rmb(); 1109d565ed63STejun Heo if (pool == get_work_pool(work)) { 1110bf4ede01STejun Heo debug_work_deactivate(work); 11113aa62497SLai Jiangshan 11123aa62497SLai Jiangshan /* 11133aa62497SLai Jiangshan * A delayed work item cannot be grabbed directly 11143aa62497SLai Jiangshan * because it might have linked NO_COLOR work items 11153aa62497SLai Jiangshan * which, if left on the delayed_list, will confuse 11163aa62497SLai Jiangshan * cwq->nr_active management later on and cause 11173aa62497SLai Jiangshan * stall. Make sure the work item is activated 11183aa62497SLai Jiangshan * before grabbing. 11193aa62497SLai Jiangshan */ 11203aa62497SLai Jiangshan if (*work_data_bits(work) & WORK_STRUCT_DELAYED) 11213aa62497SLai Jiangshan cwq_activate_delayed_work(work); 11223aa62497SLai Jiangshan 1123bf4ede01STejun Heo list_del_init(&work->entry); 1124bf4ede01STejun Heo cwq_dec_nr_in_flight(get_work_cwq(work), 1125b3f9f405SLai Jiangshan get_work_color(work)); 112636e227d2STejun Heo 1127d565ed63STejun Heo spin_unlock(&pool->lock); 112836e227d2STejun Heo return 1; 1129bf4ede01STejun Heo } 1130bf4ede01STejun Heo } 1131d565ed63STejun Heo spin_unlock(&pool->lock); 1132bbb68dfaSTejun Heo fail: 1133bbb68dfaSTejun Heo local_irq_restore(*flags); 1134bbb68dfaSTejun Heo if (work_is_canceling(work)) 1135bbb68dfaSTejun Heo return -ENOENT; 1136bbb68dfaSTejun Heo cpu_relax(); 113736e227d2STejun Heo return -EAGAIN; 1138bf4ede01STejun Heo } 1139bf4ede01STejun Heo 1140bf4ede01STejun Heo /** 11417e11629dSTejun Heo * insert_work - insert a work into gcwq 11424690c4abSTejun Heo * @cwq: cwq @work belongs to 11434690c4abSTejun Heo * @work: work to insert 11444690c4abSTejun Heo * @head: insertion point 11454690c4abSTejun Heo * @extra_flags: extra WORK_STRUCT_* flags to set 11464690c4abSTejun Heo * 11477e11629dSTejun Heo * Insert @work which belongs to @cwq into @gcwq after @head. 11487e11629dSTejun Heo * @extra_flags is or'd to work_struct flags. 11494690c4abSTejun Heo * 11504690c4abSTejun Heo * CONTEXT: 1151d565ed63STejun Heo * spin_lock_irq(pool->lock). 1152365970a1SDavid Howells */ 1153b89deed3SOleg Nesterov static void insert_work(struct cpu_workqueue_struct *cwq, 11544690c4abSTejun Heo struct work_struct *work, struct list_head *head, 11554690c4abSTejun Heo unsigned int extra_flags) 1156b89deed3SOleg Nesterov { 115763d95a91STejun Heo struct worker_pool *pool = cwq->pool; 1158e1d8aa9fSFrederic Weisbecker 11594690c4abSTejun Heo /* we own @work, set data and link */ 11607a22ad75STejun Heo set_work_cwq(work, cwq, extra_flags); 11614690c4abSTejun Heo 11626e84d644SOleg Nesterov /* 11636e84d644SOleg Nesterov * Ensure that we get the right work->data if we see the 11646e84d644SOleg Nesterov * result of list_add() below, see try_to_grab_pending(). 11656e84d644SOleg Nesterov */ 11666e84d644SOleg Nesterov smp_wmb(); 11674690c4abSTejun Heo 11681a4d9b0aSOleg Nesterov list_add_tail(&work->entry, head); 1169e22bee78STejun Heo 1170e22bee78STejun Heo /* 1171e22bee78STejun Heo * Ensure either worker_sched_deactivated() sees the above 1172e22bee78STejun Heo * list_add_tail() or we see zero nr_running to avoid workers 1173e22bee78STejun Heo * lying around lazily while there are works to be processed. 1174e22bee78STejun Heo */ 1175e22bee78STejun Heo smp_mb(); 1176e22bee78STejun Heo 117763d95a91STejun Heo if (__need_more_worker(pool)) 117863d95a91STejun Heo wake_up_worker(pool); 1179b89deed3SOleg Nesterov } 1180b89deed3SOleg Nesterov 1181c8efcc25STejun Heo /* 1182c8efcc25STejun Heo * Test whether @work is being queued from another work executing on the 1183c8efcc25STejun Heo * same workqueue. This is rather expensive and should only be used from 1184c8efcc25STejun Heo * cold paths. 1185c8efcc25STejun Heo */ 1186c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq) 1187c8efcc25STejun Heo { 1188c8efcc25STejun Heo unsigned long flags; 1189c8efcc25STejun Heo unsigned int cpu; 1190c8efcc25STejun Heo 1191c8efcc25STejun Heo for_each_gcwq_cpu(cpu) { 1192c9e7cf27STejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 1193c9e7cf27STejun Heo struct worker_pool *pool = cwq->pool; 1194c8efcc25STejun Heo struct worker *worker; 1195c8efcc25STejun Heo struct hlist_node *pos; 1196c8efcc25STejun Heo int i; 1197c8efcc25STejun Heo 1198d565ed63STejun Heo spin_lock_irqsave(&pool->lock, flags); 1199c9e7cf27STejun Heo for_each_busy_worker(worker, i, pos, pool) { 1200c8efcc25STejun Heo if (worker->task != current) 1201c8efcc25STejun Heo continue; 1202d565ed63STejun Heo spin_unlock_irqrestore(&pool->lock, flags); 1203c8efcc25STejun Heo /* 1204c8efcc25STejun Heo * I'm @worker, no locking necessary. See if @work 1205c8efcc25STejun Heo * is headed to the same workqueue. 1206c8efcc25STejun Heo */ 1207c8efcc25STejun Heo return worker->current_cwq->wq == wq; 1208c8efcc25STejun Heo } 1209d565ed63STejun Heo spin_unlock_irqrestore(&pool->lock, flags); 1210c8efcc25STejun Heo } 1211c8efcc25STejun Heo return false; 1212c8efcc25STejun Heo } 1213c8efcc25STejun Heo 12144690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq, 12151da177e4SLinus Torvalds struct work_struct *work) 12161da177e4SLinus Torvalds { 1217d565ed63STejun Heo bool highpri = wq->flags & WQ_HIGHPRI; 1218d565ed63STejun Heo struct worker_pool *pool; 1219502ca9d8STejun Heo struct cpu_workqueue_struct *cwq; 12201e19ffc6STejun Heo struct list_head *worklist; 12218a2e8e5dSTejun Heo unsigned int work_flags; 1222b75cac93SJoonsoo Kim unsigned int req_cpu = cpu; 12238930cabaSTejun Heo 12248930cabaSTejun Heo /* 12258930cabaSTejun Heo * While a work item is PENDING && off queue, a task trying to 12268930cabaSTejun Heo * steal the PENDING will busy-loop waiting for it to either get 12278930cabaSTejun Heo * queued or lose PENDING. Grabbing PENDING and queueing should 12288930cabaSTejun Heo * happen with IRQ disabled. 12298930cabaSTejun Heo */ 12308930cabaSTejun Heo WARN_ON_ONCE(!irqs_disabled()); 12311da177e4SLinus Torvalds 1232dc186ad7SThomas Gleixner debug_work_activate(work); 12331e19ffc6STejun Heo 1234c8efcc25STejun Heo /* if dying, only works from the same workqueue are allowed */ 12359c5a2ba7STejun Heo if (unlikely(wq->flags & WQ_DRAINING) && 1236c8efcc25STejun Heo WARN_ON_ONCE(!is_chained_work(wq))) 1237e41e704bSTejun Heo return; 1238e41e704bSTejun Heo 1239d565ed63STejun Heo /* determine pool to use */ 1240c7fc77f7STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 1241c9e7cf27STejun Heo struct worker_pool *last_pool; 1242c7fc77f7STejun Heo 124357469821STejun Heo if (cpu == WORK_CPU_UNBOUND) 1244f3421797STejun Heo cpu = raw_smp_processor_id(); 1245f3421797STejun Heo 124618aa9effSTejun Heo /* 1247dbf2576eSTejun Heo * It's multi cpu. If @work was previously on a different 1248dbf2576eSTejun Heo * cpu, it might still be running there, in which case the 1249dbf2576eSTejun Heo * work needs to be queued on that cpu to guarantee 1250dbf2576eSTejun Heo * non-reentrancy. 125118aa9effSTejun Heo */ 1252d565ed63STejun Heo pool = get_std_worker_pool(cpu, highpri); 1253c9e7cf27STejun Heo last_pool = get_work_pool(work); 1254dbf2576eSTejun Heo 1255d565ed63STejun Heo if (last_pool && last_pool != pool) { 125618aa9effSTejun Heo struct worker *worker; 125718aa9effSTejun Heo 1258d565ed63STejun Heo spin_lock(&last_pool->lock); 125918aa9effSTejun Heo 1260c9e7cf27STejun Heo worker = find_worker_executing_work(last_pool, work); 126118aa9effSTejun Heo 126218aa9effSTejun Heo if (worker && worker->current_cwq->wq == wq) 1263d565ed63STejun Heo pool = last_pool; 126418aa9effSTejun Heo else { 126518aa9effSTejun Heo /* meh... not running there, queue here */ 1266d565ed63STejun Heo spin_unlock(&last_pool->lock); 1267d565ed63STejun Heo spin_lock(&pool->lock); 126818aa9effSTejun Heo } 12698930cabaSTejun Heo } else { 1270d565ed63STejun Heo spin_lock(&pool->lock); 12718930cabaSTejun Heo } 1272f3421797STejun Heo } else { 1273d565ed63STejun Heo pool = get_std_worker_pool(WORK_CPU_UNBOUND, highpri); 1274d565ed63STejun Heo spin_lock(&pool->lock); 1275502ca9d8STejun Heo } 1276502ca9d8STejun Heo 1277d565ed63STejun Heo /* pool determined, get cwq and queue */ 1278d565ed63STejun Heo cwq = get_cwq(pool->cpu, wq); 1279b75cac93SJoonsoo Kim trace_workqueue_queue_work(req_cpu, cwq, work); 1280502ca9d8STejun Heo 1281f5b2552bSDan Carpenter if (WARN_ON(!list_empty(&work->entry))) { 1282d565ed63STejun Heo spin_unlock(&pool->lock); 1283f5b2552bSDan Carpenter return; 1284f5b2552bSDan Carpenter } 12851e19ffc6STejun Heo 128673f53c4aSTejun Heo cwq->nr_in_flight[cwq->work_color]++; 12878a2e8e5dSTejun Heo work_flags = work_color_to_flags(cwq->work_color); 12881e19ffc6STejun Heo 12891e19ffc6STejun Heo if (likely(cwq->nr_active < cwq->max_active)) { 1290cdadf009STejun Heo trace_workqueue_activate_work(work); 12911e19ffc6STejun Heo cwq->nr_active++; 12923270476aSTejun Heo worklist = &cwq->pool->worklist; 12938a2e8e5dSTejun Heo } else { 12948a2e8e5dSTejun Heo work_flags |= WORK_STRUCT_DELAYED; 12951e19ffc6STejun Heo worklist = &cwq->delayed_works; 12968a2e8e5dSTejun Heo } 12971e19ffc6STejun Heo 12988a2e8e5dSTejun Heo insert_work(cwq, work, worklist, work_flags); 12991e19ffc6STejun Heo 1300d565ed63STejun Heo spin_unlock(&pool->lock); 13011da177e4SLinus Torvalds } 13021da177e4SLinus Torvalds 13030fcb78c2SRolf Eike Beer /** 1304c1a220e7SZhang Rui * queue_work_on - queue work on specific cpu 1305c1a220e7SZhang Rui * @cpu: CPU number to execute work on 1306c1a220e7SZhang Rui * @wq: workqueue to use 1307c1a220e7SZhang Rui * @work: work to queue 1308c1a220e7SZhang Rui * 1309d4283e93STejun Heo * Returns %false if @work was already on a queue, %true otherwise. 1310c1a220e7SZhang Rui * 1311c1a220e7SZhang Rui * We queue the work to a specific CPU, the caller must ensure it 1312c1a220e7SZhang Rui * can't go away. 1313c1a220e7SZhang Rui */ 1314d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq, 1315d4283e93STejun Heo struct work_struct *work) 1316c1a220e7SZhang Rui { 1317d4283e93STejun Heo bool ret = false; 13188930cabaSTejun Heo unsigned long flags; 13198930cabaSTejun Heo 13208930cabaSTejun Heo local_irq_save(flags); 1321c1a220e7SZhang Rui 132222df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 13234690c4abSTejun Heo __queue_work(cpu, wq, work); 1324d4283e93STejun Heo ret = true; 1325c1a220e7SZhang Rui } 13268930cabaSTejun Heo 13278930cabaSTejun Heo local_irq_restore(flags); 1328c1a220e7SZhang Rui return ret; 1329c1a220e7SZhang Rui } 1330c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on); 1331c1a220e7SZhang Rui 13320a13c00eSTejun Heo /** 13330a13c00eSTejun Heo * queue_work - queue work on a workqueue 13340a13c00eSTejun Heo * @wq: workqueue to use 13350a13c00eSTejun Heo * @work: work to queue 13360a13c00eSTejun Heo * 1337d4283e93STejun Heo * Returns %false if @work was already on a queue, %true otherwise. 13380a13c00eSTejun Heo * 13390a13c00eSTejun Heo * We queue the work to the CPU on which it was submitted, but if the CPU dies 13400a13c00eSTejun Heo * it can be processed by another CPU. 13410a13c00eSTejun Heo */ 1342d4283e93STejun Heo bool queue_work(struct workqueue_struct *wq, struct work_struct *work) 13430a13c00eSTejun Heo { 134457469821STejun Heo return queue_work_on(WORK_CPU_UNBOUND, wq, work); 13450a13c00eSTejun Heo } 13460a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_work); 13470a13c00eSTejun Heo 1348d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data) 13491da177e4SLinus Torvalds { 135052bad64dSDavid Howells struct delayed_work *dwork = (struct delayed_work *)__data; 13517a22ad75STejun Heo struct cpu_workqueue_struct *cwq = get_work_cwq(&dwork->work); 13521da177e4SLinus Torvalds 1353e0aecdd8STejun Heo /* should have been called from irqsafe timer with irq already off */ 13541265057fSTejun Heo __queue_work(dwork->cpu, cwq->wq, &dwork->work); 13551da177e4SLinus Torvalds } 1356d8e794dfSTejun Heo EXPORT_SYMBOL_GPL(delayed_work_timer_fn); 13571da177e4SLinus Torvalds 13587beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq, 135952bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 13601da177e4SLinus Torvalds { 13617beb2edfSTejun Heo struct timer_list *timer = &dwork->timer; 13627beb2edfSTejun Heo struct work_struct *work = &dwork->work; 13637beb2edfSTejun Heo unsigned int lcpu; 13641da177e4SLinus Torvalds 13657beb2edfSTejun Heo WARN_ON_ONCE(timer->function != delayed_work_timer_fn || 13667beb2edfSTejun Heo timer->data != (unsigned long)dwork); 1367fc4b514fSTejun Heo WARN_ON_ONCE(timer_pending(timer)); 1368fc4b514fSTejun Heo WARN_ON_ONCE(!list_empty(&work->entry)); 13697beb2edfSTejun Heo 13708852aac2STejun Heo /* 13718852aac2STejun Heo * If @delay is 0, queue @dwork->work immediately. This is for 13728852aac2STejun Heo * both optimization and correctness. The earliest @timer can 13738852aac2STejun Heo * expire is on the closest next tick and delayed_work users depend 13748852aac2STejun Heo * on that there's no such delay when @delay is 0. 13758852aac2STejun Heo */ 13768852aac2STejun Heo if (!delay) { 13778852aac2STejun Heo __queue_work(cpu, wq, &dwork->work); 13788852aac2STejun Heo return; 13798852aac2STejun Heo } 13808852aac2STejun Heo 13817beb2edfSTejun Heo timer_stats_timer_set_start_info(&dwork->timer); 13827beb2edfSTejun Heo 13837beb2edfSTejun Heo /* 13847beb2edfSTejun Heo * This stores cwq for the moment, for the timer_fn. Note that the 1385ec22ca5eSTejun Heo * work's pool is preserved to allow reentrance detection for 13867beb2edfSTejun Heo * delayed works. 13877beb2edfSTejun Heo */ 13887beb2edfSTejun Heo if (!(wq->flags & WQ_UNBOUND)) { 1389ec22ca5eSTejun Heo struct worker_pool *pool = get_work_pool(work); 13907beb2edfSTejun Heo 1391e42986deSJoonsoo Kim /* 1392ec22ca5eSTejun Heo * If we cannot get the last pool from @work directly, 1393e42986deSJoonsoo Kim * select the last CPU such that it avoids unnecessarily 1394e42986deSJoonsoo Kim * triggering non-reentrancy check in __queue_work(). 1395e42986deSJoonsoo Kim */ 1396e42986deSJoonsoo Kim lcpu = cpu; 1397ec22ca5eSTejun Heo if (pool) 1398ec22ca5eSTejun Heo lcpu = pool->cpu; 1399e42986deSJoonsoo Kim if (lcpu == WORK_CPU_UNBOUND) 14007beb2edfSTejun Heo lcpu = raw_smp_processor_id(); 14017beb2edfSTejun Heo } else { 14027beb2edfSTejun Heo lcpu = WORK_CPU_UNBOUND; 14031da177e4SLinus Torvalds } 14047beb2edfSTejun Heo 14057beb2edfSTejun Heo set_work_cwq(work, get_cwq(lcpu, wq), 0); 14067beb2edfSTejun Heo 14071265057fSTejun Heo dwork->cpu = cpu; 14087beb2edfSTejun Heo timer->expires = jiffies + delay; 14097beb2edfSTejun Heo 14107beb2edfSTejun Heo if (unlikely(cpu != WORK_CPU_UNBOUND)) 14117beb2edfSTejun Heo add_timer_on(timer, cpu); 14127beb2edfSTejun Heo else 14137beb2edfSTejun Heo add_timer(timer); 14147beb2edfSTejun Heo } 14151da177e4SLinus Torvalds 14160fcb78c2SRolf Eike Beer /** 14170fcb78c2SRolf Eike Beer * queue_delayed_work_on - queue work on specific CPU after delay 14180fcb78c2SRolf Eike Beer * @cpu: CPU number to execute work on 14190fcb78c2SRolf Eike Beer * @wq: workqueue to use 1420af9997e4SRandy Dunlap * @dwork: work to queue 14210fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 14220fcb78c2SRolf Eike Beer * 1423715f1300STejun Heo * Returns %false if @work was already on a queue, %true otherwise. If 1424715f1300STejun Heo * @delay is zero and @dwork is idle, it will be scheduled for immediate 1425715f1300STejun Heo * execution. 14260fcb78c2SRolf Eike Beer */ 1427d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 142852bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 14297a6bc1cdSVenkatesh Pallipadi { 143052bad64dSDavid Howells struct work_struct *work = &dwork->work; 1431d4283e93STejun Heo bool ret = false; 14328930cabaSTejun Heo unsigned long flags; 14338930cabaSTejun Heo 14348930cabaSTejun Heo /* read the comment in __queue_work() */ 14358930cabaSTejun Heo local_irq_save(flags); 14367a6bc1cdSVenkatesh Pallipadi 143722df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 14387beb2edfSTejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 1439d4283e93STejun Heo ret = true; 14407a6bc1cdSVenkatesh Pallipadi } 14418930cabaSTejun Heo 14428930cabaSTejun Heo local_irq_restore(flags); 14437a6bc1cdSVenkatesh Pallipadi return ret; 14447a6bc1cdSVenkatesh Pallipadi } 1445ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on); 14461da177e4SLinus Torvalds 1447c8e55f36STejun Heo /** 14480a13c00eSTejun Heo * queue_delayed_work - queue work on a workqueue after delay 14490a13c00eSTejun Heo * @wq: workqueue to use 14500a13c00eSTejun Heo * @dwork: delayable work to queue 14510a13c00eSTejun Heo * @delay: number of jiffies to wait before queueing 14520a13c00eSTejun Heo * 1453715f1300STejun Heo * Equivalent to queue_delayed_work_on() but tries to use the local CPU. 14540a13c00eSTejun Heo */ 1455d4283e93STejun Heo bool queue_delayed_work(struct workqueue_struct *wq, 14560a13c00eSTejun Heo struct delayed_work *dwork, unsigned long delay) 14570a13c00eSTejun Heo { 145857469821STejun Heo return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay); 14590a13c00eSTejun Heo } 14600a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_delayed_work); 14610a13c00eSTejun Heo 14620a13c00eSTejun Heo /** 14638376fe22STejun Heo * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU 14648376fe22STejun Heo * @cpu: CPU number to execute work on 14658376fe22STejun Heo * @wq: workqueue to use 14668376fe22STejun Heo * @dwork: work to queue 14678376fe22STejun Heo * @delay: number of jiffies to wait before queueing 14688376fe22STejun Heo * 14698376fe22STejun Heo * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise, 14708376fe22STejun Heo * modify @dwork's timer so that it expires after @delay. If @delay is 14718376fe22STejun Heo * zero, @work is guaranteed to be scheduled immediately regardless of its 14728376fe22STejun Heo * current state. 14738376fe22STejun Heo * 14748376fe22STejun Heo * Returns %false if @dwork was idle and queued, %true if @dwork was 14758376fe22STejun Heo * pending and its timer was modified. 14768376fe22STejun Heo * 1477e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 14788376fe22STejun Heo * See try_to_grab_pending() for details. 14798376fe22STejun Heo */ 14808376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, 14818376fe22STejun Heo struct delayed_work *dwork, unsigned long delay) 14828376fe22STejun Heo { 14838376fe22STejun Heo unsigned long flags; 14848376fe22STejun Heo int ret; 14858376fe22STejun Heo 14868376fe22STejun Heo do { 14878376fe22STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 14888376fe22STejun Heo } while (unlikely(ret == -EAGAIN)); 14898376fe22STejun Heo 14908376fe22STejun Heo if (likely(ret >= 0)) { 14918376fe22STejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 14928376fe22STejun Heo local_irq_restore(flags); 14938376fe22STejun Heo } 14948376fe22STejun Heo 14958376fe22STejun Heo /* -ENOENT from try_to_grab_pending() becomes %true */ 14968376fe22STejun Heo return ret; 14978376fe22STejun Heo } 14988376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on); 14998376fe22STejun Heo 15008376fe22STejun Heo /** 15018376fe22STejun Heo * mod_delayed_work - modify delay of or queue a delayed work 15028376fe22STejun Heo * @wq: workqueue to use 15038376fe22STejun Heo * @dwork: work to queue 15048376fe22STejun Heo * @delay: number of jiffies to wait before queueing 15058376fe22STejun Heo * 15068376fe22STejun Heo * mod_delayed_work_on() on local CPU. 15078376fe22STejun Heo */ 15088376fe22STejun Heo bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork, 15098376fe22STejun Heo unsigned long delay) 15108376fe22STejun Heo { 15118376fe22STejun Heo return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay); 15128376fe22STejun Heo } 15138376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work); 15148376fe22STejun Heo 15158376fe22STejun Heo /** 1516c8e55f36STejun Heo * worker_enter_idle - enter idle state 1517c8e55f36STejun Heo * @worker: worker which is entering idle state 1518c8e55f36STejun Heo * 1519c8e55f36STejun Heo * @worker is entering idle state. Update stats and idle timer if 1520c8e55f36STejun Heo * necessary. 1521c8e55f36STejun Heo * 1522c8e55f36STejun Heo * LOCKING: 1523d565ed63STejun Heo * spin_lock_irq(pool->lock). 1524c8e55f36STejun Heo */ 1525c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker) 15261da177e4SLinus Torvalds { 1527bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1528c8e55f36STejun Heo 1529c8e55f36STejun Heo BUG_ON(worker->flags & WORKER_IDLE); 1530c8e55f36STejun Heo BUG_ON(!list_empty(&worker->entry) && 1531c8e55f36STejun Heo (worker->hentry.next || worker->hentry.pprev)); 1532c8e55f36STejun Heo 1533cb444766STejun Heo /* can't use worker_set_flags(), also called from start_worker() */ 1534cb444766STejun Heo worker->flags |= WORKER_IDLE; 1535bd7bdd43STejun Heo pool->nr_idle++; 1536e22bee78STejun Heo worker->last_active = jiffies; 1537c8e55f36STejun Heo 1538c8e55f36STejun Heo /* idle_list is LIFO */ 1539bd7bdd43STejun Heo list_add(&worker->entry, &pool->idle_list); 1540db7bccf4STejun Heo 154163d95a91STejun Heo if (too_many_workers(pool) && !timer_pending(&pool->idle_timer)) 1542628c78e7STejun Heo mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT); 1543cb444766STejun Heo 1544544ecf31STejun Heo /* 1545628c78e7STejun Heo * Sanity check nr_running. Because gcwq_unbind_fn() releases 1546d565ed63STejun Heo * pool->lock between setting %WORKER_UNBOUND and zapping 1547628c78e7STejun Heo * nr_running, the warning may trigger spuriously. Check iff 1548628c78e7STejun Heo * unbind is not in progress. 1549544ecf31STejun Heo */ 155024647570STejun Heo WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 1551bd7bdd43STejun Heo pool->nr_workers == pool->nr_idle && 155263d95a91STejun Heo atomic_read(get_pool_nr_running(pool))); 1553c8e55f36STejun Heo } 1554c8e55f36STejun Heo 1555c8e55f36STejun Heo /** 1556c8e55f36STejun Heo * worker_leave_idle - leave idle state 1557c8e55f36STejun Heo * @worker: worker which is leaving idle state 1558c8e55f36STejun Heo * 1559c8e55f36STejun Heo * @worker is leaving idle state. Update stats. 1560c8e55f36STejun Heo * 1561c8e55f36STejun Heo * LOCKING: 1562d565ed63STejun Heo * spin_lock_irq(pool->lock). 1563c8e55f36STejun Heo */ 1564c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker) 1565c8e55f36STejun Heo { 1566bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1567c8e55f36STejun Heo 1568c8e55f36STejun Heo BUG_ON(!(worker->flags & WORKER_IDLE)); 1569d302f017STejun Heo worker_clr_flags(worker, WORKER_IDLE); 1570bd7bdd43STejun Heo pool->nr_idle--; 1571c8e55f36STejun Heo list_del_init(&worker->entry); 1572c8e55f36STejun Heo } 1573c8e55f36STejun Heo 1574e22bee78STejun Heo /** 1575e22bee78STejun Heo * worker_maybe_bind_and_lock - bind worker to its cpu if possible and lock gcwq 1576e22bee78STejun Heo * @worker: self 1577e22bee78STejun Heo * 1578e22bee78STejun Heo * Works which are scheduled while the cpu is online must at least be 1579e22bee78STejun Heo * scheduled to a worker which is bound to the cpu so that if they are 1580e22bee78STejun Heo * flushed from cpu callbacks while cpu is going down, they are 1581e22bee78STejun Heo * guaranteed to execute on the cpu. 1582e22bee78STejun Heo * 1583e22bee78STejun Heo * This function is to be used by rogue workers and rescuers to bind 1584e22bee78STejun Heo * themselves to the target cpu and may race with cpu going down or 1585e22bee78STejun Heo * coming online. kthread_bind() can't be used because it may put the 1586e22bee78STejun Heo * worker to already dead cpu and set_cpus_allowed_ptr() can't be used 1587e22bee78STejun Heo * verbatim as it's best effort and blocking and gcwq may be 1588e22bee78STejun Heo * [dis]associated in the meantime. 1589e22bee78STejun Heo * 1590f2d5a0eeSTejun Heo * This function tries set_cpus_allowed() and locks gcwq and verifies the 159124647570STejun Heo * binding against %POOL_DISASSOCIATED which is set during 1592f2d5a0eeSTejun Heo * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker 1593f2d5a0eeSTejun Heo * enters idle state or fetches works without dropping lock, it can 1594f2d5a0eeSTejun Heo * guarantee the scheduling requirement described in the first paragraph. 1595e22bee78STejun Heo * 1596e22bee78STejun Heo * CONTEXT: 1597d565ed63STejun Heo * Might sleep. Called without any lock but returns with pool->lock 1598e22bee78STejun Heo * held. 1599e22bee78STejun Heo * 1600e22bee78STejun Heo * RETURNS: 1601e22bee78STejun Heo * %true if the associated gcwq is online (@worker is successfully 1602e22bee78STejun Heo * bound), %false if offline. 1603e22bee78STejun Heo */ 1604e22bee78STejun Heo static bool worker_maybe_bind_and_lock(struct worker *worker) 1605d565ed63STejun Heo __acquires(&pool->lock) 1606e22bee78STejun Heo { 160724647570STejun Heo struct worker_pool *pool = worker->pool; 1608e22bee78STejun Heo struct task_struct *task = worker->task; 1609e22bee78STejun Heo 1610e22bee78STejun Heo while (true) { 1611e22bee78STejun Heo /* 1612e22bee78STejun Heo * The following call may fail, succeed or succeed 1613e22bee78STejun Heo * without actually migrating the task to the cpu if 1614e22bee78STejun Heo * it races with cpu hotunplug operation. Verify 161524647570STejun Heo * against POOL_DISASSOCIATED. 1616e22bee78STejun Heo */ 161724647570STejun Heo if (!(pool->flags & POOL_DISASSOCIATED)) 1618ec22ca5eSTejun Heo set_cpus_allowed_ptr(task, get_cpu_mask(pool->cpu)); 1619e22bee78STejun Heo 1620d565ed63STejun Heo spin_lock_irq(&pool->lock); 162124647570STejun Heo if (pool->flags & POOL_DISASSOCIATED) 1622e22bee78STejun Heo return false; 1623ec22ca5eSTejun Heo if (task_cpu(task) == pool->cpu && 1624e22bee78STejun Heo cpumask_equal(¤t->cpus_allowed, 1625ec22ca5eSTejun Heo get_cpu_mask(pool->cpu))) 1626e22bee78STejun Heo return true; 1627d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1628e22bee78STejun Heo 16295035b20fSTejun Heo /* 16305035b20fSTejun Heo * We've raced with CPU hot[un]plug. Give it a breather 16315035b20fSTejun Heo * and retry migration. cond_resched() is required here; 16325035b20fSTejun Heo * otherwise, we might deadlock against cpu_stop trying to 16335035b20fSTejun Heo * bring down the CPU on non-preemptive kernel. 16345035b20fSTejun Heo */ 1635e22bee78STejun Heo cpu_relax(); 16365035b20fSTejun Heo cond_resched(); 1637e22bee78STejun Heo } 1638e22bee78STejun Heo } 1639e22bee78STejun Heo 1640e22bee78STejun Heo /* 1641ea1abd61SLai Jiangshan * Rebind an idle @worker to its CPU. worker_thread() will test 16425f7dabfdSLai Jiangshan * list_empty(@worker->entry) before leaving idle and call this function. 164325511a47STejun Heo */ 164425511a47STejun Heo static void idle_worker_rebind(struct worker *worker) 164525511a47STejun Heo { 16465f7dabfdSLai Jiangshan /* CPU may go down again inbetween, clear UNBOUND only on success */ 16475f7dabfdSLai Jiangshan if (worker_maybe_bind_and_lock(worker)) 16485f7dabfdSLai Jiangshan worker_clr_flags(worker, WORKER_UNBOUND); 164925511a47STejun Heo 1650ea1abd61SLai Jiangshan /* rebind complete, become available again */ 1651ea1abd61SLai Jiangshan list_add(&worker->entry, &worker->pool->idle_list); 1652d565ed63STejun Heo spin_unlock_irq(&worker->pool->lock); 165325511a47STejun Heo } 165425511a47STejun Heo 165525511a47STejun Heo /* 165625511a47STejun Heo * Function for @worker->rebind.work used to rebind unbound busy workers to 1657403c821dSTejun Heo * the associated cpu which is coming back online. This is scheduled by 1658403c821dSTejun Heo * cpu up but can race with other cpu hotplug operations and may be 1659403c821dSTejun Heo * executed twice without intervening cpu down. 1660e22bee78STejun Heo */ 166125511a47STejun Heo static void busy_worker_rebind_fn(struct work_struct *work) 1662e22bee78STejun Heo { 1663e22bee78STejun Heo struct worker *worker = container_of(work, struct worker, rebind_work); 1664e22bee78STejun Heo 1665eab6d828SLai Jiangshan if (worker_maybe_bind_and_lock(worker)) 1666eab6d828SLai Jiangshan worker_clr_flags(worker, WORKER_UNBOUND); 1667e22bee78STejun Heo 1668d565ed63STejun Heo spin_unlock_irq(&worker->pool->lock); 1669e22bee78STejun Heo } 1670e22bee78STejun Heo 167125511a47STejun Heo /** 167294cf58bbSTejun Heo * rebind_workers - rebind all workers of a pool to the associated CPU 167394cf58bbSTejun Heo * @pool: pool of interest 167425511a47STejun Heo * 167594cf58bbSTejun Heo * @pool->cpu is coming online. Rebind all workers to the CPU. Rebinding 167625511a47STejun Heo * is different for idle and busy ones. 167725511a47STejun Heo * 1678ea1abd61SLai Jiangshan * Idle ones will be removed from the idle_list and woken up. They will 1679ea1abd61SLai Jiangshan * add themselves back after completing rebind. This ensures that the 1680ea1abd61SLai Jiangshan * idle_list doesn't contain any unbound workers when re-bound busy workers 1681ea1abd61SLai Jiangshan * try to perform local wake-ups for concurrency management. 168225511a47STejun Heo * 1683ea1abd61SLai Jiangshan * Busy workers can rebind after they finish their current work items. 1684ea1abd61SLai Jiangshan * Queueing the rebind work item at the head of the scheduled list is 1685ea1abd61SLai Jiangshan * enough. Note that nr_running will be properly bumped as busy workers 1686ea1abd61SLai Jiangshan * rebind. 168725511a47STejun Heo * 1688ea1abd61SLai Jiangshan * On return, all non-manager workers are scheduled for rebind - see 1689ea1abd61SLai Jiangshan * manage_workers() for the manager special case. Any idle worker 1690ea1abd61SLai Jiangshan * including the manager will not appear on @idle_list until rebind is 1691ea1abd61SLai Jiangshan * complete, making local wake-ups safe. 169225511a47STejun Heo */ 169394cf58bbSTejun Heo static void rebind_workers(struct worker_pool *pool) 169425511a47STejun Heo { 1695ea1abd61SLai Jiangshan struct worker *worker, *n; 169625511a47STejun Heo struct hlist_node *pos; 169725511a47STejun Heo int i; 169825511a47STejun Heo 1699b2eb83d1SLai Jiangshan lockdep_assert_held(&pool->assoc_mutex); 1700d565ed63STejun Heo lockdep_assert_held(&pool->lock); 170125511a47STejun Heo 17025f7dabfdSLai Jiangshan /* dequeue and kick idle ones */ 1703ea1abd61SLai Jiangshan list_for_each_entry_safe(worker, n, &pool->idle_list, entry) { 1704ea1abd61SLai Jiangshan /* 170594cf58bbSTejun Heo * idle workers should be off @pool->idle_list until rebind 170694cf58bbSTejun Heo * is complete to avoid receiving premature local wake-ups. 1707ea1abd61SLai Jiangshan */ 1708ea1abd61SLai Jiangshan list_del_init(&worker->entry); 170925511a47STejun Heo 171025511a47STejun Heo /* 171194cf58bbSTejun Heo * worker_thread() will see the above dequeuing and call 171294cf58bbSTejun Heo * idle_worker_rebind(). 171325511a47STejun Heo */ 171425511a47STejun Heo wake_up_process(worker->task); 171525511a47STejun Heo } 171625511a47STejun Heo 1717ea1abd61SLai Jiangshan /* rebind busy workers */ 1718c9e7cf27STejun Heo for_each_busy_worker(worker, i, pos, pool) { 171925511a47STejun Heo struct work_struct *rebind_work = &worker->rebind_work; 1720e2b6a6d5SJoonsoo Kim struct workqueue_struct *wq; 172125511a47STejun Heo 172225511a47STejun Heo if (test_and_set_bit(WORK_STRUCT_PENDING_BIT, 172325511a47STejun Heo work_data_bits(rebind_work))) 172425511a47STejun Heo continue; 172525511a47STejun Heo 172625511a47STejun Heo debug_work_activate(rebind_work); 172790beca5dSTejun Heo 172890beca5dSTejun Heo /* 172994cf58bbSTejun Heo * wq doesn't really matter but let's keep @worker->pool 173094cf58bbSTejun Heo * and @cwq->pool consistent for sanity. 173190beca5dSTejun Heo */ 1732e34cdddbSTejun Heo if (std_worker_pool_pri(worker->pool)) 1733e2b6a6d5SJoonsoo Kim wq = system_highpri_wq; 1734e2b6a6d5SJoonsoo Kim else 1735e2b6a6d5SJoonsoo Kim wq = system_wq; 1736ec58815aSTejun Heo 1737ec22ca5eSTejun Heo insert_work(get_cwq(pool->cpu, wq), rebind_work, 173825511a47STejun Heo worker->scheduled.next, 173925511a47STejun Heo work_color_to_flags(WORK_NO_COLOR)); 1740ec58815aSTejun Heo } 174125511a47STejun Heo } 174225511a47STejun Heo 1743c34056a3STejun Heo static struct worker *alloc_worker(void) 1744c34056a3STejun Heo { 1745c34056a3STejun Heo struct worker *worker; 1746c34056a3STejun Heo 1747c34056a3STejun Heo worker = kzalloc(sizeof(*worker), GFP_KERNEL); 1748c8e55f36STejun Heo if (worker) { 1749c8e55f36STejun Heo INIT_LIST_HEAD(&worker->entry); 1750affee4b2STejun Heo INIT_LIST_HEAD(&worker->scheduled); 175125511a47STejun Heo INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn); 1752e22bee78STejun Heo /* on creation a worker is in !idle && prep state */ 1753e22bee78STejun Heo worker->flags = WORKER_PREP; 1754c8e55f36STejun Heo } 1755c34056a3STejun Heo return worker; 1756c34056a3STejun Heo } 1757c34056a3STejun Heo 1758c34056a3STejun Heo /** 1759c34056a3STejun Heo * create_worker - create a new workqueue worker 176063d95a91STejun Heo * @pool: pool the new worker will belong to 1761c34056a3STejun Heo * 176263d95a91STejun Heo * Create a new worker which is bound to @pool. The returned worker 1763c34056a3STejun Heo * can be started by calling start_worker() or destroyed using 1764c34056a3STejun Heo * destroy_worker(). 1765c34056a3STejun Heo * 1766c34056a3STejun Heo * CONTEXT: 1767c34056a3STejun Heo * Might sleep. Does GFP_KERNEL allocations. 1768c34056a3STejun Heo * 1769c34056a3STejun Heo * RETURNS: 1770c34056a3STejun Heo * Pointer to the newly created worker. 1771c34056a3STejun Heo */ 1772bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool) 1773c34056a3STejun Heo { 1774e34cdddbSTejun Heo const char *pri = std_worker_pool_pri(pool) ? "H" : ""; 1775c34056a3STejun Heo struct worker *worker = NULL; 1776f3421797STejun Heo int id = -1; 1777c34056a3STejun Heo 1778d565ed63STejun Heo spin_lock_irq(&pool->lock); 1779bd7bdd43STejun Heo while (ida_get_new(&pool->worker_ida, &id)) { 1780d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1781bd7bdd43STejun Heo if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL)) 1782c34056a3STejun Heo goto fail; 1783d565ed63STejun Heo spin_lock_irq(&pool->lock); 1784c34056a3STejun Heo } 1785d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1786c34056a3STejun Heo 1787c34056a3STejun Heo worker = alloc_worker(); 1788c34056a3STejun Heo if (!worker) 1789c34056a3STejun Heo goto fail; 1790c34056a3STejun Heo 1791bd7bdd43STejun Heo worker->pool = pool; 1792c34056a3STejun Heo worker->id = id; 1793c34056a3STejun Heo 1794ec22ca5eSTejun Heo if (pool->cpu != WORK_CPU_UNBOUND) 179594dcf29aSEric Dumazet worker->task = kthread_create_on_node(worker_thread, 1796ec22ca5eSTejun Heo worker, cpu_to_node(pool->cpu), 1797ec22ca5eSTejun Heo "kworker/%u:%d%s", pool->cpu, id, pri); 1798f3421797STejun Heo else 1799f3421797STejun Heo worker->task = kthread_create(worker_thread, worker, 18003270476aSTejun Heo "kworker/u:%d%s", id, pri); 1801c34056a3STejun Heo if (IS_ERR(worker->task)) 1802c34056a3STejun Heo goto fail; 1803c34056a3STejun Heo 1804e34cdddbSTejun Heo if (std_worker_pool_pri(pool)) 18053270476aSTejun Heo set_user_nice(worker->task, HIGHPRI_NICE_LEVEL); 18063270476aSTejun Heo 1807db7bccf4STejun Heo /* 1808bc2ae0f5STejun Heo * Determine CPU binding of the new worker depending on 180924647570STejun Heo * %POOL_DISASSOCIATED. The caller is responsible for ensuring the 1810bc2ae0f5STejun Heo * flag remains stable across this function. See the comments 1811bc2ae0f5STejun Heo * above the flag definition for details. 1812bc2ae0f5STejun Heo * 1813bc2ae0f5STejun Heo * As an unbound worker may later become a regular one if CPU comes 1814bc2ae0f5STejun Heo * online, make sure every worker has %PF_THREAD_BOUND set. 1815db7bccf4STejun Heo */ 181624647570STejun Heo if (!(pool->flags & POOL_DISASSOCIATED)) { 1817ec22ca5eSTejun Heo kthread_bind(worker->task, pool->cpu); 1818bc2ae0f5STejun Heo } else { 1819db7bccf4STejun Heo worker->task->flags |= PF_THREAD_BOUND; 1820f3421797STejun Heo worker->flags |= WORKER_UNBOUND; 1821f3421797STejun Heo } 1822c34056a3STejun Heo 1823c34056a3STejun Heo return worker; 1824c34056a3STejun Heo fail: 1825c34056a3STejun Heo if (id >= 0) { 1826d565ed63STejun Heo spin_lock_irq(&pool->lock); 1827bd7bdd43STejun Heo ida_remove(&pool->worker_ida, id); 1828d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1829c34056a3STejun Heo } 1830c34056a3STejun Heo kfree(worker); 1831c34056a3STejun Heo return NULL; 1832c34056a3STejun Heo } 1833c34056a3STejun Heo 1834c34056a3STejun Heo /** 1835c34056a3STejun Heo * start_worker - start a newly created worker 1836c34056a3STejun Heo * @worker: worker to start 1837c34056a3STejun Heo * 1838c8e55f36STejun Heo * Make the gcwq aware of @worker and start it. 1839c34056a3STejun Heo * 1840c34056a3STejun Heo * CONTEXT: 1841d565ed63STejun Heo * spin_lock_irq(pool->lock). 1842c34056a3STejun Heo */ 1843c34056a3STejun Heo static void start_worker(struct worker *worker) 1844c34056a3STejun Heo { 1845cb444766STejun Heo worker->flags |= WORKER_STARTED; 1846bd7bdd43STejun Heo worker->pool->nr_workers++; 1847c8e55f36STejun Heo worker_enter_idle(worker); 1848c34056a3STejun Heo wake_up_process(worker->task); 1849c34056a3STejun Heo } 1850c34056a3STejun Heo 1851c34056a3STejun Heo /** 1852c34056a3STejun Heo * destroy_worker - destroy a workqueue worker 1853c34056a3STejun Heo * @worker: worker to be destroyed 1854c34056a3STejun Heo * 1855c8e55f36STejun Heo * Destroy @worker and adjust @gcwq stats accordingly. 1856c8e55f36STejun Heo * 1857c8e55f36STejun Heo * CONTEXT: 1858d565ed63STejun Heo * spin_lock_irq(pool->lock) which is released and regrabbed. 1859c34056a3STejun Heo */ 1860c34056a3STejun Heo static void destroy_worker(struct worker *worker) 1861c34056a3STejun Heo { 1862bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1863c34056a3STejun Heo int id = worker->id; 1864c34056a3STejun Heo 1865c34056a3STejun Heo /* sanity check frenzy */ 1866c34056a3STejun Heo BUG_ON(worker->current_work); 1867affee4b2STejun Heo BUG_ON(!list_empty(&worker->scheduled)); 1868c34056a3STejun Heo 1869c8e55f36STejun Heo if (worker->flags & WORKER_STARTED) 1870bd7bdd43STejun Heo pool->nr_workers--; 1871c8e55f36STejun Heo if (worker->flags & WORKER_IDLE) 1872bd7bdd43STejun Heo pool->nr_idle--; 1873c8e55f36STejun Heo 1874c8e55f36STejun Heo list_del_init(&worker->entry); 1875cb444766STejun Heo worker->flags |= WORKER_DIE; 1876c8e55f36STejun Heo 1877d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1878c8e55f36STejun Heo 1879c34056a3STejun Heo kthread_stop(worker->task); 1880c34056a3STejun Heo kfree(worker); 1881c34056a3STejun Heo 1882d565ed63STejun Heo spin_lock_irq(&pool->lock); 1883bd7bdd43STejun Heo ida_remove(&pool->worker_ida, id); 1884c34056a3STejun Heo } 1885c34056a3STejun Heo 188663d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool) 1887e22bee78STejun Heo { 188863d95a91STejun Heo struct worker_pool *pool = (void *)__pool; 1889e22bee78STejun Heo 1890d565ed63STejun Heo spin_lock_irq(&pool->lock); 1891e22bee78STejun Heo 189263d95a91STejun Heo if (too_many_workers(pool)) { 1893e22bee78STejun Heo struct worker *worker; 1894e22bee78STejun Heo unsigned long expires; 1895e22bee78STejun Heo 1896e22bee78STejun Heo /* idle_list is kept in LIFO order, check the last one */ 189763d95a91STejun Heo worker = list_entry(pool->idle_list.prev, struct worker, entry); 1898e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 1899e22bee78STejun Heo 1900e22bee78STejun Heo if (time_before(jiffies, expires)) 190163d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 1902e22bee78STejun Heo else { 1903e22bee78STejun Heo /* it's been idle for too long, wake up manager */ 190411ebea50STejun Heo pool->flags |= POOL_MANAGE_WORKERS; 190563d95a91STejun Heo wake_up_worker(pool); 1906e22bee78STejun Heo } 1907e22bee78STejun Heo } 1908e22bee78STejun Heo 1909d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1910e22bee78STejun Heo } 1911e22bee78STejun Heo 1912e22bee78STejun Heo static bool send_mayday(struct work_struct *work) 1913e22bee78STejun Heo { 1914e22bee78STejun Heo struct cpu_workqueue_struct *cwq = get_work_cwq(work); 1915e22bee78STejun Heo struct workqueue_struct *wq = cwq->wq; 1916f3421797STejun Heo unsigned int cpu; 1917e22bee78STejun Heo 1918e22bee78STejun Heo if (!(wq->flags & WQ_RESCUER)) 1919e22bee78STejun Heo return false; 1920e22bee78STejun Heo 1921e22bee78STejun Heo /* mayday mayday mayday */ 1922ec22ca5eSTejun Heo cpu = cwq->pool->cpu; 1923f3421797STejun Heo /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */ 1924f3421797STejun Heo if (cpu == WORK_CPU_UNBOUND) 1925f3421797STejun Heo cpu = 0; 1926f2e005aaSTejun Heo if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask)) 1927e22bee78STejun Heo wake_up_process(wq->rescuer->task); 1928e22bee78STejun Heo return true; 1929e22bee78STejun Heo } 1930e22bee78STejun Heo 193163d95a91STejun Heo static void gcwq_mayday_timeout(unsigned long __pool) 1932e22bee78STejun Heo { 193363d95a91STejun Heo struct worker_pool *pool = (void *)__pool; 1934e22bee78STejun Heo struct work_struct *work; 1935e22bee78STejun Heo 1936d565ed63STejun Heo spin_lock_irq(&pool->lock); 1937e22bee78STejun Heo 193863d95a91STejun Heo if (need_to_create_worker(pool)) { 1939e22bee78STejun Heo /* 1940e22bee78STejun Heo * We've been trying to create a new worker but 1941e22bee78STejun Heo * haven't been successful. We might be hitting an 1942e22bee78STejun Heo * allocation deadlock. Send distress signals to 1943e22bee78STejun Heo * rescuers. 1944e22bee78STejun Heo */ 194563d95a91STejun Heo list_for_each_entry(work, &pool->worklist, entry) 1946e22bee78STejun Heo send_mayday(work); 1947e22bee78STejun Heo } 1948e22bee78STejun Heo 1949d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1950e22bee78STejun Heo 195163d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL); 1952e22bee78STejun Heo } 1953e22bee78STejun Heo 1954e22bee78STejun Heo /** 1955e22bee78STejun Heo * maybe_create_worker - create a new worker if necessary 195663d95a91STejun Heo * @pool: pool to create a new worker for 1957e22bee78STejun Heo * 195863d95a91STejun Heo * Create a new worker for @pool if necessary. @pool is guaranteed to 1959e22bee78STejun Heo * have at least one idle worker on return from this function. If 1960e22bee78STejun Heo * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is 196163d95a91STejun Heo * sent to all rescuers with works scheduled on @pool to resolve 1962e22bee78STejun Heo * possible allocation deadlock. 1963e22bee78STejun Heo * 1964e22bee78STejun Heo * On return, need_to_create_worker() is guaranteed to be false and 1965e22bee78STejun Heo * may_start_working() true. 1966e22bee78STejun Heo * 1967e22bee78STejun Heo * LOCKING: 1968d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 1969e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. Called only from 1970e22bee78STejun Heo * manager. 1971e22bee78STejun Heo * 1972e22bee78STejun Heo * RETURNS: 1973d565ed63STejun Heo * false if no action was taken and pool->lock stayed locked, true 1974e22bee78STejun Heo * otherwise. 1975e22bee78STejun Heo */ 197663d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool) 1977d565ed63STejun Heo __releases(&pool->lock) 1978d565ed63STejun Heo __acquires(&pool->lock) 1979e22bee78STejun Heo { 198063d95a91STejun Heo if (!need_to_create_worker(pool)) 1981e22bee78STejun Heo return false; 1982e22bee78STejun Heo restart: 1983d565ed63STejun Heo spin_unlock_irq(&pool->lock); 19849f9c2364STejun Heo 1985e22bee78STejun Heo /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ 198663d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); 1987e22bee78STejun Heo 1988e22bee78STejun Heo while (true) { 1989e22bee78STejun Heo struct worker *worker; 1990e22bee78STejun Heo 1991bc2ae0f5STejun Heo worker = create_worker(pool); 1992e22bee78STejun Heo if (worker) { 199363d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 1994d565ed63STejun Heo spin_lock_irq(&pool->lock); 1995e22bee78STejun Heo start_worker(worker); 199663d95a91STejun Heo BUG_ON(need_to_create_worker(pool)); 1997e22bee78STejun Heo return true; 1998e22bee78STejun Heo } 1999e22bee78STejun Heo 200063d95a91STejun Heo if (!need_to_create_worker(pool)) 2001e22bee78STejun Heo break; 2002e22bee78STejun Heo 2003e22bee78STejun Heo __set_current_state(TASK_INTERRUPTIBLE); 2004e22bee78STejun Heo schedule_timeout(CREATE_COOLDOWN); 20059f9c2364STejun Heo 200663d95a91STejun Heo if (!need_to_create_worker(pool)) 2007e22bee78STejun Heo break; 2008e22bee78STejun Heo } 2009e22bee78STejun Heo 201063d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 2011d565ed63STejun Heo spin_lock_irq(&pool->lock); 201263d95a91STejun Heo if (need_to_create_worker(pool)) 2013e22bee78STejun Heo goto restart; 2014e22bee78STejun Heo return true; 2015e22bee78STejun Heo } 2016e22bee78STejun Heo 2017e22bee78STejun Heo /** 2018e22bee78STejun Heo * maybe_destroy_worker - destroy workers which have been idle for a while 201963d95a91STejun Heo * @pool: pool to destroy workers for 2020e22bee78STejun Heo * 202163d95a91STejun Heo * Destroy @pool workers which have been idle for longer than 2022e22bee78STejun Heo * IDLE_WORKER_TIMEOUT. 2023e22bee78STejun Heo * 2024e22bee78STejun Heo * LOCKING: 2025d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2026e22bee78STejun Heo * multiple times. Called only from manager. 2027e22bee78STejun Heo * 2028e22bee78STejun Heo * RETURNS: 2029d565ed63STejun Heo * false if no action was taken and pool->lock stayed locked, true 2030e22bee78STejun Heo * otherwise. 2031e22bee78STejun Heo */ 203263d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool) 2033e22bee78STejun Heo { 2034e22bee78STejun Heo bool ret = false; 2035e22bee78STejun Heo 203663d95a91STejun Heo while (too_many_workers(pool)) { 2037e22bee78STejun Heo struct worker *worker; 2038e22bee78STejun Heo unsigned long expires; 2039e22bee78STejun Heo 204063d95a91STejun Heo worker = list_entry(pool->idle_list.prev, struct worker, entry); 2041e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 2042e22bee78STejun Heo 2043e22bee78STejun Heo if (time_before(jiffies, expires)) { 204463d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 2045e22bee78STejun Heo break; 2046e22bee78STejun Heo } 2047e22bee78STejun Heo 2048e22bee78STejun Heo destroy_worker(worker); 2049e22bee78STejun Heo ret = true; 2050e22bee78STejun Heo } 2051e22bee78STejun Heo 2052e22bee78STejun Heo return ret; 2053e22bee78STejun Heo } 2054e22bee78STejun Heo 2055e22bee78STejun Heo /** 2056e22bee78STejun Heo * manage_workers - manage worker pool 2057e22bee78STejun Heo * @worker: self 2058e22bee78STejun Heo * 2059e22bee78STejun Heo * Assume the manager role and manage gcwq worker pool @worker belongs 2060e22bee78STejun Heo * to. At any given time, there can be only zero or one manager per 2061e22bee78STejun Heo * gcwq. The exclusion is handled automatically by this function. 2062e22bee78STejun Heo * 2063e22bee78STejun Heo * The caller can safely start processing works on false return. On 2064e22bee78STejun Heo * true return, it's guaranteed that need_to_create_worker() is false 2065e22bee78STejun Heo * and may_start_working() is true. 2066e22bee78STejun Heo * 2067e22bee78STejun Heo * CONTEXT: 2068d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2069e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. 2070e22bee78STejun Heo * 2071e22bee78STejun Heo * RETURNS: 2072d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2073d565ed63STejun Heo * multiple times. Does GFP_KERNEL allocations. 2074e22bee78STejun Heo */ 2075e22bee78STejun Heo static bool manage_workers(struct worker *worker) 2076e22bee78STejun Heo { 207763d95a91STejun Heo struct worker_pool *pool = worker->pool; 2078e22bee78STejun Heo bool ret = false; 2079e22bee78STejun Heo 2080ee378aa4SLai Jiangshan if (pool->flags & POOL_MANAGING_WORKERS) 2081e22bee78STejun Heo return ret; 2082e22bee78STejun Heo 2083552a37e9SLai Jiangshan pool->flags |= POOL_MANAGING_WORKERS; 2084ee378aa4SLai Jiangshan 2085ee378aa4SLai Jiangshan /* 2086ee378aa4SLai Jiangshan * To simplify both worker management and CPU hotplug, hold off 2087ee378aa4SLai Jiangshan * management while hotplug is in progress. CPU hotplug path can't 2088ee378aa4SLai Jiangshan * grab %POOL_MANAGING_WORKERS to achieve this because that can 2089ee378aa4SLai Jiangshan * lead to idle worker depletion (all become busy thinking someone 2090ee378aa4SLai Jiangshan * else is managing) which in turn can result in deadlock under 2091b2eb83d1SLai Jiangshan * extreme circumstances. Use @pool->assoc_mutex to synchronize 2092ee378aa4SLai Jiangshan * manager against CPU hotplug. 2093ee378aa4SLai Jiangshan * 2094b2eb83d1SLai Jiangshan * assoc_mutex would always be free unless CPU hotplug is in 2095d565ed63STejun Heo * progress. trylock first without dropping @pool->lock. 2096ee378aa4SLai Jiangshan */ 2097b2eb83d1SLai Jiangshan if (unlikely(!mutex_trylock(&pool->assoc_mutex))) { 2098d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2099b2eb83d1SLai Jiangshan mutex_lock(&pool->assoc_mutex); 2100ee378aa4SLai Jiangshan /* 2101ee378aa4SLai Jiangshan * CPU hotplug could have happened while we were waiting 2102b2eb83d1SLai Jiangshan * for assoc_mutex. Hotplug itself can't handle us 2103ee378aa4SLai Jiangshan * because manager isn't either on idle or busy list, and 2104ee378aa4SLai Jiangshan * @gcwq's state and ours could have deviated. 2105ee378aa4SLai Jiangshan * 2106b2eb83d1SLai Jiangshan * As hotplug is now excluded via assoc_mutex, we can 2107ee378aa4SLai Jiangshan * simply try to bind. It will succeed or fail depending 2108ee378aa4SLai Jiangshan * on @gcwq's current state. Try it and adjust 2109ee378aa4SLai Jiangshan * %WORKER_UNBOUND accordingly. 2110ee378aa4SLai Jiangshan */ 2111ee378aa4SLai Jiangshan if (worker_maybe_bind_and_lock(worker)) 2112ee378aa4SLai Jiangshan worker->flags &= ~WORKER_UNBOUND; 2113ee378aa4SLai Jiangshan else 2114ee378aa4SLai Jiangshan worker->flags |= WORKER_UNBOUND; 2115ee378aa4SLai Jiangshan 2116ee378aa4SLai Jiangshan ret = true; 2117ee378aa4SLai Jiangshan } 2118ee378aa4SLai Jiangshan 211911ebea50STejun Heo pool->flags &= ~POOL_MANAGE_WORKERS; 2120e22bee78STejun Heo 2121e22bee78STejun Heo /* 2122e22bee78STejun Heo * Destroy and then create so that may_start_working() is true 2123e22bee78STejun Heo * on return. 2124e22bee78STejun Heo */ 212563d95a91STejun Heo ret |= maybe_destroy_workers(pool); 212663d95a91STejun Heo ret |= maybe_create_worker(pool); 2127e22bee78STejun Heo 2128552a37e9SLai Jiangshan pool->flags &= ~POOL_MANAGING_WORKERS; 2129b2eb83d1SLai Jiangshan mutex_unlock(&pool->assoc_mutex); 2130e22bee78STejun Heo return ret; 2131e22bee78STejun Heo } 2132e22bee78STejun Heo 2133a62428c0STejun Heo /** 2134a62428c0STejun Heo * process_one_work - process single work 2135c34056a3STejun Heo * @worker: self 2136a62428c0STejun Heo * @work: work to process 2137a62428c0STejun Heo * 2138a62428c0STejun Heo * Process @work. This function contains all the logics necessary to 2139a62428c0STejun Heo * process a single work including synchronization against and 2140a62428c0STejun Heo * interaction with other workers on the same cpu, queueing and 2141a62428c0STejun Heo * flushing. As long as context requirement is met, any worker can 2142a62428c0STejun Heo * call this function to process a work. 2143a62428c0STejun Heo * 2144a62428c0STejun Heo * CONTEXT: 2145d565ed63STejun Heo * spin_lock_irq(pool->lock) which is released and regrabbed. 2146a62428c0STejun Heo */ 2147c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work) 2148d565ed63STejun Heo __releases(&pool->lock) 2149d565ed63STejun Heo __acquires(&pool->lock) 21501da177e4SLinus Torvalds { 21517e11629dSTejun Heo struct cpu_workqueue_struct *cwq = get_work_cwq(work); 2152bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 2153fb0e7bebSTejun Heo bool cpu_intensive = cwq->wq->flags & WQ_CPU_INTENSIVE; 215473f53c4aSTejun Heo int work_color; 21557e11629dSTejun Heo struct worker *collision; 21564e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 21574e6045f1SJohannes Berg /* 2158a62428c0STejun Heo * It is permissible to free the struct work_struct from 2159a62428c0STejun Heo * inside the function that is called from it, this we need to 2160a62428c0STejun Heo * take into account for lockdep too. To avoid bogus "held 2161a62428c0STejun Heo * lock freed" warnings as well as problems when looking into 2162a62428c0STejun Heo * work->lockdep_map, make a copy and use that here. 21634e6045f1SJohannes Berg */ 21644d82a1deSPeter Zijlstra struct lockdep_map lockdep_map; 21654d82a1deSPeter Zijlstra 21664d82a1deSPeter Zijlstra lockdep_copy_map(&lockdep_map, &work->lockdep_map); 21674e6045f1SJohannes Berg #endif 21686fec10a1STejun Heo /* 21696fec10a1STejun Heo * Ensure we're on the correct CPU. DISASSOCIATED test is 21706fec10a1STejun Heo * necessary to avoid spurious warnings from rescuers servicing the 217124647570STejun Heo * unbound or a disassociated pool. 21726fec10a1STejun Heo */ 21735f7dabfdSLai Jiangshan WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) && 217424647570STejun Heo !(pool->flags & POOL_DISASSOCIATED) && 2175ec22ca5eSTejun Heo raw_smp_processor_id() != pool->cpu); 217625511a47STejun Heo 21777e11629dSTejun Heo /* 21787e11629dSTejun Heo * A single work shouldn't be executed concurrently by 21797e11629dSTejun Heo * multiple workers on a single cpu. Check whether anyone is 21807e11629dSTejun Heo * already processing the work. If so, defer the work to the 21817e11629dSTejun Heo * currently executing one. 21827e11629dSTejun Heo */ 2183c9e7cf27STejun Heo collision = find_worker_executing_work(pool, work); 21847e11629dSTejun Heo if (unlikely(collision)) { 21857e11629dSTejun Heo move_linked_works(work, &collision->scheduled, NULL); 21867e11629dSTejun Heo return; 21877e11629dSTejun Heo } 21881da177e4SLinus Torvalds 21898930cabaSTejun Heo /* claim and dequeue */ 21901da177e4SLinus Torvalds debug_work_deactivate(work); 2191c9e7cf27STejun Heo hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work); 2192c34056a3STejun Heo worker->current_work = work; 2193a2c1c57bSTejun Heo worker->current_func = work->func; 21948cca0eeaSTejun Heo worker->current_cwq = cwq; 219573f53c4aSTejun Heo work_color = get_work_color(work); 21967a22ad75STejun Heo 2197a62428c0STejun Heo list_del_init(&work->entry); 2198a62428c0STejun Heo 2199649027d7STejun Heo /* 2200fb0e7bebSTejun Heo * CPU intensive works don't participate in concurrency 2201fb0e7bebSTejun Heo * management. They're the scheduler's responsibility. 2202fb0e7bebSTejun Heo */ 2203fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2204fb0e7bebSTejun Heo worker_set_flags(worker, WORKER_CPU_INTENSIVE, true); 2205fb0e7bebSTejun Heo 2206974271c4STejun Heo /* 2207d565ed63STejun Heo * Unbound pool isn't concurrency managed and work items should be 2208974271c4STejun Heo * executed ASAP. Wake up another worker if necessary. 2209974271c4STejun Heo */ 221063d95a91STejun Heo if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool)) 221163d95a91STejun Heo wake_up_worker(pool); 2212974271c4STejun Heo 22138930cabaSTejun Heo /* 22147c3eed5cSTejun Heo * Record the last pool and clear PENDING which should be the last 2215d565ed63STejun Heo * update to @work. Also, do this inside @pool->lock so that 221623657bb1STejun Heo * PENDING and queued state changes happen together while IRQ is 221723657bb1STejun Heo * disabled. 22188930cabaSTejun Heo */ 22197c3eed5cSTejun Heo set_work_pool_and_clear_pending(work, pool->id); 22201da177e4SLinus Torvalds 2221d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2222365970a1SDavid Howells 2223e159489bSTejun Heo lock_map_acquire_read(&cwq->wq->lockdep_map); 22243295f0efSIngo Molnar lock_map_acquire(&lockdep_map); 2225e36c886aSArjan van de Ven trace_workqueue_execute_start(work); 2226a2c1c57bSTejun Heo worker->current_func(work); 2227e36c886aSArjan van de Ven /* 2228e36c886aSArjan van de Ven * While we must be careful to not use "work" after this, the trace 2229e36c886aSArjan van de Ven * point will only record its address. 2230e36c886aSArjan van de Ven */ 2231e36c886aSArjan van de Ven trace_workqueue_execute_end(work); 22323295f0efSIngo Molnar lock_map_release(&lockdep_map); 22333295f0efSIngo Molnar lock_map_release(&cwq->wq->lockdep_map); 22341da177e4SLinus Torvalds 2235d5abe669SPeter Zijlstra if (unlikely(in_atomic() || lockdep_depth(current) > 0)) { 2236044c782cSValentin Ilie pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n" 2237044c782cSValentin Ilie " last function: %pf\n", 2238a2c1c57bSTejun Heo current->comm, preempt_count(), task_pid_nr(current), 2239a2c1c57bSTejun Heo worker->current_func); 2240d5abe669SPeter Zijlstra debug_show_held_locks(current); 2241d5abe669SPeter Zijlstra dump_stack(); 2242d5abe669SPeter Zijlstra } 2243d5abe669SPeter Zijlstra 2244d565ed63STejun Heo spin_lock_irq(&pool->lock); 2245a62428c0STejun Heo 2246fb0e7bebSTejun Heo /* clear cpu intensive status */ 2247fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2248fb0e7bebSTejun Heo worker_clr_flags(worker, WORKER_CPU_INTENSIVE); 2249fb0e7bebSTejun Heo 2250a62428c0STejun Heo /* we're done with it, release */ 225142f8570fSSasha Levin hash_del(&worker->hentry); 2252c34056a3STejun Heo worker->current_work = NULL; 2253a2c1c57bSTejun Heo worker->current_func = NULL; 22548cca0eeaSTejun Heo worker->current_cwq = NULL; 2255b3f9f405SLai Jiangshan cwq_dec_nr_in_flight(cwq, work_color); 22561da177e4SLinus Torvalds } 22571da177e4SLinus Torvalds 2258affee4b2STejun Heo /** 2259affee4b2STejun Heo * process_scheduled_works - process scheduled works 2260affee4b2STejun Heo * @worker: self 2261affee4b2STejun Heo * 2262affee4b2STejun Heo * Process all scheduled works. Please note that the scheduled list 2263affee4b2STejun Heo * may change while processing a work, so this function repeatedly 2264affee4b2STejun Heo * fetches a work from the top and executes it. 2265affee4b2STejun Heo * 2266affee4b2STejun Heo * CONTEXT: 2267d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2268affee4b2STejun Heo * multiple times. 2269affee4b2STejun Heo */ 2270affee4b2STejun Heo static void process_scheduled_works(struct worker *worker) 22711da177e4SLinus Torvalds { 2272affee4b2STejun Heo while (!list_empty(&worker->scheduled)) { 2273affee4b2STejun Heo struct work_struct *work = list_first_entry(&worker->scheduled, 2274a62428c0STejun Heo struct work_struct, entry); 2275c34056a3STejun Heo process_one_work(worker, work); 2276a62428c0STejun Heo } 22771da177e4SLinus Torvalds } 22781da177e4SLinus Torvalds 22794690c4abSTejun Heo /** 22804690c4abSTejun Heo * worker_thread - the worker thread function 2281c34056a3STejun Heo * @__worker: self 22824690c4abSTejun Heo * 2283e22bee78STejun Heo * The gcwq worker thread function. There's a single dynamic pool of 2284e22bee78STejun Heo * these per each cpu. These workers process all works regardless of 2285e22bee78STejun Heo * their specific target workqueue. The only exception is works which 2286e22bee78STejun Heo * belong to workqueues with a rescuer which will be explained in 2287e22bee78STejun Heo * rescuer_thread(). 22884690c4abSTejun Heo */ 2289c34056a3STejun Heo static int worker_thread(void *__worker) 22901da177e4SLinus Torvalds { 2291c34056a3STejun Heo struct worker *worker = __worker; 2292bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 22931da177e4SLinus Torvalds 2294e22bee78STejun Heo /* tell the scheduler that this is a workqueue worker */ 2295e22bee78STejun Heo worker->task->flags |= PF_WQ_WORKER; 2296c8e55f36STejun Heo woke_up: 2297d565ed63STejun Heo spin_lock_irq(&pool->lock); 2298affee4b2STejun Heo 22995f7dabfdSLai Jiangshan /* we are off idle list if destruction or rebind is requested */ 23005f7dabfdSLai Jiangshan if (unlikely(list_empty(&worker->entry))) { 2301d565ed63STejun Heo spin_unlock_irq(&pool->lock); 230225511a47STejun Heo 23035f7dabfdSLai Jiangshan /* if DIE is set, destruction is requested */ 230425511a47STejun Heo if (worker->flags & WORKER_DIE) { 2305e22bee78STejun Heo worker->task->flags &= ~PF_WQ_WORKER; 2306c8e55f36STejun Heo return 0; 2307c8e55f36STejun Heo } 2308c8e55f36STejun Heo 23095f7dabfdSLai Jiangshan /* otherwise, rebind */ 231025511a47STejun Heo idle_worker_rebind(worker); 231125511a47STejun Heo goto woke_up; 231225511a47STejun Heo } 231325511a47STejun Heo 2314c8e55f36STejun Heo worker_leave_idle(worker); 2315db7bccf4STejun Heo recheck: 2316e22bee78STejun Heo /* no more worker necessary? */ 231763d95a91STejun Heo if (!need_more_worker(pool)) 2318e22bee78STejun Heo goto sleep; 2319e22bee78STejun Heo 2320e22bee78STejun Heo /* do we need to manage? */ 232163d95a91STejun Heo if (unlikely(!may_start_working(pool)) && manage_workers(worker)) 2322e22bee78STejun Heo goto recheck; 2323e22bee78STejun Heo 2324c8e55f36STejun Heo /* 2325c8e55f36STejun Heo * ->scheduled list can only be filled while a worker is 2326c8e55f36STejun Heo * preparing to process a work or actually processing it. 2327c8e55f36STejun Heo * Make sure nobody diddled with it while I was sleeping. 2328c8e55f36STejun Heo */ 2329c8e55f36STejun Heo BUG_ON(!list_empty(&worker->scheduled)); 2330c8e55f36STejun Heo 2331e22bee78STejun Heo /* 2332e22bee78STejun Heo * When control reaches this point, we're guaranteed to have 2333e22bee78STejun Heo * at least one idle worker or that someone else has already 2334e22bee78STejun Heo * assumed the manager role. 2335e22bee78STejun Heo */ 2336e22bee78STejun Heo worker_clr_flags(worker, WORKER_PREP); 2337e22bee78STejun Heo 2338e22bee78STejun Heo do { 2339affee4b2STejun Heo struct work_struct *work = 2340bd7bdd43STejun Heo list_first_entry(&pool->worklist, 2341affee4b2STejun Heo struct work_struct, entry); 2342affee4b2STejun Heo 2343c8e55f36STejun Heo if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) { 2344affee4b2STejun Heo /* optimization path, not strictly necessary */ 2345affee4b2STejun Heo process_one_work(worker, work); 2346affee4b2STejun Heo if (unlikely(!list_empty(&worker->scheduled))) 2347affee4b2STejun Heo process_scheduled_works(worker); 2348affee4b2STejun Heo } else { 2349c8e55f36STejun Heo move_linked_works(work, &worker->scheduled, NULL); 2350affee4b2STejun Heo process_scheduled_works(worker); 2351affee4b2STejun Heo } 235263d95a91STejun Heo } while (keep_working(pool)); 2353affee4b2STejun Heo 2354e22bee78STejun Heo worker_set_flags(worker, WORKER_PREP, false); 2355d313dd85STejun Heo sleep: 235663d95a91STejun Heo if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker)) 2357e22bee78STejun Heo goto recheck; 2358d313dd85STejun Heo 2359c8e55f36STejun Heo /* 2360d565ed63STejun Heo * pool->lock is held and there's no work to process and no need to 2361d565ed63STejun Heo * manage, sleep. Workers are woken up only while holding 2362d565ed63STejun Heo * pool->lock or from local cpu, so setting the current state 2363d565ed63STejun Heo * before releasing pool->lock is enough to prevent losing any 2364d565ed63STejun Heo * event. 2365c8e55f36STejun Heo */ 2366c8e55f36STejun Heo worker_enter_idle(worker); 2367c8e55f36STejun Heo __set_current_state(TASK_INTERRUPTIBLE); 2368d565ed63STejun Heo spin_unlock_irq(&pool->lock); 23691da177e4SLinus Torvalds schedule(); 2370c8e55f36STejun Heo goto woke_up; 23711da177e4SLinus Torvalds } 23721da177e4SLinus Torvalds 2373e22bee78STejun Heo /** 2374e22bee78STejun Heo * rescuer_thread - the rescuer thread function 2375111c225aSTejun Heo * @__rescuer: self 2376e22bee78STejun Heo * 2377e22bee78STejun Heo * Workqueue rescuer thread function. There's one rescuer for each 2378e22bee78STejun Heo * workqueue which has WQ_RESCUER set. 2379e22bee78STejun Heo * 2380e22bee78STejun Heo * Regular work processing on a gcwq may block trying to create a new 2381e22bee78STejun Heo * worker which uses GFP_KERNEL allocation which has slight chance of 2382e22bee78STejun Heo * developing into deadlock if some works currently on the same queue 2383e22bee78STejun Heo * need to be processed to satisfy the GFP_KERNEL allocation. This is 2384e22bee78STejun Heo * the problem rescuer solves. 2385e22bee78STejun Heo * 2386e22bee78STejun Heo * When such condition is possible, the gcwq summons rescuers of all 2387e22bee78STejun Heo * workqueues which have works queued on the gcwq and let them process 2388e22bee78STejun Heo * those works so that forward progress can be guaranteed. 2389e22bee78STejun Heo * 2390e22bee78STejun Heo * This should happen rarely. 2391e22bee78STejun Heo */ 2392111c225aSTejun Heo static int rescuer_thread(void *__rescuer) 2393e22bee78STejun Heo { 2394111c225aSTejun Heo struct worker *rescuer = __rescuer; 2395111c225aSTejun Heo struct workqueue_struct *wq = rescuer->rescue_wq; 2396e22bee78STejun Heo struct list_head *scheduled = &rescuer->scheduled; 2397f3421797STejun Heo bool is_unbound = wq->flags & WQ_UNBOUND; 2398e22bee78STejun Heo unsigned int cpu; 2399e22bee78STejun Heo 2400e22bee78STejun Heo set_user_nice(current, RESCUER_NICE_LEVEL); 2401111c225aSTejun Heo 2402111c225aSTejun Heo /* 2403111c225aSTejun Heo * Mark rescuer as worker too. As WORKER_PREP is never cleared, it 2404111c225aSTejun Heo * doesn't participate in concurrency management. 2405111c225aSTejun Heo */ 2406111c225aSTejun Heo rescuer->task->flags |= PF_WQ_WORKER; 2407e22bee78STejun Heo repeat: 2408e22bee78STejun Heo set_current_state(TASK_INTERRUPTIBLE); 24091da177e4SLinus Torvalds 2410412d32e6SMike Galbraith if (kthread_should_stop()) { 2411412d32e6SMike Galbraith __set_current_state(TASK_RUNNING); 2412111c225aSTejun Heo rescuer->task->flags &= ~PF_WQ_WORKER; 2413e22bee78STejun Heo return 0; 2414412d32e6SMike Galbraith } 24151da177e4SLinus Torvalds 2416f3421797STejun Heo /* 2417f3421797STejun Heo * See whether any cpu is asking for help. Unbounded 2418f3421797STejun Heo * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND. 2419f3421797STejun Heo */ 2420f2e005aaSTejun Heo for_each_mayday_cpu(cpu, wq->mayday_mask) { 2421f3421797STejun Heo unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu; 2422f3421797STejun Heo struct cpu_workqueue_struct *cwq = get_cwq(tcpu, wq); 2423bd7bdd43STejun Heo struct worker_pool *pool = cwq->pool; 2424e22bee78STejun Heo struct work_struct *work, *n; 2425e22bee78STejun Heo 2426e22bee78STejun Heo __set_current_state(TASK_RUNNING); 2427f2e005aaSTejun Heo mayday_clear_cpu(cpu, wq->mayday_mask); 2428e22bee78STejun Heo 2429e22bee78STejun Heo /* migrate to the target cpu if possible */ 2430bd7bdd43STejun Heo rescuer->pool = pool; 2431e22bee78STejun Heo worker_maybe_bind_and_lock(rescuer); 2432e22bee78STejun Heo 2433e22bee78STejun Heo /* 2434e22bee78STejun Heo * Slurp in all works issued via this workqueue and 2435e22bee78STejun Heo * process'em. 2436e22bee78STejun Heo */ 2437e22bee78STejun Heo BUG_ON(!list_empty(&rescuer->scheduled)); 2438bd7bdd43STejun Heo list_for_each_entry_safe(work, n, &pool->worklist, entry) 2439e22bee78STejun Heo if (get_work_cwq(work) == cwq) 2440e22bee78STejun Heo move_linked_works(work, scheduled, &n); 2441e22bee78STejun Heo 2442e22bee78STejun Heo process_scheduled_works(rescuer); 24437576958aSTejun Heo 24447576958aSTejun Heo /* 2445d565ed63STejun Heo * Leave this pool. If keep_working() is %true, notify a 24467576958aSTejun Heo * regular worker; otherwise, we end up with 0 concurrency 24477576958aSTejun Heo * and stalling the execution. 24487576958aSTejun Heo */ 244963d95a91STejun Heo if (keep_working(pool)) 245063d95a91STejun Heo wake_up_worker(pool); 24517576958aSTejun Heo 2452d565ed63STejun Heo spin_unlock_irq(&pool->lock); 24531da177e4SLinus Torvalds } 24541da177e4SLinus Torvalds 2455111c225aSTejun Heo /* rescuers should never participate in concurrency management */ 2456111c225aSTejun Heo WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING)); 2457e22bee78STejun Heo schedule(); 2458e22bee78STejun Heo goto repeat; 24591da177e4SLinus Torvalds } 24601da177e4SLinus Torvalds 2461fc2e4d70SOleg Nesterov struct wq_barrier { 2462fc2e4d70SOleg Nesterov struct work_struct work; 2463fc2e4d70SOleg Nesterov struct completion done; 2464fc2e4d70SOleg Nesterov }; 2465fc2e4d70SOleg Nesterov 2466fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work) 2467fc2e4d70SOleg Nesterov { 2468fc2e4d70SOleg Nesterov struct wq_barrier *barr = container_of(work, struct wq_barrier, work); 2469fc2e4d70SOleg Nesterov complete(&barr->done); 2470fc2e4d70SOleg Nesterov } 2471fc2e4d70SOleg Nesterov 24724690c4abSTejun Heo /** 24734690c4abSTejun Heo * insert_wq_barrier - insert a barrier work 24744690c4abSTejun Heo * @cwq: cwq to insert barrier into 24754690c4abSTejun Heo * @barr: wq_barrier to insert 2476affee4b2STejun Heo * @target: target work to attach @barr to 2477affee4b2STejun Heo * @worker: worker currently executing @target, NULL if @target is not executing 24784690c4abSTejun Heo * 2479affee4b2STejun Heo * @barr is linked to @target such that @barr is completed only after 2480affee4b2STejun Heo * @target finishes execution. Please note that the ordering 2481affee4b2STejun Heo * guarantee is observed only with respect to @target and on the local 2482affee4b2STejun Heo * cpu. 2483affee4b2STejun Heo * 2484affee4b2STejun Heo * Currently, a queued barrier can't be canceled. This is because 2485affee4b2STejun Heo * try_to_grab_pending() can't determine whether the work to be 2486affee4b2STejun Heo * grabbed is at the head of the queue and thus can't clear LINKED 2487affee4b2STejun Heo * flag of the previous work while there must be a valid next work 2488affee4b2STejun Heo * after a work with LINKED flag set. 2489affee4b2STejun Heo * 2490affee4b2STejun Heo * Note that when @worker is non-NULL, @target may be modified 2491affee4b2STejun Heo * underneath us, so we can't reliably determine cwq from @target. 24924690c4abSTejun Heo * 24934690c4abSTejun Heo * CONTEXT: 2494d565ed63STejun Heo * spin_lock_irq(pool->lock). 24954690c4abSTejun Heo */ 249683c22520SOleg Nesterov static void insert_wq_barrier(struct cpu_workqueue_struct *cwq, 2497affee4b2STejun Heo struct wq_barrier *barr, 2498affee4b2STejun Heo struct work_struct *target, struct worker *worker) 2499fc2e4d70SOleg Nesterov { 2500affee4b2STejun Heo struct list_head *head; 2501affee4b2STejun Heo unsigned int linked = 0; 2502affee4b2STejun Heo 2503dc186ad7SThomas Gleixner /* 2504d565ed63STejun Heo * debugobject calls are safe here even with pool->lock locked 2505dc186ad7SThomas Gleixner * as we know for sure that this will not trigger any of the 2506dc186ad7SThomas Gleixner * checks and call back into the fixup functions where we 2507dc186ad7SThomas Gleixner * might deadlock. 2508dc186ad7SThomas Gleixner */ 2509ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&barr->work, wq_barrier_func); 251022df02bbSTejun Heo __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); 2511fc2e4d70SOleg Nesterov init_completion(&barr->done); 251283c22520SOleg Nesterov 2513affee4b2STejun Heo /* 2514affee4b2STejun Heo * If @target is currently being executed, schedule the 2515affee4b2STejun Heo * barrier to the worker; otherwise, put it after @target. 2516affee4b2STejun Heo */ 2517affee4b2STejun Heo if (worker) 2518affee4b2STejun Heo head = worker->scheduled.next; 2519affee4b2STejun Heo else { 2520affee4b2STejun Heo unsigned long *bits = work_data_bits(target); 2521affee4b2STejun Heo 2522affee4b2STejun Heo head = target->entry.next; 2523affee4b2STejun Heo /* there can already be other linked works, inherit and set */ 2524affee4b2STejun Heo linked = *bits & WORK_STRUCT_LINKED; 2525affee4b2STejun Heo __set_bit(WORK_STRUCT_LINKED_BIT, bits); 2526affee4b2STejun Heo } 2527affee4b2STejun Heo 2528dc186ad7SThomas Gleixner debug_work_activate(&barr->work); 2529affee4b2STejun Heo insert_work(cwq, &barr->work, head, 2530affee4b2STejun Heo work_color_to_flags(WORK_NO_COLOR) | linked); 2531fc2e4d70SOleg Nesterov } 2532fc2e4d70SOleg Nesterov 253373f53c4aSTejun Heo /** 253473f53c4aSTejun Heo * flush_workqueue_prep_cwqs - prepare cwqs for workqueue flushing 253573f53c4aSTejun Heo * @wq: workqueue being flushed 253673f53c4aSTejun Heo * @flush_color: new flush color, < 0 for no-op 253773f53c4aSTejun Heo * @work_color: new work color, < 0 for no-op 253873f53c4aSTejun Heo * 253973f53c4aSTejun Heo * Prepare cwqs for workqueue flushing. 254073f53c4aSTejun Heo * 254173f53c4aSTejun Heo * If @flush_color is non-negative, flush_color on all cwqs should be 254273f53c4aSTejun Heo * -1. If no cwq has in-flight commands at the specified color, all 254373f53c4aSTejun Heo * cwq->flush_color's stay at -1 and %false is returned. If any cwq 254473f53c4aSTejun Heo * has in flight commands, its cwq->flush_color is set to 254573f53c4aSTejun Heo * @flush_color, @wq->nr_cwqs_to_flush is updated accordingly, cwq 254673f53c4aSTejun Heo * wakeup logic is armed and %true is returned. 254773f53c4aSTejun Heo * 254873f53c4aSTejun Heo * The caller should have initialized @wq->first_flusher prior to 254973f53c4aSTejun Heo * calling this function with non-negative @flush_color. If 255073f53c4aSTejun Heo * @flush_color is negative, no flush color update is done and %false 255173f53c4aSTejun Heo * is returned. 255273f53c4aSTejun Heo * 255373f53c4aSTejun Heo * If @work_color is non-negative, all cwqs should have the same 255473f53c4aSTejun Heo * work_color which is previous to @work_color and all will be 255573f53c4aSTejun Heo * advanced to @work_color. 255673f53c4aSTejun Heo * 255773f53c4aSTejun Heo * CONTEXT: 255873f53c4aSTejun Heo * mutex_lock(wq->flush_mutex). 255973f53c4aSTejun Heo * 256073f53c4aSTejun Heo * RETURNS: 256173f53c4aSTejun Heo * %true if @flush_color >= 0 and there's something to flush. %false 256273f53c4aSTejun Heo * otherwise. 256373f53c4aSTejun Heo */ 256473f53c4aSTejun Heo static bool flush_workqueue_prep_cwqs(struct workqueue_struct *wq, 256573f53c4aSTejun Heo int flush_color, int work_color) 25661da177e4SLinus Torvalds { 256773f53c4aSTejun Heo bool wait = false; 256873f53c4aSTejun Heo unsigned int cpu; 25691da177e4SLinus Torvalds 257073f53c4aSTejun Heo if (flush_color >= 0) { 257173f53c4aSTejun Heo BUG_ON(atomic_read(&wq->nr_cwqs_to_flush)); 257273f53c4aSTejun Heo atomic_set(&wq->nr_cwqs_to_flush, 1); 2573dc186ad7SThomas Gleixner } 257414441960SOleg Nesterov 2575f3421797STejun Heo for_each_cwq_cpu(cpu, wq) { 257673f53c4aSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 2577d565ed63STejun Heo struct worker_pool *pool = cwq->pool; 25781da177e4SLinus Torvalds 2579d565ed63STejun Heo spin_lock_irq(&pool->lock); 258073f53c4aSTejun Heo 258173f53c4aSTejun Heo if (flush_color >= 0) { 258273f53c4aSTejun Heo BUG_ON(cwq->flush_color != -1); 258373f53c4aSTejun Heo 258473f53c4aSTejun Heo if (cwq->nr_in_flight[flush_color]) { 258573f53c4aSTejun Heo cwq->flush_color = flush_color; 258673f53c4aSTejun Heo atomic_inc(&wq->nr_cwqs_to_flush); 258773f53c4aSTejun Heo wait = true; 25881da177e4SLinus Torvalds } 258973f53c4aSTejun Heo } 259073f53c4aSTejun Heo 259173f53c4aSTejun Heo if (work_color >= 0) { 259273f53c4aSTejun Heo BUG_ON(work_color != work_next_color(cwq->work_color)); 259373f53c4aSTejun Heo cwq->work_color = work_color; 259473f53c4aSTejun Heo } 259573f53c4aSTejun Heo 2596d565ed63STejun Heo spin_unlock_irq(&pool->lock); 25971da177e4SLinus Torvalds } 25981da177e4SLinus Torvalds 259973f53c4aSTejun Heo if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_cwqs_to_flush)) 260073f53c4aSTejun Heo complete(&wq->first_flusher->done); 260173f53c4aSTejun Heo 260273f53c4aSTejun Heo return wait; 260383c22520SOleg Nesterov } 26041da177e4SLinus Torvalds 26050fcb78c2SRolf Eike Beer /** 26061da177e4SLinus Torvalds * flush_workqueue - ensure that any scheduled work has run to completion. 26070fcb78c2SRolf Eike Beer * @wq: workqueue to flush 26081da177e4SLinus Torvalds * 26091da177e4SLinus Torvalds * Forces execution of the workqueue and blocks until its completion. 26101da177e4SLinus Torvalds * This is typically used in driver shutdown handlers. 26111da177e4SLinus Torvalds * 2612fc2e4d70SOleg Nesterov * We sleep until all works which were queued on entry have been handled, 2613fc2e4d70SOleg Nesterov * but we are not livelocked by new incoming ones. 26141da177e4SLinus Torvalds */ 26157ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq) 26161da177e4SLinus Torvalds { 261773f53c4aSTejun Heo struct wq_flusher this_flusher = { 261873f53c4aSTejun Heo .list = LIST_HEAD_INIT(this_flusher.list), 261973f53c4aSTejun Heo .flush_color = -1, 262073f53c4aSTejun Heo .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done), 262173f53c4aSTejun Heo }; 262273f53c4aSTejun Heo int next_color; 2623b1f4ec17SOleg Nesterov 26243295f0efSIngo Molnar lock_map_acquire(&wq->lockdep_map); 26253295f0efSIngo Molnar lock_map_release(&wq->lockdep_map); 262673f53c4aSTejun Heo 262773f53c4aSTejun Heo mutex_lock(&wq->flush_mutex); 262873f53c4aSTejun Heo 262973f53c4aSTejun Heo /* 263073f53c4aSTejun Heo * Start-to-wait phase 263173f53c4aSTejun Heo */ 263273f53c4aSTejun Heo next_color = work_next_color(wq->work_color); 263373f53c4aSTejun Heo 263473f53c4aSTejun Heo if (next_color != wq->flush_color) { 263573f53c4aSTejun Heo /* 263673f53c4aSTejun Heo * Color space is not full. The current work_color 263773f53c4aSTejun Heo * becomes our flush_color and work_color is advanced 263873f53c4aSTejun Heo * by one. 263973f53c4aSTejun Heo */ 264073f53c4aSTejun Heo BUG_ON(!list_empty(&wq->flusher_overflow)); 264173f53c4aSTejun Heo this_flusher.flush_color = wq->work_color; 264273f53c4aSTejun Heo wq->work_color = next_color; 264373f53c4aSTejun Heo 264473f53c4aSTejun Heo if (!wq->first_flusher) { 264573f53c4aSTejun Heo /* no flush in progress, become the first flusher */ 264673f53c4aSTejun Heo BUG_ON(wq->flush_color != this_flusher.flush_color); 264773f53c4aSTejun Heo 264873f53c4aSTejun Heo wq->first_flusher = &this_flusher; 264973f53c4aSTejun Heo 265073f53c4aSTejun Heo if (!flush_workqueue_prep_cwqs(wq, wq->flush_color, 265173f53c4aSTejun Heo wq->work_color)) { 265273f53c4aSTejun Heo /* nothing to flush, done */ 265373f53c4aSTejun Heo wq->flush_color = next_color; 265473f53c4aSTejun Heo wq->first_flusher = NULL; 265573f53c4aSTejun Heo goto out_unlock; 265673f53c4aSTejun Heo } 265773f53c4aSTejun Heo } else { 265873f53c4aSTejun Heo /* wait in queue */ 265973f53c4aSTejun Heo BUG_ON(wq->flush_color == this_flusher.flush_color); 266073f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_queue); 266173f53c4aSTejun Heo flush_workqueue_prep_cwqs(wq, -1, wq->work_color); 266273f53c4aSTejun Heo } 266373f53c4aSTejun Heo } else { 266473f53c4aSTejun Heo /* 266573f53c4aSTejun Heo * Oops, color space is full, wait on overflow queue. 266673f53c4aSTejun Heo * The next flush completion will assign us 266773f53c4aSTejun Heo * flush_color and transfer to flusher_queue. 266873f53c4aSTejun Heo */ 266973f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_overflow); 267073f53c4aSTejun Heo } 267173f53c4aSTejun Heo 267273f53c4aSTejun Heo mutex_unlock(&wq->flush_mutex); 267373f53c4aSTejun Heo 267473f53c4aSTejun Heo wait_for_completion(&this_flusher.done); 267573f53c4aSTejun Heo 267673f53c4aSTejun Heo /* 267773f53c4aSTejun Heo * Wake-up-and-cascade phase 267873f53c4aSTejun Heo * 267973f53c4aSTejun Heo * First flushers are responsible for cascading flushes and 268073f53c4aSTejun Heo * handling overflow. Non-first flushers can simply return. 268173f53c4aSTejun Heo */ 268273f53c4aSTejun Heo if (wq->first_flusher != &this_flusher) 268373f53c4aSTejun Heo return; 268473f53c4aSTejun Heo 268573f53c4aSTejun Heo mutex_lock(&wq->flush_mutex); 268673f53c4aSTejun Heo 26874ce48b37STejun Heo /* we might have raced, check again with mutex held */ 26884ce48b37STejun Heo if (wq->first_flusher != &this_flusher) 26894ce48b37STejun Heo goto out_unlock; 26904ce48b37STejun Heo 269173f53c4aSTejun Heo wq->first_flusher = NULL; 269273f53c4aSTejun Heo 269373f53c4aSTejun Heo BUG_ON(!list_empty(&this_flusher.list)); 269473f53c4aSTejun Heo BUG_ON(wq->flush_color != this_flusher.flush_color); 269573f53c4aSTejun Heo 269673f53c4aSTejun Heo while (true) { 269773f53c4aSTejun Heo struct wq_flusher *next, *tmp; 269873f53c4aSTejun Heo 269973f53c4aSTejun Heo /* complete all the flushers sharing the current flush color */ 270073f53c4aSTejun Heo list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { 270173f53c4aSTejun Heo if (next->flush_color != wq->flush_color) 270273f53c4aSTejun Heo break; 270373f53c4aSTejun Heo list_del_init(&next->list); 270473f53c4aSTejun Heo complete(&next->done); 270573f53c4aSTejun Heo } 270673f53c4aSTejun Heo 270773f53c4aSTejun Heo BUG_ON(!list_empty(&wq->flusher_overflow) && 270873f53c4aSTejun Heo wq->flush_color != work_next_color(wq->work_color)); 270973f53c4aSTejun Heo 271073f53c4aSTejun Heo /* this flush_color is finished, advance by one */ 271173f53c4aSTejun Heo wq->flush_color = work_next_color(wq->flush_color); 271273f53c4aSTejun Heo 271373f53c4aSTejun Heo /* one color has been freed, handle overflow queue */ 271473f53c4aSTejun Heo if (!list_empty(&wq->flusher_overflow)) { 271573f53c4aSTejun Heo /* 271673f53c4aSTejun Heo * Assign the same color to all overflowed 271773f53c4aSTejun Heo * flushers, advance work_color and append to 271873f53c4aSTejun Heo * flusher_queue. This is the start-to-wait 271973f53c4aSTejun Heo * phase for these overflowed flushers. 272073f53c4aSTejun Heo */ 272173f53c4aSTejun Heo list_for_each_entry(tmp, &wq->flusher_overflow, list) 272273f53c4aSTejun Heo tmp->flush_color = wq->work_color; 272373f53c4aSTejun Heo 272473f53c4aSTejun Heo wq->work_color = work_next_color(wq->work_color); 272573f53c4aSTejun Heo 272673f53c4aSTejun Heo list_splice_tail_init(&wq->flusher_overflow, 272773f53c4aSTejun Heo &wq->flusher_queue); 272873f53c4aSTejun Heo flush_workqueue_prep_cwqs(wq, -1, wq->work_color); 272973f53c4aSTejun Heo } 273073f53c4aSTejun Heo 273173f53c4aSTejun Heo if (list_empty(&wq->flusher_queue)) { 273273f53c4aSTejun Heo BUG_ON(wq->flush_color != wq->work_color); 273373f53c4aSTejun Heo break; 273473f53c4aSTejun Heo } 273573f53c4aSTejun Heo 273673f53c4aSTejun Heo /* 273773f53c4aSTejun Heo * Need to flush more colors. Make the next flusher 273873f53c4aSTejun Heo * the new first flusher and arm cwqs. 273973f53c4aSTejun Heo */ 274073f53c4aSTejun Heo BUG_ON(wq->flush_color == wq->work_color); 274173f53c4aSTejun Heo BUG_ON(wq->flush_color != next->flush_color); 274273f53c4aSTejun Heo 274373f53c4aSTejun Heo list_del_init(&next->list); 274473f53c4aSTejun Heo wq->first_flusher = next; 274573f53c4aSTejun Heo 274673f53c4aSTejun Heo if (flush_workqueue_prep_cwqs(wq, wq->flush_color, -1)) 274773f53c4aSTejun Heo break; 274873f53c4aSTejun Heo 274973f53c4aSTejun Heo /* 275073f53c4aSTejun Heo * Meh... this color is already done, clear first 275173f53c4aSTejun Heo * flusher and repeat cascading. 275273f53c4aSTejun Heo */ 275373f53c4aSTejun Heo wq->first_flusher = NULL; 275473f53c4aSTejun Heo } 275573f53c4aSTejun Heo 275673f53c4aSTejun Heo out_unlock: 275773f53c4aSTejun Heo mutex_unlock(&wq->flush_mutex); 27581da177e4SLinus Torvalds } 2759ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue); 27601da177e4SLinus Torvalds 27619c5a2ba7STejun Heo /** 27629c5a2ba7STejun Heo * drain_workqueue - drain a workqueue 27639c5a2ba7STejun Heo * @wq: workqueue to drain 27649c5a2ba7STejun Heo * 27659c5a2ba7STejun Heo * Wait until the workqueue becomes empty. While draining is in progress, 27669c5a2ba7STejun Heo * only chain queueing is allowed. IOW, only currently pending or running 27679c5a2ba7STejun Heo * work items on @wq can queue further work items on it. @wq is flushed 27689c5a2ba7STejun Heo * repeatedly until it becomes empty. The number of flushing is detemined 27699c5a2ba7STejun Heo * by the depth of chaining and should be relatively short. Whine if it 27709c5a2ba7STejun Heo * takes too long. 27719c5a2ba7STejun Heo */ 27729c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq) 27739c5a2ba7STejun Heo { 27749c5a2ba7STejun Heo unsigned int flush_cnt = 0; 27759c5a2ba7STejun Heo unsigned int cpu; 27769c5a2ba7STejun Heo 27779c5a2ba7STejun Heo /* 27789c5a2ba7STejun Heo * __queue_work() needs to test whether there are drainers, is much 27799c5a2ba7STejun Heo * hotter than drain_workqueue() and already looks at @wq->flags. 27809c5a2ba7STejun Heo * Use WQ_DRAINING so that queue doesn't have to check nr_drainers. 27819c5a2ba7STejun Heo */ 27829c5a2ba7STejun Heo spin_lock(&workqueue_lock); 27839c5a2ba7STejun Heo if (!wq->nr_drainers++) 27849c5a2ba7STejun Heo wq->flags |= WQ_DRAINING; 27859c5a2ba7STejun Heo spin_unlock(&workqueue_lock); 27869c5a2ba7STejun Heo reflush: 27879c5a2ba7STejun Heo flush_workqueue(wq); 27889c5a2ba7STejun Heo 27899c5a2ba7STejun Heo for_each_cwq_cpu(cpu, wq) { 27909c5a2ba7STejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 2791fa2563e4SThomas Tuttle bool drained; 27929c5a2ba7STejun Heo 2793d565ed63STejun Heo spin_lock_irq(&cwq->pool->lock); 2794fa2563e4SThomas Tuttle drained = !cwq->nr_active && list_empty(&cwq->delayed_works); 2795d565ed63STejun Heo spin_unlock_irq(&cwq->pool->lock); 2796fa2563e4SThomas Tuttle 2797fa2563e4SThomas Tuttle if (drained) 27989c5a2ba7STejun Heo continue; 27999c5a2ba7STejun Heo 28009c5a2ba7STejun Heo if (++flush_cnt == 10 || 28019c5a2ba7STejun Heo (flush_cnt % 100 == 0 && flush_cnt <= 1000)) 2802044c782cSValentin Ilie pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n", 28039c5a2ba7STejun Heo wq->name, flush_cnt); 28049c5a2ba7STejun Heo goto reflush; 28059c5a2ba7STejun Heo } 28069c5a2ba7STejun Heo 28079c5a2ba7STejun Heo spin_lock(&workqueue_lock); 28089c5a2ba7STejun Heo if (!--wq->nr_drainers) 28099c5a2ba7STejun Heo wq->flags &= ~WQ_DRAINING; 28109c5a2ba7STejun Heo spin_unlock(&workqueue_lock); 28119c5a2ba7STejun Heo } 28129c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue); 28139c5a2ba7STejun Heo 2814606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr) 2815baf59022STejun Heo { 2816baf59022STejun Heo struct worker *worker = NULL; 2817c9e7cf27STejun Heo struct worker_pool *pool; 2818baf59022STejun Heo struct cpu_workqueue_struct *cwq; 2819baf59022STejun Heo 2820baf59022STejun Heo might_sleep(); 2821c9e7cf27STejun Heo pool = get_work_pool(work); 2822c9e7cf27STejun Heo if (!pool) 2823baf59022STejun Heo return false; 2824baf59022STejun Heo 2825d565ed63STejun Heo spin_lock_irq(&pool->lock); 2826baf59022STejun Heo if (!list_empty(&work->entry)) { 2827baf59022STejun Heo /* 2828baf59022STejun Heo * See the comment near try_to_grab_pending()->smp_rmb(). 2829d565ed63STejun Heo * If it was re-queued to a different pool under us, we 2830baf59022STejun Heo * are not going to wait. 2831baf59022STejun Heo */ 2832baf59022STejun Heo smp_rmb(); 2833baf59022STejun Heo cwq = get_work_cwq(work); 2834d565ed63STejun Heo if (unlikely(!cwq || pool != cwq->pool)) 2835baf59022STejun Heo goto already_gone; 2836606a5020STejun Heo } else { 2837c9e7cf27STejun Heo worker = find_worker_executing_work(pool, work); 2838baf59022STejun Heo if (!worker) 2839baf59022STejun Heo goto already_gone; 2840baf59022STejun Heo cwq = worker->current_cwq; 2841606a5020STejun Heo } 2842baf59022STejun Heo 2843baf59022STejun Heo insert_wq_barrier(cwq, barr, work, worker); 2844d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2845baf59022STejun Heo 2846e159489bSTejun Heo /* 2847e159489bSTejun Heo * If @max_active is 1 or rescuer is in use, flushing another work 2848e159489bSTejun Heo * item on the same workqueue may lead to deadlock. Make sure the 2849e159489bSTejun Heo * flusher is not running on the same workqueue by verifying write 2850e159489bSTejun Heo * access. 2851e159489bSTejun Heo */ 2852e159489bSTejun Heo if (cwq->wq->saved_max_active == 1 || cwq->wq->flags & WQ_RESCUER) 2853baf59022STejun Heo lock_map_acquire(&cwq->wq->lockdep_map); 2854e159489bSTejun Heo else 2855e159489bSTejun Heo lock_map_acquire_read(&cwq->wq->lockdep_map); 2856baf59022STejun Heo lock_map_release(&cwq->wq->lockdep_map); 2857e159489bSTejun Heo 2858baf59022STejun Heo return true; 2859baf59022STejun Heo already_gone: 2860d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2861baf59022STejun Heo return false; 2862baf59022STejun Heo } 2863baf59022STejun Heo 2864db700897SOleg Nesterov /** 2865401a8d04STejun Heo * flush_work - wait for a work to finish executing the last queueing instance 2866401a8d04STejun Heo * @work: the work to flush 2867db700897SOleg Nesterov * 2868606a5020STejun Heo * Wait until @work has finished execution. @work is guaranteed to be idle 2869606a5020STejun Heo * on return if it hasn't been requeued since flush started. 2870401a8d04STejun Heo * 2871401a8d04STejun Heo * RETURNS: 2872401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2873401a8d04STejun Heo * %false if it was already idle. 2874db700897SOleg Nesterov */ 2875401a8d04STejun Heo bool flush_work(struct work_struct *work) 2876db700897SOleg Nesterov { 2877db700897SOleg Nesterov struct wq_barrier barr; 2878db700897SOleg Nesterov 28790976dfc1SStephen Boyd lock_map_acquire(&work->lockdep_map); 28800976dfc1SStephen Boyd lock_map_release(&work->lockdep_map); 28810976dfc1SStephen Boyd 2882606a5020STejun Heo if (start_flush_work(work, &barr)) { 2883db700897SOleg Nesterov wait_for_completion(&barr.done); 2884dc186ad7SThomas Gleixner destroy_work_on_stack(&barr.work); 2885401a8d04STejun Heo return true; 2886606a5020STejun Heo } else { 2887401a8d04STejun Heo return false; 2888db700897SOleg Nesterov } 2889606a5020STejun Heo } 2890db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work); 2891db700897SOleg Nesterov 289236e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork) 2893401a8d04STejun Heo { 2894bbb68dfaSTejun Heo unsigned long flags; 28951f1f642eSOleg Nesterov int ret; 28961f1f642eSOleg Nesterov 28971f1f642eSOleg Nesterov do { 2898bbb68dfaSTejun Heo ret = try_to_grab_pending(work, is_dwork, &flags); 2899bbb68dfaSTejun Heo /* 2900bbb68dfaSTejun Heo * If someone else is canceling, wait for the same event it 2901bbb68dfaSTejun Heo * would be waiting for before retrying. 2902bbb68dfaSTejun Heo */ 2903bbb68dfaSTejun Heo if (unlikely(ret == -ENOENT)) 2904606a5020STejun Heo flush_work(work); 29051f1f642eSOleg Nesterov } while (unlikely(ret < 0)); 29061f1f642eSOleg Nesterov 2907bbb68dfaSTejun Heo /* tell other tasks trying to grab @work to back off */ 2908bbb68dfaSTejun Heo mark_work_canceling(work); 2909bbb68dfaSTejun Heo local_irq_restore(flags); 2910bbb68dfaSTejun Heo 2911606a5020STejun Heo flush_work(work); 29127a22ad75STejun Heo clear_work_data(work); 29131f1f642eSOleg Nesterov return ret; 29141f1f642eSOleg Nesterov } 29151f1f642eSOleg Nesterov 29166e84d644SOleg Nesterov /** 2917401a8d04STejun Heo * cancel_work_sync - cancel a work and wait for it to finish 2918401a8d04STejun Heo * @work: the work to cancel 29196e84d644SOleg Nesterov * 2920401a8d04STejun Heo * Cancel @work and wait for its execution to finish. This function 2921401a8d04STejun Heo * can be used even if the work re-queues itself or migrates to 2922401a8d04STejun Heo * another workqueue. On return from this function, @work is 2923401a8d04STejun Heo * guaranteed to be not pending or executing on any CPU. 29241f1f642eSOleg Nesterov * 2925401a8d04STejun Heo * cancel_work_sync(&delayed_work->work) must not be used for 2926401a8d04STejun Heo * delayed_work's. Use cancel_delayed_work_sync() instead. 29276e84d644SOleg Nesterov * 2928401a8d04STejun Heo * The caller must ensure that the workqueue on which @work was last 29296e84d644SOleg Nesterov * queued can't be destroyed before this function returns. 2930401a8d04STejun Heo * 2931401a8d04STejun Heo * RETURNS: 2932401a8d04STejun Heo * %true if @work was pending, %false otherwise. 29336e84d644SOleg Nesterov */ 2934401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work) 29356e84d644SOleg Nesterov { 293636e227d2STejun Heo return __cancel_work_timer(work, false); 2937b89deed3SOleg Nesterov } 293828e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync); 2939b89deed3SOleg Nesterov 29406e84d644SOleg Nesterov /** 2941401a8d04STejun Heo * flush_delayed_work - wait for a dwork to finish executing the last queueing 2942401a8d04STejun Heo * @dwork: the delayed work to flush 29436e84d644SOleg Nesterov * 2944401a8d04STejun Heo * Delayed timer is cancelled and the pending work is queued for 2945401a8d04STejun Heo * immediate execution. Like flush_work(), this function only 2946401a8d04STejun Heo * considers the last queueing instance of @dwork. 29471f1f642eSOleg Nesterov * 2948401a8d04STejun Heo * RETURNS: 2949401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2950401a8d04STejun Heo * %false if it was already idle. 29516e84d644SOleg Nesterov */ 2952401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork) 2953401a8d04STejun Heo { 29548930cabaSTejun Heo local_irq_disable(); 2955401a8d04STejun Heo if (del_timer_sync(&dwork->timer)) 29561265057fSTejun Heo __queue_work(dwork->cpu, 2957401a8d04STejun Heo get_work_cwq(&dwork->work)->wq, &dwork->work); 29588930cabaSTejun Heo local_irq_enable(); 2959401a8d04STejun Heo return flush_work(&dwork->work); 2960401a8d04STejun Heo } 2961401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work); 2962401a8d04STejun Heo 2963401a8d04STejun Heo /** 296457b30ae7STejun Heo * cancel_delayed_work - cancel a delayed work 296557b30ae7STejun Heo * @dwork: delayed_work to cancel 296609383498STejun Heo * 296757b30ae7STejun Heo * Kill off a pending delayed_work. Returns %true if @dwork was pending 296857b30ae7STejun Heo * and canceled; %false if wasn't pending. Note that the work callback 296957b30ae7STejun Heo * function may still be running on return, unless it returns %true and the 297057b30ae7STejun Heo * work doesn't re-arm itself. Explicitly flush or use 297157b30ae7STejun Heo * cancel_delayed_work_sync() to wait on it. 297209383498STejun Heo * 297357b30ae7STejun Heo * This function is safe to call from any context including IRQ handler. 297409383498STejun Heo */ 297557b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork) 297609383498STejun Heo { 297757b30ae7STejun Heo unsigned long flags; 297857b30ae7STejun Heo int ret; 297957b30ae7STejun Heo 298057b30ae7STejun Heo do { 298157b30ae7STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 298257b30ae7STejun Heo } while (unlikely(ret == -EAGAIN)); 298357b30ae7STejun Heo 298457b30ae7STejun Heo if (unlikely(ret < 0)) 298557b30ae7STejun Heo return false; 298657b30ae7STejun Heo 29877c3eed5cSTejun Heo set_work_pool_and_clear_pending(&dwork->work, 29887c3eed5cSTejun Heo get_work_pool_id(&dwork->work)); 298957b30ae7STejun Heo local_irq_restore(flags); 2990c0158ca6SDan Magenheimer return ret; 299109383498STejun Heo } 299257b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work); 299309383498STejun Heo 299409383498STejun Heo /** 2995401a8d04STejun Heo * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish 2996401a8d04STejun Heo * @dwork: the delayed work cancel 2997401a8d04STejun Heo * 2998401a8d04STejun Heo * This is cancel_work_sync() for delayed works. 2999401a8d04STejun Heo * 3000401a8d04STejun Heo * RETURNS: 3001401a8d04STejun Heo * %true if @dwork was pending, %false otherwise. 3002401a8d04STejun Heo */ 3003401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork) 30046e84d644SOleg Nesterov { 300536e227d2STejun Heo return __cancel_work_timer(&dwork->work, true); 30066e84d644SOleg Nesterov } 3007f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync); 30081da177e4SLinus Torvalds 30090fcb78c2SRolf Eike Beer /** 3010c1a220e7SZhang Rui * schedule_work_on - put work task on a specific cpu 3011c1a220e7SZhang Rui * @cpu: cpu to put the work task on 3012c1a220e7SZhang Rui * @work: job to be done 3013c1a220e7SZhang Rui * 3014c1a220e7SZhang Rui * This puts a job on a specific cpu 3015c1a220e7SZhang Rui */ 3016d4283e93STejun Heo bool schedule_work_on(int cpu, struct work_struct *work) 3017c1a220e7SZhang Rui { 3018d320c038STejun Heo return queue_work_on(cpu, system_wq, work); 3019c1a220e7SZhang Rui } 3020c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on); 3021c1a220e7SZhang Rui 30220fcb78c2SRolf Eike Beer /** 3023ae90dd5dSDave Jones * schedule_work - put work task in global workqueue 30241da177e4SLinus Torvalds * @work: job to be done 30251da177e4SLinus Torvalds * 3026d4283e93STejun Heo * Returns %false if @work was already on the kernel-global workqueue and 3027d4283e93STejun Heo * %true otherwise. 302852bad64dSDavid Howells * 30290fcb78c2SRolf Eike Beer * This puts a job in the kernel-global workqueue if it was not already 30300fcb78c2SRolf Eike Beer * queued and leaves it in the same position on the kernel-global 30310fcb78c2SRolf Eike Beer * workqueue otherwise. 30321da177e4SLinus Torvalds */ 3033d4283e93STejun Heo bool schedule_work(struct work_struct *work) 30341da177e4SLinus Torvalds { 30350fcb78c2SRolf Eike Beer return queue_work(system_wq, work); 30361da177e4SLinus Torvalds } 30370fcb78c2SRolf Eike Beer EXPORT_SYMBOL(schedule_work); 30381da177e4SLinus Torvalds 30390fcb78c2SRolf Eike Beer /** 30400fcb78c2SRolf Eike Beer * schedule_delayed_work_on - queue work in global workqueue on CPU after delay 30410fcb78c2SRolf Eike Beer * @cpu: cpu to use 30420fcb78c2SRolf Eike Beer * @dwork: job to be done 30430fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait 30440fcb78c2SRolf Eike Beer * 30450fcb78c2SRolf Eike Beer * After waiting for a given time this puts a job in the kernel-global 30460fcb78c2SRolf Eike Beer * workqueue on the specified CPU. 30470fcb78c2SRolf Eike Beer */ 3048d4283e93STejun Heo bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork, 3049d4283e93STejun Heo unsigned long delay) 30501da177e4SLinus Torvalds { 3051d320c038STejun Heo return queue_delayed_work_on(cpu, system_wq, dwork, delay); 30521da177e4SLinus Torvalds } 3053ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on); 30541da177e4SLinus Torvalds 3055b6136773SAndrew Morton /** 30560a13c00eSTejun Heo * schedule_delayed_work - put work task in global workqueue after delay 30570a13c00eSTejun Heo * @dwork: job to be done 30580a13c00eSTejun Heo * @delay: number of jiffies to wait or 0 for immediate execution 30590a13c00eSTejun Heo * 30600a13c00eSTejun Heo * After waiting for a given time this puts a job in the kernel-global 30610a13c00eSTejun Heo * workqueue. 30620a13c00eSTejun Heo */ 3063d4283e93STejun Heo bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay) 30640a13c00eSTejun Heo { 30650a13c00eSTejun Heo return queue_delayed_work(system_wq, dwork, delay); 30660a13c00eSTejun Heo } 30670a13c00eSTejun Heo EXPORT_SYMBOL(schedule_delayed_work); 30680a13c00eSTejun Heo 30690a13c00eSTejun Heo /** 307031ddd871STejun Heo * schedule_on_each_cpu - execute a function synchronously on each online CPU 3071b6136773SAndrew Morton * @func: the function to call 3072b6136773SAndrew Morton * 307331ddd871STejun Heo * schedule_on_each_cpu() executes @func on each online CPU using the 307431ddd871STejun Heo * system workqueue and blocks until all CPUs have completed. 3075b6136773SAndrew Morton * schedule_on_each_cpu() is very slow. 307631ddd871STejun Heo * 307731ddd871STejun Heo * RETURNS: 307831ddd871STejun Heo * 0 on success, -errno on failure. 3079b6136773SAndrew Morton */ 308065f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func) 308115316ba8SChristoph Lameter { 308215316ba8SChristoph Lameter int cpu; 308338f51568SNamhyung Kim struct work_struct __percpu *works; 308415316ba8SChristoph Lameter 3085b6136773SAndrew Morton works = alloc_percpu(struct work_struct); 3086b6136773SAndrew Morton if (!works) 308715316ba8SChristoph Lameter return -ENOMEM; 3088b6136773SAndrew Morton 308995402b38SGautham R Shenoy get_online_cpus(); 309093981800STejun Heo 309115316ba8SChristoph Lameter for_each_online_cpu(cpu) { 30929bfb1839SIngo Molnar struct work_struct *work = per_cpu_ptr(works, cpu); 30939bfb1839SIngo Molnar 30949bfb1839SIngo Molnar INIT_WORK(work, func); 30958de6d308SOleg Nesterov schedule_work_on(cpu, work); 309615316ba8SChristoph Lameter } 309793981800STejun Heo 309893981800STejun Heo for_each_online_cpu(cpu) 30998616a89aSOleg Nesterov flush_work(per_cpu_ptr(works, cpu)); 310093981800STejun Heo 310195402b38SGautham R Shenoy put_online_cpus(); 3102b6136773SAndrew Morton free_percpu(works); 310315316ba8SChristoph Lameter return 0; 310415316ba8SChristoph Lameter } 310515316ba8SChristoph Lameter 3106eef6a7d5SAlan Stern /** 3107eef6a7d5SAlan Stern * flush_scheduled_work - ensure that any scheduled work has run to completion. 3108eef6a7d5SAlan Stern * 3109eef6a7d5SAlan Stern * Forces execution of the kernel-global workqueue and blocks until its 3110eef6a7d5SAlan Stern * completion. 3111eef6a7d5SAlan Stern * 3112eef6a7d5SAlan Stern * Think twice before calling this function! It's very easy to get into 3113eef6a7d5SAlan Stern * trouble if you don't take great care. Either of the following situations 3114eef6a7d5SAlan Stern * will lead to deadlock: 3115eef6a7d5SAlan Stern * 3116eef6a7d5SAlan Stern * One of the work items currently on the workqueue needs to acquire 3117eef6a7d5SAlan Stern * a lock held by your code or its caller. 3118eef6a7d5SAlan Stern * 3119eef6a7d5SAlan Stern * Your code is running in the context of a work routine. 3120eef6a7d5SAlan Stern * 3121eef6a7d5SAlan Stern * They will be detected by lockdep when they occur, but the first might not 3122eef6a7d5SAlan Stern * occur very often. It depends on what work items are on the workqueue and 3123eef6a7d5SAlan Stern * what locks they need, which you have no control over. 3124eef6a7d5SAlan Stern * 3125eef6a7d5SAlan Stern * In most situations flushing the entire workqueue is overkill; you merely 3126eef6a7d5SAlan Stern * need to know that a particular work item isn't queued and isn't running. 3127eef6a7d5SAlan Stern * In such cases you should use cancel_delayed_work_sync() or 3128eef6a7d5SAlan Stern * cancel_work_sync() instead. 3129eef6a7d5SAlan Stern */ 31301da177e4SLinus Torvalds void flush_scheduled_work(void) 31311da177e4SLinus Torvalds { 3132d320c038STejun Heo flush_workqueue(system_wq); 31331da177e4SLinus Torvalds } 3134ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work); 31351da177e4SLinus Torvalds 31361da177e4SLinus Torvalds /** 31371fa44ecaSJames Bottomley * execute_in_process_context - reliably execute the routine with user context 31381fa44ecaSJames Bottomley * @fn: the function to execute 31391fa44ecaSJames Bottomley * @ew: guaranteed storage for the execute work structure (must 31401fa44ecaSJames Bottomley * be available when the work executes) 31411fa44ecaSJames Bottomley * 31421fa44ecaSJames Bottomley * Executes the function immediately if process context is available, 31431fa44ecaSJames Bottomley * otherwise schedules the function for delayed execution. 31441fa44ecaSJames Bottomley * 31451fa44ecaSJames Bottomley * Returns: 0 - function was executed 31461fa44ecaSJames Bottomley * 1 - function was scheduled for execution 31471fa44ecaSJames Bottomley */ 314865f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew) 31491fa44ecaSJames Bottomley { 31501fa44ecaSJames Bottomley if (!in_interrupt()) { 315165f27f38SDavid Howells fn(&ew->work); 31521fa44ecaSJames Bottomley return 0; 31531fa44ecaSJames Bottomley } 31541fa44ecaSJames Bottomley 315565f27f38SDavid Howells INIT_WORK(&ew->work, fn); 31561fa44ecaSJames Bottomley schedule_work(&ew->work); 31571fa44ecaSJames Bottomley 31581fa44ecaSJames Bottomley return 1; 31591fa44ecaSJames Bottomley } 31601fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context); 31611fa44ecaSJames Bottomley 31621da177e4SLinus Torvalds int keventd_up(void) 31631da177e4SLinus Torvalds { 3164d320c038STejun Heo return system_wq != NULL; 31651da177e4SLinus Torvalds } 31661da177e4SLinus Torvalds 3167bdbc5dd7STejun Heo static int alloc_cwqs(struct workqueue_struct *wq) 31681da177e4SLinus Torvalds { 31693af24433SOleg Nesterov /* 31700f900049STejun Heo * cwqs are forced aligned according to WORK_STRUCT_FLAG_BITS. 31710f900049STejun Heo * Make sure that the alignment isn't lower than that of 31720f900049STejun Heo * unsigned long long. 31733af24433SOleg Nesterov */ 31740f900049STejun Heo const size_t size = sizeof(struct cpu_workqueue_struct); 31750f900049STejun Heo const size_t align = max_t(size_t, 1 << WORK_STRUCT_FLAG_BITS, 31760f900049STejun Heo __alignof__(unsigned long long)); 31773af24433SOleg Nesterov 3178e06ffa1eSLai Jiangshan if (!(wq->flags & WQ_UNBOUND)) 3179f3421797STejun Heo wq->cpu_wq.pcpu = __alloc_percpu(size, align); 3180931ac77eSTejun Heo else { 31810f900049STejun Heo void *ptr; 3182e1d8aa9fSFrederic Weisbecker 31830f900049STejun Heo /* 3184f3421797STejun Heo * Allocate enough room to align cwq and put an extra 3185f3421797STejun Heo * pointer at the end pointing back to the originally 3186f3421797STejun Heo * allocated pointer which will be used for free. 31870f900049STejun Heo */ 3188bdbc5dd7STejun Heo ptr = kzalloc(size + align + sizeof(void *), GFP_KERNEL); 3189bdbc5dd7STejun Heo if (ptr) { 3190bdbc5dd7STejun Heo wq->cpu_wq.single = PTR_ALIGN(ptr, align); 3191bdbc5dd7STejun Heo *(void **)(wq->cpu_wq.single + 1) = ptr; 3192bdbc5dd7STejun Heo } 31933af24433SOleg Nesterov } 31943af24433SOleg Nesterov 31950415b00dSTejun Heo /* just in case, make sure it's actually aligned */ 3196bdbc5dd7STejun Heo BUG_ON(!IS_ALIGNED(wq->cpu_wq.v, align)); 3197bdbc5dd7STejun Heo return wq->cpu_wq.v ? 0 : -ENOMEM; 31980f900049STejun Heo } 31990f900049STejun Heo 3200bdbc5dd7STejun Heo static void free_cwqs(struct workqueue_struct *wq) 320106ba38a9SOleg Nesterov { 3202e06ffa1eSLai Jiangshan if (!(wq->flags & WQ_UNBOUND)) 3203bdbc5dd7STejun Heo free_percpu(wq->cpu_wq.pcpu); 3204f3421797STejun Heo else if (wq->cpu_wq.single) { 3205f3421797STejun Heo /* the pointer to free is stored right after the cwq */ 3206f3421797STejun Heo kfree(*(void **)(wq->cpu_wq.single + 1)); 320706ba38a9SOleg Nesterov } 320806ba38a9SOleg Nesterov } 320906ba38a9SOleg Nesterov 3210f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags, 3211f3421797STejun Heo const char *name) 3212b71ab8c2STejun Heo { 3213f3421797STejun Heo int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE; 3214f3421797STejun Heo 3215f3421797STejun Heo if (max_active < 1 || max_active > lim) 3216044c782cSValentin Ilie pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n", 3217f3421797STejun Heo max_active, name, 1, lim); 3218b71ab8c2STejun Heo 3219f3421797STejun Heo return clamp_val(max_active, 1, lim); 3220b71ab8c2STejun Heo } 3221b71ab8c2STejun Heo 3222b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt, 322397e37d7bSTejun Heo unsigned int flags, 32241e19ffc6STejun Heo int max_active, 3225eb13ba87SJohannes Berg struct lock_class_key *key, 3226b196be89STejun Heo const char *lock_name, ...) 32273af24433SOleg Nesterov { 3228b196be89STejun Heo va_list args, args1; 32293af24433SOleg Nesterov struct workqueue_struct *wq; 3230c34056a3STejun Heo unsigned int cpu; 3231b196be89STejun Heo size_t namelen; 3232b196be89STejun Heo 3233b196be89STejun Heo /* determine namelen, allocate wq and format name */ 3234b196be89STejun Heo va_start(args, lock_name); 3235b196be89STejun Heo va_copy(args1, args); 3236b196be89STejun Heo namelen = vsnprintf(NULL, 0, fmt, args) + 1; 3237b196be89STejun Heo 3238b196be89STejun Heo wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL); 3239b196be89STejun Heo if (!wq) 3240b196be89STejun Heo goto err; 3241b196be89STejun Heo 3242b196be89STejun Heo vsnprintf(wq->name, namelen, fmt, args1); 3243b196be89STejun Heo va_end(args); 3244b196be89STejun Heo va_end(args1); 32453af24433SOleg Nesterov 3246f3421797STejun Heo /* 32476370a6adSTejun Heo * Workqueues which may be used during memory reclaim should 32486370a6adSTejun Heo * have a rescuer to guarantee forward progress. 32496370a6adSTejun Heo */ 32506370a6adSTejun Heo if (flags & WQ_MEM_RECLAIM) 32516370a6adSTejun Heo flags |= WQ_RESCUER; 32526370a6adSTejun Heo 3253d320c038STejun Heo max_active = max_active ?: WQ_DFL_ACTIVE; 3254b196be89STejun Heo max_active = wq_clamp_max_active(max_active, flags, wq->name); 32553af24433SOleg Nesterov 3256b196be89STejun Heo /* init wq */ 325797e37d7bSTejun Heo wq->flags = flags; 3258a0a1a5fdSTejun Heo wq->saved_max_active = max_active; 325973f53c4aSTejun Heo mutex_init(&wq->flush_mutex); 326073f53c4aSTejun Heo atomic_set(&wq->nr_cwqs_to_flush, 0); 326173f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_queue); 326273f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_overflow); 32633af24433SOleg Nesterov 3264eb13ba87SJohannes Berg lockdep_init_map(&wq->lockdep_map, lock_name, key, 0); 3265cce1a165SOleg Nesterov INIT_LIST_HEAD(&wq->list); 32663af24433SOleg Nesterov 3267bdbc5dd7STejun Heo if (alloc_cwqs(wq) < 0) 3268bdbc5dd7STejun Heo goto err; 3269bdbc5dd7STejun Heo 3270f3421797STejun Heo for_each_cwq_cpu(cpu, wq) { 32711537663fSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 32728b03ae3cSTejun Heo struct global_cwq *gcwq = get_gcwq(cpu); 32733270476aSTejun Heo int pool_idx = (bool)(flags & WQ_HIGHPRI); 32741537663fSTejun Heo 32750f900049STejun Heo BUG_ON((unsigned long)cwq & WORK_STRUCT_FLAG_MASK); 32763270476aSTejun Heo cwq->pool = &gcwq->pools[pool_idx]; 3277c34056a3STejun Heo cwq->wq = wq; 327873f53c4aSTejun Heo cwq->flush_color = -1; 32791e19ffc6STejun Heo cwq->max_active = max_active; 32801e19ffc6STejun Heo INIT_LIST_HEAD(&cwq->delayed_works); 3281e22bee78STejun Heo } 32821537663fSTejun Heo 3283e22bee78STejun Heo if (flags & WQ_RESCUER) { 3284e22bee78STejun Heo struct worker *rescuer; 3285e22bee78STejun Heo 3286f2e005aaSTejun Heo if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL)) 3287e22bee78STejun Heo goto err; 3288e22bee78STejun Heo 3289e22bee78STejun Heo wq->rescuer = rescuer = alloc_worker(); 3290e22bee78STejun Heo if (!rescuer) 3291e22bee78STejun Heo goto err; 3292e22bee78STejun Heo 3293111c225aSTejun Heo rescuer->rescue_wq = wq; 3294111c225aSTejun Heo rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", 3295b196be89STejun Heo wq->name); 3296e22bee78STejun Heo if (IS_ERR(rescuer->task)) 3297e22bee78STejun Heo goto err; 3298e22bee78STejun Heo 3299e22bee78STejun Heo rescuer->task->flags |= PF_THREAD_BOUND; 3300e22bee78STejun Heo wake_up_process(rescuer->task); 33013af24433SOleg Nesterov } 33021537663fSTejun Heo 33033af24433SOleg Nesterov /* 3304a0a1a5fdSTejun Heo * workqueue_lock protects global freeze state and workqueues 3305a0a1a5fdSTejun Heo * list. Grab it, set max_active accordingly and add the new 3306a0a1a5fdSTejun Heo * workqueue to workqueues list. 33073af24433SOleg Nesterov */ 33083af24433SOleg Nesterov spin_lock(&workqueue_lock); 3309a0a1a5fdSTejun Heo 331058a69cb4STejun Heo if (workqueue_freezing && wq->flags & WQ_FREEZABLE) 3311f3421797STejun Heo for_each_cwq_cpu(cpu, wq) 3312a0a1a5fdSTejun Heo get_cwq(cpu, wq)->max_active = 0; 3313a0a1a5fdSTejun Heo 33143af24433SOleg Nesterov list_add(&wq->list, &workqueues); 3315a0a1a5fdSTejun Heo 33163af24433SOleg Nesterov spin_unlock(&workqueue_lock); 33173af24433SOleg Nesterov 33183af24433SOleg Nesterov return wq; 33194690c4abSTejun Heo err: 33204690c4abSTejun Heo if (wq) { 3321bdbc5dd7STejun Heo free_cwqs(wq); 3322f2e005aaSTejun Heo free_mayday_mask(wq->mayday_mask); 3323e22bee78STejun Heo kfree(wq->rescuer); 33244690c4abSTejun Heo kfree(wq); 33253af24433SOleg Nesterov } 33264690c4abSTejun Heo return NULL; 33271da177e4SLinus Torvalds } 3328d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key); 33291da177e4SLinus Torvalds 33303af24433SOleg Nesterov /** 33313af24433SOleg Nesterov * destroy_workqueue - safely terminate a workqueue 33323af24433SOleg Nesterov * @wq: target workqueue 33333af24433SOleg Nesterov * 33343af24433SOleg Nesterov * Safely destroy a workqueue. All work currently pending will be done first. 33353af24433SOleg Nesterov */ 33363af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq) 33373af24433SOleg Nesterov { 3338c8e55f36STejun Heo unsigned int cpu; 33393af24433SOleg Nesterov 33409c5a2ba7STejun Heo /* drain it before proceeding with destruction */ 33419c5a2ba7STejun Heo drain_workqueue(wq); 3342c8efcc25STejun Heo 3343a0a1a5fdSTejun Heo /* 3344a0a1a5fdSTejun Heo * wq list is used to freeze wq, remove from list after 3345a0a1a5fdSTejun Heo * flushing is complete in case freeze races us. 3346a0a1a5fdSTejun Heo */ 334795402b38SGautham R Shenoy spin_lock(&workqueue_lock); 33483af24433SOleg Nesterov list_del(&wq->list); 334995402b38SGautham R Shenoy spin_unlock(&workqueue_lock); 33503af24433SOleg Nesterov 3351e22bee78STejun Heo /* sanity check */ 3352f3421797STejun Heo for_each_cwq_cpu(cpu, wq) { 335373f53c4aSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 335473f53c4aSTejun Heo int i; 33553af24433SOleg Nesterov 335673f53c4aSTejun Heo for (i = 0; i < WORK_NR_COLORS; i++) 335773f53c4aSTejun Heo BUG_ON(cwq->nr_in_flight[i]); 33581e19ffc6STejun Heo BUG_ON(cwq->nr_active); 33591e19ffc6STejun Heo BUG_ON(!list_empty(&cwq->delayed_works)); 336073f53c4aSTejun Heo } 33611537663fSTejun Heo 3362e22bee78STejun Heo if (wq->flags & WQ_RESCUER) { 3363e22bee78STejun Heo kthread_stop(wq->rescuer->task); 3364f2e005aaSTejun Heo free_mayday_mask(wq->mayday_mask); 33658d9df9f0SXiaotian Feng kfree(wq->rescuer); 3366e22bee78STejun Heo } 3367e22bee78STejun Heo 3368bdbc5dd7STejun Heo free_cwqs(wq); 33693af24433SOleg Nesterov kfree(wq); 33703af24433SOleg Nesterov } 33713af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue); 33723af24433SOleg Nesterov 3373dcd989cbSTejun Heo /** 33749f4bd4cdSLai Jiangshan * cwq_set_max_active - adjust max_active of a cwq 33759f4bd4cdSLai Jiangshan * @cwq: target cpu_workqueue_struct 33769f4bd4cdSLai Jiangshan * @max_active: new max_active value. 33779f4bd4cdSLai Jiangshan * 33789f4bd4cdSLai Jiangshan * Set @cwq->max_active to @max_active and activate delayed works if 33799f4bd4cdSLai Jiangshan * increased. 33809f4bd4cdSLai Jiangshan * 33819f4bd4cdSLai Jiangshan * CONTEXT: 3382d565ed63STejun Heo * spin_lock_irq(pool->lock). 33839f4bd4cdSLai Jiangshan */ 33849f4bd4cdSLai Jiangshan static void cwq_set_max_active(struct cpu_workqueue_struct *cwq, int max_active) 33859f4bd4cdSLai Jiangshan { 33869f4bd4cdSLai Jiangshan cwq->max_active = max_active; 33879f4bd4cdSLai Jiangshan 33889f4bd4cdSLai Jiangshan while (!list_empty(&cwq->delayed_works) && 33899f4bd4cdSLai Jiangshan cwq->nr_active < cwq->max_active) 33909f4bd4cdSLai Jiangshan cwq_activate_first_delayed(cwq); 33919f4bd4cdSLai Jiangshan } 33929f4bd4cdSLai Jiangshan 33939f4bd4cdSLai Jiangshan /** 3394dcd989cbSTejun Heo * workqueue_set_max_active - adjust max_active of a workqueue 3395dcd989cbSTejun Heo * @wq: target workqueue 3396dcd989cbSTejun Heo * @max_active: new max_active value. 3397dcd989cbSTejun Heo * 3398dcd989cbSTejun Heo * Set max_active of @wq to @max_active. 3399dcd989cbSTejun Heo * 3400dcd989cbSTejun Heo * CONTEXT: 3401dcd989cbSTejun Heo * Don't call from IRQ context. 3402dcd989cbSTejun Heo */ 3403dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) 3404dcd989cbSTejun Heo { 3405dcd989cbSTejun Heo unsigned int cpu; 3406dcd989cbSTejun Heo 3407f3421797STejun Heo max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); 3408dcd989cbSTejun Heo 3409dcd989cbSTejun Heo spin_lock(&workqueue_lock); 3410dcd989cbSTejun Heo 3411dcd989cbSTejun Heo wq->saved_max_active = max_active; 3412dcd989cbSTejun Heo 3413f3421797STejun Heo for_each_cwq_cpu(cpu, wq) { 341435b6bb63STejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 341535b6bb63STejun Heo struct worker_pool *pool = cwq->pool; 3416dcd989cbSTejun Heo 3417d565ed63STejun Heo spin_lock_irq(&pool->lock); 3418dcd989cbSTejun Heo 341958a69cb4STejun Heo if (!(wq->flags & WQ_FREEZABLE) || 342035b6bb63STejun Heo !(pool->flags & POOL_FREEZING)) 342135b6bb63STejun Heo cwq_set_max_active(cwq, max_active); 3422dcd989cbSTejun Heo 3423d565ed63STejun Heo spin_unlock_irq(&pool->lock); 3424dcd989cbSTejun Heo } 3425dcd989cbSTejun Heo 3426dcd989cbSTejun Heo spin_unlock(&workqueue_lock); 3427dcd989cbSTejun Heo } 3428dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active); 3429dcd989cbSTejun Heo 3430dcd989cbSTejun Heo /** 3431dcd989cbSTejun Heo * workqueue_congested - test whether a workqueue is congested 3432dcd989cbSTejun Heo * @cpu: CPU in question 3433dcd989cbSTejun Heo * @wq: target workqueue 3434dcd989cbSTejun Heo * 3435dcd989cbSTejun Heo * Test whether @wq's cpu workqueue for @cpu is congested. There is 3436dcd989cbSTejun Heo * no synchronization around this function and the test result is 3437dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 3438dcd989cbSTejun Heo * 3439dcd989cbSTejun Heo * RETURNS: 3440dcd989cbSTejun Heo * %true if congested, %false otherwise. 3441dcd989cbSTejun Heo */ 3442dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq) 3443dcd989cbSTejun Heo { 3444dcd989cbSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 3445dcd989cbSTejun Heo 3446dcd989cbSTejun Heo return !list_empty(&cwq->delayed_works); 3447dcd989cbSTejun Heo } 3448dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested); 3449dcd989cbSTejun Heo 3450dcd989cbSTejun Heo /** 3451dcd989cbSTejun Heo * work_busy - test whether a work is currently pending or running 3452dcd989cbSTejun Heo * @work: the work to be tested 3453dcd989cbSTejun Heo * 3454dcd989cbSTejun Heo * Test whether @work is currently pending or running. There is no 3455dcd989cbSTejun Heo * synchronization around this function and the test result is 3456dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 3457dcd989cbSTejun Heo * Especially for reentrant wqs, the pending state might hide the 3458dcd989cbSTejun Heo * running state. 3459dcd989cbSTejun Heo * 3460dcd989cbSTejun Heo * RETURNS: 3461dcd989cbSTejun Heo * OR'd bitmask of WORK_BUSY_* bits. 3462dcd989cbSTejun Heo */ 3463dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work) 3464dcd989cbSTejun Heo { 3465c9e7cf27STejun Heo struct worker_pool *pool = get_work_pool(work); 3466dcd989cbSTejun Heo unsigned long flags; 3467dcd989cbSTejun Heo unsigned int ret = 0; 3468dcd989cbSTejun Heo 3469c9e7cf27STejun Heo if (!pool) 3470999767beSJoonsoo Kim return 0; 3471dcd989cbSTejun Heo 3472d565ed63STejun Heo spin_lock_irqsave(&pool->lock, flags); 3473dcd989cbSTejun Heo 3474dcd989cbSTejun Heo if (work_pending(work)) 3475dcd989cbSTejun Heo ret |= WORK_BUSY_PENDING; 3476c9e7cf27STejun Heo if (find_worker_executing_work(pool, work)) 3477dcd989cbSTejun Heo ret |= WORK_BUSY_RUNNING; 3478dcd989cbSTejun Heo 3479d565ed63STejun Heo spin_unlock_irqrestore(&pool->lock, flags); 3480dcd989cbSTejun Heo 3481dcd989cbSTejun Heo return ret; 3482dcd989cbSTejun Heo } 3483dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy); 3484dcd989cbSTejun Heo 3485db7bccf4STejun Heo /* 3486db7bccf4STejun Heo * CPU hotplug. 3487db7bccf4STejun Heo * 3488e22bee78STejun Heo * There are two challenges in supporting CPU hotplug. Firstly, there 3489e22bee78STejun Heo * are a lot of assumptions on strong associations among work, cwq and 3490e22bee78STejun Heo * gcwq which make migrating pending and scheduled works very 3491e22bee78STejun Heo * difficult to implement without impacting hot paths. Secondly, 349294cf58bbSTejun Heo * worker pools serve mix of short, long and very long running works making 3493e22bee78STejun Heo * blocked draining impractical. 3494e22bee78STejun Heo * 349524647570STejun Heo * This is solved by allowing the pools to be disassociated from the CPU 3496628c78e7STejun Heo * running as an unbound one and allowing it to be reattached later if the 3497628c78e7STejun Heo * cpu comes back online. 3498db7bccf4STejun Heo */ 3499db7bccf4STejun Heo 3500628c78e7STejun Heo static void gcwq_unbind_fn(struct work_struct *work) 3501db7bccf4STejun Heo { 350238db41d9STejun Heo int cpu = smp_processor_id(); 35034ce62e9eSTejun Heo struct worker_pool *pool; 3504db7bccf4STejun Heo struct worker *worker; 3505db7bccf4STejun Heo struct hlist_node *pos; 3506db7bccf4STejun Heo int i; 3507db7bccf4STejun Heo 350838db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 350938db41d9STejun Heo BUG_ON(cpu != smp_processor_id()); 3510db7bccf4STejun Heo 351194cf58bbSTejun Heo mutex_lock(&pool->assoc_mutex); 351294cf58bbSTejun Heo spin_lock_irq(&pool->lock); 3513e22bee78STejun Heo 3514f2d5a0eeSTejun Heo /* 351594cf58bbSTejun Heo * We've claimed all manager positions. Make all workers 351694cf58bbSTejun Heo * unbound and set DISASSOCIATED. Before this, all workers 351794cf58bbSTejun Heo * except for the ones which are still executing works from 351894cf58bbSTejun Heo * before the last CPU down must be on the cpu. After 351994cf58bbSTejun Heo * this, they may become diasporas. 3520f2d5a0eeSTejun Heo */ 35214ce62e9eSTejun Heo list_for_each_entry(worker, &pool->idle_list, entry) 3522403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 3523db7bccf4STejun Heo 3524c9e7cf27STejun Heo for_each_busy_worker(worker, i, pos, pool) 3525403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 3526db7bccf4STejun Heo 352724647570STejun Heo pool->flags |= POOL_DISASSOCIATED; 3528f2d5a0eeSTejun Heo 352994cf58bbSTejun Heo spin_unlock_irq(&pool->lock); 353094cf58bbSTejun Heo mutex_unlock(&pool->assoc_mutex); 353194cf58bbSTejun Heo } 3532e22bee78STejun Heo 3533e22bee78STejun Heo /* 3534628c78e7STejun Heo * Call schedule() so that we cross rq->lock and thus can guarantee 3535628c78e7STejun Heo * sched callbacks see the %WORKER_UNBOUND flag. This is necessary 3536628c78e7STejun Heo * as scheduler callbacks may be invoked from other cpus. 3537628c78e7STejun Heo */ 3538628c78e7STejun Heo schedule(); 3539628c78e7STejun Heo 3540628c78e7STejun Heo /* 3541628c78e7STejun Heo * Sched callbacks are disabled now. Zap nr_running. After this, 3542628c78e7STejun Heo * nr_running stays zero and need_more_worker() and keep_working() 354338db41d9STejun Heo * are always true as long as the worklist is not empty. Pools on 354438db41d9STejun Heo * @cpu now behave as unbound (in terms of concurrency management) 354538db41d9STejun Heo * pools which are served by workers tied to the CPU. 3546628c78e7STejun Heo * 3547628c78e7STejun Heo * On return from this function, the current worker would trigger 3548628c78e7STejun Heo * unbound chain execution of pending work items if other workers 3549628c78e7STejun Heo * didn't already. 3550e22bee78STejun Heo */ 355138db41d9STejun Heo for_each_std_worker_pool(pool, cpu) 35524ce62e9eSTejun Heo atomic_set(get_pool_nr_running(pool), 0); 3553db7bccf4STejun Heo } 3554db7bccf4STejun Heo 35558db25e78STejun Heo /* 35568db25e78STejun Heo * Workqueues should be brought up before normal priority CPU notifiers. 35578db25e78STejun Heo * This will be registered high priority CPU notifier. 35588db25e78STejun Heo */ 35599fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb, 35601da177e4SLinus Torvalds unsigned long action, 35611da177e4SLinus Torvalds void *hcpu) 35621da177e4SLinus Torvalds { 35633af24433SOleg Nesterov unsigned int cpu = (unsigned long)hcpu; 35644ce62e9eSTejun Heo struct worker_pool *pool; 35651da177e4SLinus Torvalds 35668db25e78STejun Heo switch (action & ~CPU_TASKS_FROZEN) { 35673af24433SOleg Nesterov case CPU_UP_PREPARE: 356838db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 35693ce63377STejun Heo struct worker *worker; 35703ce63377STejun Heo 35713ce63377STejun Heo if (pool->nr_workers) 35723ce63377STejun Heo continue; 35733ce63377STejun Heo 35743ce63377STejun Heo worker = create_worker(pool); 35753ce63377STejun Heo if (!worker) 35763ce63377STejun Heo return NOTIFY_BAD; 35773ce63377STejun Heo 3578d565ed63STejun Heo spin_lock_irq(&pool->lock); 35793ce63377STejun Heo start_worker(worker); 3580d565ed63STejun Heo spin_unlock_irq(&pool->lock); 35813af24433SOleg Nesterov } 35821da177e4SLinus Torvalds break; 35831da177e4SLinus Torvalds 358465758202STejun Heo case CPU_DOWN_FAILED: 358565758202STejun Heo case CPU_ONLINE: 358638db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 358794cf58bbSTejun Heo mutex_lock(&pool->assoc_mutex); 358894cf58bbSTejun Heo spin_lock_irq(&pool->lock); 358994cf58bbSTejun Heo 359024647570STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 359194cf58bbSTejun Heo rebind_workers(pool); 359294cf58bbSTejun Heo 359394cf58bbSTejun Heo spin_unlock_irq(&pool->lock); 359494cf58bbSTejun Heo mutex_unlock(&pool->assoc_mutex); 359594cf58bbSTejun Heo } 35968db25e78STejun Heo break; 359765758202STejun Heo } 359865758202STejun Heo return NOTIFY_OK; 359965758202STejun Heo } 360065758202STejun Heo 360165758202STejun Heo /* 360265758202STejun Heo * Workqueues should be brought down after normal priority CPU notifiers. 360365758202STejun Heo * This will be registered as low priority CPU notifier. 360465758202STejun Heo */ 36059fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb, 360665758202STejun Heo unsigned long action, 360765758202STejun Heo void *hcpu) 360865758202STejun Heo { 36098db25e78STejun Heo unsigned int cpu = (unsigned long)hcpu; 36108db25e78STejun Heo struct work_struct unbind_work; 36118db25e78STejun Heo 361265758202STejun Heo switch (action & ~CPU_TASKS_FROZEN) { 361365758202STejun Heo case CPU_DOWN_PREPARE: 36148db25e78STejun Heo /* unbinding should happen on the local CPU */ 36158db25e78STejun Heo INIT_WORK_ONSTACK(&unbind_work, gcwq_unbind_fn); 36167635d2fdSJoonsoo Kim queue_work_on(cpu, system_highpri_wq, &unbind_work); 36178db25e78STejun Heo flush_work(&unbind_work); 36188db25e78STejun Heo break; 361965758202STejun Heo } 362065758202STejun Heo return NOTIFY_OK; 362165758202STejun Heo } 362265758202STejun Heo 36232d3854a3SRusty Russell #ifdef CONFIG_SMP 36248ccad40dSRusty Russell 36252d3854a3SRusty Russell struct work_for_cpu { 3626ed48ece2STejun Heo struct work_struct work; 36272d3854a3SRusty Russell long (*fn)(void *); 36282d3854a3SRusty Russell void *arg; 36292d3854a3SRusty Russell long ret; 36302d3854a3SRusty Russell }; 36312d3854a3SRusty Russell 3632ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work) 36332d3854a3SRusty Russell { 3634ed48ece2STejun Heo struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work); 3635ed48ece2STejun Heo 36362d3854a3SRusty Russell wfc->ret = wfc->fn(wfc->arg); 36372d3854a3SRusty Russell } 36382d3854a3SRusty Russell 36392d3854a3SRusty Russell /** 36402d3854a3SRusty Russell * work_on_cpu - run a function in user context on a particular cpu 36412d3854a3SRusty Russell * @cpu: the cpu to run on 36422d3854a3SRusty Russell * @fn: the function to run 36432d3854a3SRusty Russell * @arg: the function arg 36442d3854a3SRusty Russell * 364531ad9081SRusty Russell * This will return the value @fn returns. 364631ad9081SRusty Russell * It is up to the caller to ensure that the cpu doesn't go offline. 36476b44003eSAndrew Morton * The caller must not hold any locks which would prevent @fn from completing. 36482d3854a3SRusty Russell */ 36492d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg) 36502d3854a3SRusty Russell { 3651ed48ece2STejun Heo struct work_for_cpu wfc = { .fn = fn, .arg = arg }; 36522d3854a3SRusty Russell 3653ed48ece2STejun Heo INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn); 3654ed48ece2STejun Heo schedule_work_on(cpu, &wfc.work); 3655ed48ece2STejun Heo flush_work(&wfc.work); 36562d3854a3SRusty Russell return wfc.ret; 36572d3854a3SRusty Russell } 36582d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu); 36592d3854a3SRusty Russell #endif /* CONFIG_SMP */ 36602d3854a3SRusty Russell 3661a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 3662e7577c50SRusty Russell 3663a0a1a5fdSTejun Heo /** 3664a0a1a5fdSTejun Heo * freeze_workqueues_begin - begin freezing workqueues 3665a0a1a5fdSTejun Heo * 366658a69cb4STejun Heo * Start freezing workqueues. After this function returns, all freezable 366758a69cb4STejun Heo * workqueues will queue new works to their frozen_works list instead of 366858a69cb4STejun Heo * gcwq->worklist. 3669a0a1a5fdSTejun Heo * 3670a0a1a5fdSTejun Heo * CONTEXT: 3671d565ed63STejun Heo * Grabs and releases workqueue_lock and pool->lock's. 3672a0a1a5fdSTejun Heo */ 3673a0a1a5fdSTejun Heo void freeze_workqueues_begin(void) 3674a0a1a5fdSTejun Heo { 3675a0a1a5fdSTejun Heo unsigned int cpu; 3676a0a1a5fdSTejun Heo 3677a0a1a5fdSTejun Heo spin_lock(&workqueue_lock); 3678a0a1a5fdSTejun Heo 3679a0a1a5fdSTejun Heo BUG_ON(workqueue_freezing); 3680a0a1a5fdSTejun Heo workqueue_freezing = true; 3681a0a1a5fdSTejun Heo 3682f3421797STejun Heo for_each_gcwq_cpu(cpu) { 368335b6bb63STejun Heo struct worker_pool *pool; 3684bdbc5dd7STejun Heo struct workqueue_struct *wq; 36858b03ae3cSTejun Heo 368638db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 3687a1056305STejun Heo spin_lock_irq(&pool->lock); 3688d565ed63STejun Heo 368935b6bb63STejun Heo WARN_ON_ONCE(pool->flags & POOL_FREEZING); 369035b6bb63STejun Heo pool->flags |= POOL_FREEZING; 3691db7bccf4STejun Heo 3692a0a1a5fdSTejun Heo list_for_each_entry(wq, &workqueues, list) { 3693a0a1a5fdSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 3694a0a1a5fdSTejun Heo 3695a1056305STejun Heo if (cwq && cwq->pool == pool && 3696a1056305STejun Heo (wq->flags & WQ_FREEZABLE)) 3697a0a1a5fdSTejun Heo cwq->max_active = 0; 36981da177e4SLinus Torvalds } 36998b03ae3cSTejun Heo 3700a1056305STejun Heo spin_unlock_irq(&pool->lock); 3701a1056305STejun Heo } 3702a0a1a5fdSTejun Heo } 3703a0a1a5fdSTejun Heo 3704a0a1a5fdSTejun Heo spin_unlock(&workqueue_lock); 3705a0a1a5fdSTejun Heo } 3706a0a1a5fdSTejun Heo 3707a0a1a5fdSTejun Heo /** 370858a69cb4STejun Heo * freeze_workqueues_busy - are freezable workqueues still busy? 3709a0a1a5fdSTejun Heo * 3710a0a1a5fdSTejun Heo * Check whether freezing is complete. This function must be called 3711a0a1a5fdSTejun Heo * between freeze_workqueues_begin() and thaw_workqueues(). 3712a0a1a5fdSTejun Heo * 3713a0a1a5fdSTejun Heo * CONTEXT: 3714a0a1a5fdSTejun Heo * Grabs and releases workqueue_lock. 3715a0a1a5fdSTejun Heo * 3716a0a1a5fdSTejun Heo * RETURNS: 371758a69cb4STejun Heo * %true if some freezable workqueues are still busy. %false if freezing 371858a69cb4STejun Heo * is complete. 3719a0a1a5fdSTejun Heo */ 3720a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void) 3721a0a1a5fdSTejun Heo { 3722a0a1a5fdSTejun Heo unsigned int cpu; 3723a0a1a5fdSTejun Heo bool busy = false; 3724a0a1a5fdSTejun Heo 3725a0a1a5fdSTejun Heo spin_lock(&workqueue_lock); 3726a0a1a5fdSTejun Heo 3727a0a1a5fdSTejun Heo BUG_ON(!workqueue_freezing); 3728a0a1a5fdSTejun Heo 3729f3421797STejun Heo for_each_gcwq_cpu(cpu) { 3730bdbc5dd7STejun Heo struct workqueue_struct *wq; 3731a0a1a5fdSTejun Heo /* 3732a0a1a5fdSTejun Heo * nr_active is monotonically decreasing. It's safe 3733a0a1a5fdSTejun Heo * to peek without lock. 3734a0a1a5fdSTejun Heo */ 3735a0a1a5fdSTejun Heo list_for_each_entry(wq, &workqueues, list) { 3736a0a1a5fdSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 3737a0a1a5fdSTejun Heo 373858a69cb4STejun Heo if (!cwq || !(wq->flags & WQ_FREEZABLE)) 3739a0a1a5fdSTejun Heo continue; 3740a0a1a5fdSTejun Heo 3741a0a1a5fdSTejun Heo BUG_ON(cwq->nr_active < 0); 3742a0a1a5fdSTejun Heo if (cwq->nr_active) { 3743a0a1a5fdSTejun Heo busy = true; 3744a0a1a5fdSTejun Heo goto out_unlock; 3745a0a1a5fdSTejun Heo } 3746a0a1a5fdSTejun Heo } 3747a0a1a5fdSTejun Heo } 3748a0a1a5fdSTejun Heo out_unlock: 3749a0a1a5fdSTejun Heo spin_unlock(&workqueue_lock); 3750a0a1a5fdSTejun Heo return busy; 3751a0a1a5fdSTejun Heo } 3752a0a1a5fdSTejun Heo 3753a0a1a5fdSTejun Heo /** 3754a0a1a5fdSTejun Heo * thaw_workqueues - thaw workqueues 3755a0a1a5fdSTejun Heo * 3756a0a1a5fdSTejun Heo * Thaw workqueues. Normal queueing is restored and all collected 37577e11629dSTejun Heo * frozen works are transferred to their respective gcwq worklists. 3758a0a1a5fdSTejun Heo * 3759a0a1a5fdSTejun Heo * CONTEXT: 3760d565ed63STejun Heo * Grabs and releases workqueue_lock and pool->lock's. 3761a0a1a5fdSTejun Heo */ 3762a0a1a5fdSTejun Heo void thaw_workqueues(void) 3763a0a1a5fdSTejun Heo { 3764a0a1a5fdSTejun Heo unsigned int cpu; 3765a0a1a5fdSTejun Heo 3766a0a1a5fdSTejun Heo spin_lock(&workqueue_lock); 3767a0a1a5fdSTejun Heo 3768a0a1a5fdSTejun Heo if (!workqueue_freezing) 3769a0a1a5fdSTejun Heo goto out_unlock; 3770a0a1a5fdSTejun Heo 3771f3421797STejun Heo for_each_gcwq_cpu(cpu) { 37724ce62e9eSTejun Heo struct worker_pool *pool; 3773bdbc5dd7STejun Heo struct workqueue_struct *wq; 37748b03ae3cSTejun Heo 377538db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 3776a1056305STejun Heo spin_lock_irq(&pool->lock); 3777d565ed63STejun Heo 377835b6bb63STejun Heo WARN_ON_ONCE(!(pool->flags & POOL_FREEZING)); 377935b6bb63STejun Heo pool->flags &= ~POOL_FREEZING; 3780db7bccf4STejun Heo 3781a0a1a5fdSTejun Heo list_for_each_entry(wq, &workqueues, list) { 3782a0a1a5fdSTejun Heo struct cpu_workqueue_struct *cwq = get_cwq(cpu, wq); 3783a0a1a5fdSTejun Heo 3784a1056305STejun Heo if (!cwq || cwq->pool != pool || 3785a1056305STejun Heo !(wq->flags & WQ_FREEZABLE)) 3786a0a1a5fdSTejun Heo continue; 3787a0a1a5fdSTejun Heo 3788a0a1a5fdSTejun Heo /* restore max_active and repopulate worklist */ 37899f4bd4cdSLai Jiangshan cwq_set_max_active(cwq, wq->saved_max_active); 3790a0a1a5fdSTejun Heo } 37918b03ae3cSTejun Heo 37924ce62e9eSTejun Heo wake_up_worker(pool); 3793a1056305STejun Heo 3794a1056305STejun Heo spin_unlock_irq(&pool->lock); 3795d565ed63STejun Heo } 3796a0a1a5fdSTejun Heo } 3797a0a1a5fdSTejun Heo 3798a0a1a5fdSTejun Heo workqueue_freezing = false; 3799a0a1a5fdSTejun Heo out_unlock: 3800a0a1a5fdSTejun Heo spin_unlock(&workqueue_lock); 3801a0a1a5fdSTejun Heo } 3802a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 3803a0a1a5fdSTejun Heo 38046ee0578bSSuresh Siddha static int __init init_workqueues(void) 38051da177e4SLinus Torvalds { 3806c34056a3STejun Heo unsigned int cpu; 3807c34056a3STejun Heo 38087c3eed5cSTejun Heo /* make sure we have enough bits for OFFQ pool ID */ 38097c3eed5cSTejun Heo BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT)) < 38107c3eed5cSTejun Heo WORK_CPU_LAST * NR_STD_WORKER_POOLS); 3811b5490077STejun Heo 381265758202STejun Heo cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP); 3813a5b4e57dSLai Jiangshan hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN); 38148b03ae3cSTejun Heo 38158b03ae3cSTejun Heo /* initialize gcwqs */ 3816f3421797STejun Heo for_each_gcwq_cpu(cpu) { 38174ce62e9eSTejun Heo struct worker_pool *pool; 38188b03ae3cSTejun Heo 381938db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 3820d565ed63STejun Heo spin_lock_init(&pool->lock); 3821ec22ca5eSTejun Heo pool->cpu = cpu; 382224647570STejun Heo pool->flags |= POOL_DISASSOCIATED; 38234ce62e9eSTejun Heo INIT_LIST_HEAD(&pool->worklist); 38244ce62e9eSTejun Heo INIT_LIST_HEAD(&pool->idle_list); 3825c9e7cf27STejun Heo hash_init(pool->busy_hash); 3826e22bee78STejun Heo 38274ce62e9eSTejun Heo init_timer_deferrable(&pool->idle_timer); 38284ce62e9eSTejun Heo pool->idle_timer.function = idle_worker_timeout; 38294ce62e9eSTejun Heo pool->idle_timer.data = (unsigned long)pool; 3830e22bee78STejun Heo 38314ce62e9eSTejun Heo setup_timer(&pool->mayday_timer, gcwq_mayday_timeout, 38324ce62e9eSTejun Heo (unsigned long)pool); 38334ce62e9eSTejun Heo 3834b2eb83d1SLai Jiangshan mutex_init(&pool->assoc_mutex); 38354ce62e9eSTejun Heo ida_init(&pool->worker_ida); 38369daf9e67STejun Heo 38379daf9e67STejun Heo /* alloc pool ID */ 38389daf9e67STejun Heo BUG_ON(worker_pool_assign_id(pool)); 38394ce62e9eSTejun Heo } 38408b03ae3cSTejun Heo } 38418b03ae3cSTejun Heo 3842e22bee78STejun Heo /* create the initial worker */ 3843f3421797STejun Heo for_each_online_gcwq_cpu(cpu) { 38444ce62e9eSTejun Heo struct worker_pool *pool; 3845e22bee78STejun Heo 384638db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 38474ce62e9eSTejun Heo struct worker *worker; 38484ce62e9eSTejun Heo 384924647570STejun Heo if (cpu != WORK_CPU_UNBOUND) 385024647570STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 385124647570STejun Heo 3852bc2ae0f5STejun Heo worker = create_worker(pool); 3853e22bee78STejun Heo BUG_ON(!worker); 3854d565ed63STejun Heo spin_lock_irq(&pool->lock); 3855e22bee78STejun Heo start_worker(worker); 3856d565ed63STejun Heo spin_unlock_irq(&pool->lock); 3857e22bee78STejun Heo } 38584ce62e9eSTejun Heo } 3859e22bee78STejun Heo 3860d320c038STejun Heo system_wq = alloc_workqueue("events", 0, 0); 38611aabe902SJoonsoo Kim system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0); 3862d320c038STejun Heo system_long_wq = alloc_workqueue("events_long", 0, 0); 3863f3421797STejun Heo system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, 3864f3421797STejun Heo WQ_UNBOUND_MAX_ACTIVE); 386524d51addSTejun Heo system_freezable_wq = alloc_workqueue("events_freezable", 386624d51addSTejun Heo WQ_FREEZABLE, 0); 38671aabe902SJoonsoo Kim BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq || 3868ae930e0fSTejun Heo !system_unbound_wq || !system_freezable_wq); 38696ee0578bSSuresh Siddha return 0; 38701da177e4SLinus Torvalds } 38716ee0578bSSuresh Siddha early_initcall(init_workqueues); 3872