11da177e4SLinus Torvalds /* 2c54fce6eSTejun Heo * kernel/workqueue.c - generic async execution with shared worker pool 31da177e4SLinus Torvalds * 4c54fce6eSTejun Heo * Copyright (C) 2002 Ingo Molnar 51da177e4SLinus Torvalds * 61da177e4SLinus Torvalds * Derived from the taskqueue/keventd code by: 71da177e4SLinus Torvalds * David Woodhouse <[email protected]> 8e1f8e874SFrancois Cami * Andrew Morton 91da177e4SLinus Torvalds * Kai Petzke <[email protected]> 101da177e4SLinus Torvalds * Theodore Ts'o <[email protected]> 1189ada679SChristoph Lameter * 12cde53535SChristoph Lameter * Made to use alloc_percpu by Christoph Lameter. 13c54fce6eSTejun Heo * 14c54fce6eSTejun Heo * Copyright (C) 2010 SUSE Linux Products GmbH 15c54fce6eSTejun Heo * Copyright (C) 2010 Tejun Heo <[email protected]> 16c54fce6eSTejun Heo * 17c54fce6eSTejun Heo * This is the generic async execution mechanism. Work items as are 18c54fce6eSTejun Heo * executed in process context. The worker pool is shared and 19c54fce6eSTejun Heo * automatically managed. There is one worker pool for each CPU and 20c54fce6eSTejun Heo * one extra for works which are better served by workers which are 21c54fce6eSTejun Heo * not bound to any specific CPU. 22c54fce6eSTejun Heo * 23c54fce6eSTejun Heo * Please read Documentation/workqueue.txt for details. 241da177e4SLinus Torvalds */ 251da177e4SLinus Torvalds 269984de1aSPaul Gortmaker #include <linux/export.h> 271da177e4SLinus Torvalds #include <linux/kernel.h> 281da177e4SLinus Torvalds #include <linux/sched.h> 291da177e4SLinus Torvalds #include <linux/init.h> 301da177e4SLinus Torvalds #include <linux/signal.h> 311da177e4SLinus Torvalds #include <linux/completion.h> 321da177e4SLinus Torvalds #include <linux/workqueue.h> 331da177e4SLinus Torvalds #include <linux/slab.h> 341da177e4SLinus Torvalds #include <linux/cpu.h> 351da177e4SLinus Torvalds #include <linux/notifier.h> 361da177e4SLinus Torvalds #include <linux/kthread.h> 371fa44ecaSJames Bottomley #include <linux/hardirq.h> 3846934023SChristoph Lameter #include <linux/mempolicy.h> 39341a5958SRafael J. Wysocki #include <linux/freezer.h> 40d5abe669SPeter Zijlstra #include <linux/kallsyms.h> 41d5abe669SPeter Zijlstra #include <linux/debug_locks.h> 424e6045f1SJohannes Berg #include <linux/lockdep.h> 43c34056a3STejun Heo #include <linux/idr.h> 4429c91e99STejun Heo #include <linux/jhash.h> 4542f8570fSSasha Levin #include <linux/hashtable.h> 4676af4d93STejun Heo #include <linux/rculist.h> 47e22bee78STejun Heo 48ea138446STejun Heo #include "workqueue_internal.h" 491da177e4SLinus Torvalds 50c8e55f36STejun Heo enum { 51bc2ae0f5STejun Heo /* 5224647570STejun Heo * worker_pool flags 53bc2ae0f5STejun Heo * 5424647570STejun Heo * A bound pool is either associated or disassociated with its CPU. 55bc2ae0f5STejun Heo * While associated (!DISASSOCIATED), all workers are bound to the 56bc2ae0f5STejun Heo * CPU and none has %WORKER_UNBOUND set and concurrency management 57bc2ae0f5STejun Heo * is in effect. 58bc2ae0f5STejun Heo * 59bc2ae0f5STejun Heo * While DISASSOCIATED, the cpu may be offline and all workers have 60bc2ae0f5STejun Heo * %WORKER_UNBOUND set and concurrency management disabled, and may 6124647570STejun Heo * be executing on any CPU. The pool behaves as an unbound one. 62bc2ae0f5STejun Heo * 63bc3a1afcSTejun Heo * Note that DISASSOCIATED should be flipped only while holding 64bc3a1afcSTejun Heo * manager_mutex to avoid changing binding state while 6524647570STejun Heo * create_worker() is in progress. 66bc2ae0f5STejun Heo */ 6711ebea50STejun Heo POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */ 6824647570STejun Heo POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */ 6935b6bb63STejun Heo POOL_FREEZING = 1 << 3, /* freeze in progress */ 70db7bccf4STejun Heo 71c8e55f36STejun Heo /* worker flags */ 72c8e55f36STejun Heo WORKER_STARTED = 1 << 0, /* started */ 73c8e55f36STejun Heo WORKER_DIE = 1 << 1, /* die die die */ 74c8e55f36STejun Heo WORKER_IDLE = 1 << 2, /* is idle */ 75e22bee78STejun Heo WORKER_PREP = 1 << 3, /* preparing to run works */ 76fb0e7bebSTejun Heo WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */ 77f3421797STejun Heo WORKER_UNBOUND = 1 << 7, /* worker is unbound */ 78e22bee78STejun Heo 795f7dabfdSLai Jiangshan WORKER_NOT_RUNNING = WORKER_PREP | WORKER_UNBOUND | 80403c821dSTejun Heo WORKER_CPU_INTENSIVE, 81db7bccf4STejun Heo 82e34cdddbSTejun Heo NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */ 834ce62e9eSTejun Heo 8429c91e99STejun Heo UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */ 85c8e55f36STejun Heo BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */ 86db7bccf4STejun Heo 87e22bee78STejun Heo MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */ 88e22bee78STejun Heo IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */ 89e22bee78STejun Heo 903233cdbdSTejun Heo MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2, 913233cdbdSTejun Heo /* call for help after 10ms 923233cdbdSTejun Heo (min two ticks) */ 93e22bee78STejun Heo MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */ 94e22bee78STejun Heo CREATE_COOLDOWN = HZ, /* time to breath after fail */ 951da177e4SLinus Torvalds 961da177e4SLinus Torvalds /* 97e22bee78STejun Heo * Rescue workers are used only on emergencies and shared by 98e22bee78STejun Heo * all cpus. Give -20. 99e22bee78STejun Heo */ 100e22bee78STejun Heo RESCUER_NICE_LEVEL = -20, 1013270476aSTejun Heo HIGHPRI_NICE_LEVEL = -20, 102c8e55f36STejun Heo }; 103c8e55f36STejun Heo 1041da177e4SLinus Torvalds /* 1054690c4abSTejun Heo * Structure fields follow one of the following exclusion rules. 1064690c4abSTejun Heo * 107e41e704bSTejun Heo * I: Modifiable by initialization/destruction paths and read-only for 108e41e704bSTejun Heo * everyone else. 1094690c4abSTejun Heo * 110e22bee78STejun Heo * P: Preemption protected. Disabling preemption is enough and should 111e22bee78STejun Heo * only be modified and accessed from the local cpu. 112e22bee78STejun Heo * 113d565ed63STejun Heo * L: pool->lock protected. Access with pool->lock held. 1144690c4abSTejun Heo * 115d565ed63STejun Heo * X: During normal operation, modification requires pool->lock and should 116d565ed63STejun Heo * be done only from local cpu. Either disabling preemption on local 117d565ed63STejun Heo * cpu or grabbing pool->lock is enough for read access. If 118d565ed63STejun Heo * POOL_DISASSOCIATED is set, it's identical to L. 119e22bee78STejun Heo * 12073f53c4aSTejun Heo * F: wq->flush_mutex protected. 12173f53c4aSTejun Heo * 122*822d8405STejun Heo * MG: pool->manager_mutex and pool->lock protected. Writes require both 123*822d8405STejun Heo * locks. Reads can happen under either lock. 124*822d8405STejun Heo * 1255bcab335STejun Heo * WQ: wq_mutex protected. 12676af4d93STejun Heo * 1275bcab335STejun Heo * WR: wq_mutex protected for writes. Sched-RCU protected for reads. 1285bcab335STejun Heo * 129794b18bcSTejun Heo * PW: pwq_lock protected. 130794b18bcSTejun Heo * 131794b18bcSTejun Heo * FR: wq->flush_mutex and pwq_lock protected for writes. Sched-RCU 13275ccf595STejun Heo * protected for reads. 1332e109a28STejun Heo * 1342e109a28STejun Heo * MD: wq_mayday_lock protected. 1354690c4abSTejun Heo */ 1364690c4abSTejun Heo 1372eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */ 138c34056a3STejun Heo 139bd7bdd43STejun Heo struct worker_pool { 140d565ed63STejun Heo spinlock_t lock; /* the pool lock */ 141d84ff051STejun Heo int cpu; /* I: the associated cpu */ 1429daf9e67STejun Heo int id; /* I: pool ID */ 14311ebea50STejun Heo unsigned int flags; /* X: flags */ 144bd7bdd43STejun Heo 145bd7bdd43STejun Heo struct list_head worklist; /* L: list of pending works */ 146bd7bdd43STejun Heo int nr_workers; /* L: total number of workers */ 147ea1abd61SLai Jiangshan 148ea1abd61SLai Jiangshan /* nr_idle includes the ones off idle_list for rebinding */ 149bd7bdd43STejun Heo int nr_idle; /* L: currently idle ones */ 150bd7bdd43STejun Heo 151bd7bdd43STejun Heo struct list_head idle_list; /* X: list of idle workers */ 152bd7bdd43STejun Heo struct timer_list idle_timer; /* L: worker idle timeout */ 153bd7bdd43STejun Heo struct timer_list mayday_timer; /* L: SOS timer for workers */ 154bd7bdd43STejun Heo 155c5aa87bbSTejun Heo /* a workers is either on busy_hash or idle_list, or the manager */ 156c9e7cf27STejun Heo DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER); 157c9e7cf27STejun Heo /* L: hash of busy workers */ 158c9e7cf27STejun Heo 159bc3a1afcSTejun Heo /* see manage_workers() for details on the two manager mutexes */ 16034a06bd6STejun Heo struct mutex manager_arb; /* manager arbitration */ 161bc3a1afcSTejun Heo struct mutex manager_mutex; /* manager exclusion */ 162*822d8405STejun Heo struct idr worker_idr; /* MG: worker IDs and iteration */ 163e19e397aSTejun Heo 1647a4e344cSTejun Heo struct workqueue_attrs *attrs; /* I: worker attributes */ 1655bcab335STejun Heo struct hlist_node hash_node; /* WQ: unbound_pool_hash node */ 1665bcab335STejun Heo int refcnt; /* WQ: refcnt for unbound pools */ 1677a4e344cSTejun Heo 168e19e397aSTejun Heo /* 169e19e397aSTejun Heo * The current concurrency level. As it's likely to be accessed 170e19e397aSTejun Heo * from other CPUs during try_to_wake_up(), put it in a separate 171e19e397aSTejun Heo * cacheline. 172e19e397aSTejun Heo */ 173e19e397aSTejun Heo atomic_t nr_running ____cacheline_aligned_in_smp; 17429c91e99STejun Heo 17529c91e99STejun Heo /* 17629c91e99STejun Heo * Destruction of pool is sched-RCU protected to allow dereferences 17729c91e99STejun Heo * from get_work_pool(). 17829c91e99STejun Heo */ 17929c91e99STejun Heo struct rcu_head rcu; 1808b03ae3cSTejun Heo } ____cacheline_aligned_in_smp; 1818b03ae3cSTejun Heo 1828b03ae3cSTejun Heo /* 183112202d9STejun Heo * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS 184112202d9STejun Heo * of work_struct->data are used for flags and the remaining high bits 185112202d9STejun Heo * point to the pwq; thus, pwqs need to be aligned at two's power of the 186112202d9STejun Heo * number of flag bits. 1871da177e4SLinus Torvalds */ 188112202d9STejun Heo struct pool_workqueue { 189bd7bdd43STejun Heo struct worker_pool *pool; /* I: the associated pool */ 1904690c4abSTejun Heo struct workqueue_struct *wq; /* I: the owning workqueue */ 19173f53c4aSTejun Heo int work_color; /* L: current color */ 19273f53c4aSTejun Heo int flush_color; /* L: flushing color */ 1938864b4e5STejun Heo int refcnt; /* L: reference count */ 19473f53c4aSTejun Heo int nr_in_flight[WORK_NR_COLORS]; 19573f53c4aSTejun Heo /* L: nr of in_flight works */ 1961e19ffc6STejun Heo int nr_active; /* L: nr of active works */ 197a0a1a5fdSTejun Heo int max_active; /* L: max active works */ 1981e19ffc6STejun Heo struct list_head delayed_works; /* L: delayed works */ 19975ccf595STejun Heo struct list_head pwqs_node; /* FR: node on wq->pwqs */ 2002e109a28STejun Heo struct list_head mayday_node; /* MD: node on wq->maydays */ 2018864b4e5STejun Heo 2028864b4e5STejun Heo /* 2038864b4e5STejun Heo * Release of unbound pwq is punted to system_wq. See put_pwq() 2048864b4e5STejun Heo * and pwq_unbound_release_workfn() for details. pool_workqueue 2058864b4e5STejun Heo * itself is also sched-RCU protected so that the first pwq can be 206794b18bcSTejun Heo * determined without grabbing pwq_lock. 2078864b4e5STejun Heo */ 2088864b4e5STejun Heo struct work_struct unbound_release_work; 2098864b4e5STejun Heo struct rcu_head rcu; 210e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS); 2111da177e4SLinus Torvalds 2121da177e4SLinus Torvalds /* 21373f53c4aSTejun Heo * Structure used to wait for workqueue flush. 21473f53c4aSTejun Heo */ 21573f53c4aSTejun Heo struct wq_flusher { 21673f53c4aSTejun Heo struct list_head list; /* F: list of flushers */ 21773f53c4aSTejun Heo int flush_color; /* F: flush color waiting for */ 21873f53c4aSTejun Heo struct completion done; /* flush completion */ 21973f53c4aSTejun Heo }; 2201da177e4SLinus Torvalds 221226223abSTejun Heo struct wq_device; 222226223abSTejun Heo 22373f53c4aSTejun Heo /* 224c5aa87bbSTejun Heo * The externally visible workqueue. It relays the issued work items to 225c5aa87bbSTejun Heo * the appropriate worker_pool through its pool_workqueues. 2261da177e4SLinus Torvalds */ 2271da177e4SLinus Torvalds struct workqueue_struct { 2285bcab335STejun Heo unsigned int flags; /* WQ: WQ_* flags */ 229420c0ddbSTejun Heo struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwq's */ 23075ccf595STejun Heo struct list_head pwqs; /* FR: all pwqs of this wq */ 2315bcab335STejun Heo struct list_head list; /* WQ: list of all workqueues */ 23273f53c4aSTejun Heo 23373f53c4aSTejun Heo struct mutex flush_mutex; /* protects wq flushing */ 23473f53c4aSTejun Heo int work_color; /* F: current work color */ 23573f53c4aSTejun Heo int flush_color; /* F: current flush color */ 236112202d9STejun Heo atomic_t nr_pwqs_to_flush; /* flush in progress */ 23773f53c4aSTejun Heo struct wq_flusher *first_flusher; /* F: first flusher */ 23873f53c4aSTejun Heo struct list_head flusher_queue; /* F: flush waiters */ 23973f53c4aSTejun Heo struct list_head flusher_overflow; /* F: flush overflow list */ 24073f53c4aSTejun Heo 2412e109a28STejun Heo struct list_head maydays; /* MD: pwqs requesting rescue */ 242e22bee78STejun Heo struct worker *rescuer; /* I: rescue worker */ 243e22bee78STejun Heo 2445bcab335STejun Heo int nr_drainers; /* WQ: drain in progress */ 245794b18bcSTejun Heo int saved_max_active; /* PW: saved pwq max_active */ 246226223abSTejun Heo 247226223abSTejun Heo #ifdef CONFIG_SYSFS 248226223abSTejun Heo struct wq_device *wq_dev; /* I: for sysfs interface */ 249226223abSTejun Heo #endif 2504e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 2514e6045f1SJohannes Berg struct lockdep_map lockdep_map; 2524e6045f1SJohannes Berg #endif 253b196be89STejun Heo char name[]; /* I: workqueue name */ 2541da177e4SLinus Torvalds }; 2551da177e4SLinus Torvalds 256e904e6c2STejun Heo static struct kmem_cache *pwq_cache; 257e904e6c2STejun Heo 2585bcab335STejun Heo static DEFINE_MUTEX(wq_mutex); /* protects workqueues and pools */ 259794b18bcSTejun Heo static DEFINE_SPINLOCK(pwq_lock); /* protects pool_workqueues */ 2602e109a28STejun Heo static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */ 2615bcab335STejun Heo 2625bcab335STejun Heo static LIST_HEAD(workqueues); /* WQ: list of all workqueues */ 2635bcab335STejun Heo static bool workqueue_freezing; /* WQ: have wqs started freezing? */ 2647d19c5ceSTejun Heo 2657d19c5ceSTejun Heo /* the per-cpu worker pools */ 2667d19c5ceSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], 2677d19c5ceSTejun Heo cpu_worker_pools); 2687d19c5ceSTejun Heo 2695bcab335STejun Heo static DEFINE_IDR(worker_pool_idr); /* WR: idr of all pools */ 2707d19c5ceSTejun Heo 2715bcab335STejun Heo /* WQ: hash of all unbound pools keyed by pool->attrs */ 27229c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER); 27329c91e99STejun Heo 274c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */ 27529c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS]; 27629c91e99STejun Heo 277d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly; 278d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq); 279044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly; 2801aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq); 281044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly; 282d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq); 283044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly; 284f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq); 285044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly; 28624d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq); 287d320c038STejun Heo 2887d19c5ceSTejun Heo static int worker_thread(void *__worker); 2897d19c5ceSTejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to, 2907d19c5ceSTejun Heo const struct workqueue_attrs *from); 2917d19c5ceSTejun Heo 29297bd2347STejun Heo #define CREATE_TRACE_POINTS 29397bd2347STejun Heo #include <trace/events/workqueue.h> 29497bd2347STejun Heo 2955bcab335STejun Heo #define assert_rcu_or_wq_mutex() \ 2965bcab335STejun Heo rcu_lockdep_assert(rcu_read_lock_sched_held() || \ 2975bcab335STejun Heo lockdep_is_held(&wq_mutex), \ 2985bcab335STejun Heo "sched RCU or wq_mutex should be held") 2995bcab335STejun Heo 300794b18bcSTejun Heo #define assert_rcu_or_pwq_lock() \ 30176af4d93STejun Heo rcu_lockdep_assert(rcu_read_lock_sched_held() || \ 302794b18bcSTejun Heo lockdep_is_held(&pwq_lock), \ 303794b18bcSTejun Heo "sched RCU or pwq_lock should be held") 30476af4d93STejun Heo 305*822d8405STejun Heo #ifdef CONFIG_LOCKDEP 306*822d8405STejun Heo #define assert_manager_or_pool_lock(pool) \ 307*822d8405STejun Heo WARN_ONCE(!lockdep_is_held(&(pool)->manager_mutex) && \ 308*822d8405STejun Heo !lockdep_is_held(&(pool)->lock), \ 309*822d8405STejun Heo "pool->manager_mutex or ->lock should be held") 310*822d8405STejun Heo #else 311*822d8405STejun Heo #define assert_manager_or_pool_lock(pool) do { } while (0) 312*822d8405STejun Heo #endif 313*822d8405STejun Heo 314f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu) \ 315f02ae73aSTejun Heo for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \ 316f02ae73aSTejun Heo (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \ 3177a62c2c8STejun Heo (pool)++) 3184ce62e9eSTejun Heo 319b67bfe0dSSasha Levin #define for_each_busy_worker(worker, i, pool) \ 320b67bfe0dSSasha Levin hash_for_each(pool->busy_hash, i, worker, hentry) 321db7bccf4STejun Heo 32249e3cf44STejun Heo /** 32317116969STejun Heo * for_each_pool - iterate through all worker_pools in the system 32417116969STejun Heo * @pool: iteration cursor 325611c92a0STejun Heo * @pi: integer used for iteration 326fa1b54e6STejun Heo * 3275bcab335STejun Heo * This must be called either with wq_mutex held or sched RCU read locked. 3285bcab335STejun Heo * If the pool needs to be used beyond the locking in effect, the caller is 3295bcab335STejun Heo * responsible for guaranteeing that the pool stays online. 330fa1b54e6STejun Heo * 331fa1b54e6STejun Heo * The if/else clause exists only for the lockdep assertion and can be 332fa1b54e6STejun Heo * ignored. 33317116969STejun Heo */ 334611c92a0STejun Heo #define for_each_pool(pool, pi) \ 335611c92a0STejun Heo idr_for_each_entry(&worker_pool_idr, pool, pi) \ 3365bcab335STejun Heo if (({ assert_rcu_or_wq_mutex(); false; })) { } \ 337fa1b54e6STejun Heo else 33817116969STejun Heo 33917116969STejun Heo /** 340*822d8405STejun Heo * for_each_pool_worker - iterate through all workers of a worker_pool 341*822d8405STejun Heo * @worker: iteration cursor 342*822d8405STejun Heo * @wi: integer used for iteration 343*822d8405STejun Heo * @pool: worker_pool to iterate workers of 344*822d8405STejun Heo * 345*822d8405STejun Heo * This must be called with either @pool->manager_mutex or ->lock held. 346*822d8405STejun Heo * 347*822d8405STejun Heo * The if/else clause exists only for the lockdep assertion and can be 348*822d8405STejun Heo * ignored. 349*822d8405STejun Heo */ 350*822d8405STejun Heo #define for_each_pool_worker(worker, wi, pool) \ 351*822d8405STejun Heo idr_for_each_entry(&(pool)->worker_idr, (worker), (wi)) \ 352*822d8405STejun Heo if (({ assert_manager_or_pool_lock((pool)); false; })) { } \ 353*822d8405STejun Heo else 354*822d8405STejun Heo 355*822d8405STejun Heo /** 35649e3cf44STejun Heo * for_each_pwq - iterate through all pool_workqueues of the specified workqueue 35749e3cf44STejun Heo * @pwq: iteration cursor 35849e3cf44STejun Heo * @wq: the target workqueue 35976af4d93STejun Heo * 360794b18bcSTejun Heo * This must be called either with pwq_lock held or sched RCU read locked. 361794b18bcSTejun Heo * If the pwq needs to be used beyond the locking in effect, the caller is 362794b18bcSTejun Heo * responsible for guaranteeing that the pwq stays online. 36376af4d93STejun Heo * 36476af4d93STejun Heo * The if/else clause exists only for the lockdep assertion and can be 36576af4d93STejun Heo * ignored. 36649e3cf44STejun Heo */ 36749e3cf44STejun Heo #define for_each_pwq(pwq, wq) \ 36876af4d93STejun Heo list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \ 369794b18bcSTejun Heo if (({ assert_rcu_or_pwq_lock(); false; })) { } \ 37076af4d93STejun Heo else 371f3421797STejun Heo 372dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 373dc186ad7SThomas Gleixner 374dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr; 375dc186ad7SThomas Gleixner 37699777288SStanislaw Gruszka static void *work_debug_hint(void *addr) 37799777288SStanislaw Gruszka { 37899777288SStanislaw Gruszka return ((struct work_struct *) addr)->func; 37999777288SStanislaw Gruszka } 38099777288SStanislaw Gruszka 381dc186ad7SThomas Gleixner /* 382dc186ad7SThomas Gleixner * fixup_init is called when: 383dc186ad7SThomas Gleixner * - an active object is initialized 384dc186ad7SThomas Gleixner */ 385dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state) 386dc186ad7SThomas Gleixner { 387dc186ad7SThomas Gleixner struct work_struct *work = addr; 388dc186ad7SThomas Gleixner 389dc186ad7SThomas Gleixner switch (state) { 390dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 391dc186ad7SThomas Gleixner cancel_work_sync(work); 392dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 393dc186ad7SThomas Gleixner return 1; 394dc186ad7SThomas Gleixner default: 395dc186ad7SThomas Gleixner return 0; 396dc186ad7SThomas Gleixner } 397dc186ad7SThomas Gleixner } 398dc186ad7SThomas Gleixner 399dc186ad7SThomas Gleixner /* 400dc186ad7SThomas Gleixner * fixup_activate is called when: 401dc186ad7SThomas Gleixner * - an active object is activated 402dc186ad7SThomas Gleixner * - an unknown object is activated (might be a statically initialized object) 403dc186ad7SThomas Gleixner */ 404dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state) 405dc186ad7SThomas Gleixner { 406dc186ad7SThomas Gleixner struct work_struct *work = addr; 407dc186ad7SThomas Gleixner 408dc186ad7SThomas Gleixner switch (state) { 409dc186ad7SThomas Gleixner 410dc186ad7SThomas Gleixner case ODEBUG_STATE_NOTAVAILABLE: 411dc186ad7SThomas Gleixner /* 412dc186ad7SThomas Gleixner * This is not really a fixup. The work struct was 413dc186ad7SThomas Gleixner * statically initialized. We just make sure that it 414dc186ad7SThomas Gleixner * is tracked in the object tracker. 415dc186ad7SThomas Gleixner */ 41622df02bbSTejun Heo if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) { 417dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 418dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 419dc186ad7SThomas Gleixner return 0; 420dc186ad7SThomas Gleixner } 421dc186ad7SThomas Gleixner WARN_ON_ONCE(1); 422dc186ad7SThomas Gleixner return 0; 423dc186ad7SThomas Gleixner 424dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 425dc186ad7SThomas Gleixner WARN_ON(1); 426dc186ad7SThomas Gleixner 427dc186ad7SThomas Gleixner default: 428dc186ad7SThomas Gleixner return 0; 429dc186ad7SThomas Gleixner } 430dc186ad7SThomas Gleixner } 431dc186ad7SThomas Gleixner 432dc186ad7SThomas Gleixner /* 433dc186ad7SThomas Gleixner * fixup_free is called when: 434dc186ad7SThomas Gleixner * - an active object is freed 435dc186ad7SThomas Gleixner */ 436dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state) 437dc186ad7SThomas Gleixner { 438dc186ad7SThomas Gleixner struct work_struct *work = addr; 439dc186ad7SThomas Gleixner 440dc186ad7SThomas Gleixner switch (state) { 441dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 442dc186ad7SThomas Gleixner cancel_work_sync(work); 443dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 444dc186ad7SThomas Gleixner return 1; 445dc186ad7SThomas Gleixner default: 446dc186ad7SThomas Gleixner return 0; 447dc186ad7SThomas Gleixner } 448dc186ad7SThomas Gleixner } 449dc186ad7SThomas Gleixner 450dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = { 451dc186ad7SThomas Gleixner .name = "work_struct", 45299777288SStanislaw Gruszka .debug_hint = work_debug_hint, 453dc186ad7SThomas Gleixner .fixup_init = work_fixup_init, 454dc186ad7SThomas Gleixner .fixup_activate = work_fixup_activate, 455dc186ad7SThomas Gleixner .fixup_free = work_fixup_free, 456dc186ad7SThomas Gleixner }; 457dc186ad7SThomas Gleixner 458dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) 459dc186ad7SThomas Gleixner { 460dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 461dc186ad7SThomas Gleixner } 462dc186ad7SThomas Gleixner 463dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) 464dc186ad7SThomas Gleixner { 465dc186ad7SThomas Gleixner debug_object_deactivate(work, &work_debug_descr); 466dc186ad7SThomas Gleixner } 467dc186ad7SThomas Gleixner 468dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack) 469dc186ad7SThomas Gleixner { 470dc186ad7SThomas Gleixner if (onstack) 471dc186ad7SThomas Gleixner debug_object_init_on_stack(work, &work_debug_descr); 472dc186ad7SThomas Gleixner else 473dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 474dc186ad7SThomas Gleixner } 475dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work); 476dc186ad7SThomas Gleixner 477dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work) 478dc186ad7SThomas Gleixner { 479dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 480dc186ad7SThomas Gleixner } 481dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack); 482dc186ad7SThomas Gleixner 483dc186ad7SThomas Gleixner #else 484dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { } 485dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { } 486dc186ad7SThomas Gleixner #endif 487dc186ad7SThomas Gleixner 4889daf9e67STejun Heo /* allocate ID and assign it to @pool */ 4899daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool) 4909daf9e67STejun Heo { 4919daf9e67STejun Heo int ret; 4929daf9e67STejun Heo 4935bcab335STejun Heo lockdep_assert_held(&wq_mutex); 4945bcab335STejun Heo 495fa1b54e6STejun Heo do { 496fa1b54e6STejun Heo if (!idr_pre_get(&worker_pool_idr, GFP_KERNEL)) 497fa1b54e6STejun Heo return -ENOMEM; 4989daf9e67STejun Heo ret = idr_get_new(&worker_pool_idr, pool, &pool->id); 499fa1b54e6STejun Heo } while (ret == -EAGAIN); 5009daf9e67STejun Heo 5019daf9e67STejun Heo return ret; 5029daf9e67STejun Heo } 5039daf9e67STejun Heo 50476af4d93STejun Heo /** 50576af4d93STejun Heo * first_pwq - return the first pool_workqueue of the specified workqueue 50676af4d93STejun Heo * @wq: the target workqueue 50776af4d93STejun Heo * 508794b18bcSTejun Heo * This must be called either with pwq_lock held or sched RCU read locked. 509794b18bcSTejun Heo * If the pwq needs to be used beyond the locking in effect, the caller is 510794b18bcSTejun Heo * responsible for guaranteeing that the pwq stays online. 51176af4d93STejun Heo */ 5127fb98ea7STejun Heo static struct pool_workqueue *first_pwq(struct workqueue_struct *wq) 513a848e3b6SOleg Nesterov { 514794b18bcSTejun Heo assert_rcu_or_pwq_lock(); 51576af4d93STejun Heo return list_first_or_null_rcu(&wq->pwqs, struct pool_workqueue, 51676af4d93STejun Heo pwqs_node); 517f3421797STejun Heo } 518a848e3b6SOleg Nesterov 51973f53c4aSTejun Heo static unsigned int work_color_to_flags(int color) 52073f53c4aSTejun Heo { 52173f53c4aSTejun Heo return color << WORK_STRUCT_COLOR_SHIFT; 52273f53c4aSTejun Heo } 52373f53c4aSTejun Heo 52473f53c4aSTejun Heo static int get_work_color(struct work_struct *work) 52573f53c4aSTejun Heo { 52673f53c4aSTejun Heo return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) & 52773f53c4aSTejun Heo ((1 << WORK_STRUCT_COLOR_BITS) - 1); 52873f53c4aSTejun Heo } 52973f53c4aSTejun Heo 53073f53c4aSTejun Heo static int work_next_color(int color) 53173f53c4aSTejun Heo { 53273f53c4aSTejun Heo return (color + 1) % WORK_NR_COLORS; 533b1f4ec17SOleg Nesterov } 534b1f4ec17SOleg Nesterov 5354594bf15SDavid Howells /* 536112202d9STejun Heo * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data 537112202d9STejun Heo * contain the pointer to the queued pwq. Once execution starts, the flag 5387c3eed5cSTejun Heo * is cleared and the high bits contain OFFQ flags and pool ID. 5397a22ad75STejun Heo * 540112202d9STejun Heo * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling() 541112202d9STejun Heo * and clear_work_data() can be used to set the pwq, pool or clear 542bbb68dfaSTejun Heo * work->data. These functions should only be called while the work is 543bbb68dfaSTejun Heo * owned - ie. while the PENDING bit is set. 5447a22ad75STejun Heo * 545112202d9STejun Heo * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq 5467c3eed5cSTejun Heo * corresponding to a work. Pool is available once the work has been 547112202d9STejun Heo * queued anywhere after initialization until it is sync canceled. pwq is 5487c3eed5cSTejun Heo * available only while the work item is queued. 549bbb68dfaSTejun Heo * 550bbb68dfaSTejun Heo * %WORK_OFFQ_CANCELING is used to mark a work item which is being 551bbb68dfaSTejun Heo * canceled. While being canceled, a work item may have its PENDING set 552bbb68dfaSTejun Heo * but stay off timer and worklist for arbitrarily long and nobody should 553bbb68dfaSTejun Heo * try to steal the PENDING bit. 5544594bf15SDavid Howells */ 5557a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data, 5567a22ad75STejun Heo unsigned long flags) 5577a22ad75STejun Heo { 5586183c009STejun Heo WARN_ON_ONCE(!work_pending(work)); 5597a22ad75STejun Heo atomic_long_set(&work->data, data | flags | work_static(work)); 5607a22ad75STejun Heo } 5617a22ad75STejun Heo 562112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq, 5634690c4abSTejun Heo unsigned long extra_flags) 564365970a1SDavid Howells { 565112202d9STejun Heo set_work_data(work, (unsigned long)pwq, 566112202d9STejun Heo WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags); 567365970a1SDavid Howells } 568365970a1SDavid Howells 5694468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work, 5704468a00fSLai Jiangshan int pool_id) 5714468a00fSLai Jiangshan { 5724468a00fSLai Jiangshan set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 5734468a00fSLai Jiangshan WORK_STRUCT_PENDING); 5744468a00fSLai Jiangshan } 5754468a00fSLai Jiangshan 5767c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work, 5777c3eed5cSTejun Heo int pool_id) 5784d707b9fSOleg Nesterov { 57923657bb1STejun Heo /* 58023657bb1STejun Heo * The following wmb is paired with the implied mb in 58123657bb1STejun Heo * test_and_set_bit(PENDING) and ensures all updates to @work made 58223657bb1STejun Heo * here are visible to and precede any updates by the next PENDING 58323657bb1STejun Heo * owner. 58423657bb1STejun Heo */ 58523657bb1STejun Heo smp_wmb(); 5867c3eed5cSTejun Heo set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0); 5874d707b9fSOleg Nesterov } 5884d707b9fSOleg Nesterov 5897a22ad75STejun Heo static void clear_work_data(struct work_struct *work) 590365970a1SDavid Howells { 5917c3eed5cSTejun Heo smp_wmb(); /* see set_work_pool_and_clear_pending() */ 5927c3eed5cSTejun Heo set_work_data(work, WORK_STRUCT_NO_POOL, 0); 5937a22ad75STejun Heo } 5947a22ad75STejun Heo 595112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work) 5967a22ad75STejun Heo { 597e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 5987a22ad75STejun Heo 599112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 600e120153dSTejun Heo return (void *)(data & WORK_STRUCT_WQ_DATA_MASK); 601e120153dSTejun Heo else 602e120153dSTejun Heo return NULL; 6037a22ad75STejun Heo } 6047a22ad75STejun Heo 6057c3eed5cSTejun Heo /** 6067c3eed5cSTejun Heo * get_work_pool - return the worker_pool a given work was associated with 6077c3eed5cSTejun Heo * @work: the work item of interest 6087c3eed5cSTejun Heo * 6097c3eed5cSTejun Heo * Return the worker_pool @work was last associated with. %NULL if none. 610fa1b54e6STejun Heo * 6115bcab335STejun Heo * Pools are created and destroyed under wq_mutex, and allows read access 6125bcab335STejun Heo * under sched-RCU read lock. As such, this function should be called 6135bcab335STejun Heo * under wq_mutex or with preemption disabled. 614fa1b54e6STejun Heo * 615fa1b54e6STejun Heo * All fields of the returned pool are accessible as long as the above 616fa1b54e6STejun Heo * mentioned locking is in effect. If the returned pool needs to be used 617fa1b54e6STejun Heo * beyond the critical section, the caller is responsible for ensuring the 618fa1b54e6STejun Heo * returned pool is and stays online. 6197c3eed5cSTejun Heo */ 6207c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work) 6217a22ad75STejun Heo { 622e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 6237c3eed5cSTejun Heo int pool_id; 6247a22ad75STejun Heo 6255bcab335STejun Heo assert_rcu_or_wq_mutex(); 626fa1b54e6STejun Heo 627112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 628112202d9STejun Heo return ((struct pool_workqueue *) 6297c3eed5cSTejun Heo (data & WORK_STRUCT_WQ_DATA_MASK))->pool; 6307a22ad75STejun Heo 6317c3eed5cSTejun Heo pool_id = data >> WORK_OFFQ_POOL_SHIFT; 6327c3eed5cSTejun Heo if (pool_id == WORK_OFFQ_POOL_NONE) 6337a22ad75STejun Heo return NULL; 6347a22ad75STejun Heo 635fa1b54e6STejun Heo return idr_find(&worker_pool_idr, pool_id); 6367c3eed5cSTejun Heo } 6377c3eed5cSTejun Heo 6387c3eed5cSTejun Heo /** 6397c3eed5cSTejun Heo * get_work_pool_id - return the worker pool ID a given work is associated with 6407c3eed5cSTejun Heo * @work: the work item of interest 6417c3eed5cSTejun Heo * 6427c3eed5cSTejun Heo * Return the worker_pool ID @work was last associated with. 6437c3eed5cSTejun Heo * %WORK_OFFQ_POOL_NONE if none. 6447c3eed5cSTejun Heo */ 6457c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work) 6467c3eed5cSTejun Heo { 64754d5b7d0SLai Jiangshan unsigned long data = atomic_long_read(&work->data); 6487c3eed5cSTejun Heo 649112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 650112202d9STejun Heo return ((struct pool_workqueue *) 65154d5b7d0SLai Jiangshan (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id; 65254d5b7d0SLai Jiangshan 65354d5b7d0SLai Jiangshan return data >> WORK_OFFQ_POOL_SHIFT; 6547c3eed5cSTejun Heo } 6557c3eed5cSTejun Heo 656bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work) 657bbb68dfaSTejun Heo { 6587c3eed5cSTejun Heo unsigned long pool_id = get_work_pool_id(work); 659bbb68dfaSTejun Heo 6607c3eed5cSTejun Heo pool_id <<= WORK_OFFQ_POOL_SHIFT; 6617c3eed5cSTejun Heo set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING); 662bbb68dfaSTejun Heo } 663bbb68dfaSTejun Heo 664bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work) 665bbb68dfaSTejun Heo { 666bbb68dfaSTejun Heo unsigned long data = atomic_long_read(&work->data); 667bbb68dfaSTejun Heo 668112202d9STejun Heo return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING); 669bbb68dfaSTejun Heo } 670bbb68dfaSTejun Heo 671e22bee78STejun Heo /* 6723270476aSTejun Heo * Policy functions. These define the policies on how the global worker 6733270476aSTejun Heo * pools are managed. Unless noted otherwise, these functions assume that 674d565ed63STejun Heo * they're being called with pool->lock held. 675e22bee78STejun Heo */ 676e22bee78STejun Heo 67763d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool) 678649027d7STejun Heo { 679e19e397aSTejun Heo return !atomic_read(&pool->nr_running); 680649027d7STejun Heo } 681649027d7STejun Heo 682e22bee78STejun Heo /* 683e22bee78STejun Heo * Need to wake up a worker? Called from anything but currently 684e22bee78STejun Heo * running workers. 685974271c4STejun Heo * 686974271c4STejun Heo * Note that, because unbound workers never contribute to nr_running, this 687706026c2STejun Heo * function will always return %true for unbound pools as long as the 688974271c4STejun Heo * worklist isn't empty. 689e22bee78STejun Heo */ 69063d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool) 691e22bee78STejun Heo { 69263d95a91STejun Heo return !list_empty(&pool->worklist) && __need_more_worker(pool); 693e22bee78STejun Heo } 694e22bee78STejun Heo 695e22bee78STejun Heo /* Can I start working? Called from busy but !running workers. */ 69663d95a91STejun Heo static bool may_start_working(struct worker_pool *pool) 697e22bee78STejun Heo { 69863d95a91STejun Heo return pool->nr_idle; 699e22bee78STejun Heo } 700e22bee78STejun Heo 701e22bee78STejun Heo /* Do I need to keep working? Called from currently running workers. */ 70263d95a91STejun Heo static bool keep_working(struct worker_pool *pool) 703e22bee78STejun Heo { 704e19e397aSTejun Heo return !list_empty(&pool->worklist) && 705e19e397aSTejun Heo atomic_read(&pool->nr_running) <= 1; 706e22bee78STejun Heo } 707e22bee78STejun Heo 708e22bee78STejun Heo /* Do we need a new worker? Called from manager. */ 70963d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool) 710e22bee78STejun Heo { 71163d95a91STejun Heo return need_more_worker(pool) && !may_start_working(pool); 712e22bee78STejun Heo } 713e22bee78STejun Heo 714e22bee78STejun Heo /* Do I need to be the manager? */ 71563d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool) 716e22bee78STejun Heo { 71763d95a91STejun Heo return need_to_create_worker(pool) || 71811ebea50STejun Heo (pool->flags & POOL_MANAGE_WORKERS); 719e22bee78STejun Heo } 720e22bee78STejun Heo 721e22bee78STejun Heo /* Do we have too many workers and should some go away? */ 72263d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool) 723e22bee78STejun Heo { 72434a06bd6STejun Heo bool managing = mutex_is_locked(&pool->manager_arb); 72563d95a91STejun Heo int nr_idle = pool->nr_idle + managing; /* manager is considered idle */ 72663d95a91STejun Heo int nr_busy = pool->nr_workers - nr_idle; 727e22bee78STejun Heo 728ea1abd61SLai Jiangshan /* 729ea1abd61SLai Jiangshan * nr_idle and idle_list may disagree if idle rebinding is in 730ea1abd61SLai Jiangshan * progress. Never return %true if idle_list is empty. 731ea1abd61SLai Jiangshan */ 732ea1abd61SLai Jiangshan if (list_empty(&pool->idle_list)) 733ea1abd61SLai Jiangshan return false; 734ea1abd61SLai Jiangshan 735e22bee78STejun Heo return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; 736e22bee78STejun Heo } 737e22bee78STejun Heo 738e22bee78STejun Heo /* 739e22bee78STejun Heo * Wake up functions. 740e22bee78STejun Heo */ 741e22bee78STejun Heo 7427e11629dSTejun Heo /* Return the first worker. Safe with preemption disabled */ 74363d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool) 7447e11629dSTejun Heo { 74563d95a91STejun Heo if (unlikely(list_empty(&pool->idle_list))) 7467e11629dSTejun Heo return NULL; 7477e11629dSTejun Heo 74863d95a91STejun Heo return list_first_entry(&pool->idle_list, struct worker, entry); 7497e11629dSTejun Heo } 7507e11629dSTejun Heo 7517e11629dSTejun Heo /** 7527e11629dSTejun Heo * wake_up_worker - wake up an idle worker 75363d95a91STejun Heo * @pool: worker pool to wake worker from 7547e11629dSTejun Heo * 75563d95a91STejun Heo * Wake up the first idle worker of @pool. 7567e11629dSTejun Heo * 7577e11629dSTejun Heo * CONTEXT: 758d565ed63STejun Heo * spin_lock_irq(pool->lock). 7597e11629dSTejun Heo */ 76063d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool) 7617e11629dSTejun Heo { 76263d95a91STejun Heo struct worker *worker = first_worker(pool); 7637e11629dSTejun Heo 7647e11629dSTejun Heo if (likely(worker)) 7657e11629dSTejun Heo wake_up_process(worker->task); 7667e11629dSTejun Heo } 7677e11629dSTejun Heo 7684690c4abSTejun Heo /** 769e22bee78STejun Heo * wq_worker_waking_up - a worker is waking up 770e22bee78STejun Heo * @task: task waking up 771e22bee78STejun Heo * @cpu: CPU @task is waking up to 772e22bee78STejun Heo * 773e22bee78STejun Heo * This function is called during try_to_wake_up() when a worker is 774e22bee78STejun Heo * being awoken. 775e22bee78STejun Heo * 776e22bee78STejun Heo * CONTEXT: 777e22bee78STejun Heo * spin_lock_irq(rq->lock) 778e22bee78STejun Heo */ 779d84ff051STejun Heo void wq_worker_waking_up(struct task_struct *task, int cpu) 780e22bee78STejun Heo { 781e22bee78STejun Heo struct worker *worker = kthread_data(task); 782e22bee78STejun Heo 78336576000SJoonsoo Kim if (!(worker->flags & WORKER_NOT_RUNNING)) { 784ec22ca5eSTejun Heo WARN_ON_ONCE(worker->pool->cpu != cpu); 785e19e397aSTejun Heo atomic_inc(&worker->pool->nr_running); 786e22bee78STejun Heo } 78736576000SJoonsoo Kim } 788e22bee78STejun Heo 789e22bee78STejun Heo /** 790e22bee78STejun Heo * wq_worker_sleeping - a worker is going to sleep 791e22bee78STejun Heo * @task: task going to sleep 792e22bee78STejun Heo * @cpu: CPU in question, must be the current CPU number 793e22bee78STejun Heo * 794e22bee78STejun Heo * This function is called during schedule() when a busy worker is 795e22bee78STejun Heo * going to sleep. Worker on the same cpu can be woken up by 796e22bee78STejun Heo * returning pointer to its task. 797e22bee78STejun Heo * 798e22bee78STejun Heo * CONTEXT: 799e22bee78STejun Heo * spin_lock_irq(rq->lock) 800e22bee78STejun Heo * 801e22bee78STejun Heo * RETURNS: 802e22bee78STejun Heo * Worker task on @cpu to wake up, %NULL if none. 803e22bee78STejun Heo */ 804d84ff051STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu) 805e22bee78STejun Heo { 806e22bee78STejun Heo struct worker *worker = kthread_data(task), *to_wakeup = NULL; 807111c225aSTejun Heo struct worker_pool *pool; 808e22bee78STejun Heo 809111c225aSTejun Heo /* 810111c225aSTejun Heo * Rescuers, which may not have all the fields set up like normal 811111c225aSTejun Heo * workers, also reach here, let's not access anything before 812111c225aSTejun Heo * checking NOT_RUNNING. 813111c225aSTejun Heo */ 8142d64672eSSteven Rostedt if (worker->flags & WORKER_NOT_RUNNING) 815e22bee78STejun Heo return NULL; 816e22bee78STejun Heo 817111c225aSTejun Heo pool = worker->pool; 818111c225aSTejun Heo 819e22bee78STejun Heo /* this can only happen on the local cpu */ 8206183c009STejun Heo if (WARN_ON_ONCE(cpu != raw_smp_processor_id())) 8216183c009STejun Heo return NULL; 822e22bee78STejun Heo 823e22bee78STejun Heo /* 824e22bee78STejun Heo * The counterpart of the following dec_and_test, implied mb, 825e22bee78STejun Heo * worklist not empty test sequence is in insert_work(). 826e22bee78STejun Heo * Please read comment there. 827e22bee78STejun Heo * 828628c78e7STejun Heo * NOT_RUNNING is clear. This means that we're bound to and 829628c78e7STejun Heo * running on the local cpu w/ rq lock held and preemption 830628c78e7STejun Heo * disabled, which in turn means that none else could be 831d565ed63STejun Heo * manipulating idle_list, so dereferencing idle_list without pool 832628c78e7STejun Heo * lock is safe. 833e22bee78STejun Heo */ 834e19e397aSTejun Heo if (atomic_dec_and_test(&pool->nr_running) && 835e19e397aSTejun Heo !list_empty(&pool->worklist)) 83663d95a91STejun Heo to_wakeup = first_worker(pool); 837e22bee78STejun Heo return to_wakeup ? to_wakeup->task : NULL; 838e22bee78STejun Heo } 839e22bee78STejun Heo 840e22bee78STejun Heo /** 841e22bee78STejun Heo * worker_set_flags - set worker flags and adjust nr_running accordingly 842cb444766STejun Heo * @worker: self 843d302f017STejun Heo * @flags: flags to set 844d302f017STejun Heo * @wakeup: wakeup an idle worker if necessary 845d302f017STejun Heo * 846e22bee78STejun Heo * Set @flags in @worker->flags and adjust nr_running accordingly. If 847e22bee78STejun Heo * nr_running becomes zero and @wakeup is %true, an idle worker is 848e22bee78STejun Heo * woken up. 849d302f017STejun Heo * 850cb444766STejun Heo * CONTEXT: 851d565ed63STejun Heo * spin_lock_irq(pool->lock) 852d302f017STejun Heo */ 853d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags, 854d302f017STejun Heo bool wakeup) 855d302f017STejun Heo { 856bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 857e22bee78STejun Heo 858cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 859cb444766STejun Heo 860e22bee78STejun Heo /* 861e22bee78STejun Heo * If transitioning into NOT_RUNNING, adjust nr_running and 862e22bee78STejun Heo * wake up an idle worker as necessary if requested by 863e22bee78STejun Heo * @wakeup. 864e22bee78STejun Heo */ 865e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && 866e22bee78STejun Heo !(worker->flags & WORKER_NOT_RUNNING)) { 867e22bee78STejun Heo if (wakeup) { 868e19e397aSTejun Heo if (atomic_dec_and_test(&pool->nr_running) && 869bd7bdd43STejun Heo !list_empty(&pool->worklist)) 87063d95a91STejun Heo wake_up_worker(pool); 871e22bee78STejun Heo } else 872e19e397aSTejun Heo atomic_dec(&pool->nr_running); 873e22bee78STejun Heo } 874e22bee78STejun Heo 875d302f017STejun Heo worker->flags |= flags; 876d302f017STejun Heo } 877d302f017STejun Heo 878d302f017STejun Heo /** 879e22bee78STejun Heo * worker_clr_flags - clear worker flags and adjust nr_running accordingly 880cb444766STejun Heo * @worker: self 881d302f017STejun Heo * @flags: flags to clear 882d302f017STejun Heo * 883e22bee78STejun Heo * Clear @flags in @worker->flags and adjust nr_running accordingly. 884d302f017STejun Heo * 885cb444766STejun Heo * CONTEXT: 886d565ed63STejun Heo * spin_lock_irq(pool->lock) 887d302f017STejun Heo */ 888d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags) 889d302f017STejun Heo { 89063d95a91STejun Heo struct worker_pool *pool = worker->pool; 891e22bee78STejun Heo unsigned int oflags = worker->flags; 892e22bee78STejun Heo 893cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 894cb444766STejun Heo 895d302f017STejun Heo worker->flags &= ~flags; 896e22bee78STejun Heo 89742c025f3STejun Heo /* 89842c025f3STejun Heo * If transitioning out of NOT_RUNNING, increment nr_running. Note 89942c025f3STejun Heo * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask 90042c025f3STejun Heo * of multiple flags, not a single flag. 90142c025f3STejun Heo */ 902e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) 903e22bee78STejun Heo if (!(worker->flags & WORKER_NOT_RUNNING)) 904e19e397aSTejun Heo atomic_inc(&pool->nr_running); 905d302f017STejun Heo } 906d302f017STejun Heo 907d302f017STejun Heo /** 9088cca0eeaSTejun Heo * find_worker_executing_work - find worker which is executing a work 909c9e7cf27STejun Heo * @pool: pool of interest 9108cca0eeaSTejun Heo * @work: work to find worker for 9118cca0eeaSTejun Heo * 912c9e7cf27STejun Heo * Find a worker which is executing @work on @pool by searching 913c9e7cf27STejun Heo * @pool->busy_hash which is keyed by the address of @work. For a worker 914a2c1c57bSTejun Heo * to match, its current execution should match the address of @work and 915a2c1c57bSTejun Heo * its work function. This is to avoid unwanted dependency between 916a2c1c57bSTejun Heo * unrelated work executions through a work item being recycled while still 917a2c1c57bSTejun Heo * being executed. 918a2c1c57bSTejun Heo * 919a2c1c57bSTejun Heo * This is a bit tricky. A work item may be freed once its execution 920a2c1c57bSTejun Heo * starts and nothing prevents the freed area from being recycled for 921a2c1c57bSTejun Heo * another work item. If the same work item address ends up being reused 922a2c1c57bSTejun Heo * before the original execution finishes, workqueue will identify the 923a2c1c57bSTejun Heo * recycled work item as currently executing and make it wait until the 924a2c1c57bSTejun Heo * current execution finishes, introducing an unwanted dependency. 925a2c1c57bSTejun Heo * 926c5aa87bbSTejun Heo * This function checks the work item address and work function to avoid 927c5aa87bbSTejun Heo * false positives. Note that this isn't complete as one may construct a 928c5aa87bbSTejun Heo * work function which can introduce dependency onto itself through a 929c5aa87bbSTejun Heo * recycled work item. Well, if somebody wants to shoot oneself in the 930c5aa87bbSTejun Heo * foot that badly, there's only so much we can do, and if such deadlock 931c5aa87bbSTejun Heo * actually occurs, it should be easy to locate the culprit work function. 9328cca0eeaSTejun Heo * 9338cca0eeaSTejun Heo * CONTEXT: 934d565ed63STejun Heo * spin_lock_irq(pool->lock). 9358cca0eeaSTejun Heo * 9368cca0eeaSTejun Heo * RETURNS: 9378cca0eeaSTejun Heo * Pointer to worker which is executing @work if found, NULL 9388cca0eeaSTejun Heo * otherwise. 9398cca0eeaSTejun Heo */ 940c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool, 9418cca0eeaSTejun Heo struct work_struct *work) 9428cca0eeaSTejun Heo { 94342f8570fSSasha Levin struct worker *worker; 94442f8570fSSasha Levin 945b67bfe0dSSasha Levin hash_for_each_possible(pool->busy_hash, worker, hentry, 946a2c1c57bSTejun Heo (unsigned long)work) 947a2c1c57bSTejun Heo if (worker->current_work == work && 948a2c1c57bSTejun Heo worker->current_func == work->func) 94942f8570fSSasha Levin return worker; 95042f8570fSSasha Levin 95142f8570fSSasha Levin return NULL; 9528cca0eeaSTejun Heo } 9538cca0eeaSTejun Heo 9548cca0eeaSTejun Heo /** 955bf4ede01STejun Heo * move_linked_works - move linked works to a list 956bf4ede01STejun Heo * @work: start of series of works to be scheduled 957bf4ede01STejun Heo * @head: target list to append @work to 958bf4ede01STejun Heo * @nextp: out paramter for nested worklist walking 959bf4ede01STejun Heo * 960bf4ede01STejun Heo * Schedule linked works starting from @work to @head. Work series to 961bf4ede01STejun Heo * be scheduled starts at @work and includes any consecutive work with 962bf4ede01STejun Heo * WORK_STRUCT_LINKED set in its predecessor. 963bf4ede01STejun Heo * 964bf4ede01STejun Heo * If @nextp is not NULL, it's updated to point to the next work of 965bf4ede01STejun Heo * the last scheduled work. This allows move_linked_works() to be 966bf4ede01STejun Heo * nested inside outer list_for_each_entry_safe(). 967bf4ede01STejun Heo * 968bf4ede01STejun Heo * CONTEXT: 969d565ed63STejun Heo * spin_lock_irq(pool->lock). 970bf4ede01STejun Heo */ 971bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head, 972bf4ede01STejun Heo struct work_struct **nextp) 973bf4ede01STejun Heo { 974bf4ede01STejun Heo struct work_struct *n; 975bf4ede01STejun Heo 976bf4ede01STejun Heo /* 977bf4ede01STejun Heo * Linked worklist will always end before the end of the list, 978bf4ede01STejun Heo * use NULL for list head. 979bf4ede01STejun Heo */ 980bf4ede01STejun Heo list_for_each_entry_safe_from(work, n, NULL, entry) { 981bf4ede01STejun Heo list_move_tail(&work->entry, head); 982bf4ede01STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) 983bf4ede01STejun Heo break; 984bf4ede01STejun Heo } 985bf4ede01STejun Heo 986bf4ede01STejun Heo /* 987bf4ede01STejun Heo * If we're already inside safe list traversal and have moved 988bf4ede01STejun Heo * multiple works to the scheduled queue, the next position 989bf4ede01STejun Heo * needs to be updated. 990bf4ede01STejun Heo */ 991bf4ede01STejun Heo if (nextp) 992bf4ede01STejun Heo *nextp = n; 993bf4ede01STejun Heo } 994bf4ede01STejun Heo 9958864b4e5STejun Heo /** 9968864b4e5STejun Heo * get_pwq - get an extra reference on the specified pool_workqueue 9978864b4e5STejun Heo * @pwq: pool_workqueue to get 9988864b4e5STejun Heo * 9998864b4e5STejun Heo * Obtain an extra reference on @pwq. The caller should guarantee that 10008864b4e5STejun Heo * @pwq has positive refcnt and be holding the matching pool->lock. 10018864b4e5STejun Heo */ 10028864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq) 10038864b4e5STejun Heo { 10048864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 10058864b4e5STejun Heo WARN_ON_ONCE(pwq->refcnt <= 0); 10068864b4e5STejun Heo pwq->refcnt++; 10078864b4e5STejun Heo } 10088864b4e5STejun Heo 10098864b4e5STejun Heo /** 10108864b4e5STejun Heo * put_pwq - put a pool_workqueue reference 10118864b4e5STejun Heo * @pwq: pool_workqueue to put 10128864b4e5STejun Heo * 10138864b4e5STejun Heo * Drop a reference of @pwq. If its refcnt reaches zero, schedule its 10148864b4e5STejun Heo * destruction. The caller should be holding the matching pool->lock. 10158864b4e5STejun Heo */ 10168864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq) 10178864b4e5STejun Heo { 10188864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 10198864b4e5STejun Heo if (likely(--pwq->refcnt)) 10208864b4e5STejun Heo return; 10218864b4e5STejun Heo if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND))) 10228864b4e5STejun Heo return; 10238864b4e5STejun Heo /* 10248864b4e5STejun Heo * @pwq can't be released under pool->lock, bounce to 10258864b4e5STejun Heo * pwq_unbound_release_workfn(). This never recurses on the same 10268864b4e5STejun Heo * pool->lock as this path is taken only for unbound workqueues and 10278864b4e5STejun Heo * the release work item is scheduled on a per-cpu workqueue. To 10288864b4e5STejun Heo * avoid lockdep warning, unbound pool->locks are given lockdep 10298864b4e5STejun Heo * subclass of 1 in get_unbound_pool(). 10308864b4e5STejun Heo */ 10318864b4e5STejun Heo schedule_work(&pwq->unbound_release_work); 10328864b4e5STejun Heo } 10338864b4e5STejun Heo 1034112202d9STejun Heo static void pwq_activate_delayed_work(struct work_struct *work) 1035bf4ede01STejun Heo { 1036112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 1037bf4ede01STejun Heo 1038bf4ede01STejun Heo trace_workqueue_activate_work(work); 1039112202d9STejun Heo move_linked_works(work, &pwq->pool->worklist, NULL); 1040bf4ede01STejun Heo __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work)); 1041112202d9STejun Heo pwq->nr_active++; 1042bf4ede01STejun Heo } 1043bf4ede01STejun Heo 1044112202d9STejun Heo static void pwq_activate_first_delayed(struct pool_workqueue *pwq) 10453aa62497SLai Jiangshan { 1046112202d9STejun Heo struct work_struct *work = list_first_entry(&pwq->delayed_works, 10473aa62497SLai Jiangshan struct work_struct, entry); 10483aa62497SLai Jiangshan 1049112202d9STejun Heo pwq_activate_delayed_work(work); 10503aa62497SLai Jiangshan } 10513aa62497SLai Jiangshan 1052bf4ede01STejun Heo /** 1053112202d9STejun Heo * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight 1054112202d9STejun Heo * @pwq: pwq of interest 1055bf4ede01STejun Heo * @color: color of work which left the queue 1056bf4ede01STejun Heo * 1057bf4ede01STejun Heo * A work either has completed or is removed from pending queue, 1058112202d9STejun Heo * decrement nr_in_flight of its pwq and handle workqueue flushing. 1059bf4ede01STejun Heo * 1060bf4ede01STejun Heo * CONTEXT: 1061d565ed63STejun Heo * spin_lock_irq(pool->lock). 1062bf4ede01STejun Heo */ 1063112202d9STejun Heo static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color) 1064bf4ede01STejun Heo { 10658864b4e5STejun Heo /* uncolored work items don't participate in flushing or nr_active */ 1066bf4ede01STejun Heo if (color == WORK_NO_COLOR) 10678864b4e5STejun Heo goto out_put; 1068bf4ede01STejun Heo 1069112202d9STejun Heo pwq->nr_in_flight[color]--; 1070bf4ede01STejun Heo 1071112202d9STejun Heo pwq->nr_active--; 1072112202d9STejun Heo if (!list_empty(&pwq->delayed_works)) { 1073bf4ede01STejun Heo /* one down, submit a delayed one */ 1074112202d9STejun Heo if (pwq->nr_active < pwq->max_active) 1075112202d9STejun Heo pwq_activate_first_delayed(pwq); 1076bf4ede01STejun Heo } 1077bf4ede01STejun Heo 1078bf4ede01STejun Heo /* is flush in progress and are we at the flushing tip? */ 1079112202d9STejun Heo if (likely(pwq->flush_color != color)) 10808864b4e5STejun Heo goto out_put; 1081bf4ede01STejun Heo 1082bf4ede01STejun Heo /* are there still in-flight works? */ 1083112202d9STejun Heo if (pwq->nr_in_flight[color]) 10848864b4e5STejun Heo goto out_put; 1085bf4ede01STejun Heo 1086112202d9STejun Heo /* this pwq is done, clear flush_color */ 1087112202d9STejun Heo pwq->flush_color = -1; 1088bf4ede01STejun Heo 1089bf4ede01STejun Heo /* 1090112202d9STejun Heo * If this was the last pwq, wake up the first flusher. It 1091bf4ede01STejun Heo * will handle the rest. 1092bf4ede01STejun Heo */ 1093112202d9STejun Heo if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush)) 1094112202d9STejun Heo complete(&pwq->wq->first_flusher->done); 10958864b4e5STejun Heo out_put: 10968864b4e5STejun Heo put_pwq(pwq); 1097bf4ede01STejun Heo } 1098bf4ede01STejun Heo 109936e227d2STejun Heo /** 1100bbb68dfaSTejun Heo * try_to_grab_pending - steal work item from worklist and disable irq 110136e227d2STejun Heo * @work: work item to steal 110236e227d2STejun Heo * @is_dwork: @work is a delayed_work 1103bbb68dfaSTejun Heo * @flags: place to store irq state 110436e227d2STejun Heo * 110536e227d2STejun Heo * Try to grab PENDING bit of @work. This function can handle @work in any 110636e227d2STejun Heo * stable state - idle, on timer or on worklist. Return values are 110736e227d2STejun Heo * 110836e227d2STejun Heo * 1 if @work was pending and we successfully stole PENDING 110936e227d2STejun Heo * 0 if @work was idle and we claimed PENDING 111036e227d2STejun Heo * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry 1111bbb68dfaSTejun Heo * -ENOENT if someone else is canceling @work, this state may persist 1112bbb68dfaSTejun Heo * for arbitrarily long 111336e227d2STejun Heo * 1114bbb68dfaSTejun Heo * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting 1115e0aecdd8STejun Heo * interrupted while holding PENDING and @work off queue, irq must be 1116e0aecdd8STejun Heo * disabled on entry. This, combined with delayed_work->timer being 1117e0aecdd8STejun Heo * irqsafe, ensures that we return -EAGAIN for finite short period of time. 1118bbb68dfaSTejun Heo * 1119bbb68dfaSTejun Heo * On successful return, >= 0, irq is disabled and the caller is 1120bbb68dfaSTejun Heo * responsible for releasing it using local_irq_restore(*@flags). 1121bbb68dfaSTejun Heo * 1122e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 1123bf4ede01STejun Heo */ 1124bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork, 1125bbb68dfaSTejun Heo unsigned long *flags) 1126bf4ede01STejun Heo { 1127d565ed63STejun Heo struct worker_pool *pool; 1128112202d9STejun Heo struct pool_workqueue *pwq; 1129bf4ede01STejun Heo 1130bbb68dfaSTejun Heo local_irq_save(*flags); 1131bbb68dfaSTejun Heo 113236e227d2STejun Heo /* try to steal the timer if it exists */ 113336e227d2STejun Heo if (is_dwork) { 113436e227d2STejun Heo struct delayed_work *dwork = to_delayed_work(work); 113536e227d2STejun Heo 1136e0aecdd8STejun Heo /* 1137e0aecdd8STejun Heo * dwork->timer is irqsafe. If del_timer() fails, it's 1138e0aecdd8STejun Heo * guaranteed that the timer is not queued anywhere and not 1139e0aecdd8STejun Heo * running on the local CPU. 1140e0aecdd8STejun Heo */ 114136e227d2STejun Heo if (likely(del_timer(&dwork->timer))) 114236e227d2STejun Heo return 1; 114336e227d2STejun Heo } 114436e227d2STejun Heo 114536e227d2STejun Heo /* try to claim PENDING the normal way */ 1146bf4ede01STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) 1147bf4ede01STejun Heo return 0; 1148bf4ede01STejun Heo 1149bf4ede01STejun Heo /* 1150bf4ede01STejun Heo * The queueing is in progress, or it is already queued. Try to 1151bf4ede01STejun Heo * steal it from ->worklist without clearing WORK_STRUCT_PENDING. 1152bf4ede01STejun Heo */ 1153d565ed63STejun Heo pool = get_work_pool(work); 1154d565ed63STejun Heo if (!pool) 1155bbb68dfaSTejun Heo goto fail; 1156bf4ede01STejun Heo 1157d565ed63STejun Heo spin_lock(&pool->lock); 1158bf4ede01STejun Heo /* 1159112202d9STejun Heo * work->data is guaranteed to point to pwq only while the work 1160112202d9STejun Heo * item is queued on pwq->wq, and both updating work->data to point 1161112202d9STejun Heo * to pwq on queueing and to pool on dequeueing are done under 1162112202d9STejun Heo * pwq->pool->lock. This in turn guarantees that, if work->data 1163112202d9STejun Heo * points to pwq which is associated with a locked pool, the work 11640b3dae68SLai Jiangshan * item is currently queued on that pool. 1165bf4ede01STejun Heo */ 1166112202d9STejun Heo pwq = get_work_pwq(work); 1167112202d9STejun Heo if (pwq && pwq->pool == pool) { 1168bf4ede01STejun Heo debug_work_deactivate(work); 11693aa62497SLai Jiangshan 11703aa62497SLai Jiangshan /* 117116062836STejun Heo * A delayed work item cannot be grabbed directly because 117216062836STejun Heo * it might have linked NO_COLOR work items which, if left 1173112202d9STejun Heo * on the delayed_list, will confuse pwq->nr_active 117416062836STejun Heo * management later on and cause stall. Make sure the work 117516062836STejun Heo * item is activated before grabbing. 11763aa62497SLai Jiangshan */ 11773aa62497SLai Jiangshan if (*work_data_bits(work) & WORK_STRUCT_DELAYED) 1178112202d9STejun Heo pwq_activate_delayed_work(work); 11793aa62497SLai Jiangshan 1180bf4ede01STejun Heo list_del_init(&work->entry); 1181112202d9STejun Heo pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work)); 118236e227d2STejun Heo 1183112202d9STejun Heo /* work->data points to pwq iff queued, point to pool */ 11844468a00fSLai Jiangshan set_work_pool_and_keep_pending(work, pool->id); 11854468a00fSLai Jiangshan 1186d565ed63STejun Heo spin_unlock(&pool->lock); 118736e227d2STejun Heo return 1; 1188bf4ede01STejun Heo } 1189d565ed63STejun Heo spin_unlock(&pool->lock); 1190bbb68dfaSTejun Heo fail: 1191bbb68dfaSTejun Heo local_irq_restore(*flags); 1192bbb68dfaSTejun Heo if (work_is_canceling(work)) 1193bbb68dfaSTejun Heo return -ENOENT; 1194bbb68dfaSTejun Heo cpu_relax(); 119536e227d2STejun Heo return -EAGAIN; 1196bf4ede01STejun Heo } 1197bf4ede01STejun Heo 1198bf4ede01STejun Heo /** 1199706026c2STejun Heo * insert_work - insert a work into a pool 1200112202d9STejun Heo * @pwq: pwq @work belongs to 12014690c4abSTejun Heo * @work: work to insert 12024690c4abSTejun Heo * @head: insertion point 12034690c4abSTejun Heo * @extra_flags: extra WORK_STRUCT_* flags to set 12044690c4abSTejun Heo * 1205112202d9STejun Heo * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to 1206706026c2STejun Heo * work_struct flags. 12074690c4abSTejun Heo * 12084690c4abSTejun Heo * CONTEXT: 1209d565ed63STejun Heo * spin_lock_irq(pool->lock). 1210365970a1SDavid Howells */ 1211112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work, 1212112202d9STejun Heo struct list_head *head, unsigned int extra_flags) 1213b89deed3SOleg Nesterov { 1214112202d9STejun Heo struct worker_pool *pool = pwq->pool; 1215e1d8aa9fSFrederic Weisbecker 12164690c4abSTejun Heo /* we own @work, set data and link */ 1217112202d9STejun Heo set_work_pwq(work, pwq, extra_flags); 12181a4d9b0aSOleg Nesterov list_add_tail(&work->entry, head); 12198864b4e5STejun Heo get_pwq(pwq); 1220e22bee78STejun Heo 1221e22bee78STejun Heo /* 1222c5aa87bbSTejun Heo * Ensure either wq_worker_sleeping() sees the above 1223c5aa87bbSTejun Heo * list_add_tail() or we see zero nr_running to avoid workers lying 1224c5aa87bbSTejun Heo * around lazily while there are works to be processed. 1225e22bee78STejun Heo */ 1226e22bee78STejun Heo smp_mb(); 1227e22bee78STejun Heo 122863d95a91STejun Heo if (__need_more_worker(pool)) 122963d95a91STejun Heo wake_up_worker(pool); 1230b89deed3SOleg Nesterov } 1231b89deed3SOleg Nesterov 1232c8efcc25STejun Heo /* 1233c8efcc25STejun Heo * Test whether @work is being queued from another work executing on the 12348d03ecfeSTejun Heo * same workqueue. 1235c8efcc25STejun Heo */ 1236c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq) 1237c8efcc25STejun Heo { 1238c8efcc25STejun Heo struct worker *worker; 1239c8efcc25STejun Heo 12408d03ecfeSTejun Heo worker = current_wq_worker(); 1241c8efcc25STejun Heo /* 12428d03ecfeSTejun Heo * Return %true iff I'm a worker execuing a work item on @wq. If 12438d03ecfeSTejun Heo * I'm @worker, it's safe to dereference it without locking. 1244c8efcc25STejun Heo */ 1245112202d9STejun Heo return worker && worker->current_pwq->wq == wq; 1246c8efcc25STejun Heo } 1247c8efcc25STejun Heo 1248d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq, 12491da177e4SLinus Torvalds struct work_struct *work) 12501da177e4SLinus Torvalds { 1251112202d9STejun Heo struct pool_workqueue *pwq; 1252c9178087STejun Heo struct worker_pool *last_pool; 12531e19ffc6STejun Heo struct list_head *worklist; 12548a2e8e5dSTejun Heo unsigned int work_flags; 1255b75cac93SJoonsoo Kim unsigned int req_cpu = cpu; 12568930cabaSTejun Heo 12578930cabaSTejun Heo /* 12588930cabaSTejun Heo * While a work item is PENDING && off queue, a task trying to 12598930cabaSTejun Heo * steal the PENDING will busy-loop waiting for it to either get 12608930cabaSTejun Heo * queued or lose PENDING. Grabbing PENDING and queueing should 12618930cabaSTejun Heo * happen with IRQ disabled. 12628930cabaSTejun Heo */ 12638930cabaSTejun Heo WARN_ON_ONCE(!irqs_disabled()); 12641da177e4SLinus Torvalds 1265dc186ad7SThomas Gleixner debug_work_activate(work); 12661e19ffc6STejun Heo 1267c8efcc25STejun Heo /* if dying, only works from the same workqueue are allowed */ 1268618b01ebSTejun Heo if (unlikely(wq->flags & __WQ_DRAINING) && 1269c8efcc25STejun Heo WARN_ON_ONCE(!is_chained_work(wq))) 1270e41e704bSTejun Heo return; 12719e8cd2f5STejun Heo retry: 1272c9178087STejun Heo /* pwq which will be used unless @work is executing elsewhere */ 1273c7fc77f7STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 127457469821STejun Heo if (cpu == WORK_CPU_UNBOUND) 1275f3421797STejun Heo cpu = raw_smp_processor_id(); 1276c9178087STejun Heo pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); 1277c9178087STejun Heo } else { 1278c9178087STejun Heo pwq = first_pwq(wq); 1279c9178087STejun Heo } 1280f3421797STejun Heo 128118aa9effSTejun Heo /* 1282c9178087STejun Heo * If @work was previously on a different pool, it might still be 1283c9178087STejun Heo * running there, in which case the work needs to be queued on that 1284c9178087STejun Heo * pool to guarantee non-reentrancy. 128518aa9effSTejun Heo */ 1286c9e7cf27STejun Heo last_pool = get_work_pool(work); 1287112202d9STejun Heo if (last_pool && last_pool != pwq->pool) { 128818aa9effSTejun Heo struct worker *worker; 128918aa9effSTejun Heo 1290d565ed63STejun Heo spin_lock(&last_pool->lock); 129118aa9effSTejun Heo 1292c9e7cf27STejun Heo worker = find_worker_executing_work(last_pool, work); 129318aa9effSTejun Heo 1294112202d9STejun Heo if (worker && worker->current_pwq->wq == wq) { 1295c9178087STejun Heo pwq = worker->current_pwq; 12968594fadeSLai Jiangshan } else { 129718aa9effSTejun Heo /* meh... not running there, queue here */ 1298d565ed63STejun Heo spin_unlock(&last_pool->lock); 1299112202d9STejun Heo spin_lock(&pwq->pool->lock); 130018aa9effSTejun Heo } 13018930cabaSTejun Heo } else { 1302112202d9STejun Heo spin_lock(&pwq->pool->lock); 13038930cabaSTejun Heo } 1304502ca9d8STejun Heo 13059e8cd2f5STejun Heo /* 13069e8cd2f5STejun Heo * pwq is determined and locked. For unbound pools, we could have 13079e8cd2f5STejun Heo * raced with pwq release and it could already be dead. If its 13089e8cd2f5STejun Heo * refcnt is zero, repeat pwq selection. Note that pwqs never die 13099e8cd2f5STejun Heo * without another pwq replacing it as the first pwq or while a 13109e8cd2f5STejun Heo * work item is executing on it, so the retying is guaranteed to 13119e8cd2f5STejun Heo * make forward-progress. 13129e8cd2f5STejun Heo */ 13139e8cd2f5STejun Heo if (unlikely(!pwq->refcnt)) { 13149e8cd2f5STejun Heo if (wq->flags & WQ_UNBOUND) { 13159e8cd2f5STejun Heo spin_unlock(&pwq->pool->lock); 13169e8cd2f5STejun Heo cpu_relax(); 13179e8cd2f5STejun Heo goto retry; 13189e8cd2f5STejun Heo } 13199e8cd2f5STejun Heo /* oops */ 13209e8cd2f5STejun Heo WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt", 13219e8cd2f5STejun Heo wq->name, cpu); 13229e8cd2f5STejun Heo } 13239e8cd2f5STejun Heo 1324112202d9STejun Heo /* pwq determined, queue */ 1325112202d9STejun Heo trace_workqueue_queue_work(req_cpu, pwq, work); 1326502ca9d8STejun Heo 1327f5b2552bSDan Carpenter if (WARN_ON(!list_empty(&work->entry))) { 1328112202d9STejun Heo spin_unlock(&pwq->pool->lock); 1329f5b2552bSDan Carpenter return; 1330f5b2552bSDan Carpenter } 13311e19ffc6STejun Heo 1332112202d9STejun Heo pwq->nr_in_flight[pwq->work_color]++; 1333112202d9STejun Heo work_flags = work_color_to_flags(pwq->work_color); 13341e19ffc6STejun Heo 1335112202d9STejun Heo if (likely(pwq->nr_active < pwq->max_active)) { 1336cdadf009STejun Heo trace_workqueue_activate_work(work); 1337112202d9STejun Heo pwq->nr_active++; 1338112202d9STejun Heo worklist = &pwq->pool->worklist; 13398a2e8e5dSTejun Heo } else { 13408a2e8e5dSTejun Heo work_flags |= WORK_STRUCT_DELAYED; 1341112202d9STejun Heo worklist = &pwq->delayed_works; 13428a2e8e5dSTejun Heo } 13431e19ffc6STejun Heo 1344112202d9STejun Heo insert_work(pwq, work, worklist, work_flags); 13451e19ffc6STejun Heo 1346112202d9STejun Heo spin_unlock(&pwq->pool->lock); 13471da177e4SLinus Torvalds } 13481da177e4SLinus Torvalds 13490fcb78c2SRolf Eike Beer /** 1350c1a220e7SZhang Rui * queue_work_on - queue work on specific cpu 1351c1a220e7SZhang Rui * @cpu: CPU number to execute work on 1352c1a220e7SZhang Rui * @wq: workqueue to use 1353c1a220e7SZhang Rui * @work: work to queue 1354c1a220e7SZhang Rui * 1355d4283e93STejun Heo * Returns %false if @work was already on a queue, %true otherwise. 1356c1a220e7SZhang Rui * 1357c1a220e7SZhang Rui * We queue the work to a specific CPU, the caller must ensure it 1358c1a220e7SZhang Rui * can't go away. 1359c1a220e7SZhang Rui */ 1360d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq, 1361d4283e93STejun Heo struct work_struct *work) 1362c1a220e7SZhang Rui { 1363d4283e93STejun Heo bool ret = false; 13648930cabaSTejun Heo unsigned long flags; 13658930cabaSTejun Heo 13668930cabaSTejun Heo local_irq_save(flags); 1367c1a220e7SZhang Rui 136822df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 13694690c4abSTejun Heo __queue_work(cpu, wq, work); 1370d4283e93STejun Heo ret = true; 1371c1a220e7SZhang Rui } 13728930cabaSTejun Heo 13738930cabaSTejun Heo local_irq_restore(flags); 1374c1a220e7SZhang Rui return ret; 1375c1a220e7SZhang Rui } 1376c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on); 1377c1a220e7SZhang Rui 1378d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data) 13791da177e4SLinus Torvalds { 138052bad64dSDavid Howells struct delayed_work *dwork = (struct delayed_work *)__data; 13811da177e4SLinus Torvalds 1382e0aecdd8STejun Heo /* should have been called from irqsafe timer with irq already off */ 138360c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 13841da177e4SLinus Torvalds } 13851438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn); 13861da177e4SLinus Torvalds 13877beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq, 138852bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 13891da177e4SLinus Torvalds { 13907beb2edfSTejun Heo struct timer_list *timer = &dwork->timer; 13917beb2edfSTejun Heo struct work_struct *work = &dwork->work; 13921da177e4SLinus Torvalds 13937beb2edfSTejun Heo WARN_ON_ONCE(timer->function != delayed_work_timer_fn || 13947beb2edfSTejun Heo timer->data != (unsigned long)dwork); 1395fc4b514fSTejun Heo WARN_ON_ONCE(timer_pending(timer)); 1396fc4b514fSTejun Heo WARN_ON_ONCE(!list_empty(&work->entry)); 13977beb2edfSTejun Heo 13988852aac2STejun Heo /* 13998852aac2STejun Heo * If @delay is 0, queue @dwork->work immediately. This is for 14008852aac2STejun Heo * both optimization and correctness. The earliest @timer can 14018852aac2STejun Heo * expire is on the closest next tick and delayed_work users depend 14028852aac2STejun Heo * on that there's no such delay when @delay is 0. 14038852aac2STejun Heo */ 14048852aac2STejun Heo if (!delay) { 14058852aac2STejun Heo __queue_work(cpu, wq, &dwork->work); 14068852aac2STejun Heo return; 14078852aac2STejun Heo } 14088852aac2STejun Heo 14097beb2edfSTejun Heo timer_stats_timer_set_start_info(&dwork->timer); 14107beb2edfSTejun Heo 141160c057bcSLai Jiangshan dwork->wq = wq; 14121265057fSTejun Heo dwork->cpu = cpu; 14137beb2edfSTejun Heo timer->expires = jiffies + delay; 14147beb2edfSTejun Heo 14157beb2edfSTejun Heo if (unlikely(cpu != WORK_CPU_UNBOUND)) 14167beb2edfSTejun Heo add_timer_on(timer, cpu); 14177beb2edfSTejun Heo else 14187beb2edfSTejun Heo add_timer(timer); 14197beb2edfSTejun Heo } 14201da177e4SLinus Torvalds 14210fcb78c2SRolf Eike Beer /** 14220fcb78c2SRolf Eike Beer * queue_delayed_work_on - queue work on specific CPU after delay 14230fcb78c2SRolf Eike Beer * @cpu: CPU number to execute work on 14240fcb78c2SRolf Eike Beer * @wq: workqueue to use 1425af9997e4SRandy Dunlap * @dwork: work to queue 14260fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 14270fcb78c2SRolf Eike Beer * 1428715f1300STejun Heo * Returns %false if @work was already on a queue, %true otherwise. If 1429715f1300STejun Heo * @delay is zero and @dwork is idle, it will be scheduled for immediate 1430715f1300STejun Heo * execution. 14310fcb78c2SRolf Eike Beer */ 1432d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 143352bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 14347a6bc1cdSVenkatesh Pallipadi { 143552bad64dSDavid Howells struct work_struct *work = &dwork->work; 1436d4283e93STejun Heo bool ret = false; 14378930cabaSTejun Heo unsigned long flags; 14388930cabaSTejun Heo 14398930cabaSTejun Heo /* read the comment in __queue_work() */ 14408930cabaSTejun Heo local_irq_save(flags); 14417a6bc1cdSVenkatesh Pallipadi 144222df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 14437beb2edfSTejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 1444d4283e93STejun Heo ret = true; 14457a6bc1cdSVenkatesh Pallipadi } 14468930cabaSTejun Heo 14478930cabaSTejun Heo local_irq_restore(flags); 14487a6bc1cdSVenkatesh Pallipadi return ret; 14497a6bc1cdSVenkatesh Pallipadi } 1450ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on); 14511da177e4SLinus Torvalds 1452c8e55f36STejun Heo /** 14538376fe22STejun Heo * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU 14548376fe22STejun Heo * @cpu: CPU number to execute work on 14558376fe22STejun Heo * @wq: workqueue to use 14568376fe22STejun Heo * @dwork: work to queue 14578376fe22STejun Heo * @delay: number of jiffies to wait before queueing 14588376fe22STejun Heo * 14598376fe22STejun Heo * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise, 14608376fe22STejun Heo * modify @dwork's timer so that it expires after @delay. If @delay is 14618376fe22STejun Heo * zero, @work is guaranteed to be scheduled immediately regardless of its 14628376fe22STejun Heo * current state. 14638376fe22STejun Heo * 14648376fe22STejun Heo * Returns %false if @dwork was idle and queued, %true if @dwork was 14658376fe22STejun Heo * pending and its timer was modified. 14668376fe22STejun Heo * 1467e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 14688376fe22STejun Heo * See try_to_grab_pending() for details. 14698376fe22STejun Heo */ 14708376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, 14718376fe22STejun Heo struct delayed_work *dwork, unsigned long delay) 14728376fe22STejun Heo { 14738376fe22STejun Heo unsigned long flags; 14748376fe22STejun Heo int ret; 14758376fe22STejun Heo 14768376fe22STejun Heo do { 14778376fe22STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 14788376fe22STejun Heo } while (unlikely(ret == -EAGAIN)); 14798376fe22STejun Heo 14808376fe22STejun Heo if (likely(ret >= 0)) { 14818376fe22STejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 14828376fe22STejun Heo local_irq_restore(flags); 14838376fe22STejun Heo } 14848376fe22STejun Heo 14858376fe22STejun Heo /* -ENOENT from try_to_grab_pending() becomes %true */ 14868376fe22STejun Heo return ret; 14878376fe22STejun Heo } 14888376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on); 14898376fe22STejun Heo 14908376fe22STejun Heo /** 1491c8e55f36STejun Heo * worker_enter_idle - enter idle state 1492c8e55f36STejun Heo * @worker: worker which is entering idle state 1493c8e55f36STejun Heo * 1494c8e55f36STejun Heo * @worker is entering idle state. Update stats and idle timer if 1495c8e55f36STejun Heo * necessary. 1496c8e55f36STejun Heo * 1497c8e55f36STejun Heo * LOCKING: 1498d565ed63STejun Heo * spin_lock_irq(pool->lock). 1499c8e55f36STejun Heo */ 1500c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker) 15011da177e4SLinus Torvalds { 1502bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1503c8e55f36STejun Heo 15046183c009STejun Heo if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) || 15056183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->entry) && 15066183c009STejun Heo (worker->hentry.next || worker->hentry.pprev))) 15076183c009STejun Heo return; 1508c8e55f36STejun Heo 1509cb444766STejun Heo /* can't use worker_set_flags(), also called from start_worker() */ 1510cb444766STejun Heo worker->flags |= WORKER_IDLE; 1511bd7bdd43STejun Heo pool->nr_idle++; 1512e22bee78STejun Heo worker->last_active = jiffies; 1513c8e55f36STejun Heo 1514c8e55f36STejun Heo /* idle_list is LIFO */ 1515bd7bdd43STejun Heo list_add(&worker->entry, &pool->idle_list); 1516db7bccf4STejun Heo 151763d95a91STejun Heo if (too_many_workers(pool) && !timer_pending(&pool->idle_timer)) 1518628c78e7STejun Heo mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT); 1519cb444766STejun Heo 1520544ecf31STejun Heo /* 1521706026c2STejun Heo * Sanity check nr_running. Because wq_unbind_fn() releases 1522d565ed63STejun Heo * pool->lock between setting %WORKER_UNBOUND and zapping 1523628c78e7STejun Heo * nr_running, the warning may trigger spuriously. Check iff 1524628c78e7STejun Heo * unbind is not in progress. 1525544ecf31STejun Heo */ 152624647570STejun Heo WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 1527bd7bdd43STejun Heo pool->nr_workers == pool->nr_idle && 1528e19e397aSTejun Heo atomic_read(&pool->nr_running)); 1529c8e55f36STejun Heo } 1530c8e55f36STejun Heo 1531c8e55f36STejun Heo /** 1532c8e55f36STejun Heo * worker_leave_idle - leave idle state 1533c8e55f36STejun Heo * @worker: worker which is leaving idle state 1534c8e55f36STejun Heo * 1535c8e55f36STejun Heo * @worker is leaving idle state. Update stats. 1536c8e55f36STejun Heo * 1537c8e55f36STejun Heo * LOCKING: 1538d565ed63STejun Heo * spin_lock_irq(pool->lock). 1539c8e55f36STejun Heo */ 1540c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker) 1541c8e55f36STejun Heo { 1542bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1543c8e55f36STejun Heo 15446183c009STejun Heo if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE))) 15456183c009STejun Heo return; 1546d302f017STejun Heo worker_clr_flags(worker, WORKER_IDLE); 1547bd7bdd43STejun Heo pool->nr_idle--; 1548c8e55f36STejun Heo list_del_init(&worker->entry); 1549c8e55f36STejun Heo } 1550c8e55f36STejun Heo 1551e22bee78STejun Heo /** 1552f36dc67bSLai Jiangshan * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it 1553f36dc67bSLai Jiangshan * @pool: target worker_pool 1554f36dc67bSLai Jiangshan * 1555f36dc67bSLai Jiangshan * Bind %current to the cpu of @pool if it is associated and lock @pool. 1556e22bee78STejun Heo * 1557e22bee78STejun Heo * Works which are scheduled while the cpu is online must at least be 1558e22bee78STejun Heo * scheduled to a worker which is bound to the cpu so that if they are 1559e22bee78STejun Heo * flushed from cpu callbacks while cpu is going down, they are 1560e22bee78STejun Heo * guaranteed to execute on the cpu. 1561e22bee78STejun Heo * 1562f5faa077SLai Jiangshan * This function is to be used by unbound workers and rescuers to bind 1563e22bee78STejun Heo * themselves to the target cpu and may race with cpu going down or 1564e22bee78STejun Heo * coming online. kthread_bind() can't be used because it may put the 1565e22bee78STejun Heo * worker to already dead cpu and set_cpus_allowed_ptr() can't be used 1566706026c2STejun Heo * verbatim as it's best effort and blocking and pool may be 1567e22bee78STejun Heo * [dis]associated in the meantime. 1568e22bee78STejun Heo * 1569706026c2STejun Heo * This function tries set_cpus_allowed() and locks pool and verifies the 157024647570STejun Heo * binding against %POOL_DISASSOCIATED which is set during 1571f2d5a0eeSTejun Heo * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker 1572f2d5a0eeSTejun Heo * enters idle state or fetches works without dropping lock, it can 1573f2d5a0eeSTejun Heo * guarantee the scheduling requirement described in the first paragraph. 1574e22bee78STejun Heo * 1575e22bee78STejun Heo * CONTEXT: 1576d565ed63STejun Heo * Might sleep. Called without any lock but returns with pool->lock 1577e22bee78STejun Heo * held. 1578e22bee78STejun Heo * 1579e22bee78STejun Heo * RETURNS: 1580706026c2STejun Heo * %true if the associated pool is online (@worker is successfully 1581e22bee78STejun Heo * bound), %false if offline. 1582e22bee78STejun Heo */ 1583f36dc67bSLai Jiangshan static bool worker_maybe_bind_and_lock(struct worker_pool *pool) 1584d565ed63STejun Heo __acquires(&pool->lock) 1585e22bee78STejun Heo { 1586e22bee78STejun Heo while (true) { 1587e22bee78STejun Heo /* 1588e22bee78STejun Heo * The following call may fail, succeed or succeed 1589e22bee78STejun Heo * without actually migrating the task to the cpu if 1590e22bee78STejun Heo * it races with cpu hotunplug operation. Verify 159124647570STejun Heo * against POOL_DISASSOCIATED. 1592e22bee78STejun Heo */ 159324647570STejun Heo if (!(pool->flags & POOL_DISASSOCIATED)) 15947a4e344cSTejun Heo set_cpus_allowed_ptr(current, pool->attrs->cpumask); 1595e22bee78STejun Heo 1596d565ed63STejun Heo spin_lock_irq(&pool->lock); 159724647570STejun Heo if (pool->flags & POOL_DISASSOCIATED) 1598e22bee78STejun Heo return false; 1599f5faa077SLai Jiangshan if (task_cpu(current) == pool->cpu && 16007a4e344cSTejun Heo cpumask_equal(¤t->cpus_allowed, pool->attrs->cpumask)) 1601e22bee78STejun Heo return true; 1602d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1603e22bee78STejun Heo 16045035b20fSTejun Heo /* 16055035b20fSTejun Heo * We've raced with CPU hot[un]plug. Give it a breather 16065035b20fSTejun Heo * and retry migration. cond_resched() is required here; 16075035b20fSTejun Heo * otherwise, we might deadlock against cpu_stop trying to 16085035b20fSTejun Heo * bring down the CPU on non-preemptive kernel. 16095035b20fSTejun Heo */ 1610e22bee78STejun Heo cpu_relax(); 16115035b20fSTejun Heo cond_resched(); 1612e22bee78STejun Heo } 1613e22bee78STejun Heo } 1614e22bee78STejun Heo 1615e22bee78STejun Heo /* 1616ea1abd61SLai Jiangshan * Rebind an idle @worker to its CPU. worker_thread() will test 16175f7dabfdSLai Jiangshan * list_empty(@worker->entry) before leaving idle and call this function. 161825511a47STejun Heo */ 161925511a47STejun Heo static void idle_worker_rebind(struct worker *worker) 162025511a47STejun Heo { 16215f7dabfdSLai Jiangshan /* CPU may go down again inbetween, clear UNBOUND only on success */ 1622f36dc67bSLai Jiangshan if (worker_maybe_bind_and_lock(worker->pool)) 16235f7dabfdSLai Jiangshan worker_clr_flags(worker, WORKER_UNBOUND); 162425511a47STejun Heo 1625ea1abd61SLai Jiangshan /* rebind complete, become available again */ 1626ea1abd61SLai Jiangshan list_add(&worker->entry, &worker->pool->idle_list); 1627d565ed63STejun Heo spin_unlock_irq(&worker->pool->lock); 162825511a47STejun Heo } 162925511a47STejun Heo 163025511a47STejun Heo /* 163125511a47STejun Heo * Function for @worker->rebind.work used to rebind unbound busy workers to 1632403c821dSTejun Heo * the associated cpu which is coming back online. This is scheduled by 1633403c821dSTejun Heo * cpu up but can race with other cpu hotplug operations and may be 1634403c821dSTejun Heo * executed twice without intervening cpu down. 1635e22bee78STejun Heo */ 163625511a47STejun Heo static void busy_worker_rebind_fn(struct work_struct *work) 1637e22bee78STejun Heo { 1638e22bee78STejun Heo struct worker *worker = container_of(work, struct worker, rebind_work); 1639e22bee78STejun Heo 1640f36dc67bSLai Jiangshan if (worker_maybe_bind_and_lock(worker->pool)) 1641eab6d828SLai Jiangshan worker_clr_flags(worker, WORKER_UNBOUND); 1642e22bee78STejun Heo 1643d565ed63STejun Heo spin_unlock_irq(&worker->pool->lock); 1644e22bee78STejun Heo } 1645e22bee78STejun Heo 164625511a47STejun Heo /** 164794cf58bbSTejun Heo * rebind_workers - rebind all workers of a pool to the associated CPU 164894cf58bbSTejun Heo * @pool: pool of interest 164925511a47STejun Heo * 165094cf58bbSTejun Heo * @pool->cpu is coming online. Rebind all workers to the CPU. Rebinding 165125511a47STejun Heo * is different for idle and busy ones. 165225511a47STejun Heo * 1653ea1abd61SLai Jiangshan * Idle ones will be removed from the idle_list and woken up. They will 1654ea1abd61SLai Jiangshan * add themselves back after completing rebind. This ensures that the 1655ea1abd61SLai Jiangshan * idle_list doesn't contain any unbound workers when re-bound busy workers 1656ea1abd61SLai Jiangshan * try to perform local wake-ups for concurrency management. 165725511a47STejun Heo * 1658ea1abd61SLai Jiangshan * Busy workers can rebind after they finish their current work items. 1659ea1abd61SLai Jiangshan * Queueing the rebind work item at the head of the scheduled list is 1660ea1abd61SLai Jiangshan * enough. Note that nr_running will be properly bumped as busy workers 1661ea1abd61SLai Jiangshan * rebind. 166225511a47STejun Heo * 1663ea1abd61SLai Jiangshan * On return, all non-manager workers are scheduled for rebind - see 1664ea1abd61SLai Jiangshan * manage_workers() for the manager special case. Any idle worker 1665ea1abd61SLai Jiangshan * including the manager will not appear on @idle_list until rebind is 1666ea1abd61SLai Jiangshan * complete, making local wake-ups safe. 166725511a47STejun Heo */ 166894cf58bbSTejun Heo static void rebind_workers(struct worker_pool *pool) 166925511a47STejun Heo { 1670ea1abd61SLai Jiangshan struct worker *worker, *n; 167125511a47STejun Heo int i; 167225511a47STejun Heo 1673bc3a1afcSTejun Heo lockdep_assert_held(&pool->manager_mutex); 1674d565ed63STejun Heo lockdep_assert_held(&pool->lock); 167525511a47STejun Heo 16765f7dabfdSLai Jiangshan /* dequeue and kick idle ones */ 1677ea1abd61SLai Jiangshan list_for_each_entry_safe(worker, n, &pool->idle_list, entry) { 1678ea1abd61SLai Jiangshan /* 167994cf58bbSTejun Heo * idle workers should be off @pool->idle_list until rebind 168094cf58bbSTejun Heo * is complete to avoid receiving premature local wake-ups. 1681ea1abd61SLai Jiangshan */ 1682ea1abd61SLai Jiangshan list_del_init(&worker->entry); 168325511a47STejun Heo 168425511a47STejun Heo /* 168594cf58bbSTejun Heo * worker_thread() will see the above dequeuing and call 168694cf58bbSTejun Heo * idle_worker_rebind(). 168725511a47STejun Heo */ 168825511a47STejun Heo wake_up_process(worker->task); 168925511a47STejun Heo } 169025511a47STejun Heo 1691ea1abd61SLai Jiangshan /* rebind busy workers */ 1692b67bfe0dSSasha Levin for_each_busy_worker(worker, i, pool) { 169325511a47STejun Heo struct work_struct *rebind_work = &worker->rebind_work; 1694e2b6a6d5SJoonsoo Kim struct workqueue_struct *wq; 169525511a47STejun Heo 169625511a47STejun Heo if (test_and_set_bit(WORK_STRUCT_PENDING_BIT, 169725511a47STejun Heo work_data_bits(rebind_work))) 169825511a47STejun Heo continue; 169925511a47STejun Heo 170025511a47STejun Heo debug_work_activate(rebind_work); 170190beca5dSTejun Heo 170290beca5dSTejun Heo /* 170394cf58bbSTejun Heo * wq doesn't really matter but let's keep @worker->pool 1704112202d9STejun Heo * and @pwq->pool consistent for sanity. 170590beca5dSTejun Heo */ 17067a4e344cSTejun Heo if (worker->pool->attrs->nice < 0) 1707e2b6a6d5SJoonsoo Kim wq = system_highpri_wq; 1708e2b6a6d5SJoonsoo Kim else 1709e2b6a6d5SJoonsoo Kim wq = system_wq; 1710ec58815aSTejun Heo 17117fb98ea7STejun Heo insert_work(per_cpu_ptr(wq->cpu_pwqs, pool->cpu), rebind_work, 171225511a47STejun Heo worker->scheduled.next, 171325511a47STejun Heo work_color_to_flags(WORK_NO_COLOR)); 1714ec58815aSTejun Heo } 171525511a47STejun Heo } 171625511a47STejun Heo 1717c34056a3STejun Heo static struct worker *alloc_worker(void) 1718c34056a3STejun Heo { 1719c34056a3STejun Heo struct worker *worker; 1720c34056a3STejun Heo 1721c34056a3STejun Heo worker = kzalloc(sizeof(*worker), GFP_KERNEL); 1722c8e55f36STejun Heo if (worker) { 1723c8e55f36STejun Heo INIT_LIST_HEAD(&worker->entry); 1724affee4b2STejun Heo INIT_LIST_HEAD(&worker->scheduled); 172525511a47STejun Heo INIT_WORK(&worker->rebind_work, busy_worker_rebind_fn); 1726e22bee78STejun Heo /* on creation a worker is in !idle && prep state */ 1727e22bee78STejun Heo worker->flags = WORKER_PREP; 1728c8e55f36STejun Heo } 1729c34056a3STejun Heo return worker; 1730c34056a3STejun Heo } 1731c34056a3STejun Heo 1732c34056a3STejun Heo /** 1733c34056a3STejun Heo * create_worker - create a new workqueue worker 173463d95a91STejun Heo * @pool: pool the new worker will belong to 1735c34056a3STejun Heo * 173663d95a91STejun Heo * Create a new worker which is bound to @pool. The returned worker 1737c34056a3STejun Heo * can be started by calling start_worker() or destroyed using 1738c34056a3STejun Heo * destroy_worker(). 1739c34056a3STejun Heo * 1740c34056a3STejun Heo * CONTEXT: 1741c34056a3STejun Heo * Might sleep. Does GFP_KERNEL allocations. 1742c34056a3STejun Heo * 1743c34056a3STejun Heo * RETURNS: 1744c34056a3STejun Heo * Pointer to the newly created worker. 1745c34056a3STejun Heo */ 1746bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool) 1747c34056a3STejun Heo { 17487a4e344cSTejun Heo const char *pri = pool->attrs->nice < 0 ? "H" : ""; 1749c34056a3STejun Heo struct worker *worker = NULL; 1750f3421797STejun Heo int id = -1; 1751c34056a3STejun Heo 1752cd549687STejun Heo lockdep_assert_held(&pool->manager_mutex); 1753cd549687STejun Heo 1754*822d8405STejun Heo /* 1755*822d8405STejun Heo * ID is needed to determine kthread name. Allocate ID first 1756*822d8405STejun Heo * without installing the pointer. 1757*822d8405STejun Heo */ 1758*822d8405STejun Heo idr_preload(GFP_KERNEL); 1759d565ed63STejun Heo spin_lock_irq(&pool->lock); 1760*822d8405STejun Heo 1761*822d8405STejun Heo id = idr_alloc(&pool->worker_idr, NULL, 0, 0, GFP_NOWAIT); 1762*822d8405STejun Heo 1763d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1764*822d8405STejun Heo idr_preload_end(); 1765*822d8405STejun Heo if (id < 0) 1766c34056a3STejun Heo goto fail; 1767c34056a3STejun Heo 1768c34056a3STejun Heo worker = alloc_worker(); 1769c34056a3STejun Heo if (!worker) 1770c34056a3STejun Heo goto fail; 1771c34056a3STejun Heo 1772bd7bdd43STejun Heo worker->pool = pool; 1773c34056a3STejun Heo worker->id = id; 1774c34056a3STejun Heo 177529c91e99STejun Heo if (pool->cpu >= 0) 177694dcf29aSEric Dumazet worker->task = kthread_create_on_node(worker_thread, 1777ec22ca5eSTejun Heo worker, cpu_to_node(pool->cpu), 1778d84ff051STejun Heo "kworker/%d:%d%s", pool->cpu, id, pri); 1779f3421797STejun Heo else 1780f3421797STejun Heo worker->task = kthread_create(worker_thread, worker, 1781ac6104cdSTejun Heo "kworker/u%d:%d%s", 1782ac6104cdSTejun Heo pool->id, id, pri); 1783c34056a3STejun Heo if (IS_ERR(worker->task)) 1784c34056a3STejun Heo goto fail; 1785c34056a3STejun Heo 1786c5aa87bbSTejun Heo /* 1787c5aa87bbSTejun Heo * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any 1788c5aa87bbSTejun Heo * online CPUs. It'll be re-applied when any of the CPUs come up. 1789c5aa87bbSTejun Heo */ 17907a4e344cSTejun Heo set_user_nice(worker->task, pool->attrs->nice); 17917a4e344cSTejun Heo set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask); 17923270476aSTejun Heo 179314a40ffcSTejun Heo /* prevent userland from meddling with cpumask of workqueue workers */ 179414a40ffcSTejun Heo worker->task->flags |= PF_NO_SETAFFINITY; 17957a4e344cSTejun Heo 17967a4e344cSTejun Heo /* 17977a4e344cSTejun Heo * The caller is responsible for ensuring %POOL_DISASSOCIATED 17987a4e344cSTejun Heo * remains stable across this function. See the comments above the 17997a4e344cSTejun Heo * flag definition for details. 18007a4e344cSTejun Heo */ 18017a4e344cSTejun Heo if (pool->flags & POOL_DISASSOCIATED) 1802f3421797STejun Heo worker->flags |= WORKER_UNBOUND; 1803c34056a3STejun Heo 1804*822d8405STejun Heo /* successful, commit the pointer to idr */ 1805*822d8405STejun Heo spin_lock_irq(&pool->lock); 1806*822d8405STejun Heo idr_replace(&pool->worker_idr, worker, worker->id); 1807*822d8405STejun Heo spin_unlock_irq(&pool->lock); 1808*822d8405STejun Heo 1809c34056a3STejun Heo return worker; 1810*822d8405STejun Heo 1811c34056a3STejun Heo fail: 1812c34056a3STejun Heo if (id >= 0) { 1813d565ed63STejun Heo spin_lock_irq(&pool->lock); 1814*822d8405STejun Heo idr_remove(&pool->worker_idr, id); 1815d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1816c34056a3STejun Heo } 1817c34056a3STejun Heo kfree(worker); 1818c34056a3STejun Heo return NULL; 1819c34056a3STejun Heo } 1820c34056a3STejun Heo 1821c34056a3STejun Heo /** 1822c34056a3STejun Heo * start_worker - start a newly created worker 1823c34056a3STejun Heo * @worker: worker to start 1824c34056a3STejun Heo * 1825706026c2STejun Heo * Make the pool aware of @worker and start it. 1826c34056a3STejun Heo * 1827c34056a3STejun Heo * CONTEXT: 1828d565ed63STejun Heo * spin_lock_irq(pool->lock). 1829c34056a3STejun Heo */ 1830c34056a3STejun Heo static void start_worker(struct worker *worker) 1831c34056a3STejun Heo { 1832cb444766STejun Heo worker->flags |= WORKER_STARTED; 1833bd7bdd43STejun Heo worker->pool->nr_workers++; 1834c8e55f36STejun Heo worker_enter_idle(worker); 1835c34056a3STejun Heo wake_up_process(worker->task); 1836c34056a3STejun Heo } 1837c34056a3STejun Heo 1838c34056a3STejun Heo /** 1839ebf44d16STejun Heo * create_and_start_worker - create and start a worker for a pool 1840ebf44d16STejun Heo * @pool: the target pool 1841ebf44d16STejun Heo * 1842cd549687STejun Heo * Grab the managership of @pool and create and start a new worker for it. 1843ebf44d16STejun Heo */ 1844ebf44d16STejun Heo static int create_and_start_worker(struct worker_pool *pool) 1845ebf44d16STejun Heo { 1846ebf44d16STejun Heo struct worker *worker; 1847ebf44d16STejun Heo 1848cd549687STejun Heo mutex_lock(&pool->manager_mutex); 1849cd549687STejun Heo 1850ebf44d16STejun Heo worker = create_worker(pool); 1851ebf44d16STejun Heo if (worker) { 1852ebf44d16STejun Heo spin_lock_irq(&pool->lock); 1853ebf44d16STejun Heo start_worker(worker); 1854ebf44d16STejun Heo spin_unlock_irq(&pool->lock); 1855ebf44d16STejun Heo } 1856ebf44d16STejun Heo 1857cd549687STejun Heo mutex_unlock(&pool->manager_mutex); 1858cd549687STejun Heo 1859ebf44d16STejun Heo return worker ? 0 : -ENOMEM; 1860ebf44d16STejun Heo } 1861ebf44d16STejun Heo 1862ebf44d16STejun Heo /** 1863c34056a3STejun Heo * destroy_worker - destroy a workqueue worker 1864c34056a3STejun Heo * @worker: worker to be destroyed 1865c34056a3STejun Heo * 1866706026c2STejun Heo * Destroy @worker and adjust @pool stats accordingly. 1867c8e55f36STejun Heo * 1868c8e55f36STejun Heo * CONTEXT: 1869d565ed63STejun Heo * spin_lock_irq(pool->lock) which is released and regrabbed. 1870c34056a3STejun Heo */ 1871c34056a3STejun Heo static void destroy_worker(struct worker *worker) 1872c34056a3STejun Heo { 1873bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1874c34056a3STejun Heo 1875cd549687STejun Heo lockdep_assert_held(&pool->manager_mutex); 1876cd549687STejun Heo lockdep_assert_held(&pool->lock); 1877cd549687STejun Heo 1878c34056a3STejun Heo /* sanity check frenzy */ 18796183c009STejun Heo if (WARN_ON(worker->current_work) || 18806183c009STejun Heo WARN_ON(!list_empty(&worker->scheduled))) 18816183c009STejun Heo return; 1882c34056a3STejun Heo 1883c8e55f36STejun Heo if (worker->flags & WORKER_STARTED) 1884bd7bdd43STejun Heo pool->nr_workers--; 1885c8e55f36STejun Heo if (worker->flags & WORKER_IDLE) 1886bd7bdd43STejun Heo pool->nr_idle--; 1887c8e55f36STejun Heo 1888c8e55f36STejun Heo list_del_init(&worker->entry); 1889cb444766STejun Heo worker->flags |= WORKER_DIE; 1890c8e55f36STejun Heo 1891*822d8405STejun Heo idr_remove(&pool->worker_idr, worker->id); 1892*822d8405STejun Heo 1893d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1894c8e55f36STejun Heo 1895c34056a3STejun Heo kthread_stop(worker->task); 1896c34056a3STejun Heo kfree(worker); 1897c34056a3STejun Heo 1898d565ed63STejun Heo spin_lock_irq(&pool->lock); 1899c34056a3STejun Heo } 1900c34056a3STejun Heo 190163d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool) 1902e22bee78STejun Heo { 190363d95a91STejun Heo struct worker_pool *pool = (void *)__pool; 1904e22bee78STejun Heo 1905d565ed63STejun Heo spin_lock_irq(&pool->lock); 1906e22bee78STejun Heo 190763d95a91STejun Heo if (too_many_workers(pool)) { 1908e22bee78STejun Heo struct worker *worker; 1909e22bee78STejun Heo unsigned long expires; 1910e22bee78STejun Heo 1911e22bee78STejun Heo /* idle_list is kept in LIFO order, check the last one */ 191263d95a91STejun Heo worker = list_entry(pool->idle_list.prev, struct worker, entry); 1913e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 1914e22bee78STejun Heo 1915e22bee78STejun Heo if (time_before(jiffies, expires)) 191663d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 1917e22bee78STejun Heo else { 1918e22bee78STejun Heo /* it's been idle for too long, wake up manager */ 191911ebea50STejun Heo pool->flags |= POOL_MANAGE_WORKERS; 192063d95a91STejun Heo wake_up_worker(pool); 1921e22bee78STejun Heo } 1922e22bee78STejun Heo } 1923e22bee78STejun Heo 1924d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1925e22bee78STejun Heo } 1926e22bee78STejun Heo 1927493a1724STejun Heo static void send_mayday(struct work_struct *work) 1928e22bee78STejun Heo { 1929112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 1930112202d9STejun Heo struct workqueue_struct *wq = pwq->wq; 1931493a1724STejun Heo 19322e109a28STejun Heo lockdep_assert_held(&wq_mayday_lock); 1933e22bee78STejun Heo 1934493008a8STejun Heo if (!wq->rescuer) 1935493a1724STejun Heo return; 1936e22bee78STejun Heo 1937e22bee78STejun Heo /* mayday mayday mayday */ 1938493a1724STejun Heo if (list_empty(&pwq->mayday_node)) { 1939493a1724STejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 1940e22bee78STejun Heo wake_up_process(wq->rescuer->task); 1941493a1724STejun Heo } 1942e22bee78STejun Heo } 1943e22bee78STejun Heo 1944706026c2STejun Heo static void pool_mayday_timeout(unsigned long __pool) 1945e22bee78STejun Heo { 194663d95a91STejun Heo struct worker_pool *pool = (void *)__pool; 1947e22bee78STejun Heo struct work_struct *work; 1948e22bee78STejun Heo 19492e109a28STejun Heo spin_lock_irq(&wq_mayday_lock); /* for wq->maydays */ 1950493a1724STejun Heo spin_lock(&pool->lock); 1951e22bee78STejun Heo 195263d95a91STejun Heo if (need_to_create_worker(pool)) { 1953e22bee78STejun Heo /* 1954e22bee78STejun Heo * We've been trying to create a new worker but 1955e22bee78STejun Heo * haven't been successful. We might be hitting an 1956e22bee78STejun Heo * allocation deadlock. Send distress signals to 1957e22bee78STejun Heo * rescuers. 1958e22bee78STejun Heo */ 195963d95a91STejun Heo list_for_each_entry(work, &pool->worklist, entry) 1960e22bee78STejun Heo send_mayday(work); 1961e22bee78STejun Heo } 1962e22bee78STejun Heo 1963493a1724STejun Heo spin_unlock(&pool->lock); 19642e109a28STejun Heo spin_unlock_irq(&wq_mayday_lock); 1965e22bee78STejun Heo 196663d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL); 1967e22bee78STejun Heo } 1968e22bee78STejun Heo 1969e22bee78STejun Heo /** 1970e22bee78STejun Heo * maybe_create_worker - create a new worker if necessary 197163d95a91STejun Heo * @pool: pool to create a new worker for 1972e22bee78STejun Heo * 197363d95a91STejun Heo * Create a new worker for @pool if necessary. @pool is guaranteed to 1974e22bee78STejun Heo * have at least one idle worker on return from this function. If 1975e22bee78STejun Heo * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is 197663d95a91STejun Heo * sent to all rescuers with works scheduled on @pool to resolve 1977e22bee78STejun Heo * possible allocation deadlock. 1978e22bee78STejun Heo * 1979c5aa87bbSTejun Heo * On return, need_to_create_worker() is guaranteed to be %false and 1980c5aa87bbSTejun Heo * may_start_working() %true. 1981e22bee78STejun Heo * 1982e22bee78STejun Heo * LOCKING: 1983d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 1984e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. Called only from 1985e22bee78STejun Heo * manager. 1986e22bee78STejun Heo * 1987e22bee78STejun Heo * RETURNS: 1988c5aa87bbSTejun Heo * %false if no action was taken and pool->lock stayed locked, %true 1989e22bee78STejun Heo * otherwise. 1990e22bee78STejun Heo */ 199163d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool) 1992d565ed63STejun Heo __releases(&pool->lock) 1993d565ed63STejun Heo __acquires(&pool->lock) 1994e22bee78STejun Heo { 199563d95a91STejun Heo if (!need_to_create_worker(pool)) 1996e22bee78STejun Heo return false; 1997e22bee78STejun Heo restart: 1998d565ed63STejun Heo spin_unlock_irq(&pool->lock); 19999f9c2364STejun Heo 2000e22bee78STejun Heo /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ 200163d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); 2002e22bee78STejun Heo 2003e22bee78STejun Heo while (true) { 2004e22bee78STejun Heo struct worker *worker; 2005e22bee78STejun Heo 2006bc2ae0f5STejun Heo worker = create_worker(pool); 2007e22bee78STejun Heo if (worker) { 200863d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 2009d565ed63STejun Heo spin_lock_irq(&pool->lock); 2010e22bee78STejun Heo start_worker(worker); 20116183c009STejun Heo if (WARN_ON_ONCE(need_to_create_worker(pool))) 20126183c009STejun Heo goto restart; 2013e22bee78STejun Heo return true; 2014e22bee78STejun Heo } 2015e22bee78STejun Heo 201663d95a91STejun Heo if (!need_to_create_worker(pool)) 2017e22bee78STejun Heo break; 2018e22bee78STejun Heo 2019e22bee78STejun Heo __set_current_state(TASK_INTERRUPTIBLE); 2020e22bee78STejun Heo schedule_timeout(CREATE_COOLDOWN); 20219f9c2364STejun Heo 202263d95a91STejun Heo if (!need_to_create_worker(pool)) 2023e22bee78STejun Heo break; 2024e22bee78STejun Heo } 2025e22bee78STejun Heo 202663d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 2027d565ed63STejun Heo spin_lock_irq(&pool->lock); 202863d95a91STejun Heo if (need_to_create_worker(pool)) 2029e22bee78STejun Heo goto restart; 2030e22bee78STejun Heo return true; 2031e22bee78STejun Heo } 2032e22bee78STejun Heo 2033e22bee78STejun Heo /** 2034e22bee78STejun Heo * maybe_destroy_worker - destroy workers which have been idle for a while 203563d95a91STejun Heo * @pool: pool to destroy workers for 2036e22bee78STejun Heo * 203763d95a91STejun Heo * Destroy @pool workers which have been idle for longer than 2038e22bee78STejun Heo * IDLE_WORKER_TIMEOUT. 2039e22bee78STejun Heo * 2040e22bee78STejun Heo * LOCKING: 2041d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2042e22bee78STejun Heo * multiple times. Called only from manager. 2043e22bee78STejun Heo * 2044e22bee78STejun Heo * RETURNS: 2045c5aa87bbSTejun Heo * %false if no action was taken and pool->lock stayed locked, %true 2046e22bee78STejun Heo * otherwise. 2047e22bee78STejun Heo */ 204863d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool) 2049e22bee78STejun Heo { 2050e22bee78STejun Heo bool ret = false; 2051e22bee78STejun Heo 205263d95a91STejun Heo while (too_many_workers(pool)) { 2053e22bee78STejun Heo struct worker *worker; 2054e22bee78STejun Heo unsigned long expires; 2055e22bee78STejun Heo 205663d95a91STejun Heo worker = list_entry(pool->idle_list.prev, struct worker, entry); 2057e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 2058e22bee78STejun Heo 2059e22bee78STejun Heo if (time_before(jiffies, expires)) { 206063d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 2061e22bee78STejun Heo break; 2062e22bee78STejun Heo } 2063e22bee78STejun Heo 2064e22bee78STejun Heo destroy_worker(worker); 2065e22bee78STejun Heo ret = true; 2066e22bee78STejun Heo } 2067e22bee78STejun Heo 2068e22bee78STejun Heo return ret; 2069e22bee78STejun Heo } 2070e22bee78STejun Heo 2071e22bee78STejun Heo /** 2072e22bee78STejun Heo * manage_workers - manage worker pool 2073e22bee78STejun Heo * @worker: self 2074e22bee78STejun Heo * 2075706026c2STejun Heo * Assume the manager role and manage the worker pool @worker belongs 2076e22bee78STejun Heo * to. At any given time, there can be only zero or one manager per 2077706026c2STejun Heo * pool. The exclusion is handled automatically by this function. 2078e22bee78STejun Heo * 2079e22bee78STejun Heo * The caller can safely start processing works on false return. On 2080e22bee78STejun Heo * true return, it's guaranteed that need_to_create_worker() is false 2081e22bee78STejun Heo * and may_start_working() is true. 2082e22bee78STejun Heo * 2083e22bee78STejun Heo * CONTEXT: 2084d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2085e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. 2086e22bee78STejun Heo * 2087e22bee78STejun Heo * RETURNS: 2088d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2089d565ed63STejun Heo * multiple times. Does GFP_KERNEL allocations. 2090e22bee78STejun Heo */ 2091e22bee78STejun Heo static bool manage_workers(struct worker *worker) 2092e22bee78STejun Heo { 209363d95a91STejun Heo struct worker_pool *pool = worker->pool; 2094e22bee78STejun Heo bool ret = false; 2095e22bee78STejun Heo 2096bc3a1afcSTejun Heo /* 2097bc3a1afcSTejun Heo * Managership is governed by two mutexes - manager_arb and 2098bc3a1afcSTejun Heo * manager_mutex. manager_arb handles arbitration of manager role. 2099bc3a1afcSTejun Heo * Anyone who successfully grabs manager_arb wins the arbitration 2100bc3a1afcSTejun Heo * and becomes the manager. mutex_trylock() on pool->manager_arb 2101bc3a1afcSTejun Heo * failure while holding pool->lock reliably indicates that someone 2102bc3a1afcSTejun Heo * else is managing the pool and the worker which failed trylock 2103bc3a1afcSTejun Heo * can proceed to executing work items. This means that anyone 2104bc3a1afcSTejun Heo * grabbing manager_arb is responsible for actually performing 2105bc3a1afcSTejun Heo * manager duties. If manager_arb is grabbed and released without 2106bc3a1afcSTejun Heo * actual management, the pool may stall indefinitely. 2107bc3a1afcSTejun Heo * 2108bc3a1afcSTejun Heo * manager_mutex is used for exclusion of actual management 2109bc3a1afcSTejun Heo * operations. The holder of manager_mutex can be sure that none 2110bc3a1afcSTejun Heo * of management operations, including creation and destruction of 2111bc3a1afcSTejun Heo * workers, won't take place until the mutex is released. Because 2112bc3a1afcSTejun Heo * manager_mutex doesn't interfere with manager role arbitration, 2113bc3a1afcSTejun Heo * it is guaranteed that the pool's management, while may be 2114bc3a1afcSTejun Heo * delayed, won't be disturbed by someone else grabbing 2115bc3a1afcSTejun Heo * manager_mutex. 2116bc3a1afcSTejun Heo */ 211734a06bd6STejun Heo if (!mutex_trylock(&pool->manager_arb)) 2118e22bee78STejun Heo return ret; 2119e22bee78STejun Heo 2120ee378aa4SLai Jiangshan /* 2121bc3a1afcSTejun Heo * With manager arbitration won, manager_mutex would be free in 2122bc3a1afcSTejun Heo * most cases. trylock first without dropping @pool->lock. 2123ee378aa4SLai Jiangshan */ 2124bc3a1afcSTejun Heo if (unlikely(!mutex_trylock(&pool->manager_mutex))) { 2125d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2126bc3a1afcSTejun Heo mutex_lock(&pool->manager_mutex); 2127ee378aa4SLai Jiangshan /* 2128ee378aa4SLai Jiangshan * CPU hotplug could have happened while we were waiting 2129b2eb83d1SLai Jiangshan * for assoc_mutex. Hotplug itself can't handle us 2130ee378aa4SLai Jiangshan * because manager isn't either on idle or busy list, and 2131706026c2STejun Heo * @pool's state and ours could have deviated. 2132ee378aa4SLai Jiangshan * 2133bc3a1afcSTejun Heo * As hotplug is now excluded via manager_mutex, we can 2134ee378aa4SLai Jiangshan * simply try to bind. It will succeed or fail depending 2135706026c2STejun Heo * on @pool's current state. Try it and adjust 2136ee378aa4SLai Jiangshan * %WORKER_UNBOUND accordingly. 2137ee378aa4SLai Jiangshan */ 2138f36dc67bSLai Jiangshan if (worker_maybe_bind_and_lock(pool)) 2139ee378aa4SLai Jiangshan worker->flags &= ~WORKER_UNBOUND; 2140ee378aa4SLai Jiangshan else 2141ee378aa4SLai Jiangshan worker->flags |= WORKER_UNBOUND; 2142ee378aa4SLai Jiangshan 2143ee378aa4SLai Jiangshan ret = true; 2144ee378aa4SLai Jiangshan } 2145ee378aa4SLai Jiangshan 214611ebea50STejun Heo pool->flags &= ~POOL_MANAGE_WORKERS; 2147e22bee78STejun Heo 2148e22bee78STejun Heo /* 2149e22bee78STejun Heo * Destroy and then create so that may_start_working() is true 2150e22bee78STejun Heo * on return. 2151e22bee78STejun Heo */ 215263d95a91STejun Heo ret |= maybe_destroy_workers(pool); 215363d95a91STejun Heo ret |= maybe_create_worker(pool); 2154e22bee78STejun Heo 2155bc3a1afcSTejun Heo mutex_unlock(&pool->manager_mutex); 215634a06bd6STejun Heo mutex_unlock(&pool->manager_arb); 2157e22bee78STejun Heo return ret; 2158e22bee78STejun Heo } 2159e22bee78STejun Heo 2160a62428c0STejun Heo /** 2161a62428c0STejun Heo * process_one_work - process single work 2162c34056a3STejun Heo * @worker: self 2163a62428c0STejun Heo * @work: work to process 2164a62428c0STejun Heo * 2165a62428c0STejun Heo * Process @work. This function contains all the logics necessary to 2166a62428c0STejun Heo * process a single work including synchronization against and 2167a62428c0STejun Heo * interaction with other workers on the same cpu, queueing and 2168a62428c0STejun Heo * flushing. As long as context requirement is met, any worker can 2169a62428c0STejun Heo * call this function to process a work. 2170a62428c0STejun Heo * 2171a62428c0STejun Heo * CONTEXT: 2172d565ed63STejun Heo * spin_lock_irq(pool->lock) which is released and regrabbed. 2173a62428c0STejun Heo */ 2174c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work) 2175d565ed63STejun Heo __releases(&pool->lock) 2176d565ed63STejun Heo __acquires(&pool->lock) 21771da177e4SLinus Torvalds { 2178112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 2179bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 2180112202d9STejun Heo bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE; 218173f53c4aSTejun Heo int work_color; 21827e11629dSTejun Heo struct worker *collision; 21834e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 21844e6045f1SJohannes Berg /* 2185a62428c0STejun Heo * It is permissible to free the struct work_struct from 2186a62428c0STejun Heo * inside the function that is called from it, this we need to 2187a62428c0STejun Heo * take into account for lockdep too. To avoid bogus "held 2188a62428c0STejun Heo * lock freed" warnings as well as problems when looking into 2189a62428c0STejun Heo * work->lockdep_map, make a copy and use that here. 21904e6045f1SJohannes Berg */ 21914d82a1deSPeter Zijlstra struct lockdep_map lockdep_map; 21924d82a1deSPeter Zijlstra 21934d82a1deSPeter Zijlstra lockdep_copy_map(&lockdep_map, &work->lockdep_map); 21944e6045f1SJohannes Berg #endif 21956fec10a1STejun Heo /* 21966fec10a1STejun Heo * Ensure we're on the correct CPU. DISASSOCIATED test is 21976fec10a1STejun Heo * necessary to avoid spurious warnings from rescuers servicing the 219824647570STejun Heo * unbound or a disassociated pool. 21996fec10a1STejun Heo */ 22005f7dabfdSLai Jiangshan WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) && 220124647570STejun Heo !(pool->flags & POOL_DISASSOCIATED) && 2202ec22ca5eSTejun Heo raw_smp_processor_id() != pool->cpu); 220325511a47STejun Heo 22047e11629dSTejun Heo /* 22057e11629dSTejun Heo * A single work shouldn't be executed concurrently by 22067e11629dSTejun Heo * multiple workers on a single cpu. Check whether anyone is 22077e11629dSTejun Heo * already processing the work. If so, defer the work to the 22087e11629dSTejun Heo * currently executing one. 22097e11629dSTejun Heo */ 2210c9e7cf27STejun Heo collision = find_worker_executing_work(pool, work); 22117e11629dSTejun Heo if (unlikely(collision)) { 22127e11629dSTejun Heo move_linked_works(work, &collision->scheduled, NULL); 22137e11629dSTejun Heo return; 22147e11629dSTejun Heo } 22151da177e4SLinus Torvalds 22168930cabaSTejun Heo /* claim and dequeue */ 22171da177e4SLinus Torvalds debug_work_deactivate(work); 2218c9e7cf27STejun Heo hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work); 2219c34056a3STejun Heo worker->current_work = work; 2220a2c1c57bSTejun Heo worker->current_func = work->func; 2221112202d9STejun Heo worker->current_pwq = pwq; 222273f53c4aSTejun Heo work_color = get_work_color(work); 22237a22ad75STejun Heo 2224a62428c0STejun Heo list_del_init(&work->entry); 2225a62428c0STejun Heo 2226649027d7STejun Heo /* 2227fb0e7bebSTejun Heo * CPU intensive works don't participate in concurrency 2228fb0e7bebSTejun Heo * management. They're the scheduler's responsibility. 2229fb0e7bebSTejun Heo */ 2230fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2231fb0e7bebSTejun Heo worker_set_flags(worker, WORKER_CPU_INTENSIVE, true); 2232fb0e7bebSTejun Heo 2233974271c4STejun Heo /* 2234d565ed63STejun Heo * Unbound pool isn't concurrency managed and work items should be 2235974271c4STejun Heo * executed ASAP. Wake up another worker if necessary. 2236974271c4STejun Heo */ 223763d95a91STejun Heo if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool)) 223863d95a91STejun Heo wake_up_worker(pool); 2239974271c4STejun Heo 22408930cabaSTejun Heo /* 22417c3eed5cSTejun Heo * Record the last pool and clear PENDING which should be the last 2242d565ed63STejun Heo * update to @work. Also, do this inside @pool->lock so that 224323657bb1STejun Heo * PENDING and queued state changes happen together while IRQ is 224423657bb1STejun Heo * disabled. 22458930cabaSTejun Heo */ 22467c3eed5cSTejun Heo set_work_pool_and_clear_pending(work, pool->id); 22471da177e4SLinus Torvalds 2248d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2249365970a1SDavid Howells 2250112202d9STejun Heo lock_map_acquire_read(&pwq->wq->lockdep_map); 22513295f0efSIngo Molnar lock_map_acquire(&lockdep_map); 2252e36c886aSArjan van de Ven trace_workqueue_execute_start(work); 2253a2c1c57bSTejun Heo worker->current_func(work); 2254e36c886aSArjan van de Ven /* 2255e36c886aSArjan van de Ven * While we must be careful to not use "work" after this, the trace 2256e36c886aSArjan van de Ven * point will only record its address. 2257e36c886aSArjan van de Ven */ 2258e36c886aSArjan van de Ven trace_workqueue_execute_end(work); 22593295f0efSIngo Molnar lock_map_release(&lockdep_map); 2260112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 22611da177e4SLinus Torvalds 2262d5abe669SPeter Zijlstra if (unlikely(in_atomic() || lockdep_depth(current) > 0)) { 2263044c782cSValentin Ilie pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n" 2264044c782cSValentin Ilie " last function: %pf\n", 2265a2c1c57bSTejun Heo current->comm, preempt_count(), task_pid_nr(current), 2266a2c1c57bSTejun Heo worker->current_func); 2267d5abe669SPeter Zijlstra debug_show_held_locks(current); 2268d5abe669SPeter Zijlstra dump_stack(); 2269d5abe669SPeter Zijlstra } 2270d5abe669SPeter Zijlstra 2271d565ed63STejun Heo spin_lock_irq(&pool->lock); 2272a62428c0STejun Heo 2273fb0e7bebSTejun Heo /* clear cpu intensive status */ 2274fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2275fb0e7bebSTejun Heo worker_clr_flags(worker, WORKER_CPU_INTENSIVE); 2276fb0e7bebSTejun Heo 2277a62428c0STejun Heo /* we're done with it, release */ 227842f8570fSSasha Levin hash_del(&worker->hentry); 2279c34056a3STejun Heo worker->current_work = NULL; 2280a2c1c57bSTejun Heo worker->current_func = NULL; 2281112202d9STejun Heo worker->current_pwq = NULL; 2282112202d9STejun Heo pwq_dec_nr_in_flight(pwq, work_color); 22831da177e4SLinus Torvalds } 22841da177e4SLinus Torvalds 2285affee4b2STejun Heo /** 2286affee4b2STejun Heo * process_scheduled_works - process scheduled works 2287affee4b2STejun Heo * @worker: self 2288affee4b2STejun Heo * 2289affee4b2STejun Heo * Process all scheduled works. Please note that the scheduled list 2290affee4b2STejun Heo * may change while processing a work, so this function repeatedly 2291affee4b2STejun Heo * fetches a work from the top and executes it. 2292affee4b2STejun Heo * 2293affee4b2STejun Heo * CONTEXT: 2294d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2295affee4b2STejun Heo * multiple times. 2296affee4b2STejun Heo */ 2297affee4b2STejun Heo static void process_scheduled_works(struct worker *worker) 22981da177e4SLinus Torvalds { 2299affee4b2STejun Heo while (!list_empty(&worker->scheduled)) { 2300affee4b2STejun Heo struct work_struct *work = list_first_entry(&worker->scheduled, 2301a62428c0STejun Heo struct work_struct, entry); 2302c34056a3STejun Heo process_one_work(worker, work); 2303a62428c0STejun Heo } 23041da177e4SLinus Torvalds } 23051da177e4SLinus Torvalds 23064690c4abSTejun Heo /** 23074690c4abSTejun Heo * worker_thread - the worker thread function 2308c34056a3STejun Heo * @__worker: self 23094690c4abSTejun Heo * 2310c5aa87bbSTejun Heo * The worker thread function. All workers belong to a worker_pool - 2311c5aa87bbSTejun Heo * either a per-cpu one or dynamic unbound one. These workers process all 2312c5aa87bbSTejun Heo * work items regardless of their specific target workqueue. The only 2313c5aa87bbSTejun Heo * exception is work items which belong to workqueues with a rescuer which 2314c5aa87bbSTejun Heo * will be explained in rescuer_thread(). 23154690c4abSTejun Heo */ 2316c34056a3STejun Heo static int worker_thread(void *__worker) 23171da177e4SLinus Torvalds { 2318c34056a3STejun Heo struct worker *worker = __worker; 2319bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 23201da177e4SLinus Torvalds 2321e22bee78STejun Heo /* tell the scheduler that this is a workqueue worker */ 2322e22bee78STejun Heo worker->task->flags |= PF_WQ_WORKER; 2323c8e55f36STejun Heo woke_up: 2324d565ed63STejun Heo spin_lock_irq(&pool->lock); 2325affee4b2STejun Heo 23265f7dabfdSLai Jiangshan /* we are off idle list if destruction or rebind is requested */ 23275f7dabfdSLai Jiangshan if (unlikely(list_empty(&worker->entry))) { 2328d565ed63STejun Heo spin_unlock_irq(&pool->lock); 232925511a47STejun Heo 23305f7dabfdSLai Jiangshan /* if DIE is set, destruction is requested */ 233125511a47STejun Heo if (worker->flags & WORKER_DIE) { 2332e22bee78STejun Heo worker->task->flags &= ~PF_WQ_WORKER; 2333c8e55f36STejun Heo return 0; 2334c8e55f36STejun Heo } 2335c8e55f36STejun Heo 23365f7dabfdSLai Jiangshan /* otherwise, rebind */ 233725511a47STejun Heo idle_worker_rebind(worker); 233825511a47STejun Heo goto woke_up; 233925511a47STejun Heo } 234025511a47STejun Heo 2341c8e55f36STejun Heo worker_leave_idle(worker); 2342db7bccf4STejun Heo recheck: 2343e22bee78STejun Heo /* no more worker necessary? */ 234463d95a91STejun Heo if (!need_more_worker(pool)) 2345e22bee78STejun Heo goto sleep; 2346e22bee78STejun Heo 2347e22bee78STejun Heo /* do we need to manage? */ 234863d95a91STejun Heo if (unlikely(!may_start_working(pool)) && manage_workers(worker)) 2349e22bee78STejun Heo goto recheck; 2350e22bee78STejun Heo 2351c8e55f36STejun Heo /* 2352c8e55f36STejun Heo * ->scheduled list can only be filled while a worker is 2353c8e55f36STejun Heo * preparing to process a work or actually processing it. 2354c8e55f36STejun Heo * Make sure nobody diddled with it while I was sleeping. 2355c8e55f36STejun Heo */ 23566183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->scheduled)); 2357c8e55f36STejun Heo 2358e22bee78STejun Heo /* 2359e22bee78STejun Heo * When control reaches this point, we're guaranteed to have 2360e22bee78STejun Heo * at least one idle worker or that someone else has already 2361e22bee78STejun Heo * assumed the manager role. 2362e22bee78STejun Heo */ 2363e22bee78STejun Heo worker_clr_flags(worker, WORKER_PREP); 2364e22bee78STejun Heo 2365e22bee78STejun Heo do { 2366affee4b2STejun Heo struct work_struct *work = 2367bd7bdd43STejun Heo list_first_entry(&pool->worklist, 2368affee4b2STejun Heo struct work_struct, entry); 2369affee4b2STejun Heo 2370c8e55f36STejun Heo if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) { 2371affee4b2STejun Heo /* optimization path, not strictly necessary */ 2372affee4b2STejun Heo process_one_work(worker, work); 2373affee4b2STejun Heo if (unlikely(!list_empty(&worker->scheduled))) 2374affee4b2STejun Heo process_scheduled_works(worker); 2375affee4b2STejun Heo } else { 2376c8e55f36STejun Heo move_linked_works(work, &worker->scheduled, NULL); 2377affee4b2STejun Heo process_scheduled_works(worker); 2378affee4b2STejun Heo } 237963d95a91STejun Heo } while (keep_working(pool)); 2380affee4b2STejun Heo 2381e22bee78STejun Heo worker_set_flags(worker, WORKER_PREP, false); 2382d313dd85STejun Heo sleep: 238363d95a91STejun Heo if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker)) 2384e22bee78STejun Heo goto recheck; 2385d313dd85STejun Heo 2386c8e55f36STejun Heo /* 2387d565ed63STejun Heo * pool->lock is held and there's no work to process and no need to 2388d565ed63STejun Heo * manage, sleep. Workers are woken up only while holding 2389d565ed63STejun Heo * pool->lock or from local cpu, so setting the current state 2390d565ed63STejun Heo * before releasing pool->lock is enough to prevent losing any 2391d565ed63STejun Heo * event. 2392c8e55f36STejun Heo */ 2393c8e55f36STejun Heo worker_enter_idle(worker); 2394c8e55f36STejun Heo __set_current_state(TASK_INTERRUPTIBLE); 2395d565ed63STejun Heo spin_unlock_irq(&pool->lock); 23961da177e4SLinus Torvalds schedule(); 2397c8e55f36STejun Heo goto woke_up; 23981da177e4SLinus Torvalds } 23991da177e4SLinus Torvalds 2400e22bee78STejun Heo /** 2401e22bee78STejun Heo * rescuer_thread - the rescuer thread function 2402111c225aSTejun Heo * @__rescuer: self 2403e22bee78STejun Heo * 2404e22bee78STejun Heo * Workqueue rescuer thread function. There's one rescuer for each 2405493008a8STejun Heo * workqueue which has WQ_MEM_RECLAIM set. 2406e22bee78STejun Heo * 2407706026c2STejun Heo * Regular work processing on a pool may block trying to create a new 2408e22bee78STejun Heo * worker which uses GFP_KERNEL allocation which has slight chance of 2409e22bee78STejun Heo * developing into deadlock if some works currently on the same queue 2410e22bee78STejun Heo * need to be processed to satisfy the GFP_KERNEL allocation. This is 2411e22bee78STejun Heo * the problem rescuer solves. 2412e22bee78STejun Heo * 2413706026c2STejun Heo * When such condition is possible, the pool summons rescuers of all 2414706026c2STejun Heo * workqueues which have works queued on the pool and let them process 2415e22bee78STejun Heo * those works so that forward progress can be guaranteed. 2416e22bee78STejun Heo * 2417e22bee78STejun Heo * This should happen rarely. 2418e22bee78STejun Heo */ 2419111c225aSTejun Heo static int rescuer_thread(void *__rescuer) 2420e22bee78STejun Heo { 2421111c225aSTejun Heo struct worker *rescuer = __rescuer; 2422111c225aSTejun Heo struct workqueue_struct *wq = rescuer->rescue_wq; 2423e22bee78STejun Heo struct list_head *scheduled = &rescuer->scheduled; 2424e22bee78STejun Heo 2425e22bee78STejun Heo set_user_nice(current, RESCUER_NICE_LEVEL); 2426111c225aSTejun Heo 2427111c225aSTejun Heo /* 2428111c225aSTejun Heo * Mark rescuer as worker too. As WORKER_PREP is never cleared, it 2429111c225aSTejun Heo * doesn't participate in concurrency management. 2430111c225aSTejun Heo */ 2431111c225aSTejun Heo rescuer->task->flags |= PF_WQ_WORKER; 2432e22bee78STejun Heo repeat: 2433e22bee78STejun Heo set_current_state(TASK_INTERRUPTIBLE); 24341da177e4SLinus Torvalds 2435412d32e6SMike Galbraith if (kthread_should_stop()) { 2436412d32e6SMike Galbraith __set_current_state(TASK_RUNNING); 2437111c225aSTejun Heo rescuer->task->flags &= ~PF_WQ_WORKER; 2438e22bee78STejun Heo return 0; 2439412d32e6SMike Galbraith } 24401da177e4SLinus Torvalds 2441493a1724STejun Heo /* see whether any pwq is asking for help */ 24422e109a28STejun Heo spin_lock_irq(&wq_mayday_lock); 2443493a1724STejun Heo 2444493a1724STejun Heo while (!list_empty(&wq->maydays)) { 2445493a1724STejun Heo struct pool_workqueue *pwq = list_first_entry(&wq->maydays, 2446493a1724STejun Heo struct pool_workqueue, mayday_node); 2447112202d9STejun Heo struct worker_pool *pool = pwq->pool; 2448e22bee78STejun Heo struct work_struct *work, *n; 2449e22bee78STejun Heo 2450e22bee78STejun Heo __set_current_state(TASK_RUNNING); 2451493a1724STejun Heo list_del_init(&pwq->mayday_node); 2452493a1724STejun Heo 24532e109a28STejun Heo spin_unlock_irq(&wq_mayday_lock); 2454e22bee78STejun Heo 2455e22bee78STejun Heo /* migrate to the target cpu if possible */ 2456f36dc67bSLai Jiangshan worker_maybe_bind_and_lock(pool); 2457b3104104SLai Jiangshan rescuer->pool = pool; 2458e22bee78STejun Heo 2459e22bee78STejun Heo /* 2460e22bee78STejun Heo * Slurp in all works issued via this workqueue and 2461e22bee78STejun Heo * process'em. 2462e22bee78STejun Heo */ 24636183c009STejun Heo WARN_ON_ONCE(!list_empty(&rescuer->scheduled)); 2464bd7bdd43STejun Heo list_for_each_entry_safe(work, n, &pool->worklist, entry) 2465112202d9STejun Heo if (get_work_pwq(work) == pwq) 2466e22bee78STejun Heo move_linked_works(work, scheduled, &n); 2467e22bee78STejun Heo 2468e22bee78STejun Heo process_scheduled_works(rescuer); 24697576958aSTejun Heo 24707576958aSTejun Heo /* 2471d565ed63STejun Heo * Leave this pool. If keep_working() is %true, notify a 24727576958aSTejun Heo * regular worker; otherwise, we end up with 0 concurrency 24737576958aSTejun Heo * and stalling the execution. 24747576958aSTejun Heo */ 247563d95a91STejun Heo if (keep_working(pool)) 247663d95a91STejun Heo wake_up_worker(pool); 24777576958aSTejun Heo 2478b3104104SLai Jiangshan rescuer->pool = NULL; 2479493a1724STejun Heo spin_unlock(&pool->lock); 24802e109a28STejun Heo spin_lock(&wq_mayday_lock); 24811da177e4SLinus Torvalds } 24821da177e4SLinus Torvalds 24832e109a28STejun Heo spin_unlock_irq(&wq_mayday_lock); 2484493a1724STejun Heo 2485111c225aSTejun Heo /* rescuers should never participate in concurrency management */ 2486111c225aSTejun Heo WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING)); 2487e22bee78STejun Heo schedule(); 2488e22bee78STejun Heo goto repeat; 24891da177e4SLinus Torvalds } 24901da177e4SLinus Torvalds 2491fc2e4d70SOleg Nesterov struct wq_barrier { 2492fc2e4d70SOleg Nesterov struct work_struct work; 2493fc2e4d70SOleg Nesterov struct completion done; 2494fc2e4d70SOleg Nesterov }; 2495fc2e4d70SOleg Nesterov 2496fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work) 2497fc2e4d70SOleg Nesterov { 2498fc2e4d70SOleg Nesterov struct wq_barrier *barr = container_of(work, struct wq_barrier, work); 2499fc2e4d70SOleg Nesterov complete(&barr->done); 2500fc2e4d70SOleg Nesterov } 2501fc2e4d70SOleg Nesterov 25024690c4abSTejun Heo /** 25034690c4abSTejun Heo * insert_wq_barrier - insert a barrier work 2504112202d9STejun Heo * @pwq: pwq to insert barrier into 25054690c4abSTejun Heo * @barr: wq_barrier to insert 2506affee4b2STejun Heo * @target: target work to attach @barr to 2507affee4b2STejun Heo * @worker: worker currently executing @target, NULL if @target is not executing 25084690c4abSTejun Heo * 2509affee4b2STejun Heo * @barr is linked to @target such that @barr is completed only after 2510affee4b2STejun Heo * @target finishes execution. Please note that the ordering 2511affee4b2STejun Heo * guarantee is observed only with respect to @target and on the local 2512affee4b2STejun Heo * cpu. 2513affee4b2STejun Heo * 2514affee4b2STejun Heo * Currently, a queued barrier can't be canceled. This is because 2515affee4b2STejun Heo * try_to_grab_pending() can't determine whether the work to be 2516affee4b2STejun Heo * grabbed is at the head of the queue and thus can't clear LINKED 2517affee4b2STejun Heo * flag of the previous work while there must be a valid next work 2518affee4b2STejun Heo * after a work with LINKED flag set. 2519affee4b2STejun Heo * 2520affee4b2STejun Heo * Note that when @worker is non-NULL, @target may be modified 2521112202d9STejun Heo * underneath us, so we can't reliably determine pwq from @target. 25224690c4abSTejun Heo * 25234690c4abSTejun Heo * CONTEXT: 2524d565ed63STejun Heo * spin_lock_irq(pool->lock). 25254690c4abSTejun Heo */ 2526112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq, 2527affee4b2STejun Heo struct wq_barrier *barr, 2528affee4b2STejun Heo struct work_struct *target, struct worker *worker) 2529fc2e4d70SOleg Nesterov { 2530affee4b2STejun Heo struct list_head *head; 2531affee4b2STejun Heo unsigned int linked = 0; 2532affee4b2STejun Heo 2533dc186ad7SThomas Gleixner /* 2534d565ed63STejun Heo * debugobject calls are safe here even with pool->lock locked 2535dc186ad7SThomas Gleixner * as we know for sure that this will not trigger any of the 2536dc186ad7SThomas Gleixner * checks and call back into the fixup functions where we 2537dc186ad7SThomas Gleixner * might deadlock. 2538dc186ad7SThomas Gleixner */ 2539ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&barr->work, wq_barrier_func); 254022df02bbSTejun Heo __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); 2541fc2e4d70SOleg Nesterov init_completion(&barr->done); 254283c22520SOleg Nesterov 2543affee4b2STejun Heo /* 2544affee4b2STejun Heo * If @target is currently being executed, schedule the 2545affee4b2STejun Heo * barrier to the worker; otherwise, put it after @target. 2546affee4b2STejun Heo */ 2547affee4b2STejun Heo if (worker) 2548affee4b2STejun Heo head = worker->scheduled.next; 2549affee4b2STejun Heo else { 2550affee4b2STejun Heo unsigned long *bits = work_data_bits(target); 2551affee4b2STejun Heo 2552affee4b2STejun Heo head = target->entry.next; 2553affee4b2STejun Heo /* there can already be other linked works, inherit and set */ 2554affee4b2STejun Heo linked = *bits & WORK_STRUCT_LINKED; 2555affee4b2STejun Heo __set_bit(WORK_STRUCT_LINKED_BIT, bits); 2556affee4b2STejun Heo } 2557affee4b2STejun Heo 2558dc186ad7SThomas Gleixner debug_work_activate(&barr->work); 2559112202d9STejun Heo insert_work(pwq, &barr->work, head, 2560affee4b2STejun Heo work_color_to_flags(WORK_NO_COLOR) | linked); 2561fc2e4d70SOleg Nesterov } 2562fc2e4d70SOleg Nesterov 256373f53c4aSTejun Heo /** 2564112202d9STejun Heo * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing 256573f53c4aSTejun Heo * @wq: workqueue being flushed 256673f53c4aSTejun Heo * @flush_color: new flush color, < 0 for no-op 256773f53c4aSTejun Heo * @work_color: new work color, < 0 for no-op 256873f53c4aSTejun Heo * 2569112202d9STejun Heo * Prepare pwqs for workqueue flushing. 257073f53c4aSTejun Heo * 2571112202d9STejun Heo * If @flush_color is non-negative, flush_color on all pwqs should be 2572112202d9STejun Heo * -1. If no pwq has in-flight commands at the specified color, all 2573112202d9STejun Heo * pwq->flush_color's stay at -1 and %false is returned. If any pwq 2574112202d9STejun Heo * has in flight commands, its pwq->flush_color is set to 2575112202d9STejun Heo * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq 257673f53c4aSTejun Heo * wakeup logic is armed and %true is returned. 257773f53c4aSTejun Heo * 257873f53c4aSTejun Heo * The caller should have initialized @wq->first_flusher prior to 257973f53c4aSTejun Heo * calling this function with non-negative @flush_color. If 258073f53c4aSTejun Heo * @flush_color is negative, no flush color update is done and %false 258173f53c4aSTejun Heo * is returned. 258273f53c4aSTejun Heo * 2583112202d9STejun Heo * If @work_color is non-negative, all pwqs should have the same 258473f53c4aSTejun Heo * work_color which is previous to @work_color and all will be 258573f53c4aSTejun Heo * advanced to @work_color. 258673f53c4aSTejun Heo * 258773f53c4aSTejun Heo * CONTEXT: 258873f53c4aSTejun Heo * mutex_lock(wq->flush_mutex). 258973f53c4aSTejun Heo * 259073f53c4aSTejun Heo * RETURNS: 259173f53c4aSTejun Heo * %true if @flush_color >= 0 and there's something to flush. %false 259273f53c4aSTejun Heo * otherwise. 259373f53c4aSTejun Heo */ 2594112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq, 259573f53c4aSTejun Heo int flush_color, int work_color) 25961da177e4SLinus Torvalds { 259773f53c4aSTejun Heo bool wait = false; 259849e3cf44STejun Heo struct pool_workqueue *pwq; 25991da177e4SLinus Torvalds 260073f53c4aSTejun Heo if (flush_color >= 0) { 26016183c009STejun Heo WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush)); 2602112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 1); 2603dc186ad7SThomas Gleixner } 260414441960SOleg Nesterov 260576af4d93STejun Heo local_irq_disable(); 260676af4d93STejun Heo 260749e3cf44STejun Heo for_each_pwq(pwq, wq) { 2608112202d9STejun Heo struct worker_pool *pool = pwq->pool; 26091da177e4SLinus Torvalds 261076af4d93STejun Heo spin_lock(&pool->lock); 261173f53c4aSTejun Heo 261273f53c4aSTejun Heo if (flush_color >= 0) { 26136183c009STejun Heo WARN_ON_ONCE(pwq->flush_color != -1); 261473f53c4aSTejun Heo 2615112202d9STejun Heo if (pwq->nr_in_flight[flush_color]) { 2616112202d9STejun Heo pwq->flush_color = flush_color; 2617112202d9STejun Heo atomic_inc(&wq->nr_pwqs_to_flush); 261873f53c4aSTejun Heo wait = true; 26191da177e4SLinus Torvalds } 262073f53c4aSTejun Heo } 262173f53c4aSTejun Heo 262273f53c4aSTejun Heo if (work_color >= 0) { 26236183c009STejun Heo WARN_ON_ONCE(work_color != work_next_color(pwq->work_color)); 2624112202d9STejun Heo pwq->work_color = work_color; 262573f53c4aSTejun Heo } 262673f53c4aSTejun Heo 262776af4d93STejun Heo spin_unlock(&pool->lock); 26281da177e4SLinus Torvalds } 26291da177e4SLinus Torvalds 263076af4d93STejun Heo local_irq_enable(); 263176af4d93STejun Heo 2632112202d9STejun Heo if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush)) 263373f53c4aSTejun Heo complete(&wq->first_flusher->done); 263473f53c4aSTejun Heo 263573f53c4aSTejun Heo return wait; 263683c22520SOleg Nesterov } 26371da177e4SLinus Torvalds 26380fcb78c2SRolf Eike Beer /** 26391da177e4SLinus Torvalds * flush_workqueue - ensure that any scheduled work has run to completion. 26400fcb78c2SRolf Eike Beer * @wq: workqueue to flush 26411da177e4SLinus Torvalds * 2642c5aa87bbSTejun Heo * This function sleeps until all work items which were queued on entry 2643c5aa87bbSTejun Heo * have finished execution, but it is not livelocked by new incoming ones. 26441da177e4SLinus Torvalds */ 26457ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq) 26461da177e4SLinus Torvalds { 264773f53c4aSTejun Heo struct wq_flusher this_flusher = { 264873f53c4aSTejun Heo .list = LIST_HEAD_INIT(this_flusher.list), 264973f53c4aSTejun Heo .flush_color = -1, 265073f53c4aSTejun Heo .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done), 265173f53c4aSTejun Heo }; 265273f53c4aSTejun Heo int next_color; 2653b1f4ec17SOleg Nesterov 26543295f0efSIngo Molnar lock_map_acquire(&wq->lockdep_map); 26553295f0efSIngo Molnar lock_map_release(&wq->lockdep_map); 265673f53c4aSTejun Heo 265773f53c4aSTejun Heo mutex_lock(&wq->flush_mutex); 265873f53c4aSTejun Heo 265973f53c4aSTejun Heo /* 266073f53c4aSTejun Heo * Start-to-wait phase 266173f53c4aSTejun Heo */ 266273f53c4aSTejun Heo next_color = work_next_color(wq->work_color); 266373f53c4aSTejun Heo 266473f53c4aSTejun Heo if (next_color != wq->flush_color) { 266573f53c4aSTejun Heo /* 266673f53c4aSTejun Heo * Color space is not full. The current work_color 266773f53c4aSTejun Heo * becomes our flush_color and work_color is advanced 266873f53c4aSTejun Heo * by one. 266973f53c4aSTejun Heo */ 26706183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow)); 267173f53c4aSTejun Heo this_flusher.flush_color = wq->work_color; 267273f53c4aSTejun Heo wq->work_color = next_color; 267373f53c4aSTejun Heo 267473f53c4aSTejun Heo if (!wq->first_flusher) { 267573f53c4aSTejun Heo /* no flush in progress, become the first flusher */ 26766183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 267773f53c4aSTejun Heo 267873f53c4aSTejun Heo wq->first_flusher = &this_flusher; 267973f53c4aSTejun Heo 2680112202d9STejun Heo if (!flush_workqueue_prep_pwqs(wq, wq->flush_color, 268173f53c4aSTejun Heo wq->work_color)) { 268273f53c4aSTejun Heo /* nothing to flush, done */ 268373f53c4aSTejun Heo wq->flush_color = next_color; 268473f53c4aSTejun Heo wq->first_flusher = NULL; 268573f53c4aSTejun Heo goto out_unlock; 268673f53c4aSTejun Heo } 268773f53c4aSTejun Heo } else { 268873f53c4aSTejun Heo /* wait in queue */ 26896183c009STejun Heo WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color); 269073f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_queue); 2691112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 269273f53c4aSTejun Heo } 269373f53c4aSTejun Heo } else { 269473f53c4aSTejun Heo /* 269573f53c4aSTejun Heo * Oops, color space is full, wait on overflow queue. 269673f53c4aSTejun Heo * The next flush completion will assign us 269773f53c4aSTejun Heo * flush_color and transfer to flusher_queue. 269873f53c4aSTejun Heo */ 269973f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_overflow); 270073f53c4aSTejun Heo } 270173f53c4aSTejun Heo 270273f53c4aSTejun Heo mutex_unlock(&wq->flush_mutex); 270373f53c4aSTejun Heo 270473f53c4aSTejun Heo wait_for_completion(&this_flusher.done); 270573f53c4aSTejun Heo 270673f53c4aSTejun Heo /* 270773f53c4aSTejun Heo * Wake-up-and-cascade phase 270873f53c4aSTejun Heo * 270973f53c4aSTejun Heo * First flushers are responsible for cascading flushes and 271073f53c4aSTejun Heo * handling overflow. Non-first flushers can simply return. 271173f53c4aSTejun Heo */ 271273f53c4aSTejun Heo if (wq->first_flusher != &this_flusher) 271373f53c4aSTejun Heo return; 271473f53c4aSTejun Heo 271573f53c4aSTejun Heo mutex_lock(&wq->flush_mutex); 271673f53c4aSTejun Heo 27174ce48b37STejun Heo /* we might have raced, check again with mutex held */ 27184ce48b37STejun Heo if (wq->first_flusher != &this_flusher) 27194ce48b37STejun Heo goto out_unlock; 27204ce48b37STejun Heo 272173f53c4aSTejun Heo wq->first_flusher = NULL; 272273f53c4aSTejun Heo 27236183c009STejun Heo WARN_ON_ONCE(!list_empty(&this_flusher.list)); 27246183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 272573f53c4aSTejun Heo 272673f53c4aSTejun Heo while (true) { 272773f53c4aSTejun Heo struct wq_flusher *next, *tmp; 272873f53c4aSTejun Heo 272973f53c4aSTejun Heo /* complete all the flushers sharing the current flush color */ 273073f53c4aSTejun Heo list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { 273173f53c4aSTejun Heo if (next->flush_color != wq->flush_color) 273273f53c4aSTejun Heo break; 273373f53c4aSTejun Heo list_del_init(&next->list); 273473f53c4aSTejun Heo complete(&next->done); 273573f53c4aSTejun Heo } 273673f53c4aSTejun Heo 27376183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) && 273873f53c4aSTejun Heo wq->flush_color != work_next_color(wq->work_color)); 273973f53c4aSTejun Heo 274073f53c4aSTejun Heo /* this flush_color is finished, advance by one */ 274173f53c4aSTejun Heo wq->flush_color = work_next_color(wq->flush_color); 274273f53c4aSTejun Heo 274373f53c4aSTejun Heo /* one color has been freed, handle overflow queue */ 274473f53c4aSTejun Heo if (!list_empty(&wq->flusher_overflow)) { 274573f53c4aSTejun Heo /* 274673f53c4aSTejun Heo * Assign the same color to all overflowed 274773f53c4aSTejun Heo * flushers, advance work_color and append to 274873f53c4aSTejun Heo * flusher_queue. This is the start-to-wait 274973f53c4aSTejun Heo * phase for these overflowed flushers. 275073f53c4aSTejun Heo */ 275173f53c4aSTejun Heo list_for_each_entry(tmp, &wq->flusher_overflow, list) 275273f53c4aSTejun Heo tmp->flush_color = wq->work_color; 275373f53c4aSTejun Heo 275473f53c4aSTejun Heo wq->work_color = work_next_color(wq->work_color); 275573f53c4aSTejun Heo 275673f53c4aSTejun Heo list_splice_tail_init(&wq->flusher_overflow, 275773f53c4aSTejun Heo &wq->flusher_queue); 2758112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 275973f53c4aSTejun Heo } 276073f53c4aSTejun Heo 276173f53c4aSTejun Heo if (list_empty(&wq->flusher_queue)) { 27626183c009STejun Heo WARN_ON_ONCE(wq->flush_color != wq->work_color); 276373f53c4aSTejun Heo break; 276473f53c4aSTejun Heo } 276573f53c4aSTejun Heo 276673f53c4aSTejun Heo /* 276773f53c4aSTejun Heo * Need to flush more colors. Make the next flusher 2768112202d9STejun Heo * the new first flusher and arm pwqs. 276973f53c4aSTejun Heo */ 27706183c009STejun Heo WARN_ON_ONCE(wq->flush_color == wq->work_color); 27716183c009STejun Heo WARN_ON_ONCE(wq->flush_color != next->flush_color); 277273f53c4aSTejun Heo 277373f53c4aSTejun Heo list_del_init(&next->list); 277473f53c4aSTejun Heo wq->first_flusher = next; 277573f53c4aSTejun Heo 2776112202d9STejun Heo if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1)) 277773f53c4aSTejun Heo break; 277873f53c4aSTejun Heo 277973f53c4aSTejun Heo /* 278073f53c4aSTejun Heo * Meh... this color is already done, clear first 278173f53c4aSTejun Heo * flusher and repeat cascading. 278273f53c4aSTejun Heo */ 278373f53c4aSTejun Heo wq->first_flusher = NULL; 278473f53c4aSTejun Heo } 278573f53c4aSTejun Heo 278673f53c4aSTejun Heo out_unlock: 278773f53c4aSTejun Heo mutex_unlock(&wq->flush_mutex); 27881da177e4SLinus Torvalds } 2789ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue); 27901da177e4SLinus Torvalds 27919c5a2ba7STejun Heo /** 27929c5a2ba7STejun Heo * drain_workqueue - drain a workqueue 27939c5a2ba7STejun Heo * @wq: workqueue to drain 27949c5a2ba7STejun Heo * 27959c5a2ba7STejun Heo * Wait until the workqueue becomes empty. While draining is in progress, 27969c5a2ba7STejun Heo * only chain queueing is allowed. IOW, only currently pending or running 27979c5a2ba7STejun Heo * work items on @wq can queue further work items on it. @wq is flushed 27989c5a2ba7STejun Heo * repeatedly until it becomes empty. The number of flushing is detemined 27999c5a2ba7STejun Heo * by the depth of chaining and should be relatively short. Whine if it 28009c5a2ba7STejun Heo * takes too long. 28019c5a2ba7STejun Heo */ 28029c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq) 28039c5a2ba7STejun Heo { 28049c5a2ba7STejun Heo unsigned int flush_cnt = 0; 280549e3cf44STejun Heo struct pool_workqueue *pwq; 28069c5a2ba7STejun Heo 28079c5a2ba7STejun Heo /* 28089c5a2ba7STejun Heo * __queue_work() needs to test whether there are drainers, is much 28099c5a2ba7STejun Heo * hotter than drain_workqueue() and already looks at @wq->flags. 2810618b01ebSTejun Heo * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers. 28119c5a2ba7STejun Heo */ 28125bcab335STejun Heo mutex_lock(&wq_mutex); 28139c5a2ba7STejun Heo if (!wq->nr_drainers++) 2814618b01ebSTejun Heo wq->flags |= __WQ_DRAINING; 28155bcab335STejun Heo mutex_unlock(&wq_mutex); 28169c5a2ba7STejun Heo reflush: 28179c5a2ba7STejun Heo flush_workqueue(wq); 28189c5a2ba7STejun Heo 281976af4d93STejun Heo local_irq_disable(); 282076af4d93STejun Heo 282149e3cf44STejun Heo for_each_pwq(pwq, wq) { 2822fa2563e4SThomas Tuttle bool drained; 28239c5a2ba7STejun Heo 282476af4d93STejun Heo spin_lock(&pwq->pool->lock); 2825112202d9STejun Heo drained = !pwq->nr_active && list_empty(&pwq->delayed_works); 282676af4d93STejun Heo spin_unlock(&pwq->pool->lock); 2827fa2563e4SThomas Tuttle 2828fa2563e4SThomas Tuttle if (drained) 28299c5a2ba7STejun Heo continue; 28309c5a2ba7STejun Heo 28319c5a2ba7STejun Heo if (++flush_cnt == 10 || 28329c5a2ba7STejun Heo (flush_cnt % 100 == 0 && flush_cnt <= 1000)) 2833c5aa87bbSTejun Heo pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n", 28349c5a2ba7STejun Heo wq->name, flush_cnt); 283576af4d93STejun Heo 283676af4d93STejun Heo local_irq_enable(); 28379c5a2ba7STejun Heo goto reflush; 28389c5a2ba7STejun Heo } 28399c5a2ba7STejun Heo 28405bcab335STejun Heo local_irq_enable(); 28415bcab335STejun Heo 28425bcab335STejun Heo mutex_lock(&wq_mutex); 28439c5a2ba7STejun Heo if (!--wq->nr_drainers) 2844618b01ebSTejun Heo wq->flags &= ~__WQ_DRAINING; 28455bcab335STejun Heo mutex_unlock(&wq_mutex); 28469c5a2ba7STejun Heo } 28479c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue); 28489c5a2ba7STejun Heo 2849606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr) 2850baf59022STejun Heo { 2851baf59022STejun Heo struct worker *worker = NULL; 2852c9e7cf27STejun Heo struct worker_pool *pool; 2853112202d9STejun Heo struct pool_workqueue *pwq; 2854baf59022STejun Heo 2855baf59022STejun Heo might_sleep(); 2856baf59022STejun Heo 2857fa1b54e6STejun Heo local_irq_disable(); 2858fa1b54e6STejun Heo pool = get_work_pool(work); 2859fa1b54e6STejun Heo if (!pool) { 2860fa1b54e6STejun Heo local_irq_enable(); 2861fa1b54e6STejun Heo return false; 2862fa1b54e6STejun Heo } 2863fa1b54e6STejun Heo 2864fa1b54e6STejun Heo spin_lock(&pool->lock); 28650b3dae68SLai Jiangshan /* see the comment in try_to_grab_pending() with the same code */ 2866112202d9STejun Heo pwq = get_work_pwq(work); 2867112202d9STejun Heo if (pwq) { 2868112202d9STejun Heo if (unlikely(pwq->pool != pool)) 2869baf59022STejun Heo goto already_gone; 2870606a5020STejun Heo } else { 2871c9e7cf27STejun Heo worker = find_worker_executing_work(pool, work); 2872baf59022STejun Heo if (!worker) 2873baf59022STejun Heo goto already_gone; 2874112202d9STejun Heo pwq = worker->current_pwq; 2875606a5020STejun Heo } 2876baf59022STejun Heo 2877112202d9STejun Heo insert_wq_barrier(pwq, barr, work, worker); 2878d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2879baf59022STejun Heo 2880e159489bSTejun Heo /* 2881e159489bSTejun Heo * If @max_active is 1 or rescuer is in use, flushing another work 2882e159489bSTejun Heo * item on the same workqueue may lead to deadlock. Make sure the 2883e159489bSTejun Heo * flusher is not running on the same workqueue by verifying write 2884e159489bSTejun Heo * access. 2885e159489bSTejun Heo */ 2886493008a8STejun Heo if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer) 2887112202d9STejun Heo lock_map_acquire(&pwq->wq->lockdep_map); 2888e159489bSTejun Heo else 2889112202d9STejun Heo lock_map_acquire_read(&pwq->wq->lockdep_map); 2890112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 2891e159489bSTejun Heo 2892baf59022STejun Heo return true; 2893baf59022STejun Heo already_gone: 2894d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2895baf59022STejun Heo return false; 2896baf59022STejun Heo } 2897baf59022STejun Heo 2898db700897SOleg Nesterov /** 2899401a8d04STejun Heo * flush_work - wait for a work to finish executing the last queueing instance 2900401a8d04STejun Heo * @work: the work to flush 2901db700897SOleg Nesterov * 2902606a5020STejun Heo * Wait until @work has finished execution. @work is guaranteed to be idle 2903606a5020STejun Heo * on return if it hasn't been requeued since flush started. 2904401a8d04STejun Heo * 2905401a8d04STejun Heo * RETURNS: 2906401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2907401a8d04STejun Heo * %false if it was already idle. 2908db700897SOleg Nesterov */ 2909401a8d04STejun Heo bool flush_work(struct work_struct *work) 2910db700897SOleg Nesterov { 2911db700897SOleg Nesterov struct wq_barrier barr; 2912db700897SOleg Nesterov 29130976dfc1SStephen Boyd lock_map_acquire(&work->lockdep_map); 29140976dfc1SStephen Boyd lock_map_release(&work->lockdep_map); 29150976dfc1SStephen Boyd 2916606a5020STejun Heo if (start_flush_work(work, &barr)) { 2917db700897SOleg Nesterov wait_for_completion(&barr.done); 2918dc186ad7SThomas Gleixner destroy_work_on_stack(&barr.work); 2919401a8d04STejun Heo return true; 2920606a5020STejun Heo } else { 2921401a8d04STejun Heo return false; 2922db700897SOleg Nesterov } 2923606a5020STejun Heo } 2924db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work); 2925db700897SOleg Nesterov 292636e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork) 2927401a8d04STejun Heo { 2928bbb68dfaSTejun Heo unsigned long flags; 29291f1f642eSOleg Nesterov int ret; 29301f1f642eSOleg Nesterov 29311f1f642eSOleg Nesterov do { 2932bbb68dfaSTejun Heo ret = try_to_grab_pending(work, is_dwork, &flags); 2933bbb68dfaSTejun Heo /* 2934bbb68dfaSTejun Heo * If someone else is canceling, wait for the same event it 2935bbb68dfaSTejun Heo * would be waiting for before retrying. 2936bbb68dfaSTejun Heo */ 2937bbb68dfaSTejun Heo if (unlikely(ret == -ENOENT)) 2938606a5020STejun Heo flush_work(work); 29391f1f642eSOleg Nesterov } while (unlikely(ret < 0)); 29401f1f642eSOleg Nesterov 2941bbb68dfaSTejun Heo /* tell other tasks trying to grab @work to back off */ 2942bbb68dfaSTejun Heo mark_work_canceling(work); 2943bbb68dfaSTejun Heo local_irq_restore(flags); 2944bbb68dfaSTejun Heo 2945606a5020STejun Heo flush_work(work); 29467a22ad75STejun Heo clear_work_data(work); 29471f1f642eSOleg Nesterov return ret; 29481f1f642eSOleg Nesterov } 29491f1f642eSOleg Nesterov 29506e84d644SOleg Nesterov /** 2951401a8d04STejun Heo * cancel_work_sync - cancel a work and wait for it to finish 2952401a8d04STejun Heo * @work: the work to cancel 29536e84d644SOleg Nesterov * 2954401a8d04STejun Heo * Cancel @work and wait for its execution to finish. This function 2955401a8d04STejun Heo * can be used even if the work re-queues itself or migrates to 2956401a8d04STejun Heo * another workqueue. On return from this function, @work is 2957401a8d04STejun Heo * guaranteed to be not pending or executing on any CPU. 29581f1f642eSOleg Nesterov * 2959401a8d04STejun Heo * cancel_work_sync(&delayed_work->work) must not be used for 2960401a8d04STejun Heo * delayed_work's. Use cancel_delayed_work_sync() instead. 29616e84d644SOleg Nesterov * 2962401a8d04STejun Heo * The caller must ensure that the workqueue on which @work was last 29636e84d644SOleg Nesterov * queued can't be destroyed before this function returns. 2964401a8d04STejun Heo * 2965401a8d04STejun Heo * RETURNS: 2966401a8d04STejun Heo * %true if @work was pending, %false otherwise. 29676e84d644SOleg Nesterov */ 2968401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work) 29696e84d644SOleg Nesterov { 297036e227d2STejun Heo return __cancel_work_timer(work, false); 2971b89deed3SOleg Nesterov } 297228e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync); 2973b89deed3SOleg Nesterov 29746e84d644SOleg Nesterov /** 2975401a8d04STejun Heo * flush_delayed_work - wait for a dwork to finish executing the last queueing 2976401a8d04STejun Heo * @dwork: the delayed work to flush 29776e84d644SOleg Nesterov * 2978401a8d04STejun Heo * Delayed timer is cancelled and the pending work is queued for 2979401a8d04STejun Heo * immediate execution. Like flush_work(), this function only 2980401a8d04STejun Heo * considers the last queueing instance of @dwork. 29811f1f642eSOleg Nesterov * 2982401a8d04STejun Heo * RETURNS: 2983401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2984401a8d04STejun Heo * %false if it was already idle. 29856e84d644SOleg Nesterov */ 2986401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork) 2987401a8d04STejun Heo { 29888930cabaSTejun Heo local_irq_disable(); 2989401a8d04STejun Heo if (del_timer_sync(&dwork->timer)) 299060c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 29918930cabaSTejun Heo local_irq_enable(); 2992401a8d04STejun Heo return flush_work(&dwork->work); 2993401a8d04STejun Heo } 2994401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work); 2995401a8d04STejun Heo 2996401a8d04STejun Heo /** 299757b30ae7STejun Heo * cancel_delayed_work - cancel a delayed work 299857b30ae7STejun Heo * @dwork: delayed_work to cancel 299909383498STejun Heo * 300057b30ae7STejun Heo * Kill off a pending delayed_work. Returns %true if @dwork was pending 300157b30ae7STejun Heo * and canceled; %false if wasn't pending. Note that the work callback 300257b30ae7STejun Heo * function may still be running on return, unless it returns %true and the 300357b30ae7STejun Heo * work doesn't re-arm itself. Explicitly flush or use 300457b30ae7STejun Heo * cancel_delayed_work_sync() to wait on it. 300509383498STejun Heo * 300657b30ae7STejun Heo * This function is safe to call from any context including IRQ handler. 300709383498STejun Heo */ 300857b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork) 300909383498STejun Heo { 301057b30ae7STejun Heo unsigned long flags; 301157b30ae7STejun Heo int ret; 301257b30ae7STejun Heo 301357b30ae7STejun Heo do { 301457b30ae7STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 301557b30ae7STejun Heo } while (unlikely(ret == -EAGAIN)); 301657b30ae7STejun Heo 301757b30ae7STejun Heo if (unlikely(ret < 0)) 301857b30ae7STejun Heo return false; 301957b30ae7STejun Heo 30207c3eed5cSTejun Heo set_work_pool_and_clear_pending(&dwork->work, 30217c3eed5cSTejun Heo get_work_pool_id(&dwork->work)); 302257b30ae7STejun Heo local_irq_restore(flags); 3023c0158ca6SDan Magenheimer return ret; 302409383498STejun Heo } 302557b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work); 302609383498STejun Heo 302709383498STejun Heo /** 3028401a8d04STejun Heo * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish 3029401a8d04STejun Heo * @dwork: the delayed work cancel 3030401a8d04STejun Heo * 3031401a8d04STejun Heo * This is cancel_work_sync() for delayed works. 3032401a8d04STejun Heo * 3033401a8d04STejun Heo * RETURNS: 3034401a8d04STejun Heo * %true if @dwork was pending, %false otherwise. 3035401a8d04STejun Heo */ 3036401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork) 30376e84d644SOleg Nesterov { 303836e227d2STejun Heo return __cancel_work_timer(&dwork->work, true); 30396e84d644SOleg Nesterov } 3040f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync); 30411da177e4SLinus Torvalds 30420fcb78c2SRolf Eike Beer /** 304331ddd871STejun Heo * schedule_on_each_cpu - execute a function synchronously on each online CPU 3044b6136773SAndrew Morton * @func: the function to call 3045b6136773SAndrew Morton * 304631ddd871STejun Heo * schedule_on_each_cpu() executes @func on each online CPU using the 304731ddd871STejun Heo * system workqueue and blocks until all CPUs have completed. 3048b6136773SAndrew Morton * schedule_on_each_cpu() is very slow. 304931ddd871STejun Heo * 305031ddd871STejun Heo * RETURNS: 305131ddd871STejun Heo * 0 on success, -errno on failure. 3052b6136773SAndrew Morton */ 305365f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func) 305415316ba8SChristoph Lameter { 305515316ba8SChristoph Lameter int cpu; 305638f51568SNamhyung Kim struct work_struct __percpu *works; 305715316ba8SChristoph Lameter 3058b6136773SAndrew Morton works = alloc_percpu(struct work_struct); 3059b6136773SAndrew Morton if (!works) 306015316ba8SChristoph Lameter return -ENOMEM; 3061b6136773SAndrew Morton 306295402b38SGautham R Shenoy get_online_cpus(); 306393981800STejun Heo 306415316ba8SChristoph Lameter for_each_online_cpu(cpu) { 30659bfb1839SIngo Molnar struct work_struct *work = per_cpu_ptr(works, cpu); 30669bfb1839SIngo Molnar 30679bfb1839SIngo Molnar INIT_WORK(work, func); 30688de6d308SOleg Nesterov schedule_work_on(cpu, work); 306915316ba8SChristoph Lameter } 307093981800STejun Heo 307193981800STejun Heo for_each_online_cpu(cpu) 30728616a89aSOleg Nesterov flush_work(per_cpu_ptr(works, cpu)); 307393981800STejun Heo 307495402b38SGautham R Shenoy put_online_cpus(); 3075b6136773SAndrew Morton free_percpu(works); 307615316ba8SChristoph Lameter return 0; 307715316ba8SChristoph Lameter } 307815316ba8SChristoph Lameter 3079eef6a7d5SAlan Stern /** 3080eef6a7d5SAlan Stern * flush_scheduled_work - ensure that any scheduled work has run to completion. 3081eef6a7d5SAlan Stern * 3082eef6a7d5SAlan Stern * Forces execution of the kernel-global workqueue and blocks until its 3083eef6a7d5SAlan Stern * completion. 3084eef6a7d5SAlan Stern * 3085eef6a7d5SAlan Stern * Think twice before calling this function! It's very easy to get into 3086eef6a7d5SAlan Stern * trouble if you don't take great care. Either of the following situations 3087eef6a7d5SAlan Stern * will lead to deadlock: 3088eef6a7d5SAlan Stern * 3089eef6a7d5SAlan Stern * One of the work items currently on the workqueue needs to acquire 3090eef6a7d5SAlan Stern * a lock held by your code or its caller. 3091eef6a7d5SAlan Stern * 3092eef6a7d5SAlan Stern * Your code is running in the context of a work routine. 3093eef6a7d5SAlan Stern * 3094eef6a7d5SAlan Stern * They will be detected by lockdep when they occur, but the first might not 3095eef6a7d5SAlan Stern * occur very often. It depends on what work items are on the workqueue and 3096eef6a7d5SAlan Stern * what locks they need, which you have no control over. 3097eef6a7d5SAlan Stern * 3098eef6a7d5SAlan Stern * In most situations flushing the entire workqueue is overkill; you merely 3099eef6a7d5SAlan Stern * need to know that a particular work item isn't queued and isn't running. 3100eef6a7d5SAlan Stern * In such cases you should use cancel_delayed_work_sync() or 3101eef6a7d5SAlan Stern * cancel_work_sync() instead. 3102eef6a7d5SAlan Stern */ 31031da177e4SLinus Torvalds void flush_scheduled_work(void) 31041da177e4SLinus Torvalds { 3105d320c038STejun Heo flush_workqueue(system_wq); 31061da177e4SLinus Torvalds } 3107ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work); 31081da177e4SLinus Torvalds 31091da177e4SLinus Torvalds /** 31101fa44ecaSJames Bottomley * execute_in_process_context - reliably execute the routine with user context 31111fa44ecaSJames Bottomley * @fn: the function to execute 31121fa44ecaSJames Bottomley * @ew: guaranteed storage for the execute work structure (must 31131fa44ecaSJames Bottomley * be available when the work executes) 31141fa44ecaSJames Bottomley * 31151fa44ecaSJames Bottomley * Executes the function immediately if process context is available, 31161fa44ecaSJames Bottomley * otherwise schedules the function for delayed execution. 31171fa44ecaSJames Bottomley * 31181fa44ecaSJames Bottomley * Returns: 0 - function was executed 31191fa44ecaSJames Bottomley * 1 - function was scheduled for execution 31201fa44ecaSJames Bottomley */ 312165f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew) 31221fa44ecaSJames Bottomley { 31231fa44ecaSJames Bottomley if (!in_interrupt()) { 312465f27f38SDavid Howells fn(&ew->work); 31251fa44ecaSJames Bottomley return 0; 31261fa44ecaSJames Bottomley } 31271fa44ecaSJames Bottomley 312865f27f38SDavid Howells INIT_WORK(&ew->work, fn); 31291fa44ecaSJames Bottomley schedule_work(&ew->work); 31301fa44ecaSJames Bottomley 31311fa44ecaSJames Bottomley return 1; 31321fa44ecaSJames Bottomley } 31331fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context); 31341fa44ecaSJames Bottomley 3135226223abSTejun Heo #ifdef CONFIG_SYSFS 3136226223abSTejun Heo /* 3137226223abSTejun Heo * Workqueues with WQ_SYSFS flag set is visible to userland via 3138226223abSTejun Heo * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the 3139226223abSTejun Heo * following attributes. 3140226223abSTejun Heo * 3141226223abSTejun Heo * per_cpu RO bool : whether the workqueue is per-cpu or unbound 3142226223abSTejun Heo * max_active RW int : maximum number of in-flight work items 3143226223abSTejun Heo * 3144226223abSTejun Heo * Unbound workqueues have the following extra attributes. 3145226223abSTejun Heo * 3146226223abSTejun Heo * id RO int : the associated pool ID 3147226223abSTejun Heo * nice RW int : nice value of the workers 3148226223abSTejun Heo * cpumask RW mask : bitmask of allowed CPUs for the workers 3149226223abSTejun Heo */ 3150226223abSTejun Heo struct wq_device { 3151226223abSTejun Heo struct workqueue_struct *wq; 3152226223abSTejun Heo struct device dev; 3153226223abSTejun Heo }; 3154226223abSTejun Heo 3155226223abSTejun Heo static struct workqueue_struct *dev_to_wq(struct device *dev) 3156226223abSTejun Heo { 3157226223abSTejun Heo struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 3158226223abSTejun Heo 3159226223abSTejun Heo return wq_dev->wq; 3160226223abSTejun Heo } 3161226223abSTejun Heo 3162226223abSTejun Heo static ssize_t wq_per_cpu_show(struct device *dev, 3163226223abSTejun Heo struct device_attribute *attr, char *buf) 3164226223abSTejun Heo { 3165226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3166226223abSTejun Heo 3167226223abSTejun Heo return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND)); 3168226223abSTejun Heo } 3169226223abSTejun Heo 3170226223abSTejun Heo static ssize_t wq_max_active_show(struct device *dev, 3171226223abSTejun Heo struct device_attribute *attr, char *buf) 3172226223abSTejun Heo { 3173226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3174226223abSTejun Heo 3175226223abSTejun Heo return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active); 3176226223abSTejun Heo } 3177226223abSTejun Heo 3178226223abSTejun Heo static ssize_t wq_max_active_store(struct device *dev, 3179226223abSTejun Heo struct device_attribute *attr, 3180226223abSTejun Heo const char *buf, size_t count) 3181226223abSTejun Heo { 3182226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3183226223abSTejun Heo int val; 3184226223abSTejun Heo 3185226223abSTejun Heo if (sscanf(buf, "%d", &val) != 1 || val <= 0) 3186226223abSTejun Heo return -EINVAL; 3187226223abSTejun Heo 3188226223abSTejun Heo workqueue_set_max_active(wq, val); 3189226223abSTejun Heo return count; 3190226223abSTejun Heo } 3191226223abSTejun Heo 3192226223abSTejun Heo static struct device_attribute wq_sysfs_attrs[] = { 3193226223abSTejun Heo __ATTR(per_cpu, 0444, wq_per_cpu_show, NULL), 3194226223abSTejun Heo __ATTR(max_active, 0644, wq_max_active_show, wq_max_active_store), 3195226223abSTejun Heo __ATTR_NULL, 3196226223abSTejun Heo }; 3197226223abSTejun Heo 3198226223abSTejun Heo static ssize_t wq_pool_id_show(struct device *dev, 3199226223abSTejun Heo struct device_attribute *attr, char *buf) 3200226223abSTejun Heo { 3201226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3202226223abSTejun Heo struct worker_pool *pool; 3203226223abSTejun Heo int written; 3204226223abSTejun Heo 3205226223abSTejun Heo rcu_read_lock_sched(); 3206226223abSTejun Heo pool = first_pwq(wq)->pool; 3207226223abSTejun Heo written = scnprintf(buf, PAGE_SIZE, "%d\n", pool->id); 3208226223abSTejun Heo rcu_read_unlock_sched(); 3209226223abSTejun Heo 3210226223abSTejun Heo return written; 3211226223abSTejun Heo } 3212226223abSTejun Heo 3213226223abSTejun Heo static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr, 3214226223abSTejun Heo char *buf) 3215226223abSTejun Heo { 3216226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3217226223abSTejun Heo int written; 3218226223abSTejun Heo 3219226223abSTejun Heo rcu_read_lock_sched(); 3220226223abSTejun Heo written = scnprintf(buf, PAGE_SIZE, "%d\n", 3221226223abSTejun Heo first_pwq(wq)->pool->attrs->nice); 3222226223abSTejun Heo rcu_read_unlock_sched(); 3223226223abSTejun Heo 3224226223abSTejun Heo return written; 3225226223abSTejun Heo } 3226226223abSTejun Heo 3227226223abSTejun Heo /* prepare workqueue_attrs for sysfs store operations */ 3228226223abSTejun Heo static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq) 3229226223abSTejun Heo { 3230226223abSTejun Heo struct workqueue_attrs *attrs; 3231226223abSTejun Heo 3232226223abSTejun Heo attrs = alloc_workqueue_attrs(GFP_KERNEL); 3233226223abSTejun Heo if (!attrs) 3234226223abSTejun Heo return NULL; 3235226223abSTejun Heo 3236226223abSTejun Heo rcu_read_lock_sched(); 3237226223abSTejun Heo copy_workqueue_attrs(attrs, first_pwq(wq)->pool->attrs); 3238226223abSTejun Heo rcu_read_unlock_sched(); 3239226223abSTejun Heo return attrs; 3240226223abSTejun Heo } 3241226223abSTejun Heo 3242226223abSTejun Heo static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr, 3243226223abSTejun Heo const char *buf, size_t count) 3244226223abSTejun Heo { 3245226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3246226223abSTejun Heo struct workqueue_attrs *attrs; 3247226223abSTejun Heo int ret; 3248226223abSTejun Heo 3249226223abSTejun Heo attrs = wq_sysfs_prep_attrs(wq); 3250226223abSTejun Heo if (!attrs) 3251226223abSTejun Heo return -ENOMEM; 3252226223abSTejun Heo 3253226223abSTejun Heo if (sscanf(buf, "%d", &attrs->nice) == 1 && 3254226223abSTejun Heo attrs->nice >= -20 && attrs->nice <= 19) 3255226223abSTejun Heo ret = apply_workqueue_attrs(wq, attrs); 3256226223abSTejun Heo else 3257226223abSTejun Heo ret = -EINVAL; 3258226223abSTejun Heo 3259226223abSTejun Heo free_workqueue_attrs(attrs); 3260226223abSTejun Heo return ret ?: count; 3261226223abSTejun Heo } 3262226223abSTejun Heo 3263226223abSTejun Heo static ssize_t wq_cpumask_show(struct device *dev, 3264226223abSTejun Heo struct device_attribute *attr, char *buf) 3265226223abSTejun Heo { 3266226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3267226223abSTejun Heo int written; 3268226223abSTejun Heo 3269226223abSTejun Heo rcu_read_lock_sched(); 3270226223abSTejun Heo written = cpumask_scnprintf(buf, PAGE_SIZE, 3271226223abSTejun Heo first_pwq(wq)->pool->attrs->cpumask); 3272226223abSTejun Heo rcu_read_unlock_sched(); 3273226223abSTejun Heo 3274226223abSTejun Heo written += scnprintf(buf + written, PAGE_SIZE - written, "\n"); 3275226223abSTejun Heo return written; 3276226223abSTejun Heo } 3277226223abSTejun Heo 3278226223abSTejun Heo static ssize_t wq_cpumask_store(struct device *dev, 3279226223abSTejun Heo struct device_attribute *attr, 3280226223abSTejun Heo const char *buf, size_t count) 3281226223abSTejun Heo { 3282226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3283226223abSTejun Heo struct workqueue_attrs *attrs; 3284226223abSTejun Heo int ret; 3285226223abSTejun Heo 3286226223abSTejun Heo attrs = wq_sysfs_prep_attrs(wq); 3287226223abSTejun Heo if (!attrs) 3288226223abSTejun Heo return -ENOMEM; 3289226223abSTejun Heo 3290226223abSTejun Heo ret = cpumask_parse(buf, attrs->cpumask); 3291226223abSTejun Heo if (!ret) 3292226223abSTejun Heo ret = apply_workqueue_attrs(wq, attrs); 3293226223abSTejun Heo 3294226223abSTejun Heo free_workqueue_attrs(attrs); 3295226223abSTejun Heo return ret ?: count; 3296226223abSTejun Heo } 3297226223abSTejun Heo 3298226223abSTejun Heo static struct device_attribute wq_sysfs_unbound_attrs[] = { 3299226223abSTejun Heo __ATTR(pool_id, 0444, wq_pool_id_show, NULL), 3300226223abSTejun Heo __ATTR(nice, 0644, wq_nice_show, wq_nice_store), 3301226223abSTejun Heo __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store), 3302226223abSTejun Heo __ATTR_NULL, 3303226223abSTejun Heo }; 3304226223abSTejun Heo 3305226223abSTejun Heo static struct bus_type wq_subsys = { 3306226223abSTejun Heo .name = "workqueue", 3307226223abSTejun Heo .dev_attrs = wq_sysfs_attrs, 3308226223abSTejun Heo }; 3309226223abSTejun Heo 3310226223abSTejun Heo static int __init wq_sysfs_init(void) 3311226223abSTejun Heo { 3312226223abSTejun Heo return subsys_virtual_register(&wq_subsys, NULL); 3313226223abSTejun Heo } 3314226223abSTejun Heo core_initcall(wq_sysfs_init); 3315226223abSTejun Heo 3316226223abSTejun Heo static void wq_device_release(struct device *dev) 3317226223abSTejun Heo { 3318226223abSTejun Heo struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 3319226223abSTejun Heo 3320226223abSTejun Heo kfree(wq_dev); 3321226223abSTejun Heo } 3322226223abSTejun Heo 3323226223abSTejun Heo /** 3324226223abSTejun Heo * workqueue_sysfs_register - make a workqueue visible in sysfs 3325226223abSTejun Heo * @wq: the workqueue to register 3326226223abSTejun Heo * 3327226223abSTejun Heo * Expose @wq in sysfs under /sys/bus/workqueue/devices. 3328226223abSTejun Heo * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set 3329226223abSTejun Heo * which is the preferred method. 3330226223abSTejun Heo * 3331226223abSTejun Heo * Workqueue user should use this function directly iff it wants to apply 3332226223abSTejun Heo * workqueue_attrs before making the workqueue visible in sysfs; otherwise, 3333226223abSTejun Heo * apply_workqueue_attrs() may race against userland updating the 3334226223abSTejun Heo * attributes. 3335226223abSTejun Heo * 3336226223abSTejun Heo * Returns 0 on success, -errno on failure. 3337226223abSTejun Heo */ 3338226223abSTejun Heo int workqueue_sysfs_register(struct workqueue_struct *wq) 3339226223abSTejun Heo { 3340226223abSTejun Heo struct wq_device *wq_dev; 3341226223abSTejun Heo int ret; 3342226223abSTejun Heo 3343226223abSTejun Heo /* 3344226223abSTejun Heo * Adjusting max_active or creating new pwqs by applyting 3345226223abSTejun Heo * attributes breaks ordering guarantee. Disallow exposing ordered 3346226223abSTejun Heo * workqueues. 3347226223abSTejun Heo */ 3348226223abSTejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED)) 3349226223abSTejun Heo return -EINVAL; 3350226223abSTejun Heo 3351226223abSTejun Heo wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL); 3352226223abSTejun Heo if (!wq_dev) 3353226223abSTejun Heo return -ENOMEM; 3354226223abSTejun Heo 3355226223abSTejun Heo wq_dev->wq = wq; 3356226223abSTejun Heo wq_dev->dev.bus = &wq_subsys; 3357226223abSTejun Heo wq_dev->dev.init_name = wq->name; 3358226223abSTejun Heo wq_dev->dev.release = wq_device_release; 3359226223abSTejun Heo 3360226223abSTejun Heo /* 3361226223abSTejun Heo * unbound_attrs are created separately. Suppress uevent until 3362226223abSTejun Heo * everything is ready. 3363226223abSTejun Heo */ 3364226223abSTejun Heo dev_set_uevent_suppress(&wq_dev->dev, true); 3365226223abSTejun Heo 3366226223abSTejun Heo ret = device_register(&wq_dev->dev); 3367226223abSTejun Heo if (ret) { 3368226223abSTejun Heo kfree(wq_dev); 3369226223abSTejun Heo wq->wq_dev = NULL; 3370226223abSTejun Heo return ret; 3371226223abSTejun Heo } 3372226223abSTejun Heo 3373226223abSTejun Heo if (wq->flags & WQ_UNBOUND) { 3374226223abSTejun Heo struct device_attribute *attr; 3375226223abSTejun Heo 3376226223abSTejun Heo for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) { 3377226223abSTejun Heo ret = device_create_file(&wq_dev->dev, attr); 3378226223abSTejun Heo if (ret) { 3379226223abSTejun Heo device_unregister(&wq_dev->dev); 3380226223abSTejun Heo wq->wq_dev = NULL; 3381226223abSTejun Heo return ret; 3382226223abSTejun Heo } 3383226223abSTejun Heo } 3384226223abSTejun Heo } 3385226223abSTejun Heo 3386226223abSTejun Heo kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD); 3387226223abSTejun Heo return 0; 3388226223abSTejun Heo } 3389226223abSTejun Heo 3390226223abSTejun Heo /** 3391226223abSTejun Heo * workqueue_sysfs_unregister - undo workqueue_sysfs_register() 3392226223abSTejun Heo * @wq: the workqueue to unregister 3393226223abSTejun Heo * 3394226223abSTejun Heo * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister. 3395226223abSTejun Heo */ 3396226223abSTejun Heo static void workqueue_sysfs_unregister(struct workqueue_struct *wq) 3397226223abSTejun Heo { 3398226223abSTejun Heo struct wq_device *wq_dev = wq->wq_dev; 3399226223abSTejun Heo 3400226223abSTejun Heo if (!wq->wq_dev) 3401226223abSTejun Heo return; 3402226223abSTejun Heo 3403226223abSTejun Heo wq->wq_dev = NULL; 3404226223abSTejun Heo device_unregister(&wq_dev->dev); 3405226223abSTejun Heo } 3406226223abSTejun Heo #else /* CONFIG_SYSFS */ 3407226223abSTejun Heo static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { } 3408226223abSTejun Heo #endif /* CONFIG_SYSFS */ 3409226223abSTejun Heo 34107a4e344cSTejun Heo /** 34117a4e344cSTejun Heo * free_workqueue_attrs - free a workqueue_attrs 34127a4e344cSTejun Heo * @attrs: workqueue_attrs to free 34137a4e344cSTejun Heo * 34147a4e344cSTejun Heo * Undo alloc_workqueue_attrs(). 34157a4e344cSTejun Heo */ 34167a4e344cSTejun Heo void free_workqueue_attrs(struct workqueue_attrs *attrs) 34177a4e344cSTejun Heo { 34187a4e344cSTejun Heo if (attrs) { 34197a4e344cSTejun Heo free_cpumask_var(attrs->cpumask); 34207a4e344cSTejun Heo kfree(attrs); 34217a4e344cSTejun Heo } 34227a4e344cSTejun Heo } 34237a4e344cSTejun Heo 34247a4e344cSTejun Heo /** 34257a4e344cSTejun Heo * alloc_workqueue_attrs - allocate a workqueue_attrs 34267a4e344cSTejun Heo * @gfp_mask: allocation mask to use 34277a4e344cSTejun Heo * 34287a4e344cSTejun Heo * Allocate a new workqueue_attrs, initialize with default settings and 34297a4e344cSTejun Heo * return it. Returns NULL on failure. 34307a4e344cSTejun Heo */ 34317a4e344cSTejun Heo struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask) 34327a4e344cSTejun Heo { 34337a4e344cSTejun Heo struct workqueue_attrs *attrs; 34347a4e344cSTejun Heo 34357a4e344cSTejun Heo attrs = kzalloc(sizeof(*attrs), gfp_mask); 34367a4e344cSTejun Heo if (!attrs) 34377a4e344cSTejun Heo goto fail; 34387a4e344cSTejun Heo if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask)) 34397a4e344cSTejun Heo goto fail; 34407a4e344cSTejun Heo 34417a4e344cSTejun Heo cpumask_setall(attrs->cpumask); 34427a4e344cSTejun Heo return attrs; 34437a4e344cSTejun Heo fail: 34447a4e344cSTejun Heo free_workqueue_attrs(attrs); 34457a4e344cSTejun Heo return NULL; 34467a4e344cSTejun Heo } 34477a4e344cSTejun Heo 344829c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to, 344929c91e99STejun Heo const struct workqueue_attrs *from) 345029c91e99STejun Heo { 345129c91e99STejun Heo to->nice = from->nice; 345229c91e99STejun Heo cpumask_copy(to->cpumask, from->cpumask); 345329c91e99STejun Heo } 345429c91e99STejun Heo 345529c91e99STejun Heo /* 345629c91e99STejun Heo * Hacky implementation of jhash of bitmaps which only considers the 345729c91e99STejun Heo * specified number of bits. We probably want a proper implementation in 345829c91e99STejun Heo * include/linux/jhash.h. 345929c91e99STejun Heo */ 346029c91e99STejun Heo static u32 jhash_bitmap(const unsigned long *bitmap, int bits, u32 hash) 346129c91e99STejun Heo { 346229c91e99STejun Heo int nr_longs = bits / BITS_PER_LONG; 346329c91e99STejun Heo int nr_leftover = bits % BITS_PER_LONG; 346429c91e99STejun Heo unsigned long leftover = 0; 346529c91e99STejun Heo 346629c91e99STejun Heo if (nr_longs) 346729c91e99STejun Heo hash = jhash(bitmap, nr_longs * sizeof(long), hash); 346829c91e99STejun Heo if (nr_leftover) { 346929c91e99STejun Heo bitmap_copy(&leftover, bitmap + nr_longs, nr_leftover); 347029c91e99STejun Heo hash = jhash(&leftover, sizeof(long), hash); 347129c91e99STejun Heo } 347229c91e99STejun Heo return hash; 347329c91e99STejun Heo } 347429c91e99STejun Heo 347529c91e99STejun Heo /* hash value of the content of @attr */ 347629c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs) 347729c91e99STejun Heo { 347829c91e99STejun Heo u32 hash = 0; 347929c91e99STejun Heo 348029c91e99STejun Heo hash = jhash_1word(attrs->nice, hash); 348129c91e99STejun Heo hash = jhash_bitmap(cpumask_bits(attrs->cpumask), nr_cpu_ids, hash); 348229c91e99STejun Heo return hash; 348329c91e99STejun Heo } 348429c91e99STejun Heo 348529c91e99STejun Heo /* content equality test */ 348629c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a, 348729c91e99STejun Heo const struct workqueue_attrs *b) 348829c91e99STejun Heo { 348929c91e99STejun Heo if (a->nice != b->nice) 349029c91e99STejun Heo return false; 349129c91e99STejun Heo if (!cpumask_equal(a->cpumask, b->cpumask)) 349229c91e99STejun Heo return false; 349329c91e99STejun Heo return true; 349429c91e99STejun Heo } 349529c91e99STejun Heo 34967a4e344cSTejun Heo /** 34977a4e344cSTejun Heo * init_worker_pool - initialize a newly zalloc'd worker_pool 34987a4e344cSTejun Heo * @pool: worker_pool to initialize 34997a4e344cSTejun Heo * 35007a4e344cSTejun Heo * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs. 350129c91e99STejun Heo * Returns 0 on success, -errno on failure. Even on failure, all fields 350229c91e99STejun Heo * inside @pool proper are initialized and put_unbound_pool() can be called 350329c91e99STejun Heo * on @pool safely to release it. 35047a4e344cSTejun Heo */ 35057a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool) 35064e1a1f9aSTejun Heo { 35074e1a1f9aSTejun Heo spin_lock_init(&pool->lock); 350829c91e99STejun Heo pool->id = -1; 350929c91e99STejun Heo pool->cpu = -1; 35104e1a1f9aSTejun Heo pool->flags |= POOL_DISASSOCIATED; 35114e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->worklist); 35124e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->idle_list); 35134e1a1f9aSTejun Heo hash_init(pool->busy_hash); 35144e1a1f9aSTejun Heo 35154e1a1f9aSTejun Heo init_timer_deferrable(&pool->idle_timer); 35164e1a1f9aSTejun Heo pool->idle_timer.function = idle_worker_timeout; 35174e1a1f9aSTejun Heo pool->idle_timer.data = (unsigned long)pool; 35184e1a1f9aSTejun Heo 35194e1a1f9aSTejun Heo setup_timer(&pool->mayday_timer, pool_mayday_timeout, 35204e1a1f9aSTejun Heo (unsigned long)pool); 35214e1a1f9aSTejun Heo 35224e1a1f9aSTejun Heo mutex_init(&pool->manager_arb); 3523bc3a1afcSTejun Heo mutex_init(&pool->manager_mutex); 3524*822d8405STejun Heo idr_init(&pool->worker_idr); 35257a4e344cSTejun Heo 352629c91e99STejun Heo INIT_HLIST_NODE(&pool->hash_node); 352729c91e99STejun Heo pool->refcnt = 1; 352829c91e99STejun Heo 352929c91e99STejun Heo /* shouldn't fail above this point */ 35307a4e344cSTejun Heo pool->attrs = alloc_workqueue_attrs(GFP_KERNEL); 35317a4e344cSTejun Heo if (!pool->attrs) 35327a4e344cSTejun Heo return -ENOMEM; 35337a4e344cSTejun Heo return 0; 35344e1a1f9aSTejun Heo } 35354e1a1f9aSTejun Heo 353629c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu) 353729c91e99STejun Heo { 353829c91e99STejun Heo struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu); 353929c91e99STejun Heo 3540*822d8405STejun Heo idr_destroy(&pool->worker_idr); 354129c91e99STejun Heo free_workqueue_attrs(pool->attrs); 354229c91e99STejun Heo kfree(pool); 354329c91e99STejun Heo } 354429c91e99STejun Heo 354529c91e99STejun Heo /** 354629c91e99STejun Heo * put_unbound_pool - put a worker_pool 354729c91e99STejun Heo * @pool: worker_pool to put 354829c91e99STejun Heo * 354929c91e99STejun Heo * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU 3550c5aa87bbSTejun Heo * safe manner. get_unbound_pool() calls this function on its failure path 3551c5aa87bbSTejun Heo * and this function should be able to release pools which went through, 3552c5aa87bbSTejun Heo * successfully or not, init_worker_pool(). 355329c91e99STejun Heo */ 355429c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool) 355529c91e99STejun Heo { 355629c91e99STejun Heo struct worker *worker; 355729c91e99STejun Heo 35585bcab335STejun Heo mutex_lock(&wq_mutex); 355929c91e99STejun Heo if (--pool->refcnt) { 35605bcab335STejun Heo mutex_unlock(&wq_mutex); 356129c91e99STejun Heo return; 356229c91e99STejun Heo } 356329c91e99STejun Heo 356429c91e99STejun Heo /* sanity checks */ 356529c91e99STejun Heo if (WARN_ON(!(pool->flags & POOL_DISASSOCIATED)) || 356629c91e99STejun Heo WARN_ON(!list_empty(&pool->worklist))) { 35675bcab335STejun Heo mutex_unlock(&wq_mutex); 356829c91e99STejun Heo return; 356929c91e99STejun Heo } 357029c91e99STejun Heo 357129c91e99STejun Heo /* release id and unhash */ 357229c91e99STejun Heo if (pool->id >= 0) 357329c91e99STejun Heo idr_remove(&worker_pool_idr, pool->id); 357429c91e99STejun Heo hash_del(&pool->hash_node); 357529c91e99STejun Heo 35765bcab335STejun Heo mutex_unlock(&wq_mutex); 357729c91e99STejun Heo 3578c5aa87bbSTejun Heo /* 3579c5aa87bbSTejun Heo * Become the manager and destroy all workers. Grabbing 3580c5aa87bbSTejun Heo * manager_arb prevents @pool's workers from blocking on 3581c5aa87bbSTejun Heo * manager_mutex. 3582c5aa87bbSTejun Heo */ 358329c91e99STejun Heo mutex_lock(&pool->manager_arb); 3584cd549687STejun Heo mutex_lock(&pool->manager_mutex); 358529c91e99STejun Heo spin_lock_irq(&pool->lock); 358629c91e99STejun Heo 358729c91e99STejun Heo while ((worker = first_worker(pool))) 358829c91e99STejun Heo destroy_worker(worker); 358929c91e99STejun Heo WARN_ON(pool->nr_workers || pool->nr_idle); 359029c91e99STejun Heo 359129c91e99STejun Heo spin_unlock_irq(&pool->lock); 3592cd549687STejun Heo mutex_unlock(&pool->manager_mutex); 359329c91e99STejun Heo mutex_unlock(&pool->manager_arb); 359429c91e99STejun Heo 359529c91e99STejun Heo /* shut down the timers */ 359629c91e99STejun Heo del_timer_sync(&pool->idle_timer); 359729c91e99STejun Heo del_timer_sync(&pool->mayday_timer); 359829c91e99STejun Heo 359929c91e99STejun Heo /* sched-RCU protected to allow dereferences from get_work_pool() */ 360029c91e99STejun Heo call_rcu_sched(&pool->rcu, rcu_free_pool); 360129c91e99STejun Heo } 360229c91e99STejun Heo 360329c91e99STejun Heo /** 360429c91e99STejun Heo * get_unbound_pool - get a worker_pool with the specified attributes 360529c91e99STejun Heo * @attrs: the attributes of the worker_pool to get 360629c91e99STejun Heo * 360729c91e99STejun Heo * Obtain a worker_pool which has the same attributes as @attrs, bump the 360829c91e99STejun Heo * reference count and return it. If there already is a matching 360929c91e99STejun Heo * worker_pool, it will be used; otherwise, this function attempts to 361029c91e99STejun Heo * create a new one. On failure, returns NULL. 361129c91e99STejun Heo */ 361229c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs) 361329c91e99STejun Heo { 361429c91e99STejun Heo u32 hash = wqattrs_hash(attrs); 361529c91e99STejun Heo struct worker_pool *pool; 361629c91e99STejun Heo 36175bcab335STejun Heo mutex_lock(&wq_mutex); 361829c91e99STejun Heo 361929c91e99STejun Heo /* do we already have a matching pool? */ 362029c91e99STejun Heo hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) { 362129c91e99STejun Heo if (wqattrs_equal(pool->attrs, attrs)) { 362229c91e99STejun Heo pool->refcnt++; 362329c91e99STejun Heo goto out_unlock; 362429c91e99STejun Heo } 362529c91e99STejun Heo } 362629c91e99STejun Heo 362729c91e99STejun Heo /* nope, create a new one */ 362829c91e99STejun Heo pool = kzalloc(sizeof(*pool), GFP_KERNEL); 362929c91e99STejun Heo if (!pool || init_worker_pool(pool) < 0) 363029c91e99STejun Heo goto fail; 363129c91e99STejun Heo 36328864b4e5STejun Heo lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */ 363329c91e99STejun Heo copy_workqueue_attrs(pool->attrs, attrs); 363429c91e99STejun Heo 363529c91e99STejun Heo if (worker_pool_assign_id(pool) < 0) 363629c91e99STejun Heo goto fail; 363729c91e99STejun Heo 363829c91e99STejun Heo /* create and start the initial worker */ 3639ebf44d16STejun Heo if (create_and_start_worker(pool) < 0) 364029c91e99STejun Heo goto fail; 364129c91e99STejun Heo 364229c91e99STejun Heo /* install */ 364329c91e99STejun Heo hash_add(unbound_pool_hash, &pool->hash_node, hash); 364429c91e99STejun Heo out_unlock: 36455bcab335STejun Heo mutex_unlock(&wq_mutex); 364629c91e99STejun Heo return pool; 364729c91e99STejun Heo fail: 36485bcab335STejun Heo mutex_unlock(&wq_mutex); 364929c91e99STejun Heo if (pool) 365029c91e99STejun Heo put_unbound_pool(pool); 365129c91e99STejun Heo return NULL; 365229c91e99STejun Heo } 365329c91e99STejun Heo 36548864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu) 36558864b4e5STejun Heo { 36568864b4e5STejun Heo kmem_cache_free(pwq_cache, 36578864b4e5STejun Heo container_of(rcu, struct pool_workqueue, rcu)); 36588864b4e5STejun Heo } 36598864b4e5STejun Heo 36608864b4e5STejun Heo /* 36618864b4e5STejun Heo * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt 36628864b4e5STejun Heo * and needs to be destroyed. 36638864b4e5STejun Heo */ 36648864b4e5STejun Heo static void pwq_unbound_release_workfn(struct work_struct *work) 36658864b4e5STejun Heo { 36668864b4e5STejun Heo struct pool_workqueue *pwq = container_of(work, struct pool_workqueue, 36678864b4e5STejun Heo unbound_release_work); 36688864b4e5STejun Heo struct workqueue_struct *wq = pwq->wq; 36698864b4e5STejun Heo struct worker_pool *pool = pwq->pool; 36708864b4e5STejun Heo 36718864b4e5STejun Heo if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND))) 36728864b4e5STejun Heo return; 36738864b4e5STejun Heo 367475ccf595STejun Heo /* 367575ccf595STejun Heo * Unlink @pwq. Synchronization against flush_mutex isn't strictly 367675ccf595STejun Heo * necessary on release but do it anyway. It's easier to verify 367775ccf595STejun Heo * and consistent with the linking path. 367875ccf595STejun Heo */ 367975ccf595STejun Heo mutex_lock(&wq->flush_mutex); 3680794b18bcSTejun Heo spin_lock_irq(&pwq_lock); 36818864b4e5STejun Heo list_del_rcu(&pwq->pwqs_node); 3682794b18bcSTejun Heo spin_unlock_irq(&pwq_lock); 368375ccf595STejun Heo mutex_unlock(&wq->flush_mutex); 36848864b4e5STejun Heo 36858864b4e5STejun Heo put_unbound_pool(pool); 36868864b4e5STejun Heo call_rcu_sched(&pwq->rcu, rcu_free_pwq); 36878864b4e5STejun Heo 36888864b4e5STejun Heo /* 36898864b4e5STejun Heo * If we're the last pwq going away, @wq is already dead and no one 36908864b4e5STejun Heo * is gonna access it anymore. Free it. 36918864b4e5STejun Heo */ 36928864b4e5STejun Heo if (list_empty(&wq->pwqs)) 36938864b4e5STejun Heo kfree(wq); 36948864b4e5STejun Heo } 36958864b4e5STejun Heo 36960fbd95aaSTejun Heo /** 3697699ce097STejun Heo * pwq_adjust_max_active - update a pwq's max_active to the current setting 36980fbd95aaSTejun Heo * @pwq: target pool_workqueue 36990fbd95aaSTejun Heo * 3700699ce097STejun Heo * If @pwq isn't freezing, set @pwq->max_active to the associated 3701699ce097STejun Heo * workqueue's saved_max_active and activate delayed work items 3702699ce097STejun Heo * accordingly. If @pwq is freezing, clear @pwq->max_active to zero. 37030fbd95aaSTejun Heo */ 3704699ce097STejun Heo static void pwq_adjust_max_active(struct pool_workqueue *pwq) 37050fbd95aaSTejun Heo { 3706699ce097STejun Heo struct workqueue_struct *wq = pwq->wq; 3707699ce097STejun Heo bool freezable = wq->flags & WQ_FREEZABLE; 3708699ce097STejun Heo 3709699ce097STejun Heo /* for @wq->saved_max_active */ 3710794b18bcSTejun Heo lockdep_assert_held(&pwq_lock); 3711699ce097STejun Heo 3712699ce097STejun Heo /* fast exit for non-freezable wqs */ 3713699ce097STejun Heo if (!freezable && pwq->max_active == wq->saved_max_active) 3714699ce097STejun Heo return; 3715699ce097STejun Heo 3716699ce097STejun Heo spin_lock(&pwq->pool->lock); 3717699ce097STejun Heo 3718699ce097STejun Heo if (!freezable || !(pwq->pool->flags & POOL_FREEZING)) { 3719699ce097STejun Heo pwq->max_active = wq->saved_max_active; 37200fbd95aaSTejun Heo 37210fbd95aaSTejun Heo while (!list_empty(&pwq->delayed_works) && 37220fbd95aaSTejun Heo pwq->nr_active < pwq->max_active) 37230fbd95aaSTejun Heo pwq_activate_first_delayed(pwq); 3724699ce097STejun Heo } else { 3725699ce097STejun Heo pwq->max_active = 0; 3726699ce097STejun Heo } 3727699ce097STejun Heo 3728699ce097STejun Heo spin_unlock(&pwq->pool->lock); 37290fbd95aaSTejun Heo } 37300fbd95aaSTejun Heo 3731d2c1d404STejun Heo static void init_and_link_pwq(struct pool_workqueue *pwq, 3732d2c1d404STejun Heo struct workqueue_struct *wq, 37339e8cd2f5STejun Heo struct worker_pool *pool, 37349e8cd2f5STejun Heo struct pool_workqueue **p_last_pwq) 3735d2c1d404STejun Heo { 3736d2c1d404STejun Heo BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK); 3737d2c1d404STejun Heo 3738d2c1d404STejun Heo pwq->pool = pool; 3739d2c1d404STejun Heo pwq->wq = wq; 3740d2c1d404STejun Heo pwq->flush_color = -1; 37418864b4e5STejun Heo pwq->refcnt = 1; 3742d2c1d404STejun Heo INIT_LIST_HEAD(&pwq->delayed_works); 3743d2c1d404STejun Heo INIT_LIST_HEAD(&pwq->mayday_node); 37448864b4e5STejun Heo INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn); 3745d2c1d404STejun Heo 374675ccf595STejun Heo mutex_lock(&wq->flush_mutex); 3747794b18bcSTejun Heo spin_lock_irq(&pwq_lock); 374875ccf595STejun Heo 3749983ca25eSTejun Heo /* 3750983ca25eSTejun Heo * Set the matching work_color. This is synchronized with 3751983ca25eSTejun Heo * flush_mutex to avoid confusing flush_workqueue(). 3752983ca25eSTejun Heo */ 37539e8cd2f5STejun Heo if (p_last_pwq) 37549e8cd2f5STejun Heo *p_last_pwq = first_pwq(wq); 375575ccf595STejun Heo pwq->work_color = wq->work_color; 3756983ca25eSTejun Heo 3757983ca25eSTejun Heo /* sync max_active to the current setting */ 3758983ca25eSTejun Heo pwq_adjust_max_active(pwq); 3759983ca25eSTejun Heo 3760983ca25eSTejun Heo /* link in @pwq */ 37619e8cd2f5STejun Heo list_add_rcu(&pwq->pwqs_node, &wq->pwqs); 376275ccf595STejun Heo 3763794b18bcSTejun Heo spin_unlock_irq(&pwq_lock); 376475ccf595STejun Heo mutex_unlock(&wq->flush_mutex); 3765d2c1d404STejun Heo } 3766d2c1d404STejun Heo 37679e8cd2f5STejun Heo /** 37689e8cd2f5STejun Heo * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue 37699e8cd2f5STejun Heo * @wq: the target workqueue 37709e8cd2f5STejun Heo * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs() 37719e8cd2f5STejun Heo * 37729e8cd2f5STejun Heo * Apply @attrs to an unbound workqueue @wq. If @attrs doesn't match the 37739e8cd2f5STejun Heo * current attributes, a new pwq is created and made the first pwq which 37749e8cd2f5STejun Heo * will serve all new work items. Older pwqs are released as in-flight 37759e8cd2f5STejun Heo * work items finish. Note that a work item which repeatedly requeues 37769e8cd2f5STejun Heo * itself back-to-back will stay on its current pwq. 37779e8cd2f5STejun Heo * 37789e8cd2f5STejun Heo * Performs GFP_KERNEL allocations. Returns 0 on success and -errno on 37799e8cd2f5STejun Heo * failure. 37809e8cd2f5STejun Heo */ 37819e8cd2f5STejun Heo int apply_workqueue_attrs(struct workqueue_struct *wq, 37829e8cd2f5STejun Heo const struct workqueue_attrs *attrs) 37839e8cd2f5STejun Heo { 37849e8cd2f5STejun Heo struct pool_workqueue *pwq, *last_pwq; 37859e8cd2f5STejun Heo struct worker_pool *pool; 37869e8cd2f5STejun Heo 37878719dceaSTejun Heo /* only unbound workqueues can change attributes */ 37889e8cd2f5STejun Heo if (WARN_ON(!(wq->flags & WQ_UNBOUND))) 37899e8cd2f5STejun Heo return -EINVAL; 37909e8cd2f5STejun Heo 37918719dceaSTejun Heo /* creating multiple pwqs breaks ordering guarantee */ 37928719dceaSTejun Heo if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs))) 37938719dceaSTejun Heo return -EINVAL; 37948719dceaSTejun Heo 37959e8cd2f5STejun Heo pwq = kmem_cache_zalloc(pwq_cache, GFP_KERNEL); 37969e8cd2f5STejun Heo if (!pwq) 37979e8cd2f5STejun Heo return -ENOMEM; 37989e8cd2f5STejun Heo 37999e8cd2f5STejun Heo pool = get_unbound_pool(attrs); 38009e8cd2f5STejun Heo if (!pool) { 38019e8cd2f5STejun Heo kmem_cache_free(pwq_cache, pwq); 38029e8cd2f5STejun Heo return -ENOMEM; 38039e8cd2f5STejun Heo } 38049e8cd2f5STejun Heo 38059e8cd2f5STejun Heo init_and_link_pwq(pwq, wq, pool, &last_pwq); 38069e8cd2f5STejun Heo if (last_pwq) { 38079e8cd2f5STejun Heo spin_lock_irq(&last_pwq->pool->lock); 38089e8cd2f5STejun Heo put_pwq(last_pwq); 38099e8cd2f5STejun Heo spin_unlock_irq(&last_pwq->pool->lock); 38109e8cd2f5STejun Heo } 38119e8cd2f5STejun Heo 38129e8cd2f5STejun Heo return 0; 38139e8cd2f5STejun Heo } 38149e8cd2f5STejun Heo 381530cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq) 38161da177e4SLinus Torvalds { 381749e3cf44STejun Heo bool highpri = wq->flags & WQ_HIGHPRI; 381830cdf249STejun Heo int cpu; 3819e1d8aa9fSFrederic Weisbecker 382030cdf249STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 3821420c0ddbSTejun Heo wq->cpu_pwqs = alloc_percpu(struct pool_workqueue); 3822420c0ddbSTejun Heo if (!wq->cpu_pwqs) 382330cdf249STejun Heo return -ENOMEM; 382430cdf249STejun Heo 382530cdf249STejun Heo for_each_possible_cpu(cpu) { 38267fb98ea7STejun Heo struct pool_workqueue *pwq = 38277fb98ea7STejun Heo per_cpu_ptr(wq->cpu_pwqs, cpu); 38287a62c2c8STejun Heo struct worker_pool *cpu_pools = 3829f02ae73aSTejun Heo per_cpu(cpu_worker_pools, cpu); 383030cdf249STejun Heo 38319e8cd2f5STejun Heo init_and_link_pwq(pwq, wq, &cpu_pools[highpri], NULL); 383230cdf249STejun Heo } 383330cdf249STejun Heo return 0; 38349e8cd2f5STejun Heo } else { 38359e8cd2f5STejun Heo return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]); 38369e8cd2f5STejun Heo } 38370f900049STejun Heo } 38380f900049STejun Heo 3839f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags, 3840f3421797STejun Heo const char *name) 3841b71ab8c2STejun Heo { 3842f3421797STejun Heo int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE; 3843f3421797STejun Heo 3844f3421797STejun Heo if (max_active < 1 || max_active > lim) 3845044c782cSValentin Ilie pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n", 3846f3421797STejun Heo max_active, name, 1, lim); 3847b71ab8c2STejun Heo 3848f3421797STejun Heo return clamp_val(max_active, 1, lim); 3849b71ab8c2STejun Heo } 3850b71ab8c2STejun Heo 3851b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt, 385297e37d7bSTejun Heo unsigned int flags, 38531e19ffc6STejun Heo int max_active, 3854eb13ba87SJohannes Berg struct lock_class_key *key, 3855b196be89STejun Heo const char *lock_name, ...) 38563af24433SOleg Nesterov { 3857b196be89STejun Heo va_list args, args1; 38583af24433SOleg Nesterov struct workqueue_struct *wq; 385949e3cf44STejun Heo struct pool_workqueue *pwq; 3860b196be89STejun Heo size_t namelen; 3861b196be89STejun Heo 3862b196be89STejun Heo /* determine namelen, allocate wq and format name */ 3863b196be89STejun Heo va_start(args, lock_name); 3864b196be89STejun Heo va_copy(args1, args); 3865b196be89STejun Heo namelen = vsnprintf(NULL, 0, fmt, args) + 1; 3866b196be89STejun Heo 3867b196be89STejun Heo wq = kzalloc(sizeof(*wq) + namelen, GFP_KERNEL); 3868b196be89STejun Heo if (!wq) 3869d2c1d404STejun Heo return NULL; 3870b196be89STejun Heo 3871b196be89STejun Heo vsnprintf(wq->name, namelen, fmt, args1); 3872b196be89STejun Heo va_end(args); 3873b196be89STejun Heo va_end(args1); 38743af24433SOleg Nesterov 3875d320c038STejun Heo max_active = max_active ?: WQ_DFL_ACTIVE; 3876b196be89STejun Heo max_active = wq_clamp_max_active(max_active, flags, wq->name); 38773af24433SOleg Nesterov 3878b196be89STejun Heo /* init wq */ 387997e37d7bSTejun Heo wq->flags = flags; 3880a0a1a5fdSTejun Heo wq->saved_max_active = max_active; 388173f53c4aSTejun Heo mutex_init(&wq->flush_mutex); 3882112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 0); 388330cdf249STejun Heo INIT_LIST_HEAD(&wq->pwqs); 388473f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_queue); 388573f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_overflow); 3886493a1724STejun Heo INIT_LIST_HEAD(&wq->maydays); 38873af24433SOleg Nesterov 3888eb13ba87SJohannes Berg lockdep_init_map(&wq->lockdep_map, lock_name, key, 0); 3889cce1a165SOleg Nesterov INIT_LIST_HEAD(&wq->list); 38903af24433SOleg Nesterov 389130cdf249STejun Heo if (alloc_and_link_pwqs(wq) < 0) 3892d2c1d404STejun Heo goto err_free_wq; 38931537663fSTejun Heo 3894493008a8STejun Heo /* 3895493008a8STejun Heo * Workqueues which may be used during memory reclaim should 3896493008a8STejun Heo * have a rescuer to guarantee forward progress. 3897493008a8STejun Heo */ 3898493008a8STejun Heo if (flags & WQ_MEM_RECLAIM) { 3899e22bee78STejun Heo struct worker *rescuer; 3900e22bee78STejun Heo 3901d2c1d404STejun Heo rescuer = alloc_worker(); 3902e22bee78STejun Heo if (!rescuer) 3903d2c1d404STejun Heo goto err_destroy; 3904e22bee78STejun Heo 3905111c225aSTejun Heo rescuer->rescue_wq = wq; 3906111c225aSTejun Heo rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", 3907b196be89STejun Heo wq->name); 3908d2c1d404STejun Heo if (IS_ERR(rescuer->task)) { 3909d2c1d404STejun Heo kfree(rescuer); 3910d2c1d404STejun Heo goto err_destroy; 3911d2c1d404STejun Heo } 3912e22bee78STejun Heo 3913d2c1d404STejun Heo wq->rescuer = rescuer; 391414a40ffcSTejun Heo rescuer->task->flags |= PF_NO_SETAFFINITY; 3915e22bee78STejun Heo wake_up_process(rescuer->task); 39163af24433SOleg Nesterov } 39171537663fSTejun Heo 3918226223abSTejun Heo if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq)) 3919226223abSTejun Heo goto err_destroy; 3920226223abSTejun Heo 39213af24433SOleg Nesterov /* 39225bcab335STejun Heo * wq_mutex protects global freeze state and workqueues list. Grab 39235bcab335STejun Heo * it, adjust max_active and add the new @wq to workqueues list. 39243af24433SOleg Nesterov */ 39255bcab335STejun Heo mutex_lock(&wq_mutex); 3926a0a1a5fdSTejun Heo 3927794b18bcSTejun Heo spin_lock_irq(&pwq_lock); 392849e3cf44STejun Heo for_each_pwq(pwq, wq) 3929699ce097STejun Heo pwq_adjust_max_active(pwq); 3930794b18bcSTejun Heo spin_unlock_irq(&pwq_lock); 3931a0a1a5fdSTejun Heo 39323af24433SOleg Nesterov list_add(&wq->list, &workqueues); 3933a0a1a5fdSTejun Heo 39345bcab335STejun Heo mutex_unlock(&wq_mutex); 39353af24433SOleg Nesterov 39363af24433SOleg Nesterov return wq; 3937d2c1d404STejun Heo 3938d2c1d404STejun Heo err_free_wq: 39394690c4abSTejun Heo kfree(wq); 3940d2c1d404STejun Heo return NULL; 3941d2c1d404STejun Heo err_destroy: 3942d2c1d404STejun Heo destroy_workqueue(wq); 39434690c4abSTejun Heo return NULL; 39441da177e4SLinus Torvalds } 3945d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key); 39461da177e4SLinus Torvalds 39473af24433SOleg Nesterov /** 39483af24433SOleg Nesterov * destroy_workqueue - safely terminate a workqueue 39493af24433SOleg Nesterov * @wq: target workqueue 39503af24433SOleg Nesterov * 39513af24433SOleg Nesterov * Safely destroy a workqueue. All work currently pending will be done first. 39523af24433SOleg Nesterov */ 39533af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq) 39543af24433SOleg Nesterov { 395549e3cf44STejun Heo struct pool_workqueue *pwq; 39563af24433SOleg Nesterov 39579c5a2ba7STejun Heo /* drain it before proceeding with destruction */ 39589c5a2ba7STejun Heo drain_workqueue(wq); 3959c8efcc25STejun Heo 39606183c009STejun Heo /* sanity checks */ 3961794b18bcSTejun Heo spin_lock_irq(&pwq_lock); 396249e3cf44STejun Heo for_each_pwq(pwq, wq) { 39636183c009STejun Heo int i; 39646183c009STejun Heo 396576af4d93STejun Heo for (i = 0; i < WORK_NR_COLORS; i++) { 396676af4d93STejun Heo if (WARN_ON(pwq->nr_in_flight[i])) { 3967794b18bcSTejun Heo spin_unlock_irq(&pwq_lock); 39686183c009STejun Heo return; 396976af4d93STejun Heo } 397076af4d93STejun Heo } 397176af4d93STejun Heo 39728864b4e5STejun Heo if (WARN_ON(pwq->refcnt > 1) || 39738864b4e5STejun Heo WARN_ON(pwq->nr_active) || 397476af4d93STejun Heo WARN_ON(!list_empty(&pwq->delayed_works))) { 3975794b18bcSTejun Heo spin_unlock_irq(&pwq_lock); 39766183c009STejun Heo return; 39776183c009STejun Heo } 397876af4d93STejun Heo } 3979794b18bcSTejun Heo spin_unlock_irq(&pwq_lock); 39806183c009STejun Heo 3981a0a1a5fdSTejun Heo /* 3982a0a1a5fdSTejun Heo * wq list is used to freeze wq, remove from list after 3983a0a1a5fdSTejun Heo * flushing is complete in case freeze races us. 3984a0a1a5fdSTejun Heo */ 39855bcab335STejun Heo mutex_lock(&wq_mutex); 3986d2c1d404STejun Heo list_del_init(&wq->list); 39875bcab335STejun Heo mutex_unlock(&wq_mutex); 39883af24433SOleg Nesterov 3989226223abSTejun Heo workqueue_sysfs_unregister(wq); 3990226223abSTejun Heo 3991493008a8STejun Heo if (wq->rescuer) { 3992e22bee78STejun Heo kthread_stop(wq->rescuer->task); 39938d9df9f0SXiaotian Feng kfree(wq->rescuer); 3994493008a8STejun Heo wq->rescuer = NULL; 3995e22bee78STejun Heo } 3996e22bee78STejun Heo 39978864b4e5STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 399829c91e99STejun Heo /* 39998864b4e5STejun Heo * The base ref is never dropped on per-cpu pwqs. Directly 40008864b4e5STejun Heo * free the pwqs and wq. 400129c91e99STejun Heo */ 40028864b4e5STejun Heo free_percpu(wq->cpu_pwqs); 40038864b4e5STejun Heo kfree(wq); 40048864b4e5STejun Heo } else { 40058864b4e5STejun Heo /* 40068864b4e5STejun Heo * We're the sole accessor of @wq at this point. Directly 40078864b4e5STejun Heo * access the first pwq and put the base ref. As both pwqs 40088864b4e5STejun Heo * and pools are sched-RCU protected, the lock operations 40098864b4e5STejun Heo * are safe. @wq will be freed when the last pwq is 40108864b4e5STejun Heo * released. 40118864b4e5STejun Heo */ 401229c91e99STejun Heo pwq = list_first_entry(&wq->pwqs, struct pool_workqueue, 401329c91e99STejun Heo pwqs_node); 40148864b4e5STejun Heo spin_lock_irq(&pwq->pool->lock); 40158864b4e5STejun Heo put_pwq(pwq); 40168864b4e5STejun Heo spin_unlock_irq(&pwq->pool->lock); 401729c91e99STejun Heo } 40183af24433SOleg Nesterov } 40193af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue); 40203af24433SOleg Nesterov 4021dcd989cbSTejun Heo /** 4022dcd989cbSTejun Heo * workqueue_set_max_active - adjust max_active of a workqueue 4023dcd989cbSTejun Heo * @wq: target workqueue 4024dcd989cbSTejun Heo * @max_active: new max_active value. 4025dcd989cbSTejun Heo * 4026dcd989cbSTejun Heo * Set max_active of @wq to @max_active. 4027dcd989cbSTejun Heo * 4028dcd989cbSTejun Heo * CONTEXT: 4029dcd989cbSTejun Heo * Don't call from IRQ context. 4030dcd989cbSTejun Heo */ 4031dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) 4032dcd989cbSTejun Heo { 403349e3cf44STejun Heo struct pool_workqueue *pwq; 4034dcd989cbSTejun Heo 40358719dceaSTejun Heo /* disallow meddling with max_active for ordered workqueues */ 40368719dceaSTejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED)) 40378719dceaSTejun Heo return; 40388719dceaSTejun Heo 4039f3421797STejun Heo max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); 4040dcd989cbSTejun Heo 4041794b18bcSTejun Heo spin_lock_irq(&pwq_lock); 4042dcd989cbSTejun Heo 4043dcd989cbSTejun Heo wq->saved_max_active = max_active; 4044dcd989cbSTejun Heo 4045699ce097STejun Heo for_each_pwq(pwq, wq) 4046699ce097STejun Heo pwq_adjust_max_active(pwq); 4047dcd989cbSTejun Heo 4048794b18bcSTejun Heo spin_unlock_irq(&pwq_lock); 4049dcd989cbSTejun Heo } 4050dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active); 4051dcd989cbSTejun Heo 4052dcd989cbSTejun Heo /** 4053e6267616STejun Heo * current_is_workqueue_rescuer - is %current workqueue rescuer? 4054e6267616STejun Heo * 4055e6267616STejun Heo * Determine whether %current is a workqueue rescuer. Can be used from 4056e6267616STejun Heo * work functions to determine whether it's being run off the rescuer task. 4057e6267616STejun Heo */ 4058e6267616STejun Heo bool current_is_workqueue_rescuer(void) 4059e6267616STejun Heo { 4060e6267616STejun Heo struct worker *worker = current_wq_worker(); 4061e6267616STejun Heo 4062e6267616STejun Heo return worker && worker == worker->current_pwq->wq->rescuer; 4063e6267616STejun Heo } 4064e6267616STejun Heo 4065e6267616STejun Heo /** 4066dcd989cbSTejun Heo * workqueue_congested - test whether a workqueue is congested 4067dcd989cbSTejun Heo * @cpu: CPU in question 4068dcd989cbSTejun Heo * @wq: target workqueue 4069dcd989cbSTejun Heo * 4070dcd989cbSTejun Heo * Test whether @wq's cpu workqueue for @cpu is congested. There is 4071dcd989cbSTejun Heo * no synchronization around this function and the test result is 4072dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 4073dcd989cbSTejun Heo * 4074dcd989cbSTejun Heo * RETURNS: 4075dcd989cbSTejun Heo * %true if congested, %false otherwise. 4076dcd989cbSTejun Heo */ 4077d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq) 4078dcd989cbSTejun Heo { 40797fb98ea7STejun Heo struct pool_workqueue *pwq; 408076af4d93STejun Heo bool ret; 408176af4d93STejun Heo 408276af4d93STejun Heo preempt_disable(); 40837fb98ea7STejun Heo 40847fb98ea7STejun Heo if (!(wq->flags & WQ_UNBOUND)) 40857fb98ea7STejun Heo pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); 40867fb98ea7STejun Heo else 40877fb98ea7STejun Heo pwq = first_pwq(wq); 4088dcd989cbSTejun Heo 408976af4d93STejun Heo ret = !list_empty(&pwq->delayed_works); 409076af4d93STejun Heo preempt_enable(); 409176af4d93STejun Heo 409276af4d93STejun Heo return ret; 4093dcd989cbSTejun Heo } 4094dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested); 4095dcd989cbSTejun Heo 4096dcd989cbSTejun Heo /** 4097dcd989cbSTejun Heo * work_busy - test whether a work is currently pending or running 4098dcd989cbSTejun Heo * @work: the work to be tested 4099dcd989cbSTejun Heo * 4100dcd989cbSTejun Heo * Test whether @work is currently pending or running. There is no 4101dcd989cbSTejun Heo * synchronization around this function and the test result is 4102dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 4103dcd989cbSTejun Heo * 4104dcd989cbSTejun Heo * RETURNS: 4105dcd989cbSTejun Heo * OR'd bitmask of WORK_BUSY_* bits. 4106dcd989cbSTejun Heo */ 4107dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work) 4108dcd989cbSTejun Heo { 4109fa1b54e6STejun Heo struct worker_pool *pool; 4110dcd989cbSTejun Heo unsigned long flags; 4111dcd989cbSTejun Heo unsigned int ret = 0; 4112dcd989cbSTejun Heo 4113dcd989cbSTejun Heo if (work_pending(work)) 4114dcd989cbSTejun Heo ret |= WORK_BUSY_PENDING; 4115038366c5SLai Jiangshan 4116fa1b54e6STejun Heo local_irq_save(flags); 4117fa1b54e6STejun Heo pool = get_work_pool(work); 4118038366c5SLai Jiangshan if (pool) { 4119fa1b54e6STejun Heo spin_lock(&pool->lock); 4120c9e7cf27STejun Heo if (find_worker_executing_work(pool, work)) 4121dcd989cbSTejun Heo ret |= WORK_BUSY_RUNNING; 4122fa1b54e6STejun Heo spin_unlock(&pool->lock); 4123038366c5SLai Jiangshan } 4124fa1b54e6STejun Heo local_irq_restore(flags); 4125dcd989cbSTejun Heo 4126dcd989cbSTejun Heo return ret; 4127dcd989cbSTejun Heo } 4128dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy); 4129dcd989cbSTejun Heo 4130db7bccf4STejun Heo /* 4131db7bccf4STejun Heo * CPU hotplug. 4132db7bccf4STejun Heo * 4133e22bee78STejun Heo * There are two challenges in supporting CPU hotplug. Firstly, there 4134112202d9STejun Heo * are a lot of assumptions on strong associations among work, pwq and 4135706026c2STejun Heo * pool which make migrating pending and scheduled works very 4136e22bee78STejun Heo * difficult to implement without impacting hot paths. Secondly, 413794cf58bbSTejun Heo * worker pools serve mix of short, long and very long running works making 4138e22bee78STejun Heo * blocked draining impractical. 4139e22bee78STejun Heo * 414024647570STejun Heo * This is solved by allowing the pools to be disassociated from the CPU 4141628c78e7STejun Heo * running as an unbound one and allowing it to be reattached later if the 4142628c78e7STejun Heo * cpu comes back online. 4143db7bccf4STejun Heo */ 4144db7bccf4STejun Heo 4145706026c2STejun Heo static void wq_unbind_fn(struct work_struct *work) 4146db7bccf4STejun Heo { 414738db41d9STejun Heo int cpu = smp_processor_id(); 41484ce62e9eSTejun Heo struct worker_pool *pool; 4149db7bccf4STejun Heo struct worker *worker; 4150db7bccf4STejun Heo int i; 4151db7bccf4STejun Heo 4152f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 41536183c009STejun Heo WARN_ON_ONCE(cpu != smp_processor_id()); 4154db7bccf4STejun Heo 4155bc3a1afcSTejun Heo mutex_lock(&pool->manager_mutex); 415694cf58bbSTejun Heo spin_lock_irq(&pool->lock); 4157e22bee78STejun Heo 4158f2d5a0eeSTejun Heo /* 4159bc3a1afcSTejun Heo * We've blocked all manager operations. Make all workers 416094cf58bbSTejun Heo * unbound and set DISASSOCIATED. Before this, all workers 416194cf58bbSTejun Heo * except for the ones which are still executing works from 416294cf58bbSTejun Heo * before the last CPU down must be on the cpu. After 416394cf58bbSTejun Heo * this, they may become diasporas. 4164f2d5a0eeSTejun Heo */ 41654ce62e9eSTejun Heo list_for_each_entry(worker, &pool->idle_list, entry) 4166403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 4167db7bccf4STejun Heo 4168b67bfe0dSSasha Levin for_each_busy_worker(worker, i, pool) 4169403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 4170db7bccf4STejun Heo 417124647570STejun Heo pool->flags |= POOL_DISASSOCIATED; 4172f2d5a0eeSTejun Heo 417394cf58bbSTejun Heo spin_unlock_irq(&pool->lock); 4174bc3a1afcSTejun Heo mutex_unlock(&pool->manager_mutex); 417594cf58bbSTejun Heo } 4176e22bee78STejun Heo 4177e22bee78STejun Heo /* 4178628c78e7STejun Heo * Call schedule() so that we cross rq->lock and thus can guarantee 4179628c78e7STejun Heo * sched callbacks see the %WORKER_UNBOUND flag. This is necessary 4180628c78e7STejun Heo * as scheduler callbacks may be invoked from other cpus. 4181628c78e7STejun Heo */ 4182628c78e7STejun Heo schedule(); 4183628c78e7STejun Heo 4184628c78e7STejun Heo /* 4185628c78e7STejun Heo * Sched callbacks are disabled now. Zap nr_running. After this, 4186628c78e7STejun Heo * nr_running stays zero and need_more_worker() and keep_working() 418738db41d9STejun Heo * are always true as long as the worklist is not empty. Pools on 418838db41d9STejun Heo * @cpu now behave as unbound (in terms of concurrency management) 418938db41d9STejun Heo * pools which are served by workers tied to the CPU. 4190628c78e7STejun Heo * 4191628c78e7STejun Heo * On return from this function, the current worker would trigger 4192628c78e7STejun Heo * unbound chain execution of pending work items if other workers 4193628c78e7STejun Heo * didn't already. 4194e22bee78STejun Heo */ 4195f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) 4196e19e397aSTejun Heo atomic_set(&pool->nr_running, 0); 4197db7bccf4STejun Heo } 4198db7bccf4STejun Heo 41998db25e78STejun Heo /* 42008db25e78STejun Heo * Workqueues should be brought up before normal priority CPU notifiers. 42018db25e78STejun Heo * This will be registered high priority CPU notifier. 42028db25e78STejun Heo */ 42039fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb, 42041da177e4SLinus Torvalds unsigned long action, 42051da177e4SLinus Torvalds void *hcpu) 42061da177e4SLinus Torvalds { 4207d84ff051STejun Heo int cpu = (unsigned long)hcpu; 42084ce62e9eSTejun Heo struct worker_pool *pool; 42091da177e4SLinus Torvalds 42108db25e78STejun Heo switch (action & ~CPU_TASKS_FROZEN) { 42113af24433SOleg Nesterov case CPU_UP_PREPARE: 4212f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 42133ce63377STejun Heo if (pool->nr_workers) 42143ce63377STejun Heo continue; 4215ebf44d16STejun Heo if (create_and_start_worker(pool) < 0) 42163ce63377STejun Heo return NOTIFY_BAD; 42173af24433SOleg Nesterov } 42181da177e4SLinus Torvalds break; 42191da177e4SLinus Torvalds 422065758202STejun Heo case CPU_DOWN_FAILED: 422165758202STejun Heo case CPU_ONLINE: 4222f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 4223bc3a1afcSTejun Heo mutex_lock(&pool->manager_mutex); 422494cf58bbSTejun Heo spin_lock_irq(&pool->lock); 422594cf58bbSTejun Heo 422624647570STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 422794cf58bbSTejun Heo rebind_workers(pool); 422894cf58bbSTejun Heo 422994cf58bbSTejun Heo spin_unlock_irq(&pool->lock); 4230bc3a1afcSTejun Heo mutex_unlock(&pool->manager_mutex); 423194cf58bbSTejun Heo } 42328db25e78STejun Heo break; 423365758202STejun Heo } 423465758202STejun Heo return NOTIFY_OK; 423565758202STejun Heo } 423665758202STejun Heo 423765758202STejun Heo /* 423865758202STejun Heo * Workqueues should be brought down after normal priority CPU notifiers. 423965758202STejun Heo * This will be registered as low priority CPU notifier. 424065758202STejun Heo */ 42419fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb, 424265758202STejun Heo unsigned long action, 424365758202STejun Heo void *hcpu) 424465758202STejun Heo { 4245d84ff051STejun Heo int cpu = (unsigned long)hcpu; 42468db25e78STejun Heo struct work_struct unbind_work; 42478db25e78STejun Heo 424865758202STejun Heo switch (action & ~CPU_TASKS_FROZEN) { 424965758202STejun Heo case CPU_DOWN_PREPARE: 42508db25e78STejun Heo /* unbinding should happen on the local CPU */ 4251706026c2STejun Heo INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn); 42527635d2fdSJoonsoo Kim queue_work_on(cpu, system_highpri_wq, &unbind_work); 42538db25e78STejun Heo flush_work(&unbind_work); 42548db25e78STejun Heo break; 425565758202STejun Heo } 425665758202STejun Heo return NOTIFY_OK; 425765758202STejun Heo } 425865758202STejun Heo 42592d3854a3SRusty Russell #ifdef CONFIG_SMP 42608ccad40dSRusty Russell 42612d3854a3SRusty Russell struct work_for_cpu { 4262ed48ece2STejun Heo struct work_struct work; 42632d3854a3SRusty Russell long (*fn)(void *); 42642d3854a3SRusty Russell void *arg; 42652d3854a3SRusty Russell long ret; 42662d3854a3SRusty Russell }; 42672d3854a3SRusty Russell 4268ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work) 42692d3854a3SRusty Russell { 4270ed48ece2STejun Heo struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work); 4271ed48ece2STejun Heo 42722d3854a3SRusty Russell wfc->ret = wfc->fn(wfc->arg); 42732d3854a3SRusty Russell } 42742d3854a3SRusty Russell 42752d3854a3SRusty Russell /** 42762d3854a3SRusty Russell * work_on_cpu - run a function in user context on a particular cpu 42772d3854a3SRusty Russell * @cpu: the cpu to run on 42782d3854a3SRusty Russell * @fn: the function to run 42792d3854a3SRusty Russell * @arg: the function arg 42802d3854a3SRusty Russell * 428131ad9081SRusty Russell * This will return the value @fn returns. 428231ad9081SRusty Russell * It is up to the caller to ensure that the cpu doesn't go offline. 42836b44003eSAndrew Morton * The caller must not hold any locks which would prevent @fn from completing. 42842d3854a3SRusty Russell */ 4285d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg) 42862d3854a3SRusty Russell { 4287ed48ece2STejun Heo struct work_for_cpu wfc = { .fn = fn, .arg = arg }; 42882d3854a3SRusty Russell 4289ed48ece2STejun Heo INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn); 4290ed48ece2STejun Heo schedule_work_on(cpu, &wfc.work); 4291ed48ece2STejun Heo flush_work(&wfc.work); 42922d3854a3SRusty Russell return wfc.ret; 42932d3854a3SRusty Russell } 42942d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu); 42952d3854a3SRusty Russell #endif /* CONFIG_SMP */ 42962d3854a3SRusty Russell 4297a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 4298e7577c50SRusty Russell 4299a0a1a5fdSTejun Heo /** 4300a0a1a5fdSTejun Heo * freeze_workqueues_begin - begin freezing workqueues 4301a0a1a5fdSTejun Heo * 430258a69cb4STejun Heo * Start freezing workqueues. After this function returns, all freezable 4303c5aa87bbSTejun Heo * workqueues will queue new works to their delayed_works list instead of 4304706026c2STejun Heo * pool->worklist. 4305a0a1a5fdSTejun Heo * 4306a0a1a5fdSTejun Heo * CONTEXT: 4307794b18bcSTejun Heo * Grabs and releases wq_mutex, pwq_lock and pool->lock's. 4308a0a1a5fdSTejun Heo */ 4309a0a1a5fdSTejun Heo void freeze_workqueues_begin(void) 4310a0a1a5fdSTejun Heo { 431117116969STejun Heo struct worker_pool *pool; 431224b8a847STejun Heo struct workqueue_struct *wq; 431324b8a847STejun Heo struct pool_workqueue *pwq; 4314611c92a0STejun Heo int pi; 4315a0a1a5fdSTejun Heo 43165bcab335STejun Heo mutex_lock(&wq_mutex); 4317a0a1a5fdSTejun Heo 43186183c009STejun Heo WARN_ON_ONCE(workqueue_freezing); 4319a0a1a5fdSTejun Heo workqueue_freezing = true; 4320a0a1a5fdSTejun Heo 432124b8a847STejun Heo /* set FREEZING */ 4322611c92a0STejun Heo for_each_pool(pool, pi) { 43235bcab335STejun Heo spin_lock_irq(&pool->lock); 432435b6bb63STejun Heo WARN_ON_ONCE(pool->flags & POOL_FREEZING); 432535b6bb63STejun Heo pool->flags |= POOL_FREEZING; 43265bcab335STejun Heo spin_unlock_irq(&pool->lock); 43271da177e4SLinus Torvalds } 43288b03ae3cSTejun Heo 432924b8a847STejun Heo /* suppress further executions by setting max_active to zero */ 4330794b18bcSTejun Heo spin_lock_irq(&pwq_lock); 433124b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 4332699ce097STejun Heo for_each_pwq(pwq, wq) 4333699ce097STejun Heo pwq_adjust_max_active(pwq); 4334a1056305STejun Heo } 4335794b18bcSTejun Heo spin_unlock_irq(&pwq_lock); 43365bcab335STejun Heo 43375bcab335STejun Heo mutex_unlock(&wq_mutex); 4338a0a1a5fdSTejun Heo } 4339a0a1a5fdSTejun Heo 4340a0a1a5fdSTejun Heo /** 434158a69cb4STejun Heo * freeze_workqueues_busy - are freezable workqueues still busy? 4342a0a1a5fdSTejun Heo * 4343a0a1a5fdSTejun Heo * Check whether freezing is complete. This function must be called 4344a0a1a5fdSTejun Heo * between freeze_workqueues_begin() and thaw_workqueues(). 4345a0a1a5fdSTejun Heo * 4346a0a1a5fdSTejun Heo * CONTEXT: 43475bcab335STejun Heo * Grabs and releases wq_mutex. 4348a0a1a5fdSTejun Heo * 4349a0a1a5fdSTejun Heo * RETURNS: 435058a69cb4STejun Heo * %true if some freezable workqueues are still busy. %false if freezing 435158a69cb4STejun Heo * is complete. 4352a0a1a5fdSTejun Heo */ 4353a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void) 4354a0a1a5fdSTejun Heo { 4355a0a1a5fdSTejun Heo bool busy = false; 435624b8a847STejun Heo struct workqueue_struct *wq; 435724b8a847STejun Heo struct pool_workqueue *pwq; 4358a0a1a5fdSTejun Heo 43595bcab335STejun Heo mutex_lock(&wq_mutex); 4360a0a1a5fdSTejun Heo 43616183c009STejun Heo WARN_ON_ONCE(!workqueue_freezing); 4362a0a1a5fdSTejun Heo 436324b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 436424b8a847STejun Heo if (!(wq->flags & WQ_FREEZABLE)) 436524b8a847STejun Heo continue; 4366a0a1a5fdSTejun Heo /* 4367a0a1a5fdSTejun Heo * nr_active is monotonically decreasing. It's safe 4368a0a1a5fdSTejun Heo * to peek without lock. 4369a0a1a5fdSTejun Heo */ 43705bcab335STejun Heo preempt_disable(); 437124b8a847STejun Heo for_each_pwq(pwq, wq) { 43726183c009STejun Heo WARN_ON_ONCE(pwq->nr_active < 0); 4373112202d9STejun Heo if (pwq->nr_active) { 4374a0a1a5fdSTejun Heo busy = true; 43755bcab335STejun Heo preempt_enable(); 4376a0a1a5fdSTejun Heo goto out_unlock; 4377a0a1a5fdSTejun Heo } 4378a0a1a5fdSTejun Heo } 43795bcab335STejun Heo preempt_enable(); 4380a0a1a5fdSTejun Heo } 4381a0a1a5fdSTejun Heo out_unlock: 43825bcab335STejun Heo mutex_unlock(&wq_mutex); 4383a0a1a5fdSTejun Heo return busy; 4384a0a1a5fdSTejun Heo } 4385a0a1a5fdSTejun Heo 4386a0a1a5fdSTejun Heo /** 4387a0a1a5fdSTejun Heo * thaw_workqueues - thaw workqueues 4388a0a1a5fdSTejun Heo * 4389a0a1a5fdSTejun Heo * Thaw workqueues. Normal queueing is restored and all collected 4390706026c2STejun Heo * frozen works are transferred to their respective pool worklists. 4391a0a1a5fdSTejun Heo * 4392a0a1a5fdSTejun Heo * CONTEXT: 4393794b18bcSTejun Heo * Grabs and releases wq_mutex, pwq_lock and pool->lock's. 4394a0a1a5fdSTejun Heo */ 4395a0a1a5fdSTejun Heo void thaw_workqueues(void) 4396a0a1a5fdSTejun Heo { 439724b8a847STejun Heo struct workqueue_struct *wq; 439824b8a847STejun Heo struct pool_workqueue *pwq; 439924b8a847STejun Heo struct worker_pool *pool; 4400611c92a0STejun Heo int pi; 4401a0a1a5fdSTejun Heo 44025bcab335STejun Heo mutex_lock(&wq_mutex); 4403a0a1a5fdSTejun Heo 4404a0a1a5fdSTejun Heo if (!workqueue_freezing) 4405a0a1a5fdSTejun Heo goto out_unlock; 4406a0a1a5fdSTejun Heo 440724b8a847STejun Heo /* clear FREEZING */ 4408611c92a0STejun Heo for_each_pool(pool, pi) { 44095bcab335STejun Heo spin_lock_irq(&pool->lock); 441035b6bb63STejun Heo WARN_ON_ONCE(!(pool->flags & POOL_FREEZING)); 441135b6bb63STejun Heo pool->flags &= ~POOL_FREEZING; 44125bcab335STejun Heo spin_unlock_irq(&pool->lock); 4413d565ed63STejun Heo } 441424b8a847STejun Heo 441524b8a847STejun Heo /* restore max_active and repopulate worklist */ 4416794b18bcSTejun Heo spin_lock_irq(&pwq_lock); 441724b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 4418699ce097STejun Heo for_each_pwq(pwq, wq) 4419699ce097STejun Heo pwq_adjust_max_active(pwq); 442024b8a847STejun Heo } 4421794b18bcSTejun Heo spin_unlock_irq(&pwq_lock); 442224b8a847STejun Heo 442324b8a847STejun Heo /* kick workers */ 4424611c92a0STejun Heo for_each_pool(pool, pi) { 44255bcab335STejun Heo spin_lock_irq(&pool->lock); 442624b8a847STejun Heo wake_up_worker(pool); 44275bcab335STejun Heo spin_unlock_irq(&pool->lock); 4428a0a1a5fdSTejun Heo } 4429a0a1a5fdSTejun Heo 4430a0a1a5fdSTejun Heo workqueue_freezing = false; 4431a0a1a5fdSTejun Heo out_unlock: 44325bcab335STejun Heo mutex_unlock(&wq_mutex); 4433a0a1a5fdSTejun Heo } 4434a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 4435a0a1a5fdSTejun Heo 44366ee0578bSSuresh Siddha static int __init init_workqueues(void) 44371da177e4SLinus Torvalds { 44387a4e344cSTejun Heo int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL }; 44397a4e344cSTejun Heo int i, cpu; 4440c34056a3STejun Heo 44417c3eed5cSTejun Heo /* make sure we have enough bits for OFFQ pool ID */ 44427c3eed5cSTejun Heo BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT)) < 44436be19588SLai Jiangshan WORK_CPU_END * NR_STD_WORKER_POOLS); 4444b5490077STejun Heo 4445e904e6c2STejun Heo WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long)); 4446e904e6c2STejun Heo 4447e904e6c2STejun Heo pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC); 4448e904e6c2STejun Heo 444965758202STejun Heo cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP); 4450a5b4e57dSLai Jiangshan hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN); 44518b03ae3cSTejun Heo 4452706026c2STejun Heo /* initialize CPU pools */ 445329c91e99STejun Heo for_each_possible_cpu(cpu) { 44544ce62e9eSTejun Heo struct worker_pool *pool; 44558b03ae3cSTejun Heo 44567a4e344cSTejun Heo i = 0; 4457f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 44587a4e344cSTejun Heo BUG_ON(init_worker_pool(pool)); 4459ec22ca5eSTejun Heo pool->cpu = cpu; 44607a4e344cSTejun Heo cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu)); 44617a4e344cSTejun Heo pool->attrs->nice = std_nice[i++]; 44627a4e344cSTejun Heo 44639daf9e67STejun Heo /* alloc pool ID */ 44645bcab335STejun Heo mutex_lock(&wq_mutex); 44659daf9e67STejun Heo BUG_ON(worker_pool_assign_id(pool)); 44665bcab335STejun Heo mutex_unlock(&wq_mutex); 44674ce62e9eSTejun Heo } 44688b03ae3cSTejun Heo } 44698b03ae3cSTejun Heo 4470e22bee78STejun Heo /* create the initial worker */ 447129c91e99STejun Heo for_each_online_cpu(cpu) { 44724ce62e9eSTejun Heo struct worker_pool *pool; 4473e22bee78STejun Heo 4474f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 447524647570STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 4476ebf44d16STejun Heo BUG_ON(create_and_start_worker(pool) < 0); 4477e22bee78STejun Heo } 44784ce62e9eSTejun Heo } 4479e22bee78STejun Heo 448029c91e99STejun Heo /* create default unbound wq attrs */ 448129c91e99STejun Heo for (i = 0; i < NR_STD_WORKER_POOLS; i++) { 448229c91e99STejun Heo struct workqueue_attrs *attrs; 448329c91e99STejun Heo 448429c91e99STejun Heo BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL))); 448529c91e99STejun Heo 448629c91e99STejun Heo attrs->nice = std_nice[i]; 448729c91e99STejun Heo cpumask_setall(attrs->cpumask); 448829c91e99STejun Heo 448929c91e99STejun Heo unbound_std_wq_attrs[i] = attrs; 449029c91e99STejun Heo } 449129c91e99STejun Heo 4492d320c038STejun Heo system_wq = alloc_workqueue("events", 0, 0); 44931aabe902SJoonsoo Kim system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0); 4494d320c038STejun Heo system_long_wq = alloc_workqueue("events_long", 0, 0); 4495f3421797STejun Heo system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, 4496f3421797STejun Heo WQ_UNBOUND_MAX_ACTIVE); 449724d51addSTejun Heo system_freezable_wq = alloc_workqueue("events_freezable", 449824d51addSTejun Heo WQ_FREEZABLE, 0); 44991aabe902SJoonsoo Kim BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq || 4500ae930e0fSTejun Heo !system_unbound_wq || !system_freezable_wq); 45016ee0578bSSuresh Siddha return 0; 45021da177e4SLinus Torvalds } 45036ee0578bSSuresh Siddha early_initcall(init_workqueues); 4504