1457c8996SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only 21da177e4SLinus Torvalds /* 3c54fce6eSTejun Heo * kernel/workqueue.c - generic async execution with shared worker pool 41da177e4SLinus Torvalds * 5c54fce6eSTejun Heo * Copyright (C) 2002 Ingo Molnar 61da177e4SLinus Torvalds * 71da177e4SLinus Torvalds * Derived from the taskqueue/keventd code by: 81da177e4SLinus Torvalds * David Woodhouse <[email protected]> 9e1f8e874SFrancois Cami * Andrew Morton 101da177e4SLinus Torvalds * Kai Petzke <[email protected]> 111da177e4SLinus Torvalds * Theodore Ts'o <[email protected]> 1289ada679SChristoph Lameter * 13cde53535SChristoph Lameter * Made to use alloc_percpu by Christoph Lameter. 14c54fce6eSTejun Heo * 15c54fce6eSTejun Heo * Copyright (C) 2010 SUSE Linux Products GmbH 16c54fce6eSTejun Heo * Copyright (C) 2010 Tejun Heo <[email protected]> 17c54fce6eSTejun Heo * 18c54fce6eSTejun Heo * This is the generic async execution mechanism. Work items as are 19c54fce6eSTejun Heo * executed in process context. The worker pool is shared and 20b11895c4SLibin * automatically managed. There are two worker pools for each CPU (one for 21b11895c4SLibin * normal work items and the other for high priority ones) and some extra 22b11895c4SLibin * pools for workqueues which are not bound to any specific CPU - the 23b11895c4SLibin * number of these backing pools is dynamic. 24c54fce6eSTejun Heo * 259a261491SBenjamin Peterson * Please read Documentation/core-api/workqueue.rst for details. 261da177e4SLinus Torvalds */ 271da177e4SLinus Torvalds 289984de1aSPaul Gortmaker #include <linux/export.h> 291da177e4SLinus Torvalds #include <linux/kernel.h> 301da177e4SLinus Torvalds #include <linux/sched.h> 311da177e4SLinus Torvalds #include <linux/init.h> 321da177e4SLinus Torvalds #include <linux/signal.h> 331da177e4SLinus Torvalds #include <linux/completion.h> 341da177e4SLinus Torvalds #include <linux/workqueue.h> 351da177e4SLinus Torvalds #include <linux/slab.h> 361da177e4SLinus Torvalds #include <linux/cpu.h> 371da177e4SLinus Torvalds #include <linux/notifier.h> 381da177e4SLinus Torvalds #include <linux/kthread.h> 391fa44ecaSJames Bottomley #include <linux/hardirq.h> 4046934023SChristoph Lameter #include <linux/mempolicy.h> 41341a5958SRafael J. Wysocki #include <linux/freezer.h> 42d5abe669SPeter Zijlstra #include <linux/debug_locks.h> 434e6045f1SJohannes Berg #include <linux/lockdep.h> 44c34056a3STejun Heo #include <linux/idr.h> 4529c91e99STejun Heo #include <linux/jhash.h> 4642f8570fSSasha Levin #include <linux/hashtable.h> 4776af4d93STejun Heo #include <linux/rculist.h> 48bce90380STejun Heo #include <linux/nodemask.h> 494c16bd32STejun Heo #include <linux/moduleparam.h> 503d1cb205STejun Heo #include <linux/uaccess.h> 51c98a9805STal Shorer #include <linux/sched/isolation.h> 5262635ea8SSergey Senozhatsky #include <linux/nmi.h> 53940d71c6SSergey Senozhatsky #include <linux/kvm_para.h> 54e22bee78STejun Heo 55ea138446STejun Heo #include "workqueue_internal.h" 561da177e4SLinus Torvalds 57c8e55f36STejun Heo enum { 58bc2ae0f5STejun Heo /* 5924647570STejun Heo * worker_pool flags 60bc2ae0f5STejun Heo * 6124647570STejun Heo * A bound pool is either associated or disassociated with its CPU. 62bc2ae0f5STejun Heo * While associated (!DISASSOCIATED), all workers are bound to the 63bc2ae0f5STejun Heo * CPU and none has %WORKER_UNBOUND set and concurrency management 64bc2ae0f5STejun Heo * is in effect. 65bc2ae0f5STejun Heo * 66bc2ae0f5STejun Heo * While DISASSOCIATED, the cpu may be offline and all workers have 67bc2ae0f5STejun Heo * %WORKER_UNBOUND set and concurrency management disabled, and may 6824647570STejun Heo * be executing on any CPU. The pool behaves as an unbound one. 69bc2ae0f5STejun Heo * 70bc3a1afcSTejun Heo * Note that DISASSOCIATED should be flipped only while holding 711258fae7STejun Heo * wq_pool_attach_mutex to avoid changing binding state while 724736cbf7SLai Jiangshan * worker_attach_to_pool() is in progress. 73bc2ae0f5STejun Heo */ 74692b4825STejun Heo POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */ 7524647570STejun Heo POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */ 76db7bccf4STejun Heo 77c8e55f36STejun Heo /* worker flags */ 78c8e55f36STejun Heo WORKER_DIE = 1 << 1, /* die die die */ 79c8e55f36STejun Heo WORKER_IDLE = 1 << 2, /* is idle */ 80e22bee78STejun Heo WORKER_PREP = 1 << 3, /* preparing to run works */ 81fb0e7bebSTejun Heo WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */ 82f3421797STejun Heo WORKER_UNBOUND = 1 << 7, /* worker is unbound */ 83a9ab775bSTejun Heo WORKER_REBOUND = 1 << 8, /* worker was rebound */ 84e22bee78STejun Heo 85a9ab775bSTejun Heo WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE | 86a9ab775bSTejun Heo WORKER_UNBOUND | WORKER_REBOUND, 87db7bccf4STejun Heo 88e34cdddbSTejun Heo NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */ 894ce62e9eSTejun Heo 9029c91e99STejun Heo UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */ 91c8e55f36STejun Heo BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */ 92db7bccf4STejun Heo 93e22bee78STejun Heo MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */ 94e22bee78STejun Heo IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */ 95e22bee78STejun Heo 963233cdbdSTejun Heo MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2, 973233cdbdSTejun Heo /* call for help after 10ms 983233cdbdSTejun Heo (min two ticks) */ 99e22bee78STejun Heo MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */ 100e22bee78STejun Heo CREATE_COOLDOWN = HZ, /* time to breath after fail */ 1011da177e4SLinus Torvalds 1021da177e4SLinus Torvalds /* 103e22bee78STejun Heo * Rescue workers are used only on emergencies and shared by 1048698a745SDongsheng Yang * all cpus. Give MIN_NICE. 105e22bee78STejun Heo */ 1068698a745SDongsheng Yang RESCUER_NICE_LEVEL = MIN_NICE, 1078698a745SDongsheng Yang HIGHPRI_NICE_LEVEL = MIN_NICE, 108ecf6881fSTejun Heo 109ecf6881fSTejun Heo WQ_NAME_LEN = 24, 110c8e55f36STejun Heo }; 111c8e55f36STejun Heo 1121da177e4SLinus Torvalds /* 1134690c4abSTejun Heo * Structure fields follow one of the following exclusion rules. 1144690c4abSTejun Heo * 115e41e704bSTejun Heo * I: Modifiable by initialization/destruction paths and read-only for 116e41e704bSTejun Heo * everyone else. 1174690c4abSTejun Heo * 118e22bee78STejun Heo * P: Preemption protected. Disabling preemption is enough and should 119e22bee78STejun Heo * only be modified and accessed from the local cpu. 120e22bee78STejun Heo * 121d565ed63STejun Heo * L: pool->lock protected. Access with pool->lock held. 1224690c4abSTejun Heo * 123d565ed63STejun Heo * X: During normal operation, modification requires pool->lock and should 124d565ed63STejun Heo * be done only from local cpu. Either disabling preemption on local 125d565ed63STejun Heo * cpu or grabbing pool->lock is enough for read access. If 126d565ed63STejun Heo * POOL_DISASSOCIATED is set, it's identical to L. 127e22bee78STejun Heo * 1281258fae7STejun Heo * A: wq_pool_attach_mutex protected. 129822d8405STejun Heo * 13068e13a67SLai Jiangshan * PL: wq_pool_mutex protected. 13176af4d93STejun Heo * 13224acfb71SThomas Gleixner * PR: wq_pool_mutex protected for writes. RCU protected for reads. 1335bcab335STejun Heo * 1345b95e1afSLai Jiangshan * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads. 1355b95e1afSLai Jiangshan * 1365b95e1afSLai Jiangshan * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or 13724acfb71SThomas Gleixner * RCU for reads. 1385b95e1afSLai Jiangshan * 1393c25a55dSLai Jiangshan * WQ: wq->mutex protected. 1403c25a55dSLai Jiangshan * 14124acfb71SThomas Gleixner * WR: wq->mutex protected for writes. RCU protected for reads. 1422e109a28STejun Heo * 1432e109a28STejun Heo * MD: wq_mayday_lock protected. 1444690c4abSTejun Heo */ 1454690c4abSTejun Heo 1462eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */ 147c34056a3STejun Heo 148bd7bdd43STejun Heo struct worker_pool { 149a9b8a985SSebastian Andrzej Siewior raw_spinlock_t lock; /* the pool lock */ 150d84ff051STejun Heo int cpu; /* I: the associated cpu */ 151f3f90ad4STejun Heo int node; /* I: the associated node ID */ 1529daf9e67STejun Heo int id; /* I: pool ID */ 15311ebea50STejun Heo unsigned int flags; /* X: flags */ 154bd7bdd43STejun Heo 15582607adcSTejun Heo unsigned long watchdog_ts; /* L: watchdog timestamp */ 15682607adcSTejun Heo 157bd7bdd43STejun Heo struct list_head worklist; /* L: list of pending works */ 158ea1abd61SLai Jiangshan 1595826cc8fSLai Jiangshan int nr_workers; /* L: total number of workers */ 1605826cc8fSLai Jiangshan int nr_idle; /* L: currently idle workers */ 161bd7bdd43STejun Heo 162bd7bdd43STejun Heo struct list_head idle_list; /* X: list of idle workers */ 163bd7bdd43STejun Heo struct timer_list idle_timer; /* L: worker idle timeout */ 164bd7bdd43STejun Heo struct timer_list mayday_timer; /* L: SOS timer for workers */ 165bd7bdd43STejun Heo 166c5aa87bbSTejun Heo /* a workers is either on busy_hash or idle_list, or the manager */ 167c9e7cf27STejun Heo DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER); 168c9e7cf27STejun Heo /* L: hash of busy workers */ 169c9e7cf27STejun Heo 1702607d7a6STejun Heo struct worker *manager; /* L: purely informational */ 17192f9c5c4SLai Jiangshan struct list_head workers; /* A: attached workers */ 17260f5a4bcSLai Jiangshan struct completion *detach_completion; /* all workers detached */ 173e19e397aSTejun Heo 1747cda9aaeSLai Jiangshan struct ida worker_ida; /* worker IDs for task name */ 175e19e397aSTejun Heo 1767a4e344cSTejun Heo struct workqueue_attrs *attrs; /* I: worker attributes */ 17768e13a67SLai Jiangshan struct hlist_node hash_node; /* PL: unbound_pool_hash node */ 17868e13a67SLai Jiangshan int refcnt; /* PL: refcnt for unbound pools */ 1797a4e344cSTejun Heo 180e19e397aSTejun Heo /* 181e19e397aSTejun Heo * The current concurrency level. As it's likely to be accessed 182e19e397aSTejun Heo * from other CPUs during try_to_wake_up(), put it in a separate 183e19e397aSTejun Heo * cacheline. 184e19e397aSTejun Heo */ 185e19e397aSTejun Heo atomic_t nr_running ____cacheline_aligned_in_smp; 18629c91e99STejun Heo 18729c91e99STejun Heo /* 18824acfb71SThomas Gleixner * Destruction of pool is RCU protected to allow dereferences 18929c91e99STejun Heo * from get_work_pool(). 19029c91e99STejun Heo */ 19129c91e99STejun Heo struct rcu_head rcu; 1928b03ae3cSTejun Heo } ____cacheline_aligned_in_smp; 1938b03ae3cSTejun Heo 1948b03ae3cSTejun Heo /* 195112202d9STejun Heo * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS 196112202d9STejun Heo * of work_struct->data are used for flags and the remaining high bits 197112202d9STejun Heo * point to the pwq; thus, pwqs need to be aligned at two's power of the 198112202d9STejun Heo * number of flag bits. 1991da177e4SLinus Torvalds */ 200112202d9STejun Heo struct pool_workqueue { 201bd7bdd43STejun Heo struct worker_pool *pool; /* I: the associated pool */ 2024690c4abSTejun Heo struct workqueue_struct *wq; /* I: the owning workqueue */ 20373f53c4aSTejun Heo int work_color; /* L: current color */ 20473f53c4aSTejun Heo int flush_color; /* L: flushing color */ 2058864b4e5STejun Heo int refcnt; /* L: reference count */ 20673f53c4aSTejun Heo int nr_in_flight[WORK_NR_COLORS]; 20773f53c4aSTejun Heo /* L: nr of in_flight works */ 208018f3a13SLai Jiangshan 209018f3a13SLai Jiangshan /* 210018f3a13SLai Jiangshan * nr_active management and WORK_STRUCT_INACTIVE: 211018f3a13SLai Jiangshan * 212018f3a13SLai Jiangshan * When pwq->nr_active >= max_active, new work item is queued to 213018f3a13SLai Jiangshan * pwq->inactive_works instead of pool->worklist and marked with 214018f3a13SLai Jiangshan * WORK_STRUCT_INACTIVE. 215018f3a13SLai Jiangshan * 216018f3a13SLai Jiangshan * All work items marked with WORK_STRUCT_INACTIVE do not participate 217018f3a13SLai Jiangshan * in pwq->nr_active and all work items in pwq->inactive_works are 218018f3a13SLai Jiangshan * marked with WORK_STRUCT_INACTIVE. But not all WORK_STRUCT_INACTIVE 219018f3a13SLai Jiangshan * work items are in pwq->inactive_works. Some of them are ready to 220018f3a13SLai Jiangshan * run in pool->worklist or worker->scheduled. Those work itmes are 221018f3a13SLai Jiangshan * only struct wq_barrier which is used for flush_work() and should 222018f3a13SLai Jiangshan * not participate in pwq->nr_active. For non-barrier work item, it 223018f3a13SLai Jiangshan * is marked with WORK_STRUCT_INACTIVE iff it is in pwq->inactive_works. 224018f3a13SLai Jiangshan */ 2251e19ffc6STejun Heo int nr_active; /* L: nr of active works */ 226a0a1a5fdSTejun Heo int max_active; /* L: max active works */ 227f97a4a1aSLai Jiangshan struct list_head inactive_works; /* L: inactive works */ 2283c25a55dSLai Jiangshan struct list_head pwqs_node; /* WR: node on wq->pwqs */ 2292e109a28STejun Heo struct list_head mayday_node; /* MD: node on wq->maydays */ 2308864b4e5STejun Heo 2318864b4e5STejun Heo /* 2328864b4e5STejun Heo * Release of unbound pwq is punted to system_wq. See put_pwq() 2338864b4e5STejun Heo * and pwq_unbound_release_workfn() for details. pool_workqueue 23424acfb71SThomas Gleixner * itself is also RCU protected so that the first pwq can be 235b09f4fd3SLai Jiangshan * determined without grabbing wq->mutex. 2368864b4e5STejun Heo */ 2378864b4e5STejun Heo struct work_struct unbound_release_work; 2388864b4e5STejun Heo struct rcu_head rcu; 239e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS); 2401da177e4SLinus Torvalds 2411da177e4SLinus Torvalds /* 24273f53c4aSTejun Heo * Structure used to wait for workqueue flush. 24373f53c4aSTejun Heo */ 24473f53c4aSTejun Heo struct wq_flusher { 2453c25a55dSLai Jiangshan struct list_head list; /* WQ: list of flushers */ 2463c25a55dSLai Jiangshan int flush_color; /* WQ: flush color waiting for */ 24773f53c4aSTejun Heo struct completion done; /* flush completion */ 24873f53c4aSTejun Heo }; 2491da177e4SLinus Torvalds 250226223abSTejun Heo struct wq_device; 251226223abSTejun Heo 25273f53c4aSTejun Heo /* 253c5aa87bbSTejun Heo * The externally visible workqueue. It relays the issued work items to 254c5aa87bbSTejun Heo * the appropriate worker_pool through its pool_workqueues. 2551da177e4SLinus Torvalds */ 2561da177e4SLinus Torvalds struct workqueue_struct { 2573c25a55dSLai Jiangshan struct list_head pwqs; /* WR: all pwqs of this wq */ 258e2dca7adSTejun Heo struct list_head list; /* PR: list of all workqueues */ 25973f53c4aSTejun Heo 2603c25a55dSLai Jiangshan struct mutex mutex; /* protects this wq */ 2613c25a55dSLai Jiangshan int work_color; /* WQ: current work color */ 2623c25a55dSLai Jiangshan int flush_color; /* WQ: current flush color */ 263112202d9STejun Heo atomic_t nr_pwqs_to_flush; /* flush in progress */ 2643c25a55dSLai Jiangshan struct wq_flusher *first_flusher; /* WQ: first flusher */ 2653c25a55dSLai Jiangshan struct list_head flusher_queue; /* WQ: flush waiters */ 2663c25a55dSLai Jiangshan struct list_head flusher_overflow; /* WQ: flush overflow list */ 26773f53c4aSTejun Heo 2682e109a28STejun Heo struct list_head maydays; /* MD: pwqs requesting rescue */ 26930ae2fc0STejun Heo struct worker *rescuer; /* MD: rescue worker */ 270e22bee78STejun Heo 27187fc741eSLai Jiangshan int nr_drainers; /* WQ: drain in progress */ 272a357fc03SLai Jiangshan int saved_max_active; /* WQ: saved pwq max_active */ 273226223abSTejun Heo 2745b95e1afSLai Jiangshan struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */ 2755b95e1afSLai Jiangshan struct pool_workqueue *dfl_pwq; /* PW: only for unbound wqs */ 2766029a918STejun Heo 277226223abSTejun Heo #ifdef CONFIG_SYSFS 278226223abSTejun Heo struct wq_device *wq_dev; /* I: for sysfs interface */ 279226223abSTejun Heo #endif 2804e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 281669de8bdSBart Van Assche char *lock_name; 282669de8bdSBart Van Assche struct lock_class_key key; 2834e6045f1SJohannes Berg struct lockdep_map lockdep_map; 2844e6045f1SJohannes Berg #endif 285ecf6881fSTejun Heo char name[WQ_NAME_LEN]; /* I: workqueue name */ 2862728fd2fSTejun Heo 287e2dca7adSTejun Heo /* 28824acfb71SThomas Gleixner * Destruction of workqueue_struct is RCU protected to allow walking 28924acfb71SThomas Gleixner * the workqueues list without grabbing wq_pool_mutex. 290e2dca7adSTejun Heo * This is used to dump all workqueues from sysrq. 291e2dca7adSTejun Heo */ 292e2dca7adSTejun Heo struct rcu_head rcu; 293e2dca7adSTejun Heo 2942728fd2fSTejun Heo /* hot fields used during command issue, aligned to cacheline */ 2952728fd2fSTejun Heo unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */ 2962728fd2fSTejun Heo struct pool_workqueue __percpu *cpu_pwqs; /* I: per-cpu pwqs */ 2975b95e1afSLai Jiangshan struct pool_workqueue __rcu *numa_pwq_tbl[]; /* PWR: unbound pwqs indexed by node */ 2981da177e4SLinus Torvalds }; 2991da177e4SLinus Torvalds 300e904e6c2STejun Heo static struct kmem_cache *pwq_cache; 301e904e6c2STejun Heo 302bce90380STejun Heo static cpumask_var_t *wq_numa_possible_cpumask; 303bce90380STejun Heo /* possible CPUs of each node */ 304bce90380STejun Heo 305d55262c4STejun Heo static bool wq_disable_numa; 306d55262c4STejun Heo module_param_named(disable_numa, wq_disable_numa, bool, 0444); 307d55262c4STejun Heo 308cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */ 309552f530cSLuis R. Rodriguez static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT); 310cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444); 311cee22a15SViresh Kumar 312863b710bSTejun Heo static bool wq_online; /* can kworkers be created yet? */ 3133347fa09STejun Heo 314bce90380STejun Heo static bool wq_numa_enabled; /* unbound NUMA affinity enabled */ 315bce90380STejun Heo 3164c16bd32STejun Heo /* buf for wq_update_unbound_numa_attrs(), protected by CPU hotplug exclusion */ 3174c16bd32STejun Heo static struct workqueue_attrs *wq_update_unbound_numa_attrs_buf; 3184c16bd32STejun Heo 31968e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */ 3201258fae7STejun Heo static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */ 321a9b8a985SSebastian Andrzej Siewior static DEFINE_RAW_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */ 322d8bb65abSSebastian Andrzej Siewior /* wait for manager to go away */ 323d8bb65abSSebastian Andrzej Siewior static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait); 3245bcab335STejun Heo 325e2dca7adSTejun Heo static LIST_HEAD(workqueues); /* PR: list of all workqueues */ 32668e13a67SLai Jiangshan static bool workqueue_freezing; /* PL: have wqs started freezing? */ 3277d19c5ceSTejun Heo 328ef557180SMike Galbraith /* PL: allowable cpus for unbound wqs and work items */ 329ef557180SMike Galbraith static cpumask_var_t wq_unbound_cpumask; 330ef557180SMike Galbraith 331ef557180SMike Galbraith /* CPU where unbound work was last round robin scheduled from this CPU */ 332ef557180SMike Galbraith static DEFINE_PER_CPU(int, wq_rr_cpu_last); 333b05a7928SFrederic Weisbecker 334f303fccbSTejun Heo /* 335f303fccbSTejun Heo * Local execution of unbound work items is no longer guaranteed. The 336f303fccbSTejun Heo * following always forces round-robin CPU selection on unbound work items 337f303fccbSTejun Heo * to uncover usages which depend on it. 338f303fccbSTejun Heo */ 339f303fccbSTejun Heo #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU 340f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = true; 341f303fccbSTejun Heo #else 342f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = false; 343f303fccbSTejun Heo #endif 344f303fccbSTejun Heo module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644); 345f303fccbSTejun Heo 3467d19c5ceSTejun Heo /* the per-cpu worker pools */ 34725528213SPeter Zijlstra static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools); 3487d19c5ceSTejun Heo 34968e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */ 3507d19c5ceSTejun Heo 35168e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */ 35229c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER); 35329c91e99STejun Heo 354c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */ 35529c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS]; 35629c91e99STejun Heo 3578a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */ 3588a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS]; 3598a2b7538STejun Heo 360d320c038STejun Heo struct workqueue_struct *system_wq __read_mostly; 361ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq); 362044c782cSValentin Ilie struct workqueue_struct *system_highpri_wq __read_mostly; 3631aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq); 364044c782cSValentin Ilie struct workqueue_struct *system_long_wq __read_mostly; 365d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq); 366044c782cSValentin Ilie struct workqueue_struct *system_unbound_wq __read_mostly; 367f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq); 368044c782cSValentin Ilie struct workqueue_struct *system_freezable_wq __read_mostly; 36924d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq); 3700668106cSViresh Kumar struct workqueue_struct *system_power_efficient_wq __read_mostly; 3710668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq); 3720668106cSViresh Kumar struct workqueue_struct *system_freezable_power_efficient_wq __read_mostly; 3730668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq); 374d320c038STejun Heo 3757d19c5ceSTejun Heo static int worker_thread(void *__worker); 3766ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq); 377c29eb853STejun Heo static void show_pwq(struct pool_workqueue *pwq); 37855df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool); 3797d19c5ceSTejun Heo 38097bd2347STejun Heo #define CREATE_TRACE_POINTS 38197bd2347STejun Heo #include <trace/events/workqueue.h> 38297bd2347STejun Heo 38368e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex() \ 38424acfb71SThomas Gleixner RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \ 385f78f5b90SPaul E. McKenney !lockdep_is_held(&wq_pool_mutex), \ 38624acfb71SThomas Gleixner "RCU or wq_pool_mutex should be held") 3875bcab335STejun Heo 3885b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \ 38924acfb71SThomas Gleixner RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \ 390f78f5b90SPaul E. McKenney !lockdep_is_held(&wq->mutex) && \ 391f78f5b90SPaul E. McKenney !lockdep_is_held(&wq_pool_mutex), \ 39224acfb71SThomas Gleixner "RCU, wq->mutex or wq_pool_mutex should be held") 3935b95e1afSLai Jiangshan 394f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu) \ 395f02ae73aSTejun Heo for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \ 396f02ae73aSTejun Heo (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \ 3977a62c2c8STejun Heo (pool)++) 3984ce62e9eSTejun Heo 39949e3cf44STejun Heo /** 40017116969STejun Heo * for_each_pool - iterate through all worker_pools in the system 40117116969STejun Heo * @pool: iteration cursor 402611c92a0STejun Heo * @pi: integer used for iteration 403fa1b54e6STejun Heo * 40424acfb71SThomas Gleixner * This must be called either with wq_pool_mutex held or RCU read 40568e13a67SLai Jiangshan * locked. If the pool needs to be used beyond the locking in effect, the 40668e13a67SLai Jiangshan * caller is responsible for guaranteeing that the pool stays online. 407fa1b54e6STejun Heo * 408fa1b54e6STejun Heo * The if/else clause exists only for the lockdep assertion and can be 409fa1b54e6STejun Heo * ignored. 41017116969STejun Heo */ 411611c92a0STejun Heo #define for_each_pool(pool, pi) \ 412611c92a0STejun Heo idr_for_each_entry(&worker_pool_idr, pool, pi) \ 41368e13a67SLai Jiangshan if (({ assert_rcu_or_pool_mutex(); false; })) { } \ 414fa1b54e6STejun Heo else 41517116969STejun Heo 41617116969STejun Heo /** 417822d8405STejun Heo * for_each_pool_worker - iterate through all workers of a worker_pool 418822d8405STejun Heo * @worker: iteration cursor 419822d8405STejun Heo * @pool: worker_pool to iterate workers of 420822d8405STejun Heo * 4211258fae7STejun Heo * This must be called with wq_pool_attach_mutex. 422822d8405STejun Heo * 423822d8405STejun Heo * The if/else clause exists only for the lockdep assertion and can be 424822d8405STejun Heo * ignored. 425822d8405STejun Heo */ 426da028469SLai Jiangshan #define for_each_pool_worker(worker, pool) \ 427da028469SLai Jiangshan list_for_each_entry((worker), &(pool)->workers, node) \ 4281258fae7STejun Heo if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \ 429822d8405STejun Heo else 430822d8405STejun Heo 431822d8405STejun Heo /** 43249e3cf44STejun Heo * for_each_pwq - iterate through all pool_workqueues of the specified workqueue 43349e3cf44STejun Heo * @pwq: iteration cursor 43449e3cf44STejun Heo * @wq: the target workqueue 43576af4d93STejun Heo * 43624acfb71SThomas Gleixner * This must be called either with wq->mutex held or RCU read locked. 437794b18bcSTejun Heo * If the pwq needs to be used beyond the locking in effect, the caller is 438794b18bcSTejun Heo * responsible for guaranteeing that the pwq stays online. 43976af4d93STejun Heo * 44076af4d93STejun Heo * The if/else clause exists only for the lockdep assertion and can be 44176af4d93STejun Heo * ignored. 44249e3cf44STejun Heo */ 44349e3cf44STejun Heo #define for_each_pwq(pwq, wq) \ 44449e9d1a9SSebastian Andrzej Siewior list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \ 4455a644662SJoel Fernandes (Google) lockdep_is_held(&(wq->mutex))) 446f3421797STejun Heo 447dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 448dc186ad7SThomas Gleixner 449f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr; 450dc186ad7SThomas Gleixner 45199777288SStanislaw Gruszka static void *work_debug_hint(void *addr) 45299777288SStanislaw Gruszka { 45399777288SStanislaw Gruszka return ((struct work_struct *) addr)->func; 45499777288SStanislaw Gruszka } 45599777288SStanislaw Gruszka 456b9fdac7fSDu, Changbin static bool work_is_static_object(void *addr) 457b9fdac7fSDu, Changbin { 458b9fdac7fSDu, Changbin struct work_struct *work = addr; 459b9fdac7fSDu, Changbin 460b9fdac7fSDu, Changbin return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work)); 461b9fdac7fSDu, Changbin } 462b9fdac7fSDu, Changbin 463dc186ad7SThomas Gleixner /* 464dc186ad7SThomas Gleixner * fixup_init is called when: 465dc186ad7SThomas Gleixner * - an active object is initialized 466dc186ad7SThomas Gleixner */ 46702a982a6SDu, Changbin static bool work_fixup_init(void *addr, enum debug_obj_state state) 468dc186ad7SThomas Gleixner { 469dc186ad7SThomas Gleixner struct work_struct *work = addr; 470dc186ad7SThomas Gleixner 471dc186ad7SThomas Gleixner switch (state) { 472dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 473dc186ad7SThomas Gleixner cancel_work_sync(work); 474dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 47502a982a6SDu, Changbin return true; 476dc186ad7SThomas Gleixner default: 47702a982a6SDu, Changbin return false; 478dc186ad7SThomas Gleixner } 479dc186ad7SThomas Gleixner } 480dc186ad7SThomas Gleixner 481dc186ad7SThomas Gleixner /* 482dc186ad7SThomas Gleixner * fixup_free is called when: 483dc186ad7SThomas Gleixner * - an active object is freed 484dc186ad7SThomas Gleixner */ 48502a982a6SDu, Changbin static bool work_fixup_free(void *addr, enum debug_obj_state state) 486dc186ad7SThomas Gleixner { 487dc186ad7SThomas Gleixner struct work_struct *work = addr; 488dc186ad7SThomas Gleixner 489dc186ad7SThomas Gleixner switch (state) { 490dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 491dc186ad7SThomas Gleixner cancel_work_sync(work); 492dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 49302a982a6SDu, Changbin return true; 494dc186ad7SThomas Gleixner default: 49502a982a6SDu, Changbin return false; 496dc186ad7SThomas Gleixner } 497dc186ad7SThomas Gleixner } 498dc186ad7SThomas Gleixner 499f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr = { 500dc186ad7SThomas Gleixner .name = "work_struct", 50199777288SStanislaw Gruszka .debug_hint = work_debug_hint, 502b9fdac7fSDu, Changbin .is_static_object = work_is_static_object, 503dc186ad7SThomas Gleixner .fixup_init = work_fixup_init, 504dc186ad7SThomas Gleixner .fixup_free = work_fixup_free, 505dc186ad7SThomas Gleixner }; 506dc186ad7SThomas Gleixner 507dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) 508dc186ad7SThomas Gleixner { 509dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 510dc186ad7SThomas Gleixner } 511dc186ad7SThomas Gleixner 512dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) 513dc186ad7SThomas Gleixner { 514dc186ad7SThomas Gleixner debug_object_deactivate(work, &work_debug_descr); 515dc186ad7SThomas Gleixner } 516dc186ad7SThomas Gleixner 517dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack) 518dc186ad7SThomas Gleixner { 519dc186ad7SThomas Gleixner if (onstack) 520dc186ad7SThomas Gleixner debug_object_init_on_stack(work, &work_debug_descr); 521dc186ad7SThomas Gleixner else 522dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 523dc186ad7SThomas Gleixner } 524dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work); 525dc186ad7SThomas Gleixner 526dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work) 527dc186ad7SThomas Gleixner { 528dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 529dc186ad7SThomas Gleixner } 530dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack); 531dc186ad7SThomas Gleixner 532ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work) 533ea2e64f2SThomas Gleixner { 534ea2e64f2SThomas Gleixner destroy_timer_on_stack(&work->timer); 535ea2e64f2SThomas Gleixner debug_object_free(&work->work, &work_debug_descr); 536ea2e64f2SThomas Gleixner } 537ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack); 538ea2e64f2SThomas Gleixner 539dc186ad7SThomas Gleixner #else 540dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { } 541dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { } 542dc186ad7SThomas Gleixner #endif 543dc186ad7SThomas Gleixner 5444e8b22bdSLi Bin /** 54567dc8325SCai Huoqing * worker_pool_assign_id - allocate ID and assign it to @pool 5464e8b22bdSLi Bin * @pool: the pool pointer of interest 5474e8b22bdSLi Bin * 5484e8b22bdSLi Bin * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned 5494e8b22bdSLi Bin * successfully, -errno on failure. 5504e8b22bdSLi Bin */ 5519daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool) 5529daf9e67STejun Heo { 5539daf9e67STejun Heo int ret; 5549daf9e67STejun Heo 55568e13a67SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 5565bcab335STejun Heo 5574e8b22bdSLi Bin ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE, 5584e8b22bdSLi Bin GFP_KERNEL); 559229641a6STejun Heo if (ret >= 0) { 560e68035fbSTejun Heo pool->id = ret; 561229641a6STejun Heo return 0; 562229641a6STejun Heo } 5639daf9e67STejun Heo return ret; 5649daf9e67STejun Heo } 5659daf9e67STejun Heo 56676af4d93STejun Heo /** 567df2d5ae4STejun Heo * unbound_pwq_by_node - return the unbound pool_workqueue for the given node 568df2d5ae4STejun Heo * @wq: the target workqueue 569df2d5ae4STejun Heo * @node: the node ID 570df2d5ae4STejun Heo * 57124acfb71SThomas Gleixner * This must be called with any of wq_pool_mutex, wq->mutex or RCU 5725b95e1afSLai Jiangshan * read locked. 573df2d5ae4STejun Heo * If the pwq needs to be used beyond the locking in effect, the caller is 574df2d5ae4STejun Heo * responsible for guaranteeing that the pwq stays online. 575d185af30SYacine Belkadi * 576d185af30SYacine Belkadi * Return: The unbound pool_workqueue for @node. 577df2d5ae4STejun Heo */ 578df2d5ae4STejun Heo static struct pool_workqueue *unbound_pwq_by_node(struct workqueue_struct *wq, 579df2d5ae4STejun Heo int node) 580df2d5ae4STejun Heo { 5815b95e1afSLai Jiangshan assert_rcu_or_wq_mutex_or_pool_mutex(wq); 582d6e022f1STejun Heo 583d6e022f1STejun Heo /* 584d6e022f1STejun Heo * XXX: @node can be NUMA_NO_NODE if CPU goes offline while a 585d6e022f1STejun Heo * delayed item is pending. The plan is to keep CPU -> NODE 586d6e022f1STejun Heo * mapping valid and stable across CPU on/offlines. Once that 587d6e022f1STejun Heo * happens, this workaround can be removed. 588d6e022f1STejun Heo */ 589d6e022f1STejun Heo if (unlikely(node == NUMA_NO_NODE)) 590d6e022f1STejun Heo return wq->dfl_pwq; 591d6e022f1STejun Heo 592df2d5ae4STejun Heo return rcu_dereference_raw(wq->numa_pwq_tbl[node]); 593df2d5ae4STejun Heo } 594df2d5ae4STejun Heo 59573f53c4aSTejun Heo static unsigned int work_color_to_flags(int color) 59673f53c4aSTejun Heo { 59773f53c4aSTejun Heo return color << WORK_STRUCT_COLOR_SHIFT; 59873f53c4aSTejun Heo } 59973f53c4aSTejun Heo 600c4560c2cSLai Jiangshan static int get_work_color(unsigned long work_data) 60173f53c4aSTejun Heo { 602c4560c2cSLai Jiangshan return (work_data >> WORK_STRUCT_COLOR_SHIFT) & 60373f53c4aSTejun Heo ((1 << WORK_STRUCT_COLOR_BITS) - 1); 60473f53c4aSTejun Heo } 60573f53c4aSTejun Heo 60673f53c4aSTejun Heo static int work_next_color(int color) 60773f53c4aSTejun Heo { 60873f53c4aSTejun Heo return (color + 1) % WORK_NR_COLORS; 609a848e3b6SOleg Nesterov } 610a848e3b6SOleg Nesterov 6114594bf15SDavid Howells /* 612112202d9STejun Heo * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data 613112202d9STejun Heo * contain the pointer to the queued pwq. Once execution starts, the flag 6147c3eed5cSTejun Heo * is cleared and the high bits contain OFFQ flags and pool ID. 6157a22ad75STejun Heo * 616112202d9STejun Heo * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling() 617112202d9STejun Heo * and clear_work_data() can be used to set the pwq, pool or clear 618bbb68dfaSTejun Heo * work->data. These functions should only be called while the work is 619bbb68dfaSTejun Heo * owned - ie. while the PENDING bit is set. 6207a22ad75STejun Heo * 621112202d9STejun Heo * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq 6227c3eed5cSTejun Heo * corresponding to a work. Pool is available once the work has been 623112202d9STejun Heo * queued anywhere after initialization until it is sync canceled. pwq is 6247c3eed5cSTejun Heo * available only while the work item is queued. 625bbb68dfaSTejun Heo * 626bbb68dfaSTejun Heo * %WORK_OFFQ_CANCELING is used to mark a work item which is being 627bbb68dfaSTejun Heo * canceled. While being canceled, a work item may have its PENDING set 628bbb68dfaSTejun Heo * but stay off timer and worklist for arbitrarily long and nobody should 629bbb68dfaSTejun Heo * try to steal the PENDING bit. 6304594bf15SDavid Howells */ 6317a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data, 6327a22ad75STejun Heo unsigned long flags) 6337a22ad75STejun Heo { 6346183c009STejun Heo WARN_ON_ONCE(!work_pending(work)); 6357a22ad75STejun Heo atomic_long_set(&work->data, data | flags | work_static(work)); 6367a22ad75STejun Heo } 6377a22ad75STejun Heo 638112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq, 6394690c4abSTejun Heo unsigned long extra_flags) 640365970a1SDavid Howells { 641112202d9STejun Heo set_work_data(work, (unsigned long)pwq, 642112202d9STejun Heo WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags); 643365970a1SDavid Howells } 644365970a1SDavid Howells 6454468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work, 6464468a00fSLai Jiangshan int pool_id) 6474468a00fSLai Jiangshan { 6484468a00fSLai Jiangshan set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 6494468a00fSLai Jiangshan WORK_STRUCT_PENDING); 6504468a00fSLai Jiangshan } 6514468a00fSLai Jiangshan 6527c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work, 6537c3eed5cSTejun Heo int pool_id) 6544d707b9fSOleg Nesterov { 65523657bb1STejun Heo /* 65623657bb1STejun Heo * The following wmb is paired with the implied mb in 65723657bb1STejun Heo * test_and_set_bit(PENDING) and ensures all updates to @work made 65823657bb1STejun Heo * here are visible to and precede any updates by the next PENDING 65923657bb1STejun Heo * owner. 66023657bb1STejun Heo */ 66123657bb1STejun Heo smp_wmb(); 6627c3eed5cSTejun Heo set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0); 663346c09f8SRoman Pen /* 664346c09f8SRoman Pen * The following mb guarantees that previous clear of a PENDING bit 665346c09f8SRoman Pen * will not be reordered with any speculative LOADS or STORES from 666346c09f8SRoman Pen * work->current_func, which is executed afterwards. This possible 6678bdc6201SLiu Song * reordering can lead to a missed execution on attempt to queue 668346c09f8SRoman Pen * the same @work. E.g. consider this case: 669346c09f8SRoman Pen * 670346c09f8SRoman Pen * CPU#0 CPU#1 671346c09f8SRoman Pen * ---------------------------- -------------------------------- 672346c09f8SRoman Pen * 673346c09f8SRoman Pen * 1 STORE event_indicated 674346c09f8SRoman Pen * 2 queue_work_on() { 675346c09f8SRoman Pen * 3 test_and_set_bit(PENDING) 676346c09f8SRoman Pen * 4 } set_..._and_clear_pending() { 677346c09f8SRoman Pen * 5 set_work_data() # clear bit 678346c09f8SRoman Pen * 6 smp_mb() 679346c09f8SRoman Pen * 7 work->current_func() { 680346c09f8SRoman Pen * 8 LOAD event_indicated 681346c09f8SRoman Pen * } 682346c09f8SRoman Pen * 683346c09f8SRoman Pen * Without an explicit full barrier speculative LOAD on line 8 can 684346c09f8SRoman Pen * be executed before CPU#0 does STORE on line 1. If that happens, 685346c09f8SRoman Pen * CPU#0 observes the PENDING bit is still set and new execution of 686346c09f8SRoman Pen * a @work is not queued in a hope, that CPU#1 will eventually 687346c09f8SRoman Pen * finish the queued @work. Meanwhile CPU#1 does not see 688346c09f8SRoman Pen * event_indicated is set, because speculative LOAD was executed 689346c09f8SRoman Pen * before actual STORE. 690346c09f8SRoman Pen */ 691346c09f8SRoman Pen smp_mb(); 6924d707b9fSOleg Nesterov } 6934d707b9fSOleg Nesterov 6947a22ad75STejun Heo static void clear_work_data(struct work_struct *work) 695365970a1SDavid Howells { 6967c3eed5cSTejun Heo smp_wmb(); /* see set_work_pool_and_clear_pending() */ 6977c3eed5cSTejun Heo set_work_data(work, WORK_STRUCT_NO_POOL, 0); 6987a22ad75STejun Heo } 6997a22ad75STejun Heo 700112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work) 7017a22ad75STejun Heo { 702e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 7037a22ad75STejun Heo 704112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 705e120153dSTejun Heo return (void *)(data & WORK_STRUCT_WQ_DATA_MASK); 706e120153dSTejun Heo else 707e120153dSTejun Heo return NULL; 7087a22ad75STejun Heo } 7097a22ad75STejun Heo 7107c3eed5cSTejun Heo /** 7117c3eed5cSTejun Heo * get_work_pool - return the worker_pool a given work was associated with 7127c3eed5cSTejun Heo * @work: the work item of interest 7137c3eed5cSTejun Heo * 71468e13a67SLai Jiangshan * Pools are created and destroyed under wq_pool_mutex, and allows read 71524acfb71SThomas Gleixner * access under RCU read lock. As such, this function should be 71624acfb71SThomas Gleixner * called under wq_pool_mutex or inside of a rcu_read_lock() region. 717fa1b54e6STejun Heo * 718fa1b54e6STejun Heo * All fields of the returned pool are accessible as long as the above 719fa1b54e6STejun Heo * mentioned locking is in effect. If the returned pool needs to be used 720fa1b54e6STejun Heo * beyond the critical section, the caller is responsible for ensuring the 721fa1b54e6STejun Heo * returned pool is and stays online. 722d185af30SYacine Belkadi * 723d185af30SYacine Belkadi * Return: The worker_pool @work was last associated with. %NULL if none. 7247c3eed5cSTejun Heo */ 7257c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work) 7267a22ad75STejun Heo { 727e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 7287c3eed5cSTejun Heo int pool_id; 7297a22ad75STejun Heo 73068e13a67SLai Jiangshan assert_rcu_or_pool_mutex(); 731fa1b54e6STejun Heo 732112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 733112202d9STejun Heo return ((struct pool_workqueue *) 7347c3eed5cSTejun Heo (data & WORK_STRUCT_WQ_DATA_MASK))->pool; 7357a22ad75STejun Heo 7367c3eed5cSTejun Heo pool_id = data >> WORK_OFFQ_POOL_SHIFT; 7377c3eed5cSTejun Heo if (pool_id == WORK_OFFQ_POOL_NONE) 7387a22ad75STejun Heo return NULL; 7397a22ad75STejun Heo 740fa1b54e6STejun Heo return idr_find(&worker_pool_idr, pool_id); 7417c3eed5cSTejun Heo } 7427c3eed5cSTejun Heo 7437c3eed5cSTejun Heo /** 7447c3eed5cSTejun Heo * get_work_pool_id - return the worker pool ID a given work is associated with 7457c3eed5cSTejun Heo * @work: the work item of interest 7467c3eed5cSTejun Heo * 747d185af30SYacine Belkadi * Return: The worker_pool ID @work was last associated with. 7487c3eed5cSTejun Heo * %WORK_OFFQ_POOL_NONE if none. 7497c3eed5cSTejun Heo */ 7507c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work) 7517c3eed5cSTejun Heo { 75254d5b7d0SLai Jiangshan unsigned long data = atomic_long_read(&work->data); 7537c3eed5cSTejun Heo 754112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 755112202d9STejun Heo return ((struct pool_workqueue *) 75654d5b7d0SLai Jiangshan (data & WORK_STRUCT_WQ_DATA_MASK))->pool->id; 75754d5b7d0SLai Jiangshan 75854d5b7d0SLai Jiangshan return data >> WORK_OFFQ_POOL_SHIFT; 7597c3eed5cSTejun Heo } 7607c3eed5cSTejun Heo 761bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work) 762bbb68dfaSTejun Heo { 7637c3eed5cSTejun Heo unsigned long pool_id = get_work_pool_id(work); 764bbb68dfaSTejun Heo 7657c3eed5cSTejun Heo pool_id <<= WORK_OFFQ_POOL_SHIFT; 7667c3eed5cSTejun Heo set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING); 767bbb68dfaSTejun Heo } 768bbb68dfaSTejun Heo 769bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work) 770bbb68dfaSTejun Heo { 771bbb68dfaSTejun Heo unsigned long data = atomic_long_read(&work->data); 772bbb68dfaSTejun Heo 773112202d9STejun Heo return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING); 774bbb68dfaSTejun Heo } 775bbb68dfaSTejun Heo 776e22bee78STejun Heo /* 7773270476aSTejun Heo * Policy functions. These define the policies on how the global worker 7783270476aSTejun Heo * pools are managed. Unless noted otherwise, these functions assume that 779d565ed63STejun Heo * they're being called with pool->lock held. 780e22bee78STejun Heo */ 781e22bee78STejun Heo 78263d95a91STejun Heo static bool __need_more_worker(struct worker_pool *pool) 783649027d7STejun Heo { 784e19e397aSTejun Heo return !atomic_read(&pool->nr_running); 785649027d7STejun Heo } 786649027d7STejun Heo 787e22bee78STejun Heo /* 788e22bee78STejun Heo * Need to wake up a worker? Called from anything but currently 789e22bee78STejun Heo * running workers. 790974271c4STejun Heo * 791974271c4STejun Heo * Note that, because unbound workers never contribute to nr_running, this 792706026c2STejun Heo * function will always return %true for unbound pools as long as the 793974271c4STejun Heo * worklist isn't empty. 794e22bee78STejun Heo */ 79563d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool) 796e22bee78STejun Heo { 79763d95a91STejun Heo return !list_empty(&pool->worklist) && __need_more_worker(pool); 798e22bee78STejun Heo } 799e22bee78STejun Heo 800e22bee78STejun Heo /* Can I start working? Called from busy but !running workers. */ 80163d95a91STejun Heo static bool may_start_working(struct worker_pool *pool) 802e22bee78STejun Heo { 80363d95a91STejun Heo return pool->nr_idle; 804e22bee78STejun Heo } 805e22bee78STejun Heo 806e22bee78STejun Heo /* Do I need to keep working? Called from currently running workers. */ 80763d95a91STejun Heo static bool keep_working(struct worker_pool *pool) 808e22bee78STejun Heo { 809e19e397aSTejun Heo return !list_empty(&pool->worklist) && 810e19e397aSTejun Heo atomic_read(&pool->nr_running) <= 1; 811e22bee78STejun Heo } 812e22bee78STejun Heo 813e22bee78STejun Heo /* Do we need a new worker? Called from manager. */ 81463d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool) 815e22bee78STejun Heo { 81663d95a91STejun Heo return need_more_worker(pool) && !may_start_working(pool); 817e22bee78STejun Heo } 818e22bee78STejun Heo 819e22bee78STejun Heo /* Do we have too many workers and should some go away? */ 82063d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool) 821e22bee78STejun Heo { 822692b4825STejun Heo bool managing = pool->flags & POOL_MANAGER_ACTIVE; 82363d95a91STejun Heo int nr_idle = pool->nr_idle + managing; /* manager is considered idle */ 82463d95a91STejun Heo int nr_busy = pool->nr_workers - nr_idle; 825e22bee78STejun Heo 826e22bee78STejun Heo return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; 827e22bee78STejun Heo } 828e22bee78STejun Heo 829e22bee78STejun Heo /* 830e22bee78STejun Heo * Wake up functions. 831e22bee78STejun Heo */ 832e22bee78STejun Heo 8331037de36SLai Jiangshan /* Return the first idle worker. Safe with preemption disabled */ 8341037de36SLai Jiangshan static struct worker *first_idle_worker(struct worker_pool *pool) 8357e11629dSTejun Heo { 83663d95a91STejun Heo if (unlikely(list_empty(&pool->idle_list))) 8377e11629dSTejun Heo return NULL; 8387e11629dSTejun Heo 83963d95a91STejun Heo return list_first_entry(&pool->idle_list, struct worker, entry); 8407e11629dSTejun Heo } 8417e11629dSTejun Heo 8427e11629dSTejun Heo /** 8437e11629dSTejun Heo * wake_up_worker - wake up an idle worker 84463d95a91STejun Heo * @pool: worker pool to wake worker from 8457e11629dSTejun Heo * 84663d95a91STejun Heo * Wake up the first idle worker of @pool. 8477e11629dSTejun Heo * 8487e11629dSTejun Heo * CONTEXT: 849a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 8507e11629dSTejun Heo */ 85163d95a91STejun Heo static void wake_up_worker(struct worker_pool *pool) 8527e11629dSTejun Heo { 8531037de36SLai Jiangshan struct worker *worker = first_idle_worker(pool); 8547e11629dSTejun Heo 8557e11629dSTejun Heo if (likely(worker)) 8567e11629dSTejun Heo wake_up_process(worker->task); 8577e11629dSTejun Heo } 8587e11629dSTejun Heo 8594690c4abSTejun Heo /** 8606d25be57SThomas Gleixner * wq_worker_running - a worker is running again 861e22bee78STejun Heo * @task: task waking up 862e22bee78STejun Heo * 8636d25be57SThomas Gleixner * This function is called when a worker returns from schedule() 864e22bee78STejun Heo */ 8656d25be57SThomas Gleixner void wq_worker_running(struct task_struct *task) 866e22bee78STejun Heo { 867e22bee78STejun Heo struct worker *worker = kthread_data(task); 868e22bee78STejun Heo 8696d25be57SThomas Gleixner if (!worker->sleeping) 8706d25be57SThomas Gleixner return; 871*07edfeceSFrederic Weisbecker 872*07edfeceSFrederic Weisbecker /* 873*07edfeceSFrederic Weisbecker * If preempted by unbind_workers() between the WORKER_NOT_RUNNING check 874*07edfeceSFrederic Weisbecker * and the nr_running increment below, we may ruin the nr_running reset 875*07edfeceSFrederic Weisbecker * and leave with an unexpected pool->nr_running == 1 on the newly unbound 876*07edfeceSFrederic Weisbecker * pool. Protect against such race. 877*07edfeceSFrederic Weisbecker */ 878*07edfeceSFrederic Weisbecker preempt_disable(); 8796d25be57SThomas Gleixner if (!(worker->flags & WORKER_NOT_RUNNING)) 880e19e397aSTejun Heo atomic_inc(&worker->pool->nr_running); 881*07edfeceSFrederic Weisbecker preempt_enable(); 8826d25be57SThomas Gleixner worker->sleeping = 0; 88336576000SJoonsoo Kim } 884e22bee78STejun Heo 885e22bee78STejun Heo /** 886e22bee78STejun Heo * wq_worker_sleeping - a worker is going to sleep 887e22bee78STejun Heo * @task: task going to sleep 888e22bee78STejun Heo * 8896d25be57SThomas Gleixner * This function is called from schedule() when a busy worker is 89062849a96SSebastian Andrzej Siewior * going to sleep. Preemption needs to be disabled to protect ->sleeping 89162849a96SSebastian Andrzej Siewior * assignment. 892e22bee78STejun Heo */ 8936d25be57SThomas Gleixner void wq_worker_sleeping(struct task_struct *task) 894e22bee78STejun Heo { 8956d25be57SThomas Gleixner struct worker *next, *worker = kthread_data(task); 896111c225aSTejun Heo struct worker_pool *pool; 897e22bee78STejun Heo 898111c225aSTejun Heo /* 899111c225aSTejun Heo * Rescuers, which may not have all the fields set up like normal 900111c225aSTejun Heo * workers, also reach here, let's not access anything before 901111c225aSTejun Heo * checking NOT_RUNNING. 902111c225aSTejun Heo */ 9032d64672eSSteven Rostedt if (worker->flags & WORKER_NOT_RUNNING) 9046d25be57SThomas Gleixner return; 905e22bee78STejun Heo 906111c225aSTejun Heo pool = worker->pool; 907111c225aSTejun Heo 90862849a96SSebastian Andrzej Siewior /* Return if preempted before wq_worker_running() was reached */ 90962849a96SSebastian Andrzej Siewior if (worker->sleeping) 9106d25be57SThomas Gleixner return; 9116d25be57SThomas Gleixner 9126d25be57SThomas Gleixner worker->sleeping = 1; 913a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 914e22bee78STejun Heo 915e22bee78STejun Heo /* 916e22bee78STejun Heo * The counterpart of the following dec_and_test, implied mb, 917e22bee78STejun Heo * worklist not empty test sequence is in insert_work(). 918e22bee78STejun Heo * Please read comment there. 919e22bee78STejun Heo * 920628c78e7STejun Heo * NOT_RUNNING is clear. This means that we're bound to and 921628c78e7STejun Heo * running on the local cpu w/ rq lock held and preemption 922628c78e7STejun Heo * disabled, which in turn means that none else could be 923d565ed63STejun Heo * manipulating idle_list, so dereferencing idle_list without pool 924628c78e7STejun Heo * lock is safe. 925e22bee78STejun Heo */ 926e19e397aSTejun Heo if (atomic_dec_and_test(&pool->nr_running) && 9276d25be57SThomas Gleixner !list_empty(&pool->worklist)) { 9286d25be57SThomas Gleixner next = first_idle_worker(pool); 9296d25be57SThomas Gleixner if (next) 9306d25be57SThomas Gleixner wake_up_process(next->task); 9316d25be57SThomas Gleixner } 932a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 933e22bee78STejun Heo } 934e22bee78STejun Heo 935e22bee78STejun Heo /** 9361b69ac6bSJohannes Weiner * wq_worker_last_func - retrieve worker's last work function 9378194fe94SBart Van Assche * @task: Task to retrieve last work function of. 9381b69ac6bSJohannes Weiner * 9391b69ac6bSJohannes Weiner * Determine the last function a worker executed. This is called from 9401b69ac6bSJohannes Weiner * the scheduler to get a worker's last known identity. 9411b69ac6bSJohannes Weiner * 9421b69ac6bSJohannes Weiner * CONTEXT: 943a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(rq->lock) 9441b69ac6bSJohannes Weiner * 9454b047002SJohannes Weiner * This function is called during schedule() when a kworker is going 9464b047002SJohannes Weiner * to sleep. It's used by psi to identify aggregation workers during 9474b047002SJohannes Weiner * dequeuing, to allow periodic aggregation to shut-off when that 9484b047002SJohannes Weiner * worker is the last task in the system or cgroup to go to sleep. 9494b047002SJohannes Weiner * 9504b047002SJohannes Weiner * As this function doesn't involve any workqueue-related locking, it 9514b047002SJohannes Weiner * only returns stable values when called from inside the scheduler's 9524b047002SJohannes Weiner * queuing and dequeuing paths, when @task, which must be a kworker, 9534b047002SJohannes Weiner * is guaranteed to not be processing any works. 9544b047002SJohannes Weiner * 9551b69ac6bSJohannes Weiner * Return: 9561b69ac6bSJohannes Weiner * The last work function %current executed as a worker, NULL if it 9571b69ac6bSJohannes Weiner * hasn't executed any work yet. 9581b69ac6bSJohannes Weiner */ 9591b69ac6bSJohannes Weiner work_func_t wq_worker_last_func(struct task_struct *task) 9601b69ac6bSJohannes Weiner { 9611b69ac6bSJohannes Weiner struct worker *worker = kthread_data(task); 9621b69ac6bSJohannes Weiner 9631b69ac6bSJohannes Weiner return worker->last_func; 9641b69ac6bSJohannes Weiner } 9651b69ac6bSJohannes Weiner 9661b69ac6bSJohannes Weiner /** 967e22bee78STejun Heo * worker_set_flags - set worker flags and adjust nr_running accordingly 968cb444766STejun Heo * @worker: self 969d302f017STejun Heo * @flags: flags to set 970d302f017STejun Heo * 971228f1d00SLai Jiangshan * Set @flags in @worker->flags and adjust nr_running accordingly. 972d302f017STejun Heo * 973cb444766STejun Heo * CONTEXT: 974a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) 975d302f017STejun Heo */ 976228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags) 977d302f017STejun Heo { 978bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 979e22bee78STejun Heo 980cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 981cb444766STejun Heo 982228f1d00SLai Jiangshan /* If transitioning into NOT_RUNNING, adjust nr_running. */ 983e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && 984e22bee78STejun Heo !(worker->flags & WORKER_NOT_RUNNING)) { 985e19e397aSTejun Heo atomic_dec(&pool->nr_running); 986e22bee78STejun Heo } 987e22bee78STejun Heo 988d302f017STejun Heo worker->flags |= flags; 989d302f017STejun Heo } 990d302f017STejun Heo 991d302f017STejun Heo /** 992e22bee78STejun Heo * worker_clr_flags - clear worker flags and adjust nr_running accordingly 993cb444766STejun Heo * @worker: self 994d302f017STejun Heo * @flags: flags to clear 995d302f017STejun Heo * 996e22bee78STejun Heo * Clear @flags in @worker->flags and adjust nr_running accordingly. 997d302f017STejun Heo * 998cb444766STejun Heo * CONTEXT: 999a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) 1000d302f017STejun Heo */ 1001d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags) 1002d302f017STejun Heo { 100363d95a91STejun Heo struct worker_pool *pool = worker->pool; 1004e22bee78STejun Heo unsigned int oflags = worker->flags; 1005e22bee78STejun Heo 1006cb444766STejun Heo WARN_ON_ONCE(worker->task != current); 1007cb444766STejun Heo 1008d302f017STejun Heo worker->flags &= ~flags; 1009e22bee78STejun Heo 101042c025f3STejun Heo /* 101142c025f3STejun Heo * If transitioning out of NOT_RUNNING, increment nr_running. Note 101242c025f3STejun Heo * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask 101342c025f3STejun Heo * of multiple flags, not a single flag. 101442c025f3STejun Heo */ 1015e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) 1016e22bee78STejun Heo if (!(worker->flags & WORKER_NOT_RUNNING)) 1017e19e397aSTejun Heo atomic_inc(&pool->nr_running); 1018d302f017STejun Heo } 1019d302f017STejun Heo 1020d302f017STejun Heo /** 10218cca0eeaSTejun Heo * find_worker_executing_work - find worker which is executing a work 1022c9e7cf27STejun Heo * @pool: pool of interest 10238cca0eeaSTejun Heo * @work: work to find worker for 10248cca0eeaSTejun Heo * 1025c9e7cf27STejun Heo * Find a worker which is executing @work on @pool by searching 1026c9e7cf27STejun Heo * @pool->busy_hash which is keyed by the address of @work. For a worker 1027a2c1c57bSTejun Heo * to match, its current execution should match the address of @work and 1028a2c1c57bSTejun Heo * its work function. This is to avoid unwanted dependency between 1029a2c1c57bSTejun Heo * unrelated work executions through a work item being recycled while still 1030a2c1c57bSTejun Heo * being executed. 1031a2c1c57bSTejun Heo * 1032a2c1c57bSTejun Heo * This is a bit tricky. A work item may be freed once its execution 1033a2c1c57bSTejun Heo * starts and nothing prevents the freed area from being recycled for 1034a2c1c57bSTejun Heo * another work item. If the same work item address ends up being reused 1035a2c1c57bSTejun Heo * before the original execution finishes, workqueue will identify the 1036a2c1c57bSTejun Heo * recycled work item as currently executing and make it wait until the 1037a2c1c57bSTejun Heo * current execution finishes, introducing an unwanted dependency. 1038a2c1c57bSTejun Heo * 1039c5aa87bbSTejun Heo * This function checks the work item address and work function to avoid 1040c5aa87bbSTejun Heo * false positives. Note that this isn't complete as one may construct a 1041c5aa87bbSTejun Heo * work function which can introduce dependency onto itself through a 1042c5aa87bbSTejun Heo * recycled work item. Well, if somebody wants to shoot oneself in the 1043c5aa87bbSTejun Heo * foot that badly, there's only so much we can do, and if such deadlock 1044c5aa87bbSTejun Heo * actually occurs, it should be easy to locate the culprit work function. 10458cca0eeaSTejun Heo * 10468cca0eeaSTejun Heo * CONTEXT: 1047a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 10488cca0eeaSTejun Heo * 1049d185af30SYacine Belkadi * Return: 1050d185af30SYacine Belkadi * Pointer to worker which is executing @work if found, %NULL 10518cca0eeaSTejun Heo * otherwise. 10528cca0eeaSTejun Heo */ 1053c9e7cf27STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool, 10548cca0eeaSTejun Heo struct work_struct *work) 10558cca0eeaSTejun Heo { 105642f8570fSSasha Levin struct worker *worker; 105742f8570fSSasha Levin 1058b67bfe0dSSasha Levin hash_for_each_possible(pool->busy_hash, worker, hentry, 1059a2c1c57bSTejun Heo (unsigned long)work) 1060a2c1c57bSTejun Heo if (worker->current_work == work && 1061a2c1c57bSTejun Heo worker->current_func == work->func) 106242f8570fSSasha Levin return worker; 106342f8570fSSasha Levin 106442f8570fSSasha Levin return NULL; 10658cca0eeaSTejun Heo } 10668cca0eeaSTejun Heo 10678cca0eeaSTejun Heo /** 1068bf4ede01STejun Heo * move_linked_works - move linked works to a list 1069bf4ede01STejun Heo * @work: start of series of works to be scheduled 1070bf4ede01STejun Heo * @head: target list to append @work to 1071402dd89dSShailendra Verma * @nextp: out parameter for nested worklist walking 1072bf4ede01STejun Heo * 1073bf4ede01STejun Heo * Schedule linked works starting from @work to @head. Work series to 1074bf4ede01STejun Heo * be scheduled starts at @work and includes any consecutive work with 1075bf4ede01STejun Heo * WORK_STRUCT_LINKED set in its predecessor. 1076bf4ede01STejun Heo * 1077bf4ede01STejun Heo * If @nextp is not NULL, it's updated to point to the next work of 1078bf4ede01STejun Heo * the last scheduled work. This allows move_linked_works() to be 1079bf4ede01STejun Heo * nested inside outer list_for_each_entry_safe(). 1080bf4ede01STejun Heo * 1081bf4ede01STejun Heo * CONTEXT: 1082a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 1083bf4ede01STejun Heo */ 1084bf4ede01STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head, 1085bf4ede01STejun Heo struct work_struct **nextp) 1086bf4ede01STejun Heo { 1087bf4ede01STejun Heo struct work_struct *n; 1088bf4ede01STejun Heo 1089bf4ede01STejun Heo /* 1090bf4ede01STejun Heo * Linked worklist will always end before the end of the list, 1091bf4ede01STejun Heo * use NULL for list head. 1092bf4ede01STejun Heo */ 1093bf4ede01STejun Heo list_for_each_entry_safe_from(work, n, NULL, entry) { 1094bf4ede01STejun Heo list_move_tail(&work->entry, head); 1095bf4ede01STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) 1096bf4ede01STejun Heo break; 1097bf4ede01STejun Heo } 1098bf4ede01STejun Heo 1099bf4ede01STejun Heo /* 1100bf4ede01STejun Heo * If we're already inside safe list traversal and have moved 1101bf4ede01STejun Heo * multiple works to the scheduled queue, the next position 1102bf4ede01STejun Heo * needs to be updated. 1103bf4ede01STejun Heo */ 1104bf4ede01STejun Heo if (nextp) 1105bf4ede01STejun Heo *nextp = n; 1106bf4ede01STejun Heo } 1107bf4ede01STejun Heo 11088864b4e5STejun Heo /** 11098864b4e5STejun Heo * get_pwq - get an extra reference on the specified pool_workqueue 11108864b4e5STejun Heo * @pwq: pool_workqueue to get 11118864b4e5STejun Heo * 11128864b4e5STejun Heo * Obtain an extra reference on @pwq. The caller should guarantee that 11138864b4e5STejun Heo * @pwq has positive refcnt and be holding the matching pool->lock. 11148864b4e5STejun Heo */ 11158864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq) 11168864b4e5STejun Heo { 11178864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 11188864b4e5STejun Heo WARN_ON_ONCE(pwq->refcnt <= 0); 11198864b4e5STejun Heo pwq->refcnt++; 11208864b4e5STejun Heo } 11218864b4e5STejun Heo 11228864b4e5STejun Heo /** 11238864b4e5STejun Heo * put_pwq - put a pool_workqueue reference 11248864b4e5STejun Heo * @pwq: pool_workqueue to put 11258864b4e5STejun Heo * 11268864b4e5STejun Heo * Drop a reference of @pwq. If its refcnt reaches zero, schedule its 11278864b4e5STejun Heo * destruction. The caller should be holding the matching pool->lock. 11288864b4e5STejun Heo */ 11298864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq) 11308864b4e5STejun Heo { 11318864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 11328864b4e5STejun Heo if (likely(--pwq->refcnt)) 11338864b4e5STejun Heo return; 11348864b4e5STejun Heo if (WARN_ON_ONCE(!(pwq->wq->flags & WQ_UNBOUND))) 11358864b4e5STejun Heo return; 11368864b4e5STejun Heo /* 11378864b4e5STejun Heo * @pwq can't be released under pool->lock, bounce to 11388864b4e5STejun Heo * pwq_unbound_release_workfn(). This never recurses on the same 11398864b4e5STejun Heo * pool->lock as this path is taken only for unbound workqueues and 11408864b4e5STejun Heo * the release work item is scheduled on a per-cpu workqueue. To 11418864b4e5STejun Heo * avoid lockdep warning, unbound pool->locks are given lockdep 11428864b4e5STejun Heo * subclass of 1 in get_unbound_pool(). 11438864b4e5STejun Heo */ 11448864b4e5STejun Heo schedule_work(&pwq->unbound_release_work); 11458864b4e5STejun Heo } 11468864b4e5STejun Heo 1147dce90d47STejun Heo /** 1148dce90d47STejun Heo * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock 1149dce90d47STejun Heo * @pwq: pool_workqueue to put (can be %NULL) 1150dce90d47STejun Heo * 1151dce90d47STejun Heo * put_pwq() with locking. This function also allows %NULL @pwq. 1152dce90d47STejun Heo */ 1153dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq) 1154dce90d47STejun Heo { 1155dce90d47STejun Heo if (pwq) { 1156dce90d47STejun Heo /* 115724acfb71SThomas Gleixner * As both pwqs and pools are RCU protected, the 1158dce90d47STejun Heo * following lock operations are safe. 1159dce90d47STejun Heo */ 1160a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 1161dce90d47STejun Heo put_pwq(pwq); 1162a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 1163dce90d47STejun Heo } 1164dce90d47STejun Heo } 1165dce90d47STejun Heo 1166f97a4a1aSLai Jiangshan static void pwq_activate_inactive_work(struct work_struct *work) 1167bf4ede01STejun Heo { 1168112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 1169bf4ede01STejun Heo 1170bf4ede01STejun Heo trace_workqueue_activate_work(work); 117182607adcSTejun Heo if (list_empty(&pwq->pool->worklist)) 117282607adcSTejun Heo pwq->pool->watchdog_ts = jiffies; 1173112202d9STejun Heo move_linked_works(work, &pwq->pool->worklist, NULL); 1174f97a4a1aSLai Jiangshan __clear_bit(WORK_STRUCT_INACTIVE_BIT, work_data_bits(work)); 1175112202d9STejun Heo pwq->nr_active++; 1176bf4ede01STejun Heo } 1177bf4ede01STejun Heo 1178f97a4a1aSLai Jiangshan static void pwq_activate_first_inactive(struct pool_workqueue *pwq) 11793aa62497SLai Jiangshan { 1180f97a4a1aSLai Jiangshan struct work_struct *work = list_first_entry(&pwq->inactive_works, 11813aa62497SLai Jiangshan struct work_struct, entry); 11823aa62497SLai Jiangshan 1183f97a4a1aSLai Jiangshan pwq_activate_inactive_work(work); 11843aa62497SLai Jiangshan } 11853aa62497SLai Jiangshan 1186bf4ede01STejun Heo /** 1187112202d9STejun Heo * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight 1188112202d9STejun Heo * @pwq: pwq of interest 1189c4560c2cSLai Jiangshan * @work_data: work_data of work which left the queue 1190bf4ede01STejun Heo * 1191bf4ede01STejun Heo * A work either has completed or is removed from pending queue, 1192112202d9STejun Heo * decrement nr_in_flight of its pwq and handle workqueue flushing. 1193bf4ede01STejun Heo * 1194bf4ede01STejun Heo * CONTEXT: 1195a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 1196bf4ede01STejun Heo */ 1197c4560c2cSLai Jiangshan static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data) 1198bf4ede01STejun Heo { 1199c4560c2cSLai Jiangshan int color = get_work_color(work_data); 1200c4560c2cSLai Jiangshan 1201018f3a13SLai Jiangshan if (!(work_data & WORK_STRUCT_INACTIVE)) { 1202112202d9STejun Heo pwq->nr_active--; 1203f97a4a1aSLai Jiangshan if (!list_empty(&pwq->inactive_works)) { 1204f97a4a1aSLai Jiangshan /* one down, submit an inactive one */ 1205112202d9STejun Heo if (pwq->nr_active < pwq->max_active) 1206f97a4a1aSLai Jiangshan pwq_activate_first_inactive(pwq); 1207bf4ede01STejun Heo } 1208018f3a13SLai Jiangshan } 1209018f3a13SLai Jiangshan 1210018f3a13SLai Jiangshan pwq->nr_in_flight[color]--; 1211bf4ede01STejun Heo 1212bf4ede01STejun Heo /* is flush in progress and are we at the flushing tip? */ 1213112202d9STejun Heo if (likely(pwq->flush_color != color)) 12148864b4e5STejun Heo goto out_put; 1215bf4ede01STejun Heo 1216bf4ede01STejun Heo /* are there still in-flight works? */ 1217112202d9STejun Heo if (pwq->nr_in_flight[color]) 12188864b4e5STejun Heo goto out_put; 1219bf4ede01STejun Heo 1220112202d9STejun Heo /* this pwq is done, clear flush_color */ 1221112202d9STejun Heo pwq->flush_color = -1; 1222bf4ede01STejun Heo 1223bf4ede01STejun Heo /* 1224112202d9STejun Heo * If this was the last pwq, wake up the first flusher. It 1225bf4ede01STejun Heo * will handle the rest. 1226bf4ede01STejun Heo */ 1227112202d9STejun Heo if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush)) 1228112202d9STejun Heo complete(&pwq->wq->first_flusher->done); 12298864b4e5STejun Heo out_put: 12308864b4e5STejun Heo put_pwq(pwq); 1231bf4ede01STejun Heo } 1232bf4ede01STejun Heo 123336e227d2STejun Heo /** 1234bbb68dfaSTejun Heo * try_to_grab_pending - steal work item from worklist and disable irq 123536e227d2STejun Heo * @work: work item to steal 123636e227d2STejun Heo * @is_dwork: @work is a delayed_work 1237bbb68dfaSTejun Heo * @flags: place to store irq state 123836e227d2STejun Heo * 123936e227d2STejun Heo * Try to grab PENDING bit of @work. This function can handle @work in any 1240d185af30SYacine Belkadi * stable state - idle, on timer or on worklist. 124136e227d2STejun Heo * 1242d185af30SYacine Belkadi * Return: 12433eb6b31bSMauro Carvalho Chehab * 12443eb6b31bSMauro Carvalho Chehab * ======== ================================================================ 124536e227d2STejun Heo * 1 if @work was pending and we successfully stole PENDING 124636e227d2STejun Heo * 0 if @work was idle and we claimed PENDING 124736e227d2STejun Heo * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry 1248bbb68dfaSTejun Heo * -ENOENT if someone else is canceling @work, this state may persist 1249bbb68dfaSTejun Heo * for arbitrarily long 12503eb6b31bSMauro Carvalho Chehab * ======== ================================================================ 125136e227d2STejun Heo * 1252d185af30SYacine Belkadi * Note: 1253bbb68dfaSTejun Heo * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting 1254e0aecdd8STejun Heo * interrupted while holding PENDING and @work off queue, irq must be 1255e0aecdd8STejun Heo * disabled on entry. This, combined with delayed_work->timer being 1256e0aecdd8STejun Heo * irqsafe, ensures that we return -EAGAIN for finite short period of time. 1257bbb68dfaSTejun Heo * 1258bbb68dfaSTejun Heo * On successful return, >= 0, irq is disabled and the caller is 1259bbb68dfaSTejun Heo * responsible for releasing it using local_irq_restore(*@flags). 1260bbb68dfaSTejun Heo * 1261e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 1262bf4ede01STejun Heo */ 1263bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork, 1264bbb68dfaSTejun Heo unsigned long *flags) 1265bf4ede01STejun Heo { 1266d565ed63STejun Heo struct worker_pool *pool; 1267112202d9STejun Heo struct pool_workqueue *pwq; 1268bf4ede01STejun Heo 1269bbb68dfaSTejun Heo local_irq_save(*flags); 1270bbb68dfaSTejun Heo 127136e227d2STejun Heo /* try to steal the timer if it exists */ 127236e227d2STejun Heo if (is_dwork) { 127336e227d2STejun Heo struct delayed_work *dwork = to_delayed_work(work); 127436e227d2STejun Heo 1275e0aecdd8STejun Heo /* 1276e0aecdd8STejun Heo * dwork->timer is irqsafe. If del_timer() fails, it's 1277e0aecdd8STejun Heo * guaranteed that the timer is not queued anywhere and not 1278e0aecdd8STejun Heo * running on the local CPU. 1279e0aecdd8STejun Heo */ 128036e227d2STejun Heo if (likely(del_timer(&dwork->timer))) 128136e227d2STejun Heo return 1; 128236e227d2STejun Heo } 128336e227d2STejun Heo 128436e227d2STejun Heo /* try to claim PENDING the normal way */ 1285bf4ede01STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) 1286bf4ede01STejun Heo return 0; 1287bf4ede01STejun Heo 128824acfb71SThomas Gleixner rcu_read_lock(); 1289bf4ede01STejun Heo /* 1290bf4ede01STejun Heo * The queueing is in progress, or it is already queued. Try to 1291bf4ede01STejun Heo * steal it from ->worklist without clearing WORK_STRUCT_PENDING. 1292bf4ede01STejun Heo */ 1293d565ed63STejun Heo pool = get_work_pool(work); 1294d565ed63STejun Heo if (!pool) 1295bbb68dfaSTejun Heo goto fail; 1296bf4ede01STejun Heo 1297a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&pool->lock); 1298bf4ede01STejun Heo /* 1299112202d9STejun Heo * work->data is guaranteed to point to pwq only while the work 1300112202d9STejun Heo * item is queued on pwq->wq, and both updating work->data to point 1301112202d9STejun Heo * to pwq on queueing and to pool on dequeueing are done under 1302112202d9STejun Heo * pwq->pool->lock. This in turn guarantees that, if work->data 1303112202d9STejun Heo * points to pwq which is associated with a locked pool, the work 13040b3dae68SLai Jiangshan * item is currently queued on that pool. 1305bf4ede01STejun Heo */ 1306112202d9STejun Heo pwq = get_work_pwq(work); 1307112202d9STejun Heo if (pwq && pwq->pool == pool) { 1308bf4ede01STejun Heo debug_work_deactivate(work); 13093aa62497SLai Jiangshan 13103aa62497SLai Jiangshan /* 1311018f3a13SLai Jiangshan * A cancelable inactive work item must be in the 1312018f3a13SLai Jiangshan * pwq->inactive_works since a queued barrier can't be 1313018f3a13SLai Jiangshan * canceled (see the comments in insert_wq_barrier()). 1314018f3a13SLai Jiangshan * 1315f97a4a1aSLai Jiangshan * An inactive work item cannot be grabbed directly because 1316d812796eSLai Jiangshan * it might have linked barrier work items which, if left 1317f97a4a1aSLai Jiangshan * on the inactive_works list, will confuse pwq->nr_active 131816062836STejun Heo * management later on and cause stall. Make sure the work 131916062836STejun Heo * item is activated before grabbing. 13203aa62497SLai Jiangshan */ 1321f97a4a1aSLai Jiangshan if (*work_data_bits(work) & WORK_STRUCT_INACTIVE) 1322f97a4a1aSLai Jiangshan pwq_activate_inactive_work(work); 13233aa62497SLai Jiangshan 1324bf4ede01STejun Heo list_del_init(&work->entry); 1325c4560c2cSLai Jiangshan pwq_dec_nr_in_flight(pwq, *work_data_bits(work)); 132636e227d2STejun Heo 1327112202d9STejun Heo /* work->data points to pwq iff queued, point to pool */ 13284468a00fSLai Jiangshan set_work_pool_and_keep_pending(work, pool->id); 13294468a00fSLai Jiangshan 1330a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&pool->lock); 133124acfb71SThomas Gleixner rcu_read_unlock(); 133236e227d2STejun Heo return 1; 1333bf4ede01STejun Heo } 1334a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&pool->lock); 1335bbb68dfaSTejun Heo fail: 133624acfb71SThomas Gleixner rcu_read_unlock(); 1337bbb68dfaSTejun Heo local_irq_restore(*flags); 1338bbb68dfaSTejun Heo if (work_is_canceling(work)) 1339bbb68dfaSTejun Heo return -ENOENT; 1340bbb68dfaSTejun Heo cpu_relax(); 134136e227d2STejun Heo return -EAGAIN; 1342bf4ede01STejun Heo } 1343bf4ede01STejun Heo 1344bf4ede01STejun Heo /** 1345706026c2STejun Heo * insert_work - insert a work into a pool 1346112202d9STejun Heo * @pwq: pwq @work belongs to 13474690c4abSTejun Heo * @work: work to insert 13484690c4abSTejun Heo * @head: insertion point 13494690c4abSTejun Heo * @extra_flags: extra WORK_STRUCT_* flags to set 13504690c4abSTejun Heo * 1351112202d9STejun Heo * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to 1352706026c2STejun Heo * work_struct flags. 13534690c4abSTejun Heo * 13544690c4abSTejun Heo * CONTEXT: 1355a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 1356365970a1SDavid Howells */ 1357112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work, 1358112202d9STejun Heo struct list_head *head, unsigned int extra_flags) 1359b89deed3SOleg Nesterov { 1360112202d9STejun Heo struct worker_pool *pool = pwq->pool; 1361e1d8aa9fSFrederic Weisbecker 1362e89a85d6SWalter Wu /* record the work call stack in order to print it in KASAN reports */ 1363f70da745SMarco Elver kasan_record_aux_stack_noalloc(work); 1364e89a85d6SWalter Wu 13654690c4abSTejun Heo /* we own @work, set data and link */ 1366112202d9STejun Heo set_work_pwq(work, pwq, extra_flags); 13671a4d9b0aSOleg Nesterov list_add_tail(&work->entry, head); 13688864b4e5STejun Heo get_pwq(pwq); 1369e22bee78STejun Heo 1370e22bee78STejun Heo /* 1371c5aa87bbSTejun Heo * Ensure either wq_worker_sleeping() sees the above 1372c5aa87bbSTejun Heo * list_add_tail() or we see zero nr_running to avoid workers lying 1373c5aa87bbSTejun Heo * around lazily while there are works to be processed. 1374e22bee78STejun Heo */ 1375e22bee78STejun Heo smp_mb(); 1376e22bee78STejun Heo 137763d95a91STejun Heo if (__need_more_worker(pool)) 137863d95a91STejun Heo wake_up_worker(pool); 1379b89deed3SOleg Nesterov } 1380b89deed3SOleg Nesterov 1381c8efcc25STejun Heo /* 1382c8efcc25STejun Heo * Test whether @work is being queued from another work executing on the 13838d03ecfeSTejun Heo * same workqueue. 1384c8efcc25STejun Heo */ 1385c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq) 1386c8efcc25STejun Heo { 1387c8efcc25STejun Heo struct worker *worker; 1388c8efcc25STejun Heo 13898d03ecfeSTejun Heo worker = current_wq_worker(); 1390c8efcc25STejun Heo /* 1391bf393fd4SBart Van Assche * Return %true iff I'm a worker executing a work item on @wq. If 13928d03ecfeSTejun Heo * I'm @worker, it's safe to dereference it without locking. 1393c8efcc25STejun Heo */ 1394112202d9STejun Heo return worker && worker->current_pwq->wq == wq; 1395c8efcc25STejun Heo } 1396c8efcc25STejun Heo 1397ef557180SMike Galbraith /* 1398ef557180SMike Galbraith * When queueing an unbound work item to a wq, prefer local CPU if allowed 1399ef557180SMike Galbraith * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to 1400ef557180SMike Galbraith * avoid perturbing sensitive tasks. 1401ef557180SMike Galbraith */ 1402ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu) 1403ef557180SMike Galbraith { 1404f303fccbSTejun Heo static bool printed_dbg_warning; 1405ef557180SMike Galbraith int new_cpu; 1406ef557180SMike Galbraith 1407f303fccbSTejun Heo if (likely(!wq_debug_force_rr_cpu)) { 1408ef557180SMike Galbraith if (cpumask_test_cpu(cpu, wq_unbound_cpumask)) 1409ef557180SMike Galbraith return cpu; 1410f303fccbSTejun Heo } else if (!printed_dbg_warning) { 1411f303fccbSTejun Heo pr_warn("workqueue: round-robin CPU selection forced, expect performance impact\n"); 1412f303fccbSTejun Heo printed_dbg_warning = true; 1413f303fccbSTejun Heo } 1414f303fccbSTejun Heo 1415ef557180SMike Galbraith if (cpumask_empty(wq_unbound_cpumask)) 1416ef557180SMike Galbraith return cpu; 1417ef557180SMike Galbraith 1418ef557180SMike Galbraith new_cpu = __this_cpu_read(wq_rr_cpu_last); 1419ef557180SMike Galbraith new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask); 1420ef557180SMike Galbraith if (unlikely(new_cpu >= nr_cpu_ids)) { 1421ef557180SMike Galbraith new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask); 1422ef557180SMike Galbraith if (unlikely(new_cpu >= nr_cpu_ids)) 1423ef557180SMike Galbraith return cpu; 1424ef557180SMike Galbraith } 1425ef557180SMike Galbraith __this_cpu_write(wq_rr_cpu_last, new_cpu); 1426ef557180SMike Galbraith 1427ef557180SMike Galbraith return new_cpu; 1428ef557180SMike Galbraith } 1429ef557180SMike Galbraith 1430d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq, 14311da177e4SLinus Torvalds struct work_struct *work) 14321da177e4SLinus Torvalds { 1433112202d9STejun Heo struct pool_workqueue *pwq; 1434c9178087STejun Heo struct worker_pool *last_pool; 14351e19ffc6STejun Heo struct list_head *worklist; 14368a2e8e5dSTejun Heo unsigned int work_flags; 1437b75cac93SJoonsoo Kim unsigned int req_cpu = cpu; 14388930cabaSTejun Heo 14398930cabaSTejun Heo /* 14408930cabaSTejun Heo * While a work item is PENDING && off queue, a task trying to 14418930cabaSTejun Heo * steal the PENDING will busy-loop waiting for it to either get 14428930cabaSTejun Heo * queued or lose PENDING. Grabbing PENDING and queueing should 14438930cabaSTejun Heo * happen with IRQ disabled. 14448930cabaSTejun Heo */ 14458e8eb730SFrederic Weisbecker lockdep_assert_irqs_disabled(); 14461da177e4SLinus Torvalds 14471e19ffc6STejun Heo 14489ef28a73SLi Bin /* if draining, only works from the same workqueue are allowed */ 1449618b01ebSTejun Heo if (unlikely(wq->flags & __WQ_DRAINING) && 1450c8efcc25STejun Heo WARN_ON_ONCE(!is_chained_work(wq))) 1451e41e704bSTejun Heo return; 145224acfb71SThomas Gleixner rcu_read_lock(); 14539e8cd2f5STejun Heo retry: 1454aa202f1fSHillf Danton /* pwq which will be used unless @work is executing elsewhere */ 1455aa202f1fSHillf Danton if (wq->flags & WQ_UNBOUND) { 1456df2d5ae4STejun Heo if (req_cpu == WORK_CPU_UNBOUND) 1457ef557180SMike Galbraith cpu = wq_select_unbound_cpu(raw_smp_processor_id()); 1458df2d5ae4STejun Heo pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu)); 1459aa202f1fSHillf Danton } else { 1460aa202f1fSHillf Danton if (req_cpu == WORK_CPU_UNBOUND) 1461aa202f1fSHillf Danton cpu = raw_smp_processor_id(); 1462aa202f1fSHillf Danton pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); 1463aa202f1fSHillf Danton } 1464f3421797STejun Heo 146518aa9effSTejun Heo /* 1466c9178087STejun Heo * If @work was previously on a different pool, it might still be 1467c9178087STejun Heo * running there, in which case the work needs to be queued on that 1468c9178087STejun Heo * pool to guarantee non-reentrancy. 146918aa9effSTejun Heo */ 1470c9e7cf27STejun Heo last_pool = get_work_pool(work); 1471112202d9STejun Heo if (last_pool && last_pool != pwq->pool) { 147218aa9effSTejun Heo struct worker *worker; 147318aa9effSTejun Heo 1474a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&last_pool->lock); 147518aa9effSTejun Heo 1476c9e7cf27STejun Heo worker = find_worker_executing_work(last_pool, work); 147718aa9effSTejun Heo 1478112202d9STejun Heo if (worker && worker->current_pwq->wq == wq) { 1479c9178087STejun Heo pwq = worker->current_pwq; 14808594fadeSLai Jiangshan } else { 148118aa9effSTejun Heo /* meh... not running there, queue here */ 1482a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&last_pool->lock); 1483a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&pwq->pool->lock); 148418aa9effSTejun Heo } 14858930cabaSTejun Heo } else { 1486a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&pwq->pool->lock); 14878930cabaSTejun Heo } 1488502ca9d8STejun Heo 14899e8cd2f5STejun Heo /* 14909e8cd2f5STejun Heo * pwq is determined and locked. For unbound pools, we could have 14919e8cd2f5STejun Heo * raced with pwq release and it could already be dead. If its 14929e8cd2f5STejun Heo * refcnt is zero, repeat pwq selection. Note that pwqs never die 1493df2d5ae4STejun Heo * without another pwq replacing it in the numa_pwq_tbl or while 1494df2d5ae4STejun Heo * work items are executing on it, so the retrying is guaranteed to 14959e8cd2f5STejun Heo * make forward-progress. 14969e8cd2f5STejun Heo */ 14979e8cd2f5STejun Heo if (unlikely(!pwq->refcnt)) { 14989e8cd2f5STejun Heo if (wq->flags & WQ_UNBOUND) { 1499a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&pwq->pool->lock); 15009e8cd2f5STejun Heo cpu_relax(); 15019e8cd2f5STejun Heo goto retry; 15029e8cd2f5STejun Heo } 15039e8cd2f5STejun Heo /* oops */ 15049e8cd2f5STejun Heo WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt", 15059e8cd2f5STejun Heo wq->name, cpu); 15069e8cd2f5STejun Heo } 15079e8cd2f5STejun Heo 1508112202d9STejun Heo /* pwq determined, queue */ 1509112202d9STejun Heo trace_workqueue_queue_work(req_cpu, pwq, work); 1510502ca9d8STejun Heo 151124acfb71SThomas Gleixner if (WARN_ON(!list_empty(&work->entry))) 151224acfb71SThomas Gleixner goto out; 15131e19ffc6STejun Heo 1514112202d9STejun Heo pwq->nr_in_flight[pwq->work_color]++; 1515112202d9STejun Heo work_flags = work_color_to_flags(pwq->work_color); 15161e19ffc6STejun Heo 1517112202d9STejun Heo if (likely(pwq->nr_active < pwq->max_active)) { 1518cdadf009STejun Heo trace_workqueue_activate_work(work); 1519112202d9STejun Heo pwq->nr_active++; 1520112202d9STejun Heo worklist = &pwq->pool->worklist; 152182607adcSTejun Heo if (list_empty(worklist)) 152282607adcSTejun Heo pwq->pool->watchdog_ts = jiffies; 15238a2e8e5dSTejun Heo } else { 1524f97a4a1aSLai Jiangshan work_flags |= WORK_STRUCT_INACTIVE; 1525f97a4a1aSLai Jiangshan worklist = &pwq->inactive_works; 15268a2e8e5dSTejun Heo } 15271e19ffc6STejun Heo 15280687c66bSZqiang debug_work_activate(work); 1529112202d9STejun Heo insert_work(pwq, work, worklist, work_flags); 15301e19ffc6STejun Heo 153124acfb71SThomas Gleixner out: 1532a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&pwq->pool->lock); 153324acfb71SThomas Gleixner rcu_read_unlock(); 15341da177e4SLinus Torvalds } 15351da177e4SLinus Torvalds 15360fcb78c2SRolf Eike Beer /** 1537c1a220e7SZhang Rui * queue_work_on - queue work on specific cpu 1538c1a220e7SZhang Rui * @cpu: CPU number to execute work on 1539c1a220e7SZhang Rui * @wq: workqueue to use 1540c1a220e7SZhang Rui * @work: work to queue 1541c1a220e7SZhang Rui * 1542c1a220e7SZhang Rui * We queue the work to a specific CPU, the caller must ensure it 1543443378f0SPaul E. McKenney * can't go away. Callers that fail to ensure that the specified 1544443378f0SPaul E. McKenney * CPU cannot go away will execute on a randomly chosen CPU. 1545d185af30SYacine Belkadi * 1546d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. 1547c1a220e7SZhang Rui */ 1548d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq, 1549d4283e93STejun Heo struct work_struct *work) 1550c1a220e7SZhang Rui { 1551d4283e93STejun Heo bool ret = false; 15528930cabaSTejun Heo unsigned long flags; 15538930cabaSTejun Heo 15548930cabaSTejun Heo local_irq_save(flags); 1555c1a220e7SZhang Rui 155622df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 15574690c4abSTejun Heo __queue_work(cpu, wq, work); 1558d4283e93STejun Heo ret = true; 1559c1a220e7SZhang Rui } 15608930cabaSTejun Heo 15618930cabaSTejun Heo local_irq_restore(flags); 1562c1a220e7SZhang Rui return ret; 1563c1a220e7SZhang Rui } 1564ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on); 1565c1a220e7SZhang Rui 15668204e0c1SAlexander Duyck /** 15678204e0c1SAlexander Duyck * workqueue_select_cpu_near - Select a CPU based on NUMA node 15688204e0c1SAlexander Duyck * @node: NUMA node ID that we want to select a CPU from 15698204e0c1SAlexander Duyck * 15708204e0c1SAlexander Duyck * This function will attempt to find a "random" cpu available on a given 15718204e0c1SAlexander Duyck * node. If there are no CPUs available on the given node it will return 15728204e0c1SAlexander Duyck * WORK_CPU_UNBOUND indicating that we should just schedule to any 15738204e0c1SAlexander Duyck * available CPU if we need to schedule this work. 15748204e0c1SAlexander Duyck */ 15758204e0c1SAlexander Duyck static int workqueue_select_cpu_near(int node) 15768204e0c1SAlexander Duyck { 15778204e0c1SAlexander Duyck int cpu; 15788204e0c1SAlexander Duyck 15798204e0c1SAlexander Duyck /* No point in doing this if NUMA isn't enabled for workqueues */ 15808204e0c1SAlexander Duyck if (!wq_numa_enabled) 15818204e0c1SAlexander Duyck return WORK_CPU_UNBOUND; 15828204e0c1SAlexander Duyck 15838204e0c1SAlexander Duyck /* Delay binding to CPU if node is not valid or online */ 15848204e0c1SAlexander Duyck if (node < 0 || node >= MAX_NUMNODES || !node_online(node)) 15858204e0c1SAlexander Duyck return WORK_CPU_UNBOUND; 15868204e0c1SAlexander Duyck 15878204e0c1SAlexander Duyck /* Use local node/cpu if we are already there */ 15888204e0c1SAlexander Duyck cpu = raw_smp_processor_id(); 15898204e0c1SAlexander Duyck if (node == cpu_to_node(cpu)) 15908204e0c1SAlexander Duyck return cpu; 15918204e0c1SAlexander Duyck 15928204e0c1SAlexander Duyck /* Use "random" otherwise know as "first" online CPU of node */ 15938204e0c1SAlexander Duyck cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask); 15948204e0c1SAlexander Duyck 15958204e0c1SAlexander Duyck /* If CPU is valid return that, otherwise just defer */ 15968204e0c1SAlexander Duyck return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND; 15978204e0c1SAlexander Duyck } 15988204e0c1SAlexander Duyck 15998204e0c1SAlexander Duyck /** 16008204e0c1SAlexander Duyck * queue_work_node - queue work on a "random" cpu for a given NUMA node 16018204e0c1SAlexander Duyck * @node: NUMA node that we are targeting the work for 16028204e0c1SAlexander Duyck * @wq: workqueue to use 16038204e0c1SAlexander Duyck * @work: work to queue 16048204e0c1SAlexander Duyck * 16058204e0c1SAlexander Duyck * We queue the work to a "random" CPU within a given NUMA node. The basic 16068204e0c1SAlexander Duyck * idea here is to provide a way to somehow associate work with a given 16078204e0c1SAlexander Duyck * NUMA node. 16088204e0c1SAlexander Duyck * 16098204e0c1SAlexander Duyck * This function will only make a best effort attempt at getting this onto 16108204e0c1SAlexander Duyck * the right NUMA node. If no node is requested or the requested node is 16118204e0c1SAlexander Duyck * offline then we just fall back to standard queue_work behavior. 16128204e0c1SAlexander Duyck * 16138204e0c1SAlexander Duyck * Currently the "random" CPU ends up being the first available CPU in the 16148204e0c1SAlexander Duyck * intersection of cpu_online_mask and the cpumask of the node, unless we 16158204e0c1SAlexander Duyck * are running on the node. In that case we just use the current CPU. 16168204e0c1SAlexander Duyck * 16178204e0c1SAlexander Duyck * Return: %false if @work was already on a queue, %true otherwise. 16188204e0c1SAlexander Duyck */ 16198204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq, 16208204e0c1SAlexander Duyck struct work_struct *work) 16218204e0c1SAlexander Duyck { 16228204e0c1SAlexander Duyck unsigned long flags; 16238204e0c1SAlexander Duyck bool ret = false; 16248204e0c1SAlexander Duyck 16258204e0c1SAlexander Duyck /* 16268204e0c1SAlexander Duyck * This current implementation is specific to unbound workqueues. 16278204e0c1SAlexander Duyck * Specifically we only return the first available CPU for a given 16288204e0c1SAlexander Duyck * node instead of cycling through individual CPUs within the node. 16298204e0c1SAlexander Duyck * 16308204e0c1SAlexander Duyck * If this is used with a per-cpu workqueue then the logic in 16318204e0c1SAlexander Duyck * workqueue_select_cpu_near would need to be updated to allow for 16328204e0c1SAlexander Duyck * some round robin type logic. 16338204e0c1SAlexander Duyck */ 16348204e0c1SAlexander Duyck WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)); 16358204e0c1SAlexander Duyck 16368204e0c1SAlexander Duyck local_irq_save(flags); 16378204e0c1SAlexander Duyck 16388204e0c1SAlexander Duyck if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 16398204e0c1SAlexander Duyck int cpu = workqueue_select_cpu_near(node); 16408204e0c1SAlexander Duyck 16418204e0c1SAlexander Duyck __queue_work(cpu, wq, work); 16428204e0c1SAlexander Duyck ret = true; 16438204e0c1SAlexander Duyck } 16448204e0c1SAlexander Duyck 16458204e0c1SAlexander Duyck local_irq_restore(flags); 16468204e0c1SAlexander Duyck return ret; 16478204e0c1SAlexander Duyck } 16488204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node); 16498204e0c1SAlexander Duyck 16508c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t) 16511da177e4SLinus Torvalds { 16528c20feb6SKees Cook struct delayed_work *dwork = from_timer(dwork, t, timer); 16531da177e4SLinus Torvalds 1654e0aecdd8STejun Heo /* should have been called from irqsafe timer with irq already off */ 165560c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 16561da177e4SLinus Torvalds } 16571438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn); 16581da177e4SLinus Torvalds 16597beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq, 166052bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 16611da177e4SLinus Torvalds { 16627beb2edfSTejun Heo struct timer_list *timer = &dwork->timer; 16637beb2edfSTejun Heo struct work_struct *work = &dwork->work; 16641da177e4SLinus Torvalds 1665637fdbaeSTejun Heo WARN_ON_ONCE(!wq); 166698173112SSami Tolvanen WARN_ON_FUNCTION_MISMATCH(timer->function, delayed_work_timer_fn); 1667fc4b514fSTejun Heo WARN_ON_ONCE(timer_pending(timer)); 1668fc4b514fSTejun Heo WARN_ON_ONCE(!list_empty(&work->entry)); 16697beb2edfSTejun Heo 16708852aac2STejun Heo /* 16718852aac2STejun Heo * If @delay is 0, queue @dwork->work immediately. This is for 16728852aac2STejun Heo * both optimization and correctness. The earliest @timer can 16738852aac2STejun Heo * expire is on the closest next tick and delayed_work users depend 16748852aac2STejun Heo * on that there's no such delay when @delay is 0. 16758852aac2STejun Heo */ 16768852aac2STejun Heo if (!delay) { 16778852aac2STejun Heo __queue_work(cpu, wq, &dwork->work); 16788852aac2STejun Heo return; 16798852aac2STejun Heo } 16808852aac2STejun Heo 168160c057bcSLai Jiangshan dwork->wq = wq; 16821265057fSTejun Heo dwork->cpu = cpu; 16837beb2edfSTejun Heo timer->expires = jiffies + delay; 16847beb2edfSTejun Heo 1685041bd12eSTejun Heo if (unlikely(cpu != WORK_CPU_UNBOUND)) 16867beb2edfSTejun Heo add_timer_on(timer, cpu); 1687041bd12eSTejun Heo else 1688041bd12eSTejun Heo add_timer(timer); 16897beb2edfSTejun Heo } 16901da177e4SLinus Torvalds 16910fcb78c2SRolf Eike Beer /** 16920fcb78c2SRolf Eike Beer * queue_delayed_work_on - queue work on specific CPU after delay 16930fcb78c2SRolf Eike Beer * @cpu: CPU number to execute work on 16940fcb78c2SRolf Eike Beer * @wq: workqueue to use 1695af9997e4SRandy Dunlap * @dwork: work to queue 16960fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 16970fcb78c2SRolf Eike Beer * 1698d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. If 1699715f1300STejun Heo * @delay is zero and @dwork is idle, it will be scheduled for immediate 1700715f1300STejun Heo * execution. 17010fcb78c2SRolf Eike Beer */ 1702d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 170352bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 17047a6bc1cdSVenkatesh Pallipadi { 170552bad64dSDavid Howells struct work_struct *work = &dwork->work; 1706d4283e93STejun Heo bool ret = false; 17078930cabaSTejun Heo unsigned long flags; 17088930cabaSTejun Heo 17098930cabaSTejun Heo /* read the comment in __queue_work() */ 17108930cabaSTejun Heo local_irq_save(flags); 17117a6bc1cdSVenkatesh Pallipadi 171222df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 17137beb2edfSTejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 1714d4283e93STejun Heo ret = true; 17157a6bc1cdSVenkatesh Pallipadi } 17168930cabaSTejun Heo 17178930cabaSTejun Heo local_irq_restore(flags); 17187a6bc1cdSVenkatesh Pallipadi return ret; 17197a6bc1cdSVenkatesh Pallipadi } 1720ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on); 17211da177e4SLinus Torvalds 1722c8e55f36STejun Heo /** 17238376fe22STejun Heo * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU 17248376fe22STejun Heo * @cpu: CPU number to execute work on 17258376fe22STejun Heo * @wq: workqueue to use 17268376fe22STejun Heo * @dwork: work to queue 17278376fe22STejun Heo * @delay: number of jiffies to wait before queueing 17288376fe22STejun Heo * 17298376fe22STejun Heo * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise, 17308376fe22STejun Heo * modify @dwork's timer so that it expires after @delay. If @delay is 17318376fe22STejun Heo * zero, @work is guaranteed to be scheduled immediately regardless of its 17328376fe22STejun Heo * current state. 17338376fe22STejun Heo * 1734d185af30SYacine Belkadi * Return: %false if @dwork was idle and queued, %true if @dwork was 17358376fe22STejun Heo * pending and its timer was modified. 17368376fe22STejun Heo * 1737e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 17388376fe22STejun Heo * See try_to_grab_pending() for details. 17398376fe22STejun Heo */ 17408376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, 17418376fe22STejun Heo struct delayed_work *dwork, unsigned long delay) 17428376fe22STejun Heo { 17438376fe22STejun Heo unsigned long flags; 17448376fe22STejun Heo int ret; 17458376fe22STejun Heo 17468376fe22STejun Heo do { 17478376fe22STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 17488376fe22STejun Heo } while (unlikely(ret == -EAGAIN)); 17498376fe22STejun Heo 17508376fe22STejun Heo if (likely(ret >= 0)) { 17518376fe22STejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 17528376fe22STejun Heo local_irq_restore(flags); 17538376fe22STejun Heo } 17548376fe22STejun Heo 17558376fe22STejun Heo /* -ENOENT from try_to_grab_pending() becomes %true */ 17568376fe22STejun Heo return ret; 17578376fe22STejun Heo } 17588376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on); 17598376fe22STejun Heo 176005f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu) 176105f0fe6bSTejun Heo { 176205f0fe6bSTejun Heo struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu); 176305f0fe6bSTejun Heo 176405f0fe6bSTejun Heo /* read the comment in __queue_work() */ 176505f0fe6bSTejun Heo local_irq_disable(); 176605f0fe6bSTejun Heo __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work); 176705f0fe6bSTejun Heo local_irq_enable(); 176805f0fe6bSTejun Heo } 176905f0fe6bSTejun Heo 177005f0fe6bSTejun Heo /** 177105f0fe6bSTejun Heo * queue_rcu_work - queue work after a RCU grace period 177205f0fe6bSTejun Heo * @wq: workqueue to use 177305f0fe6bSTejun Heo * @rwork: work to queue 177405f0fe6bSTejun Heo * 177505f0fe6bSTejun Heo * Return: %false if @rwork was already pending, %true otherwise. Note 177605f0fe6bSTejun Heo * that a full RCU grace period is guaranteed only after a %true return. 1777bf393fd4SBart Van Assche * While @rwork is guaranteed to be executed after a %false return, the 177805f0fe6bSTejun Heo * execution may happen before a full RCU grace period has passed. 177905f0fe6bSTejun Heo */ 178005f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork) 178105f0fe6bSTejun Heo { 178205f0fe6bSTejun Heo struct work_struct *work = &rwork->work; 178305f0fe6bSTejun Heo 178405f0fe6bSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 178505f0fe6bSTejun Heo rwork->wq = wq; 178605f0fe6bSTejun Heo call_rcu(&rwork->rcu, rcu_work_rcufn); 178705f0fe6bSTejun Heo return true; 178805f0fe6bSTejun Heo } 178905f0fe6bSTejun Heo 179005f0fe6bSTejun Heo return false; 179105f0fe6bSTejun Heo } 179205f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work); 179305f0fe6bSTejun Heo 17948376fe22STejun Heo /** 1795c8e55f36STejun Heo * worker_enter_idle - enter idle state 1796c8e55f36STejun Heo * @worker: worker which is entering idle state 1797c8e55f36STejun Heo * 1798c8e55f36STejun Heo * @worker is entering idle state. Update stats and idle timer if 1799c8e55f36STejun Heo * necessary. 1800c8e55f36STejun Heo * 1801c8e55f36STejun Heo * LOCKING: 1802a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 1803c8e55f36STejun Heo */ 1804c8e55f36STejun Heo static void worker_enter_idle(struct worker *worker) 18051da177e4SLinus Torvalds { 1806bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1807c8e55f36STejun Heo 18086183c009STejun Heo if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) || 18096183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->entry) && 18106183c009STejun Heo (worker->hentry.next || worker->hentry.pprev))) 18116183c009STejun Heo return; 1812c8e55f36STejun Heo 1813051e1850SLai Jiangshan /* can't use worker_set_flags(), also called from create_worker() */ 1814cb444766STejun Heo worker->flags |= WORKER_IDLE; 1815bd7bdd43STejun Heo pool->nr_idle++; 1816e22bee78STejun Heo worker->last_active = jiffies; 1817c8e55f36STejun Heo 1818c8e55f36STejun Heo /* idle_list is LIFO */ 1819bd7bdd43STejun Heo list_add(&worker->entry, &pool->idle_list); 1820db7bccf4STejun Heo 182163d95a91STejun Heo if (too_many_workers(pool) && !timer_pending(&pool->idle_timer)) 1822628c78e7STejun Heo mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT); 1823cb444766STejun Heo 1824544ecf31STejun Heo /* 1825e8b3f8dbSLai Jiangshan * Sanity check nr_running. Because unbind_workers() releases 1826d565ed63STejun Heo * pool->lock between setting %WORKER_UNBOUND and zapping 1827628c78e7STejun Heo * nr_running, the warning may trigger spuriously. Check iff 1828628c78e7STejun Heo * unbind is not in progress. 1829544ecf31STejun Heo */ 183024647570STejun Heo WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 1831bd7bdd43STejun Heo pool->nr_workers == pool->nr_idle && 1832e19e397aSTejun Heo atomic_read(&pool->nr_running)); 1833c8e55f36STejun Heo } 1834c8e55f36STejun Heo 1835c8e55f36STejun Heo /** 1836c8e55f36STejun Heo * worker_leave_idle - leave idle state 1837c8e55f36STejun Heo * @worker: worker which is leaving idle state 1838c8e55f36STejun Heo * 1839c8e55f36STejun Heo * @worker is leaving idle state. Update stats. 1840c8e55f36STejun Heo * 1841c8e55f36STejun Heo * LOCKING: 1842a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 1843c8e55f36STejun Heo */ 1844c8e55f36STejun Heo static void worker_leave_idle(struct worker *worker) 1845c8e55f36STejun Heo { 1846bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 1847c8e55f36STejun Heo 18486183c009STejun Heo if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE))) 18496183c009STejun Heo return; 1850d302f017STejun Heo worker_clr_flags(worker, WORKER_IDLE); 1851bd7bdd43STejun Heo pool->nr_idle--; 1852c8e55f36STejun Heo list_del_init(&worker->entry); 1853c8e55f36STejun Heo } 1854c8e55f36STejun Heo 1855f7537df5SLai Jiangshan static struct worker *alloc_worker(int node) 1856c34056a3STejun Heo { 1857c34056a3STejun Heo struct worker *worker; 1858c34056a3STejun Heo 1859f7537df5SLai Jiangshan worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node); 1860c8e55f36STejun Heo if (worker) { 1861c8e55f36STejun Heo INIT_LIST_HEAD(&worker->entry); 1862affee4b2STejun Heo INIT_LIST_HEAD(&worker->scheduled); 1863da028469SLai Jiangshan INIT_LIST_HEAD(&worker->node); 1864e22bee78STejun Heo /* on creation a worker is in !idle && prep state */ 1865e22bee78STejun Heo worker->flags = WORKER_PREP; 1866c8e55f36STejun Heo } 1867c34056a3STejun Heo return worker; 1868c34056a3STejun Heo } 1869c34056a3STejun Heo 1870c34056a3STejun Heo /** 18714736cbf7SLai Jiangshan * worker_attach_to_pool() - attach a worker to a pool 18724736cbf7SLai Jiangshan * @worker: worker to be attached 18734736cbf7SLai Jiangshan * @pool: the target pool 18744736cbf7SLai Jiangshan * 18754736cbf7SLai Jiangshan * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and 18764736cbf7SLai Jiangshan * cpu-binding of @worker are kept coordinated with the pool across 18774736cbf7SLai Jiangshan * cpu-[un]hotplugs. 18784736cbf7SLai Jiangshan */ 18794736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker, 18804736cbf7SLai Jiangshan struct worker_pool *pool) 18814736cbf7SLai Jiangshan { 18821258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 18834736cbf7SLai Jiangshan 18844736cbf7SLai Jiangshan /* 18851258fae7STejun Heo * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains 18861258fae7STejun Heo * stable across this function. See the comments above the flag 18871258fae7STejun Heo * definition for details. 18884736cbf7SLai Jiangshan */ 18894736cbf7SLai Jiangshan if (pool->flags & POOL_DISASSOCIATED) 18904736cbf7SLai Jiangshan worker->flags |= WORKER_UNBOUND; 18915c25b5ffSPeter Zijlstra else 18925c25b5ffSPeter Zijlstra kthread_set_per_cpu(worker->task, pool->cpu); 18934736cbf7SLai Jiangshan 1894640f17c8SPeter Zijlstra if (worker->rescue_wq) 1895640f17c8SPeter Zijlstra set_cpus_allowed_ptr(worker->task, pool->attrs->cpumask); 1896640f17c8SPeter Zijlstra 18974736cbf7SLai Jiangshan list_add_tail(&worker->node, &pool->workers); 1898a2d812a2STejun Heo worker->pool = pool; 18994736cbf7SLai Jiangshan 19001258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 19014736cbf7SLai Jiangshan } 19024736cbf7SLai Jiangshan 19034736cbf7SLai Jiangshan /** 190460f5a4bcSLai Jiangshan * worker_detach_from_pool() - detach a worker from its pool 190560f5a4bcSLai Jiangshan * @worker: worker which is attached to its pool 190660f5a4bcSLai Jiangshan * 19074736cbf7SLai Jiangshan * Undo the attaching which had been done in worker_attach_to_pool(). The 19084736cbf7SLai Jiangshan * caller worker shouldn't access to the pool after detached except it has 19094736cbf7SLai Jiangshan * other reference to the pool. 191060f5a4bcSLai Jiangshan */ 1911a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker) 191260f5a4bcSLai Jiangshan { 1913a2d812a2STejun Heo struct worker_pool *pool = worker->pool; 191460f5a4bcSLai Jiangshan struct completion *detach_completion = NULL; 191560f5a4bcSLai Jiangshan 19161258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 1917a2d812a2STejun Heo 19185c25b5ffSPeter Zijlstra kthread_set_per_cpu(worker->task, -1); 1919da028469SLai Jiangshan list_del(&worker->node); 1920a2d812a2STejun Heo worker->pool = NULL; 1921a2d812a2STejun Heo 1922da028469SLai Jiangshan if (list_empty(&pool->workers)) 192360f5a4bcSLai Jiangshan detach_completion = pool->detach_completion; 19241258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 192560f5a4bcSLai Jiangshan 1926b62c0751SLai Jiangshan /* clear leftover flags without pool->lock after it is detached */ 1927b62c0751SLai Jiangshan worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND); 1928b62c0751SLai Jiangshan 192960f5a4bcSLai Jiangshan if (detach_completion) 193060f5a4bcSLai Jiangshan complete(detach_completion); 193160f5a4bcSLai Jiangshan } 193260f5a4bcSLai Jiangshan 193360f5a4bcSLai Jiangshan /** 1934c34056a3STejun Heo * create_worker - create a new workqueue worker 193563d95a91STejun Heo * @pool: pool the new worker will belong to 1936c34056a3STejun Heo * 1937051e1850SLai Jiangshan * Create and start a new worker which is attached to @pool. 1938c34056a3STejun Heo * 1939c34056a3STejun Heo * CONTEXT: 1940c34056a3STejun Heo * Might sleep. Does GFP_KERNEL allocations. 1941c34056a3STejun Heo * 1942d185af30SYacine Belkadi * Return: 1943c34056a3STejun Heo * Pointer to the newly created worker. 1944c34056a3STejun Heo */ 1945bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool) 1946c34056a3STejun Heo { 1947e441b56fSZhen Lei struct worker *worker; 1948e441b56fSZhen Lei int id; 1949e3c916a4STejun Heo char id_buf[16]; 1950c34056a3STejun Heo 19517cda9aaeSLai Jiangshan /* ID is needed to determine kthread name */ 1952e441b56fSZhen Lei id = ida_alloc(&pool->worker_ida, GFP_KERNEL); 1953822d8405STejun Heo if (id < 0) 1954e441b56fSZhen Lei return NULL; 1955c34056a3STejun Heo 1956f7537df5SLai Jiangshan worker = alloc_worker(pool->node); 1957c34056a3STejun Heo if (!worker) 1958c34056a3STejun Heo goto fail; 1959c34056a3STejun Heo 1960c34056a3STejun Heo worker->id = id; 1961c34056a3STejun Heo 196229c91e99STejun Heo if (pool->cpu >= 0) 1963e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id, 1964e3c916a4STejun Heo pool->attrs->nice < 0 ? "H" : ""); 1965f3421797STejun Heo else 1966e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id); 1967e3c916a4STejun Heo 1968f3f90ad4STejun Heo worker->task = kthread_create_on_node(worker_thread, worker, pool->node, 1969e3c916a4STejun Heo "kworker/%s", id_buf); 1970c34056a3STejun Heo if (IS_ERR(worker->task)) 1971c34056a3STejun Heo goto fail; 1972c34056a3STejun Heo 197391151228SOleg Nesterov set_user_nice(worker->task, pool->attrs->nice); 197425834c73SPeter Zijlstra kthread_bind_mask(worker->task, pool->attrs->cpumask); 197591151228SOleg Nesterov 1976da028469SLai Jiangshan /* successful, attach the worker to the pool */ 19774736cbf7SLai Jiangshan worker_attach_to_pool(worker, pool); 1978822d8405STejun Heo 1979051e1850SLai Jiangshan /* start the newly created worker */ 1980a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 1981051e1850SLai Jiangshan worker->pool->nr_workers++; 1982051e1850SLai Jiangshan worker_enter_idle(worker); 1983051e1850SLai Jiangshan wake_up_process(worker->task); 1984a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 1985051e1850SLai Jiangshan 1986c34056a3STejun Heo return worker; 1987822d8405STejun Heo 1988c34056a3STejun Heo fail: 1989e441b56fSZhen Lei ida_free(&pool->worker_ida, id); 1990c34056a3STejun Heo kfree(worker); 1991c34056a3STejun Heo return NULL; 1992c34056a3STejun Heo } 1993c34056a3STejun Heo 1994c34056a3STejun Heo /** 1995c34056a3STejun Heo * destroy_worker - destroy a workqueue worker 1996c34056a3STejun Heo * @worker: worker to be destroyed 1997c34056a3STejun Heo * 199873eb7fe7SLai Jiangshan * Destroy @worker and adjust @pool stats accordingly. The worker should 199973eb7fe7SLai Jiangshan * be idle. 2000c8e55f36STejun Heo * 2001c8e55f36STejun Heo * CONTEXT: 2002a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 2003c34056a3STejun Heo */ 2004c34056a3STejun Heo static void destroy_worker(struct worker *worker) 2005c34056a3STejun Heo { 2006bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 2007c34056a3STejun Heo 2008cd549687STejun Heo lockdep_assert_held(&pool->lock); 2009cd549687STejun Heo 2010c34056a3STejun Heo /* sanity check frenzy */ 20116183c009STejun Heo if (WARN_ON(worker->current_work) || 201273eb7fe7SLai Jiangshan WARN_ON(!list_empty(&worker->scheduled)) || 201373eb7fe7SLai Jiangshan WARN_ON(!(worker->flags & WORKER_IDLE))) 20146183c009STejun Heo return; 2015c34056a3STejun Heo 2016bd7bdd43STejun Heo pool->nr_workers--; 2017bd7bdd43STejun Heo pool->nr_idle--; 2018c8e55f36STejun Heo 2019c8e55f36STejun Heo list_del_init(&worker->entry); 2020cb444766STejun Heo worker->flags |= WORKER_DIE; 202160f5a4bcSLai Jiangshan wake_up_process(worker->task); 2022c34056a3STejun Heo } 2023c34056a3STejun Heo 202432a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t) 2025e22bee78STejun Heo { 202632a6c723SKees Cook struct worker_pool *pool = from_timer(pool, t, idle_timer); 2027e22bee78STejun Heo 2028a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2029e22bee78STejun Heo 20303347fc9fSLai Jiangshan while (too_many_workers(pool)) { 2031e22bee78STejun Heo struct worker *worker; 2032e22bee78STejun Heo unsigned long expires; 2033e22bee78STejun Heo 2034e22bee78STejun Heo /* idle_list is kept in LIFO order, check the last one */ 203563d95a91STejun Heo worker = list_entry(pool->idle_list.prev, struct worker, entry); 2036e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 2037e22bee78STejun Heo 20383347fc9fSLai Jiangshan if (time_before(jiffies, expires)) { 203963d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 20403347fc9fSLai Jiangshan break; 2041e22bee78STejun Heo } 20423347fc9fSLai Jiangshan 20433347fc9fSLai Jiangshan destroy_worker(worker); 2044e22bee78STejun Heo } 2045e22bee78STejun Heo 2046a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2047e22bee78STejun Heo } 2048e22bee78STejun Heo 2049493a1724STejun Heo static void send_mayday(struct work_struct *work) 2050e22bee78STejun Heo { 2051112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 2052112202d9STejun Heo struct workqueue_struct *wq = pwq->wq; 2053493a1724STejun Heo 20542e109a28STejun Heo lockdep_assert_held(&wq_mayday_lock); 2055e22bee78STejun Heo 2056493008a8STejun Heo if (!wq->rescuer) 2057493a1724STejun Heo return; 2058e22bee78STejun Heo 2059e22bee78STejun Heo /* mayday mayday mayday */ 2060493a1724STejun Heo if (list_empty(&pwq->mayday_node)) { 206177668c8bSLai Jiangshan /* 206277668c8bSLai Jiangshan * If @pwq is for an unbound wq, its base ref may be put at 206377668c8bSLai Jiangshan * any time due to an attribute change. Pin @pwq until the 206477668c8bSLai Jiangshan * rescuer is done with it. 206577668c8bSLai Jiangshan */ 206677668c8bSLai Jiangshan get_pwq(pwq); 2067493a1724STejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 2068e22bee78STejun Heo wake_up_process(wq->rescuer->task); 2069493a1724STejun Heo } 2070e22bee78STejun Heo } 2071e22bee78STejun Heo 207232a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t) 2073e22bee78STejun Heo { 207432a6c723SKees Cook struct worker_pool *pool = from_timer(pool, t, mayday_timer); 2075e22bee78STejun Heo struct work_struct *work; 2076e22bee78STejun Heo 2077a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2078a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&wq_mayday_lock); /* for wq->maydays */ 2079e22bee78STejun Heo 208063d95a91STejun Heo if (need_to_create_worker(pool)) { 2081e22bee78STejun Heo /* 2082e22bee78STejun Heo * We've been trying to create a new worker but 2083e22bee78STejun Heo * haven't been successful. We might be hitting an 2084e22bee78STejun Heo * allocation deadlock. Send distress signals to 2085e22bee78STejun Heo * rescuers. 2086e22bee78STejun Heo */ 208763d95a91STejun Heo list_for_each_entry(work, &pool->worklist, entry) 2088e22bee78STejun Heo send_mayday(work); 2089e22bee78STejun Heo } 2090e22bee78STejun Heo 2091a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&wq_mayday_lock); 2092a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2093e22bee78STejun Heo 209463d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL); 2095e22bee78STejun Heo } 2096e22bee78STejun Heo 2097e22bee78STejun Heo /** 2098e22bee78STejun Heo * maybe_create_worker - create a new worker if necessary 209963d95a91STejun Heo * @pool: pool to create a new worker for 2100e22bee78STejun Heo * 210163d95a91STejun Heo * Create a new worker for @pool if necessary. @pool is guaranteed to 2102e22bee78STejun Heo * have at least one idle worker on return from this function. If 2103e22bee78STejun Heo * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is 210463d95a91STejun Heo * sent to all rescuers with works scheduled on @pool to resolve 2105e22bee78STejun Heo * possible allocation deadlock. 2106e22bee78STejun Heo * 2107c5aa87bbSTejun Heo * On return, need_to_create_worker() is guaranteed to be %false and 2108c5aa87bbSTejun Heo * may_start_working() %true. 2109e22bee78STejun Heo * 2110e22bee78STejun Heo * LOCKING: 2111a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 2112e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. Called only from 2113e22bee78STejun Heo * manager. 2114e22bee78STejun Heo */ 211529187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool) 2116d565ed63STejun Heo __releases(&pool->lock) 2117d565ed63STejun Heo __acquires(&pool->lock) 2118e22bee78STejun Heo { 2119e22bee78STejun Heo restart: 2120a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 21219f9c2364STejun Heo 2122e22bee78STejun Heo /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ 212363d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); 2124e22bee78STejun Heo 2125e22bee78STejun Heo while (true) { 2126051e1850SLai Jiangshan if (create_worker(pool) || !need_to_create_worker(pool)) 2127e22bee78STejun Heo break; 2128e22bee78STejun Heo 2129e212f361SLai Jiangshan schedule_timeout_interruptible(CREATE_COOLDOWN); 21309f9c2364STejun Heo 213163d95a91STejun Heo if (!need_to_create_worker(pool)) 2132e22bee78STejun Heo break; 2133e22bee78STejun Heo } 2134e22bee78STejun Heo 213563d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 2136a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2137051e1850SLai Jiangshan /* 2138051e1850SLai Jiangshan * This is necessary even after a new worker was just successfully 2139051e1850SLai Jiangshan * created as @pool->lock was dropped and the new worker might have 2140051e1850SLai Jiangshan * already become busy. 2141051e1850SLai Jiangshan */ 214263d95a91STejun Heo if (need_to_create_worker(pool)) 2143e22bee78STejun Heo goto restart; 2144e22bee78STejun Heo } 2145e22bee78STejun Heo 2146e22bee78STejun Heo /** 2147e22bee78STejun Heo * manage_workers - manage worker pool 2148e22bee78STejun Heo * @worker: self 2149e22bee78STejun Heo * 2150706026c2STejun Heo * Assume the manager role and manage the worker pool @worker belongs 2151e22bee78STejun Heo * to. At any given time, there can be only zero or one manager per 2152706026c2STejun Heo * pool. The exclusion is handled automatically by this function. 2153e22bee78STejun Heo * 2154e22bee78STejun Heo * The caller can safely start processing works on false return. On 2155e22bee78STejun Heo * true return, it's guaranteed that need_to_create_worker() is false 2156e22bee78STejun Heo * and may_start_working() is true. 2157e22bee78STejun Heo * 2158e22bee78STejun Heo * CONTEXT: 2159a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 2160e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. 2161e22bee78STejun Heo * 2162d185af30SYacine Belkadi * Return: 216329187a9eSTejun Heo * %false if the pool doesn't need management and the caller can safely 216429187a9eSTejun Heo * start processing works, %true if management function was performed and 216529187a9eSTejun Heo * the conditions that the caller verified before calling the function may 216629187a9eSTejun Heo * no longer be true. 2167e22bee78STejun Heo */ 2168e22bee78STejun Heo static bool manage_workers(struct worker *worker) 2169e22bee78STejun Heo { 217063d95a91STejun Heo struct worker_pool *pool = worker->pool; 2171e22bee78STejun Heo 2172692b4825STejun Heo if (pool->flags & POOL_MANAGER_ACTIVE) 217329187a9eSTejun Heo return false; 2174692b4825STejun Heo 2175692b4825STejun Heo pool->flags |= POOL_MANAGER_ACTIVE; 21762607d7a6STejun Heo pool->manager = worker; 2177e22bee78STejun Heo 217829187a9eSTejun Heo maybe_create_worker(pool); 2179e22bee78STejun Heo 21802607d7a6STejun Heo pool->manager = NULL; 2181692b4825STejun Heo pool->flags &= ~POOL_MANAGER_ACTIVE; 2182d8bb65abSSebastian Andrzej Siewior rcuwait_wake_up(&manager_wait); 218329187a9eSTejun Heo return true; 2184e22bee78STejun Heo } 2185e22bee78STejun Heo 2186a62428c0STejun Heo /** 2187a62428c0STejun Heo * process_one_work - process single work 2188c34056a3STejun Heo * @worker: self 2189a62428c0STejun Heo * @work: work to process 2190a62428c0STejun Heo * 2191a62428c0STejun Heo * Process @work. This function contains all the logics necessary to 2192a62428c0STejun Heo * process a single work including synchronization against and 2193a62428c0STejun Heo * interaction with other workers on the same cpu, queueing and 2194a62428c0STejun Heo * flushing. As long as context requirement is met, any worker can 2195a62428c0STejun Heo * call this function to process a work. 2196a62428c0STejun Heo * 2197a62428c0STejun Heo * CONTEXT: 2198a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which is released and regrabbed. 2199a62428c0STejun Heo */ 2200c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work) 2201d565ed63STejun Heo __releases(&pool->lock) 2202d565ed63STejun Heo __acquires(&pool->lock) 22031da177e4SLinus Torvalds { 2204112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 2205bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 2206112202d9STejun Heo bool cpu_intensive = pwq->wq->flags & WQ_CPU_INTENSIVE; 2207c4560c2cSLai Jiangshan unsigned long work_data; 22087e11629dSTejun Heo struct worker *collision; 22094e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 22104e6045f1SJohannes Berg /* 2211a62428c0STejun Heo * It is permissible to free the struct work_struct from 2212a62428c0STejun Heo * inside the function that is called from it, this we need to 2213a62428c0STejun Heo * take into account for lockdep too. To avoid bogus "held 2214a62428c0STejun Heo * lock freed" warnings as well as problems when looking into 2215a62428c0STejun Heo * work->lockdep_map, make a copy and use that here. 22164e6045f1SJohannes Berg */ 22174d82a1deSPeter Zijlstra struct lockdep_map lockdep_map; 22184d82a1deSPeter Zijlstra 22194d82a1deSPeter Zijlstra lockdep_copy_map(&lockdep_map, &work->lockdep_map); 22204e6045f1SJohannes Berg #endif 2221807407c0SLai Jiangshan /* ensure we're on the correct CPU */ 222285327af6SLai Jiangshan WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 2223ec22ca5eSTejun Heo raw_smp_processor_id() != pool->cpu); 222425511a47STejun Heo 22257e11629dSTejun Heo /* 22267e11629dSTejun Heo * A single work shouldn't be executed concurrently by 22277e11629dSTejun Heo * multiple workers on a single cpu. Check whether anyone is 22287e11629dSTejun Heo * already processing the work. If so, defer the work to the 22297e11629dSTejun Heo * currently executing one. 22307e11629dSTejun Heo */ 2231c9e7cf27STejun Heo collision = find_worker_executing_work(pool, work); 22327e11629dSTejun Heo if (unlikely(collision)) { 22337e11629dSTejun Heo move_linked_works(work, &collision->scheduled, NULL); 22347e11629dSTejun Heo return; 22357e11629dSTejun Heo } 22361da177e4SLinus Torvalds 22378930cabaSTejun Heo /* claim and dequeue */ 22381da177e4SLinus Torvalds debug_work_deactivate(work); 2239c9e7cf27STejun Heo hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work); 2240c34056a3STejun Heo worker->current_work = work; 2241a2c1c57bSTejun Heo worker->current_func = work->func; 2242112202d9STejun Heo worker->current_pwq = pwq; 2243c4560c2cSLai Jiangshan work_data = *work_data_bits(work); 2244d812796eSLai Jiangshan worker->current_color = get_work_color(work_data); 22457a22ad75STejun Heo 22468bf89593STejun Heo /* 22478bf89593STejun Heo * Record wq name for cmdline and debug reporting, may get 22488bf89593STejun Heo * overridden through set_worker_desc(). 22498bf89593STejun Heo */ 22508bf89593STejun Heo strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN); 22518bf89593STejun Heo 2252a62428c0STejun Heo list_del_init(&work->entry); 2253a62428c0STejun Heo 2254649027d7STejun Heo /* 2255228f1d00SLai Jiangshan * CPU intensive works don't participate in concurrency management. 2256228f1d00SLai Jiangshan * They're the scheduler's responsibility. This takes @worker out 2257228f1d00SLai Jiangshan * of concurrency management and the next code block will chain 2258228f1d00SLai Jiangshan * execution of the pending work items. 2259fb0e7bebSTejun Heo */ 2260fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2261228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_CPU_INTENSIVE); 2262fb0e7bebSTejun Heo 2263974271c4STejun Heo /* 2264a489a03eSLai Jiangshan * Wake up another worker if necessary. The condition is always 2265a489a03eSLai Jiangshan * false for normal per-cpu workers since nr_running would always 2266a489a03eSLai Jiangshan * be >= 1 at this point. This is used to chain execution of the 2267a489a03eSLai Jiangshan * pending work items for WORKER_NOT_RUNNING workers such as the 2268228f1d00SLai Jiangshan * UNBOUND and CPU_INTENSIVE ones. 2269974271c4STejun Heo */ 2270a489a03eSLai Jiangshan if (need_more_worker(pool)) 227163d95a91STejun Heo wake_up_worker(pool); 2272974271c4STejun Heo 22738930cabaSTejun Heo /* 22747c3eed5cSTejun Heo * Record the last pool and clear PENDING which should be the last 2275d565ed63STejun Heo * update to @work. Also, do this inside @pool->lock so that 227623657bb1STejun Heo * PENDING and queued state changes happen together while IRQ is 227723657bb1STejun Heo * disabled. 22788930cabaSTejun Heo */ 22797c3eed5cSTejun Heo set_work_pool_and_clear_pending(work, pool->id); 22801da177e4SLinus Torvalds 2281a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2282365970a1SDavid Howells 2283a1d14934SPeter Zijlstra lock_map_acquire(&pwq->wq->lockdep_map); 22843295f0efSIngo Molnar lock_map_acquire(&lockdep_map); 2285e6f3faa7SPeter Zijlstra /* 2286f52be570SPeter Zijlstra * Strictly speaking we should mark the invariant state without holding 2287f52be570SPeter Zijlstra * any locks, that is, before these two lock_map_acquire()'s. 2288e6f3faa7SPeter Zijlstra * 2289e6f3faa7SPeter Zijlstra * However, that would result in: 2290e6f3faa7SPeter Zijlstra * 2291e6f3faa7SPeter Zijlstra * A(W1) 2292e6f3faa7SPeter Zijlstra * WFC(C) 2293e6f3faa7SPeter Zijlstra * A(W1) 2294e6f3faa7SPeter Zijlstra * C(C) 2295e6f3faa7SPeter Zijlstra * 2296e6f3faa7SPeter Zijlstra * Which would create W1->C->W1 dependencies, even though there is no 2297e6f3faa7SPeter Zijlstra * actual deadlock possible. There are two solutions, using a 2298e6f3faa7SPeter Zijlstra * read-recursive acquire on the work(queue) 'locks', but this will then 2299f52be570SPeter Zijlstra * hit the lockdep limitation on recursive locks, or simply discard 2300e6f3faa7SPeter Zijlstra * these locks. 2301e6f3faa7SPeter Zijlstra * 2302e6f3faa7SPeter Zijlstra * AFAICT there is no possible deadlock scenario between the 2303e6f3faa7SPeter Zijlstra * flush_work() and complete() primitives (except for single-threaded 2304e6f3faa7SPeter Zijlstra * workqueues), so hiding them isn't a problem. 2305e6f3faa7SPeter Zijlstra */ 2306f52be570SPeter Zijlstra lockdep_invariant_state(true); 2307e36c886aSArjan van de Ven trace_workqueue_execute_start(work); 2308a2c1c57bSTejun Heo worker->current_func(work); 2309e36c886aSArjan van de Ven /* 2310e36c886aSArjan van de Ven * While we must be careful to not use "work" after this, the trace 2311e36c886aSArjan van de Ven * point will only record its address. 2312e36c886aSArjan van de Ven */ 23131c5da0ecSDaniel Jordan trace_workqueue_execute_end(work, worker->current_func); 23143295f0efSIngo Molnar lock_map_release(&lockdep_map); 2315112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 23161da177e4SLinus Torvalds 2317d5abe669SPeter Zijlstra if (unlikely(in_atomic() || lockdep_depth(current) > 0)) { 2318044c782cSValentin Ilie pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d\n" 2319d75f773cSSakari Ailus " last function: %ps\n", 2320a2c1c57bSTejun Heo current->comm, preempt_count(), task_pid_nr(current), 2321a2c1c57bSTejun Heo worker->current_func); 2322d5abe669SPeter Zijlstra debug_show_held_locks(current); 2323d5abe669SPeter Zijlstra dump_stack(); 2324d5abe669SPeter Zijlstra } 2325d5abe669SPeter Zijlstra 2326b22ce278STejun Heo /* 2327025f50f3SSebastian Andrzej Siewior * The following prevents a kworker from hogging CPU on !PREEMPTION 2328b22ce278STejun Heo * kernels, where a requeueing work item waiting for something to 2329b22ce278STejun Heo * happen could deadlock with stop_machine as such work item could 2330b22ce278STejun Heo * indefinitely requeue itself while all other CPUs are trapped in 2331789cbbecSJoe Lawrence * stop_machine. At the same time, report a quiescent RCU state so 2332789cbbecSJoe Lawrence * the same condition doesn't freeze RCU. 2333b22ce278STejun Heo */ 2334a7e6425eSPaul E. McKenney cond_resched(); 2335b22ce278STejun Heo 2336a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2337a62428c0STejun Heo 2338fb0e7bebSTejun Heo /* clear cpu intensive status */ 2339fb0e7bebSTejun Heo if (unlikely(cpu_intensive)) 2340fb0e7bebSTejun Heo worker_clr_flags(worker, WORKER_CPU_INTENSIVE); 2341fb0e7bebSTejun Heo 23421b69ac6bSJohannes Weiner /* tag the worker for identification in schedule() */ 23431b69ac6bSJohannes Weiner worker->last_func = worker->current_func; 23441b69ac6bSJohannes Weiner 2345a62428c0STejun Heo /* we're done with it, release */ 234642f8570fSSasha Levin hash_del(&worker->hentry); 2347c34056a3STejun Heo worker->current_work = NULL; 2348a2c1c57bSTejun Heo worker->current_func = NULL; 2349112202d9STejun Heo worker->current_pwq = NULL; 2350d812796eSLai Jiangshan worker->current_color = INT_MAX; 2351c4560c2cSLai Jiangshan pwq_dec_nr_in_flight(pwq, work_data); 23521da177e4SLinus Torvalds } 23531da177e4SLinus Torvalds 2354affee4b2STejun Heo /** 2355affee4b2STejun Heo * process_scheduled_works - process scheduled works 2356affee4b2STejun Heo * @worker: self 2357affee4b2STejun Heo * 2358affee4b2STejun Heo * Process all scheduled works. Please note that the scheduled list 2359affee4b2STejun Heo * may change while processing a work, so this function repeatedly 2360affee4b2STejun Heo * fetches a work from the top and executes it. 2361affee4b2STejun Heo * 2362affee4b2STejun Heo * CONTEXT: 2363a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 2364affee4b2STejun Heo * multiple times. 2365affee4b2STejun Heo */ 2366affee4b2STejun Heo static void process_scheduled_works(struct worker *worker) 23671da177e4SLinus Torvalds { 2368affee4b2STejun Heo while (!list_empty(&worker->scheduled)) { 2369affee4b2STejun Heo struct work_struct *work = list_first_entry(&worker->scheduled, 2370a62428c0STejun Heo struct work_struct, entry); 2371c34056a3STejun Heo process_one_work(worker, work); 2372a62428c0STejun Heo } 23731da177e4SLinus Torvalds } 23741da177e4SLinus Torvalds 2375197f6accSTejun Heo static void set_pf_worker(bool val) 2376197f6accSTejun Heo { 2377197f6accSTejun Heo mutex_lock(&wq_pool_attach_mutex); 2378197f6accSTejun Heo if (val) 2379197f6accSTejun Heo current->flags |= PF_WQ_WORKER; 2380197f6accSTejun Heo else 2381197f6accSTejun Heo current->flags &= ~PF_WQ_WORKER; 2382197f6accSTejun Heo mutex_unlock(&wq_pool_attach_mutex); 2383197f6accSTejun Heo } 2384197f6accSTejun Heo 23854690c4abSTejun Heo /** 23864690c4abSTejun Heo * worker_thread - the worker thread function 2387c34056a3STejun Heo * @__worker: self 23884690c4abSTejun Heo * 2389c5aa87bbSTejun Heo * The worker thread function. All workers belong to a worker_pool - 2390c5aa87bbSTejun Heo * either a per-cpu one or dynamic unbound one. These workers process all 2391c5aa87bbSTejun Heo * work items regardless of their specific target workqueue. The only 2392c5aa87bbSTejun Heo * exception is work items which belong to workqueues with a rescuer which 2393c5aa87bbSTejun Heo * will be explained in rescuer_thread(). 2394d185af30SYacine Belkadi * 2395d185af30SYacine Belkadi * Return: 0 23964690c4abSTejun Heo */ 2397c34056a3STejun Heo static int worker_thread(void *__worker) 23981da177e4SLinus Torvalds { 2399c34056a3STejun Heo struct worker *worker = __worker; 2400bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 24011da177e4SLinus Torvalds 2402e22bee78STejun Heo /* tell the scheduler that this is a workqueue worker */ 2403197f6accSTejun Heo set_pf_worker(true); 2404c8e55f36STejun Heo woke_up: 2405a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2406affee4b2STejun Heo 2407a9ab775bSTejun Heo /* am I supposed to die? */ 2408a9ab775bSTejun Heo if (unlikely(worker->flags & WORKER_DIE)) { 2409a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2410a9ab775bSTejun Heo WARN_ON_ONCE(!list_empty(&worker->entry)); 2411197f6accSTejun Heo set_pf_worker(false); 241260f5a4bcSLai Jiangshan 241360f5a4bcSLai Jiangshan set_task_comm(worker->task, "kworker/dying"); 2414e441b56fSZhen Lei ida_free(&pool->worker_ida, worker->id); 2415a2d812a2STejun Heo worker_detach_from_pool(worker); 241660f5a4bcSLai Jiangshan kfree(worker); 2417c8e55f36STejun Heo return 0; 2418c8e55f36STejun Heo } 2419c8e55f36STejun Heo 2420c8e55f36STejun Heo worker_leave_idle(worker); 2421db7bccf4STejun Heo recheck: 2422e22bee78STejun Heo /* no more worker necessary? */ 242363d95a91STejun Heo if (!need_more_worker(pool)) 2424e22bee78STejun Heo goto sleep; 2425e22bee78STejun Heo 2426e22bee78STejun Heo /* do we need to manage? */ 242763d95a91STejun Heo if (unlikely(!may_start_working(pool)) && manage_workers(worker)) 2428e22bee78STejun Heo goto recheck; 2429e22bee78STejun Heo 2430c8e55f36STejun Heo /* 2431c8e55f36STejun Heo * ->scheduled list can only be filled while a worker is 2432c8e55f36STejun Heo * preparing to process a work or actually processing it. 2433c8e55f36STejun Heo * Make sure nobody diddled with it while I was sleeping. 2434c8e55f36STejun Heo */ 24356183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->scheduled)); 2436c8e55f36STejun Heo 2437e22bee78STejun Heo /* 2438a9ab775bSTejun Heo * Finish PREP stage. We're guaranteed to have at least one idle 2439a9ab775bSTejun Heo * worker or that someone else has already assumed the manager 2440a9ab775bSTejun Heo * role. This is where @worker starts participating in concurrency 2441a9ab775bSTejun Heo * management if applicable and concurrency management is restored 2442a9ab775bSTejun Heo * after being rebound. See rebind_workers() for details. 2443e22bee78STejun Heo */ 2444a9ab775bSTejun Heo worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND); 2445e22bee78STejun Heo 2446e22bee78STejun Heo do { 2447affee4b2STejun Heo struct work_struct *work = 2448bd7bdd43STejun Heo list_first_entry(&pool->worklist, 2449affee4b2STejun Heo struct work_struct, entry); 2450affee4b2STejun Heo 245182607adcSTejun Heo pool->watchdog_ts = jiffies; 245282607adcSTejun Heo 2453c8e55f36STejun Heo if (likely(!(*work_data_bits(work) & WORK_STRUCT_LINKED))) { 2454affee4b2STejun Heo /* optimization path, not strictly necessary */ 2455affee4b2STejun Heo process_one_work(worker, work); 2456affee4b2STejun Heo if (unlikely(!list_empty(&worker->scheduled))) 2457affee4b2STejun Heo process_scheduled_works(worker); 2458affee4b2STejun Heo } else { 2459c8e55f36STejun Heo move_linked_works(work, &worker->scheduled, NULL); 2460affee4b2STejun Heo process_scheduled_works(worker); 2461affee4b2STejun Heo } 246263d95a91STejun Heo } while (keep_working(pool)); 2463affee4b2STejun Heo 2464228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_PREP); 2465d313dd85STejun Heo sleep: 2466c8e55f36STejun Heo /* 2467d565ed63STejun Heo * pool->lock is held and there's no work to process and no need to 2468d565ed63STejun Heo * manage, sleep. Workers are woken up only while holding 2469d565ed63STejun Heo * pool->lock or from local cpu, so setting the current state 2470d565ed63STejun Heo * before releasing pool->lock is enough to prevent losing any 2471d565ed63STejun Heo * event. 2472c8e55f36STejun Heo */ 2473c8e55f36STejun Heo worker_enter_idle(worker); 2474c5a94a61SPeter Zijlstra __set_current_state(TASK_IDLE); 2475a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 24761da177e4SLinus Torvalds schedule(); 2477c8e55f36STejun Heo goto woke_up; 24781da177e4SLinus Torvalds } 24791da177e4SLinus Torvalds 2480e22bee78STejun Heo /** 2481e22bee78STejun Heo * rescuer_thread - the rescuer thread function 2482111c225aSTejun Heo * @__rescuer: self 2483e22bee78STejun Heo * 2484e22bee78STejun Heo * Workqueue rescuer thread function. There's one rescuer for each 2485493008a8STejun Heo * workqueue which has WQ_MEM_RECLAIM set. 2486e22bee78STejun Heo * 2487706026c2STejun Heo * Regular work processing on a pool may block trying to create a new 2488e22bee78STejun Heo * worker which uses GFP_KERNEL allocation which has slight chance of 2489e22bee78STejun Heo * developing into deadlock if some works currently on the same queue 2490e22bee78STejun Heo * need to be processed to satisfy the GFP_KERNEL allocation. This is 2491e22bee78STejun Heo * the problem rescuer solves. 2492e22bee78STejun Heo * 2493706026c2STejun Heo * When such condition is possible, the pool summons rescuers of all 2494706026c2STejun Heo * workqueues which have works queued on the pool and let them process 2495e22bee78STejun Heo * those works so that forward progress can be guaranteed. 2496e22bee78STejun Heo * 2497e22bee78STejun Heo * This should happen rarely. 2498d185af30SYacine Belkadi * 2499d185af30SYacine Belkadi * Return: 0 2500e22bee78STejun Heo */ 2501111c225aSTejun Heo static int rescuer_thread(void *__rescuer) 2502e22bee78STejun Heo { 2503111c225aSTejun Heo struct worker *rescuer = __rescuer; 2504111c225aSTejun Heo struct workqueue_struct *wq = rescuer->rescue_wq; 2505e22bee78STejun Heo struct list_head *scheduled = &rescuer->scheduled; 25064d595b86SLai Jiangshan bool should_stop; 2507e22bee78STejun Heo 2508e22bee78STejun Heo set_user_nice(current, RESCUER_NICE_LEVEL); 2509111c225aSTejun Heo 2510111c225aSTejun Heo /* 2511111c225aSTejun Heo * Mark rescuer as worker too. As WORKER_PREP is never cleared, it 2512111c225aSTejun Heo * doesn't participate in concurrency management. 2513111c225aSTejun Heo */ 2514197f6accSTejun Heo set_pf_worker(true); 2515e22bee78STejun Heo repeat: 2516c5a94a61SPeter Zijlstra set_current_state(TASK_IDLE); 25171da177e4SLinus Torvalds 25184d595b86SLai Jiangshan /* 25194d595b86SLai Jiangshan * By the time the rescuer is requested to stop, the workqueue 25204d595b86SLai Jiangshan * shouldn't have any work pending, but @wq->maydays may still have 25214d595b86SLai Jiangshan * pwq(s) queued. This can happen by non-rescuer workers consuming 25224d595b86SLai Jiangshan * all the work items before the rescuer got to them. Go through 25234d595b86SLai Jiangshan * @wq->maydays processing before acting on should_stop so that the 25244d595b86SLai Jiangshan * list is always empty on exit. 25254d595b86SLai Jiangshan */ 25264d595b86SLai Jiangshan should_stop = kthread_should_stop(); 25271da177e4SLinus Torvalds 2528493a1724STejun Heo /* see whether any pwq is asking for help */ 2529a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 2530493a1724STejun Heo 2531493a1724STejun Heo while (!list_empty(&wq->maydays)) { 2532493a1724STejun Heo struct pool_workqueue *pwq = list_first_entry(&wq->maydays, 2533493a1724STejun Heo struct pool_workqueue, mayday_node); 2534112202d9STejun Heo struct worker_pool *pool = pwq->pool; 2535e22bee78STejun Heo struct work_struct *work, *n; 253682607adcSTejun Heo bool first = true; 2537e22bee78STejun Heo 2538e22bee78STejun Heo __set_current_state(TASK_RUNNING); 2539493a1724STejun Heo list_del_init(&pwq->mayday_node); 2540493a1724STejun Heo 2541a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 2542e22bee78STejun Heo 254351697d39SLai Jiangshan worker_attach_to_pool(rescuer, pool); 254451697d39SLai Jiangshan 2545a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2546e22bee78STejun Heo 2547e22bee78STejun Heo /* 2548e22bee78STejun Heo * Slurp in all works issued via this workqueue and 2549e22bee78STejun Heo * process'em. 2550e22bee78STejun Heo */ 25510479c8c5STejun Heo WARN_ON_ONCE(!list_empty(scheduled)); 255282607adcSTejun Heo list_for_each_entry_safe(work, n, &pool->worklist, entry) { 255382607adcSTejun Heo if (get_work_pwq(work) == pwq) { 255482607adcSTejun Heo if (first) 255582607adcSTejun Heo pool->watchdog_ts = jiffies; 2556e22bee78STejun Heo move_linked_works(work, scheduled, &n); 255782607adcSTejun Heo } 255882607adcSTejun Heo first = false; 255982607adcSTejun Heo } 2560e22bee78STejun Heo 2561008847f6SNeilBrown if (!list_empty(scheduled)) { 2562e22bee78STejun Heo process_scheduled_works(rescuer); 25637576958aSTejun Heo 25647576958aSTejun Heo /* 2565008847f6SNeilBrown * The above execution of rescued work items could 2566008847f6SNeilBrown * have created more to rescue through 2567f97a4a1aSLai Jiangshan * pwq_activate_first_inactive() or chained 2568008847f6SNeilBrown * queueing. Let's put @pwq back on mayday list so 2569008847f6SNeilBrown * that such back-to-back work items, which may be 2570008847f6SNeilBrown * being used to relieve memory pressure, don't 2571008847f6SNeilBrown * incur MAYDAY_INTERVAL delay inbetween. 2572008847f6SNeilBrown */ 25734f3f4cf3SLai Jiangshan if (pwq->nr_active && need_to_create_worker(pool)) { 2574a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&wq_mayday_lock); 2575e66b39afSTejun Heo /* 2576e66b39afSTejun Heo * Queue iff we aren't racing destruction 2577e66b39afSTejun Heo * and somebody else hasn't queued it already. 2578e66b39afSTejun Heo */ 2579e66b39afSTejun Heo if (wq->rescuer && list_empty(&pwq->mayday_node)) { 2580008847f6SNeilBrown get_pwq(pwq); 2581e66b39afSTejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 2582e66b39afSTejun Heo } 2583a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&wq_mayday_lock); 2584008847f6SNeilBrown } 2585008847f6SNeilBrown } 2586008847f6SNeilBrown 2587008847f6SNeilBrown /* 258877668c8bSLai Jiangshan * Put the reference grabbed by send_mayday(). @pool won't 258913b1d625SLai Jiangshan * go away while we're still attached to it. 259077668c8bSLai Jiangshan */ 259177668c8bSLai Jiangshan put_pwq(pwq); 259277668c8bSLai Jiangshan 259377668c8bSLai Jiangshan /* 2594d8ca83e6SLai Jiangshan * Leave this pool. If need_more_worker() is %true, notify a 25957576958aSTejun Heo * regular worker; otherwise, we end up with 0 concurrency 25967576958aSTejun Heo * and stalling the execution. 25977576958aSTejun Heo */ 2598d8ca83e6SLai Jiangshan if (need_more_worker(pool)) 259963d95a91STejun Heo wake_up_worker(pool); 26007576958aSTejun Heo 2601a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 260213b1d625SLai Jiangshan 2603a2d812a2STejun Heo worker_detach_from_pool(rescuer); 260413b1d625SLai Jiangshan 2605a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 26061da177e4SLinus Torvalds } 26071da177e4SLinus Torvalds 2608a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 2609493a1724STejun Heo 26104d595b86SLai Jiangshan if (should_stop) { 26114d595b86SLai Jiangshan __set_current_state(TASK_RUNNING); 2612197f6accSTejun Heo set_pf_worker(false); 26134d595b86SLai Jiangshan return 0; 26144d595b86SLai Jiangshan } 26154d595b86SLai Jiangshan 2616111c225aSTejun Heo /* rescuers should never participate in concurrency management */ 2617111c225aSTejun Heo WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING)); 2618e22bee78STejun Heo schedule(); 2619e22bee78STejun Heo goto repeat; 26201da177e4SLinus Torvalds } 26211da177e4SLinus Torvalds 2622fca839c0STejun Heo /** 2623fca839c0STejun Heo * check_flush_dependency - check for flush dependency sanity 2624fca839c0STejun Heo * @target_wq: workqueue being flushed 2625fca839c0STejun Heo * @target_work: work item being flushed (NULL for workqueue flushes) 2626fca839c0STejun Heo * 2627fca839c0STejun Heo * %current is trying to flush the whole @target_wq or @target_work on it. 2628fca839c0STejun Heo * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not 2629fca839c0STejun Heo * reclaiming memory or running on a workqueue which doesn't have 2630fca839c0STejun Heo * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to 2631fca839c0STejun Heo * a deadlock. 2632fca839c0STejun Heo */ 2633fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq, 2634fca839c0STejun Heo struct work_struct *target_work) 2635fca839c0STejun Heo { 2636fca839c0STejun Heo work_func_t target_func = target_work ? target_work->func : NULL; 2637fca839c0STejun Heo struct worker *worker; 2638fca839c0STejun Heo 2639fca839c0STejun Heo if (target_wq->flags & WQ_MEM_RECLAIM) 2640fca839c0STejun Heo return; 2641fca839c0STejun Heo 2642fca839c0STejun Heo worker = current_wq_worker(); 2643fca839c0STejun Heo 2644fca839c0STejun Heo WARN_ONCE(current->flags & PF_MEMALLOC, 2645d75f773cSSakari Ailus "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps", 2646fca839c0STejun Heo current->pid, current->comm, target_wq->name, target_func); 264723d11a58STejun Heo WARN_ONCE(worker && ((worker->current_pwq->wq->flags & 264823d11a58STejun Heo (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM), 2649d75f773cSSakari Ailus "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps", 2650fca839c0STejun Heo worker->current_pwq->wq->name, worker->current_func, 2651fca839c0STejun Heo target_wq->name, target_func); 2652fca839c0STejun Heo } 2653fca839c0STejun Heo 2654fc2e4d70SOleg Nesterov struct wq_barrier { 2655fc2e4d70SOleg Nesterov struct work_struct work; 2656fc2e4d70SOleg Nesterov struct completion done; 26572607d7a6STejun Heo struct task_struct *task; /* purely informational */ 2658fc2e4d70SOleg Nesterov }; 2659fc2e4d70SOleg Nesterov 2660fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work) 2661fc2e4d70SOleg Nesterov { 2662fc2e4d70SOleg Nesterov struct wq_barrier *barr = container_of(work, struct wq_barrier, work); 2663fc2e4d70SOleg Nesterov complete(&barr->done); 2664fc2e4d70SOleg Nesterov } 2665fc2e4d70SOleg Nesterov 26664690c4abSTejun Heo /** 26674690c4abSTejun Heo * insert_wq_barrier - insert a barrier work 2668112202d9STejun Heo * @pwq: pwq to insert barrier into 26694690c4abSTejun Heo * @barr: wq_barrier to insert 2670affee4b2STejun Heo * @target: target work to attach @barr to 2671affee4b2STejun Heo * @worker: worker currently executing @target, NULL if @target is not executing 26724690c4abSTejun Heo * 2673affee4b2STejun Heo * @barr is linked to @target such that @barr is completed only after 2674affee4b2STejun Heo * @target finishes execution. Please note that the ordering 2675affee4b2STejun Heo * guarantee is observed only with respect to @target and on the local 2676affee4b2STejun Heo * cpu. 2677affee4b2STejun Heo * 2678affee4b2STejun Heo * Currently, a queued barrier can't be canceled. This is because 2679affee4b2STejun Heo * try_to_grab_pending() can't determine whether the work to be 2680affee4b2STejun Heo * grabbed is at the head of the queue and thus can't clear LINKED 2681affee4b2STejun Heo * flag of the previous work while there must be a valid next work 2682affee4b2STejun Heo * after a work with LINKED flag set. 2683affee4b2STejun Heo * 2684affee4b2STejun Heo * Note that when @worker is non-NULL, @target may be modified 2685112202d9STejun Heo * underneath us, so we can't reliably determine pwq from @target. 26864690c4abSTejun Heo * 26874690c4abSTejun Heo * CONTEXT: 2688a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 26894690c4abSTejun Heo */ 2690112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq, 2691affee4b2STejun Heo struct wq_barrier *barr, 2692affee4b2STejun Heo struct work_struct *target, struct worker *worker) 2693fc2e4d70SOleg Nesterov { 2694d812796eSLai Jiangshan unsigned int work_flags = 0; 2695d812796eSLai Jiangshan unsigned int work_color; 2696affee4b2STejun Heo struct list_head *head; 2697affee4b2STejun Heo 2698dc186ad7SThomas Gleixner /* 2699d565ed63STejun Heo * debugobject calls are safe here even with pool->lock locked 2700dc186ad7SThomas Gleixner * as we know for sure that this will not trigger any of the 2701dc186ad7SThomas Gleixner * checks and call back into the fixup functions where we 2702dc186ad7SThomas Gleixner * might deadlock. 2703dc186ad7SThomas Gleixner */ 2704ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&barr->work, wq_barrier_func); 270522df02bbSTejun Heo __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); 270652fa5bc5SBoqun Feng 2707fd1a5b04SByungchul Park init_completion_map(&barr->done, &target->lockdep_map); 2708fd1a5b04SByungchul Park 27092607d7a6STejun Heo barr->task = current; 271083c22520SOleg Nesterov 2711018f3a13SLai Jiangshan /* The barrier work item does not participate in pwq->nr_active. */ 2712018f3a13SLai Jiangshan work_flags |= WORK_STRUCT_INACTIVE; 2713018f3a13SLai Jiangshan 2714affee4b2STejun Heo /* 2715affee4b2STejun Heo * If @target is currently being executed, schedule the 2716affee4b2STejun Heo * barrier to the worker; otherwise, put it after @target. 2717affee4b2STejun Heo */ 2718d812796eSLai Jiangshan if (worker) { 2719affee4b2STejun Heo head = worker->scheduled.next; 2720d812796eSLai Jiangshan work_color = worker->current_color; 2721d812796eSLai Jiangshan } else { 2722affee4b2STejun Heo unsigned long *bits = work_data_bits(target); 2723affee4b2STejun Heo 2724affee4b2STejun Heo head = target->entry.next; 2725affee4b2STejun Heo /* there can already be other linked works, inherit and set */ 2726d21cece0SLai Jiangshan work_flags |= *bits & WORK_STRUCT_LINKED; 2727d812796eSLai Jiangshan work_color = get_work_color(*bits); 2728affee4b2STejun Heo __set_bit(WORK_STRUCT_LINKED_BIT, bits); 2729affee4b2STejun Heo } 2730affee4b2STejun Heo 2731d812796eSLai Jiangshan pwq->nr_in_flight[work_color]++; 2732d812796eSLai Jiangshan work_flags |= work_color_to_flags(work_color); 2733d812796eSLai Jiangshan 2734dc186ad7SThomas Gleixner debug_work_activate(&barr->work); 2735d21cece0SLai Jiangshan insert_work(pwq, &barr->work, head, work_flags); 2736fc2e4d70SOleg Nesterov } 2737fc2e4d70SOleg Nesterov 273873f53c4aSTejun Heo /** 2739112202d9STejun Heo * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing 274073f53c4aSTejun Heo * @wq: workqueue being flushed 274173f53c4aSTejun Heo * @flush_color: new flush color, < 0 for no-op 274273f53c4aSTejun Heo * @work_color: new work color, < 0 for no-op 274373f53c4aSTejun Heo * 2744112202d9STejun Heo * Prepare pwqs for workqueue flushing. 274573f53c4aSTejun Heo * 2746112202d9STejun Heo * If @flush_color is non-negative, flush_color on all pwqs should be 2747112202d9STejun Heo * -1. If no pwq has in-flight commands at the specified color, all 2748112202d9STejun Heo * pwq->flush_color's stay at -1 and %false is returned. If any pwq 2749112202d9STejun Heo * has in flight commands, its pwq->flush_color is set to 2750112202d9STejun Heo * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq 275173f53c4aSTejun Heo * wakeup logic is armed and %true is returned. 275273f53c4aSTejun Heo * 275373f53c4aSTejun Heo * The caller should have initialized @wq->first_flusher prior to 275473f53c4aSTejun Heo * calling this function with non-negative @flush_color. If 275573f53c4aSTejun Heo * @flush_color is negative, no flush color update is done and %false 275673f53c4aSTejun Heo * is returned. 275773f53c4aSTejun Heo * 2758112202d9STejun Heo * If @work_color is non-negative, all pwqs should have the same 275973f53c4aSTejun Heo * work_color which is previous to @work_color and all will be 276073f53c4aSTejun Heo * advanced to @work_color. 276173f53c4aSTejun Heo * 276273f53c4aSTejun Heo * CONTEXT: 27633c25a55dSLai Jiangshan * mutex_lock(wq->mutex). 276473f53c4aSTejun Heo * 2765d185af30SYacine Belkadi * Return: 276673f53c4aSTejun Heo * %true if @flush_color >= 0 and there's something to flush. %false 276773f53c4aSTejun Heo * otherwise. 276873f53c4aSTejun Heo */ 2769112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq, 277073f53c4aSTejun Heo int flush_color, int work_color) 27711da177e4SLinus Torvalds { 277273f53c4aSTejun Heo bool wait = false; 277349e3cf44STejun Heo struct pool_workqueue *pwq; 27741da177e4SLinus Torvalds 277573f53c4aSTejun Heo if (flush_color >= 0) { 27766183c009STejun Heo WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush)); 2777112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 1); 2778dc186ad7SThomas Gleixner } 277914441960SOleg Nesterov 278049e3cf44STejun Heo for_each_pwq(pwq, wq) { 2781112202d9STejun Heo struct worker_pool *pool = pwq->pool; 27821da177e4SLinus Torvalds 2783a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 278473f53c4aSTejun Heo 278573f53c4aSTejun Heo if (flush_color >= 0) { 27866183c009STejun Heo WARN_ON_ONCE(pwq->flush_color != -1); 278773f53c4aSTejun Heo 2788112202d9STejun Heo if (pwq->nr_in_flight[flush_color]) { 2789112202d9STejun Heo pwq->flush_color = flush_color; 2790112202d9STejun Heo atomic_inc(&wq->nr_pwqs_to_flush); 279173f53c4aSTejun Heo wait = true; 27921da177e4SLinus Torvalds } 279373f53c4aSTejun Heo } 279473f53c4aSTejun Heo 279573f53c4aSTejun Heo if (work_color >= 0) { 27966183c009STejun Heo WARN_ON_ONCE(work_color != work_next_color(pwq->work_color)); 2797112202d9STejun Heo pwq->work_color = work_color; 279873f53c4aSTejun Heo } 279973f53c4aSTejun Heo 2800a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 28011da177e4SLinus Torvalds } 28021da177e4SLinus Torvalds 2803112202d9STejun Heo if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush)) 280473f53c4aSTejun Heo complete(&wq->first_flusher->done); 280573f53c4aSTejun Heo 280673f53c4aSTejun Heo return wait; 280783c22520SOleg Nesterov } 28081da177e4SLinus Torvalds 28090fcb78c2SRolf Eike Beer /** 28101da177e4SLinus Torvalds * flush_workqueue - ensure that any scheduled work has run to completion. 28110fcb78c2SRolf Eike Beer * @wq: workqueue to flush 28121da177e4SLinus Torvalds * 2813c5aa87bbSTejun Heo * This function sleeps until all work items which were queued on entry 2814c5aa87bbSTejun Heo * have finished execution, but it is not livelocked by new incoming ones. 28151da177e4SLinus Torvalds */ 28167ad5b3a5SHarvey Harrison void flush_workqueue(struct workqueue_struct *wq) 28171da177e4SLinus Torvalds { 281873f53c4aSTejun Heo struct wq_flusher this_flusher = { 281973f53c4aSTejun Heo .list = LIST_HEAD_INIT(this_flusher.list), 282073f53c4aSTejun Heo .flush_color = -1, 2821fd1a5b04SByungchul Park .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map), 282273f53c4aSTejun Heo }; 282373f53c4aSTejun Heo int next_color; 2824b1f4ec17SOleg Nesterov 28253347fa09STejun Heo if (WARN_ON(!wq_online)) 28263347fa09STejun Heo return; 28273347fa09STejun Heo 282887915adcSJohannes Berg lock_map_acquire(&wq->lockdep_map); 282987915adcSJohannes Berg lock_map_release(&wq->lockdep_map); 283087915adcSJohannes Berg 28313c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 283273f53c4aSTejun Heo 283373f53c4aSTejun Heo /* 283473f53c4aSTejun Heo * Start-to-wait phase 283573f53c4aSTejun Heo */ 283673f53c4aSTejun Heo next_color = work_next_color(wq->work_color); 283773f53c4aSTejun Heo 283873f53c4aSTejun Heo if (next_color != wq->flush_color) { 283973f53c4aSTejun Heo /* 284073f53c4aSTejun Heo * Color space is not full. The current work_color 284173f53c4aSTejun Heo * becomes our flush_color and work_color is advanced 284273f53c4aSTejun Heo * by one. 284373f53c4aSTejun Heo */ 28446183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow)); 284573f53c4aSTejun Heo this_flusher.flush_color = wq->work_color; 284673f53c4aSTejun Heo wq->work_color = next_color; 284773f53c4aSTejun Heo 284873f53c4aSTejun Heo if (!wq->first_flusher) { 284973f53c4aSTejun Heo /* no flush in progress, become the first flusher */ 28506183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 285173f53c4aSTejun Heo 285273f53c4aSTejun Heo wq->first_flusher = &this_flusher; 285373f53c4aSTejun Heo 2854112202d9STejun Heo if (!flush_workqueue_prep_pwqs(wq, wq->flush_color, 285573f53c4aSTejun Heo wq->work_color)) { 285673f53c4aSTejun Heo /* nothing to flush, done */ 285773f53c4aSTejun Heo wq->flush_color = next_color; 285873f53c4aSTejun Heo wq->first_flusher = NULL; 285973f53c4aSTejun Heo goto out_unlock; 286073f53c4aSTejun Heo } 286173f53c4aSTejun Heo } else { 286273f53c4aSTejun Heo /* wait in queue */ 28636183c009STejun Heo WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color); 286473f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_queue); 2865112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 286673f53c4aSTejun Heo } 286773f53c4aSTejun Heo } else { 286873f53c4aSTejun Heo /* 286973f53c4aSTejun Heo * Oops, color space is full, wait on overflow queue. 287073f53c4aSTejun Heo * The next flush completion will assign us 287173f53c4aSTejun Heo * flush_color and transfer to flusher_queue. 287273f53c4aSTejun Heo */ 287373f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_overflow); 287473f53c4aSTejun Heo } 287573f53c4aSTejun Heo 2876fca839c0STejun Heo check_flush_dependency(wq, NULL); 2877fca839c0STejun Heo 28783c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 287973f53c4aSTejun Heo 288073f53c4aSTejun Heo wait_for_completion(&this_flusher.done); 288173f53c4aSTejun Heo 288273f53c4aSTejun Heo /* 288373f53c4aSTejun Heo * Wake-up-and-cascade phase 288473f53c4aSTejun Heo * 288573f53c4aSTejun Heo * First flushers are responsible for cascading flushes and 288673f53c4aSTejun Heo * handling overflow. Non-first flushers can simply return. 288773f53c4aSTejun Heo */ 288800d5d15bSChris Wilson if (READ_ONCE(wq->first_flusher) != &this_flusher) 288973f53c4aSTejun Heo return; 289073f53c4aSTejun Heo 28913c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 289273f53c4aSTejun Heo 28934ce48b37STejun Heo /* we might have raced, check again with mutex held */ 28944ce48b37STejun Heo if (wq->first_flusher != &this_flusher) 28954ce48b37STejun Heo goto out_unlock; 28964ce48b37STejun Heo 289700d5d15bSChris Wilson WRITE_ONCE(wq->first_flusher, NULL); 289873f53c4aSTejun Heo 28996183c009STejun Heo WARN_ON_ONCE(!list_empty(&this_flusher.list)); 29006183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 290173f53c4aSTejun Heo 290273f53c4aSTejun Heo while (true) { 290373f53c4aSTejun Heo struct wq_flusher *next, *tmp; 290473f53c4aSTejun Heo 290573f53c4aSTejun Heo /* complete all the flushers sharing the current flush color */ 290673f53c4aSTejun Heo list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { 290773f53c4aSTejun Heo if (next->flush_color != wq->flush_color) 290873f53c4aSTejun Heo break; 290973f53c4aSTejun Heo list_del_init(&next->list); 291073f53c4aSTejun Heo complete(&next->done); 291173f53c4aSTejun Heo } 291273f53c4aSTejun Heo 29136183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) && 291473f53c4aSTejun Heo wq->flush_color != work_next_color(wq->work_color)); 291573f53c4aSTejun Heo 291673f53c4aSTejun Heo /* this flush_color is finished, advance by one */ 291773f53c4aSTejun Heo wq->flush_color = work_next_color(wq->flush_color); 291873f53c4aSTejun Heo 291973f53c4aSTejun Heo /* one color has been freed, handle overflow queue */ 292073f53c4aSTejun Heo if (!list_empty(&wq->flusher_overflow)) { 292173f53c4aSTejun Heo /* 292273f53c4aSTejun Heo * Assign the same color to all overflowed 292373f53c4aSTejun Heo * flushers, advance work_color and append to 292473f53c4aSTejun Heo * flusher_queue. This is the start-to-wait 292573f53c4aSTejun Heo * phase for these overflowed flushers. 292673f53c4aSTejun Heo */ 292773f53c4aSTejun Heo list_for_each_entry(tmp, &wq->flusher_overflow, list) 292873f53c4aSTejun Heo tmp->flush_color = wq->work_color; 292973f53c4aSTejun Heo 293073f53c4aSTejun Heo wq->work_color = work_next_color(wq->work_color); 293173f53c4aSTejun Heo 293273f53c4aSTejun Heo list_splice_tail_init(&wq->flusher_overflow, 293373f53c4aSTejun Heo &wq->flusher_queue); 2934112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 293573f53c4aSTejun Heo } 293673f53c4aSTejun Heo 293773f53c4aSTejun Heo if (list_empty(&wq->flusher_queue)) { 29386183c009STejun Heo WARN_ON_ONCE(wq->flush_color != wq->work_color); 293973f53c4aSTejun Heo break; 294073f53c4aSTejun Heo } 294173f53c4aSTejun Heo 294273f53c4aSTejun Heo /* 294373f53c4aSTejun Heo * Need to flush more colors. Make the next flusher 2944112202d9STejun Heo * the new first flusher and arm pwqs. 294573f53c4aSTejun Heo */ 29466183c009STejun Heo WARN_ON_ONCE(wq->flush_color == wq->work_color); 29476183c009STejun Heo WARN_ON_ONCE(wq->flush_color != next->flush_color); 294873f53c4aSTejun Heo 294973f53c4aSTejun Heo list_del_init(&next->list); 295073f53c4aSTejun Heo wq->first_flusher = next; 295173f53c4aSTejun Heo 2952112202d9STejun Heo if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1)) 295373f53c4aSTejun Heo break; 295473f53c4aSTejun Heo 295573f53c4aSTejun Heo /* 295673f53c4aSTejun Heo * Meh... this color is already done, clear first 295773f53c4aSTejun Heo * flusher and repeat cascading. 295873f53c4aSTejun Heo */ 295973f53c4aSTejun Heo wq->first_flusher = NULL; 296073f53c4aSTejun Heo } 296173f53c4aSTejun Heo 296273f53c4aSTejun Heo out_unlock: 29633c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 29641da177e4SLinus Torvalds } 29651dadafa8STim Gardner EXPORT_SYMBOL(flush_workqueue); 29661da177e4SLinus Torvalds 29679c5a2ba7STejun Heo /** 29689c5a2ba7STejun Heo * drain_workqueue - drain a workqueue 29699c5a2ba7STejun Heo * @wq: workqueue to drain 29709c5a2ba7STejun Heo * 29719c5a2ba7STejun Heo * Wait until the workqueue becomes empty. While draining is in progress, 29729c5a2ba7STejun Heo * only chain queueing is allowed. IOW, only currently pending or running 29739c5a2ba7STejun Heo * work items on @wq can queue further work items on it. @wq is flushed 2974b749b1b6SChen Hanxiao * repeatedly until it becomes empty. The number of flushing is determined 29759c5a2ba7STejun Heo * by the depth of chaining and should be relatively short. Whine if it 29769c5a2ba7STejun Heo * takes too long. 29779c5a2ba7STejun Heo */ 29789c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq) 29799c5a2ba7STejun Heo { 29809c5a2ba7STejun Heo unsigned int flush_cnt = 0; 298149e3cf44STejun Heo struct pool_workqueue *pwq; 29829c5a2ba7STejun Heo 29839c5a2ba7STejun Heo /* 29849c5a2ba7STejun Heo * __queue_work() needs to test whether there are drainers, is much 29859c5a2ba7STejun Heo * hotter than drain_workqueue() and already looks at @wq->flags. 2986618b01ebSTejun Heo * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers. 29879c5a2ba7STejun Heo */ 298887fc741eSLai Jiangshan mutex_lock(&wq->mutex); 29899c5a2ba7STejun Heo if (!wq->nr_drainers++) 2990618b01ebSTejun Heo wq->flags |= __WQ_DRAINING; 299187fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 29929c5a2ba7STejun Heo reflush: 29939c5a2ba7STejun Heo flush_workqueue(wq); 29949c5a2ba7STejun Heo 2995b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 299676af4d93STejun Heo 299749e3cf44STejun Heo for_each_pwq(pwq, wq) { 2998fa2563e4SThomas Tuttle bool drained; 29999c5a2ba7STejun Heo 3000a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 3001f97a4a1aSLai Jiangshan drained = !pwq->nr_active && list_empty(&pwq->inactive_works); 3002a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 3003fa2563e4SThomas Tuttle 3004fa2563e4SThomas Tuttle if (drained) 30059c5a2ba7STejun Heo continue; 30069c5a2ba7STejun Heo 30079c5a2ba7STejun Heo if (++flush_cnt == 10 || 30089c5a2ba7STejun Heo (flush_cnt % 100 == 0 && flush_cnt <= 1000)) 3009e9ad2eb3SStephen Zhang pr_warn("workqueue %s: %s() isn't complete after %u tries\n", 3010e9ad2eb3SStephen Zhang wq->name, __func__, flush_cnt); 301176af4d93STejun Heo 3012b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 30139c5a2ba7STejun Heo goto reflush; 30149c5a2ba7STejun Heo } 30159c5a2ba7STejun Heo 30169c5a2ba7STejun Heo if (!--wq->nr_drainers) 3017618b01ebSTejun Heo wq->flags &= ~__WQ_DRAINING; 301887fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 30199c5a2ba7STejun Heo } 30209c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue); 30219c5a2ba7STejun Heo 3022d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr, 3023d6e89786SJohannes Berg bool from_cancel) 3024baf59022STejun Heo { 3025baf59022STejun Heo struct worker *worker = NULL; 3026c9e7cf27STejun Heo struct worker_pool *pool; 3027112202d9STejun Heo struct pool_workqueue *pwq; 3028baf59022STejun Heo 3029baf59022STejun Heo might_sleep(); 3030baf59022STejun Heo 303124acfb71SThomas Gleixner rcu_read_lock(); 3032fa1b54e6STejun Heo pool = get_work_pool(work); 3033fa1b54e6STejun Heo if (!pool) { 303424acfb71SThomas Gleixner rcu_read_unlock(); 3035fa1b54e6STejun Heo return false; 3036fa1b54e6STejun Heo } 3037fa1b54e6STejun Heo 3038a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 30390b3dae68SLai Jiangshan /* see the comment in try_to_grab_pending() with the same code */ 3040112202d9STejun Heo pwq = get_work_pwq(work); 3041112202d9STejun Heo if (pwq) { 3042112202d9STejun Heo if (unlikely(pwq->pool != pool)) 3043baf59022STejun Heo goto already_gone; 3044606a5020STejun Heo } else { 3045c9e7cf27STejun Heo worker = find_worker_executing_work(pool, work); 3046baf59022STejun Heo if (!worker) 3047baf59022STejun Heo goto already_gone; 3048112202d9STejun Heo pwq = worker->current_pwq; 3049606a5020STejun Heo } 3050baf59022STejun Heo 3051fca839c0STejun Heo check_flush_dependency(pwq->wq, work); 3052fca839c0STejun Heo 3053112202d9STejun Heo insert_wq_barrier(pwq, barr, work, worker); 3054a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 3055baf59022STejun Heo 3056e159489bSTejun Heo /* 3057a1d14934SPeter Zijlstra * Force a lock recursion deadlock when using flush_work() inside a 3058a1d14934SPeter Zijlstra * single-threaded or rescuer equipped workqueue. 3059a1d14934SPeter Zijlstra * 3060a1d14934SPeter Zijlstra * For single threaded workqueues the deadlock happens when the work 3061a1d14934SPeter Zijlstra * is after the work issuing the flush_work(). For rescuer equipped 3062a1d14934SPeter Zijlstra * workqueues the deadlock happens when the rescuer stalls, blocking 3063a1d14934SPeter Zijlstra * forward progress. 3064e159489bSTejun Heo */ 3065d6e89786SJohannes Berg if (!from_cancel && 3066d6e89786SJohannes Berg (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) { 3067112202d9STejun Heo lock_map_acquire(&pwq->wq->lockdep_map); 3068112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 3069a1d14934SPeter Zijlstra } 307024acfb71SThomas Gleixner rcu_read_unlock(); 3071baf59022STejun Heo return true; 3072baf59022STejun Heo already_gone: 3073a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 307424acfb71SThomas Gleixner rcu_read_unlock(); 3075baf59022STejun Heo return false; 3076baf59022STejun Heo } 3077baf59022STejun Heo 3078d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel) 3079d6e89786SJohannes Berg { 3080d6e89786SJohannes Berg struct wq_barrier barr; 3081d6e89786SJohannes Berg 3082d6e89786SJohannes Berg if (WARN_ON(!wq_online)) 3083d6e89786SJohannes Berg return false; 3084d6e89786SJohannes Berg 30854d43d395STetsuo Handa if (WARN_ON(!work->func)) 30864d43d395STetsuo Handa return false; 30874d43d395STetsuo Handa 308887915adcSJohannes Berg if (!from_cancel) { 308987915adcSJohannes Berg lock_map_acquire(&work->lockdep_map); 309087915adcSJohannes Berg lock_map_release(&work->lockdep_map); 309187915adcSJohannes Berg } 309287915adcSJohannes Berg 3093d6e89786SJohannes Berg if (start_flush_work(work, &barr, from_cancel)) { 3094d6e89786SJohannes Berg wait_for_completion(&barr.done); 3095d6e89786SJohannes Berg destroy_work_on_stack(&barr.work); 3096d6e89786SJohannes Berg return true; 3097d6e89786SJohannes Berg } else { 3098d6e89786SJohannes Berg return false; 3099d6e89786SJohannes Berg } 3100d6e89786SJohannes Berg } 3101d6e89786SJohannes Berg 3102db700897SOleg Nesterov /** 3103401a8d04STejun Heo * flush_work - wait for a work to finish executing the last queueing instance 3104401a8d04STejun Heo * @work: the work to flush 3105db700897SOleg Nesterov * 3106606a5020STejun Heo * Wait until @work has finished execution. @work is guaranteed to be idle 3107606a5020STejun Heo * on return if it hasn't been requeued since flush started. 3108401a8d04STejun Heo * 3109d185af30SYacine Belkadi * Return: 3110401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 3111401a8d04STejun Heo * %false if it was already idle. 3112db700897SOleg Nesterov */ 3113401a8d04STejun Heo bool flush_work(struct work_struct *work) 3114db700897SOleg Nesterov { 3115d6e89786SJohannes Berg return __flush_work(work, false); 3116606a5020STejun Heo } 3117db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work); 3118db700897SOleg Nesterov 31198603e1b3STejun Heo struct cwt_wait { 3120ac6424b9SIngo Molnar wait_queue_entry_t wait; 31218603e1b3STejun Heo struct work_struct *work; 31228603e1b3STejun Heo }; 31238603e1b3STejun Heo 3124ac6424b9SIngo Molnar static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key) 31258603e1b3STejun Heo { 31268603e1b3STejun Heo struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait); 31278603e1b3STejun Heo 31288603e1b3STejun Heo if (cwait->work != key) 31298603e1b3STejun Heo return 0; 31308603e1b3STejun Heo return autoremove_wake_function(wait, mode, sync, key); 31318603e1b3STejun Heo } 31328603e1b3STejun Heo 313336e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork) 3134401a8d04STejun Heo { 31358603e1b3STejun Heo static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq); 3136bbb68dfaSTejun Heo unsigned long flags; 31371f1f642eSOleg Nesterov int ret; 31381f1f642eSOleg Nesterov 31391f1f642eSOleg Nesterov do { 3140bbb68dfaSTejun Heo ret = try_to_grab_pending(work, is_dwork, &flags); 3141bbb68dfaSTejun Heo /* 31428603e1b3STejun Heo * If someone else is already canceling, wait for it to 31438603e1b3STejun Heo * finish. flush_work() doesn't work for PREEMPT_NONE 31448603e1b3STejun Heo * because we may get scheduled between @work's completion 31458603e1b3STejun Heo * and the other canceling task resuming and clearing 31468603e1b3STejun Heo * CANCELING - flush_work() will return false immediately 31478603e1b3STejun Heo * as @work is no longer busy, try_to_grab_pending() will 31488603e1b3STejun Heo * return -ENOENT as @work is still being canceled and the 31498603e1b3STejun Heo * other canceling task won't be able to clear CANCELING as 31508603e1b3STejun Heo * we're hogging the CPU. 31518603e1b3STejun Heo * 31528603e1b3STejun Heo * Let's wait for completion using a waitqueue. As this 31538603e1b3STejun Heo * may lead to the thundering herd problem, use a custom 31548603e1b3STejun Heo * wake function which matches @work along with exclusive 31558603e1b3STejun Heo * wait and wakeup. 3156bbb68dfaSTejun Heo */ 31578603e1b3STejun Heo if (unlikely(ret == -ENOENT)) { 31588603e1b3STejun Heo struct cwt_wait cwait; 31598603e1b3STejun Heo 31608603e1b3STejun Heo init_wait(&cwait.wait); 31618603e1b3STejun Heo cwait.wait.func = cwt_wakefn; 31628603e1b3STejun Heo cwait.work = work; 31638603e1b3STejun Heo 31648603e1b3STejun Heo prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait, 31658603e1b3STejun Heo TASK_UNINTERRUPTIBLE); 31668603e1b3STejun Heo if (work_is_canceling(work)) 31678603e1b3STejun Heo schedule(); 31688603e1b3STejun Heo finish_wait(&cancel_waitq, &cwait.wait); 31698603e1b3STejun Heo } 31701f1f642eSOleg Nesterov } while (unlikely(ret < 0)); 31711f1f642eSOleg Nesterov 3172bbb68dfaSTejun Heo /* tell other tasks trying to grab @work to back off */ 3173bbb68dfaSTejun Heo mark_work_canceling(work); 3174bbb68dfaSTejun Heo local_irq_restore(flags); 3175bbb68dfaSTejun Heo 31763347fa09STejun Heo /* 31773347fa09STejun Heo * This allows canceling during early boot. We know that @work 31783347fa09STejun Heo * isn't executing. 31793347fa09STejun Heo */ 31803347fa09STejun Heo if (wq_online) 3181d6e89786SJohannes Berg __flush_work(work, true); 31823347fa09STejun Heo 31837a22ad75STejun Heo clear_work_data(work); 31848603e1b3STejun Heo 31858603e1b3STejun Heo /* 31868603e1b3STejun Heo * Paired with prepare_to_wait() above so that either 31878603e1b3STejun Heo * waitqueue_active() is visible here or !work_is_canceling() is 31888603e1b3STejun Heo * visible there. 31898603e1b3STejun Heo */ 31908603e1b3STejun Heo smp_mb(); 31918603e1b3STejun Heo if (waitqueue_active(&cancel_waitq)) 31928603e1b3STejun Heo __wake_up(&cancel_waitq, TASK_NORMAL, 1, work); 31938603e1b3STejun Heo 31941f1f642eSOleg Nesterov return ret; 31951f1f642eSOleg Nesterov } 31961f1f642eSOleg Nesterov 31976e84d644SOleg Nesterov /** 3198401a8d04STejun Heo * cancel_work_sync - cancel a work and wait for it to finish 3199401a8d04STejun Heo * @work: the work to cancel 32006e84d644SOleg Nesterov * 3201401a8d04STejun Heo * Cancel @work and wait for its execution to finish. This function 3202401a8d04STejun Heo * can be used even if the work re-queues itself or migrates to 3203401a8d04STejun Heo * another workqueue. On return from this function, @work is 3204401a8d04STejun Heo * guaranteed to be not pending or executing on any CPU. 32051f1f642eSOleg Nesterov * 3206401a8d04STejun Heo * cancel_work_sync(&delayed_work->work) must not be used for 3207401a8d04STejun Heo * delayed_work's. Use cancel_delayed_work_sync() instead. 32086e84d644SOleg Nesterov * 3209401a8d04STejun Heo * The caller must ensure that the workqueue on which @work was last 32106e84d644SOleg Nesterov * queued can't be destroyed before this function returns. 3211401a8d04STejun Heo * 3212d185af30SYacine Belkadi * Return: 3213401a8d04STejun Heo * %true if @work was pending, %false otherwise. 32146e84d644SOleg Nesterov */ 3215401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work) 32166e84d644SOleg Nesterov { 321736e227d2STejun Heo return __cancel_work_timer(work, false); 3218b89deed3SOleg Nesterov } 321928e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync); 3220b89deed3SOleg Nesterov 32216e84d644SOleg Nesterov /** 3222401a8d04STejun Heo * flush_delayed_work - wait for a dwork to finish executing the last queueing 3223401a8d04STejun Heo * @dwork: the delayed work to flush 32246e84d644SOleg Nesterov * 3225401a8d04STejun Heo * Delayed timer is cancelled and the pending work is queued for 3226401a8d04STejun Heo * immediate execution. Like flush_work(), this function only 3227401a8d04STejun Heo * considers the last queueing instance of @dwork. 32281f1f642eSOleg Nesterov * 3229d185af30SYacine Belkadi * Return: 3230401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 3231401a8d04STejun Heo * %false if it was already idle. 32326e84d644SOleg Nesterov */ 3233401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork) 3234401a8d04STejun Heo { 32358930cabaSTejun Heo local_irq_disable(); 3236401a8d04STejun Heo if (del_timer_sync(&dwork->timer)) 323760c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 32388930cabaSTejun Heo local_irq_enable(); 3239401a8d04STejun Heo return flush_work(&dwork->work); 3240401a8d04STejun Heo } 3241401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work); 3242401a8d04STejun Heo 324305f0fe6bSTejun Heo /** 324405f0fe6bSTejun Heo * flush_rcu_work - wait for a rwork to finish executing the last queueing 324505f0fe6bSTejun Heo * @rwork: the rcu work to flush 324605f0fe6bSTejun Heo * 324705f0fe6bSTejun Heo * Return: 324805f0fe6bSTejun Heo * %true if flush_rcu_work() waited for the work to finish execution, 324905f0fe6bSTejun Heo * %false if it was already idle. 325005f0fe6bSTejun Heo */ 325105f0fe6bSTejun Heo bool flush_rcu_work(struct rcu_work *rwork) 325205f0fe6bSTejun Heo { 325305f0fe6bSTejun Heo if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) { 325405f0fe6bSTejun Heo rcu_barrier(); 325505f0fe6bSTejun Heo flush_work(&rwork->work); 325605f0fe6bSTejun Heo return true; 325705f0fe6bSTejun Heo } else { 325805f0fe6bSTejun Heo return flush_work(&rwork->work); 325905f0fe6bSTejun Heo } 326005f0fe6bSTejun Heo } 326105f0fe6bSTejun Heo EXPORT_SYMBOL(flush_rcu_work); 326205f0fe6bSTejun Heo 3263f72b8792SJens Axboe static bool __cancel_work(struct work_struct *work, bool is_dwork) 3264f72b8792SJens Axboe { 3265f72b8792SJens Axboe unsigned long flags; 3266f72b8792SJens Axboe int ret; 3267f72b8792SJens Axboe 3268f72b8792SJens Axboe do { 3269f72b8792SJens Axboe ret = try_to_grab_pending(work, is_dwork, &flags); 3270f72b8792SJens Axboe } while (unlikely(ret == -EAGAIN)); 3271f72b8792SJens Axboe 3272f72b8792SJens Axboe if (unlikely(ret < 0)) 3273f72b8792SJens Axboe return false; 3274f72b8792SJens Axboe 3275f72b8792SJens Axboe set_work_pool_and_clear_pending(work, get_work_pool_id(work)); 3276f72b8792SJens Axboe local_irq_restore(flags); 3277f72b8792SJens Axboe return ret; 3278f72b8792SJens Axboe } 3279f72b8792SJens Axboe 3280401a8d04STejun Heo /** 328157b30ae7STejun Heo * cancel_delayed_work - cancel a delayed work 328257b30ae7STejun Heo * @dwork: delayed_work to cancel 328309383498STejun Heo * 3284d185af30SYacine Belkadi * Kill off a pending delayed_work. 3285d185af30SYacine Belkadi * 3286d185af30SYacine Belkadi * Return: %true if @dwork was pending and canceled; %false if it wasn't 3287d185af30SYacine Belkadi * pending. 3288d185af30SYacine Belkadi * 3289d185af30SYacine Belkadi * Note: 3290d185af30SYacine Belkadi * The work callback function may still be running on return, unless 3291d185af30SYacine Belkadi * it returns %true and the work doesn't re-arm itself. Explicitly flush or 3292d185af30SYacine Belkadi * use cancel_delayed_work_sync() to wait on it. 329309383498STejun Heo * 329457b30ae7STejun Heo * This function is safe to call from any context including IRQ handler. 329509383498STejun Heo */ 329657b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork) 329709383498STejun Heo { 3298f72b8792SJens Axboe return __cancel_work(&dwork->work, true); 329909383498STejun Heo } 330057b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work); 330109383498STejun Heo 330209383498STejun Heo /** 3303401a8d04STejun Heo * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish 3304401a8d04STejun Heo * @dwork: the delayed work cancel 3305401a8d04STejun Heo * 3306401a8d04STejun Heo * This is cancel_work_sync() for delayed works. 3307401a8d04STejun Heo * 3308d185af30SYacine Belkadi * Return: 3309401a8d04STejun Heo * %true if @dwork was pending, %false otherwise. 3310401a8d04STejun Heo */ 3311401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork) 33126e84d644SOleg Nesterov { 331336e227d2STejun Heo return __cancel_work_timer(&dwork->work, true); 33146e84d644SOleg Nesterov } 3315f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync); 33161da177e4SLinus Torvalds 33170fcb78c2SRolf Eike Beer /** 331831ddd871STejun Heo * schedule_on_each_cpu - execute a function synchronously on each online CPU 3319b6136773SAndrew Morton * @func: the function to call 3320b6136773SAndrew Morton * 332131ddd871STejun Heo * schedule_on_each_cpu() executes @func on each online CPU using the 332231ddd871STejun Heo * system workqueue and blocks until all CPUs have completed. 3323b6136773SAndrew Morton * schedule_on_each_cpu() is very slow. 332431ddd871STejun Heo * 3325d185af30SYacine Belkadi * Return: 332631ddd871STejun Heo * 0 on success, -errno on failure. 3327b6136773SAndrew Morton */ 332865f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func) 332915316ba8SChristoph Lameter { 333015316ba8SChristoph Lameter int cpu; 333138f51568SNamhyung Kim struct work_struct __percpu *works; 333215316ba8SChristoph Lameter 3333b6136773SAndrew Morton works = alloc_percpu(struct work_struct); 3334b6136773SAndrew Morton if (!works) 333515316ba8SChristoph Lameter return -ENOMEM; 3336b6136773SAndrew Morton 3337ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 333893981800STejun Heo 333915316ba8SChristoph Lameter for_each_online_cpu(cpu) { 33409bfb1839SIngo Molnar struct work_struct *work = per_cpu_ptr(works, cpu); 33419bfb1839SIngo Molnar 33429bfb1839SIngo Molnar INIT_WORK(work, func); 33438de6d308SOleg Nesterov schedule_work_on(cpu, work); 334415316ba8SChristoph Lameter } 334593981800STejun Heo 334693981800STejun Heo for_each_online_cpu(cpu) 33478616a89aSOleg Nesterov flush_work(per_cpu_ptr(works, cpu)); 334893981800STejun Heo 3349ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 3350b6136773SAndrew Morton free_percpu(works); 335115316ba8SChristoph Lameter return 0; 335215316ba8SChristoph Lameter } 335315316ba8SChristoph Lameter 3354eef6a7d5SAlan Stern /** 33551fa44ecaSJames Bottomley * execute_in_process_context - reliably execute the routine with user context 33561fa44ecaSJames Bottomley * @fn: the function to execute 33571fa44ecaSJames Bottomley * @ew: guaranteed storage for the execute work structure (must 33581fa44ecaSJames Bottomley * be available when the work executes) 33591fa44ecaSJames Bottomley * 33601fa44ecaSJames Bottomley * Executes the function immediately if process context is available, 33611fa44ecaSJames Bottomley * otherwise schedules the function for delayed execution. 33621fa44ecaSJames Bottomley * 3363d185af30SYacine Belkadi * Return: 0 - function was executed 33641fa44ecaSJames Bottomley * 1 - function was scheduled for execution 33651fa44ecaSJames Bottomley */ 336665f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew) 33671fa44ecaSJames Bottomley { 33681fa44ecaSJames Bottomley if (!in_interrupt()) { 336965f27f38SDavid Howells fn(&ew->work); 33701fa44ecaSJames Bottomley return 0; 33711fa44ecaSJames Bottomley } 33721fa44ecaSJames Bottomley 337365f27f38SDavid Howells INIT_WORK(&ew->work, fn); 33741fa44ecaSJames Bottomley schedule_work(&ew->work); 33751fa44ecaSJames Bottomley 33761fa44ecaSJames Bottomley return 1; 33771fa44ecaSJames Bottomley } 33781fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context); 33791fa44ecaSJames Bottomley 33807a4e344cSTejun Heo /** 33817a4e344cSTejun Heo * free_workqueue_attrs - free a workqueue_attrs 33827a4e344cSTejun Heo * @attrs: workqueue_attrs to free 33837a4e344cSTejun Heo * 33847a4e344cSTejun Heo * Undo alloc_workqueue_attrs(). 33857a4e344cSTejun Heo */ 3386513c98d0SDaniel Jordan void free_workqueue_attrs(struct workqueue_attrs *attrs) 33877a4e344cSTejun Heo { 33887a4e344cSTejun Heo if (attrs) { 33897a4e344cSTejun Heo free_cpumask_var(attrs->cpumask); 33907a4e344cSTejun Heo kfree(attrs); 33917a4e344cSTejun Heo } 33927a4e344cSTejun Heo } 33937a4e344cSTejun Heo 33947a4e344cSTejun Heo /** 33957a4e344cSTejun Heo * alloc_workqueue_attrs - allocate a workqueue_attrs 33967a4e344cSTejun Heo * 33977a4e344cSTejun Heo * Allocate a new workqueue_attrs, initialize with default settings and 3398d185af30SYacine Belkadi * return it. 3399d185af30SYacine Belkadi * 3400d185af30SYacine Belkadi * Return: The allocated new workqueue_attr on success. %NULL on failure. 34017a4e344cSTejun Heo */ 3402513c98d0SDaniel Jordan struct workqueue_attrs *alloc_workqueue_attrs(void) 34037a4e344cSTejun Heo { 34047a4e344cSTejun Heo struct workqueue_attrs *attrs; 34057a4e344cSTejun Heo 3406be69d00dSThomas Gleixner attrs = kzalloc(sizeof(*attrs), GFP_KERNEL); 34077a4e344cSTejun Heo if (!attrs) 34087a4e344cSTejun Heo goto fail; 3409be69d00dSThomas Gleixner if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL)) 34107a4e344cSTejun Heo goto fail; 34117a4e344cSTejun Heo 341213e2e556STejun Heo cpumask_copy(attrs->cpumask, cpu_possible_mask); 34137a4e344cSTejun Heo return attrs; 34147a4e344cSTejun Heo fail: 34157a4e344cSTejun Heo free_workqueue_attrs(attrs); 34167a4e344cSTejun Heo return NULL; 34177a4e344cSTejun Heo } 34187a4e344cSTejun Heo 341929c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to, 342029c91e99STejun Heo const struct workqueue_attrs *from) 342129c91e99STejun Heo { 342229c91e99STejun Heo to->nice = from->nice; 342329c91e99STejun Heo cpumask_copy(to->cpumask, from->cpumask); 34242865a8fbSShaohua Li /* 34252865a8fbSShaohua Li * Unlike hash and equality test, this function doesn't ignore 34262865a8fbSShaohua Li * ->no_numa as it is used for both pool and wq attrs. Instead, 34272865a8fbSShaohua Li * get_unbound_pool() explicitly clears ->no_numa after copying. 34282865a8fbSShaohua Li */ 34292865a8fbSShaohua Li to->no_numa = from->no_numa; 343029c91e99STejun Heo } 343129c91e99STejun Heo 343229c91e99STejun Heo /* hash value of the content of @attr */ 343329c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs) 343429c91e99STejun Heo { 343529c91e99STejun Heo u32 hash = 0; 343629c91e99STejun Heo 343729c91e99STejun Heo hash = jhash_1word(attrs->nice, hash); 343813e2e556STejun Heo hash = jhash(cpumask_bits(attrs->cpumask), 343913e2e556STejun Heo BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); 344029c91e99STejun Heo return hash; 344129c91e99STejun Heo } 344229c91e99STejun Heo 344329c91e99STejun Heo /* content equality test */ 344429c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a, 344529c91e99STejun Heo const struct workqueue_attrs *b) 344629c91e99STejun Heo { 344729c91e99STejun Heo if (a->nice != b->nice) 344829c91e99STejun Heo return false; 344929c91e99STejun Heo if (!cpumask_equal(a->cpumask, b->cpumask)) 345029c91e99STejun Heo return false; 345129c91e99STejun Heo return true; 345229c91e99STejun Heo } 345329c91e99STejun Heo 34547a4e344cSTejun Heo /** 34557a4e344cSTejun Heo * init_worker_pool - initialize a newly zalloc'd worker_pool 34567a4e344cSTejun Heo * @pool: worker_pool to initialize 34577a4e344cSTejun Heo * 3458402dd89dSShailendra Verma * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs. 3459d185af30SYacine Belkadi * 3460d185af30SYacine Belkadi * Return: 0 on success, -errno on failure. Even on failure, all fields 346129c91e99STejun Heo * inside @pool proper are initialized and put_unbound_pool() can be called 346229c91e99STejun Heo * on @pool safely to release it. 34637a4e344cSTejun Heo */ 34647a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool) 34654e1a1f9aSTejun Heo { 3466a9b8a985SSebastian Andrzej Siewior raw_spin_lock_init(&pool->lock); 346729c91e99STejun Heo pool->id = -1; 346829c91e99STejun Heo pool->cpu = -1; 3469f3f90ad4STejun Heo pool->node = NUMA_NO_NODE; 34704e1a1f9aSTejun Heo pool->flags |= POOL_DISASSOCIATED; 347182607adcSTejun Heo pool->watchdog_ts = jiffies; 34724e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->worklist); 34734e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->idle_list); 34744e1a1f9aSTejun Heo hash_init(pool->busy_hash); 34754e1a1f9aSTejun Heo 347632a6c723SKees Cook timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE); 34774e1a1f9aSTejun Heo 347832a6c723SKees Cook timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0); 34794e1a1f9aSTejun Heo 3480da028469SLai Jiangshan INIT_LIST_HEAD(&pool->workers); 34817a4e344cSTejun Heo 34827cda9aaeSLai Jiangshan ida_init(&pool->worker_ida); 348329c91e99STejun Heo INIT_HLIST_NODE(&pool->hash_node); 348429c91e99STejun Heo pool->refcnt = 1; 348529c91e99STejun Heo 348629c91e99STejun Heo /* shouldn't fail above this point */ 3487be69d00dSThomas Gleixner pool->attrs = alloc_workqueue_attrs(); 34887a4e344cSTejun Heo if (!pool->attrs) 34897a4e344cSTejun Heo return -ENOMEM; 34907a4e344cSTejun Heo return 0; 34914e1a1f9aSTejun Heo } 34924e1a1f9aSTejun Heo 3493669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP 3494669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq) 3495669de8bdSBart Van Assche { 3496669de8bdSBart Van Assche char *lock_name; 3497669de8bdSBart Van Assche 3498669de8bdSBart Van Assche lockdep_register_key(&wq->key); 3499669de8bdSBart Van Assche lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name); 3500669de8bdSBart Van Assche if (!lock_name) 3501669de8bdSBart Van Assche lock_name = wq->name; 350269a106c0SQian Cai 350369a106c0SQian Cai wq->lock_name = lock_name; 3504669de8bdSBart Van Assche lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0); 3505669de8bdSBart Van Assche } 3506669de8bdSBart Van Assche 3507669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq) 3508669de8bdSBart Van Assche { 3509669de8bdSBart Van Assche lockdep_unregister_key(&wq->key); 3510669de8bdSBart Van Assche } 3511669de8bdSBart Van Assche 3512669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq) 3513669de8bdSBart Van Assche { 3514669de8bdSBart Van Assche if (wq->lock_name != wq->name) 3515669de8bdSBart Van Assche kfree(wq->lock_name); 3516669de8bdSBart Van Assche } 3517669de8bdSBart Van Assche #else 3518669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq) 3519669de8bdSBart Van Assche { 3520669de8bdSBart Van Assche } 3521669de8bdSBart Van Assche 3522669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq) 3523669de8bdSBart Van Assche { 3524669de8bdSBart Van Assche } 3525669de8bdSBart Van Assche 3526669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq) 3527669de8bdSBart Van Assche { 3528669de8bdSBart Van Assche } 3529669de8bdSBart Van Assche #endif 3530669de8bdSBart Van Assche 3531e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu) 3532e2dca7adSTejun Heo { 3533e2dca7adSTejun Heo struct workqueue_struct *wq = 3534e2dca7adSTejun Heo container_of(rcu, struct workqueue_struct, rcu); 3535e2dca7adSTejun Heo 3536669de8bdSBart Van Assche wq_free_lockdep(wq); 3537669de8bdSBart Van Assche 3538e2dca7adSTejun Heo if (!(wq->flags & WQ_UNBOUND)) 3539e2dca7adSTejun Heo free_percpu(wq->cpu_pwqs); 3540e2dca7adSTejun Heo else 3541e2dca7adSTejun Heo free_workqueue_attrs(wq->unbound_attrs); 3542e2dca7adSTejun Heo 3543e2dca7adSTejun Heo kfree(wq); 3544e2dca7adSTejun Heo } 3545e2dca7adSTejun Heo 354629c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu) 354729c91e99STejun Heo { 354829c91e99STejun Heo struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu); 354929c91e99STejun Heo 35507cda9aaeSLai Jiangshan ida_destroy(&pool->worker_ida); 355129c91e99STejun Heo free_workqueue_attrs(pool->attrs); 355229c91e99STejun Heo kfree(pool); 355329c91e99STejun Heo } 355429c91e99STejun Heo 3555d8bb65abSSebastian Andrzej Siewior /* This returns with the lock held on success (pool manager is inactive). */ 3556d8bb65abSSebastian Andrzej Siewior static bool wq_manager_inactive(struct worker_pool *pool) 3557d8bb65abSSebastian Andrzej Siewior { 3558a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 3559d8bb65abSSebastian Andrzej Siewior 3560d8bb65abSSebastian Andrzej Siewior if (pool->flags & POOL_MANAGER_ACTIVE) { 3561a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 3562d8bb65abSSebastian Andrzej Siewior return false; 3563d8bb65abSSebastian Andrzej Siewior } 3564d8bb65abSSebastian Andrzej Siewior return true; 3565d8bb65abSSebastian Andrzej Siewior } 3566d8bb65abSSebastian Andrzej Siewior 356729c91e99STejun Heo /** 356829c91e99STejun Heo * put_unbound_pool - put a worker_pool 356929c91e99STejun Heo * @pool: worker_pool to put 357029c91e99STejun Heo * 357124acfb71SThomas Gleixner * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU 3572c5aa87bbSTejun Heo * safe manner. get_unbound_pool() calls this function on its failure path 3573c5aa87bbSTejun Heo * and this function should be able to release pools which went through, 3574c5aa87bbSTejun Heo * successfully or not, init_worker_pool(). 3575a892caccSTejun Heo * 3576a892caccSTejun Heo * Should be called with wq_pool_mutex held. 357729c91e99STejun Heo */ 357829c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool) 357929c91e99STejun Heo { 358060f5a4bcSLai Jiangshan DECLARE_COMPLETION_ONSTACK(detach_completion); 358129c91e99STejun Heo struct worker *worker; 358229c91e99STejun Heo 3583a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 3584a892caccSTejun Heo 3585a892caccSTejun Heo if (--pool->refcnt) 358629c91e99STejun Heo return; 358729c91e99STejun Heo 358829c91e99STejun Heo /* sanity checks */ 358961d0fbb4SLai Jiangshan if (WARN_ON(!(pool->cpu < 0)) || 3590a892caccSTejun Heo WARN_ON(!list_empty(&pool->worklist))) 359129c91e99STejun Heo return; 359229c91e99STejun Heo 359329c91e99STejun Heo /* release id and unhash */ 359429c91e99STejun Heo if (pool->id >= 0) 359529c91e99STejun Heo idr_remove(&worker_pool_idr, pool->id); 359629c91e99STejun Heo hash_del(&pool->hash_node); 359729c91e99STejun Heo 3598c5aa87bbSTejun Heo /* 3599692b4825STejun Heo * Become the manager and destroy all workers. This prevents 3600692b4825STejun Heo * @pool's workers from blocking on attach_mutex. We're the last 3601692b4825STejun Heo * manager and @pool gets freed with the flag set. 3602d8bb65abSSebastian Andrzej Siewior * Because of how wq_manager_inactive() works, we will hold the 3603d8bb65abSSebastian Andrzej Siewior * spinlock after a successful wait. 3604c5aa87bbSTejun Heo */ 3605d8bb65abSSebastian Andrzej Siewior rcuwait_wait_event(&manager_wait, wq_manager_inactive(pool), 3606d8bb65abSSebastian Andrzej Siewior TASK_UNINTERRUPTIBLE); 3607692b4825STejun Heo pool->flags |= POOL_MANAGER_ACTIVE; 3608692b4825STejun Heo 36091037de36SLai Jiangshan while ((worker = first_idle_worker(pool))) 361029c91e99STejun Heo destroy_worker(worker); 361129c91e99STejun Heo WARN_ON(pool->nr_workers || pool->nr_idle); 3612a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 361360f5a4bcSLai Jiangshan 36141258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 3615da028469SLai Jiangshan if (!list_empty(&pool->workers)) 361660f5a4bcSLai Jiangshan pool->detach_completion = &detach_completion; 36171258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 361860f5a4bcSLai Jiangshan 361960f5a4bcSLai Jiangshan if (pool->detach_completion) 362060f5a4bcSLai Jiangshan wait_for_completion(pool->detach_completion); 362160f5a4bcSLai Jiangshan 362229c91e99STejun Heo /* shut down the timers */ 362329c91e99STejun Heo del_timer_sync(&pool->idle_timer); 362429c91e99STejun Heo del_timer_sync(&pool->mayday_timer); 362529c91e99STejun Heo 362624acfb71SThomas Gleixner /* RCU protected to allow dereferences from get_work_pool() */ 362725b00775SPaul E. McKenney call_rcu(&pool->rcu, rcu_free_pool); 362829c91e99STejun Heo } 362929c91e99STejun Heo 363029c91e99STejun Heo /** 363129c91e99STejun Heo * get_unbound_pool - get a worker_pool with the specified attributes 363229c91e99STejun Heo * @attrs: the attributes of the worker_pool to get 363329c91e99STejun Heo * 363429c91e99STejun Heo * Obtain a worker_pool which has the same attributes as @attrs, bump the 363529c91e99STejun Heo * reference count and return it. If there already is a matching 363629c91e99STejun Heo * worker_pool, it will be used; otherwise, this function attempts to 3637d185af30SYacine Belkadi * create a new one. 3638a892caccSTejun Heo * 3639a892caccSTejun Heo * Should be called with wq_pool_mutex held. 3640d185af30SYacine Belkadi * 3641d185af30SYacine Belkadi * Return: On success, a worker_pool with the same attributes as @attrs. 3642d185af30SYacine Belkadi * On failure, %NULL. 364329c91e99STejun Heo */ 364429c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs) 364529c91e99STejun Heo { 364629c91e99STejun Heo u32 hash = wqattrs_hash(attrs); 364729c91e99STejun Heo struct worker_pool *pool; 3648f3f90ad4STejun Heo int node; 3649e2273584SXunlei Pang int target_node = NUMA_NO_NODE; 365029c91e99STejun Heo 3651a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 365229c91e99STejun Heo 365329c91e99STejun Heo /* do we already have a matching pool? */ 365429c91e99STejun Heo hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) { 365529c91e99STejun Heo if (wqattrs_equal(pool->attrs, attrs)) { 365629c91e99STejun Heo pool->refcnt++; 36573fb1823cSLai Jiangshan return pool; 365829c91e99STejun Heo } 365929c91e99STejun Heo } 366029c91e99STejun Heo 3661e2273584SXunlei Pang /* if cpumask is contained inside a NUMA node, we belong to that node */ 3662e2273584SXunlei Pang if (wq_numa_enabled) { 3663e2273584SXunlei Pang for_each_node(node) { 3664e2273584SXunlei Pang if (cpumask_subset(attrs->cpumask, 3665e2273584SXunlei Pang wq_numa_possible_cpumask[node])) { 3666e2273584SXunlei Pang target_node = node; 3667e2273584SXunlei Pang break; 3668e2273584SXunlei Pang } 3669e2273584SXunlei Pang } 3670e2273584SXunlei Pang } 3671e2273584SXunlei Pang 367229c91e99STejun Heo /* nope, create a new one */ 3673e2273584SXunlei Pang pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, target_node); 367429c91e99STejun Heo if (!pool || init_worker_pool(pool) < 0) 367529c91e99STejun Heo goto fail; 367629c91e99STejun Heo 36778864b4e5STejun Heo lockdep_set_subclass(&pool->lock, 1); /* see put_pwq() */ 367829c91e99STejun Heo copy_workqueue_attrs(pool->attrs, attrs); 3679e2273584SXunlei Pang pool->node = target_node; 368029c91e99STejun Heo 36812865a8fbSShaohua Li /* 36822865a8fbSShaohua Li * no_numa isn't a worker_pool attribute, always clear it. See 36832865a8fbSShaohua Li * 'struct workqueue_attrs' comments for detail. 36842865a8fbSShaohua Li */ 36852865a8fbSShaohua Li pool->attrs->no_numa = false; 36862865a8fbSShaohua Li 368729c91e99STejun Heo if (worker_pool_assign_id(pool) < 0) 368829c91e99STejun Heo goto fail; 368929c91e99STejun Heo 369029c91e99STejun Heo /* create and start the initial worker */ 36913347fa09STejun Heo if (wq_online && !create_worker(pool)) 369229c91e99STejun Heo goto fail; 369329c91e99STejun Heo 369429c91e99STejun Heo /* install */ 369529c91e99STejun Heo hash_add(unbound_pool_hash, &pool->hash_node, hash); 36963fb1823cSLai Jiangshan 369729c91e99STejun Heo return pool; 369829c91e99STejun Heo fail: 369929c91e99STejun Heo if (pool) 370029c91e99STejun Heo put_unbound_pool(pool); 370129c91e99STejun Heo return NULL; 370229c91e99STejun Heo } 370329c91e99STejun Heo 37048864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu) 37058864b4e5STejun Heo { 37068864b4e5STejun Heo kmem_cache_free(pwq_cache, 37078864b4e5STejun Heo container_of(rcu, struct pool_workqueue, rcu)); 37088864b4e5STejun Heo } 37098864b4e5STejun Heo 37108864b4e5STejun Heo /* 37118864b4e5STejun Heo * Scheduled on system_wq by put_pwq() when an unbound pwq hits zero refcnt 37128864b4e5STejun Heo * and needs to be destroyed. 37138864b4e5STejun Heo */ 37148864b4e5STejun Heo static void pwq_unbound_release_workfn(struct work_struct *work) 37158864b4e5STejun Heo { 37168864b4e5STejun Heo struct pool_workqueue *pwq = container_of(work, struct pool_workqueue, 37178864b4e5STejun Heo unbound_release_work); 37188864b4e5STejun Heo struct workqueue_struct *wq = pwq->wq; 37198864b4e5STejun Heo struct worker_pool *pool = pwq->pool; 3720b42b0bddSYang Yingliang bool is_last = false; 37218864b4e5STejun Heo 3722b42b0bddSYang Yingliang /* 3723b42b0bddSYang Yingliang * when @pwq is not linked, it doesn't hold any reference to the 3724b42b0bddSYang Yingliang * @wq, and @wq is invalid to access. 3725b42b0bddSYang Yingliang */ 3726b42b0bddSYang Yingliang if (!list_empty(&pwq->pwqs_node)) { 37278864b4e5STejun Heo if (WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND))) 37288864b4e5STejun Heo return; 37298864b4e5STejun Heo 37303c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 37318864b4e5STejun Heo list_del_rcu(&pwq->pwqs_node); 3732bc0caf09STejun Heo is_last = list_empty(&wq->pwqs); 37333c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 3734b42b0bddSYang Yingliang } 37358864b4e5STejun Heo 3736a892caccSTejun Heo mutex_lock(&wq_pool_mutex); 37378864b4e5STejun Heo put_unbound_pool(pool); 3738a892caccSTejun Heo mutex_unlock(&wq_pool_mutex); 3739a892caccSTejun Heo 374025b00775SPaul E. McKenney call_rcu(&pwq->rcu, rcu_free_pwq); 37418864b4e5STejun Heo 37428864b4e5STejun Heo /* 37438864b4e5STejun Heo * If we're the last pwq going away, @wq is already dead and no one 3744e2dca7adSTejun Heo * is gonna access it anymore. Schedule RCU free. 37458864b4e5STejun Heo */ 3746669de8bdSBart Van Assche if (is_last) { 3747669de8bdSBart Van Assche wq_unregister_lockdep(wq); 374825b00775SPaul E. McKenney call_rcu(&wq->rcu, rcu_free_wq); 37496029a918STejun Heo } 3750669de8bdSBart Van Assche } 37518864b4e5STejun Heo 37520fbd95aaSTejun Heo /** 3753699ce097STejun Heo * pwq_adjust_max_active - update a pwq's max_active to the current setting 37540fbd95aaSTejun Heo * @pwq: target pool_workqueue 37550fbd95aaSTejun Heo * 3756699ce097STejun Heo * If @pwq isn't freezing, set @pwq->max_active to the associated 3757f97a4a1aSLai Jiangshan * workqueue's saved_max_active and activate inactive work items 3758699ce097STejun Heo * accordingly. If @pwq is freezing, clear @pwq->max_active to zero. 37590fbd95aaSTejun Heo */ 3760699ce097STejun Heo static void pwq_adjust_max_active(struct pool_workqueue *pwq) 37610fbd95aaSTejun Heo { 3762699ce097STejun Heo struct workqueue_struct *wq = pwq->wq; 3763699ce097STejun Heo bool freezable = wq->flags & WQ_FREEZABLE; 37643347fa09STejun Heo unsigned long flags; 3765699ce097STejun Heo 3766699ce097STejun Heo /* for @wq->saved_max_active */ 3767a357fc03SLai Jiangshan lockdep_assert_held(&wq->mutex); 3768699ce097STejun Heo 3769699ce097STejun Heo /* fast exit for non-freezable wqs */ 3770699ce097STejun Heo if (!freezable && pwq->max_active == wq->saved_max_active) 3771699ce097STejun Heo return; 3772699ce097STejun Heo 37733347fa09STejun Heo /* this function can be called during early boot w/ irq disabled */ 3774a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irqsave(&pwq->pool->lock, flags); 3775699ce097STejun Heo 377674b414eaSLai Jiangshan /* 377774b414eaSLai Jiangshan * During [un]freezing, the caller is responsible for ensuring that 377874b414eaSLai Jiangshan * this function is called at least once after @workqueue_freezing 377974b414eaSLai Jiangshan * is updated and visible. 378074b414eaSLai Jiangshan */ 378174b414eaSLai Jiangshan if (!freezable || !workqueue_freezing) { 378201341fbdSYunfeng Ye bool kick = false; 378301341fbdSYunfeng Ye 3784699ce097STejun Heo pwq->max_active = wq->saved_max_active; 37850fbd95aaSTejun Heo 3786f97a4a1aSLai Jiangshan while (!list_empty(&pwq->inactive_works) && 378701341fbdSYunfeng Ye pwq->nr_active < pwq->max_active) { 3788f97a4a1aSLai Jiangshan pwq_activate_first_inactive(pwq); 378901341fbdSYunfeng Ye kick = true; 379001341fbdSYunfeng Ye } 3791951a078aSLai Jiangshan 3792951a078aSLai Jiangshan /* 3793951a078aSLai Jiangshan * Need to kick a worker after thawed or an unbound wq's 379401341fbdSYunfeng Ye * max_active is bumped. In realtime scenarios, always kicking a 379501341fbdSYunfeng Ye * worker will cause interference on the isolated cpu cores, so 379601341fbdSYunfeng Ye * let's kick iff work items were activated. 3797951a078aSLai Jiangshan */ 379801341fbdSYunfeng Ye if (kick) 3799951a078aSLai Jiangshan wake_up_worker(pwq->pool); 3800699ce097STejun Heo } else { 3801699ce097STejun Heo pwq->max_active = 0; 3802699ce097STejun Heo } 3803699ce097STejun Heo 3804a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irqrestore(&pwq->pool->lock, flags); 38050fbd95aaSTejun Heo } 38060fbd95aaSTejun Heo 380767dc8325SCai Huoqing /* initialize newly allocated @pwq which is associated with @wq and @pool */ 3808f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq, 3809f147f29eSTejun Heo struct worker_pool *pool) 3810d2c1d404STejun Heo { 3811d2c1d404STejun Heo BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK); 3812d2c1d404STejun Heo 3813e50aba9aSTejun Heo memset(pwq, 0, sizeof(*pwq)); 3814e50aba9aSTejun Heo 3815d2c1d404STejun Heo pwq->pool = pool; 3816d2c1d404STejun Heo pwq->wq = wq; 3817d2c1d404STejun Heo pwq->flush_color = -1; 38188864b4e5STejun Heo pwq->refcnt = 1; 3819f97a4a1aSLai Jiangshan INIT_LIST_HEAD(&pwq->inactive_works); 38201befcf30STejun Heo INIT_LIST_HEAD(&pwq->pwqs_node); 3821d2c1d404STejun Heo INIT_LIST_HEAD(&pwq->mayday_node); 38228864b4e5STejun Heo INIT_WORK(&pwq->unbound_release_work, pwq_unbound_release_workfn); 3823f147f29eSTejun Heo } 3824d2c1d404STejun Heo 3825f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */ 38261befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq) 3827f147f29eSTejun Heo { 3828f147f29eSTejun Heo struct workqueue_struct *wq = pwq->wq; 3829f147f29eSTejun Heo 3830f147f29eSTejun Heo lockdep_assert_held(&wq->mutex); 383175ccf595STejun Heo 38321befcf30STejun Heo /* may be called multiple times, ignore if already linked */ 38331befcf30STejun Heo if (!list_empty(&pwq->pwqs_node)) 38341befcf30STejun Heo return; 38351befcf30STejun Heo 383629b1cb41SLai Jiangshan /* set the matching work_color */ 383775ccf595STejun Heo pwq->work_color = wq->work_color; 3838983ca25eSTejun Heo 3839983ca25eSTejun Heo /* sync max_active to the current setting */ 3840983ca25eSTejun Heo pwq_adjust_max_active(pwq); 3841983ca25eSTejun Heo 3842983ca25eSTejun Heo /* link in @pwq */ 38439e8cd2f5STejun Heo list_add_rcu(&pwq->pwqs_node, &wq->pwqs); 3844df2d5ae4STejun Heo } 38456029a918STejun Heo 3846f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */ 3847f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq, 3848f147f29eSTejun Heo const struct workqueue_attrs *attrs) 3849f147f29eSTejun Heo { 3850f147f29eSTejun Heo struct worker_pool *pool; 3851f147f29eSTejun Heo struct pool_workqueue *pwq; 3852f147f29eSTejun Heo 3853f147f29eSTejun Heo lockdep_assert_held(&wq_pool_mutex); 3854f147f29eSTejun Heo 3855f147f29eSTejun Heo pool = get_unbound_pool(attrs); 3856f147f29eSTejun Heo if (!pool) 3857f147f29eSTejun Heo return NULL; 3858f147f29eSTejun Heo 3859e50aba9aSTejun Heo pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node); 3860f147f29eSTejun Heo if (!pwq) { 3861f147f29eSTejun Heo put_unbound_pool(pool); 3862f147f29eSTejun Heo return NULL; 3863f147f29eSTejun Heo } 3864f147f29eSTejun Heo 3865f147f29eSTejun Heo init_pwq(pwq, wq, pool); 3866f147f29eSTejun Heo return pwq; 3867d2c1d404STejun Heo } 3868d2c1d404STejun Heo 38694c16bd32STejun Heo /** 387030186c6fSGong Zhaogang * wq_calc_node_cpumask - calculate a wq_attrs' cpumask for the specified node 3871042f7df1SLai Jiangshan * @attrs: the wq_attrs of the default pwq of the target workqueue 38724c16bd32STejun Heo * @node: the target NUMA node 38734c16bd32STejun Heo * @cpu_going_down: if >= 0, the CPU to consider as offline 38744c16bd32STejun Heo * @cpumask: outarg, the resulting cpumask 38754c16bd32STejun Heo * 38764c16bd32STejun Heo * Calculate the cpumask a workqueue with @attrs should use on @node. If 38774c16bd32STejun Heo * @cpu_going_down is >= 0, that cpu is considered offline during 3878d185af30SYacine Belkadi * calculation. The result is stored in @cpumask. 38794c16bd32STejun Heo * 38804c16bd32STejun Heo * If NUMA affinity is not enabled, @attrs->cpumask is always used. If 38814c16bd32STejun Heo * enabled and @node has online CPUs requested by @attrs, the returned 38824c16bd32STejun Heo * cpumask is the intersection of the possible CPUs of @node and 38834c16bd32STejun Heo * @attrs->cpumask. 38844c16bd32STejun Heo * 38854c16bd32STejun Heo * The caller is responsible for ensuring that the cpumask of @node stays 38864c16bd32STejun Heo * stable. 3887d185af30SYacine Belkadi * 3888d185af30SYacine Belkadi * Return: %true if the resulting @cpumask is different from @attrs->cpumask, 3889d185af30SYacine Belkadi * %false if equal. 38904c16bd32STejun Heo */ 38914c16bd32STejun Heo static bool wq_calc_node_cpumask(const struct workqueue_attrs *attrs, int node, 38924c16bd32STejun Heo int cpu_going_down, cpumask_t *cpumask) 38934c16bd32STejun Heo { 3894d55262c4STejun Heo if (!wq_numa_enabled || attrs->no_numa) 38954c16bd32STejun Heo goto use_dfl; 38964c16bd32STejun Heo 38974c16bd32STejun Heo /* does @node have any online CPUs @attrs wants? */ 38984c16bd32STejun Heo cpumask_and(cpumask, cpumask_of_node(node), attrs->cpumask); 38994c16bd32STejun Heo if (cpu_going_down >= 0) 39004c16bd32STejun Heo cpumask_clear_cpu(cpu_going_down, cpumask); 39014c16bd32STejun Heo 39024c16bd32STejun Heo if (cpumask_empty(cpumask)) 39034c16bd32STejun Heo goto use_dfl; 39044c16bd32STejun Heo 39054c16bd32STejun Heo /* yeap, return possible CPUs in @node that @attrs wants */ 39064c16bd32STejun Heo cpumask_and(cpumask, attrs->cpumask, wq_numa_possible_cpumask[node]); 39071ad0f0a7SMichael Bringmann 39081ad0f0a7SMichael Bringmann if (cpumask_empty(cpumask)) { 39091ad0f0a7SMichael Bringmann pr_warn_once("WARNING: workqueue cpumask: online intersect > " 39101ad0f0a7SMichael Bringmann "possible intersect\n"); 39111ad0f0a7SMichael Bringmann return false; 39121ad0f0a7SMichael Bringmann } 39131ad0f0a7SMichael Bringmann 39144c16bd32STejun Heo return !cpumask_equal(cpumask, attrs->cpumask); 39154c16bd32STejun Heo 39164c16bd32STejun Heo use_dfl: 39174c16bd32STejun Heo cpumask_copy(cpumask, attrs->cpumask); 39184c16bd32STejun Heo return false; 39194c16bd32STejun Heo } 39204c16bd32STejun Heo 39211befcf30STejun Heo /* install @pwq into @wq's numa_pwq_tbl[] for @node and return the old pwq */ 39221befcf30STejun Heo static struct pool_workqueue *numa_pwq_tbl_install(struct workqueue_struct *wq, 39231befcf30STejun Heo int node, 39241befcf30STejun Heo struct pool_workqueue *pwq) 39251befcf30STejun Heo { 39261befcf30STejun Heo struct pool_workqueue *old_pwq; 39271befcf30STejun Heo 39285b95e1afSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 39291befcf30STejun Heo lockdep_assert_held(&wq->mutex); 39301befcf30STejun Heo 39311befcf30STejun Heo /* link_pwq() can handle duplicate calls */ 39321befcf30STejun Heo link_pwq(pwq); 39331befcf30STejun Heo 39341befcf30STejun Heo old_pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]); 39351befcf30STejun Heo rcu_assign_pointer(wq->numa_pwq_tbl[node], pwq); 39361befcf30STejun Heo return old_pwq; 39371befcf30STejun Heo } 39381befcf30STejun Heo 39392d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */ 39402d5f0764SLai Jiangshan struct apply_wqattrs_ctx { 39412d5f0764SLai Jiangshan struct workqueue_struct *wq; /* target workqueue */ 39422d5f0764SLai Jiangshan struct workqueue_attrs *attrs; /* attrs to apply */ 3943042f7df1SLai Jiangshan struct list_head list; /* queued for batching commit */ 39442d5f0764SLai Jiangshan struct pool_workqueue *dfl_pwq; 39452d5f0764SLai Jiangshan struct pool_workqueue *pwq_tbl[]; 39462d5f0764SLai Jiangshan }; 39472d5f0764SLai Jiangshan 39482d5f0764SLai Jiangshan /* free the resources after success or abort */ 39492d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx) 39502d5f0764SLai Jiangshan { 39512d5f0764SLai Jiangshan if (ctx) { 39522d5f0764SLai Jiangshan int node; 39532d5f0764SLai Jiangshan 39542d5f0764SLai Jiangshan for_each_node(node) 39552d5f0764SLai Jiangshan put_pwq_unlocked(ctx->pwq_tbl[node]); 39562d5f0764SLai Jiangshan put_pwq_unlocked(ctx->dfl_pwq); 39572d5f0764SLai Jiangshan 39582d5f0764SLai Jiangshan free_workqueue_attrs(ctx->attrs); 39592d5f0764SLai Jiangshan 39602d5f0764SLai Jiangshan kfree(ctx); 39612d5f0764SLai Jiangshan } 39622d5f0764SLai Jiangshan } 39632d5f0764SLai Jiangshan 39642d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */ 39652d5f0764SLai Jiangshan static struct apply_wqattrs_ctx * 39662d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq, 39672d5f0764SLai Jiangshan const struct workqueue_attrs *attrs) 39682d5f0764SLai Jiangshan { 39692d5f0764SLai Jiangshan struct apply_wqattrs_ctx *ctx; 39702d5f0764SLai Jiangshan struct workqueue_attrs *new_attrs, *tmp_attrs; 39712d5f0764SLai Jiangshan int node; 39722d5f0764SLai Jiangshan 39732d5f0764SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 39742d5f0764SLai Jiangshan 3975acafe7e3SKees Cook ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_node_ids), GFP_KERNEL); 39762d5f0764SLai Jiangshan 3977be69d00dSThomas Gleixner new_attrs = alloc_workqueue_attrs(); 3978be69d00dSThomas Gleixner tmp_attrs = alloc_workqueue_attrs(); 39792d5f0764SLai Jiangshan if (!ctx || !new_attrs || !tmp_attrs) 39802d5f0764SLai Jiangshan goto out_free; 39812d5f0764SLai Jiangshan 3982042f7df1SLai Jiangshan /* 3983042f7df1SLai Jiangshan * Calculate the attrs of the default pwq. 3984042f7df1SLai Jiangshan * If the user configured cpumask doesn't overlap with the 3985042f7df1SLai Jiangshan * wq_unbound_cpumask, we fallback to the wq_unbound_cpumask. 3986042f7df1SLai Jiangshan */ 39872d5f0764SLai Jiangshan copy_workqueue_attrs(new_attrs, attrs); 3988b05a7928SFrederic Weisbecker cpumask_and(new_attrs->cpumask, new_attrs->cpumask, wq_unbound_cpumask); 3989042f7df1SLai Jiangshan if (unlikely(cpumask_empty(new_attrs->cpumask))) 3990042f7df1SLai Jiangshan cpumask_copy(new_attrs->cpumask, wq_unbound_cpumask); 39912d5f0764SLai Jiangshan 39922d5f0764SLai Jiangshan /* 39932d5f0764SLai Jiangshan * We may create multiple pwqs with differing cpumasks. Make a 39942d5f0764SLai Jiangshan * copy of @new_attrs which will be modified and used to obtain 39952d5f0764SLai Jiangshan * pools. 39962d5f0764SLai Jiangshan */ 39972d5f0764SLai Jiangshan copy_workqueue_attrs(tmp_attrs, new_attrs); 39982d5f0764SLai Jiangshan 39992d5f0764SLai Jiangshan /* 40002d5f0764SLai Jiangshan * If something goes wrong during CPU up/down, we'll fall back to 40012d5f0764SLai Jiangshan * the default pwq covering whole @attrs->cpumask. Always create 40022d5f0764SLai Jiangshan * it even if we don't use it immediately. 40032d5f0764SLai Jiangshan */ 40042d5f0764SLai Jiangshan ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs); 40052d5f0764SLai Jiangshan if (!ctx->dfl_pwq) 40062d5f0764SLai Jiangshan goto out_free; 40072d5f0764SLai Jiangshan 40082d5f0764SLai Jiangshan for_each_node(node) { 4009042f7df1SLai Jiangshan if (wq_calc_node_cpumask(new_attrs, node, -1, tmp_attrs->cpumask)) { 40102d5f0764SLai Jiangshan ctx->pwq_tbl[node] = alloc_unbound_pwq(wq, tmp_attrs); 40112d5f0764SLai Jiangshan if (!ctx->pwq_tbl[node]) 40122d5f0764SLai Jiangshan goto out_free; 40132d5f0764SLai Jiangshan } else { 40142d5f0764SLai Jiangshan ctx->dfl_pwq->refcnt++; 40152d5f0764SLai Jiangshan ctx->pwq_tbl[node] = ctx->dfl_pwq; 40162d5f0764SLai Jiangshan } 40172d5f0764SLai Jiangshan } 40182d5f0764SLai Jiangshan 4019042f7df1SLai Jiangshan /* save the user configured attrs and sanitize it. */ 4020042f7df1SLai Jiangshan copy_workqueue_attrs(new_attrs, attrs); 4021042f7df1SLai Jiangshan cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask); 40222d5f0764SLai Jiangshan ctx->attrs = new_attrs; 4023042f7df1SLai Jiangshan 40242d5f0764SLai Jiangshan ctx->wq = wq; 40252d5f0764SLai Jiangshan free_workqueue_attrs(tmp_attrs); 40262d5f0764SLai Jiangshan return ctx; 40272d5f0764SLai Jiangshan 40282d5f0764SLai Jiangshan out_free: 40292d5f0764SLai Jiangshan free_workqueue_attrs(tmp_attrs); 40302d5f0764SLai Jiangshan free_workqueue_attrs(new_attrs); 40312d5f0764SLai Jiangshan apply_wqattrs_cleanup(ctx); 40322d5f0764SLai Jiangshan return NULL; 40332d5f0764SLai Jiangshan } 40342d5f0764SLai Jiangshan 40352d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */ 40362d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx) 40372d5f0764SLai Jiangshan { 40382d5f0764SLai Jiangshan int node; 40392d5f0764SLai Jiangshan 40402d5f0764SLai Jiangshan /* all pwqs have been created successfully, let's install'em */ 40412d5f0764SLai Jiangshan mutex_lock(&ctx->wq->mutex); 40422d5f0764SLai Jiangshan 40432d5f0764SLai Jiangshan copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs); 40442d5f0764SLai Jiangshan 40452d5f0764SLai Jiangshan /* save the previous pwq and install the new one */ 40462d5f0764SLai Jiangshan for_each_node(node) 40472d5f0764SLai Jiangshan ctx->pwq_tbl[node] = numa_pwq_tbl_install(ctx->wq, node, 40482d5f0764SLai Jiangshan ctx->pwq_tbl[node]); 40492d5f0764SLai Jiangshan 40502d5f0764SLai Jiangshan /* @dfl_pwq might not have been used, ensure it's linked */ 40512d5f0764SLai Jiangshan link_pwq(ctx->dfl_pwq); 40522d5f0764SLai Jiangshan swap(ctx->wq->dfl_pwq, ctx->dfl_pwq); 40532d5f0764SLai Jiangshan 40542d5f0764SLai Jiangshan mutex_unlock(&ctx->wq->mutex); 40552d5f0764SLai Jiangshan } 40562d5f0764SLai Jiangshan 4057a0111cf6SLai Jiangshan static void apply_wqattrs_lock(void) 4058a0111cf6SLai Jiangshan { 4059a0111cf6SLai Jiangshan /* CPUs should stay stable across pwq creations and installations */ 4060ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 4061a0111cf6SLai Jiangshan mutex_lock(&wq_pool_mutex); 4062a0111cf6SLai Jiangshan } 4063a0111cf6SLai Jiangshan 4064a0111cf6SLai Jiangshan static void apply_wqattrs_unlock(void) 4065a0111cf6SLai Jiangshan { 4066a0111cf6SLai Jiangshan mutex_unlock(&wq_pool_mutex); 4067ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 4068a0111cf6SLai Jiangshan } 4069a0111cf6SLai Jiangshan 4070a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq, 4071a0111cf6SLai Jiangshan const struct workqueue_attrs *attrs) 4072a0111cf6SLai Jiangshan { 4073a0111cf6SLai Jiangshan struct apply_wqattrs_ctx *ctx; 4074a0111cf6SLai Jiangshan 4075a0111cf6SLai Jiangshan /* only unbound workqueues can change attributes */ 4076a0111cf6SLai Jiangshan if (WARN_ON(!(wq->flags & WQ_UNBOUND))) 4077a0111cf6SLai Jiangshan return -EINVAL; 4078a0111cf6SLai Jiangshan 4079a0111cf6SLai Jiangshan /* creating multiple pwqs breaks ordering guarantee */ 40800a94efb5STejun Heo if (!list_empty(&wq->pwqs)) { 40810a94efb5STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) 4082a0111cf6SLai Jiangshan return -EINVAL; 4083a0111cf6SLai Jiangshan 40840a94efb5STejun Heo wq->flags &= ~__WQ_ORDERED; 40850a94efb5STejun Heo } 40860a94efb5STejun Heo 4087a0111cf6SLai Jiangshan ctx = apply_wqattrs_prepare(wq, attrs); 40886201171eSwanghaibin if (!ctx) 40896201171eSwanghaibin return -ENOMEM; 4090a0111cf6SLai Jiangshan 4091a0111cf6SLai Jiangshan /* the ctx has been prepared successfully, let's commit it */ 4092a0111cf6SLai Jiangshan apply_wqattrs_commit(ctx); 4093a0111cf6SLai Jiangshan apply_wqattrs_cleanup(ctx); 4094a0111cf6SLai Jiangshan 40956201171eSwanghaibin return 0; 4096a0111cf6SLai Jiangshan } 4097a0111cf6SLai Jiangshan 40989e8cd2f5STejun Heo /** 40999e8cd2f5STejun Heo * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue 41009e8cd2f5STejun Heo * @wq: the target workqueue 41019e8cd2f5STejun Heo * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs() 41029e8cd2f5STejun Heo * 41034c16bd32STejun Heo * Apply @attrs to an unbound workqueue @wq. Unless disabled, on NUMA 41044c16bd32STejun Heo * machines, this function maps a separate pwq to each NUMA node with 41054c16bd32STejun Heo * possibles CPUs in @attrs->cpumask so that work items are affine to the 41064c16bd32STejun Heo * NUMA node it was issued on. Older pwqs are released as in-flight work 41074c16bd32STejun Heo * items finish. Note that a work item which repeatedly requeues itself 41084c16bd32STejun Heo * back-to-back will stay on its current pwq. 41099e8cd2f5STejun Heo * 4110d185af30SYacine Belkadi * Performs GFP_KERNEL allocations. 4111d185af30SYacine Belkadi * 4112ffd8bea8SSebastian Andrzej Siewior * Assumes caller has CPU hotplug read exclusion, i.e. cpus_read_lock(). 4113509b3204SDaniel Jordan * 4114d185af30SYacine Belkadi * Return: 0 on success and -errno on failure. 41159e8cd2f5STejun Heo */ 4116513c98d0SDaniel Jordan int apply_workqueue_attrs(struct workqueue_struct *wq, 41179e8cd2f5STejun Heo const struct workqueue_attrs *attrs) 41189e8cd2f5STejun Heo { 4119a0111cf6SLai Jiangshan int ret; 41209e8cd2f5STejun Heo 4121509b3204SDaniel Jordan lockdep_assert_cpus_held(); 4122509b3204SDaniel Jordan 4123509b3204SDaniel Jordan mutex_lock(&wq_pool_mutex); 4124a0111cf6SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 4125509b3204SDaniel Jordan mutex_unlock(&wq_pool_mutex); 41262d5f0764SLai Jiangshan 41272d5f0764SLai Jiangshan return ret; 41289e8cd2f5STejun Heo } 41299e8cd2f5STejun Heo 41304c16bd32STejun Heo /** 41314c16bd32STejun Heo * wq_update_unbound_numa - update NUMA affinity of a wq for CPU hot[un]plug 41324c16bd32STejun Heo * @wq: the target workqueue 41334c16bd32STejun Heo * @cpu: the CPU coming up or going down 41344c16bd32STejun Heo * @online: whether @cpu is coming up or going down 41354c16bd32STejun Heo * 41364c16bd32STejun Heo * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and 41374c16bd32STejun Heo * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update NUMA affinity of 41384c16bd32STejun Heo * @wq accordingly. 41394c16bd32STejun Heo * 41404c16bd32STejun Heo * If NUMA affinity can't be adjusted due to memory allocation failure, it 41414c16bd32STejun Heo * falls back to @wq->dfl_pwq which may not be optimal but is always 41424c16bd32STejun Heo * correct. 41434c16bd32STejun Heo * 41444c16bd32STejun Heo * Note that when the last allowed CPU of a NUMA node goes offline for a 41454c16bd32STejun Heo * workqueue with a cpumask spanning multiple nodes, the workers which were 41464c16bd32STejun Heo * already executing the work items for the workqueue will lose their CPU 41474c16bd32STejun Heo * affinity and may execute on any CPU. This is similar to how per-cpu 41484c16bd32STejun Heo * workqueues behave on CPU_DOWN. If a workqueue user wants strict 41494c16bd32STejun Heo * affinity, it's the user's responsibility to flush the work item from 41504c16bd32STejun Heo * CPU_DOWN_PREPARE. 41514c16bd32STejun Heo */ 41524c16bd32STejun Heo static void wq_update_unbound_numa(struct workqueue_struct *wq, int cpu, 41534c16bd32STejun Heo bool online) 41544c16bd32STejun Heo { 41554c16bd32STejun Heo int node = cpu_to_node(cpu); 41564c16bd32STejun Heo int cpu_off = online ? -1 : cpu; 41574c16bd32STejun Heo struct pool_workqueue *old_pwq = NULL, *pwq; 41584c16bd32STejun Heo struct workqueue_attrs *target_attrs; 41594c16bd32STejun Heo cpumask_t *cpumask; 41604c16bd32STejun Heo 41614c16bd32STejun Heo lockdep_assert_held(&wq_pool_mutex); 41624c16bd32STejun Heo 4163f7142ed4SLai Jiangshan if (!wq_numa_enabled || !(wq->flags & WQ_UNBOUND) || 4164f7142ed4SLai Jiangshan wq->unbound_attrs->no_numa) 41654c16bd32STejun Heo return; 41664c16bd32STejun Heo 41674c16bd32STejun Heo /* 41684c16bd32STejun Heo * We don't wanna alloc/free wq_attrs for each wq for each CPU. 41694c16bd32STejun Heo * Let's use a preallocated one. The following buf is protected by 41704c16bd32STejun Heo * CPU hotplug exclusion. 41714c16bd32STejun Heo */ 41724c16bd32STejun Heo target_attrs = wq_update_unbound_numa_attrs_buf; 41734c16bd32STejun Heo cpumask = target_attrs->cpumask; 41744c16bd32STejun Heo 41754c16bd32STejun Heo copy_workqueue_attrs(target_attrs, wq->unbound_attrs); 41764c16bd32STejun Heo pwq = unbound_pwq_by_node(wq, node); 41774c16bd32STejun Heo 41784c16bd32STejun Heo /* 41794c16bd32STejun Heo * Let's determine what needs to be done. If the target cpumask is 4180042f7df1SLai Jiangshan * different from the default pwq's, we need to compare it to @pwq's 4181042f7df1SLai Jiangshan * and create a new one if they don't match. If the target cpumask 4182042f7df1SLai Jiangshan * equals the default pwq's, the default pwq should be used. 41834c16bd32STejun Heo */ 4184042f7df1SLai Jiangshan if (wq_calc_node_cpumask(wq->dfl_pwq->pool->attrs, node, cpu_off, cpumask)) { 41854c16bd32STejun Heo if (cpumask_equal(cpumask, pwq->pool->attrs->cpumask)) 4186f7142ed4SLai Jiangshan return; 41874c16bd32STejun Heo } else { 41884c16bd32STejun Heo goto use_dfl_pwq; 41894c16bd32STejun Heo } 41904c16bd32STejun Heo 41914c16bd32STejun Heo /* create a new pwq */ 41924c16bd32STejun Heo pwq = alloc_unbound_pwq(wq, target_attrs); 41934c16bd32STejun Heo if (!pwq) { 41942d916033SFabian Frederick pr_warn("workqueue: allocation failed while updating NUMA affinity of \"%s\"\n", 41954c16bd32STejun Heo wq->name); 419677f300b1SDaeseok Youn goto use_dfl_pwq; 41974c16bd32STejun Heo } 41984c16bd32STejun Heo 4199f7142ed4SLai Jiangshan /* Install the new pwq. */ 42004c16bd32STejun Heo mutex_lock(&wq->mutex); 42014c16bd32STejun Heo old_pwq = numa_pwq_tbl_install(wq, node, pwq); 42024c16bd32STejun Heo goto out_unlock; 42034c16bd32STejun Heo 42044c16bd32STejun Heo use_dfl_pwq: 4205f7142ed4SLai Jiangshan mutex_lock(&wq->mutex); 4206a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq->dfl_pwq->pool->lock); 42074c16bd32STejun Heo get_pwq(wq->dfl_pwq); 4208a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq->dfl_pwq->pool->lock); 42094c16bd32STejun Heo old_pwq = numa_pwq_tbl_install(wq, node, wq->dfl_pwq); 42104c16bd32STejun Heo out_unlock: 42114c16bd32STejun Heo mutex_unlock(&wq->mutex); 42124c16bd32STejun Heo put_pwq_unlocked(old_pwq); 42134c16bd32STejun Heo } 42144c16bd32STejun Heo 421530cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq) 42161da177e4SLinus Torvalds { 421749e3cf44STejun Heo bool highpri = wq->flags & WQ_HIGHPRI; 42188a2b7538STejun Heo int cpu, ret; 4219e1d8aa9fSFrederic Weisbecker 422030cdf249STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 4221420c0ddbSTejun Heo wq->cpu_pwqs = alloc_percpu(struct pool_workqueue); 4222420c0ddbSTejun Heo if (!wq->cpu_pwqs) 422330cdf249STejun Heo return -ENOMEM; 422430cdf249STejun Heo 422530cdf249STejun Heo for_each_possible_cpu(cpu) { 42267fb98ea7STejun Heo struct pool_workqueue *pwq = 42277fb98ea7STejun Heo per_cpu_ptr(wq->cpu_pwqs, cpu); 42287a62c2c8STejun Heo struct worker_pool *cpu_pools = 4229f02ae73aSTejun Heo per_cpu(cpu_worker_pools, cpu); 423030cdf249STejun Heo 4231f147f29eSTejun Heo init_pwq(pwq, wq, &cpu_pools[highpri]); 4232f147f29eSTejun Heo 4233f147f29eSTejun Heo mutex_lock(&wq->mutex); 42341befcf30STejun Heo link_pwq(pwq); 4235f147f29eSTejun Heo mutex_unlock(&wq->mutex); 423630cdf249STejun Heo } 423730cdf249STejun Heo return 0; 4238509b3204SDaniel Jordan } 4239509b3204SDaniel Jordan 4240ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 4241509b3204SDaniel Jordan if (wq->flags & __WQ_ORDERED) { 42428a2b7538STejun Heo ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]); 42438a2b7538STejun Heo /* there should only be single pwq for ordering guarantee */ 42448a2b7538STejun Heo WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node || 42458a2b7538STejun Heo wq->pwqs.prev != &wq->dfl_pwq->pwqs_node), 42468a2b7538STejun Heo "ordering guarantee broken for workqueue %s\n", wq->name); 42479e8cd2f5STejun Heo } else { 4248509b3204SDaniel Jordan ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]); 42499e8cd2f5STejun Heo } 4250ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 4251509b3204SDaniel Jordan 4252509b3204SDaniel Jordan return ret; 42530f900049STejun Heo } 42540f900049STejun Heo 4255f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags, 4256f3421797STejun Heo const char *name) 4257b71ab8c2STejun Heo { 4258f3421797STejun Heo int lim = flags & WQ_UNBOUND ? WQ_UNBOUND_MAX_ACTIVE : WQ_MAX_ACTIVE; 4259f3421797STejun Heo 4260f3421797STejun Heo if (max_active < 1 || max_active > lim) 4261044c782cSValentin Ilie pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n", 4262f3421797STejun Heo max_active, name, 1, lim); 4263b71ab8c2STejun Heo 4264f3421797STejun Heo return clamp_val(max_active, 1, lim); 4265b71ab8c2STejun Heo } 4266b71ab8c2STejun Heo 4267983c7515STejun Heo /* 4268983c7515STejun Heo * Workqueues which may be used during memory reclaim should have a rescuer 4269983c7515STejun Heo * to guarantee forward progress. 4270983c7515STejun Heo */ 4271983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq) 4272983c7515STejun Heo { 4273983c7515STejun Heo struct worker *rescuer; 4274b92b36eaSDan Carpenter int ret; 4275983c7515STejun Heo 4276983c7515STejun Heo if (!(wq->flags & WQ_MEM_RECLAIM)) 4277983c7515STejun Heo return 0; 4278983c7515STejun Heo 4279983c7515STejun Heo rescuer = alloc_worker(NUMA_NO_NODE); 4280983c7515STejun Heo if (!rescuer) 4281983c7515STejun Heo return -ENOMEM; 4282983c7515STejun Heo 4283983c7515STejun Heo rescuer->rescue_wq = wq; 4284983c7515STejun Heo rescuer->task = kthread_create(rescuer_thread, rescuer, "%s", wq->name); 4285f187b697SSean Fu if (IS_ERR(rescuer->task)) { 4286b92b36eaSDan Carpenter ret = PTR_ERR(rescuer->task); 4287983c7515STejun Heo kfree(rescuer); 4288b92b36eaSDan Carpenter return ret; 4289983c7515STejun Heo } 4290983c7515STejun Heo 4291983c7515STejun Heo wq->rescuer = rescuer; 4292983c7515STejun Heo kthread_bind_mask(rescuer->task, cpu_possible_mask); 4293983c7515STejun Heo wake_up_process(rescuer->task); 4294983c7515STejun Heo 4295983c7515STejun Heo return 0; 4296983c7515STejun Heo } 4297983c7515STejun Heo 4298a2775bbcSMathieu Malaterre __printf(1, 4) 4299669de8bdSBart Van Assche struct workqueue_struct *alloc_workqueue(const char *fmt, 430097e37d7bSTejun Heo unsigned int flags, 4301669de8bdSBart Van Assche int max_active, ...) 43023af24433SOleg Nesterov { 4303df2d5ae4STejun Heo size_t tbl_size = 0; 4304ecf6881fSTejun Heo va_list args; 43053af24433SOleg Nesterov struct workqueue_struct *wq; 430649e3cf44STejun Heo struct pool_workqueue *pwq; 4307b196be89STejun Heo 43085c0338c6STejun Heo /* 43095c0338c6STejun Heo * Unbound && max_active == 1 used to imply ordered, which is no 43105c0338c6STejun Heo * longer the case on NUMA machines due to per-node pools. While 43115c0338c6STejun Heo * alloc_ordered_workqueue() is the right way to create an ordered 43125c0338c6STejun Heo * workqueue, keep the previous behavior to avoid subtle breakages 43135c0338c6STejun Heo * on NUMA. 43145c0338c6STejun Heo */ 43155c0338c6STejun Heo if ((flags & WQ_UNBOUND) && max_active == 1) 43165c0338c6STejun Heo flags |= __WQ_ORDERED; 43175c0338c6STejun Heo 4318cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */ 4319cee22a15SViresh Kumar if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient) 4320cee22a15SViresh Kumar flags |= WQ_UNBOUND; 4321cee22a15SViresh Kumar 4322ecf6881fSTejun Heo /* allocate wq and format name */ 4323df2d5ae4STejun Heo if (flags & WQ_UNBOUND) 4324ddcb57e2SLai Jiangshan tbl_size = nr_node_ids * sizeof(wq->numa_pwq_tbl[0]); 4325df2d5ae4STejun Heo 4326df2d5ae4STejun Heo wq = kzalloc(sizeof(*wq) + tbl_size, GFP_KERNEL); 4327b196be89STejun Heo if (!wq) 4328d2c1d404STejun Heo return NULL; 4329b196be89STejun Heo 43306029a918STejun Heo if (flags & WQ_UNBOUND) { 4331be69d00dSThomas Gleixner wq->unbound_attrs = alloc_workqueue_attrs(); 43326029a918STejun Heo if (!wq->unbound_attrs) 43336029a918STejun Heo goto err_free_wq; 43346029a918STejun Heo } 43356029a918STejun Heo 4336669de8bdSBart Van Assche va_start(args, max_active); 4337ecf6881fSTejun Heo vsnprintf(wq->name, sizeof(wq->name), fmt, args); 4338b196be89STejun Heo va_end(args); 43393af24433SOleg Nesterov 4340d320c038STejun Heo max_active = max_active ?: WQ_DFL_ACTIVE; 4341b196be89STejun Heo max_active = wq_clamp_max_active(max_active, flags, wq->name); 43423af24433SOleg Nesterov 4343b196be89STejun Heo /* init wq */ 434497e37d7bSTejun Heo wq->flags = flags; 4345a0a1a5fdSTejun Heo wq->saved_max_active = max_active; 43463c25a55dSLai Jiangshan mutex_init(&wq->mutex); 4347112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 0); 434830cdf249STejun Heo INIT_LIST_HEAD(&wq->pwqs); 434973f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_queue); 435073f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_overflow); 4351493a1724STejun Heo INIT_LIST_HEAD(&wq->maydays); 43523af24433SOleg Nesterov 4353669de8bdSBart Van Assche wq_init_lockdep(wq); 4354cce1a165SOleg Nesterov INIT_LIST_HEAD(&wq->list); 43553af24433SOleg Nesterov 435630cdf249STejun Heo if (alloc_and_link_pwqs(wq) < 0) 435782efcab3SBart Van Assche goto err_unreg_lockdep; 43581537663fSTejun Heo 435940c17f75STejun Heo if (wq_online && init_rescuer(wq) < 0) 4360d2c1d404STejun Heo goto err_destroy; 4361e22bee78STejun Heo 4362226223abSTejun Heo if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq)) 4363226223abSTejun Heo goto err_destroy; 4364226223abSTejun Heo 43656af8bf3dSOleg Nesterov /* 436668e13a67SLai Jiangshan * wq_pool_mutex protects global freeze state and workqueues list. 436768e13a67SLai Jiangshan * Grab it, adjust max_active and add the new @wq to workqueues 436868e13a67SLai Jiangshan * list. 43696af8bf3dSOleg Nesterov */ 437068e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 4371a0a1a5fdSTejun Heo 4372a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 437349e3cf44STejun Heo for_each_pwq(pwq, wq) 4374699ce097STejun Heo pwq_adjust_max_active(pwq); 4375a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 4376a0a1a5fdSTejun Heo 4377e2dca7adSTejun Heo list_add_tail_rcu(&wq->list, &workqueues); 4378a0a1a5fdSTejun Heo 437968e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 43803af24433SOleg Nesterov 43813af24433SOleg Nesterov return wq; 4382d2c1d404STejun Heo 438382efcab3SBart Van Assche err_unreg_lockdep: 4384009bb421SBart Van Assche wq_unregister_lockdep(wq); 4385009bb421SBart Van Assche wq_free_lockdep(wq); 438682efcab3SBart Van Assche err_free_wq: 43876029a918STejun Heo free_workqueue_attrs(wq->unbound_attrs); 43884690c4abSTejun Heo kfree(wq); 4389d2c1d404STejun Heo return NULL; 4390d2c1d404STejun Heo err_destroy: 4391d2c1d404STejun Heo destroy_workqueue(wq); 43924690c4abSTejun Heo return NULL; 43931da177e4SLinus Torvalds } 4394669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue); 43951da177e4SLinus Torvalds 4396c29eb853STejun Heo static bool pwq_busy(struct pool_workqueue *pwq) 4397c29eb853STejun Heo { 4398c29eb853STejun Heo int i; 4399c29eb853STejun Heo 4400c29eb853STejun Heo for (i = 0; i < WORK_NR_COLORS; i++) 4401c29eb853STejun Heo if (pwq->nr_in_flight[i]) 4402c29eb853STejun Heo return true; 4403c29eb853STejun Heo 4404c29eb853STejun Heo if ((pwq != pwq->wq->dfl_pwq) && (pwq->refcnt > 1)) 4405c29eb853STejun Heo return true; 4406f97a4a1aSLai Jiangshan if (pwq->nr_active || !list_empty(&pwq->inactive_works)) 4407c29eb853STejun Heo return true; 4408c29eb853STejun Heo 4409c29eb853STejun Heo return false; 4410c29eb853STejun Heo } 4411c29eb853STejun Heo 44123af24433SOleg Nesterov /** 44133af24433SOleg Nesterov * destroy_workqueue - safely terminate a workqueue 44143af24433SOleg Nesterov * @wq: target workqueue 44153af24433SOleg Nesterov * 44163af24433SOleg Nesterov * Safely destroy a workqueue. All work currently pending will be done first. 44173af24433SOleg Nesterov */ 44183af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq) 44193af24433SOleg Nesterov { 442049e3cf44STejun Heo struct pool_workqueue *pwq; 44214c16bd32STejun Heo int node; 44223af24433SOleg Nesterov 4423def98c84STejun Heo /* 4424def98c84STejun Heo * Remove it from sysfs first so that sanity check failure doesn't 4425def98c84STejun Heo * lead to sysfs name conflicts. 4426def98c84STejun Heo */ 4427def98c84STejun Heo workqueue_sysfs_unregister(wq); 4428def98c84STejun Heo 44299c5a2ba7STejun Heo /* drain it before proceeding with destruction */ 44309c5a2ba7STejun Heo drain_workqueue(wq); 4431c8efcc25STejun Heo 4432def98c84STejun Heo /* kill rescuer, if sanity checks fail, leave it w/o rescuer */ 4433def98c84STejun Heo if (wq->rescuer) { 4434def98c84STejun Heo struct worker *rescuer = wq->rescuer; 4435def98c84STejun Heo 4436def98c84STejun Heo /* this prevents new queueing */ 4437a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 4438def98c84STejun Heo wq->rescuer = NULL; 4439a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 4440def98c84STejun Heo 4441def98c84STejun Heo /* rescuer will empty maydays list before exiting */ 4442def98c84STejun Heo kthread_stop(rescuer->task); 44438efe1223STejun Heo kfree(rescuer); 4444def98c84STejun Heo } 4445def98c84STejun Heo 4446c29eb853STejun Heo /* 4447c29eb853STejun Heo * Sanity checks - grab all the locks so that we wait for all 4448c29eb853STejun Heo * in-flight operations which may do put_pwq(). 4449c29eb853STejun Heo */ 4450c29eb853STejun Heo mutex_lock(&wq_pool_mutex); 4451b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 445249e3cf44STejun Heo for_each_pwq(pwq, wq) { 4453a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 4454c29eb853STejun Heo if (WARN_ON(pwq_busy(pwq))) { 44551d9a6159SKefeng Wang pr_warn("%s: %s has the following busy pwq\n", 4456e66b39afSTejun Heo __func__, wq->name); 4457c29eb853STejun Heo show_pwq(pwq); 4458a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 4459b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 4460c29eb853STejun Heo mutex_unlock(&wq_pool_mutex); 446155df0933SImran Khan show_one_workqueue(wq); 44626183c009STejun Heo return; 446376af4d93STejun Heo } 4464a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 446576af4d93STejun Heo } 4466b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 44676183c009STejun Heo 4468a0a1a5fdSTejun Heo /* 4469a0a1a5fdSTejun Heo * wq list is used to freeze wq, remove from list after 4470a0a1a5fdSTejun Heo * flushing is complete in case freeze races us. 4471a0a1a5fdSTejun Heo */ 4472e2dca7adSTejun Heo list_del_rcu(&wq->list); 447368e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 44743af24433SOleg Nesterov 44758864b4e5STejun Heo if (!(wq->flags & WQ_UNBOUND)) { 4476669de8bdSBart Van Assche wq_unregister_lockdep(wq); 447729c91e99STejun Heo /* 44788864b4e5STejun Heo * The base ref is never dropped on per-cpu pwqs. Directly 4479e2dca7adSTejun Heo * schedule RCU free. 448029c91e99STejun Heo */ 448125b00775SPaul E. McKenney call_rcu(&wq->rcu, rcu_free_wq); 44828864b4e5STejun Heo } else { 44838864b4e5STejun Heo /* 44848864b4e5STejun Heo * We're the sole accessor of @wq at this point. Directly 44854c16bd32STejun Heo * access numa_pwq_tbl[] and dfl_pwq to put the base refs. 44864c16bd32STejun Heo * @wq will be freed when the last pwq is released. 44878864b4e5STejun Heo */ 44884c16bd32STejun Heo for_each_node(node) { 44894c16bd32STejun Heo pwq = rcu_access_pointer(wq->numa_pwq_tbl[node]); 44904c16bd32STejun Heo RCU_INIT_POINTER(wq->numa_pwq_tbl[node], NULL); 44914c16bd32STejun Heo put_pwq_unlocked(pwq); 44924c16bd32STejun Heo } 44934c16bd32STejun Heo 44944c16bd32STejun Heo /* 44954c16bd32STejun Heo * Put dfl_pwq. @wq may be freed any time after dfl_pwq is 44964c16bd32STejun Heo * put. Don't access it afterwards. 44974c16bd32STejun Heo */ 44984c16bd32STejun Heo pwq = wq->dfl_pwq; 44994c16bd32STejun Heo wq->dfl_pwq = NULL; 4500dce90d47STejun Heo put_pwq_unlocked(pwq); 450129c91e99STejun Heo } 45023af24433SOleg Nesterov } 45033af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue); 45043af24433SOleg Nesterov 4505dcd989cbSTejun Heo /** 4506dcd989cbSTejun Heo * workqueue_set_max_active - adjust max_active of a workqueue 4507dcd989cbSTejun Heo * @wq: target workqueue 4508dcd989cbSTejun Heo * @max_active: new max_active value. 4509dcd989cbSTejun Heo * 4510dcd989cbSTejun Heo * Set max_active of @wq to @max_active. 4511dcd989cbSTejun Heo * 4512dcd989cbSTejun Heo * CONTEXT: 4513dcd989cbSTejun Heo * Don't call from IRQ context. 4514dcd989cbSTejun Heo */ 4515dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) 4516dcd989cbSTejun Heo { 451749e3cf44STejun Heo struct pool_workqueue *pwq; 4518dcd989cbSTejun Heo 45198719dceaSTejun Heo /* disallow meddling with max_active for ordered workqueues */ 45200a94efb5STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) 45218719dceaSTejun Heo return; 45228719dceaSTejun Heo 4523f3421797STejun Heo max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); 4524dcd989cbSTejun Heo 4525a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 4526dcd989cbSTejun Heo 45270a94efb5STejun Heo wq->flags &= ~__WQ_ORDERED; 4528dcd989cbSTejun Heo wq->saved_max_active = max_active; 4529dcd989cbSTejun Heo 4530699ce097STejun Heo for_each_pwq(pwq, wq) 4531699ce097STejun Heo pwq_adjust_max_active(pwq); 4532dcd989cbSTejun Heo 4533a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 4534dcd989cbSTejun Heo } 4535dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active); 4536dcd989cbSTejun Heo 4537dcd989cbSTejun Heo /** 453827d4ee03SLukas Wunner * current_work - retrieve %current task's work struct 453927d4ee03SLukas Wunner * 454027d4ee03SLukas Wunner * Determine if %current task is a workqueue worker and what it's working on. 454127d4ee03SLukas Wunner * Useful to find out the context that the %current task is running in. 454227d4ee03SLukas Wunner * 454327d4ee03SLukas Wunner * Return: work struct if %current task is a workqueue worker, %NULL otherwise. 454427d4ee03SLukas Wunner */ 454527d4ee03SLukas Wunner struct work_struct *current_work(void) 454627d4ee03SLukas Wunner { 454727d4ee03SLukas Wunner struct worker *worker = current_wq_worker(); 454827d4ee03SLukas Wunner 454927d4ee03SLukas Wunner return worker ? worker->current_work : NULL; 455027d4ee03SLukas Wunner } 455127d4ee03SLukas Wunner EXPORT_SYMBOL(current_work); 455227d4ee03SLukas Wunner 455327d4ee03SLukas Wunner /** 4554e6267616STejun Heo * current_is_workqueue_rescuer - is %current workqueue rescuer? 4555e6267616STejun Heo * 4556e6267616STejun Heo * Determine whether %current is a workqueue rescuer. Can be used from 4557e6267616STejun Heo * work functions to determine whether it's being run off the rescuer task. 4558d185af30SYacine Belkadi * 4559d185af30SYacine Belkadi * Return: %true if %current is a workqueue rescuer. %false otherwise. 4560e6267616STejun Heo */ 4561e6267616STejun Heo bool current_is_workqueue_rescuer(void) 4562e6267616STejun Heo { 4563e6267616STejun Heo struct worker *worker = current_wq_worker(); 4564e6267616STejun Heo 45656a092dfdSLai Jiangshan return worker && worker->rescue_wq; 4566e6267616STejun Heo } 4567e6267616STejun Heo 4568e6267616STejun Heo /** 4569dcd989cbSTejun Heo * workqueue_congested - test whether a workqueue is congested 4570dcd989cbSTejun Heo * @cpu: CPU in question 4571dcd989cbSTejun Heo * @wq: target workqueue 4572dcd989cbSTejun Heo * 4573dcd989cbSTejun Heo * Test whether @wq's cpu workqueue for @cpu is congested. There is 4574dcd989cbSTejun Heo * no synchronization around this function and the test result is 4575dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 4576dcd989cbSTejun Heo * 4577d3251859STejun Heo * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU. 4578d3251859STejun Heo * Note that both per-cpu and unbound workqueues may be associated with 4579d3251859STejun Heo * multiple pool_workqueues which have separate congested states. A 4580d3251859STejun Heo * workqueue being congested on one CPU doesn't mean the workqueue is also 4581d3251859STejun Heo * contested on other CPUs / NUMA nodes. 4582d3251859STejun Heo * 4583d185af30SYacine Belkadi * Return: 4584dcd989cbSTejun Heo * %true if congested, %false otherwise. 4585dcd989cbSTejun Heo */ 4586d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq) 4587dcd989cbSTejun Heo { 45887fb98ea7STejun Heo struct pool_workqueue *pwq; 458976af4d93STejun Heo bool ret; 459076af4d93STejun Heo 459124acfb71SThomas Gleixner rcu_read_lock(); 459224acfb71SThomas Gleixner preempt_disable(); 45937fb98ea7STejun Heo 4594d3251859STejun Heo if (cpu == WORK_CPU_UNBOUND) 4595d3251859STejun Heo cpu = smp_processor_id(); 4596d3251859STejun Heo 45977fb98ea7STejun Heo if (!(wq->flags & WQ_UNBOUND)) 45987fb98ea7STejun Heo pwq = per_cpu_ptr(wq->cpu_pwqs, cpu); 45997fb98ea7STejun Heo else 4600df2d5ae4STejun Heo pwq = unbound_pwq_by_node(wq, cpu_to_node(cpu)); 4601dcd989cbSTejun Heo 4602f97a4a1aSLai Jiangshan ret = !list_empty(&pwq->inactive_works); 460324acfb71SThomas Gleixner preempt_enable(); 460424acfb71SThomas Gleixner rcu_read_unlock(); 460576af4d93STejun Heo 460676af4d93STejun Heo return ret; 4607dcd989cbSTejun Heo } 4608dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested); 4609dcd989cbSTejun Heo 4610dcd989cbSTejun Heo /** 4611dcd989cbSTejun Heo * work_busy - test whether a work is currently pending or running 4612dcd989cbSTejun Heo * @work: the work to be tested 4613dcd989cbSTejun Heo * 4614dcd989cbSTejun Heo * Test whether @work is currently pending or running. There is no 4615dcd989cbSTejun Heo * synchronization around this function and the test result is 4616dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 4617dcd989cbSTejun Heo * 4618d185af30SYacine Belkadi * Return: 4619dcd989cbSTejun Heo * OR'd bitmask of WORK_BUSY_* bits. 4620dcd989cbSTejun Heo */ 4621dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work) 4622dcd989cbSTejun Heo { 4623fa1b54e6STejun Heo struct worker_pool *pool; 4624dcd989cbSTejun Heo unsigned long flags; 4625dcd989cbSTejun Heo unsigned int ret = 0; 4626dcd989cbSTejun Heo 4627dcd989cbSTejun Heo if (work_pending(work)) 4628dcd989cbSTejun Heo ret |= WORK_BUSY_PENDING; 4629038366c5SLai Jiangshan 463024acfb71SThomas Gleixner rcu_read_lock(); 4631fa1b54e6STejun Heo pool = get_work_pool(work); 4632038366c5SLai Jiangshan if (pool) { 4633a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irqsave(&pool->lock, flags); 4634c9e7cf27STejun Heo if (find_worker_executing_work(pool, work)) 4635dcd989cbSTejun Heo ret |= WORK_BUSY_RUNNING; 4636a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irqrestore(&pool->lock, flags); 4637038366c5SLai Jiangshan } 463824acfb71SThomas Gleixner rcu_read_unlock(); 4639dcd989cbSTejun Heo 4640dcd989cbSTejun Heo return ret; 4641dcd989cbSTejun Heo } 4642dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy); 4643dcd989cbSTejun Heo 46443d1cb205STejun Heo /** 46453d1cb205STejun Heo * set_worker_desc - set description for the current work item 46463d1cb205STejun Heo * @fmt: printf-style format string 46473d1cb205STejun Heo * @...: arguments for the format string 46483d1cb205STejun Heo * 46493d1cb205STejun Heo * This function can be called by a running work function to describe what 46503d1cb205STejun Heo * the work item is about. If the worker task gets dumped, this 46513d1cb205STejun Heo * information will be printed out together to help debugging. The 46523d1cb205STejun Heo * description can be at most WORKER_DESC_LEN including the trailing '\0'. 46533d1cb205STejun Heo */ 46543d1cb205STejun Heo void set_worker_desc(const char *fmt, ...) 46553d1cb205STejun Heo { 46563d1cb205STejun Heo struct worker *worker = current_wq_worker(); 46573d1cb205STejun Heo va_list args; 46583d1cb205STejun Heo 46593d1cb205STejun Heo if (worker) { 46603d1cb205STejun Heo va_start(args, fmt); 46613d1cb205STejun Heo vsnprintf(worker->desc, sizeof(worker->desc), fmt, args); 46623d1cb205STejun Heo va_end(args); 46633d1cb205STejun Heo } 46643d1cb205STejun Heo } 46655c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc); 46663d1cb205STejun Heo 46673d1cb205STejun Heo /** 46683d1cb205STejun Heo * print_worker_info - print out worker information and description 46693d1cb205STejun Heo * @log_lvl: the log level to use when printing 46703d1cb205STejun Heo * @task: target task 46713d1cb205STejun Heo * 46723d1cb205STejun Heo * If @task is a worker and currently executing a work item, print out the 46733d1cb205STejun Heo * name of the workqueue being serviced and worker description set with 46743d1cb205STejun Heo * set_worker_desc() by the currently executing work item. 46753d1cb205STejun Heo * 46763d1cb205STejun Heo * This function can be safely called on any task as long as the 46773d1cb205STejun Heo * task_struct itself is accessible. While safe, this function isn't 46783d1cb205STejun Heo * synchronized and may print out mixups or garbages of limited length. 46793d1cb205STejun Heo */ 46803d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task) 46813d1cb205STejun Heo { 46823d1cb205STejun Heo work_func_t *fn = NULL; 46833d1cb205STejun Heo char name[WQ_NAME_LEN] = { }; 46843d1cb205STejun Heo char desc[WORKER_DESC_LEN] = { }; 46853d1cb205STejun Heo struct pool_workqueue *pwq = NULL; 46863d1cb205STejun Heo struct workqueue_struct *wq = NULL; 46873d1cb205STejun Heo struct worker *worker; 46883d1cb205STejun Heo 46893d1cb205STejun Heo if (!(task->flags & PF_WQ_WORKER)) 46903d1cb205STejun Heo return; 46913d1cb205STejun Heo 46923d1cb205STejun Heo /* 46933d1cb205STejun Heo * This function is called without any synchronization and @task 46943d1cb205STejun Heo * could be in any state. Be careful with dereferences. 46953d1cb205STejun Heo */ 4696e700591aSPetr Mladek worker = kthread_probe_data(task); 46973d1cb205STejun Heo 46983d1cb205STejun Heo /* 46998bf89593STejun Heo * Carefully copy the associated workqueue's workfn, name and desc. 47008bf89593STejun Heo * Keep the original last '\0' in case the original is garbage. 47013d1cb205STejun Heo */ 4702fe557319SChristoph Hellwig copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn)); 4703fe557319SChristoph Hellwig copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq)); 4704fe557319SChristoph Hellwig copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq)); 4705fe557319SChristoph Hellwig copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1); 4706fe557319SChristoph Hellwig copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1); 47073d1cb205STejun Heo 47083d1cb205STejun Heo if (fn || name[0] || desc[0]) { 4709d75f773cSSakari Ailus printk("%sWorkqueue: %s %ps", log_lvl, name, fn); 47108bf89593STejun Heo if (strcmp(name, desc)) 47113d1cb205STejun Heo pr_cont(" (%s)", desc); 47123d1cb205STejun Heo pr_cont("\n"); 47133d1cb205STejun Heo } 47143d1cb205STejun Heo } 47153d1cb205STejun Heo 47163494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool) 47173494fc30STejun Heo { 47183494fc30STejun Heo pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask); 47193494fc30STejun Heo if (pool->node != NUMA_NO_NODE) 47203494fc30STejun Heo pr_cont(" node=%d", pool->node); 47213494fc30STejun Heo pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice); 47223494fc30STejun Heo } 47233494fc30STejun Heo 47243494fc30STejun Heo static void pr_cont_work(bool comma, struct work_struct *work) 47253494fc30STejun Heo { 47263494fc30STejun Heo if (work->func == wq_barrier_func) { 47273494fc30STejun Heo struct wq_barrier *barr; 47283494fc30STejun Heo 47293494fc30STejun Heo barr = container_of(work, struct wq_barrier, work); 47303494fc30STejun Heo 47313494fc30STejun Heo pr_cont("%s BAR(%d)", comma ? "," : "", 47323494fc30STejun Heo task_pid_nr(barr->task)); 47333494fc30STejun Heo } else { 4734d75f773cSSakari Ailus pr_cont("%s %ps", comma ? "," : "", work->func); 47353494fc30STejun Heo } 47363494fc30STejun Heo } 47373494fc30STejun Heo 47383494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq) 47393494fc30STejun Heo { 47403494fc30STejun Heo struct worker_pool *pool = pwq->pool; 47413494fc30STejun Heo struct work_struct *work; 47423494fc30STejun Heo struct worker *worker; 47433494fc30STejun Heo bool has_in_flight = false, has_pending = false; 47443494fc30STejun Heo int bkt; 47453494fc30STejun Heo 47463494fc30STejun Heo pr_info(" pwq %d:", pool->id); 47473494fc30STejun Heo pr_cont_pool_info(pool); 47483494fc30STejun Heo 4749e66b39afSTejun Heo pr_cont(" active=%d/%d refcnt=%d%s\n", 4750e66b39afSTejun Heo pwq->nr_active, pwq->max_active, pwq->refcnt, 47513494fc30STejun Heo !list_empty(&pwq->mayday_node) ? " MAYDAY" : ""); 47523494fc30STejun Heo 47533494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 47543494fc30STejun Heo if (worker->current_pwq == pwq) { 47553494fc30STejun Heo has_in_flight = true; 47563494fc30STejun Heo break; 47573494fc30STejun Heo } 47583494fc30STejun Heo } 47593494fc30STejun Heo if (has_in_flight) { 47603494fc30STejun Heo bool comma = false; 47613494fc30STejun Heo 47623494fc30STejun Heo pr_info(" in-flight:"); 47633494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 47643494fc30STejun Heo if (worker->current_pwq != pwq) 47653494fc30STejun Heo continue; 47663494fc30STejun Heo 4767d75f773cSSakari Ailus pr_cont("%s %d%s:%ps", comma ? "," : "", 47683494fc30STejun Heo task_pid_nr(worker->task), 476930ae2fc0STejun Heo worker->rescue_wq ? "(RESCUER)" : "", 47703494fc30STejun Heo worker->current_func); 47713494fc30STejun Heo list_for_each_entry(work, &worker->scheduled, entry) 47723494fc30STejun Heo pr_cont_work(false, work); 47733494fc30STejun Heo comma = true; 47743494fc30STejun Heo } 47753494fc30STejun Heo pr_cont("\n"); 47763494fc30STejun Heo } 47773494fc30STejun Heo 47783494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 47793494fc30STejun Heo if (get_work_pwq(work) == pwq) { 47803494fc30STejun Heo has_pending = true; 47813494fc30STejun Heo break; 47823494fc30STejun Heo } 47833494fc30STejun Heo } 47843494fc30STejun Heo if (has_pending) { 47853494fc30STejun Heo bool comma = false; 47863494fc30STejun Heo 47873494fc30STejun Heo pr_info(" pending:"); 47883494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 47893494fc30STejun Heo if (get_work_pwq(work) != pwq) 47903494fc30STejun Heo continue; 47913494fc30STejun Heo 47923494fc30STejun Heo pr_cont_work(comma, work); 47933494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 47943494fc30STejun Heo } 47953494fc30STejun Heo pr_cont("\n"); 47963494fc30STejun Heo } 47973494fc30STejun Heo 4798f97a4a1aSLai Jiangshan if (!list_empty(&pwq->inactive_works)) { 47993494fc30STejun Heo bool comma = false; 48003494fc30STejun Heo 4801f97a4a1aSLai Jiangshan pr_info(" inactive:"); 4802f97a4a1aSLai Jiangshan list_for_each_entry(work, &pwq->inactive_works, entry) { 48033494fc30STejun Heo pr_cont_work(comma, work); 48043494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 48053494fc30STejun Heo } 48063494fc30STejun Heo pr_cont("\n"); 48073494fc30STejun Heo } 48083494fc30STejun Heo } 48093494fc30STejun Heo 48103494fc30STejun Heo /** 481155df0933SImran Khan * show_one_workqueue - dump state of specified workqueue 481255df0933SImran Khan * @wq: workqueue whose state will be printed 48133494fc30STejun Heo */ 481455df0933SImran Khan void show_one_workqueue(struct workqueue_struct *wq) 48153494fc30STejun Heo { 48163494fc30STejun Heo struct pool_workqueue *pwq; 48173494fc30STejun Heo bool idle = true; 481855df0933SImran Khan unsigned long flags; 48193494fc30STejun Heo 48203494fc30STejun Heo for_each_pwq(pwq, wq) { 4821f97a4a1aSLai Jiangshan if (pwq->nr_active || !list_empty(&pwq->inactive_works)) { 48223494fc30STejun Heo idle = false; 48233494fc30STejun Heo break; 48243494fc30STejun Heo } 48253494fc30STejun Heo } 482655df0933SImran Khan if (idle) /* Nothing to print for idle workqueue */ 482755df0933SImran Khan return; 48283494fc30STejun Heo 48293494fc30STejun Heo pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags); 48303494fc30STejun Heo 48313494fc30STejun Heo for_each_pwq(pwq, wq) { 4832a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irqsave(&pwq->pool->lock, flags); 483357116ce1SJohan Hovold if (pwq->nr_active || !list_empty(&pwq->inactive_works)) { 483457116ce1SJohan Hovold /* 483557116ce1SJohan Hovold * Defer printing to avoid deadlocks in console 483657116ce1SJohan Hovold * drivers that queue work while holding locks 483757116ce1SJohan Hovold * also taken in their write paths. 483857116ce1SJohan Hovold */ 483957116ce1SJohan Hovold printk_deferred_enter(); 48403494fc30STejun Heo show_pwq(pwq); 484157116ce1SJohan Hovold printk_deferred_exit(); 484257116ce1SJohan Hovold } 4843a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irqrestore(&pwq->pool->lock, flags); 484462635ea8SSergey Senozhatsky /* 484562635ea8SSergey Senozhatsky * We could be printing a lot from atomic context, e.g. 484655df0933SImran Khan * sysrq-t -> show_all_workqueues(). Avoid triggering 484762635ea8SSergey Senozhatsky * hard lockup. 484862635ea8SSergey Senozhatsky */ 484962635ea8SSergey Senozhatsky touch_nmi_watchdog(); 48503494fc30STejun Heo } 485155df0933SImran Khan 48523494fc30STejun Heo } 48533494fc30STejun Heo 485455df0933SImran Khan /** 485555df0933SImran Khan * show_one_worker_pool - dump state of specified worker pool 485655df0933SImran Khan * @pool: worker pool whose state will be printed 485755df0933SImran Khan */ 485855df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool) 485955df0933SImran Khan { 48603494fc30STejun Heo struct worker *worker; 48613494fc30STejun Heo bool first = true; 486255df0933SImran Khan unsigned long flags; 48633494fc30STejun Heo 4864a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irqsave(&pool->lock, flags); 48653494fc30STejun Heo if (pool->nr_workers == pool->nr_idle) 48663494fc30STejun Heo goto next_pool; 486757116ce1SJohan Hovold /* 486857116ce1SJohan Hovold * Defer printing to avoid deadlocks in console drivers that 486957116ce1SJohan Hovold * queue work while holding locks also taken in their write 487057116ce1SJohan Hovold * paths. 487157116ce1SJohan Hovold */ 487257116ce1SJohan Hovold printk_deferred_enter(); 48733494fc30STejun Heo pr_info("pool %d:", pool->id); 48743494fc30STejun Heo pr_cont_pool_info(pool); 487582607adcSTejun Heo pr_cont(" hung=%us workers=%d", 487682607adcSTejun Heo jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000, 487782607adcSTejun Heo pool->nr_workers); 48783494fc30STejun Heo if (pool->manager) 48793494fc30STejun Heo pr_cont(" manager: %d", 48803494fc30STejun Heo task_pid_nr(pool->manager->task)); 48813494fc30STejun Heo list_for_each_entry(worker, &pool->idle_list, entry) { 48823494fc30STejun Heo pr_cont(" %s%d", first ? "idle: " : "", 48833494fc30STejun Heo task_pid_nr(worker->task)); 48843494fc30STejun Heo first = false; 48853494fc30STejun Heo } 48863494fc30STejun Heo pr_cont("\n"); 488757116ce1SJohan Hovold printk_deferred_exit(); 48883494fc30STejun Heo next_pool: 4889a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irqrestore(&pool->lock, flags); 489062635ea8SSergey Senozhatsky /* 489162635ea8SSergey Senozhatsky * We could be printing a lot from atomic context, e.g. 489255df0933SImran Khan * sysrq-t -> show_all_workqueues(). Avoid triggering 489362635ea8SSergey Senozhatsky * hard lockup. 489462635ea8SSergey Senozhatsky */ 489562635ea8SSergey Senozhatsky touch_nmi_watchdog(); 489655df0933SImran Khan 48973494fc30STejun Heo } 48983494fc30STejun Heo 489955df0933SImran Khan /** 490055df0933SImran Khan * show_all_workqueues - dump workqueue state 490155df0933SImran Khan * 490255df0933SImran Khan * Called from a sysrq handler or try_to_freeze_tasks() and prints out 490355df0933SImran Khan * all busy workqueues and pools. 490455df0933SImran Khan */ 490555df0933SImran Khan void show_all_workqueues(void) 490655df0933SImran Khan { 490755df0933SImran Khan struct workqueue_struct *wq; 490855df0933SImran Khan struct worker_pool *pool; 490955df0933SImran Khan int pi; 491055df0933SImran Khan 491155df0933SImran Khan rcu_read_lock(); 491255df0933SImran Khan 491355df0933SImran Khan pr_info("Showing busy workqueues and worker pools:\n"); 491455df0933SImran Khan 491555df0933SImran Khan list_for_each_entry_rcu(wq, &workqueues, list) 491655df0933SImran Khan show_one_workqueue(wq); 491755df0933SImran Khan 491855df0933SImran Khan for_each_pool(pool, pi) 491955df0933SImran Khan show_one_worker_pool(pool); 492055df0933SImran Khan 492124acfb71SThomas Gleixner rcu_read_unlock(); 49223494fc30STejun Heo } 49233494fc30STejun Heo 49246b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */ 49256b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task) 49266b59808bSTejun Heo { 49276b59808bSTejun Heo int off; 49286b59808bSTejun Heo 49296b59808bSTejun Heo /* always show the actual comm */ 49306b59808bSTejun Heo off = strscpy(buf, task->comm, size); 49316b59808bSTejun Heo if (off < 0) 49326b59808bSTejun Heo return; 49336b59808bSTejun Heo 4934197f6accSTejun Heo /* stabilize PF_WQ_WORKER and worker pool association */ 49356b59808bSTejun Heo mutex_lock(&wq_pool_attach_mutex); 49366b59808bSTejun Heo 4937197f6accSTejun Heo if (task->flags & PF_WQ_WORKER) { 4938197f6accSTejun Heo struct worker *worker = kthread_data(task); 4939197f6accSTejun Heo struct worker_pool *pool = worker->pool; 49406b59808bSTejun Heo 49416b59808bSTejun Heo if (pool) { 4942a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 49436b59808bSTejun Heo /* 4944197f6accSTejun Heo * ->desc tracks information (wq name or 4945197f6accSTejun Heo * set_worker_desc()) for the latest execution. If 4946197f6accSTejun Heo * current, prepend '+', otherwise '-'. 49476b59808bSTejun Heo */ 49486b59808bSTejun Heo if (worker->desc[0] != '\0') { 49496b59808bSTejun Heo if (worker->current_work) 49506b59808bSTejun Heo scnprintf(buf + off, size - off, "+%s", 49516b59808bSTejun Heo worker->desc); 49526b59808bSTejun Heo else 49536b59808bSTejun Heo scnprintf(buf + off, size - off, "-%s", 49546b59808bSTejun Heo worker->desc); 49556b59808bSTejun Heo } 4956a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 49576b59808bSTejun Heo } 4958197f6accSTejun Heo } 49596b59808bSTejun Heo 49606b59808bSTejun Heo mutex_unlock(&wq_pool_attach_mutex); 49616b59808bSTejun Heo } 49626b59808bSTejun Heo 496366448bc2SMathieu Malaterre #ifdef CONFIG_SMP 496466448bc2SMathieu Malaterre 4965db7bccf4STejun Heo /* 4966db7bccf4STejun Heo * CPU hotplug. 4967db7bccf4STejun Heo * 4968e22bee78STejun Heo * There are two challenges in supporting CPU hotplug. Firstly, there 4969112202d9STejun Heo * are a lot of assumptions on strong associations among work, pwq and 4970706026c2STejun Heo * pool which make migrating pending and scheduled works very 4971e22bee78STejun Heo * difficult to implement without impacting hot paths. Secondly, 497294cf58bbSTejun Heo * worker pools serve mix of short, long and very long running works making 4973e22bee78STejun Heo * blocked draining impractical. 4974e22bee78STejun Heo * 497524647570STejun Heo * This is solved by allowing the pools to be disassociated from the CPU 4976628c78e7STejun Heo * running as an unbound one and allowing it to be reattached later if the 4977628c78e7STejun Heo * cpu comes back online. 4978db7bccf4STejun Heo */ 4979db7bccf4STejun Heo 4980e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu) 4981db7bccf4STejun Heo { 49824ce62e9eSTejun Heo struct worker_pool *pool; 4983db7bccf4STejun Heo struct worker *worker; 4984db7bccf4STejun Heo 4985f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 49861258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 4987a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 4988e22bee78STejun Heo 4989f2d5a0eeSTejun Heo /* 499092f9c5c4SLai Jiangshan * We've blocked all attach/detach operations. Make all workers 499194cf58bbSTejun Heo * unbound and set DISASSOCIATED. Before this, all workers 499294cf58bbSTejun Heo * except for the ones which are still executing works from 499394cf58bbSTejun Heo * before the last CPU down must be on the cpu. After 499494cf58bbSTejun Heo * this, they may become diasporas. 4995f2d5a0eeSTejun Heo */ 4996da028469SLai Jiangshan for_each_pool_worker(worker, pool) 4997403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 4998db7bccf4STejun Heo 499924647570STejun Heo pool->flags |= POOL_DISASSOCIATED; 5000f2d5a0eeSTejun Heo 5001a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 500206249738SPeter Zijlstra 50035c25b5ffSPeter Zijlstra for_each_pool_worker(worker, pool) { 50045c25b5ffSPeter Zijlstra kthread_set_per_cpu(worker->task, -1); 5005547a77d0SLai Jiangshan WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0); 50065c25b5ffSPeter Zijlstra } 500706249738SPeter Zijlstra 50081258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 5009e22bee78STejun Heo 5010e22bee78STejun Heo /* 5011eb283428SLai Jiangshan * Call schedule() so that we cross rq->lock and thus can 5012eb283428SLai Jiangshan * guarantee sched callbacks see the %WORKER_UNBOUND flag. 5013eb283428SLai Jiangshan * This is necessary as scheduler callbacks may be invoked 5014eb283428SLai Jiangshan * from other cpus. 5015628c78e7STejun Heo */ 5016628c78e7STejun Heo schedule(); 5017628c78e7STejun Heo 5018628c78e7STejun Heo /* 5019eb283428SLai Jiangshan * Sched callbacks are disabled now. Zap nr_running. 5020eb283428SLai Jiangshan * After this, nr_running stays zero and need_more_worker() 5021eb283428SLai Jiangshan * and keep_working() are always true as long as the 5022eb283428SLai Jiangshan * worklist is not empty. This pool now behaves as an 5023eb283428SLai Jiangshan * unbound (in terms of concurrency management) pool which 5024eb283428SLai Jiangshan * are served by workers tied to the pool. 5025e22bee78STejun Heo */ 5026e19e397aSTejun Heo atomic_set(&pool->nr_running, 0); 5027eb283428SLai Jiangshan 5028eb283428SLai Jiangshan /* 5029eb283428SLai Jiangshan * With concurrency management just turned off, a busy 5030eb283428SLai Jiangshan * worker blocking could lead to lengthy stalls. Kick off 5031eb283428SLai Jiangshan * unbound chain execution of currently pending work items. 5032eb283428SLai Jiangshan */ 5033a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 5034eb283428SLai Jiangshan wake_up_worker(pool); 5035a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 5036eb283428SLai Jiangshan } 5037db7bccf4STejun Heo } 5038db7bccf4STejun Heo 5039bd7c089eSTejun Heo /** 5040bd7c089eSTejun Heo * rebind_workers - rebind all workers of a pool to the associated CPU 5041bd7c089eSTejun Heo * @pool: pool of interest 5042bd7c089eSTejun Heo * 5043a9ab775bSTejun Heo * @pool->cpu is coming online. Rebind all workers to the CPU. 5044bd7c089eSTejun Heo */ 5045bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool) 5046bd7c089eSTejun Heo { 5047a9ab775bSTejun Heo struct worker *worker; 5048bd7c089eSTejun Heo 50491258fae7STejun Heo lockdep_assert_held(&wq_pool_attach_mutex); 5050bd7c089eSTejun Heo 5051bd7c089eSTejun Heo /* 5052a9ab775bSTejun Heo * Restore CPU affinity of all workers. As all idle workers should 5053a9ab775bSTejun Heo * be on the run-queue of the associated CPU before any local 5054402dd89dSShailendra Verma * wake-ups for concurrency management happen, restore CPU affinity 5055a9ab775bSTejun Heo * of all workers first and then clear UNBOUND. As we're called 5056a9ab775bSTejun Heo * from CPU_ONLINE, the following shouldn't fail. 5057bd7c089eSTejun Heo */ 50585c25b5ffSPeter Zijlstra for_each_pool_worker(worker, pool) { 50595c25b5ffSPeter Zijlstra kthread_set_per_cpu(worker->task, pool->cpu); 5060a9ab775bSTejun Heo WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, 5061a9ab775bSTejun Heo pool->attrs->cpumask) < 0); 50625c25b5ffSPeter Zijlstra } 5063a9ab775bSTejun Heo 5064a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 5065f7c17d26SWanpeng Li 50663de5e884SLai Jiangshan pool->flags &= ~POOL_DISASSOCIATED; 5067a9ab775bSTejun Heo 5068da028469SLai Jiangshan for_each_pool_worker(worker, pool) { 5069a9ab775bSTejun Heo unsigned int worker_flags = worker->flags; 5070a9ab775bSTejun Heo 5071a9ab775bSTejun Heo /* 5072a9ab775bSTejun Heo * A bound idle worker should actually be on the runqueue 5073a9ab775bSTejun Heo * of the associated CPU for local wake-ups targeting it to 5074a9ab775bSTejun Heo * work. Kick all idle workers so that they migrate to the 5075a9ab775bSTejun Heo * associated CPU. Doing this in the same loop as 5076a9ab775bSTejun Heo * replacing UNBOUND with REBOUND is safe as no worker will 5077a9ab775bSTejun Heo * be bound before @pool->lock is released. 5078a9ab775bSTejun Heo */ 5079a9ab775bSTejun Heo if (worker_flags & WORKER_IDLE) 5080bd7c089eSTejun Heo wake_up_process(worker->task); 5081bd7c089eSTejun Heo 5082bd7c089eSTejun Heo /* 5083a9ab775bSTejun Heo * We want to clear UNBOUND but can't directly call 5084a9ab775bSTejun Heo * worker_clr_flags() or adjust nr_running. Atomically 5085a9ab775bSTejun Heo * replace UNBOUND with another NOT_RUNNING flag REBOUND. 5086a9ab775bSTejun Heo * @worker will clear REBOUND using worker_clr_flags() when 5087a9ab775bSTejun Heo * it initiates the next execution cycle thus restoring 5088a9ab775bSTejun Heo * concurrency management. Note that when or whether 5089a9ab775bSTejun Heo * @worker clears REBOUND doesn't affect correctness. 5090a9ab775bSTejun Heo * 5091c95491edSMark Rutland * WRITE_ONCE() is necessary because @worker->flags may be 5092a9ab775bSTejun Heo * tested without holding any lock in 50936d25be57SThomas Gleixner * wq_worker_running(). Without it, NOT_RUNNING test may 5094a9ab775bSTejun Heo * fail incorrectly leading to premature concurrency 5095a9ab775bSTejun Heo * management operations. 5096bd7c089eSTejun Heo */ 5097a9ab775bSTejun Heo WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND)); 5098a9ab775bSTejun Heo worker_flags |= WORKER_REBOUND; 5099a9ab775bSTejun Heo worker_flags &= ~WORKER_UNBOUND; 5100c95491edSMark Rutland WRITE_ONCE(worker->flags, worker_flags); 5101bd7c089eSTejun Heo } 5102a9ab775bSTejun Heo 5103a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 5104bd7c089eSTejun Heo } 5105bd7c089eSTejun Heo 51067dbc725eSTejun Heo /** 51077dbc725eSTejun Heo * restore_unbound_workers_cpumask - restore cpumask of unbound workers 51087dbc725eSTejun Heo * @pool: unbound pool of interest 51097dbc725eSTejun Heo * @cpu: the CPU which is coming up 51107dbc725eSTejun Heo * 51117dbc725eSTejun Heo * An unbound pool may end up with a cpumask which doesn't have any online 51127dbc725eSTejun Heo * CPUs. When a worker of such pool get scheduled, the scheduler resets 51137dbc725eSTejun Heo * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any 51147dbc725eSTejun Heo * online CPU before, cpus_allowed of all its workers should be restored. 51157dbc725eSTejun Heo */ 51167dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu) 51177dbc725eSTejun Heo { 51187dbc725eSTejun Heo static cpumask_t cpumask; 51197dbc725eSTejun Heo struct worker *worker; 51207dbc725eSTejun Heo 51211258fae7STejun Heo lockdep_assert_held(&wq_pool_attach_mutex); 51227dbc725eSTejun Heo 51237dbc725eSTejun Heo /* is @cpu allowed for @pool? */ 51247dbc725eSTejun Heo if (!cpumask_test_cpu(cpu, pool->attrs->cpumask)) 51257dbc725eSTejun Heo return; 51267dbc725eSTejun Heo 51277dbc725eSTejun Heo cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask); 51287dbc725eSTejun Heo 51297dbc725eSTejun Heo /* as we're called from CPU_ONLINE, the following shouldn't fail */ 5130da028469SLai Jiangshan for_each_pool_worker(worker, pool) 5131d945b5e9SPeter Zijlstra WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0); 51327dbc725eSTejun Heo } 51337dbc725eSTejun Heo 51347ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu) 51351da177e4SLinus Torvalds { 51364ce62e9eSTejun Heo struct worker_pool *pool; 51371da177e4SLinus Torvalds 5138f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 51393ce63377STejun Heo if (pool->nr_workers) 51403ce63377STejun Heo continue; 5141051e1850SLai Jiangshan if (!create_worker(pool)) 51427ee681b2SThomas Gleixner return -ENOMEM; 51433af24433SOleg Nesterov } 51447ee681b2SThomas Gleixner return 0; 51457ee681b2SThomas Gleixner } 51461da177e4SLinus Torvalds 51477ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu) 51487ee681b2SThomas Gleixner { 51497ee681b2SThomas Gleixner struct worker_pool *pool; 51507ee681b2SThomas Gleixner struct workqueue_struct *wq; 51517ee681b2SThomas Gleixner int pi; 51527ee681b2SThomas Gleixner 515368e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 51547dbc725eSTejun Heo 51557dbc725eSTejun Heo for_each_pool(pool, pi) { 51561258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 515794cf58bbSTejun Heo 5158f05b558dSLai Jiangshan if (pool->cpu == cpu) 515994cf58bbSTejun Heo rebind_workers(pool); 5160f05b558dSLai Jiangshan else if (pool->cpu < 0) 51617dbc725eSTejun Heo restore_unbound_workers_cpumask(pool, cpu); 516294cf58bbSTejun Heo 51631258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 516494cf58bbSTejun Heo } 51657dbc725eSTejun Heo 51664c16bd32STejun Heo /* update NUMA affinity of unbound workqueues */ 51674c16bd32STejun Heo list_for_each_entry(wq, &workqueues, list) 51684c16bd32STejun Heo wq_update_unbound_numa(wq, cpu, true); 51694c16bd32STejun Heo 517068e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 51717ee681b2SThomas Gleixner return 0; 517265758202STejun Heo } 517365758202STejun Heo 51747ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu) 517565758202STejun Heo { 51764c16bd32STejun Heo struct workqueue_struct *wq; 51778db25e78STejun Heo 51784c16bd32STejun Heo /* unbinding per-cpu workers should happen on the local CPU */ 5179e8b3f8dbSLai Jiangshan if (WARN_ON(cpu != smp_processor_id())) 5180e8b3f8dbSLai Jiangshan return -1; 5181e8b3f8dbSLai Jiangshan 5182e8b3f8dbSLai Jiangshan unbind_workers(cpu); 51834c16bd32STejun Heo 51844c16bd32STejun Heo /* update NUMA affinity of unbound workqueues */ 51854c16bd32STejun Heo mutex_lock(&wq_pool_mutex); 51864c16bd32STejun Heo list_for_each_entry(wq, &workqueues, list) 51874c16bd32STejun Heo wq_update_unbound_numa(wq, cpu, false); 51884c16bd32STejun Heo mutex_unlock(&wq_pool_mutex); 51894c16bd32STejun Heo 51907ee681b2SThomas Gleixner return 0; 519165758202STejun Heo } 519265758202STejun Heo 51932d3854a3SRusty Russell struct work_for_cpu { 5194ed48ece2STejun Heo struct work_struct work; 51952d3854a3SRusty Russell long (*fn)(void *); 51962d3854a3SRusty Russell void *arg; 51972d3854a3SRusty Russell long ret; 51982d3854a3SRusty Russell }; 51992d3854a3SRusty Russell 5200ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work) 52012d3854a3SRusty Russell { 5202ed48ece2STejun Heo struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work); 5203ed48ece2STejun Heo 52042d3854a3SRusty Russell wfc->ret = wfc->fn(wfc->arg); 52052d3854a3SRusty Russell } 52062d3854a3SRusty Russell 52072d3854a3SRusty Russell /** 520822aceb31SAnna-Maria Gleixner * work_on_cpu - run a function in thread context on a particular cpu 52092d3854a3SRusty Russell * @cpu: the cpu to run on 52102d3854a3SRusty Russell * @fn: the function to run 52112d3854a3SRusty Russell * @arg: the function arg 52122d3854a3SRusty Russell * 521331ad9081SRusty Russell * It is up to the caller to ensure that the cpu doesn't go offline. 52146b44003eSAndrew Morton * The caller must not hold any locks which would prevent @fn from completing. 5215d185af30SYacine Belkadi * 5216d185af30SYacine Belkadi * Return: The value @fn returns. 52172d3854a3SRusty Russell */ 5218d84ff051STejun Heo long work_on_cpu(int cpu, long (*fn)(void *), void *arg) 52192d3854a3SRusty Russell { 5220ed48ece2STejun Heo struct work_for_cpu wfc = { .fn = fn, .arg = arg }; 52212d3854a3SRusty Russell 5222ed48ece2STejun Heo INIT_WORK_ONSTACK(&wfc.work, work_for_cpu_fn); 5223ed48ece2STejun Heo schedule_work_on(cpu, &wfc.work); 522412997d1aSBjorn Helgaas flush_work(&wfc.work); 5225440a1136SChuansheng Liu destroy_work_on_stack(&wfc.work); 52262d3854a3SRusty Russell return wfc.ret; 52272d3854a3SRusty Russell } 52282d3854a3SRusty Russell EXPORT_SYMBOL_GPL(work_on_cpu); 52290e8d6a93SThomas Gleixner 52300e8d6a93SThomas Gleixner /** 52310e8d6a93SThomas Gleixner * work_on_cpu_safe - run a function in thread context on a particular cpu 52320e8d6a93SThomas Gleixner * @cpu: the cpu to run on 52330e8d6a93SThomas Gleixner * @fn: the function to run 52340e8d6a93SThomas Gleixner * @arg: the function argument 52350e8d6a93SThomas Gleixner * 52360e8d6a93SThomas Gleixner * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold 52370e8d6a93SThomas Gleixner * any locks which would prevent @fn from completing. 52380e8d6a93SThomas Gleixner * 52390e8d6a93SThomas Gleixner * Return: The value @fn returns. 52400e8d6a93SThomas Gleixner */ 52410e8d6a93SThomas Gleixner long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg) 52420e8d6a93SThomas Gleixner { 52430e8d6a93SThomas Gleixner long ret = -ENODEV; 52440e8d6a93SThomas Gleixner 5245ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 52460e8d6a93SThomas Gleixner if (cpu_online(cpu)) 52470e8d6a93SThomas Gleixner ret = work_on_cpu(cpu, fn, arg); 5248ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 52490e8d6a93SThomas Gleixner return ret; 52500e8d6a93SThomas Gleixner } 52510e8d6a93SThomas Gleixner EXPORT_SYMBOL_GPL(work_on_cpu_safe); 52522d3854a3SRusty Russell #endif /* CONFIG_SMP */ 52532d3854a3SRusty Russell 5254a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 5255e7577c50SRusty Russell 5256a0a1a5fdSTejun Heo /** 5257a0a1a5fdSTejun Heo * freeze_workqueues_begin - begin freezing workqueues 5258a0a1a5fdSTejun Heo * 525958a69cb4STejun Heo * Start freezing workqueues. After this function returns, all freezable 5260f97a4a1aSLai Jiangshan * workqueues will queue new works to their inactive_works list instead of 5261706026c2STejun Heo * pool->worklist. 5262a0a1a5fdSTejun Heo * 5263a0a1a5fdSTejun Heo * CONTEXT: 5264a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 5265a0a1a5fdSTejun Heo */ 5266a0a1a5fdSTejun Heo void freeze_workqueues_begin(void) 5267a0a1a5fdSTejun Heo { 526824b8a847STejun Heo struct workqueue_struct *wq; 526924b8a847STejun Heo struct pool_workqueue *pwq; 5270a0a1a5fdSTejun Heo 527168e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 5272a0a1a5fdSTejun Heo 52736183c009STejun Heo WARN_ON_ONCE(workqueue_freezing); 5274a0a1a5fdSTejun Heo workqueue_freezing = true; 5275a0a1a5fdSTejun Heo 527624b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 5277a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 5278699ce097STejun Heo for_each_pwq(pwq, wq) 5279699ce097STejun Heo pwq_adjust_max_active(pwq); 5280a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 5281a1056305STejun Heo } 52825bcab335STejun Heo 528368e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5284a0a1a5fdSTejun Heo } 5285a0a1a5fdSTejun Heo 5286a0a1a5fdSTejun Heo /** 528758a69cb4STejun Heo * freeze_workqueues_busy - are freezable workqueues still busy? 5288a0a1a5fdSTejun Heo * 5289a0a1a5fdSTejun Heo * Check whether freezing is complete. This function must be called 5290a0a1a5fdSTejun Heo * between freeze_workqueues_begin() and thaw_workqueues(). 5291a0a1a5fdSTejun Heo * 5292a0a1a5fdSTejun Heo * CONTEXT: 529368e13a67SLai Jiangshan * Grabs and releases wq_pool_mutex. 5294a0a1a5fdSTejun Heo * 5295d185af30SYacine Belkadi * Return: 529658a69cb4STejun Heo * %true if some freezable workqueues are still busy. %false if freezing 529758a69cb4STejun Heo * is complete. 5298a0a1a5fdSTejun Heo */ 5299a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void) 5300a0a1a5fdSTejun Heo { 5301a0a1a5fdSTejun Heo bool busy = false; 530224b8a847STejun Heo struct workqueue_struct *wq; 530324b8a847STejun Heo struct pool_workqueue *pwq; 5304a0a1a5fdSTejun Heo 530568e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 5306a0a1a5fdSTejun Heo 53076183c009STejun Heo WARN_ON_ONCE(!workqueue_freezing); 5308a0a1a5fdSTejun Heo 530924b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 531024b8a847STejun Heo if (!(wq->flags & WQ_FREEZABLE)) 531124b8a847STejun Heo continue; 5312a0a1a5fdSTejun Heo /* 5313a0a1a5fdSTejun Heo * nr_active is monotonically decreasing. It's safe 5314a0a1a5fdSTejun Heo * to peek without lock. 5315a0a1a5fdSTejun Heo */ 531624acfb71SThomas Gleixner rcu_read_lock(); 531724b8a847STejun Heo for_each_pwq(pwq, wq) { 53186183c009STejun Heo WARN_ON_ONCE(pwq->nr_active < 0); 5319112202d9STejun Heo if (pwq->nr_active) { 5320a0a1a5fdSTejun Heo busy = true; 532124acfb71SThomas Gleixner rcu_read_unlock(); 5322a0a1a5fdSTejun Heo goto out_unlock; 5323a0a1a5fdSTejun Heo } 5324a0a1a5fdSTejun Heo } 532524acfb71SThomas Gleixner rcu_read_unlock(); 5326a0a1a5fdSTejun Heo } 5327a0a1a5fdSTejun Heo out_unlock: 532868e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5329a0a1a5fdSTejun Heo return busy; 5330a0a1a5fdSTejun Heo } 5331a0a1a5fdSTejun Heo 5332a0a1a5fdSTejun Heo /** 5333a0a1a5fdSTejun Heo * thaw_workqueues - thaw workqueues 5334a0a1a5fdSTejun Heo * 5335a0a1a5fdSTejun Heo * Thaw workqueues. Normal queueing is restored and all collected 5336706026c2STejun Heo * frozen works are transferred to their respective pool worklists. 5337a0a1a5fdSTejun Heo * 5338a0a1a5fdSTejun Heo * CONTEXT: 5339a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 5340a0a1a5fdSTejun Heo */ 5341a0a1a5fdSTejun Heo void thaw_workqueues(void) 5342a0a1a5fdSTejun Heo { 534324b8a847STejun Heo struct workqueue_struct *wq; 534424b8a847STejun Heo struct pool_workqueue *pwq; 5345a0a1a5fdSTejun Heo 534668e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 5347a0a1a5fdSTejun Heo 5348a0a1a5fdSTejun Heo if (!workqueue_freezing) 5349a0a1a5fdSTejun Heo goto out_unlock; 5350a0a1a5fdSTejun Heo 535174b414eaSLai Jiangshan workqueue_freezing = false; 535224b8a847STejun Heo 535324b8a847STejun Heo /* restore max_active and repopulate worklist */ 535424b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 5355a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 5356699ce097STejun Heo for_each_pwq(pwq, wq) 5357699ce097STejun Heo pwq_adjust_max_active(pwq); 5358a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 535924b8a847STejun Heo } 536024b8a847STejun Heo 5361a0a1a5fdSTejun Heo out_unlock: 536268e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5363a0a1a5fdSTejun Heo } 5364a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 5365a0a1a5fdSTejun Heo 5366042f7df1SLai Jiangshan static int workqueue_apply_unbound_cpumask(void) 5367042f7df1SLai Jiangshan { 5368042f7df1SLai Jiangshan LIST_HEAD(ctxs); 5369042f7df1SLai Jiangshan int ret = 0; 5370042f7df1SLai Jiangshan struct workqueue_struct *wq; 5371042f7df1SLai Jiangshan struct apply_wqattrs_ctx *ctx, *n; 5372042f7df1SLai Jiangshan 5373042f7df1SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 5374042f7df1SLai Jiangshan 5375042f7df1SLai Jiangshan list_for_each_entry(wq, &workqueues, list) { 5376042f7df1SLai Jiangshan if (!(wq->flags & WQ_UNBOUND)) 5377042f7df1SLai Jiangshan continue; 5378042f7df1SLai Jiangshan /* creating multiple pwqs breaks ordering guarantee */ 5379042f7df1SLai Jiangshan if (wq->flags & __WQ_ORDERED) 5380042f7df1SLai Jiangshan continue; 5381042f7df1SLai Jiangshan 5382042f7df1SLai Jiangshan ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs); 5383042f7df1SLai Jiangshan if (!ctx) { 5384042f7df1SLai Jiangshan ret = -ENOMEM; 5385042f7df1SLai Jiangshan break; 5386042f7df1SLai Jiangshan } 5387042f7df1SLai Jiangshan 5388042f7df1SLai Jiangshan list_add_tail(&ctx->list, &ctxs); 5389042f7df1SLai Jiangshan } 5390042f7df1SLai Jiangshan 5391042f7df1SLai Jiangshan list_for_each_entry_safe(ctx, n, &ctxs, list) { 5392042f7df1SLai Jiangshan if (!ret) 5393042f7df1SLai Jiangshan apply_wqattrs_commit(ctx); 5394042f7df1SLai Jiangshan apply_wqattrs_cleanup(ctx); 5395042f7df1SLai Jiangshan } 5396042f7df1SLai Jiangshan 5397042f7df1SLai Jiangshan return ret; 5398042f7df1SLai Jiangshan } 5399042f7df1SLai Jiangshan 5400042f7df1SLai Jiangshan /** 5401042f7df1SLai Jiangshan * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask 5402042f7df1SLai Jiangshan * @cpumask: the cpumask to set 5403042f7df1SLai Jiangshan * 5404042f7df1SLai Jiangshan * The low-level workqueues cpumask is a global cpumask that limits 5405042f7df1SLai Jiangshan * the affinity of all unbound workqueues. This function check the @cpumask 5406042f7df1SLai Jiangshan * and apply it to all unbound workqueues and updates all pwqs of them. 5407042f7df1SLai Jiangshan * 540867dc8325SCai Huoqing * Return: 0 - Success 5409042f7df1SLai Jiangshan * -EINVAL - Invalid @cpumask 5410042f7df1SLai Jiangshan * -ENOMEM - Failed to allocate memory for attrs or pwqs. 5411042f7df1SLai Jiangshan */ 5412042f7df1SLai Jiangshan int workqueue_set_unbound_cpumask(cpumask_var_t cpumask) 5413042f7df1SLai Jiangshan { 5414042f7df1SLai Jiangshan int ret = -EINVAL; 5415042f7df1SLai Jiangshan cpumask_var_t saved_cpumask; 5416042f7df1SLai Jiangshan 5417c98a9805STal Shorer /* 5418c98a9805STal Shorer * Not excluding isolated cpus on purpose. 5419c98a9805STal Shorer * If the user wishes to include them, we allow that. 5420c98a9805STal Shorer */ 5421042f7df1SLai Jiangshan cpumask_and(cpumask, cpumask, cpu_possible_mask); 5422042f7df1SLai Jiangshan if (!cpumask_empty(cpumask)) { 5423a0111cf6SLai Jiangshan apply_wqattrs_lock(); 5424d25302e4SMenglong Dong if (cpumask_equal(cpumask, wq_unbound_cpumask)) { 5425d25302e4SMenglong Dong ret = 0; 5426d25302e4SMenglong Dong goto out_unlock; 5427d25302e4SMenglong Dong } 5428d25302e4SMenglong Dong 5429d25302e4SMenglong Dong if (!zalloc_cpumask_var(&saved_cpumask, GFP_KERNEL)) { 5430d25302e4SMenglong Dong ret = -ENOMEM; 5431d25302e4SMenglong Dong goto out_unlock; 5432d25302e4SMenglong Dong } 5433042f7df1SLai Jiangshan 5434042f7df1SLai Jiangshan /* save the old wq_unbound_cpumask. */ 5435042f7df1SLai Jiangshan cpumask_copy(saved_cpumask, wq_unbound_cpumask); 5436042f7df1SLai Jiangshan 5437042f7df1SLai Jiangshan /* update wq_unbound_cpumask at first and apply it to wqs. */ 5438042f7df1SLai Jiangshan cpumask_copy(wq_unbound_cpumask, cpumask); 5439042f7df1SLai Jiangshan ret = workqueue_apply_unbound_cpumask(); 5440042f7df1SLai Jiangshan 5441042f7df1SLai Jiangshan /* restore the wq_unbound_cpumask when failed. */ 5442042f7df1SLai Jiangshan if (ret < 0) 5443042f7df1SLai Jiangshan cpumask_copy(wq_unbound_cpumask, saved_cpumask); 5444042f7df1SLai Jiangshan 5445d25302e4SMenglong Dong free_cpumask_var(saved_cpumask); 5446d25302e4SMenglong Dong out_unlock: 5447a0111cf6SLai Jiangshan apply_wqattrs_unlock(); 5448042f7df1SLai Jiangshan } 5449042f7df1SLai Jiangshan 5450042f7df1SLai Jiangshan return ret; 5451042f7df1SLai Jiangshan } 5452042f7df1SLai Jiangshan 54536ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS 54546ba94429SFrederic Weisbecker /* 54556ba94429SFrederic Weisbecker * Workqueues with WQ_SYSFS flag set is visible to userland via 54566ba94429SFrederic Weisbecker * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the 54576ba94429SFrederic Weisbecker * following attributes. 54586ba94429SFrederic Weisbecker * 54596ba94429SFrederic Weisbecker * per_cpu RO bool : whether the workqueue is per-cpu or unbound 54606ba94429SFrederic Weisbecker * max_active RW int : maximum number of in-flight work items 54616ba94429SFrederic Weisbecker * 54626ba94429SFrederic Weisbecker * Unbound workqueues have the following extra attributes. 54636ba94429SFrederic Weisbecker * 54649a19b463SWang Long * pool_ids RO int : the associated pool IDs for each node 54656ba94429SFrederic Weisbecker * nice RW int : nice value of the workers 54666ba94429SFrederic Weisbecker * cpumask RW mask : bitmask of allowed CPUs for the workers 54679a19b463SWang Long * numa RW bool : whether enable NUMA affinity 54686ba94429SFrederic Weisbecker */ 54696ba94429SFrederic Weisbecker struct wq_device { 54706ba94429SFrederic Weisbecker struct workqueue_struct *wq; 54716ba94429SFrederic Weisbecker struct device dev; 54726ba94429SFrederic Weisbecker }; 54736ba94429SFrederic Weisbecker 54746ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev) 54756ba94429SFrederic Weisbecker { 54766ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 54776ba94429SFrederic Weisbecker 54786ba94429SFrederic Weisbecker return wq_dev->wq; 54796ba94429SFrederic Weisbecker } 54806ba94429SFrederic Weisbecker 54816ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr, 54826ba94429SFrederic Weisbecker char *buf) 54836ba94429SFrederic Weisbecker { 54846ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 54856ba94429SFrederic Weisbecker 54866ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND)); 54876ba94429SFrederic Weisbecker } 54886ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu); 54896ba94429SFrederic Weisbecker 54906ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev, 54916ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 54926ba94429SFrederic Weisbecker { 54936ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 54946ba94429SFrederic Weisbecker 54956ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active); 54966ba94429SFrederic Weisbecker } 54976ba94429SFrederic Weisbecker 54986ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev, 54996ba94429SFrederic Weisbecker struct device_attribute *attr, const char *buf, 55006ba94429SFrederic Weisbecker size_t count) 55016ba94429SFrederic Weisbecker { 55026ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 55036ba94429SFrederic Weisbecker int val; 55046ba94429SFrederic Weisbecker 55056ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &val) != 1 || val <= 0) 55066ba94429SFrederic Weisbecker return -EINVAL; 55076ba94429SFrederic Weisbecker 55086ba94429SFrederic Weisbecker workqueue_set_max_active(wq, val); 55096ba94429SFrederic Weisbecker return count; 55106ba94429SFrederic Weisbecker } 55116ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active); 55126ba94429SFrederic Weisbecker 55136ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = { 55146ba94429SFrederic Weisbecker &dev_attr_per_cpu.attr, 55156ba94429SFrederic Weisbecker &dev_attr_max_active.attr, 55166ba94429SFrederic Weisbecker NULL, 55176ba94429SFrederic Weisbecker }; 55186ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs); 55196ba94429SFrederic Weisbecker 55206ba94429SFrederic Weisbecker static ssize_t wq_pool_ids_show(struct device *dev, 55216ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 55226ba94429SFrederic Weisbecker { 55236ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 55246ba94429SFrederic Weisbecker const char *delim = ""; 55256ba94429SFrederic Weisbecker int node, written = 0; 55266ba94429SFrederic Weisbecker 5527ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 552824acfb71SThomas Gleixner rcu_read_lock(); 55296ba94429SFrederic Weisbecker for_each_node(node) { 55306ba94429SFrederic Weisbecker written += scnprintf(buf + written, PAGE_SIZE - written, 55316ba94429SFrederic Weisbecker "%s%d:%d", delim, node, 55326ba94429SFrederic Weisbecker unbound_pwq_by_node(wq, node)->pool->id); 55336ba94429SFrederic Weisbecker delim = " "; 55346ba94429SFrederic Weisbecker } 55356ba94429SFrederic Weisbecker written += scnprintf(buf + written, PAGE_SIZE - written, "\n"); 553624acfb71SThomas Gleixner rcu_read_unlock(); 5537ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 55386ba94429SFrederic Weisbecker 55396ba94429SFrederic Weisbecker return written; 55406ba94429SFrederic Weisbecker } 55416ba94429SFrederic Weisbecker 55426ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr, 55436ba94429SFrederic Weisbecker char *buf) 55446ba94429SFrederic Weisbecker { 55456ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 55466ba94429SFrederic Weisbecker int written; 55476ba94429SFrederic Weisbecker 55486ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 55496ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice); 55506ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 55516ba94429SFrederic Weisbecker 55526ba94429SFrederic Weisbecker return written; 55536ba94429SFrederic Weisbecker } 55546ba94429SFrederic Weisbecker 55556ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */ 55566ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq) 55576ba94429SFrederic Weisbecker { 55586ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 55596ba94429SFrederic Weisbecker 5560899a94feSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 5561899a94feSLai Jiangshan 5562be69d00dSThomas Gleixner attrs = alloc_workqueue_attrs(); 55636ba94429SFrederic Weisbecker if (!attrs) 55646ba94429SFrederic Weisbecker return NULL; 55656ba94429SFrederic Weisbecker 55666ba94429SFrederic Weisbecker copy_workqueue_attrs(attrs, wq->unbound_attrs); 55676ba94429SFrederic Weisbecker return attrs; 55686ba94429SFrederic Weisbecker } 55696ba94429SFrederic Weisbecker 55706ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr, 55716ba94429SFrederic Weisbecker const char *buf, size_t count) 55726ba94429SFrederic Weisbecker { 55736ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 55746ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 5575d4d3e257SLai Jiangshan int ret = -ENOMEM; 5576d4d3e257SLai Jiangshan 5577d4d3e257SLai Jiangshan apply_wqattrs_lock(); 55786ba94429SFrederic Weisbecker 55796ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 55806ba94429SFrederic Weisbecker if (!attrs) 5581d4d3e257SLai Jiangshan goto out_unlock; 55826ba94429SFrederic Weisbecker 55836ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &attrs->nice) == 1 && 55846ba94429SFrederic Weisbecker attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE) 5585d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 55866ba94429SFrederic Weisbecker else 55876ba94429SFrederic Weisbecker ret = -EINVAL; 55886ba94429SFrederic Weisbecker 5589d4d3e257SLai Jiangshan out_unlock: 5590d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 55916ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 55926ba94429SFrederic Weisbecker return ret ?: count; 55936ba94429SFrederic Weisbecker } 55946ba94429SFrederic Weisbecker 55956ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev, 55966ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 55976ba94429SFrederic Weisbecker { 55986ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 55996ba94429SFrederic Weisbecker int written; 56006ba94429SFrederic Weisbecker 56016ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 56026ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%*pb\n", 56036ba94429SFrederic Weisbecker cpumask_pr_args(wq->unbound_attrs->cpumask)); 56046ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 56056ba94429SFrederic Weisbecker return written; 56066ba94429SFrederic Weisbecker } 56076ba94429SFrederic Weisbecker 56086ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev, 56096ba94429SFrederic Weisbecker struct device_attribute *attr, 56106ba94429SFrederic Weisbecker const char *buf, size_t count) 56116ba94429SFrederic Weisbecker { 56126ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 56136ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 5614d4d3e257SLai Jiangshan int ret = -ENOMEM; 5615d4d3e257SLai Jiangshan 5616d4d3e257SLai Jiangshan apply_wqattrs_lock(); 56176ba94429SFrederic Weisbecker 56186ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 56196ba94429SFrederic Weisbecker if (!attrs) 5620d4d3e257SLai Jiangshan goto out_unlock; 56216ba94429SFrederic Weisbecker 56226ba94429SFrederic Weisbecker ret = cpumask_parse(buf, attrs->cpumask); 56236ba94429SFrederic Weisbecker if (!ret) 5624d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 56256ba94429SFrederic Weisbecker 5626d4d3e257SLai Jiangshan out_unlock: 5627d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 56286ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 56296ba94429SFrederic Weisbecker return ret ?: count; 56306ba94429SFrederic Weisbecker } 56316ba94429SFrederic Weisbecker 56326ba94429SFrederic Weisbecker static ssize_t wq_numa_show(struct device *dev, struct device_attribute *attr, 56336ba94429SFrederic Weisbecker char *buf) 56346ba94429SFrederic Weisbecker { 56356ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 56366ba94429SFrederic Weisbecker int written; 56376ba94429SFrederic Weisbecker 56386ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 56396ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%d\n", 56406ba94429SFrederic Weisbecker !wq->unbound_attrs->no_numa); 56416ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 56426ba94429SFrederic Weisbecker 56436ba94429SFrederic Weisbecker return written; 56446ba94429SFrederic Weisbecker } 56456ba94429SFrederic Weisbecker 56466ba94429SFrederic Weisbecker static ssize_t wq_numa_store(struct device *dev, struct device_attribute *attr, 56476ba94429SFrederic Weisbecker const char *buf, size_t count) 56486ba94429SFrederic Weisbecker { 56496ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 56506ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 5651d4d3e257SLai Jiangshan int v, ret = -ENOMEM; 5652d4d3e257SLai Jiangshan 5653d4d3e257SLai Jiangshan apply_wqattrs_lock(); 56546ba94429SFrederic Weisbecker 56556ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 56566ba94429SFrederic Weisbecker if (!attrs) 5657d4d3e257SLai Jiangshan goto out_unlock; 56586ba94429SFrederic Weisbecker 56596ba94429SFrederic Weisbecker ret = -EINVAL; 56606ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &v) == 1) { 56616ba94429SFrederic Weisbecker attrs->no_numa = !v; 5662d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 56636ba94429SFrederic Weisbecker } 56646ba94429SFrederic Weisbecker 5665d4d3e257SLai Jiangshan out_unlock: 5666d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 56676ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 56686ba94429SFrederic Weisbecker return ret ?: count; 56696ba94429SFrederic Weisbecker } 56706ba94429SFrederic Weisbecker 56716ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = { 56726ba94429SFrederic Weisbecker __ATTR(pool_ids, 0444, wq_pool_ids_show, NULL), 56736ba94429SFrederic Weisbecker __ATTR(nice, 0644, wq_nice_show, wq_nice_store), 56746ba94429SFrederic Weisbecker __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store), 56756ba94429SFrederic Weisbecker __ATTR(numa, 0644, wq_numa_show, wq_numa_store), 56766ba94429SFrederic Weisbecker __ATTR_NULL, 56776ba94429SFrederic Weisbecker }; 56786ba94429SFrederic Weisbecker 56796ba94429SFrederic Weisbecker static struct bus_type wq_subsys = { 56806ba94429SFrederic Weisbecker .name = "workqueue", 56816ba94429SFrederic Weisbecker .dev_groups = wq_sysfs_groups, 56826ba94429SFrederic Weisbecker }; 56836ba94429SFrederic Weisbecker 5684b05a7928SFrederic Weisbecker static ssize_t wq_unbound_cpumask_show(struct device *dev, 5685b05a7928SFrederic Weisbecker struct device_attribute *attr, char *buf) 5686b05a7928SFrederic Weisbecker { 5687b05a7928SFrederic Weisbecker int written; 5688b05a7928SFrederic Weisbecker 5689042f7df1SLai Jiangshan mutex_lock(&wq_pool_mutex); 5690b05a7928SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%*pb\n", 5691b05a7928SFrederic Weisbecker cpumask_pr_args(wq_unbound_cpumask)); 5692042f7df1SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5693b05a7928SFrederic Weisbecker 5694b05a7928SFrederic Weisbecker return written; 5695b05a7928SFrederic Weisbecker } 5696b05a7928SFrederic Weisbecker 5697042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev, 5698042f7df1SLai Jiangshan struct device_attribute *attr, const char *buf, size_t count) 5699042f7df1SLai Jiangshan { 5700042f7df1SLai Jiangshan cpumask_var_t cpumask; 5701042f7df1SLai Jiangshan int ret; 5702042f7df1SLai Jiangshan 5703042f7df1SLai Jiangshan if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL)) 5704042f7df1SLai Jiangshan return -ENOMEM; 5705042f7df1SLai Jiangshan 5706042f7df1SLai Jiangshan ret = cpumask_parse(buf, cpumask); 5707042f7df1SLai Jiangshan if (!ret) 5708042f7df1SLai Jiangshan ret = workqueue_set_unbound_cpumask(cpumask); 5709042f7df1SLai Jiangshan 5710042f7df1SLai Jiangshan free_cpumask_var(cpumask); 5711042f7df1SLai Jiangshan return ret ? ret : count; 5712042f7df1SLai Jiangshan } 5713042f7df1SLai Jiangshan 5714b05a7928SFrederic Weisbecker static struct device_attribute wq_sysfs_cpumask_attr = 5715042f7df1SLai Jiangshan __ATTR(cpumask, 0644, wq_unbound_cpumask_show, 5716042f7df1SLai Jiangshan wq_unbound_cpumask_store); 5717b05a7928SFrederic Weisbecker 57186ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void) 57196ba94429SFrederic Weisbecker { 5720b05a7928SFrederic Weisbecker int err; 5721b05a7928SFrederic Weisbecker 5722b05a7928SFrederic Weisbecker err = subsys_virtual_register(&wq_subsys, NULL); 5723b05a7928SFrederic Weisbecker if (err) 5724b05a7928SFrederic Weisbecker return err; 5725b05a7928SFrederic Weisbecker 5726b05a7928SFrederic Weisbecker return device_create_file(wq_subsys.dev_root, &wq_sysfs_cpumask_attr); 57276ba94429SFrederic Weisbecker } 57286ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init); 57296ba94429SFrederic Weisbecker 57306ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev) 57316ba94429SFrederic Weisbecker { 57326ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 57336ba94429SFrederic Weisbecker 57346ba94429SFrederic Weisbecker kfree(wq_dev); 57356ba94429SFrederic Weisbecker } 57366ba94429SFrederic Weisbecker 57376ba94429SFrederic Weisbecker /** 57386ba94429SFrederic Weisbecker * workqueue_sysfs_register - make a workqueue visible in sysfs 57396ba94429SFrederic Weisbecker * @wq: the workqueue to register 57406ba94429SFrederic Weisbecker * 57416ba94429SFrederic Weisbecker * Expose @wq in sysfs under /sys/bus/workqueue/devices. 57426ba94429SFrederic Weisbecker * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set 57436ba94429SFrederic Weisbecker * which is the preferred method. 57446ba94429SFrederic Weisbecker * 57456ba94429SFrederic Weisbecker * Workqueue user should use this function directly iff it wants to apply 57466ba94429SFrederic Weisbecker * workqueue_attrs before making the workqueue visible in sysfs; otherwise, 57476ba94429SFrederic Weisbecker * apply_workqueue_attrs() may race against userland updating the 57486ba94429SFrederic Weisbecker * attributes. 57496ba94429SFrederic Weisbecker * 57506ba94429SFrederic Weisbecker * Return: 0 on success, -errno on failure. 57516ba94429SFrederic Weisbecker */ 57526ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq) 57536ba94429SFrederic Weisbecker { 57546ba94429SFrederic Weisbecker struct wq_device *wq_dev; 57556ba94429SFrederic Weisbecker int ret; 57566ba94429SFrederic Weisbecker 57576ba94429SFrederic Weisbecker /* 5758402dd89dSShailendra Verma * Adjusting max_active or creating new pwqs by applying 57596ba94429SFrederic Weisbecker * attributes breaks ordering guarantee. Disallow exposing ordered 57606ba94429SFrederic Weisbecker * workqueues. 57616ba94429SFrederic Weisbecker */ 57620a94efb5STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) 57636ba94429SFrederic Weisbecker return -EINVAL; 57646ba94429SFrederic Weisbecker 57656ba94429SFrederic Weisbecker wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL); 57666ba94429SFrederic Weisbecker if (!wq_dev) 57676ba94429SFrederic Weisbecker return -ENOMEM; 57686ba94429SFrederic Weisbecker 57696ba94429SFrederic Weisbecker wq_dev->wq = wq; 57706ba94429SFrederic Weisbecker wq_dev->dev.bus = &wq_subsys; 57716ba94429SFrederic Weisbecker wq_dev->dev.release = wq_device_release; 577223217b44SLars-Peter Clausen dev_set_name(&wq_dev->dev, "%s", wq->name); 57736ba94429SFrederic Weisbecker 57746ba94429SFrederic Weisbecker /* 57756ba94429SFrederic Weisbecker * unbound_attrs are created separately. Suppress uevent until 57766ba94429SFrederic Weisbecker * everything is ready. 57776ba94429SFrederic Weisbecker */ 57786ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, true); 57796ba94429SFrederic Weisbecker 57806ba94429SFrederic Weisbecker ret = device_register(&wq_dev->dev); 57816ba94429SFrederic Weisbecker if (ret) { 5782537f4146SArvind Yadav put_device(&wq_dev->dev); 57836ba94429SFrederic Weisbecker wq->wq_dev = NULL; 57846ba94429SFrederic Weisbecker return ret; 57856ba94429SFrederic Weisbecker } 57866ba94429SFrederic Weisbecker 57876ba94429SFrederic Weisbecker if (wq->flags & WQ_UNBOUND) { 57886ba94429SFrederic Weisbecker struct device_attribute *attr; 57896ba94429SFrederic Weisbecker 57906ba94429SFrederic Weisbecker for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) { 57916ba94429SFrederic Weisbecker ret = device_create_file(&wq_dev->dev, attr); 57926ba94429SFrederic Weisbecker if (ret) { 57936ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 57946ba94429SFrederic Weisbecker wq->wq_dev = NULL; 57956ba94429SFrederic Weisbecker return ret; 57966ba94429SFrederic Weisbecker } 57976ba94429SFrederic Weisbecker } 57986ba94429SFrederic Weisbecker } 57996ba94429SFrederic Weisbecker 58006ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, false); 58016ba94429SFrederic Weisbecker kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD); 58026ba94429SFrederic Weisbecker return 0; 58036ba94429SFrederic Weisbecker } 58046ba94429SFrederic Weisbecker 58056ba94429SFrederic Weisbecker /** 58066ba94429SFrederic Weisbecker * workqueue_sysfs_unregister - undo workqueue_sysfs_register() 58076ba94429SFrederic Weisbecker * @wq: the workqueue to unregister 58086ba94429SFrederic Weisbecker * 58096ba94429SFrederic Weisbecker * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister. 58106ba94429SFrederic Weisbecker */ 58116ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) 58126ba94429SFrederic Weisbecker { 58136ba94429SFrederic Weisbecker struct wq_device *wq_dev = wq->wq_dev; 58146ba94429SFrederic Weisbecker 58156ba94429SFrederic Weisbecker if (!wq->wq_dev) 58166ba94429SFrederic Weisbecker return; 58176ba94429SFrederic Weisbecker 58186ba94429SFrederic Weisbecker wq->wq_dev = NULL; 58196ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 58206ba94429SFrederic Weisbecker } 58216ba94429SFrederic Weisbecker #else /* CONFIG_SYSFS */ 58226ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { } 58236ba94429SFrederic Weisbecker #endif /* CONFIG_SYSFS */ 58246ba94429SFrederic Weisbecker 582582607adcSTejun Heo /* 582682607adcSTejun Heo * Workqueue watchdog. 582782607adcSTejun Heo * 582882607adcSTejun Heo * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal 582982607adcSTejun Heo * flush dependency, a concurrency managed work item which stays RUNNING 583082607adcSTejun Heo * indefinitely. Workqueue stalls can be very difficult to debug as the 583182607adcSTejun Heo * usual warning mechanisms don't trigger and internal workqueue state is 583282607adcSTejun Heo * largely opaque. 583382607adcSTejun Heo * 583482607adcSTejun Heo * Workqueue watchdog monitors all worker pools periodically and dumps 583582607adcSTejun Heo * state if some pools failed to make forward progress for a while where 583682607adcSTejun Heo * forward progress is defined as the first item on ->worklist changing. 583782607adcSTejun Heo * 583882607adcSTejun Heo * This mechanism is controlled through the kernel parameter 583982607adcSTejun Heo * "workqueue.watchdog_thresh" which can be updated at runtime through the 584082607adcSTejun Heo * corresponding sysfs parameter file. 584182607adcSTejun Heo */ 584282607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG 584382607adcSTejun Heo 584482607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30; 58455cd79d6aSKees Cook static struct timer_list wq_watchdog_timer; 584682607adcSTejun Heo 584782607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES; 584882607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES; 584982607adcSTejun Heo 585082607adcSTejun Heo static void wq_watchdog_reset_touched(void) 585182607adcSTejun Heo { 585282607adcSTejun Heo int cpu; 585382607adcSTejun Heo 585482607adcSTejun Heo wq_watchdog_touched = jiffies; 585582607adcSTejun Heo for_each_possible_cpu(cpu) 585682607adcSTejun Heo per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies; 585782607adcSTejun Heo } 585882607adcSTejun Heo 58595cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused) 586082607adcSTejun Heo { 586182607adcSTejun Heo unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ; 586282607adcSTejun Heo bool lockup_detected = false; 5863940d71c6SSergey Senozhatsky unsigned long now = jiffies; 586482607adcSTejun Heo struct worker_pool *pool; 586582607adcSTejun Heo int pi; 586682607adcSTejun Heo 586782607adcSTejun Heo if (!thresh) 586882607adcSTejun Heo return; 586982607adcSTejun Heo 587082607adcSTejun Heo rcu_read_lock(); 587182607adcSTejun Heo 587282607adcSTejun Heo for_each_pool(pool, pi) { 587382607adcSTejun Heo unsigned long pool_ts, touched, ts; 587482607adcSTejun Heo 587582607adcSTejun Heo if (list_empty(&pool->worklist)) 587682607adcSTejun Heo continue; 587782607adcSTejun Heo 5878940d71c6SSergey Senozhatsky /* 5879940d71c6SSergey Senozhatsky * If a virtual machine is stopped by the host it can look to 5880940d71c6SSergey Senozhatsky * the watchdog like a stall. 5881940d71c6SSergey Senozhatsky */ 5882940d71c6SSergey Senozhatsky kvm_check_and_clear_guest_paused(); 5883940d71c6SSergey Senozhatsky 588482607adcSTejun Heo /* get the latest of pool and touched timestamps */ 588589e28ce6SWang Qing if (pool->cpu >= 0) 588689e28ce6SWang Qing touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu)); 588789e28ce6SWang Qing else 588882607adcSTejun Heo touched = READ_ONCE(wq_watchdog_touched); 588989e28ce6SWang Qing pool_ts = READ_ONCE(pool->watchdog_ts); 589082607adcSTejun Heo 589182607adcSTejun Heo if (time_after(pool_ts, touched)) 589282607adcSTejun Heo ts = pool_ts; 589382607adcSTejun Heo else 589482607adcSTejun Heo ts = touched; 589582607adcSTejun Heo 589682607adcSTejun Heo /* did we stall? */ 5897940d71c6SSergey Senozhatsky if (time_after(now, ts + thresh)) { 589882607adcSTejun Heo lockup_detected = true; 589982607adcSTejun Heo pr_emerg("BUG: workqueue lockup - pool"); 590082607adcSTejun Heo pr_cont_pool_info(pool); 590182607adcSTejun Heo pr_cont(" stuck for %us!\n", 5902940d71c6SSergey Senozhatsky jiffies_to_msecs(now - pool_ts) / 1000); 590382607adcSTejun Heo } 590482607adcSTejun Heo } 590582607adcSTejun Heo 590682607adcSTejun Heo rcu_read_unlock(); 590782607adcSTejun Heo 590882607adcSTejun Heo if (lockup_detected) 590955df0933SImran Khan show_all_workqueues(); 591082607adcSTejun Heo 591182607adcSTejun Heo wq_watchdog_reset_touched(); 591282607adcSTejun Heo mod_timer(&wq_watchdog_timer, jiffies + thresh); 591382607adcSTejun Heo } 591482607adcSTejun Heo 5915cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu) 591682607adcSTejun Heo { 591782607adcSTejun Heo if (cpu >= 0) 591882607adcSTejun Heo per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies; 591989e28ce6SWang Qing 592082607adcSTejun Heo wq_watchdog_touched = jiffies; 592182607adcSTejun Heo } 592282607adcSTejun Heo 592382607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh) 592482607adcSTejun Heo { 592582607adcSTejun Heo wq_watchdog_thresh = 0; 592682607adcSTejun Heo del_timer_sync(&wq_watchdog_timer); 592782607adcSTejun Heo 592882607adcSTejun Heo if (thresh) { 592982607adcSTejun Heo wq_watchdog_thresh = thresh; 593082607adcSTejun Heo wq_watchdog_reset_touched(); 593182607adcSTejun Heo mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ); 593282607adcSTejun Heo } 593382607adcSTejun Heo } 593482607adcSTejun Heo 593582607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val, 593682607adcSTejun Heo const struct kernel_param *kp) 593782607adcSTejun Heo { 593882607adcSTejun Heo unsigned long thresh; 593982607adcSTejun Heo int ret; 594082607adcSTejun Heo 594182607adcSTejun Heo ret = kstrtoul(val, 0, &thresh); 594282607adcSTejun Heo if (ret) 594382607adcSTejun Heo return ret; 594482607adcSTejun Heo 594582607adcSTejun Heo if (system_wq) 594682607adcSTejun Heo wq_watchdog_set_thresh(thresh); 594782607adcSTejun Heo else 594882607adcSTejun Heo wq_watchdog_thresh = thresh; 594982607adcSTejun Heo 595082607adcSTejun Heo return 0; 595182607adcSTejun Heo } 595282607adcSTejun Heo 595382607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = { 595482607adcSTejun Heo .set = wq_watchdog_param_set_thresh, 595582607adcSTejun Heo .get = param_get_ulong, 595682607adcSTejun Heo }; 595782607adcSTejun Heo 595882607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh, 595982607adcSTejun Heo 0644); 596082607adcSTejun Heo 596182607adcSTejun Heo static void wq_watchdog_init(void) 596282607adcSTejun Heo { 59635cd79d6aSKees Cook timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE); 596482607adcSTejun Heo wq_watchdog_set_thresh(wq_watchdog_thresh); 596582607adcSTejun Heo } 596682607adcSTejun Heo 596782607adcSTejun Heo #else /* CONFIG_WQ_WATCHDOG */ 596882607adcSTejun Heo 596982607adcSTejun Heo static inline void wq_watchdog_init(void) { } 597082607adcSTejun Heo 597182607adcSTejun Heo #endif /* CONFIG_WQ_WATCHDOG */ 597282607adcSTejun Heo 5973bce90380STejun Heo static void __init wq_numa_init(void) 5974bce90380STejun Heo { 5975bce90380STejun Heo cpumask_var_t *tbl; 5976bce90380STejun Heo int node, cpu; 5977bce90380STejun Heo 5978bce90380STejun Heo if (num_possible_nodes() <= 1) 5979bce90380STejun Heo return; 5980bce90380STejun Heo 5981d55262c4STejun Heo if (wq_disable_numa) { 5982d55262c4STejun Heo pr_info("workqueue: NUMA affinity support disabled\n"); 5983d55262c4STejun Heo return; 5984d55262c4STejun Heo } 5985d55262c4STejun Heo 5986f728c4a9SZhen Lei for_each_possible_cpu(cpu) { 5987f728c4a9SZhen Lei if (WARN_ON(cpu_to_node(cpu) == NUMA_NO_NODE)) { 5988f728c4a9SZhen Lei pr_warn("workqueue: NUMA node mapping not available for cpu%d, disabling NUMA support\n", cpu); 5989f728c4a9SZhen Lei return; 5990f728c4a9SZhen Lei } 5991f728c4a9SZhen Lei } 5992f728c4a9SZhen Lei 5993be69d00dSThomas Gleixner wq_update_unbound_numa_attrs_buf = alloc_workqueue_attrs(); 59944c16bd32STejun Heo BUG_ON(!wq_update_unbound_numa_attrs_buf); 59954c16bd32STejun Heo 5996bce90380STejun Heo /* 5997bce90380STejun Heo * We want masks of possible CPUs of each node which isn't readily 5998bce90380STejun Heo * available. Build one from cpu_to_node() which should have been 5999bce90380STejun Heo * fully initialized by now. 6000bce90380STejun Heo */ 60016396bb22SKees Cook tbl = kcalloc(nr_node_ids, sizeof(tbl[0]), GFP_KERNEL); 6002bce90380STejun Heo BUG_ON(!tbl); 6003bce90380STejun Heo 6004bce90380STejun Heo for_each_node(node) 60055a6024f1SYasuaki Ishimatsu BUG_ON(!zalloc_cpumask_var_node(&tbl[node], GFP_KERNEL, 60061be0c25dSTejun Heo node_online(node) ? node : NUMA_NO_NODE)); 6007bce90380STejun Heo 6008bce90380STejun Heo for_each_possible_cpu(cpu) { 6009bce90380STejun Heo node = cpu_to_node(cpu); 6010bce90380STejun Heo cpumask_set_cpu(cpu, tbl[node]); 6011bce90380STejun Heo } 6012bce90380STejun Heo 6013bce90380STejun Heo wq_numa_possible_cpumask = tbl; 6014bce90380STejun Heo wq_numa_enabled = true; 6015bce90380STejun Heo } 6016bce90380STejun Heo 60173347fa09STejun Heo /** 60183347fa09STejun Heo * workqueue_init_early - early init for workqueue subsystem 60193347fa09STejun Heo * 60203347fa09STejun Heo * This is the first half of two-staged workqueue subsystem initialization 60213347fa09STejun Heo * and invoked as soon as the bare basics - memory allocation, cpumasks and 60223347fa09STejun Heo * idr are up. It sets up all the data structures and system workqueues 60233347fa09STejun Heo * and allows early boot code to create workqueues and queue/cancel work 60243347fa09STejun Heo * items. Actual work item execution starts only after kthreads can be 60253347fa09STejun Heo * created and scheduled right before early initcalls. 60263347fa09STejun Heo */ 60272333e829SYu Chen void __init workqueue_init_early(void) 60281da177e4SLinus Torvalds { 60297a4e344cSTejun Heo int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL }; 60301bda3f80SFrederic Weisbecker int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ; 60317a4e344cSTejun Heo int i, cpu; 6032c34056a3STejun Heo 603310cdb157SLai Jiangshan BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long)); 6034e904e6c2STejun Heo 6035b05a7928SFrederic Weisbecker BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL)); 60361bda3f80SFrederic Weisbecker cpumask_copy(wq_unbound_cpumask, housekeeping_cpumask(hk_flags)); 6037b05a7928SFrederic Weisbecker 6038e904e6c2STejun Heo pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC); 6039e904e6c2STejun Heo 6040706026c2STejun Heo /* initialize CPU pools */ 604129c91e99STejun Heo for_each_possible_cpu(cpu) { 60424ce62e9eSTejun Heo struct worker_pool *pool; 60438b03ae3cSTejun Heo 60447a4e344cSTejun Heo i = 0; 6045f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 60467a4e344cSTejun Heo BUG_ON(init_worker_pool(pool)); 6047ec22ca5eSTejun Heo pool->cpu = cpu; 60487a4e344cSTejun Heo cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu)); 60497a4e344cSTejun Heo pool->attrs->nice = std_nice[i++]; 6050f3f90ad4STejun Heo pool->node = cpu_to_node(cpu); 60517a4e344cSTejun Heo 60529daf9e67STejun Heo /* alloc pool ID */ 605368e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 60549daf9e67STejun Heo BUG_ON(worker_pool_assign_id(pool)); 605568e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 60564ce62e9eSTejun Heo } 60578b03ae3cSTejun Heo } 60588b03ae3cSTejun Heo 60598a2b7538STejun Heo /* create default unbound and ordered wq attrs */ 606029c91e99STejun Heo for (i = 0; i < NR_STD_WORKER_POOLS; i++) { 606129c91e99STejun Heo struct workqueue_attrs *attrs; 606229c91e99STejun Heo 6063be69d00dSThomas Gleixner BUG_ON(!(attrs = alloc_workqueue_attrs())); 606429c91e99STejun Heo attrs->nice = std_nice[i]; 606529c91e99STejun Heo unbound_std_wq_attrs[i] = attrs; 60668a2b7538STejun Heo 60678a2b7538STejun Heo /* 60688a2b7538STejun Heo * An ordered wq should have only one pwq as ordering is 60698a2b7538STejun Heo * guaranteed by max_active which is enforced by pwqs. 60708a2b7538STejun Heo * Turn off NUMA so that dfl_pwq is used for all nodes. 60718a2b7538STejun Heo */ 6072be69d00dSThomas Gleixner BUG_ON(!(attrs = alloc_workqueue_attrs())); 60738a2b7538STejun Heo attrs->nice = std_nice[i]; 60748a2b7538STejun Heo attrs->no_numa = true; 60758a2b7538STejun Heo ordered_wq_attrs[i] = attrs; 607629c91e99STejun Heo } 607729c91e99STejun Heo 6078d320c038STejun Heo system_wq = alloc_workqueue("events", 0, 0); 60791aabe902SJoonsoo Kim system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0); 6080d320c038STejun Heo system_long_wq = alloc_workqueue("events_long", 0, 0); 6081f3421797STejun Heo system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, 6082f3421797STejun Heo WQ_UNBOUND_MAX_ACTIVE); 608324d51addSTejun Heo system_freezable_wq = alloc_workqueue("events_freezable", 608424d51addSTejun Heo WQ_FREEZABLE, 0); 60850668106cSViresh Kumar system_power_efficient_wq = alloc_workqueue("events_power_efficient", 60860668106cSViresh Kumar WQ_POWER_EFFICIENT, 0); 60870668106cSViresh Kumar system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_power_efficient", 60880668106cSViresh Kumar WQ_FREEZABLE | WQ_POWER_EFFICIENT, 60890668106cSViresh Kumar 0); 60901aabe902SJoonsoo Kim BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq || 60910668106cSViresh Kumar !system_unbound_wq || !system_freezable_wq || 60920668106cSViresh Kumar !system_power_efficient_wq || 60930668106cSViresh Kumar !system_freezable_power_efficient_wq); 60943347fa09STejun Heo } 60953347fa09STejun Heo 60963347fa09STejun Heo /** 60973347fa09STejun Heo * workqueue_init - bring workqueue subsystem fully online 60983347fa09STejun Heo * 60993347fa09STejun Heo * This is the latter half of two-staged workqueue subsystem initialization 61003347fa09STejun Heo * and invoked as soon as kthreads can be created and scheduled. 61013347fa09STejun Heo * Workqueues have been created and work items queued on them, but there 61023347fa09STejun Heo * are no kworkers executing the work items yet. Populate the worker pools 61033347fa09STejun Heo * with the initial workers and enable future kworker creations. 61043347fa09STejun Heo */ 61052333e829SYu Chen void __init workqueue_init(void) 61063347fa09STejun Heo { 61072186d9f9STejun Heo struct workqueue_struct *wq; 61083347fa09STejun Heo struct worker_pool *pool; 61093347fa09STejun Heo int cpu, bkt; 61103347fa09STejun Heo 61112186d9f9STejun Heo /* 61122186d9f9STejun Heo * It'd be simpler to initialize NUMA in workqueue_init_early() but 61132186d9f9STejun Heo * CPU to node mapping may not be available that early on some 61142186d9f9STejun Heo * archs such as power and arm64. As per-cpu pools created 61152186d9f9STejun Heo * previously could be missing node hint and unbound pools NUMA 61162186d9f9STejun Heo * affinity, fix them up. 611740c17f75STejun Heo * 611840c17f75STejun Heo * Also, while iterating workqueues, create rescuers if requested. 61192186d9f9STejun Heo */ 61202186d9f9STejun Heo wq_numa_init(); 61212186d9f9STejun Heo 61222186d9f9STejun Heo mutex_lock(&wq_pool_mutex); 61232186d9f9STejun Heo 61242186d9f9STejun Heo for_each_possible_cpu(cpu) { 61252186d9f9STejun Heo for_each_cpu_worker_pool(pool, cpu) { 61262186d9f9STejun Heo pool->node = cpu_to_node(cpu); 61272186d9f9STejun Heo } 61282186d9f9STejun Heo } 61292186d9f9STejun Heo 613040c17f75STejun Heo list_for_each_entry(wq, &workqueues, list) { 61312186d9f9STejun Heo wq_update_unbound_numa(wq, smp_processor_id(), true); 613240c17f75STejun Heo WARN(init_rescuer(wq), 613340c17f75STejun Heo "workqueue: failed to create early rescuer for %s", 613440c17f75STejun Heo wq->name); 613540c17f75STejun Heo } 61362186d9f9STejun Heo 61372186d9f9STejun Heo mutex_unlock(&wq_pool_mutex); 61382186d9f9STejun Heo 61393347fa09STejun Heo /* create the initial workers */ 61403347fa09STejun Heo for_each_online_cpu(cpu) { 61413347fa09STejun Heo for_each_cpu_worker_pool(pool, cpu) { 61423347fa09STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 61433347fa09STejun Heo BUG_ON(!create_worker(pool)); 61443347fa09STejun Heo } 61453347fa09STejun Heo } 61463347fa09STejun Heo 61473347fa09STejun Heo hash_for_each(unbound_pool_hash, bkt, pool, hash_node) 61483347fa09STejun Heo BUG_ON(!create_worker(pool)); 61493347fa09STejun Heo 61503347fa09STejun Heo wq_online = true; 615182607adcSTejun Heo wq_watchdog_init(); 61521da177e4SLinus Torvalds } 6153