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> 47bce90380STejun Heo #include <linux/nodemask.h> 484c16bd32STejun Heo #include <linux/moduleparam.h> 49e22bee78STejun Heo 50ea138446STejun Heo #include "workqueue_internal.h" 511da177e4SLinus Torvalds 52c8e55f36STejun Heo enum { 53bc2ae0f5STejun Heo /* 5424647570STejun Heo * worker_pool flags 55bc2ae0f5STejun Heo * 5624647570STejun Heo * A bound pool is either associated or disassociated with its CPU. 57bc2ae0f5STejun Heo * While associated (!DISASSOCIATED), all workers are bound to the 58bc2ae0f5STejun Heo * CPU and none has %WORKER_UNBOUND set and concurrency management 59bc2ae0f5STejun Heo * is in effect. 60bc2ae0f5STejun Heo * 61bc2ae0f5STejun Heo * While DISASSOCIATED, the cpu may be offline and all workers have 62bc2ae0f5STejun Heo * %WORKER_UNBOUND set and concurrency management disabled, and may 6324647570STejun Heo * be executing on any CPU. The pool behaves as an unbound one. 64bc2ae0f5STejun Heo * 65bc3a1afcSTejun Heo * Note that DISASSOCIATED should be flipped only while holding 66bc3a1afcSTejun Heo * manager_mutex to avoid changing binding state while 6724647570STejun Heo * create_worker() is in progress. 68bc2ae0f5STejun Heo */ 6911ebea50STejun Heo POOL_MANAGE_WORKERS = 1 << 0, /* need to manage workers */ 7024647570STejun Heo POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */ 7135b6bb63STejun Heo POOL_FREEZING = 1 << 3, /* freeze in progress */ 72db7bccf4STejun Heo 73c8e55f36STejun Heo /* worker flags */ 74c8e55f36STejun Heo WORKER_STARTED = 1 << 0, /* started */ 75c8e55f36STejun Heo WORKER_DIE = 1 << 1, /* die die die */ 76c8e55f36STejun Heo WORKER_IDLE = 1 << 2, /* is idle */ 77e22bee78STejun Heo WORKER_PREP = 1 << 3, /* preparing to run works */ 78fb0e7bebSTejun Heo WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */ 79f3421797STejun Heo WORKER_UNBOUND = 1 << 7, /* worker is unbound */ 80a9ab775bSTejun Heo WORKER_REBOUND = 1 << 8, /* worker was rebound */ 81e22bee78STejun Heo 82a9ab775bSTejun Heo WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE | 83a9ab775bSTejun Heo WORKER_UNBOUND | WORKER_REBOUND, 84db7bccf4STejun Heo 85e34cdddbSTejun Heo NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */ 864ce62e9eSTejun Heo 8729c91e99STejun Heo UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */ 88c8e55f36STejun Heo BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */ 89db7bccf4STejun Heo 90e22bee78STejun Heo MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */ 91e22bee78STejun Heo IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */ 92e22bee78STejun Heo 933233cdbdSTejun Heo MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2, 943233cdbdSTejun Heo /* call for help after 10ms 953233cdbdSTejun Heo (min two ticks) */ 96e22bee78STejun Heo MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */ 97e22bee78STejun Heo CREATE_COOLDOWN = HZ, /* time to breath after fail */ 981da177e4SLinus Torvalds 991da177e4SLinus Torvalds /* 100e22bee78STejun Heo * Rescue workers are used only on emergencies and shared by 101e22bee78STejun Heo * all cpus. Give -20. 102e22bee78STejun Heo */ 103e22bee78STejun Heo RESCUER_NICE_LEVEL = -20, 1043270476aSTejun Heo HIGHPRI_NICE_LEVEL = -20, 105ecf6881fSTejun Heo 106ecf6881fSTejun Heo WQ_NAME_LEN = 24, 107c8e55f36STejun Heo }; 108c8e55f36STejun Heo 1091da177e4SLinus Torvalds /* 1104690c4abSTejun Heo * Structure fields follow one of the following exclusion rules. 1114690c4abSTejun Heo * 112e41e704bSTejun Heo * I: Modifiable by initialization/destruction paths and read-only for 113e41e704bSTejun Heo * everyone else. 1144690c4abSTejun Heo * 115e22bee78STejun Heo * P: Preemption protected. Disabling preemption is enough and should 116e22bee78STejun Heo * only be modified and accessed from the local cpu. 117e22bee78STejun Heo * 118d565ed63STejun Heo * L: pool->lock protected. Access with pool->lock held. 1194690c4abSTejun Heo * 120d565ed63STejun Heo * X: During normal operation, modification requires pool->lock and should 121d565ed63STejun Heo * be done only from local cpu. Either disabling preemption on local 122d565ed63STejun Heo * cpu or grabbing pool->lock is enough for read access. If 123d565ed63STejun Heo * POOL_DISASSOCIATED is set, it's identical to L. 124e22bee78STejun Heo * 125822d8405STejun Heo * MG: pool->manager_mutex and pool->lock protected. Writes require both 126822d8405STejun Heo * locks. Reads can happen under either lock. 127822d8405STejun Heo * 12868e13a67SLai Jiangshan * PL: wq_pool_mutex protected. 12976af4d93STejun Heo * 13068e13a67SLai Jiangshan * PR: wq_pool_mutex protected for writes. Sched-RCU protected for reads. 1315bcab335STejun Heo * 1323c25a55dSLai Jiangshan * WQ: wq->mutex protected. 1333c25a55dSLai Jiangshan * 134b5927605SLai Jiangshan * WR: wq->mutex protected for writes. Sched-RCU protected for reads. 1352e109a28STejun Heo * 1362e109a28STejun Heo * MD: wq_mayday_lock protected. 1374690c4abSTejun Heo */ 1384690c4abSTejun Heo 1392eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */ 140c34056a3STejun Heo 141bd7bdd43STejun Heo struct worker_pool { 142d565ed63STejun Heo spinlock_t lock; /* the pool lock */ 143d84ff051STejun Heo int cpu; /* I: the associated cpu */ 144f3f90ad4STejun Heo int node; /* I: the associated node ID */ 1459daf9e67STejun Heo int id; /* I: pool ID */ 14611ebea50STejun Heo unsigned int flags; /* X: flags */ 147bd7bdd43STejun Heo 148bd7bdd43STejun Heo struct list_head worklist; /* L: list of pending works */ 149bd7bdd43STejun Heo int nr_workers; /* L: total number of workers */ 150ea1abd61SLai Jiangshan 151ea1abd61SLai Jiangshan /* nr_idle includes the ones off idle_list for rebinding */ 152bd7bdd43STejun Heo int nr_idle; /* L: currently idle ones */ 153bd7bdd43STejun Heo 154bd7bdd43STejun Heo struct list_head idle_list; /* X: list of idle workers */ 155bd7bdd43STejun Heo struct timer_list idle_timer; /* L: worker idle timeout */ 156bd7bdd43STejun Heo struct timer_list mayday_timer; /* L: SOS timer for workers */ 157bd7bdd43STejun Heo 158c5aa87bbSTejun Heo /* a workers is either on busy_hash or idle_list, or the manager */ 159c9e7cf27STejun Heo DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER); 160c9e7cf27STejun Heo /* L: hash of busy workers */ 161c9e7cf27STejun Heo 162bc3a1afcSTejun Heo /* see manage_workers() for details on the two manager mutexes */ 16334a06bd6STejun Heo struct mutex manager_arb; /* manager arbitration */ 164bc3a1afcSTejun Heo struct mutex manager_mutex; /* manager exclusion */ 165822d8405STejun Heo struct idr worker_idr; /* MG: worker IDs and iteration */ 166e19e397aSTejun Heo 1677a4e344cSTejun Heo struct workqueue_attrs *attrs; /* I: worker attributes */ 16868e13a67SLai Jiangshan struct hlist_node hash_node; /* PL: unbound_pool_hash node */ 16968e13a67SLai Jiangshan int refcnt; /* PL: refcnt for unbound pools */ 1707a4e344cSTejun Heo 171e19e397aSTejun Heo /* 172e19e397aSTejun Heo * The current concurrency level. As it's likely to be accessed 173e19e397aSTejun Heo * from other CPUs during try_to_wake_up(), put it in a separate 174e19e397aSTejun Heo * cacheline. 175e19e397aSTejun Heo */ 176e19e397aSTejun Heo atomic_t nr_running ____cacheline_aligned_in_smp; 17729c91e99STejun Heo 17829c91e99STejun Heo /* 17929c91e99STejun Heo * Destruction of pool is sched-RCU protected to allow dereferences 18029c91e99STejun Heo * from get_work_pool(). 18129c91e99STejun Heo */ 18229c91e99STejun Heo struct rcu_head rcu; 1838b03ae3cSTejun Heo } ____cacheline_aligned_in_smp; 1848b03ae3cSTejun Heo 1858b03ae3cSTejun Heo /* 186112202d9STejun Heo * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS 187112202d9STejun Heo * of work_struct->data are used for flags and the remaining high bits 188112202d9STejun Heo * point to the pwq; thus, pwqs need to be aligned at two's power of the 189112202d9STejun Heo * number of flag bits. 1901da177e4SLinus Torvalds */ 191112202d9STejun Heo struct pool_workqueue { 192bd7bdd43STejun Heo struct worker_pool *pool; /* I: the associated pool */ 1934690c4abSTejun Heo struct workqueue_struct *wq; /* I: the owning workqueue */ 19473f53c4aSTejun Heo int work_color; /* L: current color */ 19573f53c4aSTejun Heo int flush_color; /* L: flushing color */ 1968864b4e5STejun Heo int refcnt; /* L: reference count */ 19773f53c4aSTejun Heo int nr_in_flight[WORK_NR_COLORS]; 19873f53c4aSTejun Heo /* L: nr of in_flight works */ 1991e19ffc6STejun Heo int nr_active; /* L: nr of active works */ 200a0a1a5fdSTejun Heo int max_active; /* L: max active works */ 2011e19ffc6STejun Heo struct list_head delayed_works; /* L: delayed works */ 2023c25a55dSLai Jiangshan struct list_head pwqs_node; /* WR: node on wq->pwqs */ 2032e109a28STejun Heo struct list_head mayday_node; /* MD: node on wq->maydays */ 2048864b4e5STejun Heo 2058864b4e5STejun Heo /* 2068864b4e5STejun Heo * Release of unbound pwq is punted to system_wq. See put_pwq() 2078864b4e5STejun Heo * and pwq_unbound_release_workfn() for details. pool_workqueue 2088864b4e5STejun Heo * itself is also sched-RCU protected so that the first pwq can be 209b09f4fd3SLai Jiangshan * determined without grabbing wq->mutex. 2108864b4e5STejun Heo */ 2118864b4e5STejun Heo struct work_struct unbound_release_work; 2128864b4e5STejun Heo struct rcu_head rcu; 213e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS); 2141da177e4SLinus Torvalds 2151da177e4SLinus Torvalds /* 21673f53c4aSTejun Heo * Structure used to wait for workqueue flush. 21773f53c4aSTejun Heo */ 21873f53c4aSTejun Heo struct wq_flusher { 2193c25a55dSLai Jiangshan struct list_head list; /* WQ: list of flushers */ 2203c25a55dSLai Jiangshan int flush_color; /* WQ: flush color waiting for */ 22173f53c4aSTejun Heo struct completion done; /* flush completion */ 22273f53c4aSTejun Heo }; 2231da177e4SLinus Torvalds 224226223abSTejun Heo struct wq_device; 225226223abSTejun Heo 22673f53c4aSTejun Heo /* 227c5aa87bbSTejun Heo * The externally visible workqueue. It relays the issued work items to 228c5aa87bbSTejun Heo * the appropriate worker_pool through its pool_workqueues. 2291da177e4SLinus Torvalds */ 2301da177e4SLinus Torvalds struct workqueue_struct { 2313c25a55dSLai Jiangshan struct list_head pwqs; /* WR: all pwqs of this wq */ 23268e13a67SLai Jiangshan struct list_head list; /* PL: list of all workqueues */ 23373f53c4aSTejun Heo 2343c25a55dSLai Jiangshan struct mutex mutex; /* protects this wq */ 2353c25a55dSLai Jiangshan int work_color; /* WQ: current work color */ 2363c25a55dSLai Jiangshan int flush_color; /* WQ: current flush color */ 237112202d9STejun Heo atomic_t nr_pwqs_to_flush; /* flush in progress */ 2383c25a55dSLai Jiangshan struct wq_flusher *first_flusher; /* WQ: first flusher */ 2393c25a55dSLai Jiangshan struct list_head flusher_queue; /* WQ: flush waiters */ 2403c25a55dSLai Jiangshan struct list_head flusher_overflow; /* WQ: flush overflow list */ 24173f53c4aSTejun Heo 2422e109a28STejun Heo struct list_head maydays; /* MD: pwqs requesting rescue */ 243e22bee78STejun Heo struct worker *rescuer; /* I: rescue worker */ 244e22bee78STejun Heo 24587fc741eSLai Jiangshan int nr_drainers; /* WQ: drain in progress */ 246a357fc03SLai Jiangshan int saved_max_active; /* WQ: saved pwq max_active */ 247226223abSTejun Heo 2486029a918STejun Heo struct workqueue_attrs *unbound_attrs; /* WQ: only for unbound wqs */ 2494c16bd32STejun Heo struct pool_workqueue *dfl_pwq; /* WQ: only for unbound wqs */ 2506029a918STejun Heo 251226223abSTejun Heo #ifdef CONFIG_SYSFS 252226223abSTejun Heo struct wq_device *wq_dev; /* I: for sysfs interface */ 253226223abSTejun Heo #endif 2544e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 2554e6045f1SJohannes Berg struct lockdep_map lockdep_map; 2564e6045f1SJohannes Berg #endif 257ecf6881fSTejun Heo char name[WQ_NAME_LEN]; /* I: workqueue name */ 2582728fd2fSTejun Heo 2592728fd2fSTejun Heo /* hot fields used during command issue, aligned to cacheline */ 2602728fd2fSTejun Heo unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */ 2612728fd2fSTejun Heo struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */ 262df2d5ae4STejun Heo struct pool_workqueue __rcu *numa_pwq_tbl[]; /* FR: unbound pwqs indexed by node */ 2631da177e4SLinus Torvalds }; 2641da177e4SLinus Torvalds 265e904e6c2STejun Heo static struct kmem_cache *pwq_cache; 266e904e6c2STejun Heo 267bce90380STejun Heo static int wq_numa_tbl_len; /* highest possible NUMA node id + 1 */ 268bce90380STejun Heo static cpumask_var_t *wq_numa_possible_cpumask; 269bce90380STejun Heo /* possible CPUs of each node */ 270bce90380STejun Heo 271d55262c4STejun Heo static bool wq_disable_numa; 272d55262c4STejun Heo module_param_named(disable_numa, wq_disable_numa, bool, 0444); 273d55262c4STejun Heo 274bce90380STejun Heo static bool wq_numa_enabled; /* unbound NUMA affinity enabled */ 275bce90380STejun Heo 2764c16bd32STejun Heo /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */ 2774c16bd32STejun Heo static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf; 2784c16bd32STejun Heo 27968e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */ 2802e109a28STejun Heo static DEFINE_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */ 2815bcab335STejun Heo 28268e13a67SLai Jiangshan static LIST_HEAD(workqueues); /* PL: list of all workqueues */ 28368e13a67SLai Jiangshan static bool workqueue_freezing; /* PL: have wqs started freezing? */ 2847d19c5ceSTejun Heo 2857d19c5ceSTejun Heo /* the per-cpu worker pools */ 2867d19c5ceSTejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], 2877d19c5ceSTejun Heo cpu_worker_pools); 2887d19c5ceSTejun Heo 28968e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */ 2907d19c5ceSTejun Heo 29168e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */ 29229c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER); 29329c91e99STejun Heo 294c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */ 29529c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS]; 29629c91e99STejun Heo 297d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly; 298d320c038STejun Heo EXPORT_SYMBOL_GPL(system_wq); 299044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly; 3001aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq); 301044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly; 302d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq); 303044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly; 304f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq); 305044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly; 30624d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq); 307d320c038STejun Heo 3087d19c5ceSTejun Heo static int worker_thread(void *__worker); 3097d19c5ceSTejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to, 3107d19c5ceSTejun Heo const struct workqueue_attrs *from); 3117d19c5ceSTejun Heo 31297bd2347STejun Heo #define CREATE_TRACE_POINTS 31397bd2347STejun Heo #include <trace/events/workqueue.h> 31497bd2347STejun Heo 31568e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex() \ 3165bcab335STejun Heo rcu_lockdep_assert(rcu_read_lock_sched_held() || \ 31768e13a67SLai Jiangshan lockdep_is_held(&wq_pool_mutex), \ 31868e13a67SLai Jiangshan "sched RCU or wq_pool_mutex should be held") 3195bcab335STejun Heo 320b09f4fd3SLai Jiangshan #define assert_rcu_or_wq_mutex(wq) \ 32176af4d93STejun Heo rcu_lockdep_assert(rcu_read_lock_sched_held() || \ 322b5927605SLai Jiangshan lockdep_is_held(&wq->mutex), \ 323b09f4fd3SLai Jiangshan "sched RCU or wq->mutex should be held") 32476af4d93STejun Heo 325822d8405STejun Heo #ifdef CONFIG_LOCKDEP 326822d8405STejun Heo #define assert_manager_or_pool_lock(pool) \ 327519e3c11SLai Jiangshan WARN_ONCE(debug_locks && \ 328519e3c11SLai Jiangshan !lockdep_is_held(&(pool)->manager_mutex) && \ 329822d8405STejun Heo !lockdep_is_held(&(pool)->lock), \ 330822d8405STejun Heo "pool->manager_mutex or ->lock should be held") 331822d8405STejun Heo #else 332822d8405STejun Heo #define assert_manager_or_pool_lock(pool) do { } while (0) 333822d8405STejun Heo #endif 334822d8405STejun Heo 335f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu) \ 336f02ae73aSTejun Heo for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \ 337f02ae73aSTejun Heo (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \ 3387a62c2c8STejun Heo (pool)++) 3394ce62e9eSTejun Heo 34049e3cf44STejun Heo /** 34117116969STejun Heo * for_each_pool - iterate through all worker_pools in the system 34217116969STejun Heo * @pool: iteration cursor 343611c92a0STejun Heo * @pi: integer used for iteration 344fa1b54e6STejun Heo * 34568e13a67SLai Jiangshan * This must be called either with wq_pool_mutex held or sched RCU read 34668e13a67SLai Jiangshan * locked. If the pool needs to be used beyond the locking in effect, the 34768e13a67SLai Jiangshan * caller is responsible for guaranteeing that the pool stays online. 348fa1b54e6STejun Heo * 349fa1b54e6STejun Heo * The if/else clause exists only for the lockdep assertion and can be 350fa1b54e6STejun Heo * ignored. 35117116969STejun Heo */ 352611c92a0STejun Heo #define for_each_pool(pool, pi) \ 353611c92a0STejun Heo idr_for_each_entry(&worker_pool_idr, pool, pi) \ 35468e13a67SLai Jiangshan if (({ assert_rcu_or_pool_mutex(); false; })) { } \ 355fa1b54e6STejun Heo else 35617116969STejun Heo 35717116969STejun Heo /** 358822d8405STejun Heo * for_each_pool_worker - iterate through all workers of a worker_pool 359822d8405STejun Heo * @worker: iteration cursor 360822d8405STejun Heo * @wi: integer used for iteration 361822d8405STejun Heo * @pool: worker_pool to iterate workers of 362822d8405STejun Heo * 363822d8405STejun Heo * This must be called with either @pool->manager_mutex or ->lock held. 364822d8405STejun Heo * 365822d8405STejun Heo * The if/else clause exists only for the lockdep assertion and can be 366822d8405STejun Heo * ignored. 367822d8405STejun Heo */ 368822d8405STejun Heo #define for_each_pool_worker(worker, wi, pool) \ 369822d8405STejun Heo idr_for_each_entry(&(pool)->worker_idr, (worker), (wi)) \ 370822d8405STejun Heo if (({ assert_manager_or_pool_lock((pool)); false; })) { } \ 371822d8405STejun Heo else 372822d8405STejun Heo 373822d8405STejun Heo /** 37449e3cf44STejun Heo * for_each_pwq - iterate through all pool_workqueues of the specified workqueue 37549e3cf44STejun Heo * @pwq: iteration cursor 37649e3cf44STejun Heo * @wq: the target workqueue 37776af4d93STejun Heo * 378b09f4fd3SLai Jiangshan * This must be called either with wq->mutex held or sched RCU read locked. 379794b18bcSTejun Heo * If the pwq needs to be used beyond the locking in effect, the caller is 380794b18bcSTejun Heo * responsible for guaranteeing that the pwq stays online. 38176af4d93STejun Heo * 38276af4d93STejun Heo * The if/else clause exists only for the lockdep assertion and can be 38376af4d93STejun Heo * ignored. 38449e3cf44STejun Heo */ 38549e3cf44STejun Heo #define for_each_pwq(pwq, wq) \ 38676af4d93STejun Heo list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node) \ 387b09f4fd3SLai Jiangshan if (({ assert_rcu_or_wq_mutex(wq); false; })) { } \ 38876af4d93STejun Heo else 389f3421797STejun Heo 390dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 391dc186ad7SThomas Gleixner 392dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr; 393dc186ad7SThomas Gleixner 39499777288SStanislaw Gruszka static void *work_debug_hint(void *addr) 39599777288SStanislaw Gruszka { 39699777288SStanislaw Gruszka return ((struct work_struct *) addr)->func; 39799777288SStanislaw Gruszka } 39899777288SStanislaw Gruszka 399dc186ad7SThomas Gleixner /* 400dc186ad7SThomas Gleixner * fixup_init is called when: 401dc186ad7SThomas Gleixner * - an active object is initialized 402dc186ad7SThomas Gleixner */ 403dc186ad7SThomas Gleixner static int work_fixup_init(void *addr, enum debug_obj_state state) 404dc186ad7SThomas Gleixner { 405dc186ad7SThomas Gleixner struct work_struct *work = addr; 406dc186ad7SThomas Gleixner 407dc186ad7SThomas Gleixner switch (state) { 408dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 409dc186ad7SThomas Gleixner cancel_work_sync(work); 410dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 411dc186ad7SThomas Gleixner return 1; 412dc186ad7SThomas Gleixner default: 413dc186ad7SThomas Gleixner return 0; 414dc186ad7SThomas Gleixner } 415dc186ad7SThomas Gleixner } 416dc186ad7SThomas Gleixner 417dc186ad7SThomas Gleixner /* 418dc186ad7SThomas Gleixner * fixup_activate is called when: 419dc186ad7SThomas Gleixner * - an active object is activated 420dc186ad7SThomas Gleixner * - an unknown object is activated (might be a statically initialized object) 421dc186ad7SThomas Gleixner */ 422dc186ad7SThomas Gleixner static int work_fixup_activate(void *addr, enum debug_obj_state state) 423dc186ad7SThomas Gleixner { 424dc186ad7SThomas Gleixner struct work_struct *work = addr; 425dc186ad7SThomas Gleixner 426dc186ad7SThomas Gleixner switch (state) { 427dc186ad7SThomas Gleixner 428dc186ad7SThomas Gleixner case ODEBUG_STATE_NOTAVAILABLE: 429dc186ad7SThomas Gleixner /* 430dc186ad7SThomas Gleixner * This is not really a fixup. The work struct was 431dc186ad7SThomas Gleixner * statically initialized. We just make sure that it 432dc186ad7SThomas Gleixner * is tracked in the object tracker. 433dc186ad7SThomas Gleixner */ 43422df02bbSTejun Heo if (test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work))) { 435dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 436dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 437dc186ad7SThomas Gleixner return 0; 438dc186ad7SThomas Gleixner } 439dc186ad7SThomas Gleixner WARN_ON_ONCE(1); 440dc186ad7SThomas Gleixner return 0; 441dc186ad7SThomas Gleixner 442dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 443dc186ad7SThomas Gleixner WARN_ON(1); 444dc186ad7SThomas Gleixner 445dc186ad7SThomas Gleixner default: 446dc186ad7SThomas Gleixner return 0; 447dc186ad7SThomas Gleixner } 448dc186ad7SThomas Gleixner } 449dc186ad7SThomas Gleixner 450dc186ad7SThomas Gleixner /* 451dc186ad7SThomas Gleixner * fixup_free is called when: 452dc186ad7SThomas Gleixner * - an active object is freed 453dc186ad7SThomas Gleixner */ 454dc186ad7SThomas Gleixner static int work_fixup_free(void *addr, enum debug_obj_state state) 455dc186ad7SThomas Gleixner { 456dc186ad7SThomas Gleixner struct work_struct *work = addr; 457dc186ad7SThomas Gleixner 458dc186ad7SThomas Gleixner switch (state) { 459dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 460dc186ad7SThomas Gleixner cancel_work_sync(work); 461dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 462dc186ad7SThomas Gleixner return 1; 463dc186ad7SThomas Gleixner default: 464dc186ad7SThomas Gleixner return 0; 465dc186ad7SThomas Gleixner } 466dc186ad7SThomas Gleixner } 467dc186ad7SThomas Gleixner 468dc186ad7SThomas Gleixner static struct debug_obj_descr work_debug_descr = { 469dc186ad7SThomas Gleixner .name = "work_struct", 47099777288SStanislaw Gruszka .debug_hint = work_debug_hint, 471dc186ad7SThomas Gleixner .fixup_init = work_fixup_init, 472dc186ad7SThomas Gleixner .fixup_activate = work_fixup_activate, 473dc186ad7SThomas Gleixner .fixup_free = work_fixup_free, 474dc186ad7SThomas Gleixner }; 475dc186ad7SThomas Gleixner 476dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) 477dc186ad7SThomas Gleixner { 478dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 479dc186ad7SThomas Gleixner } 480dc186ad7SThomas Gleixner 481dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) 482dc186ad7SThomas Gleixner { 483dc186ad7SThomas Gleixner debug_object_deactivate(work, &work_debug_descr); 484dc186ad7SThomas Gleixner } 485dc186ad7SThomas Gleixner 486dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack) 487dc186ad7SThomas Gleixner { 488dc186ad7SThomas Gleixner if (onstack) 489dc186ad7SThomas Gleixner debug_object_init_on_stack(work, &work_debug_descr); 490dc186ad7SThomas Gleixner else 491dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 492dc186ad7SThomas Gleixner } 493dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work); 494dc186ad7SThomas Gleixner 495dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work) 496dc186ad7SThomas Gleixner { 497dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 498dc186ad7SThomas Gleixner } 499dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack); 500dc186ad7SThomas Gleixner 501dc186ad7SThomas Gleixner #else 502dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { } 503dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { } 504dc186ad7SThomas Gleixner #endif 505dc186ad7SThomas Gleixner 5069daf9e67STejun Heo /* allocate ID and assign it to @pool */ 5079daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool) 5089daf9e67STejun Heo { 5099daf9e67STejun Heo int ret; 5109daf9e67STejun Heo 51168e13a67SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 5125bcab335STejun Heo 513e68035fbSTejun Heo ret = idr_alloc(&worker_pool_idr, pool, 0, 0, GFP_KERNEL); 514229641a6STejun Heo if (ret >= 0) { 515e68035fbSTejun Heo pool->id = ret; 516229641a6STejun Heo return 0; 517229641a6STejun Heo } 5189daf9e67STejun Heo return ret; 5199daf9e67STejun Heo } 5209daf9e67STejun Heo 52176af4d93STejun Heo /** 522df2d5ae4STejun Heo * unbound_pwq_by_node - return the unbound pool_workqueue for the given node 523df2d5ae4STejun Heo * @wq: the target workqueue 524df2d5ae4STejun Heo * @node: the node ID 525df2d5ae4STejun Heo * 526df2d5ae4STejun Heo * This must be called either with pwq_lock held or sched RCU read locked. 527df2d5ae4STejun Heo * If the pwq needs to be used beyond the locking in effect, the caller is 528df2d5ae4STejun Heo * responsible for guaranteeing that the pwq stays online. 529df2d5ae4STejun Heo */ 530df2d5ae4STejun Heo static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq, 531df2d5ae4STejun Heo int node) 532df2d5ae4STejun Heo { 533df2d5ae4STejun Heo assert_rcu_or_wq_mutex(wq); 534df2d5ae4STejun Heo return rcu_dereference_raw(wq->numa_pwq_tbl[node]); 535df2d5ae4STejun Heo } 536df2d5ae4STejun Heo 53773f53c4aSTejun Heo static unsigned int work_color_to_flags(int color) 53873f53c4aSTejun Heo { 53973f53c4aSTejun Heo return color << WORK_STRUCT_COLOR_SHIFT; 54073f53c4aSTejun Heo } 54173f53c4aSTejun Heo 54273f53c4aSTejun Heo static int get_work_color(struct work_struct *work) 54373f53c4aSTejun Heo { 54473f53c4aSTejun Heo return (*work_data_bits(work) >> WORK_STRUCT_COLOR_SHIFT) & 54573f53c4aSTejun Heo ((1 << WORK_STRUCT_COLOR_BITS) - 1); 54673f53c4aSTejun Heo } 54773f53c4aSTejun Heo 54873f53c4aSTejun Heo static int work_next_color(int color) 54973f53c4aSTejun Heo { 55073f53c4aSTejun Heo return (color + 1) % WORK_NR_COLORS; 551a848e3b6SOleg Nesterov } 552a848e3b6SOleg Nesterov 5534594bf15SDavid Howells /* 554112202d9STejun Heo * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data 555112202d9STejun Heo * contain the pointer to the queued pwq. Once execution starts, the flag 5567c3eed5cSTejun Heo * is cleared and the high bits contain OFFQ flags and pool ID. 5577a22ad75STejun Heo * 558112202d9STejun Heo * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling() 559112202d9STejun Heo * and clear_work_data() can be used to set the pwq, pool or clear 560bbb68dfaSTejun Heo * work->data. These functions should only be called while the work is 561bbb68dfaSTejun Heo * owned - ie. while the PENDING bit is set. 5627a22ad75STejun Heo * 563112202d9STejun Heo * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq 5647c3eed5cSTejun Heo * corresponding to a work. Pool is available once the work has been 565112202d9STejun Heo * queued anywhere after initialization until it is sync canceled. pwq is 5667c3eed5cSTejun Heo * available only while the work item is queued. 567bbb68dfaSTejun Heo * 568bbb68dfaSTejun Heo * %WORK_OFFQ_CANCELING is used to mark a work item which is being 569bbb68dfaSTejun Heo * canceled. While being canceled, a work item may have its PENDING set 570bbb68dfaSTejun Heo * but stay off timer and worklist for arbitrarily long and nobody should 571bbb68dfaSTejun Heo * try to steal the PENDING bit. 5724594bf15SDavid Howells */ 5737a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data, 5747a22ad75STejun Heo unsigned long flags) 5757a22ad75STejun Heo { 5766183c009STejun Heo WARN_ON_ONCE(!work_pending(work)); 5777a22ad75STejun Heo atomic_long_set(&work->data, data | flags | work_static(work)); 5787a22ad75STejun Heo } 5797a22ad75STejun Heo 580112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq, 5814690c4abSTejun Heo unsigned long extra_flags) 582365970a1SDavid Howells { 583112202d9STejun Heo set_work_data(work, (unsigned long)pwq, 584112202d9STejun Heo WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags); 585365970a1SDavid Howells } 586365970a1SDavid Howells 5874468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work, 5884468a00fSLai Jiangshan int pool_id) 5894468a00fSLai Jiangshan { 5904468a00fSLai Jiangshan set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 5914468a00fSLai Jiangshan WORK_STRUCT_PENDING); 5924468a00fSLai Jiangshan } 5934468a00fSLai Jiangshan 5947c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work, 5957c3eed5cSTejun Heo int pool_id) 5964d707b9fSOleg Nesterov { 59723657bb1STejun Heo /* 59823657bb1STejun Heo * The following wmb is paired with the implied mb in 59923657bb1STejun Heo * test_and_set_bit(PENDING) and ensures all updates to @work made 60023657bb1STejun Heo * here are visible to and precede any updates by the next PENDING 60123657bb1STejun Heo * owner. 60223657bb1STejun Heo */ 60323657bb1STejun Heo smp_wmb(); 6047c3eed5cSTejun Heo set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0); 6054d707b9fSOleg Nesterov } 6064d707b9fSOleg Nesterov 6077a22ad75STejun Heo static void clear_work_data(struct work_struct *work) 608365970a1SDavid Howells { 6097c3eed5cSTejun Heo smp_wmb(); /* see set_work_pool_and_clear_pending() */ 6107c3eed5cSTejun Heo set_work_data(work, WORK_STRUCT_NO_POOL, 0); 6117a22ad75STejun Heo } 6127a22ad75STejun Heo 613112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work) 6147a22ad75STejun Heo { 615e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 6167a22ad75STejun Heo 617112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 618e120153dSTejun Heo return (void *)(data & WORK_STRUCT_WQ_DATA_MASK); 619e120153dSTejun Heo else 620e120153dSTejun Heo return NULL; 6217a22ad75STejun Heo } 6227a22ad75STejun Heo 6237c3eed5cSTejun Heo /** 6247c3eed5cSTejun Heo * get_work_pool - return the worker_pool a given work was associated with 6257c3eed5cSTejun Heo * @work: the work item of interest 6267c3eed5cSTejun Heo * 6277c3eed5cSTejun Heo * Return the worker_pool @work was last associated with. %NULL if none. 628fa1b54e6STejun Heo * 62968e13a67SLai Jiangshan * Pools are created and destroyed under wq_pool_mutex, and allows read 63068e13a67SLai Jiangshan * access under sched-RCU read lock. As such, this function should be 63168e13a67SLai Jiangshan * called under wq_pool_mutex or with preemption disabled. 632fa1b54e6STejun Heo * 633fa1b54e6STejun Heo * All fields of the returned pool are accessible as long as the above 634fa1b54e6STejun Heo * mentioned locking is in effect. If the returned pool needs to be used 635fa1b54e6STejun Heo * beyond the critical section, the caller is responsible for ensuring the 636fa1b54e6STejun Heo * returned pool is and stays online. 6377c3eed5cSTejun Heo */ 6387c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work) 6397a22ad75STejun Heo { 640e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 6417c3eed5cSTejun Heo int pool_id; 6427a22ad75STejun Heo 64368e13a67SLai Jiangshan assert_rcu_or_pool_mutex(); 644fa1b54e6STejun Heo 645112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 646112202d9STejun Heo return ((struct pool_workqueue *) 6477c3eed5cSTejun Heo (data & WORK_STRUCT_WQ_DATA_MASK))->pool; 6487a22ad75STejun Heo 6497c3eed5cSTejun Heo pool_id = data >> WORK_OFFQ_POOL_SHIFT; 6507c3eed5cSTejun Heo if (pool_id == WORK_OFFQ_POOL_NONE) 6517a22ad75STejun Heo return NULL; 6527a22ad75STejun Heo 653fa1b54e6STejun Heo return idr_find(&worker_pool_idr, pool_id); 6547c3eed5cSTejun Heo } 6557c3eed5cSTejun Heo 6567c3eed5cSTejun Heo /** 6577c3eed5cSTejun Heo * get_work_pool_id - return the worker pool ID a given work is associated with 6587c3eed5cSTejun Heo * @work: the work item of interest 6597c3eed5cSTejun Heo * 6607c3eed5cSTejun Heo * Return the worker_pool ID @work was last associated with. 6617c3eed5cSTejun Heo * %WORK_OFFQ_POOL_NONE if none. 6627c3eed5cSTejun Heo */ 6637c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work) 6647c3eed5cSTejun Heo { 66554d5b7d0SLai Jiangshan unsigned long data = atomic_long_read(&work->data); 6667c3eed5cSTejun Heo 667112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 668112202d9STejun Heo return ((struct pool_workqueue *) 66954d5b7d0SLai Jiangshan (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id; 67054d5b7d0SLai Jiangshan 67154d5b7d0SLai Jiangshan return data >> WORK_OFFQ_POOL_SHIFT; 6727c3eed5cSTejun Heo } 6737c3eed5cSTejun Heo 674bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work) 675bbb68dfaSTejun Heo { 6767c3eed5cSTejun Heo unsigned long pool_id = get_work_pool_id(work); 677bbb68dfaSTejun Heo 6787c3eed5cSTejun Heo pool_id <<= WORK_OFFQ_POOL_SHIFT; 6797c3eed5cSTejun Heo set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING); 680bbb68dfaSTejun Heo } 681bbb68dfaSTejun Heo 682bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work) 683bbb68dfaSTejun Heo { 684bbb68dfaSTejun Heo unsigned long data = atomic_long_read(&work->data); 685bbb68dfaSTejun Heo 686112202d9STejun Heo return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING); 687bbb68dfaSTejun Heo } 688bbb68dfaSTejun Heo 689e22bee78STejun Heo /* 6903270476aSTejun Heo * Policy functions. These define the policies on how the global worker 6913270476aSTejun Heo * pools are managed. Unless noted otherwise, these functions assume that 692d565ed63STejun Heo * they're being called with pool->lock held. 693e22bee78STejun Heo */ 694e22bee78STejun Heo 69563d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool) 696649027d7STejun Heo { 697e19e397aSTejun Heo return !atomic_read(&pool->nr_running); 698649027d7STejun Heo } 699649027d7STejun Heo 700e22bee78STejun Heo /* 701e22bee78STejun Heo * Need to wake up a worker? Called from anything but currently 702e22bee78STejun Heo * running workers. 703974271c4STejun Heo * 704974271c4STejun Heo * Note that, because unbound workers never contribute to nr_running, this 705706026c2STejun Heo * function will always return %true for unbound pools as long as the 706974271c4STejun Heo * worklist isn't empty. 707e22bee78STejun Heo */ 70863d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool) 709e22bee78STejun Heo { 71063d95a91STejun Heo return !list_empty(&pool->worklist) && __need_more_worker(pool); 711e22bee78STejun Heo } 712e22bee78STejun Heo 713e22bee78STejun Heo /* Can I start working? Called from busy but !running workers. */ 71463d95a91STejun Heo static bool may_start_working(struct worker_pool *pool) 715e22bee78STejun Heo { 71663d95a91STejun Heo return pool->nr_idle; 717e22bee78STejun Heo } 718e22bee78STejun Heo 719e22bee78STejun Heo /* Do I need to keep working? Called from currently running workers. */ 72063d95a91STejun Heo static bool keep_working(struct worker_pool *pool) 721e22bee78STejun Heo { 722e19e397aSTejun Heo return !list_empty(&pool->worklist) && 723e19e397aSTejun Heo atomic_read(&pool->nr_running) <= 1; 724e22bee78STejun Heo } 725e22bee78STejun Heo 726e22bee78STejun Heo /* Do we need a new worker? Called from manager. */ 72763d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool) 728e22bee78STejun Heo { 72963d95a91STejun Heo return need_more_worker(pool) && !may_start_working(pool); 730e22bee78STejun Heo } 731e22bee78STejun Heo 732e22bee78STejun Heo /* Do I need to be the manager? */ 73363d95a91STejun Heo static bool need_to_manage_workers(struct worker_pool *pool) 734e22bee78STejun Heo { 73563d95a91STejun Heo return need_to_create_worker(pool) || 73611ebea50STejun Heo (pool->flags & POOL_MANAGE_WORKERS); 737e22bee78STejun Heo } 738e22bee78STejun Heo 739e22bee78STejun Heo /* Do we have too many workers and should some go away? */ 74063d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool) 741e22bee78STejun Heo { 74234a06bd6STejun Heo bool managing = mutex_is_locked(&pool->manager_arb); 74363d95a91STejun Heo int nr_idle = pool->nr_idle + managing; /* manager is considered idle */ 74463d95a91STejun Heo int nr_busy = pool->nr_workers - nr_idle; 745e22bee78STejun Heo 746ea1abd61SLai Jiangshan /* 747ea1abd61SLai Jiangshan * nr_idle and idle_list may disagree if idle rebinding is in 748ea1abd61SLai Jiangshan * progress. Never return %true if idle_list is empty. 749ea1abd61SLai Jiangshan */ 750ea1abd61SLai Jiangshan if (list_empty(&pool->idle_list)) 751ea1abd61SLai Jiangshan return false; 752ea1abd61SLai Jiangshan 753e22bee78STejun Heo return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; 754e22bee78STejun Heo } 755e22bee78STejun Heo 756e22bee78STejun Heo /* 757e22bee78STejun Heo * Wake up functions. 758e22bee78STejun Heo */ 759e22bee78STejun Heo 7607e11629dSTejun Heo /* Return the first worker. Safe with preemption disabled */ 76163d95a91STejun Heo static struct worker *first_worker(struct worker_pool *pool) 7627e11629dSTejun Heo { 76363d95a91STejun Heo if (unlikely(list_empty(&pool->idle_list))) 7647e11629dSTejun Heo return NULL; 7657e11629dSTejun Heo 76663d95a91STejun Heo return list_first_entry(&pool->idle_list, struct worker, entry); 7677e11629dSTejun Heo } 7687e11629dSTejun Heo 7697e11629dSTejun Heo /** 7707e11629dSTejun Heo * wake_up_worker - wake up an idle worker 77163d95a91STejun Heo * @pool: worker pool to wake worker from 7727e11629dSTejun Heo * 77363d95a91STejun Heo * Wake up the first idle worker of @pool. 7747e11629dSTejun Heo * 7757e11629dSTejun Heo * CONTEXT: 776d565ed63STejun Heo * spin_lock_irq(pool->lock). 7777e11629dSTejun Heo */ 77863d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool) 7797e11629dSTejun Heo { 78063d95a91STejun Heo struct worker *worker = first_worker(pool); 7817e11629dSTejun Heo 7827e11629dSTejun Heo if (likely(worker)) 7837e11629dSTejun Heo wake_up_process(worker->task); 7847e11629dSTejun Heo } 7857e11629dSTejun Heo 7864690c4abSTejun Heo /** 787e22bee78STejun Heo * wq_worker_waking_up - a worker is waking up 788e22bee78STejun Heo * @task: task waking up 789e22bee78STejun Heo * @cpu: CPU @task is waking up to 790e22bee78STejun Heo * 791e22bee78STejun Heo * This function is called during try_to_wake_up() when a worker is 792e22bee78STejun Heo * being awoken. 793e22bee78STejun Heo * 794e22bee78STejun Heo * CONTEXT: 795e22bee78STejun Heo * spin_lock_irq(rq->lock) 796e22bee78STejun Heo */ 797d84ff051STejun Heo void wq_worker_waking_up(struct task_struct *task, int cpu) 798e22bee78STejun Heo { 799e22bee78STejun Heo struct worker *worker = kthread_data(task); 800e22bee78STejun Heo 80136576000SJoonsoo Kim if (!(worker->flags & WORKER_NOT_RUNNING)) { 802ec22ca5eSTejun Heo WARN_ON_ONCE(worker->pool->cpu != cpu); 803e19e397aSTejun Heo atomic_inc(&worker->pool->nr_running); 804e22bee78STejun Heo } 80536576000SJoonsoo Kim } 806e22bee78STejun Heo 807e22bee78STejun Heo /** 808e22bee78STejun Heo * wq_worker_sleeping - a worker is going to sleep 809e22bee78STejun Heo * @task: task going to sleep 810e22bee78STejun Heo * @cpu: CPU in question, must be the current CPU number 811e22bee78STejun Heo * 812e22bee78STejun Heo * This function is called during schedule() when a busy worker is 813e22bee78STejun Heo * going to sleep. Worker on the same cpu can be woken up by 814e22bee78STejun Heo * returning pointer to its task. 815e22bee78STejun Heo * 816e22bee78STejun Heo * CONTEXT: 817e22bee78STejun Heo * spin_lock_irq(rq->lock) 818e22bee78STejun Heo * 819e22bee78STejun Heo * RETURNS: 820e22bee78STejun Heo * Worker task on @cpu to wake up, %NULL if none. 821e22bee78STejun Heo */ 822d84ff051STejun Heo struct task_struct *wq_worker_sleeping(struct task_struct *task, int cpu) 823e22bee78STejun Heo { 824e22bee78STejun Heo struct worker *worker = kthread_data(task), *to_wakeup = NULL; 825111c225aSTejun Heo struct worker_pool *pool; 826e22bee78STejun Heo 827111c225aSTejun Heo /* 828111c225aSTejun Heo * Rescuers, which may not have all the fields set up like normal 829111c225aSTejun Heo * workers, also reach here, let's not access anything before 830111c225aSTejun Heo * checking NOT_RUNNING. 831111c225aSTejun Heo */ 8322d64672eSSteven Rostedt if (worker->flags & WORKER_NOT_RUNNING) 833e22bee78STejun Heo return NULL; 834e22bee78STejun Heo 835111c225aSTejun Heo pool = worker->pool; 836111c225aSTejun Heo 837e22bee78STejun Heo /* this can only happen on the local cpu */ 8386183c009STejun Heo if (WARN_ON_ONCE(cpu != raw_smp_processor_id())) 8396183c009STejun Heo return NULL; 840e22bee78STejun Heo 841e22bee78STejun Heo /* 842e22bee78STejun Heo * The counterpart of the following dec_and_test, implied mb, 843e22bee78STejun Heo * worklist not empty test sequence is in insert_work(). 844e22bee78STejun Heo * Please read comment there. 845e22bee78STejun Heo * 846628c78e7STejun Heo * NOT_RUNNING is clear. This means that we're bound to and 847628c78e7STejun Heo * running on the local cpu w/ rq lock held and preemption 848628c78e7STejun Heo * disabled, which in turn means that none else could be 849d565ed63STejun Heo * manipulating idle_list, so dereferencing idle_list without pool 850628c78e7STejun Heo * lock is safe. 851e22bee78STejun Heo */ 852e19e397aSTejun Heo if (atomic_dec_and_test(&pool->nr_running) && 853e19e397aSTejun Heo !list_empty(&pool->worklist)) 85463d95a91STejun Heo to_wakeup = first_worker(pool); 855e22bee78STejun Heo return to_wakeup ? to_wakeup->task : NULL; 856e22bee78STejun Heo } 857e22bee78STejun Heo 858e22bee78STejun Heo /** 859e22bee78STejun Heo * worker_set_flags - set worker flags and adjust nr_running accordingly 860cb444766STejun Heo * @worker: self 861d302f017STejun Heo * @flags: flags to set 862d302f017STejun Heo * @wakeup: wakeup an idle worker if necessary 863d302f017STejun Heo * 864e22bee78STejun Heo * Set @flags in @worker->flags and adjust nr_running accordingly. If 865e22bee78STejun Heo * nr_running becomes zero and @wakeup is %true, an idle worker is 866e22bee78STejun Heo * woken up. 867d302f017STejun Heo * 868cb444766STejun Heo * CONTEXT: 869d565ed63STejun Heo * spin_lock_irq(pool->lock) 870d302f017STejun Heo */ 871d302f017STejun Heo static inline void worker_set_flags(struct worker *worker, unsigned int flags, 872d302f017STejun Heo bool wakeup) 873d302f017STejun Heo { 874bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 875e22bee78STejun Heo 876cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 877cb444766STejun Heo 878e22bee78STejun Heo /* 879e22bee78STejun Heo * If transitioning into NOT_RUNNING, adjust nr_running and 880e22bee78STejun Heo * wake up an idle worker as necessary if requested by 881e22bee78STejun Heo * @wakeup. 882e22bee78STejun Heo */ 883e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && 884e22bee78STejun Heo !(worker->flags & WORKER_NOT_RUNNING)) { 885e22bee78STejun Heo if (wakeup) { 886e19e397aSTejun Heo if (atomic_dec_and_test(&pool->nr_running) && 887bd7bdd43STejun Heo !list_empty(&pool->worklist)) 88863d95a91STejun Heo wake_up_worker(pool); 889e22bee78STejun Heo } else 890e19e397aSTejun Heo atomic_dec(&pool->nr_running); 891e22bee78STejun Heo } 892e22bee78STejun Heo 893d302f017STejun Heo worker->flags |= flags; 894d302f017STejun Heo } 895d302f017STejun Heo 896d302f017STejun Heo /** 897e22bee78STejun Heo * worker_clr_flags - clear worker flags and adjust nr_running accordingly 898cb444766STejun Heo * @worker: self 899d302f017STejun Heo * @flags: flags to clear 900d302f017STejun Heo * 901e22bee78STejun Heo * Clear @flags in @worker->flags and adjust nr_running accordingly. 902d302f017STejun Heo * 903cb444766STejun Heo * CONTEXT: 904d565ed63STejun Heo * spin_lock_irq(pool->lock) 905d302f017STejun Heo */ 906d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags) 907d302f017STejun Heo { 90863d95a91STejun Heo struct worker_pool *pool = worker->pool; 909e22bee78STejun Heo unsigned int oflags = worker->flags; 910e22bee78STejun Heo 911cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 912cb444766STejun Heo 913d302f017STejun Heo worker->flags &= ~flags; 914e22bee78STejun Heo 91542c025f3STejun Heo /* 91642c025f3STejun Heo * If transitioning out of NOT_RUNNING, increment nr_running. Note 91742c025f3STejun Heo * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask 91842c025f3STejun Heo * of multiple flags, not a single flag. 91942c025f3STejun Heo */ 920e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) 921e22bee78STejun Heo if (!(worker->flags & WORKER_NOT_RUNNING)) 922e19e397aSTejun Heo atomic_inc(&pool->nr_running); 923d302f017STejun Heo } 924d302f017STejun Heo 925d302f017STejun Heo /** 9268cca0eeaSTejun Heo * find_worker_executing_work - find worker which is executing a work 927c9e7cf27STejun Heo * @pool: pool of interest 9288cca0eeaSTejun Heo * @work: work to find worker for 9298cca0eeaSTejun Heo * 930c9e7cf27STejun Heo * Find a worker which is executing @work on @pool by searching 931c9e7cf27STejun Heo * @pool->busy_hash which is keyed by the address of @work. For a worker 932a2c1c57bSTejun Heo * to match, its current execution should match the address of @work and 933a2c1c57bSTejun Heo * its work function. This is to avoid unwanted dependency between 934a2c1c57bSTejun Heo * unrelated work executions through a work item being recycled while still 935a2c1c57bSTejun Heo * being executed. 936a2c1c57bSTejun Heo * 937a2c1c57bSTejun Heo * This is a bit tricky. A work item may be freed once its execution 938a2c1c57bSTejun Heo * starts and nothing prevents the freed area from being recycled for 939a2c1c57bSTejun Heo * another work item. If the same work item address ends up being reused 940a2c1c57bSTejun Heo * before the original execution finishes, workqueue will identify the 941a2c1c57bSTejun Heo * recycled work item as currently executing and make it wait until the 942a2c1c57bSTejun Heo * current execution finishes, introducing an unwanted dependency. 943a2c1c57bSTejun Heo * 944c5aa87bbSTejun Heo * This function checks the work item address and work function to avoid 945c5aa87bbSTejun Heo * false positives. Note that this isn't complete as one may construct a 946c5aa87bbSTejun Heo * work function which can introduce dependency onto itself through a 947c5aa87bbSTejun Heo * recycled work item. Well, if somebody wants to shoot oneself in the 948c5aa87bbSTejun Heo * foot that badly, there's only so much we can do, and if such deadlock 949c5aa87bbSTejun Heo * actually occurs, it should be easy to locate the culprit work function. 9508cca0eeaSTejun Heo * 9518cca0eeaSTejun Heo * CONTEXT: 952d565ed63STejun Heo * spin_lock_irq(pool->lock). 9538cca0eeaSTejun Heo * 9548cca0eeaSTejun Heo * RETURNS: 9558cca0eeaSTejun Heo * Pointer to worker which is executing @work if found, NULL 9568cca0eeaSTejun Heo * otherwise. 9578cca0eeaSTejun Heo */ 958c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool, 9598cca0eeaSTejun Heo struct work_struct *work) 9608cca0eeaSTejun Heo { 96142f8570fSSasha Levin struct worker *worker; 96242f8570fSSasha Levin 963b67bfe0dSSasha Levin hash_for_each_possible(pool->busy_hash, worker, hentry, 964a2c1c57bSTejun Heo (unsigned long)work) 965a2c1c57bSTejun Heo if (worker->current_work == work && 966a2c1c57bSTejun Heo worker->current_func == work->func) 96742f8570fSSasha Levin return worker; 96842f8570fSSasha Levin 96942f8570fSSasha Levin return NULL; 9708cca0eeaSTejun Heo } 9718cca0eeaSTejun Heo 9728cca0eeaSTejun Heo /** 973bf4ede01STejun Heo * move_linked_works - move linked works to a list 974bf4ede01STejun Heo * @work: start of series of works to be scheduled 975bf4ede01STejun Heo * @head: target list to append @work to 976bf4ede01STejun Heo * @nextp: out paramter for nested worklist walking 977bf4ede01STejun Heo * 978bf4ede01STejun Heo * Schedule linked works starting from @work to @head. Work series to 979bf4ede01STejun Heo * be scheduled starts at @work and includes any consecutive work with 980bf4ede01STejun Heo * WORK_STRUCT_LINKED set in its predecessor. 981bf4ede01STejun Heo * 982bf4ede01STejun Heo * If @nextp is not NULL, it's updated to point to the next work of 983bf4ede01STejun Heo * the last scheduled work. This allows move_linked_works() to be 984bf4ede01STejun Heo * nested inside outer list_for_each_entry_safe(). 985bf4ede01STejun Heo * 986bf4ede01STejun Heo * CONTEXT: 987d565ed63STejun Heo * spin_lock_irq(pool->lock). 988bf4ede01STejun Heo */ 989bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head, 990bf4ede01STejun Heo struct work_struct **nextp) 991bf4ede01STejun Heo { 992bf4ede01STejun Heo struct work_struct *n; 993bf4ede01STejun Heo 994bf4ede01STejun Heo /* 995bf4ede01STejun Heo * Linked worklist will always end before the end of the list, 996bf4ede01STejun Heo * use NULL for list head. 997bf4ede01STejun Heo */ 998bf4ede01STejun Heo list_for_each_entry_safe_from(work, n, NULL, entry) { 999bf4ede01STejun Heo list_move_tail(&work->entry, head); 1000bf4ede01STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) 1001bf4ede01STejun Heo break; 1002bf4ede01STejun Heo } 1003bf4ede01STejun Heo 1004bf4ede01STejun Heo /* 1005bf4ede01STejun Heo * If we're already inside safe list traversal and have moved 1006bf4ede01STejun Heo * multiple works to the scheduled queue, the next position 1007bf4ede01STejun Heo * needs to be updated. 1008bf4ede01STejun Heo */ 1009bf4ede01STejun Heo if (nextp) 1010bf4ede01STejun Heo *nextp = n; 1011bf4ede01STejun Heo } 1012bf4ede01STejun Heo 10138864b4e5STejun Heo /** 10148864b4e5STejun Heo * get_pwq - get an extra reference on the specified pool_workqueue 10158864b4e5STejun Heo * @pwq: pool_workqueue to get 10168864b4e5STejun Heo * 10178864b4e5STejun Heo * Obtain an extra reference on @pwq. The caller should guarantee that 10188864b4e5STejun Heo * @pwq has positive refcnt and be holding the matching pool->lock. 10198864b4e5STejun Heo */ 10208864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq) 10218864b4e5STejun Heo { 10228864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 10238864b4e5STejun Heo WARN_ON_ONCE(pwq->refcnt <= 0); 10248864b4e5STejun Heo pwq->refcnt++; 10258864b4e5STejun Heo } 10268864b4e5STejun Heo 10278864b4e5STejun Heo /** 10288864b4e5STejun Heo * put_pwq - put a pool_workqueue reference 10298864b4e5STejun Heo * @pwq: pool_workqueue to put 10308864b4e5STejun Heo * 10318864b4e5STejun Heo * Drop a reference of @pwq. If its refcnt reaches zero, schedule its 10328864b4e5STejun Heo * destruction. The caller should be holding the matching pool->lock. 10338864b4e5STejun Heo */ 10348864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq) 10358864b4e5STejun Heo { 10368864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 10378864b4e5STejun Heo if (likely(--pwq->refcnt)) 10388864b4e5STejun Heo return; 10398864b4e5STejun Heo if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND))) 10408864b4e5STejun Heo return; 10418864b4e5STejun Heo /* 10428864b4e5STejun Heo * @pwq can't be released under pool->lock, bounce to 10438864b4e5STejun Heo * pwq_unbound_release_workfn(). This never recurses on the same 10448864b4e5STejun Heo * pool->lock as this path is taken only for unbound workqueues and 10458864b4e5STejun Heo * the release work item is scheduled on a per-cpu workqueue. To 10468864b4e5STejun Heo * avoid lockdep warning, unbound pool->locks are given lockdep 10478864b4e5STejun Heo * subclass of 1 in get_unbound_pool(). 10488864b4e5STejun Heo */ 10498864b4e5STejun Heo schedule_work(&pwq->unbound_release_work); 10508864b4e5STejun Heo } 10518864b4e5STejun Heo 1052dce90d47STejun Heo /** 1053dce90d47STejun Heo * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock 1054dce90d47STejun Heo * @pwq: pool_workqueue to put (can be %NULL) 1055dce90d47STejun Heo * 1056dce90d47STejun Heo * put_pwq() with locking. This function also allows %NULL @pwq. 1057dce90d47STejun Heo */ 1058dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq) 1059dce90d47STejun Heo { 1060dce90d47STejun Heo if (pwq) { 1061dce90d47STejun Heo /* 1062dce90d47STejun Heo * As both pwqs and pools are sched-RCU protected, the 1063dce90d47STejun Heo * following lock operations are safe. 1064dce90d47STejun Heo */ 1065dce90d47STejun Heo spin_lock_irq(&pwq->pool->lock); 1066dce90d47STejun Heo put_pwq(pwq); 1067dce90d47STejun Heo spin_unlock_irq(&pwq->pool->lock); 1068dce90d47STejun Heo } 1069dce90d47STejun Heo } 1070dce90d47STejun Heo 1071112202d9STejun Heo static void pwq_activate_delayed_work(struct work_struct *work) 1072bf4ede01STejun Heo { 1073112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 1074bf4ede01STejun Heo 1075bf4ede01STejun Heo trace_workqueue_activate_work(work); 1076112202d9STejun Heo move_linked_works(work, &pwq->pool->worklist, NULL); 1077bf4ede01STejun Heo __clear_bit(WORK_STRUCT_DELAYED_BIT, work_data_bits(work)); 1078112202d9STejun Heo pwq->nr_active++; 1079bf4ede01STejun Heo } 1080bf4ede01STejun Heo 1081112202d9STejun Heo static void pwq_activate_first_delayed(struct pool_workqueue *pwq) 10823aa62497SLai Jiangshan { 1083112202d9STejun Heo struct work_struct *work = list_first_entry(&pwq->delayed_works, 10843aa62497SLai Jiangshan struct work_struct, entry); 10853aa62497SLai Jiangshan 1086112202d9STejun Heo pwq_activate_delayed_work(work); 10873aa62497SLai Jiangshan } 10883aa62497SLai Jiangshan 1089bf4ede01STejun Heo /** 1090112202d9STejun Heo * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight 1091112202d9STejun Heo * @pwq: pwq of interest 1092bf4ede01STejun Heo * @color: color of work which left the queue 1093bf4ede01STejun Heo * 1094bf4ede01STejun Heo * A work either has completed or is removed from pending queue, 1095112202d9STejun Heo * decrement nr_in_flight of its pwq and handle workqueue flushing. 1096bf4ede01STejun Heo * 1097bf4ede01STejun Heo * CONTEXT: 1098d565ed63STejun Heo * spin_lock_irq(pool->lock). 1099bf4ede01STejun Heo */ 1100112202d9STejun Heo static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color) 1101bf4ede01STejun Heo { 11028864b4e5STejun Heo /* uncolored work items don't participate in flushing or nr_active */ 1103bf4ede01STejun Heo if (color == WORK_NO_COLOR) 11048864b4e5STejun Heo goto out_put; 1105bf4ede01STejun Heo 1106112202d9STejun Heo pwq->nr_in_flight[color]--; 1107bf4ede01STejun Heo 1108112202d9STejun Heo pwq->nr_active--; 1109112202d9STejun Heo if (!list_empty(&pwq->delayed_works)) { 1110bf4ede01STejun Heo /* one down, submit a delayed one */ 1111112202d9STejun Heo if (pwq->nr_active < pwq->max_active) 1112112202d9STejun Heo pwq_activate_first_delayed(pwq); 1113bf4ede01STejun Heo } 1114bf4ede01STejun Heo 1115bf4ede01STejun Heo /* is flush in progress and are we at the flushing tip? */ 1116112202d9STejun Heo if (likely(pwq->flush_color != color)) 11178864b4e5STejun Heo goto out_put; 1118bf4ede01STejun Heo 1119bf4ede01STejun Heo /* are there still in-flight works? */ 1120112202d9STejun Heo if (pwq->nr_in_flight[color]) 11218864b4e5STejun Heo goto out_put; 1122bf4ede01STejun Heo 1123112202d9STejun Heo /* this pwq is done, clear flush_color */ 1124112202d9STejun Heo pwq->flush_color = -1; 1125bf4ede01STejun Heo 1126bf4ede01STejun Heo /* 1127112202d9STejun Heo * If this was the last pwq, wake up the first flusher. It 1128bf4ede01STejun Heo * will handle the rest. 1129bf4ede01STejun Heo */ 1130112202d9STejun Heo if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush)) 1131112202d9STejun Heo complete(&pwq->wq->first_flusher->done); 11328864b4e5STejun Heo out_put: 11338864b4e5STejun Heo put_pwq(pwq); 1134bf4ede01STejun Heo } 1135bf4ede01STejun Heo 113636e227d2STejun Heo /** 1137bbb68dfaSTejun Heo * try_to_grab_pending - steal work item from worklist and disable irq 113836e227d2STejun Heo * @work: work item to steal 113936e227d2STejun Heo * @is_dwork: @work is a delayed_work 1140bbb68dfaSTejun Heo * @flags: place to store irq state 114136e227d2STejun Heo * 114236e227d2STejun Heo * Try to grab PENDING bit of @work. This function can handle @work in any 114336e227d2STejun Heo * stable state - idle, on timer or on worklist. Return values are 114436e227d2STejun Heo * 114536e227d2STejun Heo * 1 if @work was pending and we successfully stole PENDING 114636e227d2STejun Heo * 0 if @work was idle and we claimed PENDING 114736e227d2STejun Heo * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry 1148bbb68dfaSTejun Heo * -ENOENT if someone else is canceling @work, this state may persist 1149bbb68dfaSTejun Heo * for arbitrarily long 115036e227d2STejun Heo * 1151bbb68dfaSTejun Heo * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting 1152e0aecdd8STejun Heo * interrupted while holding PENDING and @work off queue, irq must be 1153e0aecdd8STejun Heo * disabled on entry. This, combined with delayed_work->timer being 1154e0aecdd8STejun Heo * irqsafe, ensures that we return -EAGAIN for finite short period of time. 1155bbb68dfaSTejun Heo * 1156bbb68dfaSTejun Heo * On successful return, >= 0, irq is disabled and the caller is 1157bbb68dfaSTejun Heo * responsible for releasing it using local_irq_restore(*@flags). 1158bbb68dfaSTejun Heo * 1159e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 1160bf4ede01STejun Heo */ 1161bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork, 1162bbb68dfaSTejun Heo unsigned long *flags) 1163bf4ede01STejun Heo { 1164d565ed63STejun Heo struct worker_pool *pool; 1165112202d9STejun Heo struct pool_workqueue *pwq; 1166bf4ede01STejun Heo 1167bbb68dfaSTejun Heo local_irq_save(*flags); 1168bbb68dfaSTejun Heo 116936e227d2STejun Heo /* try to steal the timer if it exists */ 117036e227d2STejun Heo if (is_dwork) { 117136e227d2STejun Heo struct delayed_work *dwork = to_delayed_work(work); 117236e227d2STejun Heo 1173e0aecdd8STejun Heo /* 1174e0aecdd8STejun Heo * dwork->timer is irqsafe. If del_timer() fails, it's 1175e0aecdd8STejun Heo * guaranteed that the timer is not queued anywhere and not 1176e0aecdd8STejun Heo * running on the local CPU. 1177e0aecdd8STejun Heo */ 117836e227d2STejun Heo if (likely(del_timer(&dwork->timer))) 117936e227d2STejun Heo return 1; 118036e227d2STejun Heo } 118136e227d2STejun Heo 118236e227d2STejun Heo /* try to claim PENDING the normal way */ 1183bf4ede01STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) 1184bf4ede01STejun Heo return 0; 1185bf4ede01STejun Heo 1186bf4ede01STejun Heo /* 1187bf4ede01STejun Heo * The queueing is in progress, or it is already queued. Try to 1188bf4ede01STejun Heo * steal it from ->worklist without clearing WORK_STRUCT_PENDING. 1189bf4ede01STejun Heo */ 1190d565ed63STejun Heo pool = get_work_pool(work); 1191d565ed63STejun Heo if (!pool) 1192bbb68dfaSTejun Heo goto fail; 1193bf4ede01STejun Heo 1194d565ed63STejun Heo spin_lock(&pool->lock); 1195bf4ede01STejun Heo /* 1196112202d9STejun Heo * work->data is guaranteed to point to pwq only while the work 1197112202d9STejun Heo * item is queued on pwq->wq, and both updating work->data to point 1198112202d9STejun Heo * to pwq on queueing and to pool on dequeueing are done under 1199112202d9STejun Heo * pwq->pool->lock. This in turn guarantees that, if work->data 1200112202d9STejun Heo * points to pwq which is associated with a locked pool, the work 12010b3dae68SLai Jiangshan * item is currently queued on that pool. 1202bf4ede01STejun Heo */ 1203112202d9STejun Heo pwq = get_work_pwq(work); 1204112202d9STejun Heo if (pwq && pwq->pool == pool) { 1205bf4ede01STejun Heo debug_work_deactivate(work); 12063aa62497SLai Jiangshan 12073aa62497SLai Jiangshan /* 120816062836STejun Heo * A delayed work item cannot be grabbed directly because 120916062836STejun Heo * it might have linked NO_COLOR work items which, if left 1210112202d9STejun Heo * on the delayed_list, will confuse pwq->nr_active 121116062836STejun Heo * management later on and cause stall. Make sure the work 121216062836STejun Heo * item is activated before grabbing. 12133aa62497SLai Jiangshan */ 12143aa62497SLai Jiangshan if (*work_data_bits(work) & WORK_STRUCT_DELAYED) 1215112202d9STejun Heo pwq_activate_delayed_work(work); 12163aa62497SLai Jiangshan 1217bf4ede01STejun Heo list_del_init(&work->entry); 1218112202d9STejun Heo pwq_dec_nr_in_flight(get_work_pwq(work), get_work_color(work)); 121936e227d2STejun Heo 1220112202d9STejun Heo /* work->data points to pwq iff queued, point to pool */ 12214468a00fSLai Jiangshan set_work_pool_and_keep_pending(work, pool->id); 12224468a00fSLai Jiangshan 1223d565ed63STejun Heo spin_unlock(&pool->lock); 122436e227d2STejun Heo return 1; 1225bf4ede01STejun Heo } 1226d565ed63STejun Heo spin_unlock(&pool->lock); 1227bbb68dfaSTejun Heo fail: 1228bbb68dfaSTejun Heo local_irq_restore(*flags); 1229bbb68dfaSTejun Heo if (work_is_canceling(work)) 1230bbb68dfaSTejun Heo return -ENOENT; 1231bbb68dfaSTejun Heo cpu_relax(); 123236e227d2STejun Heo return -EAGAIN; 1233bf4ede01STejun Heo } 1234bf4ede01STejun Heo 1235bf4ede01STejun Heo /** 1236706026c2STejun Heo * insert_work - insert a work into a pool 1237112202d9STejun Heo * @pwq: pwq @work belongs to 12384690c4abSTejun Heo * @work: work to insert 12394690c4abSTejun Heo * @head: insertion point 12404690c4abSTejun Heo * @extra_flags: extra WORK_STRUCT_* flags to set 12414690c4abSTejun Heo * 1242112202d9STejun Heo * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to 1243706026c2STejun Heo * work_struct flags. 12444690c4abSTejun Heo * 12454690c4abSTejun Heo * CONTEXT: 1246d565ed63STejun Heo * spin_lock_irq(pool->lock). 1247365970a1SDavid Howells */ 1248112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work, 1249112202d9STejun Heo struct list_head *head, unsigned int extra_flags) 1250b89deed3SOleg Nesterov { 1251112202d9STejun Heo struct worker_pool *pool = pwq->pool; 1252e1d8aa9fSFrederic Weisbecker 12534690c4abSTejun Heo /* we own @work, set data and link */ 1254112202d9STejun Heo set_work_pwq(work, pwq, extra_flags); 12551a4d9b0aSOleg Nesterov list_add_tail(&work->entry, head); 12568864b4e5STejun Heo get_pwq(pwq); 1257e22bee78STejun Heo 1258e22bee78STejun Heo /* 1259c5aa87bbSTejun Heo * Ensure either wq_worker_sleeping() sees the above 1260c5aa87bbSTejun Heo * list_add_tail() or we see zero nr_running to avoid workers lying 1261c5aa87bbSTejun Heo * around lazily while there are works to be processed. 1262e22bee78STejun Heo */ 1263e22bee78STejun Heo smp_mb(); 1264e22bee78STejun Heo 126563d95a91STejun Heo if (__need_more_worker(pool)) 126663d95a91STejun Heo wake_up_worker(pool); 1267b89deed3SOleg Nesterov } 1268b89deed3SOleg Nesterov 1269c8efcc25STejun Heo /* 1270c8efcc25STejun Heo * Test whether @work is being queued from another work executing on the 12718d03ecfeSTejun Heo * same workqueue. 1272c8efcc25STejun Heo */ 1273c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq) 1274c8efcc25STejun Heo { 1275c8efcc25STejun Heo struct worker *worker; 1276c8efcc25STejun Heo 12778d03ecfeSTejun Heo worker = current_wq_worker(); 1278c8efcc25STejun Heo /* 12798d03ecfeSTejun Heo * Return %true iff I'm a worker execuing a work item on @wq. If 12808d03ecfeSTejun Heo * I'm @worker, it's safe to dereference it without locking. 1281c8efcc25STejun Heo */ 1282112202d9STejun Heo return worker && worker->current_pwq->wq == wq; 1283c8efcc25STejun Heo } 1284c8efcc25STejun Heo 1285d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq, 12861da177e4SLinus Torvalds struct work_struct *work) 12871da177e4SLinus Torvalds { 1288112202d9STejun Heo struct pool_workqueue *pwq; 1289c9178087STejun Heo struct worker_pool *last_pool; 12901e19ffc6STejun Heo struct list_head *worklist; 12918a2e8e5dSTejun Heo unsigned int work_flags; 1292b75cac93SJoonsoo Kim unsigned int req_cpu = cpu; 12938930cabaSTejun Heo 12948930cabaSTejun Heo /* 12958930cabaSTejun Heo * While a work item is PENDING && off queue, a task trying to 12968930cabaSTejun Heo * steal the PENDING will busy-loop waiting for it to either get 12978930cabaSTejun Heo * queued or lose PENDING. Grabbing PENDING and queueing should 12988930cabaSTejun Heo * happen with IRQ disabled. 12998930cabaSTejun Heo */ 13008930cabaSTejun Heo WARN_ON_ONCE(!irqs_disabled()); 13011da177e4SLinus Torvalds 1302dc186ad7SThomas Gleixner debug_work_activate(work); 13031e19ffc6STejun Heo 1304c8efcc25STejun Heo /* if dying, only works from the same workqueue are allowed */ 1305618b01ebSTejun Heo if (unlikely(wq->flags & __WQ_DRAINING) && 1306c8efcc25STejun Heo WARN_ON_ONCE(!is_chained_work(wq))) 1307e41e704bSTejun Heo return; 13089e8cd2f5STejun Heo retry: 1309df2d5ae4STejun Heo if (req_cpu == WORK_CPU_UNBOUND) 1310f3421797STejun Heo cpu = raw_smp_processor_id(); 1311df2d5ae4STejun Heo 1312df2d5ae4STejun Heo /* pwq which will be used unless @work is executing elsewhere */ 1313df2d5ae4STejun Heo if (!(wq->flags & WQ_UNBOUND)) 1314c9178087STejun Heo pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); 1315df2d5ae4STejun Heo else 1316df2d5ae4STejun Heo pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu)); 1317f3421797STejun Heo 131818aa9effSTejun Heo /* 1319c9178087STejun Heo * If @work was previously on a different pool, it might still be 1320c9178087STejun Heo * running there, in which case the work needs to be queued on that 1321c9178087STejun Heo * pool to guarantee non-reentrancy. 132218aa9effSTejun Heo */ 1323c9e7cf27STejun Heo last_pool = get_work_pool(work); 1324112202d9STejun Heo if (last_pool && last_pool != pwq->pool) { 132518aa9effSTejun Heo struct worker *worker; 132618aa9effSTejun Heo 1327d565ed63STejun Heo spin_lock(&last_pool->lock); 132818aa9effSTejun Heo 1329c9e7cf27STejun Heo worker = find_worker_executing_work(last_pool, work); 133018aa9effSTejun Heo 1331112202d9STejun Heo if (worker && worker->current_pwq->wq == wq) { 1332c9178087STejun Heo pwq = worker->current_pwq; 13338594fadeSLai Jiangshan } else { 133418aa9effSTejun Heo /* meh... not running there, queue here */ 1335d565ed63STejun Heo spin_unlock(&last_pool->lock); 1336112202d9STejun Heo spin_lock(&pwq->pool->lock); 133718aa9effSTejun Heo } 13388930cabaSTejun Heo } else { 1339112202d9STejun Heo spin_lock(&pwq->pool->lock); 13408930cabaSTejun Heo } 1341502ca9d8STejun Heo 13429e8cd2f5STejun Heo /* 13439e8cd2f5STejun Heo * pwq is determined and locked. For unbound pools, we could have 13449e8cd2f5STejun Heo * raced with pwq release and it could already be dead. If its 13459e8cd2f5STejun Heo * refcnt is zero, repeat pwq selection. Note that pwqs never die 1346df2d5ae4STejun Heo * without another pwq replacing it in the numa_pwq_tbl or while 1347df2d5ae4STejun Heo * work items are executing on it, so the retrying is guaranteed to 13489e8cd2f5STejun Heo * make forward-progress. 13499e8cd2f5STejun Heo */ 13509e8cd2f5STejun Heo if (unlikely(!pwq->refcnt)) { 13519e8cd2f5STejun Heo if (wq->flags & WQ_UNBOUND) { 13529e8cd2f5STejun Heo spin_unlock(&pwq->pool->lock); 13539e8cd2f5STejun Heo cpu_relax(); 13549e8cd2f5STejun Heo goto retry; 13559e8cd2f5STejun Heo } 13569e8cd2f5STejun Heo /* oops */ 13579e8cd2f5STejun Heo WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt", 13589e8cd2f5STejun Heo wq->name, cpu); 13599e8cd2f5STejun Heo } 13609e8cd2f5STejun Heo 1361112202d9STejun Heo /* pwq determined, queue */ 1362112202d9STejun Heo trace_workqueue_queue_work(req_cpu, pwq, work); 1363502ca9d8STejun Heo 1364f5b2552bSDan Carpenter if (WARN_ON(!list_empty(&work->entry))) { 1365112202d9STejun Heo spin_unlock(&pwq->pool->lock); 1366f5b2552bSDan Carpenter return; 1367f5b2552bSDan Carpenter } 13681e19ffc6STejun Heo 1369112202d9STejun Heo pwq->nr_in_flight[pwq->work_color]++; 1370112202d9STejun Heo work_flags = work_color_to_flags(pwq->work_color); 13711e19ffc6STejun Heo 1372112202d9STejun Heo if (likely(pwq->nr_active < pwq->max_active)) { 1373cdadf009STejun Heo trace_workqueue_activate_work(work); 1374112202d9STejun Heo pwq->nr_active++; 1375112202d9STejun Heo worklist = &pwq->pool->worklist; 13768a2e8e5dSTejun Heo } else { 13778a2e8e5dSTejun Heo work_flags |= WORK_STRUCT_DELAYED; 1378112202d9STejun Heo worklist = &pwq->delayed_works; 13798a2e8e5dSTejun Heo } 13801e19ffc6STejun Heo 1381112202d9STejun Heo insert_work(pwq, work, worklist, work_flags); 13821e19ffc6STejun Heo 1383112202d9STejun Heo spin_unlock(&pwq->pool->lock); 13841da177e4SLinus Torvalds } 13851da177e4SLinus Torvalds 13860fcb78c2SRolf Eike Beer /** 1387c1a220e7SZhang Rui * queue_work_on - queue work on specific cpu 1388c1a220e7SZhang Rui * @cpu: CPU number to execute work on 1389c1a220e7SZhang Rui * @wq: workqueue to use 1390c1a220e7SZhang Rui * @work: work to queue 1391c1a220e7SZhang Rui * 1392d4283e93STejun Heo * Returns %false if @work was already on a queue, %true otherwise. 1393c1a220e7SZhang Rui * 1394c1a220e7SZhang Rui * We queue the work to a specific CPU, the caller must ensure it 1395c1a220e7SZhang Rui * can't go away. 1396c1a220e7SZhang Rui */ 1397d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq, 1398d4283e93STejun Heo struct work_struct *work) 1399c1a220e7SZhang Rui { 1400d4283e93STejun Heo bool ret = false; 14018930cabaSTejun Heo unsigned long flags; 14028930cabaSTejun Heo 14038930cabaSTejun Heo local_irq_save(flags); 1404c1a220e7SZhang Rui 140522df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 14064690c4abSTejun Heo __queue_work(cpu, wq, work); 1407d4283e93STejun Heo ret = true; 1408c1a220e7SZhang Rui } 14098930cabaSTejun Heo 14108930cabaSTejun Heo local_irq_restore(flags); 1411c1a220e7SZhang Rui return ret; 1412c1a220e7SZhang Rui } 1413c1a220e7SZhang Rui EXPORT_SYMBOL_GPL(queue_work_on); 1414c1a220e7SZhang Rui 1415d8e794dfSTejun Heo void delayed_work_timer_fn(unsigned long __data) 14161da177e4SLinus Torvalds { 141752bad64dSDavid Howells struct delayed_work *dwork = (struct delayed_work *)__data; 14181da177e4SLinus Torvalds 1419e0aecdd8STejun Heo /* should have been called from irqsafe timer with irq already off */ 142060c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 14211da177e4SLinus Torvalds } 14221438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn); 14231da177e4SLinus Torvalds 14247beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq, 142552bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 14261da177e4SLinus Torvalds { 14277beb2edfSTejun Heo struct timer_list *timer = &dwork->timer; 14287beb2edfSTejun Heo struct work_struct *work = &dwork->work; 14291da177e4SLinus Torvalds 14307beb2edfSTejun Heo WARN_ON_ONCE(timer->function != delayed_work_timer_fn || 14317beb2edfSTejun Heo timer->data != (unsigned long)dwork); 1432fc4b514fSTejun Heo WARN_ON_ONCE(timer_pending(timer)); 1433fc4b514fSTejun Heo WARN_ON_ONCE(!list_empty(&work->entry)); 14347beb2edfSTejun Heo 14358852aac2STejun Heo /* 14368852aac2STejun Heo * If @delay is 0, queue @dwork->work immediately. This is for 14378852aac2STejun Heo * both optimization and correctness. The earliest @timer can 14388852aac2STejun Heo * expire is on the closest next tick and delayed_work users depend 14398852aac2STejun Heo * on that there's no such delay when @delay is 0. 14408852aac2STejun Heo */ 14418852aac2STejun Heo if (!delay) { 14428852aac2STejun Heo __queue_work(cpu, wq, &dwork->work); 14438852aac2STejun Heo return; 14448852aac2STejun Heo } 14458852aac2STejun Heo 14467beb2edfSTejun Heo timer_stats_timer_set_start_info(&dwork->timer); 14477beb2edfSTejun Heo 144860c057bcSLai Jiangshan dwork->wq = wq; 14491265057fSTejun Heo dwork->cpu = cpu; 14507beb2edfSTejun Heo timer->expires = jiffies + delay; 14517beb2edfSTejun Heo 14527beb2edfSTejun Heo if (unlikely(cpu != WORK_CPU_UNBOUND)) 14537beb2edfSTejun Heo add_timer_on(timer, cpu); 14547beb2edfSTejun Heo else 14557beb2edfSTejun Heo add_timer(timer); 14567beb2edfSTejun Heo } 14571da177e4SLinus Torvalds 14580fcb78c2SRolf Eike Beer /** 14590fcb78c2SRolf Eike Beer * queue_delayed_work_on - queue work on specific CPU after delay 14600fcb78c2SRolf Eike Beer * @cpu: CPU number to execute work on 14610fcb78c2SRolf Eike Beer * @wq: workqueue to use 1462af9997e4SRandy Dunlap * @dwork: work to queue 14630fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 14640fcb78c2SRolf Eike Beer * 1465715f1300STejun Heo * Returns %false if @work was already on a queue, %true otherwise. If 1466715f1300STejun Heo * @delay is zero and @dwork is idle, it will be scheduled for immediate 1467715f1300STejun Heo * execution. 14680fcb78c2SRolf Eike Beer */ 1469d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 147052bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 14717a6bc1cdSVenkatesh Pallipadi { 147252bad64dSDavid Howells struct work_struct *work = &dwork->work; 1473d4283e93STejun Heo bool ret = false; 14748930cabaSTejun Heo unsigned long flags; 14758930cabaSTejun Heo 14768930cabaSTejun Heo /* read the comment in __queue_work() */ 14778930cabaSTejun Heo local_irq_save(flags); 14787a6bc1cdSVenkatesh Pallipadi 147922df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 14807beb2edfSTejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 1481d4283e93STejun Heo ret = true; 14827a6bc1cdSVenkatesh Pallipadi } 14838930cabaSTejun Heo 14848930cabaSTejun Heo local_irq_restore(flags); 14857a6bc1cdSVenkatesh Pallipadi return ret; 14867a6bc1cdSVenkatesh Pallipadi } 1487ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(queue_delayed_work_on); 14881da177e4SLinus Torvalds 1489c8e55f36STejun Heo /** 14908376fe22STejun Heo * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU 14918376fe22STejun Heo * @cpu: CPU number to execute work on 14928376fe22STejun Heo * @wq: workqueue to use 14938376fe22STejun Heo * @dwork: work to queue 14948376fe22STejun Heo * @delay: number of jiffies to wait before queueing 14958376fe22STejun Heo * 14968376fe22STejun Heo * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise, 14978376fe22STejun Heo * modify @dwork's timer so that it expires after @delay. If @delay is 14988376fe22STejun Heo * zero, @work is guaranteed to be scheduled immediately regardless of its 14998376fe22STejun Heo * current state. 15008376fe22STejun Heo * 15018376fe22STejun Heo * Returns %false if @dwork was idle and queued, %true if @dwork was 15028376fe22STejun Heo * pending and its timer was modified. 15038376fe22STejun Heo * 1504e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 15058376fe22STejun Heo * See try_to_grab_pending() for details. 15068376fe22STejun Heo */ 15078376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, 15088376fe22STejun Heo struct delayed_work *dwork, unsigned long delay) 15098376fe22STejun Heo { 15108376fe22STejun Heo unsigned long flags; 15118376fe22STejun Heo int ret; 15128376fe22STejun Heo 15138376fe22STejun Heo do { 15148376fe22STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 15158376fe22STejun Heo } while (unlikely(ret == -EAGAIN)); 15168376fe22STejun Heo 15178376fe22STejun Heo if (likely(ret >= 0)) { 15188376fe22STejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 15198376fe22STejun Heo local_irq_restore(flags); 15208376fe22STejun Heo } 15218376fe22STejun Heo 15228376fe22STejun Heo /* -ENOENT from try_to_grab_pending() becomes %true */ 15238376fe22STejun Heo return ret; 15248376fe22STejun Heo } 15258376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on); 15268376fe22STejun Heo 15278376fe22STejun Heo /** 1528c8e55f36STejun Heo * worker_enter_idle - enter idle state 1529c8e55f36STejun Heo * @worker: worker which is entering idle state 1530c8e55f36STejun Heo * 1531c8e55f36STejun Heo * @worker is entering idle state. Update stats and idle timer if 1532c8e55f36STejun Heo * necessary. 1533c8e55f36STejun Heo * 1534c8e55f36STejun Heo * LOCKING: 1535d565ed63STejun Heo * spin_lock_irq(pool->lock). 1536c8e55f36STejun Heo */ 1537c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker) 15381da177e4SLinus Torvalds { 1539bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1540c8e55f36STejun Heo 15416183c009STejun Heo if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) || 15426183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->entry) && 15436183c009STejun Heo (worker->hentry.next || worker->hentry.pprev))) 15446183c009STejun Heo return; 1545c8e55f36STejun Heo 1546cb444766STejun Heo /* can't use worker_set_flags(), also called from start_worker() */ 1547cb444766STejun Heo worker->flags |= WORKER_IDLE; 1548bd7bdd43STejun Heo pool->nr_idle++; 1549e22bee78STejun Heo worker->last_active = jiffies; 1550c8e55f36STejun Heo 1551c8e55f36STejun Heo /* idle_list is LIFO */ 1552bd7bdd43STejun Heo list_add(&worker->entry, &pool->idle_list); 1553db7bccf4STejun Heo 155463d95a91STejun Heo if (too_many_workers(pool) && !timer_pending(&pool->idle_timer)) 1555628c78e7STejun Heo mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT); 1556cb444766STejun Heo 1557544ecf31STejun Heo /* 1558706026c2STejun Heo * Sanity check nr_running. Because wq_unbind_fn() releases 1559d565ed63STejun Heo * pool->lock between setting %WORKER_UNBOUND and zapping 1560628c78e7STejun Heo * nr_running, the warning may trigger spuriously. Check iff 1561628c78e7STejun Heo * unbind is not in progress. 1562544ecf31STejun Heo */ 156324647570STejun Heo WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 1564bd7bdd43STejun Heo pool->nr_workers == pool->nr_idle && 1565e19e397aSTejun Heo atomic_read(&pool->nr_running)); 1566c8e55f36STejun Heo } 1567c8e55f36STejun Heo 1568c8e55f36STejun Heo /** 1569c8e55f36STejun Heo * worker_leave_idle - leave idle state 1570c8e55f36STejun Heo * @worker: worker which is leaving idle state 1571c8e55f36STejun Heo * 1572c8e55f36STejun Heo * @worker is leaving idle state. Update stats. 1573c8e55f36STejun Heo * 1574c8e55f36STejun Heo * LOCKING: 1575d565ed63STejun Heo * spin_lock_irq(pool->lock). 1576c8e55f36STejun Heo */ 1577c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker) 1578c8e55f36STejun Heo { 1579bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1580c8e55f36STejun Heo 15816183c009STejun Heo if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE))) 15826183c009STejun Heo return; 1583d302f017STejun Heo worker_clr_flags(worker, WORKER_IDLE); 1584bd7bdd43STejun Heo pool->nr_idle--; 1585c8e55f36STejun Heo list_del_init(&worker->entry); 1586c8e55f36STejun Heo } 1587c8e55f36STejun Heo 1588e22bee78STejun Heo /** 1589f36dc67bSLai Jiangshan * worker_maybe_bind_and_lock - try to bind %current to worker_pool and lock it 1590f36dc67bSLai Jiangshan * @pool: target worker_pool 1591f36dc67bSLai Jiangshan * 1592f36dc67bSLai Jiangshan * Bind %current to the cpu of @pool if it is associated and lock @pool. 1593e22bee78STejun Heo * 1594e22bee78STejun Heo * Works which are scheduled while the cpu is online must at least be 1595e22bee78STejun Heo * scheduled to a worker which is bound to the cpu so that if they are 1596e22bee78STejun Heo * flushed from cpu callbacks while cpu is going down, they are 1597e22bee78STejun Heo * guaranteed to execute on the cpu. 1598e22bee78STejun Heo * 1599f5faa077SLai Jiangshan * This function is to be used by unbound workers and rescuers to bind 1600e22bee78STejun Heo * themselves to the target cpu and may race with cpu going down or 1601e22bee78STejun Heo * coming online. kthread_bind() can't be used because it may put the 1602e22bee78STejun Heo * worker to already dead cpu and set_cpus_allowed_ptr() can't be used 1603706026c2STejun Heo * verbatim as it's best effort and blocking and pool may be 1604e22bee78STejun Heo * [dis]associated in the meantime. 1605e22bee78STejun Heo * 1606706026c2STejun Heo * This function tries set_cpus_allowed() and locks pool and verifies the 160724647570STejun Heo * binding against %POOL_DISASSOCIATED which is set during 1608f2d5a0eeSTejun Heo * %CPU_DOWN_PREPARE and cleared during %CPU_ONLINE, so if the worker 1609f2d5a0eeSTejun Heo * enters idle state or fetches works without dropping lock, it can 1610f2d5a0eeSTejun Heo * guarantee the scheduling requirement described in the first paragraph. 1611e22bee78STejun Heo * 1612e22bee78STejun Heo * CONTEXT: 1613d565ed63STejun Heo * Might sleep. Called without any lock but returns with pool->lock 1614e22bee78STejun Heo * held. 1615e22bee78STejun Heo * 1616e22bee78STejun Heo * RETURNS: 1617706026c2STejun Heo * %true if the associated pool is online (@worker is successfully 1618e22bee78STejun Heo * bound), %false if offline. 1619e22bee78STejun Heo */ 1620f36dc67bSLai Jiangshan static bool worker_maybe_bind_and_lock(struct worker_pool *pool) 1621d565ed63STejun Heo __acquires(&pool->lock) 1622e22bee78STejun Heo { 1623e22bee78STejun Heo while (true) { 1624e22bee78STejun Heo /* 1625e22bee78STejun Heo * The following call may fail, succeed or succeed 1626e22bee78STejun Heo * without actually migrating the task to the cpu if 1627e22bee78STejun Heo * it races with cpu hotunplug operation. Verify 162824647570STejun Heo * against POOL_DISASSOCIATED. 1629e22bee78STejun Heo */ 163024647570STejun Heo if (!(pool->flags & POOL_DISASSOCIATED)) 16317a4e344cSTejun Heo set_cpus_allowed_ptr(current, pool->attrs->cpumask); 1632e22bee78STejun Heo 1633d565ed63STejun Heo spin_lock_irq(&pool->lock); 163424647570STejun Heo if (pool->flags & POOL_DISASSOCIATED) 1635e22bee78STejun Heo return false; 1636f5faa077SLai Jiangshan if (task_cpu(current) == pool->cpu && 16377a4e344cSTejun Heo cpumask_equal(¤t->cpus_allowed, pool->attrs->cpumask)) 1638e22bee78STejun Heo return true; 1639d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1640e22bee78STejun Heo 16415035b20fSTejun Heo /* 16425035b20fSTejun Heo * We've raced with CPU hot[un]plug. Give it a breather 16435035b20fSTejun Heo * and retry migration. cond_resched() is required here; 16445035b20fSTejun Heo * otherwise, we might deadlock against cpu_stop trying to 16455035b20fSTejun Heo * bring down the CPU on non-preemptive kernel. 16465035b20fSTejun Heo */ 1647e22bee78STejun Heo cpu_relax(); 16485035b20fSTejun Heo cond_resched(); 1649e22bee78STejun Heo } 1650e22bee78STejun Heo } 1651e22bee78STejun Heo 1652c34056a3STejun Heo static struct worker *alloc_worker(void) 1653c34056a3STejun Heo { 1654c34056a3STejun Heo struct worker *worker; 1655c34056a3STejun Heo 1656c34056a3STejun Heo worker = kzalloc(sizeof(*worker), GFP_KERNEL); 1657c8e55f36STejun Heo if (worker) { 1658c8e55f36STejun Heo INIT_LIST_HEAD(&worker->entry); 1659affee4b2STejun Heo INIT_LIST_HEAD(&worker->scheduled); 1660e22bee78STejun Heo /* on creation a worker is in !idle && prep state */ 1661e22bee78STejun Heo worker->flags = WORKER_PREP; 1662c8e55f36STejun Heo } 1663c34056a3STejun Heo return worker; 1664c34056a3STejun Heo } 1665c34056a3STejun Heo 1666c34056a3STejun Heo /** 1667c34056a3STejun Heo * create_worker - create a new workqueue worker 166863d95a91STejun Heo * @pool: pool the new worker will belong to 1669c34056a3STejun Heo * 167063d95a91STejun Heo * Create a new worker which is bound to @pool. The returned worker 1671c34056a3STejun Heo * can be started by calling start_worker() or destroyed using 1672c34056a3STejun Heo * destroy_worker(). 1673c34056a3STejun Heo * 1674c34056a3STejun Heo * CONTEXT: 1675c34056a3STejun Heo * Might sleep. Does GFP_KERNEL allocations. 1676c34056a3STejun Heo * 1677c34056a3STejun Heo * RETURNS: 1678c34056a3STejun Heo * Pointer to the newly created worker. 1679c34056a3STejun Heo */ 1680bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool) 1681c34056a3STejun Heo { 1682c34056a3STejun Heo struct worker *worker = NULL; 1683f3421797STejun Heo int id = -1; 1684e3c916a4STejun Heo char id_buf[16]; 1685c34056a3STejun Heo 1686cd549687STejun Heo lockdep_assert_held(&pool->manager_mutex); 1687cd549687STejun Heo 1688822d8405STejun Heo /* 1689822d8405STejun Heo * ID is needed to determine kthread name. Allocate ID first 1690822d8405STejun Heo * without installing the pointer. 1691822d8405STejun Heo */ 1692822d8405STejun Heo idr_preload(GFP_KERNEL); 1693d565ed63STejun Heo spin_lock_irq(&pool->lock); 1694822d8405STejun Heo 1695822d8405STejun Heo id = idr_alloc(&pool->worker_idr, NULL, 0, 0, GFP_NOWAIT); 1696822d8405STejun Heo 1697d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1698822d8405STejun Heo idr_preload_end(); 1699822d8405STejun Heo if (id < 0) 1700c34056a3STejun Heo goto fail; 1701c34056a3STejun Heo 1702c34056a3STejun Heo worker = alloc_worker(); 1703c34056a3STejun Heo if (!worker) 1704c34056a3STejun Heo goto fail; 1705c34056a3STejun Heo 1706bd7bdd43STejun Heo worker->pool = pool; 1707c34056a3STejun Heo worker->id = id; 1708c34056a3STejun Heo 170929c91e99STejun Heo if (pool->cpu >= 0) 1710e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id, 1711e3c916a4STejun Heo pool->attrs->nice < 0 ? "H" : ""); 1712f3421797STejun Heo else 1713e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id); 1714e3c916a4STejun Heo 1715f3f90ad4STejun Heo worker->task = kthread_create_on_node(worker_thread, worker, pool->node, 1716e3c916a4STejun Heo "kworker/%s", id_buf); 1717c34056a3STejun Heo if (IS_ERR(worker->task)) 1718c34056a3STejun Heo goto fail; 1719c34056a3STejun Heo 1720c5aa87bbSTejun Heo /* 1721c5aa87bbSTejun Heo * set_cpus_allowed_ptr() will fail if the cpumask doesn't have any 1722c5aa87bbSTejun Heo * online CPUs. It'll be re-applied when any of the CPUs come up. 1723c5aa87bbSTejun Heo */ 17247a4e344cSTejun Heo set_user_nice(worker->task, pool->attrs->nice); 17257a4e344cSTejun Heo set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask); 17263270476aSTejun Heo 172714a40ffcSTejun Heo /* prevent userland from meddling with cpumask of workqueue workers */ 172814a40ffcSTejun Heo worker->task->flags |= PF_NO_SETAFFINITY; 17297a4e344cSTejun Heo 17307a4e344cSTejun Heo /* 17317a4e344cSTejun Heo * The caller is responsible for ensuring %POOL_DISASSOCIATED 17327a4e344cSTejun Heo * remains stable across this function. See the comments above the 17337a4e344cSTejun Heo * flag definition for details. 17347a4e344cSTejun Heo */ 17357a4e344cSTejun Heo if (pool->flags & POOL_DISASSOCIATED) 1736f3421797STejun Heo worker->flags |= WORKER_UNBOUND; 1737c34056a3STejun Heo 1738822d8405STejun Heo /* successful, commit the pointer to idr */ 1739822d8405STejun Heo spin_lock_irq(&pool->lock); 1740822d8405STejun Heo idr_replace(&pool->worker_idr, worker, worker->id); 1741822d8405STejun Heo spin_unlock_irq(&pool->lock); 1742822d8405STejun Heo 1743c34056a3STejun Heo return worker; 1744822d8405STejun Heo 1745c34056a3STejun Heo fail: 1746c34056a3STejun Heo if (id >= 0) { 1747d565ed63STejun Heo spin_lock_irq(&pool->lock); 1748822d8405STejun Heo idr_remove(&pool->worker_idr, id); 1749d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1750c34056a3STejun Heo } 1751c34056a3STejun Heo kfree(worker); 1752c34056a3STejun Heo return NULL; 1753c34056a3STejun Heo } 1754c34056a3STejun Heo 1755c34056a3STejun Heo /** 1756c34056a3STejun Heo * start_worker - start a newly created worker 1757c34056a3STejun Heo * @worker: worker to start 1758c34056a3STejun Heo * 1759706026c2STejun Heo * Make the pool aware of @worker and start it. 1760c34056a3STejun Heo * 1761c34056a3STejun Heo * CONTEXT: 1762d565ed63STejun Heo * spin_lock_irq(pool->lock). 1763c34056a3STejun Heo */ 1764c34056a3STejun Heo static void start_worker(struct worker *worker) 1765c34056a3STejun Heo { 1766cb444766STejun Heo worker->flags |= WORKER_STARTED; 1767bd7bdd43STejun Heo worker->pool->nr_workers++; 1768c8e55f36STejun Heo worker_enter_idle(worker); 1769c34056a3STejun Heo wake_up_process(worker->task); 1770c34056a3STejun Heo } 1771c34056a3STejun Heo 1772c34056a3STejun Heo /** 1773ebf44d16STejun Heo * create_and_start_worker - create and start a worker for a pool 1774ebf44d16STejun Heo * @pool: the target pool 1775ebf44d16STejun Heo * 1776cd549687STejun Heo * Grab the managership of @pool and create and start a new worker for it. 1777ebf44d16STejun Heo */ 1778ebf44d16STejun Heo static int create_and_start_worker(struct worker_pool *pool) 1779ebf44d16STejun Heo { 1780ebf44d16STejun Heo struct worker *worker; 1781ebf44d16STejun Heo 1782cd549687STejun Heo mutex_lock(&pool->manager_mutex); 1783cd549687STejun Heo 1784ebf44d16STejun Heo worker = create_worker(pool); 1785ebf44d16STejun Heo if (worker) { 1786ebf44d16STejun Heo spin_lock_irq(&pool->lock); 1787ebf44d16STejun Heo start_worker(worker); 1788ebf44d16STejun Heo spin_unlock_irq(&pool->lock); 1789ebf44d16STejun Heo } 1790ebf44d16STejun Heo 1791cd549687STejun Heo mutex_unlock(&pool->manager_mutex); 1792cd549687STejun Heo 1793ebf44d16STejun Heo return worker ? 0 : -ENOMEM; 1794ebf44d16STejun Heo } 1795ebf44d16STejun Heo 1796ebf44d16STejun Heo /** 1797c34056a3STejun Heo * destroy_worker - destroy a workqueue worker 1798c34056a3STejun Heo * @worker: worker to be destroyed 1799c34056a3STejun Heo * 1800706026c2STejun Heo * Destroy @worker and adjust @pool stats accordingly. 1801c8e55f36STejun Heo * 1802c8e55f36STejun Heo * CONTEXT: 1803d565ed63STejun Heo * spin_lock_irq(pool->lock) which is released and regrabbed. 1804c34056a3STejun Heo */ 1805c34056a3STejun Heo static void destroy_worker(struct worker *worker) 1806c34056a3STejun Heo { 1807bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1808c34056a3STejun Heo 1809cd549687STejun Heo lockdep_assert_held(&pool->manager_mutex); 1810cd549687STejun Heo lockdep_assert_held(&pool->lock); 1811cd549687STejun Heo 1812c34056a3STejun Heo /* sanity check frenzy */ 18136183c009STejun Heo if (WARN_ON(worker->current_work) || 18146183c009STejun Heo WARN_ON(!list_empty(&worker->scheduled))) 18156183c009STejun Heo return; 1816c34056a3STejun Heo 1817c8e55f36STejun Heo if (worker->flags & WORKER_STARTED) 1818bd7bdd43STejun Heo pool->nr_workers--; 1819c8e55f36STejun Heo if (worker->flags & WORKER_IDLE) 1820bd7bdd43STejun Heo pool->nr_idle--; 1821c8e55f36STejun Heo 1822c8e55f36STejun Heo list_del_init(&worker->entry); 1823cb444766STejun Heo worker->flags |= WORKER_DIE; 1824c8e55f36STejun Heo 1825822d8405STejun Heo idr_remove(&pool->worker_idr, worker->id); 1826822d8405STejun Heo 1827d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1828c8e55f36STejun Heo 1829c34056a3STejun Heo kthread_stop(worker->task); 1830c34056a3STejun Heo kfree(worker); 1831c34056a3STejun Heo 1832d565ed63STejun Heo spin_lock_irq(&pool->lock); 1833c34056a3STejun Heo } 1834c34056a3STejun Heo 183563d95a91STejun Heo static void idle_worker_timeout(unsigned long __pool) 1836e22bee78STejun Heo { 183763d95a91STejun Heo struct worker_pool *pool = (void *)__pool; 1838e22bee78STejun Heo 1839d565ed63STejun Heo spin_lock_irq(&pool->lock); 1840e22bee78STejun Heo 184163d95a91STejun Heo if (too_many_workers(pool)) { 1842e22bee78STejun Heo struct worker *worker; 1843e22bee78STejun Heo unsigned long expires; 1844e22bee78STejun Heo 1845e22bee78STejun Heo /* idle_list is kept in LIFO order, check the last one */ 184663d95a91STejun Heo worker = list_entry(pool->idle_list.prev, struct worker, entry); 1847e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 1848e22bee78STejun Heo 1849e22bee78STejun Heo if (time_before(jiffies, expires)) 185063d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 1851e22bee78STejun Heo else { 1852e22bee78STejun Heo /* it's been idle for too long, wake up manager */ 185311ebea50STejun Heo pool->flags |= POOL_MANAGE_WORKERS; 185463d95a91STejun Heo wake_up_worker(pool); 1855e22bee78STejun Heo } 1856e22bee78STejun Heo } 1857e22bee78STejun Heo 1858d565ed63STejun Heo spin_unlock_irq(&pool->lock); 1859e22bee78STejun Heo } 1860e22bee78STejun Heo 1861493a1724STejun Heo static void send_mayday(struct work_struct *work) 1862e22bee78STejun Heo { 1863112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 1864112202d9STejun Heo struct workqueue_struct *wq = pwq->wq; 1865493a1724STejun Heo 18662e109a28STejun Heo lockdep_assert_held(&wq_mayday_lock); 1867e22bee78STejun Heo 1868493008a8STejun Heo if (!wq->rescuer) 1869493a1724STejun Heo return; 1870e22bee78STejun Heo 1871e22bee78STejun Heo /* mayday mayday mayday */ 1872493a1724STejun Heo if (list_empty(&pwq->mayday_node)) { 1873493a1724STejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 1874e22bee78STejun Heo wake_up_process(wq->rescuer->task); 1875493a1724STejun Heo } 1876e22bee78STejun Heo } 1877e22bee78STejun Heo 1878706026c2STejun Heo static void pool_mayday_timeout(unsigned long __pool) 1879e22bee78STejun Heo { 188063d95a91STejun Heo struct worker_pool *pool = (void *)__pool; 1881e22bee78STejun Heo struct work_struct *work; 1882e22bee78STejun Heo 18832e109a28STejun Heo spin_lock_irq(&wq_mayday_lock); /* for wq->maydays */ 1884493a1724STejun Heo spin_lock(&pool->lock); 1885e22bee78STejun Heo 188663d95a91STejun Heo if (need_to_create_worker(pool)) { 1887e22bee78STejun Heo /* 1888e22bee78STejun Heo * We've been trying to create a new worker but 1889e22bee78STejun Heo * haven't been successful. We might be hitting an 1890e22bee78STejun Heo * allocation deadlock. Send distress signals to 1891e22bee78STejun Heo * rescuers. 1892e22bee78STejun Heo */ 189363d95a91STejun Heo list_for_each_entry(work, &pool->worklist, entry) 1894e22bee78STejun Heo send_mayday(work); 1895e22bee78STejun Heo } 1896e22bee78STejun Heo 1897493a1724STejun Heo spin_unlock(&pool->lock); 18982e109a28STejun Heo spin_unlock_irq(&wq_mayday_lock); 1899e22bee78STejun Heo 190063d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL); 1901e22bee78STejun Heo } 1902e22bee78STejun Heo 1903e22bee78STejun Heo /** 1904e22bee78STejun Heo * maybe_create_worker - create a new worker if necessary 190563d95a91STejun Heo * @pool: pool to create a new worker for 1906e22bee78STejun Heo * 190763d95a91STejun Heo * Create a new worker for @pool if necessary. @pool is guaranteed to 1908e22bee78STejun Heo * have at least one idle worker on return from this function. If 1909e22bee78STejun Heo * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is 191063d95a91STejun Heo * sent to all rescuers with works scheduled on @pool to resolve 1911e22bee78STejun Heo * possible allocation deadlock. 1912e22bee78STejun Heo * 1913c5aa87bbSTejun Heo * On return, need_to_create_worker() is guaranteed to be %false and 1914c5aa87bbSTejun Heo * may_start_working() %true. 1915e22bee78STejun Heo * 1916e22bee78STejun Heo * LOCKING: 1917d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 1918e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. Called only from 1919e22bee78STejun Heo * manager. 1920e22bee78STejun Heo * 1921e22bee78STejun Heo * RETURNS: 1922c5aa87bbSTejun Heo * %false if no action was taken and pool->lock stayed locked, %true 1923e22bee78STejun Heo * otherwise. 1924e22bee78STejun Heo */ 192563d95a91STejun Heo static bool maybe_create_worker(struct worker_pool *pool) 1926d565ed63STejun Heo __releases(&pool->lock) 1927d565ed63STejun Heo __acquires(&pool->lock) 1928e22bee78STejun Heo { 192963d95a91STejun Heo if (!need_to_create_worker(pool)) 1930e22bee78STejun Heo return false; 1931e22bee78STejun Heo restart: 1932d565ed63STejun Heo spin_unlock_irq(&pool->lock); 19339f9c2364STejun Heo 1934e22bee78STejun Heo /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ 193563d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); 1936e22bee78STejun Heo 1937e22bee78STejun Heo while (true) { 1938e22bee78STejun Heo struct worker *worker; 1939e22bee78STejun Heo 1940bc2ae0f5STejun Heo worker = create_worker(pool); 1941e22bee78STejun Heo if (worker) { 194263d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 1943d565ed63STejun Heo spin_lock_irq(&pool->lock); 1944e22bee78STejun Heo start_worker(worker); 19456183c009STejun Heo if (WARN_ON_ONCE(need_to_create_worker(pool))) 19466183c009STejun Heo goto restart; 1947e22bee78STejun Heo return true; 1948e22bee78STejun Heo } 1949e22bee78STejun Heo 195063d95a91STejun Heo if (!need_to_create_worker(pool)) 1951e22bee78STejun Heo break; 1952e22bee78STejun Heo 1953e22bee78STejun Heo __set_current_state(TASK_INTERRUPTIBLE); 1954e22bee78STejun Heo schedule_timeout(CREATE_COOLDOWN); 19559f9c2364STejun Heo 195663d95a91STejun Heo if (!need_to_create_worker(pool)) 1957e22bee78STejun Heo break; 1958e22bee78STejun Heo } 1959e22bee78STejun Heo 196063d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 1961d565ed63STejun Heo spin_lock_irq(&pool->lock); 196263d95a91STejun Heo if (need_to_create_worker(pool)) 1963e22bee78STejun Heo goto restart; 1964e22bee78STejun Heo return true; 1965e22bee78STejun Heo } 1966e22bee78STejun Heo 1967e22bee78STejun Heo /** 1968e22bee78STejun Heo * maybe_destroy_worker - destroy workers which have been idle for a while 196963d95a91STejun Heo * @pool: pool to destroy workers for 1970e22bee78STejun Heo * 197163d95a91STejun Heo * Destroy @pool workers which have been idle for longer than 1972e22bee78STejun Heo * IDLE_WORKER_TIMEOUT. 1973e22bee78STejun Heo * 1974e22bee78STejun Heo * LOCKING: 1975d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 1976e22bee78STejun Heo * multiple times. Called only from manager. 1977e22bee78STejun Heo * 1978e22bee78STejun Heo * RETURNS: 1979c5aa87bbSTejun Heo * %false if no action was taken and pool->lock stayed locked, %true 1980e22bee78STejun Heo * otherwise. 1981e22bee78STejun Heo */ 198263d95a91STejun Heo static bool maybe_destroy_workers(struct worker_pool *pool) 1983e22bee78STejun Heo { 1984e22bee78STejun Heo bool ret = false; 1985e22bee78STejun Heo 198663d95a91STejun Heo while (too_many_workers(pool)) { 1987e22bee78STejun Heo struct worker *worker; 1988e22bee78STejun Heo unsigned long expires; 1989e22bee78STejun Heo 199063d95a91STejun Heo worker = list_entry(pool->idle_list.prev, struct worker, entry); 1991e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 1992e22bee78STejun Heo 1993e22bee78STejun Heo if (time_before(jiffies, expires)) { 199463d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 1995e22bee78STejun Heo break; 1996e22bee78STejun Heo } 1997e22bee78STejun Heo 1998e22bee78STejun Heo destroy_worker(worker); 1999e22bee78STejun Heo ret = true; 2000e22bee78STejun Heo } 2001e22bee78STejun Heo 2002e22bee78STejun Heo return ret; 2003e22bee78STejun Heo } 2004e22bee78STejun Heo 2005e22bee78STejun Heo /** 2006e22bee78STejun Heo * manage_workers - manage worker pool 2007e22bee78STejun Heo * @worker: self 2008e22bee78STejun Heo * 2009706026c2STejun Heo * Assume the manager role and manage the worker pool @worker belongs 2010e22bee78STejun Heo * to. At any given time, there can be only zero or one manager per 2011706026c2STejun Heo * pool. The exclusion is handled automatically by this function. 2012e22bee78STejun Heo * 2013e22bee78STejun Heo * The caller can safely start processing works on false return. On 2014e22bee78STejun Heo * true return, it's guaranteed that need_to_create_worker() is false 2015e22bee78STejun Heo * and may_start_working() is true. 2016e22bee78STejun Heo * 2017e22bee78STejun Heo * CONTEXT: 2018d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2019e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. 2020e22bee78STejun Heo * 2021e22bee78STejun Heo * RETURNS: 2022d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2023d565ed63STejun Heo * multiple times. Does GFP_KERNEL allocations. 2024e22bee78STejun Heo */ 2025e22bee78STejun Heo static bool manage_workers(struct worker *worker) 2026e22bee78STejun Heo { 202763d95a91STejun Heo struct worker_pool *pool = worker->pool; 2028e22bee78STejun Heo bool ret = false; 2029e22bee78STejun Heo 2030bc3a1afcSTejun Heo /* 2031bc3a1afcSTejun Heo * Managership is governed by two mutexes - manager_arb and 2032bc3a1afcSTejun Heo * manager_mutex. manager_arb handles arbitration of manager role. 2033bc3a1afcSTejun Heo * Anyone who successfully grabs manager_arb wins the arbitration 2034bc3a1afcSTejun Heo * and becomes the manager. mutex_trylock() on pool->manager_arb 2035bc3a1afcSTejun Heo * failure while holding pool->lock reliably indicates that someone 2036bc3a1afcSTejun Heo * else is managing the pool and the worker which failed trylock 2037bc3a1afcSTejun Heo * can proceed to executing work items. This means that anyone 2038bc3a1afcSTejun Heo * grabbing manager_arb is responsible for actually performing 2039bc3a1afcSTejun Heo * manager duties. If manager_arb is grabbed and released without 2040bc3a1afcSTejun Heo * actual management, the pool may stall indefinitely. 2041bc3a1afcSTejun Heo * 2042bc3a1afcSTejun Heo * manager_mutex is used for exclusion of actual management 2043bc3a1afcSTejun Heo * operations. The holder of manager_mutex can be sure that none 2044bc3a1afcSTejun Heo * of management operations, including creation and destruction of 2045bc3a1afcSTejun Heo * workers, won't take place until the mutex is released. Because 2046bc3a1afcSTejun Heo * manager_mutex doesn't interfere with manager role arbitration, 2047bc3a1afcSTejun Heo * it is guaranteed that the pool's management, while may be 2048bc3a1afcSTejun Heo * delayed, won't be disturbed by someone else grabbing 2049bc3a1afcSTejun Heo * manager_mutex. 2050bc3a1afcSTejun Heo */ 205134a06bd6STejun Heo if (!mutex_trylock(&pool->manager_arb)) 2052e22bee78STejun Heo return ret; 2053e22bee78STejun Heo 2054ee378aa4SLai Jiangshan /* 2055bc3a1afcSTejun Heo * With manager arbitration won, manager_mutex would be free in 2056bc3a1afcSTejun Heo * most cases. trylock first without dropping @pool->lock. 2057ee378aa4SLai Jiangshan */ 2058bc3a1afcSTejun Heo if (unlikely(!mutex_trylock(&pool->manager_mutex))) { 2059d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2060bc3a1afcSTejun Heo mutex_lock(&pool->manager_mutex); 2061ee378aa4SLai Jiangshan ret = true; 2062ee378aa4SLai Jiangshan } 2063ee378aa4SLai Jiangshan 206411ebea50STejun Heo pool->flags &= ~POOL_MANAGE_WORKERS; 2065e22bee78STejun Heo 2066e22bee78STejun Heo /* 2067e22bee78STejun Heo * Destroy and then create so that may_start_working() is true 2068e22bee78STejun Heo * on return. 2069e22bee78STejun Heo */ 207063d95a91STejun Heo ret |= maybe_destroy_workers(pool); 207163d95a91STejun Heo ret |= maybe_create_worker(pool); 2072e22bee78STejun Heo 2073bc3a1afcSTejun Heo mutex_unlock(&pool->manager_mutex); 207434a06bd6STejun Heo mutex_unlock(&pool->manager_arb); 2075e22bee78STejun Heo return ret; 2076e22bee78STejun Heo } 2077e22bee78STejun Heo 2078a62428c0STejun Heo /** 2079a62428c0STejun Heo * process_one_work - process single work 2080c34056a3STejun Heo * @worker: self 2081a62428c0STejun Heo * @work: work to process 2082a62428c0STejun Heo * 2083a62428c0STejun Heo * Process @work. This function contains all the logics necessary to 2084a62428c0STejun Heo * process a single work including synchronization against and 2085a62428c0STejun Heo * interaction with other workers on the same cpu, queueing and 2086a62428c0STejun Heo * flushing. As long as context requirement is met, any worker can 2087a62428c0STejun Heo * call this function to process a work. 2088a62428c0STejun Heo * 2089a62428c0STejun Heo * CONTEXT: 2090d565ed63STejun Heo * spin_lock_irq(pool->lock) which is released and regrabbed. 2091a62428c0STejun Heo */ 2092c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work) 2093d565ed63STejun Heo __releases(&pool->lock) 2094d565ed63STejun Heo __acquires(&pool->lock) 20951da177e4SLinus Torvalds { 2096112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 2097bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 2098112202d9STejun Heo bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE; 209973f53c4aSTejun Heo int work_color; 21007e11629dSTejun Heo struct worker *collision; 21014e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 21024e6045f1SJohannes Berg /* 2103a62428c0STejun Heo * It is permissible to free the struct work_struct from 2104a62428c0STejun Heo * inside the function that is called from it, this we need to 2105a62428c0STejun Heo * take into account for lockdep too. To avoid bogus "held 2106a62428c0STejun Heo * lock freed" warnings as well as problems when looking into 2107a62428c0STejun Heo * work->lockdep_map, make a copy and use that here. 21084e6045f1SJohannes Berg */ 21094d82a1deSPeter Zijlstra struct lockdep_map lockdep_map; 21104d82a1deSPeter Zijlstra 21114d82a1deSPeter Zijlstra lockdep_copy_map(&lockdep_map, &work->lockdep_map); 21124e6045f1SJohannes Berg #endif 21136fec10a1STejun Heo /* 21146fec10a1STejun Heo * Ensure we're on the correct CPU. DISASSOCIATED test is 21156fec10a1STejun Heo * necessary to avoid spurious warnings from rescuers servicing the 211624647570STejun Heo * unbound or a disassociated pool. 21176fec10a1STejun Heo */ 21185f7dabfdSLai Jiangshan WARN_ON_ONCE(!(worker->flags & WORKER_UNBOUND) && 211924647570STejun Heo !(pool->flags & POOL_DISASSOCIATED) && 2120ec22ca5eSTejun Heo raw_smp_processor_id() != pool->cpu); 212125511a47STejun Heo 21227e11629dSTejun Heo /* 21237e11629dSTejun Heo * A single work shouldn't be executed concurrently by 21247e11629dSTejun Heo * multiple workers on a single cpu. Check whether anyone is 21257e11629dSTejun Heo * already processing the work. If so, defer the work to the 21267e11629dSTejun Heo * currently executing one. 21277e11629dSTejun Heo */ 2128c9e7cf27STejun Heo collision = find_worker_executing_work(pool, work); 21297e11629dSTejun Heo if (unlikely(collision)) { 21307e11629dSTejun Heo move_linked_works(work, &collision->scheduled, NULL); 21317e11629dSTejun Heo return; 21327e11629dSTejun Heo } 21331da177e4SLinus Torvalds 21348930cabaSTejun Heo /* claim and dequeue */ 21351da177e4SLinus Torvalds debug_work_deactivate(work); 2136c9e7cf27STejun Heo hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work); 2137c34056a3STejun Heo worker->current_work = work; 2138a2c1c57bSTejun Heo worker->current_func = work->func; 2139112202d9STejun Heo worker->current_pwq = pwq; 214073f53c4aSTejun Heo work_color = get_work_color(work); 21417a22ad75STejun Heo 2142a62428c0STejun Heo list_del_init(&work->entry); 2143a62428c0STejun Heo 2144649027d7STejun Heo /* 2145fb0e7bebSTejun Heo * CPU intensive works don't participate in concurrency 2146fb0e7bebSTejun Heo * management. They're the scheduler's responsibility. 2147fb0e7bebSTejun Heo */ 2148fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2149fb0e7bebSTejun Heo worker_set_flags(worker, WORKER_CPU_INTENSIVE, true); 2150fb0e7bebSTejun Heo 2151974271c4STejun Heo /* 2152d565ed63STejun Heo * Unbound pool isn't concurrency managed and work items should be 2153974271c4STejun Heo * executed ASAP. Wake up another worker if necessary. 2154974271c4STejun Heo */ 215563d95a91STejun Heo if ((worker->flags & WORKER_UNBOUND) && need_more_worker(pool)) 215663d95a91STejun Heo wake_up_worker(pool); 2157974271c4STejun Heo 21588930cabaSTejun Heo /* 21597c3eed5cSTejun Heo * Record the last pool and clear PENDING which should be the last 2160d565ed63STejun Heo * update to @work. Also, do this inside @pool->lock so that 216123657bb1STejun Heo * PENDING and queued state changes happen together while IRQ is 216223657bb1STejun Heo * disabled. 21638930cabaSTejun Heo */ 21647c3eed5cSTejun Heo set_work_pool_and_clear_pending(work, pool->id); 21651da177e4SLinus Torvalds 2166d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2167365970a1SDavid Howells 2168112202d9STejun Heo lock_map_acquire_read(&pwq->wq->lockdep_map); 21693295f0efSIngo Molnar lock_map_acquire(&lockdep_map); 2170e36c886aSArjan van de Ven trace_workqueue_execute_start(work); 2171a2c1c57bSTejun Heo worker->current_func(work); 2172e36c886aSArjan van de Ven /* 2173e36c886aSArjan van de Ven * While we must be careful to not use "work" after this, the trace 2174e36c886aSArjan van de Ven * point will only record its address. 2175e36c886aSArjan van de Ven */ 2176e36c886aSArjan van de Ven trace_workqueue_execute_end(work); 21773295f0efSIngo Molnar lock_map_release(&lockdep_map); 2178112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 21791da177e4SLinus Torvalds 2180d5abe669SPeter Zijlstra if (unlikely(in_atomic() || lockdep_depth(current) > 0)) { 2181044c782cSValentin Ilie pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n" 2182044c782cSValentin Ilie " last function: %pf\n", 2183a2c1c57bSTejun Heo current->comm, preempt_count(), task_pid_nr(current), 2184a2c1c57bSTejun Heo worker->current_func); 2185d5abe669SPeter Zijlstra debug_show_held_locks(current); 2186d5abe669SPeter Zijlstra dump_stack(); 2187d5abe669SPeter Zijlstra } 2188d5abe669SPeter Zijlstra 2189d565ed63STejun Heo spin_lock_irq(&pool->lock); 2190a62428c0STejun Heo 2191fb0e7bebSTejun Heo /* clear cpu intensive status */ 2192fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2193fb0e7bebSTejun Heo worker_clr_flags(worker, WORKER_CPU_INTENSIVE); 2194fb0e7bebSTejun Heo 2195a62428c0STejun Heo /* we're done with it, release */ 219642f8570fSSasha Levin hash_del(&worker->hentry); 2197c34056a3STejun Heo worker->current_work = NULL; 2198a2c1c57bSTejun Heo worker->current_func = NULL; 2199112202d9STejun Heo worker->current_pwq = NULL; 2200112202d9STejun Heo pwq_dec_nr_in_flight(pwq, work_color); 22011da177e4SLinus Torvalds } 22021da177e4SLinus Torvalds 2203affee4b2STejun Heo /** 2204affee4b2STejun Heo * process_scheduled_works - process scheduled works 2205affee4b2STejun Heo * @worker: self 2206affee4b2STejun Heo * 2207affee4b2STejun Heo * Process all scheduled works. Please note that the scheduled list 2208affee4b2STejun Heo * may change while processing a work, so this function repeatedly 2209affee4b2STejun Heo * fetches a work from the top and executes it. 2210affee4b2STejun Heo * 2211affee4b2STejun Heo * CONTEXT: 2212d565ed63STejun Heo * spin_lock_irq(pool->lock) which may be released and regrabbed 2213affee4b2STejun Heo * multiple times. 2214affee4b2STejun Heo */ 2215affee4b2STejun Heo static void process_scheduled_works(struct worker *worker) 22161da177e4SLinus Torvalds { 2217affee4b2STejun Heo while (!list_empty(&worker->scheduled)) { 2218affee4b2STejun Heo struct work_struct *work = list_first_entry(&worker->scheduled, 2219a62428c0STejun Heo struct work_struct, entry); 2220c34056a3STejun Heo process_one_work(worker, work); 2221a62428c0STejun Heo } 22221da177e4SLinus Torvalds } 22231da177e4SLinus Torvalds 22244690c4abSTejun Heo /** 22254690c4abSTejun Heo * worker_thread - the worker thread function 2226c34056a3STejun Heo * @__worker: self 22274690c4abSTejun Heo * 2228c5aa87bbSTejun Heo * The worker thread function. All workers belong to a worker_pool - 2229c5aa87bbSTejun Heo * either a per-cpu one or dynamic unbound one. These workers process all 2230c5aa87bbSTejun Heo * work items regardless of their specific target workqueue. The only 2231c5aa87bbSTejun Heo * exception is work items which belong to workqueues with a rescuer which 2232c5aa87bbSTejun Heo * will be explained in rescuer_thread(). 22334690c4abSTejun Heo */ 2234c34056a3STejun Heo static int worker_thread(void *__worker) 22351da177e4SLinus Torvalds { 2236c34056a3STejun Heo struct worker *worker = __worker; 2237bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 22381da177e4SLinus Torvalds 2239e22bee78STejun Heo /* tell the scheduler that this is a workqueue worker */ 2240e22bee78STejun Heo worker->task->flags |= PF_WQ_WORKER; 2241c8e55f36STejun Heo woke_up: 2242d565ed63STejun Heo spin_lock_irq(&pool->lock); 2243affee4b2STejun Heo 2244a9ab775bSTejun Heo /* am I supposed to die? */ 2245a9ab775bSTejun Heo if (unlikely(worker->flags & WORKER_DIE)) { 2246d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2247a9ab775bSTejun Heo WARN_ON_ONCE(!list_empty(&worker->entry)); 2248e22bee78STejun Heo worker->task->flags &= ~PF_WQ_WORKER; 2249c8e55f36STejun Heo return 0; 2250c8e55f36STejun Heo } 2251c8e55f36STejun Heo 2252c8e55f36STejun Heo worker_leave_idle(worker); 2253db7bccf4STejun Heo recheck: 2254e22bee78STejun Heo /* no more worker necessary? */ 225563d95a91STejun Heo if (!need_more_worker(pool)) 2256e22bee78STejun Heo goto sleep; 2257e22bee78STejun Heo 2258e22bee78STejun Heo /* do we need to manage? */ 225963d95a91STejun Heo if (unlikely(!may_start_working(pool)) && manage_workers(worker)) 2260e22bee78STejun Heo goto recheck; 2261e22bee78STejun Heo 2262c8e55f36STejun Heo /* 2263c8e55f36STejun Heo * ->scheduled list can only be filled while a worker is 2264c8e55f36STejun Heo * preparing to process a work or actually processing it. 2265c8e55f36STejun Heo * Make sure nobody diddled with it while I was sleeping. 2266c8e55f36STejun Heo */ 22676183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->scheduled)); 2268c8e55f36STejun Heo 2269e22bee78STejun Heo /* 2270a9ab775bSTejun Heo * Finish PREP stage. We're guaranteed to have at least one idle 2271a9ab775bSTejun Heo * worker or that someone else has already assumed the manager 2272a9ab775bSTejun Heo * role. This is where @worker starts participating in concurrency 2273a9ab775bSTejun Heo * management if applicable and concurrency management is restored 2274a9ab775bSTejun Heo * after being rebound. See rebind_workers() for details. 2275e22bee78STejun Heo */ 2276a9ab775bSTejun Heo worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND); 2277e22bee78STejun Heo 2278e22bee78STejun Heo do { 2279affee4b2STejun Heo struct work_struct *work = 2280bd7bdd43STejun Heo list_first_entry(&pool->worklist, 2281affee4b2STejun Heo struct work_struct, entry); 2282affee4b2STejun Heo 2283c8e55f36STejun Heo if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) { 2284affee4b2STejun Heo /* optimization path, not strictly necessary */ 2285affee4b2STejun Heo process_one_work(worker, work); 2286affee4b2STejun Heo if (unlikely(!list_empty(&worker->scheduled))) 2287affee4b2STejun Heo process_scheduled_works(worker); 2288affee4b2STejun Heo } else { 2289c8e55f36STejun Heo move_linked_works(work, &worker->scheduled, NULL); 2290affee4b2STejun Heo process_scheduled_works(worker); 2291affee4b2STejun Heo } 229263d95a91STejun Heo } while (keep_working(pool)); 2293affee4b2STejun Heo 2294e22bee78STejun Heo worker_set_flags(worker, WORKER_PREP, false); 2295d313dd85STejun Heo sleep: 229663d95a91STejun Heo if (unlikely(need_to_manage_workers(pool)) && manage_workers(worker)) 2297e22bee78STejun Heo goto recheck; 2298d313dd85STejun Heo 2299c8e55f36STejun Heo /* 2300d565ed63STejun Heo * pool->lock is held and there's no work to process and no need to 2301d565ed63STejun Heo * manage, sleep. Workers are woken up only while holding 2302d565ed63STejun Heo * pool->lock or from local cpu, so setting the current state 2303d565ed63STejun Heo * before releasing pool->lock is enough to prevent losing any 2304d565ed63STejun Heo * event. 2305c8e55f36STejun Heo */ 2306c8e55f36STejun Heo worker_enter_idle(worker); 2307c8e55f36STejun Heo __set_current_state(TASK_INTERRUPTIBLE); 2308d565ed63STejun Heo spin_unlock_irq(&pool->lock); 23091da177e4SLinus Torvalds schedule(); 2310c8e55f36STejun Heo goto woke_up; 23111da177e4SLinus Torvalds } 23121da177e4SLinus Torvalds 2313e22bee78STejun Heo /** 2314e22bee78STejun Heo * rescuer_thread - the rescuer thread function 2315111c225aSTejun Heo * @__rescuer: self 2316e22bee78STejun Heo * 2317e22bee78STejun Heo * Workqueue rescuer thread function. There's one rescuer for each 2318493008a8STejun Heo * workqueue which has WQ_MEM_RECLAIM set. 2319e22bee78STejun Heo * 2320706026c2STejun Heo * Regular work processing on a pool may block trying to create a new 2321e22bee78STejun Heo * worker which uses GFP_KERNEL allocation which has slight chance of 2322e22bee78STejun Heo * developing into deadlock if some works currently on the same queue 2323e22bee78STejun Heo * need to be processed to satisfy the GFP_KERNEL allocation. This is 2324e22bee78STejun Heo * the problem rescuer solves. 2325e22bee78STejun Heo * 2326706026c2STejun Heo * When such condition is possible, the pool summons rescuers of all 2327706026c2STejun Heo * workqueues which have works queued on the pool and let them process 2328e22bee78STejun Heo * those works so that forward progress can be guaranteed. 2329e22bee78STejun Heo * 2330e22bee78STejun Heo * This should happen rarely. 2331e22bee78STejun Heo */ 2332111c225aSTejun Heo static int rescuer_thread(void *__rescuer) 2333e22bee78STejun Heo { 2334111c225aSTejun Heo struct worker *rescuer = __rescuer; 2335111c225aSTejun Heo struct workqueue_struct *wq = rescuer->rescue_wq; 2336e22bee78STejun Heo struct list_head *scheduled = &rescuer->scheduled; 2337e22bee78STejun Heo 2338e22bee78STejun Heo set_user_nice(current, RESCUER_NICE_LEVEL); 2339111c225aSTejun Heo 2340111c225aSTejun Heo /* 2341111c225aSTejun Heo * Mark rescuer as worker too. As WORKER_PREP is never cleared, it 2342111c225aSTejun Heo * doesn't participate in concurrency management. 2343111c225aSTejun Heo */ 2344111c225aSTejun Heo rescuer->task->flags |= PF_WQ_WORKER; 2345e22bee78STejun Heo repeat: 2346e22bee78STejun Heo set_current_state(TASK_INTERRUPTIBLE); 23471da177e4SLinus Torvalds 2348412d32e6SMike Galbraith if (kthread_should_stop()) { 2349412d32e6SMike Galbraith __set_current_state(TASK_RUNNING); 2350111c225aSTejun Heo rescuer->task->flags &= ~PF_WQ_WORKER; 2351e22bee78STejun Heo return 0; 2352412d32e6SMike Galbraith } 23531da177e4SLinus Torvalds 2354493a1724STejun Heo /* see whether any pwq is asking for help */ 23552e109a28STejun Heo spin_lock_irq(&wq_mayday_lock); 2356493a1724STejun Heo 2357493a1724STejun Heo while (!list_empty(&wq->maydays)) { 2358493a1724STejun Heo struct pool_workqueue *pwq = list_first_entry(&wq->maydays, 2359493a1724STejun Heo struct pool_workqueue, mayday_node); 2360112202d9STejun Heo struct worker_pool *pool = pwq->pool; 2361e22bee78STejun Heo struct work_struct *work, *n; 2362e22bee78STejun Heo 2363e22bee78STejun Heo __set_current_state(TASK_RUNNING); 2364493a1724STejun Heo list_del_init(&pwq->mayday_node); 2365493a1724STejun Heo 23662e109a28STejun Heo spin_unlock_irq(&wq_mayday_lock); 2367e22bee78STejun Heo 2368e22bee78STejun Heo /* migrate to the target cpu if possible */ 2369f36dc67bSLai Jiangshan worker_maybe_bind_and_lock(pool); 2370b3104104SLai Jiangshan rescuer->pool = pool; 2371e22bee78STejun Heo 2372e22bee78STejun Heo /* 2373e22bee78STejun Heo * Slurp in all works issued via this workqueue and 2374e22bee78STejun Heo * process'em. 2375e22bee78STejun Heo */ 23766183c009STejun Heo WARN_ON_ONCE(!list_empty(&rescuer->scheduled)); 2377bd7bdd43STejun Heo list_for_each_entry_safe(work, n, &pool->worklist, entry) 2378112202d9STejun Heo if (get_work_pwq(work) == pwq) 2379e22bee78STejun Heo move_linked_works(work, scheduled, &n); 2380e22bee78STejun Heo 2381e22bee78STejun Heo process_scheduled_works(rescuer); 23827576958aSTejun Heo 23837576958aSTejun Heo /* 2384d565ed63STejun Heo * Leave this pool. If keep_working() is %true, notify a 23857576958aSTejun Heo * regular worker; otherwise, we end up with 0 concurrency 23867576958aSTejun Heo * and stalling the execution. 23877576958aSTejun Heo */ 238863d95a91STejun Heo if (keep_working(pool)) 238963d95a91STejun Heo wake_up_worker(pool); 23907576958aSTejun Heo 2391b3104104SLai Jiangshan rescuer->pool = NULL; 2392493a1724STejun Heo spin_unlock(&pool->lock); 23932e109a28STejun Heo spin_lock(&wq_mayday_lock); 23941da177e4SLinus Torvalds } 23951da177e4SLinus Torvalds 23962e109a28STejun Heo spin_unlock_irq(&wq_mayday_lock); 2397493a1724STejun Heo 2398111c225aSTejun Heo /* rescuers should never participate in concurrency management */ 2399111c225aSTejun Heo WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING)); 2400e22bee78STejun Heo schedule(); 2401e22bee78STejun Heo goto repeat; 24021da177e4SLinus Torvalds } 24031da177e4SLinus Torvalds 2404fc2e4d70SOleg Nesterov struct wq_barrier { 2405fc2e4d70SOleg Nesterov struct work_struct work; 2406fc2e4d70SOleg Nesterov struct completion done; 2407fc2e4d70SOleg Nesterov }; 2408fc2e4d70SOleg Nesterov 2409fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work) 2410fc2e4d70SOleg Nesterov { 2411fc2e4d70SOleg Nesterov struct wq_barrier *barr = container_of(work, struct wq_barrier, work); 2412fc2e4d70SOleg Nesterov complete(&barr->done); 2413fc2e4d70SOleg Nesterov } 2414fc2e4d70SOleg Nesterov 24154690c4abSTejun Heo /** 24164690c4abSTejun Heo * insert_wq_barrier - insert a barrier work 2417112202d9STejun Heo * @pwq: pwq to insert barrier into 24184690c4abSTejun Heo * @barr: wq_barrier to insert 2419affee4b2STejun Heo * @target: target work to attach @barr to 2420affee4b2STejun Heo * @worker: worker currently executing @target, NULL if @target is not executing 24214690c4abSTejun Heo * 2422affee4b2STejun Heo * @barr is linked to @target such that @barr is completed only after 2423affee4b2STejun Heo * @target finishes execution. Please note that the ordering 2424affee4b2STejun Heo * guarantee is observed only with respect to @target and on the local 2425affee4b2STejun Heo * cpu. 2426affee4b2STejun Heo * 2427affee4b2STejun Heo * Currently, a queued barrier can't be canceled. This is because 2428affee4b2STejun Heo * try_to_grab_pending() can't determine whether the work to be 2429affee4b2STejun Heo * grabbed is at the head of the queue and thus can't clear LINKED 2430affee4b2STejun Heo * flag of the previous work while there must be a valid next work 2431affee4b2STejun Heo * after a work with LINKED flag set. 2432affee4b2STejun Heo * 2433affee4b2STejun Heo * Note that when @worker is non-NULL, @target may be modified 2434112202d9STejun Heo * underneath us, so we can't reliably determine pwq from @target. 24354690c4abSTejun Heo * 24364690c4abSTejun Heo * CONTEXT: 2437d565ed63STejun Heo * spin_lock_irq(pool->lock). 24384690c4abSTejun Heo */ 2439112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq, 2440affee4b2STejun Heo struct wq_barrier *barr, 2441affee4b2STejun Heo struct work_struct *target, struct worker *worker) 2442fc2e4d70SOleg Nesterov { 2443affee4b2STejun Heo struct list_head *head; 2444affee4b2STejun Heo unsigned int linked = 0; 2445affee4b2STejun Heo 2446dc186ad7SThomas Gleixner /* 2447d565ed63STejun Heo * debugobject calls are safe here even with pool->lock locked 2448dc186ad7SThomas Gleixner * as we know for sure that this will not trigger any of the 2449dc186ad7SThomas Gleixner * checks and call back into the fixup functions where we 2450dc186ad7SThomas Gleixner * might deadlock. 2451dc186ad7SThomas Gleixner */ 2452ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&barr->work, wq_barrier_func); 245322df02bbSTejun Heo __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); 2454fc2e4d70SOleg Nesterov init_completion(&barr->done); 245583c22520SOleg Nesterov 2456affee4b2STejun Heo /* 2457affee4b2STejun Heo * If @target is currently being executed, schedule the 2458affee4b2STejun Heo * barrier to the worker; otherwise, put it after @target. 2459affee4b2STejun Heo */ 2460affee4b2STejun Heo if (worker) 2461affee4b2STejun Heo head = worker->scheduled.next; 2462affee4b2STejun Heo else { 2463affee4b2STejun Heo unsigned long *bits = work_data_bits(target); 2464affee4b2STejun Heo 2465affee4b2STejun Heo head = target->entry.next; 2466affee4b2STejun Heo /* there can already be other linked works, inherit and set */ 2467affee4b2STejun Heo linked = *bits & WORK_STRUCT_LINKED; 2468affee4b2STejun Heo __set_bit(WORK_STRUCT_LINKED_BIT, bits); 2469affee4b2STejun Heo } 2470affee4b2STejun Heo 2471dc186ad7SThomas Gleixner debug_work_activate(&barr->work); 2472112202d9STejun Heo insert_work(pwq, &barr->work, head, 2473affee4b2STejun Heo work_color_to_flags(WORK_NO_COLOR) | linked); 2474fc2e4d70SOleg Nesterov } 2475fc2e4d70SOleg Nesterov 247673f53c4aSTejun Heo /** 2477112202d9STejun Heo * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing 247873f53c4aSTejun Heo * @wq: workqueue being flushed 247973f53c4aSTejun Heo * @flush_color: new flush color, < 0 for no-op 248073f53c4aSTejun Heo * @work_color: new work color, < 0 for no-op 248173f53c4aSTejun Heo * 2482112202d9STejun Heo * Prepare pwqs for workqueue flushing. 248373f53c4aSTejun Heo * 2484112202d9STejun Heo * If @flush_color is non-negative, flush_color on all pwqs should be 2485112202d9STejun Heo * -1. If no pwq has in-flight commands at the specified color, all 2486112202d9STejun Heo * pwq->flush_color's stay at -1 and %false is returned. If any pwq 2487112202d9STejun Heo * has in flight commands, its pwq->flush_color is set to 2488112202d9STejun Heo * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq 248973f53c4aSTejun Heo * wakeup logic is armed and %true is returned. 249073f53c4aSTejun Heo * 249173f53c4aSTejun Heo * The caller should have initialized @wq->first_flusher prior to 249273f53c4aSTejun Heo * calling this function with non-negative @flush_color. If 249373f53c4aSTejun Heo * @flush_color is negative, no flush color update is done and %false 249473f53c4aSTejun Heo * is returned. 249573f53c4aSTejun Heo * 2496112202d9STejun Heo * If @work_color is non-negative, all pwqs should have the same 249773f53c4aSTejun Heo * work_color which is previous to @work_color and all will be 249873f53c4aSTejun Heo * advanced to @work_color. 249973f53c4aSTejun Heo * 250073f53c4aSTejun Heo * CONTEXT: 25013c25a55dSLai Jiangshan * mutex_lock(wq->mutex). 250273f53c4aSTejun Heo * 250373f53c4aSTejun Heo * RETURNS: 250473f53c4aSTejun Heo * %true if @flush_color >= 0 and there's something to flush. %false 250573f53c4aSTejun Heo * otherwise. 250673f53c4aSTejun Heo */ 2507112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq, 250873f53c4aSTejun Heo int flush_color, int work_color) 25091da177e4SLinus Torvalds { 251073f53c4aSTejun Heo bool wait = false; 251149e3cf44STejun Heo struct pool_workqueue *pwq; 25121da177e4SLinus Torvalds 251373f53c4aSTejun Heo if (flush_color >= 0) { 25146183c009STejun Heo WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush)); 2515112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 1); 2516dc186ad7SThomas Gleixner } 251714441960SOleg Nesterov 251849e3cf44STejun Heo for_each_pwq(pwq, wq) { 2519112202d9STejun Heo struct worker_pool *pool = pwq->pool; 25201da177e4SLinus Torvalds 2521b09f4fd3SLai Jiangshan spin_lock_irq(&pool->lock); 252273f53c4aSTejun Heo 252373f53c4aSTejun Heo if (flush_color >= 0) { 25246183c009STejun Heo WARN_ON_ONCE(pwq->flush_color != -1); 252573f53c4aSTejun Heo 2526112202d9STejun Heo if (pwq->nr_in_flight[flush_color]) { 2527112202d9STejun Heo pwq->flush_color = flush_color; 2528112202d9STejun Heo atomic_inc(&wq->nr_pwqs_to_flush); 252973f53c4aSTejun Heo wait = true; 25301da177e4SLinus Torvalds } 253173f53c4aSTejun Heo } 253273f53c4aSTejun Heo 253373f53c4aSTejun Heo if (work_color >= 0) { 25346183c009STejun Heo WARN_ON_ONCE(work_color != work_next_color(pwq->work_color)); 2535112202d9STejun Heo pwq->work_color = work_color; 253673f53c4aSTejun Heo } 253773f53c4aSTejun Heo 2538b09f4fd3SLai Jiangshan spin_unlock_irq(&pool->lock); 25391da177e4SLinus Torvalds } 25401da177e4SLinus Torvalds 2541112202d9STejun Heo if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush)) 254273f53c4aSTejun Heo complete(&wq->first_flusher->done); 254373f53c4aSTejun Heo 254473f53c4aSTejun Heo return wait; 254583c22520SOleg Nesterov } 25461da177e4SLinus Torvalds 25470fcb78c2SRolf Eike Beer /** 25481da177e4SLinus Torvalds * flush_workqueue - ensure that any scheduled work has run to completion. 25490fcb78c2SRolf Eike Beer * @wq: workqueue to flush 25501da177e4SLinus Torvalds * 2551c5aa87bbSTejun Heo * This function sleeps until all work items which were queued on entry 2552c5aa87bbSTejun Heo * have finished execution, but it is not livelocked by new incoming ones. 25531da177e4SLinus Torvalds */ 25547ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq) 25551da177e4SLinus Torvalds { 255673f53c4aSTejun Heo struct wq_flusher this_flusher = { 255773f53c4aSTejun Heo .list = LIST_HEAD_INIT(this_flusher.list), 255873f53c4aSTejun Heo .flush_color = -1, 255973f53c4aSTejun Heo .done = COMPLETION_INITIALIZER_ONSTACK(this_flusher.done), 256073f53c4aSTejun Heo }; 256173f53c4aSTejun Heo int next_color; 2562b1f4ec17SOleg Nesterov 25633295f0efSIngo Molnar lock_map_acquire(&wq->lockdep_map); 25643295f0efSIngo Molnar lock_map_release(&wq->lockdep_map); 256573f53c4aSTejun Heo 25663c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 256773f53c4aSTejun Heo 256873f53c4aSTejun Heo /* 256973f53c4aSTejun Heo * Start-to-wait phase 257073f53c4aSTejun Heo */ 257173f53c4aSTejun Heo next_color = work_next_color(wq->work_color); 257273f53c4aSTejun Heo 257373f53c4aSTejun Heo if (next_color != wq->flush_color) { 257473f53c4aSTejun Heo /* 257573f53c4aSTejun Heo * Color space is not full. The current work_color 257673f53c4aSTejun Heo * becomes our flush_color and work_color is advanced 257773f53c4aSTejun Heo * by one. 257873f53c4aSTejun Heo */ 25796183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow)); 258073f53c4aSTejun Heo this_flusher.flush_color = wq->work_color; 258173f53c4aSTejun Heo wq->work_color = next_color; 258273f53c4aSTejun Heo 258373f53c4aSTejun Heo if (!wq->first_flusher) { 258473f53c4aSTejun Heo /* no flush in progress, become the first flusher */ 25856183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 258673f53c4aSTejun Heo 258773f53c4aSTejun Heo wq->first_flusher = &this_flusher; 258873f53c4aSTejun Heo 2589112202d9STejun Heo if (!flush_workqueue_prep_pwqs(wq, wq->flush_color, 259073f53c4aSTejun Heo wq->work_color)) { 259173f53c4aSTejun Heo /* nothing to flush, done */ 259273f53c4aSTejun Heo wq->flush_color = next_color; 259373f53c4aSTejun Heo wq->first_flusher = NULL; 259473f53c4aSTejun Heo goto out_unlock; 259573f53c4aSTejun Heo } 259673f53c4aSTejun Heo } else { 259773f53c4aSTejun Heo /* wait in queue */ 25986183c009STejun Heo WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color); 259973f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_queue); 2600112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 260173f53c4aSTejun Heo } 260273f53c4aSTejun Heo } else { 260373f53c4aSTejun Heo /* 260473f53c4aSTejun Heo * Oops, color space is full, wait on overflow queue. 260573f53c4aSTejun Heo * The next flush completion will assign us 260673f53c4aSTejun Heo * flush_color and transfer to flusher_queue. 260773f53c4aSTejun Heo */ 260873f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_overflow); 260973f53c4aSTejun Heo } 261073f53c4aSTejun Heo 26113c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 261273f53c4aSTejun Heo 261373f53c4aSTejun Heo wait_for_completion(&this_flusher.done); 261473f53c4aSTejun Heo 261573f53c4aSTejun Heo /* 261673f53c4aSTejun Heo * Wake-up-and-cascade phase 261773f53c4aSTejun Heo * 261873f53c4aSTejun Heo * First flushers are responsible for cascading flushes and 261973f53c4aSTejun Heo * handling overflow. Non-first flushers can simply return. 262073f53c4aSTejun Heo */ 262173f53c4aSTejun Heo if (wq->first_flusher != &this_flusher) 262273f53c4aSTejun Heo return; 262373f53c4aSTejun Heo 26243c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 262573f53c4aSTejun Heo 26264ce48b37STejun Heo /* we might have raced, check again with mutex held */ 26274ce48b37STejun Heo if (wq->first_flusher != &this_flusher) 26284ce48b37STejun Heo goto out_unlock; 26294ce48b37STejun Heo 263073f53c4aSTejun Heo wq->first_flusher = NULL; 263173f53c4aSTejun Heo 26326183c009STejun Heo WARN_ON_ONCE(!list_empty(&this_flusher.list)); 26336183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 263473f53c4aSTejun Heo 263573f53c4aSTejun Heo while (true) { 263673f53c4aSTejun Heo struct wq_flusher *next, *tmp; 263773f53c4aSTejun Heo 263873f53c4aSTejun Heo /* complete all the flushers sharing the current flush color */ 263973f53c4aSTejun Heo list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { 264073f53c4aSTejun Heo if (next->flush_color != wq->flush_color) 264173f53c4aSTejun Heo break; 264273f53c4aSTejun Heo list_del_init(&next->list); 264373f53c4aSTejun Heo complete(&next->done); 264473f53c4aSTejun Heo } 264573f53c4aSTejun Heo 26466183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) && 264773f53c4aSTejun Heo wq->flush_color != work_next_color(wq->work_color)); 264873f53c4aSTejun Heo 264973f53c4aSTejun Heo /* this flush_color is finished, advance by one */ 265073f53c4aSTejun Heo wq->flush_color = work_next_color(wq->flush_color); 265173f53c4aSTejun Heo 265273f53c4aSTejun Heo /* one color has been freed, handle overflow queue */ 265373f53c4aSTejun Heo if (!list_empty(&wq->flusher_overflow)) { 265473f53c4aSTejun Heo /* 265573f53c4aSTejun Heo * Assign the same color to all overflowed 265673f53c4aSTejun Heo * flushers, advance work_color and append to 265773f53c4aSTejun Heo * flusher_queue. This is the start-to-wait 265873f53c4aSTejun Heo * phase for these overflowed flushers. 265973f53c4aSTejun Heo */ 266073f53c4aSTejun Heo list_for_each_entry(tmp, &wq->flusher_overflow, list) 266173f53c4aSTejun Heo tmp->flush_color = wq->work_color; 266273f53c4aSTejun Heo 266373f53c4aSTejun Heo wq->work_color = work_next_color(wq->work_color); 266473f53c4aSTejun Heo 266573f53c4aSTejun Heo list_splice_tail_init(&wq->flusher_overflow, 266673f53c4aSTejun Heo &wq->flusher_queue); 2667112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 266873f53c4aSTejun Heo } 266973f53c4aSTejun Heo 267073f53c4aSTejun Heo if (list_empty(&wq->flusher_queue)) { 26716183c009STejun Heo WARN_ON_ONCE(wq->flush_color != wq->work_color); 267273f53c4aSTejun Heo break; 267373f53c4aSTejun Heo } 267473f53c4aSTejun Heo 267573f53c4aSTejun Heo /* 267673f53c4aSTejun Heo * Need to flush more colors. Make the next flusher 2677112202d9STejun Heo * the new first flusher and arm pwqs. 267873f53c4aSTejun Heo */ 26796183c009STejun Heo WARN_ON_ONCE(wq->flush_color == wq->work_color); 26806183c009STejun Heo WARN_ON_ONCE(wq->flush_color != next->flush_color); 268173f53c4aSTejun Heo 268273f53c4aSTejun Heo list_del_init(&next->list); 268373f53c4aSTejun Heo wq->first_flusher = next; 268473f53c4aSTejun Heo 2685112202d9STejun Heo if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1)) 268673f53c4aSTejun Heo break; 268773f53c4aSTejun Heo 268873f53c4aSTejun Heo /* 268973f53c4aSTejun Heo * Meh... this color is already done, clear first 269073f53c4aSTejun Heo * flusher and repeat cascading. 269173f53c4aSTejun Heo */ 269273f53c4aSTejun Heo wq->first_flusher = NULL; 269373f53c4aSTejun Heo } 269473f53c4aSTejun Heo 269573f53c4aSTejun Heo out_unlock: 26963c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 26971da177e4SLinus Torvalds } 2698ae90dd5dSDave Jones EXPORT_SYMBOL_GPL(flush_workqueue); 26991da177e4SLinus Torvalds 27009c5a2ba7STejun Heo /** 27019c5a2ba7STejun Heo * drain_workqueue - drain a workqueue 27029c5a2ba7STejun Heo * @wq: workqueue to drain 27039c5a2ba7STejun Heo * 27049c5a2ba7STejun Heo * Wait until the workqueue becomes empty. While draining is in progress, 27059c5a2ba7STejun Heo * only chain queueing is allowed. IOW, only currently pending or running 27069c5a2ba7STejun Heo * work items on @wq can queue further work items on it. @wq is flushed 27079c5a2ba7STejun Heo * repeatedly until it becomes empty. The number of flushing is detemined 27089c5a2ba7STejun Heo * by the depth of chaining and should be relatively short. Whine if it 27099c5a2ba7STejun Heo * takes too long. 27109c5a2ba7STejun Heo */ 27119c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq) 27129c5a2ba7STejun Heo { 27139c5a2ba7STejun Heo unsigned int flush_cnt = 0; 271449e3cf44STejun Heo struct pool_workqueue *pwq; 27159c5a2ba7STejun Heo 27169c5a2ba7STejun Heo /* 27179c5a2ba7STejun Heo * __queue_work() needs to test whether there are drainers, is much 27189c5a2ba7STejun Heo * hotter than drain_workqueue() and already looks at @wq->flags. 2719618b01ebSTejun Heo * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers. 27209c5a2ba7STejun Heo */ 272187fc741eSLai Jiangshan mutex_lock(&wq->mutex); 27229c5a2ba7STejun Heo if (!wq->nr_drainers++) 2723618b01ebSTejun Heo wq->flags |= __WQ_DRAINING; 272487fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 27259c5a2ba7STejun Heo reflush: 27269c5a2ba7STejun Heo flush_workqueue(wq); 27279c5a2ba7STejun Heo 2728b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 272976af4d93STejun Heo 273049e3cf44STejun Heo for_each_pwq(pwq, wq) { 2731fa2563e4SThomas Tuttle bool drained; 27329c5a2ba7STejun Heo 2733b09f4fd3SLai Jiangshan spin_lock_irq(&pwq->pool->lock); 2734112202d9STejun Heo drained = !pwq->nr_active && list_empty(&pwq->delayed_works); 2735b09f4fd3SLai Jiangshan spin_unlock_irq(&pwq->pool->lock); 2736fa2563e4SThomas Tuttle 2737fa2563e4SThomas Tuttle if (drained) 27389c5a2ba7STejun Heo continue; 27399c5a2ba7STejun Heo 27409c5a2ba7STejun Heo if (++flush_cnt == 10 || 27419c5a2ba7STejun Heo (flush_cnt % 100 == 0 && flush_cnt <= 1000)) 2742c5aa87bbSTejun Heo pr_warn("workqueue %s: drain_workqueue() isn't complete after %u tries\n", 27439c5a2ba7STejun Heo wq->name, flush_cnt); 274476af4d93STejun Heo 2745b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 27469c5a2ba7STejun Heo goto reflush; 27479c5a2ba7STejun Heo } 27489c5a2ba7STejun Heo 27499c5a2ba7STejun Heo if (!--wq->nr_drainers) 2750618b01ebSTejun Heo wq->flags &= ~__WQ_DRAINING; 275187fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 27529c5a2ba7STejun Heo } 27539c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue); 27549c5a2ba7STejun Heo 2755606a5020STejun Heo static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr) 2756baf59022STejun Heo { 2757baf59022STejun Heo struct worker *worker = NULL; 2758c9e7cf27STejun Heo struct worker_pool *pool; 2759112202d9STejun Heo struct pool_workqueue *pwq; 2760baf59022STejun Heo 2761baf59022STejun Heo might_sleep(); 2762baf59022STejun Heo 2763fa1b54e6STejun Heo local_irq_disable(); 2764fa1b54e6STejun Heo pool = get_work_pool(work); 2765fa1b54e6STejun Heo if (!pool) { 2766fa1b54e6STejun Heo local_irq_enable(); 2767fa1b54e6STejun Heo return false; 2768fa1b54e6STejun Heo } 2769fa1b54e6STejun Heo 2770fa1b54e6STejun Heo spin_lock(&pool->lock); 27710b3dae68SLai Jiangshan /* see the comment in try_to_grab_pending() with the same code */ 2772112202d9STejun Heo pwq = get_work_pwq(work); 2773112202d9STejun Heo if (pwq) { 2774112202d9STejun Heo if (unlikely(pwq->pool != pool)) 2775baf59022STejun Heo goto already_gone; 2776606a5020STejun Heo } else { 2777c9e7cf27STejun Heo worker = find_worker_executing_work(pool, work); 2778baf59022STejun Heo if (!worker) 2779baf59022STejun Heo goto already_gone; 2780112202d9STejun Heo pwq = worker->current_pwq; 2781606a5020STejun Heo } 2782baf59022STejun Heo 2783112202d9STejun Heo insert_wq_barrier(pwq, barr, work, worker); 2784d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2785baf59022STejun Heo 2786e159489bSTejun Heo /* 2787e159489bSTejun Heo * If @max_active is 1 or rescuer is in use, flushing another work 2788e159489bSTejun Heo * item on the same workqueue may lead to deadlock. Make sure the 2789e159489bSTejun Heo * flusher is not running on the same workqueue by verifying write 2790e159489bSTejun Heo * access. 2791e159489bSTejun Heo */ 2792493008a8STejun Heo if (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer) 2793112202d9STejun Heo lock_map_acquire(&pwq->wq->lockdep_map); 2794e159489bSTejun Heo else 2795112202d9STejun Heo lock_map_acquire_read(&pwq->wq->lockdep_map); 2796112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 2797e159489bSTejun Heo 2798baf59022STejun Heo return true; 2799baf59022STejun Heo already_gone: 2800d565ed63STejun Heo spin_unlock_irq(&pool->lock); 2801baf59022STejun Heo return false; 2802baf59022STejun Heo } 2803baf59022STejun Heo 2804db700897SOleg Nesterov /** 2805401a8d04STejun Heo * flush_work - wait for a work to finish executing the last queueing instance 2806401a8d04STejun Heo * @work: the work to flush 2807db700897SOleg Nesterov * 2808606a5020STejun Heo * Wait until @work has finished execution. @work is guaranteed to be idle 2809606a5020STejun Heo * on return if it hasn't been requeued since flush started. 2810401a8d04STejun Heo * 2811401a8d04STejun Heo * RETURNS: 2812401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2813401a8d04STejun Heo * %false if it was already idle. 2814db700897SOleg Nesterov */ 2815401a8d04STejun Heo bool flush_work(struct work_struct *work) 2816db700897SOleg Nesterov { 2817db700897SOleg Nesterov struct wq_barrier barr; 2818db700897SOleg Nesterov 28190976dfc1SStephen Boyd lock_map_acquire(&work->lockdep_map); 28200976dfc1SStephen Boyd lock_map_release(&work->lockdep_map); 28210976dfc1SStephen Boyd 2822606a5020STejun Heo if (start_flush_work(work, &barr)) { 2823db700897SOleg Nesterov wait_for_completion(&barr.done); 2824dc186ad7SThomas Gleixner destroy_work_on_stack(&barr.work); 2825401a8d04STejun Heo return true; 2826606a5020STejun Heo } else { 2827401a8d04STejun Heo return false; 2828db700897SOleg Nesterov } 2829606a5020STejun Heo } 2830db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work); 2831db700897SOleg Nesterov 283236e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork) 2833401a8d04STejun Heo { 2834bbb68dfaSTejun Heo unsigned long flags; 28351f1f642eSOleg Nesterov int ret; 28361f1f642eSOleg Nesterov 28371f1f642eSOleg Nesterov do { 2838bbb68dfaSTejun Heo ret = try_to_grab_pending(work, is_dwork, &flags); 2839bbb68dfaSTejun Heo /* 2840bbb68dfaSTejun Heo * If someone else is canceling, wait for the same event it 2841bbb68dfaSTejun Heo * would be waiting for before retrying. 2842bbb68dfaSTejun Heo */ 2843bbb68dfaSTejun Heo if (unlikely(ret == -ENOENT)) 2844606a5020STejun Heo flush_work(work); 28451f1f642eSOleg Nesterov } while (unlikely(ret < 0)); 28461f1f642eSOleg Nesterov 2847bbb68dfaSTejun Heo /* tell other tasks trying to grab @work to back off */ 2848bbb68dfaSTejun Heo mark_work_canceling(work); 2849bbb68dfaSTejun Heo local_irq_restore(flags); 2850bbb68dfaSTejun Heo 2851606a5020STejun Heo flush_work(work); 28527a22ad75STejun Heo clear_work_data(work); 28531f1f642eSOleg Nesterov return ret; 28541f1f642eSOleg Nesterov } 28551f1f642eSOleg Nesterov 28566e84d644SOleg Nesterov /** 2857401a8d04STejun Heo * cancel_work_sync - cancel a work and wait for it to finish 2858401a8d04STejun Heo * @work: the work to cancel 28596e84d644SOleg Nesterov * 2860401a8d04STejun Heo * Cancel @work and wait for its execution to finish. This function 2861401a8d04STejun Heo * can be used even if the work re-queues itself or migrates to 2862401a8d04STejun Heo * another workqueue. On return from this function, @work is 2863401a8d04STejun Heo * guaranteed to be not pending or executing on any CPU. 28641f1f642eSOleg Nesterov * 2865401a8d04STejun Heo * cancel_work_sync(&delayed_work->work) must not be used for 2866401a8d04STejun Heo * delayed_work's. Use cancel_delayed_work_sync() instead. 28676e84d644SOleg Nesterov * 2868401a8d04STejun Heo * The caller must ensure that the workqueue on which @work was last 28696e84d644SOleg Nesterov * queued can't be destroyed before this function returns. 2870401a8d04STejun Heo * 2871401a8d04STejun Heo * RETURNS: 2872401a8d04STejun Heo * %true if @work was pending, %false otherwise. 28736e84d644SOleg Nesterov */ 2874401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work) 28756e84d644SOleg Nesterov { 287636e227d2STejun Heo return __cancel_work_timer(work, false); 2877b89deed3SOleg Nesterov } 287828e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync); 2879b89deed3SOleg Nesterov 28806e84d644SOleg Nesterov /** 2881401a8d04STejun Heo * flush_delayed_work - wait for a dwork to finish executing the last queueing 2882401a8d04STejun Heo * @dwork: the delayed work to flush 28836e84d644SOleg Nesterov * 2884401a8d04STejun Heo * Delayed timer is cancelled and the pending work is queued for 2885401a8d04STejun Heo * immediate execution. Like flush_work(), this function only 2886401a8d04STejun Heo * considers the last queueing instance of @dwork. 28871f1f642eSOleg Nesterov * 2888401a8d04STejun Heo * RETURNS: 2889401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 2890401a8d04STejun Heo * %false if it was already idle. 28916e84d644SOleg Nesterov */ 2892401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork) 2893401a8d04STejun Heo { 28948930cabaSTejun Heo local_irq_disable(); 2895401a8d04STejun Heo if (del_timer_sync(&dwork->timer)) 289660c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 28978930cabaSTejun Heo local_irq_enable(); 2898401a8d04STejun Heo return flush_work(&dwork->work); 2899401a8d04STejun Heo } 2900401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work); 2901401a8d04STejun Heo 2902401a8d04STejun Heo /** 290357b30ae7STejun Heo * cancel_delayed_work - cancel a delayed work 290457b30ae7STejun Heo * @dwork: delayed_work to cancel 290509383498STejun Heo * 290657b30ae7STejun Heo * Kill off a pending delayed_work. Returns %true if @dwork was pending 290757b30ae7STejun Heo * and canceled; %false if wasn't pending. Note that the work callback 290857b30ae7STejun Heo * function may still be running on return, unless it returns %true and the 290957b30ae7STejun Heo * work doesn't re-arm itself. Explicitly flush or use 291057b30ae7STejun Heo * cancel_delayed_work_sync() to wait on it. 291109383498STejun Heo * 291257b30ae7STejun Heo * This function is safe to call from any context including IRQ handler. 291309383498STejun Heo */ 291457b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork) 291509383498STejun Heo { 291657b30ae7STejun Heo unsigned long flags; 291757b30ae7STejun Heo int ret; 291857b30ae7STejun Heo 291957b30ae7STejun Heo do { 292057b30ae7STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 292157b30ae7STejun Heo } while (unlikely(ret == -EAGAIN)); 292257b30ae7STejun Heo 292357b30ae7STejun Heo if (unlikely(ret < 0)) 292457b30ae7STejun Heo return false; 292557b30ae7STejun Heo 29267c3eed5cSTejun Heo set_work_pool_and_clear_pending(&dwork->work, 29277c3eed5cSTejun Heo get_work_pool_id(&dwork->work)); 292857b30ae7STejun Heo local_irq_restore(flags); 2929c0158ca6SDan Magenheimer return ret; 293009383498STejun Heo } 293157b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work); 293209383498STejun Heo 293309383498STejun Heo /** 2934401a8d04STejun Heo * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish 2935401a8d04STejun Heo * @dwork: the delayed work cancel 2936401a8d04STejun Heo * 2937401a8d04STejun Heo * This is cancel_work_sync() for delayed works. 2938401a8d04STejun Heo * 2939401a8d04STejun Heo * RETURNS: 2940401a8d04STejun Heo * %true if @dwork was pending, %false otherwise. 2941401a8d04STejun Heo */ 2942401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork) 29436e84d644SOleg Nesterov { 294436e227d2STejun Heo return __cancel_work_timer(&dwork->work, true); 29456e84d644SOleg Nesterov } 2946f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync); 29471da177e4SLinus Torvalds 29480fcb78c2SRolf Eike Beer /** 294931ddd871STejun Heo * schedule_on_each_cpu - execute a function synchronously on each online CPU 2950b6136773SAndrew Morton * @func: the function to call 2951b6136773SAndrew Morton * 295231ddd871STejun Heo * schedule_on_each_cpu() executes @func on each online CPU using the 295331ddd871STejun Heo * system workqueue and blocks until all CPUs have completed. 2954b6136773SAndrew Morton * schedule_on_each_cpu() is very slow. 295531ddd871STejun Heo * 295631ddd871STejun Heo * RETURNS: 295731ddd871STejun Heo * 0 on success, -errno on failure. 2958b6136773SAndrew Morton */ 295965f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func) 296015316ba8SChristoph Lameter { 296115316ba8SChristoph Lameter int cpu; 296238f51568SNamhyung Kim struct work_struct __percpu *works; 296315316ba8SChristoph Lameter 2964b6136773SAndrew Morton works = alloc_percpu(struct work_struct); 2965b6136773SAndrew Morton if (!works) 296615316ba8SChristoph Lameter return -ENOMEM; 2967b6136773SAndrew Morton 296895402b38SGautham R Shenoy get_online_cpus(); 296993981800STejun Heo 297015316ba8SChristoph Lameter for_each_online_cpu(cpu) { 29719bfb1839SIngo Molnar struct work_struct *work = per_cpu_ptr(works, cpu); 29729bfb1839SIngo Molnar 29739bfb1839SIngo Molnar INIT_WORK(work, func); 29748de6d308SOleg Nesterov schedule_work_on(cpu, work); 297515316ba8SChristoph Lameter } 297693981800STejun Heo 297793981800STejun Heo for_each_online_cpu(cpu) 29788616a89aSOleg Nesterov flush_work(per_cpu_ptr(works, cpu)); 297993981800STejun Heo 298095402b38SGautham R Shenoy put_online_cpus(); 2981b6136773SAndrew Morton free_percpu(works); 298215316ba8SChristoph Lameter return 0; 298315316ba8SChristoph Lameter } 298415316ba8SChristoph Lameter 2985eef6a7d5SAlan Stern /** 2986eef6a7d5SAlan Stern * flush_scheduled_work - ensure that any scheduled work has run to completion. 2987eef6a7d5SAlan Stern * 2988eef6a7d5SAlan Stern * Forces execution of the kernel-global workqueue and blocks until its 2989eef6a7d5SAlan Stern * completion. 2990eef6a7d5SAlan Stern * 2991eef6a7d5SAlan Stern * Think twice before calling this function! It's very easy to get into 2992eef6a7d5SAlan Stern * trouble if you don't take great care. Either of the following situations 2993eef6a7d5SAlan Stern * will lead to deadlock: 2994eef6a7d5SAlan Stern * 2995eef6a7d5SAlan Stern * One of the work items currently on the workqueue needs to acquire 2996eef6a7d5SAlan Stern * a lock held by your code or its caller. 2997eef6a7d5SAlan Stern * 2998eef6a7d5SAlan Stern * Your code is running in the context of a work routine. 2999eef6a7d5SAlan Stern * 3000eef6a7d5SAlan Stern * They will be detected by lockdep when they occur, but the first might not 3001eef6a7d5SAlan Stern * occur very often. It depends on what work items are on the workqueue and 3002eef6a7d5SAlan Stern * what locks they need, which you have no control over. 3003eef6a7d5SAlan Stern * 3004eef6a7d5SAlan Stern * In most situations flushing the entire workqueue is overkill; you merely 3005eef6a7d5SAlan Stern * need to know that a particular work item isn't queued and isn't running. 3006eef6a7d5SAlan Stern * In such cases you should use cancel_delayed_work_sync() or 3007eef6a7d5SAlan Stern * cancel_work_sync() instead. 3008eef6a7d5SAlan Stern */ 30091da177e4SLinus Torvalds void flush_scheduled_work(void) 30101da177e4SLinus Torvalds { 3011d320c038STejun Heo flush_workqueue(system_wq); 30121da177e4SLinus Torvalds } 3013ae90dd5dSDave Jones EXPORT_SYMBOL(flush_scheduled_work); 30141da177e4SLinus Torvalds 30151da177e4SLinus Torvalds /** 30161fa44ecaSJames Bottomley * execute_in_process_context - reliably execute the routine with user context 30171fa44ecaSJames Bottomley * @fn: the function to execute 30181fa44ecaSJames Bottomley * @ew: guaranteed storage for the execute work structure (must 30191fa44ecaSJames Bottomley * be available when the work executes) 30201fa44ecaSJames Bottomley * 30211fa44ecaSJames Bottomley * Executes the function immediately if process context is available, 30221fa44ecaSJames Bottomley * otherwise schedules the function for delayed execution. 30231fa44ecaSJames Bottomley * 30241fa44ecaSJames Bottomley * Returns: 0 - function was executed 30251fa44ecaSJames Bottomley * 1 - function was scheduled for execution 30261fa44ecaSJames Bottomley */ 302765f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew) 30281fa44ecaSJames Bottomley { 30291fa44ecaSJames Bottomley if (!in_interrupt()) { 303065f27f38SDavid Howells fn(&ew->work); 30311fa44ecaSJames Bottomley return 0; 30321fa44ecaSJames Bottomley } 30331fa44ecaSJames Bottomley 303465f27f38SDavid Howells INIT_WORK(&ew->work, fn); 30351fa44ecaSJames Bottomley schedule_work(&ew->work); 30361fa44ecaSJames Bottomley 30371fa44ecaSJames Bottomley return 1; 30381fa44ecaSJames Bottomley } 30391fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context); 30401fa44ecaSJames Bottomley 3041226223abSTejun Heo #ifdef CONFIG_SYSFS 3042226223abSTejun Heo /* 3043226223abSTejun Heo * Workqueues with WQ_SYSFS flag set is visible to userland via 3044226223abSTejun Heo * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the 3045226223abSTejun Heo * following attributes. 3046226223abSTejun Heo * 3047226223abSTejun Heo * per_cpu RO bool : whether the workqueue is per-cpu or unbound 3048226223abSTejun Heo * max_active RW int : maximum number of in-flight work items 3049226223abSTejun Heo * 3050226223abSTejun Heo * Unbound workqueues have the following extra attributes. 3051226223abSTejun Heo * 3052226223abSTejun Heo * id RO int : the associated pool ID 3053226223abSTejun Heo * nice RW int : nice value of the workers 3054226223abSTejun Heo * cpumask RW mask : bitmask of allowed CPUs for the workers 3055226223abSTejun Heo */ 3056226223abSTejun Heo struct wq_device { 3057226223abSTejun Heo struct workqueue_struct *wq; 3058226223abSTejun Heo struct device dev; 3059226223abSTejun Heo }; 3060226223abSTejun Heo 3061226223abSTejun Heo static struct workqueue_struct *dev_to_wq(struct device *dev) 3062226223abSTejun Heo { 3063226223abSTejun Heo struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 3064226223abSTejun Heo 3065226223abSTejun Heo return wq_dev->wq; 3066226223abSTejun Heo } 3067226223abSTejun Heo 3068226223abSTejun Heo static ssize_t wq_per_cpu_show(struct device *dev, 3069226223abSTejun Heo struct device_attribute *attr, char *buf) 3070226223abSTejun Heo { 3071226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3072226223abSTejun Heo 3073226223abSTejun Heo return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND)); 3074226223abSTejun Heo } 3075226223abSTejun Heo 3076226223abSTejun Heo static ssize_t wq_max_active_show(struct device *dev, 3077226223abSTejun Heo struct device_attribute *attr, char *buf) 3078226223abSTejun Heo { 3079226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3080226223abSTejun Heo 3081226223abSTejun Heo return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active); 3082226223abSTejun Heo } 3083226223abSTejun Heo 3084226223abSTejun Heo static ssize_t wq_max_active_store(struct device *dev, 3085226223abSTejun Heo struct device_attribute *attr, 3086226223abSTejun Heo const char *buf, size_t count) 3087226223abSTejun Heo { 3088226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3089226223abSTejun Heo int val; 3090226223abSTejun Heo 3091226223abSTejun Heo if (sscanf(buf, "%d", &val) != 1 || val <= 0) 3092226223abSTejun Heo return -EINVAL; 3093226223abSTejun Heo 3094226223abSTejun Heo workqueue_set_max_active(wq, val); 3095226223abSTejun Heo return count; 3096226223abSTejun Heo } 3097226223abSTejun Heo 3098226223abSTejun Heo static struct device_attribute wq_sysfs_attrs[] = { 3099226223abSTejun Heo __ATTR(per_cpu, 0444, wq_per_cpu_show, NULL), 3100226223abSTejun Heo __ATTR(max_active, 0644, wq_max_active_show, wq_max_active_store), 3101226223abSTejun Heo __ATTR_NULL, 3102226223abSTejun Heo }; 3103226223abSTejun Heo 3104d55262c4STejun Heo static ssize_t wq_pool_ids_show(struct device *dev, 3105226223abSTejun Heo struct device_attribute *attr, char *buf) 3106226223abSTejun Heo { 3107226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3108d55262c4STejun Heo const char *delim = ""; 3109d55262c4STejun Heo int node, written = 0; 3110226223abSTejun Heo 3111226223abSTejun Heo rcu_read_lock_sched(); 3112d55262c4STejun Heo for_each_node(node) { 3113d55262c4STejun Heo written += scnprintf(buf + written, PAGE_SIZE - written, 3114d55262c4STejun Heo "%s%d:%d", delim, node, 3115d55262c4STejun Heo unbound_pwq_by_node(wq, node)->pool->id); 3116d55262c4STejun Heo delim = " "; 3117d55262c4STejun Heo } 3118d55262c4STejun Heo written += scnprintf(buf + written, PAGE_SIZE - written, "\n"); 3119226223abSTejun Heo rcu_read_unlock_sched(); 3120226223abSTejun Heo 3121226223abSTejun Heo return written; 3122226223abSTejun Heo } 3123226223abSTejun Heo 3124226223abSTejun Heo static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr, 3125226223abSTejun Heo char *buf) 3126226223abSTejun Heo { 3127226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3128226223abSTejun Heo int written; 3129226223abSTejun Heo 31306029a918STejun Heo mutex_lock(&wq->mutex); 31316029a918STejun Heo written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice); 31326029a918STejun Heo mutex_unlock(&wq->mutex); 3133226223abSTejun Heo 3134226223abSTejun Heo return written; 3135226223abSTejun Heo } 3136226223abSTejun Heo 3137226223abSTejun Heo /* prepare workqueue_attrs for sysfs store operations */ 3138226223abSTejun Heo static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq) 3139226223abSTejun Heo { 3140226223abSTejun Heo struct workqueue_attrs *attrs; 3141226223abSTejun Heo 3142226223abSTejun Heo attrs = alloc_workqueue_attrs(GFP_KERNEL); 3143226223abSTejun Heo if (!attrs) 3144226223abSTejun Heo return NULL; 3145226223abSTejun Heo 31466029a918STejun Heo mutex_lock(&wq->mutex); 31476029a918STejun Heo copy_workqueue_attrs(attrs, wq->unbound_attrs); 31486029a918STejun Heo mutex_unlock(&wq->mutex); 3149226223abSTejun Heo return attrs; 3150226223abSTejun Heo } 3151226223abSTejun Heo 3152226223abSTejun Heo static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr, 3153226223abSTejun Heo const char *buf, size_t count) 3154226223abSTejun Heo { 3155226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3156226223abSTejun Heo struct workqueue_attrs *attrs; 3157226223abSTejun Heo int ret; 3158226223abSTejun Heo 3159226223abSTejun Heo attrs = wq_sysfs_prep_attrs(wq); 3160226223abSTejun Heo if (!attrs) 3161226223abSTejun Heo return -ENOMEM; 3162226223abSTejun Heo 3163226223abSTejun Heo if (sscanf(buf, "%d", &attrs->nice) == 1 && 3164226223abSTejun Heo attrs->nice >= -20 && attrs->nice <= 19) 3165226223abSTejun Heo ret = apply_workqueue_attrs(wq, attrs); 3166226223abSTejun Heo else 3167226223abSTejun Heo ret = -EINVAL; 3168226223abSTejun Heo 3169226223abSTejun Heo free_workqueue_attrs(attrs); 3170226223abSTejun Heo return ret ?: count; 3171226223abSTejun Heo } 3172226223abSTejun Heo 3173226223abSTejun Heo static ssize_t wq_cpumask_show(struct device *dev, 3174226223abSTejun Heo struct device_attribute *attr, char *buf) 3175226223abSTejun Heo { 3176226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3177226223abSTejun Heo int written; 3178226223abSTejun Heo 31796029a918STejun Heo mutex_lock(&wq->mutex); 31806029a918STejun Heo written = cpumask_scnprintf(buf, PAGE_SIZE, wq->unbound_attrs->cpumask); 31816029a918STejun Heo mutex_unlock(&wq->mutex); 3182226223abSTejun Heo 3183226223abSTejun Heo written += scnprintf(buf + written, PAGE_SIZE - written, "\n"); 3184226223abSTejun Heo return written; 3185226223abSTejun Heo } 3186226223abSTejun Heo 3187226223abSTejun Heo static ssize_t wq_cpumask_store(struct device *dev, 3188226223abSTejun Heo struct device_attribute *attr, 3189226223abSTejun Heo const char *buf, size_t count) 3190226223abSTejun Heo { 3191226223abSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3192226223abSTejun Heo struct workqueue_attrs *attrs; 3193226223abSTejun Heo int ret; 3194226223abSTejun Heo 3195226223abSTejun Heo attrs = wq_sysfs_prep_attrs(wq); 3196226223abSTejun Heo if (!attrs) 3197226223abSTejun Heo return -ENOMEM; 3198226223abSTejun Heo 3199226223abSTejun Heo ret = cpumask_parse(buf, attrs->cpumask); 3200226223abSTejun Heo if (!ret) 3201226223abSTejun Heo ret = apply_workqueue_attrs(wq, attrs); 3202226223abSTejun Heo 3203226223abSTejun Heo free_workqueue_attrs(attrs); 3204226223abSTejun Heo return ret ?: count; 3205226223abSTejun Heo } 3206226223abSTejun Heo 3207d55262c4STejun Heo static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr, 3208d55262c4STejun Heo char *buf) 3209d55262c4STejun Heo { 3210d55262c4STejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3211d55262c4STejun Heo int written; 3212d55262c4STejun Heo 3213d55262c4STejun Heo mutex_lock(&wq->mutex); 3214d55262c4STejun Heo written = scnprintf(buf, PAGE_SIZE, "%d\n", 3215d55262c4STejun Heo !wq->unbound_attrs->no_numa); 3216d55262c4STejun Heo mutex_unlock(&wq->mutex); 3217d55262c4STejun Heo 3218d55262c4STejun Heo return written; 3219d55262c4STejun Heo } 3220d55262c4STejun Heo 3221d55262c4STejun Heo static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr, 3222d55262c4STejun Heo const char *buf, size_t count) 3223d55262c4STejun Heo { 3224d55262c4STejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 3225d55262c4STejun Heo struct workqueue_attrs *attrs; 3226d55262c4STejun Heo int v, ret; 3227d55262c4STejun Heo 3228d55262c4STejun Heo attrs = wq_sysfs_prep_attrs(wq); 3229d55262c4STejun Heo if (!attrs) 3230d55262c4STejun Heo return -ENOMEM; 3231d55262c4STejun Heo 3232d55262c4STejun Heo ret = -EINVAL; 3233d55262c4STejun Heo if (sscanf(buf, "%d", &v) == 1) { 3234d55262c4STejun Heo attrs->no_numa = !v; 3235d55262c4STejun Heo ret = apply_workqueue_attrs(wq, attrs); 3236d55262c4STejun Heo } 3237d55262c4STejun Heo 3238d55262c4STejun Heo free_workqueue_attrs(attrs); 3239d55262c4STejun Heo return ret ?: count; 3240d55262c4STejun Heo } 3241d55262c4STejun Heo 3242226223abSTejun Heo static struct device_attribute wq_sysfs_unbound_attrs[] = { 3243d55262c4STejun Heo __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL), 3244226223abSTejun Heo __ATTR(nice, 0644, wq_nice_show, wq_nice_store), 3245226223abSTejun Heo __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store), 3246d55262c4STejun Heo __ATTR(numa, 0644, wq_numa_show, wq_numa_store), 3247226223abSTejun Heo __ATTR_NULL, 3248226223abSTejun Heo }; 3249226223abSTejun Heo 3250226223abSTejun Heo static struct bus_type wq_subsys = { 3251226223abSTejun Heo .name = "workqueue", 3252226223abSTejun Heo .dev_attrs = wq_sysfs_attrs, 3253226223abSTejun Heo }; 3254226223abSTejun Heo 3255226223abSTejun Heo static int __init wq_sysfs_init(void) 3256226223abSTejun Heo { 3257226223abSTejun Heo return subsys_virtual_register(&wq_subsys, NULL); 3258226223abSTejun Heo } 3259226223abSTejun Heo core_initcall(wq_sysfs_init); 3260226223abSTejun Heo 3261226223abSTejun Heo static void wq_device_release(struct device *dev) 3262226223abSTejun Heo { 3263226223abSTejun Heo struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 3264226223abSTejun Heo 3265226223abSTejun Heo kfree(wq_dev); 3266226223abSTejun Heo } 3267226223abSTejun Heo 3268226223abSTejun Heo /** 3269226223abSTejun Heo * workqueue_sysfs_register - make a workqueue visible in sysfs 3270226223abSTejun Heo * @wq: the workqueue to register 3271226223abSTejun Heo * 3272226223abSTejun Heo * Expose @wq in sysfs under /sys/bus/workqueue/devices. 3273226223abSTejun Heo * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set 3274226223abSTejun Heo * which is the preferred method. 3275226223abSTejun Heo * 3276226223abSTejun Heo * Workqueue user should use this function directly iff it wants to apply 3277226223abSTejun Heo * workqueue_attrs before making the workqueue visible in sysfs; otherwise, 3278226223abSTejun Heo * apply_workqueue_attrs() may race against userland updating the 3279226223abSTejun Heo * attributes. 3280226223abSTejun Heo * 3281226223abSTejun Heo * Returns 0 on success, -errno on failure. 3282226223abSTejun Heo */ 3283226223abSTejun Heo int workqueue_sysfs_register(struct workqueue_struct *wq) 3284226223abSTejun Heo { 3285226223abSTejun Heo struct wq_device *wq_dev; 3286226223abSTejun Heo int ret; 3287226223abSTejun Heo 3288226223abSTejun Heo /* 3289226223abSTejun Heo * Adjusting max_active or creating new pwqs by applyting 3290226223abSTejun Heo * attributes breaks ordering guarantee. Disallow exposing ordered 3291226223abSTejun Heo * workqueues. 3292226223abSTejun Heo */ 3293226223abSTejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED)) 3294226223abSTejun Heo return -EINVAL; 3295226223abSTejun Heo 3296226223abSTejun Heo wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL); 3297226223abSTejun Heo if (!wq_dev) 3298226223abSTejun Heo return -ENOMEM; 3299226223abSTejun Heo 3300226223abSTejun Heo wq_dev->wq = wq; 3301226223abSTejun Heo wq_dev->dev.bus = &wq_subsys; 3302226223abSTejun Heo wq_dev->dev.init_name = wq->name; 3303226223abSTejun Heo wq_dev->dev.release = wq_device_release; 3304226223abSTejun Heo 3305226223abSTejun Heo /* 3306226223abSTejun Heo * unbound_attrs are created separately. Suppress uevent until 3307226223abSTejun Heo * everything is ready. 3308226223abSTejun Heo */ 3309226223abSTejun Heo dev_set_uevent_suppress(&wq_dev->dev, true); 3310226223abSTejun Heo 3311226223abSTejun Heo ret = device_register(&wq_dev->dev); 3312226223abSTejun Heo if (ret) { 3313226223abSTejun Heo kfree(wq_dev); 3314226223abSTejun Heo wq->wq_dev = NULL; 3315226223abSTejun Heo return ret; 3316226223abSTejun Heo } 3317226223abSTejun Heo 3318226223abSTejun Heo if (wq->flags & WQ_UNBOUND) { 3319226223abSTejun Heo struct device_attribute *attr; 3320226223abSTejun Heo 3321226223abSTejun Heo for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) { 3322226223abSTejun Heo ret = device_create_file(&wq_dev->dev, attr); 3323226223abSTejun Heo if (ret) { 3324226223abSTejun Heo device_unregister(&wq_dev->dev); 3325226223abSTejun Heo wq->wq_dev = NULL; 3326226223abSTejun Heo return ret; 3327226223abSTejun Heo } 3328226223abSTejun Heo } 3329226223abSTejun Heo } 3330226223abSTejun Heo 3331226223abSTejun Heo kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD); 3332226223abSTejun Heo return 0; 3333226223abSTejun Heo } 3334226223abSTejun Heo 3335226223abSTejun Heo /** 3336226223abSTejun Heo * workqueue_sysfs_unregister - undo workqueue_sysfs_register() 3337226223abSTejun Heo * @wq: the workqueue to unregister 3338226223abSTejun Heo * 3339226223abSTejun Heo * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister. 3340226223abSTejun Heo */ 3341226223abSTejun Heo static void workqueue_sysfs_unregister(struct workqueue_struct *wq) 3342226223abSTejun Heo { 3343226223abSTejun Heo struct wq_device *wq_dev = wq->wq_dev; 3344226223abSTejun Heo 3345226223abSTejun Heo if (!wq->wq_dev) 3346226223abSTejun Heo return; 3347226223abSTejun Heo 3348226223abSTejun Heo wq->wq_dev = NULL; 3349226223abSTejun Heo device_unregister(&wq_dev->dev); 3350226223abSTejun Heo } 3351226223abSTejun Heo #else /* CONFIG_SYSFS */ 3352226223abSTejun Heo static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { } 3353226223abSTejun Heo #endif /* CONFIG_SYSFS */ 3354226223abSTejun Heo 33557a4e344cSTejun Heo /** 33567a4e344cSTejun Heo * free_workqueue_attrs - free a workqueue_attrs 33577a4e344cSTejun Heo * @attrs: workqueue_attrs to free 33587a4e344cSTejun Heo * 33597a4e344cSTejun Heo * Undo alloc_workqueue_attrs(). 33607a4e344cSTejun Heo */ 33617a4e344cSTejun Heo void free_workqueue_attrs(struct workqueue_attrs *attrs) 33627a4e344cSTejun Heo { 33637a4e344cSTejun Heo if (attrs) { 33647a4e344cSTejun Heo free_cpumask_var(attrs->cpumask); 33657a4e344cSTejun Heo kfree(attrs); 33667a4e344cSTejun Heo } 33677a4e344cSTejun Heo } 33687a4e344cSTejun Heo 33697a4e344cSTejun Heo /** 33707a4e344cSTejun Heo * alloc_workqueue_attrs - allocate a workqueue_attrs 33717a4e344cSTejun Heo * @gfp_mask: allocation mask to use 33727a4e344cSTejun Heo * 33737a4e344cSTejun Heo * Allocate a new workqueue_attrs, initialize with default settings and 33747a4e344cSTejun Heo * return it. Returns NULL on failure. 33757a4e344cSTejun Heo */ 33767a4e344cSTejun Heo struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask) 33777a4e344cSTejun Heo { 33787a4e344cSTejun Heo struct workqueue_attrs *attrs; 33797a4e344cSTejun Heo 33807a4e344cSTejun Heo attrs = kzalloc(sizeof(*attrs), gfp_mask); 33817a4e344cSTejun Heo if (!attrs) 33827a4e344cSTejun Heo goto fail; 33837a4e344cSTejun Heo if (!alloc_cpumask_var(&attrs->cpumask, gfp_mask)) 33847a4e344cSTejun Heo goto fail; 33857a4e344cSTejun Heo 338613e2e556STejun Heo cpumask_copy(attrs->cpumask, cpu_possible_mask); 33877a4e344cSTejun Heo return attrs; 33887a4e344cSTejun Heo fail: 33897a4e344cSTejun Heo free_workqueue_attrs(attrs); 33907a4e344cSTejun Heo return NULL; 33917a4e344cSTejun Heo } 33927a4e344cSTejun Heo 339329c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to, 339429c91e99STejun Heo const struct workqueue_attrs *from) 339529c91e99STejun Heo { 339629c91e99STejun Heo to->nice = from->nice; 339729c91e99STejun Heo cpumask_copy(to->cpumask, from->cpumask); 339829c91e99STejun Heo } 339929c91e99STejun Heo 340029c91e99STejun Heo /* hash value of the content of @attr */ 340129c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs) 340229c91e99STejun Heo { 340329c91e99STejun Heo u32 hash = 0; 340429c91e99STejun Heo 340529c91e99STejun Heo hash = jhash_1word(attrs->nice, hash); 340613e2e556STejun Heo hash = jhash(cpumask_bits(attrs->cpumask), 340713e2e556STejun Heo BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); 340829c91e99STejun Heo return hash; 340929c91e99STejun Heo } 341029c91e99STejun Heo 341129c91e99STejun Heo /* content equality test */ 341229c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a, 341329c91e99STejun Heo const struct workqueue_attrs *b) 341429c91e99STejun Heo { 341529c91e99STejun Heo if (a->nice != b->nice) 341629c91e99STejun Heo return false; 341729c91e99STejun Heo if (!cpumask_equal(a->cpumask, b->cpumask)) 341829c91e99STejun Heo return false; 341929c91e99STejun Heo return true; 342029c91e99STejun Heo } 342129c91e99STejun Heo 34227a4e344cSTejun Heo /** 34237a4e344cSTejun Heo * init_worker_pool - initialize a newly zalloc'd worker_pool 34247a4e344cSTejun Heo * @pool: worker_pool to initialize 34257a4e344cSTejun Heo * 34267a4e344cSTejun Heo * Initiailize a newly zalloc'd @pool. It also allocates @pool->attrs. 342729c91e99STejun Heo * Returns 0 on success, -errno on failure. Even on failure, all fields 342829c91e99STejun Heo * inside @pool proper are initialized and put_unbound_pool() can be called 342929c91e99STejun Heo * on @pool safely to release it. 34307a4e344cSTejun Heo */ 34317a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool) 34324e1a1f9aSTejun Heo { 34334e1a1f9aSTejun Heo spin_lock_init(&pool->lock); 343429c91e99STejun Heo pool->id = -1; 343529c91e99STejun Heo pool->cpu = -1; 3436f3f90ad4STejun Heo pool->node = NUMA_NO_NODE; 34374e1a1f9aSTejun Heo pool->flags |= POOL_DISASSOCIATED; 34384e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->worklist); 34394e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->idle_list); 34404e1a1f9aSTejun Heo hash_init(pool->busy_hash); 34414e1a1f9aSTejun Heo 34424e1a1f9aSTejun Heo init_timer_deferrable(&pool->idle_timer); 34434e1a1f9aSTejun Heo pool->idle_timer.function = idle_worker_timeout; 34444e1a1f9aSTejun Heo pool->idle_timer.data = (unsigned long)pool; 34454e1a1f9aSTejun Heo 34464e1a1f9aSTejun Heo setup_timer(&pool->mayday_timer, pool_mayday_timeout, 34474e1a1f9aSTejun Heo (unsigned long)pool); 34484e1a1f9aSTejun Heo 34494e1a1f9aSTejun Heo mutex_init(&pool->manager_arb); 3450bc3a1afcSTejun Heo mutex_init(&pool->manager_mutex); 3451822d8405STejun Heo idr_init(&pool->worker_idr); 34527a4e344cSTejun Heo 345329c91e99STejun Heo INIT_HLIST_NODE(&pool->hash_node); 345429c91e99STejun Heo pool->refcnt = 1; 345529c91e99STejun Heo 345629c91e99STejun Heo /* shouldn't fail above this point */ 34577a4e344cSTejun Heo pool->attrs = alloc_workqueue_attrs(GFP_KERNEL); 34587a4e344cSTejun Heo if (!pool->attrs) 34597a4e344cSTejun Heo return -ENOMEM; 34607a4e344cSTejun Heo return 0; 34614e1a1f9aSTejun Heo } 34624e1a1f9aSTejun Heo 346329c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu) 346429c91e99STejun Heo { 346529c91e99STejun Heo struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu); 346629c91e99STejun Heo 3467822d8405STejun Heo idr_destroy(&pool->worker_idr); 346829c91e99STejun Heo free_workqueue_attrs(pool->attrs); 346929c91e99STejun Heo kfree(pool); 347029c91e99STejun Heo } 347129c91e99STejun Heo 347229c91e99STejun Heo /** 347329c91e99STejun Heo * put_unbound_pool - put a worker_pool 347429c91e99STejun Heo * @pool: worker_pool to put 347529c91e99STejun Heo * 347629c91e99STejun Heo * Put @pool. If its refcnt reaches zero, it gets destroyed in sched-RCU 3477c5aa87bbSTejun Heo * safe manner. get_unbound_pool() calls this function on its failure path 3478c5aa87bbSTejun Heo * and this function should be able to release pools which went through, 3479c5aa87bbSTejun Heo * successfully or not, init_worker_pool(). 3480a892caccSTejun Heo * 3481a892caccSTejun Heo * Should be called with wq_pool_mutex held. 348229c91e99STejun Heo */ 348329c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool) 348429c91e99STejun Heo { 348529c91e99STejun Heo struct worker *worker; 348629c91e99STejun Heo 3487a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 3488a892caccSTejun Heo 3489a892caccSTejun Heo if (--pool->refcnt) 349029c91e99STejun Heo return; 349129c91e99STejun Heo 349229c91e99STejun Heo /* sanity checks */ 349329c91e99STejun Heo if (WARN_ON(!(pool->flags & POOL_DISASSOCIATED)) || 3494a892caccSTejun Heo WARN_ON(!list_empty(&pool->worklist))) 349529c91e99STejun Heo return; 349629c91e99STejun Heo 349729c91e99STejun Heo /* release id and unhash */ 349829c91e99STejun Heo if (pool->id >= 0) 349929c91e99STejun Heo idr_remove(&worker_pool_idr, pool->id); 350029c91e99STejun Heo hash_del(&pool->hash_node); 350129c91e99STejun Heo 3502c5aa87bbSTejun Heo /* 3503c5aa87bbSTejun Heo * Become the manager and destroy all workers. Grabbing 3504c5aa87bbSTejun Heo * manager_arb prevents @pool's workers from blocking on 3505c5aa87bbSTejun Heo * manager_mutex. 3506c5aa87bbSTejun Heo */ 350729c91e99STejun Heo mutex_lock(&pool->manager_arb); 3508cd549687STejun Heo mutex_lock(&pool->manager_mutex); 350929c91e99STejun Heo spin_lock_irq(&pool->lock); 351029c91e99STejun Heo 351129c91e99STejun Heo while ((worker = first_worker(pool))) 351229c91e99STejun Heo destroy_worker(worker); 351329c91e99STejun Heo WARN_ON(pool->nr_workers || pool->nr_idle); 351429c91e99STejun Heo 351529c91e99STejun Heo spin_unlock_irq(&pool->lock); 3516cd549687STejun Heo mutex_unlock(&pool->manager_mutex); 351729c91e99STejun Heo mutex_unlock(&pool->manager_arb); 351829c91e99STejun Heo 351929c91e99STejun Heo /* shut down the timers */ 352029c91e99STejun Heo del_timer_sync(&pool->idle_timer); 352129c91e99STejun Heo del_timer_sync(&pool->mayday_timer); 352229c91e99STejun Heo 352329c91e99STejun Heo /* sched-RCU protected to allow dereferences from get_work_pool() */ 352429c91e99STejun Heo call_rcu_sched(&pool->rcu, rcu_free_pool); 352529c91e99STejun Heo } 352629c91e99STejun Heo 352729c91e99STejun Heo /** 352829c91e99STejun Heo * get_unbound_pool - get a worker_pool with the specified attributes 352929c91e99STejun Heo * @attrs: the attributes of the worker_pool to get 353029c91e99STejun Heo * 353129c91e99STejun Heo * Obtain a worker_pool which has the same attributes as @attrs, bump the 353229c91e99STejun Heo * reference count and return it. If there already is a matching 353329c91e99STejun Heo * worker_pool, it will be used; otherwise, this function attempts to 353429c91e99STejun Heo * create a new one. On failure, returns NULL. 3535a892caccSTejun Heo * 3536a892caccSTejun Heo * Should be called with wq_pool_mutex held. 353729c91e99STejun Heo */ 353829c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs) 353929c91e99STejun Heo { 354029c91e99STejun Heo u32 hash = wqattrs_hash(attrs); 354129c91e99STejun Heo struct worker_pool *pool; 3542f3f90ad4STejun Heo int node; 354329c91e99STejun Heo 3544a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 354529c91e99STejun Heo 354629c91e99STejun Heo /* do we already have a matching pool? */ 354729c91e99STejun Heo hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) { 354829c91e99STejun Heo if (wqattrs_equal(pool->attrs, attrs)) { 354929c91e99STejun Heo pool->refcnt++; 355029c91e99STejun Heo goto out_unlock; 355129c91e99STejun Heo } 355229c91e99STejun Heo } 355329c91e99STejun Heo 355429c91e99STejun Heo /* nope, create a new one */ 355529c91e99STejun Heo pool = kzalloc(sizeof(*pool), GFP_KERNEL); 355629c91e99STejun Heo if (!pool || init_worker_pool(pool) < 0) 355729c91e99STejun Heo goto fail; 355829c91e99STejun Heo 355912ee4fc6SLai Jiangshan if (workqueue_freezing) 356012ee4fc6SLai Jiangshan pool->flags |= POOL_FREEZING; 356112ee4fc6SLai Jiangshan 35628864b4e5STejun Heo lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */ 356329c91e99STejun Heo copy_workqueue_attrs(pool->attrs, attrs); 356429c91e99STejun Heo 3565f3f90ad4STejun Heo /* if cpumask is contained inside a NUMA node, we belong to that node */ 3566f3f90ad4STejun Heo if (wq_numa_enabled) { 3567f3f90ad4STejun Heo for_each_node(node) { 3568f3f90ad4STejun Heo if (cpumask_subset(pool->attrs->cpumask, 3569f3f90ad4STejun Heo wq_numa_possible_cpumask[node])) { 3570f3f90ad4STejun Heo pool->node = node; 3571f3f90ad4STejun Heo break; 3572f3f90ad4STejun Heo } 3573f3f90ad4STejun Heo } 3574f3f90ad4STejun Heo } 3575f3f90ad4STejun Heo 357629c91e99STejun Heo if (worker_pool_assign_id(pool) < 0) 357729c91e99STejun Heo goto fail; 357829c91e99STejun Heo 357929c91e99STejun Heo /* create and start the initial worker */ 3580ebf44d16STejun Heo if (create_and_start_worker(pool) < 0) 358129c91e99STejun Heo goto fail; 358229c91e99STejun Heo 358329c91e99STejun Heo /* install */ 358429c91e99STejun Heo hash_add(unbound_pool_hash, &pool->hash_node, hash); 358529c91e99STejun Heo out_unlock: 358629c91e99STejun Heo return pool; 358729c91e99STejun Heo fail: 358829c91e99STejun Heo if (pool) 358929c91e99STejun Heo put_unbound_pool(pool); 359029c91e99STejun Heo return NULL; 359129c91e99STejun Heo } 359229c91e99STejun Heo 35938864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu) 35948864b4e5STejun Heo { 35958864b4e5STejun Heo kmem_cache_free(pwq_cache, 35968864b4e5STejun Heo container_of(rcu, struct pool_workqueue, rcu)); 35978864b4e5STejun Heo } 35988864b4e5STejun Heo 35998864b4e5STejun Heo /* 36008864b4e5STejun Heo * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt 36018864b4e5STejun Heo * and needs to be destroyed. 36028864b4e5STejun Heo */ 36038864b4e5STejun Heo static void pwq_unbound_release_workfn(struct work_struct *work) 36048864b4e5STejun Heo { 36058864b4e5STejun Heo struct pool_workqueue *pwq = container_of(work, struct pool_workqueue, 36068864b4e5STejun Heo unbound_release_work); 36078864b4e5STejun Heo struct workqueue_struct *wq = pwq->wq; 36088864b4e5STejun Heo struct worker_pool *pool = pwq->pool; 3609bc0caf09STejun Heo bool is_last; 36108864b4e5STejun Heo 36118864b4e5STejun Heo if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND))) 36128864b4e5STejun Heo return; 36138864b4e5STejun Heo 361475ccf595STejun Heo /* 36153c25a55dSLai Jiangshan * Unlink @pwq. Synchronization against wq->mutex isn't strictly 361675ccf595STejun Heo * necessary on release but do it anyway. It's easier to verify 361775ccf595STejun Heo * and consistent with the linking path. 361875ccf595STejun Heo */ 36193c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 36208864b4e5STejun Heo list_del_rcu(&pwq->pwqs_node); 3621bc0caf09STejun Heo is_last = list_empty(&wq->pwqs); 36223c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 36238864b4e5STejun Heo 3624a892caccSTejun Heo mutex_lock(&wq_pool_mutex); 36258864b4e5STejun Heo put_unbound_pool(pool); 3626a892caccSTejun Heo mutex_unlock(&wq_pool_mutex); 3627a892caccSTejun Heo 36288864b4e5STejun Heo call_rcu_sched(&pwq->rcu, rcu_free_pwq); 36298864b4e5STejun Heo 36308864b4e5STejun Heo /* 36318864b4e5STejun Heo * If we're the last pwq going away, @wq is already dead and no one 36328864b4e5STejun Heo * is gonna access it anymore. Free it. 36338864b4e5STejun Heo */ 36346029a918STejun Heo if (is_last) { 36356029a918STejun Heo free_workqueue_attrs(wq->unbound_attrs); 36368864b4e5STejun Heo kfree(wq); 36378864b4e5STejun Heo } 36386029a918STejun Heo } 36398864b4e5STejun Heo 36400fbd95aaSTejun Heo /** 3641699ce097STejun Heo * pwq_adjust_max_active - update a pwq's max_active to the current setting 36420fbd95aaSTejun Heo * @pwq: target pool_workqueue 36430fbd95aaSTejun Heo * 3644699ce097STejun Heo * If @pwq isn't freezing, set @pwq->max_active to the associated 3645699ce097STejun Heo * workqueue's saved_max_active and activate delayed work items 3646699ce097STejun Heo * accordingly. If @pwq is freezing, clear @pwq->max_active to zero. 36470fbd95aaSTejun Heo */ 3648699ce097STejun Heo static void pwq_adjust_max_active(struct pool_workqueue *pwq) 36490fbd95aaSTejun Heo { 3650699ce097STejun Heo struct workqueue_struct *wq = pwq->wq; 3651699ce097STejun Heo bool freezable = wq->flags & WQ_FREEZABLE; 3652699ce097STejun Heo 3653699ce097STejun Heo /* for @wq->saved_max_active */ 3654a357fc03SLai Jiangshan lockdep_assert_held(&wq->mutex); 3655699ce097STejun Heo 3656699ce097STejun Heo /* fast exit for non-freezable wqs */ 3657699ce097STejun Heo if (!freezable && pwq->max_active == wq->saved_max_active) 3658699ce097STejun Heo return; 3659699ce097STejun Heo 3660a357fc03SLai Jiangshan spin_lock_irq(&pwq->pool->lock); 3661699ce097STejun Heo 3662699ce097STejun Heo if (!freezable || !(pwq->pool->flags & POOL_FREEZING)) { 3663699ce097STejun Heo pwq->max_active = wq->saved_max_active; 36640fbd95aaSTejun Heo 36650fbd95aaSTejun Heo while (!list_empty(&pwq->delayed_works) && 36660fbd95aaSTejun Heo pwq->nr_active < pwq->max_active) 36670fbd95aaSTejun Heo pwq_activate_first_delayed(pwq); 3668951a078aSLai Jiangshan 3669951a078aSLai Jiangshan /* 3670951a078aSLai Jiangshan * Need to kick a worker after thawed or an unbound wq's 3671951a078aSLai Jiangshan * max_active is bumped. It's a slow path. Do it always. 3672951a078aSLai Jiangshan */ 3673951a078aSLai Jiangshan wake_up_worker(pwq->pool); 3674699ce097STejun Heo } else { 3675699ce097STejun Heo pwq->max_active = 0; 3676699ce097STejun Heo } 3677699ce097STejun Heo 3678a357fc03SLai Jiangshan spin_unlock_irq(&pwq->pool->lock); 36790fbd95aaSTejun Heo } 36800fbd95aaSTejun Heo 3681e50aba9aSTejun Heo /* initialize newly alloced @pwq which is associated with @wq and @pool */ 3682f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq, 3683f147f29eSTejun Heo struct worker_pool *pool) 3684d2c1d404STejun Heo { 3685d2c1d404STejun Heo BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK); 3686d2c1d404STejun Heo 3687e50aba9aSTejun Heo memset(pwq, 0, sizeof(*pwq)); 3688e50aba9aSTejun Heo 3689d2c1d404STejun Heo pwq->pool = pool; 3690d2c1d404STejun Heo pwq->wq = wq; 3691d2c1d404STejun Heo pwq->flush_color = -1; 36928864b4e5STejun Heo pwq->refcnt = 1; 3693d2c1d404STejun Heo INIT_LIST_HEAD(&pwq->delayed_works); 36941befcf30STejun Heo INIT_LIST_HEAD(&pwq->pwqs_node); 3695d2c1d404STejun Heo INIT_LIST_HEAD(&pwq->mayday_node); 36968864b4e5STejun Heo INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn); 3697f147f29eSTejun Heo } 3698d2c1d404STejun Heo 3699f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */ 37001befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq) 3701f147f29eSTejun Heo { 3702f147f29eSTejun Heo struct workqueue_struct *wq = pwq->wq; 3703f147f29eSTejun Heo 3704f147f29eSTejun Heo lockdep_assert_held(&wq->mutex); 370575ccf595STejun Heo 37061befcf30STejun Heo /* may be called multiple times, ignore if already linked */ 37071befcf30STejun Heo if (!list_empty(&pwq->pwqs_node)) 37081befcf30STejun Heo return; 37091befcf30STejun Heo 3710983ca25eSTejun Heo /* 3711983ca25eSTejun Heo * Set the matching work_color. This is synchronized with 37123c25a55dSLai Jiangshan * wq->mutex to avoid confusing flush_workqueue(). 3713983ca25eSTejun Heo */ 371475ccf595STejun Heo pwq->work_color = wq->work_color; 3715983ca25eSTejun Heo 3716983ca25eSTejun Heo /* sync max_active to the current setting */ 3717983ca25eSTejun Heo pwq_adjust_max_active(pwq); 3718983ca25eSTejun Heo 3719983ca25eSTejun Heo /* link in @pwq */ 37209e8cd2f5STejun Heo list_add_rcu(&pwq->pwqs_node, &wq->pwqs); 3721df2d5ae4STejun Heo } 37226029a918STejun Heo 3723f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */ 3724f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq, 3725f147f29eSTejun Heo const struct workqueue_attrs *attrs) 3726f147f29eSTejun Heo { 3727f147f29eSTejun Heo struct worker_pool *pool; 3728f147f29eSTejun Heo struct pool_workqueue *pwq; 3729f147f29eSTejun Heo 3730f147f29eSTejun Heo lockdep_assert_held(&wq_pool_mutex); 3731f147f29eSTejun Heo 3732f147f29eSTejun Heo pool = get_unbound_pool(attrs); 3733f147f29eSTejun Heo if (!pool) 3734f147f29eSTejun Heo return NULL; 3735f147f29eSTejun Heo 3736e50aba9aSTejun Heo pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node); 3737f147f29eSTejun Heo if (!pwq) { 3738f147f29eSTejun Heo put_unbound_pool(pool); 3739f147f29eSTejun Heo return NULL; 3740f147f29eSTejun Heo } 3741f147f29eSTejun Heo 3742f147f29eSTejun Heo init_pwq(pwq, wq, pool); 3743f147f29eSTejun Heo return pwq; 3744d2c1d404STejun Heo } 3745d2c1d404STejun Heo 37464c16bd32STejun Heo /* undo alloc_unbound_pwq(), used only in the error path */ 37474c16bd32STejun Heo static void free_unbound_pwq(struct pool_workqueue *pwq) 37484c16bd32STejun Heo { 37494c16bd32STejun Heo lockdep_assert_held(&wq_pool_mutex); 37504c16bd32STejun Heo 37514c16bd32STejun Heo if (pwq) { 37524c16bd32STejun Heo put_unbound_pool(pwq->pool); 3753*cece95dfSWei Yongjun kmem_cache_free(pwq_cache, pwq); 37544c16bd32STejun Heo } 37554c16bd32STejun Heo } 37564c16bd32STejun Heo 37574c16bd32STejun Heo /** 37584c16bd32STejun Heo * wq_calc_node_mask - calculate a wq_attrs' cpumask for the specified node 37594c16bd32STejun Heo * @attrs: the wq_attrs of interest 37604c16bd32STejun Heo * @node: the target NUMA node 37614c16bd32STejun Heo * @cpu_going_down: if >= 0, the CPU to consider as offline 37624c16bd32STejun Heo * @cpumask: outarg, the resulting cpumask 37634c16bd32STejun Heo * 37644c16bd32STejun Heo * Calculate the cpumask a workqueue with @attrs should use on @node. If 37654c16bd32STejun Heo * @cpu_going_down is >= 0, that cpu is considered offline during 37664c16bd32STejun Heo * calculation. The result is stored in @cpumask. This function returns 37674c16bd32STejun Heo * %true if the resulting @cpumask is different from @attrs->cpumask, 37684c16bd32STejun Heo * %false if equal. 37694c16bd32STejun Heo * 37704c16bd32STejun Heo * If NUMA affinity is not enabled, @attrs->cpumask is always used. If 37714c16bd32STejun Heo * enabled and @node has online CPUs requested by @attrs, the returned 37724c16bd32STejun Heo * cpumask is the intersection of the possible CPUs of @node and 37734c16bd32STejun Heo * @attrs->cpumask. 37744c16bd32STejun Heo * 37754c16bd32STejun Heo * The caller is responsible for ensuring that the cpumask of @node stays 37764c16bd32STejun Heo * stable. 37774c16bd32STejun Heo */ 37784c16bd32STejun Heo static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node, 37794c16bd32STejun Heo int cpu_going_down, cpumask_t *cpumask) 37804c16bd32STejun Heo { 3781d55262c4STejun Heo if (!wq_numa_enabled || attrs->no_numa) 37824c16bd32STejun Heo goto use_dfl; 37834c16bd32STejun Heo 37844c16bd32STejun Heo /* does @node have any online CPUs @attrs wants? */ 37854c16bd32STejun Heo cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask); 37864c16bd32STejun Heo if (cpu_going_down >= 0) 37874c16bd32STejun Heo cpumask_clear_cpu(cpu_going_down, cpumask); 37884c16bd32STejun Heo 37894c16bd32STejun Heo if (cpumask_empty(cpumask)) 37904c16bd32STejun Heo goto use_dfl; 37914c16bd32STejun Heo 37924c16bd32STejun Heo /* yeap, return possible CPUs in @node that @attrs wants */ 37934c16bd32STejun Heo cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]); 37944c16bd32STejun Heo return !cpumask_equal(cpumask, attrs->cpumask); 37954c16bd32STejun Heo 37964c16bd32STejun Heo use_dfl: 37974c16bd32STejun Heo cpumask_copy(cpumask, attrs->cpumask); 37984c16bd32STejun Heo return false; 37994c16bd32STejun Heo } 38004c16bd32STejun Heo 38011befcf30STejun Heo /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */ 38021befcf30STejun Heo static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq, 38031befcf30STejun Heo int node, 38041befcf30STejun Heo struct pool_workqueue *pwq) 38051befcf30STejun Heo { 38061befcf30STejun Heo struct pool_workqueue *old_pwq; 38071befcf30STejun Heo 38081befcf30STejun Heo lockdep_assert_held(&wq->mutex); 38091befcf30STejun Heo 38101befcf30STejun Heo /* link_pwq() can handle duplicate calls */ 38111befcf30STejun Heo link_pwq(pwq); 38121befcf30STejun Heo 38131befcf30STejun Heo old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]); 38141befcf30STejun Heo rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq); 38151befcf30STejun Heo return old_pwq; 38161befcf30STejun Heo } 38171befcf30STejun Heo 38189e8cd2f5STejun Heo /** 38199e8cd2f5STejun Heo * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue 38209e8cd2f5STejun Heo * @wq: the target workqueue 38219e8cd2f5STejun Heo * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs() 38229e8cd2f5STejun Heo * 38234c16bd32STejun Heo * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA 38244c16bd32STejun Heo * machines, this function maps a separate pwq to each NUMA node with 38254c16bd32STejun Heo * possibles CPUs in @attrs->cpumask so that work items are affine to the 38264c16bd32STejun Heo * NUMA node it was issued on. Older pwqs are released as in-flight work 38274c16bd32STejun Heo * items finish. Note that a work item which repeatedly requeues itself 38284c16bd32STejun Heo * back-to-back will stay on its current pwq. 38299e8cd2f5STejun Heo * 38309e8cd2f5STejun Heo * Performs GFP_KERNEL allocations. Returns 0 on success and -errno on 38319e8cd2f5STejun Heo * failure. 38329e8cd2f5STejun Heo */ 38339e8cd2f5STejun Heo int apply_workqueue_attrs(struct workqueue_struct *wq, 38349e8cd2f5STejun Heo const struct workqueue_attrs *attrs) 38359e8cd2f5STejun Heo { 38364c16bd32STejun Heo struct workqueue_attrs *new_attrs, *tmp_attrs; 38374c16bd32STejun Heo struct pool_workqueue **pwq_tbl, *dfl_pwq; 3838f147f29eSTejun Heo int node, ret; 38399e8cd2f5STejun Heo 38408719dceaSTejun Heo /* only unbound workqueues can change attributes */ 38419e8cd2f5STejun Heo if (WARN_ON(!(wq->flags & WQ_UNBOUND))) 38429e8cd2f5STejun Heo return -EINVAL; 38439e8cd2f5STejun Heo 38448719dceaSTejun Heo /* creating multiple pwqs breaks ordering guarantee */ 38458719dceaSTejun Heo if (WARN_ON((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs))) 38468719dceaSTejun Heo return -EINVAL; 38478719dceaSTejun Heo 38484c16bd32STejun Heo pwq_tbl = kzalloc(wq_numa_tbl_len * sizeof(pwq_tbl[0]), GFP_KERNEL); 384913e2e556STejun Heo new_attrs = alloc_workqueue_attrs(GFP_KERNEL); 38504c16bd32STejun Heo tmp_attrs = alloc_workqueue_attrs(GFP_KERNEL); 38514c16bd32STejun Heo if (!pwq_tbl || !new_attrs || !tmp_attrs) 385213e2e556STejun Heo goto enomem; 385313e2e556STejun Heo 38544c16bd32STejun Heo /* make a copy of @attrs and sanitize it */ 385513e2e556STejun Heo copy_workqueue_attrs(new_attrs, attrs); 385613e2e556STejun Heo cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask); 385713e2e556STejun Heo 38584c16bd32STejun Heo /* 38594c16bd32STejun Heo * We may create multiple pwqs with differing cpumasks. Make a 38604c16bd32STejun Heo * copy of @new_attrs which will be modified and used to obtain 38614c16bd32STejun Heo * pools. 38624c16bd32STejun Heo */ 38634c16bd32STejun Heo copy_workqueue_attrs(tmp_attrs, new_attrs); 38649e8cd2f5STejun Heo 38654c16bd32STejun Heo /* 38664c16bd32STejun Heo * CPUs should stay stable across pwq creations and installations. 38674c16bd32STejun Heo * Pin CPUs, determine the target cpumask for each node and create 38684c16bd32STejun Heo * pwqs accordingly. 38694c16bd32STejun Heo */ 38704c16bd32STejun Heo get_online_cpus(); 38714c16bd32STejun Heo 38724c16bd32STejun Heo mutex_lock(&wq_pool_mutex); 38734c16bd32STejun Heo 38744c16bd32STejun Heo /* 38754c16bd32STejun Heo * If something goes wrong during CPU up/down, we'll fall back to 38764c16bd32STejun Heo * the default pwq covering whole @attrs->cpumask. Always create 38774c16bd32STejun Heo * it even if we don't use it immediately. 38784c16bd32STejun Heo */ 38794c16bd32STejun Heo dfl_pwq = alloc_unbound_pwq(wq, new_attrs); 38804c16bd32STejun Heo if (!dfl_pwq) 38814c16bd32STejun Heo goto enomem_pwq; 38824c16bd32STejun Heo 38834c16bd32STejun Heo for_each_node(node) { 38844c16bd32STejun Heo if (wq_calc_node_cpumask(attrs, node, -1, tmp_attrs->cpumask)) { 38854c16bd32STejun Heo pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs); 38864c16bd32STejun Heo if (!pwq_tbl[node]) 38874c16bd32STejun Heo goto enomem_pwq; 38884c16bd32STejun Heo } else { 38894c16bd32STejun Heo dfl_pwq->refcnt++; 38904c16bd32STejun Heo pwq_tbl[node] = dfl_pwq; 38914c16bd32STejun Heo } 38924c16bd32STejun Heo } 38934c16bd32STejun Heo 38944c16bd32STejun Heo mutex_unlock(&wq_pool_mutex); 38954c16bd32STejun Heo 38964c16bd32STejun Heo /* all pwqs have been created successfully, let's install'em */ 3897f147f29eSTejun Heo mutex_lock(&wq->mutex); 3898a892caccSTejun Heo 3899f147f29eSTejun Heo copy_workqueue_attrs(wq->unbound_attrs, new_attrs); 39004c16bd32STejun Heo 39014c16bd32STejun Heo /* save the previous pwq and install the new one */ 3902f147f29eSTejun Heo for_each_node(node) 39034c16bd32STejun Heo pwq_tbl[node] = numa_pwq_tbl_install(wq, node, pwq_tbl[node]); 39044c16bd32STejun Heo 39054c16bd32STejun Heo /* @dfl_pwq might not have been used, ensure it's linked */ 39064c16bd32STejun Heo link_pwq(dfl_pwq); 39074c16bd32STejun Heo swap(wq->dfl_pwq, dfl_pwq); 3908f147f29eSTejun Heo 3909f147f29eSTejun Heo mutex_unlock(&wq->mutex); 3910f147f29eSTejun Heo 39114c16bd32STejun Heo /* put the old pwqs */ 39124c16bd32STejun Heo for_each_node(node) 39134c16bd32STejun Heo put_pwq_unlocked(pwq_tbl[node]); 39144c16bd32STejun Heo put_pwq_unlocked(dfl_pwq); 39154c16bd32STejun Heo 39164c16bd32STejun Heo put_online_cpus(); 39174862125bSTejun Heo ret = 0; 39184862125bSTejun Heo /* fall through */ 39194862125bSTejun Heo out_free: 39204c16bd32STejun Heo free_workqueue_attrs(tmp_attrs); 39214862125bSTejun Heo free_workqueue_attrs(new_attrs); 39224c16bd32STejun Heo kfree(pwq_tbl); 39234862125bSTejun Heo return ret; 392413e2e556STejun Heo 39254c16bd32STejun Heo enomem_pwq: 39264c16bd32STejun Heo free_unbound_pwq(dfl_pwq); 39274c16bd32STejun Heo for_each_node(node) 39284c16bd32STejun Heo if (pwq_tbl && pwq_tbl[node] != dfl_pwq) 39294c16bd32STejun Heo free_unbound_pwq(pwq_tbl[node]); 39304c16bd32STejun Heo mutex_unlock(&wq_pool_mutex); 39314c16bd32STejun Heo put_online_cpus(); 393213e2e556STejun Heo enomem: 39334862125bSTejun Heo ret = -ENOMEM; 39344862125bSTejun Heo goto out_free; 39359e8cd2f5STejun Heo } 39369e8cd2f5STejun Heo 39374c16bd32STejun Heo /** 39384c16bd32STejun Heo * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug 39394c16bd32STejun Heo * @wq: the target workqueue 39404c16bd32STejun Heo * @cpu: the CPU coming up or going down 39414c16bd32STejun Heo * @online: whether @cpu is coming up or going down 39424c16bd32STejun Heo * 39434c16bd32STejun Heo * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and 39444c16bd32STejun Heo * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of 39454c16bd32STejun Heo * @wq accordingly. 39464c16bd32STejun Heo * 39474c16bd32STejun Heo * If NUMA affinity can't be adjusted due to memory allocation failure, it 39484c16bd32STejun Heo * falls back to @wq->dfl_pwq which may not be optimal but is always 39494c16bd32STejun Heo * correct. 39504c16bd32STejun Heo * 39514c16bd32STejun Heo * Note that when the last allowed CPU of a NUMA node goes offline for a 39524c16bd32STejun Heo * workqueue with a cpumask spanning multiple nodes, the workers which were 39534c16bd32STejun Heo * already executing the work items for the workqueue will lose their CPU 39544c16bd32STejun Heo * affinity and may execute on any CPU. This is similar to how per-cpu 39554c16bd32STejun Heo * workqueues behave on CPU_DOWN. If a workqueue user wants strict 39564c16bd32STejun Heo * affinity, it's the user's responsibility to flush the work item from 39574c16bd32STejun Heo * CPU_DOWN_PREPARE. 39584c16bd32STejun Heo */ 39594c16bd32STejun Heo static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu, 39604c16bd32STejun Heo bool online) 39614c16bd32STejun Heo { 39624c16bd32STejun Heo int node = cpu_to_node(cpu); 39634c16bd32STejun Heo int cpu_off = online ? -1 : cpu; 39644c16bd32STejun Heo struct pool_workqueue *old_pwq = NULL, *pwq; 39654c16bd32STejun Heo struct workqueue_attrs *target_attrs; 39664c16bd32STejun Heo cpumask_t *cpumask; 39674c16bd32STejun Heo 39684c16bd32STejun Heo lockdep_assert_held(&wq_pool_mutex); 39694c16bd32STejun Heo 39704c16bd32STejun Heo if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND)) 39714c16bd32STejun Heo return; 39724c16bd32STejun Heo 39734c16bd32STejun Heo /* 39744c16bd32STejun Heo * We don't wanna alloc/free wq_attrs for each wq for each CPU. 39754c16bd32STejun Heo * Let's use a preallocated one. The following buf is protected by 39764c16bd32STejun Heo * CPU hotplug exclusion. 39774c16bd32STejun Heo */ 39784c16bd32STejun Heo target_attrs = wq_update_unbound_numa_attrs_buf; 39794c16bd32STejun Heo cpumask = target_attrs->cpumask; 39804c16bd32STejun Heo 39814c16bd32STejun Heo mutex_lock(&wq->mutex); 3982d55262c4STejun Heo if (wq->unbound_attrs->no_numa) 3983d55262c4STejun Heo goto out_unlock; 39844c16bd32STejun Heo 39854c16bd32STejun Heo copy_workqueue_attrs(target_attrs, wq->unbound_attrs); 39864c16bd32STejun Heo pwq = unbound_pwq_by_node(wq, node); 39874c16bd32STejun Heo 39884c16bd32STejun Heo /* 39894c16bd32STejun Heo * Let's determine what needs to be done. If the target cpumask is 39904c16bd32STejun Heo * different from wq's, we need to compare it to @pwq's and create 39914c16bd32STejun Heo * a new one if they don't match. If the target cpumask equals 39924c16bd32STejun Heo * wq's, the default pwq should be used. If @pwq is already the 39934c16bd32STejun Heo * default one, nothing to do; otherwise, install the default one. 39944c16bd32STejun Heo */ 39954c16bd32STejun Heo if (wq_calc_node_cpumask(wq->unbound_attrs, node, cpu_off, cpumask)) { 39964c16bd32STejun Heo if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask)) 39974c16bd32STejun Heo goto out_unlock; 39984c16bd32STejun Heo } else { 39994c16bd32STejun Heo if (pwq == wq->dfl_pwq) 40004c16bd32STejun Heo goto out_unlock; 40014c16bd32STejun Heo else 40024c16bd32STejun Heo goto use_dfl_pwq; 40034c16bd32STejun Heo } 40044c16bd32STejun Heo 40054c16bd32STejun Heo mutex_unlock(&wq->mutex); 40064c16bd32STejun Heo 40074c16bd32STejun Heo /* create a new pwq */ 40084c16bd32STejun Heo pwq = alloc_unbound_pwq(wq, target_attrs); 40094c16bd32STejun Heo if (!pwq) { 40104c16bd32STejun Heo pr_warning("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n", 40114c16bd32STejun Heo wq->name); 40124c16bd32STejun Heo goto out_unlock; 40134c16bd32STejun Heo } 40144c16bd32STejun Heo 40154c16bd32STejun Heo /* 40164c16bd32STejun Heo * Install the new pwq. As this function is called only from CPU 40174c16bd32STejun Heo * hotplug callbacks and applying a new attrs is wrapped with 40184c16bd32STejun Heo * get/put_online_cpus(), @wq->unbound_attrs couldn't have changed 40194c16bd32STejun Heo * inbetween. 40204c16bd32STejun Heo */ 40214c16bd32STejun Heo mutex_lock(&wq->mutex); 40224c16bd32STejun Heo old_pwq = numa_pwq_tbl_install(wq, node, pwq); 40234c16bd32STejun Heo goto out_unlock; 40244c16bd32STejun Heo 40254c16bd32STejun Heo use_dfl_pwq: 40264c16bd32STejun Heo spin_lock_irq(&wq->dfl_pwq->pool->lock); 40274c16bd32STejun Heo get_pwq(wq->dfl_pwq); 40284c16bd32STejun Heo spin_unlock_irq(&wq->dfl_pwq->pool->lock); 40294c16bd32STejun Heo old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq); 40304c16bd32STejun Heo out_unlock: 40314c16bd32STejun Heo mutex_unlock(&wq->mutex); 40324c16bd32STejun Heo put_pwq_unlocked(old_pwq); 40334c16bd32STejun Heo } 40344c16bd32STejun Heo 403530cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq) 40361da177e4SLinus Torvalds { 403749e3cf44STejun Heo bool highpri = wq->flags & WQ_HIGHPRI; 403830cdf249STejun Heo int cpu; 4039e1d8aa9fSFrederic Weisbecker 404030cdf249STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 4041420c0ddbSTejun Heo wq->cpu_pwqs = alloc_percpu(struct pool_workqueue); 4042420c0ddbSTejun Heo if (!wq->cpu_pwqs) 404330cdf249STejun Heo return -ENOMEM; 404430cdf249STejun Heo 404530cdf249STejun Heo for_each_possible_cpu(cpu) { 40467fb98ea7STejun Heo struct pool_workqueue *pwq = 40477fb98ea7STejun Heo per_cpu_ptr(wq->cpu_pwqs, cpu); 40487a62c2c8STejun Heo struct worker_pool *cpu_pools = 4049f02ae73aSTejun Heo per_cpu(cpu_worker_pools, cpu); 405030cdf249STejun Heo 4051f147f29eSTejun Heo init_pwq(pwq, wq, &cpu_pools[highpri]); 4052f147f29eSTejun Heo 4053f147f29eSTejun Heo mutex_lock(&wq->mutex); 40541befcf30STejun Heo link_pwq(pwq); 4055f147f29eSTejun Heo mutex_unlock(&wq->mutex); 405630cdf249STejun Heo } 405730cdf249STejun Heo return 0; 40589e8cd2f5STejun Heo } else { 40599e8cd2f5STejun Heo return apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]); 40609e8cd2f5STejun Heo } 40610f900049STejun Heo } 40620f900049STejun Heo 4063f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags, 4064f3421797STejun Heo const char *name) 4065b71ab8c2STejun Heo { 4066f3421797STejun Heo int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE; 4067f3421797STejun Heo 4068f3421797STejun Heo if (max_active < 1 || max_active > lim) 4069044c782cSValentin Ilie pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n", 4070f3421797STejun Heo max_active, name, 1, lim); 4071b71ab8c2STejun Heo 4072f3421797STejun Heo return clamp_val(max_active, 1, lim); 4073b71ab8c2STejun Heo } 4074b71ab8c2STejun Heo 4075b196be89STejun Heo struct workqueue_struct *__alloc_workqueue_key(const char *fmt, 407697e37d7bSTejun Heo unsigned int flags, 40771e19ffc6STejun Heo int max_active, 4078eb13ba87SJohannes Berg struct lock_class_key *key, 4079b196be89STejun Heo const char *lock_name, ...) 40803af24433SOleg Nesterov { 4081df2d5ae4STejun Heo size_t tbl_size = 0; 4082ecf6881fSTejun Heo va_list args; 40833af24433SOleg Nesterov struct workqueue_struct *wq; 408449e3cf44STejun Heo struct pool_workqueue *pwq; 4085b196be89STejun Heo 4086ecf6881fSTejun Heo /* allocate wq and format name */ 4087df2d5ae4STejun Heo if (flags & WQ_UNBOUND) 4088df2d5ae4STejun Heo tbl_size = wq_numa_tbl_len * sizeof(wq->numa_pwq_tbl[0]); 4089df2d5ae4STejun Heo 4090df2d5ae4STejun Heo wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL); 4091b196be89STejun Heo if (!wq) 4092d2c1d404STejun Heo return NULL; 4093b196be89STejun Heo 40946029a918STejun Heo if (flags & WQ_UNBOUND) { 40956029a918STejun Heo wq->unbound_attrs = alloc_workqueue_attrs(GFP_KERNEL); 40966029a918STejun Heo if (!wq->unbound_attrs) 40976029a918STejun Heo goto err_free_wq; 40986029a918STejun Heo } 40996029a918STejun Heo 4100ecf6881fSTejun Heo va_start(args, lock_name); 4101ecf6881fSTejun Heo vsnprintf(wq->name, sizeof(wq->name), fmt, args); 4102b196be89STejun Heo va_end(args); 41033af24433SOleg Nesterov 4104d320c038STejun Heo max_active = max_active ?: WQ_DFL_ACTIVE; 4105b196be89STejun Heo max_active = wq_clamp_max_active(max_active, flags, wq->name); 41063af24433SOleg Nesterov 4107b196be89STejun Heo /* init wq */ 410897e37d7bSTejun Heo wq->flags = flags; 4109a0a1a5fdSTejun Heo wq->saved_max_active = max_active; 41103c25a55dSLai Jiangshan mutex_init(&wq->mutex); 4111112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 0); 411230cdf249STejun Heo INIT_LIST_HEAD(&wq->pwqs); 411373f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_queue); 411473f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_overflow); 4115493a1724STejun Heo INIT_LIST_HEAD(&wq->maydays); 41163af24433SOleg Nesterov 4117eb13ba87SJohannes Berg lockdep_init_map(&wq->lockdep_map, lock_name, key, 0); 4118cce1a165SOleg Nesterov INIT_LIST_HEAD(&wq->list); 41193af24433SOleg Nesterov 412030cdf249STejun Heo if (alloc_and_link_pwqs(wq) < 0) 4121d2c1d404STejun Heo goto err_free_wq; 41221537663fSTejun Heo 4123493008a8STejun Heo /* 4124493008a8STejun Heo * Workqueues which may be used during memory reclaim should 4125493008a8STejun Heo * have a rescuer to guarantee forward progress. 4126493008a8STejun Heo */ 4127493008a8STejun Heo if (flags & WQ_MEM_RECLAIM) { 4128e22bee78STejun Heo struct worker *rescuer; 4129e22bee78STejun Heo 4130d2c1d404STejun Heo rescuer = alloc_worker(); 4131e22bee78STejun Heo if (!rescuer) 4132d2c1d404STejun Heo goto err_destroy; 4133e22bee78STejun Heo 4134111c225aSTejun Heo rescuer->rescue_wq = wq; 4135111c225aSTejun Heo rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", 4136b196be89STejun Heo wq->name); 4137d2c1d404STejun Heo if (IS_ERR(rescuer->task)) { 4138d2c1d404STejun Heo kfree(rescuer); 4139d2c1d404STejun Heo goto err_destroy; 4140d2c1d404STejun Heo } 4141e22bee78STejun Heo 4142d2c1d404STejun Heo wq->rescuer = rescuer; 414314a40ffcSTejun Heo rescuer->task->flags |= PF_NO_SETAFFINITY; 4144e22bee78STejun Heo wake_up_process(rescuer->task); 41453af24433SOleg Nesterov } 41461537663fSTejun Heo 4147226223abSTejun Heo if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq)) 4148226223abSTejun Heo goto err_destroy; 4149226223abSTejun Heo 41503af24433SOleg Nesterov /* 415168e13a67SLai Jiangshan * wq_pool_mutex protects global freeze state and workqueues list. 415268e13a67SLai Jiangshan * Grab it, adjust max_active and add the new @wq to workqueues 415368e13a67SLai Jiangshan * list. 41543af24433SOleg Nesterov */ 415568e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 4156a0a1a5fdSTejun Heo 4157a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 415849e3cf44STejun Heo for_each_pwq(pwq, wq) 4159699ce097STejun Heo pwq_adjust_max_active(pwq); 4160a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 4161a0a1a5fdSTejun Heo 41623af24433SOleg Nesterov list_add(&wq->list, &workqueues); 4163a0a1a5fdSTejun Heo 416468e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 41653af24433SOleg Nesterov 41663af24433SOleg Nesterov return wq; 4167d2c1d404STejun Heo 4168d2c1d404STejun Heo err_free_wq: 41696029a918STejun Heo free_workqueue_attrs(wq->unbound_attrs); 41704690c4abSTejun Heo kfree(wq); 4171d2c1d404STejun Heo return NULL; 4172d2c1d404STejun Heo err_destroy: 4173d2c1d404STejun Heo destroy_workqueue(wq); 41744690c4abSTejun Heo return NULL; 41751da177e4SLinus Torvalds } 4176d320c038STejun Heo EXPORT_SYMBOL_GPL(__alloc_workqueue_key); 41771da177e4SLinus Torvalds 41783af24433SOleg Nesterov /** 41793af24433SOleg Nesterov * destroy_workqueue - safely terminate a workqueue 41803af24433SOleg Nesterov * @wq: target workqueue 41813af24433SOleg Nesterov * 41823af24433SOleg Nesterov * Safely destroy a workqueue. All work currently pending will be done first. 41833af24433SOleg Nesterov */ 41843af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq) 41853af24433SOleg Nesterov { 418649e3cf44STejun Heo struct pool_workqueue *pwq; 41874c16bd32STejun Heo int node; 41883af24433SOleg Nesterov 41899c5a2ba7STejun Heo /* drain it before proceeding with destruction */ 41909c5a2ba7STejun Heo drain_workqueue(wq); 4191c8efcc25STejun Heo 41926183c009STejun Heo /* sanity checks */ 4193b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 419449e3cf44STejun Heo for_each_pwq(pwq, wq) { 41956183c009STejun Heo int i; 41966183c009STejun Heo 419776af4d93STejun Heo for (i = 0; i < WORK_NR_COLORS; i++) { 419876af4d93STejun Heo if (WARN_ON(pwq->nr_in_flight[i])) { 4199b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 42006183c009STejun Heo return; 420176af4d93STejun Heo } 420276af4d93STejun Heo } 420376af4d93STejun Heo 42045c529597SLai Jiangshan if (WARN_ON((pwq != wq->dfl_pwq) && (pwq->refcnt > 1)) || 42058864b4e5STejun Heo WARN_ON(pwq->nr_active) || 420676af4d93STejun Heo WARN_ON(!list_empty(&pwq->delayed_works))) { 4207b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 42086183c009STejun Heo return; 42096183c009STejun Heo } 421076af4d93STejun Heo } 4211b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 42126183c009STejun Heo 4213a0a1a5fdSTejun Heo /* 4214a0a1a5fdSTejun Heo * wq list is used to freeze wq, remove from list after 4215a0a1a5fdSTejun Heo * flushing is complete in case freeze races us. 4216a0a1a5fdSTejun Heo */ 421768e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 4218d2c1d404STejun Heo list_del_init(&wq->list); 421968e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 42203af24433SOleg Nesterov 4221226223abSTejun Heo workqueue_sysfs_unregister(wq); 4222226223abSTejun Heo 4223493008a8STejun Heo if (wq->rescuer) { 4224e22bee78STejun Heo kthread_stop(wq->rescuer->task); 42258d9df9f0SXiaotian Feng kfree(wq->rescuer); 4226493008a8STejun Heo wq->rescuer = NULL; 4227e22bee78STejun Heo } 4228e22bee78STejun Heo 42298864b4e5STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 423029c91e99STejun Heo /* 42318864b4e5STejun Heo * The base ref is never dropped on per-cpu pwqs. Directly 42328864b4e5STejun Heo * free the pwqs and wq. 423329c91e99STejun Heo */ 42348864b4e5STejun Heo free_percpu(wq->cpu_pwqs); 42358864b4e5STejun Heo kfree(wq); 42368864b4e5STejun Heo } else { 42378864b4e5STejun Heo /* 42388864b4e5STejun Heo * We're the sole accessor of @wq at this point. Directly 42394c16bd32STejun Heo * access numa_pwq_tbl[] and dfl_pwq to put the base refs. 42404c16bd32STejun Heo * @wq will be freed when the last pwq is released. 42418864b4e5STejun Heo */ 42424c16bd32STejun Heo for_each_node(node) { 42434c16bd32STejun Heo pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]); 42444c16bd32STejun Heo RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL); 42454c16bd32STejun Heo put_pwq_unlocked(pwq); 42464c16bd32STejun Heo } 42474c16bd32STejun Heo 42484c16bd32STejun Heo /* 42494c16bd32STejun Heo * Put dfl_pwq. @wq may be freed any time after dfl_pwq is 42504c16bd32STejun Heo * put. Don't access it afterwards. 42514c16bd32STejun Heo */ 42524c16bd32STejun Heo pwq = wq->dfl_pwq; 42534c16bd32STejun Heo wq->dfl_pwq = NULL; 4254dce90d47STejun Heo put_pwq_unlocked(pwq); 425529c91e99STejun Heo } 42563af24433SOleg Nesterov } 42573af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue); 42583af24433SOleg Nesterov 4259dcd989cbSTejun Heo /** 4260dcd989cbSTejun Heo * workqueue_set_max_active - adjust max_active of a workqueue 4261dcd989cbSTejun Heo * @wq: target workqueue 4262dcd989cbSTejun Heo * @max_active: new max_active value. 4263dcd989cbSTejun Heo * 4264dcd989cbSTejun Heo * Set max_active of @wq to @max_active. 4265dcd989cbSTejun Heo * 4266dcd989cbSTejun Heo * CONTEXT: 4267dcd989cbSTejun Heo * Don't call from IRQ context. 4268dcd989cbSTejun Heo */ 4269dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) 4270dcd989cbSTejun Heo { 427149e3cf44STejun Heo struct pool_workqueue *pwq; 4272dcd989cbSTejun Heo 42738719dceaSTejun Heo /* disallow meddling with max_active for ordered workqueues */ 42748719dceaSTejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED)) 42758719dceaSTejun Heo return; 42768719dceaSTejun Heo 4277f3421797STejun Heo max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); 4278dcd989cbSTejun Heo 4279a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 4280dcd989cbSTejun Heo 4281dcd989cbSTejun Heo wq->saved_max_active = max_active; 4282dcd989cbSTejun Heo 4283699ce097STejun Heo for_each_pwq(pwq, wq) 4284699ce097STejun Heo pwq_adjust_max_active(pwq); 4285dcd989cbSTejun Heo 4286a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 4287dcd989cbSTejun Heo } 4288dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active); 4289dcd989cbSTejun Heo 4290dcd989cbSTejun Heo /** 4291e6267616STejun Heo * current_is_workqueue_rescuer - is %current workqueue rescuer? 4292e6267616STejun Heo * 4293e6267616STejun Heo * Determine whether %current is a workqueue rescuer. Can be used from 4294e6267616STejun Heo * work functions to determine whether it's being run off the rescuer task. 4295e6267616STejun Heo */ 4296e6267616STejun Heo bool current_is_workqueue_rescuer(void) 4297e6267616STejun Heo { 4298e6267616STejun Heo struct worker *worker = current_wq_worker(); 4299e6267616STejun Heo 43006a092dfdSLai Jiangshan return worker && worker->rescue_wq; 4301e6267616STejun Heo } 4302e6267616STejun Heo 4303e6267616STejun Heo /** 4304dcd989cbSTejun Heo * workqueue_congested - test whether a workqueue is congested 4305dcd989cbSTejun Heo * @cpu: CPU in question 4306dcd989cbSTejun Heo * @wq: target workqueue 4307dcd989cbSTejun Heo * 4308dcd989cbSTejun Heo * Test whether @wq's cpu workqueue for @cpu is congested. There is 4309dcd989cbSTejun Heo * no synchronization around this function and the test result is 4310dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 4311dcd989cbSTejun Heo * 4312dcd989cbSTejun Heo * RETURNS: 4313dcd989cbSTejun Heo * %true if congested, %false otherwise. 4314dcd989cbSTejun Heo */ 4315d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq) 4316dcd989cbSTejun Heo { 43177fb98ea7STejun Heo struct pool_workqueue *pwq; 431876af4d93STejun Heo bool ret; 431976af4d93STejun Heo 432088109453SLai Jiangshan rcu_read_lock_sched(); 43217fb98ea7STejun Heo 43227fb98ea7STejun Heo if (!(wq->flags & WQ_UNBOUND)) 43237fb98ea7STejun Heo pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); 43247fb98ea7STejun Heo else 4325df2d5ae4STejun Heo pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu)); 4326dcd989cbSTejun Heo 432776af4d93STejun Heo ret = !list_empty(&pwq->delayed_works); 432888109453SLai Jiangshan rcu_read_unlock_sched(); 432976af4d93STejun Heo 433076af4d93STejun Heo return ret; 4331dcd989cbSTejun Heo } 4332dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested); 4333dcd989cbSTejun Heo 4334dcd989cbSTejun Heo /** 4335dcd989cbSTejun Heo * work_busy - test whether a work is currently pending or running 4336dcd989cbSTejun Heo * @work: the work to be tested 4337dcd989cbSTejun Heo * 4338dcd989cbSTejun Heo * Test whether @work is currently pending or running. There is no 4339dcd989cbSTejun Heo * synchronization around this function and the test result is 4340dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 4341dcd989cbSTejun Heo * 4342dcd989cbSTejun Heo * RETURNS: 4343dcd989cbSTejun Heo * OR'd bitmask of WORK_BUSY_* bits. 4344dcd989cbSTejun Heo */ 4345dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work) 4346dcd989cbSTejun Heo { 4347fa1b54e6STejun Heo struct worker_pool *pool; 4348dcd989cbSTejun Heo unsigned long flags; 4349dcd989cbSTejun Heo unsigned int ret = 0; 4350dcd989cbSTejun Heo 4351dcd989cbSTejun Heo if (work_pending(work)) 4352dcd989cbSTejun Heo ret |= WORK_BUSY_PENDING; 4353038366c5SLai Jiangshan 4354fa1b54e6STejun Heo local_irq_save(flags); 4355fa1b54e6STejun Heo pool = get_work_pool(work); 4356038366c5SLai Jiangshan if (pool) { 4357fa1b54e6STejun Heo spin_lock(&pool->lock); 4358c9e7cf27STejun Heo if (find_worker_executing_work(pool, work)) 4359dcd989cbSTejun Heo ret |= WORK_BUSY_RUNNING; 4360fa1b54e6STejun Heo spin_unlock(&pool->lock); 4361038366c5SLai Jiangshan } 4362fa1b54e6STejun Heo local_irq_restore(flags); 4363dcd989cbSTejun Heo 4364dcd989cbSTejun Heo return ret; 4365dcd989cbSTejun Heo } 4366dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy); 4367dcd989cbSTejun Heo 4368db7bccf4STejun Heo /* 4369db7bccf4STejun Heo * CPU hotplug. 4370db7bccf4STejun Heo * 4371e22bee78STejun Heo * There are two challenges in supporting CPU hotplug. Firstly, there 4372112202d9STejun Heo * are a lot of assumptions on strong associations among work, pwq and 4373706026c2STejun Heo * pool which make migrating pending and scheduled works very 4374e22bee78STejun Heo * difficult to implement without impacting hot paths. Secondly, 437594cf58bbSTejun Heo * worker pools serve mix of short, long and very long running works making 4376e22bee78STejun Heo * blocked draining impractical. 4377e22bee78STejun Heo * 437824647570STejun Heo * This is solved by allowing the pools to be disassociated from the CPU 4379628c78e7STejun Heo * running as an unbound one and allowing it to be reattached later if the 4380628c78e7STejun Heo * cpu comes back online. 4381db7bccf4STejun Heo */ 4382db7bccf4STejun Heo 4383706026c2STejun Heo static void wq_unbind_fn(struct work_struct *work) 4384db7bccf4STejun Heo { 438538db41d9STejun Heo int cpu = smp_processor_id(); 43864ce62e9eSTejun Heo struct worker_pool *pool; 4387db7bccf4STejun Heo struct worker *worker; 4388a9ab775bSTejun Heo int wi; 4389db7bccf4STejun Heo 4390f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 43916183c009STejun Heo WARN_ON_ONCE(cpu != smp_processor_id()); 4392db7bccf4STejun Heo 4393bc3a1afcSTejun Heo mutex_lock(&pool->manager_mutex); 439494cf58bbSTejun Heo spin_lock_irq(&pool->lock); 4395e22bee78STejun Heo 4396f2d5a0eeSTejun Heo /* 4397bc3a1afcSTejun Heo * We've blocked all manager operations. Make all workers 439894cf58bbSTejun Heo * unbound and set DISASSOCIATED. Before this, all workers 439994cf58bbSTejun Heo * except for the ones which are still executing works from 440094cf58bbSTejun Heo * before the last CPU down must be on the cpu. After 440194cf58bbSTejun Heo * this, they may become diasporas. 4402f2d5a0eeSTejun Heo */ 4403a9ab775bSTejun Heo for_each_pool_worker(worker, wi, pool) 4404403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 4405db7bccf4STejun Heo 440624647570STejun Heo pool->flags |= POOL_DISASSOCIATED; 4407f2d5a0eeSTejun Heo 440894cf58bbSTejun Heo spin_unlock_irq(&pool->lock); 4409bc3a1afcSTejun Heo mutex_unlock(&pool->manager_mutex); 4410e22bee78STejun Heo 4411e22bee78STejun Heo /* 4412eb283428SLai Jiangshan * Call schedule() so that we cross rq->lock and thus can 4413eb283428SLai Jiangshan * guarantee sched callbacks see the %WORKER_UNBOUND flag. 4414eb283428SLai Jiangshan * This is necessary as scheduler callbacks may be invoked 4415eb283428SLai Jiangshan * from other cpus. 4416628c78e7STejun Heo */ 4417628c78e7STejun Heo schedule(); 4418628c78e7STejun Heo 4419628c78e7STejun Heo /* 4420eb283428SLai Jiangshan * Sched callbacks are disabled now. Zap nr_running. 4421eb283428SLai Jiangshan * After this, nr_running stays zero and need_more_worker() 4422eb283428SLai Jiangshan * and keep_working() are always true as long as the 4423eb283428SLai Jiangshan * worklist is not empty. This pool now behaves as an 4424eb283428SLai Jiangshan * unbound (in terms of concurrency management) pool which 4425eb283428SLai Jiangshan * are served by workers tied to the pool. 4426e22bee78STejun Heo */ 4427e19e397aSTejun Heo atomic_set(&pool->nr_running, 0); 4428eb283428SLai Jiangshan 4429eb283428SLai Jiangshan /* 4430eb283428SLai Jiangshan * With concurrency management just turned off, a busy 4431eb283428SLai Jiangshan * worker blocking could lead to lengthy stalls. Kick off 4432eb283428SLai Jiangshan * unbound chain execution of currently pending work items. 4433eb283428SLai Jiangshan */ 4434eb283428SLai Jiangshan spin_lock_irq(&pool->lock); 4435eb283428SLai Jiangshan wake_up_worker(pool); 4436eb283428SLai Jiangshan spin_unlock_irq(&pool->lock); 4437eb283428SLai Jiangshan } 4438db7bccf4STejun Heo } 4439db7bccf4STejun Heo 4440bd7c089eSTejun Heo /** 4441bd7c089eSTejun Heo * rebind_workers - rebind all workers of a pool to the associated CPU 4442bd7c089eSTejun Heo * @pool: pool of interest 4443bd7c089eSTejun Heo * 4444a9ab775bSTejun Heo * @pool->cpu is coming online. Rebind all workers to the CPU. 4445bd7c089eSTejun Heo */ 4446bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool) 4447bd7c089eSTejun Heo { 4448a9ab775bSTejun Heo struct worker *worker; 4449a9ab775bSTejun Heo int wi; 4450bd7c089eSTejun Heo 4451bd7c089eSTejun Heo lockdep_assert_held(&pool->manager_mutex); 4452bd7c089eSTejun Heo 4453bd7c089eSTejun Heo /* 4454a9ab775bSTejun Heo * Restore CPU affinity of all workers. As all idle workers should 4455a9ab775bSTejun Heo * be on the run-queue of the associated CPU before any local 4456a9ab775bSTejun Heo * wake-ups for concurrency management happen, restore CPU affinty 4457a9ab775bSTejun Heo * of all workers first and then clear UNBOUND. As we're called 4458a9ab775bSTejun Heo * from CPU_ONLINE, the following shouldn't fail. 4459bd7c089eSTejun Heo */ 4460a9ab775bSTejun Heo for_each_pool_worker(worker, wi, pool) 4461a9ab775bSTejun Heo WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, 4462a9ab775bSTejun Heo pool->attrs->cpumask) < 0); 4463a9ab775bSTejun Heo 4464a9ab775bSTejun Heo spin_lock_irq(&pool->lock); 4465a9ab775bSTejun Heo 4466a9ab775bSTejun Heo for_each_pool_worker(worker, wi, pool) { 4467a9ab775bSTejun Heo unsigned int worker_flags = worker->flags; 4468a9ab775bSTejun Heo 4469a9ab775bSTejun Heo /* 4470a9ab775bSTejun Heo * A bound idle worker should actually be on the runqueue 4471a9ab775bSTejun Heo * of the associated CPU for local wake-ups targeting it to 4472a9ab775bSTejun Heo * work. Kick all idle workers so that they migrate to the 4473a9ab775bSTejun Heo * associated CPU. Doing this in the same loop as 4474a9ab775bSTejun Heo * replacing UNBOUND with REBOUND is safe as no worker will 4475a9ab775bSTejun Heo * be bound before @pool->lock is released. 4476a9ab775bSTejun Heo */ 4477a9ab775bSTejun Heo if (worker_flags & WORKER_IDLE) 4478bd7c089eSTejun Heo wake_up_process(worker->task); 4479bd7c089eSTejun Heo 4480bd7c089eSTejun Heo /* 4481a9ab775bSTejun Heo * We want to clear UNBOUND but can't directly call 4482a9ab775bSTejun Heo * worker_clr_flags() or adjust nr_running. Atomically 4483a9ab775bSTejun Heo * replace UNBOUND with another NOT_RUNNING flag REBOUND. 4484a9ab775bSTejun Heo * @worker will clear REBOUND using worker_clr_flags() when 4485a9ab775bSTejun Heo * it initiates the next execution cycle thus restoring 4486a9ab775bSTejun Heo * concurrency management. Note that when or whether 4487a9ab775bSTejun Heo * @worker clears REBOUND doesn't affect correctness. 4488a9ab775bSTejun Heo * 4489a9ab775bSTejun Heo * ACCESS_ONCE() is necessary because @worker->flags may be 4490a9ab775bSTejun Heo * tested without holding any lock in 4491a9ab775bSTejun Heo * wq_worker_waking_up(). Without it, NOT_RUNNING test may 4492a9ab775bSTejun Heo * fail incorrectly leading to premature concurrency 4493a9ab775bSTejun Heo * management operations. 4494bd7c089eSTejun Heo */ 4495a9ab775bSTejun Heo WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND)); 4496a9ab775bSTejun Heo worker_flags |= WORKER_REBOUND; 4497a9ab775bSTejun Heo worker_flags &= ~WORKER_UNBOUND; 4498a9ab775bSTejun Heo ACCESS_ONCE(worker->flags) = worker_flags; 4499bd7c089eSTejun Heo } 4500a9ab775bSTejun Heo 4501a9ab775bSTejun Heo spin_unlock_irq(&pool->lock); 4502bd7c089eSTejun Heo } 4503bd7c089eSTejun Heo 45047dbc725eSTejun Heo /** 45057dbc725eSTejun Heo * restore_unbound_workers_cpumask - restore cpumask of unbound workers 45067dbc725eSTejun Heo * @pool: unbound pool of interest 45077dbc725eSTejun Heo * @cpu: the CPU which is coming up 45087dbc725eSTejun Heo * 45097dbc725eSTejun Heo * An unbound pool may end up with a cpumask which doesn't have any online 45107dbc725eSTejun Heo * CPUs. When a worker of such pool get scheduled, the scheduler resets 45117dbc725eSTejun Heo * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any 45127dbc725eSTejun Heo * online CPU before, cpus_allowed of all its workers should be restored. 45137dbc725eSTejun Heo */ 45147dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu) 45157dbc725eSTejun Heo { 45167dbc725eSTejun Heo static cpumask_t cpumask; 45177dbc725eSTejun Heo struct worker *worker; 45187dbc725eSTejun Heo int wi; 45197dbc725eSTejun Heo 45207dbc725eSTejun Heo lockdep_assert_held(&pool->manager_mutex); 45217dbc725eSTejun Heo 45227dbc725eSTejun Heo /* is @cpu allowed for @pool? */ 45237dbc725eSTejun Heo if (!cpumask_test_cpu(cpu, pool->attrs->cpumask)) 45247dbc725eSTejun Heo return; 45257dbc725eSTejun Heo 45267dbc725eSTejun Heo /* is @cpu the only online CPU? */ 45277dbc725eSTejun Heo cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask); 45287dbc725eSTejun Heo if (cpumask_weight(&cpumask) != 1) 45297dbc725eSTejun Heo return; 45307dbc725eSTejun Heo 45317dbc725eSTejun Heo /* as we're called from CPU_ONLINE, the following shouldn't fail */ 45327dbc725eSTejun Heo for_each_pool_worker(worker, wi, pool) 45337dbc725eSTejun Heo WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, 45347dbc725eSTejun Heo pool->attrs->cpumask) < 0); 45357dbc725eSTejun Heo } 45367dbc725eSTejun Heo 45378db25e78STejun Heo /* 45388db25e78STejun Heo * Workqueues should be brought up before normal priority CPU notifiers. 45398db25e78STejun Heo * This will be registered high priority CPU notifier. 45408db25e78STejun Heo */ 45419fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_up_callback(struct notifier_block *nfb, 45421da177e4SLinus Torvalds unsigned long action, 45431da177e4SLinus Torvalds void *hcpu) 45441da177e4SLinus Torvalds { 4545d84ff051STejun Heo int cpu = (unsigned long)hcpu; 45464ce62e9eSTejun Heo struct worker_pool *pool; 45474c16bd32STejun Heo struct workqueue_struct *wq; 45487dbc725eSTejun Heo int pi; 45491da177e4SLinus Torvalds 45508db25e78STejun Heo switch (action & ~CPU_TASKS_FROZEN) { 45513af24433SOleg Nesterov case CPU_UP_PREPARE: 4552f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 45533ce63377STejun Heo if (pool->nr_workers) 45543ce63377STejun Heo continue; 4555ebf44d16STejun Heo if (create_and_start_worker(pool) < 0) 45563ce63377STejun Heo return NOTIFY_BAD; 45573af24433SOleg Nesterov } 45581da177e4SLinus Torvalds break; 45591da177e4SLinus Torvalds 456065758202STejun Heo case CPU_DOWN_FAILED: 456165758202STejun Heo case CPU_ONLINE: 456268e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 45637dbc725eSTejun Heo 45647dbc725eSTejun Heo for_each_pool(pool, pi) { 4565bc3a1afcSTejun Heo mutex_lock(&pool->manager_mutex); 456694cf58bbSTejun Heo 45677dbc725eSTejun Heo if (pool->cpu == cpu) { 4568a9ab775bSTejun Heo spin_lock_irq(&pool->lock); 456924647570STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 4570a9ab775bSTejun Heo spin_unlock_irq(&pool->lock); 4571a9ab775bSTejun Heo 457294cf58bbSTejun Heo rebind_workers(pool); 45737dbc725eSTejun Heo } else if (pool->cpu < 0) { 45747dbc725eSTejun Heo restore_unbound_workers_cpumask(pool, cpu); 45757dbc725eSTejun Heo } 457694cf58bbSTejun Heo 4577bc3a1afcSTejun Heo mutex_unlock(&pool->manager_mutex); 457894cf58bbSTejun Heo } 45797dbc725eSTejun Heo 45804c16bd32STejun Heo /* update NUMA affinity of unbound workqueues */ 45814c16bd32STejun Heo list_for_each_entry(wq, &workqueues, list) 45824c16bd32STejun Heo wq_update_unbound_numa(wq, cpu, true); 45834c16bd32STejun Heo 458468e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 45858db25e78STejun Heo break; 458665758202STejun Heo } 458765758202STejun Heo return NOTIFY_OK; 458865758202STejun Heo } 458965758202STejun Heo 459065758202STejun Heo /* 459165758202STejun Heo * Workqueues should be brought down after normal priority CPU notifiers. 459265758202STejun Heo * This will be registered as low priority CPU notifier. 459365758202STejun Heo */ 45949fdf9b73SLai Jiangshan static int __cpuinit workqueue_cpu_down_callback(struct notifier_block *nfb, 459565758202STejun Heo unsigned long action, 459665758202STejun Heo void *hcpu) 459765758202STejun Heo { 4598d84ff051STejun Heo int cpu = (unsigned long)hcpu; 45998db25e78STejun Heo struct work_struct unbind_work; 46004c16bd32STejun Heo struct workqueue_struct *wq; 46018db25e78STejun Heo 460265758202STejun Heo switch (action & ~CPU_TASKS_FROZEN) { 460365758202STejun Heo case CPU_DOWN_PREPARE: 46044c16bd32STejun Heo /* unbinding per-cpu workers should happen on the local CPU */ 4605706026c2STejun Heo INIT_WORK_ONSTACK(&unbind_work, wq_unbind_fn); 46067635d2fdSJoonsoo Kim queue_work_on(cpu, system_highpri_wq, &unbind_work); 46074c16bd32STejun Heo 46084c16bd32STejun Heo /* update NUMA affinity of unbound workqueues */ 46094c16bd32STejun Heo mutex_lock(&wq_pool_mutex); 46104c16bd32STejun Heo list_for_each_entry(wq, &workqueues, list) 46114c16bd32STejun Heo wq_update_unbound_numa(wq, cpu, false); 46124c16bd32STejun Heo mutex_unlock(&wq_pool_mutex); 46134c16bd32STejun Heo 46144c16bd32STejun Heo /* wait for per-cpu unbinding to finish */ 46158db25e78STejun Heo flush_work(&unbind_work); 46168db25e78STejun Heo break; 461765758202STejun Heo } 461865758202STejun Heo return NOTIFY_OK; 461965758202STejun Heo } 462065758202STejun Heo 46212d3854a3SRusty Russell #ifdef CONFIG_SMP 46228ccad40dSRusty Russell 46232d3854a3SRusty Russell struct work_for_cpu { 4624ed48ece2STejun Heo struct work_struct work; 46252d3854a3SRusty Russell long (*fn)(void *); 46262d3854a3SRusty Russell void *arg; 46272d3854a3SRusty Russell long ret; 46282d3854a3SRusty Russell }; 46292d3854a3SRusty Russell 4630ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work) 46312d3854a3SRusty Russell { 4632ed48ece2STejun Heo struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work); 4633ed48ece2STejun Heo 46342d3854a3SRusty Russell wfc->ret = wfc->fn(wfc->arg); 46352d3854a3SRusty Russell } 46362d3854a3SRusty Russell 46372d3854a3SRusty Russell /** 46382d3854a3SRusty Russell * work_on_cpu - run a function in user context on a particular cpu 46392d3854a3SRusty Russell * @cpu: the cpu to run on 46402d3854a3SRusty Russell * @fn: the function to run 46412d3854a3SRusty Russell * @arg: the function arg 46422d3854a3SRusty Russell * 464331ad9081SRusty Russell * This will return the value @fn returns. 464431ad9081SRusty Russell * It is up to the caller to ensure that the cpu doesn't go offline. 46456b44003eSAndrew Morton * The caller must not hold any locks which would prevent @fn from completing. 46462d3854a3SRusty Russell */ 4647d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg) 46482d3854a3SRusty Russell { 4649ed48ece2STejun Heo struct work_for_cpu wfc = { .fn = fn, .arg = arg }; 46502d3854a3SRusty Russell 4651ed48ece2STejun Heo INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn); 4652ed48ece2STejun Heo schedule_work_on(cpu, &wfc.work); 4653ed48ece2STejun Heo flush_work(&wfc.work); 46542d3854a3SRusty Russell return wfc.ret; 46552d3854a3SRusty Russell } 46562d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu); 46572d3854a3SRusty Russell #endif /* CONFIG_SMP */ 46582d3854a3SRusty Russell 4659a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 4660e7577c50SRusty Russell 4661a0a1a5fdSTejun Heo /** 4662a0a1a5fdSTejun Heo * freeze_workqueues_begin - begin freezing workqueues 4663a0a1a5fdSTejun Heo * 466458a69cb4STejun Heo * Start freezing workqueues. After this function returns, all freezable 4665c5aa87bbSTejun Heo * workqueues will queue new works to their delayed_works list instead of 4666706026c2STejun Heo * pool->worklist. 4667a0a1a5fdSTejun Heo * 4668a0a1a5fdSTejun Heo * CONTEXT: 4669a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 4670a0a1a5fdSTejun Heo */ 4671a0a1a5fdSTejun Heo void freeze_workqueues_begin(void) 4672a0a1a5fdSTejun Heo { 467317116969STejun Heo struct worker_pool *pool; 467424b8a847STejun Heo struct workqueue_struct *wq; 467524b8a847STejun Heo struct pool_workqueue *pwq; 4676611c92a0STejun Heo int pi; 4677a0a1a5fdSTejun Heo 467868e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 4679a0a1a5fdSTejun Heo 46806183c009STejun Heo WARN_ON_ONCE(workqueue_freezing); 4681a0a1a5fdSTejun Heo workqueue_freezing = true; 4682a0a1a5fdSTejun Heo 468324b8a847STejun Heo /* set FREEZING */ 4684611c92a0STejun Heo for_each_pool(pool, pi) { 46855bcab335STejun Heo spin_lock_irq(&pool->lock); 468635b6bb63STejun Heo WARN_ON_ONCE(pool->flags & POOL_FREEZING); 468735b6bb63STejun Heo pool->flags |= POOL_FREEZING; 46885bcab335STejun Heo spin_unlock_irq(&pool->lock); 46891da177e4SLinus Torvalds } 46908b03ae3cSTejun Heo 469124b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 4692a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 4693699ce097STejun Heo for_each_pwq(pwq, wq) 4694699ce097STejun Heo pwq_adjust_max_active(pwq); 4695a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 4696a1056305STejun Heo } 46975bcab335STejun Heo 469868e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 4699a0a1a5fdSTejun Heo } 4700a0a1a5fdSTejun Heo 4701a0a1a5fdSTejun Heo /** 470258a69cb4STejun Heo * freeze_workqueues_busy - are freezable workqueues still busy? 4703a0a1a5fdSTejun Heo * 4704a0a1a5fdSTejun Heo * Check whether freezing is complete. This function must be called 4705a0a1a5fdSTejun Heo * between freeze_workqueues_begin() and thaw_workqueues(). 4706a0a1a5fdSTejun Heo * 4707a0a1a5fdSTejun Heo * CONTEXT: 470868e13a67SLai Jiangshan * Grabs and releases wq_pool_mutex. 4709a0a1a5fdSTejun Heo * 4710a0a1a5fdSTejun Heo * RETURNS: 471158a69cb4STejun Heo * %true if some freezable workqueues are still busy. %false if freezing 471258a69cb4STejun Heo * is complete. 4713a0a1a5fdSTejun Heo */ 4714a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void) 4715a0a1a5fdSTejun Heo { 4716a0a1a5fdSTejun Heo bool busy = false; 471724b8a847STejun Heo struct workqueue_struct *wq; 471824b8a847STejun Heo struct pool_workqueue *pwq; 4719a0a1a5fdSTejun Heo 472068e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 4721a0a1a5fdSTejun Heo 47226183c009STejun Heo WARN_ON_ONCE(!workqueue_freezing); 4723a0a1a5fdSTejun Heo 472424b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 472524b8a847STejun Heo if (!(wq->flags & WQ_FREEZABLE)) 472624b8a847STejun Heo continue; 4727a0a1a5fdSTejun Heo /* 4728a0a1a5fdSTejun Heo * nr_active is monotonically decreasing. It's safe 4729a0a1a5fdSTejun Heo * to peek without lock. 4730a0a1a5fdSTejun Heo */ 473188109453SLai Jiangshan rcu_read_lock_sched(); 473224b8a847STejun Heo for_each_pwq(pwq, wq) { 47336183c009STejun Heo WARN_ON_ONCE(pwq->nr_active < 0); 4734112202d9STejun Heo if (pwq->nr_active) { 4735a0a1a5fdSTejun Heo busy = true; 473688109453SLai Jiangshan rcu_read_unlock_sched(); 4737a0a1a5fdSTejun Heo goto out_unlock; 4738a0a1a5fdSTejun Heo } 4739a0a1a5fdSTejun Heo } 474088109453SLai Jiangshan rcu_read_unlock_sched(); 4741a0a1a5fdSTejun Heo } 4742a0a1a5fdSTejun Heo out_unlock: 474368e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 4744a0a1a5fdSTejun Heo return busy; 4745a0a1a5fdSTejun Heo } 4746a0a1a5fdSTejun Heo 4747a0a1a5fdSTejun Heo /** 4748a0a1a5fdSTejun Heo * thaw_workqueues - thaw workqueues 4749a0a1a5fdSTejun Heo * 4750a0a1a5fdSTejun Heo * Thaw workqueues. Normal queueing is restored and all collected 4751706026c2STejun Heo * frozen works are transferred to their respective pool worklists. 4752a0a1a5fdSTejun Heo * 4753a0a1a5fdSTejun Heo * CONTEXT: 4754a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 4755a0a1a5fdSTejun Heo */ 4756a0a1a5fdSTejun Heo void thaw_workqueues(void) 4757a0a1a5fdSTejun Heo { 475824b8a847STejun Heo struct workqueue_struct *wq; 475924b8a847STejun Heo struct pool_workqueue *pwq; 476024b8a847STejun Heo struct worker_pool *pool; 4761611c92a0STejun Heo int pi; 4762a0a1a5fdSTejun Heo 476368e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 4764a0a1a5fdSTejun Heo 4765a0a1a5fdSTejun Heo if (!workqueue_freezing) 4766a0a1a5fdSTejun Heo goto out_unlock; 4767a0a1a5fdSTejun Heo 476824b8a847STejun Heo /* clear FREEZING */ 4769611c92a0STejun Heo for_each_pool(pool, pi) { 47705bcab335STejun Heo spin_lock_irq(&pool->lock); 477135b6bb63STejun Heo WARN_ON_ONCE(!(pool->flags & POOL_FREEZING)); 477235b6bb63STejun Heo pool->flags &= ~POOL_FREEZING; 47735bcab335STejun Heo spin_unlock_irq(&pool->lock); 4774d565ed63STejun Heo } 477524b8a847STejun Heo 477624b8a847STejun Heo /* restore max_active and repopulate worklist */ 477724b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 4778a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 4779699ce097STejun Heo for_each_pwq(pwq, wq) 4780699ce097STejun Heo pwq_adjust_max_active(pwq); 4781a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 478224b8a847STejun Heo } 478324b8a847STejun Heo 4784a0a1a5fdSTejun Heo workqueue_freezing = false; 4785a0a1a5fdSTejun Heo out_unlock: 478668e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 4787a0a1a5fdSTejun Heo } 4788a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 4789a0a1a5fdSTejun Heo 4790bce90380STejun Heo static void __init wq_numa_init(void) 4791bce90380STejun Heo { 4792bce90380STejun Heo cpumask_var_t *tbl; 4793bce90380STejun Heo int node, cpu; 4794bce90380STejun Heo 4795bce90380STejun Heo /* determine NUMA pwq table len - highest node id + 1 */ 4796bce90380STejun Heo for_each_node(node) 4797bce90380STejun Heo wq_numa_tbl_len = max(wq_numa_tbl_len, node + 1); 4798bce90380STejun Heo 4799bce90380STejun Heo if (num_possible_nodes() <= 1) 4800bce90380STejun Heo return; 4801bce90380STejun Heo 4802d55262c4STejun Heo if (wq_disable_numa) { 4803d55262c4STejun Heo pr_info("workqueue: NUMA affinity support disabled\n"); 4804d55262c4STejun Heo return; 4805d55262c4STejun Heo } 4806d55262c4STejun Heo 48074c16bd32STejun Heo wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(GFP_KERNEL); 48084c16bd32STejun Heo BUG_ON(!wq_update_unbound_numa_attrs_buf); 48094c16bd32STejun Heo 4810bce90380STejun Heo /* 4811bce90380STejun Heo * We want masks of possible CPUs of each node which isn't readily 4812bce90380STejun Heo * available. Build one from cpu_to_node() which should have been 4813bce90380STejun Heo * fully initialized by now. 4814bce90380STejun Heo */ 4815bce90380STejun Heo tbl = kzalloc(wq_numa_tbl_len * sizeof(tbl[0]), GFP_KERNEL); 4816bce90380STejun Heo BUG_ON(!tbl); 4817bce90380STejun Heo 4818bce90380STejun Heo for_each_node(node) 4819bce90380STejun Heo BUG_ON(!alloc_cpumask_var_node(&tbl[node], GFP_KERNEL, node)); 4820bce90380STejun Heo 4821bce90380STejun Heo for_each_possible_cpu(cpu) { 4822bce90380STejun Heo node = cpu_to_node(cpu); 4823bce90380STejun Heo if (WARN_ON(node == NUMA_NO_NODE)) { 4824bce90380STejun Heo pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu); 4825bce90380STejun Heo /* happens iff arch is bonkers, let's just proceed */ 4826bce90380STejun Heo return; 4827bce90380STejun Heo } 4828bce90380STejun Heo cpumask_set_cpu(cpu, tbl[node]); 4829bce90380STejun Heo } 4830bce90380STejun Heo 4831bce90380STejun Heo wq_numa_possible_cpumask = tbl; 4832bce90380STejun Heo wq_numa_enabled = true; 4833bce90380STejun Heo } 4834bce90380STejun Heo 48356ee0578bSSuresh Siddha static int __init init_workqueues(void) 48361da177e4SLinus Torvalds { 48377a4e344cSTejun Heo int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL }; 48387a4e344cSTejun Heo int i, cpu; 4839c34056a3STejun Heo 48407c3eed5cSTejun Heo /* make sure we have enough bits for OFFQ pool ID */ 48417c3eed5cSTejun Heo BUILD_BUG_ON((1LU << (BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT)) < 48426be19588SLai Jiangshan WORK_CPU_END * NR_STD_WORKER_POOLS); 4843b5490077STejun Heo 4844e904e6c2STejun Heo WARN_ON(__alignof__(struct pool_workqueue) < __alignof__(long long)); 4845e904e6c2STejun Heo 4846e904e6c2STejun Heo pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC); 4847e904e6c2STejun Heo 484865758202STejun Heo cpu_notifier(workqueue_cpu_up_callback, CPU_PRI_WORKQUEUE_UP); 4849a5b4e57dSLai Jiangshan hotcpu_notifier(workqueue_cpu_down_callback, CPU_PRI_WORKQUEUE_DOWN); 48508b03ae3cSTejun Heo 4851bce90380STejun Heo wq_numa_init(); 4852bce90380STejun Heo 4853706026c2STejun Heo /* initialize CPU pools */ 485429c91e99STejun Heo for_each_possible_cpu(cpu) { 48554ce62e9eSTejun Heo struct worker_pool *pool; 48568b03ae3cSTejun Heo 48577a4e344cSTejun Heo i = 0; 4858f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 48597a4e344cSTejun Heo BUG_ON(init_worker_pool(pool)); 4860ec22ca5eSTejun Heo pool->cpu = cpu; 48617a4e344cSTejun Heo cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu)); 48627a4e344cSTejun Heo pool->attrs->nice = std_nice[i++]; 4863f3f90ad4STejun Heo pool->node = cpu_to_node(cpu); 48647a4e344cSTejun Heo 48659daf9e67STejun Heo /* alloc pool ID */ 486668e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 48679daf9e67STejun Heo BUG_ON(worker_pool_assign_id(pool)); 486868e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 48694ce62e9eSTejun Heo } 48708b03ae3cSTejun Heo } 48718b03ae3cSTejun Heo 4872e22bee78STejun Heo /* create the initial worker */ 487329c91e99STejun Heo for_each_online_cpu(cpu) { 48744ce62e9eSTejun Heo struct worker_pool *pool; 4875e22bee78STejun Heo 4876f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 487724647570STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 4878ebf44d16STejun Heo BUG_ON(create_and_start_worker(pool) < 0); 4879e22bee78STejun Heo } 48804ce62e9eSTejun Heo } 4881e22bee78STejun Heo 488229c91e99STejun Heo /* create default unbound wq attrs */ 488329c91e99STejun Heo for (i = 0; i < NR_STD_WORKER_POOLS; i++) { 488429c91e99STejun Heo struct workqueue_attrs *attrs; 488529c91e99STejun Heo 488629c91e99STejun Heo BUG_ON(!(attrs = alloc_workqueue_attrs(GFP_KERNEL))); 488729c91e99STejun Heo attrs->nice = std_nice[i]; 488829c91e99STejun Heo unbound_std_wq_attrs[i] = attrs; 488929c91e99STejun Heo } 489029c91e99STejun Heo 4891d320c038STejun Heo system_wq = alloc_workqueue("events", 0, 0); 48921aabe902SJoonsoo Kim system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0); 4893d320c038STejun Heo system_long_wq = alloc_workqueue("events_long", 0, 0); 4894f3421797STejun Heo system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, 4895f3421797STejun Heo WQ_UNBOUND_MAX_ACTIVE); 489624d51addSTejun Heo system_freezable_wq = alloc_workqueue("events_freezable", 489724d51addSTejun Heo WQ_FREEZABLE, 0); 48981aabe902SJoonsoo Kim BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq || 4899ae930e0fSTejun Heo !system_unbound_wq || !system_freezable_wq); 49006ee0578bSSuresh Siddha return 0; 49011da177e4SLinus Torvalds } 49026ee0578bSSuresh Siddha early_initcall(init_workqueues); 4903