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> 52cd2440d6SPetr Mladek #include <linux/sched/debug.h> 5362635ea8SSergey Senozhatsky #include <linux/nmi.h> 54940d71c6SSergey Senozhatsky #include <linux/kvm_para.h> 55aa6fde93STejun Heo #include <linux/delay.h> 56e22bee78STejun Heo 57ea138446STejun Heo #include "workqueue_internal.h" 581da177e4SLinus Torvalds 59e563d0a7STejun Heo enum worker_pool_flags { 60bc2ae0f5STejun Heo /* 6124647570STejun Heo * worker_pool flags 62bc2ae0f5STejun Heo * 6324647570STejun Heo * A bound pool is either associated or disassociated with its CPU. 64bc2ae0f5STejun Heo * While associated (!DISASSOCIATED), all workers are bound to the 65bc2ae0f5STejun Heo * CPU and none has %WORKER_UNBOUND set and concurrency management 66bc2ae0f5STejun Heo * is in effect. 67bc2ae0f5STejun Heo * 68bc2ae0f5STejun Heo * While DISASSOCIATED, the cpu may be offline and all workers have 69bc2ae0f5STejun Heo * %WORKER_UNBOUND set and concurrency management disabled, and may 7024647570STejun Heo * be executing on any CPU. The pool behaves as an unbound one. 71bc2ae0f5STejun Heo * 72bc3a1afcSTejun Heo * Note that DISASSOCIATED should be flipped only while holding 731258fae7STejun Heo * wq_pool_attach_mutex to avoid changing binding state while 744736cbf7SLai Jiangshan * worker_attach_to_pool() is in progress. 75bc2ae0f5STejun Heo */ 76692b4825STejun Heo POOL_MANAGER_ACTIVE = 1 << 0, /* being managed */ 7724647570STejun Heo POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */ 78e563d0a7STejun Heo }; 79db7bccf4STejun Heo 80e563d0a7STejun Heo enum worker_flags { 81c8e55f36STejun Heo /* worker flags */ 82c8e55f36STejun Heo WORKER_DIE = 1 << 1, /* die die die */ 83c8e55f36STejun Heo WORKER_IDLE = 1 << 2, /* is idle */ 84e22bee78STejun Heo WORKER_PREP = 1 << 3, /* preparing to run works */ 85fb0e7bebSTejun Heo WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */ 86f3421797STejun Heo WORKER_UNBOUND = 1 << 7, /* worker is unbound */ 87a9ab775bSTejun Heo WORKER_REBOUND = 1 << 8, /* worker was rebound */ 88e22bee78STejun Heo 89a9ab775bSTejun Heo WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE | 90a9ab775bSTejun Heo WORKER_UNBOUND | WORKER_REBOUND, 91e563d0a7STejun Heo }; 92db7bccf4STejun Heo 93e563d0a7STejun Heo enum wq_internal_consts { 94e34cdddbSTejun Heo NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */ 954ce62e9eSTejun Heo 9629c91e99STejun Heo UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */ 97c8e55f36STejun Heo BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */ 98db7bccf4STejun Heo 99e22bee78STejun Heo MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */ 100e22bee78STejun Heo IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */ 101e22bee78STejun Heo 1023233cdbdSTejun Heo MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2, 1033233cdbdSTejun Heo /* call for help after 10ms 1043233cdbdSTejun Heo (min two ticks) */ 105e22bee78STejun Heo MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */ 106e22bee78STejun Heo CREATE_COOLDOWN = HZ, /* time to breath after fail */ 1071da177e4SLinus Torvalds 1081da177e4SLinus Torvalds /* 109e22bee78STejun Heo * Rescue workers are used only on emergencies and shared by 1108698a745SDongsheng Yang * all cpus. Give MIN_NICE. 111e22bee78STejun Heo */ 1128698a745SDongsheng Yang RESCUER_NICE_LEVEL = MIN_NICE, 1138698a745SDongsheng Yang HIGHPRI_NICE_LEVEL = MIN_NICE, 114ecf6881fSTejun Heo 11531c89007SAudra Mitchell WQ_NAME_LEN = 32, 116c8e55f36STejun Heo }; 117c8e55f36STejun Heo 1181da177e4SLinus Torvalds /* 1194690c4abSTejun Heo * Structure fields follow one of the following exclusion rules. 1204690c4abSTejun Heo * 121e41e704bSTejun Heo * I: Modifiable by initialization/destruction paths and read-only for 122e41e704bSTejun Heo * everyone else. 1234690c4abSTejun Heo * 124e22bee78STejun Heo * P: Preemption protected. Disabling preemption is enough and should 125e22bee78STejun Heo * only be modified and accessed from the local cpu. 126e22bee78STejun Heo * 127d565ed63STejun Heo * L: pool->lock protected. Access with pool->lock held. 1284690c4abSTejun Heo * 129bdf8b9bfSTejun Heo * K: Only modified by worker while holding pool->lock. Can be safely read by 130bdf8b9bfSTejun Heo * self, while holding pool->lock or from IRQ context if %current is the 131bdf8b9bfSTejun Heo * kworker. 132bdf8b9bfSTejun Heo * 133bdf8b9bfSTejun Heo * S: Only modified by worker self. 134bdf8b9bfSTejun Heo * 1351258fae7STejun Heo * A: wq_pool_attach_mutex protected. 136822d8405STejun Heo * 13768e13a67SLai Jiangshan * PL: wq_pool_mutex protected. 13876af4d93STejun Heo * 13924acfb71SThomas Gleixner * PR: wq_pool_mutex protected for writes. RCU protected for reads. 1405bcab335STejun Heo * 1415b95e1afSLai Jiangshan * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads. 1425b95e1afSLai Jiangshan * 1435b95e1afSLai Jiangshan * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or 14424acfb71SThomas Gleixner * RCU for reads. 1455b95e1afSLai Jiangshan * 1463c25a55dSLai Jiangshan * WQ: wq->mutex protected. 1473c25a55dSLai Jiangshan * 14824acfb71SThomas Gleixner * WR: wq->mutex protected for writes. RCU protected for reads. 1492e109a28STejun Heo * 150a045a272STejun Heo * WO: wq->mutex protected for writes. Updated with WRITE_ONCE() and can be read 151a045a272STejun Heo * with READ_ONCE() without locking. 152a045a272STejun Heo * 1532e109a28STejun Heo * MD: wq_mayday_lock protected. 154cd2440d6SPetr Mladek * 155cd2440d6SPetr Mladek * WD: Used internally by the watchdog. 1564690c4abSTejun Heo */ 1574690c4abSTejun Heo 1582eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */ 159c34056a3STejun Heo 160bd7bdd43STejun Heo struct worker_pool { 161a9b8a985SSebastian Andrzej Siewior raw_spinlock_t lock; /* the pool lock */ 162d84ff051STejun Heo int cpu; /* I: the associated cpu */ 163f3f90ad4STejun Heo int node; /* I: the associated node ID */ 1649daf9e67STejun Heo int id; /* I: pool ID */ 165bc8b50c2STejun Heo unsigned int flags; /* L: flags */ 166bd7bdd43STejun Heo 16782607adcSTejun Heo unsigned long watchdog_ts; /* L: watchdog timestamp */ 168cd2440d6SPetr Mladek bool cpu_stall; /* WD: stalled cpu bound pool */ 16982607adcSTejun Heo 170bc35f7efSLai Jiangshan /* 171bc35f7efSLai Jiangshan * The counter is incremented in a process context on the associated CPU 172bc35f7efSLai Jiangshan * w/ preemption disabled, and decremented or reset in the same context 173bc35f7efSLai Jiangshan * but w/ pool->lock held. The readers grab pool->lock and are 174bc35f7efSLai Jiangshan * guaranteed to see if the counter reached zero. 175bc35f7efSLai Jiangshan */ 176bc35f7efSLai Jiangshan int nr_running; 17784f91c62SLai Jiangshan 178bd7bdd43STejun Heo struct list_head worklist; /* L: list of pending works */ 179ea1abd61SLai Jiangshan 1805826cc8fSLai Jiangshan int nr_workers; /* L: total number of workers */ 1815826cc8fSLai Jiangshan int nr_idle; /* L: currently idle workers */ 182bd7bdd43STejun Heo 1832c1f1a91SLai Jiangshan struct list_head idle_list; /* L: list of idle workers */ 184bd7bdd43STejun Heo struct timer_list idle_timer; /* L: worker idle timeout */ 1853f959aa3SValentin Schneider struct work_struct idle_cull_work; /* L: worker idle cleanup */ 1863f959aa3SValentin Schneider 187bd7bdd43STejun Heo struct timer_list mayday_timer; /* L: SOS timer for workers */ 188bd7bdd43STejun Heo 189c5aa87bbSTejun Heo /* a workers is either on busy_hash or idle_list, or the manager */ 190c9e7cf27STejun Heo DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER); 191c9e7cf27STejun Heo /* L: hash of busy workers */ 192c9e7cf27STejun Heo 1932607d7a6STejun Heo struct worker *manager; /* L: purely informational */ 19492f9c5c4SLai Jiangshan struct list_head workers; /* A: attached workers */ 195e02b9312SValentin Schneider struct list_head dying_workers; /* A: workers about to die */ 19660f5a4bcSLai Jiangshan struct completion *detach_completion; /* all workers detached */ 197e19e397aSTejun Heo 1987cda9aaeSLai Jiangshan struct ida worker_ida; /* worker IDs for task name */ 199e19e397aSTejun Heo 2007a4e344cSTejun Heo struct workqueue_attrs *attrs; /* I: worker attributes */ 20168e13a67SLai Jiangshan struct hlist_node hash_node; /* PL: unbound_pool_hash node */ 20268e13a67SLai Jiangshan int refcnt; /* PL: refcnt for unbound pools */ 2037a4e344cSTejun Heo 204e19e397aSTejun Heo /* 20524acfb71SThomas Gleixner * Destruction of pool is RCU protected to allow dereferences 20629c91e99STejun Heo * from get_work_pool(). 20729c91e99STejun Heo */ 20829c91e99STejun Heo struct rcu_head rcu; 20984f91c62SLai Jiangshan }; 2108b03ae3cSTejun Heo 2118b03ae3cSTejun Heo /* 212725e8ec5STejun Heo * Per-pool_workqueue statistics. These can be monitored using 213725e8ec5STejun Heo * tools/workqueue/wq_monitor.py. 214725e8ec5STejun Heo */ 215725e8ec5STejun Heo enum pool_workqueue_stats { 216725e8ec5STejun Heo PWQ_STAT_STARTED, /* work items started execution */ 217725e8ec5STejun Heo PWQ_STAT_COMPLETED, /* work items completed execution */ 2188a1dd1e5STejun Heo PWQ_STAT_CPU_TIME, /* total CPU time consumed */ 219616db877STejun Heo PWQ_STAT_CPU_INTENSIVE, /* wq_cpu_intensive_thresh_us violations */ 220725e8ec5STejun Heo PWQ_STAT_CM_WAKEUP, /* concurrency-management worker wakeups */ 2218639ecebSTejun Heo PWQ_STAT_REPATRIATED, /* unbound workers brought back into scope */ 222725e8ec5STejun Heo PWQ_STAT_MAYDAY, /* maydays to rescuer */ 223725e8ec5STejun Heo PWQ_STAT_RESCUED, /* linked work items executed by rescuer */ 224725e8ec5STejun Heo 225725e8ec5STejun Heo PWQ_NR_STATS, 226725e8ec5STejun Heo }; 227725e8ec5STejun Heo 228725e8ec5STejun Heo /* 229112202d9STejun Heo * The per-pool workqueue. While queued, the lower WORK_STRUCT_FLAG_BITS 230112202d9STejun Heo * of work_struct->data are used for flags and the remaining high bits 231112202d9STejun Heo * point to the pwq; thus, pwqs need to be aligned at two's power of the 232112202d9STejun Heo * number of flag bits. 2331da177e4SLinus Torvalds */ 234112202d9STejun Heo struct pool_workqueue { 235bd7bdd43STejun Heo struct worker_pool *pool; /* I: the associated pool */ 2364690c4abSTejun Heo struct workqueue_struct *wq; /* I: the owning workqueue */ 23773f53c4aSTejun Heo int work_color; /* L: current color */ 23873f53c4aSTejun Heo int flush_color; /* L: flushing color */ 2398864b4e5STejun Heo int refcnt; /* L: reference count */ 24073f53c4aSTejun Heo int nr_in_flight[WORK_NR_COLORS]; 24173f53c4aSTejun Heo /* L: nr of in_flight works */ 242018f3a13SLai Jiangshan 243018f3a13SLai Jiangshan /* 244018f3a13SLai Jiangshan * nr_active management and WORK_STRUCT_INACTIVE: 245018f3a13SLai Jiangshan * 246018f3a13SLai Jiangshan * When pwq->nr_active >= max_active, new work item is queued to 247018f3a13SLai Jiangshan * pwq->inactive_works instead of pool->worklist and marked with 248018f3a13SLai Jiangshan * WORK_STRUCT_INACTIVE. 249018f3a13SLai Jiangshan * 250018f3a13SLai Jiangshan * All work items marked with WORK_STRUCT_INACTIVE do not participate 251018f3a13SLai Jiangshan * in pwq->nr_active and all work items in pwq->inactive_works are 252018f3a13SLai Jiangshan * marked with WORK_STRUCT_INACTIVE. But not all WORK_STRUCT_INACTIVE 253018f3a13SLai Jiangshan * work items are in pwq->inactive_works. Some of them are ready to 254018f3a13SLai Jiangshan * run in pool->worklist or worker->scheduled. Those work itmes are 255018f3a13SLai Jiangshan * only struct wq_barrier which is used for flush_work() and should 256018f3a13SLai Jiangshan * not participate in pwq->nr_active. For non-barrier work item, it 257018f3a13SLai Jiangshan * is marked with WORK_STRUCT_INACTIVE iff it is in pwq->inactive_works. 258018f3a13SLai Jiangshan */ 2591e19ffc6STejun Heo int nr_active; /* L: nr of active works */ 260f97a4a1aSLai Jiangshan struct list_head inactive_works; /* L: inactive works */ 2613c25a55dSLai Jiangshan struct list_head pwqs_node; /* WR: node on wq->pwqs */ 2622e109a28STejun Heo struct list_head mayday_node; /* MD: node on wq->maydays */ 2638864b4e5STejun Heo 264725e8ec5STejun Heo u64 stats[PWQ_NR_STATS]; 265725e8ec5STejun Heo 2668864b4e5STejun Heo /* 267967b494eSTejun Heo * Release of unbound pwq is punted to a kthread_worker. See put_pwq() 268687a9aa5STejun Heo * and pwq_release_workfn() for details. pool_workqueue itself is also 269687a9aa5STejun Heo * RCU protected so that the first pwq can be determined without 270967b494eSTejun Heo * grabbing wq->mutex. 2718864b4e5STejun Heo */ 272687a9aa5STejun Heo struct kthread_work release_work; 2738864b4e5STejun Heo struct rcu_head rcu; 274e904e6c2STejun Heo } __aligned(1 << WORK_STRUCT_FLAG_BITS); 2751da177e4SLinus Torvalds 2761da177e4SLinus Torvalds /* 27773f53c4aSTejun Heo * Structure used to wait for workqueue flush. 27873f53c4aSTejun Heo */ 27973f53c4aSTejun Heo struct wq_flusher { 2803c25a55dSLai Jiangshan struct list_head list; /* WQ: list of flushers */ 2813c25a55dSLai Jiangshan int flush_color; /* WQ: flush color waiting for */ 28273f53c4aSTejun Heo struct completion done; /* flush completion */ 28373f53c4aSTejun Heo }; 2841da177e4SLinus Torvalds 285226223abSTejun Heo struct wq_device; 286226223abSTejun Heo 28773f53c4aSTejun Heo /* 288c5aa87bbSTejun Heo * The externally visible workqueue. It relays the issued work items to 289c5aa87bbSTejun Heo * the appropriate worker_pool through its pool_workqueues. 2901da177e4SLinus Torvalds */ 2911da177e4SLinus Torvalds struct workqueue_struct { 2923c25a55dSLai Jiangshan struct list_head pwqs; /* WR: all pwqs of this wq */ 293e2dca7adSTejun Heo struct list_head list; /* PR: list of all workqueues */ 29473f53c4aSTejun Heo 2953c25a55dSLai Jiangshan struct mutex mutex; /* protects this wq */ 2963c25a55dSLai Jiangshan int work_color; /* WQ: current work color */ 2973c25a55dSLai Jiangshan int flush_color; /* WQ: current flush color */ 298112202d9STejun Heo atomic_t nr_pwqs_to_flush; /* flush in progress */ 2993c25a55dSLai Jiangshan struct wq_flusher *first_flusher; /* WQ: first flusher */ 3003c25a55dSLai Jiangshan struct list_head flusher_queue; /* WQ: flush waiters */ 3013c25a55dSLai Jiangshan struct list_head flusher_overflow; /* WQ: flush overflow list */ 30273f53c4aSTejun Heo 3032e109a28STejun Heo struct list_head maydays; /* MD: pwqs requesting rescue */ 30430ae2fc0STejun Heo struct worker *rescuer; /* MD: rescue worker */ 305e22bee78STejun Heo 30687fc741eSLai Jiangshan int nr_drainers; /* WQ: drain in progress */ 307a045a272STejun Heo int max_active; /* WO: max active works */ 308a045a272STejun Heo int saved_max_active; /* WQ: saved max_active */ 309226223abSTejun Heo 3105b95e1afSLai Jiangshan struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */ 3119f66cff2STejun Heo struct pool_workqueue __rcu *dfl_pwq; /* PW: only for unbound wqs */ 3126029a918STejun Heo 313226223abSTejun Heo #ifdef CONFIG_SYSFS 314226223abSTejun Heo struct wq_device *wq_dev; /* I: for sysfs interface */ 315226223abSTejun Heo #endif 3164e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 317669de8bdSBart Van Assche char *lock_name; 318669de8bdSBart Van Assche struct lock_class_key key; 3194e6045f1SJohannes Berg struct lockdep_map lockdep_map; 3204e6045f1SJohannes Berg #endif 321ecf6881fSTejun Heo char name[WQ_NAME_LEN]; /* I: workqueue name */ 3222728fd2fSTejun Heo 323e2dca7adSTejun Heo /* 32424acfb71SThomas Gleixner * Destruction of workqueue_struct is RCU protected to allow walking 32524acfb71SThomas Gleixner * the workqueues list without grabbing wq_pool_mutex. 326e2dca7adSTejun Heo * This is used to dump all workqueues from sysrq. 327e2dca7adSTejun Heo */ 328e2dca7adSTejun Heo struct rcu_head rcu; 329e2dca7adSTejun Heo 3302728fd2fSTejun Heo /* hot fields used during command issue, aligned to cacheline */ 3312728fd2fSTejun Heo unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */ 332636b927eSTejun Heo struct pool_workqueue __percpu __rcu **cpu_pwq; /* I: per-cpu pwqs */ 3331da177e4SLinus Torvalds }; 3341da177e4SLinus Torvalds 335e904e6c2STejun Heo static struct kmem_cache *pwq_cache; 336e904e6c2STejun Heo 33784193c07STejun Heo /* 33884193c07STejun Heo * Each pod type describes how CPUs should be grouped for unbound workqueues. 33984193c07STejun Heo * See the comment above workqueue_attrs->affn_scope. 34084193c07STejun Heo */ 34184193c07STejun Heo struct wq_pod_type { 34284193c07STejun Heo int nr_pods; /* number of pods */ 34384193c07STejun Heo cpumask_var_t *pod_cpus; /* pod -> cpus */ 34484193c07STejun Heo int *pod_node; /* pod -> node */ 34584193c07STejun Heo int *cpu_pod; /* cpu -> pod */ 34684193c07STejun Heo }; 34784193c07STejun Heo 34884193c07STejun Heo static struct wq_pod_type wq_pod_types[WQ_AFFN_NR_TYPES]; 349523a301eSTejun Heo static enum wq_affn_scope wq_affn_dfl = WQ_AFFN_CACHE; 35063c5484eSTejun Heo 35163c5484eSTejun Heo static const char *wq_affn_names[WQ_AFFN_NR_TYPES] = { 352523a301eSTejun Heo [WQ_AFFN_DFL] = "default", 35363c5484eSTejun Heo [WQ_AFFN_CPU] = "cpu", 35463c5484eSTejun Heo [WQ_AFFN_SMT] = "smt", 35563c5484eSTejun Heo [WQ_AFFN_CACHE] = "cache", 35663c5484eSTejun Heo [WQ_AFFN_NUMA] = "numa", 35763c5484eSTejun Heo [WQ_AFFN_SYSTEM] = "system", 35863c5484eSTejun Heo }; 359bce90380STejun Heo 360616db877STejun Heo /* 361616db877STejun Heo * Per-cpu work items which run for longer than the following threshold are 362616db877STejun Heo * automatically considered CPU intensive and excluded from concurrency 363616db877STejun Heo * management to prevent them from noticeably delaying other per-cpu work items. 364aa6fde93STejun Heo * ULONG_MAX indicates that the user hasn't overridden it with a boot parameter. 365aa6fde93STejun Heo * The actual value is initialized in wq_cpu_intensive_thresh_init(). 366616db877STejun Heo */ 367aa6fde93STejun Heo static unsigned long wq_cpu_intensive_thresh_us = ULONG_MAX; 368616db877STejun Heo module_param_named(cpu_intensive_thresh_us, wq_cpu_intensive_thresh_us, ulong, 0644); 369616db877STejun Heo 370cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */ 371552f530cSLuis R. Rodriguez static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT); 372cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444); 373cee22a15SViresh Kumar 374863b710bSTejun Heo static bool wq_online; /* can kworkers be created yet? */ 3753347fa09STejun Heo 376fef59c9cSTejun Heo /* buf for wq_update_unbound_pod_attrs(), protected by CPU hotplug exclusion */ 377fef59c9cSTejun Heo static struct workqueue_attrs *wq_update_pod_attrs_buf; 3784c16bd32STejun Heo 37968e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */ 3801258fae7STejun Heo static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */ 381a9b8a985SSebastian Andrzej Siewior static DEFINE_RAW_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */ 382d8bb65abSSebastian Andrzej Siewior /* wait for manager to go away */ 383d8bb65abSSebastian Andrzej Siewior static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait); 3845bcab335STejun Heo 385e2dca7adSTejun Heo static LIST_HEAD(workqueues); /* PR: list of all workqueues */ 38668e13a67SLai Jiangshan static bool workqueue_freezing; /* PL: have wqs started freezing? */ 3877d19c5ceSTejun Heo 38899c621efSLai Jiangshan /* PL&A: allowable cpus for unbound wqs and work items */ 389ef557180SMike Galbraith static cpumask_var_t wq_unbound_cpumask; 390ef557180SMike Galbraith 391fe28f631SWaiman Long /* PL: user requested unbound cpumask via sysfs */ 392fe28f631SWaiman Long static cpumask_var_t wq_requested_unbound_cpumask; 393fe28f631SWaiman Long 394fe28f631SWaiman Long /* PL: isolated cpumask to be excluded from unbound cpumask */ 395fe28f631SWaiman Long static cpumask_var_t wq_isolated_cpumask; 396fe28f631SWaiman Long 397ace3c549Stiozhang /* for further constrain wq_unbound_cpumask by cmdline parameter*/ 398ace3c549Stiozhang static struct cpumask wq_cmdline_cpumask __initdata; 399ace3c549Stiozhang 400ef557180SMike Galbraith /* CPU where unbound work was last round robin scheduled from this CPU */ 401ef557180SMike Galbraith static DEFINE_PER_CPU(int, wq_rr_cpu_last); 402b05a7928SFrederic Weisbecker 403f303fccbSTejun Heo /* 404f303fccbSTejun Heo * Local execution of unbound work items is no longer guaranteed. The 405f303fccbSTejun Heo * following always forces round-robin CPU selection on unbound work items 406f303fccbSTejun Heo * to uncover usages which depend on it. 407f303fccbSTejun Heo */ 408f303fccbSTejun Heo #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU 409f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = true; 410f303fccbSTejun Heo #else 411f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = false; 412f303fccbSTejun Heo #endif 413f303fccbSTejun Heo module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644); 414f303fccbSTejun Heo 4157d19c5ceSTejun Heo /* the per-cpu worker pools */ 41625528213SPeter Zijlstra static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], cpu_worker_pools); 4177d19c5ceSTejun Heo 41868e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */ 4197d19c5ceSTejun Heo 42068e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */ 42129c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER); 42229c91e99STejun Heo 423c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */ 42429c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS]; 42529c91e99STejun Heo 4268a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */ 4278a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS]; 4288a2b7538STejun Heo 429967b494eSTejun Heo /* 430967b494eSTejun Heo * I: kthread_worker to release pwq's. pwq release needs to be bounced to a 431967b494eSTejun Heo * process context while holding a pool lock. Bounce to a dedicated kthread 432967b494eSTejun Heo * worker to avoid A-A deadlocks. 433967b494eSTejun Heo */ 43468279f9cSAlexey Dobriyan static struct kthread_worker *pwq_release_worker __ro_after_init; 435967b494eSTejun Heo 43668279f9cSAlexey Dobriyan struct workqueue_struct *system_wq __ro_after_init; 437ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq); 43868279f9cSAlexey Dobriyan struct workqueue_struct *system_highpri_wq __ro_after_init; 4391aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq); 44068279f9cSAlexey Dobriyan struct workqueue_struct *system_long_wq __ro_after_init; 441d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq); 44268279f9cSAlexey Dobriyan struct workqueue_struct *system_unbound_wq __ro_after_init; 443f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq); 44468279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_wq __ro_after_init; 44524d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq); 44668279f9cSAlexey Dobriyan struct workqueue_struct *system_power_efficient_wq __ro_after_init; 4470668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq); 44868279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_power_efficient_wq __ro_after_init; 4490668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq); 450d320c038STejun Heo 4517d19c5ceSTejun Heo static int worker_thread(void *__worker); 4526ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq); 453c29eb853STejun Heo static void show_pwq(struct pool_workqueue *pwq); 45455df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool); 4557d19c5ceSTejun Heo 45697bd2347STejun Heo #define CREATE_TRACE_POINTS 45797bd2347STejun Heo #include <trace/events/workqueue.h> 45897bd2347STejun Heo 45968e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex() \ 46024acfb71SThomas Gleixner RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \ 461f78f5b90SPaul E. McKenney !lockdep_is_held(&wq_pool_mutex), \ 46224acfb71SThomas Gleixner "RCU or wq_pool_mutex should be held") 4635bcab335STejun Heo 4645b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \ 46524acfb71SThomas Gleixner RCU_LOCKDEP_WARN(!rcu_read_lock_held() && \ 466f78f5b90SPaul E. McKenney !lockdep_is_held(&wq->mutex) && \ 467f78f5b90SPaul E. McKenney !lockdep_is_held(&wq_pool_mutex), \ 46824acfb71SThomas Gleixner "RCU, wq->mutex or wq_pool_mutex should be held") 4695b95e1afSLai Jiangshan 470f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu) \ 471f02ae73aSTejun Heo for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \ 472f02ae73aSTejun Heo (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \ 4737a62c2c8STejun Heo (pool)++) 4744ce62e9eSTejun Heo 47549e3cf44STejun Heo /** 47617116969STejun Heo * for_each_pool - iterate through all worker_pools in the system 47717116969STejun Heo * @pool: iteration cursor 478611c92a0STejun Heo * @pi: integer used for iteration 479fa1b54e6STejun Heo * 48024acfb71SThomas Gleixner * This must be called either with wq_pool_mutex held or RCU read 48168e13a67SLai Jiangshan * locked. If the pool needs to be used beyond the locking in effect, the 48268e13a67SLai Jiangshan * caller is responsible for guaranteeing that the pool stays online. 483fa1b54e6STejun Heo * 484fa1b54e6STejun Heo * The if/else clause exists only for the lockdep assertion and can be 485fa1b54e6STejun Heo * ignored. 48617116969STejun Heo */ 487611c92a0STejun Heo #define for_each_pool(pool, pi) \ 488611c92a0STejun Heo idr_for_each_entry(&worker_pool_idr, pool, pi) \ 48968e13a67SLai Jiangshan if (({ assert_rcu_or_pool_mutex(); false; })) { } \ 490fa1b54e6STejun Heo else 49117116969STejun Heo 49217116969STejun Heo /** 493822d8405STejun Heo * for_each_pool_worker - iterate through all workers of a worker_pool 494822d8405STejun Heo * @worker: iteration cursor 495822d8405STejun Heo * @pool: worker_pool to iterate workers of 496822d8405STejun Heo * 4971258fae7STejun Heo * This must be called with wq_pool_attach_mutex. 498822d8405STejun Heo * 499822d8405STejun Heo * The if/else clause exists only for the lockdep assertion and can be 500822d8405STejun Heo * ignored. 501822d8405STejun Heo */ 502da028469SLai Jiangshan #define for_each_pool_worker(worker, pool) \ 503da028469SLai Jiangshan list_for_each_entry((worker), &(pool)->workers, node) \ 5041258fae7STejun Heo if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \ 505822d8405STejun Heo else 506822d8405STejun Heo 507822d8405STejun Heo /** 50849e3cf44STejun Heo * for_each_pwq - iterate through all pool_workqueues of the specified workqueue 50949e3cf44STejun Heo * @pwq: iteration cursor 51049e3cf44STejun Heo * @wq: the target workqueue 51176af4d93STejun Heo * 51224acfb71SThomas Gleixner * This must be called either with wq->mutex held or RCU read locked. 513794b18bcSTejun Heo * If the pwq needs to be used beyond the locking in effect, the caller is 514794b18bcSTejun Heo * responsible for guaranteeing that the pwq stays online. 51576af4d93STejun Heo * 51676af4d93STejun Heo * The if/else clause exists only for the lockdep assertion and can be 51776af4d93STejun Heo * ignored. 51849e3cf44STejun Heo */ 51949e3cf44STejun Heo #define for_each_pwq(pwq, wq) \ 52049e9d1a9SSebastian Andrzej Siewior list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \ 5215a644662SJoel Fernandes (Google) lockdep_is_held(&(wq->mutex))) 522f3421797STejun Heo 523dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 524dc186ad7SThomas Gleixner 525f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr; 526dc186ad7SThomas Gleixner 52799777288SStanislaw Gruszka static void *work_debug_hint(void *addr) 52899777288SStanislaw Gruszka { 52999777288SStanislaw Gruszka return ((struct work_struct *) addr)->func; 53099777288SStanislaw Gruszka } 53199777288SStanislaw Gruszka 532b9fdac7fSDu, Changbin static bool work_is_static_object(void *addr) 533b9fdac7fSDu, Changbin { 534b9fdac7fSDu, Changbin struct work_struct *work = addr; 535b9fdac7fSDu, Changbin 536b9fdac7fSDu, Changbin return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work)); 537b9fdac7fSDu, Changbin } 538b9fdac7fSDu, Changbin 539dc186ad7SThomas Gleixner /* 540dc186ad7SThomas Gleixner * fixup_init is called when: 541dc186ad7SThomas Gleixner * - an active object is initialized 542dc186ad7SThomas Gleixner */ 54302a982a6SDu, Changbin static bool work_fixup_init(void *addr, enum debug_obj_state state) 544dc186ad7SThomas Gleixner { 545dc186ad7SThomas Gleixner struct work_struct *work = addr; 546dc186ad7SThomas Gleixner 547dc186ad7SThomas Gleixner switch (state) { 548dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 549dc186ad7SThomas Gleixner cancel_work_sync(work); 550dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 55102a982a6SDu, Changbin return true; 552dc186ad7SThomas Gleixner default: 55302a982a6SDu, Changbin return false; 554dc186ad7SThomas Gleixner } 555dc186ad7SThomas Gleixner } 556dc186ad7SThomas Gleixner 557dc186ad7SThomas Gleixner /* 558dc186ad7SThomas Gleixner * fixup_free is called when: 559dc186ad7SThomas Gleixner * - an active object is freed 560dc186ad7SThomas Gleixner */ 56102a982a6SDu, Changbin static bool work_fixup_free(void *addr, enum debug_obj_state state) 562dc186ad7SThomas Gleixner { 563dc186ad7SThomas Gleixner struct work_struct *work = addr; 564dc186ad7SThomas Gleixner 565dc186ad7SThomas Gleixner switch (state) { 566dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 567dc186ad7SThomas Gleixner cancel_work_sync(work); 568dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 56902a982a6SDu, Changbin return true; 570dc186ad7SThomas Gleixner default: 57102a982a6SDu, Changbin return false; 572dc186ad7SThomas Gleixner } 573dc186ad7SThomas Gleixner } 574dc186ad7SThomas Gleixner 575f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr = { 576dc186ad7SThomas Gleixner .name = "work_struct", 57799777288SStanislaw Gruszka .debug_hint = work_debug_hint, 578b9fdac7fSDu, Changbin .is_static_object = work_is_static_object, 579dc186ad7SThomas Gleixner .fixup_init = work_fixup_init, 580dc186ad7SThomas Gleixner .fixup_free = work_fixup_free, 581dc186ad7SThomas Gleixner }; 582dc186ad7SThomas Gleixner 583dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) 584dc186ad7SThomas Gleixner { 585dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 586dc186ad7SThomas Gleixner } 587dc186ad7SThomas Gleixner 588dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) 589dc186ad7SThomas Gleixner { 590dc186ad7SThomas Gleixner debug_object_deactivate(work, &work_debug_descr); 591dc186ad7SThomas Gleixner } 592dc186ad7SThomas Gleixner 593dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack) 594dc186ad7SThomas Gleixner { 595dc186ad7SThomas Gleixner if (onstack) 596dc186ad7SThomas Gleixner debug_object_init_on_stack(work, &work_debug_descr); 597dc186ad7SThomas Gleixner else 598dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 599dc186ad7SThomas Gleixner } 600dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work); 601dc186ad7SThomas Gleixner 602dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work) 603dc186ad7SThomas Gleixner { 604dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 605dc186ad7SThomas Gleixner } 606dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack); 607dc186ad7SThomas Gleixner 608ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work) 609ea2e64f2SThomas Gleixner { 610ea2e64f2SThomas Gleixner destroy_timer_on_stack(&work->timer); 611ea2e64f2SThomas Gleixner debug_object_free(&work->work, &work_debug_descr); 612ea2e64f2SThomas Gleixner } 613ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack); 614ea2e64f2SThomas Gleixner 615dc186ad7SThomas Gleixner #else 616dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { } 617dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { } 618dc186ad7SThomas Gleixner #endif 619dc186ad7SThomas Gleixner 6204e8b22bdSLi Bin /** 62167dc8325SCai Huoqing * worker_pool_assign_id - allocate ID and assign it to @pool 6224e8b22bdSLi Bin * @pool: the pool pointer of interest 6234e8b22bdSLi Bin * 6244e8b22bdSLi Bin * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned 6254e8b22bdSLi Bin * successfully, -errno on failure. 6264e8b22bdSLi Bin */ 6279daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool) 6289daf9e67STejun Heo { 6299daf9e67STejun Heo int ret; 6309daf9e67STejun Heo 63168e13a67SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 6325bcab335STejun Heo 6334e8b22bdSLi Bin ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE, 6344e8b22bdSLi Bin GFP_KERNEL); 635229641a6STejun Heo if (ret >= 0) { 636e68035fbSTejun Heo pool->id = ret; 637229641a6STejun Heo return 0; 638229641a6STejun Heo } 6399daf9e67STejun Heo return ret; 6409daf9e67STejun Heo } 6419daf9e67STejun Heo 6429f66cff2STejun Heo static struct pool_workqueue __rcu ** 6439f66cff2STejun Heo unbound_pwq_slot(struct workqueue_struct *wq, int cpu) 6449f66cff2STejun Heo { 6459f66cff2STejun Heo if (cpu >= 0) 6469f66cff2STejun Heo return per_cpu_ptr(wq->cpu_pwq, cpu); 6479f66cff2STejun Heo else 6489f66cff2STejun Heo return &wq->dfl_pwq; 6499f66cff2STejun Heo } 6509f66cff2STejun Heo 6519f66cff2STejun Heo /* @cpu < 0 for dfl_pwq */ 6529f66cff2STejun Heo static struct pool_workqueue *unbound_pwq(struct workqueue_struct *wq, int cpu) 6539f66cff2STejun Heo { 6549f66cff2STejun Heo return rcu_dereference_check(*unbound_pwq_slot(wq, cpu), 6559f66cff2STejun Heo lockdep_is_held(&wq_pool_mutex) || 6569f66cff2STejun Heo lockdep_is_held(&wq->mutex)); 6579f66cff2STejun Heo } 6589f66cff2STejun Heo 65973f53c4aSTejun Heo static unsigned int work_color_to_flags(int color) 66073f53c4aSTejun Heo { 66173f53c4aSTejun Heo return color << WORK_STRUCT_COLOR_SHIFT; 66273f53c4aSTejun Heo } 66373f53c4aSTejun Heo 664c4560c2cSLai Jiangshan static int get_work_color(unsigned long work_data) 66573f53c4aSTejun Heo { 666c4560c2cSLai Jiangshan return (work_data >> WORK_STRUCT_COLOR_SHIFT) & 66773f53c4aSTejun Heo ((1 << WORK_STRUCT_COLOR_BITS) - 1); 66873f53c4aSTejun Heo } 66973f53c4aSTejun Heo 67073f53c4aSTejun Heo static int work_next_color(int color) 67173f53c4aSTejun Heo { 67273f53c4aSTejun Heo return (color + 1) % WORK_NR_COLORS; 673a848e3b6SOleg Nesterov } 674a848e3b6SOleg Nesterov 6754594bf15SDavid Howells /* 676112202d9STejun Heo * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data 677112202d9STejun Heo * contain the pointer to the queued pwq. Once execution starts, the flag 6787c3eed5cSTejun Heo * is cleared and the high bits contain OFFQ flags and pool ID. 6797a22ad75STejun Heo * 680112202d9STejun Heo * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling() 681112202d9STejun Heo * and clear_work_data() can be used to set the pwq, pool or clear 682bbb68dfaSTejun Heo * work->data. These functions should only be called while the work is 683bbb68dfaSTejun Heo * owned - ie. while the PENDING bit is set. 6847a22ad75STejun Heo * 685112202d9STejun Heo * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq 6867c3eed5cSTejun Heo * corresponding to a work. Pool is available once the work has been 687112202d9STejun Heo * queued anywhere after initialization until it is sync canceled. pwq is 6887c3eed5cSTejun Heo * available only while the work item is queued. 689bbb68dfaSTejun Heo * 690bbb68dfaSTejun Heo * %WORK_OFFQ_CANCELING is used to mark a work item which is being 691bbb68dfaSTejun Heo * canceled. While being canceled, a work item may have its PENDING set 692bbb68dfaSTejun Heo * but stay off timer and worklist for arbitrarily long and nobody should 693bbb68dfaSTejun Heo * try to steal the PENDING bit. 6944594bf15SDavid Howells */ 6957a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data, 6967a22ad75STejun Heo unsigned long flags) 6977a22ad75STejun Heo { 6986183c009STejun Heo WARN_ON_ONCE(!work_pending(work)); 6997a22ad75STejun Heo atomic_long_set(&work->data, data | flags | work_static(work)); 7007a22ad75STejun Heo } 7017a22ad75STejun Heo 702112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq, 7034690c4abSTejun Heo unsigned long extra_flags) 704365970a1SDavid Howells { 705112202d9STejun Heo set_work_data(work, (unsigned long)pwq, 706112202d9STejun Heo WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags); 707365970a1SDavid Howells } 708365970a1SDavid Howells 7094468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work, 7104468a00fSLai Jiangshan int pool_id) 7114468a00fSLai Jiangshan { 7124468a00fSLai Jiangshan set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 7134468a00fSLai Jiangshan WORK_STRUCT_PENDING); 7144468a00fSLai Jiangshan } 7154468a00fSLai Jiangshan 7167c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work, 7177c3eed5cSTejun Heo int pool_id) 7184d707b9fSOleg Nesterov { 71923657bb1STejun Heo /* 72023657bb1STejun Heo * The following wmb is paired with the implied mb in 72123657bb1STejun Heo * test_and_set_bit(PENDING) and ensures all updates to @work made 72223657bb1STejun Heo * here are visible to and precede any updates by the next PENDING 72323657bb1STejun Heo * owner. 72423657bb1STejun Heo */ 72523657bb1STejun Heo smp_wmb(); 7267c3eed5cSTejun Heo set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0); 727346c09f8SRoman Pen /* 728346c09f8SRoman Pen * The following mb guarantees that previous clear of a PENDING bit 729346c09f8SRoman Pen * will not be reordered with any speculative LOADS or STORES from 730346c09f8SRoman Pen * work->current_func, which is executed afterwards. This possible 7318bdc6201SLiu Song * reordering can lead to a missed execution on attempt to queue 732346c09f8SRoman Pen * the same @work. E.g. consider this case: 733346c09f8SRoman Pen * 734346c09f8SRoman Pen * CPU#0 CPU#1 735346c09f8SRoman Pen * ---------------------------- -------------------------------- 736346c09f8SRoman Pen * 737346c09f8SRoman Pen * 1 STORE event_indicated 738346c09f8SRoman Pen * 2 queue_work_on() { 739346c09f8SRoman Pen * 3 test_and_set_bit(PENDING) 740346c09f8SRoman Pen * 4 } set_..._and_clear_pending() { 741346c09f8SRoman Pen * 5 set_work_data() # clear bit 742346c09f8SRoman Pen * 6 smp_mb() 743346c09f8SRoman Pen * 7 work->current_func() { 744346c09f8SRoman Pen * 8 LOAD event_indicated 745346c09f8SRoman Pen * } 746346c09f8SRoman Pen * 747346c09f8SRoman Pen * Without an explicit full barrier speculative LOAD on line 8 can 748346c09f8SRoman Pen * be executed before CPU#0 does STORE on line 1. If that happens, 749346c09f8SRoman Pen * CPU#0 observes the PENDING bit is still set and new execution of 750346c09f8SRoman Pen * a @work is not queued in a hope, that CPU#1 will eventually 751346c09f8SRoman Pen * finish the queued @work. Meanwhile CPU#1 does not see 752346c09f8SRoman Pen * event_indicated is set, because speculative LOAD was executed 753346c09f8SRoman Pen * before actual STORE. 754346c09f8SRoman Pen */ 755346c09f8SRoman Pen smp_mb(); 7564d707b9fSOleg Nesterov } 7574d707b9fSOleg Nesterov 7587a22ad75STejun Heo static void clear_work_data(struct work_struct *work) 759365970a1SDavid Howells { 7607c3eed5cSTejun Heo smp_wmb(); /* see set_work_pool_and_clear_pending() */ 7617c3eed5cSTejun Heo set_work_data(work, WORK_STRUCT_NO_POOL, 0); 7627a22ad75STejun Heo } 7637a22ad75STejun Heo 764afa4bb77SLinus Torvalds static inline struct pool_workqueue *work_struct_pwq(unsigned long data) 765afa4bb77SLinus Torvalds { 766afa4bb77SLinus Torvalds return (struct pool_workqueue *)(data & WORK_STRUCT_WQ_DATA_MASK); 767afa4bb77SLinus Torvalds } 768afa4bb77SLinus Torvalds 769112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work) 7707a22ad75STejun Heo { 771e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 7727a22ad75STejun Heo 773112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 774afa4bb77SLinus Torvalds return work_struct_pwq(data); 775e120153dSTejun Heo else 776e120153dSTejun Heo return NULL; 7777a22ad75STejun Heo } 7787a22ad75STejun Heo 7797c3eed5cSTejun Heo /** 7807c3eed5cSTejun Heo * get_work_pool - return the worker_pool a given work was associated with 7817c3eed5cSTejun Heo * @work: the work item of interest 7827c3eed5cSTejun Heo * 78368e13a67SLai Jiangshan * Pools are created and destroyed under wq_pool_mutex, and allows read 78424acfb71SThomas Gleixner * access under RCU read lock. As such, this function should be 78524acfb71SThomas Gleixner * called under wq_pool_mutex or inside of a rcu_read_lock() region. 786fa1b54e6STejun Heo * 787fa1b54e6STejun Heo * All fields of the returned pool are accessible as long as the above 788fa1b54e6STejun Heo * mentioned locking is in effect. If the returned pool needs to be used 789fa1b54e6STejun Heo * beyond the critical section, the caller is responsible for ensuring the 790fa1b54e6STejun Heo * returned pool is and stays online. 791d185af30SYacine Belkadi * 792d185af30SYacine Belkadi * Return: The worker_pool @work was last associated with. %NULL if none. 7937c3eed5cSTejun Heo */ 7947c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work) 7957a22ad75STejun Heo { 796e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 7977c3eed5cSTejun Heo int pool_id; 7987a22ad75STejun Heo 79968e13a67SLai Jiangshan assert_rcu_or_pool_mutex(); 800fa1b54e6STejun Heo 801112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 802afa4bb77SLinus Torvalds return work_struct_pwq(data)->pool; 8037a22ad75STejun Heo 8047c3eed5cSTejun Heo pool_id = data >> WORK_OFFQ_POOL_SHIFT; 8057c3eed5cSTejun Heo if (pool_id == WORK_OFFQ_POOL_NONE) 8067a22ad75STejun Heo return NULL; 8077a22ad75STejun Heo 808fa1b54e6STejun Heo return idr_find(&worker_pool_idr, pool_id); 8097c3eed5cSTejun Heo } 8107c3eed5cSTejun Heo 8117c3eed5cSTejun Heo /** 8127c3eed5cSTejun Heo * get_work_pool_id - return the worker pool ID a given work is associated with 8137c3eed5cSTejun Heo * @work: the work item of interest 8147c3eed5cSTejun Heo * 815d185af30SYacine Belkadi * Return: The worker_pool ID @work was last associated with. 8167c3eed5cSTejun Heo * %WORK_OFFQ_POOL_NONE if none. 8177c3eed5cSTejun Heo */ 8187c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work) 8197c3eed5cSTejun Heo { 82054d5b7d0SLai Jiangshan unsigned long data = atomic_long_read(&work->data); 8217c3eed5cSTejun Heo 822112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 823afa4bb77SLinus Torvalds return work_struct_pwq(data)->pool->id; 82454d5b7d0SLai Jiangshan 82554d5b7d0SLai Jiangshan return data >> WORK_OFFQ_POOL_SHIFT; 8267c3eed5cSTejun Heo } 8277c3eed5cSTejun Heo 828bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work) 829bbb68dfaSTejun Heo { 8307c3eed5cSTejun Heo unsigned long pool_id = get_work_pool_id(work); 831bbb68dfaSTejun Heo 8327c3eed5cSTejun Heo pool_id <<= WORK_OFFQ_POOL_SHIFT; 8337c3eed5cSTejun Heo set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING); 834bbb68dfaSTejun Heo } 835bbb68dfaSTejun Heo 836bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work) 837bbb68dfaSTejun Heo { 838bbb68dfaSTejun Heo unsigned long data = atomic_long_read(&work->data); 839bbb68dfaSTejun Heo 840112202d9STejun Heo return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING); 841bbb68dfaSTejun Heo } 842bbb68dfaSTejun Heo 843e22bee78STejun Heo /* 8443270476aSTejun Heo * Policy functions. These define the policies on how the global worker 8453270476aSTejun Heo * pools are managed. Unless noted otherwise, these functions assume that 846d565ed63STejun Heo * they're being called with pool->lock held. 847e22bee78STejun Heo */ 848e22bee78STejun Heo 849e22bee78STejun Heo /* 850e22bee78STejun Heo * Need to wake up a worker? Called from anything but currently 851e22bee78STejun Heo * running workers. 852974271c4STejun Heo * 853974271c4STejun Heo * Note that, because unbound workers never contribute to nr_running, this 854706026c2STejun Heo * function will always return %true for unbound pools as long as the 855974271c4STejun Heo * worklist isn't empty. 856e22bee78STejun Heo */ 85763d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool) 858e22bee78STejun Heo { 8590219a352STejun Heo return !list_empty(&pool->worklist) && !pool->nr_running; 860e22bee78STejun Heo } 861e22bee78STejun Heo 862e22bee78STejun Heo /* Can I start working? Called from busy but !running workers. */ 86363d95a91STejun Heo static bool may_start_working(struct worker_pool *pool) 864e22bee78STejun Heo { 86563d95a91STejun Heo return pool->nr_idle; 866e22bee78STejun Heo } 867e22bee78STejun Heo 868e22bee78STejun Heo /* Do I need to keep working? Called from currently running workers. */ 86963d95a91STejun Heo static bool keep_working(struct worker_pool *pool) 870e22bee78STejun Heo { 871bc35f7efSLai Jiangshan return !list_empty(&pool->worklist) && (pool->nr_running <= 1); 872e22bee78STejun Heo } 873e22bee78STejun Heo 874e22bee78STejun Heo /* Do we need a new worker? Called from manager. */ 87563d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool) 876e22bee78STejun Heo { 87763d95a91STejun Heo return need_more_worker(pool) && !may_start_working(pool); 878e22bee78STejun Heo } 879e22bee78STejun Heo 880e22bee78STejun Heo /* Do we have too many workers and should some go away? */ 88163d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool) 882e22bee78STejun Heo { 883692b4825STejun Heo bool managing = pool->flags & POOL_MANAGER_ACTIVE; 88463d95a91STejun Heo int nr_idle = pool->nr_idle + managing; /* manager is considered idle */ 88563d95a91STejun Heo int nr_busy = pool->nr_workers - nr_idle; 886e22bee78STejun Heo 887e22bee78STejun Heo return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; 888e22bee78STejun Heo } 889e22bee78STejun Heo 8904690c4abSTejun Heo /** 891e22bee78STejun Heo * worker_set_flags - set worker flags and adjust nr_running accordingly 892cb444766STejun Heo * @worker: self 893d302f017STejun Heo * @flags: flags to set 894d302f017STejun Heo * 895228f1d00SLai Jiangshan * Set @flags in @worker->flags and adjust nr_running accordingly. 896d302f017STejun Heo */ 897228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags) 898d302f017STejun Heo { 899bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 900e22bee78STejun Heo 901bc8b50c2STejun Heo lockdep_assert_held(&pool->lock); 902cb444766STejun Heo 903228f1d00SLai Jiangshan /* If transitioning into NOT_RUNNING, adjust nr_running. */ 904e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && 905e22bee78STejun Heo !(worker->flags & WORKER_NOT_RUNNING)) { 906bc35f7efSLai Jiangshan pool->nr_running--; 907e22bee78STejun Heo } 908e22bee78STejun Heo 909d302f017STejun Heo worker->flags |= flags; 910d302f017STejun Heo } 911d302f017STejun Heo 912d302f017STejun Heo /** 913e22bee78STejun Heo * worker_clr_flags - clear worker flags and adjust nr_running accordingly 914cb444766STejun Heo * @worker: self 915d302f017STejun Heo * @flags: flags to clear 916d302f017STejun Heo * 917e22bee78STejun Heo * Clear @flags in @worker->flags and adjust nr_running accordingly. 918d302f017STejun Heo */ 919d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags) 920d302f017STejun Heo { 92163d95a91STejun Heo struct worker_pool *pool = worker->pool; 922e22bee78STejun Heo unsigned int oflags = worker->flags; 923e22bee78STejun Heo 924bc8b50c2STejun Heo lockdep_assert_held(&pool->lock); 925cb444766STejun Heo 926d302f017STejun Heo worker->flags &= ~flags; 927e22bee78STejun Heo 92842c025f3STejun Heo /* 92942c025f3STejun Heo * If transitioning out of NOT_RUNNING, increment nr_running. Note 93042c025f3STejun Heo * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask 93142c025f3STejun Heo * of multiple flags, not a single flag. 93242c025f3STejun Heo */ 933e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) 934e22bee78STejun Heo if (!(worker->flags & WORKER_NOT_RUNNING)) 935bc35f7efSLai Jiangshan pool->nr_running++; 936d302f017STejun Heo } 937d302f017STejun Heo 938797e8345STejun Heo /* Return the first idle worker. Called with pool->lock held. */ 939797e8345STejun Heo static struct worker *first_idle_worker(struct worker_pool *pool) 940797e8345STejun Heo { 941797e8345STejun Heo if (unlikely(list_empty(&pool->idle_list))) 942797e8345STejun Heo return NULL; 943797e8345STejun Heo 944797e8345STejun Heo return list_first_entry(&pool->idle_list, struct worker, entry); 945797e8345STejun Heo } 946797e8345STejun Heo 947797e8345STejun Heo /** 948797e8345STejun Heo * worker_enter_idle - enter idle state 949797e8345STejun Heo * @worker: worker which is entering idle state 950797e8345STejun Heo * 951797e8345STejun Heo * @worker is entering idle state. Update stats and idle timer if 952797e8345STejun Heo * necessary. 953797e8345STejun Heo * 954797e8345STejun Heo * LOCKING: 955797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 956797e8345STejun Heo */ 957797e8345STejun Heo static void worker_enter_idle(struct worker *worker) 958797e8345STejun Heo { 959797e8345STejun Heo struct worker_pool *pool = worker->pool; 960797e8345STejun Heo 961797e8345STejun Heo if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) || 962797e8345STejun Heo WARN_ON_ONCE(!list_empty(&worker->entry) && 963797e8345STejun Heo (worker->hentry.next || worker->hentry.pprev))) 964797e8345STejun Heo return; 965797e8345STejun Heo 966797e8345STejun Heo /* can't use worker_set_flags(), also called from create_worker() */ 967797e8345STejun Heo worker->flags |= WORKER_IDLE; 968797e8345STejun Heo pool->nr_idle++; 969797e8345STejun Heo worker->last_active = jiffies; 970797e8345STejun Heo 971797e8345STejun Heo /* idle_list is LIFO */ 972797e8345STejun Heo list_add(&worker->entry, &pool->idle_list); 973797e8345STejun Heo 974797e8345STejun Heo if (too_many_workers(pool) && !timer_pending(&pool->idle_timer)) 975797e8345STejun Heo mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT); 976797e8345STejun Heo 977797e8345STejun Heo /* Sanity check nr_running. */ 978797e8345STejun Heo WARN_ON_ONCE(pool->nr_workers == pool->nr_idle && pool->nr_running); 979797e8345STejun Heo } 980797e8345STejun Heo 981797e8345STejun Heo /** 982797e8345STejun Heo * worker_leave_idle - leave idle state 983797e8345STejun Heo * @worker: worker which is leaving idle state 984797e8345STejun Heo * 985797e8345STejun Heo * @worker is leaving idle state. Update stats. 986797e8345STejun Heo * 987797e8345STejun Heo * LOCKING: 988797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 989797e8345STejun Heo */ 990797e8345STejun Heo static void worker_leave_idle(struct worker *worker) 991797e8345STejun Heo { 992797e8345STejun Heo struct worker_pool *pool = worker->pool; 993797e8345STejun Heo 994797e8345STejun Heo if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE))) 995797e8345STejun Heo return; 996797e8345STejun Heo worker_clr_flags(worker, WORKER_IDLE); 997797e8345STejun Heo pool->nr_idle--; 998797e8345STejun Heo list_del_init(&worker->entry); 999797e8345STejun Heo } 1000797e8345STejun Heo 1001797e8345STejun Heo /** 1002797e8345STejun Heo * find_worker_executing_work - find worker which is executing a work 1003797e8345STejun Heo * @pool: pool of interest 1004797e8345STejun Heo * @work: work to find worker for 1005797e8345STejun Heo * 1006797e8345STejun Heo * Find a worker which is executing @work on @pool by searching 1007797e8345STejun Heo * @pool->busy_hash which is keyed by the address of @work. For a worker 1008797e8345STejun Heo * to match, its current execution should match the address of @work and 1009797e8345STejun Heo * its work function. This is to avoid unwanted dependency between 1010797e8345STejun Heo * unrelated work executions through a work item being recycled while still 1011797e8345STejun Heo * being executed. 1012797e8345STejun Heo * 1013797e8345STejun Heo * This is a bit tricky. A work item may be freed once its execution 1014797e8345STejun Heo * starts and nothing prevents the freed area from being recycled for 1015797e8345STejun Heo * another work item. If the same work item address ends up being reused 1016797e8345STejun Heo * before the original execution finishes, workqueue will identify the 1017797e8345STejun Heo * recycled work item as currently executing and make it wait until the 1018797e8345STejun Heo * current execution finishes, introducing an unwanted dependency. 1019797e8345STejun Heo * 1020797e8345STejun Heo * This function checks the work item address and work function to avoid 1021797e8345STejun Heo * false positives. Note that this isn't complete as one may construct a 1022797e8345STejun Heo * work function which can introduce dependency onto itself through a 1023797e8345STejun Heo * recycled work item. Well, if somebody wants to shoot oneself in the 1024797e8345STejun Heo * foot that badly, there's only so much we can do, and if such deadlock 1025797e8345STejun Heo * actually occurs, it should be easy to locate the culprit work function. 1026797e8345STejun Heo * 1027797e8345STejun Heo * CONTEXT: 1028797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 1029797e8345STejun Heo * 1030797e8345STejun Heo * Return: 1031797e8345STejun Heo * Pointer to worker which is executing @work if found, %NULL 1032797e8345STejun Heo * otherwise. 1033797e8345STejun Heo */ 1034797e8345STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool, 1035797e8345STejun Heo struct work_struct *work) 1036797e8345STejun Heo { 1037797e8345STejun Heo struct worker *worker; 1038797e8345STejun Heo 1039797e8345STejun Heo hash_for_each_possible(pool->busy_hash, worker, hentry, 1040797e8345STejun Heo (unsigned long)work) 1041797e8345STejun Heo if (worker->current_work == work && 1042797e8345STejun Heo worker->current_func == work->func) 1043797e8345STejun Heo return worker; 1044797e8345STejun Heo 1045797e8345STejun Heo return NULL; 1046797e8345STejun Heo } 1047797e8345STejun Heo 1048797e8345STejun Heo /** 1049797e8345STejun Heo * move_linked_works - move linked works to a list 1050797e8345STejun Heo * @work: start of series of works to be scheduled 1051797e8345STejun Heo * @head: target list to append @work to 1052797e8345STejun Heo * @nextp: out parameter for nested worklist walking 1053797e8345STejun Heo * 1054873eaca6STejun Heo * Schedule linked works starting from @work to @head. Work series to be 1055873eaca6STejun Heo * scheduled starts at @work and includes any consecutive work with 1056873eaca6STejun Heo * WORK_STRUCT_LINKED set in its predecessor. See assign_work() for details on 1057873eaca6STejun Heo * @nextp. 1058797e8345STejun Heo * 1059797e8345STejun Heo * CONTEXT: 1060797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 1061797e8345STejun Heo */ 1062797e8345STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head, 1063797e8345STejun Heo struct work_struct **nextp) 1064797e8345STejun Heo { 1065797e8345STejun Heo struct work_struct *n; 1066797e8345STejun Heo 1067797e8345STejun Heo /* 1068797e8345STejun Heo * Linked worklist will always end before the end of the list, 1069797e8345STejun Heo * use NULL for list head. 1070797e8345STejun Heo */ 1071797e8345STejun Heo list_for_each_entry_safe_from(work, n, NULL, entry) { 1072797e8345STejun Heo list_move_tail(&work->entry, head); 1073797e8345STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) 1074797e8345STejun Heo break; 1075797e8345STejun Heo } 1076797e8345STejun Heo 1077797e8345STejun Heo /* 1078797e8345STejun Heo * If we're already inside safe list traversal and have moved 1079797e8345STejun Heo * multiple works to the scheduled queue, the next position 1080797e8345STejun Heo * needs to be updated. 1081797e8345STejun Heo */ 1082797e8345STejun Heo if (nextp) 1083797e8345STejun Heo *nextp = n; 1084797e8345STejun Heo } 1085797e8345STejun Heo 1086797e8345STejun Heo /** 1087873eaca6STejun Heo * assign_work - assign a work item and its linked work items to a worker 1088873eaca6STejun Heo * @work: work to assign 1089873eaca6STejun Heo * @worker: worker to assign to 1090873eaca6STejun Heo * @nextp: out parameter for nested worklist walking 1091873eaca6STejun Heo * 1092873eaca6STejun Heo * Assign @work and its linked work items to @worker. If @work is already being 1093873eaca6STejun Heo * executed by another worker in the same pool, it'll be punted there. 1094873eaca6STejun Heo * 1095873eaca6STejun Heo * If @nextp is not NULL, it's updated to point to the next work of the last 1096873eaca6STejun Heo * scheduled work. This allows assign_work() to be nested inside 1097873eaca6STejun Heo * list_for_each_entry_safe(). 1098873eaca6STejun Heo * 1099873eaca6STejun Heo * Returns %true if @work was successfully assigned to @worker. %false if @work 1100873eaca6STejun Heo * was punted to another worker already executing it. 1101873eaca6STejun Heo */ 1102873eaca6STejun Heo static bool assign_work(struct work_struct *work, struct worker *worker, 1103873eaca6STejun Heo struct work_struct **nextp) 1104873eaca6STejun Heo { 1105873eaca6STejun Heo struct worker_pool *pool = worker->pool; 1106873eaca6STejun Heo struct worker *collision; 1107873eaca6STejun Heo 1108873eaca6STejun Heo lockdep_assert_held(&pool->lock); 1109873eaca6STejun Heo 1110873eaca6STejun Heo /* 1111873eaca6STejun Heo * A single work shouldn't be executed concurrently by multiple workers. 1112873eaca6STejun Heo * __queue_work() ensures that @work doesn't jump to a different pool 1113873eaca6STejun Heo * while still running in the previous pool. Here, we should ensure that 1114873eaca6STejun Heo * @work is not executed concurrently by multiple workers from the same 1115873eaca6STejun Heo * pool. Check whether anyone is already processing the work. If so, 1116873eaca6STejun Heo * defer the work to the currently executing one. 1117873eaca6STejun Heo */ 1118873eaca6STejun Heo collision = find_worker_executing_work(pool, work); 1119873eaca6STejun Heo if (unlikely(collision)) { 1120873eaca6STejun Heo move_linked_works(work, &collision->scheduled, nextp); 1121873eaca6STejun Heo return false; 1122873eaca6STejun Heo } 1123873eaca6STejun Heo 1124873eaca6STejun Heo move_linked_works(work, &worker->scheduled, nextp); 1125873eaca6STejun Heo return true; 1126873eaca6STejun Heo } 1127873eaca6STejun Heo 1128873eaca6STejun Heo /** 11290219a352STejun Heo * kick_pool - wake up an idle worker if necessary 11300219a352STejun Heo * @pool: pool to kick 1131797e8345STejun Heo * 11320219a352STejun Heo * @pool may have pending work items. Wake up worker if necessary. Returns 11330219a352STejun Heo * whether a worker was woken up. 1134797e8345STejun Heo */ 11350219a352STejun Heo static bool kick_pool(struct worker_pool *pool) 1136797e8345STejun Heo { 1137797e8345STejun Heo struct worker *worker = first_idle_worker(pool); 11388639ecebSTejun Heo struct task_struct *p; 1139797e8345STejun Heo 11400219a352STejun Heo lockdep_assert_held(&pool->lock); 11410219a352STejun Heo 11420219a352STejun Heo if (!need_more_worker(pool) || !worker) 11430219a352STejun Heo return false; 11440219a352STejun Heo 11458639ecebSTejun Heo p = worker->task; 11468639ecebSTejun Heo 11478639ecebSTejun Heo #ifdef CONFIG_SMP 11488639ecebSTejun Heo /* 11498639ecebSTejun Heo * Idle @worker is about to execute @work and waking up provides an 11508639ecebSTejun Heo * opportunity to migrate @worker at a lower cost by setting the task's 11518639ecebSTejun Heo * wake_cpu field. Let's see if we want to move @worker to improve 11528639ecebSTejun Heo * execution locality. 11538639ecebSTejun Heo * 11548639ecebSTejun Heo * We're waking the worker that went idle the latest and there's some 11558639ecebSTejun Heo * chance that @worker is marked idle but hasn't gone off CPU yet. If 11568639ecebSTejun Heo * so, setting the wake_cpu won't do anything. As this is a best-effort 11578639ecebSTejun Heo * optimization and the race window is narrow, let's leave as-is for 11588639ecebSTejun Heo * now. If this becomes pronounced, we can skip over workers which are 11598639ecebSTejun Heo * still on cpu when picking an idle worker. 11608639ecebSTejun Heo * 11618639ecebSTejun Heo * If @pool has non-strict affinity, @worker might have ended up outside 11628639ecebSTejun Heo * its affinity scope. Repatriate. 11638639ecebSTejun Heo */ 11648639ecebSTejun Heo if (!pool->attrs->affn_strict && 11658639ecebSTejun Heo !cpumask_test_cpu(p->wake_cpu, pool->attrs->__pod_cpumask)) { 11668639ecebSTejun Heo struct work_struct *work = list_first_entry(&pool->worklist, 11678639ecebSTejun Heo struct work_struct, entry); 11688639ecebSTejun Heo p->wake_cpu = cpumask_any_distribute(pool->attrs->__pod_cpumask); 11698639ecebSTejun Heo get_work_pwq(work)->stats[PWQ_STAT_REPATRIATED]++; 11708639ecebSTejun Heo } 11718639ecebSTejun Heo #endif 11728639ecebSTejun Heo wake_up_process(p); 11730219a352STejun Heo return true; 1174797e8345STejun Heo } 1175797e8345STejun Heo 117663638450STejun Heo #ifdef CONFIG_WQ_CPU_INTENSIVE_REPORT 117763638450STejun Heo 117863638450STejun Heo /* 117963638450STejun Heo * Concurrency-managed per-cpu work items that hog CPU for longer than 118063638450STejun Heo * wq_cpu_intensive_thresh_us trigger the automatic CPU_INTENSIVE mechanism, 118163638450STejun Heo * which prevents them from stalling other concurrency-managed work items. If a 118263638450STejun Heo * work function keeps triggering this mechanism, it's likely that the work item 118363638450STejun Heo * should be using an unbound workqueue instead. 118463638450STejun Heo * 118563638450STejun Heo * wq_cpu_intensive_report() tracks work functions which trigger such conditions 118663638450STejun Heo * and report them so that they can be examined and converted to use unbound 118763638450STejun Heo * workqueues as appropriate. To avoid flooding the console, each violating work 118863638450STejun Heo * function is tracked and reported with exponential backoff. 118963638450STejun Heo */ 119063638450STejun Heo #define WCI_MAX_ENTS 128 119163638450STejun Heo 119263638450STejun Heo struct wci_ent { 119363638450STejun Heo work_func_t func; 119463638450STejun Heo atomic64_t cnt; 119563638450STejun Heo struct hlist_node hash_node; 119663638450STejun Heo }; 119763638450STejun Heo 119863638450STejun Heo static struct wci_ent wci_ents[WCI_MAX_ENTS]; 119963638450STejun Heo static int wci_nr_ents; 120063638450STejun Heo static DEFINE_RAW_SPINLOCK(wci_lock); 120163638450STejun Heo static DEFINE_HASHTABLE(wci_hash, ilog2(WCI_MAX_ENTS)); 120263638450STejun Heo 120363638450STejun Heo static struct wci_ent *wci_find_ent(work_func_t func) 120463638450STejun Heo { 120563638450STejun Heo struct wci_ent *ent; 120663638450STejun Heo 120763638450STejun Heo hash_for_each_possible_rcu(wci_hash, ent, hash_node, 120863638450STejun Heo (unsigned long)func) { 120963638450STejun Heo if (ent->func == func) 121063638450STejun Heo return ent; 121163638450STejun Heo } 121263638450STejun Heo return NULL; 121363638450STejun Heo } 121463638450STejun Heo 121563638450STejun Heo static void wq_cpu_intensive_report(work_func_t func) 121663638450STejun Heo { 121763638450STejun Heo struct wci_ent *ent; 121863638450STejun Heo 121963638450STejun Heo restart: 122063638450STejun Heo ent = wci_find_ent(func); 122163638450STejun Heo if (ent) { 122263638450STejun Heo u64 cnt; 122363638450STejun Heo 122463638450STejun Heo /* 122563638450STejun Heo * Start reporting from the fourth time and back off 122663638450STejun Heo * exponentially. 122763638450STejun Heo */ 122863638450STejun Heo cnt = atomic64_inc_return_relaxed(&ent->cnt); 122963638450STejun Heo if (cnt >= 4 && is_power_of_2(cnt)) 123063638450STejun Heo printk_deferred(KERN_WARNING "workqueue: %ps hogged CPU for >%luus %llu times, consider switching to WQ_UNBOUND\n", 123163638450STejun Heo ent->func, wq_cpu_intensive_thresh_us, 123263638450STejun Heo atomic64_read(&ent->cnt)); 123363638450STejun Heo return; 123463638450STejun Heo } 123563638450STejun Heo 123663638450STejun Heo /* 123763638450STejun Heo * @func is a new violation. Allocate a new entry for it. If wcn_ents[] 123863638450STejun Heo * is exhausted, something went really wrong and we probably made enough 123963638450STejun Heo * noise already. 124063638450STejun Heo */ 124163638450STejun Heo if (wci_nr_ents >= WCI_MAX_ENTS) 124263638450STejun Heo return; 124363638450STejun Heo 124463638450STejun Heo raw_spin_lock(&wci_lock); 124563638450STejun Heo 124663638450STejun Heo if (wci_nr_ents >= WCI_MAX_ENTS) { 124763638450STejun Heo raw_spin_unlock(&wci_lock); 124863638450STejun Heo return; 124963638450STejun Heo } 125063638450STejun Heo 125163638450STejun Heo if (wci_find_ent(func)) { 125263638450STejun Heo raw_spin_unlock(&wci_lock); 125363638450STejun Heo goto restart; 125463638450STejun Heo } 125563638450STejun Heo 125663638450STejun Heo ent = &wci_ents[wci_nr_ents++]; 125763638450STejun Heo ent->func = func; 125863638450STejun Heo atomic64_set(&ent->cnt, 1); 125963638450STejun Heo hash_add_rcu(wci_hash, &ent->hash_node, (unsigned long)func); 126063638450STejun Heo 126163638450STejun Heo raw_spin_unlock(&wci_lock); 126263638450STejun Heo } 126363638450STejun Heo 126463638450STejun Heo #else /* CONFIG_WQ_CPU_INTENSIVE_REPORT */ 126563638450STejun Heo static void wq_cpu_intensive_report(work_func_t func) {} 126663638450STejun Heo #endif /* CONFIG_WQ_CPU_INTENSIVE_REPORT */ 126763638450STejun Heo 1268c54d5046STejun Heo /** 12691da177e4SLinus Torvalds * wq_worker_running - a worker is running again 12701da177e4SLinus Torvalds * @task: task waking up 12711da177e4SLinus Torvalds * 12721da177e4SLinus Torvalds * This function is called when a worker returns from schedule() 12731da177e4SLinus Torvalds */ 12741da177e4SLinus Torvalds void wq_worker_running(struct task_struct *task) 12751da177e4SLinus Torvalds { 12761da177e4SLinus Torvalds struct worker *worker = kthread_data(task); 12771da177e4SLinus Torvalds 1278c8f6219bSZqiang if (!READ_ONCE(worker->sleeping)) 12791da177e4SLinus Torvalds return; 12801da177e4SLinus Torvalds 12811da177e4SLinus Torvalds /* 12821da177e4SLinus Torvalds * If preempted by unbind_workers() between the WORKER_NOT_RUNNING check 12831da177e4SLinus Torvalds * and the nr_running increment below, we may ruin the nr_running reset 12841da177e4SLinus Torvalds * and leave with an unexpected pool->nr_running == 1 on the newly unbound 12851da177e4SLinus Torvalds * pool. Protect against such race. 12861da177e4SLinus Torvalds */ 12871da177e4SLinus Torvalds preempt_disable(); 12881da177e4SLinus Torvalds if (!(worker->flags & WORKER_NOT_RUNNING)) 12891da177e4SLinus Torvalds worker->pool->nr_running++; 12901da177e4SLinus Torvalds preempt_enable(); 1291616db877STejun Heo 1292616db877STejun Heo /* 1293616db877STejun Heo * CPU intensive auto-detection cares about how long a work item hogged 1294616db877STejun Heo * CPU without sleeping. Reset the starting timestamp on wakeup. 1295616db877STejun Heo */ 1296616db877STejun Heo worker->current_at = worker->task->se.sum_exec_runtime; 1297616db877STejun Heo 1298c8f6219bSZqiang WRITE_ONCE(worker->sleeping, 0); 12991da177e4SLinus Torvalds } 13001da177e4SLinus Torvalds 13011da177e4SLinus Torvalds /** 13021da177e4SLinus Torvalds * wq_worker_sleeping - a worker is going to sleep 13031da177e4SLinus Torvalds * @task: task going to sleep 13041da177e4SLinus Torvalds * 13051da177e4SLinus Torvalds * This function is called from schedule() when a busy worker is 13061da177e4SLinus Torvalds * going to sleep. 13071da177e4SLinus Torvalds */ 13081da177e4SLinus Torvalds void wq_worker_sleeping(struct task_struct *task) 13091da177e4SLinus Torvalds { 13101da177e4SLinus Torvalds struct worker *worker = kthread_data(task); 13111da177e4SLinus Torvalds struct worker_pool *pool; 13121da177e4SLinus Torvalds 13131da177e4SLinus Torvalds /* 13141da177e4SLinus Torvalds * Rescuers, which may not have all the fields set up like normal 13151da177e4SLinus Torvalds * workers, also reach here, let's not access anything before 13161da177e4SLinus Torvalds * checking NOT_RUNNING. 13171da177e4SLinus Torvalds */ 13181da177e4SLinus Torvalds if (worker->flags & WORKER_NOT_RUNNING) 13191da177e4SLinus Torvalds return; 13201da177e4SLinus Torvalds 13211da177e4SLinus Torvalds pool = worker->pool; 13221da177e4SLinus Torvalds 13231da177e4SLinus Torvalds /* Return if preempted before wq_worker_running() was reached */ 1324c8f6219bSZqiang if (READ_ONCE(worker->sleeping)) 13251da177e4SLinus Torvalds return; 13261da177e4SLinus Torvalds 1327c8f6219bSZqiang WRITE_ONCE(worker->sleeping, 1); 13281da177e4SLinus Torvalds raw_spin_lock_irq(&pool->lock); 13291da177e4SLinus Torvalds 13301da177e4SLinus Torvalds /* 13311da177e4SLinus Torvalds * Recheck in case unbind_workers() preempted us. We don't 13321da177e4SLinus Torvalds * want to decrement nr_running after the worker is unbound 13331da177e4SLinus Torvalds * and nr_running has been reset. 13341da177e4SLinus Torvalds */ 13351da177e4SLinus Torvalds if (worker->flags & WORKER_NOT_RUNNING) { 13361da177e4SLinus Torvalds raw_spin_unlock_irq(&pool->lock); 13371da177e4SLinus Torvalds return; 13381da177e4SLinus Torvalds } 13391da177e4SLinus Torvalds 13401da177e4SLinus Torvalds pool->nr_running--; 13410219a352STejun Heo if (kick_pool(pool)) 1342725e8ec5STejun Heo worker->current_pwq->stats[PWQ_STAT_CM_WAKEUP]++; 13430219a352STejun Heo 13441da177e4SLinus Torvalds raw_spin_unlock_irq(&pool->lock); 13451da177e4SLinus Torvalds } 13461da177e4SLinus Torvalds 13471da177e4SLinus Torvalds /** 1348616db877STejun Heo * wq_worker_tick - a scheduler tick occurred while a kworker is running 1349616db877STejun Heo * @task: task currently running 1350616db877STejun Heo * 1351616db877STejun Heo * Called from scheduler_tick(). We're in the IRQ context and the current 1352616db877STejun Heo * worker's fields which follow the 'K' locking rule can be accessed safely. 1353616db877STejun Heo */ 1354616db877STejun Heo void wq_worker_tick(struct task_struct *task) 1355616db877STejun Heo { 1356616db877STejun Heo struct worker *worker = kthread_data(task); 1357616db877STejun Heo struct pool_workqueue *pwq = worker->current_pwq; 1358616db877STejun Heo struct worker_pool *pool = worker->pool; 1359616db877STejun Heo 1360616db877STejun Heo if (!pwq) 1361616db877STejun Heo return; 1362616db877STejun Heo 13638a1dd1e5STejun Heo pwq->stats[PWQ_STAT_CPU_TIME] += TICK_USEC; 13648a1dd1e5STejun Heo 136518c8ae81SZqiang if (!wq_cpu_intensive_thresh_us) 136618c8ae81SZqiang return; 136718c8ae81SZqiang 1368616db877STejun Heo /* 1369616db877STejun Heo * If the current worker is concurrency managed and hogged the CPU for 1370616db877STejun Heo * longer than wq_cpu_intensive_thresh_us, it's automatically marked 1371616db877STejun Heo * CPU_INTENSIVE to avoid stalling other concurrency-managed work items. 1372c8f6219bSZqiang * 1373c8f6219bSZqiang * Set @worker->sleeping means that @worker is in the process of 1374c8f6219bSZqiang * switching out voluntarily and won't be contributing to 1375c8f6219bSZqiang * @pool->nr_running until it wakes up. As wq_worker_sleeping() also 1376c8f6219bSZqiang * decrements ->nr_running, setting CPU_INTENSIVE here can lead to 1377c8f6219bSZqiang * double decrements. The task is releasing the CPU anyway. Let's skip. 1378c8f6219bSZqiang * We probably want to make this prettier in the future. 1379616db877STejun Heo */ 1380c8f6219bSZqiang if ((worker->flags & WORKER_NOT_RUNNING) || READ_ONCE(worker->sleeping) || 1381616db877STejun Heo worker->task->se.sum_exec_runtime - worker->current_at < 1382616db877STejun Heo wq_cpu_intensive_thresh_us * NSEC_PER_USEC) 1383616db877STejun Heo return; 1384616db877STejun Heo 1385616db877STejun Heo raw_spin_lock(&pool->lock); 1386616db877STejun Heo 1387616db877STejun Heo worker_set_flags(worker, WORKER_CPU_INTENSIVE); 138863638450STejun Heo wq_cpu_intensive_report(worker->current_func); 1389616db877STejun Heo pwq->stats[PWQ_STAT_CPU_INTENSIVE]++; 1390616db877STejun Heo 13910219a352STejun Heo if (kick_pool(pool)) 1392616db877STejun Heo pwq->stats[PWQ_STAT_CM_WAKEUP]++; 1393616db877STejun Heo 1394616db877STejun Heo raw_spin_unlock(&pool->lock); 1395616db877STejun Heo } 1396616db877STejun Heo 1397616db877STejun Heo /** 13981da177e4SLinus Torvalds * wq_worker_last_func - retrieve worker's last work function 13991da177e4SLinus Torvalds * @task: Task to retrieve last work function of. 14001da177e4SLinus Torvalds * 14011da177e4SLinus Torvalds * Determine the last function a worker executed. This is called from 14021da177e4SLinus Torvalds * the scheduler to get a worker's last known identity. 14031da177e4SLinus Torvalds * 14041da177e4SLinus Torvalds * CONTEXT: 14059b41ea72SAndrew Morton * raw_spin_lock_irq(rq->lock) 14061da177e4SLinus Torvalds * 14071da177e4SLinus Torvalds * This function is called during schedule() when a kworker is going 1408f756d5e2SNathan Lynch * to sleep. It's used by psi to identify aggregation workers during 1409f756d5e2SNathan Lynch * dequeuing, to allow periodic aggregation to shut-off when that 14101da177e4SLinus Torvalds * worker is the last task in the system or cgroup to go to sleep. 14111da177e4SLinus Torvalds * 14121da177e4SLinus Torvalds * As this function doesn't involve any workqueue-related locking, it 14131da177e4SLinus Torvalds * only returns stable values when called from inside the scheduler's 14141da177e4SLinus Torvalds * queuing and dequeuing paths, when @task, which must be a kworker, 14151da177e4SLinus Torvalds * is guaranteed to not be processing any works. 1416365970a1SDavid Howells * 1417365970a1SDavid Howells * Return: 1418365970a1SDavid Howells * The last work function %current executed as a worker, NULL if it 1419365970a1SDavid Howells * hasn't executed any work yet. 1420365970a1SDavid Howells */ 1421365970a1SDavid Howells work_func_t wq_worker_last_func(struct task_struct *task) 1422365970a1SDavid Howells { 1423365970a1SDavid Howells struct worker *worker = kthread_data(task); 1424365970a1SDavid Howells 1425365970a1SDavid Howells return worker->last_func; 1426365970a1SDavid Howells } 1427365970a1SDavid Howells 1428d302f017STejun Heo /** 14298864b4e5STejun Heo * get_pwq - get an extra reference on the specified pool_workqueue 14308864b4e5STejun Heo * @pwq: pool_workqueue to get 14318864b4e5STejun Heo * 14328864b4e5STejun Heo * Obtain an extra reference on @pwq. The caller should guarantee that 14338864b4e5STejun Heo * @pwq has positive refcnt and be holding the matching pool->lock. 14348864b4e5STejun Heo */ 14358864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq) 14368864b4e5STejun Heo { 14378864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 14388864b4e5STejun Heo WARN_ON_ONCE(pwq->refcnt <= 0); 14398864b4e5STejun Heo pwq->refcnt++; 14408864b4e5STejun Heo } 14418864b4e5STejun Heo 14428864b4e5STejun Heo /** 14438864b4e5STejun Heo * put_pwq - put a pool_workqueue reference 14448864b4e5STejun Heo * @pwq: pool_workqueue to put 14458864b4e5STejun Heo * 14468864b4e5STejun Heo * Drop a reference of @pwq. If its refcnt reaches zero, schedule its 14478864b4e5STejun Heo * destruction. The caller should be holding the matching pool->lock. 14488864b4e5STejun Heo */ 14498864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq) 14508864b4e5STejun Heo { 14518864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 14528864b4e5STejun Heo if (likely(--pwq->refcnt)) 14538864b4e5STejun Heo return; 14548864b4e5STejun Heo /* 1455967b494eSTejun Heo * @pwq can't be released under pool->lock, bounce to a dedicated 1456967b494eSTejun Heo * kthread_worker to avoid A-A deadlocks. 14578864b4e5STejun Heo */ 1458687a9aa5STejun Heo kthread_queue_work(pwq_release_worker, &pwq->release_work); 14598864b4e5STejun Heo } 14608864b4e5STejun Heo 1461dce90d47STejun Heo /** 1462dce90d47STejun Heo * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock 1463dce90d47STejun Heo * @pwq: pool_workqueue to put (can be %NULL) 1464dce90d47STejun Heo * 1465dce90d47STejun Heo * put_pwq() with locking. This function also allows %NULL @pwq. 1466dce90d47STejun Heo */ 1467dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq) 1468dce90d47STejun Heo { 1469dce90d47STejun Heo if (pwq) { 1470dce90d47STejun Heo /* 147124acfb71SThomas Gleixner * As both pwqs and pools are RCU protected, the 1472dce90d47STejun Heo * following lock operations are safe. 1473dce90d47STejun Heo */ 1474a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 1475dce90d47STejun Heo put_pwq(pwq); 1476a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 1477dce90d47STejun Heo } 1478dce90d47STejun Heo } 1479dce90d47STejun Heo 1480afa87ce8STejun Heo static bool pwq_is_empty(struct pool_workqueue *pwq) 1481afa87ce8STejun Heo { 1482afa87ce8STejun Heo return !pwq->nr_active && list_empty(&pwq->inactive_works); 1483afa87ce8STejun Heo } 1484afa87ce8STejun Heo 14854c638030STejun Heo static void __pwq_activate_work(struct pool_workqueue *pwq, 14864c638030STejun Heo struct work_struct *work) 1487bf4ede01STejun Heo { 14881c270b79STejun Heo unsigned long *wdb = work_data_bits(work); 14891c270b79STejun Heo 14901c270b79STejun Heo WARN_ON_ONCE(!(*wdb & WORK_STRUCT_INACTIVE)); 1491bf4ede01STejun Heo trace_workqueue_activate_work(work); 149282607adcSTejun Heo if (list_empty(&pwq->pool->worklist)) 149382607adcSTejun Heo pwq->pool->watchdog_ts = jiffies; 1494112202d9STejun Heo move_linked_works(work, &pwq->pool->worklist, NULL); 14951c270b79STejun Heo __clear_bit(WORK_STRUCT_INACTIVE_BIT, wdb); 14964c638030STejun Heo } 14974c638030STejun Heo 14984c638030STejun Heo /** 14994c638030STejun Heo * pwq_activate_work - Activate a work item if inactive 15004c638030STejun Heo * @pwq: pool_workqueue @work belongs to 15014c638030STejun Heo * @work: work item to activate 15024c638030STejun Heo * 15034c638030STejun Heo * Returns %true if activated. %false if already active. 15044c638030STejun Heo */ 15054c638030STejun Heo static bool pwq_activate_work(struct pool_workqueue *pwq, 15064c638030STejun Heo struct work_struct *work) 15074c638030STejun Heo { 15084c638030STejun Heo struct worker_pool *pool = pwq->pool; 15094c638030STejun Heo 15104c638030STejun Heo lockdep_assert_held(&pool->lock); 15114c638030STejun Heo 15124c638030STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_INACTIVE)) 15134c638030STejun Heo return false; 15144c638030STejun Heo 1515112202d9STejun Heo pwq->nr_active++; 15164c638030STejun Heo __pwq_activate_work(pwq, work); 15174c638030STejun Heo return true; 1518bf4ede01STejun Heo } 1519bf4ede01STejun Heo 15201c270b79STejun Heo /** 15211c270b79STejun Heo * pwq_tryinc_nr_active - Try to increment nr_active for a pwq 15221c270b79STejun Heo * @pwq: pool_workqueue of interest 15231c270b79STejun Heo * 15241c270b79STejun Heo * Try to increment nr_active for @pwq. Returns %true if an nr_active count is 15251c270b79STejun Heo * successfully obtained. %false otherwise. 15261c270b79STejun Heo */ 15271c270b79STejun Heo static bool pwq_tryinc_nr_active(struct pool_workqueue *pwq) 15283aa62497SLai Jiangshan { 15291c270b79STejun Heo struct workqueue_struct *wq = pwq->wq; 15301c270b79STejun Heo struct worker_pool *pool = pwq->pool; 15311c270b79STejun Heo bool obtained; 15321c270b79STejun Heo 15331c270b79STejun Heo lockdep_assert_held(&pool->lock); 15341c270b79STejun Heo 15351c270b79STejun Heo obtained = pwq->nr_active < READ_ONCE(wq->max_active); 15361c270b79STejun Heo 15371c270b79STejun Heo if (obtained) 15381c270b79STejun Heo pwq->nr_active++; 15391c270b79STejun Heo return obtained; 15401c270b79STejun Heo } 15411c270b79STejun Heo 15421c270b79STejun Heo /** 15431c270b79STejun Heo * pwq_activate_first_inactive - Activate the first inactive work item on a pwq 15441c270b79STejun Heo * @pwq: pool_workqueue of interest 15451c270b79STejun Heo * 15461c270b79STejun Heo * Activate the first inactive work item of @pwq if available and allowed by 15471c270b79STejun Heo * max_active limit. 15481c270b79STejun Heo * 15491c270b79STejun Heo * Returns %true if an inactive work item has been activated. %false if no 15501c270b79STejun Heo * inactive work item is found or max_active limit is reached. 15511c270b79STejun Heo */ 15521c270b79STejun Heo static bool pwq_activate_first_inactive(struct pool_workqueue *pwq) 15531c270b79STejun Heo { 15541c270b79STejun Heo struct work_struct *work = 15551c270b79STejun Heo list_first_entry_or_null(&pwq->inactive_works, 15563aa62497SLai Jiangshan struct work_struct, entry); 15573aa62497SLai Jiangshan 15581c270b79STejun Heo if (work && pwq_tryinc_nr_active(pwq)) { 15591c270b79STejun Heo __pwq_activate_work(pwq, work); 15601c270b79STejun Heo return true; 15611c270b79STejun Heo } else { 15621c270b79STejun Heo return false; 15631c270b79STejun Heo } 15641c270b79STejun Heo } 15651c270b79STejun Heo 15661c270b79STejun Heo /** 15671c270b79STejun Heo * pwq_dec_nr_active - Retire an active count 15681c270b79STejun Heo * @pwq: pool_workqueue of interest 15691c270b79STejun Heo * 15701c270b79STejun Heo * Decrement @pwq's nr_active and try to activate the first inactive work item. 15711c270b79STejun Heo */ 15721c270b79STejun Heo static void pwq_dec_nr_active(struct pool_workqueue *pwq) 15731c270b79STejun Heo { 15741c270b79STejun Heo struct worker_pool *pool = pwq->pool; 15751c270b79STejun Heo 15761c270b79STejun Heo lockdep_assert_held(&pool->lock); 15771c270b79STejun Heo 15781c270b79STejun Heo pwq->nr_active--; 15791c270b79STejun Heo pwq_activate_first_inactive(pwq); 15803aa62497SLai Jiangshan } 15813aa62497SLai Jiangshan 1582bf4ede01STejun Heo /** 1583112202d9STejun Heo * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight 1584112202d9STejun Heo * @pwq: pwq of interest 1585c4560c2cSLai Jiangshan * @work_data: work_data of work which left the queue 1586bf4ede01STejun Heo * 1587bf4ede01STejun Heo * A work either has completed or is removed from pending queue, 1588112202d9STejun Heo * decrement nr_in_flight of its pwq and handle workqueue flushing. 1589bf4ede01STejun Heo * 1590*dd6c3c54STejun Heo * NOTE: 1591*dd6c3c54STejun Heo * For unbound workqueues, this function may temporarily drop @pwq->pool->lock 1592*dd6c3c54STejun Heo * and thus should be called after all other state updates for the in-flight 1593*dd6c3c54STejun Heo * work item is complete. 1594*dd6c3c54STejun Heo * 1595bf4ede01STejun Heo * CONTEXT: 1596a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 1597bf4ede01STejun Heo */ 1598c4560c2cSLai Jiangshan static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data) 1599bf4ede01STejun Heo { 1600c4560c2cSLai Jiangshan int color = get_work_color(work_data); 1601c4560c2cSLai Jiangshan 16021c270b79STejun Heo if (!(work_data & WORK_STRUCT_INACTIVE)) 16031c270b79STejun Heo pwq_dec_nr_active(pwq); 1604018f3a13SLai Jiangshan 1605018f3a13SLai Jiangshan pwq->nr_in_flight[color]--; 1606bf4ede01STejun Heo 1607bf4ede01STejun Heo /* is flush in progress and are we at the flushing tip? */ 1608112202d9STejun Heo if (likely(pwq->flush_color != color)) 16098864b4e5STejun Heo goto out_put; 1610bf4ede01STejun Heo 1611bf4ede01STejun Heo /* are there still in-flight works? */ 1612112202d9STejun Heo if (pwq->nr_in_flight[color]) 16138864b4e5STejun Heo goto out_put; 1614bf4ede01STejun Heo 1615112202d9STejun Heo /* this pwq is done, clear flush_color */ 1616112202d9STejun Heo pwq->flush_color = -1; 1617bf4ede01STejun Heo 1618bf4ede01STejun Heo /* 1619112202d9STejun Heo * If this was the last pwq, wake up the first flusher. It 1620bf4ede01STejun Heo * will handle the rest. 1621bf4ede01STejun Heo */ 1622112202d9STejun Heo if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush)) 1623112202d9STejun Heo complete(&pwq->wq->first_flusher->done); 16248864b4e5STejun Heo out_put: 16258864b4e5STejun Heo put_pwq(pwq); 1626bf4ede01STejun Heo } 1627bf4ede01STejun Heo 162836e227d2STejun Heo /** 1629bbb68dfaSTejun Heo * try_to_grab_pending - steal work item from worklist and disable irq 163036e227d2STejun Heo * @work: work item to steal 163136e227d2STejun Heo * @is_dwork: @work is a delayed_work 1632bbb68dfaSTejun Heo * @flags: place to store irq state 163336e227d2STejun Heo * 163436e227d2STejun Heo * Try to grab PENDING bit of @work. This function can handle @work in any 1635d185af30SYacine Belkadi * stable state - idle, on timer or on worklist. 163636e227d2STejun Heo * 1637d185af30SYacine Belkadi * Return: 16383eb6b31bSMauro Carvalho Chehab * 16393eb6b31bSMauro Carvalho Chehab * ======== ================================================================ 164036e227d2STejun Heo * 1 if @work was pending and we successfully stole PENDING 164136e227d2STejun Heo * 0 if @work was idle and we claimed PENDING 164236e227d2STejun Heo * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry 1643bbb68dfaSTejun Heo * -ENOENT if someone else is canceling @work, this state may persist 1644bbb68dfaSTejun Heo * for arbitrarily long 16453eb6b31bSMauro Carvalho Chehab * ======== ================================================================ 164636e227d2STejun Heo * 1647d185af30SYacine Belkadi * Note: 1648bbb68dfaSTejun Heo * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting 1649e0aecdd8STejun Heo * interrupted while holding PENDING and @work off queue, irq must be 1650e0aecdd8STejun Heo * disabled on entry. This, combined with delayed_work->timer being 1651e0aecdd8STejun Heo * irqsafe, ensures that we return -EAGAIN for finite short period of time. 1652bbb68dfaSTejun Heo * 1653bbb68dfaSTejun Heo * On successful return, >= 0, irq is disabled and the caller is 1654bbb68dfaSTejun Heo * responsible for releasing it using local_irq_restore(*@flags). 1655bbb68dfaSTejun Heo * 1656e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 1657bf4ede01STejun Heo */ 1658bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork, 1659bbb68dfaSTejun Heo unsigned long *flags) 1660bf4ede01STejun Heo { 1661d565ed63STejun Heo struct worker_pool *pool; 1662112202d9STejun Heo struct pool_workqueue *pwq; 1663bf4ede01STejun Heo 1664bbb68dfaSTejun Heo local_irq_save(*flags); 1665bbb68dfaSTejun Heo 166636e227d2STejun Heo /* try to steal the timer if it exists */ 166736e227d2STejun Heo if (is_dwork) { 166836e227d2STejun Heo struct delayed_work *dwork = to_delayed_work(work); 166936e227d2STejun Heo 1670e0aecdd8STejun Heo /* 1671e0aecdd8STejun Heo * dwork->timer is irqsafe. If del_timer() fails, it's 1672e0aecdd8STejun Heo * guaranteed that the timer is not queued anywhere and not 1673e0aecdd8STejun Heo * running on the local CPU. 1674e0aecdd8STejun Heo */ 167536e227d2STejun Heo if (likely(del_timer(&dwork->timer))) 167636e227d2STejun Heo return 1; 167736e227d2STejun Heo } 167836e227d2STejun Heo 167936e227d2STejun Heo /* try to claim PENDING the normal way */ 1680bf4ede01STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) 1681bf4ede01STejun Heo return 0; 1682bf4ede01STejun Heo 168324acfb71SThomas Gleixner rcu_read_lock(); 1684bf4ede01STejun Heo /* 1685bf4ede01STejun Heo * The queueing is in progress, or it is already queued. Try to 1686bf4ede01STejun Heo * steal it from ->worklist without clearing WORK_STRUCT_PENDING. 1687bf4ede01STejun Heo */ 1688d565ed63STejun Heo pool = get_work_pool(work); 1689d565ed63STejun Heo if (!pool) 1690bbb68dfaSTejun Heo goto fail; 1691bf4ede01STejun Heo 1692a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&pool->lock); 1693bf4ede01STejun Heo /* 1694112202d9STejun Heo * work->data is guaranteed to point to pwq only while the work 1695112202d9STejun Heo * item is queued on pwq->wq, and both updating work->data to point 1696112202d9STejun Heo * to pwq on queueing and to pool on dequeueing are done under 1697112202d9STejun Heo * pwq->pool->lock. This in turn guarantees that, if work->data 1698112202d9STejun Heo * points to pwq which is associated with a locked pool, the work 16990b3dae68SLai Jiangshan * item is currently queued on that pool. 1700bf4ede01STejun Heo */ 1701112202d9STejun Heo pwq = get_work_pwq(work); 1702112202d9STejun Heo if (pwq && pwq->pool == pool) { 1703bf4ede01STejun Heo debug_work_deactivate(work); 17043aa62497SLai Jiangshan 17053aa62497SLai Jiangshan /* 1706018f3a13SLai Jiangshan * A cancelable inactive work item must be in the 1707018f3a13SLai Jiangshan * pwq->inactive_works since a queued barrier can't be 1708018f3a13SLai Jiangshan * canceled (see the comments in insert_wq_barrier()). 1709018f3a13SLai Jiangshan * 1710f97a4a1aSLai Jiangshan * An inactive work item cannot be grabbed directly because 1711d812796eSLai Jiangshan * it might have linked barrier work items which, if left 1712f97a4a1aSLai Jiangshan * on the inactive_works list, will confuse pwq->nr_active 171316062836STejun Heo * management later on and cause stall. Make sure the work 171416062836STejun Heo * item is activated before grabbing. 17153aa62497SLai Jiangshan */ 17164c638030STejun Heo pwq_activate_work(pwq, work); 17173aa62497SLai Jiangshan 1718bf4ede01STejun Heo list_del_init(&work->entry); 171936e227d2STejun Heo 1720112202d9STejun Heo /* work->data points to pwq iff queued, point to pool */ 17214468a00fSLai Jiangshan set_work_pool_and_keep_pending(work, pool->id); 17224468a00fSLai Jiangshan 1723*dd6c3c54STejun Heo /* must be the last step, see the function comment */ 1724*dd6c3c54STejun Heo pwq_dec_nr_in_flight(pwq, *work_data_bits(work)); 1725*dd6c3c54STejun Heo 1726a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&pool->lock); 172724acfb71SThomas Gleixner rcu_read_unlock(); 172836e227d2STejun Heo return 1; 1729bf4ede01STejun Heo } 1730a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&pool->lock); 1731bbb68dfaSTejun Heo fail: 173224acfb71SThomas Gleixner rcu_read_unlock(); 1733bbb68dfaSTejun Heo local_irq_restore(*flags); 1734bbb68dfaSTejun Heo if (work_is_canceling(work)) 1735bbb68dfaSTejun Heo return -ENOENT; 1736bbb68dfaSTejun Heo cpu_relax(); 173736e227d2STejun Heo return -EAGAIN; 1738bf4ede01STejun Heo } 1739bf4ede01STejun Heo 1740bf4ede01STejun Heo /** 1741706026c2STejun Heo * insert_work - insert a work into a pool 1742112202d9STejun Heo * @pwq: pwq @work belongs to 17434690c4abSTejun Heo * @work: work to insert 17444690c4abSTejun Heo * @head: insertion point 17454690c4abSTejun Heo * @extra_flags: extra WORK_STRUCT_* flags to set 17464690c4abSTejun Heo * 1747112202d9STejun Heo * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to 1748706026c2STejun Heo * work_struct flags. 17494690c4abSTejun Heo * 17504690c4abSTejun Heo * CONTEXT: 1751a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 1752365970a1SDavid Howells */ 1753112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work, 1754112202d9STejun Heo struct list_head *head, unsigned int extra_flags) 1755b89deed3SOleg Nesterov { 1756fe089f87STejun Heo debug_work_activate(work); 1757e1d8aa9fSFrederic Weisbecker 1758e89a85d6SWalter Wu /* record the work call stack in order to print it in KASAN reports */ 1759f70da745SMarco Elver kasan_record_aux_stack_noalloc(work); 1760e89a85d6SWalter Wu 17614690c4abSTejun Heo /* we own @work, set data and link */ 1762112202d9STejun Heo set_work_pwq(work, pwq, extra_flags); 17631a4d9b0aSOleg Nesterov list_add_tail(&work->entry, head); 17648864b4e5STejun Heo get_pwq(pwq); 1765b89deed3SOleg Nesterov } 1766b89deed3SOleg Nesterov 1767c8efcc25STejun Heo /* 1768c8efcc25STejun Heo * Test whether @work is being queued from another work executing on the 17698d03ecfeSTejun Heo * same workqueue. 1770c8efcc25STejun Heo */ 1771c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq) 1772c8efcc25STejun Heo { 1773c8efcc25STejun Heo struct worker *worker; 1774c8efcc25STejun Heo 17758d03ecfeSTejun Heo worker = current_wq_worker(); 1776c8efcc25STejun Heo /* 1777bf393fd4SBart Van Assche * Return %true iff I'm a worker executing a work item on @wq. If 17788d03ecfeSTejun Heo * I'm @worker, it's safe to dereference it without locking. 1779c8efcc25STejun Heo */ 1780112202d9STejun Heo return worker && worker->current_pwq->wq == wq; 1781c8efcc25STejun Heo } 1782c8efcc25STejun Heo 1783ef557180SMike Galbraith /* 1784ef557180SMike Galbraith * When queueing an unbound work item to a wq, prefer local CPU if allowed 1785ef557180SMike Galbraith * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to 1786ef557180SMike Galbraith * avoid perturbing sensitive tasks. 1787ef557180SMike Galbraith */ 1788ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu) 1789ef557180SMike Galbraith { 1790ef557180SMike Galbraith int new_cpu; 1791ef557180SMike Galbraith 1792f303fccbSTejun Heo if (likely(!wq_debug_force_rr_cpu)) { 1793ef557180SMike Galbraith if (cpumask_test_cpu(cpu, wq_unbound_cpumask)) 1794ef557180SMike Galbraith return cpu; 1795a8ec5880SAmmar Faizi } else { 1796a8ec5880SAmmar Faizi pr_warn_once("workqueue: round-robin CPU selection forced, expect performance impact\n"); 1797f303fccbSTejun Heo } 1798f303fccbSTejun Heo 1799ef557180SMike Galbraith new_cpu = __this_cpu_read(wq_rr_cpu_last); 1800ef557180SMike Galbraith new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask); 1801ef557180SMike Galbraith if (unlikely(new_cpu >= nr_cpu_ids)) { 1802ef557180SMike Galbraith new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask); 1803ef557180SMike Galbraith if (unlikely(new_cpu >= nr_cpu_ids)) 1804ef557180SMike Galbraith return cpu; 1805ef557180SMike Galbraith } 1806ef557180SMike Galbraith __this_cpu_write(wq_rr_cpu_last, new_cpu); 1807ef557180SMike Galbraith 1808ef557180SMike Galbraith return new_cpu; 1809ef557180SMike Galbraith } 1810ef557180SMike Galbraith 1811d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq, 18121da177e4SLinus Torvalds struct work_struct *work) 18131da177e4SLinus Torvalds { 1814112202d9STejun Heo struct pool_workqueue *pwq; 1815fe089f87STejun Heo struct worker_pool *last_pool, *pool; 18168a2e8e5dSTejun Heo unsigned int work_flags; 1817b75cac93SJoonsoo Kim unsigned int req_cpu = cpu; 18188930cabaSTejun Heo 18198930cabaSTejun Heo /* 18208930cabaSTejun Heo * While a work item is PENDING && off queue, a task trying to 18218930cabaSTejun Heo * steal the PENDING will busy-loop waiting for it to either get 18228930cabaSTejun Heo * queued or lose PENDING. Grabbing PENDING and queueing should 18238930cabaSTejun Heo * happen with IRQ disabled. 18248930cabaSTejun Heo */ 18258e8eb730SFrederic Weisbecker lockdep_assert_irqs_disabled(); 18261da177e4SLinus Torvalds 18271e19ffc6STejun Heo 182833e3f0a3SRichard Clark /* 182933e3f0a3SRichard Clark * For a draining wq, only works from the same workqueue are 183033e3f0a3SRichard Clark * allowed. The __WQ_DESTROYING helps to spot the issue that 183133e3f0a3SRichard Clark * queues a new work item to a wq after destroy_workqueue(wq). 183233e3f0a3SRichard Clark */ 183333e3f0a3SRichard Clark if (unlikely(wq->flags & (__WQ_DESTROYING | __WQ_DRAINING) && 183433e3f0a3SRichard Clark WARN_ON_ONCE(!is_chained_work(wq)))) 1835e41e704bSTejun Heo return; 183624acfb71SThomas Gleixner rcu_read_lock(); 18379e8cd2f5STejun Heo retry: 1838aa202f1fSHillf Danton /* pwq which will be used unless @work is executing elsewhere */ 1839636b927eSTejun Heo if (req_cpu == WORK_CPU_UNBOUND) { 1840636b927eSTejun Heo if (wq->flags & WQ_UNBOUND) 1841ef557180SMike Galbraith cpu = wq_select_unbound_cpu(raw_smp_processor_id()); 1842636b927eSTejun Heo else 1843aa202f1fSHillf Danton cpu = raw_smp_processor_id(); 1844aa202f1fSHillf Danton } 1845f3421797STejun Heo 1846636b927eSTejun Heo pwq = rcu_dereference(*per_cpu_ptr(wq->cpu_pwq, cpu)); 1847fe089f87STejun Heo pool = pwq->pool; 1848fe089f87STejun Heo 184918aa9effSTejun Heo /* 1850c9178087STejun Heo * If @work was previously on a different pool, it might still be 1851c9178087STejun Heo * running there, in which case the work needs to be queued on that 1852c9178087STejun Heo * pool to guarantee non-reentrancy. 185318aa9effSTejun Heo */ 1854c9e7cf27STejun Heo last_pool = get_work_pool(work); 1855fe089f87STejun Heo if (last_pool && last_pool != pool) { 185618aa9effSTejun Heo struct worker *worker; 185718aa9effSTejun Heo 1858a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&last_pool->lock); 185918aa9effSTejun Heo 1860c9e7cf27STejun Heo worker = find_worker_executing_work(last_pool, work); 186118aa9effSTejun Heo 1862112202d9STejun Heo if (worker && worker->current_pwq->wq == wq) { 1863c9178087STejun Heo pwq = worker->current_pwq; 1864fe089f87STejun Heo pool = pwq->pool; 1865fe089f87STejun Heo WARN_ON_ONCE(pool != last_pool); 18668594fadeSLai Jiangshan } else { 186718aa9effSTejun Heo /* meh... not running there, queue here */ 1868a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&last_pool->lock); 1869fe089f87STejun Heo raw_spin_lock(&pool->lock); 187018aa9effSTejun Heo } 18718930cabaSTejun Heo } else { 1872fe089f87STejun Heo raw_spin_lock(&pool->lock); 18738930cabaSTejun Heo } 1874502ca9d8STejun Heo 18759e8cd2f5STejun Heo /* 1876636b927eSTejun Heo * pwq is determined and locked. For unbound pools, we could have raced 1877636b927eSTejun Heo * with pwq release and it could already be dead. If its refcnt is zero, 1878636b927eSTejun Heo * repeat pwq selection. Note that unbound pwqs never die without 1879636b927eSTejun Heo * another pwq replacing it in cpu_pwq or while work items are executing 1880636b927eSTejun Heo * on it, so the retrying is guaranteed to make forward-progress. 18819e8cd2f5STejun Heo */ 18829e8cd2f5STejun Heo if (unlikely(!pwq->refcnt)) { 18839e8cd2f5STejun Heo if (wq->flags & WQ_UNBOUND) { 1884fe089f87STejun Heo raw_spin_unlock(&pool->lock); 18859e8cd2f5STejun Heo cpu_relax(); 18869e8cd2f5STejun Heo goto retry; 18879e8cd2f5STejun Heo } 18889e8cd2f5STejun Heo /* oops */ 18899e8cd2f5STejun Heo WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt", 18909e8cd2f5STejun Heo wq->name, cpu); 18919e8cd2f5STejun Heo } 18929e8cd2f5STejun Heo 1893112202d9STejun Heo /* pwq determined, queue */ 1894112202d9STejun Heo trace_workqueue_queue_work(req_cpu, pwq, work); 1895502ca9d8STejun Heo 189624acfb71SThomas Gleixner if (WARN_ON(!list_empty(&work->entry))) 189724acfb71SThomas Gleixner goto out; 18981e19ffc6STejun Heo 1899112202d9STejun Heo pwq->nr_in_flight[pwq->work_color]++; 1900112202d9STejun Heo work_flags = work_color_to_flags(pwq->work_color); 19011e19ffc6STejun Heo 1902a045a272STejun Heo /* 1903a045a272STejun Heo * Limit the number of concurrently active work items to max_active. 1904a045a272STejun Heo * @work must also queue behind existing inactive work items to maintain 1905a045a272STejun Heo * ordering when max_active changes. See wq_adjust_max_active(). 1906a045a272STejun Heo */ 19071c270b79STejun Heo if (list_empty(&pwq->inactive_works) && pwq_tryinc_nr_active(pwq)) { 1908fe089f87STejun Heo if (list_empty(&pool->worklist)) 1909fe089f87STejun Heo pool->watchdog_ts = jiffies; 1910fe089f87STejun Heo 1911cdadf009STejun Heo trace_workqueue_activate_work(work); 1912fe089f87STejun Heo insert_work(pwq, work, &pool->worklist, work_flags); 19130219a352STejun Heo kick_pool(pool); 19148a2e8e5dSTejun Heo } else { 1915f97a4a1aSLai Jiangshan work_flags |= WORK_STRUCT_INACTIVE; 1916fe089f87STejun Heo insert_work(pwq, work, &pwq->inactive_works, work_flags); 19178a2e8e5dSTejun Heo } 19181e19ffc6STejun Heo 191924acfb71SThomas Gleixner out: 1920fe089f87STejun Heo raw_spin_unlock(&pool->lock); 192124acfb71SThomas Gleixner rcu_read_unlock(); 19221da177e4SLinus Torvalds } 19231da177e4SLinus Torvalds 19240fcb78c2SRolf Eike Beer /** 1925c1a220e7SZhang Rui * queue_work_on - queue work on specific cpu 1926c1a220e7SZhang Rui * @cpu: CPU number to execute work on 1927c1a220e7SZhang Rui * @wq: workqueue to use 1928c1a220e7SZhang Rui * @work: work to queue 1929c1a220e7SZhang Rui * 1930c1a220e7SZhang Rui * We queue the work to a specific CPU, the caller must ensure it 1931443378f0SPaul E. McKenney * can't go away. Callers that fail to ensure that the specified 1932443378f0SPaul E. McKenney * CPU cannot go away will execute on a randomly chosen CPU. 1933854f5cc5SPaul E. McKenney * But note well that callers specifying a CPU that never has been 1934854f5cc5SPaul E. McKenney * online will get a splat. 1935d185af30SYacine Belkadi * 1936d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. 1937c1a220e7SZhang Rui */ 1938d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq, 1939d4283e93STejun Heo struct work_struct *work) 1940c1a220e7SZhang Rui { 1941d4283e93STejun Heo bool ret = false; 19428930cabaSTejun Heo unsigned long flags; 19438930cabaSTejun Heo 19448930cabaSTejun Heo local_irq_save(flags); 1945c1a220e7SZhang Rui 194622df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 19474690c4abSTejun Heo __queue_work(cpu, wq, work); 1948d4283e93STejun Heo ret = true; 1949c1a220e7SZhang Rui } 19508930cabaSTejun Heo 19518930cabaSTejun Heo local_irq_restore(flags); 1952c1a220e7SZhang Rui return ret; 1953c1a220e7SZhang Rui } 1954ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on); 1955c1a220e7SZhang Rui 19568204e0c1SAlexander Duyck /** 1957fef59c9cSTejun Heo * select_numa_node_cpu - Select a CPU based on NUMA node 19588204e0c1SAlexander Duyck * @node: NUMA node ID that we want to select a CPU from 19598204e0c1SAlexander Duyck * 19608204e0c1SAlexander Duyck * This function will attempt to find a "random" cpu available on a given 19618204e0c1SAlexander Duyck * node. If there are no CPUs available on the given node it will return 19628204e0c1SAlexander Duyck * WORK_CPU_UNBOUND indicating that we should just schedule to any 19638204e0c1SAlexander Duyck * available CPU if we need to schedule this work. 19648204e0c1SAlexander Duyck */ 1965fef59c9cSTejun Heo static int select_numa_node_cpu(int node) 19668204e0c1SAlexander Duyck { 19678204e0c1SAlexander Duyck int cpu; 19688204e0c1SAlexander Duyck 19698204e0c1SAlexander Duyck /* Delay binding to CPU if node is not valid or online */ 19708204e0c1SAlexander Duyck if (node < 0 || node >= MAX_NUMNODES || !node_online(node)) 19718204e0c1SAlexander Duyck return WORK_CPU_UNBOUND; 19728204e0c1SAlexander Duyck 19738204e0c1SAlexander Duyck /* Use local node/cpu if we are already there */ 19748204e0c1SAlexander Duyck cpu = raw_smp_processor_id(); 19758204e0c1SAlexander Duyck if (node == cpu_to_node(cpu)) 19768204e0c1SAlexander Duyck return cpu; 19778204e0c1SAlexander Duyck 19788204e0c1SAlexander Duyck /* Use "random" otherwise know as "first" online CPU of node */ 19798204e0c1SAlexander Duyck cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask); 19808204e0c1SAlexander Duyck 19818204e0c1SAlexander Duyck /* If CPU is valid return that, otherwise just defer */ 19828204e0c1SAlexander Duyck return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND; 19838204e0c1SAlexander Duyck } 19848204e0c1SAlexander Duyck 19858204e0c1SAlexander Duyck /** 19868204e0c1SAlexander Duyck * queue_work_node - queue work on a "random" cpu for a given NUMA node 19878204e0c1SAlexander Duyck * @node: NUMA node that we are targeting the work for 19888204e0c1SAlexander Duyck * @wq: workqueue to use 19898204e0c1SAlexander Duyck * @work: work to queue 19908204e0c1SAlexander Duyck * 19918204e0c1SAlexander Duyck * We queue the work to a "random" CPU within a given NUMA node. The basic 19928204e0c1SAlexander Duyck * idea here is to provide a way to somehow associate work with a given 19938204e0c1SAlexander Duyck * NUMA node. 19948204e0c1SAlexander Duyck * 19958204e0c1SAlexander Duyck * This function will only make a best effort attempt at getting this onto 19968204e0c1SAlexander Duyck * the right NUMA node. If no node is requested or the requested node is 19978204e0c1SAlexander Duyck * offline then we just fall back to standard queue_work behavior. 19988204e0c1SAlexander Duyck * 19998204e0c1SAlexander Duyck * Currently the "random" CPU ends up being the first available CPU in the 20008204e0c1SAlexander Duyck * intersection of cpu_online_mask and the cpumask of the node, unless we 20018204e0c1SAlexander Duyck * are running on the node. In that case we just use the current CPU. 20028204e0c1SAlexander Duyck * 20038204e0c1SAlexander Duyck * Return: %false if @work was already on a queue, %true otherwise. 20048204e0c1SAlexander Duyck */ 20058204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq, 20068204e0c1SAlexander Duyck struct work_struct *work) 20078204e0c1SAlexander Duyck { 20088204e0c1SAlexander Duyck unsigned long flags; 20098204e0c1SAlexander Duyck bool ret = false; 20108204e0c1SAlexander Duyck 20118204e0c1SAlexander Duyck /* 20128204e0c1SAlexander Duyck * This current implementation is specific to unbound workqueues. 20138204e0c1SAlexander Duyck * Specifically we only return the first available CPU for a given 20148204e0c1SAlexander Duyck * node instead of cycling through individual CPUs within the node. 20158204e0c1SAlexander Duyck * 20168204e0c1SAlexander Duyck * If this is used with a per-cpu workqueue then the logic in 20178204e0c1SAlexander Duyck * workqueue_select_cpu_near would need to be updated to allow for 20188204e0c1SAlexander Duyck * some round robin type logic. 20198204e0c1SAlexander Duyck */ 20208204e0c1SAlexander Duyck WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)); 20218204e0c1SAlexander Duyck 20228204e0c1SAlexander Duyck local_irq_save(flags); 20238204e0c1SAlexander Duyck 20248204e0c1SAlexander Duyck if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 2025fef59c9cSTejun Heo int cpu = select_numa_node_cpu(node); 20268204e0c1SAlexander Duyck 20278204e0c1SAlexander Duyck __queue_work(cpu, wq, work); 20288204e0c1SAlexander Duyck ret = true; 20298204e0c1SAlexander Duyck } 20308204e0c1SAlexander Duyck 20318204e0c1SAlexander Duyck local_irq_restore(flags); 20328204e0c1SAlexander Duyck return ret; 20338204e0c1SAlexander Duyck } 20348204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node); 20358204e0c1SAlexander Duyck 20368c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t) 20371da177e4SLinus Torvalds { 20388c20feb6SKees Cook struct delayed_work *dwork = from_timer(dwork, t, timer); 20391da177e4SLinus Torvalds 2040e0aecdd8STejun Heo /* should have been called from irqsafe timer with irq already off */ 204160c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 20421da177e4SLinus Torvalds } 20431438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn); 20441da177e4SLinus Torvalds 20457beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq, 204652bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 20471da177e4SLinus Torvalds { 20487beb2edfSTejun Heo struct timer_list *timer = &dwork->timer; 20497beb2edfSTejun Heo struct work_struct *work = &dwork->work; 20501da177e4SLinus Torvalds 2051637fdbaeSTejun Heo WARN_ON_ONCE(!wq); 20524b243563SSami Tolvanen WARN_ON_ONCE(timer->function != delayed_work_timer_fn); 2053fc4b514fSTejun Heo WARN_ON_ONCE(timer_pending(timer)); 2054fc4b514fSTejun Heo WARN_ON_ONCE(!list_empty(&work->entry)); 20557beb2edfSTejun Heo 20568852aac2STejun Heo /* 20578852aac2STejun Heo * If @delay is 0, queue @dwork->work immediately. This is for 20588852aac2STejun Heo * both optimization and correctness. The earliest @timer can 20598852aac2STejun Heo * expire is on the closest next tick and delayed_work users depend 20608852aac2STejun Heo * on that there's no such delay when @delay is 0. 20618852aac2STejun Heo */ 20628852aac2STejun Heo if (!delay) { 20638852aac2STejun Heo __queue_work(cpu, wq, &dwork->work); 20648852aac2STejun Heo return; 20658852aac2STejun Heo } 20668852aac2STejun Heo 206760c057bcSLai Jiangshan dwork->wq = wq; 20681265057fSTejun Heo dwork->cpu = cpu; 20697beb2edfSTejun Heo timer->expires = jiffies + delay; 20707beb2edfSTejun Heo 2071041bd12eSTejun Heo if (unlikely(cpu != WORK_CPU_UNBOUND)) 20727beb2edfSTejun Heo add_timer_on(timer, cpu); 2073041bd12eSTejun Heo else 2074041bd12eSTejun Heo add_timer(timer); 20757beb2edfSTejun Heo } 20761da177e4SLinus Torvalds 20770fcb78c2SRolf Eike Beer /** 20780fcb78c2SRolf Eike Beer * queue_delayed_work_on - queue work on specific CPU after delay 20790fcb78c2SRolf Eike Beer * @cpu: CPU number to execute work on 20800fcb78c2SRolf Eike Beer * @wq: workqueue to use 2081af9997e4SRandy Dunlap * @dwork: work to queue 20820fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 20830fcb78c2SRolf Eike Beer * 2084d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. If 2085715f1300STejun Heo * @delay is zero and @dwork is idle, it will be scheduled for immediate 2086715f1300STejun Heo * execution. 20870fcb78c2SRolf Eike Beer */ 2088d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 208952bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 20907a6bc1cdSVenkatesh Pallipadi { 209152bad64dSDavid Howells struct work_struct *work = &dwork->work; 2092d4283e93STejun Heo bool ret = false; 20938930cabaSTejun Heo unsigned long flags; 20948930cabaSTejun Heo 20958930cabaSTejun Heo /* read the comment in __queue_work() */ 20968930cabaSTejun Heo local_irq_save(flags); 20977a6bc1cdSVenkatesh Pallipadi 209822df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 20997beb2edfSTejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 2100d4283e93STejun Heo ret = true; 21017a6bc1cdSVenkatesh Pallipadi } 21028930cabaSTejun Heo 21038930cabaSTejun Heo local_irq_restore(flags); 21047a6bc1cdSVenkatesh Pallipadi return ret; 21057a6bc1cdSVenkatesh Pallipadi } 2106ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on); 21071da177e4SLinus Torvalds 2108c8e55f36STejun Heo /** 21098376fe22STejun Heo * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU 21108376fe22STejun Heo * @cpu: CPU number to execute work on 21118376fe22STejun Heo * @wq: workqueue to use 21128376fe22STejun Heo * @dwork: work to queue 21138376fe22STejun Heo * @delay: number of jiffies to wait before queueing 21148376fe22STejun Heo * 21158376fe22STejun Heo * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise, 21168376fe22STejun Heo * modify @dwork's timer so that it expires after @delay. If @delay is 21178376fe22STejun Heo * zero, @work is guaranteed to be scheduled immediately regardless of its 21188376fe22STejun Heo * current state. 21198376fe22STejun Heo * 2120d185af30SYacine Belkadi * Return: %false if @dwork was idle and queued, %true if @dwork was 21218376fe22STejun Heo * pending and its timer was modified. 21228376fe22STejun Heo * 2123e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 21248376fe22STejun Heo * See try_to_grab_pending() for details. 21258376fe22STejun Heo */ 21268376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, 21278376fe22STejun Heo struct delayed_work *dwork, unsigned long delay) 21288376fe22STejun Heo { 21298376fe22STejun Heo unsigned long flags; 21308376fe22STejun Heo int ret; 21318376fe22STejun Heo 21328376fe22STejun Heo do { 21338376fe22STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 21348376fe22STejun Heo } while (unlikely(ret == -EAGAIN)); 21358376fe22STejun Heo 21368376fe22STejun Heo if (likely(ret >= 0)) { 21378376fe22STejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 21388376fe22STejun Heo local_irq_restore(flags); 21398376fe22STejun Heo } 21408376fe22STejun Heo 21418376fe22STejun Heo /* -ENOENT from try_to_grab_pending() becomes %true */ 21428376fe22STejun Heo return ret; 21438376fe22STejun Heo } 21448376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on); 21458376fe22STejun Heo 214605f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu) 214705f0fe6bSTejun Heo { 214805f0fe6bSTejun Heo struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu); 214905f0fe6bSTejun Heo 215005f0fe6bSTejun Heo /* read the comment in __queue_work() */ 215105f0fe6bSTejun Heo local_irq_disable(); 215205f0fe6bSTejun Heo __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work); 215305f0fe6bSTejun Heo local_irq_enable(); 215405f0fe6bSTejun Heo } 215505f0fe6bSTejun Heo 215605f0fe6bSTejun Heo /** 215705f0fe6bSTejun Heo * queue_rcu_work - queue work after a RCU grace period 215805f0fe6bSTejun Heo * @wq: workqueue to use 215905f0fe6bSTejun Heo * @rwork: work to queue 216005f0fe6bSTejun Heo * 216105f0fe6bSTejun Heo * Return: %false if @rwork was already pending, %true otherwise. Note 216205f0fe6bSTejun Heo * that a full RCU grace period is guaranteed only after a %true return. 2163bf393fd4SBart Van Assche * While @rwork is guaranteed to be executed after a %false return, the 216405f0fe6bSTejun Heo * execution may happen before a full RCU grace period has passed. 216505f0fe6bSTejun Heo */ 216605f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork) 216705f0fe6bSTejun Heo { 216805f0fe6bSTejun Heo struct work_struct *work = &rwork->work; 216905f0fe6bSTejun Heo 217005f0fe6bSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 217105f0fe6bSTejun Heo rwork->wq = wq; 2172a7e30c0eSUladzislau Rezki call_rcu_hurry(&rwork->rcu, rcu_work_rcufn); 217305f0fe6bSTejun Heo return true; 217405f0fe6bSTejun Heo } 217505f0fe6bSTejun Heo 217605f0fe6bSTejun Heo return false; 217705f0fe6bSTejun Heo } 217805f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work); 217905f0fe6bSTejun Heo 2180f7537df5SLai Jiangshan static struct worker *alloc_worker(int node) 2181c34056a3STejun Heo { 2182c34056a3STejun Heo struct worker *worker; 2183c34056a3STejun Heo 2184f7537df5SLai Jiangshan worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node); 2185c8e55f36STejun Heo if (worker) { 2186c8e55f36STejun Heo INIT_LIST_HEAD(&worker->entry); 2187affee4b2STejun Heo INIT_LIST_HEAD(&worker->scheduled); 2188da028469SLai Jiangshan INIT_LIST_HEAD(&worker->node); 2189e22bee78STejun Heo /* on creation a worker is in !idle && prep state */ 2190e22bee78STejun Heo worker->flags = WORKER_PREP; 2191c8e55f36STejun Heo } 2192c34056a3STejun Heo return worker; 2193c34056a3STejun Heo } 2194c34056a3STejun Heo 21959546b29eSTejun Heo static cpumask_t *pool_allowed_cpus(struct worker_pool *pool) 21969546b29eSTejun Heo { 21978639ecebSTejun Heo if (pool->cpu < 0 && pool->attrs->affn_strict) 21989546b29eSTejun Heo return pool->attrs->__pod_cpumask; 21998639ecebSTejun Heo else 22008639ecebSTejun Heo return pool->attrs->cpumask; 22019546b29eSTejun Heo } 22029546b29eSTejun Heo 2203c34056a3STejun Heo /** 22044736cbf7SLai Jiangshan * worker_attach_to_pool() - attach a worker to a pool 22054736cbf7SLai Jiangshan * @worker: worker to be attached 22064736cbf7SLai Jiangshan * @pool: the target pool 22074736cbf7SLai Jiangshan * 22084736cbf7SLai Jiangshan * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and 22094736cbf7SLai Jiangshan * cpu-binding of @worker are kept coordinated with the pool across 22104736cbf7SLai Jiangshan * cpu-[un]hotplugs. 22114736cbf7SLai Jiangshan */ 22124736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker, 22134736cbf7SLai Jiangshan struct worker_pool *pool) 22144736cbf7SLai Jiangshan { 22151258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 22164736cbf7SLai Jiangshan 22174736cbf7SLai Jiangshan /* 22181258fae7STejun Heo * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains 22191258fae7STejun Heo * stable across this function. See the comments above the flag 22201258fae7STejun Heo * definition for details. 22214736cbf7SLai Jiangshan */ 22224736cbf7SLai Jiangshan if (pool->flags & POOL_DISASSOCIATED) 22234736cbf7SLai Jiangshan worker->flags |= WORKER_UNBOUND; 22245c25b5ffSPeter Zijlstra else 22255c25b5ffSPeter Zijlstra kthread_set_per_cpu(worker->task, pool->cpu); 22264736cbf7SLai Jiangshan 2227640f17c8SPeter Zijlstra if (worker->rescue_wq) 22289546b29eSTejun Heo set_cpus_allowed_ptr(worker->task, pool_allowed_cpus(pool)); 2229640f17c8SPeter Zijlstra 22304736cbf7SLai Jiangshan list_add_tail(&worker->node, &pool->workers); 2231a2d812a2STejun Heo worker->pool = pool; 22324736cbf7SLai Jiangshan 22331258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 22344736cbf7SLai Jiangshan } 22354736cbf7SLai Jiangshan 22364736cbf7SLai Jiangshan /** 223760f5a4bcSLai Jiangshan * worker_detach_from_pool() - detach a worker from its pool 223860f5a4bcSLai Jiangshan * @worker: worker which is attached to its pool 223960f5a4bcSLai Jiangshan * 22404736cbf7SLai Jiangshan * Undo the attaching which had been done in worker_attach_to_pool(). The 22414736cbf7SLai Jiangshan * caller worker shouldn't access to the pool after detached except it has 22424736cbf7SLai Jiangshan * other reference to the pool. 224360f5a4bcSLai Jiangshan */ 2244a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker) 224560f5a4bcSLai Jiangshan { 2246a2d812a2STejun Heo struct worker_pool *pool = worker->pool; 224760f5a4bcSLai Jiangshan struct completion *detach_completion = NULL; 224860f5a4bcSLai Jiangshan 22491258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 2250a2d812a2STejun Heo 22515c25b5ffSPeter Zijlstra kthread_set_per_cpu(worker->task, -1); 2252da028469SLai Jiangshan list_del(&worker->node); 2253a2d812a2STejun Heo worker->pool = NULL; 2254a2d812a2STejun Heo 2255e02b9312SValentin Schneider if (list_empty(&pool->workers) && list_empty(&pool->dying_workers)) 225660f5a4bcSLai Jiangshan detach_completion = pool->detach_completion; 22571258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 225860f5a4bcSLai Jiangshan 2259b62c0751SLai Jiangshan /* clear leftover flags without pool->lock after it is detached */ 2260b62c0751SLai Jiangshan worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND); 2261b62c0751SLai Jiangshan 226260f5a4bcSLai Jiangshan if (detach_completion) 226360f5a4bcSLai Jiangshan complete(detach_completion); 226460f5a4bcSLai Jiangshan } 226560f5a4bcSLai Jiangshan 226660f5a4bcSLai Jiangshan /** 2267c34056a3STejun Heo * create_worker - create a new workqueue worker 226863d95a91STejun Heo * @pool: pool the new worker will belong to 2269c34056a3STejun Heo * 2270051e1850SLai Jiangshan * Create and start a new worker which is attached to @pool. 2271c34056a3STejun Heo * 2272c34056a3STejun Heo * CONTEXT: 2273c34056a3STejun Heo * Might sleep. Does GFP_KERNEL allocations. 2274c34056a3STejun Heo * 2275d185af30SYacine Belkadi * Return: 2276c34056a3STejun Heo * Pointer to the newly created worker. 2277c34056a3STejun Heo */ 2278bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool) 2279c34056a3STejun Heo { 2280e441b56fSZhen Lei struct worker *worker; 2281e441b56fSZhen Lei int id; 22825d9c7a1eSLucy Mielke char id_buf[23]; 2283c34056a3STejun Heo 22847cda9aaeSLai Jiangshan /* ID is needed to determine kthread name */ 2285e441b56fSZhen Lei id = ida_alloc(&pool->worker_ida, GFP_KERNEL); 22863f0ea0b8SPetr Mladek if (id < 0) { 22873f0ea0b8SPetr Mladek pr_err_once("workqueue: Failed to allocate a worker ID: %pe\n", 22883f0ea0b8SPetr Mladek ERR_PTR(id)); 2289e441b56fSZhen Lei return NULL; 22903f0ea0b8SPetr Mladek } 2291c34056a3STejun Heo 2292f7537df5SLai Jiangshan worker = alloc_worker(pool->node); 22933f0ea0b8SPetr Mladek if (!worker) { 22943f0ea0b8SPetr Mladek pr_err_once("workqueue: Failed to allocate a worker\n"); 2295c34056a3STejun Heo goto fail; 22963f0ea0b8SPetr Mladek } 2297c34056a3STejun Heo 2298c34056a3STejun Heo worker->id = id; 2299c34056a3STejun Heo 230029c91e99STejun Heo if (pool->cpu >= 0) 2301e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id, 2302e3c916a4STejun Heo pool->attrs->nice < 0 ? "H" : ""); 2303f3421797STejun Heo else 2304e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id); 2305e3c916a4STejun Heo 2306f3f90ad4STejun Heo worker->task = kthread_create_on_node(worker_thread, worker, pool->node, 2307e3c916a4STejun Heo "kworker/%s", id_buf); 23083f0ea0b8SPetr Mladek if (IS_ERR(worker->task)) { 230960f54038SPetr Mladek if (PTR_ERR(worker->task) == -EINTR) { 231060f54038SPetr Mladek pr_err("workqueue: Interrupted when creating a worker thread \"kworker/%s\"\n", 231160f54038SPetr Mladek id_buf); 231260f54038SPetr Mladek } else { 23133f0ea0b8SPetr Mladek pr_err_once("workqueue: Failed to create a worker thread: %pe", 23143f0ea0b8SPetr Mladek worker->task); 231560f54038SPetr Mladek } 2316c34056a3STejun Heo goto fail; 23173f0ea0b8SPetr Mladek } 2318c34056a3STejun Heo 231991151228SOleg Nesterov set_user_nice(worker->task, pool->attrs->nice); 23209546b29eSTejun Heo kthread_bind_mask(worker->task, pool_allowed_cpus(pool)); 232191151228SOleg Nesterov 2322da028469SLai Jiangshan /* successful, attach the worker to the pool */ 23234736cbf7SLai Jiangshan worker_attach_to_pool(worker, pool); 2324822d8405STejun Heo 2325051e1850SLai Jiangshan /* start the newly created worker */ 2326a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 23270219a352STejun Heo 2328051e1850SLai Jiangshan worker->pool->nr_workers++; 2329051e1850SLai Jiangshan worker_enter_idle(worker); 23300219a352STejun Heo 23310219a352STejun Heo /* 23320219a352STejun Heo * @worker is waiting on a completion in kthread() and will trigger hung 23336a229b0eSTejun Heo * check if not woken up soon. As kick_pool() is noop if @pool is empty, 23346a229b0eSTejun Heo * wake it up explicitly. 23350219a352STejun Heo */ 2336051e1850SLai Jiangshan wake_up_process(worker->task); 23370219a352STejun Heo 2338a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2339051e1850SLai Jiangshan 2340c34056a3STejun Heo return worker; 2341822d8405STejun Heo 2342c34056a3STejun Heo fail: 2343e441b56fSZhen Lei ida_free(&pool->worker_ida, id); 2344c34056a3STejun Heo kfree(worker); 2345c34056a3STejun Heo return NULL; 2346c34056a3STejun Heo } 2347c34056a3STejun Heo 2348793777bcSValentin Schneider static void unbind_worker(struct worker *worker) 2349793777bcSValentin Schneider { 2350793777bcSValentin Schneider lockdep_assert_held(&wq_pool_attach_mutex); 2351793777bcSValentin Schneider 2352793777bcSValentin Schneider kthread_set_per_cpu(worker->task, -1); 2353793777bcSValentin Schneider if (cpumask_intersects(wq_unbound_cpumask, cpu_active_mask)) 2354793777bcSValentin Schneider WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, wq_unbound_cpumask) < 0); 2355793777bcSValentin Schneider else 2356793777bcSValentin Schneider WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0); 2357793777bcSValentin Schneider } 2358793777bcSValentin Schneider 2359e02b9312SValentin Schneider static void wake_dying_workers(struct list_head *cull_list) 2360e02b9312SValentin Schneider { 2361e02b9312SValentin Schneider struct worker *worker, *tmp; 2362e02b9312SValentin Schneider 2363e02b9312SValentin Schneider list_for_each_entry_safe(worker, tmp, cull_list, entry) { 2364e02b9312SValentin Schneider list_del_init(&worker->entry); 2365e02b9312SValentin Schneider unbind_worker(worker); 2366e02b9312SValentin Schneider /* 2367e02b9312SValentin Schneider * If the worker was somehow already running, then it had to be 2368e02b9312SValentin Schneider * in pool->idle_list when set_worker_dying() happened or we 2369e02b9312SValentin Schneider * wouldn't have gotten here. 2370c34056a3STejun Heo * 2371e02b9312SValentin Schneider * Thus, the worker must either have observed the WORKER_DIE 2372e02b9312SValentin Schneider * flag, or have set its state to TASK_IDLE. Either way, the 2373e02b9312SValentin Schneider * below will be observed by the worker and is safe to do 2374e02b9312SValentin Schneider * outside of pool->lock. 2375e02b9312SValentin Schneider */ 2376e02b9312SValentin Schneider wake_up_process(worker->task); 2377e02b9312SValentin Schneider } 2378e02b9312SValentin Schneider } 2379e02b9312SValentin Schneider 2380e02b9312SValentin Schneider /** 2381e02b9312SValentin Schneider * set_worker_dying - Tag a worker for destruction 2382e02b9312SValentin Schneider * @worker: worker to be destroyed 2383e02b9312SValentin Schneider * @list: transfer worker away from its pool->idle_list and into list 2384e02b9312SValentin Schneider * 2385e02b9312SValentin Schneider * Tag @worker for destruction and adjust @pool stats accordingly. The worker 2386e02b9312SValentin Schneider * should be idle. 2387c8e55f36STejun Heo * 2388c8e55f36STejun Heo * CONTEXT: 2389a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 2390c34056a3STejun Heo */ 2391e02b9312SValentin Schneider static void set_worker_dying(struct worker *worker, struct list_head *list) 2392c34056a3STejun Heo { 2393bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 2394c34056a3STejun Heo 2395cd549687STejun Heo lockdep_assert_held(&pool->lock); 2396e02b9312SValentin Schneider lockdep_assert_held(&wq_pool_attach_mutex); 2397cd549687STejun Heo 2398c34056a3STejun Heo /* sanity check frenzy */ 23996183c009STejun Heo if (WARN_ON(worker->current_work) || 240073eb7fe7SLai Jiangshan WARN_ON(!list_empty(&worker->scheduled)) || 240173eb7fe7SLai Jiangshan WARN_ON(!(worker->flags & WORKER_IDLE))) 24026183c009STejun Heo return; 2403c34056a3STejun Heo 2404bd7bdd43STejun Heo pool->nr_workers--; 2405bd7bdd43STejun Heo pool->nr_idle--; 2406c8e55f36STejun Heo 2407cb444766STejun Heo worker->flags |= WORKER_DIE; 2408e02b9312SValentin Schneider 2409e02b9312SValentin Schneider list_move(&worker->entry, list); 2410e02b9312SValentin Schneider list_move(&worker->node, &pool->dying_workers); 2411c34056a3STejun Heo } 2412c34056a3STejun Heo 24133f959aa3SValentin Schneider /** 24143f959aa3SValentin Schneider * idle_worker_timeout - check if some idle workers can now be deleted. 24153f959aa3SValentin Schneider * @t: The pool's idle_timer that just expired 24163f959aa3SValentin Schneider * 24173f959aa3SValentin Schneider * The timer is armed in worker_enter_idle(). Note that it isn't disarmed in 24183f959aa3SValentin Schneider * worker_leave_idle(), as a worker flicking between idle and active while its 24193f959aa3SValentin Schneider * pool is at the too_many_workers() tipping point would cause too much timer 24203f959aa3SValentin Schneider * housekeeping overhead. Since IDLE_WORKER_TIMEOUT is long enough, we just let 24213f959aa3SValentin Schneider * it expire and re-evaluate things from there. 24223f959aa3SValentin Schneider */ 242332a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t) 2424e22bee78STejun Heo { 242532a6c723SKees Cook struct worker_pool *pool = from_timer(pool, t, idle_timer); 24263f959aa3SValentin Schneider bool do_cull = false; 24273f959aa3SValentin Schneider 24283f959aa3SValentin Schneider if (work_pending(&pool->idle_cull_work)) 24293f959aa3SValentin Schneider return; 24303f959aa3SValentin Schneider 24313f959aa3SValentin Schneider raw_spin_lock_irq(&pool->lock); 24323f959aa3SValentin Schneider 24333f959aa3SValentin Schneider if (too_many_workers(pool)) { 24343f959aa3SValentin Schneider struct worker *worker; 24353f959aa3SValentin Schneider unsigned long expires; 24363f959aa3SValentin Schneider 24373f959aa3SValentin Schneider /* idle_list is kept in LIFO order, check the last one */ 24383f959aa3SValentin Schneider worker = list_entry(pool->idle_list.prev, struct worker, entry); 24393f959aa3SValentin Schneider expires = worker->last_active + IDLE_WORKER_TIMEOUT; 24403f959aa3SValentin Schneider do_cull = !time_before(jiffies, expires); 24413f959aa3SValentin Schneider 24423f959aa3SValentin Schneider if (!do_cull) 24433f959aa3SValentin Schneider mod_timer(&pool->idle_timer, expires); 24443f959aa3SValentin Schneider } 24453f959aa3SValentin Schneider raw_spin_unlock_irq(&pool->lock); 24463f959aa3SValentin Schneider 24473f959aa3SValentin Schneider if (do_cull) 24483f959aa3SValentin Schneider queue_work(system_unbound_wq, &pool->idle_cull_work); 24493f959aa3SValentin Schneider } 24503f959aa3SValentin Schneider 24513f959aa3SValentin Schneider /** 24523f959aa3SValentin Schneider * idle_cull_fn - cull workers that have been idle for too long. 24533f959aa3SValentin Schneider * @work: the pool's work for handling these idle workers 24543f959aa3SValentin Schneider * 24553f959aa3SValentin Schneider * This goes through a pool's idle workers and gets rid of those that have been 24563f959aa3SValentin Schneider * idle for at least IDLE_WORKER_TIMEOUT seconds. 2457e02b9312SValentin Schneider * 2458e02b9312SValentin Schneider * We don't want to disturb isolated CPUs because of a pcpu kworker being 2459e02b9312SValentin Schneider * culled, so this also resets worker affinity. This requires a sleepable 2460e02b9312SValentin Schneider * context, hence the split between timer callback and work item. 24613f959aa3SValentin Schneider */ 24623f959aa3SValentin Schneider static void idle_cull_fn(struct work_struct *work) 24633f959aa3SValentin Schneider { 24643f959aa3SValentin Schneider struct worker_pool *pool = container_of(work, struct worker_pool, idle_cull_work); 24659680540cSYang Yingliang LIST_HEAD(cull_list); 2466e22bee78STejun Heo 2467e02b9312SValentin Schneider /* 2468e02b9312SValentin Schneider * Grabbing wq_pool_attach_mutex here ensures an already-running worker 2469e02b9312SValentin Schneider * cannot proceed beyong worker_detach_from_pool() in its self-destruct 2470e02b9312SValentin Schneider * path. This is required as a previously-preempted worker could run after 2471e02b9312SValentin Schneider * set_worker_dying() has happened but before wake_dying_workers() did. 2472e02b9312SValentin Schneider */ 2473e02b9312SValentin Schneider mutex_lock(&wq_pool_attach_mutex); 2474a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2475e22bee78STejun Heo 24763347fc9fSLai Jiangshan while (too_many_workers(pool)) { 2477e22bee78STejun Heo struct worker *worker; 2478e22bee78STejun Heo unsigned long expires; 2479e22bee78STejun Heo 248063d95a91STejun Heo worker = list_entry(pool->idle_list.prev, struct worker, entry); 2481e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 2482e22bee78STejun Heo 24833347fc9fSLai Jiangshan if (time_before(jiffies, expires)) { 248463d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 24853347fc9fSLai Jiangshan break; 2486e22bee78STejun Heo } 24873347fc9fSLai Jiangshan 2488e02b9312SValentin Schneider set_worker_dying(worker, &cull_list); 2489e22bee78STejun Heo } 2490e22bee78STejun Heo 2491a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2492e02b9312SValentin Schneider wake_dying_workers(&cull_list); 2493e02b9312SValentin Schneider mutex_unlock(&wq_pool_attach_mutex); 2494e22bee78STejun Heo } 2495e22bee78STejun Heo 2496493a1724STejun Heo static void send_mayday(struct work_struct *work) 2497e22bee78STejun Heo { 2498112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 2499112202d9STejun Heo struct workqueue_struct *wq = pwq->wq; 2500493a1724STejun Heo 25012e109a28STejun Heo lockdep_assert_held(&wq_mayday_lock); 2502e22bee78STejun Heo 2503493008a8STejun Heo if (!wq->rescuer) 2504493a1724STejun Heo return; 2505e22bee78STejun Heo 2506e22bee78STejun Heo /* mayday mayday mayday */ 2507493a1724STejun Heo if (list_empty(&pwq->mayday_node)) { 250877668c8bSLai Jiangshan /* 250977668c8bSLai Jiangshan * If @pwq is for an unbound wq, its base ref may be put at 251077668c8bSLai Jiangshan * any time due to an attribute change. Pin @pwq until the 251177668c8bSLai Jiangshan * rescuer is done with it. 251277668c8bSLai Jiangshan */ 251377668c8bSLai Jiangshan get_pwq(pwq); 2514493a1724STejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 2515e22bee78STejun Heo wake_up_process(wq->rescuer->task); 2516725e8ec5STejun Heo pwq->stats[PWQ_STAT_MAYDAY]++; 2517493a1724STejun Heo } 2518e22bee78STejun Heo } 2519e22bee78STejun Heo 252032a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t) 2521e22bee78STejun Heo { 252232a6c723SKees Cook struct worker_pool *pool = from_timer(pool, t, mayday_timer); 2523e22bee78STejun Heo struct work_struct *work; 2524e22bee78STejun Heo 2525a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2526a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&wq_mayday_lock); /* for wq->maydays */ 2527e22bee78STejun Heo 252863d95a91STejun Heo if (need_to_create_worker(pool)) { 2529e22bee78STejun Heo /* 2530e22bee78STejun Heo * We've been trying to create a new worker but 2531e22bee78STejun Heo * haven't been successful. We might be hitting an 2532e22bee78STejun Heo * allocation deadlock. Send distress signals to 2533e22bee78STejun Heo * rescuers. 2534e22bee78STejun Heo */ 253563d95a91STejun Heo list_for_each_entry(work, &pool->worklist, entry) 2536e22bee78STejun Heo send_mayday(work); 2537e22bee78STejun Heo } 2538e22bee78STejun Heo 2539a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&wq_mayday_lock); 2540a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2541e22bee78STejun Heo 254263d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL); 2543e22bee78STejun Heo } 2544e22bee78STejun Heo 2545e22bee78STejun Heo /** 2546e22bee78STejun Heo * maybe_create_worker - create a new worker if necessary 254763d95a91STejun Heo * @pool: pool to create a new worker for 2548e22bee78STejun Heo * 254963d95a91STejun Heo * Create a new worker for @pool if necessary. @pool is guaranteed to 2550e22bee78STejun Heo * have at least one idle worker on return from this function. If 2551e22bee78STejun Heo * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is 255263d95a91STejun Heo * sent to all rescuers with works scheduled on @pool to resolve 2553e22bee78STejun Heo * possible allocation deadlock. 2554e22bee78STejun Heo * 2555c5aa87bbSTejun Heo * On return, need_to_create_worker() is guaranteed to be %false and 2556c5aa87bbSTejun Heo * may_start_working() %true. 2557e22bee78STejun Heo * 2558e22bee78STejun Heo * LOCKING: 2559a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 2560e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. Called only from 2561e22bee78STejun Heo * manager. 2562e22bee78STejun Heo */ 256329187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool) 2564d565ed63STejun Heo __releases(&pool->lock) 2565d565ed63STejun Heo __acquires(&pool->lock) 2566e22bee78STejun Heo { 2567e22bee78STejun Heo restart: 2568a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 25699f9c2364STejun Heo 2570e22bee78STejun Heo /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ 257163d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); 2572e22bee78STejun Heo 2573e22bee78STejun Heo while (true) { 2574051e1850SLai Jiangshan if (create_worker(pool) || !need_to_create_worker(pool)) 2575e22bee78STejun Heo break; 2576e22bee78STejun Heo 2577e212f361SLai Jiangshan schedule_timeout_interruptible(CREATE_COOLDOWN); 25789f9c2364STejun Heo 257963d95a91STejun Heo if (!need_to_create_worker(pool)) 2580e22bee78STejun Heo break; 2581e22bee78STejun Heo } 2582e22bee78STejun Heo 258363d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 2584a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2585051e1850SLai Jiangshan /* 2586051e1850SLai Jiangshan * This is necessary even after a new worker was just successfully 2587051e1850SLai Jiangshan * created as @pool->lock was dropped and the new worker might have 2588051e1850SLai Jiangshan * already become busy. 2589051e1850SLai Jiangshan */ 259063d95a91STejun Heo if (need_to_create_worker(pool)) 2591e22bee78STejun Heo goto restart; 2592e22bee78STejun Heo } 2593e22bee78STejun Heo 2594e22bee78STejun Heo /** 2595e22bee78STejun Heo * manage_workers - manage worker pool 2596e22bee78STejun Heo * @worker: self 2597e22bee78STejun Heo * 2598706026c2STejun Heo * Assume the manager role and manage the worker pool @worker belongs 2599e22bee78STejun Heo * to. At any given time, there can be only zero or one manager per 2600706026c2STejun Heo * pool. The exclusion is handled automatically by this function. 2601e22bee78STejun Heo * 2602e22bee78STejun Heo * The caller can safely start processing works on false return. On 2603e22bee78STejun Heo * true return, it's guaranteed that need_to_create_worker() is false 2604e22bee78STejun Heo * and may_start_working() is true. 2605e22bee78STejun Heo * 2606e22bee78STejun Heo * CONTEXT: 2607a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 2608e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. 2609e22bee78STejun Heo * 2610d185af30SYacine Belkadi * Return: 261129187a9eSTejun Heo * %false if the pool doesn't need management and the caller can safely 261229187a9eSTejun Heo * start processing works, %true if management function was performed and 261329187a9eSTejun Heo * the conditions that the caller verified before calling the function may 261429187a9eSTejun Heo * no longer be true. 2615e22bee78STejun Heo */ 2616e22bee78STejun Heo static bool manage_workers(struct worker *worker) 2617e22bee78STejun Heo { 261863d95a91STejun Heo struct worker_pool *pool = worker->pool; 2619e22bee78STejun Heo 2620692b4825STejun Heo if (pool->flags & POOL_MANAGER_ACTIVE) 262129187a9eSTejun Heo return false; 2622692b4825STejun Heo 2623692b4825STejun Heo pool->flags |= POOL_MANAGER_ACTIVE; 26242607d7a6STejun Heo pool->manager = worker; 2625e22bee78STejun Heo 262629187a9eSTejun Heo maybe_create_worker(pool); 2627e22bee78STejun Heo 26282607d7a6STejun Heo pool->manager = NULL; 2629692b4825STejun Heo pool->flags &= ~POOL_MANAGER_ACTIVE; 2630d8bb65abSSebastian Andrzej Siewior rcuwait_wake_up(&manager_wait); 263129187a9eSTejun Heo return true; 2632e22bee78STejun Heo } 2633e22bee78STejun Heo 2634a62428c0STejun Heo /** 2635a62428c0STejun Heo * process_one_work - process single work 2636c34056a3STejun Heo * @worker: self 2637a62428c0STejun Heo * @work: work to process 2638a62428c0STejun Heo * 2639a62428c0STejun Heo * Process @work. This function contains all the logics necessary to 2640a62428c0STejun Heo * process a single work including synchronization against and 2641a62428c0STejun Heo * interaction with other workers on the same cpu, queueing and 2642a62428c0STejun Heo * flushing. As long as context requirement is met, any worker can 2643a62428c0STejun Heo * call this function to process a work. 2644a62428c0STejun Heo * 2645a62428c0STejun Heo * CONTEXT: 2646a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which is released and regrabbed. 2647a62428c0STejun Heo */ 2648c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work) 2649d565ed63STejun Heo __releases(&pool->lock) 2650d565ed63STejun Heo __acquires(&pool->lock) 26511da177e4SLinus Torvalds { 2652112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 2653bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 2654c4560c2cSLai Jiangshan unsigned long work_data; 26554e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 26564e6045f1SJohannes Berg /* 2657a62428c0STejun Heo * It is permissible to free the struct work_struct from 2658a62428c0STejun Heo * inside the function that is called from it, this we need to 2659a62428c0STejun Heo * take into account for lockdep too. To avoid bogus "held 2660a62428c0STejun Heo * lock freed" warnings as well as problems when looking into 2661a62428c0STejun Heo * work->lockdep_map, make a copy and use that here. 26624e6045f1SJohannes Berg */ 26634d82a1deSPeter Zijlstra struct lockdep_map lockdep_map; 26644d82a1deSPeter Zijlstra 26654d82a1deSPeter Zijlstra lockdep_copy_map(&lockdep_map, &work->lockdep_map); 26664e6045f1SJohannes Berg #endif 2667807407c0SLai Jiangshan /* ensure we're on the correct CPU */ 266885327af6SLai Jiangshan WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 2669ec22ca5eSTejun Heo raw_smp_processor_id() != pool->cpu); 267025511a47STejun Heo 26718930cabaSTejun Heo /* claim and dequeue */ 2672dc186ad7SThomas Gleixner debug_work_deactivate(work); 2673c9e7cf27STejun Heo hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work); 2674c34056a3STejun Heo worker->current_work = work; 2675a2c1c57bSTejun Heo worker->current_func = work->func; 2676112202d9STejun Heo worker->current_pwq = pwq; 2677616db877STejun Heo worker->current_at = worker->task->se.sum_exec_runtime; 2678c4560c2cSLai Jiangshan work_data = *work_data_bits(work); 2679d812796eSLai Jiangshan worker->current_color = get_work_color(work_data); 26807a22ad75STejun Heo 26818bf89593STejun Heo /* 26828bf89593STejun Heo * Record wq name for cmdline and debug reporting, may get 26838bf89593STejun Heo * overridden through set_worker_desc(). 26848bf89593STejun Heo */ 26858bf89593STejun Heo strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN); 26868bf89593STejun Heo 2687a62428c0STejun Heo list_del_init(&work->entry); 2688a62428c0STejun Heo 2689649027d7STejun Heo /* 2690228f1d00SLai Jiangshan * CPU intensive works don't participate in concurrency management. 2691228f1d00SLai Jiangshan * They're the scheduler's responsibility. This takes @worker out 2692228f1d00SLai Jiangshan * of concurrency management and the next code block will chain 2693228f1d00SLai Jiangshan * execution of the pending work items. 2694fb0e7bebSTejun Heo */ 2695616db877STejun Heo if (unlikely(pwq->wq->flags & WQ_CPU_INTENSIVE)) 2696228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_CPU_INTENSIVE); 2697fb0e7bebSTejun Heo 2698974271c4STejun Heo /* 26990219a352STejun Heo * Kick @pool if necessary. It's always noop for per-cpu worker pools 27000219a352STejun Heo * since nr_running would always be >= 1 at this point. This is used to 27010219a352STejun Heo * chain execution of the pending work items for WORKER_NOT_RUNNING 27020219a352STejun Heo * workers such as the UNBOUND and CPU_INTENSIVE ones. 2703974271c4STejun Heo */ 27040219a352STejun Heo kick_pool(pool); 2705974271c4STejun Heo 27068930cabaSTejun Heo /* 27077c3eed5cSTejun Heo * Record the last pool and clear PENDING which should be the last 2708d565ed63STejun Heo * update to @work. Also, do this inside @pool->lock so that 270923657bb1STejun Heo * PENDING and queued state changes happen together while IRQ is 271023657bb1STejun Heo * disabled. 27118930cabaSTejun Heo */ 27127c3eed5cSTejun Heo set_work_pool_and_clear_pending(work, pool->id); 27131da177e4SLinus Torvalds 2714fe48ba7dSMirsad Goran Todorovac pwq->stats[PWQ_STAT_STARTED]++; 2715a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2716365970a1SDavid Howells 2717a1d14934SPeter Zijlstra lock_map_acquire(&pwq->wq->lockdep_map); 27183295f0efSIngo Molnar lock_map_acquire(&lockdep_map); 2719e6f3faa7SPeter Zijlstra /* 2720f52be570SPeter Zijlstra * Strictly speaking we should mark the invariant state without holding 2721f52be570SPeter Zijlstra * any locks, that is, before these two lock_map_acquire()'s. 2722e6f3faa7SPeter Zijlstra * 2723e6f3faa7SPeter Zijlstra * However, that would result in: 2724e6f3faa7SPeter Zijlstra * 2725e6f3faa7SPeter Zijlstra * A(W1) 2726e6f3faa7SPeter Zijlstra * WFC(C) 2727e6f3faa7SPeter Zijlstra * A(W1) 2728e6f3faa7SPeter Zijlstra * C(C) 2729e6f3faa7SPeter Zijlstra * 2730e6f3faa7SPeter Zijlstra * Which would create W1->C->W1 dependencies, even though there is no 2731e6f3faa7SPeter Zijlstra * actual deadlock possible. There are two solutions, using a 2732e6f3faa7SPeter Zijlstra * read-recursive acquire on the work(queue) 'locks', but this will then 2733f52be570SPeter Zijlstra * hit the lockdep limitation on recursive locks, or simply discard 2734e6f3faa7SPeter Zijlstra * these locks. 2735e6f3faa7SPeter Zijlstra * 2736e6f3faa7SPeter Zijlstra * AFAICT there is no possible deadlock scenario between the 2737e6f3faa7SPeter Zijlstra * flush_work() and complete() primitives (except for single-threaded 2738e6f3faa7SPeter Zijlstra * workqueues), so hiding them isn't a problem. 2739e6f3faa7SPeter Zijlstra */ 2740f52be570SPeter Zijlstra lockdep_invariant_state(true); 2741e36c886aSArjan van de Ven trace_workqueue_execute_start(work); 2742a2c1c57bSTejun Heo worker->current_func(work); 2743e36c886aSArjan van de Ven /* 2744e36c886aSArjan van de Ven * While we must be careful to not use "work" after this, the trace 2745e36c886aSArjan van de Ven * point will only record its address. 2746e36c886aSArjan van de Ven */ 27471c5da0ecSDaniel Jordan trace_workqueue_execute_end(work, worker->current_func); 2748725e8ec5STejun Heo pwq->stats[PWQ_STAT_COMPLETED]++; 27493295f0efSIngo Molnar lock_map_release(&lockdep_map); 2750112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 27511da177e4SLinus Torvalds 27521a65a6d1SXuewen Yan if (unlikely(in_atomic() || lockdep_depth(current) > 0 || 27531a65a6d1SXuewen Yan rcu_preempt_depth() > 0)) { 27541a65a6d1SXuewen Yan pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d/%d\n" 2755d75f773cSSakari Ailus " last function: %ps\n", 27561a65a6d1SXuewen Yan current->comm, preempt_count(), rcu_preempt_depth(), 27571a65a6d1SXuewen Yan task_pid_nr(current), worker->current_func); 2758d5abe669SPeter Zijlstra debug_show_held_locks(current); 2759d5abe669SPeter Zijlstra dump_stack(); 2760d5abe669SPeter Zijlstra } 2761d5abe669SPeter Zijlstra 2762b22ce278STejun Heo /* 2763025f50f3SSebastian Andrzej Siewior * The following prevents a kworker from hogging CPU on !PREEMPTION 2764b22ce278STejun Heo * kernels, where a requeueing work item waiting for something to 2765b22ce278STejun Heo * happen could deadlock with stop_machine as such work item could 2766b22ce278STejun Heo * indefinitely requeue itself while all other CPUs are trapped in 2767789cbbecSJoe Lawrence * stop_machine. At the same time, report a quiescent RCU state so 2768789cbbecSJoe Lawrence * the same condition doesn't freeze RCU. 2769b22ce278STejun Heo */ 2770a7e6425eSPaul E. McKenney cond_resched(); 2771b22ce278STejun Heo 2772a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2773a62428c0STejun Heo 2774616db877STejun Heo /* 2775616db877STejun Heo * In addition to %WQ_CPU_INTENSIVE, @worker may also have been marked 2776616db877STejun Heo * CPU intensive by wq_worker_tick() if @work hogged CPU longer than 2777616db877STejun Heo * wq_cpu_intensive_thresh_us. Clear it. 2778616db877STejun Heo */ 2779fb0e7bebSTejun Heo worker_clr_flags(worker, WORKER_CPU_INTENSIVE); 2780fb0e7bebSTejun Heo 27811b69ac6bSJohannes Weiner /* tag the worker for identification in schedule() */ 27821b69ac6bSJohannes Weiner worker->last_func = worker->current_func; 27831b69ac6bSJohannes Weiner 2784a62428c0STejun Heo /* we're done with it, release */ 278542f8570fSSasha Levin hash_del(&worker->hentry); 2786c34056a3STejun Heo worker->current_work = NULL; 2787a2c1c57bSTejun Heo worker->current_func = NULL; 2788112202d9STejun Heo worker->current_pwq = NULL; 2789d812796eSLai Jiangshan worker->current_color = INT_MAX; 2790*dd6c3c54STejun Heo 2791*dd6c3c54STejun Heo /* must be the last step, see the function comment */ 2792c4560c2cSLai Jiangshan pwq_dec_nr_in_flight(pwq, work_data); 27931da177e4SLinus Torvalds } 27941da177e4SLinus Torvalds 2795affee4b2STejun Heo /** 2796affee4b2STejun Heo * process_scheduled_works - process scheduled works 2797affee4b2STejun Heo * @worker: self 2798affee4b2STejun Heo * 2799affee4b2STejun Heo * Process all scheduled works. Please note that the scheduled list 2800affee4b2STejun Heo * may change while processing a work, so this function repeatedly 2801affee4b2STejun Heo * fetches a work from the top and executes it. 2802affee4b2STejun Heo * 2803affee4b2STejun Heo * CONTEXT: 2804a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 2805affee4b2STejun Heo * multiple times. 2806affee4b2STejun Heo */ 2807affee4b2STejun Heo static void process_scheduled_works(struct worker *worker) 28081da177e4SLinus Torvalds { 2809c0ab017dSTejun Heo struct work_struct *work; 2810c0ab017dSTejun Heo bool first = true; 2811c0ab017dSTejun Heo 2812c0ab017dSTejun Heo while ((work = list_first_entry_or_null(&worker->scheduled, 2813c0ab017dSTejun Heo struct work_struct, entry))) { 2814c0ab017dSTejun Heo if (first) { 2815c0ab017dSTejun Heo worker->pool->watchdog_ts = jiffies; 2816c0ab017dSTejun Heo first = false; 2817c0ab017dSTejun Heo } 2818c34056a3STejun Heo process_one_work(worker, work); 2819a62428c0STejun Heo } 28201da177e4SLinus Torvalds } 28211da177e4SLinus Torvalds 2822197f6accSTejun Heo static void set_pf_worker(bool val) 2823197f6accSTejun Heo { 2824197f6accSTejun Heo mutex_lock(&wq_pool_attach_mutex); 2825197f6accSTejun Heo if (val) 2826197f6accSTejun Heo current->flags |= PF_WQ_WORKER; 2827197f6accSTejun Heo else 2828197f6accSTejun Heo current->flags &= ~PF_WQ_WORKER; 2829197f6accSTejun Heo mutex_unlock(&wq_pool_attach_mutex); 2830197f6accSTejun Heo } 2831197f6accSTejun Heo 28324690c4abSTejun Heo /** 28334690c4abSTejun Heo * worker_thread - the worker thread function 2834c34056a3STejun Heo * @__worker: self 28354690c4abSTejun Heo * 2836c5aa87bbSTejun Heo * The worker thread function. All workers belong to a worker_pool - 2837c5aa87bbSTejun Heo * either a per-cpu one or dynamic unbound one. These workers process all 2838c5aa87bbSTejun Heo * work items regardless of their specific target workqueue. The only 2839c5aa87bbSTejun Heo * exception is work items which belong to workqueues with a rescuer which 2840c5aa87bbSTejun Heo * will be explained in rescuer_thread(). 2841d185af30SYacine Belkadi * 2842d185af30SYacine Belkadi * Return: 0 28434690c4abSTejun Heo */ 2844c34056a3STejun Heo static int worker_thread(void *__worker) 28451da177e4SLinus Torvalds { 2846c34056a3STejun Heo struct worker *worker = __worker; 2847bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 28481da177e4SLinus Torvalds 2849e22bee78STejun Heo /* tell the scheduler that this is a workqueue worker */ 2850197f6accSTejun Heo set_pf_worker(true); 2851c8e55f36STejun Heo woke_up: 2852a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2853affee4b2STejun Heo 2854a9ab775bSTejun Heo /* am I supposed to die? */ 2855a9ab775bSTejun Heo if (unlikely(worker->flags & WORKER_DIE)) { 2856a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2857197f6accSTejun Heo set_pf_worker(false); 285860f5a4bcSLai Jiangshan 285960f5a4bcSLai Jiangshan set_task_comm(worker->task, "kworker/dying"); 2860e441b56fSZhen Lei ida_free(&pool->worker_ida, worker->id); 2861a2d812a2STejun Heo worker_detach_from_pool(worker); 2862e02b9312SValentin Schneider WARN_ON_ONCE(!list_empty(&worker->entry)); 286360f5a4bcSLai Jiangshan kfree(worker); 2864c8e55f36STejun Heo return 0; 2865c8e55f36STejun Heo } 2866c8e55f36STejun Heo 2867c8e55f36STejun Heo worker_leave_idle(worker); 2868db7bccf4STejun Heo recheck: 2869e22bee78STejun Heo /* no more worker necessary? */ 287063d95a91STejun Heo if (!need_more_worker(pool)) 2871e22bee78STejun Heo goto sleep; 2872e22bee78STejun Heo 2873e22bee78STejun Heo /* do we need to manage? */ 287463d95a91STejun Heo if (unlikely(!may_start_working(pool)) && manage_workers(worker)) 2875e22bee78STejun Heo goto recheck; 2876e22bee78STejun Heo 2877c8e55f36STejun Heo /* 2878c8e55f36STejun Heo * ->scheduled list can only be filled while a worker is 2879c8e55f36STejun Heo * preparing to process a work or actually processing it. 2880c8e55f36STejun Heo * Make sure nobody diddled with it while I was sleeping. 2881c8e55f36STejun Heo */ 28826183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->scheduled)); 2883c8e55f36STejun Heo 2884e22bee78STejun Heo /* 2885a9ab775bSTejun Heo * Finish PREP stage. We're guaranteed to have at least one idle 2886a9ab775bSTejun Heo * worker or that someone else has already assumed the manager 2887a9ab775bSTejun Heo * role. This is where @worker starts participating in concurrency 2888a9ab775bSTejun Heo * management if applicable and concurrency management is restored 2889a9ab775bSTejun Heo * after being rebound. See rebind_workers() for details. 2890e22bee78STejun Heo */ 2891a9ab775bSTejun Heo worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND); 2892e22bee78STejun Heo 2893e22bee78STejun Heo do { 2894affee4b2STejun Heo struct work_struct *work = 2895bd7bdd43STejun Heo list_first_entry(&pool->worklist, 2896affee4b2STejun Heo struct work_struct, entry); 2897affee4b2STejun Heo 2898873eaca6STejun Heo if (assign_work(work, worker, NULL)) 2899affee4b2STejun Heo process_scheduled_works(worker); 290063d95a91STejun Heo } while (keep_working(pool)); 2901affee4b2STejun Heo 2902228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_PREP); 2903d313dd85STejun Heo sleep: 2904c8e55f36STejun Heo /* 2905d565ed63STejun Heo * pool->lock is held and there's no work to process and no need to 2906d565ed63STejun Heo * manage, sleep. Workers are woken up only while holding 2907d565ed63STejun Heo * pool->lock or from local cpu, so setting the current state 2908d565ed63STejun Heo * before releasing pool->lock is enough to prevent losing any 2909d565ed63STejun Heo * event. 2910c8e55f36STejun Heo */ 2911c8e55f36STejun Heo worker_enter_idle(worker); 2912c5a94a61SPeter Zijlstra __set_current_state(TASK_IDLE); 2913a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 29141da177e4SLinus Torvalds schedule(); 2915c8e55f36STejun Heo goto woke_up; 29161da177e4SLinus Torvalds } 29171da177e4SLinus Torvalds 2918e22bee78STejun Heo /** 2919e22bee78STejun Heo * rescuer_thread - the rescuer thread function 2920111c225aSTejun Heo * @__rescuer: self 2921e22bee78STejun Heo * 2922e22bee78STejun Heo * Workqueue rescuer thread function. There's one rescuer for each 2923493008a8STejun Heo * workqueue which has WQ_MEM_RECLAIM set. 2924e22bee78STejun Heo * 2925706026c2STejun Heo * Regular work processing on a pool may block trying to create a new 2926e22bee78STejun Heo * worker which uses GFP_KERNEL allocation which has slight chance of 2927e22bee78STejun Heo * developing into deadlock if some works currently on the same queue 2928e22bee78STejun Heo * need to be processed to satisfy the GFP_KERNEL allocation. This is 2929e22bee78STejun Heo * the problem rescuer solves. 2930e22bee78STejun Heo * 2931706026c2STejun Heo * When such condition is possible, the pool summons rescuers of all 2932706026c2STejun Heo * workqueues which have works queued on the pool and let them process 2933e22bee78STejun Heo * those works so that forward progress can be guaranteed. 2934e22bee78STejun Heo * 2935e22bee78STejun Heo * This should happen rarely. 2936d185af30SYacine Belkadi * 2937d185af30SYacine Belkadi * Return: 0 2938e22bee78STejun Heo */ 2939111c225aSTejun Heo static int rescuer_thread(void *__rescuer) 2940e22bee78STejun Heo { 2941111c225aSTejun Heo struct worker *rescuer = __rescuer; 2942111c225aSTejun Heo struct workqueue_struct *wq = rescuer->rescue_wq; 29434d595b86SLai Jiangshan bool should_stop; 2944e22bee78STejun Heo 2945e22bee78STejun Heo set_user_nice(current, RESCUER_NICE_LEVEL); 2946111c225aSTejun Heo 2947111c225aSTejun Heo /* 2948111c225aSTejun Heo * Mark rescuer as worker too. As WORKER_PREP is never cleared, it 2949111c225aSTejun Heo * doesn't participate in concurrency management. 2950111c225aSTejun Heo */ 2951197f6accSTejun Heo set_pf_worker(true); 2952e22bee78STejun Heo repeat: 2953c5a94a61SPeter Zijlstra set_current_state(TASK_IDLE); 29541da177e4SLinus Torvalds 29554d595b86SLai Jiangshan /* 29564d595b86SLai Jiangshan * By the time the rescuer is requested to stop, the workqueue 29574d595b86SLai Jiangshan * shouldn't have any work pending, but @wq->maydays may still have 29584d595b86SLai Jiangshan * pwq(s) queued. This can happen by non-rescuer workers consuming 29594d595b86SLai Jiangshan * all the work items before the rescuer got to them. Go through 29604d595b86SLai Jiangshan * @wq->maydays processing before acting on should_stop so that the 29614d595b86SLai Jiangshan * list is always empty on exit. 29624d595b86SLai Jiangshan */ 29634d595b86SLai Jiangshan should_stop = kthread_should_stop(); 29641da177e4SLinus Torvalds 2965493a1724STejun Heo /* see whether any pwq is asking for help */ 2966a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 2967493a1724STejun Heo 2968493a1724STejun Heo while (!list_empty(&wq->maydays)) { 2969493a1724STejun Heo struct pool_workqueue *pwq = list_first_entry(&wq->maydays, 2970493a1724STejun Heo struct pool_workqueue, mayday_node); 2971112202d9STejun Heo struct worker_pool *pool = pwq->pool; 2972e22bee78STejun Heo struct work_struct *work, *n; 2973e22bee78STejun Heo 2974e22bee78STejun Heo __set_current_state(TASK_RUNNING); 2975493a1724STejun Heo list_del_init(&pwq->mayday_node); 2976493a1724STejun Heo 2977a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 2978e22bee78STejun Heo 297951697d39SLai Jiangshan worker_attach_to_pool(rescuer, pool); 298051697d39SLai Jiangshan 2981a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2982e22bee78STejun Heo 2983e22bee78STejun Heo /* 2984e22bee78STejun Heo * Slurp in all works issued via this workqueue and 2985e22bee78STejun Heo * process'em. 2986e22bee78STejun Heo */ 2987873eaca6STejun Heo WARN_ON_ONCE(!list_empty(&rescuer->scheduled)); 298882607adcSTejun Heo list_for_each_entry_safe(work, n, &pool->worklist, entry) { 2989873eaca6STejun Heo if (get_work_pwq(work) == pwq && 2990873eaca6STejun Heo assign_work(work, rescuer, &n)) 2991725e8ec5STejun Heo pwq->stats[PWQ_STAT_RESCUED]++; 299282607adcSTejun Heo } 2993e22bee78STejun Heo 2994873eaca6STejun Heo if (!list_empty(&rescuer->scheduled)) { 2995e22bee78STejun Heo process_scheduled_works(rescuer); 29967576958aSTejun Heo 29977576958aSTejun Heo /* 2998008847f6SNeilBrown * The above execution of rescued work items could 2999008847f6SNeilBrown * have created more to rescue through 3000f97a4a1aSLai Jiangshan * pwq_activate_first_inactive() or chained 3001008847f6SNeilBrown * queueing. Let's put @pwq back on mayday list so 3002008847f6SNeilBrown * that such back-to-back work items, which may be 3003008847f6SNeilBrown * being used to relieve memory pressure, don't 3004008847f6SNeilBrown * incur MAYDAY_INTERVAL delay inbetween. 3005008847f6SNeilBrown */ 30064f3f4cf3SLai Jiangshan if (pwq->nr_active && need_to_create_worker(pool)) { 3007a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&wq_mayday_lock); 3008e66b39afSTejun Heo /* 3009e66b39afSTejun Heo * Queue iff we aren't racing destruction 3010e66b39afSTejun Heo * and somebody else hasn't queued it already. 3011e66b39afSTejun Heo */ 3012e66b39afSTejun Heo if (wq->rescuer && list_empty(&pwq->mayday_node)) { 3013008847f6SNeilBrown get_pwq(pwq); 3014e66b39afSTejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 3015e66b39afSTejun Heo } 3016a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&wq_mayday_lock); 3017008847f6SNeilBrown } 3018008847f6SNeilBrown } 3019008847f6SNeilBrown 3020008847f6SNeilBrown /* 302177668c8bSLai Jiangshan * Put the reference grabbed by send_mayday(). @pool won't 302213b1d625SLai Jiangshan * go away while we're still attached to it. 302377668c8bSLai Jiangshan */ 302477668c8bSLai Jiangshan put_pwq(pwq); 302577668c8bSLai Jiangshan 302677668c8bSLai Jiangshan /* 30270219a352STejun Heo * Leave this pool. Notify regular workers; otherwise, we end up 30280219a352STejun Heo * with 0 concurrency and stalling the execution. 30297576958aSTejun Heo */ 30300219a352STejun Heo kick_pool(pool); 30317576958aSTejun Heo 3032a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 303313b1d625SLai Jiangshan 3034a2d812a2STejun Heo worker_detach_from_pool(rescuer); 303513b1d625SLai Jiangshan 3036a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 30371da177e4SLinus Torvalds } 30381da177e4SLinus Torvalds 3039a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 3040493a1724STejun Heo 30414d595b86SLai Jiangshan if (should_stop) { 30424d595b86SLai Jiangshan __set_current_state(TASK_RUNNING); 3043197f6accSTejun Heo set_pf_worker(false); 30444d595b86SLai Jiangshan return 0; 30454d595b86SLai Jiangshan } 30464d595b86SLai Jiangshan 3047111c225aSTejun Heo /* rescuers should never participate in concurrency management */ 3048111c225aSTejun Heo WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING)); 3049e22bee78STejun Heo schedule(); 3050e22bee78STejun Heo goto repeat; 30511da177e4SLinus Torvalds } 30521da177e4SLinus Torvalds 3053fca839c0STejun Heo /** 3054fca839c0STejun Heo * check_flush_dependency - check for flush dependency sanity 3055fca839c0STejun Heo * @target_wq: workqueue being flushed 3056fca839c0STejun Heo * @target_work: work item being flushed (NULL for workqueue flushes) 3057fca839c0STejun Heo * 3058fca839c0STejun Heo * %current is trying to flush the whole @target_wq or @target_work on it. 3059fca839c0STejun Heo * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not 3060fca839c0STejun Heo * reclaiming memory or running on a workqueue which doesn't have 3061fca839c0STejun Heo * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to 3062fca839c0STejun Heo * a deadlock. 3063fca839c0STejun Heo */ 3064fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq, 3065fca839c0STejun Heo struct work_struct *target_work) 3066fca839c0STejun Heo { 3067fca839c0STejun Heo work_func_t target_func = target_work ? target_work->func : NULL; 3068fca839c0STejun Heo struct worker *worker; 3069fca839c0STejun Heo 3070fca839c0STejun Heo if (target_wq->flags & WQ_MEM_RECLAIM) 3071fca839c0STejun Heo return; 3072fca839c0STejun Heo 3073fca839c0STejun Heo worker = current_wq_worker(); 3074fca839c0STejun Heo 3075fca839c0STejun Heo WARN_ONCE(current->flags & PF_MEMALLOC, 3076d75f773cSSakari Ailus "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps", 3077fca839c0STejun Heo current->pid, current->comm, target_wq->name, target_func); 307823d11a58STejun Heo WARN_ONCE(worker && ((worker->current_pwq->wq->flags & 307923d11a58STejun Heo (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM), 3080d75f773cSSakari Ailus "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps", 3081fca839c0STejun Heo worker->current_pwq->wq->name, worker->current_func, 3082fca839c0STejun Heo target_wq->name, target_func); 3083fca839c0STejun Heo } 3084fca839c0STejun Heo 3085fc2e4d70SOleg Nesterov struct wq_barrier { 3086fc2e4d70SOleg Nesterov struct work_struct work; 3087fc2e4d70SOleg Nesterov struct completion done; 30882607d7a6STejun Heo struct task_struct *task; /* purely informational */ 3089fc2e4d70SOleg Nesterov }; 3090fc2e4d70SOleg Nesterov 3091fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work) 3092fc2e4d70SOleg Nesterov { 3093fc2e4d70SOleg Nesterov struct wq_barrier *barr = container_of(work, struct wq_barrier, work); 3094fc2e4d70SOleg Nesterov complete(&barr->done); 3095fc2e4d70SOleg Nesterov } 3096fc2e4d70SOleg Nesterov 30974690c4abSTejun Heo /** 30984690c4abSTejun Heo * insert_wq_barrier - insert a barrier work 3099112202d9STejun Heo * @pwq: pwq to insert barrier into 31004690c4abSTejun Heo * @barr: wq_barrier to insert 3101affee4b2STejun Heo * @target: target work to attach @barr to 3102affee4b2STejun Heo * @worker: worker currently executing @target, NULL if @target is not executing 31034690c4abSTejun Heo * 3104affee4b2STejun Heo * @barr is linked to @target such that @barr is completed only after 3105affee4b2STejun Heo * @target finishes execution. Please note that the ordering 3106affee4b2STejun Heo * guarantee is observed only with respect to @target and on the local 3107affee4b2STejun Heo * cpu. 3108affee4b2STejun Heo * 3109affee4b2STejun Heo * Currently, a queued barrier can't be canceled. This is because 3110affee4b2STejun Heo * try_to_grab_pending() can't determine whether the work to be 3111affee4b2STejun Heo * grabbed is at the head of the queue and thus can't clear LINKED 3112affee4b2STejun Heo * flag of the previous work while there must be a valid next work 3113affee4b2STejun Heo * after a work with LINKED flag set. 3114affee4b2STejun Heo * 3115affee4b2STejun Heo * Note that when @worker is non-NULL, @target may be modified 3116112202d9STejun Heo * underneath us, so we can't reliably determine pwq from @target. 31174690c4abSTejun Heo * 31184690c4abSTejun Heo * CONTEXT: 3119a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 31204690c4abSTejun Heo */ 3121112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq, 3122affee4b2STejun Heo struct wq_barrier *barr, 3123affee4b2STejun Heo struct work_struct *target, struct worker *worker) 3124fc2e4d70SOleg Nesterov { 3125d812796eSLai Jiangshan unsigned int work_flags = 0; 3126d812796eSLai Jiangshan unsigned int work_color; 3127affee4b2STejun Heo struct list_head *head; 3128affee4b2STejun Heo 3129dc186ad7SThomas Gleixner /* 3130d565ed63STejun Heo * debugobject calls are safe here even with pool->lock locked 3131dc186ad7SThomas Gleixner * as we know for sure that this will not trigger any of the 3132dc186ad7SThomas Gleixner * checks and call back into the fixup functions where we 3133dc186ad7SThomas Gleixner * might deadlock. 3134dc186ad7SThomas Gleixner */ 3135ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&barr->work, wq_barrier_func); 313622df02bbSTejun Heo __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); 313752fa5bc5SBoqun Feng 3138fd1a5b04SByungchul Park init_completion_map(&barr->done, &target->lockdep_map); 3139fd1a5b04SByungchul Park 31402607d7a6STejun Heo barr->task = current; 314183c22520SOleg Nesterov 3142018f3a13SLai Jiangshan /* The barrier work item does not participate in pwq->nr_active. */ 3143018f3a13SLai Jiangshan work_flags |= WORK_STRUCT_INACTIVE; 3144018f3a13SLai Jiangshan 3145affee4b2STejun Heo /* 3146affee4b2STejun Heo * If @target is currently being executed, schedule the 3147affee4b2STejun Heo * barrier to the worker; otherwise, put it after @target. 3148affee4b2STejun Heo */ 3149d812796eSLai Jiangshan if (worker) { 3150affee4b2STejun Heo head = worker->scheduled.next; 3151d812796eSLai Jiangshan work_color = worker->current_color; 3152d812796eSLai Jiangshan } else { 3153affee4b2STejun Heo unsigned long *bits = work_data_bits(target); 3154affee4b2STejun Heo 3155affee4b2STejun Heo head = target->entry.next; 3156affee4b2STejun Heo /* there can already be other linked works, inherit and set */ 3157d21cece0SLai Jiangshan work_flags |= *bits & WORK_STRUCT_LINKED; 3158d812796eSLai Jiangshan work_color = get_work_color(*bits); 3159affee4b2STejun Heo __set_bit(WORK_STRUCT_LINKED_BIT, bits); 3160affee4b2STejun Heo } 3161affee4b2STejun Heo 3162d812796eSLai Jiangshan pwq->nr_in_flight[work_color]++; 3163d812796eSLai Jiangshan work_flags |= work_color_to_flags(work_color); 3164d812796eSLai Jiangshan 3165d21cece0SLai Jiangshan insert_work(pwq, &barr->work, head, work_flags); 3166fc2e4d70SOleg Nesterov } 3167fc2e4d70SOleg Nesterov 316873f53c4aSTejun Heo /** 3169112202d9STejun Heo * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing 317073f53c4aSTejun Heo * @wq: workqueue being flushed 317173f53c4aSTejun Heo * @flush_color: new flush color, < 0 for no-op 317273f53c4aSTejun Heo * @work_color: new work color, < 0 for no-op 317373f53c4aSTejun Heo * 3174112202d9STejun Heo * Prepare pwqs for workqueue flushing. 317573f53c4aSTejun Heo * 3176112202d9STejun Heo * If @flush_color is non-negative, flush_color on all pwqs should be 3177112202d9STejun Heo * -1. If no pwq has in-flight commands at the specified color, all 3178112202d9STejun Heo * pwq->flush_color's stay at -1 and %false is returned. If any pwq 3179112202d9STejun Heo * has in flight commands, its pwq->flush_color is set to 3180112202d9STejun Heo * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq 318173f53c4aSTejun Heo * wakeup logic is armed and %true is returned. 318273f53c4aSTejun Heo * 318373f53c4aSTejun Heo * The caller should have initialized @wq->first_flusher prior to 318473f53c4aSTejun Heo * calling this function with non-negative @flush_color. If 318573f53c4aSTejun Heo * @flush_color is negative, no flush color update is done and %false 318673f53c4aSTejun Heo * is returned. 318773f53c4aSTejun Heo * 3188112202d9STejun Heo * If @work_color is non-negative, all pwqs should have the same 318973f53c4aSTejun Heo * work_color which is previous to @work_color and all will be 319073f53c4aSTejun Heo * advanced to @work_color. 319173f53c4aSTejun Heo * 319273f53c4aSTejun Heo * CONTEXT: 31933c25a55dSLai Jiangshan * mutex_lock(wq->mutex). 319473f53c4aSTejun Heo * 3195d185af30SYacine Belkadi * Return: 319673f53c4aSTejun Heo * %true if @flush_color >= 0 and there's something to flush. %false 319773f53c4aSTejun Heo * otherwise. 319873f53c4aSTejun Heo */ 3199112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq, 320073f53c4aSTejun Heo int flush_color, int work_color) 32011da177e4SLinus Torvalds { 320273f53c4aSTejun Heo bool wait = false; 320349e3cf44STejun Heo struct pool_workqueue *pwq; 32041da177e4SLinus Torvalds 320573f53c4aSTejun Heo if (flush_color >= 0) { 32066183c009STejun Heo WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush)); 3207112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 1); 3208dc186ad7SThomas Gleixner } 320914441960SOleg Nesterov 321049e3cf44STejun Heo for_each_pwq(pwq, wq) { 3211112202d9STejun Heo struct worker_pool *pool = pwq->pool; 32121da177e4SLinus Torvalds 3213a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 321473f53c4aSTejun Heo 321573f53c4aSTejun Heo if (flush_color >= 0) { 32166183c009STejun Heo WARN_ON_ONCE(pwq->flush_color != -1); 321773f53c4aSTejun Heo 3218112202d9STejun Heo if (pwq->nr_in_flight[flush_color]) { 3219112202d9STejun Heo pwq->flush_color = flush_color; 3220112202d9STejun Heo atomic_inc(&wq->nr_pwqs_to_flush); 322173f53c4aSTejun Heo wait = true; 32221da177e4SLinus Torvalds } 322373f53c4aSTejun Heo } 322473f53c4aSTejun Heo 322573f53c4aSTejun Heo if (work_color >= 0) { 32266183c009STejun Heo WARN_ON_ONCE(work_color != work_next_color(pwq->work_color)); 3227112202d9STejun Heo pwq->work_color = work_color; 322873f53c4aSTejun Heo } 322973f53c4aSTejun Heo 3230a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 32311da177e4SLinus Torvalds } 32321da177e4SLinus Torvalds 3233112202d9STejun Heo if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush)) 323473f53c4aSTejun Heo complete(&wq->first_flusher->done); 323573f53c4aSTejun Heo 323673f53c4aSTejun Heo return wait; 323783c22520SOleg Nesterov } 32381da177e4SLinus Torvalds 32390fcb78c2SRolf Eike Beer /** 3240c4f135d6STetsuo Handa * __flush_workqueue - ensure that any scheduled work has run to completion. 32410fcb78c2SRolf Eike Beer * @wq: workqueue to flush 32421da177e4SLinus Torvalds * 3243c5aa87bbSTejun Heo * This function sleeps until all work items which were queued on entry 3244c5aa87bbSTejun Heo * have finished execution, but it is not livelocked by new incoming ones. 32451da177e4SLinus Torvalds */ 3246c4f135d6STetsuo Handa void __flush_workqueue(struct workqueue_struct *wq) 32471da177e4SLinus Torvalds { 324873f53c4aSTejun Heo struct wq_flusher this_flusher = { 324973f53c4aSTejun Heo .list = LIST_HEAD_INIT(this_flusher.list), 325073f53c4aSTejun Heo .flush_color = -1, 3251fd1a5b04SByungchul Park .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map), 325273f53c4aSTejun Heo }; 325373f53c4aSTejun Heo int next_color; 3254b1f4ec17SOleg Nesterov 32553347fa09STejun Heo if (WARN_ON(!wq_online)) 32563347fa09STejun Heo return; 32573347fa09STejun Heo 325887915adcSJohannes Berg lock_map_acquire(&wq->lockdep_map); 325987915adcSJohannes Berg lock_map_release(&wq->lockdep_map); 326087915adcSJohannes Berg 32613c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 326273f53c4aSTejun Heo 326373f53c4aSTejun Heo /* 326473f53c4aSTejun Heo * Start-to-wait phase 326573f53c4aSTejun Heo */ 326673f53c4aSTejun Heo next_color = work_next_color(wq->work_color); 326773f53c4aSTejun Heo 326873f53c4aSTejun Heo if (next_color != wq->flush_color) { 326973f53c4aSTejun Heo /* 327073f53c4aSTejun Heo * Color space is not full. The current work_color 327173f53c4aSTejun Heo * becomes our flush_color and work_color is advanced 327273f53c4aSTejun Heo * by one. 327373f53c4aSTejun Heo */ 32746183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow)); 327573f53c4aSTejun Heo this_flusher.flush_color = wq->work_color; 327673f53c4aSTejun Heo wq->work_color = next_color; 327773f53c4aSTejun Heo 327873f53c4aSTejun Heo if (!wq->first_flusher) { 327973f53c4aSTejun Heo /* no flush in progress, become the first flusher */ 32806183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 328173f53c4aSTejun Heo 328273f53c4aSTejun Heo wq->first_flusher = &this_flusher; 328373f53c4aSTejun Heo 3284112202d9STejun Heo if (!flush_workqueue_prep_pwqs(wq, wq->flush_color, 328573f53c4aSTejun Heo wq->work_color)) { 328673f53c4aSTejun Heo /* nothing to flush, done */ 328773f53c4aSTejun Heo wq->flush_color = next_color; 328873f53c4aSTejun Heo wq->first_flusher = NULL; 328973f53c4aSTejun Heo goto out_unlock; 329073f53c4aSTejun Heo } 329173f53c4aSTejun Heo } else { 329273f53c4aSTejun Heo /* wait in queue */ 32936183c009STejun Heo WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color); 329473f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_queue); 3295112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 329673f53c4aSTejun Heo } 329773f53c4aSTejun Heo } else { 329873f53c4aSTejun Heo /* 329973f53c4aSTejun Heo * Oops, color space is full, wait on overflow queue. 330073f53c4aSTejun Heo * The next flush completion will assign us 330173f53c4aSTejun Heo * flush_color and transfer to flusher_queue. 330273f53c4aSTejun Heo */ 330373f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_overflow); 330473f53c4aSTejun Heo } 330573f53c4aSTejun Heo 3306fca839c0STejun Heo check_flush_dependency(wq, NULL); 3307fca839c0STejun Heo 33083c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 330973f53c4aSTejun Heo 331073f53c4aSTejun Heo wait_for_completion(&this_flusher.done); 331173f53c4aSTejun Heo 331273f53c4aSTejun Heo /* 331373f53c4aSTejun Heo * Wake-up-and-cascade phase 331473f53c4aSTejun Heo * 331573f53c4aSTejun Heo * First flushers are responsible for cascading flushes and 331673f53c4aSTejun Heo * handling overflow. Non-first flushers can simply return. 331773f53c4aSTejun Heo */ 331800d5d15bSChris Wilson if (READ_ONCE(wq->first_flusher) != &this_flusher) 331973f53c4aSTejun Heo return; 332073f53c4aSTejun Heo 33213c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 332273f53c4aSTejun Heo 33234ce48b37STejun Heo /* we might have raced, check again with mutex held */ 33244ce48b37STejun Heo if (wq->first_flusher != &this_flusher) 33254ce48b37STejun Heo goto out_unlock; 33264ce48b37STejun Heo 332700d5d15bSChris Wilson WRITE_ONCE(wq->first_flusher, NULL); 332873f53c4aSTejun Heo 33296183c009STejun Heo WARN_ON_ONCE(!list_empty(&this_flusher.list)); 33306183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 333173f53c4aSTejun Heo 333273f53c4aSTejun Heo while (true) { 333373f53c4aSTejun Heo struct wq_flusher *next, *tmp; 333473f53c4aSTejun Heo 333573f53c4aSTejun Heo /* complete all the flushers sharing the current flush color */ 333673f53c4aSTejun Heo list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { 333773f53c4aSTejun Heo if (next->flush_color != wq->flush_color) 333873f53c4aSTejun Heo break; 333973f53c4aSTejun Heo list_del_init(&next->list); 334073f53c4aSTejun Heo complete(&next->done); 334173f53c4aSTejun Heo } 334273f53c4aSTejun Heo 33436183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) && 334473f53c4aSTejun Heo wq->flush_color != work_next_color(wq->work_color)); 334573f53c4aSTejun Heo 334673f53c4aSTejun Heo /* this flush_color is finished, advance by one */ 334773f53c4aSTejun Heo wq->flush_color = work_next_color(wq->flush_color); 334873f53c4aSTejun Heo 334973f53c4aSTejun Heo /* one color has been freed, handle overflow queue */ 335073f53c4aSTejun Heo if (!list_empty(&wq->flusher_overflow)) { 335173f53c4aSTejun Heo /* 335273f53c4aSTejun Heo * Assign the same color to all overflowed 335373f53c4aSTejun Heo * flushers, advance work_color and append to 335473f53c4aSTejun Heo * flusher_queue. This is the start-to-wait 335573f53c4aSTejun Heo * phase for these overflowed flushers. 335673f53c4aSTejun Heo */ 335773f53c4aSTejun Heo list_for_each_entry(tmp, &wq->flusher_overflow, list) 335873f53c4aSTejun Heo tmp->flush_color = wq->work_color; 335973f53c4aSTejun Heo 336073f53c4aSTejun Heo wq->work_color = work_next_color(wq->work_color); 336173f53c4aSTejun Heo 336273f53c4aSTejun Heo list_splice_tail_init(&wq->flusher_overflow, 336373f53c4aSTejun Heo &wq->flusher_queue); 3364112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 336573f53c4aSTejun Heo } 336673f53c4aSTejun Heo 336773f53c4aSTejun Heo if (list_empty(&wq->flusher_queue)) { 33686183c009STejun Heo WARN_ON_ONCE(wq->flush_color != wq->work_color); 336973f53c4aSTejun Heo break; 337073f53c4aSTejun Heo } 337173f53c4aSTejun Heo 337273f53c4aSTejun Heo /* 337373f53c4aSTejun Heo * Need to flush more colors. Make the next flusher 3374112202d9STejun Heo * the new first flusher and arm pwqs. 337573f53c4aSTejun Heo */ 33766183c009STejun Heo WARN_ON_ONCE(wq->flush_color == wq->work_color); 33776183c009STejun Heo WARN_ON_ONCE(wq->flush_color != next->flush_color); 337873f53c4aSTejun Heo 337973f53c4aSTejun Heo list_del_init(&next->list); 338073f53c4aSTejun Heo wq->first_flusher = next; 338173f53c4aSTejun Heo 3382112202d9STejun Heo if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1)) 338373f53c4aSTejun Heo break; 338473f53c4aSTejun Heo 338573f53c4aSTejun Heo /* 338673f53c4aSTejun Heo * Meh... this color is already done, clear first 338773f53c4aSTejun Heo * flusher and repeat cascading. 338873f53c4aSTejun Heo */ 338973f53c4aSTejun Heo wq->first_flusher = NULL; 339073f53c4aSTejun Heo } 339173f53c4aSTejun Heo 339273f53c4aSTejun Heo out_unlock: 33933c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 33941da177e4SLinus Torvalds } 3395c4f135d6STetsuo Handa EXPORT_SYMBOL(__flush_workqueue); 33961da177e4SLinus Torvalds 33979c5a2ba7STejun Heo /** 33989c5a2ba7STejun Heo * drain_workqueue - drain a workqueue 33999c5a2ba7STejun Heo * @wq: workqueue to drain 34009c5a2ba7STejun Heo * 34019c5a2ba7STejun Heo * Wait until the workqueue becomes empty. While draining is in progress, 34029c5a2ba7STejun Heo * only chain queueing is allowed. IOW, only currently pending or running 34039c5a2ba7STejun Heo * work items on @wq can queue further work items on it. @wq is flushed 3404b749b1b6SChen Hanxiao * repeatedly until it becomes empty. The number of flushing is determined 34059c5a2ba7STejun Heo * by the depth of chaining and should be relatively short. Whine if it 34069c5a2ba7STejun Heo * takes too long. 34079c5a2ba7STejun Heo */ 34089c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq) 34099c5a2ba7STejun Heo { 34109c5a2ba7STejun Heo unsigned int flush_cnt = 0; 341149e3cf44STejun Heo struct pool_workqueue *pwq; 34129c5a2ba7STejun Heo 34139c5a2ba7STejun Heo /* 34149c5a2ba7STejun Heo * __queue_work() needs to test whether there are drainers, is much 34159c5a2ba7STejun Heo * hotter than drain_workqueue() and already looks at @wq->flags. 3416618b01ebSTejun Heo * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers. 34179c5a2ba7STejun Heo */ 341887fc741eSLai Jiangshan mutex_lock(&wq->mutex); 34199c5a2ba7STejun Heo if (!wq->nr_drainers++) 3420618b01ebSTejun Heo wq->flags |= __WQ_DRAINING; 342187fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 34229c5a2ba7STejun Heo reflush: 3423c4f135d6STetsuo Handa __flush_workqueue(wq); 34249c5a2ba7STejun Heo 3425b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 342676af4d93STejun Heo 342749e3cf44STejun Heo for_each_pwq(pwq, wq) { 3428fa2563e4SThomas Tuttle bool drained; 34299c5a2ba7STejun Heo 3430a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 3431afa87ce8STejun Heo drained = pwq_is_empty(pwq); 3432a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 3433fa2563e4SThomas Tuttle 3434fa2563e4SThomas Tuttle if (drained) 34359c5a2ba7STejun Heo continue; 34369c5a2ba7STejun Heo 34379c5a2ba7STejun Heo if (++flush_cnt == 10 || 34389c5a2ba7STejun Heo (flush_cnt % 100 == 0 && flush_cnt <= 1000)) 3439e9ad2eb3SStephen Zhang pr_warn("workqueue %s: %s() isn't complete after %u tries\n", 3440e9ad2eb3SStephen Zhang wq->name, __func__, flush_cnt); 344176af4d93STejun Heo 3442b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 34439c5a2ba7STejun Heo goto reflush; 34449c5a2ba7STejun Heo } 34459c5a2ba7STejun Heo 34469c5a2ba7STejun Heo if (!--wq->nr_drainers) 3447618b01ebSTejun Heo wq->flags &= ~__WQ_DRAINING; 344887fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 34499c5a2ba7STejun Heo } 34509c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue); 34519c5a2ba7STejun Heo 3452d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr, 3453d6e89786SJohannes Berg bool from_cancel) 3454baf59022STejun Heo { 3455baf59022STejun Heo struct worker *worker = NULL; 3456c9e7cf27STejun Heo struct worker_pool *pool; 3457112202d9STejun Heo struct pool_workqueue *pwq; 3458baf59022STejun Heo 3459baf59022STejun Heo might_sleep(); 3460baf59022STejun Heo 346124acfb71SThomas Gleixner rcu_read_lock(); 3462fa1b54e6STejun Heo pool = get_work_pool(work); 3463fa1b54e6STejun Heo if (!pool) { 346424acfb71SThomas Gleixner rcu_read_unlock(); 3465fa1b54e6STejun Heo return false; 3466fa1b54e6STejun Heo } 3467fa1b54e6STejun Heo 3468a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 34690b3dae68SLai Jiangshan /* see the comment in try_to_grab_pending() with the same code */ 3470112202d9STejun Heo pwq = get_work_pwq(work); 3471112202d9STejun Heo if (pwq) { 3472112202d9STejun Heo if (unlikely(pwq->pool != pool)) 3473baf59022STejun Heo goto already_gone; 3474606a5020STejun Heo } else { 3475c9e7cf27STejun Heo worker = find_worker_executing_work(pool, work); 3476baf59022STejun Heo if (!worker) 3477baf59022STejun Heo goto already_gone; 3478112202d9STejun Heo pwq = worker->current_pwq; 3479606a5020STejun Heo } 3480baf59022STejun Heo 3481fca839c0STejun Heo check_flush_dependency(pwq->wq, work); 3482fca839c0STejun Heo 3483112202d9STejun Heo insert_wq_barrier(pwq, barr, work, worker); 3484a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 3485baf59022STejun Heo 3486e159489bSTejun Heo /* 3487a1d14934SPeter Zijlstra * Force a lock recursion deadlock when using flush_work() inside a 3488a1d14934SPeter Zijlstra * single-threaded or rescuer equipped workqueue. 3489a1d14934SPeter Zijlstra * 3490a1d14934SPeter Zijlstra * For single threaded workqueues the deadlock happens when the work 3491a1d14934SPeter Zijlstra * is after the work issuing the flush_work(). For rescuer equipped 3492a1d14934SPeter Zijlstra * workqueues the deadlock happens when the rescuer stalls, blocking 3493a1d14934SPeter Zijlstra * forward progress. 3494e159489bSTejun Heo */ 3495d6e89786SJohannes Berg if (!from_cancel && 3496d6e89786SJohannes Berg (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) { 3497112202d9STejun Heo lock_map_acquire(&pwq->wq->lockdep_map); 3498112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 3499a1d14934SPeter Zijlstra } 350024acfb71SThomas Gleixner rcu_read_unlock(); 3501baf59022STejun Heo return true; 3502baf59022STejun Heo already_gone: 3503a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 350424acfb71SThomas Gleixner rcu_read_unlock(); 3505baf59022STejun Heo return false; 3506baf59022STejun Heo } 3507baf59022STejun Heo 3508d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel) 3509d6e89786SJohannes Berg { 3510d6e89786SJohannes Berg struct wq_barrier barr; 3511d6e89786SJohannes Berg 3512d6e89786SJohannes Berg if (WARN_ON(!wq_online)) 3513d6e89786SJohannes Berg return false; 3514d6e89786SJohannes Berg 35154d43d395STetsuo Handa if (WARN_ON(!work->func)) 35164d43d395STetsuo Handa return false; 35174d43d395STetsuo Handa 351887915adcSJohannes Berg lock_map_acquire(&work->lockdep_map); 351987915adcSJohannes Berg lock_map_release(&work->lockdep_map); 352087915adcSJohannes Berg 3521d6e89786SJohannes Berg if (start_flush_work(work, &barr, from_cancel)) { 3522d6e89786SJohannes Berg wait_for_completion(&barr.done); 3523d6e89786SJohannes Berg destroy_work_on_stack(&barr.work); 3524d6e89786SJohannes Berg return true; 3525d6e89786SJohannes Berg } else { 3526d6e89786SJohannes Berg return false; 3527d6e89786SJohannes Berg } 3528d6e89786SJohannes Berg } 3529d6e89786SJohannes Berg 3530db700897SOleg Nesterov /** 3531401a8d04STejun Heo * flush_work - wait for a work to finish executing the last queueing instance 3532401a8d04STejun Heo * @work: the work to flush 3533db700897SOleg Nesterov * 3534606a5020STejun Heo * Wait until @work has finished execution. @work is guaranteed to be idle 3535606a5020STejun Heo * on return if it hasn't been requeued since flush started. 3536401a8d04STejun Heo * 3537d185af30SYacine Belkadi * Return: 3538401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 3539401a8d04STejun Heo * %false if it was already idle. 3540db700897SOleg Nesterov */ 3541401a8d04STejun Heo bool flush_work(struct work_struct *work) 3542db700897SOleg Nesterov { 3543d6e89786SJohannes Berg return __flush_work(work, false); 3544606a5020STejun Heo } 3545db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work); 3546db700897SOleg Nesterov 35478603e1b3STejun Heo struct cwt_wait { 3548ac6424b9SIngo Molnar wait_queue_entry_t wait; 35498603e1b3STejun Heo struct work_struct *work; 35508603e1b3STejun Heo }; 35518603e1b3STejun Heo 3552ac6424b9SIngo Molnar static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key) 35538603e1b3STejun Heo { 35548603e1b3STejun Heo struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait); 35558603e1b3STejun Heo 35568603e1b3STejun Heo if (cwait->work != key) 35578603e1b3STejun Heo return 0; 35588603e1b3STejun Heo return autoremove_wake_function(wait, mode, sync, key); 35598603e1b3STejun Heo } 35608603e1b3STejun Heo 356136e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork) 3562401a8d04STejun Heo { 35638603e1b3STejun Heo static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq); 3564bbb68dfaSTejun Heo unsigned long flags; 35651f1f642eSOleg Nesterov int ret; 35661f1f642eSOleg Nesterov 35671f1f642eSOleg Nesterov do { 3568bbb68dfaSTejun Heo ret = try_to_grab_pending(work, is_dwork, &flags); 3569bbb68dfaSTejun Heo /* 35708603e1b3STejun Heo * If someone else is already canceling, wait for it to 35718603e1b3STejun Heo * finish. flush_work() doesn't work for PREEMPT_NONE 35728603e1b3STejun Heo * because we may get scheduled between @work's completion 35738603e1b3STejun Heo * and the other canceling task resuming and clearing 35748603e1b3STejun Heo * CANCELING - flush_work() will return false immediately 35758603e1b3STejun Heo * as @work is no longer busy, try_to_grab_pending() will 35768603e1b3STejun Heo * return -ENOENT as @work is still being canceled and the 35778603e1b3STejun Heo * other canceling task won't be able to clear CANCELING as 35788603e1b3STejun Heo * we're hogging the CPU. 35798603e1b3STejun Heo * 35808603e1b3STejun Heo * Let's wait for completion using a waitqueue. As this 35818603e1b3STejun Heo * may lead to the thundering herd problem, use a custom 35828603e1b3STejun Heo * wake function which matches @work along with exclusive 35838603e1b3STejun Heo * wait and wakeup. 3584bbb68dfaSTejun Heo */ 35858603e1b3STejun Heo if (unlikely(ret == -ENOENT)) { 35868603e1b3STejun Heo struct cwt_wait cwait; 35878603e1b3STejun Heo 35888603e1b3STejun Heo init_wait(&cwait.wait); 35898603e1b3STejun Heo cwait.wait.func = cwt_wakefn; 35908603e1b3STejun Heo cwait.work = work; 35918603e1b3STejun Heo 35928603e1b3STejun Heo prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait, 35938603e1b3STejun Heo TASK_UNINTERRUPTIBLE); 35948603e1b3STejun Heo if (work_is_canceling(work)) 35958603e1b3STejun Heo schedule(); 35968603e1b3STejun Heo finish_wait(&cancel_waitq, &cwait.wait); 35978603e1b3STejun Heo } 35981f1f642eSOleg Nesterov } while (unlikely(ret < 0)); 35991f1f642eSOleg Nesterov 3600bbb68dfaSTejun Heo /* tell other tasks trying to grab @work to back off */ 3601bbb68dfaSTejun Heo mark_work_canceling(work); 3602bbb68dfaSTejun Heo local_irq_restore(flags); 3603bbb68dfaSTejun Heo 36043347fa09STejun Heo /* 36053347fa09STejun Heo * This allows canceling during early boot. We know that @work 36063347fa09STejun Heo * isn't executing. 36073347fa09STejun Heo */ 36083347fa09STejun Heo if (wq_online) 3609d6e89786SJohannes Berg __flush_work(work, true); 36103347fa09STejun Heo 36117a22ad75STejun Heo clear_work_data(work); 36128603e1b3STejun Heo 36138603e1b3STejun Heo /* 36148603e1b3STejun Heo * Paired with prepare_to_wait() above so that either 36158603e1b3STejun Heo * waitqueue_active() is visible here or !work_is_canceling() is 36168603e1b3STejun Heo * visible there. 36178603e1b3STejun Heo */ 36188603e1b3STejun Heo smp_mb(); 36198603e1b3STejun Heo if (waitqueue_active(&cancel_waitq)) 36208603e1b3STejun Heo __wake_up(&cancel_waitq, TASK_NORMAL, 1, work); 36218603e1b3STejun Heo 36221f1f642eSOleg Nesterov return ret; 36231f1f642eSOleg Nesterov } 36241f1f642eSOleg Nesterov 36256e84d644SOleg Nesterov /** 3626401a8d04STejun Heo * cancel_work_sync - cancel a work and wait for it to finish 3627401a8d04STejun Heo * @work: the work to cancel 36286e84d644SOleg Nesterov * 3629401a8d04STejun Heo * Cancel @work and wait for its execution to finish. This function 3630401a8d04STejun Heo * can be used even if the work re-queues itself or migrates to 3631401a8d04STejun Heo * another workqueue. On return from this function, @work is 3632401a8d04STejun Heo * guaranteed to be not pending or executing on any CPU. 36331f1f642eSOleg Nesterov * 3634401a8d04STejun Heo * cancel_work_sync(&delayed_work->work) must not be used for 3635401a8d04STejun Heo * delayed_work's. Use cancel_delayed_work_sync() instead. 36366e84d644SOleg Nesterov * 3637401a8d04STejun Heo * The caller must ensure that the workqueue on which @work was last 36386e84d644SOleg Nesterov * queued can't be destroyed before this function returns. 3639401a8d04STejun Heo * 3640d185af30SYacine Belkadi * Return: 3641401a8d04STejun Heo * %true if @work was pending, %false otherwise. 36426e84d644SOleg Nesterov */ 3643401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work) 36446e84d644SOleg Nesterov { 364536e227d2STejun Heo return __cancel_work_timer(work, false); 3646b89deed3SOleg Nesterov } 364728e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync); 3648b89deed3SOleg Nesterov 36496e84d644SOleg Nesterov /** 3650401a8d04STejun Heo * flush_delayed_work - wait for a dwork to finish executing the last queueing 3651401a8d04STejun Heo * @dwork: the delayed work to flush 36526e84d644SOleg Nesterov * 3653401a8d04STejun Heo * Delayed timer is cancelled and the pending work is queued for 3654401a8d04STejun Heo * immediate execution. Like flush_work(), this function only 3655401a8d04STejun Heo * considers the last queueing instance of @dwork. 36561f1f642eSOleg Nesterov * 3657d185af30SYacine Belkadi * Return: 3658401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 3659401a8d04STejun Heo * %false if it was already idle. 36606e84d644SOleg Nesterov */ 3661401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork) 3662401a8d04STejun Heo { 36638930cabaSTejun Heo local_irq_disable(); 3664401a8d04STejun Heo if (del_timer_sync(&dwork->timer)) 366560c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 36668930cabaSTejun Heo local_irq_enable(); 3667401a8d04STejun Heo return flush_work(&dwork->work); 3668401a8d04STejun Heo } 3669401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work); 3670401a8d04STejun Heo 367105f0fe6bSTejun Heo /** 367205f0fe6bSTejun Heo * flush_rcu_work - wait for a rwork to finish executing the last queueing 367305f0fe6bSTejun Heo * @rwork: the rcu work to flush 367405f0fe6bSTejun Heo * 367505f0fe6bSTejun Heo * Return: 367605f0fe6bSTejun Heo * %true if flush_rcu_work() waited for the work to finish execution, 367705f0fe6bSTejun Heo * %false if it was already idle. 367805f0fe6bSTejun Heo */ 367905f0fe6bSTejun Heo bool flush_rcu_work(struct rcu_work *rwork) 368005f0fe6bSTejun Heo { 368105f0fe6bSTejun Heo if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) { 368205f0fe6bSTejun Heo rcu_barrier(); 368305f0fe6bSTejun Heo flush_work(&rwork->work); 368405f0fe6bSTejun Heo return true; 368505f0fe6bSTejun Heo } else { 368605f0fe6bSTejun Heo return flush_work(&rwork->work); 368705f0fe6bSTejun Heo } 368805f0fe6bSTejun Heo } 368905f0fe6bSTejun Heo EXPORT_SYMBOL(flush_rcu_work); 369005f0fe6bSTejun Heo 3691f72b8792SJens Axboe static bool __cancel_work(struct work_struct *work, bool is_dwork) 3692f72b8792SJens Axboe { 3693f72b8792SJens Axboe unsigned long flags; 3694f72b8792SJens Axboe int ret; 3695f72b8792SJens Axboe 3696f72b8792SJens Axboe do { 3697f72b8792SJens Axboe ret = try_to_grab_pending(work, is_dwork, &flags); 3698f72b8792SJens Axboe } while (unlikely(ret == -EAGAIN)); 3699f72b8792SJens Axboe 3700f72b8792SJens Axboe if (unlikely(ret < 0)) 3701f72b8792SJens Axboe return false; 3702f72b8792SJens Axboe 3703f72b8792SJens Axboe set_work_pool_and_clear_pending(work, get_work_pool_id(work)); 3704f72b8792SJens Axboe local_irq_restore(flags); 3705f72b8792SJens Axboe return ret; 3706f72b8792SJens Axboe } 3707f72b8792SJens Axboe 370873b4b532SAndrey Grodzovsky /* 370973b4b532SAndrey Grodzovsky * See cancel_delayed_work() 371073b4b532SAndrey Grodzovsky */ 371173b4b532SAndrey Grodzovsky bool cancel_work(struct work_struct *work) 371273b4b532SAndrey Grodzovsky { 371373b4b532SAndrey Grodzovsky return __cancel_work(work, false); 371473b4b532SAndrey Grodzovsky } 371573b4b532SAndrey Grodzovsky EXPORT_SYMBOL(cancel_work); 371673b4b532SAndrey Grodzovsky 3717401a8d04STejun Heo /** 371857b30ae7STejun Heo * cancel_delayed_work - cancel a delayed work 371957b30ae7STejun Heo * @dwork: delayed_work to cancel 372009383498STejun Heo * 3721d185af30SYacine Belkadi * Kill off a pending delayed_work. 3722d185af30SYacine Belkadi * 3723d185af30SYacine Belkadi * Return: %true if @dwork was pending and canceled; %false if it wasn't 3724d185af30SYacine Belkadi * pending. 3725d185af30SYacine Belkadi * 3726d185af30SYacine Belkadi * Note: 3727d185af30SYacine Belkadi * The work callback function may still be running on return, unless 3728d185af30SYacine Belkadi * it returns %true and the work doesn't re-arm itself. Explicitly flush or 3729d185af30SYacine Belkadi * use cancel_delayed_work_sync() to wait on it. 373009383498STejun Heo * 373157b30ae7STejun Heo * This function is safe to call from any context including IRQ handler. 373209383498STejun Heo */ 373357b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork) 373409383498STejun Heo { 3735f72b8792SJens Axboe return __cancel_work(&dwork->work, true); 373609383498STejun Heo } 373757b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work); 373809383498STejun Heo 373909383498STejun Heo /** 3740401a8d04STejun Heo * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish 3741401a8d04STejun Heo * @dwork: the delayed work cancel 3742401a8d04STejun Heo * 3743401a8d04STejun Heo * This is cancel_work_sync() for delayed works. 3744401a8d04STejun Heo * 3745d185af30SYacine Belkadi * Return: 3746401a8d04STejun Heo * %true if @dwork was pending, %false otherwise. 3747401a8d04STejun Heo */ 3748401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork) 37496e84d644SOleg Nesterov { 375036e227d2STejun Heo return __cancel_work_timer(&dwork->work, true); 37516e84d644SOleg Nesterov } 3752f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync); 37531da177e4SLinus Torvalds 37540fcb78c2SRolf Eike Beer /** 375531ddd871STejun Heo * schedule_on_each_cpu - execute a function synchronously on each online CPU 3756b6136773SAndrew Morton * @func: the function to call 3757b6136773SAndrew Morton * 375831ddd871STejun Heo * schedule_on_each_cpu() executes @func on each online CPU using the 375931ddd871STejun Heo * system workqueue and blocks until all CPUs have completed. 3760b6136773SAndrew Morton * schedule_on_each_cpu() is very slow. 376131ddd871STejun Heo * 3762d185af30SYacine Belkadi * Return: 376331ddd871STejun Heo * 0 on success, -errno on failure. 3764b6136773SAndrew Morton */ 376565f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func) 376615316ba8SChristoph Lameter { 376715316ba8SChristoph Lameter int cpu; 376838f51568SNamhyung Kim struct work_struct __percpu *works; 376915316ba8SChristoph Lameter 3770b6136773SAndrew Morton works = alloc_percpu(struct work_struct); 3771b6136773SAndrew Morton if (!works) 377215316ba8SChristoph Lameter return -ENOMEM; 3773b6136773SAndrew Morton 3774ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 377593981800STejun Heo 377615316ba8SChristoph Lameter for_each_online_cpu(cpu) { 37779bfb1839SIngo Molnar struct work_struct *work = per_cpu_ptr(works, cpu); 37789bfb1839SIngo Molnar 37799bfb1839SIngo Molnar INIT_WORK(work, func); 37808de6d308SOleg Nesterov schedule_work_on(cpu, work); 378115316ba8SChristoph Lameter } 378293981800STejun Heo 378393981800STejun Heo for_each_online_cpu(cpu) 37848616a89aSOleg Nesterov flush_work(per_cpu_ptr(works, cpu)); 378593981800STejun Heo 3786ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 3787b6136773SAndrew Morton free_percpu(works); 378815316ba8SChristoph Lameter return 0; 378915316ba8SChristoph Lameter } 379015316ba8SChristoph Lameter 3791eef6a7d5SAlan Stern /** 37921fa44ecaSJames Bottomley * execute_in_process_context - reliably execute the routine with user context 37931fa44ecaSJames Bottomley * @fn: the function to execute 37941fa44ecaSJames Bottomley * @ew: guaranteed storage for the execute work structure (must 37951fa44ecaSJames Bottomley * be available when the work executes) 37961fa44ecaSJames Bottomley * 37971fa44ecaSJames Bottomley * Executes the function immediately if process context is available, 37981fa44ecaSJames Bottomley * otherwise schedules the function for delayed execution. 37991fa44ecaSJames Bottomley * 3800d185af30SYacine Belkadi * Return: 0 - function was executed 38011fa44ecaSJames Bottomley * 1 - function was scheduled for execution 38021fa44ecaSJames Bottomley */ 380365f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew) 38041fa44ecaSJames Bottomley { 38051fa44ecaSJames Bottomley if (!in_interrupt()) { 380665f27f38SDavid Howells fn(&ew->work); 38071fa44ecaSJames Bottomley return 0; 38081fa44ecaSJames Bottomley } 38091fa44ecaSJames Bottomley 381065f27f38SDavid Howells INIT_WORK(&ew->work, fn); 38111fa44ecaSJames Bottomley schedule_work(&ew->work); 38121fa44ecaSJames Bottomley 38131fa44ecaSJames Bottomley return 1; 38141fa44ecaSJames Bottomley } 38151fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context); 38161fa44ecaSJames Bottomley 38177a4e344cSTejun Heo /** 38187a4e344cSTejun Heo * free_workqueue_attrs - free a workqueue_attrs 38197a4e344cSTejun Heo * @attrs: workqueue_attrs to free 38207a4e344cSTejun Heo * 38217a4e344cSTejun Heo * Undo alloc_workqueue_attrs(). 38227a4e344cSTejun Heo */ 3823513c98d0SDaniel Jordan void free_workqueue_attrs(struct workqueue_attrs *attrs) 38247a4e344cSTejun Heo { 38257a4e344cSTejun Heo if (attrs) { 38267a4e344cSTejun Heo free_cpumask_var(attrs->cpumask); 38279546b29eSTejun Heo free_cpumask_var(attrs->__pod_cpumask); 38287a4e344cSTejun Heo kfree(attrs); 38297a4e344cSTejun Heo } 38307a4e344cSTejun Heo } 38317a4e344cSTejun Heo 38327a4e344cSTejun Heo /** 38337a4e344cSTejun Heo * alloc_workqueue_attrs - allocate a workqueue_attrs 38347a4e344cSTejun Heo * 38357a4e344cSTejun Heo * Allocate a new workqueue_attrs, initialize with default settings and 3836d185af30SYacine Belkadi * return it. 3837d185af30SYacine Belkadi * 3838d185af30SYacine Belkadi * Return: The allocated new workqueue_attr on success. %NULL on failure. 38397a4e344cSTejun Heo */ 3840513c98d0SDaniel Jordan struct workqueue_attrs *alloc_workqueue_attrs(void) 38417a4e344cSTejun Heo { 38427a4e344cSTejun Heo struct workqueue_attrs *attrs; 38437a4e344cSTejun Heo 3844be69d00dSThomas Gleixner attrs = kzalloc(sizeof(*attrs), GFP_KERNEL); 38457a4e344cSTejun Heo if (!attrs) 38467a4e344cSTejun Heo goto fail; 3847be69d00dSThomas Gleixner if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL)) 38487a4e344cSTejun Heo goto fail; 38499546b29eSTejun Heo if (!alloc_cpumask_var(&attrs->__pod_cpumask, GFP_KERNEL)) 38509546b29eSTejun Heo goto fail; 38517a4e344cSTejun Heo 385213e2e556STejun Heo cpumask_copy(attrs->cpumask, cpu_possible_mask); 3853523a301eSTejun Heo attrs->affn_scope = WQ_AFFN_DFL; 38547a4e344cSTejun Heo return attrs; 38557a4e344cSTejun Heo fail: 38567a4e344cSTejun Heo free_workqueue_attrs(attrs); 38577a4e344cSTejun Heo return NULL; 38587a4e344cSTejun Heo } 38597a4e344cSTejun Heo 386029c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to, 386129c91e99STejun Heo const struct workqueue_attrs *from) 386229c91e99STejun Heo { 386329c91e99STejun Heo to->nice = from->nice; 386429c91e99STejun Heo cpumask_copy(to->cpumask, from->cpumask); 38659546b29eSTejun Heo cpumask_copy(to->__pod_cpumask, from->__pod_cpumask); 38668639ecebSTejun Heo to->affn_strict = from->affn_strict; 386784193c07STejun Heo 38682865a8fbSShaohua Li /* 386984193c07STejun Heo * Unlike hash and equality test, copying shouldn't ignore wq-only 387084193c07STejun Heo * fields as copying is used for both pool and wq attrs. Instead, 387184193c07STejun Heo * get_unbound_pool() explicitly clears the fields. 38722865a8fbSShaohua Li */ 387384193c07STejun Heo to->affn_scope = from->affn_scope; 3874af73f5c9STejun Heo to->ordered = from->ordered; 387529c91e99STejun Heo } 387629c91e99STejun Heo 38775de7a03cSTejun Heo /* 38785de7a03cSTejun Heo * Some attrs fields are workqueue-only. Clear them for worker_pool's. See the 38795de7a03cSTejun Heo * comments in 'struct workqueue_attrs' definition. 38805de7a03cSTejun Heo */ 38815de7a03cSTejun Heo static void wqattrs_clear_for_pool(struct workqueue_attrs *attrs) 38825de7a03cSTejun Heo { 388384193c07STejun Heo attrs->affn_scope = WQ_AFFN_NR_TYPES; 38845de7a03cSTejun Heo attrs->ordered = false; 38855de7a03cSTejun Heo } 38865de7a03cSTejun Heo 388729c91e99STejun Heo /* hash value of the content of @attr */ 388829c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs) 388929c91e99STejun Heo { 389029c91e99STejun Heo u32 hash = 0; 389129c91e99STejun Heo 389229c91e99STejun Heo hash = jhash_1word(attrs->nice, hash); 389313e2e556STejun Heo hash = jhash(cpumask_bits(attrs->cpumask), 389413e2e556STejun Heo BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); 38959546b29eSTejun Heo hash = jhash(cpumask_bits(attrs->__pod_cpumask), 38969546b29eSTejun Heo BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); 38978639ecebSTejun Heo hash = jhash_1word(attrs->affn_strict, hash); 389829c91e99STejun Heo return hash; 389929c91e99STejun Heo } 390029c91e99STejun Heo 390129c91e99STejun Heo /* content equality test */ 390229c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a, 390329c91e99STejun Heo const struct workqueue_attrs *b) 390429c91e99STejun Heo { 390529c91e99STejun Heo if (a->nice != b->nice) 390629c91e99STejun Heo return false; 390729c91e99STejun Heo if (!cpumask_equal(a->cpumask, b->cpumask)) 390829c91e99STejun Heo return false; 39099546b29eSTejun Heo if (!cpumask_equal(a->__pod_cpumask, b->__pod_cpumask)) 39109546b29eSTejun Heo return false; 39118639ecebSTejun Heo if (a->affn_strict != b->affn_strict) 39128639ecebSTejun Heo return false; 391329c91e99STejun Heo return true; 391429c91e99STejun Heo } 391529c91e99STejun Heo 39160f36ee24STejun Heo /* Update @attrs with actually available CPUs */ 39170f36ee24STejun Heo static void wqattrs_actualize_cpumask(struct workqueue_attrs *attrs, 39180f36ee24STejun Heo const cpumask_t *unbound_cpumask) 39190f36ee24STejun Heo { 39200f36ee24STejun Heo /* 39210f36ee24STejun Heo * Calculate the effective CPU mask of @attrs given @unbound_cpumask. If 39220f36ee24STejun Heo * @attrs->cpumask doesn't overlap with @unbound_cpumask, we fallback to 39230f36ee24STejun Heo * @unbound_cpumask. 39240f36ee24STejun Heo */ 39250f36ee24STejun Heo cpumask_and(attrs->cpumask, attrs->cpumask, unbound_cpumask); 39260f36ee24STejun Heo if (unlikely(cpumask_empty(attrs->cpumask))) 39270f36ee24STejun Heo cpumask_copy(attrs->cpumask, unbound_cpumask); 39280f36ee24STejun Heo } 39290f36ee24STejun Heo 393084193c07STejun Heo /* find wq_pod_type to use for @attrs */ 393184193c07STejun Heo static const struct wq_pod_type * 393284193c07STejun Heo wqattrs_pod_type(const struct workqueue_attrs *attrs) 393384193c07STejun Heo { 3934523a301eSTejun Heo enum wq_affn_scope scope; 3935523a301eSTejun Heo struct wq_pod_type *pt; 3936523a301eSTejun Heo 3937523a301eSTejun Heo /* to synchronize access to wq_affn_dfl */ 3938523a301eSTejun Heo lockdep_assert_held(&wq_pool_mutex); 3939523a301eSTejun Heo 3940523a301eSTejun Heo if (attrs->affn_scope == WQ_AFFN_DFL) 3941523a301eSTejun Heo scope = wq_affn_dfl; 3942523a301eSTejun Heo else 3943523a301eSTejun Heo scope = attrs->affn_scope; 3944523a301eSTejun Heo 3945523a301eSTejun Heo pt = &wq_pod_types[scope]; 394684193c07STejun Heo 394784193c07STejun Heo if (!WARN_ON_ONCE(attrs->affn_scope == WQ_AFFN_NR_TYPES) && 394884193c07STejun Heo likely(pt->nr_pods)) 394984193c07STejun Heo return pt; 395084193c07STejun Heo 395184193c07STejun Heo /* 395284193c07STejun Heo * Before workqueue_init_topology(), only SYSTEM is available which is 395384193c07STejun Heo * initialized in workqueue_init_early(). 395484193c07STejun Heo */ 395584193c07STejun Heo pt = &wq_pod_types[WQ_AFFN_SYSTEM]; 395684193c07STejun Heo BUG_ON(!pt->nr_pods); 395784193c07STejun Heo return pt; 395884193c07STejun Heo } 395984193c07STejun Heo 39607a4e344cSTejun Heo /** 39617a4e344cSTejun Heo * init_worker_pool - initialize a newly zalloc'd worker_pool 39627a4e344cSTejun Heo * @pool: worker_pool to initialize 39637a4e344cSTejun Heo * 3964402dd89dSShailendra Verma * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs. 3965d185af30SYacine Belkadi * 3966d185af30SYacine Belkadi * Return: 0 on success, -errno on failure. Even on failure, all fields 396729c91e99STejun Heo * inside @pool proper are initialized and put_unbound_pool() can be called 396829c91e99STejun Heo * on @pool safely to release it. 39697a4e344cSTejun Heo */ 39707a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool) 39714e1a1f9aSTejun Heo { 3972a9b8a985SSebastian Andrzej Siewior raw_spin_lock_init(&pool->lock); 397329c91e99STejun Heo pool->id = -1; 397429c91e99STejun Heo pool->cpu = -1; 3975f3f90ad4STejun Heo pool->node = NUMA_NO_NODE; 39764e1a1f9aSTejun Heo pool->flags |= POOL_DISASSOCIATED; 397782607adcSTejun Heo pool->watchdog_ts = jiffies; 39784e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->worklist); 39794e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->idle_list); 39804e1a1f9aSTejun Heo hash_init(pool->busy_hash); 39814e1a1f9aSTejun Heo 398232a6c723SKees Cook timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE); 39833f959aa3SValentin Schneider INIT_WORK(&pool->idle_cull_work, idle_cull_fn); 39844e1a1f9aSTejun Heo 398532a6c723SKees Cook timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0); 39864e1a1f9aSTejun Heo 3987da028469SLai Jiangshan INIT_LIST_HEAD(&pool->workers); 3988e02b9312SValentin Schneider INIT_LIST_HEAD(&pool->dying_workers); 39897a4e344cSTejun Heo 39907cda9aaeSLai Jiangshan ida_init(&pool->worker_ida); 399129c91e99STejun Heo INIT_HLIST_NODE(&pool->hash_node); 399229c91e99STejun Heo pool->refcnt = 1; 399329c91e99STejun Heo 399429c91e99STejun Heo /* shouldn't fail above this point */ 3995be69d00dSThomas Gleixner pool->attrs = alloc_workqueue_attrs(); 39967a4e344cSTejun Heo if (!pool->attrs) 39977a4e344cSTejun Heo return -ENOMEM; 39985de7a03cSTejun Heo 39995de7a03cSTejun Heo wqattrs_clear_for_pool(pool->attrs); 40005de7a03cSTejun Heo 40017a4e344cSTejun Heo return 0; 40024e1a1f9aSTejun Heo } 40034e1a1f9aSTejun Heo 4004669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP 4005669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq) 4006669de8bdSBart Van Assche { 4007669de8bdSBart Van Assche char *lock_name; 4008669de8bdSBart Van Assche 4009669de8bdSBart Van Assche lockdep_register_key(&wq->key); 4010669de8bdSBart Van Assche lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name); 4011669de8bdSBart Van Assche if (!lock_name) 4012669de8bdSBart Van Assche lock_name = wq->name; 401369a106c0SQian Cai 401469a106c0SQian Cai wq->lock_name = lock_name; 4015669de8bdSBart Van Assche lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0); 4016669de8bdSBart Van Assche } 4017669de8bdSBart Van Assche 4018669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq) 4019669de8bdSBart Van Assche { 4020669de8bdSBart Van Assche lockdep_unregister_key(&wq->key); 4021669de8bdSBart Van Assche } 4022669de8bdSBart Van Assche 4023669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq) 4024669de8bdSBart Van Assche { 4025669de8bdSBart Van Assche if (wq->lock_name != wq->name) 4026669de8bdSBart Van Assche kfree(wq->lock_name); 4027669de8bdSBart Van Assche } 4028669de8bdSBart Van Assche #else 4029669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq) 4030669de8bdSBart Van Assche { 4031669de8bdSBart Van Assche } 4032669de8bdSBart Van Assche 4033669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq) 4034669de8bdSBart Van Assche { 4035669de8bdSBart Van Assche } 4036669de8bdSBart Van Assche 4037669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq) 4038669de8bdSBart Van Assche { 4039669de8bdSBart Van Assche } 4040669de8bdSBart Van Assche #endif 4041669de8bdSBart Van Assche 4042e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu) 4043e2dca7adSTejun Heo { 4044e2dca7adSTejun Heo struct workqueue_struct *wq = 4045e2dca7adSTejun Heo container_of(rcu, struct workqueue_struct, rcu); 4046e2dca7adSTejun Heo 4047669de8bdSBart Van Assche wq_free_lockdep(wq); 4048ee1ceef7STejun Heo free_percpu(wq->cpu_pwq); 4049e2dca7adSTejun Heo free_workqueue_attrs(wq->unbound_attrs); 4050e2dca7adSTejun Heo kfree(wq); 4051e2dca7adSTejun Heo } 4052e2dca7adSTejun Heo 405329c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu) 405429c91e99STejun Heo { 405529c91e99STejun Heo struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu); 405629c91e99STejun Heo 40577cda9aaeSLai Jiangshan ida_destroy(&pool->worker_ida); 405829c91e99STejun Heo free_workqueue_attrs(pool->attrs); 405929c91e99STejun Heo kfree(pool); 406029c91e99STejun Heo } 406129c91e99STejun Heo 406229c91e99STejun Heo /** 406329c91e99STejun Heo * put_unbound_pool - put a worker_pool 406429c91e99STejun Heo * @pool: worker_pool to put 406529c91e99STejun Heo * 406624acfb71SThomas Gleixner * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU 4067c5aa87bbSTejun Heo * safe manner. get_unbound_pool() calls this function on its failure path 4068c5aa87bbSTejun Heo * and this function should be able to release pools which went through, 4069c5aa87bbSTejun Heo * successfully or not, init_worker_pool(). 4070a892caccSTejun Heo * 4071a892caccSTejun Heo * Should be called with wq_pool_mutex held. 407229c91e99STejun Heo */ 407329c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool) 407429c91e99STejun Heo { 407560f5a4bcSLai Jiangshan DECLARE_COMPLETION_ONSTACK(detach_completion); 407629c91e99STejun Heo struct worker *worker; 40779680540cSYang Yingliang LIST_HEAD(cull_list); 4078e02b9312SValentin Schneider 4079a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 4080a892caccSTejun Heo 4081a892caccSTejun Heo if (--pool->refcnt) 408229c91e99STejun Heo return; 408329c91e99STejun Heo 408429c91e99STejun Heo /* sanity checks */ 408561d0fbb4SLai Jiangshan if (WARN_ON(!(pool->cpu < 0)) || 4086a892caccSTejun Heo WARN_ON(!list_empty(&pool->worklist))) 408729c91e99STejun Heo return; 408829c91e99STejun Heo 408929c91e99STejun Heo /* release id and unhash */ 409029c91e99STejun Heo if (pool->id >= 0) 409129c91e99STejun Heo idr_remove(&worker_pool_idr, pool->id); 409229c91e99STejun Heo hash_del(&pool->hash_node); 409329c91e99STejun Heo 4094c5aa87bbSTejun Heo /* 4095692b4825STejun Heo * Become the manager and destroy all workers. This prevents 4096692b4825STejun Heo * @pool's workers from blocking on attach_mutex. We're the last 4097692b4825STejun Heo * manager and @pool gets freed with the flag set. 40989ab03be4SValentin Schneider * 40999ab03be4SValentin Schneider * Having a concurrent manager is quite unlikely to happen as we can 41009ab03be4SValentin Schneider * only get here with 41019ab03be4SValentin Schneider * pwq->refcnt == pool->refcnt == 0 41029ab03be4SValentin Schneider * which implies no work queued to the pool, which implies no worker can 41039ab03be4SValentin Schneider * become the manager. However a worker could have taken the role of 41049ab03be4SValentin Schneider * manager before the refcnts dropped to 0, since maybe_create_worker() 41059ab03be4SValentin Schneider * drops pool->lock 4106c5aa87bbSTejun Heo */ 41079ab03be4SValentin Schneider while (true) { 41089ab03be4SValentin Schneider rcuwait_wait_event(&manager_wait, 41099ab03be4SValentin Schneider !(pool->flags & POOL_MANAGER_ACTIVE), 4110d8bb65abSSebastian Andrzej Siewior TASK_UNINTERRUPTIBLE); 4111e02b9312SValentin Schneider 4112e02b9312SValentin Schneider mutex_lock(&wq_pool_attach_mutex); 41139ab03be4SValentin Schneider raw_spin_lock_irq(&pool->lock); 41149ab03be4SValentin Schneider if (!(pool->flags & POOL_MANAGER_ACTIVE)) { 4115692b4825STejun Heo pool->flags |= POOL_MANAGER_ACTIVE; 41169ab03be4SValentin Schneider break; 41179ab03be4SValentin Schneider } 41189ab03be4SValentin Schneider raw_spin_unlock_irq(&pool->lock); 4119e02b9312SValentin Schneider mutex_unlock(&wq_pool_attach_mutex); 41209ab03be4SValentin Schneider } 4121692b4825STejun Heo 41221037de36SLai Jiangshan while ((worker = first_idle_worker(pool))) 4123e02b9312SValentin Schneider set_worker_dying(worker, &cull_list); 412429c91e99STejun Heo WARN_ON(pool->nr_workers || pool->nr_idle); 4125a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 412660f5a4bcSLai Jiangshan 4127e02b9312SValentin Schneider wake_dying_workers(&cull_list); 4128e02b9312SValentin Schneider 4129e02b9312SValentin Schneider if (!list_empty(&pool->workers) || !list_empty(&pool->dying_workers)) 413060f5a4bcSLai Jiangshan pool->detach_completion = &detach_completion; 41311258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 413260f5a4bcSLai Jiangshan 413360f5a4bcSLai Jiangshan if (pool->detach_completion) 413460f5a4bcSLai Jiangshan wait_for_completion(pool->detach_completion); 413560f5a4bcSLai Jiangshan 413629c91e99STejun Heo /* shut down the timers */ 413729c91e99STejun Heo del_timer_sync(&pool->idle_timer); 41383f959aa3SValentin Schneider cancel_work_sync(&pool->idle_cull_work); 413929c91e99STejun Heo del_timer_sync(&pool->mayday_timer); 414029c91e99STejun Heo 414124acfb71SThomas Gleixner /* RCU protected to allow dereferences from get_work_pool() */ 414225b00775SPaul E. McKenney call_rcu(&pool->rcu, rcu_free_pool); 414329c91e99STejun Heo } 414429c91e99STejun Heo 414529c91e99STejun Heo /** 414629c91e99STejun Heo * get_unbound_pool - get a worker_pool with the specified attributes 414729c91e99STejun Heo * @attrs: the attributes of the worker_pool to get 414829c91e99STejun Heo * 414929c91e99STejun Heo * Obtain a worker_pool which has the same attributes as @attrs, bump the 415029c91e99STejun Heo * reference count and return it. If there already is a matching 415129c91e99STejun Heo * worker_pool, it will be used; otherwise, this function attempts to 4152d185af30SYacine Belkadi * create a new one. 4153a892caccSTejun Heo * 4154a892caccSTejun Heo * Should be called with wq_pool_mutex held. 4155d185af30SYacine Belkadi * 4156d185af30SYacine Belkadi * Return: On success, a worker_pool with the same attributes as @attrs. 4157d185af30SYacine Belkadi * On failure, %NULL. 415829c91e99STejun Heo */ 415929c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs) 416029c91e99STejun Heo { 416184193c07STejun Heo struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_NUMA]; 416229c91e99STejun Heo u32 hash = wqattrs_hash(attrs); 416329c91e99STejun Heo struct worker_pool *pool; 416484193c07STejun Heo int pod, node = NUMA_NO_NODE; 416529c91e99STejun Heo 4166a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 416729c91e99STejun Heo 416829c91e99STejun Heo /* do we already have a matching pool? */ 416929c91e99STejun Heo hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) { 417029c91e99STejun Heo if (wqattrs_equal(pool->attrs, attrs)) { 417129c91e99STejun Heo pool->refcnt++; 41723fb1823cSLai Jiangshan return pool; 417329c91e99STejun Heo } 417429c91e99STejun Heo } 417529c91e99STejun Heo 41769546b29eSTejun Heo /* If __pod_cpumask is contained inside a NUMA pod, that's our node */ 417784193c07STejun Heo for (pod = 0; pod < pt->nr_pods; pod++) { 41789546b29eSTejun Heo if (cpumask_subset(attrs->__pod_cpumask, pt->pod_cpus[pod])) { 417984193c07STejun Heo node = pt->pod_node[pod]; 4180e2273584SXunlei Pang break; 4181e2273584SXunlei Pang } 4182e2273584SXunlei Pang } 4183e2273584SXunlei Pang 418429c91e99STejun Heo /* nope, create a new one */ 418584193c07STejun Heo pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, node); 418629c91e99STejun Heo if (!pool || init_worker_pool(pool) < 0) 418729c91e99STejun Heo goto fail; 418829c91e99STejun Heo 418984193c07STejun Heo pool->node = node; 41905de7a03cSTejun Heo copy_workqueue_attrs(pool->attrs, attrs); 41915de7a03cSTejun Heo wqattrs_clear_for_pool(pool->attrs); 41922865a8fbSShaohua Li 419329c91e99STejun Heo if (worker_pool_assign_id(pool) < 0) 419429c91e99STejun Heo goto fail; 419529c91e99STejun Heo 419629c91e99STejun Heo /* create and start the initial worker */ 41973347fa09STejun Heo if (wq_online && !create_worker(pool)) 419829c91e99STejun Heo goto fail; 419929c91e99STejun Heo 420029c91e99STejun Heo /* install */ 420129c91e99STejun Heo hash_add(unbound_pool_hash, &pool->hash_node, hash); 42023fb1823cSLai Jiangshan 420329c91e99STejun Heo return pool; 420429c91e99STejun Heo fail: 420529c91e99STejun Heo if (pool) 420629c91e99STejun Heo put_unbound_pool(pool); 420729c91e99STejun Heo return NULL; 420829c91e99STejun Heo } 420929c91e99STejun Heo 42108864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu) 42118864b4e5STejun Heo { 42128864b4e5STejun Heo kmem_cache_free(pwq_cache, 42138864b4e5STejun Heo container_of(rcu, struct pool_workqueue, rcu)); 42148864b4e5STejun Heo } 42158864b4e5STejun Heo 42168864b4e5STejun Heo /* 4217967b494eSTejun Heo * Scheduled on pwq_release_worker by put_pwq() when an unbound pwq hits zero 4218967b494eSTejun Heo * refcnt and needs to be destroyed. 42198864b4e5STejun Heo */ 4220687a9aa5STejun Heo static void pwq_release_workfn(struct kthread_work *work) 42218864b4e5STejun Heo { 42228864b4e5STejun Heo struct pool_workqueue *pwq = container_of(work, struct pool_workqueue, 4223687a9aa5STejun Heo release_work); 42248864b4e5STejun Heo struct workqueue_struct *wq = pwq->wq; 42258864b4e5STejun Heo struct worker_pool *pool = pwq->pool; 4226b42b0bddSYang Yingliang bool is_last = false; 42278864b4e5STejun Heo 4228b42b0bddSYang Yingliang /* 4229687a9aa5STejun Heo * When @pwq is not linked, it doesn't hold any reference to the 4230b42b0bddSYang Yingliang * @wq, and @wq is invalid to access. 4231b42b0bddSYang Yingliang */ 4232b42b0bddSYang Yingliang if (!list_empty(&pwq->pwqs_node)) { 42333c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 42348864b4e5STejun Heo list_del_rcu(&pwq->pwqs_node); 4235bc0caf09STejun Heo is_last = list_empty(&wq->pwqs); 42363c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 4237b42b0bddSYang Yingliang } 42388864b4e5STejun Heo 4239687a9aa5STejun Heo if (wq->flags & WQ_UNBOUND) { 4240a892caccSTejun Heo mutex_lock(&wq_pool_mutex); 42418864b4e5STejun Heo put_unbound_pool(pool); 4242a892caccSTejun Heo mutex_unlock(&wq_pool_mutex); 4243687a9aa5STejun Heo } 4244a892caccSTejun Heo 424525b00775SPaul E. McKenney call_rcu(&pwq->rcu, rcu_free_pwq); 42468864b4e5STejun Heo 42478864b4e5STejun Heo /* 42488864b4e5STejun Heo * If we're the last pwq going away, @wq is already dead and no one 4249e2dca7adSTejun Heo * is gonna access it anymore. Schedule RCU free. 42508864b4e5STejun Heo */ 4251669de8bdSBart Van Assche if (is_last) { 4252669de8bdSBart Van Assche wq_unregister_lockdep(wq); 425325b00775SPaul E. McKenney call_rcu(&wq->rcu, rcu_free_wq); 42546029a918STejun Heo } 4255669de8bdSBart Van Assche } 42568864b4e5STejun Heo 425767dc8325SCai Huoqing /* initialize newly allocated @pwq which is associated with @wq and @pool */ 4258f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq, 4259f147f29eSTejun Heo struct worker_pool *pool) 4260d2c1d404STejun Heo { 4261d2c1d404STejun Heo BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK); 4262d2c1d404STejun Heo 4263e50aba9aSTejun Heo memset(pwq, 0, sizeof(*pwq)); 4264e50aba9aSTejun Heo 4265d2c1d404STejun Heo pwq->pool = pool; 4266d2c1d404STejun Heo pwq->wq = wq; 4267d2c1d404STejun Heo pwq->flush_color = -1; 42688864b4e5STejun Heo pwq->refcnt = 1; 4269f97a4a1aSLai Jiangshan INIT_LIST_HEAD(&pwq->inactive_works); 42701befcf30STejun Heo INIT_LIST_HEAD(&pwq->pwqs_node); 4271d2c1d404STejun Heo INIT_LIST_HEAD(&pwq->mayday_node); 4272687a9aa5STejun Heo kthread_init_work(&pwq->release_work, pwq_release_workfn); 4273f147f29eSTejun Heo } 4274d2c1d404STejun Heo 4275f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */ 42761befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq) 4277f147f29eSTejun Heo { 4278f147f29eSTejun Heo struct workqueue_struct *wq = pwq->wq; 4279f147f29eSTejun Heo 4280f147f29eSTejun Heo lockdep_assert_held(&wq->mutex); 428175ccf595STejun Heo 42821befcf30STejun Heo /* may be called multiple times, ignore if already linked */ 42831befcf30STejun Heo if (!list_empty(&pwq->pwqs_node)) 42841befcf30STejun Heo return; 42851befcf30STejun Heo 428629b1cb41SLai Jiangshan /* set the matching work_color */ 428775ccf595STejun Heo pwq->work_color = wq->work_color; 4288983ca25eSTejun Heo 4289983ca25eSTejun Heo /* link in @pwq */ 42909e8cd2f5STejun Heo list_add_rcu(&pwq->pwqs_node, &wq->pwqs); 4291df2d5ae4STejun Heo } 42926029a918STejun Heo 4293f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */ 4294f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq, 4295f147f29eSTejun Heo const struct workqueue_attrs *attrs) 4296f147f29eSTejun Heo { 4297f147f29eSTejun Heo struct worker_pool *pool; 4298f147f29eSTejun Heo struct pool_workqueue *pwq; 4299f147f29eSTejun Heo 4300f147f29eSTejun Heo lockdep_assert_held(&wq_pool_mutex); 4301f147f29eSTejun Heo 4302f147f29eSTejun Heo pool = get_unbound_pool(attrs); 4303f147f29eSTejun Heo if (!pool) 4304f147f29eSTejun Heo return NULL; 4305f147f29eSTejun Heo 4306e50aba9aSTejun Heo pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node); 4307f147f29eSTejun Heo if (!pwq) { 4308f147f29eSTejun Heo put_unbound_pool(pool); 4309f147f29eSTejun Heo return NULL; 4310f147f29eSTejun Heo } 4311f147f29eSTejun Heo 4312f147f29eSTejun Heo init_pwq(pwq, wq, pool); 4313f147f29eSTejun Heo return pwq; 4314d2c1d404STejun Heo } 4315d2c1d404STejun Heo 43164c16bd32STejun Heo /** 4317fef59c9cSTejun Heo * wq_calc_pod_cpumask - calculate a wq_attrs' cpumask for a pod 4318042f7df1SLai Jiangshan * @attrs: the wq_attrs of the default pwq of the target workqueue 431984193c07STejun Heo * @cpu: the target CPU 43204c16bd32STejun Heo * @cpu_going_down: if >= 0, the CPU to consider as offline 43214c16bd32STejun Heo * 4322fef59c9cSTejun Heo * Calculate the cpumask a workqueue with @attrs should use on @pod. If 4323fef59c9cSTejun Heo * @cpu_going_down is >= 0, that cpu is considered offline during calculation. 43249546b29eSTejun Heo * The result is stored in @attrs->__pod_cpumask. 43254c16bd32STejun Heo * 4326fef59c9cSTejun Heo * If pod affinity is not enabled, @attrs->cpumask is always used. If enabled 4327fef59c9cSTejun Heo * and @pod has online CPUs requested by @attrs, the returned cpumask is the 4328fef59c9cSTejun Heo * intersection of the possible CPUs of @pod and @attrs->cpumask. 43294c16bd32STejun Heo * 4330fef59c9cSTejun Heo * The caller is responsible for ensuring that the cpumask of @pod stays stable. 43314c16bd32STejun Heo */ 43329546b29eSTejun Heo static void wq_calc_pod_cpumask(struct workqueue_attrs *attrs, int cpu, 43339546b29eSTejun Heo int cpu_going_down) 43344c16bd32STejun Heo { 433584193c07STejun Heo const struct wq_pod_type *pt = wqattrs_pod_type(attrs); 433684193c07STejun Heo int pod = pt->cpu_pod[cpu]; 43374c16bd32STejun Heo 4338fef59c9cSTejun Heo /* does @pod have any online CPUs @attrs wants? */ 43399546b29eSTejun Heo cpumask_and(attrs->__pod_cpumask, pt->pod_cpus[pod], attrs->cpumask); 43409546b29eSTejun Heo cpumask_and(attrs->__pod_cpumask, attrs->__pod_cpumask, cpu_online_mask); 43414c16bd32STejun Heo if (cpu_going_down >= 0) 43429546b29eSTejun Heo cpumask_clear_cpu(cpu_going_down, attrs->__pod_cpumask); 43434c16bd32STejun Heo 43449546b29eSTejun Heo if (cpumask_empty(attrs->__pod_cpumask)) { 43459546b29eSTejun Heo cpumask_copy(attrs->__pod_cpumask, attrs->cpumask); 434684193c07STejun Heo return; 434784193c07STejun Heo } 43484c16bd32STejun Heo 4349fef59c9cSTejun Heo /* yeap, return possible CPUs in @pod that @attrs wants */ 43509546b29eSTejun Heo cpumask_and(attrs->__pod_cpumask, attrs->cpumask, pt->pod_cpus[pod]); 43511ad0f0a7SMichael Bringmann 43529546b29eSTejun Heo if (cpumask_empty(attrs->__pod_cpumask)) 43531ad0f0a7SMichael Bringmann pr_warn_once("WARNING: workqueue cpumask: online intersect > " 43541ad0f0a7SMichael Bringmann "possible intersect\n"); 43554c16bd32STejun Heo } 43564c16bd32STejun Heo 43579f66cff2STejun Heo /* install @pwq into @wq and return the old pwq, @cpu < 0 for dfl_pwq */ 4358636b927eSTejun Heo static struct pool_workqueue *install_unbound_pwq(struct workqueue_struct *wq, 4359636b927eSTejun Heo int cpu, struct pool_workqueue *pwq) 43601befcf30STejun Heo { 43619f66cff2STejun Heo struct pool_workqueue __rcu **slot = unbound_pwq_slot(wq, cpu); 43621befcf30STejun Heo struct pool_workqueue *old_pwq; 43631befcf30STejun Heo 43645b95e1afSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 43651befcf30STejun Heo lockdep_assert_held(&wq->mutex); 43661befcf30STejun Heo 43671befcf30STejun Heo /* link_pwq() can handle duplicate calls */ 43681befcf30STejun Heo link_pwq(pwq); 43691befcf30STejun Heo 43709f66cff2STejun Heo old_pwq = rcu_access_pointer(*slot); 43719f66cff2STejun Heo rcu_assign_pointer(*slot, pwq); 43721befcf30STejun Heo return old_pwq; 43731befcf30STejun Heo } 43741befcf30STejun Heo 43752d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */ 43762d5f0764SLai Jiangshan struct apply_wqattrs_ctx { 43772d5f0764SLai Jiangshan struct workqueue_struct *wq; /* target workqueue */ 43782d5f0764SLai Jiangshan struct workqueue_attrs *attrs; /* attrs to apply */ 4379042f7df1SLai Jiangshan struct list_head list; /* queued for batching commit */ 43802d5f0764SLai Jiangshan struct pool_workqueue *dfl_pwq; 43812d5f0764SLai Jiangshan struct pool_workqueue *pwq_tbl[]; 43822d5f0764SLai Jiangshan }; 43832d5f0764SLai Jiangshan 43842d5f0764SLai Jiangshan /* free the resources after success or abort */ 43852d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx) 43862d5f0764SLai Jiangshan { 43872d5f0764SLai Jiangshan if (ctx) { 4388636b927eSTejun Heo int cpu; 43892d5f0764SLai Jiangshan 4390636b927eSTejun Heo for_each_possible_cpu(cpu) 4391636b927eSTejun Heo put_pwq_unlocked(ctx->pwq_tbl[cpu]); 43922d5f0764SLai Jiangshan put_pwq_unlocked(ctx->dfl_pwq); 43932d5f0764SLai Jiangshan 43942d5f0764SLai Jiangshan free_workqueue_attrs(ctx->attrs); 43952d5f0764SLai Jiangshan 43962d5f0764SLai Jiangshan kfree(ctx); 43972d5f0764SLai Jiangshan } 43982d5f0764SLai Jiangshan } 43992d5f0764SLai Jiangshan 44002d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */ 44012d5f0764SLai Jiangshan static struct apply_wqattrs_ctx * 44022d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq, 440399c621efSLai Jiangshan const struct workqueue_attrs *attrs, 440499c621efSLai Jiangshan const cpumask_var_t unbound_cpumask) 44052d5f0764SLai Jiangshan { 44062d5f0764SLai Jiangshan struct apply_wqattrs_ctx *ctx; 44079546b29eSTejun Heo struct workqueue_attrs *new_attrs; 4408636b927eSTejun Heo int cpu; 44092d5f0764SLai Jiangshan 44102d5f0764SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 44112d5f0764SLai Jiangshan 441284193c07STejun Heo if (WARN_ON(attrs->affn_scope < 0 || 441384193c07STejun Heo attrs->affn_scope >= WQ_AFFN_NR_TYPES)) 441484193c07STejun Heo return ERR_PTR(-EINVAL); 441584193c07STejun Heo 4416636b927eSTejun Heo ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_cpu_ids), GFP_KERNEL); 44172d5f0764SLai Jiangshan 4418be69d00dSThomas Gleixner new_attrs = alloc_workqueue_attrs(); 44199546b29eSTejun Heo if (!ctx || !new_attrs) 44202d5f0764SLai Jiangshan goto out_free; 44212d5f0764SLai Jiangshan 4422042f7df1SLai Jiangshan /* 44232d5f0764SLai Jiangshan * If something goes wrong during CPU up/down, we'll fall back to 44242d5f0764SLai Jiangshan * the default pwq covering whole @attrs->cpumask. Always create 44252d5f0764SLai Jiangshan * it even if we don't use it immediately. 44262d5f0764SLai Jiangshan */ 44270f36ee24STejun Heo copy_workqueue_attrs(new_attrs, attrs); 44280f36ee24STejun Heo wqattrs_actualize_cpumask(new_attrs, unbound_cpumask); 44299546b29eSTejun Heo cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask); 44302d5f0764SLai Jiangshan ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs); 44312d5f0764SLai Jiangshan if (!ctx->dfl_pwq) 44322d5f0764SLai Jiangshan goto out_free; 44332d5f0764SLai Jiangshan 4434636b927eSTejun Heo for_each_possible_cpu(cpu) { 4435af73f5c9STejun Heo if (new_attrs->ordered) { 44362d5f0764SLai Jiangshan ctx->dfl_pwq->refcnt++; 4437636b927eSTejun Heo ctx->pwq_tbl[cpu] = ctx->dfl_pwq; 4438636b927eSTejun Heo } else { 44399546b29eSTejun Heo wq_calc_pod_cpumask(new_attrs, cpu, -1); 44409546b29eSTejun Heo ctx->pwq_tbl[cpu] = alloc_unbound_pwq(wq, new_attrs); 4441636b927eSTejun Heo if (!ctx->pwq_tbl[cpu]) 4442636b927eSTejun Heo goto out_free; 44432d5f0764SLai Jiangshan } 44442d5f0764SLai Jiangshan } 44452d5f0764SLai Jiangshan 4446042f7df1SLai Jiangshan /* save the user configured attrs and sanitize it. */ 4447042f7df1SLai Jiangshan copy_workqueue_attrs(new_attrs, attrs); 4448042f7df1SLai Jiangshan cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask); 44499546b29eSTejun Heo cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask); 44502d5f0764SLai Jiangshan ctx->attrs = new_attrs; 4451042f7df1SLai Jiangshan 44522d5f0764SLai Jiangshan ctx->wq = wq; 44532d5f0764SLai Jiangshan return ctx; 44542d5f0764SLai Jiangshan 44552d5f0764SLai Jiangshan out_free: 44562d5f0764SLai Jiangshan free_workqueue_attrs(new_attrs); 44572d5f0764SLai Jiangshan apply_wqattrs_cleanup(ctx); 445884193c07STejun Heo return ERR_PTR(-ENOMEM); 44592d5f0764SLai Jiangshan } 44602d5f0764SLai Jiangshan 44612d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */ 44622d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx) 44632d5f0764SLai Jiangshan { 4464636b927eSTejun Heo int cpu; 44652d5f0764SLai Jiangshan 44662d5f0764SLai Jiangshan /* all pwqs have been created successfully, let's install'em */ 44672d5f0764SLai Jiangshan mutex_lock(&ctx->wq->mutex); 44682d5f0764SLai Jiangshan 44692d5f0764SLai Jiangshan copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs); 44702d5f0764SLai Jiangshan 44719f66cff2STejun Heo /* save the previous pwqs and install the new ones */ 4472636b927eSTejun Heo for_each_possible_cpu(cpu) 4473636b927eSTejun Heo ctx->pwq_tbl[cpu] = install_unbound_pwq(ctx->wq, cpu, 4474636b927eSTejun Heo ctx->pwq_tbl[cpu]); 44759f66cff2STejun Heo ctx->dfl_pwq = install_unbound_pwq(ctx->wq, -1, ctx->dfl_pwq); 44762d5f0764SLai Jiangshan 44772d5f0764SLai Jiangshan mutex_unlock(&ctx->wq->mutex); 44782d5f0764SLai Jiangshan } 44792d5f0764SLai Jiangshan 4480a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq, 4481a0111cf6SLai Jiangshan const struct workqueue_attrs *attrs) 4482a0111cf6SLai Jiangshan { 4483a0111cf6SLai Jiangshan struct apply_wqattrs_ctx *ctx; 4484a0111cf6SLai Jiangshan 4485a0111cf6SLai Jiangshan /* only unbound workqueues can change attributes */ 4486a0111cf6SLai Jiangshan if (WARN_ON(!(wq->flags & WQ_UNBOUND))) 4487a0111cf6SLai Jiangshan return -EINVAL; 4488a0111cf6SLai Jiangshan 4489a0111cf6SLai Jiangshan /* creating multiple pwqs breaks ordering guarantee */ 44900a94efb5STejun Heo if (!list_empty(&wq->pwqs)) { 44910a94efb5STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) 4492a0111cf6SLai Jiangshan return -EINVAL; 4493a0111cf6SLai Jiangshan 44940a94efb5STejun Heo wq->flags &= ~__WQ_ORDERED; 44950a94efb5STejun Heo } 44960a94efb5STejun Heo 449799c621efSLai Jiangshan ctx = apply_wqattrs_prepare(wq, attrs, wq_unbound_cpumask); 449884193c07STejun Heo if (IS_ERR(ctx)) 449984193c07STejun Heo return PTR_ERR(ctx); 4500a0111cf6SLai Jiangshan 4501a0111cf6SLai Jiangshan /* the ctx has been prepared successfully, let's commit it */ 4502a0111cf6SLai Jiangshan apply_wqattrs_commit(ctx); 4503a0111cf6SLai Jiangshan apply_wqattrs_cleanup(ctx); 4504a0111cf6SLai Jiangshan 45056201171eSwanghaibin return 0; 4506a0111cf6SLai Jiangshan } 4507a0111cf6SLai Jiangshan 45089e8cd2f5STejun Heo /** 45099e8cd2f5STejun Heo * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue 45109e8cd2f5STejun Heo * @wq: the target workqueue 45119e8cd2f5STejun Heo * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs() 45129e8cd2f5STejun Heo * 4513fef59c9cSTejun Heo * Apply @attrs to an unbound workqueue @wq. Unless disabled, this function maps 4514fef59c9cSTejun Heo * a separate pwq to each CPU pod with possibles CPUs in @attrs->cpumask so that 4515fef59c9cSTejun Heo * work items are affine to the pod it was issued on. Older pwqs are released as 4516fef59c9cSTejun Heo * in-flight work items finish. Note that a work item which repeatedly requeues 4517fef59c9cSTejun Heo * itself back-to-back will stay on its current pwq. 45189e8cd2f5STejun Heo * 4519d185af30SYacine Belkadi * Performs GFP_KERNEL allocations. 4520d185af30SYacine Belkadi * 4521ffd8bea8SSebastian Andrzej Siewior * Assumes caller has CPU hotplug read exclusion, i.e. cpus_read_lock(). 4522509b3204SDaniel Jordan * 4523d185af30SYacine Belkadi * Return: 0 on success and -errno on failure. 45249e8cd2f5STejun Heo */ 4525513c98d0SDaniel Jordan int apply_workqueue_attrs(struct workqueue_struct *wq, 45269e8cd2f5STejun Heo const struct workqueue_attrs *attrs) 45279e8cd2f5STejun Heo { 4528a0111cf6SLai Jiangshan int ret; 45299e8cd2f5STejun Heo 4530509b3204SDaniel Jordan lockdep_assert_cpus_held(); 4531509b3204SDaniel Jordan 4532509b3204SDaniel Jordan mutex_lock(&wq_pool_mutex); 4533a0111cf6SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 4534509b3204SDaniel Jordan mutex_unlock(&wq_pool_mutex); 45352d5f0764SLai Jiangshan 45362d5f0764SLai Jiangshan return ret; 45379e8cd2f5STejun Heo } 45389e8cd2f5STejun Heo 45394c16bd32STejun Heo /** 4540fef59c9cSTejun Heo * wq_update_pod - update pod affinity of a wq for CPU hot[un]plug 45414c16bd32STejun Heo * @wq: the target workqueue 45424cbfd3deSTejun Heo * @cpu: the CPU to update pool association for 45434cbfd3deSTejun Heo * @hotplug_cpu: the CPU coming up or going down 45444c16bd32STejun Heo * @online: whether @cpu is coming up or going down 45454c16bd32STejun Heo * 45464c16bd32STejun Heo * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and 4547fef59c9cSTejun Heo * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update pod affinity of 45484c16bd32STejun Heo * @wq accordingly. 45494c16bd32STejun Heo * 45504c16bd32STejun Heo * 4551fef59c9cSTejun Heo * If pod affinity can't be adjusted due to memory allocation failure, it falls 4552fef59c9cSTejun Heo * back to @wq->dfl_pwq which may not be optimal but is always correct. 4553fef59c9cSTejun Heo * 4554fef59c9cSTejun Heo * Note that when the last allowed CPU of a pod goes offline for a workqueue 4555fef59c9cSTejun Heo * with a cpumask spanning multiple pods, the workers which were already 4556fef59c9cSTejun Heo * executing the work items for the workqueue will lose their CPU affinity and 4557fef59c9cSTejun Heo * may execute on any CPU. This is similar to how per-cpu workqueues behave on 4558fef59c9cSTejun Heo * CPU_DOWN. If a workqueue user wants strict affinity, it's the user's 4559fef59c9cSTejun Heo * responsibility to flush the work item from CPU_DOWN_PREPARE. 45604c16bd32STejun Heo */ 4561fef59c9cSTejun Heo static void wq_update_pod(struct workqueue_struct *wq, int cpu, 45624cbfd3deSTejun Heo int hotplug_cpu, bool online) 45634c16bd32STejun Heo { 45644cbfd3deSTejun Heo int off_cpu = online ? -1 : hotplug_cpu; 45654c16bd32STejun Heo struct pool_workqueue *old_pwq = NULL, *pwq; 45664c16bd32STejun Heo struct workqueue_attrs *target_attrs; 45674c16bd32STejun Heo 45684c16bd32STejun Heo lockdep_assert_held(&wq_pool_mutex); 45694c16bd32STejun Heo 457084193c07STejun Heo if (!(wq->flags & WQ_UNBOUND) || wq->unbound_attrs->ordered) 45714c16bd32STejun Heo return; 45724c16bd32STejun Heo 45734c16bd32STejun Heo /* 45744c16bd32STejun Heo * We don't wanna alloc/free wq_attrs for each wq for each CPU. 45754c16bd32STejun Heo * Let's use a preallocated one. The following buf is protected by 45764c16bd32STejun Heo * CPU hotplug exclusion. 45774c16bd32STejun Heo */ 4578fef59c9cSTejun Heo target_attrs = wq_update_pod_attrs_buf; 45794c16bd32STejun Heo 45804c16bd32STejun Heo copy_workqueue_attrs(target_attrs, wq->unbound_attrs); 45810f36ee24STejun Heo wqattrs_actualize_cpumask(target_attrs, wq_unbound_cpumask); 45824c16bd32STejun Heo 4583636b927eSTejun Heo /* nothing to do if the target cpumask matches the current pwq */ 45849546b29eSTejun Heo wq_calc_pod_cpumask(target_attrs, cpu, off_cpu); 45859f66cff2STejun Heo if (wqattrs_equal(target_attrs, unbound_pwq(wq, cpu)->pool->attrs)) 4586f7142ed4SLai Jiangshan return; 45874c16bd32STejun Heo 45884c16bd32STejun Heo /* create a new pwq */ 45894c16bd32STejun Heo pwq = alloc_unbound_pwq(wq, target_attrs); 45904c16bd32STejun Heo if (!pwq) { 4591fef59c9cSTejun Heo pr_warn("workqueue: allocation failed while updating CPU pod affinity of \"%s\"\n", 45924c16bd32STejun Heo wq->name); 459377f300b1SDaeseok Youn goto use_dfl_pwq; 45944c16bd32STejun Heo } 45954c16bd32STejun Heo 4596f7142ed4SLai Jiangshan /* Install the new pwq. */ 45974c16bd32STejun Heo mutex_lock(&wq->mutex); 4598636b927eSTejun Heo old_pwq = install_unbound_pwq(wq, cpu, pwq); 45994c16bd32STejun Heo goto out_unlock; 46004c16bd32STejun Heo 46014c16bd32STejun Heo use_dfl_pwq: 4602f7142ed4SLai Jiangshan mutex_lock(&wq->mutex); 46039f66cff2STejun Heo pwq = unbound_pwq(wq, -1); 46049f66cff2STejun Heo raw_spin_lock_irq(&pwq->pool->lock); 46059f66cff2STejun Heo get_pwq(pwq); 46069f66cff2STejun Heo raw_spin_unlock_irq(&pwq->pool->lock); 46079f66cff2STejun Heo old_pwq = install_unbound_pwq(wq, cpu, pwq); 46084c16bd32STejun Heo out_unlock: 46094c16bd32STejun Heo mutex_unlock(&wq->mutex); 46104c16bd32STejun Heo put_pwq_unlocked(old_pwq); 46114c16bd32STejun Heo } 46124c16bd32STejun Heo 461330cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq) 46141da177e4SLinus Torvalds { 461549e3cf44STejun Heo bool highpri = wq->flags & WQ_HIGHPRI; 46168a2b7538STejun Heo int cpu, ret; 4617e1d8aa9fSFrederic Weisbecker 4618687a9aa5STejun Heo wq->cpu_pwq = alloc_percpu(struct pool_workqueue *); 4619ee1ceef7STejun Heo if (!wq->cpu_pwq) 4620687a9aa5STejun Heo goto enomem; 462130cdf249STejun Heo 4622636b927eSTejun Heo if (!(wq->flags & WQ_UNBOUND)) { 462330cdf249STejun Heo for_each_possible_cpu(cpu) { 4624687a9aa5STejun Heo struct pool_workqueue **pwq_p = 4625ee1ceef7STejun Heo per_cpu_ptr(wq->cpu_pwq, cpu); 4626687a9aa5STejun Heo struct worker_pool *pool = 4627687a9aa5STejun Heo &(per_cpu_ptr(cpu_worker_pools, cpu)[highpri]); 462830cdf249STejun Heo 4629687a9aa5STejun Heo *pwq_p = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, 4630687a9aa5STejun Heo pool->node); 4631687a9aa5STejun Heo if (!*pwq_p) 4632687a9aa5STejun Heo goto enomem; 4633687a9aa5STejun Heo 4634687a9aa5STejun Heo init_pwq(*pwq_p, wq, pool); 4635f147f29eSTejun Heo 4636f147f29eSTejun Heo mutex_lock(&wq->mutex); 4637687a9aa5STejun Heo link_pwq(*pwq_p); 4638f147f29eSTejun Heo mutex_unlock(&wq->mutex); 463930cdf249STejun Heo } 464030cdf249STejun Heo return 0; 4641509b3204SDaniel Jordan } 4642509b3204SDaniel Jordan 4643ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 4644509b3204SDaniel Jordan if (wq->flags & __WQ_ORDERED) { 46459f66cff2STejun Heo struct pool_workqueue *dfl_pwq; 46469f66cff2STejun Heo 46478a2b7538STejun Heo ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]); 46488a2b7538STejun Heo /* there should only be single pwq for ordering guarantee */ 46499f66cff2STejun Heo dfl_pwq = rcu_access_pointer(wq->dfl_pwq); 46509f66cff2STejun Heo WARN(!ret && (wq->pwqs.next != &dfl_pwq->pwqs_node || 46519f66cff2STejun Heo wq->pwqs.prev != &dfl_pwq->pwqs_node), 46528a2b7538STejun Heo "ordering guarantee broken for workqueue %s\n", wq->name); 46539e8cd2f5STejun Heo } else { 4654509b3204SDaniel Jordan ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]); 46559e8cd2f5STejun Heo } 4656ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 4657509b3204SDaniel Jordan 465864344553SZqiang /* for unbound pwq, flush the pwq_release_worker ensures that the 465964344553SZqiang * pwq_release_workfn() completes before calling kfree(wq). 466064344553SZqiang */ 466164344553SZqiang if (ret) 466264344553SZqiang kthread_flush_worker(pwq_release_worker); 466364344553SZqiang 4664509b3204SDaniel Jordan return ret; 4665687a9aa5STejun Heo 4666687a9aa5STejun Heo enomem: 4667687a9aa5STejun Heo if (wq->cpu_pwq) { 46687b42f401SZqiang for_each_possible_cpu(cpu) { 46697b42f401SZqiang struct pool_workqueue *pwq = *per_cpu_ptr(wq->cpu_pwq, cpu); 46707b42f401SZqiang 46717b42f401SZqiang if (pwq) 46727b42f401SZqiang kmem_cache_free(pwq_cache, pwq); 46737b42f401SZqiang } 4674687a9aa5STejun Heo free_percpu(wq->cpu_pwq); 4675687a9aa5STejun Heo wq->cpu_pwq = NULL; 4676687a9aa5STejun Heo } 4677687a9aa5STejun Heo return -ENOMEM; 46780f900049STejun Heo } 46790f900049STejun Heo 4680f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags, 4681f3421797STejun Heo const char *name) 4682b71ab8c2STejun Heo { 4683636b927eSTejun Heo if (max_active < 1 || max_active > WQ_MAX_ACTIVE) 4684044c782cSValentin Ilie pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n", 4685636b927eSTejun Heo max_active, name, 1, WQ_MAX_ACTIVE); 4686b71ab8c2STejun Heo 4687636b927eSTejun Heo return clamp_val(max_active, 1, WQ_MAX_ACTIVE); 4688b71ab8c2STejun Heo } 4689b71ab8c2STejun Heo 4690983c7515STejun Heo /* 4691983c7515STejun Heo * Workqueues which may be used during memory reclaim should have a rescuer 4692983c7515STejun Heo * to guarantee forward progress. 4693983c7515STejun Heo */ 4694983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq) 4695983c7515STejun Heo { 4696983c7515STejun Heo struct worker *rescuer; 4697b92b36eaSDan Carpenter int ret; 4698983c7515STejun Heo 4699983c7515STejun Heo if (!(wq->flags & WQ_MEM_RECLAIM)) 4700983c7515STejun Heo return 0; 4701983c7515STejun Heo 4702983c7515STejun Heo rescuer = alloc_worker(NUMA_NO_NODE); 47034c0736a7SPetr Mladek if (!rescuer) { 47044c0736a7SPetr Mladek pr_err("workqueue: Failed to allocate a rescuer for wq \"%s\"\n", 47054c0736a7SPetr Mladek wq->name); 4706983c7515STejun Heo return -ENOMEM; 47074c0736a7SPetr Mladek } 4708983c7515STejun Heo 4709983c7515STejun Heo rescuer->rescue_wq = wq; 4710b6a46f72SAaron Tomlin rescuer->task = kthread_create(rescuer_thread, rescuer, "kworker/R-%s", wq->name); 4711f187b697SSean Fu if (IS_ERR(rescuer->task)) { 4712b92b36eaSDan Carpenter ret = PTR_ERR(rescuer->task); 47134c0736a7SPetr Mladek pr_err("workqueue: Failed to create a rescuer kthread for wq \"%s\": %pe", 47144c0736a7SPetr Mladek wq->name, ERR_PTR(ret)); 4715983c7515STejun Heo kfree(rescuer); 4716b92b36eaSDan Carpenter return ret; 4717983c7515STejun Heo } 4718983c7515STejun Heo 4719983c7515STejun Heo wq->rescuer = rescuer; 472085f0ab43SJuri Lelli if (wq->flags & WQ_UNBOUND) 472185f0ab43SJuri Lelli kthread_bind_mask(rescuer->task, wq->unbound_attrs->cpumask); 472285f0ab43SJuri Lelli else 4723983c7515STejun Heo kthread_bind_mask(rescuer->task, cpu_possible_mask); 4724983c7515STejun Heo wake_up_process(rescuer->task); 4725983c7515STejun Heo 4726983c7515STejun Heo return 0; 4727983c7515STejun Heo } 4728983c7515STejun Heo 4729a045a272STejun Heo /** 4730a045a272STejun Heo * wq_adjust_max_active - update a wq's max_active to the current setting 4731a045a272STejun Heo * @wq: target workqueue 4732a045a272STejun Heo * 4733a045a272STejun Heo * If @wq isn't freezing, set @wq->max_active to the saved_max_active and 4734a045a272STejun Heo * activate inactive work items accordingly. If @wq is freezing, clear 4735a045a272STejun Heo * @wq->max_active to zero. 4736a045a272STejun Heo */ 4737a045a272STejun Heo static void wq_adjust_max_active(struct workqueue_struct *wq) 4738a045a272STejun Heo { 4739c5404d4eSTejun Heo bool activated; 4740a045a272STejun Heo 4741a045a272STejun Heo lockdep_assert_held(&wq->mutex); 4742a045a272STejun Heo 4743a045a272STejun Heo if ((wq->flags & WQ_FREEZABLE) && workqueue_freezing) { 4744a045a272STejun Heo WRITE_ONCE(wq->max_active, 0); 4745a045a272STejun Heo return; 4746a045a272STejun Heo } 4747a045a272STejun Heo 4748a045a272STejun Heo if (wq->max_active == wq->saved_max_active) 4749a045a272STejun Heo return; 4750a045a272STejun Heo 4751a045a272STejun Heo /* 4752a045a272STejun Heo * Update @wq->max_active and then kick inactive work items if more 4753a045a272STejun Heo * active work items are allowed. This doesn't break work item ordering 4754a045a272STejun Heo * because new work items are always queued behind existing inactive 4755a045a272STejun Heo * work items if there are any. 4756a045a272STejun Heo */ 4757a045a272STejun Heo WRITE_ONCE(wq->max_active, wq->saved_max_active); 4758a045a272STejun Heo 4759c5404d4eSTejun Heo /* 4760c5404d4eSTejun Heo * Round-robin through pwq's activating the first inactive work item 4761c5404d4eSTejun Heo * until max_active is filled. 4762c5404d4eSTejun Heo */ 4763c5404d4eSTejun Heo do { 4764c5404d4eSTejun Heo struct pool_workqueue *pwq; 4765c5404d4eSTejun Heo 4766c5404d4eSTejun Heo activated = false; 4767a045a272STejun Heo for_each_pwq(pwq, wq) { 4768a045a272STejun Heo unsigned long flags; 4769a045a272STejun Heo 4770c5404d4eSTejun Heo /* can be called during early boot w/ irq disabled */ 4771a045a272STejun Heo raw_spin_lock_irqsave(&pwq->pool->lock, flags); 4772c5404d4eSTejun Heo if (pwq_activate_first_inactive(pwq)) { 4773c5404d4eSTejun Heo activated = true; 4774a045a272STejun Heo kick_pool(pwq->pool); 4775c5404d4eSTejun Heo } 4776a045a272STejun Heo raw_spin_unlock_irqrestore(&pwq->pool->lock, flags); 4777a045a272STejun Heo } 4778c5404d4eSTejun Heo } while (activated); 4779a045a272STejun Heo } 4780a045a272STejun Heo 4781a2775bbcSMathieu Malaterre __printf(1, 4) 4782669de8bdSBart Van Assche struct workqueue_struct *alloc_workqueue(const char *fmt, 478397e37d7bSTejun Heo unsigned int flags, 4784669de8bdSBart Van Assche int max_active, ...) 47853af24433SOleg Nesterov { 4786ecf6881fSTejun Heo va_list args; 47873af24433SOleg Nesterov struct workqueue_struct *wq; 478831c89007SAudra Mitchell int len; 4789b196be89STejun Heo 47905c0338c6STejun Heo /* 4791fef59c9cSTejun Heo * Unbound && max_active == 1 used to imply ordered, which is no longer 4792fef59c9cSTejun Heo * the case on many machines due to per-pod pools. While 47935c0338c6STejun Heo * alloc_ordered_workqueue() is the right way to create an ordered 4794fef59c9cSTejun Heo * workqueue, keep the previous behavior to avoid subtle breakages. 47955c0338c6STejun Heo */ 47965c0338c6STejun Heo if ((flags & WQ_UNBOUND) && max_active == 1) 47975c0338c6STejun Heo flags |= __WQ_ORDERED; 47985c0338c6STejun Heo 4799cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */ 4800cee22a15SViresh Kumar if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient) 4801cee22a15SViresh Kumar flags |= WQ_UNBOUND; 4802cee22a15SViresh Kumar 4803ecf6881fSTejun Heo /* allocate wq and format name */ 4804636b927eSTejun Heo wq = kzalloc(sizeof(*wq), GFP_KERNEL); 4805b196be89STejun Heo if (!wq) 4806d2c1d404STejun Heo return NULL; 4807b196be89STejun Heo 48086029a918STejun Heo if (flags & WQ_UNBOUND) { 4809be69d00dSThomas Gleixner wq->unbound_attrs = alloc_workqueue_attrs(); 48106029a918STejun Heo if (!wq->unbound_attrs) 48116029a918STejun Heo goto err_free_wq; 48126029a918STejun Heo } 48136029a918STejun Heo 4814669de8bdSBart Van Assche va_start(args, max_active); 481531c89007SAudra Mitchell len = vsnprintf(wq->name, sizeof(wq->name), fmt, args); 4816b196be89STejun Heo va_end(args); 48173af24433SOleg Nesterov 481831c89007SAudra Mitchell if (len >= WQ_NAME_LEN) 481931c89007SAudra Mitchell pr_warn_once("workqueue: name exceeds WQ_NAME_LEN. Truncating to: %s\n", wq->name); 482031c89007SAudra Mitchell 4821d320c038STejun Heo max_active = max_active ?: WQ_DFL_ACTIVE; 4822b196be89STejun Heo max_active = wq_clamp_max_active(max_active, flags, wq->name); 48233af24433SOleg Nesterov 4824b196be89STejun Heo /* init wq */ 482597e37d7bSTejun Heo wq->flags = flags; 4826a045a272STejun Heo wq->max_active = max_active; 4827a0a1a5fdSTejun Heo wq->saved_max_active = max_active; 48283c25a55dSLai Jiangshan mutex_init(&wq->mutex); 4829112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 0); 483030cdf249STejun Heo INIT_LIST_HEAD(&wq->pwqs); 483173f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_queue); 483273f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_overflow); 4833493a1724STejun Heo INIT_LIST_HEAD(&wq->maydays); 48343af24433SOleg Nesterov 4835669de8bdSBart Van Assche wq_init_lockdep(wq); 4836cce1a165SOleg Nesterov INIT_LIST_HEAD(&wq->list); 48373af24433SOleg Nesterov 483830cdf249STejun Heo if (alloc_and_link_pwqs(wq) < 0) 483982efcab3SBart Van Assche goto err_unreg_lockdep; 48401537663fSTejun Heo 484140c17f75STejun Heo if (wq_online && init_rescuer(wq) < 0) 4842d2c1d404STejun Heo goto err_destroy; 4843e22bee78STejun Heo 4844226223abSTejun Heo if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq)) 4845226223abSTejun Heo goto err_destroy; 4846226223abSTejun Heo 48476af8bf3dSOleg Nesterov /* 484868e13a67SLai Jiangshan * wq_pool_mutex protects global freeze state and workqueues list. 484968e13a67SLai Jiangshan * Grab it, adjust max_active and add the new @wq to workqueues 485068e13a67SLai Jiangshan * list. 48516af8bf3dSOleg Nesterov */ 485268e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 4853a0a1a5fdSTejun Heo 4854a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 4855a045a272STejun Heo wq_adjust_max_active(wq); 4856a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 4857a0a1a5fdSTejun Heo 4858e2dca7adSTejun Heo list_add_tail_rcu(&wq->list, &workqueues); 4859a0a1a5fdSTejun Heo 486068e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 48613af24433SOleg Nesterov 48623af24433SOleg Nesterov return wq; 4863d2c1d404STejun Heo 486482efcab3SBart Van Assche err_unreg_lockdep: 4865009bb421SBart Van Assche wq_unregister_lockdep(wq); 4866009bb421SBart Van Assche wq_free_lockdep(wq); 486782efcab3SBart Van Assche err_free_wq: 48686029a918STejun Heo free_workqueue_attrs(wq->unbound_attrs); 48694690c4abSTejun Heo kfree(wq); 4870d2c1d404STejun Heo return NULL; 4871d2c1d404STejun Heo err_destroy: 4872d2c1d404STejun Heo destroy_workqueue(wq); 48734690c4abSTejun Heo return NULL; 48741da177e4SLinus Torvalds } 4875669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue); 48761da177e4SLinus Torvalds 4877c29eb853STejun Heo static bool pwq_busy(struct pool_workqueue *pwq) 4878c29eb853STejun Heo { 4879c29eb853STejun Heo int i; 4880c29eb853STejun Heo 4881c29eb853STejun Heo for (i = 0; i < WORK_NR_COLORS; i++) 4882c29eb853STejun Heo if (pwq->nr_in_flight[i]) 4883c29eb853STejun Heo return true; 4884c29eb853STejun Heo 48859f66cff2STejun Heo if ((pwq != rcu_access_pointer(pwq->wq->dfl_pwq)) && (pwq->refcnt > 1)) 4886c29eb853STejun Heo return true; 4887afa87ce8STejun Heo if (!pwq_is_empty(pwq)) 4888c29eb853STejun Heo return true; 4889c29eb853STejun Heo 4890c29eb853STejun Heo return false; 4891c29eb853STejun Heo } 4892c29eb853STejun Heo 48933af24433SOleg Nesterov /** 48943af24433SOleg Nesterov * destroy_workqueue - safely terminate a workqueue 48953af24433SOleg Nesterov * @wq: target workqueue 48963af24433SOleg Nesterov * 48973af24433SOleg Nesterov * Safely destroy a workqueue. All work currently pending will be done first. 48983af24433SOleg Nesterov */ 48993af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq) 49003af24433SOleg Nesterov { 490149e3cf44STejun Heo struct pool_workqueue *pwq; 4902636b927eSTejun Heo int cpu; 49033af24433SOleg Nesterov 4904def98c84STejun Heo /* 4905def98c84STejun Heo * Remove it from sysfs first so that sanity check failure doesn't 4906def98c84STejun Heo * lead to sysfs name conflicts. 4907def98c84STejun Heo */ 4908def98c84STejun Heo workqueue_sysfs_unregister(wq); 4909def98c84STejun Heo 491033e3f0a3SRichard Clark /* mark the workqueue destruction is in progress */ 491133e3f0a3SRichard Clark mutex_lock(&wq->mutex); 491233e3f0a3SRichard Clark wq->flags |= __WQ_DESTROYING; 491333e3f0a3SRichard Clark mutex_unlock(&wq->mutex); 491433e3f0a3SRichard Clark 49159c5a2ba7STejun Heo /* drain it before proceeding with destruction */ 49169c5a2ba7STejun Heo drain_workqueue(wq); 4917c8efcc25STejun Heo 4918def98c84STejun Heo /* kill rescuer, if sanity checks fail, leave it w/o rescuer */ 4919def98c84STejun Heo if (wq->rescuer) { 4920def98c84STejun Heo struct worker *rescuer = wq->rescuer; 4921def98c84STejun Heo 4922def98c84STejun Heo /* this prevents new queueing */ 4923a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 4924def98c84STejun Heo wq->rescuer = NULL; 4925a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 4926def98c84STejun Heo 4927def98c84STejun Heo /* rescuer will empty maydays list before exiting */ 4928def98c84STejun Heo kthread_stop(rescuer->task); 49298efe1223STejun Heo kfree(rescuer); 4930def98c84STejun Heo } 4931def98c84STejun Heo 4932c29eb853STejun Heo /* 4933c29eb853STejun Heo * Sanity checks - grab all the locks so that we wait for all 4934c29eb853STejun Heo * in-flight operations which may do put_pwq(). 4935c29eb853STejun Heo */ 4936c29eb853STejun Heo mutex_lock(&wq_pool_mutex); 4937b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 493849e3cf44STejun Heo for_each_pwq(pwq, wq) { 4939a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 4940c29eb853STejun Heo if (WARN_ON(pwq_busy(pwq))) { 49411d9a6159SKefeng Wang pr_warn("%s: %s has the following busy pwq\n", 4942e66b39afSTejun Heo __func__, wq->name); 4943c29eb853STejun Heo show_pwq(pwq); 4944a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 4945b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 4946c29eb853STejun Heo mutex_unlock(&wq_pool_mutex); 494755df0933SImran Khan show_one_workqueue(wq); 49486183c009STejun Heo return; 494976af4d93STejun Heo } 4950a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 495176af4d93STejun Heo } 4952b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 49536183c009STejun Heo 4954a0a1a5fdSTejun Heo /* 4955a0a1a5fdSTejun Heo * wq list is used to freeze wq, remove from list after 4956a0a1a5fdSTejun Heo * flushing is complete in case freeze races us. 4957a0a1a5fdSTejun Heo */ 4958e2dca7adSTejun Heo list_del_rcu(&wq->list); 495968e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 49603af24433SOleg Nesterov 49618864b4e5STejun Heo /* 4962636b927eSTejun Heo * We're the sole accessor of @wq. Directly access cpu_pwq and dfl_pwq 4963636b927eSTejun Heo * to put the base refs. @wq will be auto-destroyed from the last 4964636b927eSTejun Heo * pwq_put. RCU read lock prevents @wq from going away from under us. 49658864b4e5STejun Heo */ 4966636b927eSTejun Heo rcu_read_lock(); 4967636b927eSTejun Heo 4968636b927eSTejun Heo for_each_possible_cpu(cpu) { 49699f66cff2STejun Heo put_pwq_unlocked(unbound_pwq(wq, cpu)); 49709f66cff2STejun Heo RCU_INIT_POINTER(*unbound_pwq_slot(wq, cpu), NULL); 49714c16bd32STejun Heo } 49724c16bd32STejun Heo 49739f66cff2STejun Heo put_pwq_unlocked(unbound_pwq(wq, -1)); 49749f66cff2STejun Heo RCU_INIT_POINTER(*unbound_pwq_slot(wq, -1), NULL); 4975636b927eSTejun Heo 4976636b927eSTejun Heo rcu_read_unlock(); 49773af24433SOleg Nesterov } 49783af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue); 49793af24433SOleg Nesterov 4980dcd989cbSTejun Heo /** 4981dcd989cbSTejun Heo * workqueue_set_max_active - adjust max_active of a workqueue 4982dcd989cbSTejun Heo * @wq: target workqueue 4983dcd989cbSTejun Heo * @max_active: new max_active value. 4984dcd989cbSTejun Heo * 4985dcd989cbSTejun Heo * Set max_active of @wq to @max_active. 4986dcd989cbSTejun Heo * 4987dcd989cbSTejun Heo * CONTEXT: 4988dcd989cbSTejun Heo * Don't call from IRQ context. 4989dcd989cbSTejun Heo */ 4990dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) 4991dcd989cbSTejun Heo { 49928719dceaSTejun Heo /* disallow meddling with max_active for ordered workqueues */ 49930a94efb5STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) 49948719dceaSTejun Heo return; 49958719dceaSTejun Heo 4996f3421797STejun Heo max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); 4997dcd989cbSTejun Heo 4998a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 4999dcd989cbSTejun Heo 50000a94efb5STejun Heo wq->flags &= ~__WQ_ORDERED; 5001dcd989cbSTejun Heo wq->saved_max_active = max_active; 5002a045a272STejun Heo wq_adjust_max_active(wq); 5003dcd989cbSTejun Heo 5004a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 5005dcd989cbSTejun Heo } 5006dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active); 5007dcd989cbSTejun Heo 5008dcd989cbSTejun Heo /** 500927d4ee03SLukas Wunner * current_work - retrieve %current task's work struct 501027d4ee03SLukas Wunner * 501127d4ee03SLukas Wunner * Determine if %current task is a workqueue worker and what it's working on. 501227d4ee03SLukas Wunner * Useful to find out the context that the %current task is running in. 501327d4ee03SLukas Wunner * 501427d4ee03SLukas Wunner * Return: work struct if %current task is a workqueue worker, %NULL otherwise. 501527d4ee03SLukas Wunner */ 501627d4ee03SLukas Wunner struct work_struct *current_work(void) 501727d4ee03SLukas Wunner { 501827d4ee03SLukas Wunner struct worker *worker = current_wq_worker(); 501927d4ee03SLukas Wunner 502027d4ee03SLukas Wunner return worker ? worker->current_work : NULL; 502127d4ee03SLukas Wunner } 502227d4ee03SLukas Wunner EXPORT_SYMBOL(current_work); 502327d4ee03SLukas Wunner 502427d4ee03SLukas Wunner /** 5025e6267616STejun Heo * current_is_workqueue_rescuer - is %current workqueue rescuer? 5026e6267616STejun Heo * 5027e6267616STejun Heo * Determine whether %current is a workqueue rescuer. Can be used from 5028e6267616STejun Heo * work functions to determine whether it's being run off the rescuer task. 5029d185af30SYacine Belkadi * 5030d185af30SYacine Belkadi * Return: %true if %current is a workqueue rescuer. %false otherwise. 5031e6267616STejun Heo */ 5032e6267616STejun Heo bool current_is_workqueue_rescuer(void) 5033e6267616STejun Heo { 5034e6267616STejun Heo struct worker *worker = current_wq_worker(); 5035e6267616STejun Heo 50366a092dfdSLai Jiangshan return worker && worker->rescue_wq; 5037e6267616STejun Heo } 5038e6267616STejun Heo 5039e6267616STejun Heo /** 5040dcd989cbSTejun Heo * workqueue_congested - test whether a workqueue is congested 5041dcd989cbSTejun Heo * @cpu: CPU in question 5042dcd989cbSTejun Heo * @wq: target workqueue 5043dcd989cbSTejun Heo * 5044dcd989cbSTejun Heo * Test whether @wq's cpu workqueue for @cpu is congested. There is 5045dcd989cbSTejun Heo * no synchronization around this function and the test result is 5046dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 5047dcd989cbSTejun Heo * 5048d3251859STejun Heo * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU. 5049636b927eSTejun Heo * 5050636b927eSTejun Heo * With the exception of ordered workqueues, all workqueues have per-cpu 5051636b927eSTejun Heo * pool_workqueues, each with its own congested state. A workqueue being 5052636b927eSTejun Heo * congested on one CPU doesn't mean that the workqueue is contested on any 5053636b927eSTejun Heo * other CPUs. 5054d3251859STejun Heo * 5055d185af30SYacine Belkadi * Return: 5056dcd989cbSTejun Heo * %true if congested, %false otherwise. 5057dcd989cbSTejun Heo */ 5058d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq) 5059dcd989cbSTejun Heo { 50607fb98ea7STejun Heo struct pool_workqueue *pwq; 506176af4d93STejun Heo bool ret; 506276af4d93STejun Heo 506324acfb71SThomas Gleixner rcu_read_lock(); 506424acfb71SThomas Gleixner preempt_disable(); 50657fb98ea7STejun Heo 5066d3251859STejun Heo if (cpu == WORK_CPU_UNBOUND) 5067d3251859STejun Heo cpu = smp_processor_id(); 5068d3251859STejun Heo 5069687a9aa5STejun Heo pwq = *per_cpu_ptr(wq->cpu_pwq, cpu); 5070f97a4a1aSLai Jiangshan ret = !list_empty(&pwq->inactive_works); 5071636b927eSTejun Heo 507224acfb71SThomas Gleixner preempt_enable(); 507324acfb71SThomas Gleixner rcu_read_unlock(); 507476af4d93STejun Heo 507576af4d93STejun Heo return ret; 5076dcd989cbSTejun Heo } 5077dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested); 5078dcd989cbSTejun Heo 5079dcd989cbSTejun Heo /** 5080dcd989cbSTejun Heo * work_busy - test whether a work is currently pending or running 5081dcd989cbSTejun Heo * @work: the work to be tested 5082dcd989cbSTejun Heo * 5083dcd989cbSTejun Heo * Test whether @work is currently pending or running. There is no 5084dcd989cbSTejun Heo * synchronization around this function and the test result is 5085dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 5086dcd989cbSTejun Heo * 5087d185af30SYacine Belkadi * Return: 5088dcd989cbSTejun Heo * OR'd bitmask of WORK_BUSY_* bits. 5089dcd989cbSTejun Heo */ 5090dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work) 5091dcd989cbSTejun Heo { 5092fa1b54e6STejun Heo struct worker_pool *pool; 5093dcd989cbSTejun Heo unsigned long flags; 5094dcd989cbSTejun Heo unsigned int ret = 0; 5095dcd989cbSTejun Heo 5096dcd989cbSTejun Heo if (work_pending(work)) 5097dcd989cbSTejun Heo ret |= WORK_BUSY_PENDING; 5098038366c5SLai Jiangshan 509924acfb71SThomas Gleixner rcu_read_lock(); 5100fa1b54e6STejun Heo pool = get_work_pool(work); 5101038366c5SLai Jiangshan if (pool) { 5102a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irqsave(&pool->lock, flags); 5103c9e7cf27STejun Heo if (find_worker_executing_work(pool, work)) 5104dcd989cbSTejun Heo ret |= WORK_BUSY_RUNNING; 5105a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irqrestore(&pool->lock, flags); 5106038366c5SLai Jiangshan } 510724acfb71SThomas Gleixner rcu_read_unlock(); 5108dcd989cbSTejun Heo 5109dcd989cbSTejun Heo return ret; 5110dcd989cbSTejun Heo } 5111dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy); 5112dcd989cbSTejun Heo 51133d1cb205STejun Heo /** 51143d1cb205STejun Heo * set_worker_desc - set description for the current work item 51153d1cb205STejun Heo * @fmt: printf-style format string 51163d1cb205STejun Heo * @...: arguments for the format string 51173d1cb205STejun Heo * 51183d1cb205STejun Heo * This function can be called by a running work function to describe what 51193d1cb205STejun Heo * the work item is about. If the worker task gets dumped, this 51203d1cb205STejun Heo * information will be printed out together to help debugging. The 51213d1cb205STejun Heo * description can be at most WORKER_DESC_LEN including the trailing '\0'. 51223d1cb205STejun Heo */ 51233d1cb205STejun Heo void set_worker_desc(const char *fmt, ...) 51243d1cb205STejun Heo { 51253d1cb205STejun Heo struct worker *worker = current_wq_worker(); 51263d1cb205STejun Heo va_list args; 51273d1cb205STejun Heo 51283d1cb205STejun Heo if (worker) { 51293d1cb205STejun Heo va_start(args, fmt); 51303d1cb205STejun Heo vsnprintf(worker->desc, sizeof(worker->desc), fmt, args); 51313d1cb205STejun Heo va_end(args); 51323d1cb205STejun Heo } 51333d1cb205STejun Heo } 51345c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc); 51353d1cb205STejun Heo 51363d1cb205STejun Heo /** 51373d1cb205STejun Heo * print_worker_info - print out worker information and description 51383d1cb205STejun Heo * @log_lvl: the log level to use when printing 51393d1cb205STejun Heo * @task: target task 51403d1cb205STejun Heo * 51413d1cb205STejun Heo * If @task is a worker and currently executing a work item, print out the 51423d1cb205STejun Heo * name of the workqueue being serviced and worker description set with 51433d1cb205STejun Heo * set_worker_desc() by the currently executing work item. 51443d1cb205STejun Heo * 51453d1cb205STejun Heo * This function can be safely called on any task as long as the 51463d1cb205STejun Heo * task_struct itself is accessible. While safe, this function isn't 51473d1cb205STejun Heo * synchronized and may print out mixups or garbages of limited length. 51483d1cb205STejun Heo */ 51493d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task) 51503d1cb205STejun Heo { 51513d1cb205STejun Heo work_func_t *fn = NULL; 51523d1cb205STejun Heo char name[WQ_NAME_LEN] = { }; 51533d1cb205STejun Heo char desc[WORKER_DESC_LEN] = { }; 51543d1cb205STejun Heo struct pool_workqueue *pwq = NULL; 51553d1cb205STejun Heo struct workqueue_struct *wq = NULL; 51563d1cb205STejun Heo struct worker *worker; 51573d1cb205STejun Heo 51583d1cb205STejun Heo if (!(task->flags & PF_WQ_WORKER)) 51593d1cb205STejun Heo return; 51603d1cb205STejun Heo 51613d1cb205STejun Heo /* 51623d1cb205STejun Heo * This function is called without any synchronization and @task 51633d1cb205STejun Heo * could be in any state. Be careful with dereferences. 51643d1cb205STejun Heo */ 5165e700591aSPetr Mladek worker = kthread_probe_data(task); 51663d1cb205STejun Heo 51673d1cb205STejun Heo /* 51688bf89593STejun Heo * Carefully copy the associated workqueue's workfn, name and desc. 51698bf89593STejun Heo * Keep the original last '\0' in case the original is garbage. 51703d1cb205STejun Heo */ 5171fe557319SChristoph Hellwig copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn)); 5172fe557319SChristoph Hellwig copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq)); 5173fe557319SChristoph Hellwig copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq)); 5174fe557319SChristoph Hellwig copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1); 5175fe557319SChristoph Hellwig copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1); 51763d1cb205STejun Heo 51773d1cb205STejun Heo if (fn || name[0] || desc[0]) { 5178d75f773cSSakari Ailus printk("%sWorkqueue: %s %ps", log_lvl, name, fn); 51798bf89593STejun Heo if (strcmp(name, desc)) 51803d1cb205STejun Heo pr_cont(" (%s)", desc); 51813d1cb205STejun Heo pr_cont("\n"); 51823d1cb205STejun Heo } 51833d1cb205STejun Heo } 51843d1cb205STejun Heo 51853494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool) 51863494fc30STejun Heo { 51873494fc30STejun Heo pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask); 51883494fc30STejun Heo if (pool->node != NUMA_NO_NODE) 51893494fc30STejun Heo pr_cont(" node=%d", pool->node); 51903494fc30STejun Heo pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice); 51913494fc30STejun Heo } 51923494fc30STejun Heo 5193c76feb0dSPaul E. McKenney struct pr_cont_work_struct { 5194c76feb0dSPaul E. McKenney bool comma; 5195c76feb0dSPaul E. McKenney work_func_t func; 5196c76feb0dSPaul E. McKenney long ctr; 5197c76feb0dSPaul E. McKenney }; 5198c76feb0dSPaul E. McKenney 5199c76feb0dSPaul E. McKenney static void pr_cont_work_flush(bool comma, work_func_t func, struct pr_cont_work_struct *pcwsp) 5200c76feb0dSPaul E. McKenney { 5201c76feb0dSPaul E. McKenney if (!pcwsp->ctr) 5202c76feb0dSPaul E. McKenney goto out_record; 5203c76feb0dSPaul E. McKenney if (func == pcwsp->func) { 5204c76feb0dSPaul E. McKenney pcwsp->ctr++; 5205c76feb0dSPaul E. McKenney return; 5206c76feb0dSPaul E. McKenney } 5207c76feb0dSPaul E. McKenney if (pcwsp->ctr == 1) 5208c76feb0dSPaul E. McKenney pr_cont("%s %ps", pcwsp->comma ? "," : "", pcwsp->func); 5209c76feb0dSPaul E. McKenney else 5210c76feb0dSPaul E. McKenney pr_cont("%s %ld*%ps", pcwsp->comma ? "," : "", pcwsp->ctr, pcwsp->func); 5211c76feb0dSPaul E. McKenney pcwsp->ctr = 0; 5212c76feb0dSPaul E. McKenney out_record: 5213c76feb0dSPaul E. McKenney if ((long)func == -1L) 5214c76feb0dSPaul E. McKenney return; 5215c76feb0dSPaul E. McKenney pcwsp->comma = comma; 5216c76feb0dSPaul E. McKenney pcwsp->func = func; 5217c76feb0dSPaul E. McKenney pcwsp->ctr = 1; 5218c76feb0dSPaul E. McKenney } 5219c76feb0dSPaul E. McKenney 5220c76feb0dSPaul E. McKenney static void pr_cont_work(bool comma, struct work_struct *work, struct pr_cont_work_struct *pcwsp) 52213494fc30STejun Heo { 52223494fc30STejun Heo if (work->func == wq_barrier_func) { 52233494fc30STejun Heo struct wq_barrier *barr; 52243494fc30STejun Heo 52253494fc30STejun Heo barr = container_of(work, struct wq_barrier, work); 52263494fc30STejun Heo 5227c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1, pcwsp); 52283494fc30STejun Heo pr_cont("%s BAR(%d)", comma ? "," : "", 52293494fc30STejun Heo task_pid_nr(barr->task)); 52303494fc30STejun Heo } else { 5231c76feb0dSPaul E. McKenney if (!comma) 5232c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1, pcwsp); 5233c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, work->func, pcwsp); 52343494fc30STejun Heo } 52353494fc30STejun Heo } 52363494fc30STejun Heo 52373494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq) 52383494fc30STejun Heo { 5239c76feb0dSPaul E. McKenney struct pr_cont_work_struct pcws = { .ctr = 0, }; 52403494fc30STejun Heo struct worker_pool *pool = pwq->pool; 52413494fc30STejun Heo struct work_struct *work; 52423494fc30STejun Heo struct worker *worker; 52433494fc30STejun Heo bool has_in_flight = false, has_pending = false; 52443494fc30STejun Heo int bkt; 52453494fc30STejun Heo 52463494fc30STejun Heo pr_info(" pwq %d:", pool->id); 52473494fc30STejun Heo pr_cont_pool_info(pool); 52483494fc30STejun Heo 5249a045a272STejun Heo pr_cont(" active=%d refcnt=%d%s\n", 5250a045a272STejun Heo pwq->nr_active, pwq->refcnt, 52513494fc30STejun Heo !list_empty(&pwq->mayday_node) ? " MAYDAY" : ""); 52523494fc30STejun Heo 52533494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 52543494fc30STejun Heo if (worker->current_pwq == pwq) { 52553494fc30STejun Heo has_in_flight = true; 52563494fc30STejun Heo break; 52573494fc30STejun Heo } 52583494fc30STejun Heo } 52593494fc30STejun Heo if (has_in_flight) { 52603494fc30STejun Heo bool comma = false; 52613494fc30STejun Heo 52623494fc30STejun Heo pr_info(" in-flight:"); 52633494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 52643494fc30STejun Heo if (worker->current_pwq != pwq) 52653494fc30STejun Heo continue; 52663494fc30STejun Heo 5267d75f773cSSakari Ailus pr_cont("%s %d%s:%ps", comma ? "," : "", 52683494fc30STejun Heo task_pid_nr(worker->task), 526930ae2fc0STejun Heo worker->rescue_wq ? "(RESCUER)" : "", 52703494fc30STejun Heo worker->current_func); 52713494fc30STejun Heo list_for_each_entry(work, &worker->scheduled, entry) 5272c76feb0dSPaul E. McKenney pr_cont_work(false, work, &pcws); 5273c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1L, &pcws); 52743494fc30STejun Heo comma = true; 52753494fc30STejun Heo } 52763494fc30STejun Heo pr_cont("\n"); 52773494fc30STejun Heo } 52783494fc30STejun Heo 52793494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 52803494fc30STejun Heo if (get_work_pwq(work) == pwq) { 52813494fc30STejun Heo has_pending = true; 52823494fc30STejun Heo break; 52833494fc30STejun Heo } 52843494fc30STejun Heo } 52853494fc30STejun Heo if (has_pending) { 52863494fc30STejun Heo bool comma = false; 52873494fc30STejun Heo 52883494fc30STejun Heo pr_info(" pending:"); 52893494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 52903494fc30STejun Heo if (get_work_pwq(work) != pwq) 52913494fc30STejun Heo continue; 52923494fc30STejun Heo 5293c76feb0dSPaul E. McKenney pr_cont_work(comma, work, &pcws); 52943494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 52953494fc30STejun Heo } 5296c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1L, &pcws); 52973494fc30STejun Heo pr_cont("\n"); 52983494fc30STejun Heo } 52993494fc30STejun Heo 5300f97a4a1aSLai Jiangshan if (!list_empty(&pwq->inactive_works)) { 53013494fc30STejun Heo bool comma = false; 53023494fc30STejun Heo 5303f97a4a1aSLai Jiangshan pr_info(" inactive:"); 5304f97a4a1aSLai Jiangshan list_for_each_entry(work, &pwq->inactive_works, entry) { 5305c76feb0dSPaul E. McKenney pr_cont_work(comma, work, &pcws); 53063494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 53073494fc30STejun Heo } 5308c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1L, &pcws); 53093494fc30STejun Heo pr_cont("\n"); 53103494fc30STejun Heo } 53113494fc30STejun Heo } 53123494fc30STejun Heo 53133494fc30STejun Heo /** 531455df0933SImran Khan * show_one_workqueue - dump state of specified workqueue 531555df0933SImran Khan * @wq: workqueue whose state will be printed 53163494fc30STejun Heo */ 531755df0933SImran Khan void show_one_workqueue(struct workqueue_struct *wq) 53183494fc30STejun Heo { 53193494fc30STejun Heo struct pool_workqueue *pwq; 53203494fc30STejun Heo bool idle = true; 532155df0933SImran Khan unsigned long flags; 53223494fc30STejun Heo 53233494fc30STejun Heo for_each_pwq(pwq, wq) { 5324afa87ce8STejun Heo if (!pwq_is_empty(pwq)) { 53253494fc30STejun Heo idle = false; 53263494fc30STejun Heo break; 53273494fc30STejun Heo } 53283494fc30STejun Heo } 532955df0933SImran Khan if (idle) /* Nothing to print for idle workqueue */ 533055df0933SImran Khan return; 53313494fc30STejun Heo 53323494fc30STejun Heo pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags); 53333494fc30STejun Heo 53343494fc30STejun Heo for_each_pwq(pwq, wq) { 5335a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irqsave(&pwq->pool->lock, flags); 5336afa87ce8STejun Heo if (!pwq_is_empty(pwq)) { 533757116ce1SJohan Hovold /* 533857116ce1SJohan Hovold * Defer printing to avoid deadlocks in console 533957116ce1SJohan Hovold * drivers that queue work while holding locks 534057116ce1SJohan Hovold * also taken in their write paths. 534157116ce1SJohan Hovold */ 534257116ce1SJohan Hovold printk_deferred_enter(); 53433494fc30STejun Heo show_pwq(pwq); 534457116ce1SJohan Hovold printk_deferred_exit(); 534557116ce1SJohan Hovold } 5346a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irqrestore(&pwq->pool->lock, flags); 534762635ea8SSergey Senozhatsky /* 534862635ea8SSergey Senozhatsky * We could be printing a lot from atomic context, e.g. 534955df0933SImran Khan * sysrq-t -> show_all_workqueues(). Avoid triggering 535062635ea8SSergey Senozhatsky * hard lockup. 535162635ea8SSergey Senozhatsky */ 535262635ea8SSergey Senozhatsky touch_nmi_watchdog(); 53533494fc30STejun Heo } 535455df0933SImran Khan 53553494fc30STejun Heo } 53563494fc30STejun Heo 535755df0933SImran Khan /** 535855df0933SImran Khan * show_one_worker_pool - dump state of specified worker pool 535955df0933SImran Khan * @pool: worker pool whose state will be printed 536055df0933SImran Khan */ 536155df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool) 536255df0933SImran Khan { 53633494fc30STejun Heo struct worker *worker; 53643494fc30STejun Heo bool first = true; 536555df0933SImran Khan unsigned long flags; 5366335a42ebSPetr Mladek unsigned long hung = 0; 53673494fc30STejun Heo 5368a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irqsave(&pool->lock, flags); 53693494fc30STejun Heo if (pool->nr_workers == pool->nr_idle) 53703494fc30STejun Heo goto next_pool; 5371335a42ebSPetr Mladek 5372335a42ebSPetr Mladek /* How long the first pending work is waiting for a worker. */ 5373335a42ebSPetr Mladek if (!list_empty(&pool->worklist)) 5374335a42ebSPetr Mladek hung = jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000; 5375335a42ebSPetr Mladek 537657116ce1SJohan Hovold /* 537757116ce1SJohan Hovold * Defer printing to avoid deadlocks in console drivers that 537857116ce1SJohan Hovold * queue work while holding locks also taken in their write 537957116ce1SJohan Hovold * paths. 538057116ce1SJohan Hovold */ 538157116ce1SJohan Hovold printk_deferred_enter(); 53823494fc30STejun Heo pr_info("pool %d:", pool->id); 53833494fc30STejun Heo pr_cont_pool_info(pool); 5384335a42ebSPetr Mladek pr_cont(" hung=%lus workers=%d", hung, pool->nr_workers); 53853494fc30STejun Heo if (pool->manager) 53863494fc30STejun Heo pr_cont(" manager: %d", 53873494fc30STejun Heo task_pid_nr(pool->manager->task)); 53883494fc30STejun Heo list_for_each_entry(worker, &pool->idle_list, entry) { 53893494fc30STejun Heo pr_cont(" %s%d", first ? "idle: " : "", 53903494fc30STejun Heo task_pid_nr(worker->task)); 53913494fc30STejun Heo first = false; 53923494fc30STejun Heo } 53933494fc30STejun Heo pr_cont("\n"); 539457116ce1SJohan Hovold printk_deferred_exit(); 53953494fc30STejun Heo next_pool: 5396a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irqrestore(&pool->lock, flags); 539762635ea8SSergey Senozhatsky /* 539862635ea8SSergey Senozhatsky * We could be printing a lot from atomic context, e.g. 539955df0933SImran Khan * sysrq-t -> show_all_workqueues(). Avoid triggering 540062635ea8SSergey Senozhatsky * hard lockup. 540162635ea8SSergey Senozhatsky */ 540262635ea8SSergey Senozhatsky touch_nmi_watchdog(); 540355df0933SImran Khan 54043494fc30STejun Heo } 54053494fc30STejun Heo 540655df0933SImran Khan /** 540755df0933SImran Khan * show_all_workqueues - dump workqueue state 540855df0933SImran Khan * 5409704bc669SJungseung Lee * Called from a sysrq handler and prints out all busy workqueues and pools. 541055df0933SImran Khan */ 541155df0933SImran Khan void show_all_workqueues(void) 541255df0933SImran Khan { 541355df0933SImran Khan struct workqueue_struct *wq; 541455df0933SImran Khan struct worker_pool *pool; 541555df0933SImran Khan int pi; 541655df0933SImran Khan 541755df0933SImran Khan rcu_read_lock(); 541855df0933SImran Khan 541955df0933SImran Khan pr_info("Showing busy workqueues and worker pools:\n"); 542055df0933SImran Khan 542155df0933SImran Khan list_for_each_entry_rcu(wq, &workqueues, list) 542255df0933SImran Khan show_one_workqueue(wq); 542355df0933SImran Khan 542455df0933SImran Khan for_each_pool(pool, pi) 542555df0933SImran Khan show_one_worker_pool(pool); 542655df0933SImran Khan 542724acfb71SThomas Gleixner rcu_read_unlock(); 54283494fc30STejun Heo } 54293494fc30STejun Heo 5430704bc669SJungseung Lee /** 5431704bc669SJungseung Lee * show_freezable_workqueues - dump freezable workqueue state 5432704bc669SJungseung Lee * 5433704bc669SJungseung Lee * Called from try_to_freeze_tasks() and prints out all freezable workqueues 5434704bc669SJungseung Lee * still busy. 5435704bc669SJungseung Lee */ 5436704bc669SJungseung Lee void show_freezable_workqueues(void) 5437704bc669SJungseung Lee { 5438704bc669SJungseung Lee struct workqueue_struct *wq; 5439704bc669SJungseung Lee 5440704bc669SJungseung Lee rcu_read_lock(); 5441704bc669SJungseung Lee 5442704bc669SJungseung Lee pr_info("Showing freezable workqueues that are still busy:\n"); 5443704bc669SJungseung Lee 5444704bc669SJungseung Lee list_for_each_entry_rcu(wq, &workqueues, list) { 5445704bc669SJungseung Lee if (!(wq->flags & WQ_FREEZABLE)) 5446704bc669SJungseung Lee continue; 5447704bc669SJungseung Lee show_one_workqueue(wq); 5448704bc669SJungseung Lee } 5449704bc669SJungseung Lee 5450704bc669SJungseung Lee rcu_read_unlock(); 5451704bc669SJungseung Lee } 5452704bc669SJungseung Lee 54536b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */ 54546b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task) 54556b59808bSTejun Heo { 54566b59808bSTejun Heo int off; 54576b59808bSTejun Heo 54586b59808bSTejun Heo /* always show the actual comm */ 54596b59808bSTejun Heo off = strscpy(buf, task->comm, size); 54606b59808bSTejun Heo if (off < 0) 54616b59808bSTejun Heo return; 54626b59808bSTejun Heo 5463197f6accSTejun Heo /* stabilize PF_WQ_WORKER and worker pool association */ 54646b59808bSTejun Heo mutex_lock(&wq_pool_attach_mutex); 54656b59808bSTejun Heo 5466197f6accSTejun Heo if (task->flags & PF_WQ_WORKER) { 5467197f6accSTejun Heo struct worker *worker = kthread_data(task); 5468197f6accSTejun Heo struct worker_pool *pool = worker->pool; 54696b59808bSTejun Heo 54706b59808bSTejun Heo if (pool) { 5471a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 54726b59808bSTejun Heo /* 5473197f6accSTejun Heo * ->desc tracks information (wq name or 5474197f6accSTejun Heo * set_worker_desc()) for the latest execution. If 5475197f6accSTejun Heo * current, prepend '+', otherwise '-'. 54766b59808bSTejun Heo */ 54776b59808bSTejun Heo if (worker->desc[0] != '\0') { 54786b59808bSTejun Heo if (worker->current_work) 54796b59808bSTejun Heo scnprintf(buf + off, size - off, "+%s", 54806b59808bSTejun Heo worker->desc); 54816b59808bSTejun Heo else 54826b59808bSTejun Heo scnprintf(buf + off, size - off, "-%s", 54836b59808bSTejun Heo worker->desc); 54846b59808bSTejun Heo } 5485a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 54866b59808bSTejun Heo } 5487197f6accSTejun Heo } 54886b59808bSTejun Heo 54896b59808bSTejun Heo mutex_unlock(&wq_pool_attach_mutex); 54906b59808bSTejun Heo } 54916b59808bSTejun Heo 549266448bc2SMathieu Malaterre #ifdef CONFIG_SMP 549366448bc2SMathieu Malaterre 5494db7bccf4STejun Heo /* 5495db7bccf4STejun Heo * CPU hotplug. 5496db7bccf4STejun Heo * 5497e22bee78STejun Heo * There are two challenges in supporting CPU hotplug. Firstly, there 5498112202d9STejun Heo * are a lot of assumptions on strong associations among work, pwq and 5499706026c2STejun Heo * pool which make migrating pending and scheduled works very 5500e22bee78STejun Heo * difficult to implement without impacting hot paths. Secondly, 550194cf58bbSTejun Heo * worker pools serve mix of short, long and very long running works making 5502e22bee78STejun Heo * blocked draining impractical. 5503e22bee78STejun Heo * 550424647570STejun Heo * This is solved by allowing the pools to be disassociated from the CPU 5505628c78e7STejun Heo * running as an unbound one and allowing it to be reattached later if the 5506628c78e7STejun Heo * cpu comes back online. 5507db7bccf4STejun Heo */ 5508db7bccf4STejun Heo 5509e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu) 5510db7bccf4STejun Heo { 55114ce62e9eSTejun Heo struct worker_pool *pool; 5512db7bccf4STejun Heo struct worker *worker; 5513db7bccf4STejun Heo 5514f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 55151258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 5516a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 5517e22bee78STejun Heo 5518f2d5a0eeSTejun Heo /* 551992f9c5c4SLai Jiangshan * We've blocked all attach/detach operations. Make all workers 552094cf58bbSTejun Heo * unbound and set DISASSOCIATED. Before this, all workers 552111b45b0bSLai Jiangshan * must be on the cpu. After this, they may become diasporas. 5522b4ac9384SLai Jiangshan * And the preemption disabled section in their sched callbacks 5523b4ac9384SLai Jiangshan * are guaranteed to see WORKER_UNBOUND since the code here 5524b4ac9384SLai Jiangshan * is on the same cpu. 5525f2d5a0eeSTejun Heo */ 5526da028469SLai Jiangshan for_each_pool_worker(worker, pool) 5527403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 5528db7bccf4STejun Heo 552924647570STejun Heo pool->flags |= POOL_DISASSOCIATED; 5530f2d5a0eeSTejun Heo 5531e22bee78STejun Heo /* 5532989442d7SLai Jiangshan * The handling of nr_running in sched callbacks are disabled 5533989442d7SLai Jiangshan * now. Zap nr_running. After this, nr_running stays zero and 5534989442d7SLai Jiangshan * need_more_worker() and keep_working() are always true as 5535989442d7SLai Jiangshan * long as the worklist is not empty. This pool now behaves as 5536989442d7SLai Jiangshan * an unbound (in terms of concurrency management) pool which 5537eb283428SLai Jiangshan * are served by workers tied to the pool. 5538e22bee78STejun Heo */ 5539bc35f7efSLai Jiangshan pool->nr_running = 0; 5540eb283428SLai Jiangshan 5541eb283428SLai Jiangshan /* 5542eb283428SLai Jiangshan * With concurrency management just turned off, a busy 5543eb283428SLai Jiangshan * worker blocking could lead to lengthy stalls. Kick off 5544eb283428SLai Jiangshan * unbound chain execution of currently pending work items. 5545eb283428SLai Jiangshan */ 55460219a352STejun Heo kick_pool(pool); 5547989442d7SLai Jiangshan 5548a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 5549989442d7SLai Jiangshan 5550793777bcSValentin Schneider for_each_pool_worker(worker, pool) 5551793777bcSValentin Schneider unbind_worker(worker); 5552989442d7SLai Jiangshan 5553989442d7SLai Jiangshan mutex_unlock(&wq_pool_attach_mutex); 5554eb283428SLai Jiangshan } 5555db7bccf4STejun Heo } 5556db7bccf4STejun Heo 5557bd7c089eSTejun Heo /** 5558bd7c089eSTejun Heo * rebind_workers - rebind all workers of a pool to the associated CPU 5559bd7c089eSTejun Heo * @pool: pool of interest 5560bd7c089eSTejun Heo * 5561a9ab775bSTejun Heo * @pool->cpu is coming online. Rebind all workers to the CPU. 5562bd7c089eSTejun Heo */ 5563bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool) 5564bd7c089eSTejun Heo { 5565a9ab775bSTejun Heo struct worker *worker; 5566bd7c089eSTejun Heo 55671258fae7STejun Heo lockdep_assert_held(&wq_pool_attach_mutex); 5568bd7c089eSTejun Heo 5569bd7c089eSTejun Heo /* 5570a9ab775bSTejun Heo * Restore CPU affinity of all workers. As all idle workers should 5571a9ab775bSTejun Heo * be on the run-queue of the associated CPU before any local 5572402dd89dSShailendra Verma * wake-ups for concurrency management happen, restore CPU affinity 5573a9ab775bSTejun Heo * of all workers first and then clear UNBOUND. As we're called 5574a9ab775bSTejun Heo * from CPU_ONLINE, the following shouldn't fail. 5575bd7c089eSTejun Heo */ 5576c63a2e52SValentin Schneider for_each_pool_worker(worker, pool) { 5577c63a2e52SValentin Schneider kthread_set_per_cpu(worker->task, pool->cpu); 5578c63a2e52SValentin Schneider WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, 55799546b29eSTejun Heo pool_allowed_cpus(pool)) < 0); 5580c63a2e52SValentin Schneider } 5581a9ab775bSTejun Heo 5582a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 5583f7c17d26SWanpeng Li 55843de5e884SLai Jiangshan pool->flags &= ~POOL_DISASSOCIATED; 5585a9ab775bSTejun Heo 5586da028469SLai Jiangshan for_each_pool_worker(worker, pool) { 5587a9ab775bSTejun Heo unsigned int worker_flags = worker->flags; 5588a9ab775bSTejun Heo 5589a9ab775bSTejun Heo /* 5590a9ab775bSTejun Heo * We want to clear UNBOUND but can't directly call 5591a9ab775bSTejun Heo * worker_clr_flags() or adjust nr_running. Atomically 5592a9ab775bSTejun Heo * replace UNBOUND with another NOT_RUNNING flag REBOUND. 5593a9ab775bSTejun Heo * @worker will clear REBOUND using worker_clr_flags() when 5594a9ab775bSTejun Heo * it initiates the next execution cycle thus restoring 5595a9ab775bSTejun Heo * concurrency management. Note that when or whether 5596a9ab775bSTejun Heo * @worker clears REBOUND doesn't affect correctness. 5597a9ab775bSTejun Heo * 5598c95491edSMark Rutland * WRITE_ONCE() is necessary because @worker->flags may be 5599a9ab775bSTejun Heo * tested without holding any lock in 56006d25be57SThomas Gleixner * wq_worker_running(). Without it, NOT_RUNNING test may 5601a9ab775bSTejun Heo * fail incorrectly leading to premature concurrency 5602a9ab775bSTejun Heo * management operations. 5603bd7c089eSTejun Heo */ 5604a9ab775bSTejun Heo WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND)); 5605a9ab775bSTejun Heo worker_flags |= WORKER_REBOUND; 5606a9ab775bSTejun Heo worker_flags &= ~WORKER_UNBOUND; 5607c95491edSMark Rutland WRITE_ONCE(worker->flags, worker_flags); 5608bd7c089eSTejun Heo } 5609a9ab775bSTejun Heo 5610a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 5611bd7c089eSTejun Heo } 5612bd7c089eSTejun Heo 56137dbc725eSTejun Heo /** 56147dbc725eSTejun Heo * restore_unbound_workers_cpumask - restore cpumask of unbound workers 56157dbc725eSTejun Heo * @pool: unbound pool of interest 56167dbc725eSTejun Heo * @cpu: the CPU which is coming up 56177dbc725eSTejun Heo * 56187dbc725eSTejun Heo * An unbound pool may end up with a cpumask which doesn't have any online 56197dbc725eSTejun Heo * CPUs. When a worker of such pool get scheduled, the scheduler resets 56207dbc725eSTejun Heo * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any 56217dbc725eSTejun Heo * online CPU before, cpus_allowed of all its workers should be restored. 56227dbc725eSTejun Heo */ 56237dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu) 56247dbc725eSTejun Heo { 56257dbc725eSTejun Heo static cpumask_t cpumask; 56267dbc725eSTejun Heo struct worker *worker; 56277dbc725eSTejun Heo 56281258fae7STejun Heo lockdep_assert_held(&wq_pool_attach_mutex); 56297dbc725eSTejun Heo 56307dbc725eSTejun Heo /* is @cpu allowed for @pool? */ 56317dbc725eSTejun Heo if (!cpumask_test_cpu(cpu, pool->attrs->cpumask)) 56327dbc725eSTejun Heo return; 56337dbc725eSTejun Heo 56347dbc725eSTejun Heo cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask); 56357dbc725eSTejun Heo 56367dbc725eSTejun Heo /* as we're called from CPU_ONLINE, the following shouldn't fail */ 5637da028469SLai Jiangshan for_each_pool_worker(worker, pool) 5638d945b5e9SPeter Zijlstra WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0); 56397dbc725eSTejun Heo } 56407dbc725eSTejun Heo 56417ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu) 56421da177e4SLinus Torvalds { 56434ce62e9eSTejun Heo struct worker_pool *pool; 56441da177e4SLinus Torvalds 5645f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 56463ce63377STejun Heo if (pool->nr_workers) 56473ce63377STejun Heo continue; 5648051e1850SLai Jiangshan if (!create_worker(pool)) 56497ee681b2SThomas Gleixner return -ENOMEM; 56503af24433SOleg Nesterov } 56517ee681b2SThomas Gleixner return 0; 56527ee681b2SThomas Gleixner } 56531da177e4SLinus Torvalds 56547ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu) 56557ee681b2SThomas Gleixner { 56567ee681b2SThomas Gleixner struct worker_pool *pool; 56577ee681b2SThomas Gleixner struct workqueue_struct *wq; 56587ee681b2SThomas Gleixner int pi; 56597ee681b2SThomas Gleixner 566068e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 56617dbc725eSTejun Heo 56627dbc725eSTejun Heo for_each_pool(pool, pi) { 56631258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 566494cf58bbSTejun Heo 5665f05b558dSLai Jiangshan if (pool->cpu == cpu) 566694cf58bbSTejun Heo rebind_workers(pool); 5667f05b558dSLai Jiangshan else if (pool->cpu < 0) 56687dbc725eSTejun Heo restore_unbound_workers_cpumask(pool, cpu); 566994cf58bbSTejun Heo 56701258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 567194cf58bbSTejun Heo } 56727dbc725eSTejun Heo 5673fef59c9cSTejun Heo /* update pod affinity of unbound workqueues */ 56744cbfd3deSTejun Heo list_for_each_entry(wq, &workqueues, list) { 567584193c07STejun Heo struct workqueue_attrs *attrs = wq->unbound_attrs; 567684193c07STejun Heo 567784193c07STejun Heo if (attrs) { 567884193c07STejun Heo const struct wq_pod_type *pt = wqattrs_pod_type(attrs); 56794cbfd3deSTejun Heo int tcpu; 56804cbfd3deSTejun Heo 568184193c07STejun Heo for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]]) 5682fef59c9cSTejun Heo wq_update_pod(wq, tcpu, cpu, true); 56834cbfd3deSTejun Heo } 56844cbfd3deSTejun Heo } 56854c16bd32STejun Heo 568668e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 56877ee681b2SThomas Gleixner return 0; 568865758202STejun Heo } 568965758202STejun Heo 56907ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu) 569165758202STejun Heo { 56924c16bd32STejun Heo struct workqueue_struct *wq; 56938db25e78STejun Heo 56944c16bd32STejun Heo /* unbinding per-cpu workers should happen on the local CPU */ 5695e8b3f8dbSLai Jiangshan if (WARN_ON(cpu != smp_processor_id())) 5696e8b3f8dbSLai Jiangshan return -1; 5697e8b3f8dbSLai Jiangshan 5698e8b3f8dbSLai Jiangshan unbind_workers(cpu); 56994c16bd32STejun Heo 5700fef59c9cSTejun Heo /* update pod affinity of unbound workqueues */ 57014c16bd32STejun Heo mutex_lock(&wq_pool_mutex); 57024cbfd3deSTejun Heo list_for_each_entry(wq, &workqueues, list) { 570384193c07STejun Heo struct workqueue_attrs *attrs = wq->unbound_attrs; 570484193c07STejun Heo 570584193c07STejun Heo if (attrs) { 570684193c07STejun Heo const struct wq_pod_type *pt = wqattrs_pod_type(attrs); 57074cbfd3deSTejun Heo int tcpu; 57084cbfd3deSTejun Heo 570984193c07STejun Heo for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]]) 5710fef59c9cSTejun Heo wq_update_pod(wq, tcpu, cpu, false); 57114cbfd3deSTejun Heo } 57124cbfd3deSTejun Heo } 57134c16bd32STejun Heo mutex_unlock(&wq_pool_mutex); 57144c16bd32STejun Heo 57157ee681b2SThomas Gleixner return 0; 571665758202STejun Heo } 571765758202STejun Heo 57182d3854a3SRusty Russell struct work_for_cpu { 5719ed48ece2STejun Heo struct work_struct work; 57202d3854a3SRusty Russell long (*fn)(void *); 57212d3854a3SRusty Russell void *arg; 57222d3854a3SRusty Russell long ret; 57232d3854a3SRusty Russell }; 57242d3854a3SRusty Russell 5725ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work) 57262d3854a3SRusty Russell { 5727ed48ece2STejun Heo struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work); 5728ed48ece2STejun Heo 57292d3854a3SRusty Russell wfc->ret = wfc->fn(wfc->arg); 57302d3854a3SRusty Russell } 57312d3854a3SRusty Russell 57322d3854a3SRusty Russell /** 5733265f3ed0SFrederic Weisbecker * work_on_cpu_key - run a function in thread context on a particular cpu 57342d3854a3SRusty Russell * @cpu: the cpu to run on 57352d3854a3SRusty Russell * @fn: the function to run 57362d3854a3SRusty Russell * @arg: the function arg 5737265f3ed0SFrederic Weisbecker * @key: The lock class key for lock debugging purposes 57382d3854a3SRusty Russell * 573931ad9081SRusty Russell * It is up to the caller to ensure that the cpu doesn't go offline. 57406b44003eSAndrew Morton * The caller must not hold any locks which would prevent @fn from completing. 5741d185af30SYacine Belkadi * 5742d185af30SYacine Belkadi * Return: The value @fn returns. 57432d3854a3SRusty Russell */ 5744265f3ed0SFrederic Weisbecker long work_on_cpu_key(int cpu, long (*fn)(void *), 5745265f3ed0SFrederic Weisbecker void *arg, struct lock_class_key *key) 57462d3854a3SRusty Russell { 5747ed48ece2STejun Heo struct work_for_cpu wfc = { .fn = fn, .arg = arg }; 57482d3854a3SRusty Russell 5749265f3ed0SFrederic Weisbecker INIT_WORK_ONSTACK_KEY(&wfc.work, work_for_cpu_fn, key); 5750ed48ece2STejun Heo schedule_work_on(cpu, &wfc.work); 575112997d1aSBjorn Helgaas flush_work(&wfc.work); 5752440a1136SChuansheng Liu destroy_work_on_stack(&wfc.work); 57532d3854a3SRusty Russell return wfc.ret; 57542d3854a3SRusty Russell } 5755265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_key); 57560e8d6a93SThomas Gleixner 57570e8d6a93SThomas Gleixner /** 5758265f3ed0SFrederic Weisbecker * work_on_cpu_safe_key - run a function in thread context on a particular cpu 57590e8d6a93SThomas Gleixner * @cpu: the cpu to run on 57600e8d6a93SThomas Gleixner * @fn: the function to run 57610e8d6a93SThomas Gleixner * @arg: the function argument 5762265f3ed0SFrederic Weisbecker * @key: The lock class key for lock debugging purposes 57630e8d6a93SThomas Gleixner * 57640e8d6a93SThomas Gleixner * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold 57650e8d6a93SThomas Gleixner * any locks which would prevent @fn from completing. 57660e8d6a93SThomas Gleixner * 57670e8d6a93SThomas Gleixner * Return: The value @fn returns. 57680e8d6a93SThomas Gleixner */ 5769265f3ed0SFrederic Weisbecker long work_on_cpu_safe_key(int cpu, long (*fn)(void *), 5770265f3ed0SFrederic Weisbecker void *arg, struct lock_class_key *key) 57710e8d6a93SThomas Gleixner { 57720e8d6a93SThomas Gleixner long ret = -ENODEV; 57730e8d6a93SThomas Gleixner 5774ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 57750e8d6a93SThomas Gleixner if (cpu_online(cpu)) 5776265f3ed0SFrederic Weisbecker ret = work_on_cpu_key(cpu, fn, arg, key); 5777ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 57780e8d6a93SThomas Gleixner return ret; 57790e8d6a93SThomas Gleixner } 5780265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_safe_key); 57812d3854a3SRusty Russell #endif /* CONFIG_SMP */ 57822d3854a3SRusty Russell 5783a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 5784e7577c50SRusty Russell 5785a0a1a5fdSTejun Heo /** 5786a0a1a5fdSTejun Heo * freeze_workqueues_begin - begin freezing workqueues 5787a0a1a5fdSTejun Heo * 578858a69cb4STejun Heo * Start freezing workqueues. After this function returns, all freezable 5789f97a4a1aSLai Jiangshan * workqueues will queue new works to their inactive_works list instead of 5790706026c2STejun Heo * pool->worklist. 5791a0a1a5fdSTejun Heo * 5792a0a1a5fdSTejun Heo * CONTEXT: 5793a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 5794a0a1a5fdSTejun Heo */ 5795a0a1a5fdSTejun Heo void freeze_workqueues_begin(void) 5796a0a1a5fdSTejun Heo { 579724b8a847STejun Heo struct workqueue_struct *wq; 5798a0a1a5fdSTejun Heo 579968e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 5800a0a1a5fdSTejun Heo 58016183c009STejun Heo WARN_ON_ONCE(workqueue_freezing); 5802a0a1a5fdSTejun Heo workqueue_freezing = true; 5803a0a1a5fdSTejun Heo 580424b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 5805a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 5806a045a272STejun Heo wq_adjust_max_active(wq); 5807a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 5808a1056305STejun Heo } 58095bcab335STejun Heo 581068e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5811a0a1a5fdSTejun Heo } 5812a0a1a5fdSTejun Heo 5813a0a1a5fdSTejun Heo /** 581458a69cb4STejun Heo * freeze_workqueues_busy - are freezable workqueues still busy? 5815a0a1a5fdSTejun Heo * 5816a0a1a5fdSTejun Heo * Check whether freezing is complete. This function must be called 5817a0a1a5fdSTejun Heo * between freeze_workqueues_begin() and thaw_workqueues(). 5818a0a1a5fdSTejun Heo * 5819a0a1a5fdSTejun Heo * CONTEXT: 582068e13a67SLai Jiangshan * Grabs and releases wq_pool_mutex. 5821a0a1a5fdSTejun Heo * 5822d185af30SYacine Belkadi * Return: 582358a69cb4STejun Heo * %true if some freezable workqueues are still busy. %false if freezing 582458a69cb4STejun Heo * is complete. 5825a0a1a5fdSTejun Heo */ 5826a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void) 5827a0a1a5fdSTejun Heo { 5828a0a1a5fdSTejun Heo bool busy = false; 582924b8a847STejun Heo struct workqueue_struct *wq; 583024b8a847STejun Heo struct pool_workqueue *pwq; 5831a0a1a5fdSTejun Heo 583268e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 5833a0a1a5fdSTejun Heo 58346183c009STejun Heo WARN_ON_ONCE(!workqueue_freezing); 5835a0a1a5fdSTejun Heo 583624b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 583724b8a847STejun Heo if (!(wq->flags & WQ_FREEZABLE)) 583824b8a847STejun Heo continue; 5839a0a1a5fdSTejun Heo /* 5840a0a1a5fdSTejun Heo * nr_active is monotonically decreasing. It's safe 5841a0a1a5fdSTejun Heo * to peek without lock. 5842a0a1a5fdSTejun Heo */ 584324acfb71SThomas Gleixner rcu_read_lock(); 584424b8a847STejun Heo for_each_pwq(pwq, wq) { 58456183c009STejun Heo WARN_ON_ONCE(pwq->nr_active < 0); 5846112202d9STejun Heo if (pwq->nr_active) { 5847a0a1a5fdSTejun Heo busy = true; 584824acfb71SThomas Gleixner rcu_read_unlock(); 5849a0a1a5fdSTejun Heo goto out_unlock; 5850a0a1a5fdSTejun Heo } 5851a0a1a5fdSTejun Heo } 585224acfb71SThomas Gleixner rcu_read_unlock(); 5853a0a1a5fdSTejun Heo } 5854a0a1a5fdSTejun Heo out_unlock: 585568e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5856a0a1a5fdSTejun Heo return busy; 5857a0a1a5fdSTejun Heo } 5858a0a1a5fdSTejun Heo 5859a0a1a5fdSTejun Heo /** 5860a0a1a5fdSTejun Heo * thaw_workqueues - thaw workqueues 5861a0a1a5fdSTejun Heo * 5862a0a1a5fdSTejun Heo * Thaw workqueues. Normal queueing is restored and all collected 5863706026c2STejun Heo * frozen works are transferred to their respective pool worklists. 5864a0a1a5fdSTejun Heo * 5865a0a1a5fdSTejun Heo * CONTEXT: 5866a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 5867a0a1a5fdSTejun Heo */ 5868a0a1a5fdSTejun Heo void thaw_workqueues(void) 5869a0a1a5fdSTejun Heo { 587024b8a847STejun Heo struct workqueue_struct *wq; 5871a0a1a5fdSTejun Heo 587268e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 5873a0a1a5fdSTejun Heo 5874a0a1a5fdSTejun Heo if (!workqueue_freezing) 5875a0a1a5fdSTejun Heo goto out_unlock; 5876a0a1a5fdSTejun Heo 587774b414eaSLai Jiangshan workqueue_freezing = false; 587824b8a847STejun Heo 587924b8a847STejun Heo /* restore max_active and repopulate worklist */ 588024b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 5881a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 5882a045a272STejun Heo wq_adjust_max_active(wq); 5883a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 588424b8a847STejun Heo } 588524b8a847STejun Heo 5886a0a1a5fdSTejun Heo out_unlock: 588768e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5888a0a1a5fdSTejun Heo } 5889a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 5890a0a1a5fdSTejun Heo 589199c621efSLai Jiangshan static int workqueue_apply_unbound_cpumask(const cpumask_var_t unbound_cpumask) 5892042f7df1SLai Jiangshan { 5893042f7df1SLai Jiangshan LIST_HEAD(ctxs); 5894042f7df1SLai Jiangshan int ret = 0; 5895042f7df1SLai Jiangshan struct workqueue_struct *wq; 5896042f7df1SLai Jiangshan struct apply_wqattrs_ctx *ctx, *n; 5897042f7df1SLai Jiangshan 5898042f7df1SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 5899042f7df1SLai Jiangshan 5900042f7df1SLai Jiangshan list_for_each_entry(wq, &workqueues, list) { 5901042f7df1SLai Jiangshan if (!(wq->flags & WQ_UNBOUND)) 5902042f7df1SLai Jiangshan continue; 5903ca10d851SWaiman Long 5904042f7df1SLai Jiangshan /* creating multiple pwqs breaks ordering guarantee */ 5905ca10d851SWaiman Long if (!list_empty(&wq->pwqs)) { 5906ca10d851SWaiman Long if (wq->flags & __WQ_ORDERED_EXPLICIT) 5907042f7df1SLai Jiangshan continue; 5908ca10d851SWaiman Long wq->flags &= ~__WQ_ORDERED; 5909ca10d851SWaiman Long } 5910042f7df1SLai Jiangshan 591199c621efSLai Jiangshan ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs, unbound_cpumask); 591284193c07STejun Heo if (IS_ERR(ctx)) { 591384193c07STejun Heo ret = PTR_ERR(ctx); 5914042f7df1SLai Jiangshan break; 5915042f7df1SLai Jiangshan } 5916042f7df1SLai Jiangshan 5917042f7df1SLai Jiangshan list_add_tail(&ctx->list, &ctxs); 5918042f7df1SLai Jiangshan } 5919042f7df1SLai Jiangshan 5920042f7df1SLai Jiangshan list_for_each_entry_safe(ctx, n, &ctxs, list) { 5921042f7df1SLai Jiangshan if (!ret) 5922042f7df1SLai Jiangshan apply_wqattrs_commit(ctx); 5923042f7df1SLai Jiangshan apply_wqattrs_cleanup(ctx); 5924042f7df1SLai Jiangshan } 5925042f7df1SLai Jiangshan 592699c621efSLai Jiangshan if (!ret) { 592799c621efSLai Jiangshan mutex_lock(&wq_pool_attach_mutex); 592899c621efSLai Jiangshan cpumask_copy(wq_unbound_cpumask, unbound_cpumask); 592999c621efSLai Jiangshan mutex_unlock(&wq_pool_attach_mutex); 593099c621efSLai Jiangshan } 5931042f7df1SLai Jiangshan return ret; 5932042f7df1SLai Jiangshan } 5933042f7df1SLai Jiangshan 5934042f7df1SLai Jiangshan /** 5935fe28f631SWaiman Long * workqueue_unbound_exclude_cpumask - Exclude given CPUs from unbound cpumask 5936fe28f631SWaiman Long * @exclude_cpumask: the cpumask to be excluded from wq_unbound_cpumask 5937fe28f631SWaiman Long * 5938fe28f631SWaiman Long * This function can be called from cpuset code to provide a set of isolated 5939fe28f631SWaiman Long * CPUs that should be excluded from wq_unbound_cpumask. The caller must hold 5940fe28f631SWaiman Long * either cpus_read_lock or cpus_write_lock. 5941fe28f631SWaiman Long */ 5942fe28f631SWaiman Long int workqueue_unbound_exclude_cpumask(cpumask_var_t exclude_cpumask) 5943fe28f631SWaiman Long { 5944fe28f631SWaiman Long cpumask_var_t cpumask; 5945fe28f631SWaiman Long int ret = 0; 5946fe28f631SWaiman Long 5947fe28f631SWaiman Long if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL)) 5948fe28f631SWaiman Long return -ENOMEM; 5949fe28f631SWaiman Long 5950fe28f631SWaiman Long lockdep_assert_cpus_held(); 5951fe28f631SWaiman Long mutex_lock(&wq_pool_mutex); 5952fe28f631SWaiman Long 5953fe28f631SWaiman Long /* Save the current isolated cpumask & export it via sysfs */ 5954fe28f631SWaiman Long cpumask_copy(wq_isolated_cpumask, exclude_cpumask); 5955fe28f631SWaiman Long 5956fe28f631SWaiman Long /* 5957fe28f631SWaiman Long * If the operation fails, it will fall back to 5958fe28f631SWaiman Long * wq_requested_unbound_cpumask which is initially set to 5959fe28f631SWaiman Long * (HK_TYPE_WQ ∩ HK_TYPE_DOMAIN) house keeping mask and rewritten 5960fe28f631SWaiman Long * by any subsequent write to workqueue/cpumask sysfs file. 5961fe28f631SWaiman Long */ 5962fe28f631SWaiman Long if (!cpumask_andnot(cpumask, wq_requested_unbound_cpumask, exclude_cpumask)) 5963fe28f631SWaiman Long cpumask_copy(cpumask, wq_requested_unbound_cpumask); 5964fe28f631SWaiman Long if (!cpumask_equal(cpumask, wq_unbound_cpumask)) 5965fe28f631SWaiman Long ret = workqueue_apply_unbound_cpumask(cpumask); 5966fe28f631SWaiman Long 5967fe28f631SWaiman Long mutex_unlock(&wq_pool_mutex); 5968fe28f631SWaiman Long free_cpumask_var(cpumask); 5969fe28f631SWaiman Long return ret; 5970fe28f631SWaiman Long } 5971fe28f631SWaiman Long 597263c5484eSTejun Heo static int parse_affn_scope(const char *val) 597363c5484eSTejun Heo { 597463c5484eSTejun Heo int i; 597563c5484eSTejun Heo 597663c5484eSTejun Heo for (i = 0; i < ARRAY_SIZE(wq_affn_names); i++) { 597763c5484eSTejun Heo if (!strncasecmp(val, wq_affn_names[i], strlen(wq_affn_names[i]))) 597863c5484eSTejun Heo return i; 597963c5484eSTejun Heo } 598063c5484eSTejun Heo return -EINVAL; 598163c5484eSTejun Heo } 598263c5484eSTejun Heo 598363c5484eSTejun Heo static int wq_affn_dfl_set(const char *val, const struct kernel_param *kp) 598463c5484eSTejun Heo { 5985523a301eSTejun Heo struct workqueue_struct *wq; 5986523a301eSTejun Heo int affn, cpu; 598763c5484eSTejun Heo 598863c5484eSTejun Heo affn = parse_affn_scope(val); 598963c5484eSTejun Heo if (affn < 0) 599063c5484eSTejun Heo return affn; 5991523a301eSTejun Heo if (affn == WQ_AFFN_DFL) 5992523a301eSTejun Heo return -EINVAL; 5993523a301eSTejun Heo 5994523a301eSTejun Heo cpus_read_lock(); 5995523a301eSTejun Heo mutex_lock(&wq_pool_mutex); 599663c5484eSTejun Heo 599763c5484eSTejun Heo wq_affn_dfl = affn; 5998523a301eSTejun Heo 5999523a301eSTejun Heo list_for_each_entry(wq, &workqueues, list) { 6000523a301eSTejun Heo for_each_online_cpu(cpu) { 6001523a301eSTejun Heo wq_update_pod(wq, cpu, cpu, true); 6002523a301eSTejun Heo } 6003523a301eSTejun Heo } 6004523a301eSTejun Heo 6005523a301eSTejun Heo mutex_unlock(&wq_pool_mutex); 6006523a301eSTejun Heo cpus_read_unlock(); 6007523a301eSTejun Heo 600863c5484eSTejun Heo return 0; 600963c5484eSTejun Heo } 601063c5484eSTejun Heo 601163c5484eSTejun Heo static int wq_affn_dfl_get(char *buffer, const struct kernel_param *kp) 601263c5484eSTejun Heo { 601363c5484eSTejun Heo return scnprintf(buffer, PAGE_SIZE, "%s\n", wq_affn_names[wq_affn_dfl]); 601463c5484eSTejun Heo } 601563c5484eSTejun Heo 601663c5484eSTejun Heo static const struct kernel_param_ops wq_affn_dfl_ops = { 601763c5484eSTejun Heo .set = wq_affn_dfl_set, 601863c5484eSTejun Heo .get = wq_affn_dfl_get, 601963c5484eSTejun Heo }; 602063c5484eSTejun Heo 602163c5484eSTejun Heo module_param_cb(default_affinity_scope, &wq_affn_dfl_ops, NULL, 0644); 602263c5484eSTejun Heo 60236ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS 60246ba94429SFrederic Weisbecker /* 60256ba94429SFrederic Weisbecker * Workqueues with WQ_SYSFS flag set is visible to userland via 60266ba94429SFrederic Weisbecker * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the 60276ba94429SFrederic Weisbecker * following attributes. 60286ba94429SFrederic Weisbecker * 60296ba94429SFrederic Weisbecker * per_cpu RO bool : whether the workqueue is per-cpu or unbound 60306ba94429SFrederic Weisbecker * max_active RW int : maximum number of in-flight work items 60316ba94429SFrederic Weisbecker * 60326ba94429SFrederic Weisbecker * Unbound workqueues have the following extra attributes. 60336ba94429SFrederic Weisbecker * 60346ba94429SFrederic Weisbecker * nice RW int : nice value of the workers 60356ba94429SFrederic Weisbecker * cpumask RW mask : bitmask of allowed CPUs for the workers 603663c5484eSTejun Heo * affinity_scope RW str : worker CPU affinity scope (cache, numa, none) 60378639ecebSTejun Heo * affinity_strict RW bool : worker CPU affinity is strict 60386ba94429SFrederic Weisbecker */ 60396ba94429SFrederic Weisbecker struct wq_device { 60406ba94429SFrederic Weisbecker struct workqueue_struct *wq; 60416ba94429SFrederic Weisbecker struct device dev; 60426ba94429SFrederic Weisbecker }; 60436ba94429SFrederic Weisbecker 60446ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev) 60456ba94429SFrederic Weisbecker { 60466ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 60476ba94429SFrederic Weisbecker 60486ba94429SFrederic Weisbecker return wq_dev->wq; 60496ba94429SFrederic Weisbecker } 60506ba94429SFrederic Weisbecker 60516ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr, 60526ba94429SFrederic Weisbecker char *buf) 60536ba94429SFrederic Weisbecker { 60546ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 60556ba94429SFrederic Weisbecker 60566ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND)); 60576ba94429SFrederic Weisbecker } 60586ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu); 60596ba94429SFrederic Weisbecker 60606ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev, 60616ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 60626ba94429SFrederic Weisbecker { 60636ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 60646ba94429SFrederic Weisbecker 60656ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active); 60666ba94429SFrederic Weisbecker } 60676ba94429SFrederic Weisbecker 60686ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev, 60696ba94429SFrederic Weisbecker struct device_attribute *attr, const char *buf, 60706ba94429SFrederic Weisbecker size_t count) 60716ba94429SFrederic Weisbecker { 60726ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 60736ba94429SFrederic Weisbecker int val; 60746ba94429SFrederic Weisbecker 60756ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &val) != 1 || val <= 0) 60766ba94429SFrederic Weisbecker return -EINVAL; 60776ba94429SFrederic Weisbecker 60786ba94429SFrederic Weisbecker workqueue_set_max_active(wq, val); 60796ba94429SFrederic Weisbecker return count; 60806ba94429SFrederic Weisbecker } 60816ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active); 60826ba94429SFrederic Weisbecker 60836ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = { 60846ba94429SFrederic Weisbecker &dev_attr_per_cpu.attr, 60856ba94429SFrederic Weisbecker &dev_attr_max_active.attr, 60866ba94429SFrederic Weisbecker NULL, 60876ba94429SFrederic Weisbecker }; 60886ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs); 60896ba94429SFrederic Weisbecker 609049277a5bSWaiman Long static void apply_wqattrs_lock(void) 609149277a5bSWaiman Long { 609249277a5bSWaiman Long /* CPUs should stay stable across pwq creations and installations */ 609349277a5bSWaiman Long cpus_read_lock(); 609449277a5bSWaiman Long mutex_lock(&wq_pool_mutex); 609549277a5bSWaiman Long } 609649277a5bSWaiman Long 609749277a5bSWaiman Long static void apply_wqattrs_unlock(void) 609849277a5bSWaiman Long { 609949277a5bSWaiman Long mutex_unlock(&wq_pool_mutex); 610049277a5bSWaiman Long cpus_read_unlock(); 610149277a5bSWaiman Long } 610249277a5bSWaiman Long 61036ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr, 61046ba94429SFrederic Weisbecker char *buf) 61056ba94429SFrederic Weisbecker { 61066ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 61076ba94429SFrederic Weisbecker int written; 61086ba94429SFrederic Weisbecker 61096ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 61106ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice); 61116ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 61126ba94429SFrederic Weisbecker 61136ba94429SFrederic Weisbecker return written; 61146ba94429SFrederic Weisbecker } 61156ba94429SFrederic Weisbecker 61166ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */ 61176ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq) 61186ba94429SFrederic Weisbecker { 61196ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 61206ba94429SFrederic Weisbecker 6121899a94feSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 6122899a94feSLai Jiangshan 6123be69d00dSThomas Gleixner attrs = alloc_workqueue_attrs(); 61246ba94429SFrederic Weisbecker if (!attrs) 61256ba94429SFrederic Weisbecker return NULL; 61266ba94429SFrederic Weisbecker 61276ba94429SFrederic Weisbecker copy_workqueue_attrs(attrs, wq->unbound_attrs); 61286ba94429SFrederic Weisbecker return attrs; 61296ba94429SFrederic Weisbecker } 61306ba94429SFrederic Weisbecker 61316ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr, 61326ba94429SFrederic Weisbecker const char *buf, size_t count) 61336ba94429SFrederic Weisbecker { 61346ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 61356ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 6136d4d3e257SLai Jiangshan int ret = -ENOMEM; 6137d4d3e257SLai Jiangshan 6138d4d3e257SLai Jiangshan apply_wqattrs_lock(); 61396ba94429SFrederic Weisbecker 61406ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 61416ba94429SFrederic Weisbecker if (!attrs) 6142d4d3e257SLai Jiangshan goto out_unlock; 61436ba94429SFrederic Weisbecker 61446ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &attrs->nice) == 1 && 61456ba94429SFrederic Weisbecker attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE) 6146d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 61476ba94429SFrederic Weisbecker else 61486ba94429SFrederic Weisbecker ret = -EINVAL; 61496ba94429SFrederic Weisbecker 6150d4d3e257SLai Jiangshan out_unlock: 6151d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 61526ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 61536ba94429SFrederic Weisbecker return ret ?: count; 61546ba94429SFrederic Weisbecker } 61556ba94429SFrederic Weisbecker 61566ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev, 61576ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 61586ba94429SFrederic Weisbecker { 61596ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 61606ba94429SFrederic Weisbecker int written; 61616ba94429SFrederic Weisbecker 61626ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 61636ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%*pb\n", 61646ba94429SFrederic Weisbecker cpumask_pr_args(wq->unbound_attrs->cpumask)); 61656ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 61666ba94429SFrederic Weisbecker return written; 61676ba94429SFrederic Weisbecker } 61686ba94429SFrederic Weisbecker 61696ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev, 61706ba94429SFrederic Weisbecker struct device_attribute *attr, 61716ba94429SFrederic Weisbecker const char *buf, size_t count) 61726ba94429SFrederic Weisbecker { 61736ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 61746ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 6175d4d3e257SLai Jiangshan int ret = -ENOMEM; 6176d4d3e257SLai Jiangshan 6177d4d3e257SLai Jiangshan apply_wqattrs_lock(); 61786ba94429SFrederic Weisbecker 61796ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 61806ba94429SFrederic Weisbecker if (!attrs) 6181d4d3e257SLai Jiangshan goto out_unlock; 61826ba94429SFrederic Weisbecker 61836ba94429SFrederic Weisbecker ret = cpumask_parse(buf, attrs->cpumask); 61846ba94429SFrederic Weisbecker if (!ret) 6185d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 61866ba94429SFrederic Weisbecker 6187d4d3e257SLai Jiangshan out_unlock: 6188d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 61896ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 61906ba94429SFrederic Weisbecker return ret ?: count; 61916ba94429SFrederic Weisbecker } 61926ba94429SFrederic Weisbecker 619363c5484eSTejun Heo static ssize_t wq_affn_scope_show(struct device *dev, 619463c5484eSTejun Heo struct device_attribute *attr, char *buf) 619563c5484eSTejun Heo { 619663c5484eSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 619763c5484eSTejun Heo int written; 619863c5484eSTejun Heo 619963c5484eSTejun Heo mutex_lock(&wq->mutex); 6200523a301eSTejun Heo if (wq->unbound_attrs->affn_scope == WQ_AFFN_DFL) 6201523a301eSTejun Heo written = scnprintf(buf, PAGE_SIZE, "%s (%s)\n", 6202523a301eSTejun Heo wq_affn_names[WQ_AFFN_DFL], 6203523a301eSTejun Heo wq_affn_names[wq_affn_dfl]); 6204523a301eSTejun Heo else 620563c5484eSTejun Heo written = scnprintf(buf, PAGE_SIZE, "%s\n", 620663c5484eSTejun Heo wq_affn_names[wq->unbound_attrs->affn_scope]); 620763c5484eSTejun Heo mutex_unlock(&wq->mutex); 620863c5484eSTejun Heo 620963c5484eSTejun Heo return written; 621063c5484eSTejun Heo } 621163c5484eSTejun Heo 621263c5484eSTejun Heo static ssize_t wq_affn_scope_store(struct device *dev, 621363c5484eSTejun Heo struct device_attribute *attr, 621463c5484eSTejun Heo const char *buf, size_t count) 621563c5484eSTejun Heo { 621663c5484eSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 621763c5484eSTejun Heo struct workqueue_attrs *attrs; 621863c5484eSTejun Heo int affn, ret = -ENOMEM; 621963c5484eSTejun Heo 622063c5484eSTejun Heo affn = parse_affn_scope(buf); 622163c5484eSTejun Heo if (affn < 0) 622263c5484eSTejun Heo return affn; 622363c5484eSTejun Heo 622463c5484eSTejun Heo apply_wqattrs_lock(); 622563c5484eSTejun Heo attrs = wq_sysfs_prep_attrs(wq); 622663c5484eSTejun Heo if (attrs) { 622763c5484eSTejun Heo attrs->affn_scope = affn; 622863c5484eSTejun Heo ret = apply_workqueue_attrs_locked(wq, attrs); 622963c5484eSTejun Heo } 623063c5484eSTejun Heo apply_wqattrs_unlock(); 623163c5484eSTejun Heo free_workqueue_attrs(attrs); 623263c5484eSTejun Heo return ret ?: count; 623363c5484eSTejun Heo } 623463c5484eSTejun Heo 62358639ecebSTejun Heo static ssize_t wq_affinity_strict_show(struct device *dev, 62368639ecebSTejun Heo struct device_attribute *attr, char *buf) 62378639ecebSTejun Heo { 62388639ecebSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 62398639ecebSTejun Heo 62408639ecebSTejun Heo return scnprintf(buf, PAGE_SIZE, "%d\n", 62418639ecebSTejun Heo wq->unbound_attrs->affn_strict); 62428639ecebSTejun Heo } 62438639ecebSTejun Heo 62448639ecebSTejun Heo static ssize_t wq_affinity_strict_store(struct device *dev, 62458639ecebSTejun Heo struct device_attribute *attr, 62468639ecebSTejun Heo const char *buf, size_t count) 62478639ecebSTejun Heo { 62488639ecebSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 62498639ecebSTejun Heo struct workqueue_attrs *attrs; 62508639ecebSTejun Heo int v, ret = -ENOMEM; 62518639ecebSTejun Heo 62528639ecebSTejun Heo if (sscanf(buf, "%d", &v) != 1) 62538639ecebSTejun Heo return -EINVAL; 62548639ecebSTejun Heo 62558639ecebSTejun Heo apply_wqattrs_lock(); 62568639ecebSTejun Heo attrs = wq_sysfs_prep_attrs(wq); 62578639ecebSTejun Heo if (attrs) { 62588639ecebSTejun Heo attrs->affn_strict = (bool)v; 62598639ecebSTejun Heo ret = apply_workqueue_attrs_locked(wq, attrs); 62608639ecebSTejun Heo } 62618639ecebSTejun Heo apply_wqattrs_unlock(); 62628639ecebSTejun Heo free_workqueue_attrs(attrs); 62638639ecebSTejun Heo return ret ?: count; 62648639ecebSTejun Heo } 62658639ecebSTejun Heo 62666ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = { 62676ba94429SFrederic Weisbecker __ATTR(nice, 0644, wq_nice_show, wq_nice_store), 62686ba94429SFrederic Weisbecker __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store), 626963c5484eSTejun Heo __ATTR(affinity_scope, 0644, wq_affn_scope_show, wq_affn_scope_store), 62708639ecebSTejun Heo __ATTR(affinity_strict, 0644, wq_affinity_strict_show, wq_affinity_strict_store), 62716ba94429SFrederic Weisbecker __ATTR_NULL, 62726ba94429SFrederic Weisbecker }; 62736ba94429SFrederic Weisbecker 62746ba94429SFrederic Weisbecker static struct bus_type wq_subsys = { 62756ba94429SFrederic Weisbecker .name = "workqueue", 62766ba94429SFrederic Weisbecker .dev_groups = wq_sysfs_groups, 62776ba94429SFrederic Weisbecker }; 62786ba94429SFrederic Weisbecker 627949277a5bSWaiman Long /** 628049277a5bSWaiman Long * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask 628149277a5bSWaiman Long * @cpumask: the cpumask to set 628249277a5bSWaiman Long * 628349277a5bSWaiman Long * The low-level workqueues cpumask is a global cpumask that limits 628449277a5bSWaiman Long * the affinity of all unbound workqueues. This function check the @cpumask 628549277a5bSWaiman Long * and apply it to all unbound workqueues and updates all pwqs of them. 628649277a5bSWaiman Long * 628749277a5bSWaiman Long * Return: 0 - Success 628849277a5bSWaiman Long * -EINVAL - Invalid @cpumask 628949277a5bSWaiman Long * -ENOMEM - Failed to allocate memory for attrs or pwqs. 629049277a5bSWaiman Long */ 629149277a5bSWaiman Long static int workqueue_set_unbound_cpumask(cpumask_var_t cpumask) 629249277a5bSWaiman Long { 629349277a5bSWaiman Long int ret = -EINVAL; 629449277a5bSWaiman Long 629549277a5bSWaiman Long /* 629649277a5bSWaiman Long * Not excluding isolated cpus on purpose. 629749277a5bSWaiman Long * If the user wishes to include them, we allow that. 629849277a5bSWaiman Long */ 629949277a5bSWaiman Long cpumask_and(cpumask, cpumask, cpu_possible_mask); 630049277a5bSWaiman Long if (!cpumask_empty(cpumask)) { 630149277a5bSWaiman Long apply_wqattrs_lock(); 630249277a5bSWaiman Long cpumask_copy(wq_requested_unbound_cpumask, cpumask); 630349277a5bSWaiman Long if (cpumask_equal(cpumask, wq_unbound_cpumask)) { 630449277a5bSWaiman Long ret = 0; 630549277a5bSWaiman Long goto out_unlock; 630649277a5bSWaiman Long } 630749277a5bSWaiman Long 630849277a5bSWaiman Long ret = workqueue_apply_unbound_cpumask(cpumask); 630949277a5bSWaiman Long 631049277a5bSWaiman Long out_unlock: 631149277a5bSWaiman Long apply_wqattrs_unlock(); 631249277a5bSWaiman Long } 631349277a5bSWaiman Long 631449277a5bSWaiman Long return ret; 631549277a5bSWaiman Long } 631649277a5bSWaiman Long 6317fe28f631SWaiman Long static ssize_t __wq_cpumask_show(struct device *dev, 6318fe28f631SWaiman Long struct device_attribute *attr, char *buf, cpumask_var_t mask) 6319b05a7928SFrederic Weisbecker { 6320b05a7928SFrederic Weisbecker int written; 6321b05a7928SFrederic Weisbecker 6322042f7df1SLai Jiangshan mutex_lock(&wq_pool_mutex); 6323fe28f631SWaiman Long written = scnprintf(buf, PAGE_SIZE, "%*pb\n", cpumask_pr_args(mask)); 6324042f7df1SLai Jiangshan mutex_unlock(&wq_pool_mutex); 6325b05a7928SFrederic Weisbecker 6326b05a7928SFrederic Weisbecker return written; 6327b05a7928SFrederic Weisbecker } 6328b05a7928SFrederic Weisbecker 6329fe28f631SWaiman Long static ssize_t wq_unbound_cpumask_show(struct device *dev, 6330fe28f631SWaiman Long struct device_attribute *attr, char *buf) 6331fe28f631SWaiman Long { 6332fe28f631SWaiman Long return __wq_cpumask_show(dev, attr, buf, wq_unbound_cpumask); 6333fe28f631SWaiman Long } 6334fe28f631SWaiman Long 6335fe28f631SWaiman Long static ssize_t wq_requested_cpumask_show(struct device *dev, 6336fe28f631SWaiman Long struct device_attribute *attr, char *buf) 6337fe28f631SWaiman Long { 6338fe28f631SWaiman Long return __wq_cpumask_show(dev, attr, buf, wq_requested_unbound_cpumask); 6339fe28f631SWaiman Long } 6340fe28f631SWaiman Long 6341fe28f631SWaiman Long static ssize_t wq_isolated_cpumask_show(struct device *dev, 6342fe28f631SWaiman Long struct device_attribute *attr, char *buf) 6343fe28f631SWaiman Long { 6344fe28f631SWaiman Long return __wq_cpumask_show(dev, attr, buf, wq_isolated_cpumask); 6345fe28f631SWaiman Long } 6346fe28f631SWaiman Long 6347042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev, 6348042f7df1SLai Jiangshan struct device_attribute *attr, const char *buf, size_t count) 6349042f7df1SLai Jiangshan { 6350042f7df1SLai Jiangshan cpumask_var_t cpumask; 6351042f7df1SLai Jiangshan int ret; 6352042f7df1SLai Jiangshan 6353042f7df1SLai Jiangshan if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL)) 6354042f7df1SLai Jiangshan return -ENOMEM; 6355042f7df1SLai Jiangshan 6356042f7df1SLai Jiangshan ret = cpumask_parse(buf, cpumask); 6357042f7df1SLai Jiangshan if (!ret) 6358042f7df1SLai Jiangshan ret = workqueue_set_unbound_cpumask(cpumask); 6359042f7df1SLai Jiangshan 6360042f7df1SLai Jiangshan free_cpumask_var(cpumask); 6361042f7df1SLai Jiangshan return ret ? ret : count; 6362042f7df1SLai Jiangshan } 6363042f7df1SLai Jiangshan 6364fe28f631SWaiman Long static struct device_attribute wq_sysfs_cpumask_attrs[] = { 6365042f7df1SLai Jiangshan __ATTR(cpumask, 0644, wq_unbound_cpumask_show, 6366fe28f631SWaiman Long wq_unbound_cpumask_store), 6367fe28f631SWaiman Long __ATTR(cpumask_requested, 0444, wq_requested_cpumask_show, NULL), 6368fe28f631SWaiman Long __ATTR(cpumask_isolated, 0444, wq_isolated_cpumask_show, NULL), 6369fe28f631SWaiman Long __ATTR_NULL, 6370fe28f631SWaiman Long }; 6371b05a7928SFrederic Weisbecker 63726ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void) 63736ba94429SFrederic Weisbecker { 6374686f6697SGreg Kroah-Hartman struct device *dev_root; 6375b05a7928SFrederic Weisbecker int err; 6376b05a7928SFrederic Weisbecker 6377b05a7928SFrederic Weisbecker err = subsys_virtual_register(&wq_subsys, NULL); 6378b05a7928SFrederic Weisbecker if (err) 6379b05a7928SFrederic Weisbecker return err; 6380b05a7928SFrederic Weisbecker 6381686f6697SGreg Kroah-Hartman dev_root = bus_get_dev_root(&wq_subsys); 6382686f6697SGreg Kroah-Hartman if (dev_root) { 6383fe28f631SWaiman Long struct device_attribute *attr; 6384fe28f631SWaiman Long 6385fe28f631SWaiman Long for (attr = wq_sysfs_cpumask_attrs; attr->attr.name; attr++) { 6386fe28f631SWaiman Long err = device_create_file(dev_root, attr); 6387fe28f631SWaiman Long if (err) 6388fe28f631SWaiman Long break; 6389fe28f631SWaiman Long } 6390686f6697SGreg Kroah-Hartman put_device(dev_root); 6391686f6697SGreg Kroah-Hartman } 6392686f6697SGreg Kroah-Hartman return err; 63936ba94429SFrederic Weisbecker } 63946ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init); 63956ba94429SFrederic Weisbecker 63966ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev) 63976ba94429SFrederic Weisbecker { 63986ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 63996ba94429SFrederic Weisbecker 64006ba94429SFrederic Weisbecker kfree(wq_dev); 64016ba94429SFrederic Weisbecker } 64026ba94429SFrederic Weisbecker 64036ba94429SFrederic Weisbecker /** 64046ba94429SFrederic Weisbecker * workqueue_sysfs_register - make a workqueue visible in sysfs 64056ba94429SFrederic Weisbecker * @wq: the workqueue to register 64066ba94429SFrederic Weisbecker * 64076ba94429SFrederic Weisbecker * Expose @wq in sysfs under /sys/bus/workqueue/devices. 64086ba94429SFrederic Weisbecker * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set 64096ba94429SFrederic Weisbecker * which is the preferred method. 64106ba94429SFrederic Weisbecker * 64116ba94429SFrederic Weisbecker * Workqueue user should use this function directly iff it wants to apply 64126ba94429SFrederic Weisbecker * workqueue_attrs before making the workqueue visible in sysfs; otherwise, 64136ba94429SFrederic Weisbecker * apply_workqueue_attrs() may race against userland updating the 64146ba94429SFrederic Weisbecker * attributes. 64156ba94429SFrederic Weisbecker * 64166ba94429SFrederic Weisbecker * Return: 0 on success, -errno on failure. 64176ba94429SFrederic Weisbecker */ 64186ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq) 64196ba94429SFrederic Weisbecker { 64206ba94429SFrederic Weisbecker struct wq_device *wq_dev; 64216ba94429SFrederic Weisbecker int ret; 64226ba94429SFrederic Weisbecker 64236ba94429SFrederic Weisbecker /* 6424402dd89dSShailendra Verma * Adjusting max_active or creating new pwqs by applying 64256ba94429SFrederic Weisbecker * attributes breaks ordering guarantee. Disallow exposing ordered 64266ba94429SFrederic Weisbecker * workqueues. 64276ba94429SFrederic Weisbecker */ 64280a94efb5STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) 64296ba94429SFrederic Weisbecker return -EINVAL; 64306ba94429SFrederic Weisbecker 64316ba94429SFrederic Weisbecker wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL); 64326ba94429SFrederic Weisbecker if (!wq_dev) 64336ba94429SFrederic Weisbecker return -ENOMEM; 64346ba94429SFrederic Weisbecker 64356ba94429SFrederic Weisbecker wq_dev->wq = wq; 64366ba94429SFrederic Weisbecker wq_dev->dev.bus = &wq_subsys; 64376ba94429SFrederic Weisbecker wq_dev->dev.release = wq_device_release; 643823217b44SLars-Peter Clausen dev_set_name(&wq_dev->dev, "%s", wq->name); 64396ba94429SFrederic Weisbecker 64406ba94429SFrederic Weisbecker /* 64416ba94429SFrederic Weisbecker * unbound_attrs are created separately. Suppress uevent until 64426ba94429SFrederic Weisbecker * everything is ready. 64436ba94429SFrederic Weisbecker */ 64446ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, true); 64456ba94429SFrederic Weisbecker 64466ba94429SFrederic Weisbecker ret = device_register(&wq_dev->dev); 64476ba94429SFrederic Weisbecker if (ret) { 6448537f4146SArvind Yadav put_device(&wq_dev->dev); 64496ba94429SFrederic Weisbecker wq->wq_dev = NULL; 64506ba94429SFrederic Weisbecker return ret; 64516ba94429SFrederic Weisbecker } 64526ba94429SFrederic Weisbecker 64536ba94429SFrederic Weisbecker if (wq->flags & WQ_UNBOUND) { 64546ba94429SFrederic Weisbecker struct device_attribute *attr; 64556ba94429SFrederic Weisbecker 64566ba94429SFrederic Weisbecker for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) { 64576ba94429SFrederic Weisbecker ret = device_create_file(&wq_dev->dev, attr); 64586ba94429SFrederic Weisbecker if (ret) { 64596ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 64606ba94429SFrederic Weisbecker wq->wq_dev = NULL; 64616ba94429SFrederic Weisbecker return ret; 64626ba94429SFrederic Weisbecker } 64636ba94429SFrederic Weisbecker } 64646ba94429SFrederic Weisbecker } 64656ba94429SFrederic Weisbecker 64666ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, false); 64676ba94429SFrederic Weisbecker kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD); 64686ba94429SFrederic Weisbecker return 0; 64696ba94429SFrederic Weisbecker } 64706ba94429SFrederic Weisbecker 64716ba94429SFrederic Weisbecker /** 64726ba94429SFrederic Weisbecker * workqueue_sysfs_unregister - undo workqueue_sysfs_register() 64736ba94429SFrederic Weisbecker * @wq: the workqueue to unregister 64746ba94429SFrederic Weisbecker * 64756ba94429SFrederic Weisbecker * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister. 64766ba94429SFrederic Weisbecker */ 64776ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) 64786ba94429SFrederic Weisbecker { 64796ba94429SFrederic Weisbecker struct wq_device *wq_dev = wq->wq_dev; 64806ba94429SFrederic Weisbecker 64816ba94429SFrederic Weisbecker if (!wq->wq_dev) 64826ba94429SFrederic Weisbecker return; 64836ba94429SFrederic Weisbecker 64846ba94429SFrederic Weisbecker wq->wq_dev = NULL; 64856ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 64866ba94429SFrederic Weisbecker } 64876ba94429SFrederic Weisbecker #else /* CONFIG_SYSFS */ 64886ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { } 64896ba94429SFrederic Weisbecker #endif /* CONFIG_SYSFS */ 64906ba94429SFrederic Weisbecker 649182607adcSTejun Heo /* 649282607adcSTejun Heo * Workqueue watchdog. 649382607adcSTejun Heo * 649482607adcSTejun Heo * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal 649582607adcSTejun Heo * flush dependency, a concurrency managed work item which stays RUNNING 649682607adcSTejun Heo * indefinitely. Workqueue stalls can be very difficult to debug as the 649782607adcSTejun Heo * usual warning mechanisms don't trigger and internal workqueue state is 649882607adcSTejun Heo * largely opaque. 649982607adcSTejun Heo * 650082607adcSTejun Heo * Workqueue watchdog monitors all worker pools periodically and dumps 650182607adcSTejun Heo * state if some pools failed to make forward progress for a while where 650282607adcSTejun Heo * forward progress is defined as the first item on ->worklist changing. 650382607adcSTejun Heo * 650482607adcSTejun Heo * This mechanism is controlled through the kernel parameter 650582607adcSTejun Heo * "workqueue.watchdog_thresh" which can be updated at runtime through the 650682607adcSTejun Heo * corresponding sysfs parameter file. 650782607adcSTejun Heo */ 650882607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG 650982607adcSTejun Heo 651082607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30; 65115cd79d6aSKees Cook static struct timer_list wq_watchdog_timer; 651282607adcSTejun Heo 651382607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES; 651482607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES; 651582607adcSTejun Heo 6516cd2440d6SPetr Mladek /* 6517cd2440d6SPetr Mladek * Show workers that might prevent the processing of pending work items. 6518cd2440d6SPetr Mladek * The only candidates are CPU-bound workers in the running state. 6519cd2440d6SPetr Mladek * Pending work items should be handled by another idle worker 6520cd2440d6SPetr Mladek * in all other situations. 6521cd2440d6SPetr Mladek */ 6522cd2440d6SPetr Mladek static void show_cpu_pool_hog(struct worker_pool *pool) 6523cd2440d6SPetr Mladek { 6524cd2440d6SPetr Mladek struct worker *worker; 6525cd2440d6SPetr Mladek unsigned long flags; 6526cd2440d6SPetr Mladek int bkt; 6527cd2440d6SPetr Mladek 6528cd2440d6SPetr Mladek raw_spin_lock_irqsave(&pool->lock, flags); 6529cd2440d6SPetr Mladek 6530cd2440d6SPetr Mladek hash_for_each(pool->busy_hash, bkt, worker, hentry) { 6531cd2440d6SPetr Mladek if (task_is_running(worker->task)) { 6532cd2440d6SPetr Mladek /* 6533cd2440d6SPetr Mladek * Defer printing to avoid deadlocks in console 6534cd2440d6SPetr Mladek * drivers that queue work while holding locks 6535cd2440d6SPetr Mladek * also taken in their write paths. 6536cd2440d6SPetr Mladek */ 6537cd2440d6SPetr Mladek printk_deferred_enter(); 6538cd2440d6SPetr Mladek 6539cd2440d6SPetr Mladek pr_info("pool %d:\n", pool->id); 6540cd2440d6SPetr Mladek sched_show_task(worker->task); 6541cd2440d6SPetr Mladek 6542cd2440d6SPetr Mladek printk_deferred_exit(); 6543cd2440d6SPetr Mladek } 6544cd2440d6SPetr Mladek } 6545cd2440d6SPetr Mladek 6546cd2440d6SPetr Mladek raw_spin_unlock_irqrestore(&pool->lock, flags); 6547cd2440d6SPetr Mladek } 6548cd2440d6SPetr Mladek 6549cd2440d6SPetr Mladek static void show_cpu_pools_hogs(void) 6550cd2440d6SPetr Mladek { 6551cd2440d6SPetr Mladek struct worker_pool *pool; 6552cd2440d6SPetr Mladek int pi; 6553cd2440d6SPetr Mladek 6554cd2440d6SPetr Mladek pr_info("Showing backtraces of running workers in stalled CPU-bound worker pools:\n"); 6555cd2440d6SPetr Mladek 6556cd2440d6SPetr Mladek rcu_read_lock(); 6557cd2440d6SPetr Mladek 6558cd2440d6SPetr Mladek for_each_pool(pool, pi) { 6559cd2440d6SPetr Mladek if (pool->cpu_stall) 6560cd2440d6SPetr Mladek show_cpu_pool_hog(pool); 6561cd2440d6SPetr Mladek 6562cd2440d6SPetr Mladek } 6563cd2440d6SPetr Mladek 6564cd2440d6SPetr Mladek rcu_read_unlock(); 6565cd2440d6SPetr Mladek } 6566cd2440d6SPetr Mladek 656782607adcSTejun Heo static void wq_watchdog_reset_touched(void) 656882607adcSTejun Heo { 656982607adcSTejun Heo int cpu; 657082607adcSTejun Heo 657182607adcSTejun Heo wq_watchdog_touched = jiffies; 657282607adcSTejun Heo for_each_possible_cpu(cpu) 657382607adcSTejun Heo per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies; 657482607adcSTejun Heo } 657582607adcSTejun Heo 65765cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused) 657782607adcSTejun Heo { 657882607adcSTejun Heo unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ; 657982607adcSTejun Heo bool lockup_detected = false; 6580cd2440d6SPetr Mladek bool cpu_pool_stall = false; 6581940d71c6SSergey Senozhatsky unsigned long now = jiffies; 658282607adcSTejun Heo struct worker_pool *pool; 658382607adcSTejun Heo int pi; 658482607adcSTejun Heo 658582607adcSTejun Heo if (!thresh) 658682607adcSTejun Heo return; 658782607adcSTejun Heo 658882607adcSTejun Heo rcu_read_lock(); 658982607adcSTejun Heo 659082607adcSTejun Heo for_each_pool(pool, pi) { 659182607adcSTejun Heo unsigned long pool_ts, touched, ts; 659282607adcSTejun Heo 6593cd2440d6SPetr Mladek pool->cpu_stall = false; 659482607adcSTejun Heo if (list_empty(&pool->worklist)) 659582607adcSTejun Heo continue; 659682607adcSTejun Heo 6597940d71c6SSergey Senozhatsky /* 6598940d71c6SSergey Senozhatsky * If a virtual machine is stopped by the host it can look to 6599940d71c6SSergey Senozhatsky * the watchdog like a stall. 6600940d71c6SSergey Senozhatsky */ 6601940d71c6SSergey Senozhatsky kvm_check_and_clear_guest_paused(); 6602940d71c6SSergey Senozhatsky 660382607adcSTejun Heo /* get the latest of pool and touched timestamps */ 660489e28ce6SWang Qing if (pool->cpu >= 0) 660589e28ce6SWang Qing touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu)); 660689e28ce6SWang Qing else 660782607adcSTejun Heo touched = READ_ONCE(wq_watchdog_touched); 660889e28ce6SWang Qing pool_ts = READ_ONCE(pool->watchdog_ts); 660982607adcSTejun Heo 661082607adcSTejun Heo if (time_after(pool_ts, touched)) 661182607adcSTejun Heo ts = pool_ts; 661282607adcSTejun Heo else 661382607adcSTejun Heo ts = touched; 661482607adcSTejun Heo 661582607adcSTejun Heo /* did we stall? */ 6616940d71c6SSergey Senozhatsky if (time_after(now, ts + thresh)) { 661782607adcSTejun Heo lockup_detected = true; 6618cd2440d6SPetr Mladek if (pool->cpu >= 0) { 6619cd2440d6SPetr Mladek pool->cpu_stall = true; 6620cd2440d6SPetr Mladek cpu_pool_stall = true; 6621cd2440d6SPetr Mladek } 662282607adcSTejun Heo pr_emerg("BUG: workqueue lockup - pool"); 662382607adcSTejun Heo pr_cont_pool_info(pool); 662482607adcSTejun Heo pr_cont(" stuck for %us!\n", 6625940d71c6SSergey Senozhatsky jiffies_to_msecs(now - pool_ts) / 1000); 662682607adcSTejun Heo } 6627cd2440d6SPetr Mladek 6628cd2440d6SPetr Mladek 662982607adcSTejun Heo } 663082607adcSTejun Heo 663182607adcSTejun Heo rcu_read_unlock(); 663282607adcSTejun Heo 663382607adcSTejun Heo if (lockup_detected) 663455df0933SImran Khan show_all_workqueues(); 663582607adcSTejun Heo 6636cd2440d6SPetr Mladek if (cpu_pool_stall) 6637cd2440d6SPetr Mladek show_cpu_pools_hogs(); 6638cd2440d6SPetr Mladek 663982607adcSTejun Heo wq_watchdog_reset_touched(); 664082607adcSTejun Heo mod_timer(&wq_watchdog_timer, jiffies + thresh); 664182607adcSTejun Heo } 664282607adcSTejun Heo 6643cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu) 664482607adcSTejun Heo { 664582607adcSTejun Heo if (cpu >= 0) 664682607adcSTejun Heo per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies; 664789e28ce6SWang Qing 664882607adcSTejun Heo wq_watchdog_touched = jiffies; 664982607adcSTejun Heo } 665082607adcSTejun Heo 665182607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh) 665282607adcSTejun Heo { 665382607adcSTejun Heo wq_watchdog_thresh = 0; 665482607adcSTejun Heo del_timer_sync(&wq_watchdog_timer); 665582607adcSTejun Heo 665682607adcSTejun Heo if (thresh) { 665782607adcSTejun Heo wq_watchdog_thresh = thresh; 665882607adcSTejun Heo wq_watchdog_reset_touched(); 665982607adcSTejun Heo mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ); 666082607adcSTejun Heo } 666182607adcSTejun Heo } 666282607adcSTejun Heo 666382607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val, 666482607adcSTejun Heo const struct kernel_param *kp) 666582607adcSTejun Heo { 666682607adcSTejun Heo unsigned long thresh; 666782607adcSTejun Heo int ret; 666882607adcSTejun Heo 666982607adcSTejun Heo ret = kstrtoul(val, 0, &thresh); 667082607adcSTejun Heo if (ret) 667182607adcSTejun Heo return ret; 667282607adcSTejun Heo 667382607adcSTejun Heo if (system_wq) 667482607adcSTejun Heo wq_watchdog_set_thresh(thresh); 667582607adcSTejun Heo else 667682607adcSTejun Heo wq_watchdog_thresh = thresh; 667782607adcSTejun Heo 667882607adcSTejun Heo return 0; 667982607adcSTejun Heo } 668082607adcSTejun Heo 668182607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = { 668282607adcSTejun Heo .set = wq_watchdog_param_set_thresh, 668382607adcSTejun Heo .get = param_get_ulong, 668482607adcSTejun Heo }; 668582607adcSTejun Heo 668682607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh, 668782607adcSTejun Heo 0644); 668882607adcSTejun Heo 668982607adcSTejun Heo static void wq_watchdog_init(void) 669082607adcSTejun Heo { 66915cd79d6aSKees Cook timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE); 669282607adcSTejun Heo wq_watchdog_set_thresh(wq_watchdog_thresh); 669382607adcSTejun Heo } 669482607adcSTejun Heo 669582607adcSTejun Heo #else /* CONFIG_WQ_WATCHDOG */ 669682607adcSTejun Heo 669782607adcSTejun Heo static inline void wq_watchdog_init(void) { } 669882607adcSTejun Heo 669982607adcSTejun Heo #endif /* CONFIG_WQ_WATCHDOG */ 670082607adcSTejun Heo 67014a6c5607STejun Heo static void __init restrict_unbound_cpumask(const char *name, const struct cpumask *mask) 67024a6c5607STejun Heo { 67034a6c5607STejun Heo if (!cpumask_intersects(wq_unbound_cpumask, mask)) { 67044a6c5607STejun Heo pr_warn("workqueue: Restricting unbound_cpumask (%*pb) with %s (%*pb) leaves no CPU, ignoring\n", 67054a6c5607STejun Heo cpumask_pr_args(wq_unbound_cpumask), name, cpumask_pr_args(mask)); 67064a6c5607STejun Heo return; 67074a6c5607STejun Heo } 67084a6c5607STejun Heo 67094a6c5607STejun Heo cpumask_and(wq_unbound_cpumask, wq_unbound_cpumask, mask); 67104a6c5607STejun Heo } 67114a6c5607STejun Heo 67123347fa09STejun Heo /** 67133347fa09STejun Heo * workqueue_init_early - early init for workqueue subsystem 67143347fa09STejun Heo * 67152930155bSTejun Heo * This is the first step of three-staged workqueue subsystem initialization and 67162930155bSTejun Heo * invoked as soon as the bare basics - memory allocation, cpumasks and idr are 67172930155bSTejun Heo * up. It sets up all the data structures and system workqueues and allows early 67182930155bSTejun Heo * boot code to create workqueues and queue/cancel work items. Actual work item 67192930155bSTejun Heo * execution starts only after kthreads can be created and scheduled right 67202930155bSTejun Heo * before early initcalls. 67213347fa09STejun Heo */ 67222333e829SYu Chen void __init workqueue_init_early(void) 67231da177e4SLinus Torvalds { 672484193c07STejun Heo struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_SYSTEM]; 67257a4e344cSTejun Heo int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL }; 67267a4e344cSTejun Heo int i, cpu; 6727c34056a3STejun Heo 672810cdb157SLai Jiangshan BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long)); 6729e904e6c2STejun Heo 6730b05a7928SFrederic Weisbecker BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL)); 6731fe28f631SWaiman Long BUG_ON(!alloc_cpumask_var(&wq_requested_unbound_cpumask, GFP_KERNEL)); 6732fe28f631SWaiman Long BUG_ON(!zalloc_cpumask_var(&wq_isolated_cpumask, GFP_KERNEL)); 6733b05a7928SFrederic Weisbecker 67344a6c5607STejun Heo cpumask_copy(wq_unbound_cpumask, cpu_possible_mask); 67354a6c5607STejun Heo restrict_unbound_cpumask("HK_TYPE_WQ", housekeeping_cpumask(HK_TYPE_WQ)); 67364a6c5607STejun Heo restrict_unbound_cpumask("HK_TYPE_DOMAIN", housekeeping_cpumask(HK_TYPE_DOMAIN)); 6737ace3c549Stiozhang if (!cpumask_empty(&wq_cmdline_cpumask)) 67384a6c5607STejun Heo restrict_unbound_cpumask("workqueue.unbound_cpus", &wq_cmdline_cpumask); 6739ace3c549Stiozhang 6740fe28f631SWaiman Long cpumask_copy(wq_requested_unbound_cpumask, wq_unbound_cpumask); 67418b03ae3cSTejun Heo 67428b03ae3cSTejun Heo pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC); 6743e22bee78STejun Heo 67442930155bSTejun Heo wq_update_pod_attrs_buf = alloc_workqueue_attrs(); 67452930155bSTejun Heo BUG_ON(!wq_update_pod_attrs_buf); 67462930155bSTejun Heo 67477bd20b6bSMarcelo Tosatti /* 67487bd20b6bSMarcelo Tosatti * If nohz_full is enabled, set power efficient workqueue as unbound. 67497bd20b6bSMarcelo Tosatti * This allows workqueue items to be moved to HK CPUs. 67507bd20b6bSMarcelo Tosatti */ 67517bd20b6bSMarcelo Tosatti if (housekeeping_enabled(HK_TYPE_TICK)) 67527bd20b6bSMarcelo Tosatti wq_power_efficient = true; 67537bd20b6bSMarcelo Tosatti 675484193c07STejun Heo /* initialize WQ_AFFN_SYSTEM pods */ 675584193c07STejun Heo pt->pod_cpus = kcalloc(1, sizeof(pt->pod_cpus[0]), GFP_KERNEL); 675684193c07STejun Heo pt->pod_node = kcalloc(1, sizeof(pt->pod_node[0]), GFP_KERNEL); 675784193c07STejun Heo pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL); 675884193c07STejun Heo BUG_ON(!pt->pod_cpus || !pt->pod_node || !pt->cpu_pod); 675984193c07STejun Heo 676084193c07STejun Heo BUG_ON(!zalloc_cpumask_var_node(&pt->pod_cpus[0], GFP_KERNEL, NUMA_NO_NODE)); 676184193c07STejun Heo 676284193c07STejun Heo pt->nr_pods = 1; 676384193c07STejun Heo cpumask_copy(pt->pod_cpus[0], cpu_possible_mask); 676484193c07STejun Heo pt->pod_node[0] = NUMA_NO_NODE; 676584193c07STejun Heo pt->cpu_pod[0] = 0; 676684193c07STejun Heo 6767f02ae73aSTejun Heo /* initialize CPU pools */ 676824647570STejun Heo for_each_possible_cpu(cpu) { 6769ebf44d16STejun Heo struct worker_pool *pool; 6770e22bee78STejun Heo 67714ce62e9eSTejun Heo i = 0; 6772e22bee78STejun Heo for_each_cpu_worker_pool(pool, cpu) { 677329c91e99STejun Heo BUG_ON(init_worker_pool(pool)); 677429c91e99STejun Heo pool->cpu = cpu; 677529c91e99STejun Heo cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu)); 67769546b29eSTejun Heo cpumask_copy(pool->attrs->__pod_cpumask, cpumask_of(cpu)); 67771da177e4SLinus Torvalds pool->attrs->nice = std_nice[i++]; 67788639ecebSTejun Heo pool->attrs->affn_strict = true; 67791da177e4SLinus Torvalds pool->node = cpu_to_node(cpu); 67801da177e4SLinus Torvalds 67811da177e4SLinus Torvalds /* alloc pool ID */ 67821da177e4SLinus Torvalds mutex_lock(&wq_pool_mutex); 67831da177e4SLinus Torvalds BUG_ON(worker_pool_assign_id(pool)); 67841da177e4SLinus Torvalds mutex_unlock(&wq_pool_mutex); 678529c91e99STejun Heo } 678629c91e99STejun Heo } 678729c91e99STejun Heo 67888a2b7538STejun Heo /* create default unbound and ordered wq attrs */ 678929c91e99STejun Heo for (i = 0; i < NR_STD_WORKER_POOLS; i++) { 679029c91e99STejun Heo struct workqueue_attrs *attrs; 679129c91e99STejun Heo 6792be69d00dSThomas Gleixner BUG_ON(!(attrs = alloc_workqueue_attrs())); 679329c91e99STejun Heo attrs->nice = std_nice[i]; 679429c91e99STejun Heo unbound_std_wq_attrs[i] = attrs; 67958a2b7538STejun Heo 67968a2b7538STejun Heo /* 67978a2b7538STejun Heo * An ordered wq should have only one pwq as ordering is 67988a2b7538STejun Heo * guaranteed by max_active which is enforced by pwqs. 67998a2b7538STejun Heo */ 6800be69d00dSThomas Gleixner BUG_ON(!(attrs = alloc_workqueue_attrs())); 68018a2b7538STejun Heo attrs->nice = std_nice[i]; 6802af73f5c9STejun Heo attrs->ordered = true; 68038a2b7538STejun Heo ordered_wq_attrs[i] = attrs; 680429c91e99STejun Heo } 680529c91e99STejun Heo 68061da177e4SLinus Torvalds system_wq = alloc_workqueue("events", 0, 0); 68071aabe902SJoonsoo Kim system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0); 68081da177e4SLinus Torvalds system_long_wq = alloc_workqueue("events_long", 0, 0); 68091da177e4SLinus Torvalds system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, 6810636b927eSTejun Heo WQ_MAX_ACTIVE); 68111da177e4SLinus Torvalds system_freezable_wq = alloc_workqueue("events_freezable", 68121da177e4SLinus Torvalds WQ_FREEZABLE, 0); 68130668106cSViresh Kumar system_power_efficient_wq = alloc_workqueue("events_power_efficient", 68140668106cSViresh Kumar WQ_POWER_EFFICIENT, 0); 68158318d6a6SAudra Mitchell system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_pwr_efficient", 68160668106cSViresh Kumar WQ_FREEZABLE | WQ_POWER_EFFICIENT, 68170668106cSViresh Kumar 0); 68181aabe902SJoonsoo Kim BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq || 68190668106cSViresh Kumar !system_unbound_wq || !system_freezable_wq || 68200668106cSViresh Kumar !system_power_efficient_wq || 68210668106cSViresh Kumar !system_freezable_power_efficient_wq); 68223347fa09STejun Heo } 68233347fa09STejun Heo 6824aa6fde93STejun Heo static void __init wq_cpu_intensive_thresh_init(void) 6825aa6fde93STejun Heo { 6826aa6fde93STejun Heo unsigned long thresh; 6827aa6fde93STejun Heo unsigned long bogo; 6828aa6fde93STejun Heo 6829dd64c873SZqiang pwq_release_worker = kthread_create_worker(0, "pool_workqueue_release"); 6830dd64c873SZqiang BUG_ON(IS_ERR(pwq_release_worker)); 6831dd64c873SZqiang 6832aa6fde93STejun Heo /* if the user set it to a specific value, keep it */ 6833aa6fde93STejun Heo if (wq_cpu_intensive_thresh_us != ULONG_MAX) 6834aa6fde93STejun Heo return; 6835aa6fde93STejun Heo 6836aa6fde93STejun Heo /* 6837aa6fde93STejun Heo * The default of 10ms is derived from the fact that most modern (as of 6838aa6fde93STejun Heo * 2023) processors can do a lot in 10ms and that it's just below what 6839aa6fde93STejun Heo * most consider human-perceivable. However, the kernel also runs on a 6840aa6fde93STejun Heo * lot slower CPUs including microcontrollers where the threshold is way 6841aa6fde93STejun Heo * too low. 6842aa6fde93STejun Heo * 6843aa6fde93STejun Heo * Let's scale up the threshold upto 1 second if BogoMips is below 4000. 6844aa6fde93STejun Heo * This is by no means accurate but it doesn't have to be. The mechanism 6845aa6fde93STejun Heo * is still useful even when the threshold is fully scaled up. Also, as 6846aa6fde93STejun Heo * the reports would usually be applicable to everyone, some machines 6847aa6fde93STejun Heo * operating on longer thresholds won't significantly diminish their 6848aa6fde93STejun Heo * usefulness. 6849aa6fde93STejun Heo */ 6850aa6fde93STejun Heo thresh = 10 * USEC_PER_MSEC; 6851aa6fde93STejun Heo 6852aa6fde93STejun Heo /* see init/calibrate.c for lpj -> BogoMIPS calculation */ 6853aa6fde93STejun Heo bogo = max_t(unsigned long, loops_per_jiffy / 500000 * HZ, 1); 6854aa6fde93STejun Heo if (bogo < 4000) 6855aa6fde93STejun Heo thresh = min_t(unsigned long, thresh * 4000 / bogo, USEC_PER_SEC); 6856aa6fde93STejun Heo 6857aa6fde93STejun Heo pr_debug("wq_cpu_intensive_thresh: lpj=%lu BogoMIPS=%lu thresh_us=%lu\n", 6858aa6fde93STejun Heo loops_per_jiffy, bogo, thresh); 6859aa6fde93STejun Heo 6860aa6fde93STejun Heo wq_cpu_intensive_thresh_us = thresh; 6861aa6fde93STejun Heo } 6862aa6fde93STejun Heo 68633347fa09STejun Heo /** 68643347fa09STejun Heo * workqueue_init - bring workqueue subsystem fully online 68653347fa09STejun Heo * 68662930155bSTejun Heo * This is the second step of three-staged workqueue subsystem initialization 68672930155bSTejun Heo * and invoked as soon as kthreads can be created and scheduled. Workqueues have 68682930155bSTejun Heo * been created and work items queued on them, but there are no kworkers 68692930155bSTejun Heo * executing the work items yet. Populate the worker pools with the initial 68702930155bSTejun Heo * workers and enable future kworker creations. 68713347fa09STejun Heo */ 68722333e829SYu Chen void __init workqueue_init(void) 68733347fa09STejun Heo { 68742186d9f9STejun Heo struct workqueue_struct *wq; 68753347fa09STejun Heo struct worker_pool *pool; 68763347fa09STejun Heo int cpu, bkt; 68773347fa09STejun Heo 6878aa6fde93STejun Heo wq_cpu_intensive_thresh_init(); 6879aa6fde93STejun Heo 68802186d9f9STejun Heo mutex_lock(&wq_pool_mutex); 68812186d9f9STejun Heo 68822930155bSTejun Heo /* 68832930155bSTejun Heo * Per-cpu pools created earlier could be missing node hint. Fix them 68842930155bSTejun Heo * up. Also, create a rescuer for workqueues that requested it. 68852930155bSTejun Heo */ 68862186d9f9STejun Heo for_each_possible_cpu(cpu) { 68872186d9f9STejun Heo for_each_cpu_worker_pool(pool, cpu) { 68882186d9f9STejun Heo pool->node = cpu_to_node(cpu); 68892186d9f9STejun Heo } 68902186d9f9STejun Heo } 68912186d9f9STejun Heo 689240c17f75STejun Heo list_for_each_entry(wq, &workqueues, list) { 689340c17f75STejun Heo WARN(init_rescuer(wq), 689440c17f75STejun Heo "workqueue: failed to create early rescuer for %s", 689540c17f75STejun Heo wq->name); 689640c17f75STejun Heo } 68972186d9f9STejun Heo 68982186d9f9STejun Heo mutex_unlock(&wq_pool_mutex); 68992186d9f9STejun Heo 69003347fa09STejun Heo /* create the initial workers */ 69013347fa09STejun Heo for_each_online_cpu(cpu) { 69023347fa09STejun Heo for_each_cpu_worker_pool(pool, cpu) { 69033347fa09STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 69043347fa09STejun Heo BUG_ON(!create_worker(pool)); 69053347fa09STejun Heo } 69063347fa09STejun Heo } 69073347fa09STejun Heo 69083347fa09STejun Heo hash_for_each(unbound_pool_hash, bkt, pool, hash_node) 69093347fa09STejun Heo BUG_ON(!create_worker(pool)); 69103347fa09STejun Heo 69113347fa09STejun Heo wq_online = true; 691282607adcSTejun Heo wq_watchdog_init(); 69131da177e4SLinus Torvalds } 6914c4f135d6STetsuo Handa 6915025e1684STejun Heo /* 6916025e1684STejun Heo * Initialize @pt by first initializing @pt->cpu_pod[] with pod IDs according to 6917025e1684STejun Heo * @cpu_shares_pod(). Each subset of CPUs that share a pod is assigned a unique 6918025e1684STejun Heo * and consecutive pod ID. The rest of @pt is initialized accordingly. 6919025e1684STejun Heo */ 6920025e1684STejun Heo static void __init init_pod_type(struct wq_pod_type *pt, 6921025e1684STejun Heo bool (*cpus_share_pod)(int, int)) 6922025e1684STejun Heo { 6923025e1684STejun Heo int cur, pre, cpu, pod; 6924025e1684STejun Heo 6925025e1684STejun Heo pt->nr_pods = 0; 6926025e1684STejun Heo 6927025e1684STejun Heo /* init @pt->cpu_pod[] according to @cpus_share_pod() */ 6928025e1684STejun Heo pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL); 6929025e1684STejun Heo BUG_ON(!pt->cpu_pod); 6930025e1684STejun Heo 6931025e1684STejun Heo for_each_possible_cpu(cur) { 6932025e1684STejun Heo for_each_possible_cpu(pre) { 6933025e1684STejun Heo if (pre >= cur) { 6934025e1684STejun Heo pt->cpu_pod[cur] = pt->nr_pods++; 6935025e1684STejun Heo break; 6936025e1684STejun Heo } 6937025e1684STejun Heo if (cpus_share_pod(cur, pre)) { 6938025e1684STejun Heo pt->cpu_pod[cur] = pt->cpu_pod[pre]; 6939025e1684STejun Heo break; 6940025e1684STejun Heo } 6941025e1684STejun Heo } 6942025e1684STejun Heo } 6943025e1684STejun Heo 6944025e1684STejun Heo /* init the rest to match @pt->cpu_pod[] */ 6945025e1684STejun Heo pt->pod_cpus = kcalloc(pt->nr_pods, sizeof(pt->pod_cpus[0]), GFP_KERNEL); 6946025e1684STejun Heo pt->pod_node = kcalloc(pt->nr_pods, sizeof(pt->pod_node[0]), GFP_KERNEL); 6947025e1684STejun Heo BUG_ON(!pt->pod_cpus || !pt->pod_node); 6948025e1684STejun Heo 6949025e1684STejun Heo for (pod = 0; pod < pt->nr_pods; pod++) 6950025e1684STejun Heo BUG_ON(!zalloc_cpumask_var(&pt->pod_cpus[pod], GFP_KERNEL)); 6951025e1684STejun Heo 6952025e1684STejun Heo for_each_possible_cpu(cpu) { 6953025e1684STejun Heo cpumask_set_cpu(cpu, pt->pod_cpus[pt->cpu_pod[cpu]]); 6954025e1684STejun Heo pt->pod_node[pt->cpu_pod[cpu]] = cpu_to_node(cpu); 6955025e1684STejun Heo } 6956025e1684STejun Heo } 6957025e1684STejun Heo 695863c5484eSTejun Heo static bool __init cpus_dont_share(int cpu0, int cpu1) 695963c5484eSTejun Heo { 696063c5484eSTejun Heo return false; 696163c5484eSTejun Heo } 696263c5484eSTejun Heo 696363c5484eSTejun Heo static bool __init cpus_share_smt(int cpu0, int cpu1) 696463c5484eSTejun Heo { 696563c5484eSTejun Heo #ifdef CONFIG_SCHED_SMT 696663c5484eSTejun Heo return cpumask_test_cpu(cpu0, cpu_smt_mask(cpu1)); 696763c5484eSTejun Heo #else 696863c5484eSTejun Heo return false; 696963c5484eSTejun Heo #endif 697063c5484eSTejun Heo } 697163c5484eSTejun Heo 6972025e1684STejun Heo static bool __init cpus_share_numa(int cpu0, int cpu1) 6973025e1684STejun Heo { 6974025e1684STejun Heo return cpu_to_node(cpu0) == cpu_to_node(cpu1); 6975025e1684STejun Heo } 6976025e1684STejun Heo 69772930155bSTejun Heo /** 69782930155bSTejun Heo * workqueue_init_topology - initialize CPU pods for unbound workqueues 69792930155bSTejun Heo * 69802930155bSTejun Heo * This is the third step of there-staged workqueue subsystem initialization and 69812930155bSTejun Heo * invoked after SMP and topology information are fully initialized. It 69822930155bSTejun Heo * initializes the unbound CPU pods accordingly. 69832930155bSTejun Heo */ 69842930155bSTejun Heo void __init workqueue_init_topology(void) 6985a86feae6STejun Heo { 69862930155bSTejun Heo struct workqueue_struct *wq; 6987025e1684STejun Heo int cpu; 6988a86feae6STejun Heo 698963c5484eSTejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_CPU], cpus_dont_share); 699063c5484eSTejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_SMT], cpus_share_smt); 699163c5484eSTejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_CACHE], cpus_share_cache); 6992025e1684STejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_NUMA], cpus_share_numa); 6993a86feae6STejun Heo 69942930155bSTejun Heo mutex_lock(&wq_pool_mutex); 6995a86feae6STejun Heo 6996a86feae6STejun Heo /* 69972930155bSTejun Heo * Workqueues allocated earlier would have all CPUs sharing the default 69982930155bSTejun Heo * worker pool. Explicitly call wq_update_pod() on all workqueue and CPU 69992930155bSTejun Heo * combinations to apply per-pod sharing. 70002930155bSTejun Heo */ 70012930155bSTejun Heo list_for_each_entry(wq, &workqueues, list) { 70022930155bSTejun Heo for_each_online_cpu(cpu) { 70032930155bSTejun Heo wq_update_pod(wq, cpu, cpu, true); 70042930155bSTejun Heo } 70052930155bSTejun Heo } 70062930155bSTejun Heo 70072930155bSTejun Heo mutex_unlock(&wq_pool_mutex); 7008a86feae6STejun Heo } 7009a86feae6STejun Heo 701020bdedafSTetsuo Handa void __warn_flushing_systemwide_wq(void) 701120bdedafSTetsuo Handa { 701220bdedafSTetsuo Handa pr_warn("WARNING: Flushing system-wide workqueues will be prohibited in near future.\n"); 701320bdedafSTetsuo Handa dump_stack(); 701420bdedafSTetsuo Handa } 7015c4f135d6STetsuo Handa EXPORT_SYMBOL(__warn_flushing_systemwide_wq); 7016ace3c549Stiozhang 7017ace3c549Stiozhang static int __init workqueue_unbound_cpus_setup(char *str) 7018ace3c549Stiozhang { 7019ace3c549Stiozhang if (cpulist_parse(str, &wq_cmdline_cpumask) < 0) { 7020ace3c549Stiozhang cpumask_clear(&wq_cmdline_cpumask); 7021ace3c549Stiozhang pr_warn("workqueue.unbound_cpus: incorrect CPU range, using default\n"); 7022ace3c549Stiozhang } 7023ace3c549Stiozhang 7024ace3c549Stiozhang return 1; 7025ace3c549Stiozhang } 7026ace3c549Stiozhang __setup("workqueue.unbound_cpus=", workqueue_unbound_cpus_setup); 7027