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 <dwmw2@infradead.org> 8e1f8e874SFrancois Cami * Andrew Morton 91da177e4SLinus Torvalds * Kai Petzke <wpp@marie.physik.tu-berlin.de> 101da177e4SLinus Torvalds * Theodore Ts'o <tytso@mit.edu> 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 <tj@kernel.org> 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 */ 147e19e397aSTejun Heo 148e19e397aSTejun Heo /* 149e19e397aSTejun Heo * The current concurrency level. As it's likely to be accessed 150e19e397aSTejun Heo * from other CPUs during try_to_wake_up(), put it in a separate 151e19e397aSTejun Heo * cacheline. 152e19e397aSTejun Heo */ 153e19e397aSTejun Heo atomic_t nr_running ____cacheline_aligned_in_smp; 1548b03ae3cSTejun Heo } ____cacheline_aligned_in_smp; 1558b03ae3cSTejun Heo 1568b03ae3cSTejun Heo /* 157112202d9STejun Heo * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS 158112202d9STejun Heo * of work_struct->data are used for flags and the remaining high bits 159112202d9STejun Heo * point to the pwq; thus, pwqs need to be aligned at two's power of the 160112202d9STejun Heo * number of flag bits. 1611da177e4SLinus Torvalds */ 162112202d9STejun Heo struct pool_workqueue { 163bd7bdd43STejun Heo struct worker_pool *pool; /* I: the associated pool */ 1644690c4abSTejun Heo struct workqueue_struct *wq; /* I: the owning workqueue */ 16573f53c4aSTejun Heo int work_color; /* L: current color */ 16673f53c4aSTejun Heo int flush_color; /* L: flushing color */ 16773f53c4aSTejun Heo int nr_in_flight[WORK_NR_COLORS]; 16873f53c4aSTejun Heo /* L: nr of in_flight works */ 1691e19ffc6STejun Heo int nr_active; /* L: nr of active works */ 170a0a1a5fdSTejun Heo int max_active; /* L: max active works */ 1711e19ffc6STejun Heo struct list_head delayed_works; /* L: delayed works */ 17230cdf249STejun Heo struct list_head pwqs_node; /* I: node on wq->pwqs */ 173e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS); 1741da177e4SLinus Torvalds 1751da177e4SLinus Torvalds /* 17673f53c4aSTejun Heo * Structure used to wait for workqueue flush. 17773f53c4aSTejun Heo */ 17873f53c4aSTejun Heo struct wq_flusher { 17973f53c4aSTejun Heo struct list_head list; /* F: list of flushers */ 18073f53c4aSTejun Heo int flush_color; /* F: flush color waiting for */ 18173f53c4aSTejun Heo struct completion done; /* flush completion */ 18273f53c4aSTejun Heo }; 1831da177e4SLinus Torvalds 18473f53c4aSTejun Heo /* 185f2e005aaSTejun Heo * All cpumasks are assumed to be always set on UP and thus can't be 186f2e005aaSTejun Heo * used to determine whether there's something to be done. 187f2e005aaSTejun Heo */ 188f2e005aaSTejun Heo #ifdef CONFIG_SMP 189f2e005aaSTejun Heo typedef cpumask_var_t mayday_mask_t; 190f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask) \ 191f2e005aaSTejun Heo cpumask_test_and_set_cpu((cpu), (mask)) 192f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask) cpumask_clear_cpu((cpu), (mask)) 193f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask) for_each_cpu((cpu), (mask)) 1949c37547aSTejun Heo #define alloc_mayday_mask(maskp, gfp) zalloc_cpumask_var((maskp), (gfp)) 195f2e005aaSTejun Heo #define free_mayday_mask(mask) free_cpumask_var((mask)) 196f2e005aaSTejun Heo #else 197f2e005aaSTejun Heo typedef unsigned long mayday_mask_t; 198f2e005aaSTejun Heo #define mayday_test_and_set_cpu(cpu, mask) test_and_set_bit(0, &(mask)) 199f2e005aaSTejun Heo #define mayday_clear_cpu(cpu, mask) clear_bit(0, &(mask)) 200f2e005aaSTejun Heo #define for_each_mayday_cpu(cpu, mask) if ((cpu) = 0, (mask)) 201f2e005aaSTejun Heo #define alloc_mayday_mask(maskp, gfp) true 202f2e005aaSTejun Heo #define free_mayday_mask(mask) do { } while (0) 203f2e005aaSTejun Heo #endif 2041da177e4SLinus Torvalds 2051da177e4SLinus Torvalds /* 2061da177e4SLinus Torvalds * The externally visible workqueue abstraction is an array of 2071da177e4SLinus Torvalds * per-CPU workqueues: 2081da177e4SLinus Torvalds */ 2091da177e4SLinus Torvalds struct workqueue_struct { 2109c5a2ba7STejun Heo unsigned int flags; /* W: WQ_* flags */ 211bdbc5dd7STejun Heo union { 212112202d9STejun Heo struct pool_workqueue __percpu *pcpu; 213112202d9STejun Heo struct pool_workqueue *single; 214bdbc5dd7STejun Heo unsigned long v; 215112202d9STejun Heo } pool_wq; /* I: pwq's */ 21630cdf249STejun Heo struct list_head pwqs; /* I: all pwqs of this wq */ 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 */ 222112202d9STejun Heo atomic_t nr_pwqs_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 */ 231112202d9STejun Heo int saved_max_active; /* W: saved pwq 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 238e904e6c2STejun Heo static struct kmem_cache *pwq_cache; 239e904e6c2STejun Heo 240d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly; 241d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq); 242044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly; 2431aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq); 244044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly; 245d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq); 246044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly; 247f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq); 248044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly; 24924d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq); 250d320c038STejun Heo 25197bd2347STejun Heo #define CREATE_TRACE_POINTS 25297bd2347STejun Heo #include <trace/events/workqueue.h> 25397bd2347STejun Heo 25438db41d9STejun Heo #define for_each_std_worker_pool(pool, cpu) \ 255a60dc39cSTejun Heo for ((pool) = &std_worker_pools(cpu)[0]; \ 256a60dc39cSTejun Heo (pool) < &std_worker_pools(cpu)[NR_STD_WORKER_POOLS]; (pool)++) 2574ce62e9eSTejun Heo 258b67bfe0dSSasha Levin #define for_each_busy_worker(worker, i, pool) \ 259b67bfe0dSSasha Levin hash_for_each(pool->busy_hash, i, worker, hentry) 260db7bccf4STejun Heo 261706026c2STejun Heo static inline int __next_wq_cpu(int cpu, const struct cpumask *mask, 262f3421797STejun Heo unsigned int sw) 263f3421797STejun Heo { 264f3421797STejun Heo if (cpu < nr_cpu_ids) { 265f3421797STejun Heo if (sw & 1) { 266f3421797STejun Heo cpu = cpumask_next(cpu, mask); 267f3421797STejun Heo if (cpu < nr_cpu_ids) 268f3421797STejun Heo return cpu; 269f3421797STejun Heo } 270f3421797STejun Heo if (sw & 2) 271f3421797STejun Heo return WORK_CPU_UNBOUND; 272f3421797STejun Heo } 2736be19588SLai Jiangshan return WORK_CPU_END; 274f3421797STejun Heo } 275f3421797STejun Heo 27609884951STejun Heo /* 27709884951STejun Heo * CPU iterators 27809884951STejun Heo * 279706026c2STejun Heo * An extra cpu number is defined using an invalid cpu number 28009884951STejun Heo * (WORK_CPU_UNBOUND) to host workqueues which are not bound to any 281706026c2STejun Heo * specific CPU. The following iterators are similar to for_each_*_cpu() 282706026c2STejun Heo * iterators but also considers the unbound CPU. 28309884951STejun Heo * 284706026c2STejun Heo * for_each_wq_cpu() : possible CPUs + WORK_CPU_UNBOUND 285706026c2STejun Heo * for_each_online_wq_cpu() : online CPUs + WORK_CPU_UNBOUND 28609884951STejun Heo */ 287706026c2STejun Heo #define for_each_wq_cpu(cpu) \ 288706026c2STejun Heo for ((cpu) = __next_wq_cpu(-1, cpu_possible_mask, 3); \ 2896be19588SLai Jiangshan (cpu) < WORK_CPU_END; \ 290706026c2STejun Heo (cpu) = __next_wq_cpu((cpu), cpu_possible_mask, 3)) 291f3421797STejun Heo 292706026c2STejun Heo #define for_each_online_wq_cpu(cpu) \ 293706026c2STejun Heo for ((cpu) = __next_wq_cpu(-1, cpu_online_mask, 3); \ 2946be19588SLai Jiangshan (cpu) < WORK_CPU_END; \ 295706026c2STejun Heo (cpu) = __next_wq_cpu((cpu), cpu_online_mask, 3)) 296f3421797STejun Heo 29749e3cf44STejun Heo /** 29849e3cf44STejun Heo * for_each_pwq - iterate through all pool_workqueues of the specified workqueue 29949e3cf44STejun Heo * @pwq: iteration cursor 30049e3cf44STejun Heo * @wq: the target workqueue 30149e3cf44STejun Heo */ 30249e3cf44STejun Heo #define for_each_pwq(pwq, wq) \ 30349e3cf44STejun Heo list_for_each_entry((pwq), &(wq)->pwqs, pwqs_node) 304f3421797STejun Heo 305dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 306dc186ad7SThomas Gleixner 307dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr; 308dc186ad7SThomas Gleixner 30999777288SStanislaw Gruszka static void *work_debug_hint(void *addr) 31099777288SStanislaw Gruszka { 31199777288SStanislaw Gruszka return ((struct work_struct *) addr)->func; 31299777288SStanislaw Gruszka } 31399777288SStanislaw Gruszka 314dc186ad7SThomas Gleixner /* 315dc186ad7SThomas Gleixner * fixup_init is called when: 316dc186ad7SThomas Gleixner * - an active object is initialized 317dc186ad7SThomas Gleixner */ 318dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state) 319dc186ad7SThomas Gleixner { 320dc186ad7SThomas Gleixner struct work_struct *work = addr; 321dc186ad7SThomas Gleixner 322dc186ad7SThomas Gleixner switch (state) { 323dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 324dc186ad7SThomas Gleixner cancel_work_sync(work); 325dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 326dc186ad7SThomas Gleixner return 1; 327dc186ad7SThomas Gleixner default: 328dc186ad7SThomas Gleixner return 0; 329dc186ad7SThomas Gleixner } 330dc186ad7SThomas Gleixner } 331dc186ad7SThomas Gleixner 332dc186ad7SThomas Gleixner /* 333dc186ad7SThomas Gleixner * fixup_activate is called when: 334dc186ad7SThomas Gleixner * - an active object is activated 335dc186ad7SThomas Gleixner * - an unknown object is activated (might be a statically initialized object) 336dc186ad7SThomas Gleixner */ 337dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state) 338dc186ad7SThomas Gleixner { 339dc186ad7SThomas Gleixner struct work_struct *work = addr; 340dc186ad7SThomas Gleixner 341dc186ad7SThomas Gleixner switch (state) { 342dc186ad7SThomas Gleixner 343dc186ad7SThomas Gleixner case ODEBUG_STATE_NOTAVAILABLE: 344dc186ad7SThomas Gleixner /* 345dc186ad7SThomas Gleixner * This is not really a fixup. The work struct was 346dc186ad7SThomas Gleixner * statically initialized. We just make sure that it 347dc186ad7SThomas Gleixner * is tracked in the object tracker. 348dc186ad7SThomas Gleixner */ 34922df02bbSTejun Heo if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) { 350dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 351dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 352dc186ad7SThomas Gleixner return 0; 353dc186ad7SThomas Gleixner } 354dc186ad7SThomas Gleixner WARN_ON_ONCE(1); 355dc186ad7SThomas Gleixner return 0; 356dc186ad7SThomas Gleixner 357dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 358dc186ad7SThomas Gleixner WARN_ON(1); 359dc186ad7SThomas Gleixner 360dc186ad7SThomas Gleixner default: 361dc186ad7SThomas Gleixner return 0; 362dc186ad7SThomas Gleixner } 363dc186ad7SThomas Gleixner } 364dc186ad7SThomas Gleixner 365dc186ad7SThomas Gleixner /* 366dc186ad7SThomas Gleixner * fixup_free is called when: 367dc186ad7SThomas Gleixner * - an active object is freed 368dc186ad7SThomas Gleixner */ 369dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state) 370dc186ad7SThomas Gleixner { 371dc186ad7SThomas Gleixner struct work_struct *work = addr; 372dc186ad7SThomas Gleixner 373dc186ad7SThomas Gleixner switch (state) { 374dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 375dc186ad7SThomas Gleixner cancel_work_sync(work); 376dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 377dc186ad7SThomas Gleixner return 1; 378dc186ad7SThomas Gleixner default: 379dc186ad7SThomas Gleixner return 0; 380dc186ad7SThomas Gleixner } 381dc186ad7SThomas Gleixner } 382dc186ad7SThomas Gleixner 383dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = { 384dc186ad7SThomas Gleixner .name = "work_struct", 38599777288SStanislaw Gruszka .debug_hint = work_debug_hint, 386dc186ad7SThomas Gleixner .fixup_init = work_fixup_init, 387dc186ad7SThomas Gleixner .fixup_activate = work_fixup_activate, 388dc186ad7SThomas Gleixner .fixup_free = work_fixup_free, 389dc186ad7SThomas Gleixner }; 390dc186ad7SThomas Gleixner 391dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) 392dc186ad7SThomas Gleixner { 393dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 394dc186ad7SThomas Gleixner } 395dc186ad7SThomas Gleixner 396dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) 397dc186ad7SThomas Gleixner { 398dc186ad7SThomas Gleixner debug_object_deactivate(work, &work_debug_descr); 399dc186ad7SThomas Gleixner } 400dc186ad7SThomas Gleixner 401dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack) 402dc186ad7SThomas Gleixner { 403dc186ad7SThomas Gleixner if (onstack) 404dc186ad7SThomas Gleixner debug_object_init_on_stack(work, &work_debug_descr); 405dc186ad7SThomas Gleixner else 406dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 407dc186ad7SThomas Gleixner } 408dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work); 409dc186ad7SThomas Gleixner 410dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work) 411dc186ad7SThomas Gleixner { 412dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 413dc186ad7SThomas Gleixner } 414dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack); 415dc186ad7SThomas Gleixner 416dc186ad7SThomas Gleixner #else 417dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { } 418dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { } 419dc186ad7SThomas Gleixner #endif 420dc186ad7SThomas Gleixner 42195402b38SGautham R Shenoy /* Serializes the accesses to the list of workqueues. */ 42295402b38SGautham R Shenoy static DEFINE_SPINLOCK(workqueue_lock); 4231da177e4SLinus Torvalds static LIST_HEAD(workqueues); 424a0a1a5fdSTejun Heo static bool workqueue_freezing; /* W: have wqs started freezing? */ 4251da177e4SLinus Torvalds 42614441960SOleg Nesterov /* 427e19e397aSTejun Heo * The CPU and unbound standard worker pools. The unbound ones have 428e19e397aSTejun Heo * POOL_DISASSOCIATED set, and their workers have WORKER_UNBOUND set. 42914441960SOleg Nesterov */ 430e19e397aSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], 431a60dc39cSTejun Heo cpu_std_worker_pools); 432a60dc39cSTejun Heo static struct worker_pool unbound_std_worker_pools[NR_STD_WORKER_POOLS]; 433f3421797STejun Heo 4349daf9e67STejun Heo /* idr of all pools */ 4359daf9e67STejun Heo static DEFINE_MUTEX(worker_pool_idr_mutex); 4369daf9e67STejun Heo static DEFINE_IDR(worker_pool_idr); 4379daf9e67STejun Heo 438c34056a3STejun Heo static int worker_thread(void *__worker); 4391da177e4SLinus Torvalds 440a60dc39cSTejun Heo static struct worker_pool *std_worker_pools(int cpu) 4411da177e4SLinus Torvalds { 442f3421797STejun Heo if (cpu != WORK_CPU_UNBOUND) 443a60dc39cSTejun Heo return per_cpu(cpu_std_worker_pools, cpu); 444f3421797STejun Heo else 445a60dc39cSTejun Heo return unbound_std_worker_pools; 4461da177e4SLinus Torvalds } 4471da177e4SLinus Torvalds 4484e8f0a60STejun Heo static int std_worker_pool_pri(struct worker_pool *pool) 4494e8f0a60STejun Heo { 450a60dc39cSTejun Heo return pool - std_worker_pools(pool->cpu); 4514e8f0a60STejun Heo } 4524e8f0a60STejun Heo 4539daf9e67STejun Heo /* allocate ID and assign it to @pool */ 4549daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool) 4559daf9e67STejun Heo { 4569daf9e67STejun Heo int ret; 4579daf9e67STejun Heo 4589daf9e67STejun Heo mutex_lock(&worker_pool_idr_mutex); 4599daf9e67STejun Heo idr_pre_get(&worker_pool_idr, GFP_KERNEL); 4609daf9e67STejun Heo ret = idr_get_new(&worker_pool_idr, pool, &pool->id); 4619daf9e67STejun Heo mutex_unlock(&worker_pool_idr_mutex); 4629daf9e67STejun Heo 4639daf9e67STejun Heo return ret; 4649daf9e67STejun Heo } 4659daf9e67STejun Heo 4667c3eed5cSTejun Heo /* 4677c3eed5cSTejun Heo * Lookup worker_pool by id. The idr currently is built during boot and 4687c3eed5cSTejun Heo * never modified. Don't worry about locking for now. 4697c3eed5cSTejun Heo */ 4707c3eed5cSTejun Heo static struct worker_pool *worker_pool_by_id(int pool_id) 4717c3eed5cSTejun Heo { 4727c3eed5cSTejun Heo return idr_find(&worker_pool_idr, pool_id); 4737c3eed5cSTejun Heo } 4747c3eed5cSTejun Heo 475d565ed63STejun Heo static struct worker_pool *get_std_worker_pool(int cpu, bool highpri) 476d565ed63STejun Heo { 477a60dc39cSTejun Heo struct worker_pool *pools = std_worker_pools(cpu); 478d565ed63STejun Heo 479a60dc39cSTejun Heo return &pools[highpri]; 480d565ed63STejun Heo } 481d565ed63STejun Heo 482112202d9STejun Heo static struct pool_workqueue *get_pwq(unsigned int cpu, 4834690c4abSTejun Heo struct workqueue_struct *wq) 484a848e3b6SOleg Nesterov { 485f3421797STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 486e06ffa1eSLai Jiangshan if (likely(cpu < nr_cpu_ids)) 487112202d9STejun Heo return per_cpu_ptr(wq->pool_wq.pcpu, cpu); 488f3421797STejun Heo } else if (likely(cpu == WORK_CPU_UNBOUND)) 489112202d9STejun Heo return wq->pool_wq.single; 490f3421797STejun Heo return NULL; 491f3421797STejun Heo } 492a848e3b6SOleg Nesterov 49373f53c4aSTejun Heo static unsigned int work_color_to_flags(int color) 49473f53c4aSTejun Heo { 49573f53c4aSTejun Heo return color << WORK_STRUCT_COLOR_SHIFT; 49673f53c4aSTejun Heo } 49773f53c4aSTejun Heo 49873f53c4aSTejun Heo static int get_work_color(struct work_struct *work) 49973f53c4aSTejun Heo { 50073f53c4aSTejun Heo return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) & 50173f53c4aSTejun Heo ((1 << WORK_STRUCT_COLOR_BITS) - 1); 50273f53c4aSTejun Heo } 50373f53c4aSTejun Heo 50473f53c4aSTejun Heo static int work_next_color(int color) 50573f53c4aSTejun Heo { 50673f53c4aSTejun Heo return (color + 1) % WORK_NR_COLORS; 507b1f4ec17SOleg Nesterov } 508b1f4ec17SOleg Nesterov 5094594bf15SDavid Howells /* 510112202d9STejun Heo * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data 511112202d9STejun Heo * contain the pointer to the queued pwq. Once execution starts, the flag 5127c3eed5cSTejun Heo * is cleared and the high bits contain OFFQ flags and pool ID. 5137a22ad75STejun Heo * 514112202d9STejun Heo * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling() 515112202d9STejun Heo * and clear_work_data() can be used to set the pwq, pool or clear 516bbb68dfaSTejun Heo * work->data. These functions should only be called while the work is 517bbb68dfaSTejun Heo * owned - ie. while the PENDING bit is set. 5187a22ad75STejun Heo * 519112202d9STejun Heo * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq 5207c3eed5cSTejun Heo * corresponding to a work. Pool is available once the work has been 521112202d9STejun Heo * queued anywhere after initialization until it is sync canceled. pwq is 5227c3eed5cSTejun Heo * available only while the work item is queued. 523bbb68dfaSTejun Heo * 524bbb68dfaSTejun Heo * %WORK_OFFQ_CANCELING is used to mark a work item which is being 525bbb68dfaSTejun Heo * canceled. While being canceled, a work item may have its PENDING set 526bbb68dfaSTejun Heo * but stay off timer and worklist for arbitrarily long and nobody should 527bbb68dfaSTejun Heo * try to steal the PENDING bit. 5284594bf15SDavid Howells */ 5297a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data, 5307a22ad75STejun Heo unsigned long flags) 5317a22ad75STejun Heo { 5326183c009STejun Heo WARN_ON_ONCE(!work_pending(work)); 5337a22ad75STejun Heo atomic_long_set(&work->data, data | flags | work_static(work)); 5347a22ad75STejun Heo } 5357a22ad75STejun Heo 536112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq, 5374690c4abSTejun Heo unsigned long extra_flags) 538365970a1SDavid Howells { 539112202d9STejun Heo set_work_data(work, (unsigned long)pwq, 540112202d9STejun Heo WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags); 541365970a1SDavid Howells } 542365970a1SDavid Howells 5434468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work, 5444468a00fSLai Jiangshan int pool_id) 5454468a00fSLai Jiangshan { 5464468a00fSLai Jiangshan set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 5474468a00fSLai Jiangshan WORK_STRUCT_PENDING); 5484468a00fSLai Jiangshan } 5494468a00fSLai Jiangshan 5507c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work, 5517c3eed5cSTejun Heo int pool_id) 5524d707b9fSOleg Nesterov { 55323657bb1STejun Heo /* 55423657bb1STejun Heo * The following wmb is paired with the implied mb in 55523657bb1STejun Heo * test_and_set_bit(PENDING) and ensures all updates to @work made 55623657bb1STejun Heo * here are visible to and precede any updates by the next PENDING 55723657bb1STejun Heo * owner. 55823657bb1STejun Heo */ 55923657bb1STejun Heo smp_wmb(); 5607c3eed5cSTejun Heo set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0); 5614d707b9fSOleg Nesterov } 5624d707b9fSOleg Nesterov 5637a22ad75STejun Heo static void clear_work_data(struct work_struct *work) 564365970a1SDavid Howells { 5657c3eed5cSTejun Heo smp_wmb(); /* see set_work_pool_and_clear_pending() */ 5667c3eed5cSTejun Heo set_work_data(work, WORK_STRUCT_NO_POOL, 0); 5677a22ad75STejun Heo } 5687a22ad75STejun Heo 569112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work) 5707a22ad75STejun Heo { 571e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 5727a22ad75STejun Heo 573112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 574e120153dSTejun Heo return (void *)(data & WORK_STRUCT_WQ_DATA_MASK); 575e120153dSTejun Heo else 576e120153dSTejun Heo return NULL; 5777a22ad75STejun Heo } 5787a22ad75STejun Heo 5797c3eed5cSTejun Heo /** 5807c3eed5cSTejun Heo * get_work_pool - return the worker_pool a given work was associated with 5817c3eed5cSTejun Heo * @work: the work item of interest 5827c3eed5cSTejun Heo * 5837c3eed5cSTejun Heo * Return the worker_pool @work was last associated with. %NULL if none. 5847c3eed5cSTejun Heo */ 5857c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work) 5867a22ad75STejun Heo { 587e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 5887c3eed5cSTejun Heo struct worker_pool *pool; 5897c3eed5cSTejun Heo int pool_id; 5907a22ad75STejun Heo 591112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 592112202d9STejun Heo return ((struct pool_workqueue *) 5937c3eed5cSTejun Heo (data & WORK_STRUCT_WQ_DATA_MASK))->pool; 5947a22ad75STejun Heo 5957c3eed5cSTejun Heo pool_id = data >> WORK_OFFQ_POOL_SHIFT; 5967c3eed5cSTejun Heo if (pool_id == WORK_OFFQ_POOL_NONE) 5977a22ad75STejun Heo return NULL; 5987a22ad75STejun Heo 5997c3eed5cSTejun Heo pool = worker_pool_by_id(pool_id); 6007c3eed5cSTejun Heo WARN_ON_ONCE(!pool); 6017c3eed5cSTejun Heo return pool; 6027c3eed5cSTejun Heo } 6037c3eed5cSTejun Heo 6047c3eed5cSTejun Heo /** 6057c3eed5cSTejun Heo * get_work_pool_id - return the worker pool ID a given work is associated with 6067c3eed5cSTejun Heo * @work: the work item of interest 6077c3eed5cSTejun Heo * 6087c3eed5cSTejun Heo * Return the worker_pool ID @work was last associated with. 6097c3eed5cSTejun Heo * %WORK_OFFQ_POOL_NONE if none. 6107c3eed5cSTejun Heo */ 6117c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work) 6127c3eed5cSTejun Heo { 61354d5b7d0SLai Jiangshan unsigned long data = atomic_long_read(&work->data); 6147c3eed5cSTejun Heo 615112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 616112202d9STejun Heo return ((struct pool_workqueue *) 61754d5b7d0SLai Jiangshan (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id; 61854d5b7d0SLai Jiangshan 61954d5b7d0SLai Jiangshan return data >> WORK_OFFQ_POOL_SHIFT; 6207c3eed5cSTejun Heo } 6217c3eed5cSTejun Heo 622bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work) 623bbb68dfaSTejun Heo { 6247c3eed5cSTejun Heo unsigned long pool_id = get_work_pool_id(work); 625bbb68dfaSTejun Heo 6267c3eed5cSTejun Heo pool_id <<= WORK_OFFQ_POOL_SHIFT; 6277c3eed5cSTejun Heo set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING); 628bbb68dfaSTejun Heo } 629bbb68dfaSTejun Heo 630bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work) 631bbb68dfaSTejun Heo { 632bbb68dfaSTejun Heo unsigned long data = atomic_long_read(&work->data); 633bbb68dfaSTejun Heo 634112202d9STejun Heo return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING); 635bbb68dfaSTejun Heo } 636bbb68dfaSTejun Heo 637e22bee78STejun Heo /* 6383270476aSTejun Heo * Policy functions. These define the policies on how the global worker 6393270476aSTejun Heo * pools are managed. Unless noted otherwise, these functions assume that 640d565ed63STejun Heo * they're being called with pool->lock held. 641e22bee78STejun Heo */ 642e22bee78STejun Heo 64363d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool) 644649027d7STejun Heo { 645e19e397aSTejun Heo return !atomic_read(&pool->nr_running); 646649027d7STejun Heo } 647649027d7STejun Heo 648e22bee78STejun Heo /* 649e22bee78STejun Heo * Need to wake up a worker? Called from anything but currently 650e22bee78STejun Heo * running workers. 651974271c4STejun Heo * 652974271c4STejun Heo * Note that, because unbound workers never contribute to nr_running, this 653706026c2STejun Heo * function will always return %true for unbound pools as long as the 654974271c4STejun Heo * worklist isn't empty. 655e22bee78STejun Heo */ 65663d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool) 657e22bee78STejun Heo { 65863d95a91STejun Heo return !list_empty(&pool->worklist) && __need_more_worker(pool); 659e22bee78STejun Heo } 660e22bee78STejun Heo 661e22bee78STejun Heo /* Can I start working? Called from busy but !running workers. */ 66263d95a91STejun Heo static bool may_start_working(struct worker_pool *pool) 663e22bee78STejun Heo { 66463d95a91STejun Heo return pool->nr_idle; 665e22bee78STejun Heo } 666e22bee78STejun Heo 667e22bee78STejun Heo /* Do I need to keep working? Called from currently running workers. */ 66863d95a91STejun Heo static bool keep_working(struct worker_pool *pool) 669e22bee78STejun Heo { 670e19e397aSTejun Heo return !list_empty(&pool->worklist) && 671e19e397aSTejun Heo atomic_read(&pool->nr_running) <= 1; 672e22bee78STejun Heo } 673e22bee78STejun Heo 674e22bee78STejun Heo /* Do we need a new worker? Called from manager. */ 67563d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool) 676e22bee78STejun Heo { 67763d95a91STejun Heo return need_more_worker(pool) && !may_start_working(pool); 678e22bee78STejun Heo } 679e22bee78STejun Heo 680e22bee78STejun Heo /* Do I need to be the manager? */ 68163d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool) 682e22bee78STejun Heo { 68363d95a91STejun Heo return need_to_create_worker(pool) || 68411ebea50STejun Heo (pool->flags & POOL_MANAGE_WORKERS); 685e22bee78STejun Heo } 686e22bee78STejun Heo 687e22bee78STejun Heo /* Do we have too many workers and should some go away? */ 68863d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool) 689e22bee78STejun Heo { 690552a37e9SLai Jiangshan bool managing = pool->flags & POOL_MANAGING_WORKERS; 69163d95a91STejun Heo int nr_idle = pool->nr_idle + managing; /* manager is considered idle */ 69263d95a91STejun Heo int nr_busy = pool->nr_workers - nr_idle; 693e22bee78STejun Heo 694ea1abd61SLai Jiangshan /* 695ea1abd61SLai Jiangshan * nr_idle and idle_list may disagree if idle rebinding is in 696ea1abd61SLai Jiangshan * progress. Never return %true if idle_list is empty. 697ea1abd61SLai Jiangshan */ 698ea1abd61SLai Jiangshan if (list_empty(&pool->idle_list)) 699ea1abd61SLai Jiangshan return false; 700ea1abd61SLai Jiangshan 701e22bee78STejun Heo return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; 702e22bee78STejun Heo } 703e22bee78STejun Heo 704e22bee78STejun Heo /* 705e22bee78STejun Heo * Wake up functions. 706e22bee78STejun Heo */ 707e22bee78STejun Heo 7087e11629dSTejun Heo /* Return the first worker. Safe with preemption disabled */ 70963d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool) 7107e11629dSTejun Heo { 71163d95a91STejun Heo if (unlikely(list_empty(&pool->idle_list))) 7127e11629dSTejun Heo return NULL; 7137e11629dSTejun Heo 71463d95a91STejun Heo return list_first_entry(&pool->idle_list, struct worker, entry); 7157e11629dSTejun Heo } 7167e11629dSTejun Heo 7177e11629dSTejun Heo /** 7187e11629dSTejun Heo * wake_up_worker - wake up an idle worker 71963d95a91STejun Heo * @pool: worker pool to wake worker from 7207e11629dSTejun Heo * 72163d95a91STejun Heo * Wake up the first idle worker of @pool. 7227e11629dSTejun Heo * 7237e11629dSTejun Heo * CONTEXT: 724d565ed63STejun Heo * spin_lock_irq(pool->lock). 7257e11629dSTejun Heo */ 72663d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool) 7277e11629dSTejun Heo { 72863d95a91STejun Heo struct worker *worker = first_worker(pool); 7297e11629dSTejun Heo 7307e11629dSTejun Heo if (likely(worker)) 7317e11629dSTejun Heo wake_up_process(worker->task); 7327e11629dSTejun Heo } 7337e11629dSTejun Heo 7344690c4abSTejun Heo /** 735e22bee78STejun Heo * wq_worker_waking_up - a worker is waking up 736e22bee78STejun Heo * @task: task waking up 737e22bee78STejun Heo * @cpu: CPU @task is waking up to 738e22bee78STejun Heo * 739e22bee78STejun Heo * This function is called during try_to_wake_up() when a worker is 740e22bee78STejun Heo * being awoken. 741e22bee78STejun Heo * 742e22bee78STejun Heo * CONTEXT: 743e22bee78STejun Heo * spin_lock_irq(rq->lock) 744e22bee78STejun Heo */ 745e22bee78STejun Heo void wq_worker_waking_up(struct task_struct *task, unsigned int cpu) 746e22bee78STejun Heo { 747e22bee78STejun Heo struct worker *worker = kthread_data(task); 748e22bee78STejun Heo 74936576000SJoonsoo Kim if (!(worker->flags & WORKER_NOT_RUNNING)) { 750ec22ca5eSTejun Heo WARN_ON_ONCE(worker->pool->cpu != cpu); 751e19e397aSTejun Heo atomic_inc(&worker->pool->nr_running); 752e22bee78STejun Heo } 75336576000SJoonsoo Kim } 754e22bee78STejun Heo 755e22bee78STejun Heo /** 756e22bee78STejun Heo * wq_worker_sleeping - a worker is going to sleep 757e22bee78STejun Heo * @task: task going to sleep 758e22bee78STejun Heo * @cpu: CPU in question, must be the current CPU number 759e22bee78STejun Heo * 760e22bee78STejun Heo * This function is called during schedule() when a busy worker is 761e22bee78STejun Heo * going to sleep. Worker on the same cpu can be woken up by 762e22bee78STejun Heo * returning pointer to its task. 763e22bee78STejun Heo * 764e22bee78STejun Heo * CONTEXT: 765e22bee78STejun Heo * spin_lock_irq(rq->lock) 766e22bee78STejun Heo * 767e22bee78STejun Heo * RETURNS: 768e22bee78STejun Heo * Worker task on @cpu to wake up, %NULL if none. 769e22bee78STejun Heo */ 770e22bee78STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task, 771e22bee78STejun Heo unsigned int cpu) 772e22bee78STejun Heo { 773e22bee78STejun Heo struct worker *worker = kthread_data(task), *to_wakeup = NULL; 774111c225aSTejun Heo struct worker_pool *pool; 775e22bee78STejun Heo 776111c225aSTejun Heo /* 777111c225aSTejun Heo * Rescuers, which may not have all the fields set up like normal 778111c225aSTejun Heo * workers, also reach here, let's not access anything before 779111c225aSTejun Heo * checking NOT_RUNNING. 780111c225aSTejun Heo */ 7812d64672eSSteven Rostedt if (worker->flags & WORKER_NOT_RUNNING) 782e22bee78STejun Heo return NULL; 783e22bee78STejun Heo 784111c225aSTejun Heo pool = worker->pool; 785111c225aSTejun Heo 786e22bee78STejun Heo /* this can only happen on the local cpu */ 7876183c009STejun Heo if (WARN_ON_ONCE(cpu != raw_smp_processor_id())) 7886183c009STejun Heo return NULL; 789e22bee78STejun Heo 790e22bee78STejun Heo /* 791e22bee78STejun Heo * The counterpart of the following dec_and_test, implied mb, 792e22bee78STejun Heo * worklist not empty test sequence is in insert_work(). 793e22bee78STejun Heo * Please read comment there. 794e22bee78STejun Heo * 795628c78e7STejun Heo * NOT_RUNNING is clear. This means that we're bound to and 796628c78e7STejun Heo * running on the local cpu w/ rq lock held and preemption 797628c78e7STejun Heo * disabled, which in turn means that none else could be 798d565ed63STejun Heo * manipulating idle_list, so dereferencing idle_list without pool 799628c78e7STejun Heo * lock is safe. 800e22bee78STejun Heo */ 801e19e397aSTejun Heo if (atomic_dec_and_test(&pool->nr_running) && 802e19e397aSTejun Heo !list_empty(&pool->worklist)) 80363d95a91STejun Heo to_wakeup = first_worker(pool); 804e22bee78STejun Heo return to_wakeup ? to_wakeup->task : NULL; 805e22bee78STejun Heo } 806e22bee78STejun Heo 807e22bee78STejun Heo /** 808e22bee78STejun Heo * worker_set_flags - set worker flags and adjust nr_running accordingly 809cb444766STejun Heo * @worker: self 810d302f017STejun Heo * @flags: flags to set 811d302f017STejun Heo * @wakeup: wakeup an idle worker if necessary 812d302f017STejun Heo * 813e22bee78STejun Heo * Set @flags in @worker->flags and adjust nr_running accordingly. If 814e22bee78STejun Heo * nr_running becomes zero and @wakeup is %true, an idle worker is 815e22bee78STejun Heo * woken up. 816d302f017STejun Heo * 817cb444766STejun Heo * CONTEXT: 818d565ed63STejun Heo * spin_lock_irq(pool->lock) 819d302f017STejun Heo */ 820d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags, 821d302f017STejun Heo bool wakeup) 822d302f017STejun Heo { 823bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 824e22bee78STejun Heo 825cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 826cb444766STejun Heo 827e22bee78STejun Heo /* 828e22bee78STejun Heo * If transitioning into NOT_RUNNING, adjust nr_running and 829e22bee78STejun Heo * wake up an idle worker as necessary if requested by 830e22bee78STejun Heo * @wakeup. 831e22bee78STejun Heo */ 832e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && 833e22bee78STejun Heo !(worker->flags & WORKER_NOT_RUNNING)) { 834e22bee78STejun Heo if (wakeup) { 835e19e397aSTejun Heo if (atomic_dec_and_test(&pool->nr_running) && 836bd7bdd43STejun Heo !list_empty(&pool->worklist)) 83763d95a91STejun Heo wake_up_worker(pool); 838e22bee78STejun Heo } else 839e19e397aSTejun Heo atomic_dec(&pool->nr_running); 840e22bee78STejun Heo } 841e22bee78STejun Heo 842d302f017STejun Heo worker->flags |= flags; 843d302f017STejun Heo } 844d302f017STejun Heo 845d302f017STejun Heo /** 846e22bee78STejun Heo * worker_clr_flags - clear worker flags and adjust nr_running accordingly 847cb444766STejun Heo * @worker: self 848d302f017STejun Heo * @flags: flags to clear 849d302f017STejun Heo * 850e22bee78STejun Heo * Clear @flags in @worker->flags and adjust nr_running accordingly. 851d302f017STejun Heo * 852cb444766STejun Heo * CONTEXT: 853d565ed63STejun Heo * spin_lock_irq(pool->lock) 854d302f017STejun Heo */ 855d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags) 856d302f017STejun Heo { 85763d95a91STejun Heo struct worker_pool *pool = worker->pool; 858e22bee78STejun Heo unsigned int oflags = worker->flags; 859e22bee78STejun Heo 860cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 861cb444766STejun Heo 862d302f017STejun Heo worker->flags &= ~flags; 863e22bee78STejun Heo 86442c025f3STejun Heo /* 86542c025f3STejun Heo * If transitioning out of NOT_RUNNING, increment nr_running. Note 86642c025f3STejun Heo * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask 86742c025f3STejun Heo * of multiple flags, not a single flag. 86842c025f3STejun Heo */ 869e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) 870e22bee78STejun Heo if (!(worker->flags & WORKER_NOT_RUNNING)) 871e19e397aSTejun Heo atomic_inc(&pool->nr_running); 872d302f017STejun Heo } 873d302f017STejun Heo 874d302f017STejun Heo /** 8758cca0eeaSTejun Heo * find_worker_executing_work - find worker which is executing a work 876c9e7cf27STejun Heo * @pool: pool of interest 8778cca0eeaSTejun Heo * @work: work to find worker for 8788cca0eeaSTejun Heo * 879c9e7cf27STejun Heo * Find a worker which is executing @work on @pool by searching 880c9e7cf27STejun Heo * @pool->busy_hash which is keyed by the address of @work. For a worker 881a2c1c57bSTejun Heo * to match, its current execution should match the address of @work and 882a2c1c57bSTejun Heo * its work function. This is to avoid unwanted dependency between 883a2c1c57bSTejun Heo * unrelated work executions through a work item being recycled while still 884a2c1c57bSTejun Heo * being executed. 885a2c1c57bSTejun Heo * 886a2c1c57bSTejun Heo * This is a bit tricky. A work item may be freed once its execution 887a2c1c57bSTejun Heo * starts and nothing prevents the freed area from being recycled for 888a2c1c57bSTejun Heo * another work item. If the same work item address ends up being reused 889a2c1c57bSTejun Heo * before the original execution finishes, workqueue will identify the 890a2c1c57bSTejun Heo * recycled work item as currently executing and make it wait until the 891a2c1c57bSTejun Heo * current execution finishes, introducing an unwanted dependency. 892a2c1c57bSTejun Heo * 893a2c1c57bSTejun Heo * This function checks the work item address, work function and workqueue 894a2c1c57bSTejun Heo * to avoid false positives. Note that this isn't complete as one may 895a2c1c57bSTejun Heo * construct a work function which can introduce dependency onto itself 896a2c1c57bSTejun Heo * through a recycled work item. Well, if somebody wants to shoot oneself 897a2c1c57bSTejun Heo * in the foot that badly, there's only so much we can do, and if such 898a2c1c57bSTejun Heo * deadlock actually occurs, it should be easy to locate the culprit work 899a2c1c57bSTejun Heo * function. 9008cca0eeaSTejun Heo * 9018cca0eeaSTejun Heo * CONTEXT: 902d565ed63STejun Heo * spin_lock_irq(pool->lock). 9038cca0eeaSTejun Heo * 9048cca0eeaSTejun Heo * RETURNS: 9058cca0eeaSTejun Heo * Pointer to worker which is executing @work if found, NULL 9068cca0eeaSTejun Heo * otherwise. 9078cca0eeaSTejun Heo */ 908c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool, 9098cca0eeaSTejun Heo struct work_struct *work) 9108cca0eeaSTejun Heo { 91142f8570fSSasha Levin struct worker *worker; 91242f8570fSSasha Levin 913b67bfe0dSSasha Levin hash_for_each_possible(pool->busy_hash, worker, hentry, 914a2c1c57bSTejun Heo (unsigned long)work) 915a2c1c57bSTejun Heo if (worker->current_work == work && 916a2c1c57bSTejun Heo worker->current_func == work->func) 91742f8570fSSasha Levin return worker; 91842f8570fSSasha Levin 91942f8570fSSasha Levin return NULL; 9208cca0eeaSTejun Heo } 9218cca0eeaSTejun Heo 9228cca0eeaSTejun Heo /** 923bf4ede01STejun Heo * move_linked_works - move linked works to a list 924bf4ede01STejun Heo * @work: start of series of works to be scheduled 925bf4ede01STejun Heo * @head: target list to append @work to 926bf4ede01STejun Heo * @nextp: out paramter for nested worklist walking 927bf4ede01STejun Heo * 928bf4ede01STejun Heo * Schedule linked works starting from @work to @head. Work series to 929bf4ede01STejun Heo * be scheduled starts at @work and includes any consecutive work with 930bf4ede01STejun Heo * WORK_STRUCT_LINKED set in its predecessor. 931bf4ede01STejun Heo * 932bf4ede01STejun Heo * If @nextp is not NULL, it's updated to point to the next work of 933bf4ede01STejun Heo * the last scheduled work. This allows move_linked_works() to be 934bf4ede01STejun Heo * nested inside outer list_for_each_entry_safe(). 935bf4ede01STejun Heo * 936bf4ede01STejun Heo * CONTEXT: 937d565ed63STejun Heo * spin_lock_irq(pool->lock). 938bf4ede01STejun Heo */ 939bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head, 940bf4ede01STejun Heo struct work_struct **nextp) 941bf4ede01STejun Heo { 942bf4ede01STejun Heo struct work_struct *n; 943bf4ede01STejun Heo 944bf4ede01STejun Heo /* 945bf4ede01STejun Heo * Linked worklist will always end before the end of the list, 946bf4ede01STejun Heo * use NULL for list head. 947bf4ede01STejun Heo */ 948bf4ede01STejun Heo list_for_each_entry_safe_from(work, n, NULL, entry) { 949bf4ede01STejun Heo list_move_tail(&work->entry, head); 950bf4ede01STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) 951bf4ede01STejun Heo break; 952bf4ede01STejun Heo } 953bf4ede01STejun Heo 954bf4ede01STejun Heo /* 955bf4ede01STejun Heo * If we're already inside safe list traversal and have moved 956bf4ede01STejun Heo * multiple works to the scheduled queue, the next position 957bf4ede01STejun Heo * needs to be updated. 958bf4ede01STejun Heo */ 959bf4ede01STejun Heo if (nextp) 960bf4ede01STejun Heo *nextp = n; 961bf4ede01STejun Heo } 962bf4ede01STejun Heo 963112202d9STejun Heo static void pwq_activate_delayed_work(struct work_struct *work) 964bf4ede01STejun Heo { 965112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 966bf4ede01STejun Heo 967bf4ede01STejun Heo trace_workqueue_activate_work(work); 968112202d9STejun Heo move_linked_works(work, &pwq->pool->worklist, NULL); 969bf4ede01STejun Heo __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work)); 970112202d9STejun Heo pwq->nr_active++; 971bf4ede01STejun Heo } 972bf4ede01STejun Heo 973112202d9STejun Heo static void pwq_activate_first_delayed(struct pool_workqueue *pwq) 9743aa62497SLai Jiangshan { 975112202d9STejun Heo struct work_struct *work = list_first_entry(&pwq->delayed_works, 9763aa62497SLai Jiangshan struct work_struct, entry); 9773aa62497SLai Jiangshan 978112202d9STejun Heo pwq_activate_delayed_work(work); 9793aa62497SLai Jiangshan } 9803aa62497SLai Jiangshan 981bf4ede01STejun Heo /** 982112202d9STejun Heo * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight 983112202d9STejun Heo * @pwq: pwq of interest 984bf4ede01STejun Heo * @color: color of work which left the queue 985bf4ede01STejun Heo * 986bf4ede01STejun Heo * A work either has completed or is removed from pending queue, 987112202d9STejun Heo * decrement nr_in_flight of its pwq and handle workqueue flushing. 988bf4ede01STejun Heo * 989bf4ede01STejun Heo * CONTEXT: 990d565ed63STejun Heo * spin_lock_irq(pool->lock). 991bf4ede01STejun Heo */ 992112202d9STejun Heo static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color) 993bf4ede01STejun Heo { 994bf4ede01STejun Heo /* ignore uncolored works */ 995bf4ede01STejun Heo if (color == WORK_NO_COLOR) 996bf4ede01STejun Heo return; 997bf4ede01STejun Heo 998112202d9STejun Heo pwq->nr_in_flight[color]--; 999bf4ede01STejun Heo 1000112202d9STejun Heo pwq->nr_active--; 1001112202d9STejun Heo if (!list_empty(&pwq->delayed_works)) { 1002bf4ede01STejun Heo /* one down, submit a delayed one */ 1003112202d9STejun Heo if (pwq->nr_active < pwq->max_active) 1004112202d9STejun Heo pwq_activate_first_delayed(pwq); 1005bf4ede01STejun Heo } 1006bf4ede01STejun Heo 1007bf4ede01STejun Heo /* is flush in progress and are we at the flushing tip? */ 1008112202d9STejun Heo if (likely(pwq->flush_color != color)) 1009bf4ede01STejun Heo return; 1010bf4ede01STejun Heo 1011bf4ede01STejun Heo /* are there still in-flight works? */ 1012112202d9STejun Heo if (pwq->nr_in_flight[color]) 1013bf4ede01STejun Heo return; 1014bf4ede01STejun Heo 1015112202d9STejun Heo /* this pwq is done, clear flush_color */ 1016112202d9STejun Heo pwq->flush_color = -1; 1017bf4ede01STejun Heo 1018bf4ede01STejun Heo /* 1019112202d9STejun Heo * If this was the last pwq, wake up the first flusher. It 1020bf4ede01STejun Heo * will handle the rest. 1021bf4ede01STejun Heo */ 1022112202d9STejun Heo if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush)) 1023112202d9STejun Heo complete(&pwq->wq->first_flusher->done); 1024bf4ede01STejun Heo } 1025bf4ede01STejun Heo 102636e227d2STejun Heo /** 1027bbb68dfaSTejun Heo * try_to_grab_pending - steal work item from worklist and disable irq 102836e227d2STejun Heo * @work: work item to steal 102936e227d2STejun Heo * @is_dwork: @work is a delayed_work 1030bbb68dfaSTejun Heo * @flags: place to store irq state 103136e227d2STejun Heo * 103236e227d2STejun Heo * Try to grab PENDING bit of @work. This function can handle @work in any 103336e227d2STejun Heo * stable state - idle, on timer or on worklist. Return values are 103436e227d2STejun Heo * 103536e227d2STejun Heo * 1 if @work was pending and we successfully stole PENDING 103636e227d2STejun Heo * 0 if @work was idle and we claimed PENDING 103736e227d2STejun Heo * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry 1038bbb68dfaSTejun Heo * -ENOENT if someone else is canceling @work, this state may persist 1039bbb68dfaSTejun Heo * for arbitrarily long 104036e227d2STejun Heo * 1041bbb68dfaSTejun Heo * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting 1042e0aecdd8STejun Heo * interrupted while holding PENDING and @work off queue, irq must be 1043e0aecdd8STejun Heo * disabled on entry. This, combined with delayed_work->timer being 1044e0aecdd8STejun Heo * irqsafe, ensures that we return -EAGAIN for finite short period of time. 1045bbb68dfaSTejun Heo * 1046bbb68dfaSTejun Heo * On successful return, >= 0, irq is disabled and the caller is 1047bbb68dfaSTejun Heo * responsible for releasing it using local_irq_restore(*@flags). 1048bbb68dfaSTejun Heo * 1049e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 1050bf4ede01STejun Heo */ 1051bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork, 1052bbb68dfaSTejun Heo unsigned long *flags) 1053bf4ede01STejun Heo { 1054d565ed63STejun Heo struct worker_pool *pool; 1055112202d9STejun Heo struct pool_workqueue *pwq; 1056bf4ede01STejun Heo 1057bbb68dfaSTejun Heo local_irq_save(*flags); 1058bbb68dfaSTejun Heo 105936e227d2STejun Heo /* try to steal the timer if it exists */ 106036e227d2STejun Heo if (is_dwork) { 106136e227d2STejun Heo struct delayed_work *dwork = to_delayed_work(work); 106236e227d2STejun Heo 1063e0aecdd8STejun Heo /* 1064e0aecdd8STejun Heo * dwork->timer is irqsafe. If del_timer() fails, it's 1065e0aecdd8STejun Heo * guaranteed that the timer is not queued anywhere and not 1066e0aecdd8STejun Heo * running on the local CPU. 1067e0aecdd8STejun Heo */ 106836e227d2STejun Heo if (likely(del_timer(&dwork->timer))) 106936e227d2STejun Heo return 1; 107036e227d2STejun Heo } 107136e227d2STejun Heo 107236e227d2STejun Heo /* try to claim PENDING the normal way */ 1073bf4ede01STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) 1074bf4ede01STejun Heo return 0; 1075bf4ede01STejun Heo 1076bf4ede01STejun Heo /* 1077bf4ede01STejun Heo * The queueing is in progress, or it is already queued. Try to 1078bf4ede01STejun Heo * steal it from ->worklist without clearing WORK_STRUCT_PENDING. 1079bf4ede01STejun Heo */ 1080d565ed63STejun Heo pool = get_work_pool(work); 1081d565ed63STejun Heo if (!pool) 1082bbb68dfaSTejun Heo goto fail; 1083bf4ede01STejun Heo 1084d565ed63STejun Heo spin_lock(&pool->lock); 1085bf4ede01STejun Heo /* 1086112202d9STejun Heo * work->data is guaranteed to point to pwq only while the work 1087112202d9STejun Heo * item is queued on pwq->wq, and both updating work->data to point 1088112202d9STejun Heo * to pwq on queueing and to pool on dequeueing are done under 1089112202d9STejun Heo * pwq->pool->lock. This in turn guarantees that, if work->data 1090112202d9STejun Heo * points to pwq which is associated with a locked pool, the work 10910b3dae68SLai Jiangshan * item is currently queued on that pool. 1092bf4ede01STejun Heo */ 1093112202d9STejun Heo pwq = get_work_pwq(work); 1094112202d9STejun Heo if (pwq && pwq->pool == pool) { 1095bf4ede01STejun Heo debug_work_deactivate(work); 10963aa62497SLai Jiangshan 10973aa62497SLai Jiangshan /* 109816062836STejun Heo * A delayed work item cannot be grabbed directly because 109916062836STejun Heo * it might have linked NO_COLOR work items which, if left 1100112202d9STejun Heo * on the delayed_list, will confuse pwq->nr_active 110116062836STejun Heo * management later on and cause stall. Make sure the work 110216062836STejun Heo * item is activated before grabbing. 11033aa62497SLai Jiangshan */ 11043aa62497SLai Jiangshan if (*work_data_bits(work) & WORK_STRUCT_DELAYED) 1105112202d9STejun Heo pwq_activate_delayed_work(work); 11063aa62497SLai Jiangshan 1107bf4ede01STejun Heo list_del_init(&work->entry); 1108112202d9STejun Heo pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work)); 110936e227d2STejun Heo 1110112202d9STejun Heo /* work->data points to pwq iff queued, point to pool */ 11114468a00fSLai Jiangshan set_work_pool_and_keep_pending(work, pool->id); 11124468a00fSLai Jiangshan 1113d565ed63STejun Heo spin_unlock(&pool->lock); 111436e227d2STejun Heo return 1; 1115bf4ede01STejun Heo } 1116d565ed63STejun Heo spin_unlock(&pool->lock); 1117bbb68dfaSTejun Heo fail: 1118bbb68dfaSTejun Heo local_irq_restore(*flags); 1119bbb68dfaSTejun Heo if (work_is_canceling(work)) 1120bbb68dfaSTejun Heo return -ENOENT; 1121bbb68dfaSTejun Heo cpu_relax(); 112236e227d2STejun Heo return -EAGAIN; 1123bf4ede01STejun Heo } 1124bf4ede01STejun Heo 1125bf4ede01STejun Heo /** 1126706026c2STejun Heo * insert_work - insert a work into a pool 1127112202d9STejun Heo * @pwq: pwq @work belongs to 11284690c4abSTejun Heo * @work: work to insert 11294690c4abSTejun Heo * @head: insertion point 11304690c4abSTejun Heo * @extra_flags: extra WORK_STRUCT_* flags to set 11314690c4abSTejun Heo * 1132112202d9STejun Heo * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to 1133706026c2STejun Heo * work_struct flags. 11344690c4abSTejun Heo * 11354690c4abSTejun Heo * CONTEXT: 1136d565ed63STejun Heo * spin_lock_irq(pool->lock). 1137365970a1SDavid Howells */ 1138112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work, 1139112202d9STejun Heo struct list_head *head, unsigned int extra_flags) 1140b89deed3SOleg Nesterov { 1141112202d9STejun Heo struct worker_pool *pool = pwq->pool; 1142e1d8aa9fSFrederic Weisbecker 11434690c4abSTejun Heo /* we own @work, set data and link */ 1144112202d9STejun Heo set_work_pwq(work, pwq, extra_flags); 11451a4d9b0aSOleg Nesterov list_add_tail(&work->entry, head); 1146e22bee78STejun Heo 1147e22bee78STejun Heo /* 1148e22bee78STejun Heo * Ensure either worker_sched_deactivated() sees the above 1149e22bee78STejun Heo * list_add_tail() or we see zero nr_running to avoid workers 1150e22bee78STejun Heo * lying around lazily while there are works to be processed. 1151e22bee78STejun Heo */ 1152e22bee78STejun Heo smp_mb(); 1153e22bee78STejun Heo 115463d95a91STejun Heo if (__need_more_worker(pool)) 115563d95a91STejun Heo wake_up_worker(pool); 1156b89deed3SOleg Nesterov } 1157b89deed3SOleg Nesterov 1158c8efcc25STejun Heo /* 1159c8efcc25STejun Heo * Test whether @work is being queued from another work executing on the 11608d03ecfeSTejun Heo * same workqueue. 1161c8efcc25STejun Heo */ 1162c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq) 1163c8efcc25STejun Heo { 1164c8efcc25STejun Heo struct worker *worker; 1165c8efcc25STejun Heo 11668d03ecfeSTejun Heo worker = current_wq_worker(); 1167c8efcc25STejun Heo /* 11688d03ecfeSTejun Heo * Return %true iff I'm a worker execuing a work item on @wq. If 11698d03ecfeSTejun Heo * I'm @worker, it's safe to dereference it without locking. 1170c8efcc25STejun Heo */ 1171112202d9STejun Heo return worker && worker->current_pwq->wq == wq; 1172c8efcc25STejun Heo } 1173c8efcc25STejun Heo 11744690c4abSTejun Heo static void __queue_work(unsigned int cpu, struct workqueue_struct *wq, 11751da177e4SLinus Torvalds struct work_struct *work) 11761da177e4SLinus Torvalds { 1177112202d9STejun Heo struct pool_workqueue *pwq; 11781e19ffc6STejun Heo struct list_head *worklist; 11798a2e8e5dSTejun Heo unsigned int work_flags; 1180b75cac93SJoonsoo Kim unsigned int req_cpu = cpu; 11818930cabaSTejun Heo 11828930cabaSTejun Heo /* 11838930cabaSTejun Heo * While a work item is PENDING && off queue, a task trying to 11848930cabaSTejun Heo * steal the PENDING will busy-loop waiting for it to either get 11858930cabaSTejun Heo * queued or lose PENDING. Grabbing PENDING and queueing should 11868930cabaSTejun Heo * happen with IRQ disabled. 11878930cabaSTejun Heo */ 11888930cabaSTejun Heo WARN_ON_ONCE(!irqs_disabled()); 11891da177e4SLinus Torvalds 1190dc186ad7SThomas Gleixner debug_work_activate(work); 11911e19ffc6STejun Heo 1192c8efcc25STejun Heo /* if dying, only works from the same workqueue are allowed */ 11939c5a2ba7STejun Heo if (unlikely(wq->flags & WQ_DRAINING) && 1194c8efcc25STejun Heo WARN_ON_ONCE(!is_chained_work(wq))) 1195e41e704bSTejun Heo return; 1196e41e704bSTejun Heo 1197112202d9STejun Heo /* determine the pwq to use */ 1198c7fc77f7STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 1199c9e7cf27STejun Heo struct worker_pool *last_pool; 1200c7fc77f7STejun Heo 120157469821STejun Heo if (cpu == WORK_CPU_UNBOUND) 1202f3421797STejun Heo cpu = raw_smp_processor_id(); 1203f3421797STejun Heo 120418aa9effSTejun Heo /* 1205dbf2576eSTejun Heo * It's multi cpu. If @work was previously on a different 1206dbf2576eSTejun Heo * cpu, it might still be running there, in which case the 1207dbf2576eSTejun Heo * work needs to be queued on that cpu to guarantee 1208dbf2576eSTejun Heo * non-reentrancy. 120918aa9effSTejun Heo */ 1210112202d9STejun Heo pwq = get_pwq(cpu, wq); 1211c9e7cf27STejun Heo last_pool = get_work_pool(work); 1212dbf2576eSTejun Heo 1213112202d9STejun Heo if (last_pool && last_pool != pwq->pool) { 121418aa9effSTejun Heo struct worker *worker; 121518aa9effSTejun Heo 1216d565ed63STejun Heo spin_lock(&last_pool->lock); 121718aa9effSTejun Heo 1218c9e7cf27STejun Heo worker = find_worker_executing_work(last_pool, work); 121918aa9effSTejun Heo 1220112202d9STejun Heo if (worker && worker->current_pwq->wq == wq) { 1221112202d9STejun Heo pwq = get_pwq(last_pool->cpu, wq); 12228594fadeSLai Jiangshan } else { 122318aa9effSTejun Heo /* meh... not running there, queue here */ 1224d565ed63STejun Heo spin_unlock(&last_pool->lock); 1225112202d9STejun Heo spin_lock(&pwq->pool->lock); 122618aa9effSTejun Heo } 12278930cabaSTejun Heo } else { 1228112202d9STejun Heo spin_lock(&pwq->pool->lock); 12298930cabaSTejun Heo } 1230f3421797STejun Heo } else { 1231112202d9STejun Heo pwq = get_pwq(WORK_CPU_UNBOUND, wq); 1232112202d9STejun Heo spin_lock(&pwq->pool->lock); 1233502ca9d8STejun Heo } 1234502ca9d8STejun Heo 1235112202d9STejun Heo /* pwq determined, queue */ 1236112202d9STejun Heo trace_workqueue_queue_work(req_cpu, pwq, work); 1237502ca9d8STejun Heo 1238f5b2552bSDan Carpenter if (WARN_ON(!list_empty(&work->entry))) { 1239112202d9STejun Heo spin_unlock(&pwq->pool->lock); 1240f5b2552bSDan Carpenter return; 1241f5b2552bSDan Carpenter } 12421e19ffc6STejun Heo 1243112202d9STejun Heo pwq->nr_in_flight[pwq->work_color]++; 1244112202d9STejun Heo work_flags = work_color_to_flags(pwq->work_color); 12451e19ffc6STejun Heo 1246112202d9STejun Heo if (likely(pwq->nr_active < pwq->max_active)) { 1247cdadf009STejun Heo trace_workqueue_activate_work(work); 1248112202d9STejun Heo pwq->nr_active++; 1249112202d9STejun Heo worklist = &pwq->pool->worklist; 12508a2e8e5dSTejun Heo } else { 12518a2e8e5dSTejun Heo work_flags |= WORK_STRUCT_DELAYED; 1252112202d9STejun Heo worklist = &pwq->delayed_works; 12538a2e8e5dSTejun Heo } 12541e19ffc6STejun Heo 1255112202d9STejun Heo insert_work(pwq, work, worklist, work_flags); 12561e19ffc6STejun Heo 1257112202d9STejun Heo spin_unlock(&pwq->pool->lock); 12581da177e4SLinus Torvalds } 12591da177e4SLinus Torvalds 12600fcb78c2SRolf Eike Beer /** 1261c1a220e7SZhang Rui * queue_work_on - queue work on specific cpu 1262c1a220e7SZhang Rui * @cpu: CPU number to execute work on 1263c1a220e7SZhang Rui * @wq: workqueue to use 1264c1a220e7SZhang Rui * @work: work to queue 1265c1a220e7SZhang Rui * 1266d4283e93STejun Heo * Returns %false if @work was already on a queue, %true otherwise. 1267c1a220e7SZhang Rui * 1268c1a220e7SZhang Rui * We queue the work to a specific CPU, the caller must ensure it 1269c1a220e7SZhang Rui * can't go away. 1270c1a220e7SZhang Rui */ 1271d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq, 1272d4283e93STejun Heo struct work_struct *work) 1273c1a220e7SZhang Rui { 1274d4283e93STejun Heo bool ret = false; 12758930cabaSTejun Heo unsigned long flags; 12768930cabaSTejun Heo 12778930cabaSTejun Heo local_irq_save(flags); 1278c1a220e7SZhang Rui 127922df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 12804690c4abSTejun Heo __queue_work(cpu, wq, work); 1281d4283e93STejun Heo ret = true; 1282c1a220e7SZhang Rui } 12838930cabaSTejun Heo 12848930cabaSTejun Heo local_irq_restore(flags); 1285c1a220e7SZhang Rui return ret; 1286c1a220e7SZhang Rui } 1287c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on); 1288c1a220e7SZhang Rui 12890a13c00eSTejun Heo /** 12900a13c00eSTejun Heo * queue_work - queue work on a workqueue 12910a13c00eSTejun Heo * @wq: workqueue to use 12920a13c00eSTejun Heo * @work: work to queue 12930a13c00eSTejun Heo * 1294d4283e93STejun Heo * Returns %false if @work was already on a queue, %true otherwise. 12950a13c00eSTejun Heo * 12960a13c00eSTejun Heo * We queue the work to the CPU on which it was submitted, but if the CPU dies 12970a13c00eSTejun Heo * it can be processed by another CPU. 12980a13c00eSTejun Heo */ 1299d4283e93STejun Heo bool queue_work(struct workqueue_struct *wq, struct work_struct *work) 13000a13c00eSTejun Heo { 130157469821STejun Heo return queue_work_on(WORK_CPU_UNBOUND, wq, work); 13020a13c00eSTejun Heo } 13030a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_work); 13040a13c00eSTejun Heo 1305d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data) 13061da177e4SLinus Torvalds { 130752bad64dSDavid Howells struct delayed_work *dwork = (struct delayed_work *)__data; 13081da177e4SLinus Torvalds 1309e0aecdd8STejun Heo /* should have been called from irqsafe timer with irq already off */ 131060c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 13111da177e4SLinus Torvalds } 13121438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn); 13131da177e4SLinus Torvalds 13147beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq, 131552bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 13161da177e4SLinus Torvalds { 13177beb2edfSTejun Heo struct timer_list *timer = &dwork->timer; 13187beb2edfSTejun Heo struct work_struct *work = &dwork->work; 13191da177e4SLinus Torvalds 13207beb2edfSTejun Heo WARN_ON_ONCE(timer->function != delayed_work_timer_fn || 13217beb2edfSTejun Heo timer->data != (unsigned long)dwork); 1322fc4b514fSTejun Heo WARN_ON_ONCE(timer_pending(timer)); 1323fc4b514fSTejun Heo WARN_ON_ONCE(!list_empty(&work->entry)); 13247beb2edfSTejun Heo 13258852aac2STejun Heo /* 13268852aac2STejun Heo * If @delay is 0, queue @dwork->work immediately. This is for 13278852aac2STejun Heo * both optimization and correctness. The earliest @timer can 13288852aac2STejun Heo * expire is on the closest next tick and delayed_work users depend 13298852aac2STejun Heo * on that there's no such delay when @delay is 0. 13308852aac2STejun Heo */ 13318852aac2STejun Heo if (!delay) { 13328852aac2STejun Heo __queue_work(cpu, wq, &dwork->work); 13338852aac2STejun Heo return; 13348852aac2STejun Heo } 13358852aac2STejun Heo 13367beb2edfSTejun Heo timer_stats_timer_set_start_info(&dwork->timer); 13377beb2edfSTejun Heo 133860c057bcSLai Jiangshan dwork->wq = wq; 13391265057fSTejun Heo dwork->cpu = cpu; 13407beb2edfSTejun Heo timer->expires = jiffies + delay; 13417beb2edfSTejun Heo 13427beb2edfSTejun Heo if (unlikely(cpu != WORK_CPU_UNBOUND)) 13437beb2edfSTejun Heo add_timer_on(timer, cpu); 13447beb2edfSTejun Heo else 13457beb2edfSTejun Heo add_timer(timer); 13467beb2edfSTejun Heo } 13471da177e4SLinus Torvalds 13480fcb78c2SRolf Eike Beer /** 13490fcb78c2SRolf Eike Beer * queue_delayed_work_on - queue work on specific CPU after delay 13500fcb78c2SRolf Eike Beer * @cpu: CPU number to execute work on 13510fcb78c2SRolf Eike Beer * @wq: workqueue to use 1352af9997e4SRandy Dunlap * @dwork: work to queue 13530fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 13540fcb78c2SRolf Eike Beer * 1355715f1300STejun Heo * Returns %false if @work was already on a queue, %true otherwise. If 1356715f1300STejun Heo * @delay is zero and @dwork is idle, it will be scheduled for immediate 1357715f1300STejun Heo * execution. 13580fcb78c2SRolf Eike Beer */ 1359d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 136052bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 13617a6bc1cdSVenkatesh Pallipadi { 136252bad64dSDavid Howells struct work_struct *work = &dwork->work; 1363d4283e93STejun Heo bool ret = false; 13648930cabaSTejun Heo unsigned long flags; 13658930cabaSTejun Heo 13668930cabaSTejun Heo /* read the comment in __queue_work() */ 13678930cabaSTejun Heo local_irq_save(flags); 13687a6bc1cdSVenkatesh Pallipadi 136922df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 13707beb2edfSTejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 1371d4283e93STejun Heo ret = true; 13727a6bc1cdSVenkatesh Pallipadi } 13738930cabaSTejun Heo 13748930cabaSTejun Heo local_irq_restore(flags); 13757a6bc1cdSVenkatesh Pallipadi return ret; 13767a6bc1cdSVenkatesh Pallipadi } 1377ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on); 13781da177e4SLinus Torvalds 1379c8e55f36STejun Heo /** 13800a13c00eSTejun Heo * queue_delayed_work - queue work on a workqueue after delay 13810a13c00eSTejun Heo * @wq: workqueue to use 13820a13c00eSTejun Heo * @dwork: delayable work to queue 13830a13c00eSTejun Heo * @delay: number of jiffies to wait before queueing 13840a13c00eSTejun Heo * 1385715f1300STejun Heo * Equivalent to queue_delayed_work_on() but tries to use the local CPU. 13860a13c00eSTejun Heo */ 1387d4283e93STejun Heo bool queue_delayed_work(struct workqueue_struct *wq, 13880a13c00eSTejun Heo struct delayed_work *dwork, unsigned long delay) 13890a13c00eSTejun Heo { 139057469821STejun Heo return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay); 13910a13c00eSTejun Heo } 13920a13c00eSTejun Heo EXPORT_SYMBOL_GPL(queue_delayed_work); 13930a13c00eSTejun Heo 13940a13c00eSTejun Heo /** 13958376fe22STejun Heo * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU 13968376fe22STejun Heo * @cpu: CPU number to execute work on 13978376fe22STejun Heo * @wq: workqueue to use 13988376fe22STejun Heo * @dwork: work to queue 13998376fe22STejun Heo * @delay: number of jiffies to wait before queueing 14008376fe22STejun Heo * 14018376fe22STejun Heo * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise, 14028376fe22STejun Heo * modify @dwork's timer so that it expires after @delay. If @delay is 14038376fe22STejun Heo * zero, @work is guaranteed to be scheduled immediately regardless of its 14048376fe22STejun Heo * current state. 14058376fe22STejun Heo * 14068376fe22STejun Heo * Returns %false if @dwork was idle and queued, %true if @dwork was 14078376fe22STejun Heo * pending and its timer was modified. 14088376fe22STejun Heo * 1409e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 14108376fe22STejun Heo * See try_to_grab_pending() for details. 14118376fe22STejun Heo */ 14128376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, 14138376fe22STejun Heo struct delayed_work *dwork, unsigned long delay) 14148376fe22STejun Heo { 14158376fe22STejun Heo unsigned long flags; 14168376fe22STejun Heo int ret; 14178376fe22STejun Heo 14188376fe22STejun Heo do { 14198376fe22STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 14208376fe22STejun Heo } while (unlikely(ret == -EAGAIN)); 14218376fe22STejun Heo 14228376fe22STejun Heo if (likely(ret >= 0)) { 14238376fe22STejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 14248376fe22STejun Heo local_irq_restore(flags); 14258376fe22STejun Heo } 14268376fe22STejun Heo 14278376fe22STejun Heo /* -ENOENT from try_to_grab_pending() becomes %true */ 14288376fe22STejun Heo return ret; 14298376fe22STejun Heo } 14308376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on); 14318376fe22STejun Heo 14328376fe22STejun Heo /** 14338376fe22STejun Heo * mod_delayed_work - modify delay of or queue a delayed work 14348376fe22STejun Heo * @wq: workqueue to use 14358376fe22STejun Heo * @dwork: work to queue 14368376fe22STejun Heo * @delay: number of jiffies to wait before queueing 14378376fe22STejun Heo * 14388376fe22STejun Heo * mod_delayed_work_on() on local CPU. 14398376fe22STejun Heo */ 14408376fe22STejun Heo bool mod_delayed_work(struct workqueue_struct *wq, struct delayed_work *dwork, 14418376fe22STejun Heo unsigned long delay) 14428376fe22STejun Heo { 14438376fe22STejun Heo return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay); 14448376fe22STejun Heo } 14458376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work); 14468376fe22STejun Heo 14478376fe22STejun Heo /** 1448c8e55f36STejun Heo * worker_enter_idle - enter idle state 1449c8e55f36STejun Heo * @worker: worker which is entering idle state 1450c8e55f36STejun Heo * 1451c8e55f36STejun Heo * @worker is entering idle state. Update stats and idle timer if 1452c8e55f36STejun Heo * necessary. 1453c8e55f36STejun Heo * 1454c8e55f36STejun Heo * LOCKING: 1455d565ed63STejun Heo * spin_lock_irq(pool->lock). 1456c8e55f36STejun Heo */ 1457c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker) 14581da177e4SLinus Torvalds { 1459bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1460c8e55f36STejun Heo 14616183c009STejun Heo if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) || 14626183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->entry) && 14636183c009STejun Heo (worker->hentry.next || worker->hentry.pprev))) 14646183c009STejun Heo return; 1465c8e55f36STejun Heo 1466cb444766STejun Heo /* can't use worker_set_flags(), also called from start_worker() */ 1467cb444766STejun Heo worker->flags |= WORKER_IDLE; 1468bd7bdd43STejun Heo pool->nr_idle++; 1469e22bee78STejun Heo worker->last_active = jiffies; 1470c8e55f36STejun Heo 1471c8e55f36STejun Heo /* idle_list is LIFO */ 1472bd7bdd43STejun Heo list_add(&worker->entry, &pool->idle_list); 1473db7bccf4STejun Heo 147463d95a91STejun Heo if (too_many_workers(pool) && !timer_pending(&pool->idle_timer)) 1475628c78e7STejun Heo mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT); 1476cb444766STejun Heo 1477544ecf31STejun Heo /* 1478706026c2STejun Heo * Sanity check nr_running. Because wq_unbind_fn() releases 1479d565ed63STejun Heo * pool->lock between setting %WORKER_UNBOUND and zapping 1480628c78e7STejun Heo * nr_running, the warning may trigger spuriously. Check iff 1481628c78e7STejun Heo * unbind is not in progress. 1482544ecf31STejun Heo */ 148324647570STejun Heo WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 1484bd7bdd43STejun Heo pool->nr_workers == pool->nr_idle && 1485e19e397aSTejun Heo atomic_read(&pool->nr_running)); 1486c8e55f36STejun Heo } 1487c8e55f36STejun Heo 1488c8e55f36STejun Heo /** 1489c8e55f36STejun Heo * worker_leave_idle - leave idle state 1490c8e55f36STejun Heo * @worker: worker which is leaving idle state 1491c8e55f36STejun Heo * 1492c8e55f36STejun Heo * @worker is leaving idle state. Update stats. 1493c8e55f36STejun Heo * 1494c8e55f36STejun Heo * LOCKING: 1495d565ed63STejun Heo * spin_lock_irq(pool->lock). 1496c8e55f36STejun Heo */ 1497c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker) 1498c8e55f36STejun Heo { 1499bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1500c8e55f36STejun Heo 15016183c009STejun Heo if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE))) 15026183c009STejun Heo return; 1503d302f017STejun Heo worker_clr_flags(worker, WORKER_IDLE); 1504bd7bdd43STejun Heo pool->nr_idle--; 1505c8e55f36STejun Heo list_del_init(&worker->entry); 1506c8e55f36STejun Heo } 1507c8e55f36STejun Heo 1508e22bee78STejun Heo /** 1509f36dc67bSLai Jiangshan * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it 1510f36dc67bSLai Jiangshan * @pool: target worker_pool 1511f36dc67bSLai Jiangshan * 1512f36dc67bSLai Jiangshan * Bind %current to the cpu of @pool if it is associated and lock @pool. 1513e22bee78STejun Heo * 1514e22bee78STejun Heo * Works which are scheduled while the cpu is online must at least be 1515e22bee78STejun Heo * scheduled to a worker which is bound to the cpu so that if they are 1516e22bee78STejun Heo * flushed from cpu callbacks while cpu is going down, they are 1517e22bee78STejun Heo * guaranteed to execute on the cpu. 1518e22bee78STejun Heo * 1519f5faa077SLai Jiangshan * This function is to be used by unbound workers and rescuers to bind 1520e22bee78STejun Heo * themselves to the target cpu and may race with cpu going down or 1521e22bee78STejun Heo * coming online. kthread_bind() can't be used because it may put the 1522e22bee78STejun Heo * worker to already dead cpu and set_cpus_allowed_ptr() can't be used 1523706026c2STejun Heo * verbatim as it's best effort and blocking and pool may be 1524e22bee78STejun Heo * [dis]associated in the meantime. 1525e22bee78STejun Heo * 1526706026c2STejun Heo * This function tries set_cpus_allowed() and locks pool and verifies the 152724647570STejun Heo * binding against %POOL_DISASSOCIATED which is set during 1528f2d5a0eeSTejun Heo * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker 1529f2d5a0eeSTejun Heo * enters idle state or fetches works without dropping lock, it can 1530f2d5a0eeSTejun Heo * guarantee the scheduling requirement described in the first paragraph. 1531e22bee78STejun Heo * 1532e22bee78STejun Heo * CONTEXT: 1533d565ed63STejun Heo * Might sleep. Called without any lock but returns with pool->lock 1534e22bee78STejun Heo * held. 1535e22bee78STejun Heo * 1536e22bee78STejun Heo * RETURNS: 1537706026c2STejun Heo * %true if the associated pool is online (@worker is successfully 1538e22bee78STejun Heo * bound), %false if offline. 1539e22bee78STejun Heo */ 1540f36dc67bSLai Jiangshan static bool worker_maybe_bind_and_lock(struct worker_pool *pool) 1541d565ed63STejun Heo __acquires(&pool->lock) 1542e22bee78STejun Heo { 1543e22bee78STejun Heo while (true) { 1544e22bee78STejun Heo /* 1545e22bee78STejun Heo * The following call may fail, succeed or succeed 1546e22bee78STejun Heo * without actually migrating the task to the cpu if 1547e22bee78STejun Heo * it races with cpu hotunplug operation. Verify 154824647570STejun Heo * against POOL_DISASSOCIATED. 1549e22bee78STejun Heo */ 155024647570STejun Heo if (!(pool->flags & POOL_DISASSOCIATED)) 1551f5faa077SLai Jiangshan set_cpus_allowed_ptr(current, get_cpu_mask(pool->cpu)); 1552e22bee78STejun Heo 1553d565ed63STejun Heo spin_lock_irq(&pool->lock); 155424647570STejun Heo if (pool->flags & POOL_DISASSOCIATED) 1555e22bee78STejun Heo return false; 1556f5faa077SLai Jiangshan if (task_cpu(current) == pool->cpu && 1557e22bee78STejun Heo cpumask_equal(¤t->cpus_allowed, 1558ec22ca5eSTejun Heo get_cpu_mask(pool->cpu))) 1559e22bee78STejun Heo return true; 1560d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1561e22bee78STejun Heo 15625035b20fSTejun Heo /* 15635035b20fSTejun Heo * We've raced with CPU hot[un]plug. Give it a breather 15645035b20fSTejun Heo * and retry migration. cond_resched() is required here; 15655035b20fSTejun Heo * otherwise, we might deadlock against cpu_stop trying to 15665035b20fSTejun Heo * bring down the CPU on non-preemptive kernel. 15675035b20fSTejun Heo */ 1568e22bee78STejun Heo cpu_relax(); 15695035b20fSTejun Heo cond_resched(); 1570e22bee78STejun Heo } 1571e22bee78STejun Heo } 1572e22bee78STejun Heo 1573e22bee78STejun Heo /* 1574ea1abd61SLai Jiangshan * Rebind an idle @worker to its CPU. worker_thread() will test 15755f7dabfdSLai Jiangshan * list_empty(@worker->entry) before leaving idle and call this function. 157625511a47STejun Heo */ 157725511a47STejun Heo static void idle_worker_rebind(struct worker *worker) 157825511a47STejun Heo { 15795f7dabfdSLai Jiangshan /* CPU may go down again inbetween, clear UNBOUND only on success */ 1580f36dc67bSLai Jiangshan if (worker_maybe_bind_and_lock(worker->pool)) 15815f7dabfdSLai Jiangshan worker_clr_flags(worker, WORKER_UNBOUND); 158225511a47STejun Heo 1583ea1abd61SLai Jiangshan /* rebind complete, become available again */ 1584ea1abd61SLai Jiangshan list_add(&worker->entry, &worker->pool->idle_list); 1585d565ed63STejun Heo spin_unlock_irq(&worker->pool->lock); 158625511a47STejun Heo } 158725511a47STejun Heo 158825511a47STejun Heo /* 158925511a47STejun Heo * Function for @worker->rebind.work used to rebind unbound busy workers to 1590403c821dSTejun Heo * the associated cpu which is coming back online. This is scheduled by 1591403c821dSTejun Heo * cpu up but can race with other cpu hotplug operations and may be 1592403c821dSTejun Heo * executed twice without intervening cpu down. 1593e22bee78STejun Heo */ 159425511a47STejun Heo static void busy_worker_rebind_fn(struct work_struct *work) 1595e22bee78STejun Heo { 1596e22bee78STejun Heo struct worker *worker = container_of(work, struct worker, rebind_work); 1597e22bee78STejun Heo 1598f36dc67bSLai Jiangshan if (worker_maybe_bind_and_lock(worker->pool)) 1599eab6d828SLai Jiangshan worker_clr_flags(worker, WORKER_UNBOUND); 1600e22bee78STejun Heo 1601d565ed63STejun Heo spin_unlock_irq(&worker->pool->lock); 1602e22bee78STejun Heo } 1603e22bee78STejun Heo 160425511a47STejun Heo /** 160594cf58bbSTejun Heo * rebind_workers - rebind all workers of a pool to the associated CPU 160694cf58bbSTejun Heo * @pool: pool of interest 160725511a47STejun Heo * 160894cf58bbSTejun Heo * @pool->cpu is coming online. Rebind all workers to the CPU. Rebinding 160925511a47STejun Heo * is different for idle and busy ones. 161025511a47STejun Heo * 1611ea1abd61SLai Jiangshan * Idle ones will be removed from the idle_list and woken up. They will 1612ea1abd61SLai Jiangshan * add themselves back after completing rebind. This ensures that the 1613ea1abd61SLai Jiangshan * idle_list doesn't contain any unbound workers when re-bound busy workers 1614ea1abd61SLai Jiangshan * try to perform local wake-ups for concurrency management. 161525511a47STejun Heo * 1616ea1abd61SLai Jiangshan * Busy workers can rebind after they finish their current work items. 1617ea1abd61SLai Jiangshan * Queueing the rebind work item at the head of the scheduled list is 1618ea1abd61SLai Jiangshan * enough. Note that nr_running will be properly bumped as busy workers 1619ea1abd61SLai Jiangshan * rebind. 162025511a47STejun Heo * 1621ea1abd61SLai Jiangshan * On return, all non-manager workers are scheduled for rebind - see 1622ea1abd61SLai Jiangshan * manage_workers() for the manager special case. Any idle worker 1623ea1abd61SLai Jiangshan * including the manager will not appear on @idle_list until rebind is 1624ea1abd61SLai Jiangshan * complete, making local wake-ups safe. 162525511a47STejun Heo */ 162694cf58bbSTejun Heo static void rebind_workers(struct worker_pool *pool) 162725511a47STejun Heo { 1628ea1abd61SLai Jiangshan struct worker *worker, *n; 162925511a47STejun Heo int i; 163025511a47STejun Heo 1631b2eb83d1SLai Jiangshan lockdep_assert_held(&pool->assoc_mutex); 1632d565ed63STejun Heo lockdep_assert_held(&pool->lock); 163325511a47STejun Heo 16345f7dabfdSLai Jiangshan /* dequeue and kick idle ones */ 1635ea1abd61SLai Jiangshan list_for_each_entry_safe(worker, n, &pool->idle_list, entry) { 1636ea1abd61SLai Jiangshan /* 163794cf58bbSTejun Heo * idle workers should be off @pool->idle_list until rebind 163894cf58bbSTejun Heo * is complete to avoid receiving premature local wake-ups. 1639ea1abd61SLai Jiangshan */ 1640ea1abd61SLai Jiangshan list_del_init(&worker->entry); 164125511a47STejun Heo 164225511a47STejun Heo /* 164394cf58bbSTejun Heo * worker_thread() will see the above dequeuing and call 164494cf58bbSTejun Heo * idle_worker_rebind(). 164525511a47STejun Heo */ 164625511a47STejun Heo wake_up_process(worker->task); 164725511a47STejun Heo } 164825511a47STejun Heo 1649ea1abd61SLai Jiangshan /* rebind busy workers */ 1650b67bfe0dSSasha Levin for_each_busy_worker(worker, i, pool) { 165125511a47STejun Heo struct work_struct *rebind_work = &worker->rebind_work; 1652e2b6a6d5SJoonsoo Kim struct workqueue_struct *wq; 165325511a47STejun Heo 165425511a47STejun Heo if (test_and_set_bit(WORK_STRUCT_PENDING_BIT, 165525511a47STejun Heo work_data_bits(rebind_work))) 165625511a47STejun Heo continue; 165725511a47STejun Heo 165825511a47STejun Heo debug_work_activate(rebind_work); 165990beca5dSTejun Heo 166090beca5dSTejun Heo /* 166194cf58bbSTejun Heo * wq doesn't really matter but let's keep @worker->pool 1662112202d9STejun Heo * and @pwq->pool consistent for sanity. 166390beca5dSTejun Heo */ 1664e34cdddbSTejun Heo if (std_worker_pool_pri(worker->pool)) 1665e2b6a6d5SJoonsoo Kim wq = system_highpri_wq; 1666e2b6a6d5SJoonsoo Kim else 1667e2b6a6d5SJoonsoo Kim wq = system_wq; 1668ec58815aSTejun Heo 1669112202d9STejun Heo insert_work(get_pwq(pool->cpu, wq), rebind_work, 167025511a47STejun Heo worker->scheduled.next, 167125511a47STejun Heo work_color_to_flags(WORK_NO_COLOR)); 1672ec58815aSTejun Heo } 167325511a47STejun Heo } 167425511a47STejun Heo 1675c34056a3STejun Heo static struct worker *alloc_worker(void) 1676c34056a3STejun Heo { 1677c34056a3STejun Heo struct worker *worker; 1678c34056a3STejun Heo 1679c34056a3STejun Heo worker = kzalloc(sizeof(*worker), GFP_KERNEL); 1680c8e55f36STejun Heo if (worker) { 1681c8e55f36STejun Heo INIT_LIST_HEAD(&worker->entry); 1682affee4b2STejun Heo INIT_LIST_HEAD(&worker->scheduled); 168325511a47STejun Heo INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn); 1684e22bee78STejun Heo /* on creation a worker is in !idle && prep state */ 1685e22bee78STejun Heo worker->flags = WORKER_PREP; 1686c8e55f36STejun Heo } 1687c34056a3STejun Heo return worker; 1688c34056a3STejun Heo } 1689c34056a3STejun Heo 1690c34056a3STejun Heo /** 1691c34056a3STejun Heo * create_worker - create a new workqueue worker 169263d95a91STejun Heo * @pool: pool the new worker will belong to 1693c34056a3STejun Heo * 169463d95a91STejun Heo * Create a new worker which is bound to @pool. The returned worker 1695c34056a3STejun Heo * can be started by calling start_worker() or destroyed using 1696c34056a3STejun Heo * destroy_worker(). 1697c34056a3STejun Heo * 1698c34056a3STejun Heo * CONTEXT: 1699c34056a3STejun Heo * Might sleep. Does GFP_KERNEL allocations. 1700c34056a3STejun Heo * 1701c34056a3STejun Heo * RETURNS: 1702c34056a3STejun Heo * Pointer to the newly created worker. 1703c34056a3STejun Heo */ 1704bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool) 1705c34056a3STejun Heo { 1706e34cdddbSTejun Heo const char *pri = std_worker_pool_pri(pool) ? "H" : ""; 1707c34056a3STejun Heo struct worker *worker = NULL; 1708f3421797STejun Heo int id = -1; 1709c34056a3STejun Heo 1710d565ed63STejun Heo spin_lock_irq(&pool->lock); 1711bd7bdd43STejun Heo while (ida_get_new(&pool->worker_ida, &id)) { 1712d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1713bd7bdd43STejun Heo if (!ida_pre_get(&pool->worker_ida, GFP_KERNEL)) 1714c34056a3STejun Heo goto fail; 1715d565ed63STejun Heo spin_lock_irq(&pool->lock); 1716c34056a3STejun Heo } 1717d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1718c34056a3STejun Heo 1719c34056a3STejun Heo worker = alloc_worker(); 1720c34056a3STejun Heo if (!worker) 1721c34056a3STejun Heo goto fail; 1722c34056a3STejun Heo 1723bd7bdd43STejun Heo worker->pool = pool; 1724c34056a3STejun Heo worker->id = id; 1725c34056a3STejun Heo 1726ec22ca5eSTejun Heo if (pool->cpu != WORK_CPU_UNBOUND) 172794dcf29aSEric Dumazet worker->task = kthread_create_on_node(worker_thread, 1728ec22ca5eSTejun Heo worker, cpu_to_node(pool->cpu), 1729ec22ca5eSTejun Heo "kworker/%u:%d%s", pool->cpu, id, pri); 1730f3421797STejun Heo else 1731f3421797STejun Heo worker->task = kthread_create(worker_thread, worker, 17323270476aSTejun Heo "kworker/u:%d%s", id, pri); 1733c34056a3STejun Heo if (IS_ERR(worker->task)) 1734c34056a3STejun Heo goto fail; 1735c34056a3STejun Heo 1736e34cdddbSTejun Heo if (std_worker_pool_pri(pool)) 17373270476aSTejun Heo set_user_nice(worker->task, HIGHPRI_NICE_LEVEL); 17383270476aSTejun Heo 1739db7bccf4STejun Heo /* 1740bc2ae0f5STejun Heo * Determine CPU binding of the new worker depending on 174124647570STejun Heo * %POOL_DISASSOCIATED. The caller is responsible for ensuring the 1742bc2ae0f5STejun Heo * flag remains stable across this function. See the comments 1743bc2ae0f5STejun Heo * above the flag definition for details. 1744bc2ae0f5STejun Heo * 1745bc2ae0f5STejun Heo * As an unbound worker may later become a regular one if CPU comes 1746bc2ae0f5STejun Heo * online, make sure every worker has %PF_THREAD_BOUND set. 1747db7bccf4STejun Heo */ 174824647570STejun Heo if (!(pool->flags & POOL_DISASSOCIATED)) { 1749ec22ca5eSTejun Heo kthread_bind(worker->task, pool->cpu); 1750bc2ae0f5STejun Heo } else { 1751db7bccf4STejun Heo worker->task->flags |= PF_THREAD_BOUND; 1752f3421797STejun Heo worker->flags |= WORKER_UNBOUND; 1753f3421797STejun Heo } 1754c34056a3STejun Heo 1755c34056a3STejun Heo return worker; 1756c34056a3STejun Heo fail: 1757c34056a3STejun Heo if (id >= 0) { 1758d565ed63STejun Heo spin_lock_irq(&pool->lock); 1759bd7bdd43STejun Heo ida_remove(&pool->worker_ida, id); 1760d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1761c34056a3STejun Heo } 1762c34056a3STejun Heo kfree(worker); 1763c34056a3STejun Heo return NULL; 1764c34056a3STejun Heo } 1765c34056a3STejun Heo 1766c34056a3STejun Heo /** 1767c34056a3STejun Heo * start_worker - start a newly created worker 1768c34056a3STejun Heo * @worker: worker to start 1769c34056a3STejun Heo * 1770706026c2STejun Heo * Make the pool aware of @worker and start it. 1771c34056a3STejun Heo * 1772c34056a3STejun Heo * CONTEXT: 1773d565ed63STejun Heo * spin_lock_irq(pool->lock). 1774c34056a3STejun Heo */ 1775c34056a3STejun Heo static void start_worker(struct worker *worker) 1776c34056a3STejun Heo { 1777cb444766STejun Heo worker->flags |= WORKER_STARTED; 1778bd7bdd43STejun Heo worker->pool->nr_workers++; 1779c8e55f36STejun Heo worker_enter_idle(worker); 1780c34056a3STejun Heo wake_up_process(worker->task); 1781c34056a3STejun Heo } 1782c34056a3STejun Heo 1783c34056a3STejun Heo /** 1784c34056a3STejun Heo * destroy_worker - destroy a workqueue worker 1785c34056a3STejun Heo * @worker: worker to be destroyed 1786c34056a3STejun Heo * 1787706026c2STejun Heo * Destroy @worker and adjust @pool stats accordingly. 1788c8e55f36STejun Heo * 1789c8e55f36STejun Heo * CONTEXT: 1790d565ed63STejun Heo * spin_lock_irq(pool->lock) which is released and regrabbed. 1791c34056a3STejun Heo */ 1792c34056a3STejun Heo static void destroy_worker(struct worker *worker) 1793c34056a3STejun Heo { 1794bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1795c34056a3STejun Heo int id = worker->id; 1796c34056a3STejun Heo 1797c34056a3STejun Heo /* sanity check frenzy */ 17986183c009STejun Heo if (WARN_ON(worker->current_work) || 17996183c009STejun Heo WARN_ON(!list_empty(&worker->scheduled))) 18006183c009STejun Heo return; 1801c34056a3STejun Heo 1802c8e55f36STejun Heo if (worker->flags & WORKER_STARTED) 1803bd7bdd43STejun Heo pool->nr_workers--; 1804c8e55f36STejun Heo if (worker->flags & WORKER_IDLE) 1805bd7bdd43STejun Heo pool->nr_idle--; 1806c8e55f36STejun Heo 1807c8e55f36STejun Heo list_del_init(&worker->entry); 1808cb444766STejun Heo worker->flags |= WORKER_DIE; 1809c8e55f36STejun Heo 1810d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1811c8e55f36STejun Heo 1812c34056a3STejun Heo kthread_stop(worker->task); 1813c34056a3STejun Heo kfree(worker); 1814c34056a3STejun Heo 1815d565ed63STejun Heo spin_lock_irq(&pool->lock); 1816bd7bdd43STejun Heo ida_remove(&pool->worker_ida, id); 1817c34056a3STejun Heo } 1818c34056a3STejun Heo 181963d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool) 1820e22bee78STejun Heo { 182163d95a91STejun Heo struct worker_pool *pool = (void *)__pool; 1822e22bee78STejun Heo 1823d565ed63STejun Heo spin_lock_irq(&pool->lock); 1824e22bee78STejun Heo 182563d95a91STejun Heo if (too_many_workers(pool)) { 1826e22bee78STejun Heo struct worker *worker; 1827e22bee78STejun Heo unsigned long expires; 1828e22bee78STejun Heo 1829e22bee78STejun Heo /* idle_list is kept in LIFO order, check the last one */ 183063d95a91STejun Heo worker = list_entry(pool->idle_list.prev, struct worker, entry); 1831e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 1832e22bee78STejun Heo 1833e22bee78STejun Heo if (time_before(jiffies, expires)) 183463d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 1835e22bee78STejun Heo else { 1836e22bee78STejun Heo /* it's been idle for too long, wake up manager */ 183711ebea50STejun Heo pool->flags |= POOL_MANAGE_WORKERS; 183863d95a91STejun Heo wake_up_worker(pool); 1839e22bee78STejun Heo } 1840e22bee78STejun Heo } 1841e22bee78STejun Heo 1842d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1843e22bee78STejun Heo } 1844e22bee78STejun Heo 1845e22bee78STejun Heo static bool send_mayday(struct work_struct *work) 1846e22bee78STejun Heo { 1847112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 1848112202d9STejun Heo struct workqueue_struct *wq = pwq->wq; 1849f3421797STejun Heo unsigned int cpu; 1850e22bee78STejun Heo 1851e22bee78STejun Heo if (!(wq->flags & WQ_RESCUER)) 1852e22bee78STejun Heo return false; 1853e22bee78STejun Heo 1854e22bee78STejun Heo /* mayday mayday mayday */ 1855112202d9STejun Heo cpu = pwq->pool->cpu; 1856f3421797STejun Heo /* WORK_CPU_UNBOUND can't be set in cpumask, use cpu 0 instead */ 1857f3421797STejun Heo if (cpu == WORK_CPU_UNBOUND) 1858f3421797STejun Heo cpu = 0; 1859f2e005aaSTejun Heo if (!mayday_test_and_set_cpu(cpu, wq->mayday_mask)) 1860e22bee78STejun Heo wake_up_process(wq->rescuer->task); 1861e22bee78STejun Heo return true; 1862e22bee78STejun Heo } 1863e22bee78STejun Heo 1864706026c2STejun Heo static void pool_mayday_timeout(unsigned long __pool) 1865e22bee78STejun Heo { 186663d95a91STejun Heo struct worker_pool *pool = (void *)__pool; 1867e22bee78STejun Heo struct work_struct *work; 1868e22bee78STejun Heo 1869d565ed63STejun Heo spin_lock_irq(&pool->lock); 1870e22bee78STejun Heo 187163d95a91STejun Heo if (need_to_create_worker(pool)) { 1872e22bee78STejun Heo /* 1873e22bee78STejun Heo * We've been trying to create a new worker but 1874e22bee78STejun Heo * haven't been successful. We might be hitting an 1875e22bee78STejun Heo * allocation deadlock. Send distress signals to 1876e22bee78STejun Heo * rescuers. 1877e22bee78STejun Heo */ 187863d95a91STejun Heo list_for_each_entry(work, &pool->worklist, entry) 1879e22bee78STejun Heo send_mayday(work); 1880e22bee78STejun Heo } 1881e22bee78STejun Heo 1882d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1883e22bee78STejun Heo 188463d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL); 1885e22bee78STejun Heo } 1886e22bee78STejun Heo 1887e22bee78STejun Heo /** 1888e22bee78STejun Heo * maybe_create_worker - create a new worker if necessary 188963d95a91STejun Heo * @pool: pool to create a new worker for 1890e22bee78STejun Heo * 189163d95a91STejun Heo * Create a new worker for @pool if necessary. @pool is guaranteed to 1892e22bee78STejun Heo * have at least one idle worker on return from this function. If 1893e22bee78STejun Heo * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is 189463d95a91STejun Heo * sent to all rescuers with works scheduled on @pool to resolve 1895e22bee78STejun Heo * possible allocation deadlock. 1896e22bee78STejun Heo * 1897e22bee78STejun Heo * On return, need_to_create_worker() is guaranteed to be false and 1898e22bee78STejun Heo * may_start_working() true. 1899e22bee78STejun Heo * 1900e22bee78STejun Heo * LOCKING: 1901d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 1902e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. Called only from 1903e22bee78STejun Heo * manager. 1904e22bee78STejun Heo * 1905e22bee78STejun Heo * RETURNS: 1906d565ed63STejun Heo * false if no action was taken and pool->lock stayed locked, true 1907e22bee78STejun Heo * otherwise. 1908e22bee78STejun Heo */ 190963d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool) 1910d565ed63STejun Heo __releases(&pool->lock) 1911d565ed63STejun Heo __acquires(&pool->lock) 1912e22bee78STejun Heo { 191363d95a91STejun Heo if (!need_to_create_worker(pool)) 1914e22bee78STejun Heo return false; 1915e22bee78STejun Heo restart: 1916d565ed63STejun Heo spin_unlock_irq(&pool->lock); 19179f9c2364STejun Heo 1918e22bee78STejun Heo /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ 191963d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); 1920e22bee78STejun Heo 1921e22bee78STejun Heo while (true) { 1922e22bee78STejun Heo struct worker *worker; 1923e22bee78STejun Heo 1924bc2ae0f5STejun Heo worker = create_worker(pool); 1925e22bee78STejun Heo if (worker) { 192663d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 1927d565ed63STejun Heo spin_lock_irq(&pool->lock); 1928e22bee78STejun Heo start_worker(worker); 19296183c009STejun Heo if (WARN_ON_ONCE(need_to_create_worker(pool))) 19306183c009STejun Heo goto restart; 1931e22bee78STejun Heo return true; 1932e22bee78STejun Heo } 1933e22bee78STejun Heo 193463d95a91STejun Heo if (!need_to_create_worker(pool)) 1935e22bee78STejun Heo break; 1936e22bee78STejun Heo 1937e22bee78STejun Heo __set_current_state(TASK_INTERRUPTIBLE); 1938e22bee78STejun Heo schedule_timeout(CREATE_COOLDOWN); 19399f9c2364STejun Heo 194063d95a91STejun Heo if (!need_to_create_worker(pool)) 1941e22bee78STejun Heo break; 1942e22bee78STejun Heo } 1943e22bee78STejun Heo 194463d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 1945d565ed63STejun Heo spin_lock_irq(&pool->lock); 194663d95a91STejun Heo if (need_to_create_worker(pool)) 1947e22bee78STejun Heo goto restart; 1948e22bee78STejun Heo return true; 1949e22bee78STejun Heo } 1950e22bee78STejun Heo 1951e22bee78STejun Heo /** 1952e22bee78STejun Heo * maybe_destroy_worker - destroy workers which have been idle for a while 195363d95a91STejun Heo * @pool: pool to destroy workers for 1954e22bee78STejun Heo * 195563d95a91STejun Heo * Destroy @pool workers which have been idle for longer than 1956e22bee78STejun Heo * IDLE_WORKER_TIMEOUT. 1957e22bee78STejun Heo * 1958e22bee78STejun Heo * LOCKING: 1959d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 1960e22bee78STejun Heo * multiple times. Called only from manager. 1961e22bee78STejun Heo * 1962e22bee78STejun Heo * RETURNS: 1963d565ed63STejun Heo * false if no action was taken and pool->lock stayed locked, true 1964e22bee78STejun Heo * otherwise. 1965e22bee78STejun Heo */ 196663d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool) 1967e22bee78STejun Heo { 1968e22bee78STejun Heo bool ret = false; 1969e22bee78STejun Heo 197063d95a91STejun Heo while (too_many_workers(pool)) { 1971e22bee78STejun Heo struct worker *worker; 1972e22bee78STejun Heo unsigned long expires; 1973e22bee78STejun Heo 197463d95a91STejun Heo worker = list_entry(pool->idle_list.prev, struct worker, entry); 1975e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 1976e22bee78STejun Heo 1977e22bee78STejun Heo if (time_before(jiffies, expires)) { 197863d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 1979e22bee78STejun Heo break; 1980e22bee78STejun Heo } 1981e22bee78STejun Heo 1982e22bee78STejun Heo destroy_worker(worker); 1983e22bee78STejun Heo ret = true; 1984e22bee78STejun Heo } 1985e22bee78STejun Heo 1986e22bee78STejun Heo return ret; 1987e22bee78STejun Heo } 1988e22bee78STejun Heo 1989e22bee78STejun Heo /** 1990e22bee78STejun Heo * manage_workers - manage worker pool 1991e22bee78STejun Heo * @worker: self 1992e22bee78STejun Heo * 1993706026c2STejun Heo * Assume the manager role and manage the worker pool @worker belongs 1994e22bee78STejun Heo * to. At any given time, there can be only zero or one manager per 1995706026c2STejun Heo * pool. The exclusion is handled automatically by this function. 1996e22bee78STejun Heo * 1997e22bee78STejun Heo * The caller can safely start processing works on false return. On 1998e22bee78STejun Heo * true return, it's guaranteed that need_to_create_worker() is false 1999e22bee78STejun Heo * and may_start_working() is true. 2000e22bee78STejun Heo * 2001e22bee78STejun Heo * CONTEXT: 2002d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2003e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. 2004e22bee78STejun Heo * 2005e22bee78STejun Heo * RETURNS: 2006d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2007d565ed63STejun Heo * multiple times. Does GFP_KERNEL allocations. 2008e22bee78STejun Heo */ 2009e22bee78STejun Heo static bool manage_workers(struct worker *worker) 2010e22bee78STejun Heo { 201163d95a91STejun Heo struct worker_pool *pool = worker->pool; 2012e22bee78STejun Heo bool ret = false; 2013e22bee78STejun Heo 2014ee378aa4SLai Jiangshan if (pool->flags & POOL_MANAGING_WORKERS) 2015e22bee78STejun Heo return ret; 2016e22bee78STejun Heo 2017552a37e9SLai Jiangshan pool->flags |= POOL_MANAGING_WORKERS; 2018ee378aa4SLai Jiangshan 2019ee378aa4SLai Jiangshan /* 2020ee378aa4SLai Jiangshan * To simplify both worker management and CPU hotplug, hold off 2021ee378aa4SLai Jiangshan * management while hotplug is in progress. CPU hotplug path can't 2022ee378aa4SLai Jiangshan * grab %POOL_MANAGING_WORKERS to achieve this because that can 2023ee378aa4SLai Jiangshan * lead to idle worker depletion (all become busy thinking someone 2024ee378aa4SLai Jiangshan * else is managing) which in turn can result in deadlock under 2025b2eb83d1SLai Jiangshan * extreme circumstances. Use @pool->assoc_mutex to synchronize 2026ee378aa4SLai Jiangshan * manager against CPU hotplug. 2027ee378aa4SLai Jiangshan * 2028b2eb83d1SLai Jiangshan * assoc_mutex would always be free unless CPU hotplug is in 2029d565ed63STejun Heo * progress. trylock first without dropping @pool->lock. 2030ee378aa4SLai Jiangshan */ 2031b2eb83d1SLai Jiangshan if (unlikely(!mutex_trylock(&pool->assoc_mutex))) { 2032d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2033b2eb83d1SLai Jiangshan mutex_lock(&pool->assoc_mutex); 2034ee378aa4SLai Jiangshan /* 2035ee378aa4SLai Jiangshan * CPU hotplug could have happened while we were waiting 2036b2eb83d1SLai Jiangshan * for assoc_mutex. Hotplug itself can't handle us 2037ee378aa4SLai Jiangshan * because manager isn't either on idle or busy list, and 2038706026c2STejun Heo * @pool's state and ours could have deviated. 2039ee378aa4SLai Jiangshan * 2040b2eb83d1SLai Jiangshan * As hotplug is now excluded via assoc_mutex, we can 2041ee378aa4SLai Jiangshan * simply try to bind. It will succeed or fail depending 2042706026c2STejun Heo * on @pool's current state. Try it and adjust 2043ee378aa4SLai Jiangshan * %WORKER_UNBOUND accordingly. 2044ee378aa4SLai Jiangshan */ 2045f36dc67bSLai Jiangshan if (worker_maybe_bind_and_lock(pool)) 2046ee378aa4SLai Jiangshan worker->flags &= ~WORKER_UNBOUND; 2047ee378aa4SLai Jiangshan else 2048ee378aa4SLai Jiangshan worker->flags |= WORKER_UNBOUND; 2049ee378aa4SLai Jiangshan 2050ee378aa4SLai Jiangshan ret = true; 2051ee378aa4SLai Jiangshan } 2052ee378aa4SLai Jiangshan 205311ebea50STejun Heo pool->flags &= ~POOL_MANAGE_WORKERS; 2054e22bee78STejun Heo 2055e22bee78STejun Heo /* 2056e22bee78STejun Heo * Destroy and then create so that may_start_working() is true 2057e22bee78STejun Heo * on return. 2058e22bee78STejun Heo */ 205963d95a91STejun Heo ret |= maybe_destroy_workers(pool); 206063d95a91STejun Heo ret |= maybe_create_worker(pool); 2061e22bee78STejun Heo 2062552a37e9SLai Jiangshan pool->flags &= ~POOL_MANAGING_WORKERS; 2063b2eb83d1SLai Jiangshan mutex_unlock(&pool->assoc_mutex); 2064e22bee78STejun Heo return ret; 2065e22bee78STejun Heo } 2066e22bee78STejun Heo 2067a62428c0STejun Heo /** 2068a62428c0STejun Heo * process_one_work - process single work 2069c34056a3STejun Heo * @worker: self 2070a62428c0STejun Heo * @work: work to process 2071a62428c0STejun Heo * 2072a62428c0STejun Heo * Process @work. This function contains all the logics necessary to 2073a62428c0STejun Heo * process a single work including synchronization against and 2074a62428c0STejun Heo * interaction with other workers on the same cpu, queueing and 2075a62428c0STejun Heo * flushing. As long as context requirement is met, any worker can 2076a62428c0STejun Heo * call this function to process a work. 2077a62428c0STejun Heo * 2078a62428c0STejun Heo * CONTEXT: 2079d565ed63STejun Heo * spin_lock_irq(pool->lock) which is released and regrabbed. 2080a62428c0STejun Heo */ 2081c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work) 2082d565ed63STejun Heo __releases(&pool->lock) 2083d565ed63STejun Heo __acquires(&pool->lock) 20841da177e4SLinus Torvalds { 2085112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 2086bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 2087112202d9STejun Heo bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE; 208873f53c4aSTejun Heo int work_color; 20897e11629dSTejun Heo struct worker *collision; 20904e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 20914e6045f1SJohannes Berg /* 2092a62428c0STejun Heo * It is permissible to free the struct work_struct from 2093a62428c0STejun Heo * inside the function that is called from it, this we need to 2094a62428c0STejun Heo * take into account for lockdep too. To avoid bogus "held 2095a62428c0STejun Heo * lock freed" warnings as well as problems when looking into 2096a62428c0STejun Heo * work->lockdep_map, make a copy and use that here. 20974e6045f1SJohannes Berg */ 20984d82a1deSPeter Zijlstra struct lockdep_map lockdep_map; 20994d82a1deSPeter Zijlstra 21004d82a1deSPeter Zijlstra lockdep_copy_map(&lockdep_map, &work->lockdep_map); 21014e6045f1SJohannes Berg #endif 21026fec10a1STejun Heo /* 21036fec10a1STejun Heo * Ensure we're on the correct CPU. DISASSOCIATED test is 21046fec10a1STejun Heo * necessary to avoid spurious warnings from rescuers servicing the 210524647570STejun Heo * unbound or a disassociated pool. 21066fec10a1STejun Heo */ 21075f7dabfdSLai Jiangshan WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) && 210824647570STejun Heo !(pool->flags & POOL_DISASSOCIATED) && 2109ec22ca5eSTejun Heo raw_smp_processor_id() != pool->cpu); 211025511a47STejun Heo 21117e11629dSTejun Heo /* 21127e11629dSTejun Heo * A single work shouldn't be executed concurrently by 21137e11629dSTejun Heo * multiple workers on a single cpu. Check whether anyone is 21147e11629dSTejun Heo * already processing the work. If so, defer the work to the 21157e11629dSTejun Heo * currently executing one. 21167e11629dSTejun Heo */ 2117c9e7cf27STejun Heo collision = find_worker_executing_work(pool, work); 21187e11629dSTejun Heo if (unlikely(collision)) { 21197e11629dSTejun Heo move_linked_works(work, &collision->scheduled, NULL); 21207e11629dSTejun Heo return; 21217e11629dSTejun Heo } 21221da177e4SLinus Torvalds 21238930cabaSTejun Heo /* claim and dequeue */ 21241da177e4SLinus Torvalds debug_work_deactivate(work); 2125c9e7cf27STejun Heo hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work); 2126c34056a3STejun Heo worker->current_work = work; 2127a2c1c57bSTejun Heo worker->current_func = work->func; 2128112202d9STejun Heo worker->current_pwq = pwq; 212973f53c4aSTejun Heo work_color = get_work_color(work); 21307a22ad75STejun Heo 2131a62428c0STejun Heo list_del_init(&work->entry); 2132a62428c0STejun Heo 2133649027d7STejun Heo /* 2134fb0e7bebSTejun Heo * CPU intensive works don't participate in concurrency 2135fb0e7bebSTejun Heo * management. They're the scheduler's responsibility. 2136fb0e7bebSTejun Heo */ 2137fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2138fb0e7bebSTejun Heo worker_set_flags(worker, WORKER_CPU_INTENSIVE, true); 2139fb0e7bebSTejun Heo 2140974271c4STejun Heo /* 2141d565ed63STejun Heo * Unbound pool isn't concurrency managed and work items should be 2142974271c4STejun Heo * executed ASAP. Wake up another worker if necessary. 2143974271c4STejun Heo */ 214463d95a91STejun Heo if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool)) 214563d95a91STejun Heo wake_up_worker(pool); 2146974271c4STejun Heo 21478930cabaSTejun Heo /* 21487c3eed5cSTejun Heo * Record the last pool and clear PENDING which should be the last 2149d565ed63STejun Heo * update to @work. Also, do this inside @pool->lock so that 215023657bb1STejun Heo * PENDING and queued state changes happen together while IRQ is 215123657bb1STejun Heo * disabled. 21528930cabaSTejun Heo */ 21537c3eed5cSTejun Heo set_work_pool_and_clear_pending(work, pool->id); 21541da177e4SLinus Torvalds 2155d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2156365970a1SDavid Howells 2157112202d9STejun Heo lock_map_acquire_read(&pwq->wq->lockdep_map); 21583295f0efSIngo Molnar lock_map_acquire(&lockdep_map); 2159e36c886aSArjan van de Ven trace_workqueue_execute_start(work); 2160a2c1c57bSTejun Heo worker->current_func(work); 2161e36c886aSArjan van de Ven /* 2162e36c886aSArjan van de Ven * While we must be careful to not use "work" after this, the trace 2163e36c886aSArjan van de Ven * point will only record its address. 2164e36c886aSArjan van de Ven */ 2165e36c886aSArjan van de Ven trace_workqueue_execute_end(work); 21663295f0efSIngo Molnar lock_map_release(&lockdep_map); 2167112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 21681da177e4SLinus Torvalds 2169d5abe669SPeter Zijlstra if (unlikely(in_atomic() || lockdep_depth(current) > 0)) { 2170044c782cSValentin Ilie pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n" 2171044c782cSValentin Ilie " last function: %pf\n", 2172a2c1c57bSTejun Heo current->comm, preempt_count(), task_pid_nr(current), 2173a2c1c57bSTejun Heo worker->current_func); 2174d5abe669SPeter Zijlstra debug_show_held_locks(current); 2175d5abe669SPeter Zijlstra dump_stack(); 2176d5abe669SPeter Zijlstra } 2177d5abe669SPeter Zijlstra 2178d565ed63STejun Heo spin_lock_irq(&pool->lock); 2179a62428c0STejun Heo 2180fb0e7bebSTejun Heo /* clear cpu intensive status */ 2181fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2182fb0e7bebSTejun Heo worker_clr_flags(worker, WORKER_CPU_INTENSIVE); 2183fb0e7bebSTejun Heo 2184a62428c0STejun Heo /* we're done with it, release */ 218542f8570fSSasha Levin hash_del(&worker->hentry); 2186c34056a3STejun Heo worker->current_work = NULL; 2187a2c1c57bSTejun Heo worker->current_func = NULL; 2188112202d9STejun Heo worker->current_pwq = NULL; 2189112202d9STejun Heo pwq_dec_nr_in_flight(pwq, work_color); 21901da177e4SLinus Torvalds } 21911da177e4SLinus Torvalds 2192affee4b2STejun Heo /** 2193affee4b2STejun Heo * process_scheduled_works - process scheduled works 2194affee4b2STejun Heo * @worker: self 2195affee4b2STejun Heo * 2196affee4b2STejun Heo * Process all scheduled works. Please note that the scheduled list 2197affee4b2STejun Heo * may change while processing a work, so this function repeatedly 2198affee4b2STejun Heo * fetches a work from the top and executes it. 2199affee4b2STejun Heo * 2200affee4b2STejun Heo * CONTEXT: 2201d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2202affee4b2STejun Heo * multiple times. 2203affee4b2STejun Heo */ 2204affee4b2STejun Heo static void process_scheduled_works(struct worker *worker) 22051da177e4SLinus Torvalds { 2206affee4b2STejun Heo while (!list_empty(&worker->scheduled)) { 2207affee4b2STejun Heo struct work_struct *work = list_first_entry(&worker->scheduled, 2208a62428c0STejun Heo struct work_struct, entry); 2209c34056a3STejun Heo process_one_work(worker, work); 2210a62428c0STejun Heo } 22111da177e4SLinus Torvalds } 22121da177e4SLinus Torvalds 22134690c4abSTejun Heo /** 22144690c4abSTejun Heo * worker_thread - the worker thread function 2215c34056a3STejun Heo * @__worker: self 22164690c4abSTejun Heo * 2217706026c2STejun Heo * The worker thread function. There are NR_CPU_WORKER_POOLS dynamic pools 2218706026c2STejun Heo * of these per each cpu. These workers process all works regardless of 2219e22bee78STejun Heo * their specific target workqueue. The only exception is works which 2220e22bee78STejun Heo * belong to workqueues with a rescuer which will be explained in 2221e22bee78STejun Heo * rescuer_thread(). 22224690c4abSTejun Heo */ 2223c34056a3STejun Heo static int worker_thread(void *__worker) 22241da177e4SLinus Torvalds { 2225c34056a3STejun Heo struct worker *worker = __worker; 2226bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 22271da177e4SLinus Torvalds 2228e22bee78STejun Heo /* tell the scheduler that this is a workqueue worker */ 2229e22bee78STejun Heo worker->task->flags |= PF_WQ_WORKER; 2230c8e55f36STejun Heo woke_up: 2231d565ed63STejun Heo spin_lock_irq(&pool->lock); 2232affee4b2STejun Heo 22335f7dabfdSLai Jiangshan /* we are off idle list if destruction or rebind is requested */ 22345f7dabfdSLai Jiangshan if (unlikely(list_empty(&worker->entry))) { 2235d565ed63STejun Heo spin_unlock_irq(&pool->lock); 223625511a47STejun Heo 22375f7dabfdSLai Jiangshan /* if DIE is set, destruction is requested */ 223825511a47STejun Heo if (worker->flags & WORKER_DIE) { 2239e22bee78STejun Heo worker->task->flags &= ~PF_WQ_WORKER; 2240c8e55f36STejun Heo return 0; 2241c8e55f36STejun Heo } 2242c8e55f36STejun Heo 22435f7dabfdSLai Jiangshan /* otherwise, rebind */ 224425511a47STejun Heo idle_worker_rebind(worker); 224525511a47STejun Heo goto woke_up; 224625511a47STejun Heo } 224725511a47STejun Heo 2248c8e55f36STejun Heo worker_leave_idle(worker); 2249db7bccf4STejun Heo recheck: 2250e22bee78STejun Heo /* no more worker necessary? */ 225163d95a91STejun Heo if (!need_more_worker(pool)) 2252e22bee78STejun Heo goto sleep; 2253e22bee78STejun Heo 2254e22bee78STejun Heo /* do we need to manage? */ 225563d95a91STejun Heo if (unlikely(!may_start_working(pool)) && manage_workers(worker)) 2256e22bee78STejun Heo goto recheck; 2257e22bee78STejun Heo 2258c8e55f36STejun Heo /* 2259c8e55f36STejun Heo * ->scheduled list can only be filled while a worker is 2260c8e55f36STejun Heo * preparing to process a work or actually processing it. 2261c8e55f36STejun Heo * Make sure nobody diddled with it while I was sleeping. 2262c8e55f36STejun Heo */ 22636183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->scheduled)); 2264c8e55f36STejun Heo 2265e22bee78STejun Heo /* 2266e22bee78STejun Heo * When control reaches this point, we're guaranteed to have 2267e22bee78STejun Heo * at least one idle worker or that someone else has already 2268e22bee78STejun Heo * assumed the manager role. 2269e22bee78STejun Heo */ 2270e22bee78STejun Heo worker_clr_flags(worker, WORKER_PREP); 2271e22bee78STejun Heo 2272e22bee78STejun Heo do { 2273affee4b2STejun Heo struct work_struct *work = 2274bd7bdd43STejun Heo list_first_entry(&pool->worklist, 2275affee4b2STejun Heo struct work_struct, entry); 2276affee4b2STejun Heo 2277c8e55f36STejun Heo if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) { 2278affee4b2STejun Heo /* optimization path, not strictly necessary */ 2279affee4b2STejun Heo process_one_work(worker, work); 2280affee4b2STejun Heo if (unlikely(!list_empty(&worker->scheduled))) 2281affee4b2STejun Heo process_scheduled_works(worker); 2282affee4b2STejun Heo } else { 2283c8e55f36STejun Heo move_linked_works(work, &worker->scheduled, NULL); 2284affee4b2STejun Heo process_scheduled_works(worker); 2285affee4b2STejun Heo } 228663d95a91STejun Heo } while (keep_working(pool)); 2287affee4b2STejun Heo 2288e22bee78STejun Heo worker_set_flags(worker, WORKER_PREP, false); 2289d313dd85STejun Heo sleep: 229063d95a91STejun Heo if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker)) 2291e22bee78STejun Heo goto recheck; 2292d313dd85STejun Heo 2293c8e55f36STejun Heo /* 2294d565ed63STejun Heo * pool->lock is held and there's no work to process and no need to 2295d565ed63STejun Heo * manage, sleep. Workers are woken up only while holding 2296d565ed63STejun Heo * pool->lock or from local cpu, so setting the current state 2297d565ed63STejun Heo * before releasing pool->lock is enough to prevent losing any 2298d565ed63STejun Heo * event. 2299c8e55f36STejun Heo */ 2300c8e55f36STejun Heo worker_enter_idle(worker); 2301c8e55f36STejun Heo __set_current_state(TASK_INTERRUPTIBLE); 2302d565ed63STejun Heo spin_unlock_irq(&pool->lock); 23031da177e4SLinus Torvalds schedule(); 2304c8e55f36STejun Heo goto woke_up; 23051da177e4SLinus Torvalds } 23061da177e4SLinus Torvalds 2307e22bee78STejun Heo /** 2308e22bee78STejun Heo * rescuer_thread - the rescuer thread function 2309111c225aSTejun Heo * @__rescuer: self 2310e22bee78STejun Heo * 2311e22bee78STejun Heo * Workqueue rescuer thread function. There's one rescuer for each 2312e22bee78STejun Heo * workqueue which has WQ_RESCUER set. 2313e22bee78STejun Heo * 2314706026c2STejun Heo * Regular work processing on a pool may block trying to create a new 2315e22bee78STejun Heo * worker which uses GFP_KERNEL allocation which has slight chance of 2316e22bee78STejun Heo * developing into deadlock if some works currently on the same queue 2317e22bee78STejun Heo * need to be processed to satisfy the GFP_KERNEL allocation. This is 2318e22bee78STejun Heo * the problem rescuer solves. 2319e22bee78STejun Heo * 2320706026c2STejun Heo * When such condition is possible, the pool summons rescuers of all 2321706026c2STejun Heo * workqueues which have works queued on the pool and let them process 2322e22bee78STejun Heo * those works so that forward progress can be guaranteed. 2323e22bee78STejun Heo * 2324e22bee78STejun Heo * This should happen rarely. 2325e22bee78STejun Heo */ 2326111c225aSTejun Heo static int rescuer_thread(void *__rescuer) 2327e22bee78STejun Heo { 2328111c225aSTejun Heo struct worker *rescuer = __rescuer; 2329111c225aSTejun Heo struct workqueue_struct *wq = rescuer->rescue_wq; 2330e22bee78STejun Heo struct list_head *scheduled = &rescuer->scheduled; 2331f3421797STejun Heo bool is_unbound = wq->flags & WQ_UNBOUND; 2332e22bee78STejun Heo unsigned int cpu; 2333e22bee78STejun Heo 2334e22bee78STejun Heo set_user_nice(current, RESCUER_NICE_LEVEL); 2335111c225aSTejun Heo 2336111c225aSTejun Heo /* 2337111c225aSTejun Heo * Mark rescuer as worker too. As WORKER_PREP is never cleared, it 2338111c225aSTejun Heo * doesn't participate in concurrency management. 2339111c225aSTejun Heo */ 2340111c225aSTejun Heo rescuer->task->flags |= PF_WQ_WORKER; 2341e22bee78STejun Heo repeat: 2342e22bee78STejun Heo set_current_state(TASK_INTERRUPTIBLE); 23431da177e4SLinus Torvalds 2344412d32e6SMike Galbraith if (kthread_should_stop()) { 2345412d32e6SMike Galbraith __set_current_state(TASK_RUNNING); 2346111c225aSTejun Heo rescuer->task->flags &= ~PF_WQ_WORKER; 2347e22bee78STejun Heo return 0; 2348412d32e6SMike Galbraith } 23491da177e4SLinus Torvalds 2350f3421797STejun Heo /* 2351f3421797STejun Heo * See whether any cpu is asking for help. Unbounded 2352f3421797STejun Heo * workqueues use cpu 0 in mayday_mask for CPU_UNBOUND. 2353f3421797STejun Heo */ 2354f2e005aaSTejun Heo for_each_mayday_cpu(cpu, wq->mayday_mask) { 2355f3421797STejun Heo unsigned int tcpu = is_unbound ? WORK_CPU_UNBOUND : cpu; 2356112202d9STejun Heo struct pool_workqueue *pwq = get_pwq(tcpu, wq); 2357112202d9STejun Heo struct worker_pool *pool = pwq->pool; 2358e22bee78STejun Heo struct work_struct *work, *n; 2359e22bee78STejun Heo 2360e22bee78STejun Heo __set_current_state(TASK_RUNNING); 2361f2e005aaSTejun Heo mayday_clear_cpu(cpu, wq->mayday_mask); 2362e22bee78STejun Heo 2363e22bee78STejun Heo /* migrate to the target cpu if possible */ 2364f36dc67bSLai Jiangshan worker_maybe_bind_and_lock(pool); 2365b3104104SLai Jiangshan rescuer->pool = pool; 2366e22bee78STejun Heo 2367e22bee78STejun Heo /* 2368e22bee78STejun Heo * Slurp in all works issued via this workqueue and 2369e22bee78STejun Heo * process'em. 2370e22bee78STejun Heo */ 23716183c009STejun Heo WARN_ON_ONCE(!list_empty(&rescuer->scheduled)); 2372bd7bdd43STejun Heo list_for_each_entry_safe(work, n, &pool->worklist, entry) 2373112202d9STejun Heo if (get_work_pwq(work) == pwq) 2374e22bee78STejun Heo move_linked_works(work, scheduled, &n); 2375e22bee78STejun Heo 2376e22bee78STejun Heo process_scheduled_works(rescuer); 23777576958aSTejun Heo 23787576958aSTejun Heo /* 2379d565ed63STejun Heo * Leave this pool. If keep_working() is %true, notify a 23807576958aSTejun Heo * regular worker; otherwise, we end up with 0 concurrency 23817576958aSTejun Heo * and stalling the execution. 23827576958aSTejun Heo */ 238363d95a91STejun Heo if (keep_working(pool)) 238463d95a91STejun Heo wake_up_worker(pool); 23857576958aSTejun Heo 2386b3104104SLai Jiangshan rescuer->pool = NULL; 2387d565ed63STejun Heo spin_unlock_irq(&pool->lock); 23881da177e4SLinus Torvalds } 23891da177e4SLinus Torvalds 2390111c225aSTejun Heo /* rescuers should never participate in concurrency management */ 2391111c225aSTejun Heo WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING)); 2392e22bee78STejun Heo schedule(); 2393e22bee78STejun Heo goto repeat; 23941da177e4SLinus Torvalds } 23951da177e4SLinus Torvalds 2396fc2e4d70SOleg Nesterov struct wq_barrier { 2397fc2e4d70SOleg Nesterov struct work_struct work; 2398fc2e4d70SOleg Nesterov struct completion done; 2399fc2e4d70SOleg Nesterov }; 2400fc2e4d70SOleg Nesterov 2401fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work) 2402fc2e4d70SOleg Nesterov { 2403fc2e4d70SOleg Nesterov struct wq_barrier *barr = container_of(work, struct wq_barrier, work); 2404fc2e4d70SOleg Nesterov complete(&barr->done); 2405fc2e4d70SOleg Nesterov } 2406fc2e4d70SOleg Nesterov 24074690c4abSTejun Heo /** 24084690c4abSTejun Heo * insert_wq_barrier - insert a barrier work 2409112202d9STejun Heo * @pwq: pwq to insert barrier into 24104690c4abSTejun Heo * @barr: wq_barrier to insert 2411affee4b2STejun Heo * @target: target work to attach @barr to 2412affee4b2STejun Heo * @worker: worker currently executing @target, NULL if @target is not executing 24134690c4abSTejun Heo * 2414affee4b2STejun Heo * @barr is linked to @target such that @barr is completed only after 2415affee4b2STejun Heo * @target finishes execution. Please note that the ordering 2416affee4b2STejun Heo * guarantee is observed only with respect to @target and on the local 2417affee4b2STejun Heo * cpu. 2418affee4b2STejun Heo * 2419affee4b2STejun Heo * Currently, a queued barrier can't be canceled. This is because 2420affee4b2STejun Heo * try_to_grab_pending() can't determine whether the work to be 2421affee4b2STejun Heo * grabbed is at the head of the queue and thus can't clear LINKED 2422affee4b2STejun Heo * flag of the previous work while there must be a valid next work 2423affee4b2STejun Heo * after a work with LINKED flag set. 2424affee4b2STejun Heo * 2425affee4b2STejun Heo * Note that when @worker is non-NULL, @target may be modified 2426112202d9STejun Heo * underneath us, so we can't reliably determine pwq from @target. 24274690c4abSTejun Heo * 24284690c4abSTejun Heo * CONTEXT: 2429d565ed63STejun Heo * spin_lock_irq(pool->lock). 24304690c4abSTejun Heo */ 2431112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq, 2432affee4b2STejun Heo struct wq_barrier *barr, 2433affee4b2STejun Heo struct work_struct *target, struct worker *worker) 2434fc2e4d70SOleg Nesterov { 2435affee4b2STejun Heo struct list_head *head; 2436affee4b2STejun Heo unsigned int linked = 0; 2437affee4b2STejun Heo 2438dc186ad7SThomas Gleixner /* 2439d565ed63STejun Heo * debugobject calls are safe here even with pool->lock locked 2440dc186ad7SThomas Gleixner * as we know for sure that this will not trigger any of the 2441dc186ad7SThomas Gleixner * checks and call back into the fixup functions where we 2442dc186ad7SThomas Gleixner * might deadlock. 2443dc186ad7SThomas Gleixner */ 2444ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&barr->work, wq_barrier_func); 244522df02bbSTejun Heo __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); 2446fc2e4d70SOleg Nesterov init_completion(&barr->done); 244783c22520SOleg Nesterov 2448affee4b2STejun Heo /* 2449affee4b2STejun Heo * If @target is currently being executed, schedule the 2450affee4b2STejun Heo * barrier to the worker; otherwise, put it after @target. 2451affee4b2STejun Heo */ 2452affee4b2STejun Heo if (worker) 2453affee4b2STejun Heo head = worker->scheduled.next; 2454affee4b2STejun Heo else { 2455affee4b2STejun Heo unsigned long *bits = work_data_bits(target); 2456affee4b2STejun Heo 2457affee4b2STejun Heo head = target->entry.next; 2458affee4b2STejun Heo /* there can already be other linked works, inherit and set */ 2459affee4b2STejun Heo linked = *bits & WORK_STRUCT_LINKED; 2460affee4b2STejun Heo __set_bit(WORK_STRUCT_LINKED_BIT, bits); 2461affee4b2STejun Heo } 2462affee4b2STejun Heo 2463dc186ad7SThomas Gleixner debug_work_activate(&barr->work); 2464112202d9STejun Heo insert_work(pwq, &barr->work, head, 2465affee4b2STejun Heo work_color_to_flags(WORK_NO_COLOR) | linked); 2466fc2e4d70SOleg Nesterov } 2467fc2e4d70SOleg Nesterov 246873f53c4aSTejun Heo /** 2469112202d9STejun Heo * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing 247073f53c4aSTejun Heo * @wq: workqueue being flushed 247173f53c4aSTejun Heo * @flush_color: new flush color, < 0 for no-op 247273f53c4aSTejun Heo * @work_color: new work color, < 0 for no-op 247373f53c4aSTejun Heo * 2474112202d9STejun Heo * Prepare pwqs for workqueue flushing. 247573f53c4aSTejun Heo * 2476112202d9STejun Heo * If @flush_color is non-negative, flush_color on all pwqs should be 2477112202d9STejun Heo * -1. If no pwq has in-flight commands at the specified color, all 2478112202d9STejun Heo * pwq->flush_color's stay at -1 and %false is returned. If any pwq 2479112202d9STejun Heo * has in flight commands, its pwq->flush_color is set to 2480112202d9STejun Heo * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq 248173f53c4aSTejun Heo * wakeup logic is armed and %true is returned. 248273f53c4aSTejun Heo * 248373f53c4aSTejun Heo * The caller should have initialized @wq->first_flusher prior to 248473f53c4aSTejun Heo * calling this function with non-negative @flush_color. If 248573f53c4aSTejun Heo * @flush_color is negative, no flush color update is done and %false 248673f53c4aSTejun Heo * is returned. 248773f53c4aSTejun Heo * 2488112202d9STejun Heo * If @work_color is non-negative, all pwqs should have the same 248973f53c4aSTejun Heo * work_color which is previous to @work_color and all will be 249073f53c4aSTejun Heo * advanced to @work_color. 249173f53c4aSTejun Heo * 249273f53c4aSTejun Heo * CONTEXT: 249373f53c4aSTejun Heo * mutex_lock(wq->flush_mutex). 249473f53c4aSTejun Heo * 249573f53c4aSTejun Heo * RETURNS: 249673f53c4aSTejun Heo * %true if @flush_color >= 0 and there's something to flush. %false 249773f53c4aSTejun Heo * otherwise. 249873f53c4aSTejun Heo */ 2499112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq, 250073f53c4aSTejun Heo int flush_color, int work_color) 25011da177e4SLinus Torvalds { 250273f53c4aSTejun Heo bool wait = false; 250349e3cf44STejun Heo struct pool_workqueue *pwq; 25041da177e4SLinus Torvalds 250573f53c4aSTejun Heo if (flush_color >= 0) { 25066183c009STejun Heo WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush)); 2507112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 1); 2508dc186ad7SThomas Gleixner } 250914441960SOleg Nesterov 251049e3cf44STejun Heo for_each_pwq(pwq, wq) { 2511112202d9STejun Heo struct worker_pool *pool = pwq->pool; 25121da177e4SLinus Torvalds 2513d565ed63STejun Heo spin_lock_irq(&pool->lock); 251473f53c4aSTejun Heo 251573f53c4aSTejun Heo if (flush_color >= 0) { 25166183c009STejun Heo WARN_ON_ONCE(pwq->flush_color != -1); 251773f53c4aSTejun Heo 2518112202d9STejun Heo if (pwq->nr_in_flight[flush_color]) { 2519112202d9STejun Heo pwq->flush_color = flush_color; 2520112202d9STejun Heo atomic_inc(&wq->nr_pwqs_to_flush); 252173f53c4aSTejun Heo wait = true; 25221da177e4SLinus Torvalds } 252373f53c4aSTejun Heo } 252473f53c4aSTejun Heo 252573f53c4aSTejun Heo if (work_color >= 0) { 25266183c009STejun Heo WARN_ON_ONCE(work_color != work_next_color(pwq->work_color)); 2527112202d9STejun Heo pwq->work_color = work_color; 252873f53c4aSTejun Heo } 252973f53c4aSTejun Heo 2530d565ed63STejun Heo spin_unlock_irq(&pool->lock); 25311da177e4SLinus Torvalds } 25321da177e4SLinus Torvalds 2533112202d9STejun Heo if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush)) 253473f53c4aSTejun Heo complete(&wq->first_flusher->done); 253573f53c4aSTejun Heo 253673f53c4aSTejun Heo return wait; 253783c22520SOleg Nesterov } 25381da177e4SLinus Torvalds 25390fcb78c2SRolf Eike Beer /** 25401da177e4SLinus Torvalds * flush_workqueue - ensure that any scheduled work has run to completion. 25410fcb78c2SRolf Eike Beer * @wq: workqueue to flush 25421da177e4SLinus Torvalds * 25431da177e4SLinus Torvalds * Forces execution of the workqueue and blocks until its completion. 25441da177e4SLinus Torvalds * This is typically used in driver shutdown handlers. 25451da177e4SLinus Torvalds * 2546fc2e4d70SOleg Nesterov * We sleep until all works which were queued on entry have been handled, 2547fc2e4d70SOleg Nesterov * but we are not livelocked by new incoming ones. 25481da177e4SLinus Torvalds */ 25497ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq) 25501da177e4SLinus Torvalds { 255173f53c4aSTejun Heo struct wq_flusher this_flusher = { 255273f53c4aSTejun Heo .list = LIST_HEAD_INIT(this_flusher.list), 255373f53c4aSTejun Heo .flush_color = -1, 255473f53c4aSTejun Heo .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done), 255573f53c4aSTejun Heo }; 255673f53c4aSTejun Heo int next_color; 2557b1f4ec17SOleg Nesterov 25583295f0efSIngo Molnar lock_map_acquire(&wq->lockdep_map); 25593295f0efSIngo Molnar lock_map_release(&wq->lockdep_map); 256073f53c4aSTejun Heo 256173f53c4aSTejun Heo mutex_lock(&wq->flush_mutex); 256273f53c4aSTejun Heo 256373f53c4aSTejun Heo /* 256473f53c4aSTejun Heo * Start-to-wait phase 256573f53c4aSTejun Heo */ 256673f53c4aSTejun Heo next_color = work_next_color(wq->work_color); 256773f53c4aSTejun Heo 256873f53c4aSTejun Heo if (next_color != wq->flush_color) { 256973f53c4aSTejun Heo /* 257073f53c4aSTejun Heo * Color space is not full. The current work_color 257173f53c4aSTejun Heo * becomes our flush_color and work_color is advanced 257273f53c4aSTejun Heo * by one. 257373f53c4aSTejun Heo */ 25746183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow)); 257573f53c4aSTejun Heo this_flusher.flush_color = wq->work_color; 257673f53c4aSTejun Heo wq->work_color = next_color; 257773f53c4aSTejun Heo 257873f53c4aSTejun Heo if (!wq->first_flusher) { 257973f53c4aSTejun Heo /* no flush in progress, become the first flusher */ 25806183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 258173f53c4aSTejun Heo 258273f53c4aSTejun Heo wq->first_flusher = &this_flusher; 258373f53c4aSTejun Heo 2584112202d9STejun Heo if (!flush_workqueue_prep_pwqs(wq, wq->flush_color, 258573f53c4aSTejun Heo wq->work_color)) { 258673f53c4aSTejun Heo /* nothing to flush, done */ 258773f53c4aSTejun Heo wq->flush_color = next_color; 258873f53c4aSTejun Heo wq->first_flusher = NULL; 258973f53c4aSTejun Heo goto out_unlock; 259073f53c4aSTejun Heo } 259173f53c4aSTejun Heo } else { 259273f53c4aSTejun Heo /* wait in queue */ 25936183c009STejun Heo WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color); 259473f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_queue); 2595112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 259673f53c4aSTejun Heo } 259773f53c4aSTejun Heo } else { 259873f53c4aSTejun Heo /* 259973f53c4aSTejun Heo * Oops, color space is full, wait on overflow queue. 260073f53c4aSTejun Heo * The next flush completion will assign us 260173f53c4aSTejun Heo * flush_color and transfer to flusher_queue. 260273f53c4aSTejun Heo */ 260373f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_overflow); 260473f53c4aSTejun Heo } 260573f53c4aSTejun Heo 260673f53c4aSTejun Heo mutex_unlock(&wq->flush_mutex); 260773f53c4aSTejun Heo 260873f53c4aSTejun Heo wait_for_completion(&this_flusher.done); 260973f53c4aSTejun Heo 261073f53c4aSTejun Heo /* 261173f53c4aSTejun Heo * Wake-up-and-cascade phase 261273f53c4aSTejun Heo * 261373f53c4aSTejun Heo * First flushers are responsible for cascading flushes and 261473f53c4aSTejun Heo * handling overflow. Non-first flushers can simply return. 261573f53c4aSTejun Heo */ 261673f53c4aSTejun Heo if (wq->first_flusher != &this_flusher) 261773f53c4aSTejun Heo return; 261873f53c4aSTejun Heo 261973f53c4aSTejun Heo mutex_lock(&wq->flush_mutex); 262073f53c4aSTejun Heo 26214ce48b37STejun Heo /* we might have raced, check again with mutex held */ 26224ce48b37STejun Heo if (wq->first_flusher != &this_flusher) 26234ce48b37STejun Heo goto out_unlock; 26244ce48b37STejun Heo 262573f53c4aSTejun Heo wq->first_flusher = NULL; 262673f53c4aSTejun Heo 26276183c009STejun Heo WARN_ON_ONCE(!list_empty(&this_flusher.list)); 26286183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 262973f53c4aSTejun Heo 263073f53c4aSTejun Heo while (true) { 263173f53c4aSTejun Heo struct wq_flusher *next, *tmp; 263273f53c4aSTejun Heo 263373f53c4aSTejun Heo /* complete all the flushers sharing the current flush color */ 263473f53c4aSTejun Heo list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { 263573f53c4aSTejun Heo if (next->flush_color != wq->flush_color) 263673f53c4aSTejun Heo break; 263773f53c4aSTejun Heo list_del_init(&next->list); 263873f53c4aSTejun Heo complete(&next->done); 263973f53c4aSTejun Heo } 264073f53c4aSTejun Heo 26416183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) && 264273f53c4aSTejun Heo wq->flush_color != work_next_color(wq->work_color)); 264373f53c4aSTejun Heo 264473f53c4aSTejun Heo /* this flush_color is finished, advance by one */ 264573f53c4aSTejun Heo wq->flush_color = work_next_color(wq->flush_color); 264673f53c4aSTejun Heo 264773f53c4aSTejun Heo /* one color has been freed, handle overflow queue */ 264873f53c4aSTejun Heo if (!list_empty(&wq->flusher_overflow)) { 264973f53c4aSTejun Heo /* 265073f53c4aSTejun Heo * Assign the same color to all overflowed 265173f53c4aSTejun Heo * flushers, advance work_color and append to 265273f53c4aSTejun Heo * flusher_queue. This is the start-to-wait 265373f53c4aSTejun Heo * phase for these overflowed flushers. 265473f53c4aSTejun Heo */ 265573f53c4aSTejun Heo list_for_each_entry(tmp, &wq->flusher_overflow, list) 265673f53c4aSTejun Heo tmp->flush_color = wq->work_color; 265773f53c4aSTejun Heo 265873f53c4aSTejun Heo wq->work_color = work_next_color(wq->work_color); 265973f53c4aSTejun Heo 266073f53c4aSTejun Heo list_splice_tail_init(&wq->flusher_overflow, 266173f53c4aSTejun Heo &wq->flusher_queue); 2662112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 266373f53c4aSTejun Heo } 266473f53c4aSTejun Heo 266573f53c4aSTejun Heo if (list_empty(&wq->flusher_queue)) { 26666183c009STejun Heo WARN_ON_ONCE(wq->flush_color != wq->work_color); 266773f53c4aSTejun Heo break; 266873f53c4aSTejun Heo } 266973f53c4aSTejun Heo 267073f53c4aSTejun Heo /* 267173f53c4aSTejun Heo * Need to flush more colors. Make the next flusher 2672112202d9STejun Heo * the new first flusher and arm pwqs. 267373f53c4aSTejun Heo */ 26746183c009STejun Heo WARN_ON_ONCE(wq->flush_color == wq->work_color); 26756183c009STejun Heo WARN_ON_ONCE(wq->flush_color != next->flush_color); 267673f53c4aSTejun Heo 267773f53c4aSTejun Heo list_del_init(&next->list); 267873f53c4aSTejun Heo wq->first_flusher = next; 267973f53c4aSTejun Heo 2680112202d9STejun Heo if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1)) 268173f53c4aSTejun Heo break; 268273f53c4aSTejun Heo 268373f53c4aSTejun Heo /* 268473f53c4aSTejun Heo * Meh... this color is already done, clear first 268573f53c4aSTejun Heo * flusher and repeat cascading. 268673f53c4aSTejun Heo */ 268773f53c4aSTejun Heo wq->first_flusher = NULL; 268873f53c4aSTejun Heo } 268973f53c4aSTejun Heo 269073f53c4aSTejun Heo out_unlock: 269173f53c4aSTejun Heo mutex_unlock(&wq->flush_mutex); 26921da177e4SLinus Torvalds } 2693ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue); 26941da177e4SLinus Torvalds 26959c5a2ba7STejun Heo /** 26969c5a2ba7STejun Heo * drain_workqueue - drain a workqueue 26979c5a2ba7STejun Heo * @wq: workqueue to drain 26989c5a2ba7STejun Heo * 26999c5a2ba7STejun Heo * Wait until the workqueue becomes empty. While draining is in progress, 27009c5a2ba7STejun Heo * only chain queueing is allowed. IOW, only currently pending or running 27019c5a2ba7STejun Heo * work items on @wq can queue further work items on it. @wq is flushed 27029c5a2ba7STejun Heo * repeatedly until it becomes empty. The number of flushing is detemined 27039c5a2ba7STejun Heo * by the depth of chaining and should be relatively short. Whine if it 27049c5a2ba7STejun Heo * takes too long. 27059c5a2ba7STejun Heo */ 27069c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq) 27079c5a2ba7STejun Heo { 27089c5a2ba7STejun Heo unsigned int flush_cnt = 0; 270949e3cf44STejun Heo struct pool_workqueue *pwq; 27109c5a2ba7STejun Heo 27119c5a2ba7STejun Heo /* 27129c5a2ba7STejun Heo * __queue_work() needs to test whether there are drainers, is much 27139c5a2ba7STejun Heo * hotter than drain_workqueue() and already looks at @wq->flags. 27149c5a2ba7STejun Heo * Use WQ_DRAINING so that queue doesn't have to check nr_drainers. 27159c5a2ba7STejun Heo */ 2716e98d5b16STejun Heo spin_lock_irq(&workqueue_lock); 27179c5a2ba7STejun Heo if (!wq->nr_drainers++) 27189c5a2ba7STejun Heo wq->flags |= WQ_DRAINING; 2719e98d5b16STejun Heo spin_unlock_irq(&workqueue_lock); 27209c5a2ba7STejun Heo reflush: 27219c5a2ba7STejun Heo flush_workqueue(wq); 27229c5a2ba7STejun Heo 272349e3cf44STejun Heo for_each_pwq(pwq, wq) { 2724fa2563e4SThomas Tuttle bool drained; 27259c5a2ba7STejun Heo 2726112202d9STejun Heo spin_lock_irq(&pwq->pool->lock); 2727112202d9STejun Heo drained = !pwq->nr_active && list_empty(&pwq->delayed_works); 2728112202d9STejun Heo spin_unlock_irq(&pwq->pool->lock); 2729fa2563e4SThomas Tuttle 2730fa2563e4SThomas Tuttle if (drained) 27319c5a2ba7STejun Heo continue; 27329c5a2ba7STejun Heo 27339c5a2ba7STejun Heo if (++flush_cnt == 10 || 27349c5a2ba7STejun Heo (flush_cnt % 100 == 0 && flush_cnt <= 1000)) 2735044c782cSValentin Ilie pr_warn("workqueue %s: flush on destruction isn't complete after %u tries\n", 27369c5a2ba7STejun Heo wq->name, flush_cnt); 27379c5a2ba7STejun Heo goto reflush; 27389c5a2ba7STejun Heo } 27399c5a2ba7STejun Heo 2740e98d5b16STejun Heo spin_lock_irq(&workqueue_lock); 27419c5a2ba7STejun Heo if (!--wq->nr_drainers) 27429c5a2ba7STejun Heo wq->flags &= ~WQ_DRAINING; 2743e98d5b16STejun Heo spin_unlock_irq(&workqueue_lock); 27449c5a2ba7STejun Heo } 27459c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue); 27469c5a2ba7STejun Heo 2747606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr) 2748baf59022STejun Heo { 2749baf59022STejun Heo struct worker *worker = NULL; 2750c9e7cf27STejun Heo struct worker_pool *pool; 2751112202d9STejun Heo struct pool_workqueue *pwq; 2752baf59022STejun Heo 2753baf59022STejun Heo might_sleep(); 2754c9e7cf27STejun Heo pool = get_work_pool(work); 2755c9e7cf27STejun Heo if (!pool) 2756baf59022STejun Heo return false; 2757baf59022STejun Heo 2758d565ed63STejun Heo spin_lock_irq(&pool->lock); 27590b3dae68SLai Jiangshan /* see the comment in try_to_grab_pending() with the same code */ 2760112202d9STejun Heo pwq = get_work_pwq(work); 2761112202d9STejun Heo if (pwq) { 2762112202d9STejun Heo if (unlikely(pwq->pool != pool)) 2763baf59022STejun Heo goto already_gone; 2764606a5020STejun Heo } else { 2765c9e7cf27STejun Heo worker = find_worker_executing_work(pool, work); 2766baf59022STejun Heo if (!worker) 2767baf59022STejun Heo goto already_gone; 2768112202d9STejun Heo pwq = worker->current_pwq; 2769606a5020STejun Heo } 2770baf59022STejun Heo 2771112202d9STejun Heo insert_wq_barrier(pwq, barr, work, worker); 2772d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2773baf59022STejun Heo 2774e159489bSTejun Heo /* 2775e159489bSTejun Heo * If @max_active is 1 or rescuer is in use, flushing another work 2776e159489bSTejun Heo * item on the same workqueue may lead to deadlock. Make sure the 2777e159489bSTejun Heo * flusher is not running on the same workqueue by verifying write 2778e159489bSTejun Heo * access. 2779e159489bSTejun Heo */ 2780112202d9STejun Heo if (pwq->wq->saved_max_active == 1 || pwq->wq->flags & WQ_RESCUER) 2781112202d9STejun Heo lock_map_acquire(&pwq->wq->lockdep_map); 2782e159489bSTejun Heo else 2783112202d9STejun Heo lock_map_acquire_read(&pwq->wq->lockdep_map); 2784112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 2785e159489bSTejun Heo 2786baf59022STejun Heo return true; 2787baf59022STejun Heo already_gone: 2788d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2789baf59022STejun Heo return false; 2790baf59022STejun Heo } 2791baf59022STejun Heo 2792db700897SOleg Nesterov /** 2793401a8d04STejun Heo * flush_work - wait for a work to finish executing the last queueing instance 2794401a8d04STejun Heo * @work: the work to flush 2795db700897SOleg Nesterov * 2796606a5020STejun Heo * Wait until @work has finished execution. @work is guaranteed to be idle 2797606a5020STejun Heo * on return if it hasn't been requeued since flush started. 2798401a8d04STejun Heo * 2799401a8d04STejun Heo * RETURNS: 2800401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2801401a8d04STejun Heo * %false if it was already idle. 2802db700897SOleg Nesterov */ 2803401a8d04STejun Heo bool flush_work(struct work_struct *work) 2804db700897SOleg Nesterov { 2805db700897SOleg Nesterov struct wq_barrier barr; 2806db700897SOleg Nesterov 28070976dfc1SStephen Boyd lock_map_acquire(&work->lockdep_map); 28080976dfc1SStephen Boyd lock_map_release(&work->lockdep_map); 28090976dfc1SStephen Boyd 2810606a5020STejun Heo if (start_flush_work(work, &barr)) { 2811db700897SOleg Nesterov wait_for_completion(&barr.done); 2812dc186ad7SThomas Gleixner destroy_work_on_stack(&barr.work); 2813401a8d04STejun Heo return true; 2814606a5020STejun Heo } else { 2815401a8d04STejun Heo return false; 2816db700897SOleg Nesterov } 2817606a5020STejun Heo } 2818db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work); 2819db700897SOleg Nesterov 282036e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork) 2821401a8d04STejun Heo { 2822bbb68dfaSTejun Heo unsigned long flags; 28231f1f642eSOleg Nesterov int ret; 28241f1f642eSOleg Nesterov 28251f1f642eSOleg Nesterov do { 2826bbb68dfaSTejun Heo ret = try_to_grab_pending(work, is_dwork, &flags); 2827bbb68dfaSTejun Heo /* 2828bbb68dfaSTejun Heo * If someone else is canceling, wait for the same event it 2829bbb68dfaSTejun Heo * would be waiting for before retrying. 2830bbb68dfaSTejun Heo */ 2831bbb68dfaSTejun Heo if (unlikely(ret == -ENOENT)) 2832606a5020STejun Heo flush_work(work); 28331f1f642eSOleg Nesterov } while (unlikely(ret < 0)); 28341f1f642eSOleg Nesterov 2835bbb68dfaSTejun Heo /* tell other tasks trying to grab @work to back off */ 2836bbb68dfaSTejun Heo mark_work_canceling(work); 2837bbb68dfaSTejun Heo local_irq_restore(flags); 2838bbb68dfaSTejun Heo 2839606a5020STejun Heo flush_work(work); 28407a22ad75STejun Heo clear_work_data(work); 28411f1f642eSOleg Nesterov return ret; 28421f1f642eSOleg Nesterov } 28431f1f642eSOleg Nesterov 28446e84d644SOleg Nesterov /** 2845401a8d04STejun Heo * cancel_work_sync - cancel a work and wait for it to finish 2846401a8d04STejun Heo * @work: the work to cancel 28476e84d644SOleg Nesterov * 2848401a8d04STejun Heo * Cancel @work and wait for its execution to finish. This function 2849401a8d04STejun Heo * can be used even if the work re-queues itself or migrates to 2850401a8d04STejun Heo * another workqueue. On return from this function, @work is 2851401a8d04STejun Heo * guaranteed to be not pending or executing on any CPU. 28521f1f642eSOleg Nesterov * 2853401a8d04STejun Heo * cancel_work_sync(&delayed_work->work) must not be used for 2854401a8d04STejun Heo * delayed_work's. Use cancel_delayed_work_sync() instead. 28556e84d644SOleg Nesterov * 2856401a8d04STejun Heo * The caller must ensure that the workqueue on which @work was last 28576e84d644SOleg Nesterov * queued can't be destroyed before this function returns. 2858401a8d04STejun Heo * 2859401a8d04STejun Heo * RETURNS: 2860401a8d04STejun Heo * %true if @work was pending, %false otherwise. 28616e84d644SOleg Nesterov */ 2862401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work) 28636e84d644SOleg Nesterov { 286436e227d2STejun Heo return __cancel_work_timer(work, false); 2865b89deed3SOleg Nesterov } 286628e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync); 2867b89deed3SOleg Nesterov 28686e84d644SOleg Nesterov /** 2869401a8d04STejun Heo * flush_delayed_work - wait for a dwork to finish executing the last queueing 2870401a8d04STejun Heo * @dwork: the delayed work to flush 28716e84d644SOleg Nesterov * 2872401a8d04STejun Heo * Delayed timer is cancelled and the pending work is queued for 2873401a8d04STejun Heo * immediate execution. Like flush_work(), this function only 2874401a8d04STejun Heo * considers the last queueing instance of @dwork. 28751f1f642eSOleg Nesterov * 2876401a8d04STejun Heo * RETURNS: 2877401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2878401a8d04STejun Heo * %false if it was already idle. 28796e84d644SOleg Nesterov */ 2880401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork) 2881401a8d04STejun Heo { 28828930cabaSTejun Heo local_irq_disable(); 2883401a8d04STejun Heo if (del_timer_sync(&dwork->timer)) 288460c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 28858930cabaSTejun Heo local_irq_enable(); 2886401a8d04STejun Heo return flush_work(&dwork->work); 2887401a8d04STejun Heo } 2888401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work); 2889401a8d04STejun Heo 2890401a8d04STejun Heo /** 289157b30ae7STejun Heo * cancel_delayed_work - cancel a delayed work 289257b30ae7STejun Heo * @dwork: delayed_work to cancel 289309383498STejun Heo * 289457b30ae7STejun Heo * Kill off a pending delayed_work. Returns %true if @dwork was pending 289557b30ae7STejun Heo * and canceled; %false if wasn't pending. Note that the work callback 289657b30ae7STejun Heo * function may still be running on return, unless it returns %true and the 289757b30ae7STejun Heo * work doesn't re-arm itself. Explicitly flush or use 289857b30ae7STejun Heo * cancel_delayed_work_sync() to wait on it. 289909383498STejun Heo * 290057b30ae7STejun Heo * This function is safe to call from any context including IRQ handler. 290109383498STejun Heo */ 290257b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork) 290309383498STejun Heo { 290457b30ae7STejun Heo unsigned long flags; 290557b30ae7STejun Heo int ret; 290657b30ae7STejun Heo 290757b30ae7STejun Heo do { 290857b30ae7STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 290957b30ae7STejun Heo } while (unlikely(ret == -EAGAIN)); 291057b30ae7STejun Heo 291157b30ae7STejun Heo if (unlikely(ret < 0)) 291257b30ae7STejun Heo return false; 291357b30ae7STejun Heo 29147c3eed5cSTejun Heo set_work_pool_and_clear_pending(&dwork->work, 29157c3eed5cSTejun Heo get_work_pool_id(&dwork->work)); 291657b30ae7STejun Heo local_irq_restore(flags); 2917c0158ca6SDan Magenheimer return ret; 291809383498STejun Heo } 291957b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work); 292009383498STejun Heo 292109383498STejun Heo /** 2922401a8d04STejun Heo * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish 2923401a8d04STejun Heo * @dwork: the delayed work cancel 2924401a8d04STejun Heo * 2925401a8d04STejun Heo * This is cancel_work_sync() for delayed works. 2926401a8d04STejun Heo * 2927401a8d04STejun Heo * RETURNS: 2928401a8d04STejun Heo * %true if @dwork was pending, %false otherwise. 2929401a8d04STejun Heo */ 2930401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork) 29316e84d644SOleg Nesterov { 293236e227d2STejun Heo return __cancel_work_timer(&dwork->work, true); 29336e84d644SOleg Nesterov } 2934f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync); 29351da177e4SLinus Torvalds 29360fcb78c2SRolf Eike Beer /** 2937c1a220e7SZhang Rui * schedule_work_on - put work task on a specific cpu 2938c1a220e7SZhang Rui * @cpu: cpu to put the work task on 2939c1a220e7SZhang Rui * @work: job to be done 2940c1a220e7SZhang Rui * 2941c1a220e7SZhang Rui * This puts a job on a specific cpu 2942c1a220e7SZhang Rui */ 2943d4283e93STejun Heo bool schedule_work_on(int cpu, struct work_struct *work) 2944c1a220e7SZhang Rui { 2945d320c038STejun Heo return queue_work_on(cpu, system_wq, work); 2946c1a220e7SZhang Rui } 2947c1a220e7SZhang Rui EXPORT_SYMBOL(schedule_work_on); 2948c1a220e7SZhang Rui 29490fcb78c2SRolf Eike Beer /** 2950ae90dd5dSDave Jones * schedule_work - put work task in global workqueue 29511da177e4SLinus Torvalds * @work: job to be done 29521da177e4SLinus Torvalds * 2953d4283e93STejun Heo * Returns %false if @work was already on the kernel-global workqueue and 2954d4283e93STejun Heo * %true otherwise. 295552bad64dSDavid Howells * 29560fcb78c2SRolf Eike Beer * This puts a job in the kernel-global workqueue if it was not already 29570fcb78c2SRolf Eike Beer * queued and leaves it in the same position on the kernel-global 29580fcb78c2SRolf Eike Beer * workqueue otherwise. 29591da177e4SLinus Torvalds */ 2960d4283e93STejun Heo bool schedule_work(struct work_struct *work) 29611da177e4SLinus Torvalds { 29620fcb78c2SRolf Eike Beer return queue_work(system_wq, work); 29631da177e4SLinus Torvalds } 29640fcb78c2SRolf Eike Beer EXPORT_SYMBOL(schedule_work); 29651da177e4SLinus Torvalds 29660fcb78c2SRolf Eike Beer /** 29670fcb78c2SRolf Eike Beer * schedule_delayed_work_on - queue work in global workqueue on CPU after delay 29680fcb78c2SRolf Eike Beer * @cpu: cpu to use 29690fcb78c2SRolf Eike Beer * @dwork: job to be done 29700fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait 29710fcb78c2SRolf Eike Beer * 29720fcb78c2SRolf Eike Beer * After waiting for a given time this puts a job in the kernel-global 29730fcb78c2SRolf Eike Beer * workqueue on the specified CPU. 29740fcb78c2SRolf Eike Beer */ 2975d4283e93STejun Heo bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork, 2976d4283e93STejun Heo unsigned long delay) 29771da177e4SLinus Torvalds { 2978d320c038STejun Heo return queue_delayed_work_on(cpu, system_wq, dwork, delay); 29791da177e4SLinus Torvalds } 2980ae90dd5dSDave Jones EXPORT_SYMBOL(schedule_delayed_work_on); 29811da177e4SLinus Torvalds 2982b6136773SAndrew Morton /** 29830a13c00eSTejun Heo * schedule_delayed_work - put work task in global workqueue after delay 29840a13c00eSTejun Heo * @dwork: job to be done 29850a13c00eSTejun Heo * @delay: number of jiffies to wait or 0 for immediate execution 29860a13c00eSTejun Heo * 29870a13c00eSTejun Heo * After waiting for a given time this puts a job in the kernel-global 29880a13c00eSTejun Heo * workqueue. 29890a13c00eSTejun Heo */ 2990d4283e93STejun Heo bool schedule_delayed_work(struct delayed_work *dwork, unsigned long delay) 29910a13c00eSTejun Heo { 29920a13c00eSTejun Heo return queue_delayed_work(system_wq, dwork, delay); 29930a13c00eSTejun Heo } 29940a13c00eSTejun Heo EXPORT_SYMBOL(schedule_delayed_work); 29950a13c00eSTejun Heo 29960a13c00eSTejun Heo /** 299731ddd871STejun Heo * schedule_on_each_cpu - execute a function synchronously on each online CPU 2998b6136773SAndrew Morton * @func: the function to call 2999b6136773SAndrew Morton * 300031ddd871STejun Heo * schedule_on_each_cpu() executes @func on each online CPU using the 300131ddd871STejun Heo * system workqueue and blocks until all CPUs have completed. 3002b6136773SAndrew Morton * schedule_on_each_cpu() is very slow. 300331ddd871STejun Heo * 300431ddd871STejun Heo * RETURNS: 300531ddd871STejun Heo * 0 on success, -errno on failure. 3006b6136773SAndrew Morton */ 300765f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func) 300815316ba8SChristoph Lameter { 300915316ba8SChristoph Lameter int cpu; 301038f51568SNamhyung Kim struct work_struct __percpu *works; 301115316ba8SChristoph Lameter 3012b6136773SAndrew Morton works = alloc_percpu(struct work_struct); 3013b6136773SAndrew Morton if (!works) 301415316ba8SChristoph Lameter return -ENOMEM; 3015b6136773SAndrew Morton 301695402b38SGautham R Shenoy get_online_cpus(); 301793981800STejun Heo 301815316ba8SChristoph Lameter for_each_online_cpu(cpu) { 30199bfb1839SIngo Molnar struct work_struct *work = per_cpu_ptr(works, cpu); 30209bfb1839SIngo Molnar 30219bfb1839SIngo Molnar INIT_WORK(work, func); 30228de6d308SOleg Nesterov schedule_work_on(cpu, work); 302315316ba8SChristoph Lameter } 302493981800STejun Heo 302593981800STejun Heo for_each_online_cpu(cpu) 30268616a89aSOleg Nesterov flush_work(per_cpu_ptr(works, cpu)); 302793981800STejun Heo 302895402b38SGautham R Shenoy put_online_cpus(); 3029b6136773SAndrew Morton free_percpu(works); 303015316ba8SChristoph Lameter return 0; 303115316ba8SChristoph Lameter } 303215316ba8SChristoph Lameter 3033eef6a7d5SAlan Stern /** 3034eef6a7d5SAlan Stern * flush_scheduled_work - ensure that any scheduled work has run to completion. 3035eef6a7d5SAlan Stern * 3036eef6a7d5SAlan Stern * Forces execution of the kernel-global workqueue and blocks until its 3037eef6a7d5SAlan Stern * completion. 3038eef6a7d5SAlan Stern * 3039eef6a7d5SAlan Stern * Think twice before calling this function! It's very easy to get into 3040eef6a7d5SAlan Stern * trouble if you don't take great care. Either of the following situations 3041eef6a7d5SAlan Stern * will lead to deadlock: 3042eef6a7d5SAlan Stern * 3043eef6a7d5SAlan Stern * One of the work items currently on the workqueue needs to acquire 3044eef6a7d5SAlan Stern * a lock held by your code or its caller. 3045eef6a7d5SAlan Stern * 3046eef6a7d5SAlan Stern * Your code is running in the context of a work routine. 3047eef6a7d5SAlan Stern * 3048eef6a7d5SAlan Stern * They will be detected by lockdep when they occur, but the first might not 3049eef6a7d5SAlan Stern * occur very often. It depends on what work items are on the workqueue and 3050eef6a7d5SAlan Stern * what locks they need, which you have no control over. 3051eef6a7d5SAlan Stern * 3052eef6a7d5SAlan Stern * In most situations flushing the entire workqueue is overkill; you merely 3053eef6a7d5SAlan Stern * need to know that a particular work item isn't queued and isn't running. 3054eef6a7d5SAlan Stern * In such cases you should use cancel_delayed_work_sync() or 3055eef6a7d5SAlan Stern * cancel_work_sync() instead. 3056eef6a7d5SAlan Stern */ 30571da177e4SLinus Torvalds void flush_scheduled_work(void) 30581da177e4SLinus Torvalds { 3059d320c038STejun Heo flush_workqueue(system_wq); 30601da177e4SLinus Torvalds } 3061ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work); 30621da177e4SLinus Torvalds 30631da177e4SLinus Torvalds /** 30641fa44ecaSJames Bottomley * execute_in_process_context - reliably execute the routine with user context 30651fa44ecaSJames Bottomley * @fn: the function to execute 30661fa44ecaSJames Bottomley * @ew: guaranteed storage for the execute work structure (must 30671fa44ecaSJames Bottomley * be available when the work executes) 30681fa44ecaSJames Bottomley * 30691fa44ecaSJames Bottomley * Executes the function immediately if process context is available, 30701fa44ecaSJames Bottomley * otherwise schedules the function for delayed execution. 30711fa44ecaSJames Bottomley * 30721fa44ecaSJames Bottomley * Returns: 0 - function was executed 30731fa44ecaSJames Bottomley * 1 - function was scheduled for execution 30741fa44ecaSJames Bottomley */ 307565f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew) 30761fa44ecaSJames Bottomley { 30771fa44ecaSJames Bottomley if (!in_interrupt()) { 307865f27f38SDavid Howells fn(&ew->work); 30791fa44ecaSJames Bottomley return 0; 30801fa44ecaSJames Bottomley } 30811fa44ecaSJames Bottomley 308265f27f38SDavid Howells INIT_WORK(&ew->work, fn); 30831fa44ecaSJames Bottomley schedule_work(&ew->work); 30841fa44ecaSJames Bottomley 30851fa44ecaSJames Bottomley return 1; 30861fa44ecaSJames Bottomley } 30871fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context); 30881fa44ecaSJames Bottomley 30891da177e4SLinus Torvalds int keventd_up(void) 30901da177e4SLinus Torvalds { 3091d320c038STejun Heo return system_wq != NULL; 30921da177e4SLinus Torvalds } 30931da177e4SLinus Torvalds 309430cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq) 30951da177e4SLinus Torvalds { 309649e3cf44STejun Heo bool highpri = wq->flags & WQ_HIGHPRI; 309730cdf249STejun Heo int cpu; 3098e1d8aa9fSFrederic Weisbecker 309930cdf249STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 310030cdf249STejun Heo wq->pool_wq.pcpu = alloc_percpu(struct pool_workqueue); 310130cdf249STejun Heo if (!wq->pool_wq.pcpu) 310230cdf249STejun Heo return -ENOMEM; 310330cdf249STejun Heo 310430cdf249STejun Heo for_each_possible_cpu(cpu) { 310530cdf249STejun Heo struct pool_workqueue *pwq = get_pwq(cpu, wq); 310630cdf249STejun Heo 310749e3cf44STejun Heo pwq->pool = get_std_worker_pool(cpu, highpri); 310830cdf249STejun Heo list_add_tail(&pwq->pwqs_node, &wq->pwqs); 310930cdf249STejun Heo } 311030cdf249STejun Heo } else { 311130cdf249STejun Heo struct pool_workqueue *pwq; 311230cdf249STejun Heo 311330cdf249STejun Heo pwq = kmem_cache_zalloc(pwq_cache, GFP_KERNEL); 311430cdf249STejun Heo if (!pwq) 311530cdf249STejun Heo return -ENOMEM; 311630cdf249STejun Heo 311730cdf249STejun Heo wq->pool_wq.single = pwq; 311849e3cf44STejun Heo pwq->pool = get_std_worker_pool(WORK_CPU_UNBOUND, highpri); 311930cdf249STejun Heo list_add_tail(&pwq->pwqs_node, &wq->pwqs); 312030cdf249STejun Heo } 312130cdf249STejun Heo 312230cdf249STejun Heo return 0; 31230f900049STejun Heo } 31240f900049STejun Heo 3125112202d9STejun Heo static void free_pwqs(struct workqueue_struct *wq) 312606ba38a9SOleg Nesterov { 3127e06ffa1eSLai Jiangshan if (!(wq->flags & WQ_UNBOUND)) 3128112202d9STejun Heo free_percpu(wq->pool_wq.pcpu); 3129e904e6c2STejun Heo else 3130e904e6c2STejun Heo kmem_cache_free(pwq_cache, wq->pool_wq.single); 313106ba38a9SOleg Nesterov } 313206ba38a9SOleg Nesterov 3133f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags, 3134f3421797STejun Heo const char *name) 3135b71ab8c2STejun Heo { 3136f3421797STejun Heo int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE; 3137f3421797STejun Heo 3138f3421797STejun Heo if (max_active < 1 || max_active > lim) 3139044c782cSValentin Ilie pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n", 3140f3421797STejun Heo max_active, name, 1, lim); 3141b71ab8c2STejun Heo 3142f3421797STejun Heo return clamp_val(max_active, 1, lim); 3143b71ab8c2STejun Heo } 3144b71ab8c2STejun Heo 3145b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt, 314697e37d7bSTejun Heo unsigned int flags, 31471e19ffc6STejun Heo int max_active, 3148eb13ba87SJohannes Berg struct lock_class_key *key, 3149b196be89STejun Heo const char *lock_name, ...) 31503af24433SOleg Nesterov { 3151b196be89STejun Heo va_list args, args1; 31523af24433SOleg Nesterov struct workqueue_struct *wq; 315349e3cf44STejun Heo struct pool_workqueue *pwq; 3154b196be89STejun Heo size_t namelen; 3155b196be89STejun Heo 3156b196be89STejun Heo /* determine namelen, allocate wq and format name */ 3157b196be89STejun Heo va_start(args, lock_name); 3158b196be89STejun Heo va_copy(args1, args); 3159b196be89STejun Heo namelen = vsnprintf(NULL, 0, fmt, args) + 1; 3160b196be89STejun Heo 3161b196be89STejun Heo wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL); 3162b196be89STejun Heo if (!wq) 3163b196be89STejun Heo goto err; 3164b196be89STejun Heo 3165b196be89STejun Heo vsnprintf(wq->name, namelen, fmt, args1); 3166b196be89STejun Heo va_end(args); 3167b196be89STejun Heo va_end(args1); 31683af24433SOleg Nesterov 3169f3421797STejun Heo /* 31706370a6adSTejun Heo * Workqueues which may be used during memory reclaim should 31716370a6adSTejun Heo * have a rescuer to guarantee forward progress. 31726370a6adSTejun Heo */ 31736370a6adSTejun Heo if (flags & WQ_MEM_RECLAIM) 31746370a6adSTejun Heo flags |= WQ_RESCUER; 31756370a6adSTejun Heo 3176d320c038STejun Heo max_active = max_active ?: WQ_DFL_ACTIVE; 3177b196be89STejun Heo max_active = wq_clamp_max_active(max_active, flags, wq->name); 31783af24433SOleg Nesterov 3179b196be89STejun Heo /* init wq */ 318097e37d7bSTejun Heo wq->flags = flags; 3181a0a1a5fdSTejun Heo wq->saved_max_active = max_active; 318273f53c4aSTejun Heo mutex_init(&wq->flush_mutex); 3183112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 0); 318430cdf249STejun Heo INIT_LIST_HEAD(&wq->pwqs); 318573f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_queue); 318673f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_overflow); 31873af24433SOleg Nesterov 3188eb13ba87SJohannes Berg lockdep_init_map(&wq->lockdep_map, lock_name, key, 0); 3189cce1a165SOleg Nesterov INIT_LIST_HEAD(&wq->list); 31903af24433SOleg Nesterov 319130cdf249STejun Heo if (alloc_and_link_pwqs(wq) < 0) 3192bdbc5dd7STejun Heo goto err; 3193bdbc5dd7STejun Heo 319449e3cf44STejun Heo for_each_pwq(pwq, wq) { 3195112202d9STejun Heo BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK); 3196112202d9STejun Heo pwq->wq = wq; 3197112202d9STejun Heo pwq->flush_color = -1; 3198112202d9STejun Heo pwq->max_active = max_active; 3199112202d9STejun Heo INIT_LIST_HEAD(&pwq->delayed_works); 3200e22bee78STejun Heo } 32011537663fSTejun Heo 3202e22bee78STejun Heo if (flags & WQ_RESCUER) { 3203e22bee78STejun Heo struct worker *rescuer; 3204e22bee78STejun Heo 3205f2e005aaSTejun Heo if (!alloc_mayday_mask(&wq->mayday_mask, GFP_KERNEL)) 3206e22bee78STejun Heo goto err; 3207e22bee78STejun Heo 3208e22bee78STejun Heo wq->rescuer = rescuer = alloc_worker(); 3209e22bee78STejun Heo if (!rescuer) 3210e22bee78STejun Heo goto err; 3211e22bee78STejun Heo 3212111c225aSTejun Heo rescuer->rescue_wq = wq; 3213111c225aSTejun Heo rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", 3214b196be89STejun Heo wq->name); 3215e22bee78STejun Heo if (IS_ERR(rescuer->task)) 3216e22bee78STejun Heo goto err; 3217e22bee78STejun Heo 3218e22bee78STejun Heo rescuer->task->flags |= PF_THREAD_BOUND; 3219e22bee78STejun Heo wake_up_process(rescuer->task); 32203af24433SOleg Nesterov } 32211537663fSTejun Heo 32223af24433SOleg Nesterov /* 3223a0a1a5fdSTejun Heo * workqueue_lock protects global freeze state and workqueues 3224a0a1a5fdSTejun Heo * list. Grab it, set max_active accordingly and add the new 3225a0a1a5fdSTejun Heo * workqueue to workqueues list. 32263af24433SOleg Nesterov */ 3227e98d5b16STejun Heo spin_lock_irq(&workqueue_lock); 3228a0a1a5fdSTejun Heo 322958a69cb4STejun Heo if (workqueue_freezing && wq->flags & WQ_FREEZABLE) 323049e3cf44STejun Heo for_each_pwq(pwq, wq) 323149e3cf44STejun Heo pwq->max_active = 0; 3232a0a1a5fdSTejun Heo 32333af24433SOleg Nesterov list_add(&wq->list, &workqueues); 3234a0a1a5fdSTejun Heo 3235e98d5b16STejun Heo spin_unlock_irq(&workqueue_lock); 32363af24433SOleg Nesterov 32373af24433SOleg Nesterov return wq; 32384690c4abSTejun Heo err: 32394690c4abSTejun Heo if (wq) { 3240112202d9STejun Heo free_pwqs(wq); 3241f2e005aaSTejun Heo free_mayday_mask(wq->mayday_mask); 3242e22bee78STejun Heo kfree(wq->rescuer); 32434690c4abSTejun Heo kfree(wq); 32443af24433SOleg Nesterov } 32454690c4abSTejun Heo return NULL; 32461da177e4SLinus Torvalds } 3247d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key); 32481da177e4SLinus Torvalds 32493af24433SOleg Nesterov /** 32503af24433SOleg Nesterov * destroy_workqueue - safely terminate a workqueue 32513af24433SOleg Nesterov * @wq: target workqueue 32523af24433SOleg Nesterov * 32533af24433SOleg Nesterov * Safely destroy a workqueue. All work currently pending will be done first. 32543af24433SOleg Nesterov */ 32553af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq) 32563af24433SOleg Nesterov { 325749e3cf44STejun Heo struct pool_workqueue *pwq; 32583af24433SOleg Nesterov 32599c5a2ba7STejun Heo /* drain it before proceeding with destruction */ 32609c5a2ba7STejun Heo drain_workqueue(wq); 3261c8efcc25STejun Heo 32626183c009STejun Heo /* sanity checks */ 326349e3cf44STejun Heo for_each_pwq(pwq, wq) { 32646183c009STejun Heo int i; 32656183c009STejun Heo 32666183c009STejun Heo for (i = 0; i < WORK_NR_COLORS; i++) 32676183c009STejun Heo if (WARN_ON(pwq->nr_in_flight[i])) 32686183c009STejun Heo return; 32696183c009STejun Heo if (WARN_ON(pwq->nr_active) || 32706183c009STejun Heo WARN_ON(!list_empty(&pwq->delayed_works))) 32716183c009STejun Heo return; 32726183c009STejun Heo } 32736183c009STejun Heo 3274a0a1a5fdSTejun Heo /* 3275a0a1a5fdSTejun Heo * wq list is used to freeze wq, remove from list after 3276a0a1a5fdSTejun Heo * flushing is complete in case freeze races us. 3277a0a1a5fdSTejun Heo */ 3278e98d5b16STejun Heo spin_lock_irq(&workqueue_lock); 32793af24433SOleg Nesterov list_del(&wq->list); 3280e98d5b16STejun Heo spin_unlock_irq(&workqueue_lock); 32813af24433SOleg Nesterov 3282e22bee78STejun Heo if (wq->flags & WQ_RESCUER) { 3283e22bee78STejun Heo kthread_stop(wq->rescuer->task); 3284f2e005aaSTejun Heo free_mayday_mask(wq->mayday_mask); 32858d9df9f0SXiaotian Feng kfree(wq->rescuer); 3286e22bee78STejun Heo } 3287e22bee78STejun Heo 3288112202d9STejun Heo free_pwqs(wq); 32893af24433SOleg Nesterov kfree(wq); 32903af24433SOleg Nesterov } 32913af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue); 32923af24433SOleg Nesterov 3293dcd989cbSTejun Heo /** 3294112202d9STejun Heo * pwq_set_max_active - adjust max_active of a pwq 3295112202d9STejun Heo * @pwq: target pool_workqueue 32969f4bd4cdSLai Jiangshan * @max_active: new max_active value. 32979f4bd4cdSLai Jiangshan * 3298112202d9STejun Heo * Set @pwq->max_active to @max_active and activate delayed works if 32999f4bd4cdSLai Jiangshan * increased. 33009f4bd4cdSLai Jiangshan * 33019f4bd4cdSLai Jiangshan * CONTEXT: 3302d565ed63STejun Heo * spin_lock_irq(pool->lock). 33039f4bd4cdSLai Jiangshan */ 3304112202d9STejun Heo static void pwq_set_max_active(struct pool_workqueue *pwq, int max_active) 33059f4bd4cdSLai Jiangshan { 3306112202d9STejun Heo pwq->max_active = max_active; 33079f4bd4cdSLai Jiangshan 3308112202d9STejun Heo while (!list_empty(&pwq->delayed_works) && 3309112202d9STejun Heo pwq->nr_active < pwq->max_active) 3310112202d9STejun Heo pwq_activate_first_delayed(pwq); 33119f4bd4cdSLai Jiangshan } 33129f4bd4cdSLai Jiangshan 33139f4bd4cdSLai Jiangshan /** 3314dcd989cbSTejun Heo * workqueue_set_max_active - adjust max_active of a workqueue 3315dcd989cbSTejun Heo * @wq: target workqueue 3316dcd989cbSTejun Heo * @max_active: new max_active value. 3317dcd989cbSTejun Heo * 3318dcd989cbSTejun Heo * Set max_active of @wq to @max_active. 3319dcd989cbSTejun Heo * 3320dcd989cbSTejun Heo * CONTEXT: 3321dcd989cbSTejun Heo * Don't call from IRQ context. 3322dcd989cbSTejun Heo */ 3323dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) 3324dcd989cbSTejun Heo { 332549e3cf44STejun Heo struct pool_workqueue *pwq; 3326dcd989cbSTejun Heo 3327f3421797STejun Heo max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); 3328dcd989cbSTejun Heo 3329e98d5b16STejun Heo spin_lock_irq(&workqueue_lock); 3330dcd989cbSTejun Heo 3331dcd989cbSTejun Heo wq->saved_max_active = max_active; 3332dcd989cbSTejun Heo 333349e3cf44STejun Heo for_each_pwq(pwq, wq) { 3334112202d9STejun Heo struct worker_pool *pool = pwq->pool; 3335dcd989cbSTejun Heo 3336e98d5b16STejun Heo spin_lock(&pool->lock); 3337dcd989cbSTejun Heo 333858a69cb4STejun Heo if (!(wq->flags & WQ_FREEZABLE) || 333935b6bb63STejun Heo !(pool->flags & POOL_FREEZING)) 3340112202d9STejun Heo pwq_set_max_active(pwq, max_active); 3341dcd989cbSTejun Heo 3342e98d5b16STejun Heo spin_unlock(&pool->lock); 3343dcd989cbSTejun Heo } 3344dcd989cbSTejun Heo 3345e98d5b16STejun Heo spin_unlock_irq(&workqueue_lock); 3346dcd989cbSTejun Heo } 3347dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active); 3348dcd989cbSTejun Heo 3349dcd989cbSTejun Heo /** 3350dcd989cbSTejun Heo * workqueue_congested - test whether a workqueue is congested 3351dcd989cbSTejun Heo * @cpu: CPU in question 3352dcd989cbSTejun Heo * @wq: target workqueue 3353dcd989cbSTejun Heo * 3354dcd989cbSTejun Heo * Test whether @wq's cpu workqueue for @cpu is congested. There is 3355dcd989cbSTejun Heo * no synchronization around this function and the test result is 3356dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 3357dcd989cbSTejun Heo * 3358dcd989cbSTejun Heo * RETURNS: 3359dcd989cbSTejun Heo * %true if congested, %false otherwise. 3360dcd989cbSTejun Heo */ 3361dcd989cbSTejun Heo bool workqueue_congested(unsigned int cpu, struct workqueue_struct *wq) 3362dcd989cbSTejun Heo { 3363112202d9STejun Heo struct pool_workqueue *pwq = get_pwq(cpu, wq); 3364dcd989cbSTejun Heo 3365112202d9STejun Heo return !list_empty(&pwq->delayed_works); 3366dcd989cbSTejun Heo } 3367dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested); 3368dcd989cbSTejun Heo 3369dcd989cbSTejun Heo /** 3370dcd989cbSTejun Heo * work_busy - test whether a work is currently pending or running 3371dcd989cbSTejun Heo * @work: the work to be tested 3372dcd989cbSTejun Heo * 3373dcd989cbSTejun Heo * Test whether @work is currently pending or running. There is no 3374dcd989cbSTejun Heo * synchronization around this function and the test result is 3375dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 3376dcd989cbSTejun Heo * 3377dcd989cbSTejun Heo * RETURNS: 3378dcd989cbSTejun Heo * OR'd bitmask of WORK_BUSY_* bits. 3379dcd989cbSTejun Heo */ 3380dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work) 3381dcd989cbSTejun Heo { 3382c9e7cf27STejun Heo struct worker_pool *pool = get_work_pool(work); 3383dcd989cbSTejun Heo unsigned long flags; 3384dcd989cbSTejun Heo unsigned int ret = 0; 3385dcd989cbSTejun Heo 3386dcd989cbSTejun Heo if (work_pending(work)) 3387dcd989cbSTejun Heo ret |= WORK_BUSY_PENDING; 3388038366c5SLai Jiangshan 3389038366c5SLai Jiangshan if (pool) { 3390038366c5SLai Jiangshan spin_lock_irqsave(&pool->lock, flags); 3391c9e7cf27STejun Heo if (find_worker_executing_work(pool, work)) 3392dcd989cbSTejun Heo ret |= WORK_BUSY_RUNNING; 3393d565ed63STejun Heo spin_unlock_irqrestore(&pool->lock, flags); 3394038366c5SLai Jiangshan } 3395dcd989cbSTejun Heo 3396dcd989cbSTejun Heo return ret; 3397dcd989cbSTejun Heo } 3398dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy); 3399dcd989cbSTejun Heo 3400db7bccf4STejun Heo /* 3401db7bccf4STejun Heo * CPU hotplug. 3402db7bccf4STejun Heo * 3403e22bee78STejun Heo * There are two challenges in supporting CPU hotplug. Firstly, there 3404112202d9STejun Heo * are a lot of assumptions on strong associations among work, pwq and 3405706026c2STejun Heo * pool which make migrating pending and scheduled works very 3406e22bee78STejun Heo * difficult to implement without impacting hot paths. Secondly, 340794cf58bbSTejun Heo * worker pools serve mix of short, long and very long running works making 3408e22bee78STejun Heo * blocked draining impractical. 3409e22bee78STejun Heo * 341024647570STejun Heo * This is solved by allowing the pools to be disassociated from the CPU 3411628c78e7STejun Heo * running as an unbound one and allowing it to be reattached later if the 3412628c78e7STejun Heo * cpu comes back online. 3413db7bccf4STejun Heo */ 3414db7bccf4STejun Heo 3415706026c2STejun Heo static void wq_unbind_fn(struct work_struct *work) 3416db7bccf4STejun Heo { 341738db41d9STejun Heo int cpu = smp_processor_id(); 34184ce62e9eSTejun Heo struct worker_pool *pool; 3419db7bccf4STejun Heo struct worker *worker; 3420db7bccf4STejun Heo int i; 3421db7bccf4STejun Heo 342238db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 34236183c009STejun Heo WARN_ON_ONCE(cpu != smp_processor_id()); 3424db7bccf4STejun Heo 342594cf58bbSTejun Heo mutex_lock(&pool->assoc_mutex); 342694cf58bbSTejun Heo spin_lock_irq(&pool->lock); 3427e22bee78STejun Heo 3428f2d5a0eeSTejun Heo /* 342994cf58bbSTejun Heo * We've claimed all manager positions. Make all workers 343094cf58bbSTejun Heo * unbound and set DISASSOCIATED. Before this, all workers 343194cf58bbSTejun Heo * except for the ones which are still executing works from 343294cf58bbSTejun Heo * before the last CPU down must be on the cpu. After 343394cf58bbSTejun Heo * this, they may become diasporas. 3434f2d5a0eeSTejun Heo */ 34354ce62e9eSTejun Heo list_for_each_entry(worker, &pool->idle_list, entry) 3436403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 3437db7bccf4STejun Heo 3438b67bfe0dSSasha Levin for_each_busy_worker(worker, i, pool) 3439403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 3440db7bccf4STejun Heo 344124647570STejun Heo pool->flags |= POOL_DISASSOCIATED; 3442f2d5a0eeSTejun Heo 344394cf58bbSTejun Heo spin_unlock_irq(&pool->lock); 344494cf58bbSTejun Heo mutex_unlock(&pool->assoc_mutex); 344594cf58bbSTejun Heo } 3446e22bee78STejun Heo 3447e22bee78STejun Heo /* 3448628c78e7STejun Heo * Call schedule() so that we cross rq->lock and thus can guarantee 3449628c78e7STejun Heo * sched callbacks see the %WORKER_UNBOUND flag. This is necessary 3450628c78e7STejun Heo * as scheduler callbacks may be invoked from other cpus. 3451628c78e7STejun Heo */ 3452628c78e7STejun Heo schedule(); 3453628c78e7STejun Heo 3454628c78e7STejun Heo /* 3455628c78e7STejun Heo * Sched callbacks are disabled now. Zap nr_running. After this, 3456628c78e7STejun Heo * nr_running stays zero and need_more_worker() and keep_working() 345738db41d9STejun Heo * are always true as long as the worklist is not empty. Pools on 345838db41d9STejun Heo * @cpu now behave as unbound (in terms of concurrency management) 345938db41d9STejun Heo * pools which are served by workers tied to the CPU. 3460628c78e7STejun Heo * 3461628c78e7STejun Heo * On return from this function, the current worker would trigger 3462628c78e7STejun Heo * unbound chain execution of pending work items if other workers 3463628c78e7STejun Heo * didn't already. 3464e22bee78STejun Heo */ 346538db41d9STejun Heo for_each_std_worker_pool(pool, cpu) 3466e19e397aSTejun Heo atomic_set(&pool->nr_running, 0); 3467db7bccf4STejun Heo } 3468db7bccf4STejun Heo 34698db25e78STejun Heo /* 34708db25e78STejun Heo * Workqueues should be brought up before normal priority CPU notifiers. 34718db25e78STejun Heo * This will be registered high priority CPU notifier. 34728db25e78STejun Heo */ 34739fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb, 34741da177e4SLinus Torvalds unsigned long action, 34751da177e4SLinus Torvalds void *hcpu) 34761da177e4SLinus Torvalds { 34773af24433SOleg Nesterov unsigned int cpu = (unsigned long)hcpu; 34784ce62e9eSTejun Heo struct worker_pool *pool; 34791da177e4SLinus Torvalds 34808db25e78STejun Heo switch (action & ~CPU_TASKS_FROZEN) { 34813af24433SOleg Nesterov case CPU_UP_PREPARE: 348238db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 34833ce63377STejun Heo struct worker *worker; 34843ce63377STejun Heo 34853ce63377STejun Heo if (pool->nr_workers) 34863ce63377STejun Heo continue; 34873ce63377STejun Heo 34883ce63377STejun Heo worker = create_worker(pool); 34893ce63377STejun Heo if (!worker) 34903ce63377STejun Heo return NOTIFY_BAD; 34913ce63377STejun Heo 3492d565ed63STejun Heo spin_lock_irq(&pool->lock); 34933ce63377STejun Heo start_worker(worker); 3494d565ed63STejun Heo spin_unlock_irq(&pool->lock); 34953af24433SOleg Nesterov } 34961da177e4SLinus Torvalds break; 34971da177e4SLinus Torvalds 349865758202STejun Heo case CPU_DOWN_FAILED: 349965758202STejun Heo case CPU_ONLINE: 350038db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 350194cf58bbSTejun Heo mutex_lock(&pool->assoc_mutex); 350294cf58bbSTejun Heo spin_lock_irq(&pool->lock); 350394cf58bbSTejun Heo 350424647570STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 350594cf58bbSTejun Heo rebind_workers(pool); 350694cf58bbSTejun Heo 350794cf58bbSTejun Heo spin_unlock_irq(&pool->lock); 350894cf58bbSTejun Heo mutex_unlock(&pool->assoc_mutex); 350994cf58bbSTejun Heo } 35108db25e78STejun Heo break; 351165758202STejun Heo } 351265758202STejun Heo return NOTIFY_OK; 351365758202STejun Heo } 351465758202STejun Heo 351565758202STejun Heo /* 351665758202STejun Heo * Workqueues should be brought down after normal priority CPU notifiers. 351765758202STejun Heo * This will be registered as low priority CPU notifier. 351865758202STejun Heo */ 35199fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb, 352065758202STejun Heo unsigned long action, 352165758202STejun Heo void *hcpu) 352265758202STejun Heo { 35238db25e78STejun Heo unsigned int cpu = (unsigned long)hcpu; 35248db25e78STejun Heo struct work_struct unbind_work; 35258db25e78STejun Heo 352665758202STejun Heo switch (action & ~CPU_TASKS_FROZEN) { 352765758202STejun Heo case CPU_DOWN_PREPARE: 35288db25e78STejun Heo /* unbinding should happen on the local CPU */ 3529706026c2STejun Heo INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn); 35307635d2fdSJoonsoo Kim queue_work_on(cpu, system_highpri_wq, &unbind_work); 35318db25e78STejun Heo flush_work(&unbind_work); 35328db25e78STejun Heo break; 353365758202STejun Heo } 353465758202STejun Heo return NOTIFY_OK; 353565758202STejun Heo } 353665758202STejun Heo 35372d3854a3SRusty Russell #ifdef CONFIG_SMP 35388ccad40dSRusty Russell 35392d3854a3SRusty Russell struct work_for_cpu { 3540ed48ece2STejun Heo struct work_struct work; 35412d3854a3SRusty Russell long (*fn)(void *); 35422d3854a3SRusty Russell void *arg; 35432d3854a3SRusty Russell long ret; 35442d3854a3SRusty Russell }; 35452d3854a3SRusty Russell 3546ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work) 35472d3854a3SRusty Russell { 3548ed48ece2STejun Heo struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work); 3549ed48ece2STejun Heo 35502d3854a3SRusty Russell wfc->ret = wfc->fn(wfc->arg); 35512d3854a3SRusty Russell } 35522d3854a3SRusty Russell 35532d3854a3SRusty Russell /** 35542d3854a3SRusty Russell * work_on_cpu - run a function in user context on a particular cpu 35552d3854a3SRusty Russell * @cpu: the cpu to run on 35562d3854a3SRusty Russell * @fn: the function to run 35572d3854a3SRusty Russell * @arg: the function arg 35582d3854a3SRusty Russell * 355931ad9081SRusty Russell * This will return the value @fn returns. 356031ad9081SRusty Russell * It is up to the caller to ensure that the cpu doesn't go offline. 35616b44003eSAndrew Morton * The caller must not hold any locks which would prevent @fn from completing. 35622d3854a3SRusty Russell */ 35632d3854a3SRusty Russell long work_on_cpu(unsigned int cpu, long (*fn)(void *), void *arg) 35642d3854a3SRusty Russell { 3565ed48ece2STejun Heo struct work_for_cpu wfc = { .fn = fn, .arg = arg }; 35662d3854a3SRusty Russell 3567ed48ece2STejun Heo INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn); 3568ed48ece2STejun Heo schedule_work_on(cpu, &wfc.work); 3569ed48ece2STejun Heo flush_work(&wfc.work); 35702d3854a3SRusty Russell return wfc.ret; 35712d3854a3SRusty Russell } 35722d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu); 35732d3854a3SRusty Russell #endif /* CONFIG_SMP */ 35742d3854a3SRusty Russell 3575a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 3576e7577c50SRusty Russell 3577a0a1a5fdSTejun Heo /** 3578a0a1a5fdSTejun Heo * freeze_workqueues_begin - begin freezing workqueues 3579a0a1a5fdSTejun Heo * 358058a69cb4STejun Heo * Start freezing workqueues. After this function returns, all freezable 358158a69cb4STejun Heo * workqueues will queue new works to their frozen_works list instead of 3582706026c2STejun Heo * pool->worklist. 3583a0a1a5fdSTejun Heo * 3584a0a1a5fdSTejun Heo * CONTEXT: 3585d565ed63STejun Heo * Grabs and releases workqueue_lock and pool->lock's. 3586a0a1a5fdSTejun Heo */ 3587a0a1a5fdSTejun Heo void freeze_workqueues_begin(void) 3588a0a1a5fdSTejun Heo { 3589a0a1a5fdSTejun Heo unsigned int cpu; 3590a0a1a5fdSTejun Heo 3591e98d5b16STejun Heo spin_lock_irq(&workqueue_lock); 3592a0a1a5fdSTejun Heo 35936183c009STejun Heo WARN_ON_ONCE(workqueue_freezing); 3594a0a1a5fdSTejun Heo workqueue_freezing = true; 3595a0a1a5fdSTejun Heo 3596706026c2STejun Heo for_each_wq_cpu(cpu) { 359735b6bb63STejun Heo struct worker_pool *pool; 3598bdbc5dd7STejun Heo struct workqueue_struct *wq; 35998b03ae3cSTejun Heo 360038db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 3601e98d5b16STejun Heo spin_lock(&pool->lock); 3602d565ed63STejun Heo 360335b6bb63STejun Heo WARN_ON_ONCE(pool->flags & POOL_FREEZING); 360435b6bb63STejun Heo pool->flags |= POOL_FREEZING; 3605db7bccf4STejun Heo 3606a0a1a5fdSTejun Heo list_for_each_entry(wq, &workqueues, list) { 3607112202d9STejun Heo struct pool_workqueue *pwq = get_pwq(cpu, wq); 3608a0a1a5fdSTejun Heo 3609112202d9STejun Heo if (pwq && pwq->pool == pool && 3610a1056305STejun Heo (wq->flags & WQ_FREEZABLE)) 3611112202d9STejun Heo pwq->max_active = 0; 36121da177e4SLinus Torvalds } 36138b03ae3cSTejun Heo 3614e98d5b16STejun Heo spin_unlock(&pool->lock); 3615a1056305STejun Heo } 3616a0a1a5fdSTejun Heo } 3617a0a1a5fdSTejun Heo 3618e98d5b16STejun Heo spin_unlock_irq(&workqueue_lock); 3619a0a1a5fdSTejun Heo } 3620a0a1a5fdSTejun Heo 3621a0a1a5fdSTejun Heo /** 362258a69cb4STejun Heo * freeze_workqueues_busy - are freezable workqueues still busy? 3623a0a1a5fdSTejun Heo * 3624a0a1a5fdSTejun Heo * Check whether freezing is complete. This function must be called 3625a0a1a5fdSTejun Heo * between freeze_workqueues_begin() and thaw_workqueues(). 3626a0a1a5fdSTejun Heo * 3627a0a1a5fdSTejun Heo * CONTEXT: 3628a0a1a5fdSTejun Heo * Grabs and releases workqueue_lock. 3629a0a1a5fdSTejun Heo * 3630a0a1a5fdSTejun Heo * RETURNS: 363158a69cb4STejun Heo * %true if some freezable workqueues are still busy. %false if freezing 363258a69cb4STejun Heo * is complete. 3633a0a1a5fdSTejun Heo */ 3634a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void) 3635a0a1a5fdSTejun Heo { 3636a0a1a5fdSTejun Heo unsigned int cpu; 3637a0a1a5fdSTejun Heo bool busy = false; 3638a0a1a5fdSTejun Heo 3639e98d5b16STejun Heo spin_lock_irq(&workqueue_lock); 3640a0a1a5fdSTejun Heo 36416183c009STejun Heo WARN_ON_ONCE(!workqueue_freezing); 3642a0a1a5fdSTejun Heo 3643706026c2STejun Heo for_each_wq_cpu(cpu) { 3644bdbc5dd7STejun Heo struct workqueue_struct *wq; 3645a0a1a5fdSTejun Heo /* 3646a0a1a5fdSTejun Heo * nr_active is monotonically decreasing. It's safe 3647a0a1a5fdSTejun Heo * to peek without lock. 3648a0a1a5fdSTejun Heo */ 3649a0a1a5fdSTejun Heo list_for_each_entry(wq, &workqueues, list) { 3650112202d9STejun Heo struct pool_workqueue *pwq = get_pwq(cpu, wq); 3651a0a1a5fdSTejun Heo 3652112202d9STejun Heo if (!pwq || !(wq->flags & WQ_FREEZABLE)) 3653a0a1a5fdSTejun Heo continue; 3654a0a1a5fdSTejun Heo 36556183c009STejun Heo WARN_ON_ONCE(pwq->nr_active < 0); 3656112202d9STejun Heo if (pwq->nr_active) { 3657a0a1a5fdSTejun Heo busy = true; 3658a0a1a5fdSTejun Heo goto out_unlock; 3659a0a1a5fdSTejun Heo } 3660a0a1a5fdSTejun Heo } 3661a0a1a5fdSTejun Heo } 3662a0a1a5fdSTejun Heo out_unlock: 3663e98d5b16STejun Heo spin_unlock_irq(&workqueue_lock); 3664a0a1a5fdSTejun Heo return busy; 3665a0a1a5fdSTejun Heo } 3666a0a1a5fdSTejun Heo 3667a0a1a5fdSTejun Heo /** 3668a0a1a5fdSTejun Heo * thaw_workqueues - thaw workqueues 3669a0a1a5fdSTejun Heo * 3670a0a1a5fdSTejun Heo * Thaw workqueues. Normal queueing is restored and all collected 3671706026c2STejun Heo * frozen works are transferred to their respective pool worklists. 3672a0a1a5fdSTejun Heo * 3673a0a1a5fdSTejun Heo * CONTEXT: 3674d565ed63STejun Heo * Grabs and releases workqueue_lock and pool->lock's. 3675a0a1a5fdSTejun Heo */ 3676a0a1a5fdSTejun Heo void thaw_workqueues(void) 3677a0a1a5fdSTejun Heo { 3678a0a1a5fdSTejun Heo unsigned int cpu; 3679a0a1a5fdSTejun Heo 3680e98d5b16STejun Heo spin_lock_irq(&workqueue_lock); 3681a0a1a5fdSTejun Heo 3682a0a1a5fdSTejun Heo if (!workqueue_freezing) 3683a0a1a5fdSTejun Heo goto out_unlock; 3684a0a1a5fdSTejun Heo 3685706026c2STejun Heo for_each_wq_cpu(cpu) { 36864ce62e9eSTejun Heo struct worker_pool *pool; 3687bdbc5dd7STejun Heo struct workqueue_struct *wq; 36888b03ae3cSTejun Heo 368938db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 3690e98d5b16STejun Heo spin_lock(&pool->lock); 3691d565ed63STejun Heo 369235b6bb63STejun Heo WARN_ON_ONCE(!(pool->flags & POOL_FREEZING)); 369335b6bb63STejun Heo pool->flags &= ~POOL_FREEZING; 3694db7bccf4STejun Heo 3695a0a1a5fdSTejun Heo list_for_each_entry(wq, &workqueues, list) { 3696112202d9STejun Heo struct pool_workqueue *pwq = get_pwq(cpu, wq); 3697a0a1a5fdSTejun Heo 3698112202d9STejun Heo if (!pwq || pwq->pool != pool || 3699a1056305STejun Heo !(wq->flags & WQ_FREEZABLE)) 3700a0a1a5fdSTejun Heo continue; 3701a0a1a5fdSTejun Heo 3702a0a1a5fdSTejun Heo /* restore max_active and repopulate worklist */ 3703112202d9STejun Heo pwq_set_max_active(pwq, wq->saved_max_active); 3704a0a1a5fdSTejun Heo } 37058b03ae3cSTejun Heo 37064ce62e9eSTejun Heo wake_up_worker(pool); 3707a1056305STejun Heo 3708e98d5b16STejun Heo spin_unlock(&pool->lock); 3709d565ed63STejun Heo } 3710a0a1a5fdSTejun Heo } 3711a0a1a5fdSTejun Heo 3712a0a1a5fdSTejun Heo workqueue_freezing = false; 3713a0a1a5fdSTejun Heo out_unlock: 3714e98d5b16STejun Heo spin_unlock_irq(&workqueue_lock); 3715a0a1a5fdSTejun Heo } 3716a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 3717a0a1a5fdSTejun Heo 37186ee0578bSSuresh Siddha static int __init init_workqueues(void) 37191da177e4SLinus Torvalds { 3720c34056a3STejun Heo unsigned int cpu; 3721c34056a3STejun Heo 37227c3eed5cSTejun Heo /* make sure we have enough bits for OFFQ pool ID */ 37237c3eed5cSTejun Heo BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT)) < 37246be19588SLai Jiangshan WORK_CPU_END * NR_STD_WORKER_POOLS); 3725b5490077STejun Heo 3726e904e6c2STejun Heo WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long)); 3727e904e6c2STejun Heo 3728e904e6c2STejun Heo pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC); 3729e904e6c2STejun Heo 373065758202STejun Heo cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP); 3731a5b4e57dSLai Jiangshan hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN); 37328b03ae3cSTejun Heo 3733706026c2STejun Heo /* initialize CPU pools */ 3734706026c2STejun Heo for_each_wq_cpu(cpu) { 37354ce62e9eSTejun Heo struct worker_pool *pool; 37368b03ae3cSTejun Heo 373738db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 3738d565ed63STejun Heo spin_lock_init(&pool->lock); 3739ec22ca5eSTejun Heo pool->cpu = cpu; 374024647570STejun Heo pool->flags |= POOL_DISASSOCIATED; 37414ce62e9eSTejun Heo INIT_LIST_HEAD(&pool->worklist); 37424ce62e9eSTejun Heo INIT_LIST_HEAD(&pool->idle_list); 3743c9e7cf27STejun Heo hash_init(pool->busy_hash); 3744e22bee78STejun Heo 37454ce62e9eSTejun Heo init_timer_deferrable(&pool->idle_timer); 37464ce62e9eSTejun Heo pool->idle_timer.function = idle_worker_timeout; 37474ce62e9eSTejun Heo pool->idle_timer.data = (unsigned long)pool; 3748e22bee78STejun Heo 3749706026c2STejun Heo setup_timer(&pool->mayday_timer, pool_mayday_timeout, 37504ce62e9eSTejun Heo (unsigned long)pool); 37514ce62e9eSTejun Heo 3752b2eb83d1SLai Jiangshan mutex_init(&pool->assoc_mutex); 37534ce62e9eSTejun Heo ida_init(&pool->worker_ida); 37549daf9e67STejun Heo 37559daf9e67STejun Heo /* alloc pool ID */ 37569daf9e67STejun Heo BUG_ON(worker_pool_assign_id(pool)); 37574ce62e9eSTejun Heo } 37588b03ae3cSTejun Heo } 37598b03ae3cSTejun Heo 3760e22bee78STejun Heo /* create the initial worker */ 3761706026c2STejun Heo for_each_online_wq_cpu(cpu) { 37624ce62e9eSTejun Heo struct worker_pool *pool; 3763e22bee78STejun Heo 376438db41d9STejun Heo for_each_std_worker_pool(pool, cpu) { 37654ce62e9eSTejun Heo struct worker *worker; 37664ce62e9eSTejun Heo 376724647570STejun Heo if (cpu != WORK_CPU_UNBOUND) 376824647570STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 376924647570STejun Heo 3770bc2ae0f5STejun Heo worker = create_worker(pool); 3771e22bee78STejun Heo BUG_ON(!worker); 3772d565ed63STejun Heo spin_lock_irq(&pool->lock); 3773e22bee78STejun Heo start_worker(worker); 3774d565ed63STejun Heo spin_unlock_irq(&pool->lock); 3775e22bee78STejun Heo } 37764ce62e9eSTejun Heo } 3777e22bee78STejun Heo 3778d320c038STejun Heo system_wq = alloc_workqueue("events", 0, 0); 37791aabe902SJoonsoo Kim system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0); 3780d320c038STejun Heo system_long_wq = alloc_workqueue("events_long", 0, 0); 3781f3421797STejun Heo system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, 3782f3421797STejun Heo WQ_UNBOUND_MAX_ACTIVE); 378324d51addSTejun Heo system_freezable_wq = alloc_workqueue("events_freezable", 378424d51addSTejun Heo WQ_FREEZABLE, 0); 37851aabe902SJoonsoo Kim BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq || 3786ae930e0fSTejun Heo !system_unbound_wq || !system_freezable_wq); 37876ee0578bSSuresh Siddha return 0; 37881da177e4SLinus Torvalds } 37896ee0578bSSuresh Siddha early_initcall(init_workqueues); 3790