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 */ 3115b95e1afSLai Jiangshan struct pool_workqueue *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 64273f53c4aSTejun Heo static unsigned int work_color_to_flags(int color) 64373f53c4aSTejun Heo { 64473f53c4aSTejun Heo return color << WORK_STRUCT_COLOR_SHIFT; 64573f53c4aSTejun Heo } 64673f53c4aSTejun Heo 647c4560c2cSLai Jiangshan static int get_work_color(unsigned long work_data) 64873f53c4aSTejun Heo { 649c4560c2cSLai Jiangshan return (work_data >> WORK_STRUCT_COLOR_SHIFT) & 65073f53c4aSTejun Heo ((1 << WORK_STRUCT_COLOR_BITS) - 1); 65173f53c4aSTejun Heo } 65273f53c4aSTejun Heo 65373f53c4aSTejun Heo static int work_next_color(int color) 65473f53c4aSTejun Heo { 65573f53c4aSTejun Heo return (color + 1) % WORK_NR_COLORS; 656a848e3b6SOleg Nesterov } 657a848e3b6SOleg Nesterov 6584594bf15SDavid Howells /* 659112202d9STejun Heo * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data 660112202d9STejun Heo * contain the pointer to the queued pwq. Once execution starts, the flag 6617c3eed5cSTejun Heo * is cleared and the high bits contain OFFQ flags and pool ID. 6627a22ad75STejun Heo * 663112202d9STejun Heo * set_work_pwq(), set_work_pool_and_clear_pending(), mark_work_canceling() 664112202d9STejun Heo * and clear_work_data() can be used to set the pwq, pool or clear 665bbb68dfaSTejun Heo * work->data. These functions should only be called while the work is 666bbb68dfaSTejun Heo * owned - ie. while the PENDING bit is set. 6677a22ad75STejun Heo * 668112202d9STejun Heo * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq 6697c3eed5cSTejun Heo * corresponding to a work. Pool is available once the work has been 670112202d9STejun Heo * queued anywhere after initialization until it is sync canceled. pwq is 6717c3eed5cSTejun Heo * available only while the work item is queued. 672bbb68dfaSTejun Heo * 673bbb68dfaSTejun Heo * %WORK_OFFQ_CANCELING is used to mark a work item which is being 674bbb68dfaSTejun Heo * canceled. While being canceled, a work item may have its PENDING set 675bbb68dfaSTejun Heo * but stay off timer and worklist for arbitrarily long and nobody should 676bbb68dfaSTejun Heo * try to steal the PENDING bit. 6774594bf15SDavid Howells */ 6787a22ad75STejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data, 6797a22ad75STejun Heo unsigned long flags) 6807a22ad75STejun Heo { 6816183c009STejun Heo WARN_ON_ONCE(!work_pending(work)); 6827a22ad75STejun Heo atomic_long_set(&work->data, data | flags | work_static(work)); 6837a22ad75STejun Heo } 6847a22ad75STejun Heo 685112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq, 6864690c4abSTejun Heo unsigned long extra_flags) 687365970a1SDavid Howells { 688112202d9STejun Heo set_work_data(work, (unsigned long)pwq, 689112202d9STejun Heo WORK_STRUCT_PENDING | WORK_STRUCT_PWQ | extra_flags); 690365970a1SDavid Howells } 691365970a1SDavid Howells 6924468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work, 6934468a00fSLai Jiangshan int pool_id) 6944468a00fSLai Jiangshan { 6954468a00fSLai Jiangshan set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 6964468a00fSLai Jiangshan WORK_STRUCT_PENDING); 6974468a00fSLai Jiangshan } 6984468a00fSLai Jiangshan 6997c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work, 7007c3eed5cSTejun Heo int pool_id) 7014d707b9fSOleg Nesterov { 70223657bb1STejun Heo /* 70323657bb1STejun Heo * The following wmb is paired with the implied mb in 70423657bb1STejun Heo * test_and_set_bit(PENDING) and ensures all updates to @work made 70523657bb1STejun Heo * here are visible to and precede any updates by the next PENDING 70623657bb1STejun Heo * owner. 70723657bb1STejun Heo */ 70823657bb1STejun Heo smp_wmb(); 7097c3eed5cSTejun Heo set_work_data(work, (unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT, 0); 710346c09f8SRoman Pen /* 711346c09f8SRoman Pen * The following mb guarantees that previous clear of a PENDING bit 712346c09f8SRoman Pen * will not be reordered with any speculative LOADS or STORES from 713346c09f8SRoman Pen * work->current_func, which is executed afterwards. This possible 7148bdc6201SLiu Song * reordering can lead to a missed execution on attempt to queue 715346c09f8SRoman Pen * the same @work. E.g. consider this case: 716346c09f8SRoman Pen * 717346c09f8SRoman Pen * CPU#0 CPU#1 718346c09f8SRoman Pen * ---------------------------- -------------------------------- 719346c09f8SRoman Pen * 720346c09f8SRoman Pen * 1 STORE event_indicated 721346c09f8SRoman Pen * 2 queue_work_on() { 722346c09f8SRoman Pen * 3 test_and_set_bit(PENDING) 723346c09f8SRoman Pen * 4 } set_..._and_clear_pending() { 724346c09f8SRoman Pen * 5 set_work_data() # clear bit 725346c09f8SRoman Pen * 6 smp_mb() 726346c09f8SRoman Pen * 7 work->current_func() { 727346c09f8SRoman Pen * 8 LOAD event_indicated 728346c09f8SRoman Pen * } 729346c09f8SRoman Pen * 730346c09f8SRoman Pen * Without an explicit full barrier speculative LOAD on line 8 can 731346c09f8SRoman Pen * be executed before CPU#0 does STORE on line 1. If that happens, 732346c09f8SRoman Pen * CPU#0 observes the PENDING bit is still set and new execution of 733346c09f8SRoman Pen * a @work is not queued in a hope, that CPU#1 will eventually 734346c09f8SRoman Pen * finish the queued @work. Meanwhile CPU#1 does not see 735346c09f8SRoman Pen * event_indicated is set, because speculative LOAD was executed 736346c09f8SRoman Pen * before actual STORE. 737346c09f8SRoman Pen */ 738346c09f8SRoman Pen smp_mb(); 7394d707b9fSOleg Nesterov } 7404d707b9fSOleg Nesterov 7417a22ad75STejun Heo static void clear_work_data(struct work_struct *work) 742365970a1SDavid Howells { 7437c3eed5cSTejun Heo smp_wmb(); /* see set_work_pool_and_clear_pending() */ 7447c3eed5cSTejun Heo set_work_data(work, WORK_STRUCT_NO_POOL, 0); 7457a22ad75STejun Heo } 7467a22ad75STejun Heo 747afa4bb77SLinus Torvalds static inline struct pool_workqueue *work_struct_pwq(unsigned long data) 748afa4bb77SLinus Torvalds { 749afa4bb77SLinus Torvalds return (struct pool_workqueue *)(data & WORK_STRUCT_WQ_DATA_MASK); 750afa4bb77SLinus Torvalds } 751afa4bb77SLinus Torvalds 752112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work) 7537a22ad75STejun Heo { 754e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 7557a22ad75STejun Heo 756112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 757afa4bb77SLinus Torvalds return work_struct_pwq(data); 758e120153dSTejun Heo else 759e120153dSTejun Heo return NULL; 7607a22ad75STejun Heo } 7617a22ad75STejun Heo 7627c3eed5cSTejun Heo /** 7637c3eed5cSTejun Heo * get_work_pool - return the worker_pool a given work was associated with 7647c3eed5cSTejun Heo * @work: the work item of interest 7657c3eed5cSTejun Heo * 76668e13a67SLai Jiangshan * Pools are created and destroyed under wq_pool_mutex, and allows read 76724acfb71SThomas Gleixner * access under RCU read lock. As such, this function should be 76824acfb71SThomas Gleixner * called under wq_pool_mutex or inside of a rcu_read_lock() region. 769fa1b54e6STejun Heo * 770fa1b54e6STejun Heo * All fields of the returned pool are accessible as long as the above 771fa1b54e6STejun Heo * mentioned locking is in effect. If the returned pool needs to be used 772fa1b54e6STejun Heo * beyond the critical section, the caller is responsible for ensuring the 773fa1b54e6STejun Heo * returned pool is and stays online. 774d185af30SYacine Belkadi * 775d185af30SYacine Belkadi * Return: The worker_pool @work was last associated with. %NULL if none. 7767c3eed5cSTejun Heo */ 7777c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work) 7787a22ad75STejun Heo { 779e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 7807c3eed5cSTejun Heo int pool_id; 7817a22ad75STejun Heo 78268e13a67SLai Jiangshan assert_rcu_or_pool_mutex(); 783fa1b54e6STejun Heo 784112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 785afa4bb77SLinus Torvalds return work_struct_pwq(data)->pool; 7867a22ad75STejun Heo 7877c3eed5cSTejun Heo pool_id = data >> WORK_OFFQ_POOL_SHIFT; 7887c3eed5cSTejun Heo if (pool_id == WORK_OFFQ_POOL_NONE) 7897a22ad75STejun Heo return NULL; 7907a22ad75STejun Heo 791fa1b54e6STejun Heo return idr_find(&worker_pool_idr, pool_id); 7927c3eed5cSTejun Heo } 7937c3eed5cSTejun Heo 7947c3eed5cSTejun Heo /** 7957c3eed5cSTejun Heo * get_work_pool_id - return the worker pool ID a given work is associated with 7967c3eed5cSTejun Heo * @work: the work item of interest 7977c3eed5cSTejun Heo * 798d185af30SYacine Belkadi * Return: The worker_pool ID @work was last associated with. 7997c3eed5cSTejun Heo * %WORK_OFFQ_POOL_NONE if none. 8007c3eed5cSTejun Heo */ 8017c3eed5cSTejun Heo static int get_work_pool_id(struct work_struct *work) 8027c3eed5cSTejun Heo { 80354d5b7d0SLai Jiangshan unsigned long data = atomic_long_read(&work->data); 8047c3eed5cSTejun Heo 805112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 806afa4bb77SLinus Torvalds return work_struct_pwq(data)->pool->id; 80754d5b7d0SLai Jiangshan 80854d5b7d0SLai Jiangshan return data >> WORK_OFFQ_POOL_SHIFT; 8097c3eed5cSTejun Heo } 8107c3eed5cSTejun Heo 811bbb68dfaSTejun Heo static void mark_work_canceling(struct work_struct *work) 812bbb68dfaSTejun Heo { 8137c3eed5cSTejun Heo unsigned long pool_id = get_work_pool_id(work); 814bbb68dfaSTejun Heo 8157c3eed5cSTejun Heo pool_id <<= WORK_OFFQ_POOL_SHIFT; 8167c3eed5cSTejun Heo set_work_data(work, pool_id | WORK_OFFQ_CANCELING, WORK_STRUCT_PENDING); 817bbb68dfaSTejun Heo } 818bbb68dfaSTejun Heo 819bbb68dfaSTejun Heo static bool work_is_canceling(struct work_struct *work) 820bbb68dfaSTejun Heo { 821bbb68dfaSTejun Heo unsigned long data = atomic_long_read(&work->data); 822bbb68dfaSTejun Heo 823112202d9STejun Heo return !(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_CANCELING); 824bbb68dfaSTejun Heo } 825bbb68dfaSTejun Heo 826e22bee78STejun Heo /* 8273270476aSTejun Heo * Policy functions. These define the policies on how the global worker 8283270476aSTejun Heo * pools are managed. Unless noted otherwise, these functions assume that 829d565ed63STejun Heo * they're being called with pool->lock held. 830e22bee78STejun Heo */ 831e22bee78STejun Heo 832e22bee78STejun Heo /* 833e22bee78STejun Heo * Need to wake up a worker? Called from anything but currently 834e22bee78STejun Heo * running workers. 835974271c4STejun Heo * 836974271c4STejun Heo * Note that, because unbound workers never contribute to nr_running, this 837706026c2STejun Heo * function will always return %true for unbound pools as long as the 838974271c4STejun Heo * worklist isn't empty. 839e22bee78STejun Heo */ 84063d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool) 841e22bee78STejun Heo { 8420219a352STejun Heo return !list_empty(&pool->worklist) && !pool->nr_running; 843e22bee78STejun Heo } 844e22bee78STejun Heo 845e22bee78STejun Heo /* Can I start working? Called from busy but !running workers. */ 84663d95a91STejun Heo static bool may_start_working(struct worker_pool *pool) 847e22bee78STejun Heo { 84863d95a91STejun Heo return pool->nr_idle; 849e22bee78STejun Heo } 850e22bee78STejun Heo 851e22bee78STejun Heo /* Do I need to keep working? Called from currently running workers. */ 85263d95a91STejun Heo static bool keep_working(struct worker_pool *pool) 853e22bee78STejun Heo { 854bc35f7efSLai Jiangshan return !list_empty(&pool->worklist) && (pool->nr_running <= 1); 855e22bee78STejun Heo } 856e22bee78STejun Heo 857e22bee78STejun Heo /* Do we need a new worker? Called from manager. */ 85863d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool) 859e22bee78STejun Heo { 86063d95a91STejun Heo return need_more_worker(pool) && !may_start_working(pool); 861e22bee78STejun Heo } 862e22bee78STejun Heo 863e22bee78STejun Heo /* Do we have too many workers and should some go away? */ 86463d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool) 865e22bee78STejun Heo { 866692b4825STejun Heo bool managing = pool->flags & POOL_MANAGER_ACTIVE; 86763d95a91STejun Heo int nr_idle = pool->nr_idle + managing; /* manager is considered idle */ 86863d95a91STejun Heo int nr_busy = pool->nr_workers - nr_idle; 869e22bee78STejun Heo 870e22bee78STejun Heo return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; 871e22bee78STejun Heo } 872e22bee78STejun Heo 8734690c4abSTejun Heo /** 874e22bee78STejun Heo * worker_set_flags - set worker flags and adjust nr_running accordingly 875cb444766STejun Heo * @worker: self 876d302f017STejun Heo * @flags: flags to set 877d302f017STejun Heo * 878228f1d00SLai Jiangshan * Set @flags in @worker->flags and adjust nr_running accordingly. 879d302f017STejun Heo */ 880228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags) 881d302f017STejun Heo { 882bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 883e22bee78STejun Heo 884bc8b50c2STejun Heo lockdep_assert_held(&pool->lock); 885cb444766STejun Heo 886228f1d00SLai Jiangshan /* If transitioning into NOT_RUNNING, adjust nr_running. */ 887e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && 888e22bee78STejun Heo !(worker->flags & WORKER_NOT_RUNNING)) { 889bc35f7efSLai Jiangshan pool->nr_running--; 890e22bee78STejun Heo } 891e22bee78STejun Heo 892d302f017STejun Heo worker->flags |= flags; 893d302f017STejun Heo } 894d302f017STejun Heo 895d302f017STejun Heo /** 896e22bee78STejun Heo * worker_clr_flags - clear worker flags and adjust nr_running accordingly 897cb444766STejun Heo * @worker: self 898d302f017STejun Heo * @flags: flags to clear 899d302f017STejun Heo * 900e22bee78STejun Heo * Clear @flags in @worker->flags and adjust nr_running accordingly. 901d302f017STejun Heo */ 902d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags) 903d302f017STejun Heo { 90463d95a91STejun Heo struct worker_pool *pool = worker->pool; 905e22bee78STejun Heo unsigned int oflags = worker->flags; 906e22bee78STejun Heo 907bc8b50c2STejun Heo lockdep_assert_held(&pool->lock); 908cb444766STejun Heo 909d302f017STejun Heo worker->flags &= ~flags; 910e22bee78STejun Heo 91142c025f3STejun Heo /* 91242c025f3STejun Heo * If transitioning out of NOT_RUNNING, increment nr_running. Note 91342c025f3STejun Heo * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask 91442c025f3STejun Heo * of multiple flags, not a single flag. 91542c025f3STejun Heo */ 916e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) 917e22bee78STejun Heo if (!(worker->flags & WORKER_NOT_RUNNING)) 918bc35f7efSLai Jiangshan pool->nr_running++; 919d302f017STejun Heo } 920d302f017STejun Heo 921797e8345STejun Heo /* Return the first idle worker. Called with pool->lock held. */ 922797e8345STejun Heo static struct worker *first_idle_worker(struct worker_pool *pool) 923797e8345STejun Heo { 924797e8345STejun Heo if (unlikely(list_empty(&pool->idle_list))) 925797e8345STejun Heo return NULL; 926797e8345STejun Heo 927797e8345STejun Heo return list_first_entry(&pool->idle_list, struct worker, entry); 928797e8345STejun Heo } 929797e8345STejun Heo 930797e8345STejun Heo /** 931797e8345STejun Heo * worker_enter_idle - enter idle state 932797e8345STejun Heo * @worker: worker which is entering idle state 933797e8345STejun Heo * 934797e8345STejun Heo * @worker is entering idle state. Update stats and idle timer if 935797e8345STejun Heo * necessary. 936797e8345STejun Heo * 937797e8345STejun Heo * LOCKING: 938797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 939797e8345STejun Heo */ 940797e8345STejun Heo static void worker_enter_idle(struct worker *worker) 941797e8345STejun Heo { 942797e8345STejun Heo struct worker_pool *pool = worker->pool; 943797e8345STejun Heo 944797e8345STejun Heo if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) || 945797e8345STejun Heo WARN_ON_ONCE(!list_empty(&worker->entry) && 946797e8345STejun Heo (worker->hentry.next || worker->hentry.pprev))) 947797e8345STejun Heo return; 948797e8345STejun Heo 949797e8345STejun Heo /* can't use worker_set_flags(), also called from create_worker() */ 950797e8345STejun Heo worker->flags |= WORKER_IDLE; 951797e8345STejun Heo pool->nr_idle++; 952797e8345STejun Heo worker->last_active = jiffies; 953797e8345STejun Heo 954797e8345STejun Heo /* idle_list is LIFO */ 955797e8345STejun Heo list_add(&worker->entry, &pool->idle_list); 956797e8345STejun Heo 957797e8345STejun Heo if (too_many_workers(pool) && !timer_pending(&pool->idle_timer)) 958797e8345STejun Heo mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT); 959797e8345STejun Heo 960797e8345STejun Heo /* Sanity check nr_running. */ 961797e8345STejun Heo WARN_ON_ONCE(pool->nr_workers == pool->nr_idle && pool->nr_running); 962797e8345STejun Heo } 963797e8345STejun Heo 964797e8345STejun Heo /** 965797e8345STejun Heo * worker_leave_idle - leave idle state 966797e8345STejun Heo * @worker: worker which is leaving idle state 967797e8345STejun Heo * 968797e8345STejun Heo * @worker is leaving idle state. Update stats. 969797e8345STejun Heo * 970797e8345STejun Heo * LOCKING: 971797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 972797e8345STejun Heo */ 973797e8345STejun Heo static void worker_leave_idle(struct worker *worker) 974797e8345STejun Heo { 975797e8345STejun Heo struct worker_pool *pool = worker->pool; 976797e8345STejun Heo 977797e8345STejun Heo if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE))) 978797e8345STejun Heo return; 979797e8345STejun Heo worker_clr_flags(worker, WORKER_IDLE); 980797e8345STejun Heo pool->nr_idle--; 981797e8345STejun Heo list_del_init(&worker->entry); 982797e8345STejun Heo } 983797e8345STejun Heo 984797e8345STejun Heo /** 985797e8345STejun Heo * find_worker_executing_work - find worker which is executing a work 986797e8345STejun Heo * @pool: pool of interest 987797e8345STejun Heo * @work: work to find worker for 988797e8345STejun Heo * 989797e8345STejun Heo * Find a worker which is executing @work on @pool by searching 990797e8345STejun Heo * @pool->busy_hash which is keyed by the address of @work. For a worker 991797e8345STejun Heo * to match, its current execution should match the address of @work and 992797e8345STejun Heo * its work function. This is to avoid unwanted dependency between 993797e8345STejun Heo * unrelated work executions through a work item being recycled while still 994797e8345STejun Heo * being executed. 995797e8345STejun Heo * 996797e8345STejun Heo * This is a bit tricky. A work item may be freed once its execution 997797e8345STejun Heo * starts and nothing prevents the freed area from being recycled for 998797e8345STejun Heo * another work item. If the same work item address ends up being reused 999797e8345STejun Heo * before the original execution finishes, workqueue will identify the 1000797e8345STejun Heo * recycled work item as currently executing and make it wait until the 1001797e8345STejun Heo * current execution finishes, introducing an unwanted dependency. 1002797e8345STejun Heo * 1003797e8345STejun Heo * This function checks the work item address and work function to avoid 1004797e8345STejun Heo * false positives. Note that this isn't complete as one may construct a 1005797e8345STejun Heo * work function which can introduce dependency onto itself through a 1006797e8345STejun Heo * recycled work item. Well, if somebody wants to shoot oneself in the 1007797e8345STejun Heo * foot that badly, there's only so much we can do, and if such deadlock 1008797e8345STejun Heo * actually occurs, it should be easy to locate the culprit work function. 1009797e8345STejun Heo * 1010797e8345STejun Heo * CONTEXT: 1011797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 1012797e8345STejun Heo * 1013797e8345STejun Heo * Return: 1014797e8345STejun Heo * Pointer to worker which is executing @work if found, %NULL 1015797e8345STejun Heo * otherwise. 1016797e8345STejun Heo */ 1017797e8345STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool, 1018797e8345STejun Heo struct work_struct *work) 1019797e8345STejun Heo { 1020797e8345STejun Heo struct worker *worker; 1021797e8345STejun Heo 1022797e8345STejun Heo hash_for_each_possible(pool->busy_hash, worker, hentry, 1023797e8345STejun Heo (unsigned long)work) 1024797e8345STejun Heo if (worker->current_work == work && 1025797e8345STejun Heo worker->current_func == work->func) 1026797e8345STejun Heo return worker; 1027797e8345STejun Heo 1028797e8345STejun Heo return NULL; 1029797e8345STejun Heo } 1030797e8345STejun Heo 1031797e8345STejun Heo /** 1032797e8345STejun Heo * move_linked_works - move linked works to a list 1033797e8345STejun Heo * @work: start of series of works to be scheduled 1034797e8345STejun Heo * @head: target list to append @work to 1035797e8345STejun Heo * @nextp: out parameter for nested worklist walking 1036797e8345STejun Heo * 1037873eaca6STejun Heo * Schedule linked works starting from @work to @head. Work series to be 1038873eaca6STejun Heo * scheduled starts at @work and includes any consecutive work with 1039873eaca6STejun Heo * WORK_STRUCT_LINKED set in its predecessor. See assign_work() for details on 1040873eaca6STejun Heo * @nextp. 1041797e8345STejun Heo * 1042797e8345STejun Heo * CONTEXT: 1043797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 1044797e8345STejun Heo */ 1045797e8345STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head, 1046797e8345STejun Heo struct work_struct **nextp) 1047797e8345STejun Heo { 1048797e8345STejun Heo struct work_struct *n; 1049797e8345STejun Heo 1050797e8345STejun Heo /* 1051797e8345STejun Heo * Linked worklist will always end before the end of the list, 1052797e8345STejun Heo * use NULL for list head. 1053797e8345STejun Heo */ 1054797e8345STejun Heo list_for_each_entry_safe_from(work, n, NULL, entry) { 1055797e8345STejun Heo list_move_tail(&work->entry, head); 1056797e8345STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) 1057797e8345STejun Heo break; 1058797e8345STejun Heo } 1059797e8345STejun Heo 1060797e8345STejun Heo /* 1061797e8345STejun Heo * If we're already inside safe list traversal and have moved 1062797e8345STejun Heo * multiple works to the scheduled queue, the next position 1063797e8345STejun Heo * needs to be updated. 1064797e8345STejun Heo */ 1065797e8345STejun Heo if (nextp) 1066797e8345STejun Heo *nextp = n; 1067797e8345STejun Heo } 1068797e8345STejun Heo 1069797e8345STejun Heo /** 1070873eaca6STejun Heo * assign_work - assign a work item and its linked work items to a worker 1071873eaca6STejun Heo * @work: work to assign 1072873eaca6STejun Heo * @worker: worker to assign to 1073873eaca6STejun Heo * @nextp: out parameter for nested worklist walking 1074873eaca6STejun Heo * 1075873eaca6STejun Heo * Assign @work and its linked work items to @worker. If @work is already being 1076873eaca6STejun Heo * executed by another worker in the same pool, it'll be punted there. 1077873eaca6STejun Heo * 1078873eaca6STejun Heo * If @nextp is not NULL, it's updated to point to the next work of the last 1079873eaca6STejun Heo * scheduled work. This allows assign_work() to be nested inside 1080873eaca6STejun Heo * list_for_each_entry_safe(). 1081873eaca6STejun Heo * 1082873eaca6STejun Heo * Returns %true if @work was successfully assigned to @worker. %false if @work 1083873eaca6STejun Heo * was punted to another worker already executing it. 1084873eaca6STejun Heo */ 1085873eaca6STejun Heo static bool assign_work(struct work_struct *work, struct worker *worker, 1086873eaca6STejun Heo struct work_struct **nextp) 1087873eaca6STejun Heo { 1088873eaca6STejun Heo struct worker_pool *pool = worker->pool; 1089873eaca6STejun Heo struct worker *collision; 1090873eaca6STejun Heo 1091873eaca6STejun Heo lockdep_assert_held(&pool->lock); 1092873eaca6STejun Heo 1093873eaca6STejun Heo /* 1094873eaca6STejun Heo * A single work shouldn't be executed concurrently by multiple workers. 1095873eaca6STejun Heo * __queue_work() ensures that @work doesn't jump to a different pool 1096873eaca6STejun Heo * while still running in the previous pool. Here, we should ensure that 1097873eaca6STejun Heo * @work is not executed concurrently by multiple workers from the same 1098873eaca6STejun Heo * pool. Check whether anyone is already processing the work. If so, 1099873eaca6STejun Heo * defer the work to the currently executing one. 1100873eaca6STejun Heo */ 1101873eaca6STejun Heo collision = find_worker_executing_work(pool, work); 1102873eaca6STejun Heo if (unlikely(collision)) { 1103873eaca6STejun Heo move_linked_works(work, &collision->scheduled, nextp); 1104873eaca6STejun Heo return false; 1105873eaca6STejun Heo } 1106873eaca6STejun Heo 1107873eaca6STejun Heo move_linked_works(work, &worker->scheduled, nextp); 1108873eaca6STejun Heo return true; 1109873eaca6STejun Heo } 1110873eaca6STejun Heo 1111873eaca6STejun Heo /** 11120219a352STejun Heo * kick_pool - wake up an idle worker if necessary 11130219a352STejun Heo * @pool: pool to kick 1114797e8345STejun Heo * 11150219a352STejun Heo * @pool may have pending work items. Wake up worker if necessary. Returns 11160219a352STejun Heo * whether a worker was woken up. 1117797e8345STejun Heo */ 11180219a352STejun Heo static bool kick_pool(struct worker_pool *pool) 1119797e8345STejun Heo { 1120797e8345STejun Heo struct worker *worker = first_idle_worker(pool); 11218639ecebSTejun Heo struct task_struct *p; 1122797e8345STejun Heo 11230219a352STejun Heo lockdep_assert_held(&pool->lock); 11240219a352STejun Heo 11250219a352STejun Heo if (!need_more_worker(pool) || !worker) 11260219a352STejun Heo return false; 11270219a352STejun Heo 11288639ecebSTejun Heo p = worker->task; 11298639ecebSTejun Heo 11308639ecebSTejun Heo #ifdef CONFIG_SMP 11318639ecebSTejun Heo /* 11328639ecebSTejun Heo * Idle @worker is about to execute @work and waking up provides an 11338639ecebSTejun Heo * opportunity to migrate @worker at a lower cost by setting the task's 11348639ecebSTejun Heo * wake_cpu field. Let's see if we want to move @worker to improve 11358639ecebSTejun Heo * execution locality. 11368639ecebSTejun Heo * 11378639ecebSTejun Heo * We're waking the worker that went idle the latest and there's some 11388639ecebSTejun Heo * chance that @worker is marked idle but hasn't gone off CPU yet. If 11398639ecebSTejun Heo * so, setting the wake_cpu won't do anything. As this is a best-effort 11408639ecebSTejun Heo * optimization and the race window is narrow, let's leave as-is for 11418639ecebSTejun Heo * now. If this becomes pronounced, we can skip over workers which are 11428639ecebSTejun Heo * still on cpu when picking an idle worker. 11438639ecebSTejun Heo * 11448639ecebSTejun Heo * If @pool has non-strict affinity, @worker might have ended up outside 11458639ecebSTejun Heo * its affinity scope. Repatriate. 11468639ecebSTejun Heo */ 11478639ecebSTejun Heo if (!pool->attrs->affn_strict && 11488639ecebSTejun Heo !cpumask_test_cpu(p->wake_cpu, pool->attrs->__pod_cpumask)) { 11498639ecebSTejun Heo struct work_struct *work = list_first_entry(&pool->worklist, 11508639ecebSTejun Heo struct work_struct, entry); 11518639ecebSTejun Heo p->wake_cpu = cpumask_any_distribute(pool->attrs->__pod_cpumask); 11528639ecebSTejun Heo get_work_pwq(work)->stats[PWQ_STAT_REPATRIATED]++; 11538639ecebSTejun Heo } 11548639ecebSTejun Heo #endif 11558639ecebSTejun Heo wake_up_process(p); 11560219a352STejun Heo return true; 1157797e8345STejun Heo } 1158797e8345STejun Heo 115963638450STejun Heo #ifdef CONFIG_WQ_CPU_INTENSIVE_REPORT 116063638450STejun Heo 116163638450STejun Heo /* 116263638450STejun Heo * Concurrency-managed per-cpu work items that hog CPU for longer than 116363638450STejun Heo * wq_cpu_intensive_thresh_us trigger the automatic CPU_INTENSIVE mechanism, 116463638450STejun Heo * which prevents them from stalling other concurrency-managed work items. If a 116563638450STejun Heo * work function keeps triggering this mechanism, it's likely that the work item 116663638450STejun Heo * should be using an unbound workqueue instead. 116763638450STejun Heo * 116863638450STejun Heo * wq_cpu_intensive_report() tracks work functions which trigger such conditions 116963638450STejun Heo * and report them so that they can be examined and converted to use unbound 117063638450STejun Heo * workqueues as appropriate. To avoid flooding the console, each violating work 117163638450STejun Heo * function is tracked and reported with exponential backoff. 117263638450STejun Heo */ 117363638450STejun Heo #define WCI_MAX_ENTS 128 117463638450STejun Heo 117563638450STejun Heo struct wci_ent { 117663638450STejun Heo work_func_t func; 117763638450STejun Heo atomic64_t cnt; 117863638450STejun Heo struct hlist_node hash_node; 117963638450STejun Heo }; 118063638450STejun Heo 118163638450STejun Heo static struct wci_ent wci_ents[WCI_MAX_ENTS]; 118263638450STejun Heo static int wci_nr_ents; 118363638450STejun Heo static DEFINE_RAW_SPINLOCK(wci_lock); 118463638450STejun Heo static DEFINE_HASHTABLE(wci_hash, ilog2(WCI_MAX_ENTS)); 118563638450STejun Heo 118663638450STejun Heo static struct wci_ent *wci_find_ent(work_func_t func) 118763638450STejun Heo { 118863638450STejun Heo struct wci_ent *ent; 118963638450STejun Heo 119063638450STejun Heo hash_for_each_possible_rcu(wci_hash, ent, hash_node, 119163638450STejun Heo (unsigned long)func) { 119263638450STejun Heo if (ent->func == func) 119363638450STejun Heo return ent; 119463638450STejun Heo } 119563638450STejun Heo return NULL; 119663638450STejun Heo } 119763638450STejun Heo 119863638450STejun Heo static void wq_cpu_intensive_report(work_func_t func) 119963638450STejun Heo { 120063638450STejun Heo struct wci_ent *ent; 120163638450STejun Heo 120263638450STejun Heo restart: 120363638450STejun Heo ent = wci_find_ent(func); 120463638450STejun Heo if (ent) { 120563638450STejun Heo u64 cnt; 120663638450STejun Heo 120763638450STejun Heo /* 120863638450STejun Heo * Start reporting from the fourth time and back off 120963638450STejun Heo * exponentially. 121063638450STejun Heo */ 121163638450STejun Heo cnt = atomic64_inc_return_relaxed(&ent->cnt); 121263638450STejun Heo if (cnt >= 4 && is_power_of_2(cnt)) 121363638450STejun Heo printk_deferred(KERN_WARNING "workqueue: %ps hogged CPU for >%luus %llu times, consider switching to WQ_UNBOUND\n", 121463638450STejun Heo ent->func, wq_cpu_intensive_thresh_us, 121563638450STejun Heo atomic64_read(&ent->cnt)); 121663638450STejun Heo return; 121763638450STejun Heo } 121863638450STejun Heo 121963638450STejun Heo /* 122063638450STejun Heo * @func is a new violation. Allocate a new entry for it. If wcn_ents[] 122163638450STejun Heo * is exhausted, something went really wrong and we probably made enough 122263638450STejun Heo * noise already. 122363638450STejun Heo */ 122463638450STejun Heo if (wci_nr_ents >= WCI_MAX_ENTS) 122563638450STejun Heo return; 122663638450STejun Heo 122763638450STejun Heo raw_spin_lock(&wci_lock); 122863638450STejun Heo 122963638450STejun Heo if (wci_nr_ents >= WCI_MAX_ENTS) { 123063638450STejun Heo raw_spin_unlock(&wci_lock); 123163638450STejun Heo return; 123263638450STejun Heo } 123363638450STejun Heo 123463638450STejun Heo if (wci_find_ent(func)) { 123563638450STejun Heo raw_spin_unlock(&wci_lock); 123663638450STejun Heo goto restart; 123763638450STejun Heo } 123863638450STejun Heo 123963638450STejun Heo ent = &wci_ents[wci_nr_ents++]; 124063638450STejun Heo ent->func = func; 124163638450STejun Heo atomic64_set(&ent->cnt, 1); 124263638450STejun Heo hash_add_rcu(wci_hash, &ent->hash_node, (unsigned long)func); 124363638450STejun Heo 124463638450STejun Heo raw_spin_unlock(&wci_lock); 124563638450STejun Heo } 124663638450STejun Heo 124763638450STejun Heo #else /* CONFIG_WQ_CPU_INTENSIVE_REPORT */ 124863638450STejun Heo static void wq_cpu_intensive_report(work_func_t func) {} 124963638450STejun Heo #endif /* CONFIG_WQ_CPU_INTENSIVE_REPORT */ 125063638450STejun Heo 1251c54d5046STejun Heo /** 12521da177e4SLinus Torvalds * wq_worker_running - a worker is running again 12531da177e4SLinus Torvalds * @task: task waking up 12541da177e4SLinus Torvalds * 12551da177e4SLinus Torvalds * This function is called when a worker returns from schedule() 12561da177e4SLinus Torvalds */ 12571da177e4SLinus Torvalds void wq_worker_running(struct task_struct *task) 12581da177e4SLinus Torvalds { 12591da177e4SLinus Torvalds struct worker *worker = kthread_data(task); 12601da177e4SLinus Torvalds 1261c8f6219bSZqiang if (!READ_ONCE(worker->sleeping)) 12621da177e4SLinus Torvalds return; 12631da177e4SLinus Torvalds 12641da177e4SLinus Torvalds /* 12651da177e4SLinus Torvalds * If preempted by unbind_workers() between the WORKER_NOT_RUNNING check 12661da177e4SLinus Torvalds * and the nr_running increment below, we may ruin the nr_running reset 12671da177e4SLinus Torvalds * and leave with an unexpected pool->nr_running == 1 on the newly unbound 12681da177e4SLinus Torvalds * pool. Protect against such race. 12691da177e4SLinus Torvalds */ 12701da177e4SLinus Torvalds preempt_disable(); 12711da177e4SLinus Torvalds if (!(worker->flags & WORKER_NOT_RUNNING)) 12721da177e4SLinus Torvalds worker->pool->nr_running++; 12731da177e4SLinus Torvalds preempt_enable(); 1274616db877STejun Heo 1275616db877STejun Heo /* 1276616db877STejun Heo * CPU intensive auto-detection cares about how long a work item hogged 1277616db877STejun Heo * CPU without sleeping. Reset the starting timestamp on wakeup. 1278616db877STejun Heo */ 1279616db877STejun Heo worker->current_at = worker->task->se.sum_exec_runtime; 1280616db877STejun Heo 1281c8f6219bSZqiang WRITE_ONCE(worker->sleeping, 0); 12821da177e4SLinus Torvalds } 12831da177e4SLinus Torvalds 12841da177e4SLinus Torvalds /** 12851da177e4SLinus Torvalds * wq_worker_sleeping - a worker is going to sleep 12861da177e4SLinus Torvalds * @task: task going to sleep 12871da177e4SLinus Torvalds * 12881da177e4SLinus Torvalds * This function is called from schedule() when a busy worker is 12891da177e4SLinus Torvalds * going to sleep. 12901da177e4SLinus Torvalds */ 12911da177e4SLinus Torvalds void wq_worker_sleeping(struct task_struct *task) 12921da177e4SLinus Torvalds { 12931da177e4SLinus Torvalds struct worker *worker = kthread_data(task); 12941da177e4SLinus Torvalds struct worker_pool *pool; 12951da177e4SLinus Torvalds 12961da177e4SLinus Torvalds /* 12971da177e4SLinus Torvalds * Rescuers, which may not have all the fields set up like normal 12981da177e4SLinus Torvalds * workers, also reach here, let's not access anything before 12991da177e4SLinus Torvalds * checking NOT_RUNNING. 13001da177e4SLinus Torvalds */ 13011da177e4SLinus Torvalds if (worker->flags & WORKER_NOT_RUNNING) 13021da177e4SLinus Torvalds return; 13031da177e4SLinus Torvalds 13041da177e4SLinus Torvalds pool = worker->pool; 13051da177e4SLinus Torvalds 13061da177e4SLinus Torvalds /* Return if preempted before wq_worker_running() was reached */ 1307c8f6219bSZqiang if (READ_ONCE(worker->sleeping)) 13081da177e4SLinus Torvalds return; 13091da177e4SLinus Torvalds 1310c8f6219bSZqiang WRITE_ONCE(worker->sleeping, 1); 13111da177e4SLinus Torvalds raw_spin_lock_irq(&pool->lock); 13121da177e4SLinus Torvalds 13131da177e4SLinus Torvalds /* 13141da177e4SLinus Torvalds * Recheck in case unbind_workers() preempted us. We don't 13151da177e4SLinus Torvalds * want to decrement nr_running after the worker is unbound 13161da177e4SLinus Torvalds * and nr_running has been reset. 13171da177e4SLinus Torvalds */ 13181da177e4SLinus Torvalds if (worker->flags & WORKER_NOT_RUNNING) { 13191da177e4SLinus Torvalds raw_spin_unlock_irq(&pool->lock); 13201da177e4SLinus Torvalds return; 13211da177e4SLinus Torvalds } 13221da177e4SLinus Torvalds 13231da177e4SLinus Torvalds pool->nr_running--; 13240219a352STejun Heo if (kick_pool(pool)) 1325725e8ec5STejun Heo worker->current_pwq->stats[PWQ_STAT_CM_WAKEUP]++; 13260219a352STejun Heo 13271da177e4SLinus Torvalds raw_spin_unlock_irq(&pool->lock); 13281da177e4SLinus Torvalds } 13291da177e4SLinus Torvalds 13301da177e4SLinus Torvalds /** 1331616db877STejun Heo * wq_worker_tick - a scheduler tick occurred while a kworker is running 1332616db877STejun Heo * @task: task currently running 1333616db877STejun Heo * 1334616db877STejun Heo * Called from scheduler_tick(). We're in the IRQ context and the current 1335616db877STejun Heo * worker's fields which follow the 'K' locking rule can be accessed safely. 1336616db877STejun Heo */ 1337616db877STejun Heo void wq_worker_tick(struct task_struct *task) 1338616db877STejun Heo { 1339616db877STejun Heo struct worker *worker = kthread_data(task); 1340616db877STejun Heo struct pool_workqueue *pwq = worker->current_pwq; 1341616db877STejun Heo struct worker_pool *pool = worker->pool; 1342616db877STejun Heo 1343616db877STejun Heo if (!pwq) 1344616db877STejun Heo return; 1345616db877STejun Heo 13468a1dd1e5STejun Heo pwq->stats[PWQ_STAT_CPU_TIME] += TICK_USEC; 13478a1dd1e5STejun Heo 134818c8ae81SZqiang if (!wq_cpu_intensive_thresh_us) 134918c8ae81SZqiang return; 135018c8ae81SZqiang 1351616db877STejun Heo /* 1352616db877STejun Heo * If the current worker is concurrency managed and hogged the CPU for 1353616db877STejun Heo * longer than wq_cpu_intensive_thresh_us, it's automatically marked 1354616db877STejun Heo * CPU_INTENSIVE to avoid stalling other concurrency-managed work items. 1355c8f6219bSZqiang * 1356c8f6219bSZqiang * Set @worker->sleeping means that @worker is in the process of 1357c8f6219bSZqiang * switching out voluntarily and won't be contributing to 1358c8f6219bSZqiang * @pool->nr_running until it wakes up. As wq_worker_sleeping() also 1359c8f6219bSZqiang * decrements ->nr_running, setting CPU_INTENSIVE here can lead to 1360c8f6219bSZqiang * double decrements. The task is releasing the CPU anyway. Let's skip. 1361c8f6219bSZqiang * We probably want to make this prettier in the future. 1362616db877STejun Heo */ 1363c8f6219bSZqiang if ((worker->flags & WORKER_NOT_RUNNING) || READ_ONCE(worker->sleeping) || 1364616db877STejun Heo worker->task->se.sum_exec_runtime - worker->current_at < 1365616db877STejun Heo wq_cpu_intensive_thresh_us * NSEC_PER_USEC) 1366616db877STejun Heo return; 1367616db877STejun Heo 1368616db877STejun Heo raw_spin_lock(&pool->lock); 1369616db877STejun Heo 1370616db877STejun Heo worker_set_flags(worker, WORKER_CPU_INTENSIVE); 137163638450STejun Heo wq_cpu_intensive_report(worker->current_func); 1372616db877STejun Heo pwq->stats[PWQ_STAT_CPU_INTENSIVE]++; 1373616db877STejun Heo 13740219a352STejun Heo if (kick_pool(pool)) 1375616db877STejun Heo pwq->stats[PWQ_STAT_CM_WAKEUP]++; 1376616db877STejun Heo 1377616db877STejun Heo raw_spin_unlock(&pool->lock); 1378616db877STejun Heo } 1379616db877STejun Heo 1380616db877STejun Heo /** 13811da177e4SLinus Torvalds * wq_worker_last_func - retrieve worker's last work function 13821da177e4SLinus Torvalds * @task: Task to retrieve last work function of. 13831da177e4SLinus Torvalds * 13841da177e4SLinus Torvalds * Determine the last function a worker executed. This is called from 13851da177e4SLinus Torvalds * the scheduler to get a worker's last known identity. 13861da177e4SLinus Torvalds * 13871da177e4SLinus Torvalds * CONTEXT: 13889b41ea72SAndrew Morton * raw_spin_lock_irq(rq->lock) 13891da177e4SLinus Torvalds * 13901da177e4SLinus Torvalds * This function is called during schedule() when a kworker is going 1391f756d5e2SNathan Lynch * to sleep. It's used by psi to identify aggregation workers during 1392f756d5e2SNathan Lynch * dequeuing, to allow periodic aggregation to shut-off when that 13931da177e4SLinus Torvalds * worker is the last task in the system or cgroup to go to sleep. 13941da177e4SLinus Torvalds * 13951da177e4SLinus Torvalds * As this function doesn't involve any workqueue-related locking, it 13961da177e4SLinus Torvalds * only returns stable values when called from inside the scheduler's 13971da177e4SLinus Torvalds * queuing and dequeuing paths, when @task, which must be a kworker, 13981da177e4SLinus Torvalds * is guaranteed to not be processing any works. 1399365970a1SDavid Howells * 1400365970a1SDavid Howells * Return: 1401365970a1SDavid Howells * The last work function %current executed as a worker, NULL if it 1402365970a1SDavid Howells * hasn't executed any work yet. 1403365970a1SDavid Howells */ 1404365970a1SDavid Howells work_func_t wq_worker_last_func(struct task_struct *task) 1405365970a1SDavid Howells { 1406365970a1SDavid Howells struct worker *worker = kthread_data(task); 1407365970a1SDavid Howells 1408365970a1SDavid Howells return worker->last_func; 1409365970a1SDavid Howells } 1410365970a1SDavid Howells 1411d302f017STejun Heo /** 14128864b4e5STejun Heo * get_pwq - get an extra reference on the specified pool_workqueue 14138864b4e5STejun Heo * @pwq: pool_workqueue to get 14148864b4e5STejun Heo * 14158864b4e5STejun Heo * Obtain an extra reference on @pwq. The caller should guarantee that 14168864b4e5STejun Heo * @pwq has positive refcnt and be holding the matching pool->lock. 14178864b4e5STejun Heo */ 14188864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq) 14198864b4e5STejun Heo { 14208864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 14218864b4e5STejun Heo WARN_ON_ONCE(pwq->refcnt <= 0); 14228864b4e5STejun Heo pwq->refcnt++; 14238864b4e5STejun Heo } 14248864b4e5STejun Heo 14258864b4e5STejun Heo /** 14268864b4e5STejun Heo * put_pwq - put a pool_workqueue reference 14278864b4e5STejun Heo * @pwq: pool_workqueue to put 14288864b4e5STejun Heo * 14298864b4e5STejun Heo * Drop a reference of @pwq. If its refcnt reaches zero, schedule its 14308864b4e5STejun Heo * destruction. The caller should be holding the matching pool->lock. 14318864b4e5STejun Heo */ 14328864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq) 14338864b4e5STejun Heo { 14348864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 14358864b4e5STejun Heo if (likely(--pwq->refcnt)) 14368864b4e5STejun Heo return; 14378864b4e5STejun Heo /* 1438967b494eSTejun Heo * @pwq can't be released under pool->lock, bounce to a dedicated 1439967b494eSTejun Heo * kthread_worker to avoid A-A deadlocks. 14408864b4e5STejun Heo */ 1441687a9aa5STejun Heo kthread_queue_work(pwq_release_worker, &pwq->release_work); 14428864b4e5STejun Heo } 14438864b4e5STejun Heo 1444dce90d47STejun Heo /** 1445dce90d47STejun Heo * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock 1446dce90d47STejun Heo * @pwq: pool_workqueue to put (can be %NULL) 1447dce90d47STejun Heo * 1448dce90d47STejun Heo * put_pwq() with locking. This function also allows %NULL @pwq. 1449dce90d47STejun Heo */ 1450dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq) 1451dce90d47STejun Heo { 1452dce90d47STejun Heo if (pwq) { 1453dce90d47STejun Heo /* 145424acfb71SThomas Gleixner * As both pwqs and pools are RCU protected, the 1455dce90d47STejun Heo * following lock operations are safe. 1456dce90d47STejun Heo */ 1457a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 1458dce90d47STejun Heo put_pwq(pwq); 1459a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 1460dce90d47STejun Heo } 1461dce90d47STejun Heo } 1462dce90d47STejun Heo 1463afa87ce8STejun Heo static bool pwq_is_empty(struct pool_workqueue *pwq) 1464afa87ce8STejun Heo { 1465afa87ce8STejun Heo return !pwq->nr_active && list_empty(&pwq->inactive_works); 1466afa87ce8STejun Heo } 1467afa87ce8STejun Heo 1468*4c638030STejun Heo static void __pwq_activate_work(struct pool_workqueue *pwq, 1469*4c638030STejun Heo struct work_struct *work) 1470bf4ede01STejun Heo { 1471bf4ede01STejun Heo trace_workqueue_activate_work(work); 147282607adcSTejun Heo if (list_empty(&pwq->pool->worklist)) 147382607adcSTejun Heo pwq->pool->watchdog_ts = jiffies; 1474112202d9STejun Heo move_linked_works(work, &pwq->pool->worklist, NULL); 1475f97a4a1aSLai Jiangshan __clear_bit(WORK_STRUCT_INACTIVE_BIT, work_data_bits(work)); 1476*4c638030STejun Heo } 1477*4c638030STejun Heo 1478*4c638030STejun Heo /** 1479*4c638030STejun Heo * pwq_activate_work - Activate a work item if inactive 1480*4c638030STejun Heo * @pwq: pool_workqueue @work belongs to 1481*4c638030STejun Heo * @work: work item to activate 1482*4c638030STejun Heo * 1483*4c638030STejun Heo * Returns %true if activated. %false if already active. 1484*4c638030STejun Heo */ 1485*4c638030STejun Heo static bool pwq_activate_work(struct pool_workqueue *pwq, 1486*4c638030STejun Heo struct work_struct *work) 1487*4c638030STejun Heo { 1488*4c638030STejun Heo struct worker_pool *pool = pwq->pool; 1489*4c638030STejun Heo 1490*4c638030STejun Heo lockdep_assert_held(&pool->lock); 1491*4c638030STejun Heo 1492*4c638030STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_INACTIVE)) 1493*4c638030STejun Heo return false; 1494*4c638030STejun Heo 1495112202d9STejun Heo pwq->nr_active++; 1496*4c638030STejun Heo __pwq_activate_work(pwq, work); 1497*4c638030STejun Heo return true; 1498bf4ede01STejun Heo } 1499bf4ede01STejun Heo 1500f97a4a1aSLai Jiangshan static void pwq_activate_first_inactive(struct pool_workqueue *pwq) 15013aa62497SLai Jiangshan { 1502f97a4a1aSLai Jiangshan struct work_struct *work = list_first_entry(&pwq->inactive_works, 15033aa62497SLai Jiangshan struct work_struct, entry); 15043aa62497SLai Jiangshan 1505*4c638030STejun Heo pwq_activate_work(pwq, work); 15063aa62497SLai Jiangshan } 15073aa62497SLai Jiangshan 1508bf4ede01STejun Heo /** 1509112202d9STejun Heo * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight 1510112202d9STejun Heo * @pwq: pwq of interest 1511c4560c2cSLai Jiangshan * @work_data: work_data of work which left the queue 1512bf4ede01STejun Heo * 1513bf4ede01STejun Heo * A work either has completed or is removed from pending queue, 1514112202d9STejun Heo * decrement nr_in_flight of its pwq and handle workqueue flushing. 1515bf4ede01STejun Heo * 1516bf4ede01STejun Heo * CONTEXT: 1517a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 1518bf4ede01STejun Heo */ 1519c4560c2cSLai Jiangshan static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data) 1520bf4ede01STejun Heo { 1521c4560c2cSLai Jiangshan int color = get_work_color(work_data); 1522c4560c2cSLai Jiangshan 1523018f3a13SLai Jiangshan if (!(work_data & WORK_STRUCT_INACTIVE)) { 1524112202d9STejun Heo pwq->nr_active--; 1525f97a4a1aSLai Jiangshan if (!list_empty(&pwq->inactive_works)) { 1526f97a4a1aSLai Jiangshan /* one down, submit an inactive one */ 1527a045a272STejun Heo if (pwq->nr_active < READ_ONCE(pwq->wq->max_active)) 1528f97a4a1aSLai Jiangshan pwq_activate_first_inactive(pwq); 1529bf4ede01STejun Heo } 1530018f3a13SLai Jiangshan } 1531018f3a13SLai Jiangshan 1532018f3a13SLai Jiangshan pwq->nr_in_flight[color]--; 1533bf4ede01STejun Heo 1534bf4ede01STejun Heo /* is flush in progress and are we at the flushing tip? */ 1535112202d9STejun Heo if (likely(pwq->flush_color != color)) 15368864b4e5STejun Heo goto out_put; 1537bf4ede01STejun Heo 1538bf4ede01STejun Heo /* are there still in-flight works? */ 1539112202d9STejun Heo if (pwq->nr_in_flight[color]) 15408864b4e5STejun Heo goto out_put; 1541bf4ede01STejun Heo 1542112202d9STejun Heo /* this pwq is done, clear flush_color */ 1543112202d9STejun Heo pwq->flush_color = -1; 1544bf4ede01STejun Heo 1545bf4ede01STejun Heo /* 1546112202d9STejun Heo * If this was the last pwq, wake up the first flusher. It 1547bf4ede01STejun Heo * will handle the rest. 1548bf4ede01STejun Heo */ 1549112202d9STejun Heo if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush)) 1550112202d9STejun Heo complete(&pwq->wq->first_flusher->done); 15518864b4e5STejun Heo out_put: 15528864b4e5STejun Heo put_pwq(pwq); 1553bf4ede01STejun Heo } 1554bf4ede01STejun Heo 155536e227d2STejun Heo /** 1556bbb68dfaSTejun Heo * try_to_grab_pending - steal work item from worklist and disable irq 155736e227d2STejun Heo * @work: work item to steal 155836e227d2STejun Heo * @is_dwork: @work is a delayed_work 1559bbb68dfaSTejun Heo * @flags: place to store irq state 156036e227d2STejun Heo * 156136e227d2STejun Heo * Try to grab PENDING bit of @work. This function can handle @work in any 1562d185af30SYacine Belkadi * stable state - idle, on timer or on worklist. 156336e227d2STejun Heo * 1564d185af30SYacine Belkadi * Return: 15653eb6b31bSMauro Carvalho Chehab * 15663eb6b31bSMauro Carvalho Chehab * ======== ================================================================ 156736e227d2STejun Heo * 1 if @work was pending and we successfully stole PENDING 156836e227d2STejun Heo * 0 if @work was idle and we claimed PENDING 156936e227d2STejun Heo * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry 1570bbb68dfaSTejun Heo * -ENOENT if someone else is canceling @work, this state may persist 1571bbb68dfaSTejun Heo * for arbitrarily long 15723eb6b31bSMauro Carvalho Chehab * ======== ================================================================ 157336e227d2STejun Heo * 1574d185af30SYacine Belkadi * Note: 1575bbb68dfaSTejun Heo * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting 1576e0aecdd8STejun Heo * interrupted while holding PENDING and @work off queue, irq must be 1577e0aecdd8STejun Heo * disabled on entry. This, combined with delayed_work->timer being 1578e0aecdd8STejun Heo * irqsafe, ensures that we return -EAGAIN for finite short period of time. 1579bbb68dfaSTejun Heo * 1580bbb68dfaSTejun Heo * On successful return, >= 0, irq is disabled and the caller is 1581bbb68dfaSTejun Heo * responsible for releasing it using local_irq_restore(*@flags). 1582bbb68dfaSTejun Heo * 1583e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 1584bf4ede01STejun Heo */ 1585bbb68dfaSTejun Heo static int try_to_grab_pending(struct work_struct *work, bool is_dwork, 1586bbb68dfaSTejun Heo unsigned long *flags) 1587bf4ede01STejun Heo { 1588d565ed63STejun Heo struct worker_pool *pool; 1589112202d9STejun Heo struct pool_workqueue *pwq; 1590bf4ede01STejun Heo 1591bbb68dfaSTejun Heo local_irq_save(*flags); 1592bbb68dfaSTejun Heo 159336e227d2STejun Heo /* try to steal the timer if it exists */ 159436e227d2STejun Heo if (is_dwork) { 159536e227d2STejun Heo struct delayed_work *dwork = to_delayed_work(work); 159636e227d2STejun Heo 1597e0aecdd8STejun Heo /* 1598e0aecdd8STejun Heo * dwork->timer is irqsafe. If del_timer() fails, it's 1599e0aecdd8STejun Heo * guaranteed that the timer is not queued anywhere and not 1600e0aecdd8STejun Heo * running on the local CPU. 1601e0aecdd8STejun Heo */ 160236e227d2STejun Heo if (likely(del_timer(&dwork->timer))) 160336e227d2STejun Heo return 1; 160436e227d2STejun Heo } 160536e227d2STejun Heo 160636e227d2STejun Heo /* try to claim PENDING the normal way */ 1607bf4ede01STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) 1608bf4ede01STejun Heo return 0; 1609bf4ede01STejun Heo 161024acfb71SThomas Gleixner rcu_read_lock(); 1611bf4ede01STejun Heo /* 1612bf4ede01STejun Heo * The queueing is in progress, or it is already queued. Try to 1613bf4ede01STejun Heo * steal it from ->worklist without clearing WORK_STRUCT_PENDING. 1614bf4ede01STejun Heo */ 1615d565ed63STejun Heo pool = get_work_pool(work); 1616d565ed63STejun Heo if (!pool) 1617bbb68dfaSTejun Heo goto fail; 1618bf4ede01STejun Heo 1619a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&pool->lock); 1620bf4ede01STejun Heo /* 1621112202d9STejun Heo * work->data is guaranteed to point to pwq only while the work 1622112202d9STejun Heo * item is queued on pwq->wq, and both updating work->data to point 1623112202d9STejun Heo * to pwq on queueing and to pool on dequeueing are done under 1624112202d9STejun Heo * pwq->pool->lock. This in turn guarantees that, if work->data 1625112202d9STejun Heo * points to pwq which is associated with a locked pool, the work 16260b3dae68SLai Jiangshan * item is currently queued on that pool. 1627bf4ede01STejun Heo */ 1628112202d9STejun Heo pwq = get_work_pwq(work); 1629112202d9STejun Heo if (pwq && pwq->pool == pool) { 1630bf4ede01STejun Heo debug_work_deactivate(work); 16313aa62497SLai Jiangshan 16323aa62497SLai Jiangshan /* 1633018f3a13SLai Jiangshan * A cancelable inactive work item must be in the 1634018f3a13SLai Jiangshan * pwq->inactive_works since a queued barrier can't be 1635018f3a13SLai Jiangshan * canceled (see the comments in insert_wq_barrier()). 1636018f3a13SLai Jiangshan * 1637f97a4a1aSLai Jiangshan * An inactive work item cannot be grabbed directly because 1638d812796eSLai Jiangshan * it might have linked barrier work items which, if left 1639f97a4a1aSLai Jiangshan * on the inactive_works list, will confuse pwq->nr_active 164016062836STejun Heo * management later on and cause stall. Make sure the work 164116062836STejun Heo * item is activated before grabbing. 16423aa62497SLai Jiangshan */ 1643*4c638030STejun Heo pwq_activate_work(pwq, work); 16443aa62497SLai Jiangshan 1645bf4ede01STejun Heo list_del_init(&work->entry); 1646c4560c2cSLai Jiangshan pwq_dec_nr_in_flight(pwq, *work_data_bits(work)); 164736e227d2STejun Heo 1648112202d9STejun Heo /* work->data points to pwq iff queued, point to pool */ 16494468a00fSLai Jiangshan set_work_pool_and_keep_pending(work, pool->id); 16504468a00fSLai Jiangshan 1651a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&pool->lock); 165224acfb71SThomas Gleixner rcu_read_unlock(); 165336e227d2STejun Heo return 1; 1654bf4ede01STejun Heo } 1655a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&pool->lock); 1656bbb68dfaSTejun Heo fail: 165724acfb71SThomas Gleixner rcu_read_unlock(); 1658bbb68dfaSTejun Heo local_irq_restore(*flags); 1659bbb68dfaSTejun Heo if (work_is_canceling(work)) 1660bbb68dfaSTejun Heo return -ENOENT; 1661bbb68dfaSTejun Heo cpu_relax(); 166236e227d2STejun Heo return -EAGAIN; 1663bf4ede01STejun Heo } 1664bf4ede01STejun Heo 1665bf4ede01STejun Heo /** 1666706026c2STejun Heo * insert_work - insert a work into a pool 1667112202d9STejun Heo * @pwq: pwq @work belongs to 16684690c4abSTejun Heo * @work: work to insert 16694690c4abSTejun Heo * @head: insertion point 16704690c4abSTejun Heo * @extra_flags: extra WORK_STRUCT_* flags to set 16714690c4abSTejun Heo * 1672112202d9STejun Heo * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to 1673706026c2STejun Heo * work_struct flags. 16744690c4abSTejun Heo * 16754690c4abSTejun Heo * CONTEXT: 1676a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 1677365970a1SDavid Howells */ 1678112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work, 1679112202d9STejun Heo struct list_head *head, unsigned int extra_flags) 1680b89deed3SOleg Nesterov { 1681fe089f87STejun Heo debug_work_activate(work); 1682e1d8aa9fSFrederic Weisbecker 1683e89a85d6SWalter Wu /* record the work call stack in order to print it in KASAN reports */ 1684f70da745SMarco Elver kasan_record_aux_stack_noalloc(work); 1685e89a85d6SWalter Wu 16864690c4abSTejun Heo /* we own @work, set data and link */ 1687112202d9STejun Heo set_work_pwq(work, pwq, extra_flags); 16881a4d9b0aSOleg Nesterov list_add_tail(&work->entry, head); 16898864b4e5STejun Heo get_pwq(pwq); 1690b89deed3SOleg Nesterov } 1691b89deed3SOleg Nesterov 1692c8efcc25STejun Heo /* 1693c8efcc25STejun Heo * Test whether @work is being queued from another work executing on the 16948d03ecfeSTejun Heo * same workqueue. 1695c8efcc25STejun Heo */ 1696c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq) 1697c8efcc25STejun Heo { 1698c8efcc25STejun Heo struct worker *worker; 1699c8efcc25STejun Heo 17008d03ecfeSTejun Heo worker = current_wq_worker(); 1701c8efcc25STejun Heo /* 1702bf393fd4SBart Van Assche * Return %true iff I'm a worker executing a work item on @wq. If 17038d03ecfeSTejun Heo * I'm @worker, it's safe to dereference it without locking. 1704c8efcc25STejun Heo */ 1705112202d9STejun Heo return worker && worker->current_pwq->wq == wq; 1706c8efcc25STejun Heo } 1707c8efcc25STejun Heo 1708ef557180SMike Galbraith /* 1709ef557180SMike Galbraith * When queueing an unbound work item to a wq, prefer local CPU if allowed 1710ef557180SMike Galbraith * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to 1711ef557180SMike Galbraith * avoid perturbing sensitive tasks. 1712ef557180SMike Galbraith */ 1713ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu) 1714ef557180SMike Galbraith { 1715ef557180SMike Galbraith int new_cpu; 1716ef557180SMike Galbraith 1717f303fccbSTejun Heo if (likely(!wq_debug_force_rr_cpu)) { 1718ef557180SMike Galbraith if (cpumask_test_cpu(cpu, wq_unbound_cpumask)) 1719ef557180SMike Galbraith return cpu; 1720a8ec5880SAmmar Faizi } else { 1721a8ec5880SAmmar Faizi pr_warn_once("workqueue: round-robin CPU selection forced, expect performance impact\n"); 1722f303fccbSTejun Heo } 1723f303fccbSTejun Heo 1724ef557180SMike Galbraith new_cpu = __this_cpu_read(wq_rr_cpu_last); 1725ef557180SMike Galbraith new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask); 1726ef557180SMike Galbraith if (unlikely(new_cpu >= nr_cpu_ids)) { 1727ef557180SMike Galbraith new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask); 1728ef557180SMike Galbraith if (unlikely(new_cpu >= nr_cpu_ids)) 1729ef557180SMike Galbraith return cpu; 1730ef557180SMike Galbraith } 1731ef557180SMike Galbraith __this_cpu_write(wq_rr_cpu_last, new_cpu); 1732ef557180SMike Galbraith 1733ef557180SMike Galbraith return new_cpu; 1734ef557180SMike Galbraith } 1735ef557180SMike Galbraith 1736d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq, 17371da177e4SLinus Torvalds struct work_struct *work) 17381da177e4SLinus Torvalds { 1739112202d9STejun Heo struct pool_workqueue *pwq; 1740fe089f87STejun Heo struct worker_pool *last_pool, *pool; 17418a2e8e5dSTejun Heo unsigned int work_flags; 1742b75cac93SJoonsoo Kim unsigned int req_cpu = cpu; 17438930cabaSTejun Heo 17448930cabaSTejun Heo /* 17458930cabaSTejun Heo * While a work item is PENDING && off queue, a task trying to 17468930cabaSTejun Heo * steal the PENDING will busy-loop waiting for it to either get 17478930cabaSTejun Heo * queued or lose PENDING. Grabbing PENDING and queueing should 17488930cabaSTejun Heo * happen with IRQ disabled. 17498930cabaSTejun Heo */ 17508e8eb730SFrederic Weisbecker lockdep_assert_irqs_disabled(); 17511da177e4SLinus Torvalds 17521e19ffc6STejun Heo 175333e3f0a3SRichard Clark /* 175433e3f0a3SRichard Clark * For a draining wq, only works from the same workqueue are 175533e3f0a3SRichard Clark * allowed. The __WQ_DESTROYING helps to spot the issue that 175633e3f0a3SRichard Clark * queues a new work item to a wq after destroy_workqueue(wq). 175733e3f0a3SRichard Clark */ 175833e3f0a3SRichard Clark if (unlikely(wq->flags & (__WQ_DESTROYING | __WQ_DRAINING) && 175933e3f0a3SRichard Clark WARN_ON_ONCE(!is_chained_work(wq)))) 1760e41e704bSTejun Heo return; 176124acfb71SThomas Gleixner rcu_read_lock(); 17629e8cd2f5STejun Heo retry: 1763aa202f1fSHillf Danton /* pwq which will be used unless @work is executing elsewhere */ 1764636b927eSTejun Heo if (req_cpu == WORK_CPU_UNBOUND) { 1765636b927eSTejun Heo if (wq->flags & WQ_UNBOUND) 1766ef557180SMike Galbraith cpu = wq_select_unbound_cpu(raw_smp_processor_id()); 1767636b927eSTejun Heo else 1768aa202f1fSHillf Danton cpu = raw_smp_processor_id(); 1769aa202f1fSHillf Danton } 1770f3421797STejun Heo 1771636b927eSTejun Heo pwq = rcu_dereference(*per_cpu_ptr(wq->cpu_pwq, cpu)); 1772fe089f87STejun Heo pool = pwq->pool; 1773fe089f87STejun Heo 177418aa9effSTejun Heo /* 1775c9178087STejun Heo * If @work was previously on a different pool, it might still be 1776c9178087STejun Heo * running there, in which case the work needs to be queued on that 1777c9178087STejun Heo * pool to guarantee non-reentrancy. 177818aa9effSTejun Heo */ 1779c9e7cf27STejun Heo last_pool = get_work_pool(work); 1780fe089f87STejun Heo if (last_pool && last_pool != pool) { 178118aa9effSTejun Heo struct worker *worker; 178218aa9effSTejun Heo 1783a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&last_pool->lock); 178418aa9effSTejun Heo 1785c9e7cf27STejun Heo worker = find_worker_executing_work(last_pool, work); 178618aa9effSTejun Heo 1787112202d9STejun Heo if (worker && worker->current_pwq->wq == wq) { 1788c9178087STejun Heo pwq = worker->current_pwq; 1789fe089f87STejun Heo pool = pwq->pool; 1790fe089f87STejun Heo WARN_ON_ONCE(pool != last_pool); 17918594fadeSLai Jiangshan } else { 179218aa9effSTejun Heo /* meh... not running there, queue here */ 1793a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&last_pool->lock); 1794fe089f87STejun Heo raw_spin_lock(&pool->lock); 179518aa9effSTejun Heo } 17968930cabaSTejun Heo } else { 1797fe089f87STejun Heo raw_spin_lock(&pool->lock); 17988930cabaSTejun Heo } 1799502ca9d8STejun Heo 18009e8cd2f5STejun Heo /* 1801636b927eSTejun Heo * pwq is determined and locked. For unbound pools, we could have raced 1802636b927eSTejun Heo * with pwq release and it could already be dead. If its refcnt is zero, 1803636b927eSTejun Heo * repeat pwq selection. Note that unbound pwqs never die without 1804636b927eSTejun Heo * another pwq replacing it in cpu_pwq or while work items are executing 1805636b927eSTejun Heo * on it, so the retrying is guaranteed to make forward-progress. 18069e8cd2f5STejun Heo */ 18079e8cd2f5STejun Heo if (unlikely(!pwq->refcnt)) { 18089e8cd2f5STejun Heo if (wq->flags & WQ_UNBOUND) { 1809fe089f87STejun Heo raw_spin_unlock(&pool->lock); 18109e8cd2f5STejun Heo cpu_relax(); 18119e8cd2f5STejun Heo goto retry; 18129e8cd2f5STejun Heo } 18139e8cd2f5STejun Heo /* oops */ 18149e8cd2f5STejun Heo WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt", 18159e8cd2f5STejun Heo wq->name, cpu); 18169e8cd2f5STejun Heo } 18179e8cd2f5STejun Heo 1818112202d9STejun Heo /* pwq determined, queue */ 1819112202d9STejun Heo trace_workqueue_queue_work(req_cpu, pwq, work); 1820502ca9d8STejun Heo 182124acfb71SThomas Gleixner if (WARN_ON(!list_empty(&work->entry))) 182224acfb71SThomas Gleixner goto out; 18231e19ffc6STejun Heo 1824112202d9STejun Heo pwq->nr_in_flight[pwq->work_color]++; 1825112202d9STejun Heo work_flags = work_color_to_flags(pwq->work_color); 18261e19ffc6STejun Heo 1827a045a272STejun Heo /* 1828a045a272STejun Heo * Limit the number of concurrently active work items to max_active. 1829a045a272STejun Heo * @work must also queue behind existing inactive work items to maintain 1830a045a272STejun Heo * ordering when max_active changes. See wq_adjust_max_active(). 1831a045a272STejun Heo */ 1832a045a272STejun Heo if (list_empty(&pwq->inactive_works) && 1833a045a272STejun Heo pwq->nr_active < READ_ONCE(pwq->wq->max_active)) { 1834fe089f87STejun Heo if (list_empty(&pool->worklist)) 1835fe089f87STejun Heo pool->watchdog_ts = jiffies; 1836fe089f87STejun Heo 1837cdadf009STejun Heo trace_workqueue_activate_work(work); 1838112202d9STejun Heo pwq->nr_active++; 1839fe089f87STejun Heo insert_work(pwq, work, &pool->worklist, work_flags); 18400219a352STejun Heo kick_pool(pool); 18418a2e8e5dSTejun Heo } else { 1842f97a4a1aSLai Jiangshan work_flags |= WORK_STRUCT_INACTIVE; 1843fe089f87STejun Heo insert_work(pwq, work, &pwq->inactive_works, work_flags); 18448a2e8e5dSTejun Heo } 18451e19ffc6STejun Heo 184624acfb71SThomas Gleixner out: 1847fe089f87STejun Heo raw_spin_unlock(&pool->lock); 184824acfb71SThomas Gleixner rcu_read_unlock(); 18491da177e4SLinus Torvalds } 18501da177e4SLinus Torvalds 18510fcb78c2SRolf Eike Beer /** 1852c1a220e7SZhang Rui * queue_work_on - queue work on specific cpu 1853c1a220e7SZhang Rui * @cpu: CPU number to execute work on 1854c1a220e7SZhang Rui * @wq: workqueue to use 1855c1a220e7SZhang Rui * @work: work to queue 1856c1a220e7SZhang Rui * 1857c1a220e7SZhang Rui * We queue the work to a specific CPU, the caller must ensure it 1858443378f0SPaul E. McKenney * can't go away. Callers that fail to ensure that the specified 1859443378f0SPaul E. McKenney * CPU cannot go away will execute on a randomly chosen CPU. 1860854f5cc5SPaul E. McKenney * But note well that callers specifying a CPU that never has been 1861854f5cc5SPaul E. McKenney * online will get a splat. 1862d185af30SYacine Belkadi * 1863d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. 1864c1a220e7SZhang Rui */ 1865d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq, 1866d4283e93STejun Heo struct work_struct *work) 1867c1a220e7SZhang Rui { 1868d4283e93STejun Heo bool ret = false; 18698930cabaSTejun Heo unsigned long flags; 18708930cabaSTejun Heo 18718930cabaSTejun Heo local_irq_save(flags); 1872c1a220e7SZhang Rui 187322df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 18744690c4abSTejun Heo __queue_work(cpu, wq, work); 1875d4283e93STejun Heo ret = true; 1876c1a220e7SZhang Rui } 18778930cabaSTejun Heo 18788930cabaSTejun Heo local_irq_restore(flags); 1879c1a220e7SZhang Rui return ret; 1880c1a220e7SZhang Rui } 1881ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on); 1882c1a220e7SZhang Rui 18838204e0c1SAlexander Duyck /** 1884fef59c9cSTejun Heo * select_numa_node_cpu - Select a CPU based on NUMA node 18858204e0c1SAlexander Duyck * @node: NUMA node ID that we want to select a CPU from 18868204e0c1SAlexander Duyck * 18878204e0c1SAlexander Duyck * This function will attempt to find a "random" cpu available on a given 18888204e0c1SAlexander Duyck * node. If there are no CPUs available on the given node it will return 18898204e0c1SAlexander Duyck * WORK_CPU_UNBOUND indicating that we should just schedule to any 18908204e0c1SAlexander Duyck * available CPU if we need to schedule this work. 18918204e0c1SAlexander Duyck */ 1892fef59c9cSTejun Heo static int select_numa_node_cpu(int node) 18938204e0c1SAlexander Duyck { 18948204e0c1SAlexander Duyck int cpu; 18958204e0c1SAlexander Duyck 18968204e0c1SAlexander Duyck /* Delay binding to CPU if node is not valid or online */ 18978204e0c1SAlexander Duyck if (node < 0 || node >= MAX_NUMNODES || !node_online(node)) 18988204e0c1SAlexander Duyck return WORK_CPU_UNBOUND; 18998204e0c1SAlexander Duyck 19008204e0c1SAlexander Duyck /* Use local node/cpu if we are already there */ 19018204e0c1SAlexander Duyck cpu = raw_smp_processor_id(); 19028204e0c1SAlexander Duyck if (node == cpu_to_node(cpu)) 19038204e0c1SAlexander Duyck return cpu; 19048204e0c1SAlexander Duyck 19058204e0c1SAlexander Duyck /* Use "random" otherwise know as "first" online CPU of node */ 19068204e0c1SAlexander Duyck cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask); 19078204e0c1SAlexander Duyck 19088204e0c1SAlexander Duyck /* If CPU is valid return that, otherwise just defer */ 19098204e0c1SAlexander Duyck return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND; 19108204e0c1SAlexander Duyck } 19118204e0c1SAlexander Duyck 19128204e0c1SAlexander Duyck /** 19138204e0c1SAlexander Duyck * queue_work_node - queue work on a "random" cpu for a given NUMA node 19148204e0c1SAlexander Duyck * @node: NUMA node that we are targeting the work for 19158204e0c1SAlexander Duyck * @wq: workqueue to use 19168204e0c1SAlexander Duyck * @work: work to queue 19178204e0c1SAlexander Duyck * 19188204e0c1SAlexander Duyck * We queue the work to a "random" CPU within a given NUMA node. The basic 19198204e0c1SAlexander Duyck * idea here is to provide a way to somehow associate work with a given 19208204e0c1SAlexander Duyck * NUMA node. 19218204e0c1SAlexander Duyck * 19228204e0c1SAlexander Duyck * This function will only make a best effort attempt at getting this onto 19238204e0c1SAlexander Duyck * the right NUMA node. If no node is requested or the requested node is 19248204e0c1SAlexander Duyck * offline then we just fall back to standard queue_work behavior. 19258204e0c1SAlexander Duyck * 19268204e0c1SAlexander Duyck * Currently the "random" CPU ends up being the first available CPU in the 19278204e0c1SAlexander Duyck * intersection of cpu_online_mask and the cpumask of the node, unless we 19288204e0c1SAlexander Duyck * are running on the node. In that case we just use the current CPU. 19298204e0c1SAlexander Duyck * 19308204e0c1SAlexander Duyck * Return: %false if @work was already on a queue, %true otherwise. 19318204e0c1SAlexander Duyck */ 19328204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq, 19338204e0c1SAlexander Duyck struct work_struct *work) 19348204e0c1SAlexander Duyck { 19358204e0c1SAlexander Duyck unsigned long flags; 19368204e0c1SAlexander Duyck bool ret = false; 19378204e0c1SAlexander Duyck 19388204e0c1SAlexander Duyck /* 19398204e0c1SAlexander Duyck * This current implementation is specific to unbound workqueues. 19408204e0c1SAlexander Duyck * Specifically we only return the first available CPU for a given 19418204e0c1SAlexander Duyck * node instead of cycling through individual CPUs within the node. 19428204e0c1SAlexander Duyck * 19438204e0c1SAlexander Duyck * If this is used with a per-cpu workqueue then the logic in 19448204e0c1SAlexander Duyck * workqueue_select_cpu_near would need to be updated to allow for 19458204e0c1SAlexander Duyck * some round robin type logic. 19468204e0c1SAlexander Duyck */ 19478204e0c1SAlexander Duyck WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)); 19488204e0c1SAlexander Duyck 19498204e0c1SAlexander Duyck local_irq_save(flags); 19508204e0c1SAlexander Duyck 19518204e0c1SAlexander Duyck if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 1952fef59c9cSTejun Heo int cpu = select_numa_node_cpu(node); 19538204e0c1SAlexander Duyck 19548204e0c1SAlexander Duyck __queue_work(cpu, wq, work); 19558204e0c1SAlexander Duyck ret = true; 19568204e0c1SAlexander Duyck } 19578204e0c1SAlexander Duyck 19588204e0c1SAlexander Duyck local_irq_restore(flags); 19598204e0c1SAlexander Duyck return ret; 19608204e0c1SAlexander Duyck } 19618204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node); 19628204e0c1SAlexander Duyck 19638c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t) 19641da177e4SLinus Torvalds { 19658c20feb6SKees Cook struct delayed_work *dwork = from_timer(dwork, t, timer); 19661da177e4SLinus Torvalds 1967e0aecdd8STejun Heo /* should have been called from irqsafe timer with irq already off */ 196860c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 19691da177e4SLinus Torvalds } 19701438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn); 19711da177e4SLinus Torvalds 19727beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq, 197352bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 19741da177e4SLinus Torvalds { 19757beb2edfSTejun Heo struct timer_list *timer = &dwork->timer; 19767beb2edfSTejun Heo struct work_struct *work = &dwork->work; 19771da177e4SLinus Torvalds 1978637fdbaeSTejun Heo WARN_ON_ONCE(!wq); 19794b243563SSami Tolvanen WARN_ON_ONCE(timer->function != delayed_work_timer_fn); 1980fc4b514fSTejun Heo WARN_ON_ONCE(timer_pending(timer)); 1981fc4b514fSTejun Heo WARN_ON_ONCE(!list_empty(&work->entry)); 19827beb2edfSTejun Heo 19838852aac2STejun Heo /* 19848852aac2STejun Heo * If @delay is 0, queue @dwork->work immediately. This is for 19858852aac2STejun Heo * both optimization and correctness. The earliest @timer can 19868852aac2STejun Heo * expire is on the closest next tick and delayed_work users depend 19878852aac2STejun Heo * on that there's no such delay when @delay is 0. 19888852aac2STejun Heo */ 19898852aac2STejun Heo if (!delay) { 19908852aac2STejun Heo __queue_work(cpu, wq, &dwork->work); 19918852aac2STejun Heo return; 19928852aac2STejun Heo } 19938852aac2STejun Heo 199460c057bcSLai Jiangshan dwork->wq = wq; 19951265057fSTejun Heo dwork->cpu = cpu; 19967beb2edfSTejun Heo timer->expires = jiffies + delay; 19977beb2edfSTejun Heo 1998041bd12eSTejun Heo if (unlikely(cpu != WORK_CPU_UNBOUND)) 19997beb2edfSTejun Heo add_timer_on(timer, cpu); 2000041bd12eSTejun Heo else 2001041bd12eSTejun Heo add_timer(timer); 20027beb2edfSTejun Heo } 20031da177e4SLinus Torvalds 20040fcb78c2SRolf Eike Beer /** 20050fcb78c2SRolf Eike Beer * queue_delayed_work_on - queue work on specific CPU after delay 20060fcb78c2SRolf Eike Beer * @cpu: CPU number to execute work on 20070fcb78c2SRolf Eike Beer * @wq: workqueue to use 2008af9997e4SRandy Dunlap * @dwork: work to queue 20090fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 20100fcb78c2SRolf Eike Beer * 2011d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. If 2012715f1300STejun Heo * @delay is zero and @dwork is idle, it will be scheduled for immediate 2013715f1300STejun Heo * execution. 20140fcb78c2SRolf Eike Beer */ 2015d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 201652bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 20177a6bc1cdSVenkatesh Pallipadi { 201852bad64dSDavid Howells struct work_struct *work = &dwork->work; 2019d4283e93STejun Heo bool ret = false; 20208930cabaSTejun Heo unsigned long flags; 20218930cabaSTejun Heo 20228930cabaSTejun Heo /* read the comment in __queue_work() */ 20238930cabaSTejun Heo local_irq_save(flags); 20247a6bc1cdSVenkatesh Pallipadi 202522df02bbSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 20267beb2edfSTejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 2027d4283e93STejun Heo ret = true; 20287a6bc1cdSVenkatesh Pallipadi } 20298930cabaSTejun Heo 20308930cabaSTejun Heo local_irq_restore(flags); 20317a6bc1cdSVenkatesh Pallipadi return ret; 20327a6bc1cdSVenkatesh Pallipadi } 2033ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on); 20341da177e4SLinus Torvalds 2035c8e55f36STejun Heo /** 20368376fe22STejun Heo * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU 20378376fe22STejun Heo * @cpu: CPU number to execute work on 20388376fe22STejun Heo * @wq: workqueue to use 20398376fe22STejun Heo * @dwork: work to queue 20408376fe22STejun Heo * @delay: number of jiffies to wait before queueing 20418376fe22STejun Heo * 20428376fe22STejun Heo * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise, 20438376fe22STejun Heo * modify @dwork's timer so that it expires after @delay. If @delay is 20448376fe22STejun Heo * zero, @work is guaranteed to be scheduled immediately regardless of its 20458376fe22STejun Heo * current state. 20468376fe22STejun Heo * 2047d185af30SYacine Belkadi * Return: %false if @dwork was idle and queued, %true if @dwork was 20488376fe22STejun Heo * pending and its timer was modified. 20498376fe22STejun Heo * 2050e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 20518376fe22STejun Heo * See try_to_grab_pending() for details. 20528376fe22STejun Heo */ 20538376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, 20548376fe22STejun Heo struct delayed_work *dwork, unsigned long delay) 20558376fe22STejun Heo { 20568376fe22STejun Heo unsigned long flags; 20578376fe22STejun Heo int ret; 20588376fe22STejun Heo 20598376fe22STejun Heo do { 20608376fe22STejun Heo ret = try_to_grab_pending(&dwork->work, true, &flags); 20618376fe22STejun Heo } while (unlikely(ret == -EAGAIN)); 20628376fe22STejun Heo 20638376fe22STejun Heo if (likely(ret >= 0)) { 20648376fe22STejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 20658376fe22STejun Heo local_irq_restore(flags); 20668376fe22STejun Heo } 20678376fe22STejun Heo 20688376fe22STejun Heo /* -ENOENT from try_to_grab_pending() becomes %true */ 20698376fe22STejun Heo return ret; 20708376fe22STejun Heo } 20718376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on); 20728376fe22STejun Heo 207305f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu) 207405f0fe6bSTejun Heo { 207505f0fe6bSTejun Heo struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu); 207605f0fe6bSTejun Heo 207705f0fe6bSTejun Heo /* read the comment in __queue_work() */ 207805f0fe6bSTejun Heo local_irq_disable(); 207905f0fe6bSTejun Heo __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work); 208005f0fe6bSTejun Heo local_irq_enable(); 208105f0fe6bSTejun Heo } 208205f0fe6bSTejun Heo 208305f0fe6bSTejun Heo /** 208405f0fe6bSTejun Heo * queue_rcu_work - queue work after a RCU grace period 208505f0fe6bSTejun Heo * @wq: workqueue to use 208605f0fe6bSTejun Heo * @rwork: work to queue 208705f0fe6bSTejun Heo * 208805f0fe6bSTejun Heo * Return: %false if @rwork was already pending, %true otherwise. Note 208905f0fe6bSTejun Heo * that a full RCU grace period is guaranteed only after a %true return. 2090bf393fd4SBart Van Assche * While @rwork is guaranteed to be executed after a %false return, the 209105f0fe6bSTejun Heo * execution may happen before a full RCU grace period has passed. 209205f0fe6bSTejun Heo */ 209305f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork) 209405f0fe6bSTejun Heo { 209505f0fe6bSTejun Heo struct work_struct *work = &rwork->work; 209605f0fe6bSTejun Heo 209705f0fe6bSTejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) { 209805f0fe6bSTejun Heo rwork->wq = wq; 2099a7e30c0eSUladzislau Rezki call_rcu_hurry(&rwork->rcu, rcu_work_rcufn); 210005f0fe6bSTejun Heo return true; 210105f0fe6bSTejun Heo } 210205f0fe6bSTejun Heo 210305f0fe6bSTejun Heo return false; 210405f0fe6bSTejun Heo } 210505f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work); 210605f0fe6bSTejun Heo 2107f7537df5SLai Jiangshan static struct worker *alloc_worker(int node) 2108c34056a3STejun Heo { 2109c34056a3STejun Heo struct worker *worker; 2110c34056a3STejun Heo 2111f7537df5SLai Jiangshan worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node); 2112c8e55f36STejun Heo if (worker) { 2113c8e55f36STejun Heo INIT_LIST_HEAD(&worker->entry); 2114affee4b2STejun Heo INIT_LIST_HEAD(&worker->scheduled); 2115da028469SLai Jiangshan INIT_LIST_HEAD(&worker->node); 2116e22bee78STejun Heo /* on creation a worker is in !idle && prep state */ 2117e22bee78STejun Heo worker->flags = WORKER_PREP; 2118c8e55f36STejun Heo } 2119c34056a3STejun Heo return worker; 2120c34056a3STejun Heo } 2121c34056a3STejun Heo 21229546b29eSTejun Heo static cpumask_t *pool_allowed_cpus(struct worker_pool *pool) 21239546b29eSTejun Heo { 21248639ecebSTejun Heo if (pool->cpu < 0 && pool->attrs->affn_strict) 21259546b29eSTejun Heo return pool->attrs->__pod_cpumask; 21268639ecebSTejun Heo else 21278639ecebSTejun Heo return pool->attrs->cpumask; 21289546b29eSTejun Heo } 21299546b29eSTejun Heo 2130c34056a3STejun Heo /** 21314736cbf7SLai Jiangshan * worker_attach_to_pool() - attach a worker to a pool 21324736cbf7SLai Jiangshan * @worker: worker to be attached 21334736cbf7SLai Jiangshan * @pool: the target pool 21344736cbf7SLai Jiangshan * 21354736cbf7SLai Jiangshan * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and 21364736cbf7SLai Jiangshan * cpu-binding of @worker are kept coordinated with the pool across 21374736cbf7SLai Jiangshan * cpu-[un]hotplugs. 21384736cbf7SLai Jiangshan */ 21394736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker, 21404736cbf7SLai Jiangshan struct worker_pool *pool) 21414736cbf7SLai Jiangshan { 21421258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 21434736cbf7SLai Jiangshan 21444736cbf7SLai Jiangshan /* 21451258fae7STejun Heo * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains 21461258fae7STejun Heo * stable across this function. See the comments above the flag 21471258fae7STejun Heo * definition for details. 21484736cbf7SLai Jiangshan */ 21494736cbf7SLai Jiangshan if (pool->flags & POOL_DISASSOCIATED) 21504736cbf7SLai Jiangshan worker->flags |= WORKER_UNBOUND; 21515c25b5ffSPeter Zijlstra else 21525c25b5ffSPeter Zijlstra kthread_set_per_cpu(worker->task, pool->cpu); 21534736cbf7SLai Jiangshan 2154640f17c8SPeter Zijlstra if (worker->rescue_wq) 21559546b29eSTejun Heo set_cpus_allowed_ptr(worker->task, pool_allowed_cpus(pool)); 2156640f17c8SPeter Zijlstra 21574736cbf7SLai Jiangshan list_add_tail(&worker->node, &pool->workers); 2158a2d812a2STejun Heo worker->pool = pool; 21594736cbf7SLai Jiangshan 21601258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 21614736cbf7SLai Jiangshan } 21624736cbf7SLai Jiangshan 21634736cbf7SLai Jiangshan /** 216460f5a4bcSLai Jiangshan * worker_detach_from_pool() - detach a worker from its pool 216560f5a4bcSLai Jiangshan * @worker: worker which is attached to its pool 216660f5a4bcSLai Jiangshan * 21674736cbf7SLai Jiangshan * Undo the attaching which had been done in worker_attach_to_pool(). The 21684736cbf7SLai Jiangshan * caller worker shouldn't access to the pool after detached except it has 21694736cbf7SLai Jiangshan * other reference to the pool. 217060f5a4bcSLai Jiangshan */ 2171a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker) 217260f5a4bcSLai Jiangshan { 2173a2d812a2STejun Heo struct worker_pool *pool = worker->pool; 217460f5a4bcSLai Jiangshan struct completion *detach_completion = NULL; 217560f5a4bcSLai Jiangshan 21761258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 2177a2d812a2STejun Heo 21785c25b5ffSPeter Zijlstra kthread_set_per_cpu(worker->task, -1); 2179da028469SLai Jiangshan list_del(&worker->node); 2180a2d812a2STejun Heo worker->pool = NULL; 2181a2d812a2STejun Heo 2182e02b9312SValentin Schneider if (list_empty(&pool->workers) && list_empty(&pool->dying_workers)) 218360f5a4bcSLai Jiangshan detach_completion = pool->detach_completion; 21841258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 218560f5a4bcSLai Jiangshan 2186b62c0751SLai Jiangshan /* clear leftover flags without pool->lock after it is detached */ 2187b62c0751SLai Jiangshan worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND); 2188b62c0751SLai Jiangshan 218960f5a4bcSLai Jiangshan if (detach_completion) 219060f5a4bcSLai Jiangshan complete(detach_completion); 219160f5a4bcSLai Jiangshan } 219260f5a4bcSLai Jiangshan 219360f5a4bcSLai Jiangshan /** 2194c34056a3STejun Heo * create_worker - create a new workqueue worker 219563d95a91STejun Heo * @pool: pool the new worker will belong to 2196c34056a3STejun Heo * 2197051e1850SLai Jiangshan * Create and start a new worker which is attached to @pool. 2198c34056a3STejun Heo * 2199c34056a3STejun Heo * CONTEXT: 2200c34056a3STejun Heo * Might sleep. Does GFP_KERNEL allocations. 2201c34056a3STejun Heo * 2202d185af30SYacine Belkadi * Return: 2203c34056a3STejun Heo * Pointer to the newly created worker. 2204c34056a3STejun Heo */ 2205bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool) 2206c34056a3STejun Heo { 2207e441b56fSZhen Lei struct worker *worker; 2208e441b56fSZhen Lei int id; 22095d9c7a1eSLucy Mielke char id_buf[23]; 2210c34056a3STejun Heo 22117cda9aaeSLai Jiangshan /* ID is needed to determine kthread name */ 2212e441b56fSZhen Lei id = ida_alloc(&pool->worker_ida, GFP_KERNEL); 22133f0ea0b8SPetr Mladek if (id < 0) { 22143f0ea0b8SPetr Mladek pr_err_once("workqueue: Failed to allocate a worker ID: %pe\n", 22153f0ea0b8SPetr Mladek ERR_PTR(id)); 2216e441b56fSZhen Lei return NULL; 22173f0ea0b8SPetr Mladek } 2218c34056a3STejun Heo 2219f7537df5SLai Jiangshan worker = alloc_worker(pool->node); 22203f0ea0b8SPetr Mladek if (!worker) { 22213f0ea0b8SPetr Mladek pr_err_once("workqueue: Failed to allocate a worker\n"); 2222c34056a3STejun Heo goto fail; 22233f0ea0b8SPetr Mladek } 2224c34056a3STejun Heo 2225c34056a3STejun Heo worker->id = id; 2226c34056a3STejun Heo 222729c91e99STejun Heo if (pool->cpu >= 0) 2228e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id, 2229e3c916a4STejun Heo pool->attrs->nice < 0 ? "H" : ""); 2230f3421797STejun Heo else 2231e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id); 2232e3c916a4STejun Heo 2233f3f90ad4STejun Heo worker->task = kthread_create_on_node(worker_thread, worker, pool->node, 2234e3c916a4STejun Heo "kworker/%s", id_buf); 22353f0ea0b8SPetr Mladek if (IS_ERR(worker->task)) { 223660f54038SPetr Mladek if (PTR_ERR(worker->task) == -EINTR) { 223760f54038SPetr Mladek pr_err("workqueue: Interrupted when creating a worker thread \"kworker/%s\"\n", 223860f54038SPetr Mladek id_buf); 223960f54038SPetr Mladek } else { 22403f0ea0b8SPetr Mladek pr_err_once("workqueue: Failed to create a worker thread: %pe", 22413f0ea0b8SPetr Mladek worker->task); 224260f54038SPetr Mladek } 2243c34056a3STejun Heo goto fail; 22443f0ea0b8SPetr Mladek } 2245c34056a3STejun Heo 224691151228SOleg Nesterov set_user_nice(worker->task, pool->attrs->nice); 22479546b29eSTejun Heo kthread_bind_mask(worker->task, pool_allowed_cpus(pool)); 224891151228SOleg Nesterov 2249da028469SLai Jiangshan /* successful, attach the worker to the pool */ 22504736cbf7SLai Jiangshan worker_attach_to_pool(worker, pool); 2251822d8405STejun Heo 2252051e1850SLai Jiangshan /* start the newly created worker */ 2253a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 22540219a352STejun Heo 2255051e1850SLai Jiangshan worker->pool->nr_workers++; 2256051e1850SLai Jiangshan worker_enter_idle(worker); 22570219a352STejun Heo 22580219a352STejun Heo /* 22590219a352STejun Heo * @worker is waiting on a completion in kthread() and will trigger hung 22606a229b0eSTejun Heo * check if not woken up soon. As kick_pool() is noop if @pool is empty, 22616a229b0eSTejun Heo * wake it up explicitly. 22620219a352STejun Heo */ 2263051e1850SLai Jiangshan wake_up_process(worker->task); 22640219a352STejun Heo 2265a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2266051e1850SLai Jiangshan 2267c34056a3STejun Heo return worker; 2268822d8405STejun Heo 2269c34056a3STejun Heo fail: 2270e441b56fSZhen Lei ida_free(&pool->worker_ida, id); 2271c34056a3STejun Heo kfree(worker); 2272c34056a3STejun Heo return NULL; 2273c34056a3STejun Heo } 2274c34056a3STejun Heo 2275793777bcSValentin Schneider static void unbind_worker(struct worker *worker) 2276793777bcSValentin Schneider { 2277793777bcSValentin Schneider lockdep_assert_held(&wq_pool_attach_mutex); 2278793777bcSValentin Schneider 2279793777bcSValentin Schneider kthread_set_per_cpu(worker->task, -1); 2280793777bcSValentin Schneider if (cpumask_intersects(wq_unbound_cpumask, cpu_active_mask)) 2281793777bcSValentin Schneider WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, wq_unbound_cpumask) < 0); 2282793777bcSValentin Schneider else 2283793777bcSValentin Schneider WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0); 2284793777bcSValentin Schneider } 2285793777bcSValentin Schneider 2286e02b9312SValentin Schneider static void wake_dying_workers(struct list_head *cull_list) 2287e02b9312SValentin Schneider { 2288e02b9312SValentin Schneider struct worker *worker, *tmp; 2289e02b9312SValentin Schneider 2290e02b9312SValentin Schneider list_for_each_entry_safe(worker, tmp, cull_list, entry) { 2291e02b9312SValentin Schneider list_del_init(&worker->entry); 2292e02b9312SValentin Schneider unbind_worker(worker); 2293e02b9312SValentin Schneider /* 2294e02b9312SValentin Schneider * If the worker was somehow already running, then it had to be 2295e02b9312SValentin Schneider * in pool->idle_list when set_worker_dying() happened or we 2296e02b9312SValentin Schneider * wouldn't have gotten here. 2297c34056a3STejun Heo * 2298e02b9312SValentin Schneider * Thus, the worker must either have observed the WORKER_DIE 2299e02b9312SValentin Schneider * flag, or have set its state to TASK_IDLE. Either way, the 2300e02b9312SValentin Schneider * below will be observed by the worker and is safe to do 2301e02b9312SValentin Schneider * outside of pool->lock. 2302e02b9312SValentin Schneider */ 2303e02b9312SValentin Schneider wake_up_process(worker->task); 2304e02b9312SValentin Schneider } 2305e02b9312SValentin Schneider } 2306e02b9312SValentin Schneider 2307e02b9312SValentin Schneider /** 2308e02b9312SValentin Schneider * set_worker_dying - Tag a worker for destruction 2309e02b9312SValentin Schneider * @worker: worker to be destroyed 2310e02b9312SValentin Schneider * @list: transfer worker away from its pool->idle_list and into list 2311e02b9312SValentin Schneider * 2312e02b9312SValentin Schneider * Tag @worker for destruction and adjust @pool stats accordingly. The worker 2313e02b9312SValentin Schneider * should be idle. 2314c8e55f36STejun Heo * 2315c8e55f36STejun Heo * CONTEXT: 2316a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 2317c34056a3STejun Heo */ 2318e02b9312SValentin Schneider static void set_worker_dying(struct worker *worker, struct list_head *list) 2319c34056a3STejun Heo { 2320bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 2321c34056a3STejun Heo 2322cd549687STejun Heo lockdep_assert_held(&pool->lock); 2323e02b9312SValentin Schneider lockdep_assert_held(&wq_pool_attach_mutex); 2324cd549687STejun Heo 2325c34056a3STejun Heo /* sanity check frenzy */ 23266183c009STejun Heo if (WARN_ON(worker->current_work) || 232773eb7fe7SLai Jiangshan WARN_ON(!list_empty(&worker->scheduled)) || 232873eb7fe7SLai Jiangshan WARN_ON(!(worker->flags & WORKER_IDLE))) 23296183c009STejun Heo return; 2330c34056a3STejun Heo 2331bd7bdd43STejun Heo pool->nr_workers--; 2332bd7bdd43STejun Heo pool->nr_idle--; 2333c8e55f36STejun Heo 2334cb444766STejun Heo worker->flags |= WORKER_DIE; 2335e02b9312SValentin Schneider 2336e02b9312SValentin Schneider list_move(&worker->entry, list); 2337e02b9312SValentin Schneider list_move(&worker->node, &pool->dying_workers); 2338c34056a3STejun Heo } 2339c34056a3STejun Heo 23403f959aa3SValentin Schneider /** 23413f959aa3SValentin Schneider * idle_worker_timeout - check if some idle workers can now be deleted. 23423f959aa3SValentin Schneider * @t: The pool's idle_timer that just expired 23433f959aa3SValentin Schneider * 23443f959aa3SValentin Schneider * The timer is armed in worker_enter_idle(). Note that it isn't disarmed in 23453f959aa3SValentin Schneider * worker_leave_idle(), as a worker flicking between idle and active while its 23463f959aa3SValentin Schneider * pool is at the too_many_workers() tipping point would cause too much timer 23473f959aa3SValentin Schneider * housekeeping overhead. Since IDLE_WORKER_TIMEOUT is long enough, we just let 23483f959aa3SValentin Schneider * it expire and re-evaluate things from there. 23493f959aa3SValentin Schneider */ 235032a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t) 2351e22bee78STejun Heo { 235232a6c723SKees Cook struct worker_pool *pool = from_timer(pool, t, idle_timer); 23533f959aa3SValentin Schneider bool do_cull = false; 23543f959aa3SValentin Schneider 23553f959aa3SValentin Schneider if (work_pending(&pool->idle_cull_work)) 23563f959aa3SValentin Schneider return; 23573f959aa3SValentin Schneider 23583f959aa3SValentin Schneider raw_spin_lock_irq(&pool->lock); 23593f959aa3SValentin Schneider 23603f959aa3SValentin Schneider if (too_many_workers(pool)) { 23613f959aa3SValentin Schneider struct worker *worker; 23623f959aa3SValentin Schneider unsigned long expires; 23633f959aa3SValentin Schneider 23643f959aa3SValentin Schneider /* idle_list is kept in LIFO order, check the last one */ 23653f959aa3SValentin Schneider worker = list_entry(pool->idle_list.prev, struct worker, entry); 23663f959aa3SValentin Schneider expires = worker->last_active + IDLE_WORKER_TIMEOUT; 23673f959aa3SValentin Schneider do_cull = !time_before(jiffies, expires); 23683f959aa3SValentin Schneider 23693f959aa3SValentin Schneider if (!do_cull) 23703f959aa3SValentin Schneider mod_timer(&pool->idle_timer, expires); 23713f959aa3SValentin Schneider } 23723f959aa3SValentin Schneider raw_spin_unlock_irq(&pool->lock); 23733f959aa3SValentin Schneider 23743f959aa3SValentin Schneider if (do_cull) 23753f959aa3SValentin Schneider queue_work(system_unbound_wq, &pool->idle_cull_work); 23763f959aa3SValentin Schneider } 23773f959aa3SValentin Schneider 23783f959aa3SValentin Schneider /** 23793f959aa3SValentin Schneider * idle_cull_fn - cull workers that have been idle for too long. 23803f959aa3SValentin Schneider * @work: the pool's work for handling these idle workers 23813f959aa3SValentin Schneider * 23823f959aa3SValentin Schneider * This goes through a pool's idle workers and gets rid of those that have been 23833f959aa3SValentin Schneider * idle for at least IDLE_WORKER_TIMEOUT seconds. 2384e02b9312SValentin Schneider * 2385e02b9312SValentin Schneider * We don't want to disturb isolated CPUs because of a pcpu kworker being 2386e02b9312SValentin Schneider * culled, so this also resets worker affinity. This requires a sleepable 2387e02b9312SValentin Schneider * context, hence the split between timer callback and work item. 23883f959aa3SValentin Schneider */ 23893f959aa3SValentin Schneider static void idle_cull_fn(struct work_struct *work) 23903f959aa3SValentin Schneider { 23913f959aa3SValentin Schneider struct worker_pool *pool = container_of(work, struct worker_pool, idle_cull_work); 23929680540cSYang Yingliang LIST_HEAD(cull_list); 2393e22bee78STejun Heo 2394e02b9312SValentin Schneider /* 2395e02b9312SValentin Schneider * Grabbing wq_pool_attach_mutex here ensures an already-running worker 2396e02b9312SValentin Schneider * cannot proceed beyong worker_detach_from_pool() in its self-destruct 2397e02b9312SValentin Schneider * path. This is required as a previously-preempted worker could run after 2398e02b9312SValentin Schneider * set_worker_dying() has happened but before wake_dying_workers() did. 2399e02b9312SValentin Schneider */ 2400e02b9312SValentin Schneider mutex_lock(&wq_pool_attach_mutex); 2401a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2402e22bee78STejun Heo 24033347fc9fSLai Jiangshan while (too_many_workers(pool)) { 2404e22bee78STejun Heo struct worker *worker; 2405e22bee78STejun Heo unsigned long expires; 2406e22bee78STejun Heo 240763d95a91STejun Heo worker = list_entry(pool->idle_list.prev, struct worker, entry); 2408e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 2409e22bee78STejun Heo 24103347fc9fSLai Jiangshan if (time_before(jiffies, expires)) { 241163d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 24123347fc9fSLai Jiangshan break; 2413e22bee78STejun Heo } 24143347fc9fSLai Jiangshan 2415e02b9312SValentin Schneider set_worker_dying(worker, &cull_list); 2416e22bee78STejun Heo } 2417e22bee78STejun Heo 2418a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2419e02b9312SValentin Schneider wake_dying_workers(&cull_list); 2420e02b9312SValentin Schneider mutex_unlock(&wq_pool_attach_mutex); 2421e22bee78STejun Heo } 2422e22bee78STejun Heo 2423493a1724STejun Heo static void send_mayday(struct work_struct *work) 2424e22bee78STejun Heo { 2425112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 2426112202d9STejun Heo struct workqueue_struct *wq = pwq->wq; 2427493a1724STejun Heo 24282e109a28STejun Heo lockdep_assert_held(&wq_mayday_lock); 2429e22bee78STejun Heo 2430493008a8STejun Heo if (!wq->rescuer) 2431493a1724STejun Heo return; 2432e22bee78STejun Heo 2433e22bee78STejun Heo /* mayday mayday mayday */ 2434493a1724STejun Heo if (list_empty(&pwq->mayday_node)) { 243577668c8bSLai Jiangshan /* 243677668c8bSLai Jiangshan * If @pwq is for an unbound wq, its base ref may be put at 243777668c8bSLai Jiangshan * any time due to an attribute change. Pin @pwq until the 243877668c8bSLai Jiangshan * rescuer is done with it. 243977668c8bSLai Jiangshan */ 244077668c8bSLai Jiangshan get_pwq(pwq); 2441493a1724STejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 2442e22bee78STejun Heo wake_up_process(wq->rescuer->task); 2443725e8ec5STejun Heo pwq->stats[PWQ_STAT_MAYDAY]++; 2444493a1724STejun Heo } 2445e22bee78STejun Heo } 2446e22bee78STejun Heo 244732a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t) 2448e22bee78STejun Heo { 244932a6c723SKees Cook struct worker_pool *pool = from_timer(pool, t, mayday_timer); 2450e22bee78STejun Heo struct work_struct *work; 2451e22bee78STejun Heo 2452a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2453a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&wq_mayday_lock); /* for wq->maydays */ 2454e22bee78STejun Heo 245563d95a91STejun Heo if (need_to_create_worker(pool)) { 2456e22bee78STejun Heo /* 2457e22bee78STejun Heo * We've been trying to create a new worker but 2458e22bee78STejun Heo * haven't been successful. We might be hitting an 2459e22bee78STejun Heo * allocation deadlock. Send distress signals to 2460e22bee78STejun Heo * rescuers. 2461e22bee78STejun Heo */ 246263d95a91STejun Heo list_for_each_entry(work, &pool->worklist, entry) 2463e22bee78STejun Heo send_mayday(work); 2464e22bee78STejun Heo } 2465e22bee78STejun Heo 2466a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&wq_mayday_lock); 2467a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2468e22bee78STejun Heo 246963d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL); 2470e22bee78STejun Heo } 2471e22bee78STejun Heo 2472e22bee78STejun Heo /** 2473e22bee78STejun Heo * maybe_create_worker - create a new worker if necessary 247463d95a91STejun Heo * @pool: pool to create a new worker for 2475e22bee78STejun Heo * 247663d95a91STejun Heo * Create a new worker for @pool if necessary. @pool is guaranteed to 2477e22bee78STejun Heo * have at least one idle worker on return from this function. If 2478e22bee78STejun Heo * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is 247963d95a91STejun Heo * sent to all rescuers with works scheduled on @pool to resolve 2480e22bee78STejun Heo * possible allocation deadlock. 2481e22bee78STejun Heo * 2482c5aa87bbSTejun Heo * On return, need_to_create_worker() is guaranteed to be %false and 2483c5aa87bbSTejun Heo * may_start_working() %true. 2484e22bee78STejun Heo * 2485e22bee78STejun Heo * LOCKING: 2486a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 2487e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. Called only from 2488e22bee78STejun Heo * manager. 2489e22bee78STejun Heo */ 249029187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool) 2491d565ed63STejun Heo __releases(&pool->lock) 2492d565ed63STejun Heo __acquires(&pool->lock) 2493e22bee78STejun Heo { 2494e22bee78STejun Heo restart: 2495a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 24969f9c2364STejun Heo 2497e22bee78STejun Heo /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ 249863d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); 2499e22bee78STejun Heo 2500e22bee78STejun Heo while (true) { 2501051e1850SLai Jiangshan if (create_worker(pool) || !need_to_create_worker(pool)) 2502e22bee78STejun Heo break; 2503e22bee78STejun Heo 2504e212f361SLai Jiangshan schedule_timeout_interruptible(CREATE_COOLDOWN); 25059f9c2364STejun Heo 250663d95a91STejun Heo if (!need_to_create_worker(pool)) 2507e22bee78STejun Heo break; 2508e22bee78STejun Heo } 2509e22bee78STejun Heo 251063d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 2511a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2512051e1850SLai Jiangshan /* 2513051e1850SLai Jiangshan * This is necessary even after a new worker was just successfully 2514051e1850SLai Jiangshan * created as @pool->lock was dropped and the new worker might have 2515051e1850SLai Jiangshan * already become busy. 2516051e1850SLai Jiangshan */ 251763d95a91STejun Heo if (need_to_create_worker(pool)) 2518e22bee78STejun Heo goto restart; 2519e22bee78STejun Heo } 2520e22bee78STejun Heo 2521e22bee78STejun Heo /** 2522e22bee78STejun Heo * manage_workers - manage worker pool 2523e22bee78STejun Heo * @worker: self 2524e22bee78STejun Heo * 2525706026c2STejun Heo * Assume the manager role and manage the worker pool @worker belongs 2526e22bee78STejun Heo * to. At any given time, there can be only zero or one manager per 2527706026c2STejun Heo * pool. The exclusion is handled automatically by this function. 2528e22bee78STejun Heo * 2529e22bee78STejun Heo * The caller can safely start processing works on false return. On 2530e22bee78STejun Heo * true return, it's guaranteed that need_to_create_worker() is false 2531e22bee78STejun Heo * and may_start_working() is true. 2532e22bee78STejun Heo * 2533e22bee78STejun Heo * CONTEXT: 2534a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 2535e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. 2536e22bee78STejun Heo * 2537d185af30SYacine Belkadi * Return: 253829187a9eSTejun Heo * %false if the pool doesn't need management and the caller can safely 253929187a9eSTejun Heo * start processing works, %true if management function was performed and 254029187a9eSTejun Heo * the conditions that the caller verified before calling the function may 254129187a9eSTejun Heo * no longer be true. 2542e22bee78STejun Heo */ 2543e22bee78STejun Heo static bool manage_workers(struct worker *worker) 2544e22bee78STejun Heo { 254563d95a91STejun Heo struct worker_pool *pool = worker->pool; 2546e22bee78STejun Heo 2547692b4825STejun Heo if (pool->flags & POOL_MANAGER_ACTIVE) 254829187a9eSTejun Heo return false; 2549692b4825STejun Heo 2550692b4825STejun Heo pool->flags |= POOL_MANAGER_ACTIVE; 25512607d7a6STejun Heo pool->manager = worker; 2552e22bee78STejun Heo 255329187a9eSTejun Heo maybe_create_worker(pool); 2554e22bee78STejun Heo 25552607d7a6STejun Heo pool->manager = NULL; 2556692b4825STejun Heo pool->flags &= ~POOL_MANAGER_ACTIVE; 2557d8bb65abSSebastian Andrzej Siewior rcuwait_wake_up(&manager_wait); 255829187a9eSTejun Heo return true; 2559e22bee78STejun Heo } 2560e22bee78STejun Heo 2561a62428c0STejun Heo /** 2562a62428c0STejun Heo * process_one_work - process single work 2563c34056a3STejun Heo * @worker: self 2564a62428c0STejun Heo * @work: work to process 2565a62428c0STejun Heo * 2566a62428c0STejun Heo * Process @work. This function contains all the logics necessary to 2567a62428c0STejun Heo * process a single work including synchronization against and 2568a62428c0STejun Heo * interaction with other workers on the same cpu, queueing and 2569a62428c0STejun Heo * flushing. As long as context requirement is met, any worker can 2570a62428c0STejun Heo * call this function to process a work. 2571a62428c0STejun Heo * 2572a62428c0STejun Heo * CONTEXT: 2573a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which is released and regrabbed. 2574a62428c0STejun Heo */ 2575c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work) 2576d565ed63STejun Heo __releases(&pool->lock) 2577d565ed63STejun Heo __acquires(&pool->lock) 25781da177e4SLinus Torvalds { 2579112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 2580bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 2581c4560c2cSLai Jiangshan unsigned long work_data; 25824e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 25834e6045f1SJohannes Berg /* 2584a62428c0STejun Heo * It is permissible to free the struct work_struct from 2585a62428c0STejun Heo * inside the function that is called from it, this we need to 2586a62428c0STejun Heo * take into account for lockdep too. To avoid bogus "held 2587a62428c0STejun Heo * lock freed" warnings as well as problems when looking into 2588a62428c0STejun Heo * work->lockdep_map, make a copy and use that here. 25894e6045f1SJohannes Berg */ 25904d82a1deSPeter Zijlstra struct lockdep_map lockdep_map; 25914d82a1deSPeter Zijlstra 25924d82a1deSPeter Zijlstra lockdep_copy_map(&lockdep_map, &work->lockdep_map); 25934e6045f1SJohannes Berg #endif 2594807407c0SLai Jiangshan /* ensure we're on the correct CPU */ 259585327af6SLai Jiangshan WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 2596ec22ca5eSTejun Heo raw_smp_processor_id() != pool->cpu); 259725511a47STejun Heo 25988930cabaSTejun Heo /* claim and dequeue */ 2599dc186ad7SThomas Gleixner debug_work_deactivate(work); 2600c9e7cf27STejun Heo hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work); 2601c34056a3STejun Heo worker->current_work = work; 2602a2c1c57bSTejun Heo worker->current_func = work->func; 2603112202d9STejun Heo worker->current_pwq = pwq; 2604616db877STejun Heo worker->current_at = worker->task->se.sum_exec_runtime; 2605c4560c2cSLai Jiangshan work_data = *work_data_bits(work); 2606d812796eSLai Jiangshan worker->current_color = get_work_color(work_data); 26077a22ad75STejun Heo 26088bf89593STejun Heo /* 26098bf89593STejun Heo * Record wq name for cmdline and debug reporting, may get 26108bf89593STejun Heo * overridden through set_worker_desc(). 26118bf89593STejun Heo */ 26128bf89593STejun Heo strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN); 26138bf89593STejun Heo 2614a62428c0STejun Heo list_del_init(&work->entry); 2615a62428c0STejun Heo 2616649027d7STejun Heo /* 2617228f1d00SLai Jiangshan * CPU intensive works don't participate in concurrency management. 2618228f1d00SLai Jiangshan * They're the scheduler's responsibility. This takes @worker out 2619228f1d00SLai Jiangshan * of concurrency management and the next code block will chain 2620228f1d00SLai Jiangshan * execution of the pending work items. 2621fb0e7bebSTejun Heo */ 2622616db877STejun Heo if (unlikely(pwq->wq->flags & WQ_CPU_INTENSIVE)) 2623228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_CPU_INTENSIVE); 2624fb0e7bebSTejun Heo 2625974271c4STejun Heo /* 26260219a352STejun Heo * Kick @pool if necessary. It's always noop for per-cpu worker pools 26270219a352STejun Heo * since nr_running would always be >= 1 at this point. This is used to 26280219a352STejun Heo * chain execution of the pending work items for WORKER_NOT_RUNNING 26290219a352STejun Heo * workers such as the UNBOUND and CPU_INTENSIVE ones. 2630974271c4STejun Heo */ 26310219a352STejun Heo kick_pool(pool); 2632974271c4STejun Heo 26338930cabaSTejun Heo /* 26347c3eed5cSTejun Heo * Record the last pool and clear PENDING which should be the last 2635d565ed63STejun Heo * update to @work. Also, do this inside @pool->lock so that 263623657bb1STejun Heo * PENDING and queued state changes happen together while IRQ is 263723657bb1STejun Heo * disabled. 26388930cabaSTejun Heo */ 26397c3eed5cSTejun Heo set_work_pool_and_clear_pending(work, pool->id); 26401da177e4SLinus Torvalds 2641fe48ba7dSMirsad Goran Todorovac pwq->stats[PWQ_STAT_STARTED]++; 2642a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2643365970a1SDavid Howells 2644a1d14934SPeter Zijlstra lock_map_acquire(&pwq->wq->lockdep_map); 26453295f0efSIngo Molnar lock_map_acquire(&lockdep_map); 2646e6f3faa7SPeter Zijlstra /* 2647f52be570SPeter Zijlstra * Strictly speaking we should mark the invariant state without holding 2648f52be570SPeter Zijlstra * any locks, that is, before these two lock_map_acquire()'s. 2649e6f3faa7SPeter Zijlstra * 2650e6f3faa7SPeter Zijlstra * However, that would result in: 2651e6f3faa7SPeter Zijlstra * 2652e6f3faa7SPeter Zijlstra * A(W1) 2653e6f3faa7SPeter Zijlstra * WFC(C) 2654e6f3faa7SPeter Zijlstra * A(W1) 2655e6f3faa7SPeter Zijlstra * C(C) 2656e6f3faa7SPeter Zijlstra * 2657e6f3faa7SPeter Zijlstra * Which would create W1->C->W1 dependencies, even though there is no 2658e6f3faa7SPeter Zijlstra * actual deadlock possible. There are two solutions, using a 2659e6f3faa7SPeter Zijlstra * read-recursive acquire on the work(queue) 'locks', but this will then 2660f52be570SPeter Zijlstra * hit the lockdep limitation on recursive locks, or simply discard 2661e6f3faa7SPeter Zijlstra * these locks. 2662e6f3faa7SPeter Zijlstra * 2663e6f3faa7SPeter Zijlstra * AFAICT there is no possible deadlock scenario between the 2664e6f3faa7SPeter Zijlstra * flush_work() and complete() primitives (except for single-threaded 2665e6f3faa7SPeter Zijlstra * workqueues), so hiding them isn't a problem. 2666e6f3faa7SPeter Zijlstra */ 2667f52be570SPeter Zijlstra lockdep_invariant_state(true); 2668e36c886aSArjan van de Ven trace_workqueue_execute_start(work); 2669a2c1c57bSTejun Heo worker->current_func(work); 2670e36c886aSArjan van de Ven /* 2671e36c886aSArjan van de Ven * While we must be careful to not use "work" after this, the trace 2672e36c886aSArjan van de Ven * point will only record its address. 2673e36c886aSArjan van de Ven */ 26741c5da0ecSDaniel Jordan trace_workqueue_execute_end(work, worker->current_func); 2675725e8ec5STejun Heo pwq->stats[PWQ_STAT_COMPLETED]++; 26763295f0efSIngo Molnar lock_map_release(&lockdep_map); 2677112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 26781da177e4SLinus Torvalds 26791a65a6d1SXuewen Yan if (unlikely(in_atomic() || lockdep_depth(current) > 0 || 26801a65a6d1SXuewen Yan rcu_preempt_depth() > 0)) { 26811a65a6d1SXuewen Yan pr_err("BUG: workqueue leaked lock or atomic: %s/0x%08x/%d/%d\n" 2682d75f773cSSakari Ailus " last function: %ps\n", 26831a65a6d1SXuewen Yan current->comm, preempt_count(), rcu_preempt_depth(), 26841a65a6d1SXuewen Yan task_pid_nr(current), worker->current_func); 2685d5abe669SPeter Zijlstra debug_show_held_locks(current); 2686d5abe669SPeter Zijlstra dump_stack(); 2687d5abe669SPeter Zijlstra } 2688d5abe669SPeter Zijlstra 2689b22ce278STejun Heo /* 2690025f50f3SSebastian Andrzej Siewior * The following prevents a kworker from hogging CPU on !PREEMPTION 2691b22ce278STejun Heo * kernels, where a requeueing work item waiting for something to 2692b22ce278STejun Heo * happen could deadlock with stop_machine as such work item could 2693b22ce278STejun Heo * indefinitely requeue itself while all other CPUs are trapped in 2694789cbbecSJoe Lawrence * stop_machine. At the same time, report a quiescent RCU state so 2695789cbbecSJoe Lawrence * the same condition doesn't freeze RCU. 2696b22ce278STejun Heo */ 2697a7e6425eSPaul E. McKenney cond_resched(); 2698b22ce278STejun Heo 2699a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2700a62428c0STejun Heo 2701616db877STejun Heo /* 2702616db877STejun Heo * In addition to %WQ_CPU_INTENSIVE, @worker may also have been marked 2703616db877STejun Heo * CPU intensive by wq_worker_tick() if @work hogged CPU longer than 2704616db877STejun Heo * wq_cpu_intensive_thresh_us. Clear it. 2705616db877STejun Heo */ 2706fb0e7bebSTejun Heo worker_clr_flags(worker, WORKER_CPU_INTENSIVE); 2707fb0e7bebSTejun Heo 27081b69ac6bSJohannes Weiner /* tag the worker for identification in schedule() */ 27091b69ac6bSJohannes Weiner worker->last_func = worker->current_func; 27101b69ac6bSJohannes Weiner 2711a62428c0STejun Heo /* we're done with it, release */ 271242f8570fSSasha Levin hash_del(&worker->hentry); 2713c34056a3STejun Heo worker->current_work = NULL; 2714a2c1c57bSTejun Heo worker->current_func = NULL; 2715112202d9STejun Heo worker->current_pwq = NULL; 2716d812796eSLai Jiangshan worker->current_color = INT_MAX; 2717c4560c2cSLai Jiangshan pwq_dec_nr_in_flight(pwq, work_data); 27181da177e4SLinus Torvalds } 27191da177e4SLinus Torvalds 2720affee4b2STejun Heo /** 2721affee4b2STejun Heo * process_scheduled_works - process scheduled works 2722affee4b2STejun Heo * @worker: self 2723affee4b2STejun Heo * 2724affee4b2STejun Heo * Process all scheduled works. Please note that the scheduled list 2725affee4b2STejun Heo * may change while processing a work, so this function repeatedly 2726affee4b2STejun Heo * fetches a work from the top and executes it. 2727affee4b2STejun Heo * 2728affee4b2STejun Heo * CONTEXT: 2729a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 2730affee4b2STejun Heo * multiple times. 2731affee4b2STejun Heo */ 2732affee4b2STejun Heo static void process_scheduled_works(struct worker *worker) 27331da177e4SLinus Torvalds { 2734c0ab017dSTejun Heo struct work_struct *work; 2735c0ab017dSTejun Heo bool first = true; 2736c0ab017dSTejun Heo 2737c0ab017dSTejun Heo while ((work = list_first_entry_or_null(&worker->scheduled, 2738c0ab017dSTejun Heo struct work_struct, entry))) { 2739c0ab017dSTejun Heo if (first) { 2740c0ab017dSTejun Heo worker->pool->watchdog_ts = jiffies; 2741c0ab017dSTejun Heo first = false; 2742c0ab017dSTejun Heo } 2743c34056a3STejun Heo process_one_work(worker, work); 2744a62428c0STejun Heo } 27451da177e4SLinus Torvalds } 27461da177e4SLinus Torvalds 2747197f6accSTejun Heo static void set_pf_worker(bool val) 2748197f6accSTejun Heo { 2749197f6accSTejun Heo mutex_lock(&wq_pool_attach_mutex); 2750197f6accSTejun Heo if (val) 2751197f6accSTejun Heo current->flags |= PF_WQ_WORKER; 2752197f6accSTejun Heo else 2753197f6accSTejun Heo current->flags &= ~PF_WQ_WORKER; 2754197f6accSTejun Heo mutex_unlock(&wq_pool_attach_mutex); 2755197f6accSTejun Heo } 2756197f6accSTejun Heo 27574690c4abSTejun Heo /** 27584690c4abSTejun Heo * worker_thread - the worker thread function 2759c34056a3STejun Heo * @__worker: self 27604690c4abSTejun Heo * 2761c5aa87bbSTejun Heo * The worker thread function. All workers belong to a worker_pool - 2762c5aa87bbSTejun Heo * either a per-cpu one or dynamic unbound one. These workers process all 2763c5aa87bbSTejun Heo * work items regardless of their specific target workqueue. The only 2764c5aa87bbSTejun Heo * exception is work items which belong to workqueues with a rescuer which 2765c5aa87bbSTejun Heo * will be explained in rescuer_thread(). 2766d185af30SYacine Belkadi * 2767d185af30SYacine Belkadi * Return: 0 27684690c4abSTejun Heo */ 2769c34056a3STejun Heo static int worker_thread(void *__worker) 27701da177e4SLinus Torvalds { 2771c34056a3STejun Heo struct worker *worker = __worker; 2772bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 27731da177e4SLinus Torvalds 2774e22bee78STejun Heo /* tell the scheduler that this is a workqueue worker */ 2775197f6accSTejun Heo set_pf_worker(true); 2776c8e55f36STejun Heo woke_up: 2777a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2778affee4b2STejun Heo 2779a9ab775bSTejun Heo /* am I supposed to die? */ 2780a9ab775bSTejun Heo if (unlikely(worker->flags & WORKER_DIE)) { 2781a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2782197f6accSTejun Heo set_pf_worker(false); 278360f5a4bcSLai Jiangshan 278460f5a4bcSLai Jiangshan set_task_comm(worker->task, "kworker/dying"); 2785e441b56fSZhen Lei ida_free(&pool->worker_ida, worker->id); 2786a2d812a2STejun Heo worker_detach_from_pool(worker); 2787e02b9312SValentin Schneider WARN_ON_ONCE(!list_empty(&worker->entry)); 278860f5a4bcSLai Jiangshan kfree(worker); 2789c8e55f36STejun Heo return 0; 2790c8e55f36STejun Heo } 2791c8e55f36STejun Heo 2792c8e55f36STejun Heo worker_leave_idle(worker); 2793db7bccf4STejun Heo recheck: 2794e22bee78STejun Heo /* no more worker necessary? */ 279563d95a91STejun Heo if (!need_more_worker(pool)) 2796e22bee78STejun Heo goto sleep; 2797e22bee78STejun Heo 2798e22bee78STejun Heo /* do we need to manage? */ 279963d95a91STejun Heo if (unlikely(!may_start_working(pool)) && manage_workers(worker)) 2800e22bee78STejun Heo goto recheck; 2801e22bee78STejun Heo 2802c8e55f36STejun Heo /* 2803c8e55f36STejun Heo * ->scheduled list can only be filled while a worker is 2804c8e55f36STejun Heo * preparing to process a work or actually processing it. 2805c8e55f36STejun Heo * Make sure nobody diddled with it while I was sleeping. 2806c8e55f36STejun Heo */ 28076183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->scheduled)); 2808c8e55f36STejun Heo 2809e22bee78STejun Heo /* 2810a9ab775bSTejun Heo * Finish PREP stage. We're guaranteed to have at least one idle 2811a9ab775bSTejun Heo * worker or that someone else has already assumed the manager 2812a9ab775bSTejun Heo * role. This is where @worker starts participating in concurrency 2813a9ab775bSTejun Heo * management if applicable and concurrency management is restored 2814a9ab775bSTejun Heo * after being rebound. See rebind_workers() for details. 2815e22bee78STejun Heo */ 2816a9ab775bSTejun Heo worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND); 2817e22bee78STejun Heo 2818e22bee78STejun Heo do { 2819affee4b2STejun Heo struct work_struct *work = 2820bd7bdd43STejun Heo list_first_entry(&pool->worklist, 2821affee4b2STejun Heo struct work_struct, entry); 2822affee4b2STejun Heo 2823873eaca6STejun Heo if (assign_work(work, worker, NULL)) 2824affee4b2STejun Heo process_scheduled_works(worker); 282563d95a91STejun Heo } while (keep_working(pool)); 2826affee4b2STejun Heo 2827228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_PREP); 2828d313dd85STejun Heo sleep: 2829c8e55f36STejun Heo /* 2830d565ed63STejun Heo * pool->lock is held and there's no work to process and no need to 2831d565ed63STejun Heo * manage, sleep. Workers are woken up only while holding 2832d565ed63STejun Heo * pool->lock or from local cpu, so setting the current state 2833d565ed63STejun Heo * before releasing pool->lock is enough to prevent losing any 2834d565ed63STejun Heo * event. 2835c8e55f36STejun Heo */ 2836c8e55f36STejun Heo worker_enter_idle(worker); 2837c5a94a61SPeter Zijlstra __set_current_state(TASK_IDLE); 2838a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 28391da177e4SLinus Torvalds schedule(); 2840c8e55f36STejun Heo goto woke_up; 28411da177e4SLinus Torvalds } 28421da177e4SLinus Torvalds 2843e22bee78STejun Heo /** 2844e22bee78STejun Heo * rescuer_thread - the rescuer thread function 2845111c225aSTejun Heo * @__rescuer: self 2846e22bee78STejun Heo * 2847e22bee78STejun Heo * Workqueue rescuer thread function. There's one rescuer for each 2848493008a8STejun Heo * workqueue which has WQ_MEM_RECLAIM set. 2849e22bee78STejun Heo * 2850706026c2STejun Heo * Regular work processing on a pool may block trying to create a new 2851e22bee78STejun Heo * worker which uses GFP_KERNEL allocation which has slight chance of 2852e22bee78STejun Heo * developing into deadlock if some works currently on the same queue 2853e22bee78STejun Heo * need to be processed to satisfy the GFP_KERNEL allocation. This is 2854e22bee78STejun Heo * the problem rescuer solves. 2855e22bee78STejun Heo * 2856706026c2STejun Heo * When such condition is possible, the pool summons rescuers of all 2857706026c2STejun Heo * workqueues which have works queued on the pool and let them process 2858e22bee78STejun Heo * those works so that forward progress can be guaranteed. 2859e22bee78STejun Heo * 2860e22bee78STejun Heo * This should happen rarely. 2861d185af30SYacine Belkadi * 2862d185af30SYacine Belkadi * Return: 0 2863e22bee78STejun Heo */ 2864111c225aSTejun Heo static int rescuer_thread(void *__rescuer) 2865e22bee78STejun Heo { 2866111c225aSTejun Heo struct worker *rescuer = __rescuer; 2867111c225aSTejun Heo struct workqueue_struct *wq = rescuer->rescue_wq; 28684d595b86SLai Jiangshan bool should_stop; 2869e22bee78STejun Heo 2870e22bee78STejun Heo set_user_nice(current, RESCUER_NICE_LEVEL); 2871111c225aSTejun Heo 2872111c225aSTejun Heo /* 2873111c225aSTejun Heo * Mark rescuer as worker too. As WORKER_PREP is never cleared, it 2874111c225aSTejun Heo * doesn't participate in concurrency management. 2875111c225aSTejun Heo */ 2876197f6accSTejun Heo set_pf_worker(true); 2877e22bee78STejun Heo repeat: 2878c5a94a61SPeter Zijlstra set_current_state(TASK_IDLE); 28791da177e4SLinus Torvalds 28804d595b86SLai Jiangshan /* 28814d595b86SLai Jiangshan * By the time the rescuer is requested to stop, the workqueue 28824d595b86SLai Jiangshan * shouldn't have any work pending, but @wq->maydays may still have 28834d595b86SLai Jiangshan * pwq(s) queued. This can happen by non-rescuer workers consuming 28844d595b86SLai Jiangshan * all the work items before the rescuer got to them. Go through 28854d595b86SLai Jiangshan * @wq->maydays processing before acting on should_stop so that the 28864d595b86SLai Jiangshan * list is always empty on exit. 28874d595b86SLai Jiangshan */ 28884d595b86SLai Jiangshan should_stop = kthread_should_stop(); 28891da177e4SLinus Torvalds 2890493a1724STejun Heo /* see whether any pwq is asking for help */ 2891a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 2892493a1724STejun Heo 2893493a1724STejun Heo while (!list_empty(&wq->maydays)) { 2894493a1724STejun Heo struct pool_workqueue *pwq = list_first_entry(&wq->maydays, 2895493a1724STejun Heo struct pool_workqueue, mayday_node); 2896112202d9STejun Heo struct worker_pool *pool = pwq->pool; 2897e22bee78STejun Heo struct work_struct *work, *n; 2898e22bee78STejun Heo 2899e22bee78STejun Heo __set_current_state(TASK_RUNNING); 2900493a1724STejun Heo list_del_init(&pwq->mayday_node); 2901493a1724STejun Heo 2902a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 2903e22bee78STejun Heo 290451697d39SLai Jiangshan worker_attach_to_pool(rescuer, pool); 290551697d39SLai Jiangshan 2906a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2907e22bee78STejun Heo 2908e22bee78STejun Heo /* 2909e22bee78STejun Heo * Slurp in all works issued via this workqueue and 2910e22bee78STejun Heo * process'em. 2911e22bee78STejun Heo */ 2912873eaca6STejun Heo WARN_ON_ONCE(!list_empty(&rescuer->scheduled)); 291382607adcSTejun Heo list_for_each_entry_safe(work, n, &pool->worklist, entry) { 2914873eaca6STejun Heo if (get_work_pwq(work) == pwq && 2915873eaca6STejun Heo assign_work(work, rescuer, &n)) 2916725e8ec5STejun Heo pwq->stats[PWQ_STAT_RESCUED]++; 291782607adcSTejun Heo } 2918e22bee78STejun Heo 2919873eaca6STejun Heo if (!list_empty(&rescuer->scheduled)) { 2920e22bee78STejun Heo process_scheduled_works(rescuer); 29217576958aSTejun Heo 29227576958aSTejun Heo /* 2923008847f6SNeilBrown * The above execution of rescued work items could 2924008847f6SNeilBrown * have created more to rescue through 2925f97a4a1aSLai Jiangshan * pwq_activate_first_inactive() or chained 2926008847f6SNeilBrown * queueing. Let's put @pwq back on mayday list so 2927008847f6SNeilBrown * that such back-to-back work items, which may be 2928008847f6SNeilBrown * being used to relieve memory pressure, don't 2929008847f6SNeilBrown * incur MAYDAY_INTERVAL delay inbetween. 2930008847f6SNeilBrown */ 29314f3f4cf3SLai Jiangshan if (pwq->nr_active && need_to_create_worker(pool)) { 2932a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&wq_mayday_lock); 2933e66b39afSTejun Heo /* 2934e66b39afSTejun Heo * Queue iff we aren't racing destruction 2935e66b39afSTejun Heo * and somebody else hasn't queued it already. 2936e66b39afSTejun Heo */ 2937e66b39afSTejun Heo if (wq->rescuer && list_empty(&pwq->mayday_node)) { 2938008847f6SNeilBrown get_pwq(pwq); 2939e66b39afSTejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 2940e66b39afSTejun Heo } 2941a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&wq_mayday_lock); 2942008847f6SNeilBrown } 2943008847f6SNeilBrown } 2944008847f6SNeilBrown 2945008847f6SNeilBrown /* 294677668c8bSLai Jiangshan * Put the reference grabbed by send_mayday(). @pool won't 294713b1d625SLai Jiangshan * go away while we're still attached to it. 294877668c8bSLai Jiangshan */ 294977668c8bSLai Jiangshan put_pwq(pwq); 295077668c8bSLai Jiangshan 295177668c8bSLai Jiangshan /* 29520219a352STejun Heo * Leave this pool. Notify regular workers; otherwise, we end up 29530219a352STejun Heo * with 0 concurrency and stalling the execution. 29547576958aSTejun Heo */ 29550219a352STejun Heo kick_pool(pool); 29567576958aSTejun Heo 2957a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 295813b1d625SLai Jiangshan 2959a2d812a2STejun Heo worker_detach_from_pool(rescuer); 296013b1d625SLai Jiangshan 2961a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 29621da177e4SLinus Torvalds } 29631da177e4SLinus Torvalds 2964a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 2965493a1724STejun Heo 29664d595b86SLai Jiangshan if (should_stop) { 29674d595b86SLai Jiangshan __set_current_state(TASK_RUNNING); 2968197f6accSTejun Heo set_pf_worker(false); 29694d595b86SLai Jiangshan return 0; 29704d595b86SLai Jiangshan } 29714d595b86SLai Jiangshan 2972111c225aSTejun Heo /* rescuers should never participate in concurrency management */ 2973111c225aSTejun Heo WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING)); 2974e22bee78STejun Heo schedule(); 2975e22bee78STejun Heo goto repeat; 29761da177e4SLinus Torvalds } 29771da177e4SLinus Torvalds 2978fca839c0STejun Heo /** 2979fca839c0STejun Heo * check_flush_dependency - check for flush dependency sanity 2980fca839c0STejun Heo * @target_wq: workqueue being flushed 2981fca839c0STejun Heo * @target_work: work item being flushed (NULL for workqueue flushes) 2982fca839c0STejun Heo * 2983fca839c0STejun Heo * %current is trying to flush the whole @target_wq or @target_work on it. 2984fca839c0STejun Heo * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not 2985fca839c0STejun Heo * reclaiming memory or running on a workqueue which doesn't have 2986fca839c0STejun Heo * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to 2987fca839c0STejun Heo * a deadlock. 2988fca839c0STejun Heo */ 2989fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq, 2990fca839c0STejun Heo struct work_struct *target_work) 2991fca839c0STejun Heo { 2992fca839c0STejun Heo work_func_t target_func = target_work ? target_work->func : NULL; 2993fca839c0STejun Heo struct worker *worker; 2994fca839c0STejun Heo 2995fca839c0STejun Heo if (target_wq->flags & WQ_MEM_RECLAIM) 2996fca839c0STejun Heo return; 2997fca839c0STejun Heo 2998fca839c0STejun Heo worker = current_wq_worker(); 2999fca839c0STejun Heo 3000fca839c0STejun Heo WARN_ONCE(current->flags & PF_MEMALLOC, 3001d75f773cSSakari Ailus "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps", 3002fca839c0STejun Heo current->pid, current->comm, target_wq->name, target_func); 300323d11a58STejun Heo WARN_ONCE(worker && ((worker->current_pwq->wq->flags & 300423d11a58STejun Heo (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM), 3005d75f773cSSakari Ailus "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps", 3006fca839c0STejun Heo worker->current_pwq->wq->name, worker->current_func, 3007fca839c0STejun Heo target_wq->name, target_func); 3008fca839c0STejun Heo } 3009fca839c0STejun Heo 3010fc2e4d70SOleg Nesterov struct wq_barrier { 3011fc2e4d70SOleg Nesterov struct work_struct work; 3012fc2e4d70SOleg Nesterov struct completion done; 30132607d7a6STejun Heo struct task_struct *task; /* purely informational */ 3014fc2e4d70SOleg Nesterov }; 3015fc2e4d70SOleg Nesterov 3016fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work) 3017fc2e4d70SOleg Nesterov { 3018fc2e4d70SOleg Nesterov struct wq_barrier *barr = container_of(work, struct wq_barrier, work); 3019fc2e4d70SOleg Nesterov complete(&barr->done); 3020fc2e4d70SOleg Nesterov } 3021fc2e4d70SOleg Nesterov 30224690c4abSTejun Heo /** 30234690c4abSTejun Heo * insert_wq_barrier - insert a barrier work 3024112202d9STejun Heo * @pwq: pwq to insert barrier into 30254690c4abSTejun Heo * @barr: wq_barrier to insert 3026affee4b2STejun Heo * @target: target work to attach @barr to 3027affee4b2STejun Heo * @worker: worker currently executing @target, NULL if @target is not executing 30284690c4abSTejun Heo * 3029affee4b2STejun Heo * @barr is linked to @target such that @barr is completed only after 3030affee4b2STejun Heo * @target finishes execution. Please note that the ordering 3031affee4b2STejun Heo * guarantee is observed only with respect to @target and on the local 3032affee4b2STejun Heo * cpu. 3033affee4b2STejun Heo * 3034affee4b2STejun Heo * Currently, a queued barrier can't be canceled. This is because 3035affee4b2STejun Heo * try_to_grab_pending() can't determine whether the work to be 3036affee4b2STejun Heo * grabbed is at the head of the queue and thus can't clear LINKED 3037affee4b2STejun Heo * flag of the previous work while there must be a valid next work 3038affee4b2STejun Heo * after a work with LINKED flag set. 3039affee4b2STejun Heo * 3040affee4b2STejun Heo * Note that when @worker is non-NULL, @target may be modified 3041112202d9STejun Heo * underneath us, so we can't reliably determine pwq from @target. 30424690c4abSTejun Heo * 30434690c4abSTejun Heo * CONTEXT: 3044a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 30454690c4abSTejun Heo */ 3046112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq, 3047affee4b2STejun Heo struct wq_barrier *barr, 3048affee4b2STejun Heo struct work_struct *target, struct worker *worker) 3049fc2e4d70SOleg Nesterov { 3050d812796eSLai Jiangshan unsigned int work_flags = 0; 3051d812796eSLai Jiangshan unsigned int work_color; 3052affee4b2STejun Heo struct list_head *head; 3053affee4b2STejun Heo 3054dc186ad7SThomas Gleixner /* 3055d565ed63STejun Heo * debugobject calls are safe here even with pool->lock locked 3056dc186ad7SThomas Gleixner * as we know for sure that this will not trigger any of the 3057dc186ad7SThomas Gleixner * checks and call back into the fixup functions where we 3058dc186ad7SThomas Gleixner * might deadlock. 3059dc186ad7SThomas Gleixner */ 3060ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&barr->work, wq_barrier_func); 306122df02bbSTejun Heo __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); 306252fa5bc5SBoqun Feng 3063fd1a5b04SByungchul Park init_completion_map(&barr->done, &target->lockdep_map); 3064fd1a5b04SByungchul Park 30652607d7a6STejun Heo barr->task = current; 306683c22520SOleg Nesterov 3067018f3a13SLai Jiangshan /* The barrier work item does not participate in pwq->nr_active. */ 3068018f3a13SLai Jiangshan work_flags |= WORK_STRUCT_INACTIVE; 3069018f3a13SLai Jiangshan 3070affee4b2STejun Heo /* 3071affee4b2STejun Heo * If @target is currently being executed, schedule the 3072affee4b2STejun Heo * barrier to the worker; otherwise, put it after @target. 3073affee4b2STejun Heo */ 3074d812796eSLai Jiangshan if (worker) { 3075affee4b2STejun Heo head = worker->scheduled.next; 3076d812796eSLai Jiangshan work_color = worker->current_color; 3077d812796eSLai Jiangshan } else { 3078affee4b2STejun Heo unsigned long *bits = work_data_bits(target); 3079affee4b2STejun Heo 3080affee4b2STejun Heo head = target->entry.next; 3081affee4b2STejun Heo /* there can already be other linked works, inherit and set */ 3082d21cece0SLai Jiangshan work_flags |= *bits & WORK_STRUCT_LINKED; 3083d812796eSLai Jiangshan work_color = get_work_color(*bits); 3084affee4b2STejun Heo __set_bit(WORK_STRUCT_LINKED_BIT, bits); 3085affee4b2STejun Heo } 3086affee4b2STejun Heo 3087d812796eSLai Jiangshan pwq->nr_in_flight[work_color]++; 3088d812796eSLai Jiangshan work_flags |= work_color_to_flags(work_color); 3089d812796eSLai Jiangshan 3090d21cece0SLai Jiangshan insert_work(pwq, &barr->work, head, work_flags); 3091fc2e4d70SOleg Nesterov } 3092fc2e4d70SOleg Nesterov 309373f53c4aSTejun Heo /** 3094112202d9STejun Heo * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing 309573f53c4aSTejun Heo * @wq: workqueue being flushed 309673f53c4aSTejun Heo * @flush_color: new flush color, < 0 for no-op 309773f53c4aSTejun Heo * @work_color: new work color, < 0 for no-op 309873f53c4aSTejun Heo * 3099112202d9STejun Heo * Prepare pwqs for workqueue flushing. 310073f53c4aSTejun Heo * 3101112202d9STejun Heo * If @flush_color is non-negative, flush_color on all pwqs should be 3102112202d9STejun Heo * -1. If no pwq has in-flight commands at the specified color, all 3103112202d9STejun Heo * pwq->flush_color's stay at -1 and %false is returned. If any pwq 3104112202d9STejun Heo * has in flight commands, its pwq->flush_color is set to 3105112202d9STejun Heo * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq 310673f53c4aSTejun Heo * wakeup logic is armed and %true is returned. 310773f53c4aSTejun Heo * 310873f53c4aSTejun Heo * The caller should have initialized @wq->first_flusher prior to 310973f53c4aSTejun Heo * calling this function with non-negative @flush_color. If 311073f53c4aSTejun Heo * @flush_color is negative, no flush color update is done and %false 311173f53c4aSTejun Heo * is returned. 311273f53c4aSTejun Heo * 3113112202d9STejun Heo * If @work_color is non-negative, all pwqs should have the same 311473f53c4aSTejun Heo * work_color which is previous to @work_color and all will be 311573f53c4aSTejun Heo * advanced to @work_color. 311673f53c4aSTejun Heo * 311773f53c4aSTejun Heo * CONTEXT: 31183c25a55dSLai Jiangshan * mutex_lock(wq->mutex). 311973f53c4aSTejun Heo * 3120d185af30SYacine Belkadi * Return: 312173f53c4aSTejun Heo * %true if @flush_color >= 0 and there's something to flush. %false 312273f53c4aSTejun Heo * otherwise. 312373f53c4aSTejun Heo */ 3124112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq, 312573f53c4aSTejun Heo int flush_color, int work_color) 31261da177e4SLinus Torvalds { 312773f53c4aSTejun Heo bool wait = false; 312849e3cf44STejun Heo struct pool_workqueue *pwq; 31291da177e4SLinus Torvalds 313073f53c4aSTejun Heo if (flush_color >= 0) { 31316183c009STejun Heo WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush)); 3132112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 1); 3133dc186ad7SThomas Gleixner } 313414441960SOleg Nesterov 313549e3cf44STejun Heo for_each_pwq(pwq, wq) { 3136112202d9STejun Heo struct worker_pool *pool = pwq->pool; 31371da177e4SLinus Torvalds 3138a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 313973f53c4aSTejun Heo 314073f53c4aSTejun Heo if (flush_color >= 0) { 31416183c009STejun Heo WARN_ON_ONCE(pwq->flush_color != -1); 314273f53c4aSTejun Heo 3143112202d9STejun Heo if (pwq->nr_in_flight[flush_color]) { 3144112202d9STejun Heo pwq->flush_color = flush_color; 3145112202d9STejun Heo atomic_inc(&wq->nr_pwqs_to_flush); 314673f53c4aSTejun Heo wait = true; 31471da177e4SLinus Torvalds } 314873f53c4aSTejun Heo } 314973f53c4aSTejun Heo 315073f53c4aSTejun Heo if (work_color >= 0) { 31516183c009STejun Heo WARN_ON_ONCE(work_color != work_next_color(pwq->work_color)); 3152112202d9STejun Heo pwq->work_color = work_color; 315373f53c4aSTejun Heo } 315473f53c4aSTejun Heo 3155a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 31561da177e4SLinus Torvalds } 31571da177e4SLinus Torvalds 3158112202d9STejun Heo if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush)) 315973f53c4aSTejun Heo complete(&wq->first_flusher->done); 316073f53c4aSTejun Heo 316173f53c4aSTejun Heo return wait; 316283c22520SOleg Nesterov } 31631da177e4SLinus Torvalds 31640fcb78c2SRolf Eike Beer /** 3165c4f135d6STetsuo Handa * __flush_workqueue - ensure that any scheduled work has run to completion. 31660fcb78c2SRolf Eike Beer * @wq: workqueue to flush 31671da177e4SLinus Torvalds * 3168c5aa87bbSTejun Heo * This function sleeps until all work items which were queued on entry 3169c5aa87bbSTejun Heo * have finished execution, but it is not livelocked by new incoming ones. 31701da177e4SLinus Torvalds */ 3171c4f135d6STetsuo Handa void __flush_workqueue(struct workqueue_struct *wq) 31721da177e4SLinus Torvalds { 317373f53c4aSTejun Heo struct wq_flusher this_flusher = { 317473f53c4aSTejun Heo .list = LIST_HEAD_INIT(this_flusher.list), 317573f53c4aSTejun Heo .flush_color = -1, 3176fd1a5b04SByungchul Park .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map), 317773f53c4aSTejun Heo }; 317873f53c4aSTejun Heo int next_color; 3179b1f4ec17SOleg Nesterov 31803347fa09STejun Heo if (WARN_ON(!wq_online)) 31813347fa09STejun Heo return; 31823347fa09STejun Heo 318387915adcSJohannes Berg lock_map_acquire(&wq->lockdep_map); 318487915adcSJohannes Berg lock_map_release(&wq->lockdep_map); 318587915adcSJohannes Berg 31863c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 318773f53c4aSTejun Heo 318873f53c4aSTejun Heo /* 318973f53c4aSTejun Heo * Start-to-wait phase 319073f53c4aSTejun Heo */ 319173f53c4aSTejun Heo next_color = work_next_color(wq->work_color); 319273f53c4aSTejun Heo 319373f53c4aSTejun Heo if (next_color != wq->flush_color) { 319473f53c4aSTejun Heo /* 319573f53c4aSTejun Heo * Color space is not full. The current work_color 319673f53c4aSTejun Heo * becomes our flush_color and work_color is advanced 319773f53c4aSTejun Heo * by one. 319873f53c4aSTejun Heo */ 31996183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow)); 320073f53c4aSTejun Heo this_flusher.flush_color = wq->work_color; 320173f53c4aSTejun Heo wq->work_color = next_color; 320273f53c4aSTejun Heo 320373f53c4aSTejun Heo if (!wq->first_flusher) { 320473f53c4aSTejun Heo /* no flush in progress, become the first flusher */ 32056183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 320673f53c4aSTejun Heo 320773f53c4aSTejun Heo wq->first_flusher = &this_flusher; 320873f53c4aSTejun Heo 3209112202d9STejun Heo if (!flush_workqueue_prep_pwqs(wq, wq->flush_color, 321073f53c4aSTejun Heo wq->work_color)) { 321173f53c4aSTejun Heo /* nothing to flush, done */ 321273f53c4aSTejun Heo wq->flush_color = next_color; 321373f53c4aSTejun Heo wq->first_flusher = NULL; 321473f53c4aSTejun Heo goto out_unlock; 321573f53c4aSTejun Heo } 321673f53c4aSTejun Heo } else { 321773f53c4aSTejun Heo /* wait in queue */ 32186183c009STejun Heo WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color); 321973f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_queue); 3220112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 322173f53c4aSTejun Heo } 322273f53c4aSTejun Heo } else { 322373f53c4aSTejun Heo /* 322473f53c4aSTejun Heo * Oops, color space is full, wait on overflow queue. 322573f53c4aSTejun Heo * The next flush completion will assign us 322673f53c4aSTejun Heo * flush_color and transfer to flusher_queue. 322773f53c4aSTejun Heo */ 322873f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_overflow); 322973f53c4aSTejun Heo } 323073f53c4aSTejun Heo 3231fca839c0STejun Heo check_flush_dependency(wq, NULL); 3232fca839c0STejun Heo 32333c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 323473f53c4aSTejun Heo 323573f53c4aSTejun Heo wait_for_completion(&this_flusher.done); 323673f53c4aSTejun Heo 323773f53c4aSTejun Heo /* 323873f53c4aSTejun Heo * Wake-up-and-cascade phase 323973f53c4aSTejun Heo * 324073f53c4aSTejun Heo * First flushers are responsible for cascading flushes and 324173f53c4aSTejun Heo * handling overflow. Non-first flushers can simply return. 324273f53c4aSTejun Heo */ 324300d5d15bSChris Wilson if (READ_ONCE(wq->first_flusher) != &this_flusher) 324473f53c4aSTejun Heo return; 324573f53c4aSTejun Heo 32463c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 324773f53c4aSTejun Heo 32484ce48b37STejun Heo /* we might have raced, check again with mutex held */ 32494ce48b37STejun Heo if (wq->first_flusher != &this_flusher) 32504ce48b37STejun Heo goto out_unlock; 32514ce48b37STejun Heo 325200d5d15bSChris Wilson WRITE_ONCE(wq->first_flusher, NULL); 325373f53c4aSTejun Heo 32546183c009STejun Heo WARN_ON_ONCE(!list_empty(&this_flusher.list)); 32556183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 325673f53c4aSTejun Heo 325773f53c4aSTejun Heo while (true) { 325873f53c4aSTejun Heo struct wq_flusher *next, *tmp; 325973f53c4aSTejun Heo 326073f53c4aSTejun Heo /* complete all the flushers sharing the current flush color */ 326173f53c4aSTejun Heo list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { 326273f53c4aSTejun Heo if (next->flush_color != wq->flush_color) 326373f53c4aSTejun Heo break; 326473f53c4aSTejun Heo list_del_init(&next->list); 326573f53c4aSTejun Heo complete(&next->done); 326673f53c4aSTejun Heo } 326773f53c4aSTejun Heo 32686183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) && 326973f53c4aSTejun Heo wq->flush_color != work_next_color(wq->work_color)); 327073f53c4aSTejun Heo 327173f53c4aSTejun Heo /* this flush_color is finished, advance by one */ 327273f53c4aSTejun Heo wq->flush_color = work_next_color(wq->flush_color); 327373f53c4aSTejun Heo 327473f53c4aSTejun Heo /* one color has been freed, handle overflow queue */ 327573f53c4aSTejun Heo if (!list_empty(&wq->flusher_overflow)) { 327673f53c4aSTejun Heo /* 327773f53c4aSTejun Heo * Assign the same color to all overflowed 327873f53c4aSTejun Heo * flushers, advance work_color and append to 327973f53c4aSTejun Heo * flusher_queue. This is the start-to-wait 328073f53c4aSTejun Heo * phase for these overflowed flushers. 328173f53c4aSTejun Heo */ 328273f53c4aSTejun Heo list_for_each_entry(tmp, &wq->flusher_overflow, list) 328373f53c4aSTejun Heo tmp->flush_color = wq->work_color; 328473f53c4aSTejun Heo 328573f53c4aSTejun Heo wq->work_color = work_next_color(wq->work_color); 328673f53c4aSTejun Heo 328773f53c4aSTejun Heo list_splice_tail_init(&wq->flusher_overflow, 328873f53c4aSTejun Heo &wq->flusher_queue); 3289112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 329073f53c4aSTejun Heo } 329173f53c4aSTejun Heo 329273f53c4aSTejun Heo if (list_empty(&wq->flusher_queue)) { 32936183c009STejun Heo WARN_ON_ONCE(wq->flush_color != wq->work_color); 329473f53c4aSTejun Heo break; 329573f53c4aSTejun Heo } 329673f53c4aSTejun Heo 329773f53c4aSTejun Heo /* 329873f53c4aSTejun Heo * Need to flush more colors. Make the next flusher 3299112202d9STejun Heo * the new first flusher and arm pwqs. 330073f53c4aSTejun Heo */ 33016183c009STejun Heo WARN_ON_ONCE(wq->flush_color == wq->work_color); 33026183c009STejun Heo WARN_ON_ONCE(wq->flush_color != next->flush_color); 330373f53c4aSTejun Heo 330473f53c4aSTejun Heo list_del_init(&next->list); 330573f53c4aSTejun Heo wq->first_flusher = next; 330673f53c4aSTejun Heo 3307112202d9STejun Heo if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1)) 330873f53c4aSTejun Heo break; 330973f53c4aSTejun Heo 331073f53c4aSTejun Heo /* 331173f53c4aSTejun Heo * Meh... this color is already done, clear first 331273f53c4aSTejun Heo * flusher and repeat cascading. 331373f53c4aSTejun Heo */ 331473f53c4aSTejun Heo wq->first_flusher = NULL; 331573f53c4aSTejun Heo } 331673f53c4aSTejun Heo 331773f53c4aSTejun Heo out_unlock: 33183c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 33191da177e4SLinus Torvalds } 3320c4f135d6STetsuo Handa EXPORT_SYMBOL(__flush_workqueue); 33211da177e4SLinus Torvalds 33229c5a2ba7STejun Heo /** 33239c5a2ba7STejun Heo * drain_workqueue - drain a workqueue 33249c5a2ba7STejun Heo * @wq: workqueue to drain 33259c5a2ba7STejun Heo * 33269c5a2ba7STejun Heo * Wait until the workqueue becomes empty. While draining is in progress, 33279c5a2ba7STejun Heo * only chain queueing is allowed. IOW, only currently pending or running 33289c5a2ba7STejun Heo * work items on @wq can queue further work items on it. @wq is flushed 3329b749b1b6SChen Hanxiao * repeatedly until it becomes empty. The number of flushing is determined 33309c5a2ba7STejun Heo * by the depth of chaining and should be relatively short. Whine if it 33319c5a2ba7STejun Heo * takes too long. 33329c5a2ba7STejun Heo */ 33339c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq) 33349c5a2ba7STejun Heo { 33359c5a2ba7STejun Heo unsigned int flush_cnt = 0; 333649e3cf44STejun Heo struct pool_workqueue *pwq; 33379c5a2ba7STejun Heo 33389c5a2ba7STejun Heo /* 33399c5a2ba7STejun Heo * __queue_work() needs to test whether there are drainers, is much 33409c5a2ba7STejun Heo * hotter than drain_workqueue() and already looks at @wq->flags. 3341618b01ebSTejun Heo * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers. 33429c5a2ba7STejun Heo */ 334387fc741eSLai Jiangshan mutex_lock(&wq->mutex); 33449c5a2ba7STejun Heo if (!wq->nr_drainers++) 3345618b01ebSTejun Heo wq->flags |= __WQ_DRAINING; 334687fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 33479c5a2ba7STejun Heo reflush: 3348c4f135d6STetsuo Handa __flush_workqueue(wq); 33499c5a2ba7STejun Heo 3350b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 335176af4d93STejun Heo 335249e3cf44STejun Heo for_each_pwq(pwq, wq) { 3353fa2563e4SThomas Tuttle bool drained; 33549c5a2ba7STejun Heo 3355a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 3356afa87ce8STejun Heo drained = pwq_is_empty(pwq); 3357a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 3358fa2563e4SThomas Tuttle 3359fa2563e4SThomas Tuttle if (drained) 33609c5a2ba7STejun Heo continue; 33619c5a2ba7STejun Heo 33629c5a2ba7STejun Heo if (++flush_cnt == 10 || 33639c5a2ba7STejun Heo (flush_cnt % 100 == 0 && flush_cnt <= 1000)) 3364e9ad2eb3SStephen Zhang pr_warn("workqueue %s: %s() isn't complete after %u tries\n", 3365e9ad2eb3SStephen Zhang wq->name, __func__, flush_cnt); 336676af4d93STejun Heo 3367b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 33689c5a2ba7STejun Heo goto reflush; 33699c5a2ba7STejun Heo } 33709c5a2ba7STejun Heo 33719c5a2ba7STejun Heo if (!--wq->nr_drainers) 3372618b01ebSTejun Heo wq->flags &= ~__WQ_DRAINING; 337387fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 33749c5a2ba7STejun Heo } 33759c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue); 33769c5a2ba7STejun Heo 3377d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr, 3378d6e89786SJohannes Berg bool from_cancel) 3379baf59022STejun Heo { 3380baf59022STejun Heo struct worker *worker = NULL; 3381c9e7cf27STejun Heo struct worker_pool *pool; 3382112202d9STejun Heo struct pool_workqueue *pwq; 3383baf59022STejun Heo 3384baf59022STejun Heo might_sleep(); 3385baf59022STejun Heo 338624acfb71SThomas Gleixner rcu_read_lock(); 3387fa1b54e6STejun Heo pool = get_work_pool(work); 3388fa1b54e6STejun Heo if (!pool) { 338924acfb71SThomas Gleixner rcu_read_unlock(); 3390fa1b54e6STejun Heo return false; 3391fa1b54e6STejun Heo } 3392fa1b54e6STejun Heo 3393a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 33940b3dae68SLai Jiangshan /* see the comment in try_to_grab_pending() with the same code */ 3395112202d9STejun Heo pwq = get_work_pwq(work); 3396112202d9STejun Heo if (pwq) { 3397112202d9STejun Heo if (unlikely(pwq->pool != pool)) 3398baf59022STejun Heo goto already_gone; 3399606a5020STejun Heo } else { 3400c9e7cf27STejun Heo worker = find_worker_executing_work(pool, work); 3401baf59022STejun Heo if (!worker) 3402baf59022STejun Heo goto already_gone; 3403112202d9STejun Heo pwq = worker->current_pwq; 3404606a5020STejun Heo } 3405baf59022STejun Heo 3406fca839c0STejun Heo check_flush_dependency(pwq->wq, work); 3407fca839c0STejun Heo 3408112202d9STejun Heo insert_wq_barrier(pwq, barr, work, worker); 3409a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 3410baf59022STejun Heo 3411e159489bSTejun Heo /* 3412a1d14934SPeter Zijlstra * Force a lock recursion deadlock when using flush_work() inside a 3413a1d14934SPeter Zijlstra * single-threaded or rescuer equipped workqueue. 3414a1d14934SPeter Zijlstra * 3415a1d14934SPeter Zijlstra * For single threaded workqueues the deadlock happens when the work 3416a1d14934SPeter Zijlstra * is after the work issuing the flush_work(). For rescuer equipped 3417a1d14934SPeter Zijlstra * workqueues the deadlock happens when the rescuer stalls, blocking 3418a1d14934SPeter Zijlstra * forward progress. 3419e159489bSTejun Heo */ 3420d6e89786SJohannes Berg if (!from_cancel && 3421d6e89786SJohannes Berg (pwq->wq->saved_max_active == 1 || pwq->wq->rescuer)) { 3422112202d9STejun Heo lock_map_acquire(&pwq->wq->lockdep_map); 3423112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 3424a1d14934SPeter Zijlstra } 342524acfb71SThomas Gleixner rcu_read_unlock(); 3426baf59022STejun Heo return true; 3427baf59022STejun Heo already_gone: 3428a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 342924acfb71SThomas Gleixner rcu_read_unlock(); 3430baf59022STejun Heo return false; 3431baf59022STejun Heo } 3432baf59022STejun Heo 3433d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel) 3434d6e89786SJohannes Berg { 3435d6e89786SJohannes Berg struct wq_barrier barr; 3436d6e89786SJohannes Berg 3437d6e89786SJohannes Berg if (WARN_ON(!wq_online)) 3438d6e89786SJohannes Berg return false; 3439d6e89786SJohannes Berg 34404d43d395STetsuo Handa if (WARN_ON(!work->func)) 34414d43d395STetsuo Handa return false; 34424d43d395STetsuo Handa 344387915adcSJohannes Berg lock_map_acquire(&work->lockdep_map); 344487915adcSJohannes Berg lock_map_release(&work->lockdep_map); 344587915adcSJohannes Berg 3446d6e89786SJohannes Berg if (start_flush_work(work, &barr, from_cancel)) { 3447d6e89786SJohannes Berg wait_for_completion(&barr.done); 3448d6e89786SJohannes Berg destroy_work_on_stack(&barr.work); 3449d6e89786SJohannes Berg return true; 3450d6e89786SJohannes Berg } else { 3451d6e89786SJohannes Berg return false; 3452d6e89786SJohannes Berg } 3453d6e89786SJohannes Berg } 3454d6e89786SJohannes Berg 3455db700897SOleg Nesterov /** 3456401a8d04STejun Heo * flush_work - wait for a work to finish executing the last queueing instance 3457401a8d04STejun Heo * @work: the work to flush 3458db700897SOleg Nesterov * 3459606a5020STejun Heo * Wait until @work has finished execution. @work is guaranteed to be idle 3460606a5020STejun Heo * on return if it hasn't been requeued since flush started. 3461401a8d04STejun Heo * 3462d185af30SYacine Belkadi * Return: 3463401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 3464401a8d04STejun Heo * %false if it was already idle. 3465db700897SOleg Nesterov */ 3466401a8d04STejun Heo bool flush_work(struct work_struct *work) 3467db700897SOleg Nesterov { 3468d6e89786SJohannes Berg return __flush_work(work, false); 3469606a5020STejun Heo } 3470db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work); 3471db700897SOleg Nesterov 34728603e1b3STejun Heo struct cwt_wait { 3473ac6424b9SIngo Molnar wait_queue_entry_t wait; 34748603e1b3STejun Heo struct work_struct *work; 34758603e1b3STejun Heo }; 34768603e1b3STejun Heo 3477ac6424b9SIngo Molnar static int cwt_wakefn(wait_queue_entry_t *wait, unsigned mode, int sync, void *key) 34788603e1b3STejun Heo { 34798603e1b3STejun Heo struct cwt_wait *cwait = container_of(wait, struct cwt_wait, wait); 34808603e1b3STejun Heo 34818603e1b3STejun Heo if (cwait->work != key) 34828603e1b3STejun Heo return 0; 34838603e1b3STejun Heo return autoremove_wake_function(wait, mode, sync, key); 34848603e1b3STejun Heo } 34858603e1b3STejun Heo 348636e227d2STejun Heo static bool __cancel_work_timer(struct work_struct *work, bool is_dwork) 3487401a8d04STejun Heo { 34888603e1b3STejun Heo static DECLARE_WAIT_QUEUE_HEAD(cancel_waitq); 3489bbb68dfaSTejun Heo unsigned long flags; 34901f1f642eSOleg Nesterov int ret; 34911f1f642eSOleg Nesterov 34921f1f642eSOleg Nesterov do { 3493bbb68dfaSTejun Heo ret = try_to_grab_pending(work, is_dwork, &flags); 3494bbb68dfaSTejun Heo /* 34958603e1b3STejun Heo * If someone else is already canceling, wait for it to 34968603e1b3STejun Heo * finish. flush_work() doesn't work for PREEMPT_NONE 34978603e1b3STejun Heo * because we may get scheduled between @work's completion 34988603e1b3STejun Heo * and the other canceling task resuming and clearing 34998603e1b3STejun Heo * CANCELING - flush_work() will return false immediately 35008603e1b3STejun Heo * as @work is no longer busy, try_to_grab_pending() will 35018603e1b3STejun Heo * return -ENOENT as @work is still being canceled and the 35028603e1b3STejun Heo * other canceling task won't be able to clear CANCELING as 35038603e1b3STejun Heo * we're hogging the CPU. 35048603e1b3STejun Heo * 35058603e1b3STejun Heo * Let's wait for completion using a waitqueue. As this 35068603e1b3STejun Heo * may lead to the thundering herd problem, use a custom 35078603e1b3STejun Heo * wake function which matches @work along with exclusive 35088603e1b3STejun Heo * wait and wakeup. 3509bbb68dfaSTejun Heo */ 35108603e1b3STejun Heo if (unlikely(ret == -ENOENT)) { 35118603e1b3STejun Heo struct cwt_wait cwait; 35128603e1b3STejun Heo 35138603e1b3STejun Heo init_wait(&cwait.wait); 35148603e1b3STejun Heo cwait.wait.func = cwt_wakefn; 35158603e1b3STejun Heo cwait.work = work; 35168603e1b3STejun Heo 35178603e1b3STejun Heo prepare_to_wait_exclusive(&cancel_waitq, &cwait.wait, 35188603e1b3STejun Heo TASK_UNINTERRUPTIBLE); 35198603e1b3STejun Heo if (work_is_canceling(work)) 35208603e1b3STejun Heo schedule(); 35218603e1b3STejun Heo finish_wait(&cancel_waitq, &cwait.wait); 35228603e1b3STejun Heo } 35231f1f642eSOleg Nesterov } while (unlikely(ret < 0)); 35241f1f642eSOleg Nesterov 3525bbb68dfaSTejun Heo /* tell other tasks trying to grab @work to back off */ 3526bbb68dfaSTejun Heo mark_work_canceling(work); 3527bbb68dfaSTejun Heo local_irq_restore(flags); 3528bbb68dfaSTejun Heo 35293347fa09STejun Heo /* 35303347fa09STejun Heo * This allows canceling during early boot. We know that @work 35313347fa09STejun Heo * isn't executing. 35323347fa09STejun Heo */ 35333347fa09STejun Heo if (wq_online) 3534d6e89786SJohannes Berg __flush_work(work, true); 35353347fa09STejun Heo 35367a22ad75STejun Heo clear_work_data(work); 35378603e1b3STejun Heo 35388603e1b3STejun Heo /* 35398603e1b3STejun Heo * Paired with prepare_to_wait() above so that either 35408603e1b3STejun Heo * waitqueue_active() is visible here or !work_is_canceling() is 35418603e1b3STejun Heo * visible there. 35428603e1b3STejun Heo */ 35438603e1b3STejun Heo smp_mb(); 35448603e1b3STejun Heo if (waitqueue_active(&cancel_waitq)) 35458603e1b3STejun Heo __wake_up(&cancel_waitq, TASK_NORMAL, 1, work); 35468603e1b3STejun Heo 35471f1f642eSOleg Nesterov return ret; 35481f1f642eSOleg Nesterov } 35491f1f642eSOleg Nesterov 35506e84d644SOleg Nesterov /** 3551401a8d04STejun Heo * cancel_work_sync - cancel a work and wait for it to finish 3552401a8d04STejun Heo * @work: the work to cancel 35536e84d644SOleg Nesterov * 3554401a8d04STejun Heo * Cancel @work and wait for its execution to finish. This function 3555401a8d04STejun Heo * can be used even if the work re-queues itself or migrates to 3556401a8d04STejun Heo * another workqueue. On return from this function, @work is 3557401a8d04STejun Heo * guaranteed to be not pending or executing on any CPU. 35581f1f642eSOleg Nesterov * 3559401a8d04STejun Heo * cancel_work_sync(&delayed_work->work) must not be used for 3560401a8d04STejun Heo * delayed_work's. Use cancel_delayed_work_sync() instead. 35616e84d644SOleg Nesterov * 3562401a8d04STejun Heo * The caller must ensure that the workqueue on which @work was last 35636e84d644SOleg Nesterov * queued can't be destroyed before this function returns. 3564401a8d04STejun Heo * 3565d185af30SYacine Belkadi * Return: 3566401a8d04STejun Heo * %true if @work was pending, %false otherwise. 35676e84d644SOleg Nesterov */ 3568401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work) 35696e84d644SOleg Nesterov { 357036e227d2STejun Heo return __cancel_work_timer(work, false); 3571b89deed3SOleg Nesterov } 357228e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync); 3573b89deed3SOleg Nesterov 35746e84d644SOleg Nesterov /** 3575401a8d04STejun Heo * flush_delayed_work - wait for a dwork to finish executing the last queueing 3576401a8d04STejun Heo * @dwork: the delayed work to flush 35776e84d644SOleg Nesterov * 3578401a8d04STejun Heo * Delayed timer is cancelled and the pending work is queued for 3579401a8d04STejun Heo * immediate execution. Like flush_work(), this function only 3580401a8d04STejun Heo * considers the last queueing instance of @dwork. 35811f1f642eSOleg Nesterov * 3582d185af30SYacine Belkadi * Return: 3583401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 3584401a8d04STejun Heo * %false if it was already idle. 35856e84d644SOleg Nesterov */ 3586401a8d04STejun Heo bool flush_delayed_work(struct delayed_work *dwork) 3587401a8d04STejun Heo { 35888930cabaSTejun Heo local_irq_disable(); 3589401a8d04STejun Heo if (del_timer_sync(&dwork->timer)) 359060c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 35918930cabaSTejun Heo local_irq_enable(); 3592401a8d04STejun Heo return flush_work(&dwork->work); 3593401a8d04STejun Heo } 3594401a8d04STejun Heo EXPORT_SYMBOL(flush_delayed_work); 3595401a8d04STejun Heo 359605f0fe6bSTejun Heo /** 359705f0fe6bSTejun Heo * flush_rcu_work - wait for a rwork to finish executing the last queueing 359805f0fe6bSTejun Heo * @rwork: the rcu work to flush 359905f0fe6bSTejun Heo * 360005f0fe6bSTejun Heo * Return: 360105f0fe6bSTejun Heo * %true if flush_rcu_work() waited for the work to finish execution, 360205f0fe6bSTejun Heo * %false if it was already idle. 360305f0fe6bSTejun Heo */ 360405f0fe6bSTejun Heo bool flush_rcu_work(struct rcu_work *rwork) 360505f0fe6bSTejun Heo { 360605f0fe6bSTejun Heo if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) { 360705f0fe6bSTejun Heo rcu_barrier(); 360805f0fe6bSTejun Heo flush_work(&rwork->work); 360905f0fe6bSTejun Heo return true; 361005f0fe6bSTejun Heo } else { 361105f0fe6bSTejun Heo return flush_work(&rwork->work); 361205f0fe6bSTejun Heo } 361305f0fe6bSTejun Heo } 361405f0fe6bSTejun Heo EXPORT_SYMBOL(flush_rcu_work); 361505f0fe6bSTejun Heo 3616f72b8792SJens Axboe static bool __cancel_work(struct work_struct *work, bool is_dwork) 3617f72b8792SJens Axboe { 3618f72b8792SJens Axboe unsigned long flags; 3619f72b8792SJens Axboe int ret; 3620f72b8792SJens Axboe 3621f72b8792SJens Axboe do { 3622f72b8792SJens Axboe ret = try_to_grab_pending(work, is_dwork, &flags); 3623f72b8792SJens Axboe } while (unlikely(ret == -EAGAIN)); 3624f72b8792SJens Axboe 3625f72b8792SJens Axboe if (unlikely(ret < 0)) 3626f72b8792SJens Axboe return false; 3627f72b8792SJens Axboe 3628f72b8792SJens Axboe set_work_pool_and_clear_pending(work, get_work_pool_id(work)); 3629f72b8792SJens Axboe local_irq_restore(flags); 3630f72b8792SJens Axboe return ret; 3631f72b8792SJens Axboe } 3632f72b8792SJens Axboe 363373b4b532SAndrey Grodzovsky /* 363473b4b532SAndrey Grodzovsky * See cancel_delayed_work() 363573b4b532SAndrey Grodzovsky */ 363673b4b532SAndrey Grodzovsky bool cancel_work(struct work_struct *work) 363773b4b532SAndrey Grodzovsky { 363873b4b532SAndrey Grodzovsky return __cancel_work(work, false); 363973b4b532SAndrey Grodzovsky } 364073b4b532SAndrey Grodzovsky EXPORT_SYMBOL(cancel_work); 364173b4b532SAndrey Grodzovsky 3642401a8d04STejun Heo /** 364357b30ae7STejun Heo * cancel_delayed_work - cancel a delayed work 364457b30ae7STejun Heo * @dwork: delayed_work to cancel 364509383498STejun Heo * 3646d185af30SYacine Belkadi * Kill off a pending delayed_work. 3647d185af30SYacine Belkadi * 3648d185af30SYacine Belkadi * Return: %true if @dwork was pending and canceled; %false if it wasn't 3649d185af30SYacine Belkadi * pending. 3650d185af30SYacine Belkadi * 3651d185af30SYacine Belkadi * Note: 3652d185af30SYacine Belkadi * The work callback function may still be running on return, unless 3653d185af30SYacine Belkadi * it returns %true and the work doesn't re-arm itself. Explicitly flush or 3654d185af30SYacine Belkadi * use cancel_delayed_work_sync() to wait on it. 365509383498STejun Heo * 365657b30ae7STejun Heo * This function is safe to call from any context including IRQ handler. 365709383498STejun Heo */ 365857b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork) 365909383498STejun Heo { 3660f72b8792SJens Axboe return __cancel_work(&dwork->work, true); 366109383498STejun Heo } 366257b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work); 366309383498STejun Heo 366409383498STejun Heo /** 3665401a8d04STejun Heo * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish 3666401a8d04STejun Heo * @dwork: the delayed work cancel 3667401a8d04STejun Heo * 3668401a8d04STejun Heo * This is cancel_work_sync() for delayed works. 3669401a8d04STejun Heo * 3670d185af30SYacine Belkadi * Return: 3671401a8d04STejun Heo * %true if @dwork was pending, %false otherwise. 3672401a8d04STejun Heo */ 3673401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork) 36746e84d644SOleg Nesterov { 367536e227d2STejun Heo return __cancel_work_timer(&dwork->work, true); 36766e84d644SOleg Nesterov } 3677f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync); 36781da177e4SLinus Torvalds 36790fcb78c2SRolf Eike Beer /** 368031ddd871STejun Heo * schedule_on_each_cpu - execute a function synchronously on each online CPU 3681b6136773SAndrew Morton * @func: the function to call 3682b6136773SAndrew Morton * 368331ddd871STejun Heo * schedule_on_each_cpu() executes @func on each online CPU using the 368431ddd871STejun Heo * system workqueue and blocks until all CPUs have completed. 3685b6136773SAndrew Morton * schedule_on_each_cpu() is very slow. 368631ddd871STejun Heo * 3687d185af30SYacine Belkadi * Return: 368831ddd871STejun Heo * 0 on success, -errno on failure. 3689b6136773SAndrew Morton */ 369065f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func) 369115316ba8SChristoph Lameter { 369215316ba8SChristoph Lameter int cpu; 369338f51568SNamhyung Kim struct work_struct __percpu *works; 369415316ba8SChristoph Lameter 3695b6136773SAndrew Morton works = alloc_percpu(struct work_struct); 3696b6136773SAndrew Morton if (!works) 369715316ba8SChristoph Lameter return -ENOMEM; 3698b6136773SAndrew Morton 3699ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 370093981800STejun Heo 370115316ba8SChristoph Lameter for_each_online_cpu(cpu) { 37029bfb1839SIngo Molnar struct work_struct *work = per_cpu_ptr(works, cpu); 37039bfb1839SIngo Molnar 37049bfb1839SIngo Molnar INIT_WORK(work, func); 37058de6d308SOleg Nesterov schedule_work_on(cpu, work); 370615316ba8SChristoph Lameter } 370793981800STejun Heo 370893981800STejun Heo for_each_online_cpu(cpu) 37098616a89aSOleg Nesterov flush_work(per_cpu_ptr(works, cpu)); 371093981800STejun Heo 3711ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 3712b6136773SAndrew Morton free_percpu(works); 371315316ba8SChristoph Lameter return 0; 371415316ba8SChristoph Lameter } 371515316ba8SChristoph Lameter 3716eef6a7d5SAlan Stern /** 37171fa44ecaSJames Bottomley * execute_in_process_context - reliably execute the routine with user context 37181fa44ecaSJames Bottomley * @fn: the function to execute 37191fa44ecaSJames Bottomley * @ew: guaranteed storage for the execute work structure (must 37201fa44ecaSJames Bottomley * be available when the work executes) 37211fa44ecaSJames Bottomley * 37221fa44ecaSJames Bottomley * Executes the function immediately if process context is available, 37231fa44ecaSJames Bottomley * otherwise schedules the function for delayed execution. 37241fa44ecaSJames Bottomley * 3725d185af30SYacine Belkadi * Return: 0 - function was executed 37261fa44ecaSJames Bottomley * 1 - function was scheduled for execution 37271fa44ecaSJames Bottomley */ 372865f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew) 37291fa44ecaSJames Bottomley { 37301fa44ecaSJames Bottomley if (!in_interrupt()) { 373165f27f38SDavid Howells fn(&ew->work); 37321fa44ecaSJames Bottomley return 0; 37331fa44ecaSJames Bottomley } 37341fa44ecaSJames Bottomley 373565f27f38SDavid Howells INIT_WORK(&ew->work, fn); 37361fa44ecaSJames Bottomley schedule_work(&ew->work); 37371fa44ecaSJames Bottomley 37381fa44ecaSJames Bottomley return 1; 37391fa44ecaSJames Bottomley } 37401fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context); 37411fa44ecaSJames Bottomley 37427a4e344cSTejun Heo /** 37437a4e344cSTejun Heo * free_workqueue_attrs - free a workqueue_attrs 37447a4e344cSTejun Heo * @attrs: workqueue_attrs to free 37457a4e344cSTejun Heo * 37467a4e344cSTejun Heo * Undo alloc_workqueue_attrs(). 37477a4e344cSTejun Heo */ 3748513c98d0SDaniel Jordan void free_workqueue_attrs(struct workqueue_attrs *attrs) 37497a4e344cSTejun Heo { 37507a4e344cSTejun Heo if (attrs) { 37517a4e344cSTejun Heo free_cpumask_var(attrs->cpumask); 37529546b29eSTejun Heo free_cpumask_var(attrs->__pod_cpumask); 37537a4e344cSTejun Heo kfree(attrs); 37547a4e344cSTejun Heo } 37557a4e344cSTejun Heo } 37567a4e344cSTejun Heo 37577a4e344cSTejun Heo /** 37587a4e344cSTejun Heo * alloc_workqueue_attrs - allocate a workqueue_attrs 37597a4e344cSTejun Heo * 37607a4e344cSTejun Heo * Allocate a new workqueue_attrs, initialize with default settings and 3761d185af30SYacine Belkadi * return it. 3762d185af30SYacine Belkadi * 3763d185af30SYacine Belkadi * Return: The allocated new workqueue_attr on success. %NULL on failure. 37647a4e344cSTejun Heo */ 3765513c98d0SDaniel Jordan struct workqueue_attrs *alloc_workqueue_attrs(void) 37667a4e344cSTejun Heo { 37677a4e344cSTejun Heo struct workqueue_attrs *attrs; 37687a4e344cSTejun Heo 3769be69d00dSThomas Gleixner attrs = kzalloc(sizeof(*attrs), GFP_KERNEL); 37707a4e344cSTejun Heo if (!attrs) 37717a4e344cSTejun Heo goto fail; 3772be69d00dSThomas Gleixner if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL)) 37737a4e344cSTejun Heo goto fail; 37749546b29eSTejun Heo if (!alloc_cpumask_var(&attrs->__pod_cpumask, GFP_KERNEL)) 37759546b29eSTejun Heo goto fail; 37767a4e344cSTejun Heo 377713e2e556STejun Heo cpumask_copy(attrs->cpumask, cpu_possible_mask); 3778523a301eSTejun Heo attrs->affn_scope = WQ_AFFN_DFL; 37797a4e344cSTejun Heo return attrs; 37807a4e344cSTejun Heo fail: 37817a4e344cSTejun Heo free_workqueue_attrs(attrs); 37827a4e344cSTejun Heo return NULL; 37837a4e344cSTejun Heo } 37847a4e344cSTejun Heo 378529c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to, 378629c91e99STejun Heo const struct workqueue_attrs *from) 378729c91e99STejun Heo { 378829c91e99STejun Heo to->nice = from->nice; 378929c91e99STejun Heo cpumask_copy(to->cpumask, from->cpumask); 37909546b29eSTejun Heo cpumask_copy(to->__pod_cpumask, from->__pod_cpumask); 37918639ecebSTejun Heo to->affn_strict = from->affn_strict; 379284193c07STejun Heo 37932865a8fbSShaohua Li /* 379484193c07STejun Heo * Unlike hash and equality test, copying shouldn't ignore wq-only 379584193c07STejun Heo * fields as copying is used for both pool and wq attrs. Instead, 379684193c07STejun Heo * get_unbound_pool() explicitly clears the fields. 37972865a8fbSShaohua Li */ 379884193c07STejun Heo to->affn_scope = from->affn_scope; 3799af73f5c9STejun Heo to->ordered = from->ordered; 380029c91e99STejun Heo } 380129c91e99STejun Heo 38025de7a03cSTejun Heo /* 38035de7a03cSTejun Heo * Some attrs fields are workqueue-only. Clear them for worker_pool's. See the 38045de7a03cSTejun Heo * comments in 'struct workqueue_attrs' definition. 38055de7a03cSTejun Heo */ 38065de7a03cSTejun Heo static void wqattrs_clear_for_pool(struct workqueue_attrs *attrs) 38075de7a03cSTejun Heo { 380884193c07STejun Heo attrs->affn_scope = WQ_AFFN_NR_TYPES; 38095de7a03cSTejun Heo attrs->ordered = false; 38105de7a03cSTejun Heo } 38115de7a03cSTejun Heo 381229c91e99STejun Heo /* hash value of the content of @attr */ 381329c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs) 381429c91e99STejun Heo { 381529c91e99STejun Heo u32 hash = 0; 381629c91e99STejun Heo 381729c91e99STejun Heo hash = jhash_1word(attrs->nice, hash); 381813e2e556STejun Heo hash = jhash(cpumask_bits(attrs->cpumask), 381913e2e556STejun Heo BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); 38209546b29eSTejun Heo hash = jhash(cpumask_bits(attrs->__pod_cpumask), 38219546b29eSTejun Heo BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); 38228639ecebSTejun Heo hash = jhash_1word(attrs->affn_strict, hash); 382329c91e99STejun Heo return hash; 382429c91e99STejun Heo } 382529c91e99STejun Heo 382629c91e99STejun Heo /* content equality test */ 382729c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a, 382829c91e99STejun Heo const struct workqueue_attrs *b) 382929c91e99STejun Heo { 383029c91e99STejun Heo if (a->nice != b->nice) 383129c91e99STejun Heo return false; 383229c91e99STejun Heo if (!cpumask_equal(a->cpumask, b->cpumask)) 383329c91e99STejun Heo return false; 38349546b29eSTejun Heo if (!cpumask_equal(a->__pod_cpumask, b->__pod_cpumask)) 38359546b29eSTejun Heo return false; 38368639ecebSTejun Heo if (a->affn_strict != b->affn_strict) 38378639ecebSTejun Heo return false; 383829c91e99STejun Heo return true; 383929c91e99STejun Heo } 384029c91e99STejun Heo 38410f36ee24STejun Heo /* Update @attrs with actually available CPUs */ 38420f36ee24STejun Heo static void wqattrs_actualize_cpumask(struct workqueue_attrs *attrs, 38430f36ee24STejun Heo const cpumask_t *unbound_cpumask) 38440f36ee24STejun Heo { 38450f36ee24STejun Heo /* 38460f36ee24STejun Heo * Calculate the effective CPU mask of @attrs given @unbound_cpumask. If 38470f36ee24STejun Heo * @attrs->cpumask doesn't overlap with @unbound_cpumask, we fallback to 38480f36ee24STejun Heo * @unbound_cpumask. 38490f36ee24STejun Heo */ 38500f36ee24STejun Heo cpumask_and(attrs->cpumask, attrs->cpumask, unbound_cpumask); 38510f36ee24STejun Heo if (unlikely(cpumask_empty(attrs->cpumask))) 38520f36ee24STejun Heo cpumask_copy(attrs->cpumask, unbound_cpumask); 38530f36ee24STejun Heo } 38540f36ee24STejun Heo 385584193c07STejun Heo /* find wq_pod_type to use for @attrs */ 385684193c07STejun Heo static const struct wq_pod_type * 385784193c07STejun Heo wqattrs_pod_type(const struct workqueue_attrs *attrs) 385884193c07STejun Heo { 3859523a301eSTejun Heo enum wq_affn_scope scope; 3860523a301eSTejun Heo struct wq_pod_type *pt; 3861523a301eSTejun Heo 3862523a301eSTejun Heo /* to synchronize access to wq_affn_dfl */ 3863523a301eSTejun Heo lockdep_assert_held(&wq_pool_mutex); 3864523a301eSTejun Heo 3865523a301eSTejun Heo if (attrs->affn_scope == WQ_AFFN_DFL) 3866523a301eSTejun Heo scope = wq_affn_dfl; 3867523a301eSTejun Heo else 3868523a301eSTejun Heo scope = attrs->affn_scope; 3869523a301eSTejun Heo 3870523a301eSTejun Heo pt = &wq_pod_types[scope]; 387184193c07STejun Heo 387284193c07STejun Heo if (!WARN_ON_ONCE(attrs->affn_scope == WQ_AFFN_NR_TYPES) && 387384193c07STejun Heo likely(pt->nr_pods)) 387484193c07STejun Heo return pt; 387584193c07STejun Heo 387684193c07STejun Heo /* 387784193c07STejun Heo * Before workqueue_init_topology(), only SYSTEM is available which is 387884193c07STejun Heo * initialized in workqueue_init_early(). 387984193c07STejun Heo */ 388084193c07STejun Heo pt = &wq_pod_types[WQ_AFFN_SYSTEM]; 388184193c07STejun Heo BUG_ON(!pt->nr_pods); 388284193c07STejun Heo return pt; 388384193c07STejun Heo } 388484193c07STejun Heo 38857a4e344cSTejun Heo /** 38867a4e344cSTejun Heo * init_worker_pool - initialize a newly zalloc'd worker_pool 38877a4e344cSTejun Heo * @pool: worker_pool to initialize 38887a4e344cSTejun Heo * 3889402dd89dSShailendra Verma * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs. 3890d185af30SYacine Belkadi * 3891d185af30SYacine Belkadi * Return: 0 on success, -errno on failure. Even on failure, all fields 389229c91e99STejun Heo * inside @pool proper are initialized and put_unbound_pool() can be called 389329c91e99STejun Heo * on @pool safely to release it. 38947a4e344cSTejun Heo */ 38957a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool) 38964e1a1f9aSTejun Heo { 3897a9b8a985SSebastian Andrzej Siewior raw_spin_lock_init(&pool->lock); 389829c91e99STejun Heo pool->id = -1; 389929c91e99STejun Heo pool->cpu = -1; 3900f3f90ad4STejun Heo pool->node = NUMA_NO_NODE; 39014e1a1f9aSTejun Heo pool->flags |= POOL_DISASSOCIATED; 390282607adcSTejun Heo pool->watchdog_ts = jiffies; 39034e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->worklist); 39044e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->idle_list); 39054e1a1f9aSTejun Heo hash_init(pool->busy_hash); 39064e1a1f9aSTejun Heo 390732a6c723SKees Cook timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE); 39083f959aa3SValentin Schneider INIT_WORK(&pool->idle_cull_work, idle_cull_fn); 39094e1a1f9aSTejun Heo 391032a6c723SKees Cook timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0); 39114e1a1f9aSTejun Heo 3912da028469SLai Jiangshan INIT_LIST_HEAD(&pool->workers); 3913e02b9312SValentin Schneider INIT_LIST_HEAD(&pool->dying_workers); 39147a4e344cSTejun Heo 39157cda9aaeSLai Jiangshan ida_init(&pool->worker_ida); 391629c91e99STejun Heo INIT_HLIST_NODE(&pool->hash_node); 391729c91e99STejun Heo pool->refcnt = 1; 391829c91e99STejun Heo 391929c91e99STejun Heo /* shouldn't fail above this point */ 3920be69d00dSThomas Gleixner pool->attrs = alloc_workqueue_attrs(); 39217a4e344cSTejun Heo if (!pool->attrs) 39227a4e344cSTejun Heo return -ENOMEM; 39235de7a03cSTejun Heo 39245de7a03cSTejun Heo wqattrs_clear_for_pool(pool->attrs); 39255de7a03cSTejun Heo 39267a4e344cSTejun Heo return 0; 39274e1a1f9aSTejun Heo } 39284e1a1f9aSTejun Heo 3929669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP 3930669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq) 3931669de8bdSBart Van Assche { 3932669de8bdSBart Van Assche char *lock_name; 3933669de8bdSBart Van Assche 3934669de8bdSBart Van Assche lockdep_register_key(&wq->key); 3935669de8bdSBart Van Assche lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name); 3936669de8bdSBart Van Assche if (!lock_name) 3937669de8bdSBart Van Assche lock_name = wq->name; 393869a106c0SQian Cai 393969a106c0SQian Cai wq->lock_name = lock_name; 3940669de8bdSBart Van Assche lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0); 3941669de8bdSBart Van Assche } 3942669de8bdSBart Van Assche 3943669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq) 3944669de8bdSBart Van Assche { 3945669de8bdSBart Van Assche lockdep_unregister_key(&wq->key); 3946669de8bdSBart Van Assche } 3947669de8bdSBart Van Assche 3948669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq) 3949669de8bdSBart Van Assche { 3950669de8bdSBart Van Assche if (wq->lock_name != wq->name) 3951669de8bdSBart Van Assche kfree(wq->lock_name); 3952669de8bdSBart Van Assche } 3953669de8bdSBart Van Assche #else 3954669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq) 3955669de8bdSBart Van Assche { 3956669de8bdSBart Van Assche } 3957669de8bdSBart Van Assche 3958669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq) 3959669de8bdSBart Van Assche { 3960669de8bdSBart Van Assche } 3961669de8bdSBart Van Assche 3962669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq) 3963669de8bdSBart Van Assche { 3964669de8bdSBart Van Assche } 3965669de8bdSBart Van Assche #endif 3966669de8bdSBart Van Assche 3967e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu) 3968e2dca7adSTejun Heo { 3969e2dca7adSTejun Heo struct workqueue_struct *wq = 3970e2dca7adSTejun Heo container_of(rcu, struct workqueue_struct, rcu); 3971e2dca7adSTejun Heo 3972669de8bdSBart Van Assche wq_free_lockdep(wq); 3973ee1ceef7STejun Heo free_percpu(wq->cpu_pwq); 3974e2dca7adSTejun Heo free_workqueue_attrs(wq->unbound_attrs); 3975e2dca7adSTejun Heo kfree(wq); 3976e2dca7adSTejun Heo } 3977e2dca7adSTejun Heo 397829c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu) 397929c91e99STejun Heo { 398029c91e99STejun Heo struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu); 398129c91e99STejun Heo 39827cda9aaeSLai Jiangshan ida_destroy(&pool->worker_ida); 398329c91e99STejun Heo free_workqueue_attrs(pool->attrs); 398429c91e99STejun Heo kfree(pool); 398529c91e99STejun Heo } 398629c91e99STejun Heo 398729c91e99STejun Heo /** 398829c91e99STejun Heo * put_unbound_pool - put a worker_pool 398929c91e99STejun Heo * @pool: worker_pool to put 399029c91e99STejun Heo * 399124acfb71SThomas Gleixner * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU 3992c5aa87bbSTejun Heo * safe manner. get_unbound_pool() calls this function on its failure path 3993c5aa87bbSTejun Heo * and this function should be able to release pools which went through, 3994c5aa87bbSTejun Heo * successfully or not, init_worker_pool(). 3995a892caccSTejun Heo * 3996a892caccSTejun Heo * Should be called with wq_pool_mutex held. 399729c91e99STejun Heo */ 399829c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool) 399929c91e99STejun Heo { 400060f5a4bcSLai Jiangshan DECLARE_COMPLETION_ONSTACK(detach_completion); 400129c91e99STejun Heo struct worker *worker; 40029680540cSYang Yingliang LIST_HEAD(cull_list); 4003e02b9312SValentin Schneider 4004a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 4005a892caccSTejun Heo 4006a892caccSTejun Heo if (--pool->refcnt) 400729c91e99STejun Heo return; 400829c91e99STejun Heo 400929c91e99STejun Heo /* sanity checks */ 401061d0fbb4SLai Jiangshan if (WARN_ON(!(pool->cpu < 0)) || 4011a892caccSTejun Heo WARN_ON(!list_empty(&pool->worklist))) 401229c91e99STejun Heo return; 401329c91e99STejun Heo 401429c91e99STejun Heo /* release id and unhash */ 401529c91e99STejun Heo if (pool->id >= 0) 401629c91e99STejun Heo idr_remove(&worker_pool_idr, pool->id); 401729c91e99STejun Heo hash_del(&pool->hash_node); 401829c91e99STejun Heo 4019c5aa87bbSTejun Heo /* 4020692b4825STejun Heo * Become the manager and destroy all workers. This prevents 4021692b4825STejun Heo * @pool's workers from blocking on attach_mutex. We're the last 4022692b4825STejun Heo * manager and @pool gets freed with the flag set. 40239ab03be4SValentin Schneider * 40249ab03be4SValentin Schneider * Having a concurrent manager is quite unlikely to happen as we can 40259ab03be4SValentin Schneider * only get here with 40269ab03be4SValentin Schneider * pwq->refcnt == pool->refcnt == 0 40279ab03be4SValentin Schneider * which implies no work queued to the pool, which implies no worker can 40289ab03be4SValentin Schneider * become the manager. However a worker could have taken the role of 40299ab03be4SValentin Schneider * manager before the refcnts dropped to 0, since maybe_create_worker() 40309ab03be4SValentin Schneider * drops pool->lock 4031c5aa87bbSTejun Heo */ 40329ab03be4SValentin Schneider while (true) { 40339ab03be4SValentin Schneider rcuwait_wait_event(&manager_wait, 40349ab03be4SValentin Schneider !(pool->flags & POOL_MANAGER_ACTIVE), 4035d8bb65abSSebastian Andrzej Siewior TASK_UNINTERRUPTIBLE); 4036e02b9312SValentin Schneider 4037e02b9312SValentin Schneider mutex_lock(&wq_pool_attach_mutex); 40389ab03be4SValentin Schneider raw_spin_lock_irq(&pool->lock); 40399ab03be4SValentin Schneider if (!(pool->flags & POOL_MANAGER_ACTIVE)) { 4040692b4825STejun Heo pool->flags |= POOL_MANAGER_ACTIVE; 40419ab03be4SValentin Schneider break; 40429ab03be4SValentin Schneider } 40439ab03be4SValentin Schneider raw_spin_unlock_irq(&pool->lock); 4044e02b9312SValentin Schneider mutex_unlock(&wq_pool_attach_mutex); 40459ab03be4SValentin Schneider } 4046692b4825STejun Heo 40471037de36SLai Jiangshan while ((worker = first_idle_worker(pool))) 4048e02b9312SValentin Schneider set_worker_dying(worker, &cull_list); 404929c91e99STejun Heo WARN_ON(pool->nr_workers || pool->nr_idle); 4050a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 405160f5a4bcSLai Jiangshan 4052e02b9312SValentin Schneider wake_dying_workers(&cull_list); 4053e02b9312SValentin Schneider 4054e02b9312SValentin Schneider if (!list_empty(&pool->workers) || !list_empty(&pool->dying_workers)) 405560f5a4bcSLai Jiangshan pool->detach_completion = &detach_completion; 40561258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 405760f5a4bcSLai Jiangshan 405860f5a4bcSLai Jiangshan if (pool->detach_completion) 405960f5a4bcSLai Jiangshan wait_for_completion(pool->detach_completion); 406060f5a4bcSLai Jiangshan 406129c91e99STejun Heo /* shut down the timers */ 406229c91e99STejun Heo del_timer_sync(&pool->idle_timer); 40633f959aa3SValentin Schneider cancel_work_sync(&pool->idle_cull_work); 406429c91e99STejun Heo del_timer_sync(&pool->mayday_timer); 406529c91e99STejun Heo 406624acfb71SThomas Gleixner /* RCU protected to allow dereferences from get_work_pool() */ 406725b00775SPaul E. McKenney call_rcu(&pool->rcu, rcu_free_pool); 406829c91e99STejun Heo } 406929c91e99STejun Heo 407029c91e99STejun Heo /** 407129c91e99STejun Heo * get_unbound_pool - get a worker_pool with the specified attributes 407229c91e99STejun Heo * @attrs: the attributes of the worker_pool to get 407329c91e99STejun Heo * 407429c91e99STejun Heo * Obtain a worker_pool which has the same attributes as @attrs, bump the 407529c91e99STejun Heo * reference count and return it. If there already is a matching 407629c91e99STejun Heo * worker_pool, it will be used; otherwise, this function attempts to 4077d185af30SYacine Belkadi * create a new one. 4078a892caccSTejun Heo * 4079a892caccSTejun Heo * Should be called with wq_pool_mutex held. 4080d185af30SYacine Belkadi * 4081d185af30SYacine Belkadi * Return: On success, a worker_pool with the same attributes as @attrs. 4082d185af30SYacine Belkadi * On failure, %NULL. 408329c91e99STejun Heo */ 408429c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs) 408529c91e99STejun Heo { 408684193c07STejun Heo struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_NUMA]; 408729c91e99STejun Heo u32 hash = wqattrs_hash(attrs); 408829c91e99STejun Heo struct worker_pool *pool; 408984193c07STejun Heo int pod, node = NUMA_NO_NODE; 409029c91e99STejun Heo 4091a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 409229c91e99STejun Heo 409329c91e99STejun Heo /* do we already have a matching pool? */ 409429c91e99STejun Heo hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) { 409529c91e99STejun Heo if (wqattrs_equal(pool->attrs, attrs)) { 409629c91e99STejun Heo pool->refcnt++; 40973fb1823cSLai Jiangshan return pool; 409829c91e99STejun Heo } 409929c91e99STejun Heo } 410029c91e99STejun Heo 41019546b29eSTejun Heo /* If __pod_cpumask is contained inside a NUMA pod, that's our node */ 410284193c07STejun Heo for (pod = 0; pod < pt->nr_pods; pod++) { 41039546b29eSTejun Heo if (cpumask_subset(attrs->__pod_cpumask, pt->pod_cpus[pod])) { 410484193c07STejun Heo node = pt->pod_node[pod]; 4105e2273584SXunlei Pang break; 4106e2273584SXunlei Pang } 4107e2273584SXunlei Pang } 4108e2273584SXunlei Pang 410929c91e99STejun Heo /* nope, create a new one */ 411084193c07STejun Heo pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, node); 411129c91e99STejun Heo if (!pool || init_worker_pool(pool) < 0) 411229c91e99STejun Heo goto fail; 411329c91e99STejun Heo 411484193c07STejun Heo pool->node = node; 41155de7a03cSTejun Heo copy_workqueue_attrs(pool->attrs, attrs); 41165de7a03cSTejun Heo wqattrs_clear_for_pool(pool->attrs); 41172865a8fbSShaohua Li 411829c91e99STejun Heo if (worker_pool_assign_id(pool) < 0) 411929c91e99STejun Heo goto fail; 412029c91e99STejun Heo 412129c91e99STejun Heo /* create and start the initial worker */ 41223347fa09STejun Heo if (wq_online && !create_worker(pool)) 412329c91e99STejun Heo goto fail; 412429c91e99STejun Heo 412529c91e99STejun Heo /* install */ 412629c91e99STejun Heo hash_add(unbound_pool_hash, &pool->hash_node, hash); 41273fb1823cSLai Jiangshan 412829c91e99STejun Heo return pool; 412929c91e99STejun Heo fail: 413029c91e99STejun Heo if (pool) 413129c91e99STejun Heo put_unbound_pool(pool); 413229c91e99STejun Heo return NULL; 413329c91e99STejun Heo } 413429c91e99STejun Heo 41358864b4e5STejun Heo static void rcu_free_pwq(struct rcu_head *rcu) 41368864b4e5STejun Heo { 41378864b4e5STejun Heo kmem_cache_free(pwq_cache, 41388864b4e5STejun Heo container_of(rcu, struct pool_workqueue, rcu)); 41398864b4e5STejun Heo } 41408864b4e5STejun Heo 41418864b4e5STejun Heo /* 4142967b494eSTejun Heo * Scheduled on pwq_release_worker by put_pwq() when an unbound pwq hits zero 4143967b494eSTejun Heo * refcnt and needs to be destroyed. 41448864b4e5STejun Heo */ 4145687a9aa5STejun Heo static void pwq_release_workfn(struct kthread_work *work) 41468864b4e5STejun Heo { 41478864b4e5STejun Heo struct pool_workqueue *pwq = container_of(work, struct pool_workqueue, 4148687a9aa5STejun Heo release_work); 41498864b4e5STejun Heo struct workqueue_struct *wq = pwq->wq; 41508864b4e5STejun Heo struct worker_pool *pool = pwq->pool; 4151b42b0bddSYang Yingliang bool is_last = false; 41528864b4e5STejun Heo 4153b42b0bddSYang Yingliang /* 4154687a9aa5STejun Heo * When @pwq is not linked, it doesn't hold any reference to the 4155b42b0bddSYang Yingliang * @wq, and @wq is invalid to access. 4156b42b0bddSYang Yingliang */ 4157b42b0bddSYang Yingliang if (!list_empty(&pwq->pwqs_node)) { 41583c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 41598864b4e5STejun Heo list_del_rcu(&pwq->pwqs_node); 4160bc0caf09STejun Heo is_last = list_empty(&wq->pwqs); 41613c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 4162b42b0bddSYang Yingliang } 41638864b4e5STejun Heo 4164687a9aa5STejun Heo if (wq->flags & WQ_UNBOUND) { 4165a892caccSTejun Heo mutex_lock(&wq_pool_mutex); 41668864b4e5STejun Heo put_unbound_pool(pool); 4167a892caccSTejun Heo mutex_unlock(&wq_pool_mutex); 4168687a9aa5STejun Heo } 4169a892caccSTejun Heo 417025b00775SPaul E. McKenney call_rcu(&pwq->rcu, rcu_free_pwq); 41718864b4e5STejun Heo 41728864b4e5STejun Heo /* 41738864b4e5STejun Heo * If we're the last pwq going away, @wq is already dead and no one 4174e2dca7adSTejun Heo * is gonna access it anymore. Schedule RCU free. 41758864b4e5STejun Heo */ 4176669de8bdSBart Van Assche if (is_last) { 4177669de8bdSBart Van Assche wq_unregister_lockdep(wq); 417825b00775SPaul E. McKenney call_rcu(&wq->rcu, rcu_free_wq); 41796029a918STejun Heo } 4180669de8bdSBart Van Assche } 41818864b4e5STejun Heo 418267dc8325SCai Huoqing /* initialize newly allocated @pwq which is associated with @wq and @pool */ 4183f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq, 4184f147f29eSTejun Heo struct worker_pool *pool) 4185d2c1d404STejun Heo { 4186d2c1d404STejun Heo BUG_ON((unsigned long)pwq & WORK_STRUCT_FLAG_MASK); 4187d2c1d404STejun Heo 4188e50aba9aSTejun Heo memset(pwq, 0, sizeof(*pwq)); 4189e50aba9aSTejun Heo 4190d2c1d404STejun Heo pwq->pool = pool; 4191d2c1d404STejun Heo pwq->wq = wq; 4192d2c1d404STejun Heo pwq->flush_color = -1; 41938864b4e5STejun Heo pwq->refcnt = 1; 4194f97a4a1aSLai Jiangshan INIT_LIST_HEAD(&pwq->inactive_works); 41951befcf30STejun Heo INIT_LIST_HEAD(&pwq->pwqs_node); 4196d2c1d404STejun Heo INIT_LIST_HEAD(&pwq->mayday_node); 4197687a9aa5STejun Heo kthread_init_work(&pwq->release_work, pwq_release_workfn); 4198f147f29eSTejun Heo } 4199d2c1d404STejun Heo 4200f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */ 42011befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq) 4202f147f29eSTejun Heo { 4203f147f29eSTejun Heo struct workqueue_struct *wq = pwq->wq; 4204f147f29eSTejun Heo 4205f147f29eSTejun Heo lockdep_assert_held(&wq->mutex); 420675ccf595STejun Heo 42071befcf30STejun Heo /* may be called multiple times, ignore if already linked */ 42081befcf30STejun Heo if (!list_empty(&pwq->pwqs_node)) 42091befcf30STejun Heo return; 42101befcf30STejun Heo 421129b1cb41SLai Jiangshan /* set the matching work_color */ 421275ccf595STejun Heo pwq->work_color = wq->work_color; 4213983ca25eSTejun Heo 4214983ca25eSTejun Heo /* link in @pwq */ 42159e8cd2f5STejun Heo list_add_rcu(&pwq->pwqs_node, &wq->pwqs); 4216df2d5ae4STejun Heo } 42176029a918STejun Heo 4218f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */ 4219f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq, 4220f147f29eSTejun Heo const struct workqueue_attrs *attrs) 4221f147f29eSTejun Heo { 4222f147f29eSTejun Heo struct worker_pool *pool; 4223f147f29eSTejun Heo struct pool_workqueue *pwq; 4224f147f29eSTejun Heo 4225f147f29eSTejun Heo lockdep_assert_held(&wq_pool_mutex); 4226f147f29eSTejun Heo 4227f147f29eSTejun Heo pool = get_unbound_pool(attrs); 4228f147f29eSTejun Heo if (!pool) 4229f147f29eSTejun Heo return NULL; 4230f147f29eSTejun Heo 4231e50aba9aSTejun Heo pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node); 4232f147f29eSTejun Heo if (!pwq) { 4233f147f29eSTejun Heo put_unbound_pool(pool); 4234f147f29eSTejun Heo return NULL; 4235f147f29eSTejun Heo } 4236f147f29eSTejun Heo 4237f147f29eSTejun Heo init_pwq(pwq, wq, pool); 4238f147f29eSTejun Heo return pwq; 4239d2c1d404STejun Heo } 4240d2c1d404STejun Heo 42414c16bd32STejun Heo /** 4242fef59c9cSTejun Heo * wq_calc_pod_cpumask - calculate a wq_attrs' cpumask for a pod 4243042f7df1SLai Jiangshan * @attrs: the wq_attrs of the default pwq of the target workqueue 424484193c07STejun Heo * @cpu: the target CPU 42454c16bd32STejun Heo * @cpu_going_down: if >= 0, the CPU to consider as offline 42464c16bd32STejun Heo * 4247fef59c9cSTejun Heo * Calculate the cpumask a workqueue with @attrs should use on @pod. If 4248fef59c9cSTejun Heo * @cpu_going_down is >= 0, that cpu is considered offline during calculation. 42499546b29eSTejun Heo * The result is stored in @attrs->__pod_cpumask. 42504c16bd32STejun Heo * 4251fef59c9cSTejun Heo * If pod affinity is not enabled, @attrs->cpumask is always used. If enabled 4252fef59c9cSTejun Heo * and @pod has online CPUs requested by @attrs, the returned cpumask is the 4253fef59c9cSTejun Heo * intersection of the possible CPUs of @pod and @attrs->cpumask. 42544c16bd32STejun Heo * 4255fef59c9cSTejun Heo * The caller is responsible for ensuring that the cpumask of @pod stays stable. 42564c16bd32STejun Heo */ 42579546b29eSTejun Heo static void wq_calc_pod_cpumask(struct workqueue_attrs *attrs, int cpu, 42589546b29eSTejun Heo int cpu_going_down) 42594c16bd32STejun Heo { 426084193c07STejun Heo const struct wq_pod_type *pt = wqattrs_pod_type(attrs); 426184193c07STejun Heo int pod = pt->cpu_pod[cpu]; 42624c16bd32STejun Heo 4263fef59c9cSTejun Heo /* does @pod have any online CPUs @attrs wants? */ 42649546b29eSTejun Heo cpumask_and(attrs->__pod_cpumask, pt->pod_cpus[pod], attrs->cpumask); 42659546b29eSTejun Heo cpumask_and(attrs->__pod_cpumask, attrs->__pod_cpumask, cpu_online_mask); 42664c16bd32STejun Heo if (cpu_going_down >= 0) 42679546b29eSTejun Heo cpumask_clear_cpu(cpu_going_down, attrs->__pod_cpumask); 42684c16bd32STejun Heo 42699546b29eSTejun Heo if (cpumask_empty(attrs->__pod_cpumask)) { 42709546b29eSTejun Heo cpumask_copy(attrs->__pod_cpumask, attrs->cpumask); 427184193c07STejun Heo return; 427284193c07STejun Heo } 42734c16bd32STejun Heo 4274fef59c9cSTejun Heo /* yeap, return possible CPUs in @pod that @attrs wants */ 42759546b29eSTejun Heo cpumask_and(attrs->__pod_cpumask, attrs->cpumask, pt->pod_cpus[pod]); 42761ad0f0a7SMichael Bringmann 42779546b29eSTejun Heo if (cpumask_empty(attrs->__pod_cpumask)) 42781ad0f0a7SMichael Bringmann pr_warn_once("WARNING: workqueue cpumask: online intersect > " 42791ad0f0a7SMichael Bringmann "possible intersect\n"); 42804c16bd32STejun Heo } 42814c16bd32STejun Heo 4282636b927eSTejun Heo /* install @pwq into @wq's cpu_pwq and return the old pwq */ 4283636b927eSTejun Heo static struct pool_workqueue *install_unbound_pwq(struct workqueue_struct *wq, 4284636b927eSTejun Heo int cpu, struct pool_workqueue *pwq) 42851befcf30STejun Heo { 42861befcf30STejun Heo struct pool_workqueue *old_pwq; 42871befcf30STejun Heo 42885b95e1afSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 42891befcf30STejun Heo lockdep_assert_held(&wq->mutex); 42901befcf30STejun Heo 42911befcf30STejun Heo /* link_pwq() can handle duplicate calls */ 42921befcf30STejun Heo link_pwq(pwq); 42931befcf30STejun Heo 4294636b927eSTejun Heo old_pwq = rcu_access_pointer(*per_cpu_ptr(wq->cpu_pwq, cpu)); 4295636b927eSTejun Heo rcu_assign_pointer(*per_cpu_ptr(wq->cpu_pwq, cpu), pwq); 42961befcf30STejun Heo return old_pwq; 42971befcf30STejun Heo } 42981befcf30STejun Heo 42992d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */ 43002d5f0764SLai Jiangshan struct apply_wqattrs_ctx { 43012d5f0764SLai Jiangshan struct workqueue_struct *wq; /* target workqueue */ 43022d5f0764SLai Jiangshan struct workqueue_attrs *attrs; /* attrs to apply */ 4303042f7df1SLai Jiangshan struct list_head list; /* queued for batching commit */ 43042d5f0764SLai Jiangshan struct pool_workqueue *dfl_pwq; 43052d5f0764SLai Jiangshan struct pool_workqueue *pwq_tbl[]; 43062d5f0764SLai Jiangshan }; 43072d5f0764SLai Jiangshan 43082d5f0764SLai Jiangshan /* free the resources after success or abort */ 43092d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx) 43102d5f0764SLai Jiangshan { 43112d5f0764SLai Jiangshan if (ctx) { 4312636b927eSTejun Heo int cpu; 43132d5f0764SLai Jiangshan 4314636b927eSTejun Heo for_each_possible_cpu(cpu) 4315636b927eSTejun Heo put_pwq_unlocked(ctx->pwq_tbl[cpu]); 43162d5f0764SLai Jiangshan put_pwq_unlocked(ctx->dfl_pwq); 43172d5f0764SLai Jiangshan 43182d5f0764SLai Jiangshan free_workqueue_attrs(ctx->attrs); 43192d5f0764SLai Jiangshan 43202d5f0764SLai Jiangshan kfree(ctx); 43212d5f0764SLai Jiangshan } 43222d5f0764SLai Jiangshan } 43232d5f0764SLai Jiangshan 43242d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */ 43252d5f0764SLai Jiangshan static struct apply_wqattrs_ctx * 43262d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq, 432799c621efSLai Jiangshan const struct workqueue_attrs *attrs, 432899c621efSLai Jiangshan const cpumask_var_t unbound_cpumask) 43292d5f0764SLai Jiangshan { 43302d5f0764SLai Jiangshan struct apply_wqattrs_ctx *ctx; 43319546b29eSTejun Heo struct workqueue_attrs *new_attrs; 4332636b927eSTejun Heo int cpu; 43332d5f0764SLai Jiangshan 43342d5f0764SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 43352d5f0764SLai Jiangshan 433684193c07STejun Heo if (WARN_ON(attrs->affn_scope < 0 || 433784193c07STejun Heo attrs->affn_scope >= WQ_AFFN_NR_TYPES)) 433884193c07STejun Heo return ERR_PTR(-EINVAL); 433984193c07STejun Heo 4340636b927eSTejun Heo ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_cpu_ids), GFP_KERNEL); 43412d5f0764SLai Jiangshan 4342be69d00dSThomas Gleixner new_attrs = alloc_workqueue_attrs(); 43439546b29eSTejun Heo if (!ctx || !new_attrs) 43442d5f0764SLai Jiangshan goto out_free; 43452d5f0764SLai Jiangshan 4346042f7df1SLai Jiangshan /* 43472d5f0764SLai Jiangshan * If something goes wrong during CPU up/down, we'll fall back to 43482d5f0764SLai Jiangshan * the default pwq covering whole @attrs->cpumask. Always create 43492d5f0764SLai Jiangshan * it even if we don't use it immediately. 43502d5f0764SLai Jiangshan */ 43510f36ee24STejun Heo copy_workqueue_attrs(new_attrs, attrs); 43520f36ee24STejun Heo wqattrs_actualize_cpumask(new_attrs, unbound_cpumask); 43539546b29eSTejun Heo cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask); 43542d5f0764SLai Jiangshan ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs); 43552d5f0764SLai Jiangshan if (!ctx->dfl_pwq) 43562d5f0764SLai Jiangshan goto out_free; 43572d5f0764SLai Jiangshan 4358636b927eSTejun Heo for_each_possible_cpu(cpu) { 4359af73f5c9STejun Heo if (new_attrs->ordered) { 43602d5f0764SLai Jiangshan ctx->dfl_pwq->refcnt++; 4361636b927eSTejun Heo ctx->pwq_tbl[cpu] = ctx->dfl_pwq; 4362636b927eSTejun Heo } else { 43639546b29eSTejun Heo wq_calc_pod_cpumask(new_attrs, cpu, -1); 43649546b29eSTejun Heo ctx->pwq_tbl[cpu] = alloc_unbound_pwq(wq, new_attrs); 4365636b927eSTejun Heo if (!ctx->pwq_tbl[cpu]) 4366636b927eSTejun Heo goto out_free; 43672d5f0764SLai Jiangshan } 43682d5f0764SLai Jiangshan } 43692d5f0764SLai Jiangshan 4370042f7df1SLai Jiangshan /* save the user configured attrs and sanitize it. */ 4371042f7df1SLai Jiangshan copy_workqueue_attrs(new_attrs, attrs); 4372042f7df1SLai Jiangshan cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask); 43739546b29eSTejun Heo cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask); 43742d5f0764SLai Jiangshan ctx->attrs = new_attrs; 4375042f7df1SLai Jiangshan 43762d5f0764SLai Jiangshan ctx->wq = wq; 43772d5f0764SLai Jiangshan return ctx; 43782d5f0764SLai Jiangshan 43792d5f0764SLai Jiangshan out_free: 43802d5f0764SLai Jiangshan free_workqueue_attrs(new_attrs); 43812d5f0764SLai Jiangshan apply_wqattrs_cleanup(ctx); 438284193c07STejun Heo return ERR_PTR(-ENOMEM); 43832d5f0764SLai Jiangshan } 43842d5f0764SLai Jiangshan 43852d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */ 43862d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx) 43872d5f0764SLai Jiangshan { 4388636b927eSTejun Heo int cpu; 43892d5f0764SLai Jiangshan 43902d5f0764SLai Jiangshan /* all pwqs have been created successfully, let's install'em */ 43912d5f0764SLai Jiangshan mutex_lock(&ctx->wq->mutex); 43922d5f0764SLai Jiangshan 43932d5f0764SLai Jiangshan copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs); 43942d5f0764SLai Jiangshan 43952d5f0764SLai Jiangshan /* save the previous pwq and install the new one */ 4396636b927eSTejun Heo for_each_possible_cpu(cpu) 4397636b927eSTejun Heo ctx->pwq_tbl[cpu] = install_unbound_pwq(ctx->wq, cpu, 4398636b927eSTejun Heo ctx->pwq_tbl[cpu]); 43992d5f0764SLai Jiangshan 44002d5f0764SLai Jiangshan /* @dfl_pwq might not have been used, ensure it's linked */ 44012d5f0764SLai Jiangshan link_pwq(ctx->dfl_pwq); 44022d5f0764SLai Jiangshan swap(ctx->wq->dfl_pwq, ctx->dfl_pwq); 44032d5f0764SLai Jiangshan 44042d5f0764SLai Jiangshan mutex_unlock(&ctx->wq->mutex); 44052d5f0764SLai Jiangshan } 44062d5f0764SLai Jiangshan 4407a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq, 4408a0111cf6SLai Jiangshan const struct workqueue_attrs *attrs) 4409a0111cf6SLai Jiangshan { 4410a0111cf6SLai Jiangshan struct apply_wqattrs_ctx *ctx; 4411a0111cf6SLai Jiangshan 4412a0111cf6SLai Jiangshan /* only unbound workqueues can change attributes */ 4413a0111cf6SLai Jiangshan if (WARN_ON(!(wq->flags & WQ_UNBOUND))) 4414a0111cf6SLai Jiangshan return -EINVAL; 4415a0111cf6SLai Jiangshan 4416a0111cf6SLai Jiangshan /* creating multiple pwqs breaks ordering guarantee */ 44170a94efb5STejun Heo if (!list_empty(&wq->pwqs)) { 44180a94efb5STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) 4419a0111cf6SLai Jiangshan return -EINVAL; 4420a0111cf6SLai Jiangshan 44210a94efb5STejun Heo wq->flags &= ~__WQ_ORDERED; 44220a94efb5STejun Heo } 44230a94efb5STejun Heo 442499c621efSLai Jiangshan ctx = apply_wqattrs_prepare(wq, attrs, wq_unbound_cpumask); 442584193c07STejun Heo if (IS_ERR(ctx)) 442684193c07STejun Heo return PTR_ERR(ctx); 4427a0111cf6SLai Jiangshan 4428a0111cf6SLai Jiangshan /* the ctx has been prepared successfully, let's commit it */ 4429a0111cf6SLai Jiangshan apply_wqattrs_commit(ctx); 4430a0111cf6SLai Jiangshan apply_wqattrs_cleanup(ctx); 4431a0111cf6SLai Jiangshan 44326201171eSwanghaibin return 0; 4433a0111cf6SLai Jiangshan } 4434a0111cf6SLai Jiangshan 44359e8cd2f5STejun Heo /** 44369e8cd2f5STejun Heo * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue 44379e8cd2f5STejun Heo * @wq: the target workqueue 44389e8cd2f5STejun Heo * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs() 44399e8cd2f5STejun Heo * 4440fef59c9cSTejun Heo * Apply @attrs to an unbound workqueue @wq. Unless disabled, this function maps 4441fef59c9cSTejun Heo * a separate pwq to each CPU pod with possibles CPUs in @attrs->cpumask so that 4442fef59c9cSTejun Heo * work items are affine to the pod it was issued on. Older pwqs are released as 4443fef59c9cSTejun Heo * in-flight work items finish. Note that a work item which repeatedly requeues 4444fef59c9cSTejun Heo * itself back-to-back will stay on its current pwq. 44459e8cd2f5STejun Heo * 4446d185af30SYacine Belkadi * Performs GFP_KERNEL allocations. 4447d185af30SYacine Belkadi * 4448ffd8bea8SSebastian Andrzej Siewior * Assumes caller has CPU hotplug read exclusion, i.e. cpus_read_lock(). 4449509b3204SDaniel Jordan * 4450d185af30SYacine Belkadi * Return: 0 on success and -errno on failure. 44519e8cd2f5STejun Heo */ 4452513c98d0SDaniel Jordan int apply_workqueue_attrs(struct workqueue_struct *wq, 44539e8cd2f5STejun Heo const struct workqueue_attrs *attrs) 44549e8cd2f5STejun Heo { 4455a0111cf6SLai Jiangshan int ret; 44569e8cd2f5STejun Heo 4457509b3204SDaniel Jordan lockdep_assert_cpus_held(); 4458509b3204SDaniel Jordan 4459509b3204SDaniel Jordan mutex_lock(&wq_pool_mutex); 4460a0111cf6SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 4461509b3204SDaniel Jordan mutex_unlock(&wq_pool_mutex); 44622d5f0764SLai Jiangshan 44632d5f0764SLai Jiangshan return ret; 44649e8cd2f5STejun Heo } 44659e8cd2f5STejun Heo 44664c16bd32STejun Heo /** 4467fef59c9cSTejun Heo * wq_update_pod - update pod affinity of a wq for CPU hot[un]plug 44684c16bd32STejun Heo * @wq: the target workqueue 44694cbfd3deSTejun Heo * @cpu: the CPU to update pool association for 44704cbfd3deSTejun Heo * @hotplug_cpu: the CPU coming up or going down 44714c16bd32STejun Heo * @online: whether @cpu is coming up or going down 44724c16bd32STejun Heo * 44734c16bd32STejun Heo * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and 4474fef59c9cSTejun Heo * %CPU_DOWN_FAILED. @cpu is being hot[un]plugged, update pod affinity of 44754c16bd32STejun Heo * @wq accordingly. 44764c16bd32STejun Heo * 44774c16bd32STejun Heo * 4478fef59c9cSTejun Heo * If pod affinity can't be adjusted due to memory allocation failure, it falls 4479fef59c9cSTejun Heo * back to @wq->dfl_pwq which may not be optimal but is always correct. 4480fef59c9cSTejun Heo * 4481fef59c9cSTejun Heo * Note that when the last allowed CPU of a pod goes offline for a workqueue 4482fef59c9cSTejun Heo * with a cpumask spanning multiple pods, the workers which were already 4483fef59c9cSTejun Heo * executing the work items for the workqueue will lose their CPU affinity and 4484fef59c9cSTejun Heo * may execute on any CPU. This is similar to how per-cpu workqueues behave on 4485fef59c9cSTejun Heo * CPU_DOWN. If a workqueue user wants strict affinity, it's the user's 4486fef59c9cSTejun Heo * responsibility to flush the work item from CPU_DOWN_PREPARE. 44874c16bd32STejun Heo */ 4488fef59c9cSTejun Heo static void wq_update_pod(struct workqueue_struct *wq, int cpu, 44894cbfd3deSTejun Heo int hotplug_cpu, bool online) 44904c16bd32STejun Heo { 44914cbfd3deSTejun Heo int off_cpu = online ? -1 : hotplug_cpu; 44924c16bd32STejun Heo struct pool_workqueue *old_pwq = NULL, *pwq; 44934c16bd32STejun Heo struct workqueue_attrs *target_attrs; 44944c16bd32STejun Heo 44954c16bd32STejun Heo lockdep_assert_held(&wq_pool_mutex); 44964c16bd32STejun Heo 449784193c07STejun Heo if (!(wq->flags & WQ_UNBOUND) || wq->unbound_attrs->ordered) 44984c16bd32STejun Heo return; 44994c16bd32STejun Heo 45004c16bd32STejun Heo /* 45014c16bd32STejun Heo * We don't wanna alloc/free wq_attrs for each wq for each CPU. 45024c16bd32STejun Heo * Let's use a preallocated one. The following buf is protected by 45034c16bd32STejun Heo * CPU hotplug exclusion. 45044c16bd32STejun Heo */ 4505fef59c9cSTejun Heo target_attrs = wq_update_pod_attrs_buf; 45064c16bd32STejun Heo 45074c16bd32STejun Heo copy_workqueue_attrs(target_attrs, wq->unbound_attrs); 45080f36ee24STejun Heo wqattrs_actualize_cpumask(target_attrs, wq_unbound_cpumask); 45094c16bd32STejun Heo 4510636b927eSTejun Heo /* nothing to do if the target cpumask matches the current pwq */ 45119546b29eSTejun Heo wq_calc_pod_cpumask(target_attrs, cpu, off_cpu); 4512636b927eSTejun Heo pwq = rcu_dereference_protected(*per_cpu_ptr(wq->cpu_pwq, cpu), 4513636b927eSTejun Heo lockdep_is_held(&wq_pool_mutex)); 45149546b29eSTejun Heo if (wqattrs_equal(target_attrs, pwq->pool->attrs)) 4515f7142ed4SLai Jiangshan return; 45164c16bd32STejun Heo 45174c16bd32STejun Heo /* create a new pwq */ 45184c16bd32STejun Heo pwq = alloc_unbound_pwq(wq, target_attrs); 45194c16bd32STejun Heo if (!pwq) { 4520fef59c9cSTejun Heo pr_warn("workqueue: allocation failed while updating CPU pod affinity of \"%s\"\n", 45214c16bd32STejun Heo wq->name); 452277f300b1SDaeseok Youn goto use_dfl_pwq; 45234c16bd32STejun Heo } 45244c16bd32STejun Heo 4525f7142ed4SLai Jiangshan /* Install the new pwq. */ 45264c16bd32STejun Heo mutex_lock(&wq->mutex); 4527636b927eSTejun Heo old_pwq = install_unbound_pwq(wq, cpu, pwq); 45284c16bd32STejun Heo goto out_unlock; 45294c16bd32STejun Heo 45304c16bd32STejun Heo use_dfl_pwq: 4531f7142ed4SLai Jiangshan mutex_lock(&wq->mutex); 4532a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq->dfl_pwq->pool->lock); 45334c16bd32STejun Heo get_pwq(wq->dfl_pwq); 4534a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq->dfl_pwq->pool->lock); 4535636b927eSTejun Heo old_pwq = install_unbound_pwq(wq, cpu, wq->dfl_pwq); 45364c16bd32STejun Heo out_unlock: 45374c16bd32STejun Heo mutex_unlock(&wq->mutex); 45384c16bd32STejun Heo put_pwq_unlocked(old_pwq); 45394c16bd32STejun Heo } 45404c16bd32STejun Heo 454130cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq) 45421da177e4SLinus Torvalds { 454349e3cf44STejun Heo bool highpri = wq->flags & WQ_HIGHPRI; 45448a2b7538STejun Heo int cpu, ret; 4545e1d8aa9fSFrederic Weisbecker 4546687a9aa5STejun Heo wq->cpu_pwq = alloc_percpu(struct pool_workqueue *); 4547ee1ceef7STejun Heo if (!wq->cpu_pwq) 4548687a9aa5STejun Heo goto enomem; 454930cdf249STejun Heo 4550636b927eSTejun Heo if (!(wq->flags & WQ_UNBOUND)) { 455130cdf249STejun Heo for_each_possible_cpu(cpu) { 4552687a9aa5STejun Heo struct pool_workqueue **pwq_p = 4553ee1ceef7STejun Heo per_cpu_ptr(wq->cpu_pwq, cpu); 4554687a9aa5STejun Heo struct worker_pool *pool = 4555687a9aa5STejun Heo &(per_cpu_ptr(cpu_worker_pools, cpu)[highpri]); 455630cdf249STejun Heo 4557687a9aa5STejun Heo *pwq_p = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, 4558687a9aa5STejun Heo pool->node); 4559687a9aa5STejun Heo if (!*pwq_p) 4560687a9aa5STejun Heo goto enomem; 4561687a9aa5STejun Heo 4562687a9aa5STejun Heo init_pwq(*pwq_p, wq, pool); 4563f147f29eSTejun Heo 4564f147f29eSTejun Heo mutex_lock(&wq->mutex); 4565687a9aa5STejun Heo link_pwq(*pwq_p); 4566f147f29eSTejun Heo mutex_unlock(&wq->mutex); 456730cdf249STejun Heo } 456830cdf249STejun Heo return 0; 4569509b3204SDaniel Jordan } 4570509b3204SDaniel Jordan 4571ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 4572509b3204SDaniel Jordan if (wq->flags & __WQ_ORDERED) { 45738a2b7538STejun Heo ret = apply_workqueue_attrs(wq, ordered_wq_attrs[highpri]); 45748a2b7538STejun Heo /* there should only be single pwq for ordering guarantee */ 45758a2b7538STejun Heo WARN(!ret && (wq->pwqs.next != &wq->dfl_pwq->pwqs_node || 45768a2b7538STejun Heo wq->pwqs.prev != &wq->dfl_pwq->pwqs_node), 45778a2b7538STejun Heo "ordering guarantee broken for workqueue %s\n", wq->name); 45789e8cd2f5STejun Heo } else { 4579509b3204SDaniel Jordan ret = apply_workqueue_attrs(wq, unbound_std_wq_attrs[highpri]); 45809e8cd2f5STejun Heo } 4581ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 4582509b3204SDaniel Jordan 458364344553SZqiang /* for unbound pwq, flush the pwq_release_worker ensures that the 458464344553SZqiang * pwq_release_workfn() completes before calling kfree(wq). 458564344553SZqiang */ 458664344553SZqiang if (ret) 458764344553SZqiang kthread_flush_worker(pwq_release_worker); 458864344553SZqiang 4589509b3204SDaniel Jordan return ret; 4590687a9aa5STejun Heo 4591687a9aa5STejun Heo enomem: 4592687a9aa5STejun Heo if (wq->cpu_pwq) { 45937b42f401SZqiang for_each_possible_cpu(cpu) { 45947b42f401SZqiang struct pool_workqueue *pwq = *per_cpu_ptr(wq->cpu_pwq, cpu); 45957b42f401SZqiang 45967b42f401SZqiang if (pwq) 45977b42f401SZqiang kmem_cache_free(pwq_cache, pwq); 45987b42f401SZqiang } 4599687a9aa5STejun Heo free_percpu(wq->cpu_pwq); 4600687a9aa5STejun Heo wq->cpu_pwq = NULL; 4601687a9aa5STejun Heo } 4602687a9aa5STejun Heo return -ENOMEM; 46030f900049STejun Heo } 46040f900049STejun Heo 4605f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags, 4606f3421797STejun Heo const char *name) 4607b71ab8c2STejun Heo { 4608636b927eSTejun Heo if (max_active < 1 || max_active > WQ_MAX_ACTIVE) 4609044c782cSValentin Ilie pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n", 4610636b927eSTejun Heo max_active, name, 1, WQ_MAX_ACTIVE); 4611b71ab8c2STejun Heo 4612636b927eSTejun Heo return clamp_val(max_active, 1, WQ_MAX_ACTIVE); 4613b71ab8c2STejun Heo } 4614b71ab8c2STejun Heo 4615983c7515STejun Heo /* 4616983c7515STejun Heo * Workqueues which may be used during memory reclaim should have a rescuer 4617983c7515STejun Heo * to guarantee forward progress. 4618983c7515STejun Heo */ 4619983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq) 4620983c7515STejun Heo { 4621983c7515STejun Heo struct worker *rescuer; 4622b92b36eaSDan Carpenter int ret; 4623983c7515STejun Heo 4624983c7515STejun Heo if (!(wq->flags & WQ_MEM_RECLAIM)) 4625983c7515STejun Heo return 0; 4626983c7515STejun Heo 4627983c7515STejun Heo rescuer = alloc_worker(NUMA_NO_NODE); 46284c0736a7SPetr Mladek if (!rescuer) { 46294c0736a7SPetr Mladek pr_err("workqueue: Failed to allocate a rescuer for wq \"%s\"\n", 46304c0736a7SPetr Mladek wq->name); 4631983c7515STejun Heo return -ENOMEM; 46324c0736a7SPetr Mladek } 4633983c7515STejun Heo 4634983c7515STejun Heo rescuer->rescue_wq = wq; 4635b6a46f72SAaron Tomlin rescuer->task = kthread_create(rescuer_thread, rescuer, "kworker/R-%s", wq->name); 4636f187b697SSean Fu if (IS_ERR(rescuer->task)) { 4637b92b36eaSDan Carpenter ret = PTR_ERR(rescuer->task); 46384c0736a7SPetr Mladek pr_err("workqueue: Failed to create a rescuer kthread for wq \"%s\": %pe", 46394c0736a7SPetr Mladek wq->name, ERR_PTR(ret)); 4640983c7515STejun Heo kfree(rescuer); 4641b92b36eaSDan Carpenter return ret; 4642983c7515STejun Heo } 4643983c7515STejun Heo 4644983c7515STejun Heo wq->rescuer = rescuer; 464585f0ab43SJuri Lelli if (wq->flags & WQ_UNBOUND) 464685f0ab43SJuri Lelli kthread_bind_mask(rescuer->task, wq->unbound_attrs->cpumask); 464785f0ab43SJuri Lelli else 4648983c7515STejun Heo kthread_bind_mask(rescuer->task, cpu_possible_mask); 4649983c7515STejun Heo wake_up_process(rescuer->task); 4650983c7515STejun Heo 4651983c7515STejun Heo return 0; 4652983c7515STejun Heo } 4653983c7515STejun Heo 4654a045a272STejun Heo /** 4655a045a272STejun Heo * wq_adjust_max_active - update a wq's max_active to the current setting 4656a045a272STejun Heo * @wq: target workqueue 4657a045a272STejun Heo * 4658a045a272STejun Heo * If @wq isn't freezing, set @wq->max_active to the saved_max_active and 4659a045a272STejun Heo * activate inactive work items accordingly. If @wq is freezing, clear 4660a045a272STejun Heo * @wq->max_active to zero. 4661a045a272STejun Heo */ 4662a045a272STejun Heo static void wq_adjust_max_active(struct workqueue_struct *wq) 4663a045a272STejun Heo { 4664a045a272STejun Heo struct pool_workqueue *pwq; 4665a045a272STejun Heo 4666a045a272STejun Heo lockdep_assert_held(&wq->mutex); 4667a045a272STejun Heo 4668a045a272STejun Heo if ((wq->flags & WQ_FREEZABLE) && workqueue_freezing) { 4669a045a272STejun Heo WRITE_ONCE(wq->max_active, 0); 4670a045a272STejun Heo return; 4671a045a272STejun Heo } 4672a045a272STejun Heo 4673a045a272STejun Heo if (wq->max_active == wq->saved_max_active) 4674a045a272STejun Heo return; 4675a045a272STejun Heo 4676a045a272STejun Heo /* 4677a045a272STejun Heo * Update @wq->max_active and then kick inactive work items if more 4678a045a272STejun Heo * active work items are allowed. This doesn't break work item ordering 4679a045a272STejun Heo * because new work items are always queued behind existing inactive 4680a045a272STejun Heo * work items if there are any. 4681a045a272STejun Heo */ 4682a045a272STejun Heo WRITE_ONCE(wq->max_active, wq->saved_max_active); 4683a045a272STejun Heo 4684a045a272STejun Heo for_each_pwq(pwq, wq) { 4685a045a272STejun Heo unsigned long flags; 4686a045a272STejun Heo 4687a045a272STejun Heo /* this function can be called during early boot w/ irq disabled */ 4688a045a272STejun Heo raw_spin_lock_irqsave(&pwq->pool->lock, flags); 4689a045a272STejun Heo 4690a045a272STejun Heo while (!list_empty(&pwq->inactive_works) && 4691a045a272STejun Heo pwq->nr_active < wq->max_active) 4692a045a272STejun Heo pwq_activate_first_inactive(pwq); 4693a045a272STejun Heo 4694a045a272STejun Heo kick_pool(pwq->pool); 4695a045a272STejun Heo 4696a045a272STejun Heo raw_spin_unlock_irqrestore(&pwq->pool->lock, flags); 4697a045a272STejun Heo } 4698a045a272STejun Heo } 4699a045a272STejun Heo 4700a2775bbcSMathieu Malaterre __printf(1, 4) 4701669de8bdSBart Van Assche struct workqueue_struct *alloc_workqueue(const char *fmt, 470297e37d7bSTejun Heo unsigned int flags, 4703669de8bdSBart Van Assche int max_active, ...) 47043af24433SOleg Nesterov { 4705ecf6881fSTejun Heo va_list args; 47063af24433SOleg Nesterov struct workqueue_struct *wq; 470731c89007SAudra Mitchell int len; 4708b196be89STejun Heo 47095c0338c6STejun Heo /* 4710fef59c9cSTejun Heo * Unbound && max_active == 1 used to imply ordered, which is no longer 4711fef59c9cSTejun Heo * the case on many machines due to per-pod pools. While 47125c0338c6STejun Heo * alloc_ordered_workqueue() is the right way to create an ordered 4713fef59c9cSTejun Heo * workqueue, keep the previous behavior to avoid subtle breakages. 47145c0338c6STejun Heo */ 47155c0338c6STejun Heo if ((flags & WQ_UNBOUND) && max_active == 1) 47165c0338c6STejun Heo flags |= __WQ_ORDERED; 47175c0338c6STejun Heo 4718cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */ 4719cee22a15SViresh Kumar if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient) 4720cee22a15SViresh Kumar flags |= WQ_UNBOUND; 4721cee22a15SViresh Kumar 4722ecf6881fSTejun Heo /* allocate wq and format name */ 4723636b927eSTejun Heo wq = kzalloc(sizeof(*wq), GFP_KERNEL); 4724b196be89STejun Heo if (!wq) 4725d2c1d404STejun Heo return NULL; 4726b196be89STejun Heo 47276029a918STejun Heo if (flags & WQ_UNBOUND) { 4728be69d00dSThomas Gleixner wq->unbound_attrs = alloc_workqueue_attrs(); 47296029a918STejun Heo if (!wq->unbound_attrs) 47306029a918STejun Heo goto err_free_wq; 47316029a918STejun Heo } 47326029a918STejun Heo 4733669de8bdSBart Van Assche va_start(args, max_active); 473431c89007SAudra Mitchell len = vsnprintf(wq->name, sizeof(wq->name), fmt, args); 4735b196be89STejun Heo va_end(args); 47363af24433SOleg Nesterov 473731c89007SAudra Mitchell if (len >= WQ_NAME_LEN) 473831c89007SAudra Mitchell pr_warn_once("workqueue: name exceeds WQ_NAME_LEN. Truncating to: %s\n", wq->name); 473931c89007SAudra Mitchell 4740d320c038STejun Heo max_active = max_active ?: WQ_DFL_ACTIVE; 4741b196be89STejun Heo max_active = wq_clamp_max_active(max_active, flags, wq->name); 47423af24433SOleg Nesterov 4743b196be89STejun Heo /* init wq */ 474497e37d7bSTejun Heo wq->flags = flags; 4745a045a272STejun Heo wq->max_active = max_active; 4746a0a1a5fdSTejun Heo wq->saved_max_active = max_active; 47473c25a55dSLai Jiangshan mutex_init(&wq->mutex); 4748112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 0); 474930cdf249STejun Heo INIT_LIST_HEAD(&wq->pwqs); 475073f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_queue); 475173f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_overflow); 4752493a1724STejun Heo INIT_LIST_HEAD(&wq->maydays); 47533af24433SOleg Nesterov 4754669de8bdSBart Van Assche wq_init_lockdep(wq); 4755cce1a165SOleg Nesterov INIT_LIST_HEAD(&wq->list); 47563af24433SOleg Nesterov 475730cdf249STejun Heo if (alloc_and_link_pwqs(wq) < 0) 475882efcab3SBart Van Assche goto err_unreg_lockdep; 47591537663fSTejun Heo 476040c17f75STejun Heo if (wq_online && init_rescuer(wq) < 0) 4761d2c1d404STejun Heo goto err_destroy; 4762e22bee78STejun Heo 4763226223abSTejun Heo if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq)) 4764226223abSTejun Heo goto err_destroy; 4765226223abSTejun Heo 47666af8bf3dSOleg Nesterov /* 476768e13a67SLai Jiangshan * wq_pool_mutex protects global freeze state and workqueues list. 476868e13a67SLai Jiangshan * Grab it, adjust max_active and add the new @wq to workqueues 476968e13a67SLai Jiangshan * list. 47706af8bf3dSOleg Nesterov */ 477168e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 4772a0a1a5fdSTejun Heo 4773a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 4774a045a272STejun Heo wq_adjust_max_active(wq); 4775a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 4776a0a1a5fdSTejun Heo 4777e2dca7adSTejun Heo list_add_tail_rcu(&wq->list, &workqueues); 4778a0a1a5fdSTejun Heo 477968e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 47803af24433SOleg Nesterov 47813af24433SOleg Nesterov return wq; 4782d2c1d404STejun Heo 478382efcab3SBart Van Assche err_unreg_lockdep: 4784009bb421SBart Van Assche wq_unregister_lockdep(wq); 4785009bb421SBart Van Assche wq_free_lockdep(wq); 478682efcab3SBart Van Assche err_free_wq: 47876029a918STejun Heo free_workqueue_attrs(wq->unbound_attrs); 47884690c4abSTejun Heo kfree(wq); 4789d2c1d404STejun Heo return NULL; 4790d2c1d404STejun Heo err_destroy: 4791d2c1d404STejun Heo destroy_workqueue(wq); 47924690c4abSTejun Heo return NULL; 47931da177e4SLinus Torvalds } 4794669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue); 47951da177e4SLinus Torvalds 4796c29eb853STejun Heo static bool pwq_busy(struct pool_workqueue *pwq) 4797c29eb853STejun Heo { 4798c29eb853STejun Heo int i; 4799c29eb853STejun Heo 4800c29eb853STejun Heo for (i = 0; i < WORK_NR_COLORS; i++) 4801c29eb853STejun Heo if (pwq->nr_in_flight[i]) 4802c29eb853STejun Heo return true; 4803c29eb853STejun Heo 4804c29eb853STejun Heo if ((pwq != pwq->wq->dfl_pwq) && (pwq->refcnt > 1)) 4805c29eb853STejun Heo return true; 4806afa87ce8STejun Heo if (!pwq_is_empty(pwq)) 4807c29eb853STejun Heo return true; 4808c29eb853STejun Heo 4809c29eb853STejun Heo return false; 4810c29eb853STejun Heo } 4811c29eb853STejun Heo 48123af24433SOleg Nesterov /** 48133af24433SOleg Nesterov * destroy_workqueue - safely terminate a workqueue 48143af24433SOleg Nesterov * @wq: target workqueue 48153af24433SOleg Nesterov * 48163af24433SOleg Nesterov * Safely destroy a workqueue. All work currently pending will be done first. 48173af24433SOleg Nesterov */ 48183af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq) 48193af24433SOleg Nesterov { 482049e3cf44STejun Heo struct pool_workqueue *pwq; 4821636b927eSTejun Heo int cpu; 48223af24433SOleg Nesterov 4823def98c84STejun Heo /* 4824def98c84STejun Heo * Remove it from sysfs first so that sanity check failure doesn't 4825def98c84STejun Heo * lead to sysfs name conflicts. 4826def98c84STejun Heo */ 4827def98c84STejun Heo workqueue_sysfs_unregister(wq); 4828def98c84STejun Heo 482933e3f0a3SRichard Clark /* mark the workqueue destruction is in progress */ 483033e3f0a3SRichard Clark mutex_lock(&wq->mutex); 483133e3f0a3SRichard Clark wq->flags |= __WQ_DESTROYING; 483233e3f0a3SRichard Clark mutex_unlock(&wq->mutex); 483333e3f0a3SRichard Clark 48349c5a2ba7STejun Heo /* drain it before proceeding with destruction */ 48359c5a2ba7STejun Heo drain_workqueue(wq); 4836c8efcc25STejun Heo 4837def98c84STejun Heo /* kill rescuer, if sanity checks fail, leave it w/o rescuer */ 4838def98c84STejun Heo if (wq->rescuer) { 4839def98c84STejun Heo struct worker *rescuer = wq->rescuer; 4840def98c84STejun Heo 4841def98c84STejun Heo /* this prevents new queueing */ 4842a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 4843def98c84STejun Heo wq->rescuer = NULL; 4844a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 4845def98c84STejun Heo 4846def98c84STejun Heo /* rescuer will empty maydays list before exiting */ 4847def98c84STejun Heo kthread_stop(rescuer->task); 48488efe1223STejun Heo kfree(rescuer); 4849def98c84STejun Heo } 4850def98c84STejun Heo 4851c29eb853STejun Heo /* 4852c29eb853STejun Heo * Sanity checks - grab all the locks so that we wait for all 4853c29eb853STejun Heo * in-flight operations which may do put_pwq(). 4854c29eb853STejun Heo */ 4855c29eb853STejun Heo mutex_lock(&wq_pool_mutex); 4856b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 485749e3cf44STejun Heo for_each_pwq(pwq, wq) { 4858a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 4859c29eb853STejun Heo if (WARN_ON(pwq_busy(pwq))) { 48601d9a6159SKefeng Wang pr_warn("%s: %s has the following busy pwq\n", 4861e66b39afSTejun Heo __func__, wq->name); 4862c29eb853STejun Heo show_pwq(pwq); 4863a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 4864b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 4865c29eb853STejun Heo mutex_unlock(&wq_pool_mutex); 486655df0933SImran Khan show_one_workqueue(wq); 48676183c009STejun Heo return; 486876af4d93STejun Heo } 4869a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 487076af4d93STejun Heo } 4871b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 48726183c009STejun Heo 4873a0a1a5fdSTejun Heo /* 4874a0a1a5fdSTejun Heo * wq list is used to freeze wq, remove from list after 4875a0a1a5fdSTejun Heo * flushing is complete in case freeze races us. 4876a0a1a5fdSTejun Heo */ 4877e2dca7adSTejun Heo list_del_rcu(&wq->list); 487868e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 48793af24433SOleg Nesterov 48808864b4e5STejun Heo /* 4881636b927eSTejun Heo * We're the sole accessor of @wq. Directly access cpu_pwq and dfl_pwq 4882636b927eSTejun Heo * to put the base refs. @wq will be auto-destroyed from the last 4883636b927eSTejun Heo * pwq_put. RCU read lock prevents @wq from going away from under us. 48848864b4e5STejun Heo */ 4885636b927eSTejun Heo rcu_read_lock(); 4886636b927eSTejun Heo 4887636b927eSTejun Heo for_each_possible_cpu(cpu) { 4888636b927eSTejun Heo pwq = rcu_access_pointer(*per_cpu_ptr(wq->cpu_pwq, cpu)); 4889636b927eSTejun Heo RCU_INIT_POINTER(*per_cpu_ptr(wq->cpu_pwq, cpu), NULL); 48904c16bd32STejun Heo put_pwq_unlocked(pwq); 48914c16bd32STejun Heo } 48924c16bd32STejun Heo 4893636b927eSTejun Heo put_pwq_unlocked(wq->dfl_pwq); 48944c16bd32STejun Heo wq->dfl_pwq = NULL; 4895636b927eSTejun Heo 4896636b927eSTejun Heo rcu_read_unlock(); 48973af24433SOleg Nesterov } 48983af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue); 48993af24433SOleg Nesterov 4900dcd989cbSTejun Heo /** 4901dcd989cbSTejun Heo * workqueue_set_max_active - adjust max_active of a workqueue 4902dcd989cbSTejun Heo * @wq: target workqueue 4903dcd989cbSTejun Heo * @max_active: new max_active value. 4904dcd989cbSTejun Heo * 4905dcd989cbSTejun Heo * Set max_active of @wq to @max_active. 4906dcd989cbSTejun Heo * 4907dcd989cbSTejun Heo * CONTEXT: 4908dcd989cbSTejun Heo * Don't call from IRQ context. 4909dcd989cbSTejun Heo */ 4910dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) 4911dcd989cbSTejun Heo { 49128719dceaSTejun Heo /* disallow meddling with max_active for ordered workqueues */ 49130a94efb5STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) 49148719dceaSTejun Heo return; 49158719dceaSTejun Heo 4916f3421797STejun Heo max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); 4917dcd989cbSTejun Heo 4918a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 4919dcd989cbSTejun Heo 49200a94efb5STejun Heo wq->flags &= ~__WQ_ORDERED; 4921dcd989cbSTejun Heo wq->saved_max_active = max_active; 4922a045a272STejun Heo wq_adjust_max_active(wq); 4923dcd989cbSTejun Heo 4924a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 4925dcd989cbSTejun Heo } 4926dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active); 4927dcd989cbSTejun Heo 4928dcd989cbSTejun Heo /** 492927d4ee03SLukas Wunner * current_work - retrieve %current task's work struct 493027d4ee03SLukas Wunner * 493127d4ee03SLukas Wunner * Determine if %current task is a workqueue worker and what it's working on. 493227d4ee03SLukas Wunner * Useful to find out the context that the %current task is running in. 493327d4ee03SLukas Wunner * 493427d4ee03SLukas Wunner * Return: work struct if %current task is a workqueue worker, %NULL otherwise. 493527d4ee03SLukas Wunner */ 493627d4ee03SLukas Wunner struct work_struct *current_work(void) 493727d4ee03SLukas Wunner { 493827d4ee03SLukas Wunner struct worker *worker = current_wq_worker(); 493927d4ee03SLukas Wunner 494027d4ee03SLukas Wunner return worker ? worker->current_work : NULL; 494127d4ee03SLukas Wunner } 494227d4ee03SLukas Wunner EXPORT_SYMBOL(current_work); 494327d4ee03SLukas Wunner 494427d4ee03SLukas Wunner /** 4945e6267616STejun Heo * current_is_workqueue_rescuer - is %current workqueue rescuer? 4946e6267616STejun Heo * 4947e6267616STejun Heo * Determine whether %current is a workqueue rescuer. Can be used from 4948e6267616STejun Heo * work functions to determine whether it's being run off the rescuer task. 4949d185af30SYacine Belkadi * 4950d185af30SYacine Belkadi * Return: %true if %current is a workqueue rescuer. %false otherwise. 4951e6267616STejun Heo */ 4952e6267616STejun Heo bool current_is_workqueue_rescuer(void) 4953e6267616STejun Heo { 4954e6267616STejun Heo struct worker *worker = current_wq_worker(); 4955e6267616STejun Heo 49566a092dfdSLai Jiangshan return worker && worker->rescue_wq; 4957e6267616STejun Heo } 4958e6267616STejun Heo 4959e6267616STejun Heo /** 4960dcd989cbSTejun Heo * workqueue_congested - test whether a workqueue is congested 4961dcd989cbSTejun Heo * @cpu: CPU in question 4962dcd989cbSTejun Heo * @wq: target workqueue 4963dcd989cbSTejun Heo * 4964dcd989cbSTejun Heo * Test whether @wq's cpu workqueue for @cpu is congested. There is 4965dcd989cbSTejun Heo * no synchronization around this function and the test result is 4966dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 4967dcd989cbSTejun Heo * 4968d3251859STejun Heo * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU. 4969636b927eSTejun Heo * 4970636b927eSTejun Heo * With the exception of ordered workqueues, all workqueues have per-cpu 4971636b927eSTejun Heo * pool_workqueues, each with its own congested state. A workqueue being 4972636b927eSTejun Heo * congested on one CPU doesn't mean that the workqueue is contested on any 4973636b927eSTejun Heo * other CPUs. 4974d3251859STejun Heo * 4975d185af30SYacine Belkadi * Return: 4976dcd989cbSTejun Heo * %true if congested, %false otherwise. 4977dcd989cbSTejun Heo */ 4978d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq) 4979dcd989cbSTejun Heo { 49807fb98ea7STejun Heo struct pool_workqueue *pwq; 498176af4d93STejun Heo bool ret; 498276af4d93STejun Heo 498324acfb71SThomas Gleixner rcu_read_lock(); 498424acfb71SThomas Gleixner preempt_disable(); 49857fb98ea7STejun Heo 4986d3251859STejun Heo if (cpu == WORK_CPU_UNBOUND) 4987d3251859STejun Heo cpu = smp_processor_id(); 4988d3251859STejun Heo 4989687a9aa5STejun Heo pwq = *per_cpu_ptr(wq->cpu_pwq, cpu); 4990f97a4a1aSLai Jiangshan ret = !list_empty(&pwq->inactive_works); 4991636b927eSTejun Heo 499224acfb71SThomas Gleixner preempt_enable(); 499324acfb71SThomas Gleixner rcu_read_unlock(); 499476af4d93STejun Heo 499576af4d93STejun Heo return ret; 4996dcd989cbSTejun Heo } 4997dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested); 4998dcd989cbSTejun Heo 4999dcd989cbSTejun Heo /** 5000dcd989cbSTejun Heo * work_busy - test whether a work is currently pending or running 5001dcd989cbSTejun Heo * @work: the work to be tested 5002dcd989cbSTejun Heo * 5003dcd989cbSTejun Heo * Test whether @work is currently pending or running. There is no 5004dcd989cbSTejun Heo * synchronization around this function and the test result is 5005dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 5006dcd989cbSTejun Heo * 5007d185af30SYacine Belkadi * Return: 5008dcd989cbSTejun Heo * OR'd bitmask of WORK_BUSY_* bits. 5009dcd989cbSTejun Heo */ 5010dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work) 5011dcd989cbSTejun Heo { 5012fa1b54e6STejun Heo struct worker_pool *pool; 5013dcd989cbSTejun Heo unsigned long flags; 5014dcd989cbSTejun Heo unsigned int ret = 0; 5015dcd989cbSTejun Heo 5016dcd989cbSTejun Heo if (work_pending(work)) 5017dcd989cbSTejun Heo ret |= WORK_BUSY_PENDING; 5018038366c5SLai Jiangshan 501924acfb71SThomas Gleixner rcu_read_lock(); 5020fa1b54e6STejun Heo pool = get_work_pool(work); 5021038366c5SLai Jiangshan if (pool) { 5022a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irqsave(&pool->lock, flags); 5023c9e7cf27STejun Heo if (find_worker_executing_work(pool, work)) 5024dcd989cbSTejun Heo ret |= WORK_BUSY_RUNNING; 5025a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irqrestore(&pool->lock, flags); 5026038366c5SLai Jiangshan } 502724acfb71SThomas Gleixner rcu_read_unlock(); 5028dcd989cbSTejun Heo 5029dcd989cbSTejun Heo return ret; 5030dcd989cbSTejun Heo } 5031dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy); 5032dcd989cbSTejun Heo 50333d1cb205STejun Heo /** 50343d1cb205STejun Heo * set_worker_desc - set description for the current work item 50353d1cb205STejun Heo * @fmt: printf-style format string 50363d1cb205STejun Heo * @...: arguments for the format string 50373d1cb205STejun Heo * 50383d1cb205STejun Heo * This function can be called by a running work function to describe what 50393d1cb205STejun Heo * the work item is about. If the worker task gets dumped, this 50403d1cb205STejun Heo * information will be printed out together to help debugging. The 50413d1cb205STejun Heo * description can be at most WORKER_DESC_LEN including the trailing '\0'. 50423d1cb205STejun Heo */ 50433d1cb205STejun Heo void set_worker_desc(const char *fmt, ...) 50443d1cb205STejun Heo { 50453d1cb205STejun Heo struct worker *worker = current_wq_worker(); 50463d1cb205STejun Heo va_list args; 50473d1cb205STejun Heo 50483d1cb205STejun Heo if (worker) { 50493d1cb205STejun Heo va_start(args, fmt); 50503d1cb205STejun Heo vsnprintf(worker->desc, sizeof(worker->desc), fmt, args); 50513d1cb205STejun Heo va_end(args); 50523d1cb205STejun Heo } 50533d1cb205STejun Heo } 50545c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc); 50553d1cb205STejun Heo 50563d1cb205STejun Heo /** 50573d1cb205STejun Heo * print_worker_info - print out worker information and description 50583d1cb205STejun Heo * @log_lvl: the log level to use when printing 50593d1cb205STejun Heo * @task: target task 50603d1cb205STejun Heo * 50613d1cb205STejun Heo * If @task is a worker and currently executing a work item, print out the 50623d1cb205STejun Heo * name of the workqueue being serviced and worker description set with 50633d1cb205STejun Heo * set_worker_desc() by the currently executing work item. 50643d1cb205STejun Heo * 50653d1cb205STejun Heo * This function can be safely called on any task as long as the 50663d1cb205STejun Heo * task_struct itself is accessible. While safe, this function isn't 50673d1cb205STejun Heo * synchronized and may print out mixups or garbages of limited length. 50683d1cb205STejun Heo */ 50693d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task) 50703d1cb205STejun Heo { 50713d1cb205STejun Heo work_func_t *fn = NULL; 50723d1cb205STejun Heo char name[WQ_NAME_LEN] = { }; 50733d1cb205STejun Heo char desc[WORKER_DESC_LEN] = { }; 50743d1cb205STejun Heo struct pool_workqueue *pwq = NULL; 50753d1cb205STejun Heo struct workqueue_struct *wq = NULL; 50763d1cb205STejun Heo struct worker *worker; 50773d1cb205STejun Heo 50783d1cb205STejun Heo if (!(task->flags & PF_WQ_WORKER)) 50793d1cb205STejun Heo return; 50803d1cb205STejun Heo 50813d1cb205STejun Heo /* 50823d1cb205STejun Heo * This function is called without any synchronization and @task 50833d1cb205STejun Heo * could be in any state. Be careful with dereferences. 50843d1cb205STejun Heo */ 5085e700591aSPetr Mladek worker = kthread_probe_data(task); 50863d1cb205STejun Heo 50873d1cb205STejun Heo /* 50888bf89593STejun Heo * Carefully copy the associated workqueue's workfn, name and desc. 50898bf89593STejun Heo * Keep the original last '\0' in case the original is garbage. 50903d1cb205STejun Heo */ 5091fe557319SChristoph Hellwig copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn)); 5092fe557319SChristoph Hellwig copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq)); 5093fe557319SChristoph Hellwig copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq)); 5094fe557319SChristoph Hellwig copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1); 5095fe557319SChristoph Hellwig copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1); 50963d1cb205STejun Heo 50973d1cb205STejun Heo if (fn || name[0] || desc[0]) { 5098d75f773cSSakari Ailus printk("%sWorkqueue: %s %ps", log_lvl, name, fn); 50998bf89593STejun Heo if (strcmp(name, desc)) 51003d1cb205STejun Heo pr_cont(" (%s)", desc); 51013d1cb205STejun Heo pr_cont("\n"); 51023d1cb205STejun Heo } 51033d1cb205STejun Heo } 51043d1cb205STejun Heo 51053494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool) 51063494fc30STejun Heo { 51073494fc30STejun Heo pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask); 51083494fc30STejun Heo if (pool->node != NUMA_NO_NODE) 51093494fc30STejun Heo pr_cont(" node=%d", pool->node); 51103494fc30STejun Heo pr_cont(" flags=0x%x nice=%d", pool->flags, pool->attrs->nice); 51113494fc30STejun Heo } 51123494fc30STejun Heo 5113c76feb0dSPaul E. McKenney struct pr_cont_work_struct { 5114c76feb0dSPaul E. McKenney bool comma; 5115c76feb0dSPaul E. McKenney work_func_t func; 5116c76feb0dSPaul E. McKenney long ctr; 5117c76feb0dSPaul E. McKenney }; 5118c76feb0dSPaul E. McKenney 5119c76feb0dSPaul E. McKenney static void pr_cont_work_flush(bool comma, work_func_t func, struct pr_cont_work_struct *pcwsp) 5120c76feb0dSPaul E. McKenney { 5121c76feb0dSPaul E. McKenney if (!pcwsp->ctr) 5122c76feb0dSPaul E. McKenney goto out_record; 5123c76feb0dSPaul E. McKenney if (func == pcwsp->func) { 5124c76feb0dSPaul E. McKenney pcwsp->ctr++; 5125c76feb0dSPaul E. McKenney return; 5126c76feb0dSPaul E. McKenney } 5127c76feb0dSPaul E. McKenney if (pcwsp->ctr == 1) 5128c76feb0dSPaul E. McKenney pr_cont("%s %ps", pcwsp->comma ? "," : "", pcwsp->func); 5129c76feb0dSPaul E. McKenney else 5130c76feb0dSPaul E. McKenney pr_cont("%s %ld*%ps", pcwsp->comma ? "," : "", pcwsp->ctr, pcwsp->func); 5131c76feb0dSPaul E. McKenney pcwsp->ctr = 0; 5132c76feb0dSPaul E. McKenney out_record: 5133c76feb0dSPaul E. McKenney if ((long)func == -1L) 5134c76feb0dSPaul E. McKenney return; 5135c76feb0dSPaul E. McKenney pcwsp->comma = comma; 5136c76feb0dSPaul E. McKenney pcwsp->func = func; 5137c76feb0dSPaul E. McKenney pcwsp->ctr = 1; 5138c76feb0dSPaul E. McKenney } 5139c76feb0dSPaul E. McKenney 5140c76feb0dSPaul E. McKenney static void pr_cont_work(bool comma, struct work_struct *work, struct pr_cont_work_struct *pcwsp) 51413494fc30STejun Heo { 51423494fc30STejun Heo if (work->func == wq_barrier_func) { 51433494fc30STejun Heo struct wq_barrier *barr; 51443494fc30STejun Heo 51453494fc30STejun Heo barr = container_of(work, struct wq_barrier, work); 51463494fc30STejun Heo 5147c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1, pcwsp); 51483494fc30STejun Heo pr_cont("%s BAR(%d)", comma ? "," : "", 51493494fc30STejun Heo task_pid_nr(barr->task)); 51503494fc30STejun Heo } else { 5151c76feb0dSPaul E. McKenney if (!comma) 5152c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1, pcwsp); 5153c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, work->func, pcwsp); 51543494fc30STejun Heo } 51553494fc30STejun Heo } 51563494fc30STejun Heo 51573494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq) 51583494fc30STejun Heo { 5159c76feb0dSPaul E. McKenney struct pr_cont_work_struct pcws = { .ctr = 0, }; 51603494fc30STejun Heo struct worker_pool *pool = pwq->pool; 51613494fc30STejun Heo struct work_struct *work; 51623494fc30STejun Heo struct worker *worker; 51633494fc30STejun Heo bool has_in_flight = false, has_pending = false; 51643494fc30STejun Heo int bkt; 51653494fc30STejun Heo 51663494fc30STejun Heo pr_info(" pwq %d:", pool->id); 51673494fc30STejun Heo pr_cont_pool_info(pool); 51683494fc30STejun Heo 5169a045a272STejun Heo pr_cont(" active=%d refcnt=%d%s\n", 5170a045a272STejun Heo pwq->nr_active, pwq->refcnt, 51713494fc30STejun Heo !list_empty(&pwq->mayday_node) ? " MAYDAY" : ""); 51723494fc30STejun Heo 51733494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 51743494fc30STejun Heo if (worker->current_pwq == pwq) { 51753494fc30STejun Heo has_in_flight = true; 51763494fc30STejun Heo break; 51773494fc30STejun Heo } 51783494fc30STejun Heo } 51793494fc30STejun Heo if (has_in_flight) { 51803494fc30STejun Heo bool comma = false; 51813494fc30STejun Heo 51823494fc30STejun Heo pr_info(" in-flight:"); 51833494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 51843494fc30STejun Heo if (worker->current_pwq != pwq) 51853494fc30STejun Heo continue; 51863494fc30STejun Heo 5187d75f773cSSakari Ailus pr_cont("%s %d%s:%ps", comma ? "," : "", 51883494fc30STejun Heo task_pid_nr(worker->task), 518930ae2fc0STejun Heo worker->rescue_wq ? "(RESCUER)" : "", 51903494fc30STejun Heo worker->current_func); 51913494fc30STejun Heo list_for_each_entry(work, &worker->scheduled, entry) 5192c76feb0dSPaul E. McKenney pr_cont_work(false, work, &pcws); 5193c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1L, &pcws); 51943494fc30STejun Heo comma = true; 51953494fc30STejun Heo } 51963494fc30STejun Heo pr_cont("\n"); 51973494fc30STejun Heo } 51983494fc30STejun Heo 51993494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 52003494fc30STejun Heo if (get_work_pwq(work) == pwq) { 52013494fc30STejun Heo has_pending = true; 52023494fc30STejun Heo break; 52033494fc30STejun Heo } 52043494fc30STejun Heo } 52053494fc30STejun Heo if (has_pending) { 52063494fc30STejun Heo bool comma = false; 52073494fc30STejun Heo 52083494fc30STejun Heo pr_info(" pending:"); 52093494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 52103494fc30STejun Heo if (get_work_pwq(work) != pwq) 52113494fc30STejun Heo continue; 52123494fc30STejun Heo 5213c76feb0dSPaul E. McKenney pr_cont_work(comma, work, &pcws); 52143494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 52153494fc30STejun Heo } 5216c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1L, &pcws); 52173494fc30STejun Heo pr_cont("\n"); 52183494fc30STejun Heo } 52193494fc30STejun Heo 5220f97a4a1aSLai Jiangshan if (!list_empty(&pwq->inactive_works)) { 52213494fc30STejun Heo bool comma = false; 52223494fc30STejun Heo 5223f97a4a1aSLai Jiangshan pr_info(" inactive:"); 5224f97a4a1aSLai Jiangshan list_for_each_entry(work, &pwq->inactive_works, entry) { 5225c76feb0dSPaul E. McKenney pr_cont_work(comma, work, &pcws); 52263494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 52273494fc30STejun Heo } 5228c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1L, &pcws); 52293494fc30STejun Heo pr_cont("\n"); 52303494fc30STejun Heo } 52313494fc30STejun Heo } 52323494fc30STejun Heo 52333494fc30STejun Heo /** 523455df0933SImran Khan * show_one_workqueue - dump state of specified workqueue 523555df0933SImran Khan * @wq: workqueue whose state will be printed 52363494fc30STejun Heo */ 523755df0933SImran Khan void show_one_workqueue(struct workqueue_struct *wq) 52383494fc30STejun Heo { 52393494fc30STejun Heo struct pool_workqueue *pwq; 52403494fc30STejun Heo bool idle = true; 524155df0933SImran Khan unsigned long flags; 52423494fc30STejun Heo 52433494fc30STejun Heo for_each_pwq(pwq, wq) { 5244afa87ce8STejun Heo if (!pwq_is_empty(pwq)) { 52453494fc30STejun Heo idle = false; 52463494fc30STejun Heo break; 52473494fc30STejun Heo } 52483494fc30STejun Heo } 524955df0933SImran Khan if (idle) /* Nothing to print for idle workqueue */ 525055df0933SImran Khan return; 52513494fc30STejun Heo 52523494fc30STejun Heo pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags); 52533494fc30STejun Heo 52543494fc30STejun Heo for_each_pwq(pwq, wq) { 5255a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irqsave(&pwq->pool->lock, flags); 5256afa87ce8STejun Heo if (!pwq_is_empty(pwq)) { 525757116ce1SJohan Hovold /* 525857116ce1SJohan Hovold * Defer printing to avoid deadlocks in console 525957116ce1SJohan Hovold * drivers that queue work while holding locks 526057116ce1SJohan Hovold * also taken in their write paths. 526157116ce1SJohan Hovold */ 526257116ce1SJohan Hovold printk_deferred_enter(); 52633494fc30STejun Heo show_pwq(pwq); 526457116ce1SJohan Hovold printk_deferred_exit(); 526557116ce1SJohan Hovold } 5266a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irqrestore(&pwq->pool->lock, flags); 526762635ea8SSergey Senozhatsky /* 526862635ea8SSergey Senozhatsky * We could be printing a lot from atomic context, e.g. 526955df0933SImran Khan * sysrq-t -> show_all_workqueues(). Avoid triggering 527062635ea8SSergey Senozhatsky * hard lockup. 527162635ea8SSergey Senozhatsky */ 527262635ea8SSergey Senozhatsky touch_nmi_watchdog(); 52733494fc30STejun Heo } 527455df0933SImran Khan 52753494fc30STejun Heo } 52763494fc30STejun Heo 527755df0933SImran Khan /** 527855df0933SImran Khan * show_one_worker_pool - dump state of specified worker pool 527955df0933SImran Khan * @pool: worker pool whose state will be printed 528055df0933SImran Khan */ 528155df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool) 528255df0933SImran Khan { 52833494fc30STejun Heo struct worker *worker; 52843494fc30STejun Heo bool first = true; 528555df0933SImran Khan unsigned long flags; 5286335a42ebSPetr Mladek unsigned long hung = 0; 52873494fc30STejun Heo 5288a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irqsave(&pool->lock, flags); 52893494fc30STejun Heo if (pool->nr_workers == pool->nr_idle) 52903494fc30STejun Heo goto next_pool; 5291335a42ebSPetr Mladek 5292335a42ebSPetr Mladek /* How long the first pending work is waiting for a worker. */ 5293335a42ebSPetr Mladek if (!list_empty(&pool->worklist)) 5294335a42ebSPetr Mladek hung = jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000; 5295335a42ebSPetr Mladek 529657116ce1SJohan Hovold /* 529757116ce1SJohan Hovold * Defer printing to avoid deadlocks in console drivers that 529857116ce1SJohan Hovold * queue work while holding locks also taken in their write 529957116ce1SJohan Hovold * paths. 530057116ce1SJohan Hovold */ 530157116ce1SJohan Hovold printk_deferred_enter(); 53023494fc30STejun Heo pr_info("pool %d:", pool->id); 53033494fc30STejun Heo pr_cont_pool_info(pool); 5304335a42ebSPetr Mladek pr_cont(" hung=%lus workers=%d", hung, pool->nr_workers); 53053494fc30STejun Heo if (pool->manager) 53063494fc30STejun Heo pr_cont(" manager: %d", 53073494fc30STejun Heo task_pid_nr(pool->manager->task)); 53083494fc30STejun Heo list_for_each_entry(worker, &pool->idle_list, entry) { 53093494fc30STejun Heo pr_cont(" %s%d", first ? "idle: " : "", 53103494fc30STejun Heo task_pid_nr(worker->task)); 53113494fc30STejun Heo first = false; 53123494fc30STejun Heo } 53133494fc30STejun Heo pr_cont("\n"); 531457116ce1SJohan Hovold printk_deferred_exit(); 53153494fc30STejun Heo next_pool: 5316a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irqrestore(&pool->lock, flags); 531762635ea8SSergey Senozhatsky /* 531862635ea8SSergey Senozhatsky * We could be printing a lot from atomic context, e.g. 531955df0933SImran Khan * sysrq-t -> show_all_workqueues(). Avoid triggering 532062635ea8SSergey Senozhatsky * hard lockup. 532162635ea8SSergey Senozhatsky */ 532262635ea8SSergey Senozhatsky touch_nmi_watchdog(); 532355df0933SImran Khan 53243494fc30STejun Heo } 53253494fc30STejun Heo 532655df0933SImran Khan /** 532755df0933SImran Khan * show_all_workqueues - dump workqueue state 532855df0933SImran Khan * 5329704bc669SJungseung Lee * Called from a sysrq handler and prints out all busy workqueues and pools. 533055df0933SImran Khan */ 533155df0933SImran Khan void show_all_workqueues(void) 533255df0933SImran Khan { 533355df0933SImran Khan struct workqueue_struct *wq; 533455df0933SImran Khan struct worker_pool *pool; 533555df0933SImran Khan int pi; 533655df0933SImran Khan 533755df0933SImran Khan rcu_read_lock(); 533855df0933SImran Khan 533955df0933SImran Khan pr_info("Showing busy workqueues and worker pools:\n"); 534055df0933SImran Khan 534155df0933SImran Khan list_for_each_entry_rcu(wq, &workqueues, list) 534255df0933SImran Khan show_one_workqueue(wq); 534355df0933SImran Khan 534455df0933SImran Khan for_each_pool(pool, pi) 534555df0933SImran Khan show_one_worker_pool(pool); 534655df0933SImran Khan 534724acfb71SThomas Gleixner rcu_read_unlock(); 53483494fc30STejun Heo } 53493494fc30STejun Heo 5350704bc669SJungseung Lee /** 5351704bc669SJungseung Lee * show_freezable_workqueues - dump freezable workqueue state 5352704bc669SJungseung Lee * 5353704bc669SJungseung Lee * Called from try_to_freeze_tasks() and prints out all freezable workqueues 5354704bc669SJungseung Lee * still busy. 5355704bc669SJungseung Lee */ 5356704bc669SJungseung Lee void show_freezable_workqueues(void) 5357704bc669SJungseung Lee { 5358704bc669SJungseung Lee struct workqueue_struct *wq; 5359704bc669SJungseung Lee 5360704bc669SJungseung Lee rcu_read_lock(); 5361704bc669SJungseung Lee 5362704bc669SJungseung Lee pr_info("Showing freezable workqueues that are still busy:\n"); 5363704bc669SJungseung Lee 5364704bc669SJungseung Lee list_for_each_entry_rcu(wq, &workqueues, list) { 5365704bc669SJungseung Lee if (!(wq->flags & WQ_FREEZABLE)) 5366704bc669SJungseung Lee continue; 5367704bc669SJungseung Lee show_one_workqueue(wq); 5368704bc669SJungseung Lee } 5369704bc669SJungseung Lee 5370704bc669SJungseung Lee rcu_read_unlock(); 5371704bc669SJungseung Lee } 5372704bc669SJungseung Lee 53736b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */ 53746b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task) 53756b59808bSTejun Heo { 53766b59808bSTejun Heo int off; 53776b59808bSTejun Heo 53786b59808bSTejun Heo /* always show the actual comm */ 53796b59808bSTejun Heo off = strscpy(buf, task->comm, size); 53806b59808bSTejun Heo if (off < 0) 53816b59808bSTejun Heo return; 53826b59808bSTejun Heo 5383197f6accSTejun Heo /* stabilize PF_WQ_WORKER and worker pool association */ 53846b59808bSTejun Heo mutex_lock(&wq_pool_attach_mutex); 53856b59808bSTejun Heo 5386197f6accSTejun Heo if (task->flags & PF_WQ_WORKER) { 5387197f6accSTejun Heo struct worker *worker = kthread_data(task); 5388197f6accSTejun Heo struct worker_pool *pool = worker->pool; 53896b59808bSTejun Heo 53906b59808bSTejun Heo if (pool) { 5391a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 53926b59808bSTejun Heo /* 5393197f6accSTejun Heo * ->desc tracks information (wq name or 5394197f6accSTejun Heo * set_worker_desc()) for the latest execution. If 5395197f6accSTejun Heo * current, prepend '+', otherwise '-'. 53966b59808bSTejun Heo */ 53976b59808bSTejun Heo if (worker->desc[0] != '\0') { 53986b59808bSTejun Heo if (worker->current_work) 53996b59808bSTejun Heo scnprintf(buf + off, size - off, "+%s", 54006b59808bSTejun Heo worker->desc); 54016b59808bSTejun Heo else 54026b59808bSTejun Heo scnprintf(buf + off, size - off, "-%s", 54036b59808bSTejun Heo worker->desc); 54046b59808bSTejun Heo } 5405a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 54066b59808bSTejun Heo } 5407197f6accSTejun Heo } 54086b59808bSTejun Heo 54096b59808bSTejun Heo mutex_unlock(&wq_pool_attach_mutex); 54106b59808bSTejun Heo } 54116b59808bSTejun Heo 541266448bc2SMathieu Malaterre #ifdef CONFIG_SMP 541366448bc2SMathieu Malaterre 5414db7bccf4STejun Heo /* 5415db7bccf4STejun Heo * CPU hotplug. 5416db7bccf4STejun Heo * 5417e22bee78STejun Heo * There are two challenges in supporting CPU hotplug. Firstly, there 5418112202d9STejun Heo * are a lot of assumptions on strong associations among work, pwq and 5419706026c2STejun Heo * pool which make migrating pending and scheduled works very 5420e22bee78STejun Heo * difficult to implement without impacting hot paths. Secondly, 542194cf58bbSTejun Heo * worker pools serve mix of short, long and very long running works making 5422e22bee78STejun Heo * blocked draining impractical. 5423e22bee78STejun Heo * 542424647570STejun Heo * This is solved by allowing the pools to be disassociated from the CPU 5425628c78e7STejun Heo * running as an unbound one and allowing it to be reattached later if the 5426628c78e7STejun Heo * cpu comes back online. 5427db7bccf4STejun Heo */ 5428db7bccf4STejun Heo 5429e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu) 5430db7bccf4STejun Heo { 54314ce62e9eSTejun Heo struct worker_pool *pool; 5432db7bccf4STejun Heo struct worker *worker; 5433db7bccf4STejun Heo 5434f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 54351258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 5436a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 5437e22bee78STejun Heo 5438f2d5a0eeSTejun Heo /* 543992f9c5c4SLai Jiangshan * We've blocked all attach/detach operations. Make all workers 544094cf58bbSTejun Heo * unbound and set DISASSOCIATED. Before this, all workers 544111b45b0bSLai Jiangshan * must be on the cpu. After this, they may become diasporas. 5442b4ac9384SLai Jiangshan * And the preemption disabled section in their sched callbacks 5443b4ac9384SLai Jiangshan * are guaranteed to see WORKER_UNBOUND since the code here 5444b4ac9384SLai Jiangshan * is on the same cpu. 5445f2d5a0eeSTejun Heo */ 5446da028469SLai Jiangshan for_each_pool_worker(worker, pool) 5447403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 5448db7bccf4STejun Heo 544924647570STejun Heo pool->flags |= POOL_DISASSOCIATED; 5450f2d5a0eeSTejun Heo 5451e22bee78STejun Heo /* 5452989442d7SLai Jiangshan * The handling of nr_running in sched callbacks are disabled 5453989442d7SLai Jiangshan * now. Zap nr_running. After this, nr_running stays zero and 5454989442d7SLai Jiangshan * need_more_worker() and keep_working() are always true as 5455989442d7SLai Jiangshan * long as the worklist is not empty. This pool now behaves as 5456989442d7SLai Jiangshan * an unbound (in terms of concurrency management) pool which 5457eb283428SLai Jiangshan * are served by workers tied to the pool. 5458e22bee78STejun Heo */ 5459bc35f7efSLai Jiangshan pool->nr_running = 0; 5460eb283428SLai Jiangshan 5461eb283428SLai Jiangshan /* 5462eb283428SLai Jiangshan * With concurrency management just turned off, a busy 5463eb283428SLai Jiangshan * worker blocking could lead to lengthy stalls. Kick off 5464eb283428SLai Jiangshan * unbound chain execution of currently pending work items. 5465eb283428SLai Jiangshan */ 54660219a352STejun Heo kick_pool(pool); 5467989442d7SLai Jiangshan 5468a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 5469989442d7SLai Jiangshan 5470793777bcSValentin Schneider for_each_pool_worker(worker, pool) 5471793777bcSValentin Schneider unbind_worker(worker); 5472989442d7SLai Jiangshan 5473989442d7SLai Jiangshan mutex_unlock(&wq_pool_attach_mutex); 5474eb283428SLai Jiangshan } 5475db7bccf4STejun Heo } 5476db7bccf4STejun Heo 5477bd7c089eSTejun Heo /** 5478bd7c089eSTejun Heo * rebind_workers - rebind all workers of a pool to the associated CPU 5479bd7c089eSTejun Heo * @pool: pool of interest 5480bd7c089eSTejun Heo * 5481a9ab775bSTejun Heo * @pool->cpu is coming online. Rebind all workers to the CPU. 5482bd7c089eSTejun Heo */ 5483bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool) 5484bd7c089eSTejun Heo { 5485a9ab775bSTejun Heo struct worker *worker; 5486bd7c089eSTejun Heo 54871258fae7STejun Heo lockdep_assert_held(&wq_pool_attach_mutex); 5488bd7c089eSTejun Heo 5489bd7c089eSTejun Heo /* 5490a9ab775bSTejun Heo * Restore CPU affinity of all workers. As all idle workers should 5491a9ab775bSTejun Heo * be on the run-queue of the associated CPU before any local 5492402dd89dSShailendra Verma * wake-ups for concurrency management happen, restore CPU affinity 5493a9ab775bSTejun Heo * of all workers first and then clear UNBOUND. As we're called 5494a9ab775bSTejun Heo * from CPU_ONLINE, the following shouldn't fail. 5495bd7c089eSTejun Heo */ 5496c63a2e52SValentin Schneider for_each_pool_worker(worker, pool) { 5497c63a2e52SValentin Schneider kthread_set_per_cpu(worker->task, pool->cpu); 5498c63a2e52SValentin Schneider WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, 54999546b29eSTejun Heo pool_allowed_cpus(pool)) < 0); 5500c63a2e52SValentin Schneider } 5501a9ab775bSTejun Heo 5502a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 5503f7c17d26SWanpeng Li 55043de5e884SLai Jiangshan pool->flags &= ~POOL_DISASSOCIATED; 5505a9ab775bSTejun Heo 5506da028469SLai Jiangshan for_each_pool_worker(worker, pool) { 5507a9ab775bSTejun Heo unsigned int worker_flags = worker->flags; 5508a9ab775bSTejun Heo 5509a9ab775bSTejun Heo /* 5510a9ab775bSTejun Heo * We want to clear UNBOUND but can't directly call 5511a9ab775bSTejun Heo * worker_clr_flags() or adjust nr_running. Atomically 5512a9ab775bSTejun Heo * replace UNBOUND with another NOT_RUNNING flag REBOUND. 5513a9ab775bSTejun Heo * @worker will clear REBOUND using worker_clr_flags() when 5514a9ab775bSTejun Heo * it initiates the next execution cycle thus restoring 5515a9ab775bSTejun Heo * concurrency management. Note that when or whether 5516a9ab775bSTejun Heo * @worker clears REBOUND doesn't affect correctness. 5517a9ab775bSTejun Heo * 5518c95491edSMark Rutland * WRITE_ONCE() is necessary because @worker->flags may be 5519a9ab775bSTejun Heo * tested without holding any lock in 55206d25be57SThomas Gleixner * wq_worker_running(). Without it, NOT_RUNNING test may 5521a9ab775bSTejun Heo * fail incorrectly leading to premature concurrency 5522a9ab775bSTejun Heo * management operations. 5523bd7c089eSTejun Heo */ 5524a9ab775bSTejun Heo WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND)); 5525a9ab775bSTejun Heo worker_flags |= WORKER_REBOUND; 5526a9ab775bSTejun Heo worker_flags &= ~WORKER_UNBOUND; 5527c95491edSMark Rutland WRITE_ONCE(worker->flags, worker_flags); 5528bd7c089eSTejun Heo } 5529a9ab775bSTejun Heo 5530a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 5531bd7c089eSTejun Heo } 5532bd7c089eSTejun Heo 55337dbc725eSTejun Heo /** 55347dbc725eSTejun Heo * restore_unbound_workers_cpumask - restore cpumask of unbound workers 55357dbc725eSTejun Heo * @pool: unbound pool of interest 55367dbc725eSTejun Heo * @cpu: the CPU which is coming up 55377dbc725eSTejun Heo * 55387dbc725eSTejun Heo * An unbound pool may end up with a cpumask which doesn't have any online 55397dbc725eSTejun Heo * CPUs. When a worker of such pool get scheduled, the scheduler resets 55407dbc725eSTejun Heo * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any 55417dbc725eSTejun Heo * online CPU before, cpus_allowed of all its workers should be restored. 55427dbc725eSTejun Heo */ 55437dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu) 55447dbc725eSTejun Heo { 55457dbc725eSTejun Heo static cpumask_t cpumask; 55467dbc725eSTejun Heo struct worker *worker; 55477dbc725eSTejun Heo 55481258fae7STejun Heo lockdep_assert_held(&wq_pool_attach_mutex); 55497dbc725eSTejun Heo 55507dbc725eSTejun Heo /* is @cpu allowed for @pool? */ 55517dbc725eSTejun Heo if (!cpumask_test_cpu(cpu, pool->attrs->cpumask)) 55527dbc725eSTejun Heo return; 55537dbc725eSTejun Heo 55547dbc725eSTejun Heo cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask); 55557dbc725eSTejun Heo 55567dbc725eSTejun Heo /* as we're called from CPU_ONLINE, the following shouldn't fail */ 5557da028469SLai Jiangshan for_each_pool_worker(worker, pool) 5558d945b5e9SPeter Zijlstra WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0); 55597dbc725eSTejun Heo } 55607dbc725eSTejun Heo 55617ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu) 55621da177e4SLinus Torvalds { 55634ce62e9eSTejun Heo struct worker_pool *pool; 55641da177e4SLinus Torvalds 5565f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 55663ce63377STejun Heo if (pool->nr_workers) 55673ce63377STejun Heo continue; 5568051e1850SLai Jiangshan if (!create_worker(pool)) 55697ee681b2SThomas Gleixner return -ENOMEM; 55703af24433SOleg Nesterov } 55717ee681b2SThomas Gleixner return 0; 55727ee681b2SThomas Gleixner } 55731da177e4SLinus Torvalds 55747ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu) 55757ee681b2SThomas Gleixner { 55767ee681b2SThomas Gleixner struct worker_pool *pool; 55777ee681b2SThomas Gleixner struct workqueue_struct *wq; 55787ee681b2SThomas Gleixner int pi; 55797ee681b2SThomas Gleixner 558068e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 55817dbc725eSTejun Heo 55827dbc725eSTejun Heo for_each_pool(pool, pi) { 55831258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 558494cf58bbSTejun Heo 5585f05b558dSLai Jiangshan if (pool->cpu == cpu) 558694cf58bbSTejun Heo rebind_workers(pool); 5587f05b558dSLai Jiangshan else if (pool->cpu < 0) 55887dbc725eSTejun Heo restore_unbound_workers_cpumask(pool, cpu); 558994cf58bbSTejun Heo 55901258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 559194cf58bbSTejun Heo } 55927dbc725eSTejun Heo 5593fef59c9cSTejun Heo /* update pod affinity of unbound workqueues */ 55944cbfd3deSTejun Heo list_for_each_entry(wq, &workqueues, list) { 559584193c07STejun Heo struct workqueue_attrs *attrs = wq->unbound_attrs; 559684193c07STejun Heo 559784193c07STejun Heo if (attrs) { 559884193c07STejun Heo const struct wq_pod_type *pt = wqattrs_pod_type(attrs); 55994cbfd3deSTejun Heo int tcpu; 56004cbfd3deSTejun Heo 560184193c07STejun Heo for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]]) 5602fef59c9cSTejun Heo wq_update_pod(wq, tcpu, cpu, true); 56034cbfd3deSTejun Heo } 56044cbfd3deSTejun Heo } 56054c16bd32STejun Heo 560668e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 56077ee681b2SThomas Gleixner return 0; 560865758202STejun Heo } 560965758202STejun Heo 56107ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu) 561165758202STejun Heo { 56124c16bd32STejun Heo struct workqueue_struct *wq; 56138db25e78STejun Heo 56144c16bd32STejun Heo /* unbinding per-cpu workers should happen on the local CPU */ 5615e8b3f8dbSLai Jiangshan if (WARN_ON(cpu != smp_processor_id())) 5616e8b3f8dbSLai Jiangshan return -1; 5617e8b3f8dbSLai Jiangshan 5618e8b3f8dbSLai Jiangshan unbind_workers(cpu); 56194c16bd32STejun Heo 5620fef59c9cSTejun Heo /* update pod affinity of unbound workqueues */ 56214c16bd32STejun Heo mutex_lock(&wq_pool_mutex); 56224cbfd3deSTejun Heo list_for_each_entry(wq, &workqueues, list) { 562384193c07STejun Heo struct workqueue_attrs *attrs = wq->unbound_attrs; 562484193c07STejun Heo 562584193c07STejun Heo if (attrs) { 562684193c07STejun Heo const struct wq_pod_type *pt = wqattrs_pod_type(attrs); 56274cbfd3deSTejun Heo int tcpu; 56284cbfd3deSTejun Heo 562984193c07STejun Heo for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]]) 5630fef59c9cSTejun Heo wq_update_pod(wq, tcpu, cpu, false); 56314cbfd3deSTejun Heo } 56324cbfd3deSTejun Heo } 56334c16bd32STejun Heo mutex_unlock(&wq_pool_mutex); 56344c16bd32STejun Heo 56357ee681b2SThomas Gleixner return 0; 563665758202STejun Heo } 563765758202STejun Heo 56382d3854a3SRusty Russell struct work_for_cpu { 5639ed48ece2STejun Heo struct work_struct work; 56402d3854a3SRusty Russell long (*fn)(void *); 56412d3854a3SRusty Russell void *arg; 56422d3854a3SRusty Russell long ret; 56432d3854a3SRusty Russell }; 56442d3854a3SRusty Russell 5645ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work) 56462d3854a3SRusty Russell { 5647ed48ece2STejun Heo struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work); 5648ed48ece2STejun Heo 56492d3854a3SRusty Russell wfc->ret = wfc->fn(wfc->arg); 56502d3854a3SRusty Russell } 56512d3854a3SRusty Russell 56522d3854a3SRusty Russell /** 5653265f3ed0SFrederic Weisbecker * work_on_cpu_key - run a function in thread context on a particular cpu 56542d3854a3SRusty Russell * @cpu: the cpu to run on 56552d3854a3SRusty Russell * @fn: the function to run 56562d3854a3SRusty Russell * @arg: the function arg 5657265f3ed0SFrederic Weisbecker * @key: The lock class key for lock debugging purposes 56582d3854a3SRusty Russell * 565931ad9081SRusty Russell * It is up to the caller to ensure that the cpu doesn't go offline. 56606b44003eSAndrew Morton * The caller must not hold any locks which would prevent @fn from completing. 5661d185af30SYacine Belkadi * 5662d185af30SYacine Belkadi * Return: The value @fn returns. 56632d3854a3SRusty Russell */ 5664265f3ed0SFrederic Weisbecker long work_on_cpu_key(int cpu, long (*fn)(void *), 5665265f3ed0SFrederic Weisbecker void *arg, struct lock_class_key *key) 56662d3854a3SRusty Russell { 5667ed48ece2STejun Heo struct work_for_cpu wfc = { .fn = fn, .arg = arg }; 56682d3854a3SRusty Russell 5669265f3ed0SFrederic Weisbecker INIT_WORK_ONSTACK_KEY(&wfc.work, work_for_cpu_fn, key); 5670ed48ece2STejun Heo schedule_work_on(cpu, &wfc.work); 567112997d1aSBjorn Helgaas flush_work(&wfc.work); 5672440a1136SChuansheng Liu destroy_work_on_stack(&wfc.work); 56732d3854a3SRusty Russell return wfc.ret; 56742d3854a3SRusty Russell } 5675265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_key); 56760e8d6a93SThomas Gleixner 56770e8d6a93SThomas Gleixner /** 5678265f3ed0SFrederic Weisbecker * work_on_cpu_safe_key - run a function in thread context on a particular cpu 56790e8d6a93SThomas Gleixner * @cpu: the cpu to run on 56800e8d6a93SThomas Gleixner * @fn: the function to run 56810e8d6a93SThomas Gleixner * @arg: the function argument 5682265f3ed0SFrederic Weisbecker * @key: The lock class key for lock debugging purposes 56830e8d6a93SThomas Gleixner * 56840e8d6a93SThomas Gleixner * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold 56850e8d6a93SThomas Gleixner * any locks which would prevent @fn from completing. 56860e8d6a93SThomas Gleixner * 56870e8d6a93SThomas Gleixner * Return: The value @fn returns. 56880e8d6a93SThomas Gleixner */ 5689265f3ed0SFrederic Weisbecker long work_on_cpu_safe_key(int cpu, long (*fn)(void *), 5690265f3ed0SFrederic Weisbecker void *arg, struct lock_class_key *key) 56910e8d6a93SThomas Gleixner { 56920e8d6a93SThomas Gleixner long ret = -ENODEV; 56930e8d6a93SThomas Gleixner 5694ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 56950e8d6a93SThomas Gleixner if (cpu_online(cpu)) 5696265f3ed0SFrederic Weisbecker ret = work_on_cpu_key(cpu, fn, arg, key); 5697ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 56980e8d6a93SThomas Gleixner return ret; 56990e8d6a93SThomas Gleixner } 5700265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_safe_key); 57012d3854a3SRusty Russell #endif /* CONFIG_SMP */ 57022d3854a3SRusty Russell 5703a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 5704e7577c50SRusty Russell 5705a0a1a5fdSTejun Heo /** 5706a0a1a5fdSTejun Heo * freeze_workqueues_begin - begin freezing workqueues 5707a0a1a5fdSTejun Heo * 570858a69cb4STejun Heo * Start freezing workqueues. After this function returns, all freezable 5709f97a4a1aSLai Jiangshan * workqueues will queue new works to their inactive_works list instead of 5710706026c2STejun Heo * pool->worklist. 5711a0a1a5fdSTejun Heo * 5712a0a1a5fdSTejun Heo * CONTEXT: 5713a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 5714a0a1a5fdSTejun Heo */ 5715a0a1a5fdSTejun Heo void freeze_workqueues_begin(void) 5716a0a1a5fdSTejun Heo { 571724b8a847STejun Heo struct workqueue_struct *wq; 5718a0a1a5fdSTejun Heo 571968e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 5720a0a1a5fdSTejun Heo 57216183c009STejun Heo WARN_ON_ONCE(workqueue_freezing); 5722a0a1a5fdSTejun Heo workqueue_freezing = true; 5723a0a1a5fdSTejun Heo 572424b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 5725a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 5726a045a272STejun Heo wq_adjust_max_active(wq); 5727a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 5728a1056305STejun Heo } 57295bcab335STejun Heo 573068e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5731a0a1a5fdSTejun Heo } 5732a0a1a5fdSTejun Heo 5733a0a1a5fdSTejun Heo /** 573458a69cb4STejun Heo * freeze_workqueues_busy - are freezable workqueues still busy? 5735a0a1a5fdSTejun Heo * 5736a0a1a5fdSTejun Heo * Check whether freezing is complete. This function must be called 5737a0a1a5fdSTejun Heo * between freeze_workqueues_begin() and thaw_workqueues(). 5738a0a1a5fdSTejun Heo * 5739a0a1a5fdSTejun Heo * CONTEXT: 574068e13a67SLai Jiangshan * Grabs and releases wq_pool_mutex. 5741a0a1a5fdSTejun Heo * 5742d185af30SYacine Belkadi * Return: 574358a69cb4STejun Heo * %true if some freezable workqueues are still busy. %false if freezing 574458a69cb4STejun Heo * is complete. 5745a0a1a5fdSTejun Heo */ 5746a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void) 5747a0a1a5fdSTejun Heo { 5748a0a1a5fdSTejun Heo bool busy = false; 574924b8a847STejun Heo struct workqueue_struct *wq; 575024b8a847STejun Heo struct pool_workqueue *pwq; 5751a0a1a5fdSTejun Heo 575268e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 5753a0a1a5fdSTejun Heo 57546183c009STejun Heo WARN_ON_ONCE(!workqueue_freezing); 5755a0a1a5fdSTejun Heo 575624b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 575724b8a847STejun Heo if (!(wq->flags & WQ_FREEZABLE)) 575824b8a847STejun Heo continue; 5759a0a1a5fdSTejun Heo /* 5760a0a1a5fdSTejun Heo * nr_active is monotonically decreasing. It's safe 5761a0a1a5fdSTejun Heo * to peek without lock. 5762a0a1a5fdSTejun Heo */ 576324acfb71SThomas Gleixner rcu_read_lock(); 576424b8a847STejun Heo for_each_pwq(pwq, wq) { 57656183c009STejun Heo WARN_ON_ONCE(pwq->nr_active < 0); 5766112202d9STejun Heo if (pwq->nr_active) { 5767a0a1a5fdSTejun Heo busy = true; 576824acfb71SThomas Gleixner rcu_read_unlock(); 5769a0a1a5fdSTejun Heo goto out_unlock; 5770a0a1a5fdSTejun Heo } 5771a0a1a5fdSTejun Heo } 577224acfb71SThomas Gleixner rcu_read_unlock(); 5773a0a1a5fdSTejun Heo } 5774a0a1a5fdSTejun Heo out_unlock: 577568e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5776a0a1a5fdSTejun Heo return busy; 5777a0a1a5fdSTejun Heo } 5778a0a1a5fdSTejun Heo 5779a0a1a5fdSTejun Heo /** 5780a0a1a5fdSTejun Heo * thaw_workqueues - thaw workqueues 5781a0a1a5fdSTejun Heo * 5782a0a1a5fdSTejun Heo * Thaw workqueues. Normal queueing is restored and all collected 5783706026c2STejun Heo * frozen works are transferred to their respective pool worklists. 5784a0a1a5fdSTejun Heo * 5785a0a1a5fdSTejun Heo * CONTEXT: 5786a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 5787a0a1a5fdSTejun Heo */ 5788a0a1a5fdSTejun Heo void thaw_workqueues(void) 5789a0a1a5fdSTejun Heo { 579024b8a847STejun Heo struct workqueue_struct *wq; 5791a0a1a5fdSTejun Heo 579268e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 5793a0a1a5fdSTejun Heo 5794a0a1a5fdSTejun Heo if (!workqueue_freezing) 5795a0a1a5fdSTejun Heo goto out_unlock; 5796a0a1a5fdSTejun Heo 579774b414eaSLai Jiangshan workqueue_freezing = false; 579824b8a847STejun Heo 579924b8a847STejun Heo /* restore max_active and repopulate worklist */ 580024b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 5801a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 5802a045a272STejun Heo wq_adjust_max_active(wq); 5803a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 580424b8a847STejun Heo } 580524b8a847STejun Heo 5806a0a1a5fdSTejun Heo out_unlock: 580768e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 5808a0a1a5fdSTejun Heo } 5809a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 5810a0a1a5fdSTejun Heo 581199c621efSLai Jiangshan static int workqueue_apply_unbound_cpumask(const cpumask_var_t unbound_cpumask) 5812042f7df1SLai Jiangshan { 5813042f7df1SLai Jiangshan LIST_HEAD(ctxs); 5814042f7df1SLai Jiangshan int ret = 0; 5815042f7df1SLai Jiangshan struct workqueue_struct *wq; 5816042f7df1SLai Jiangshan struct apply_wqattrs_ctx *ctx, *n; 5817042f7df1SLai Jiangshan 5818042f7df1SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 5819042f7df1SLai Jiangshan 5820042f7df1SLai Jiangshan list_for_each_entry(wq, &workqueues, list) { 5821042f7df1SLai Jiangshan if (!(wq->flags & WQ_UNBOUND)) 5822042f7df1SLai Jiangshan continue; 5823ca10d851SWaiman Long 5824042f7df1SLai Jiangshan /* creating multiple pwqs breaks ordering guarantee */ 5825ca10d851SWaiman Long if (!list_empty(&wq->pwqs)) { 5826ca10d851SWaiman Long if (wq->flags & __WQ_ORDERED_EXPLICIT) 5827042f7df1SLai Jiangshan continue; 5828ca10d851SWaiman Long wq->flags &= ~__WQ_ORDERED; 5829ca10d851SWaiman Long } 5830042f7df1SLai Jiangshan 583199c621efSLai Jiangshan ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs, unbound_cpumask); 583284193c07STejun Heo if (IS_ERR(ctx)) { 583384193c07STejun Heo ret = PTR_ERR(ctx); 5834042f7df1SLai Jiangshan break; 5835042f7df1SLai Jiangshan } 5836042f7df1SLai Jiangshan 5837042f7df1SLai Jiangshan list_add_tail(&ctx->list, &ctxs); 5838042f7df1SLai Jiangshan } 5839042f7df1SLai Jiangshan 5840042f7df1SLai Jiangshan list_for_each_entry_safe(ctx, n, &ctxs, list) { 5841042f7df1SLai Jiangshan if (!ret) 5842042f7df1SLai Jiangshan apply_wqattrs_commit(ctx); 5843042f7df1SLai Jiangshan apply_wqattrs_cleanup(ctx); 5844042f7df1SLai Jiangshan } 5845042f7df1SLai Jiangshan 584699c621efSLai Jiangshan if (!ret) { 584799c621efSLai Jiangshan mutex_lock(&wq_pool_attach_mutex); 584899c621efSLai Jiangshan cpumask_copy(wq_unbound_cpumask, unbound_cpumask); 584999c621efSLai Jiangshan mutex_unlock(&wq_pool_attach_mutex); 585099c621efSLai Jiangshan } 5851042f7df1SLai Jiangshan return ret; 5852042f7df1SLai Jiangshan } 5853042f7df1SLai Jiangshan 5854042f7df1SLai Jiangshan /** 5855fe28f631SWaiman Long * workqueue_unbound_exclude_cpumask - Exclude given CPUs from unbound cpumask 5856fe28f631SWaiman Long * @exclude_cpumask: the cpumask to be excluded from wq_unbound_cpumask 5857fe28f631SWaiman Long * 5858fe28f631SWaiman Long * This function can be called from cpuset code to provide a set of isolated 5859fe28f631SWaiman Long * CPUs that should be excluded from wq_unbound_cpumask. The caller must hold 5860fe28f631SWaiman Long * either cpus_read_lock or cpus_write_lock. 5861fe28f631SWaiman Long */ 5862fe28f631SWaiman Long int workqueue_unbound_exclude_cpumask(cpumask_var_t exclude_cpumask) 5863fe28f631SWaiman Long { 5864fe28f631SWaiman Long cpumask_var_t cpumask; 5865fe28f631SWaiman Long int ret = 0; 5866fe28f631SWaiman Long 5867fe28f631SWaiman Long if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL)) 5868fe28f631SWaiman Long return -ENOMEM; 5869fe28f631SWaiman Long 5870fe28f631SWaiman Long lockdep_assert_cpus_held(); 5871fe28f631SWaiman Long mutex_lock(&wq_pool_mutex); 5872fe28f631SWaiman Long 5873fe28f631SWaiman Long /* Save the current isolated cpumask & export it via sysfs */ 5874fe28f631SWaiman Long cpumask_copy(wq_isolated_cpumask, exclude_cpumask); 5875fe28f631SWaiman Long 5876fe28f631SWaiman Long /* 5877fe28f631SWaiman Long * If the operation fails, it will fall back to 5878fe28f631SWaiman Long * wq_requested_unbound_cpumask which is initially set to 5879fe28f631SWaiman Long * (HK_TYPE_WQ ∩ HK_TYPE_DOMAIN) house keeping mask and rewritten 5880fe28f631SWaiman Long * by any subsequent write to workqueue/cpumask sysfs file. 5881fe28f631SWaiman Long */ 5882fe28f631SWaiman Long if (!cpumask_andnot(cpumask, wq_requested_unbound_cpumask, exclude_cpumask)) 5883fe28f631SWaiman Long cpumask_copy(cpumask, wq_requested_unbound_cpumask); 5884fe28f631SWaiman Long if (!cpumask_equal(cpumask, wq_unbound_cpumask)) 5885fe28f631SWaiman Long ret = workqueue_apply_unbound_cpumask(cpumask); 5886fe28f631SWaiman Long 5887fe28f631SWaiman Long mutex_unlock(&wq_pool_mutex); 5888fe28f631SWaiman Long free_cpumask_var(cpumask); 5889fe28f631SWaiman Long return ret; 5890fe28f631SWaiman Long } 5891fe28f631SWaiman Long 589263c5484eSTejun Heo static int parse_affn_scope(const char *val) 589363c5484eSTejun Heo { 589463c5484eSTejun Heo int i; 589563c5484eSTejun Heo 589663c5484eSTejun Heo for (i = 0; i < ARRAY_SIZE(wq_affn_names); i++) { 589763c5484eSTejun Heo if (!strncasecmp(val, wq_affn_names[i], strlen(wq_affn_names[i]))) 589863c5484eSTejun Heo return i; 589963c5484eSTejun Heo } 590063c5484eSTejun Heo return -EINVAL; 590163c5484eSTejun Heo } 590263c5484eSTejun Heo 590363c5484eSTejun Heo static int wq_affn_dfl_set(const char *val, const struct kernel_param *kp) 590463c5484eSTejun Heo { 5905523a301eSTejun Heo struct workqueue_struct *wq; 5906523a301eSTejun Heo int affn, cpu; 590763c5484eSTejun Heo 590863c5484eSTejun Heo affn = parse_affn_scope(val); 590963c5484eSTejun Heo if (affn < 0) 591063c5484eSTejun Heo return affn; 5911523a301eSTejun Heo if (affn == WQ_AFFN_DFL) 5912523a301eSTejun Heo return -EINVAL; 5913523a301eSTejun Heo 5914523a301eSTejun Heo cpus_read_lock(); 5915523a301eSTejun Heo mutex_lock(&wq_pool_mutex); 591663c5484eSTejun Heo 591763c5484eSTejun Heo wq_affn_dfl = affn; 5918523a301eSTejun Heo 5919523a301eSTejun Heo list_for_each_entry(wq, &workqueues, list) { 5920523a301eSTejun Heo for_each_online_cpu(cpu) { 5921523a301eSTejun Heo wq_update_pod(wq, cpu, cpu, true); 5922523a301eSTejun Heo } 5923523a301eSTejun Heo } 5924523a301eSTejun Heo 5925523a301eSTejun Heo mutex_unlock(&wq_pool_mutex); 5926523a301eSTejun Heo cpus_read_unlock(); 5927523a301eSTejun Heo 592863c5484eSTejun Heo return 0; 592963c5484eSTejun Heo } 593063c5484eSTejun Heo 593163c5484eSTejun Heo static int wq_affn_dfl_get(char *buffer, const struct kernel_param *kp) 593263c5484eSTejun Heo { 593363c5484eSTejun Heo return scnprintf(buffer, PAGE_SIZE, "%s\n", wq_affn_names[wq_affn_dfl]); 593463c5484eSTejun Heo } 593563c5484eSTejun Heo 593663c5484eSTejun Heo static const struct kernel_param_ops wq_affn_dfl_ops = { 593763c5484eSTejun Heo .set = wq_affn_dfl_set, 593863c5484eSTejun Heo .get = wq_affn_dfl_get, 593963c5484eSTejun Heo }; 594063c5484eSTejun Heo 594163c5484eSTejun Heo module_param_cb(default_affinity_scope, &wq_affn_dfl_ops, NULL, 0644); 594263c5484eSTejun Heo 59436ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS 59446ba94429SFrederic Weisbecker /* 59456ba94429SFrederic Weisbecker * Workqueues with WQ_SYSFS flag set is visible to userland via 59466ba94429SFrederic Weisbecker * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the 59476ba94429SFrederic Weisbecker * following attributes. 59486ba94429SFrederic Weisbecker * 59496ba94429SFrederic Weisbecker * per_cpu RO bool : whether the workqueue is per-cpu or unbound 59506ba94429SFrederic Weisbecker * max_active RW int : maximum number of in-flight work items 59516ba94429SFrederic Weisbecker * 59526ba94429SFrederic Weisbecker * Unbound workqueues have the following extra attributes. 59536ba94429SFrederic Weisbecker * 59546ba94429SFrederic Weisbecker * nice RW int : nice value of the workers 59556ba94429SFrederic Weisbecker * cpumask RW mask : bitmask of allowed CPUs for the workers 595663c5484eSTejun Heo * affinity_scope RW str : worker CPU affinity scope (cache, numa, none) 59578639ecebSTejun Heo * affinity_strict RW bool : worker CPU affinity is strict 59586ba94429SFrederic Weisbecker */ 59596ba94429SFrederic Weisbecker struct wq_device { 59606ba94429SFrederic Weisbecker struct workqueue_struct *wq; 59616ba94429SFrederic Weisbecker struct device dev; 59626ba94429SFrederic Weisbecker }; 59636ba94429SFrederic Weisbecker 59646ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev) 59656ba94429SFrederic Weisbecker { 59666ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 59676ba94429SFrederic Weisbecker 59686ba94429SFrederic Weisbecker return wq_dev->wq; 59696ba94429SFrederic Weisbecker } 59706ba94429SFrederic Weisbecker 59716ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr, 59726ba94429SFrederic Weisbecker char *buf) 59736ba94429SFrederic Weisbecker { 59746ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 59756ba94429SFrederic Weisbecker 59766ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND)); 59776ba94429SFrederic Weisbecker } 59786ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu); 59796ba94429SFrederic Weisbecker 59806ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev, 59816ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 59826ba94429SFrederic Weisbecker { 59836ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 59846ba94429SFrederic Weisbecker 59856ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active); 59866ba94429SFrederic Weisbecker } 59876ba94429SFrederic Weisbecker 59886ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev, 59896ba94429SFrederic Weisbecker struct device_attribute *attr, const char *buf, 59906ba94429SFrederic Weisbecker size_t count) 59916ba94429SFrederic Weisbecker { 59926ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 59936ba94429SFrederic Weisbecker int val; 59946ba94429SFrederic Weisbecker 59956ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &val) != 1 || val <= 0) 59966ba94429SFrederic Weisbecker return -EINVAL; 59976ba94429SFrederic Weisbecker 59986ba94429SFrederic Weisbecker workqueue_set_max_active(wq, val); 59996ba94429SFrederic Weisbecker return count; 60006ba94429SFrederic Weisbecker } 60016ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active); 60026ba94429SFrederic Weisbecker 60036ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = { 60046ba94429SFrederic Weisbecker &dev_attr_per_cpu.attr, 60056ba94429SFrederic Weisbecker &dev_attr_max_active.attr, 60066ba94429SFrederic Weisbecker NULL, 60076ba94429SFrederic Weisbecker }; 60086ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs); 60096ba94429SFrederic Weisbecker 601049277a5bSWaiman Long static void apply_wqattrs_lock(void) 601149277a5bSWaiman Long { 601249277a5bSWaiman Long /* CPUs should stay stable across pwq creations and installations */ 601349277a5bSWaiman Long cpus_read_lock(); 601449277a5bSWaiman Long mutex_lock(&wq_pool_mutex); 601549277a5bSWaiman Long } 601649277a5bSWaiman Long 601749277a5bSWaiman Long static void apply_wqattrs_unlock(void) 601849277a5bSWaiman Long { 601949277a5bSWaiman Long mutex_unlock(&wq_pool_mutex); 602049277a5bSWaiman Long cpus_read_unlock(); 602149277a5bSWaiman Long } 602249277a5bSWaiman Long 60236ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr, 60246ba94429SFrederic Weisbecker char *buf) 60256ba94429SFrederic Weisbecker { 60266ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 60276ba94429SFrederic Weisbecker int written; 60286ba94429SFrederic Weisbecker 60296ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 60306ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice); 60316ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 60326ba94429SFrederic Weisbecker 60336ba94429SFrederic Weisbecker return written; 60346ba94429SFrederic Weisbecker } 60356ba94429SFrederic Weisbecker 60366ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */ 60376ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq) 60386ba94429SFrederic Weisbecker { 60396ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 60406ba94429SFrederic Weisbecker 6041899a94feSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 6042899a94feSLai Jiangshan 6043be69d00dSThomas Gleixner attrs = alloc_workqueue_attrs(); 60446ba94429SFrederic Weisbecker if (!attrs) 60456ba94429SFrederic Weisbecker return NULL; 60466ba94429SFrederic Weisbecker 60476ba94429SFrederic Weisbecker copy_workqueue_attrs(attrs, wq->unbound_attrs); 60486ba94429SFrederic Weisbecker return attrs; 60496ba94429SFrederic Weisbecker } 60506ba94429SFrederic Weisbecker 60516ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr, 60526ba94429SFrederic Weisbecker const char *buf, size_t count) 60536ba94429SFrederic Weisbecker { 60546ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 60556ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 6056d4d3e257SLai Jiangshan int ret = -ENOMEM; 6057d4d3e257SLai Jiangshan 6058d4d3e257SLai Jiangshan apply_wqattrs_lock(); 60596ba94429SFrederic Weisbecker 60606ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 60616ba94429SFrederic Weisbecker if (!attrs) 6062d4d3e257SLai Jiangshan goto out_unlock; 60636ba94429SFrederic Weisbecker 60646ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &attrs->nice) == 1 && 60656ba94429SFrederic Weisbecker attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE) 6066d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 60676ba94429SFrederic Weisbecker else 60686ba94429SFrederic Weisbecker ret = -EINVAL; 60696ba94429SFrederic Weisbecker 6070d4d3e257SLai Jiangshan out_unlock: 6071d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 60726ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 60736ba94429SFrederic Weisbecker return ret ?: count; 60746ba94429SFrederic Weisbecker } 60756ba94429SFrederic Weisbecker 60766ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev, 60776ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 60786ba94429SFrederic Weisbecker { 60796ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 60806ba94429SFrederic Weisbecker int written; 60816ba94429SFrederic Weisbecker 60826ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 60836ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%*pb\n", 60846ba94429SFrederic Weisbecker cpumask_pr_args(wq->unbound_attrs->cpumask)); 60856ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 60866ba94429SFrederic Weisbecker return written; 60876ba94429SFrederic Weisbecker } 60886ba94429SFrederic Weisbecker 60896ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev, 60906ba94429SFrederic Weisbecker struct device_attribute *attr, 60916ba94429SFrederic Weisbecker const char *buf, size_t count) 60926ba94429SFrederic Weisbecker { 60936ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 60946ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 6095d4d3e257SLai Jiangshan int ret = -ENOMEM; 6096d4d3e257SLai Jiangshan 6097d4d3e257SLai Jiangshan apply_wqattrs_lock(); 60986ba94429SFrederic Weisbecker 60996ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 61006ba94429SFrederic Weisbecker if (!attrs) 6101d4d3e257SLai Jiangshan goto out_unlock; 61026ba94429SFrederic Weisbecker 61036ba94429SFrederic Weisbecker ret = cpumask_parse(buf, attrs->cpumask); 61046ba94429SFrederic Weisbecker if (!ret) 6105d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 61066ba94429SFrederic Weisbecker 6107d4d3e257SLai Jiangshan out_unlock: 6108d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 61096ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 61106ba94429SFrederic Weisbecker return ret ?: count; 61116ba94429SFrederic Weisbecker } 61126ba94429SFrederic Weisbecker 611363c5484eSTejun Heo static ssize_t wq_affn_scope_show(struct device *dev, 611463c5484eSTejun Heo struct device_attribute *attr, char *buf) 611563c5484eSTejun Heo { 611663c5484eSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 611763c5484eSTejun Heo int written; 611863c5484eSTejun Heo 611963c5484eSTejun Heo mutex_lock(&wq->mutex); 6120523a301eSTejun Heo if (wq->unbound_attrs->affn_scope == WQ_AFFN_DFL) 6121523a301eSTejun Heo written = scnprintf(buf, PAGE_SIZE, "%s (%s)\n", 6122523a301eSTejun Heo wq_affn_names[WQ_AFFN_DFL], 6123523a301eSTejun Heo wq_affn_names[wq_affn_dfl]); 6124523a301eSTejun Heo else 612563c5484eSTejun Heo written = scnprintf(buf, PAGE_SIZE, "%s\n", 612663c5484eSTejun Heo wq_affn_names[wq->unbound_attrs->affn_scope]); 612763c5484eSTejun Heo mutex_unlock(&wq->mutex); 612863c5484eSTejun Heo 612963c5484eSTejun Heo return written; 613063c5484eSTejun Heo } 613163c5484eSTejun Heo 613263c5484eSTejun Heo static ssize_t wq_affn_scope_store(struct device *dev, 613363c5484eSTejun Heo struct device_attribute *attr, 613463c5484eSTejun Heo const char *buf, size_t count) 613563c5484eSTejun Heo { 613663c5484eSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 613763c5484eSTejun Heo struct workqueue_attrs *attrs; 613863c5484eSTejun Heo int affn, ret = -ENOMEM; 613963c5484eSTejun Heo 614063c5484eSTejun Heo affn = parse_affn_scope(buf); 614163c5484eSTejun Heo if (affn < 0) 614263c5484eSTejun Heo return affn; 614363c5484eSTejun Heo 614463c5484eSTejun Heo apply_wqattrs_lock(); 614563c5484eSTejun Heo attrs = wq_sysfs_prep_attrs(wq); 614663c5484eSTejun Heo if (attrs) { 614763c5484eSTejun Heo attrs->affn_scope = affn; 614863c5484eSTejun Heo ret = apply_workqueue_attrs_locked(wq, attrs); 614963c5484eSTejun Heo } 615063c5484eSTejun Heo apply_wqattrs_unlock(); 615163c5484eSTejun Heo free_workqueue_attrs(attrs); 615263c5484eSTejun Heo return ret ?: count; 615363c5484eSTejun Heo } 615463c5484eSTejun Heo 61558639ecebSTejun Heo static ssize_t wq_affinity_strict_show(struct device *dev, 61568639ecebSTejun Heo struct device_attribute *attr, char *buf) 61578639ecebSTejun Heo { 61588639ecebSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 61598639ecebSTejun Heo 61608639ecebSTejun Heo return scnprintf(buf, PAGE_SIZE, "%d\n", 61618639ecebSTejun Heo wq->unbound_attrs->affn_strict); 61628639ecebSTejun Heo } 61638639ecebSTejun Heo 61648639ecebSTejun Heo static ssize_t wq_affinity_strict_store(struct device *dev, 61658639ecebSTejun Heo struct device_attribute *attr, 61668639ecebSTejun Heo const char *buf, size_t count) 61678639ecebSTejun Heo { 61688639ecebSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 61698639ecebSTejun Heo struct workqueue_attrs *attrs; 61708639ecebSTejun Heo int v, ret = -ENOMEM; 61718639ecebSTejun Heo 61728639ecebSTejun Heo if (sscanf(buf, "%d", &v) != 1) 61738639ecebSTejun Heo return -EINVAL; 61748639ecebSTejun Heo 61758639ecebSTejun Heo apply_wqattrs_lock(); 61768639ecebSTejun Heo attrs = wq_sysfs_prep_attrs(wq); 61778639ecebSTejun Heo if (attrs) { 61788639ecebSTejun Heo attrs->affn_strict = (bool)v; 61798639ecebSTejun Heo ret = apply_workqueue_attrs_locked(wq, attrs); 61808639ecebSTejun Heo } 61818639ecebSTejun Heo apply_wqattrs_unlock(); 61828639ecebSTejun Heo free_workqueue_attrs(attrs); 61838639ecebSTejun Heo return ret ?: count; 61848639ecebSTejun Heo } 61858639ecebSTejun Heo 61866ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = { 61876ba94429SFrederic Weisbecker __ATTR(nice, 0644, wq_nice_show, wq_nice_store), 61886ba94429SFrederic Weisbecker __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store), 618963c5484eSTejun Heo __ATTR(affinity_scope, 0644, wq_affn_scope_show, wq_affn_scope_store), 61908639ecebSTejun Heo __ATTR(affinity_strict, 0644, wq_affinity_strict_show, wq_affinity_strict_store), 61916ba94429SFrederic Weisbecker __ATTR_NULL, 61926ba94429SFrederic Weisbecker }; 61936ba94429SFrederic Weisbecker 61946ba94429SFrederic Weisbecker static struct bus_type wq_subsys = { 61956ba94429SFrederic Weisbecker .name = "workqueue", 61966ba94429SFrederic Weisbecker .dev_groups = wq_sysfs_groups, 61976ba94429SFrederic Weisbecker }; 61986ba94429SFrederic Weisbecker 619949277a5bSWaiman Long /** 620049277a5bSWaiman Long * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask 620149277a5bSWaiman Long * @cpumask: the cpumask to set 620249277a5bSWaiman Long * 620349277a5bSWaiman Long * The low-level workqueues cpumask is a global cpumask that limits 620449277a5bSWaiman Long * the affinity of all unbound workqueues. This function check the @cpumask 620549277a5bSWaiman Long * and apply it to all unbound workqueues and updates all pwqs of them. 620649277a5bSWaiman Long * 620749277a5bSWaiman Long * Return: 0 - Success 620849277a5bSWaiman Long * -EINVAL - Invalid @cpumask 620949277a5bSWaiman Long * -ENOMEM - Failed to allocate memory for attrs or pwqs. 621049277a5bSWaiman Long */ 621149277a5bSWaiman Long static int workqueue_set_unbound_cpumask(cpumask_var_t cpumask) 621249277a5bSWaiman Long { 621349277a5bSWaiman Long int ret = -EINVAL; 621449277a5bSWaiman Long 621549277a5bSWaiman Long /* 621649277a5bSWaiman Long * Not excluding isolated cpus on purpose. 621749277a5bSWaiman Long * If the user wishes to include them, we allow that. 621849277a5bSWaiman Long */ 621949277a5bSWaiman Long cpumask_and(cpumask, cpumask, cpu_possible_mask); 622049277a5bSWaiman Long if (!cpumask_empty(cpumask)) { 622149277a5bSWaiman Long apply_wqattrs_lock(); 622249277a5bSWaiman Long cpumask_copy(wq_requested_unbound_cpumask, cpumask); 622349277a5bSWaiman Long if (cpumask_equal(cpumask, wq_unbound_cpumask)) { 622449277a5bSWaiman Long ret = 0; 622549277a5bSWaiman Long goto out_unlock; 622649277a5bSWaiman Long } 622749277a5bSWaiman Long 622849277a5bSWaiman Long ret = workqueue_apply_unbound_cpumask(cpumask); 622949277a5bSWaiman Long 623049277a5bSWaiman Long out_unlock: 623149277a5bSWaiman Long apply_wqattrs_unlock(); 623249277a5bSWaiman Long } 623349277a5bSWaiman Long 623449277a5bSWaiman Long return ret; 623549277a5bSWaiman Long } 623649277a5bSWaiman Long 6237fe28f631SWaiman Long static ssize_t __wq_cpumask_show(struct device *dev, 6238fe28f631SWaiman Long struct device_attribute *attr, char *buf, cpumask_var_t mask) 6239b05a7928SFrederic Weisbecker { 6240b05a7928SFrederic Weisbecker int written; 6241b05a7928SFrederic Weisbecker 6242042f7df1SLai Jiangshan mutex_lock(&wq_pool_mutex); 6243fe28f631SWaiman Long written = scnprintf(buf, PAGE_SIZE, "%*pb\n", cpumask_pr_args(mask)); 6244042f7df1SLai Jiangshan mutex_unlock(&wq_pool_mutex); 6245b05a7928SFrederic Weisbecker 6246b05a7928SFrederic Weisbecker return written; 6247b05a7928SFrederic Weisbecker } 6248b05a7928SFrederic Weisbecker 6249fe28f631SWaiman Long static ssize_t wq_unbound_cpumask_show(struct device *dev, 6250fe28f631SWaiman Long struct device_attribute *attr, char *buf) 6251fe28f631SWaiman Long { 6252fe28f631SWaiman Long return __wq_cpumask_show(dev, attr, buf, wq_unbound_cpumask); 6253fe28f631SWaiman Long } 6254fe28f631SWaiman Long 6255fe28f631SWaiman Long static ssize_t wq_requested_cpumask_show(struct device *dev, 6256fe28f631SWaiman Long struct device_attribute *attr, char *buf) 6257fe28f631SWaiman Long { 6258fe28f631SWaiman Long return __wq_cpumask_show(dev, attr, buf, wq_requested_unbound_cpumask); 6259fe28f631SWaiman Long } 6260fe28f631SWaiman Long 6261fe28f631SWaiman Long static ssize_t wq_isolated_cpumask_show(struct device *dev, 6262fe28f631SWaiman Long struct device_attribute *attr, char *buf) 6263fe28f631SWaiman Long { 6264fe28f631SWaiman Long return __wq_cpumask_show(dev, attr, buf, wq_isolated_cpumask); 6265fe28f631SWaiman Long } 6266fe28f631SWaiman Long 6267042f7df1SLai Jiangshan static ssize_t wq_unbound_cpumask_store(struct device *dev, 6268042f7df1SLai Jiangshan struct device_attribute *attr, const char *buf, size_t count) 6269042f7df1SLai Jiangshan { 6270042f7df1SLai Jiangshan cpumask_var_t cpumask; 6271042f7df1SLai Jiangshan int ret; 6272042f7df1SLai Jiangshan 6273042f7df1SLai Jiangshan if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL)) 6274042f7df1SLai Jiangshan return -ENOMEM; 6275042f7df1SLai Jiangshan 6276042f7df1SLai Jiangshan ret = cpumask_parse(buf, cpumask); 6277042f7df1SLai Jiangshan if (!ret) 6278042f7df1SLai Jiangshan ret = workqueue_set_unbound_cpumask(cpumask); 6279042f7df1SLai Jiangshan 6280042f7df1SLai Jiangshan free_cpumask_var(cpumask); 6281042f7df1SLai Jiangshan return ret ? ret : count; 6282042f7df1SLai Jiangshan } 6283042f7df1SLai Jiangshan 6284fe28f631SWaiman Long static struct device_attribute wq_sysfs_cpumask_attrs[] = { 6285042f7df1SLai Jiangshan __ATTR(cpumask, 0644, wq_unbound_cpumask_show, 6286fe28f631SWaiman Long wq_unbound_cpumask_store), 6287fe28f631SWaiman Long __ATTR(cpumask_requested, 0444, wq_requested_cpumask_show, NULL), 6288fe28f631SWaiman Long __ATTR(cpumask_isolated, 0444, wq_isolated_cpumask_show, NULL), 6289fe28f631SWaiman Long __ATTR_NULL, 6290fe28f631SWaiman Long }; 6291b05a7928SFrederic Weisbecker 62926ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void) 62936ba94429SFrederic Weisbecker { 6294686f6697SGreg Kroah-Hartman struct device *dev_root; 6295b05a7928SFrederic Weisbecker int err; 6296b05a7928SFrederic Weisbecker 6297b05a7928SFrederic Weisbecker err = subsys_virtual_register(&wq_subsys, NULL); 6298b05a7928SFrederic Weisbecker if (err) 6299b05a7928SFrederic Weisbecker return err; 6300b05a7928SFrederic Weisbecker 6301686f6697SGreg Kroah-Hartman dev_root = bus_get_dev_root(&wq_subsys); 6302686f6697SGreg Kroah-Hartman if (dev_root) { 6303fe28f631SWaiman Long struct device_attribute *attr; 6304fe28f631SWaiman Long 6305fe28f631SWaiman Long for (attr = wq_sysfs_cpumask_attrs; attr->attr.name; attr++) { 6306fe28f631SWaiman Long err = device_create_file(dev_root, attr); 6307fe28f631SWaiman Long if (err) 6308fe28f631SWaiman Long break; 6309fe28f631SWaiman Long } 6310686f6697SGreg Kroah-Hartman put_device(dev_root); 6311686f6697SGreg Kroah-Hartman } 6312686f6697SGreg Kroah-Hartman return err; 63136ba94429SFrederic Weisbecker } 63146ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init); 63156ba94429SFrederic Weisbecker 63166ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev) 63176ba94429SFrederic Weisbecker { 63186ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 63196ba94429SFrederic Weisbecker 63206ba94429SFrederic Weisbecker kfree(wq_dev); 63216ba94429SFrederic Weisbecker } 63226ba94429SFrederic Weisbecker 63236ba94429SFrederic Weisbecker /** 63246ba94429SFrederic Weisbecker * workqueue_sysfs_register - make a workqueue visible in sysfs 63256ba94429SFrederic Weisbecker * @wq: the workqueue to register 63266ba94429SFrederic Weisbecker * 63276ba94429SFrederic Weisbecker * Expose @wq in sysfs under /sys/bus/workqueue/devices. 63286ba94429SFrederic Weisbecker * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set 63296ba94429SFrederic Weisbecker * which is the preferred method. 63306ba94429SFrederic Weisbecker * 63316ba94429SFrederic Weisbecker * Workqueue user should use this function directly iff it wants to apply 63326ba94429SFrederic Weisbecker * workqueue_attrs before making the workqueue visible in sysfs; otherwise, 63336ba94429SFrederic Weisbecker * apply_workqueue_attrs() may race against userland updating the 63346ba94429SFrederic Weisbecker * attributes. 63356ba94429SFrederic Weisbecker * 63366ba94429SFrederic Weisbecker * Return: 0 on success, -errno on failure. 63376ba94429SFrederic Weisbecker */ 63386ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq) 63396ba94429SFrederic Weisbecker { 63406ba94429SFrederic Weisbecker struct wq_device *wq_dev; 63416ba94429SFrederic Weisbecker int ret; 63426ba94429SFrederic Weisbecker 63436ba94429SFrederic Weisbecker /* 6344402dd89dSShailendra Verma * Adjusting max_active or creating new pwqs by applying 63456ba94429SFrederic Weisbecker * attributes breaks ordering guarantee. Disallow exposing ordered 63466ba94429SFrederic Weisbecker * workqueues. 63476ba94429SFrederic Weisbecker */ 63480a94efb5STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED_EXPLICIT)) 63496ba94429SFrederic Weisbecker return -EINVAL; 63506ba94429SFrederic Weisbecker 63516ba94429SFrederic Weisbecker wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL); 63526ba94429SFrederic Weisbecker if (!wq_dev) 63536ba94429SFrederic Weisbecker return -ENOMEM; 63546ba94429SFrederic Weisbecker 63556ba94429SFrederic Weisbecker wq_dev->wq = wq; 63566ba94429SFrederic Weisbecker wq_dev->dev.bus = &wq_subsys; 63576ba94429SFrederic Weisbecker wq_dev->dev.release = wq_device_release; 635823217b44SLars-Peter Clausen dev_set_name(&wq_dev->dev, "%s", wq->name); 63596ba94429SFrederic Weisbecker 63606ba94429SFrederic Weisbecker /* 63616ba94429SFrederic Weisbecker * unbound_attrs are created separately. Suppress uevent until 63626ba94429SFrederic Weisbecker * everything is ready. 63636ba94429SFrederic Weisbecker */ 63646ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, true); 63656ba94429SFrederic Weisbecker 63666ba94429SFrederic Weisbecker ret = device_register(&wq_dev->dev); 63676ba94429SFrederic Weisbecker if (ret) { 6368537f4146SArvind Yadav put_device(&wq_dev->dev); 63696ba94429SFrederic Weisbecker wq->wq_dev = NULL; 63706ba94429SFrederic Weisbecker return ret; 63716ba94429SFrederic Weisbecker } 63726ba94429SFrederic Weisbecker 63736ba94429SFrederic Weisbecker if (wq->flags & WQ_UNBOUND) { 63746ba94429SFrederic Weisbecker struct device_attribute *attr; 63756ba94429SFrederic Weisbecker 63766ba94429SFrederic Weisbecker for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) { 63776ba94429SFrederic Weisbecker ret = device_create_file(&wq_dev->dev, attr); 63786ba94429SFrederic Weisbecker if (ret) { 63796ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 63806ba94429SFrederic Weisbecker wq->wq_dev = NULL; 63816ba94429SFrederic Weisbecker return ret; 63826ba94429SFrederic Weisbecker } 63836ba94429SFrederic Weisbecker } 63846ba94429SFrederic Weisbecker } 63856ba94429SFrederic Weisbecker 63866ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, false); 63876ba94429SFrederic Weisbecker kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD); 63886ba94429SFrederic Weisbecker return 0; 63896ba94429SFrederic Weisbecker } 63906ba94429SFrederic Weisbecker 63916ba94429SFrederic Weisbecker /** 63926ba94429SFrederic Weisbecker * workqueue_sysfs_unregister - undo workqueue_sysfs_register() 63936ba94429SFrederic Weisbecker * @wq: the workqueue to unregister 63946ba94429SFrederic Weisbecker * 63956ba94429SFrederic Weisbecker * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister. 63966ba94429SFrederic Weisbecker */ 63976ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) 63986ba94429SFrederic Weisbecker { 63996ba94429SFrederic Weisbecker struct wq_device *wq_dev = wq->wq_dev; 64006ba94429SFrederic Weisbecker 64016ba94429SFrederic Weisbecker if (!wq->wq_dev) 64026ba94429SFrederic Weisbecker return; 64036ba94429SFrederic Weisbecker 64046ba94429SFrederic Weisbecker wq->wq_dev = NULL; 64056ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 64066ba94429SFrederic Weisbecker } 64076ba94429SFrederic Weisbecker #else /* CONFIG_SYSFS */ 64086ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { } 64096ba94429SFrederic Weisbecker #endif /* CONFIG_SYSFS */ 64106ba94429SFrederic Weisbecker 641182607adcSTejun Heo /* 641282607adcSTejun Heo * Workqueue watchdog. 641382607adcSTejun Heo * 641482607adcSTejun Heo * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal 641582607adcSTejun Heo * flush dependency, a concurrency managed work item which stays RUNNING 641682607adcSTejun Heo * indefinitely. Workqueue stalls can be very difficult to debug as the 641782607adcSTejun Heo * usual warning mechanisms don't trigger and internal workqueue state is 641882607adcSTejun Heo * largely opaque. 641982607adcSTejun Heo * 642082607adcSTejun Heo * Workqueue watchdog monitors all worker pools periodically and dumps 642182607adcSTejun Heo * state if some pools failed to make forward progress for a while where 642282607adcSTejun Heo * forward progress is defined as the first item on ->worklist changing. 642382607adcSTejun Heo * 642482607adcSTejun Heo * This mechanism is controlled through the kernel parameter 642582607adcSTejun Heo * "workqueue.watchdog_thresh" which can be updated at runtime through the 642682607adcSTejun Heo * corresponding sysfs parameter file. 642782607adcSTejun Heo */ 642882607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG 642982607adcSTejun Heo 643082607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30; 64315cd79d6aSKees Cook static struct timer_list wq_watchdog_timer; 643282607adcSTejun Heo 643382607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES; 643482607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES; 643582607adcSTejun Heo 6436cd2440d6SPetr Mladek /* 6437cd2440d6SPetr Mladek * Show workers that might prevent the processing of pending work items. 6438cd2440d6SPetr Mladek * The only candidates are CPU-bound workers in the running state. 6439cd2440d6SPetr Mladek * Pending work items should be handled by another idle worker 6440cd2440d6SPetr Mladek * in all other situations. 6441cd2440d6SPetr Mladek */ 6442cd2440d6SPetr Mladek static void show_cpu_pool_hog(struct worker_pool *pool) 6443cd2440d6SPetr Mladek { 6444cd2440d6SPetr Mladek struct worker *worker; 6445cd2440d6SPetr Mladek unsigned long flags; 6446cd2440d6SPetr Mladek int bkt; 6447cd2440d6SPetr Mladek 6448cd2440d6SPetr Mladek raw_spin_lock_irqsave(&pool->lock, flags); 6449cd2440d6SPetr Mladek 6450cd2440d6SPetr Mladek hash_for_each(pool->busy_hash, bkt, worker, hentry) { 6451cd2440d6SPetr Mladek if (task_is_running(worker->task)) { 6452cd2440d6SPetr Mladek /* 6453cd2440d6SPetr Mladek * Defer printing to avoid deadlocks in console 6454cd2440d6SPetr Mladek * drivers that queue work while holding locks 6455cd2440d6SPetr Mladek * also taken in their write paths. 6456cd2440d6SPetr Mladek */ 6457cd2440d6SPetr Mladek printk_deferred_enter(); 6458cd2440d6SPetr Mladek 6459cd2440d6SPetr Mladek pr_info("pool %d:\n", pool->id); 6460cd2440d6SPetr Mladek sched_show_task(worker->task); 6461cd2440d6SPetr Mladek 6462cd2440d6SPetr Mladek printk_deferred_exit(); 6463cd2440d6SPetr Mladek } 6464cd2440d6SPetr Mladek } 6465cd2440d6SPetr Mladek 6466cd2440d6SPetr Mladek raw_spin_unlock_irqrestore(&pool->lock, flags); 6467cd2440d6SPetr Mladek } 6468cd2440d6SPetr Mladek 6469cd2440d6SPetr Mladek static void show_cpu_pools_hogs(void) 6470cd2440d6SPetr Mladek { 6471cd2440d6SPetr Mladek struct worker_pool *pool; 6472cd2440d6SPetr Mladek int pi; 6473cd2440d6SPetr Mladek 6474cd2440d6SPetr Mladek pr_info("Showing backtraces of running workers in stalled CPU-bound worker pools:\n"); 6475cd2440d6SPetr Mladek 6476cd2440d6SPetr Mladek rcu_read_lock(); 6477cd2440d6SPetr Mladek 6478cd2440d6SPetr Mladek for_each_pool(pool, pi) { 6479cd2440d6SPetr Mladek if (pool->cpu_stall) 6480cd2440d6SPetr Mladek show_cpu_pool_hog(pool); 6481cd2440d6SPetr Mladek 6482cd2440d6SPetr Mladek } 6483cd2440d6SPetr Mladek 6484cd2440d6SPetr Mladek rcu_read_unlock(); 6485cd2440d6SPetr Mladek } 6486cd2440d6SPetr Mladek 648782607adcSTejun Heo static void wq_watchdog_reset_touched(void) 648882607adcSTejun Heo { 648982607adcSTejun Heo int cpu; 649082607adcSTejun Heo 649182607adcSTejun Heo wq_watchdog_touched = jiffies; 649282607adcSTejun Heo for_each_possible_cpu(cpu) 649382607adcSTejun Heo per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies; 649482607adcSTejun Heo } 649582607adcSTejun Heo 64965cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused) 649782607adcSTejun Heo { 649882607adcSTejun Heo unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ; 649982607adcSTejun Heo bool lockup_detected = false; 6500cd2440d6SPetr Mladek bool cpu_pool_stall = false; 6501940d71c6SSergey Senozhatsky unsigned long now = jiffies; 650282607adcSTejun Heo struct worker_pool *pool; 650382607adcSTejun Heo int pi; 650482607adcSTejun Heo 650582607adcSTejun Heo if (!thresh) 650682607adcSTejun Heo return; 650782607adcSTejun Heo 650882607adcSTejun Heo rcu_read_lock(); 650982607adcSTejun Heo 651082607adcSTejun Heo for_each_pool(pool, pi) { 651182607adcSTejun Heo unsigned long pool_ts, touched, ts; 651282607adcSTejun Heo 6513cd2440d6SPetr Mladek pool->cpu_stall = false; 651482607adcSTejun Heo if (list_empty(&pool->worklist)) 651582607adcSTejun Heo continue; 651682607adcSTejun Heo 6517940d71c6SSergey Senozhatsky /* 6518940d71c6SSergey Senozhatsky * If a virtual machine is stopped by the host it can look to 6519940d71c6SSergey Senozhatsky * the watchdog like a stall. 6520940d71c6SSergey Senozhatsky */ 6521940d71c6SSergey Senozhatsky kvm_check_and_clear_guest_paused(); 6522940d71c6SSergey Senozhatsky 652382607adcSTejun Heo /* get the latest of pool and touched timestamps */ 652489e28ce6SWang Qing if (pool->cpu >= 0) 652589e28ce6SWang Qing touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu)); 652689e28ce6SWang Qing else 652782607adcSTejun Heo touched = READ_ONCE(wq_watchdog_touched); 652889e28ce6SWang Qing pool_ts = READ_ONCE(pool->watchdog_ts); 652982607adcSTejun Heo 653082607adcSTejun Heo if (time_after(pool_ts, touched)) 653182607adcSTejun Heo ts = pool_ts; 653282607adcSTejun Heo else 653382607adcSTejun Heo ts = touched; 653482607adcSTejun Heo 653582607adcSTejun Heo /* did we stall? */ 6536940d71c6SSergey Senozhatsky if (time_after(now, ts + thresh)) { 653782607adcSTejun Heo lockup_detected = true; 6538cd2440d6SPetr Mladek if (pool->cpu >= 0) { 6539cd2440d6SPetr Mladek pool->cpu_stall = true; 6540cd2440d6SPetr Mladek cpu_pool_stall = true; 6541cd2440d6SPetr Mladek } 654282607adcSTejun Heo pr_emerg("BUG: workqueue lockup - pool"); 654382607adcSTejun Heo pr_cont_pool_info(pool); 654482607adcSTejun Heo pr_cont(" stuck for %us!\n", 6545940d71c6SSergey Senozhatsky jiffies_to_msecs(now - pool_ts) / 1000); 654682607adcSTejun Heo } 6547cd2440d6SPetr Mladek 6548cd2440d6SPetr Mladek 654982607adcSTejun Heo } 655082607adcSTejun Heo 655182607adcSTejun Heo rcu_read_unlock(); 655282607adcSTejun Heo 655382607adcSTejun Heo if (lockup_detected) 655455df0933SImran Khan show_all_workqueues(); 655582607adcSTejun Heo 6556cd2440d6SPetr Mladek if (cpu_pool_stall) 6557cd2440d6SPetr Mladek show_cpu_pools_hogs(); 6558cd2440d6SPetr Mladek 655982607adcSTejun Heo wq_watchdog_reset_touched(); 656082607adcSTejun Heo mod_timer(&wq_watchdog_timer, jiffies + thresh); 656182607adcSTejun Heo } 656282607adcSTejun Heo 6563cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu) 656482607adcSTejun Heo { 656582607adcSTejun Heo if (cpu >= 0) 656682607adcSTejun Heo per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies; 656789e28ce6SWang Qing 656882607adcSTejun Heo wq_watchdog_touched = jiffies; 656982607adcSTejun Heo } 657082607adcSTejun Heo 657182607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh) 657282607adcSTejun Heo { 657382607adcSTejun Heo wq_watchdog_thresh = 0; 657482607adcSTejun Heo del_timer_sync(&wq_watchdog_timer); 657582607adcSTejun Heo 657682607adcSTejun Heo if (thresh) { 657782607adcSTejun Heo wq_watchdog_thresh = thresh; 657882607adcSTejun Heo wq_watchdog_reset_touched(); 657982607adcSTejun Heo mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ); 658082607adcSTejun Heo } 658182607adcSTejun Heo } 658282607adcSTejun Heo 658382607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val, 658482607adcSTejun Heo const struct kernel_param *kp) 658582607adcSTejun Heo { 658682607adcSTejun Heo unsigned long thresh; 658782607adcSTejun Heo int ret; 658882607adcSTejun Heo 658982607adcSTejun Heo ret = kstrtoul(val, 0, &thresh); 659082607adcSTejun Heo if (ret) 659182607adcSTejun Heo return ret; 659282607adcSTejun Heo 659382607adcSTejun Heo if (system_wq) 659482607adcSTejun Heo wq_watchdog_set_thresh(thresh); 659582607adcSTejun Heo else 659682607adcSTejun Heo wq_watchdog_thresh = thresh; 659782607adcSTejun Heo 659882607adcSTejun Heo return 0; 659982607adcSTejun Heo } 660082607adcSTejun Heo 660182607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = { 660282607adcSTejun Heo .set = wq_watchdog_param_set_thresh, 660382607adcSTejun Heo .get = param_get_ulong, 660482607adcSTejun Heo }; 660582607adcSTejun Heo 660682607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh, 660782607adcSTejun Heo 0644); 660882607adcSTejun Heo 660982607adcSTejun Heo static void wq_watchdog_init(void) 661082607adcSTejun Heo { 66115cd79d6aSKees Cook timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE); 661282607adcSTejun Heo wq_watchdog_set_thresh(wq_watchdog_thresh); 661382607adcSTejun Heo } 661482607adcSTejun Heo 661582607adcSTejun Heo #else /* CONFIG_WQ_WATCHDOG */ 661682607adcSTejun Heo 661782607adcSTejun Heo static inline void wq_watchdog_init(void) { } 661882607adcSTejun Heo 661982607adcSTejun Heo #endif /* CONFIG_WQ_WATCHDOG */ 662082607adcSTejun Heo 66214a6c5607STejun Heo static void __init restrict_unbound_cpumask(const char *name, const struct cpumask *mask) 66224a6c5607STejun Heo { 66234a6c5607STejun Heo if (!cpumask_intersects(wq_unbound_cpumask, mask)) { 66244a6c5607STejun Heo pr_warn("workqueue: Restricting unbound_cpumask (%*pb) with %s (%*pb) leaves no CPU, ignoring\n", 66254a6c5607STejun Heo cpumask_pr_args(wq_unbound_cpumask), name, cpumask_pr_args(mask)); 66264a6c5607STejun Heo return; 66274a6c5607STejun Heo } 66284a6c5607STejun Heo 66294a6c5607STejun Heo cpumask_and(wq_unbound_cpumask, wq_unbound_cpumask, mask); 66304a6c5607STejun Heo } 66314a6c5607STejun Heo 66323347fa09STejun Heo /** 66333347fa09STejun Heo * workqueue_init_early - early init for workqueue subsystem 66343347fa09STejun Heo * 66352930155bSTejun Heo * This is the first step of three-staged workqueue subsystem initialization and 66362930155bSTejun Heo * invoked as soon as the bare basics - memory allocation, cpumasks and idr are 66372930155bSTejun Heo * up. It sets up all the data structures and system workqueues and allows early 66382930155bSTejun Heo * boot code to create workqueues and queue/cancel work items. Actual work item 66392930155bSTejun Heo * execution starts only after kthreads can be created and scheduled right 66402930155bSTejun Heo * before early initcalls. 66413347fa09STejun Heo */ 66422333e829SYu Chen void __init workqueue_init_early(void) 66431da177e4SLinus Torvalds { 664484193c07STejun Heo struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_SYSTEM]; 66457a4e344cSTejun Heo int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL }; 66467a4e344cSTejun Heo int i, cpu; 6647c34056a3STejun Heo 664810cdb157SLai Jiangshan BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long)); 6649e904e6c2STejun Heo 6650b05a7928SFrederic Weisbecker BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL)); 6651fe28f631SWaiman Long BUG_ON(!alloc_cpumask_var(&wq_requested_unbound_cpumask, GFP_KERNEL)); 6652fe28f631SWaiman Long BUG_ON(!zalloc_cpumask_var(&wq_isolated_cpumask, GFP_KERNEL)); 6653b05a7928SFrederic Weisbecker 66544a6c5607STejun Heo cpumask_copy(wq_unbound_cpumask, cpu_possible_mask); 66554a6c5607STejun Heo restrict_unbound_cpumask("HK_TYPE_WQ", housekeeping_cpumask(HK_TYPE_WQ)); 66564a6c5607STejun Heo restrict_unbound_cpumask("HK_TYPE_DOMAIN", housekeeping_cpumask(HK_TYPE_DOMAIN)); 6657ace3c549Stiozhang if (!cpumask_empty(&wq_cmdline_cpumask)) 66584a6c5607STejun Heo restrict_unbound_cpumask("workqueue.unbound_cpus", &wq_cmdline_cpumask); 6659ace3c549Stiozhang 6660fe28f631SWaiman Long cpumask_copy(wq_requested_unbound_cpumask, wq_unbound_cpumask); 66618b03ae3cSTejun Heo 66628b03ae3cSTejun Heo pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC); 6663e22bee78STejun Heo 66642930155bSTejun Heo wq_update_pod_attrs_buf = alloc_workqueue_attrs(); 66652930155bSTejun Heo BUG_ON(!wq_update_pod_attrs_buf); 66662930155bSTejun Heo 66677bd20b6bSMarcelo Tosatti /* 66687bd20b6bSMarcelo Tosatti * If nohz_full is enabled, set power efficient workqueue as unbound. 66697bd20b6bSMarcelo Tosatti * This allows workqueue items to be moved to HK CPUs. 66707bd20b6bSMarcelo Tosatti */ 66717bd20b6bSMarcelo Tosatti if (housekeeping_enabled(HK_TYPE_TICK)) 66727bd20b6bSMarcelo Tosatti wq_power_efficient = true; 66737bd20b6bSMarcelo Tosatti 667484193c07STejun Heo /* initialize WQ_AFFN_SYSTEM pods */ 667584193c07STejun Heo pt->pod_cpus = kcalloc(1, sizeof(pt->pod_cpus[0]), GFP_KERNEL); 667684193c07STejun Heo pt->pod_node = kcalloc(1, sizeof(pt->pod_node[0]), GFP_KERNEL); 667784193c07STejun Heo pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL); 667884193c07STejun Heo BUG_ON(!pt->pod_cpus || !pt->pod_node || !pt->cpu_pod); 667984193c07STejun Heo 668084193c07STejun Heo BUG_ON(!zalloc_cpumask_var_node(&pt->pod_cpus[0], GFP_KERNEL, NUMA_NO_NODE)); 668184193c07STejun Heo 668284193c07STejun Heo pt->nr_pods = 1; 668384193c07STejun Heo cpumask_copy(pt->pod_cpus[0], cpu_possible_mask); 668484193c07STejun Heo pt->pod_node[0] = NUMA_NO_NODE; 668584193c07STejun Heo pt->cpu_pod[0] = 0; 668684193c07STejun Heo 6687f02ae73aSTejun Heo /* initialize CPU pools */ 668824647570STejun Heo for_each_possible_cpu(cpu) { 6689ebf44d16STejun Heo struct worker_pool *pool; 6690e22bee78STejun Heo 66914ce62e9eSTejun Heo i = 0; 6692e22bee78STejun Heo for_each_cpu_worker_pool(pool, cpu) { 669329c91e99STejun Heo BUG_ON(init_worker_pool(pool)); 669429c91e99STejun Heo pool->cpu = cpu; 669529c91e99STejun Heo cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu)); 66969546b29eSTejun Heo cpumask_copy(pool->attrs->__pod_cpumask, cpumask_of(cpu)); 66971da177e4SLinus Torvalds pool->attrs->nice = std_nice[i++]; 66988639ecebSTejun Heo pool->attrs->affn_strict = true; 66991da177e4SLinus Torvalds pool->node = cpu_to_node(cpu); 67001da177e4SLinus Torvalds 67011da177e4SLinus Torvalds /* alloc pool ID */ 67021da177e4SLinus Torvalds mutex_lock(&wq_pool_mutex); 67031da177e4SLinus Torvalds BUG_ON(worker_pool_assign_id(pool)); 67041da177e4SLinus Torvalds mutex_unlock(&wq_pool_mutex); 670529c91e99STejun Heo } 670629c91e99STejun Heo } 670729c91e99STejun Heo 67088a2b7538STejun Heo /* create default unbound and ordered wq attrs */ 670929c91e99STejun Heo for (i = 0; i < NR_STD_WORKER_POOLS; i++) { 671029c91e99STejun Heo struct workqueue_attrs *attrs; 671129c91e99STejun Heo 6712be69d00dSThomas Gleixner BUG_ON(!(attrs = alloc_workqueue_attrs())); 671329c91e99STejun Heo attrs->nice = std_nice[i]; 671429c91e99STejun Heo unbound_std_wq_attrs[i] = attrs; 67158a2b7538STejun Heo 67168a2b7538STejun Heo /* 67178a2b7538STejun Heo * An ordered wq should have only one pwq as ordering is 67188a2b7538STejun Heo * guaranteed by max_active which is enforced by pwqs. 67198a2b7538STejun Heo */ 6720be69d00dSThomas Gleixner BUG_ON(!(attrs = alloc_workqueue_attrs())); 67218a2b7538STejun Heo attrs->nice = std_nice[i]; 6722af73f5c9STejun Heo attrs->ordered = true; 67238a2b7538STejun Heo ordered_wq_attrs[i] = attrs; 672429c91e99STejun Heo } 672529c91e99STejun Heo 67261da177e4SLinus Torvalds system_wq = alloc_workqueue("events", 0, 0); 67271aabe902SJoonsoo Kim system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0); 67281da177e4SLinus Torvalds system_long_wq = alloc_workqueue("events_long", 0, 0); 67291da177e4SLinus Torvalds system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, 6730636b927eSTejun Heo WQ_MAX_ACTIVE); 67311da177e4SLinus Torvalds system_freezable_wq = alloc_workqueue("events_freezable", 67321da177e4SLinus Torvalds WQ_FREEZABLE, 0); 67330668106cSViresh Kumar system_power_efficient_wq = alloc_workqueue("events_power_efficient", 67340668106cSViresh Kumar WQ_POWER_EFFICIENT, 0); 67358318d6a6SAudra Mitchell system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_pwr_efficient", 67360668106cSViresh Kumar WQ_FREEZABLE | WQ_POWER_EFFICIENT, 67370668106cSViresh Kumar 0); 67381aabe902SJoonsoo Kim BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq || 67390668106cSViresh Kumar !system_unbound_wq || !system_freezable_wq || 67400668106cSViresh Kumar !system_power_efficient_wq || 67410668106cSViresh Kumar !system_freezable_power_efficient_wq); 67423347fa09STejun Heo } 67433347fa09STejun Heo 6744aa6fde93STejun Heo static void __init wq_cpu_intensive_thresh_init(void) 6745aa6fde93STejun Heo { 6746aa6fde93STejun Heo unsigned long thresh; 6747aa6fde93STejun Heo unsigned long bogo; 6748aa6fde93STejun Heo 6749dd64c873SZqiang pwq_release_worker = kthread_create_worker(0, "pool_workqueue_release"); 6750dd64c873SZqiang BUG_ON(IS_ERR(pwq_release_worker)); 6751dd64c873SZqiang 6752aa6fde93STejun Heo /* if the user set it to a specific value, keep it */ 6753aa6fde93STejun Heo if (wq_cpu_intensive_thresh_us != ULONG_MAX) 6754aa6fde93STejun Heo return; 6755aa6fde93STejun Heo 6756aa6fde93STejun Heo /* 6757aa6fde93STejun Heo * The default of 10ms is derived from the fact that most modern (as of 6758aa6fde93STejun Heo * 2023) processors can do a lot in 10ms and that it's just below what 6759aa6fde93STejun Heo * most consider human-perceivable. However, the kernel also runs on a 6760aa6fde93STejun Heo * lot slower CPUs including microcontrollers where the threshold is way 6761aa6fde93STejun Heo * too low. 6762aa6fde93STejun Heo * 6763aa6fde93STejun Heo * Let's scale up the threshold upto 1 second if BogoMips is below 4000. 6764aa6fde93STejun Heo * This is by no means accurate but it doesn't have to be. The mechanism 6765aa6fde93STejun Heo * is still useful even when the threshold is fully scaled up. Also, as 6766aa6fde93STejun Heo * the reports would usually be applicable to everyone, some machines 6767aa6fde93STejun Heo * operating on longer thresholds won't significantly diminish their 6768aa6fde93STejun Heo * usefulness. 6769aa6fde93STejun Heo */ 6770aa6fde93STejun Heo thresh = 10 * USEC_PER_MSEC; 6771aa6fde93STejun Heo 6772aa6fde93STejun Heo /* see init/calibrate.c for lpj -> BogoMIPS calculation */ 6773aa6fde93STejun Heo bogo = max_t(unsigned long, loops_per_jiffy / 500000 * HZ, 1); 6774aa6fde93STejun Heo if (bogo < 4000) 6775aa6fde93STejun Heo thresh = min_t(unsigned long, thresh * 4000 / bogo, USEC_PER_SEC); 6776aa6fde93STejun Heo 6777aa6fde93STejun Heo pr_debug("wq_cpu_intensive_thresh: lpj=%lu BogoMIPS=%lu thresh_us=%lu\n", 6778aa6fde93STejun Heo loops_per_jiffy, bogo, thresh); 6779aa6fde93STejun Heo 6780aa6fde93STejun Heo wq_cpu_intensive_thresh_us = thresh; 6781aa6fde93STejun Heo } 6782aa6fde93STejun Heo 67833347fa09STejun Heo /** 67843347fa09STejun Heo * workqueue_init - bring workqueue subsystem fully online 67853347fa09STejun Heo * 67862930155bSTejun Heo * This is the second step of three-staged workqueue subsystem initialization 67872930155bSTejun Heo * and invoked as soon as kthreads can be created and scheduled. Workqueues have 67882930155bSTejun Heo * been created and work items queued on them, but there are no kworkers 67892930155bSTejun Heo * executing the work items yet. Populate the worker pools with the initial 67902930155bSTejun Heo * workers and enable future kworker creations. 67913347fa09STejun Heo */ 67922333e829SYu Chen void __init workqueue_init(void) 67933347fa09STejun Heo { 67942186d9f9STejun Heo struct workqueue_struct *wq; 67953347fa09STejun Heo struct worker_pool *pool; 67963347fa09STejun Heo int cpu, bkt; 67973347fa09STejun Heo 6798aa6fde93STejun Heo wq_cpu_intensive_thresh_init(); 6799aa6fde93STejun Heo 68002186d9f9STejun Heo mutex_lock(&wq_pool_mutex); 68012186d9f9STejun Heo 68022930155bSTejun Heo /* 68032930155bSTejun Heo * Per-cpu pools created earlier could be missing node hint. Fix them 68042930155bSTejun Heo * up. Also, create a rescuer for workqueues that requested it. 68052930155bSTejun Heo */ 68062186d9f9STejun Heo for_each_possible_cpu(cpu) { 68072186d9f9STejun Heo for_each_cpu_worker_pool(pool, cpu) { 68082186d9f9STejun Heo pool->node = cpu_to_node(cpu); 68092186d9f9STejun Heo } 68102186d9f9STejun Heo } 68112186d9f9STejun Heo 681240c17f75STejun Heo list_for_each_entry(wq, &workqueues, list) { 681340c17f75STejun Heo WARN(init_rescuer(wq), 681440c17f75STejun Heo "workqueue: failed to create early rescuer for %s", 681540c17f75STejun Heo wq->name); 681640c17f75STejun Heo } 68172186d9f9STejun Heo 68182186d9f9STejun Heo mutex_unlock(&wq_pool_mutex); 68192186d9f9STejun Heo 68203347fa09STejun Heo /* create the initial workers */ 68213347fa09STejun Heo for_each_online_cpu(cpu) { 68223347fa09STejun Heo for_each_cpu_worker_pool(pool, cpu) { 68233347fa09STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 68243347fa09STejun Heo BUG_ON(!create_worker(pool)); 68253347fa09STejun Heo } 68263347fa09STejun Heo } 68273347fa09STejun Heo 68283347fa09STejun Heo hash_for_each(unbound_pool_hash, bkt, pool, hash_node) 68293347fa09STejun Heo BUG_ON(!create_worker(pool)); 68303347fa09STejun Heo 68313347fa09STejun Heo wq_online = true; 683282607adcSTejun Heo wq_watchdog_init(); 68331da177e4SLinus Torvalds } 6834c4f135d6STetsuo Handa 6835025e1684STejun Heo /* 6836025e1684STejun Heo * Initialize @pt by first initializing @pt->cpu_pod[] with pod IDs according to 6837025e1684STejun Heo * @cpu_shares_pod(). Each subset of CPUs that share a pod is assigned a unique 6838025e1684STejun Heo * and consecutive pod ID. The rest of @pt is initialized accordingly. 6839025e1684STejun Heo */ 6840025e1684STejun Heo static void __init init_pod_type(struct wq_pod_type *pt, 6841025e1684STejun Heo bool (*cpus_share_pod)(int, int)) 6842025e1684STejun Heo { 6843025e1684STejun Heo int cur, pre, cpu, pod; 6844025e1684STejun Heo 6845025e1684STejun Heo pt->nr_pods = 0; 6846025e1684STejun Heo 6847025e1684STejun Heo /* init @pt->cpu_pod[] according to @cpus_share_pod() */ 6848025e1684STejun Heo pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL); 6849025e1684STejun Heo BUG_ON(!pt->cpu_pod); 6850025e1684STejun Heo 6851025e1684STejun Heo for_each_possible_cpu(cur) { 6852025e1684STejun Heo for_each_possible_cpu(pre) { 6853025e1684STejun Heo if (pre >= cur) { 6854025e1684STejun Heo pt->cpu_pod[cur] = pt->nr_pods++; 6855025e1684STejun Heo break; 6856025e1684STejun Heo } 6857025e1684STejun Heo if (cpus_share_pod(cur, pre)) { 6858025e1684STejun Heo pt->cpu_pod[cur] = pt->cpu_pod[pre]; 6859025e1684STejun Heo break; 6860025e1684STejun Heo } 6861025e1684STejun Heo } 6862025e1684STejun Heo } 6863025e1684STejun Heo 6864025e1684STejun Heo /* init the rest to match @pt->cpu_pod[] */ 6865025e1684STejun Heo pt->pod_cpus = kcalloc(pt->nr_pods, sizeof(pt->pod_cpus[0]), GFP_KERNEL); 6866025e1684STejun Heo pt->pod_node = kcalloc(pt->nr_pods, sizeof(pt->pod_node[0]), GFP_KERNEL); 6867025e1684STejun Heo BUG_ON(!pt->pod_cpus || !pt->pod_node); 6868025e1684STejun Heo 6869025e1684STejun Heo for (pod = 0; pod < pt->nr_pods; pod++) 6870025e1684STejun Heo BUG_ON(!zalloc_cpumask_var(&pt->pod_cpus[pod], GFP_KERNEL)); 6871025e1684STejun Heo 6872025e1684STejun Heo for_each_possible_cpu(cpu) { 6873025e1684STejun Heo cpumask_set_cpu(cpu, pt->pod_cpus[pt->cpu_pod[cpu]]); 6874025e1684STejun Heo pt->pod_node[pt->cpu_pod[cpu]] = cpu_to_node(cpu); 6875025e1684STejun Heo } 6876025e1684STejun Heo } 6877025e1684STejun Heo 687863c5484eSTejun Heo static bool __init cpus_dont_share(int cpu0, int cpu1) 687963c5484eSTejun Heo { 688063c5484eSTejun Heo return false; 688163c5484eSTejun Heo } 688263c5484eSTejun Heo 688363c5484eSTejun Heo static bool __init cpus_share_smt(int cpu0, int cpu1) 688463c5484eSTejun Heo { 688563c5484eSTejun Heo #ifdef CONFIG_SCHED_SMT 688663c5484eSTejun Heo return cpumask_test_cpu(cpu0, cpu_smt_mask(cpu1)); 688763c5484eSTejun Heo #else 688863c5484eSTejun Heo return false; 688963c5484eSTejun Heo #endif 689063c5484eSTejun Heo } 689163c5484eSTejun Heo 6892025e1684STejun Heo static bool __init cpus_share_numa(int cpu0, int cpu1) 6893025e1684STejun Heo { 6894025e1684STejun Heo return cpu_to_node(cpu0) == cpu_to_node(cpu1); 6895025e1684STejun Heo } 6896025e1684STejun Heo 68972930155bSTejun Heo /** 68982930155bSTejun Heo * workqueue_init_topology - initialize CPU pods for unbound workqueues 68992930155bSTejun Heo * 69002930155bSTejun Heo * This is the third step of there-staged workqueue subsystem initialization and 69012930155bSTejun Heo * invoked after SMP and topology information are fully initialized. It 69022930155bSTejun Heo * initializes the unbound CPU pods accordingly. 69032930155bSTejun Heo */ 69042930155bSTejun Heo void __init workqueue_init_topology(void) 6905a86feae6STejun Heo { 69062930155bSTejun Heo struct workqueue_struct *wq; 6907025e1684STejun Heo int cpu; 6908a86feae6STejun Heo 690963c5484eSTejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_CPU], cpus_dont_share); 691063c5484eSTejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_SMT], cpus_share_smt); 691163c5484eSTejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_CACHE], cpus_share_cache); 6912025e1684STejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_NUMA], cpus_share_numa); 6913a86feae6STejun Heo 69142930155bSTejun Heo mutex_lock(&wq_pool_mutex); 6915a86feae6STejun Heo 6916a86feae6STejun Heo /* 69172930155bSTejun Heo * Workqueues allocated earlier would have all CPUs sharing the default 69182930155bSTejun Heo * worker pool. Explicitly call wq_update_pod() on all workqueue and CPU 69192930155bSTejun Heo * combinations to apply per-pod sharing. 69202930155bSTejun Heo */ 69212930155bSTejun Heo list_for_each_entry(wq, &workqueues, list) { 69222930155bSTejun Heo for_each_online_cpu(cpu) { 69232930155bSTejun Heo wq_update_pod(wq, cpu, cpu, true); 69242930155bSTejun Heo } 69252930155bSTejun Heo } 69262930155bSTejun Heo 69272930155bSTejun Heo mutex_unlock(&wq_pool_mutex); 6928a86feae6STejun Heo } 6929a86feae6STejun Heo 693020bdedafSTetsuo Handa void __warn_flushing_systemwide_wq(void) 693120bdedafSTetsuo Handa { 693220bdedafSTetsuo Handa pr_warn("WARNING: Flushing system-wide workqueues will be prohibited in near future.\n"); 693320bdedafSTetsuo Handa dump_stack(); 693420bdedafSTetsuo Handa } 6935c4f135d6STetsuo Handa EXPORT_SYMBOL(__warn_flushing_systemwide_wq); 6936ace3c549Stiozhang 6937ace3c549Stiozhang static int __init workqueue_unbound_cpus_setup(char *str) 6938ace3c549Stiozhang { 6939ace3c549Stiozhang if (cpulist_parse(str, &wq_cmdline_cpumask) < 0) { 6940ace3c549Stiozhang cpumask_clear(&wq_cmdline_cpumask); 6941ace3c549Stiozhang pr_warn("workqueue.unbound_cpus: incorrect CPU range, using default\n"); 6942ace3c549Stiozhang } 6943ace3c549Stiozhang 6944ace3c549Stiozhang return 1; 6945ace3c549Stiozhang } 6946ace3c549Stiozhang __setup("workqueue.unbound_cpus=", workqueue_unbound_cpus_setup); 6947