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> 324cb1ef64STejun Heo #include <linux/interrupt.h> 331da177e4SLinus Torvalds #include <linux/signal.h> 341da177e4SLinus Torvalds #include <linux/completion.h> 351da177e4SLinus Torvalds #include <linux/workqueue.h> 361da177e4SLinus Torvalds #include <linux/slab.h> 371da177e4SLinus Torvalds #include <linux/cpu.h> 381da177e4SLinus Torvalds #include <linux/notifier.h> 391da177e4SLinus Torvalds #include <linux/kthread.h> 401fa44ecaSJames Bottomley #include <linux/hardirq.h> 4146934023SChristoph Lameter #include <linux/mempolicy.h> 42341a5958SRafael J. Wysocki #include <linux/freezer.h> 43d5abe669SPeter Zijlstra #include <linux/debug_locks.h> 444e6045f1SJohannes Berg #include <linux/lockdep.h> 45c34056a3STejun Heo #include <linux/idr.h> 4629c91e99STejun Heo #include <linux/jhash.h> 4742f8570fSSasha Levin #include <linux/hashtable.h> 4876af4d93STejun Heo #include <linux/rculist.h> 49bce90380STejun Heo #include <linux/nodemask.h> 504c16bd32STejun Heo #include <linux/moduleparam.h> 513d1cb205STejun Heo #include <linux/uaccess.h> 52c98a9805STal Shorer #include <linux/sched/isolation.h> 53cd2440d6SPetr Mladek #include <linux/sched/debug.h> 5462635ea8SSergey Senozhatsky #include <linux/nmi.h> 55940d71c6SSergey Senozhatsky #include <linux/kvm_para.h> 56aa6fde93STejun Heo #include <linux/delay.h> 572f34d733STejun Heo #include <linux/irq_work.h> 58e22bee78STejun Heo 59ea138446STejun Heo #include "workqueue_internal.h" 601da177e4SLinus Torvalds 61e563d0a7STejun Heo enum worker_pool_flags { 62bc2ae0f5STejun Heo /* 6324647570STejun Heo * worker_pool flags 64bc2ae0f5STejun Heo * 6524647570STejun Heo * A bound pool is either associated or disassociated with its CPU. 66bc2ae0f5STejun Heo * While associated (!DISASSOCIATED), all workers are bound to the 67bc2ae0f5STejun Heo * CPU and none has %WORKER_UNBOUND set and concurrency management 68bc2ae0f5STejun Heo * is in effect. 69bc2ae0f5STejun Heo * 70bc2ae0f5STejun Heo * While DISASSOCIATED, the cpu may be offline and all workers have 71bc2ae0f5STejun Heo * %WORKER_UNBOUND set and concurrency management disabled, and may 7224647570STejun Heo * be executing on any CPU. The pool behaves as an unbound one. 73bc2ae0f5STejun Heo * 74bc3a1afcSTejun Heo * Note that DISASSOCIATED should be flipped only while holding 751258fae7STejun Heo * wq_pool_attach_mutex to avoid changing binding state while 764736cbf7SLai Jiangshan * worker_attach_to_pool() is in progress. 774cb1ef64STejun Heo * 784cb1ef64STejun Heo * As there can only be one concurrent BH execution context per CPU, a 794cb1ef64STejun Heo * BH pool is per-CPU and always DISASSOCIATED. 80bc2ae0f5STejun Heo */ 814cb1ef64STejun Heo POOL_BH = 1 << 0, /* is a BH pool */ 824cb1ef64STejun Heo POOL_MANAGER_ACTIVE = 1 << 1, /* being managed */ 8324647570STejun Heo POOL_DISASSOCIATED = 1 << 2, /* cpu can't serve workers */ 841acd92d9STejun Heo POOL_BH_DRAINING = 1 << 3, /* draining after CPU offline */ 85e563d0a7STejun Heo }; 86db7bccf4STejun Heo 87e563d0a7STejun Heo enum worker_flags { 88c8e55f36STejun Heo /* worker flags */ 89c8e55f36STejun Heo WORKER_DIE = 1 << 1, /* die die die */ 90c8e55f36STejun Heo WORKER_IDLE = 1 << 2, /* is idle */ 91e22bee78STejun Heo WORKER_PREP = 1 << 3, /* preparing to run works */ 92fb0e7bebSTejun Heo WORKER_CPU_INTENSIVE = 1 << 6, /* cpu intensive */ 93f3421797STejun Heo WORKER_UNBOUND = 1 << 7, /* worker is unbound */ 94a9ab775bSTejun Heo WORKER_REBOUND = 1 << 8, /* worker was rebound */ 95e22bee78STejun Heo 96a9ab775bSTejun Heo WORKER_NOT_RUNNING = WORKER_PREP | WORKER_CPU_INTENSIVE | 97a9ab775bSTejun Heo WORKER_UNBOUND | WORKER_REBOUND, 98e563d0a7STejun Heo }; 99db7bccf4STejun Heo 100c5f5b942STejun Heo enum work_cancel_flags { 101c5f5b942STejun Heo WORK_CANCEL_DELAYED = 1 << 0, /* canceling a delayed_work */ 10286898fa6STejun Heo WORK_CANCEL_DISABLE = 1 << 1, /* canceling to disable */ 103c5f5b942STejun Heo }; 104c5f5b942STejun Heo 105e563d0a7STejun Heo enum wq_internal_consts { 106e34cdddbSTejun Heo NR_STD_WORKER_POOLS = 2, /* # standard pools per cpu */ 1074ce62e9eSTejun Heo 10829c91e99STejun Heo UNBOUND_POOL_HASH_ORDER = 6, /* hashed by pool->attrs */ 109c8e55f36STejun Heo BUSY_WORKER_HASH_ORDER = 6, /* 64 pointers */ 110db7bccf4STejun Heo 111e22bee78STejun Heo MAX_IDLE_WORKERS_RATIO = 4, /* 1/4 of busy can be idle */ 112e22bee78STejun Heo IDLE_WORKER_TIMEOUT = 300 * HZ, /* keep idle ones for 5 mins */ 113e22bee78STejun Heo 1143233cdbdSTejun Heo MAYDAY_INITIAL_TIMEOUT = HZ / 100 >= 2 ? HZ / 100 : 2, 1153233cdbdSTejun Heo /* call for help after 10ms 1163233cdbdSTejun Heo (min two ticks) */ 117e22bee78STejun Heo MAYDAY_INTERVAL = HZ / 10, /* and then every 100ms */ 118e22bee78STejun Heo CREATE_COOLDOWN = HZ, /* time to breath after fail */ 1191da177e4SLinus Torvalds 1201da177e4SLinus Torvalds /* 121e22bee78STejun Heo * Rescue workers are used only on emergencies and shared by 1228698a745SDongsheng Yang * all cpus. Give MIN_NICE. 123e22bee78STejun Heo */ 1248698a745SDongsheng Yang RESCUER_NICE_LEVEL = MIN_NICE, 1258698a745SDongsheng Yang HIGHPRI_NICE_LEVEL = MIN_NICE, 126ecf6881fSTejun Heo 12731c89007SAudra Mitchell WQ_NAME_LEN = 32, 128c8e55f36STejun Heo }; 129c8e55f36STejun Heo 1301da177e4SLinus Torvalds /* 1314cb1ef64STejun Heo * We don't want to trap softirq for too long. See MAX_SOFTIRQ_TIME and 1324cb1ef64STejun Heo * MAX_SOFTIRQ_RESTART in kernel/softirq.c. These are macros because 1334cb1ef64STejun Heo * msecs_to_jiffies() can't be an initializer. 1344cb1ef64STejun Heo */ 1354cb1ef64STejun Heo #define BH_WORKER_JIFFIES msecs_to_jiffies(2) 1364cb1ef64STejun Heo #define BH_WORKER_RESTARTS 10 1374cb1ef64STejun Heo 1384cb1ef64STejun Heo /* 1394690c4abSTejun Heo * Structure fields follow one of the following exclusion rules. 1404690c4abSTejun Heo * 141e41e704bSTejun Heo * I: Modifiable by initialization/destruction paths and read-only for 142e41e704bSTejun Heo * everyone else. 1434690c4abSTejun Heo * 144e22bee78STejun Heo * P: Preemption protected. Disabling preemption is enough and should 145e22bee78STejun Heo * only be modified and accessed from the local cpu. 146e22bee78STejun Heo * 147d565ed63STejun Heo * L: pool->lock protected. Access with pool->lock held. 1484690c4abSTejun Heo * 1495797b1c1STejun Heo * LN: pool->lock and wq_node_nr_active->lock protected for writes. Either for 1505797b1c1STejun Heo * reads. 1515797b1c1STejun Heo * 152bdf8b9bfSTejun Heo * K: Only modified by worker while holding pool->lock. Can be safely read by 153bdf8b9bfSTejun Heo * self, while holding pool->lock or from IRQ context if %current is the 154bdf8b9bfSTejun Heo * kworker. 155bdf8b9bfSTejun Heo * 156bdf8b9bfSTejun Heo * S: Only modified by worker self. 157bdf8b9bfSTejun Heo * 1581258fae7STejun Heo * A: wq_pool_attach_mutex protected. 159822d8405STejun Heo * 16068e13a67SLai Jiangshan * PL: wq_pool_mutex protected. 16176af4d93STejun Heo * 16224acfb71SThomas Gleixner * PR: wq_pool_mutex protected for writes. RCU protected for reads. 1635bcab335STejun Heo * 1645b95e1afSLai Jiangshan * PW: wq_pool_mutex and wq->mutex protected for writes. Either for reads. 1655b95e1afSLai Jiangshan * 1665b95e1afSLai Jiangshan * PWR: wq_pool_mutex and wq->mutex protected for writes. Either or 16724acfb71SThomas Gleixner * RCU for reads. 1685b95e1afSLai Jiangshan * 1693c25a55dSLai Jiangshan * WQ: wq->mutex protected. 1703c25a55dSLai Jiangshan * 17124acfb71SThomas Gleixner * WR: wq->mutex protected for writes. RCU protected for reads. 1722e109a28STejun Heo * 173a045a272STejun Heo * WO: wq->mutex protected for writes. Updated with WRITE_ONCE() and can be read 174a045a272STejun Heo * with READ_ONCE() without locking. 175a045a272STejun Heo * 1762e109a28STejun Heo * MD: wq_mayday_lock protected. 177cd2440d6SPetr Mladek * 178cd2440d6SPetr Mladek * WD: Used internally by the watchdog. 1794690c4abSTejun Heo */ 1804690c4abSTejun Heo 1812eaebdb3STejun Heo /* struct worker is defined in workqueue_internal.h */ 182c34056a3STejun Heo 183bd7bdd43STejun Heo struct worker_pool { 184a9b8a985SSebastian Andrzej Siewior raw_spinlock_t lock; /* the pool lock */ 185d84ff051STejun Heo int cpu; /* I: the associated cpu */ 186f3f90ad4STejun Heo int node; /* I: the associated node ID */ 1879daf9e67STejun Heo int id; /* I: pool ID */ 188bc8b50c2STejun Heo unsigned int flags; /* L: flags */ 189bd7bdd43STejun Heo 19082607adcSTejun Heo unsigned long watchdog_ts; /* L: watchdog timestamp */ 191cd2440d6SPetr Mladek bool cpu_stall; /* WD: stalled cpu bound pool */ 19282607adcSTejun Heo 193bc35f7efSLai Jiangshan /* 194bc35f7efSLai Jiangshan * The counter is incremented in a process context on the associated CPU 195bc35f7efSLai Jiangshan * w/ preemption disabled, and decremented or reset in the same context 196bc35f7efSLai Jiangshan * but w/ pool->lock held. The readers grab pool->lock and are 197bc35f7efSLai Jiangshan * guaranteed to see if the counter reached zero. 198bc35f7efSLai Jiangshan */ 199bc35f7efSLai Jiangshan int nr_running; 20084f91c62SLai Jiangshan 201bd7bdd43STejun Heo struct list_head worklist; /* L: list of pending works */ 202ea1abd61SLai Jiangshan 2035826cc8fSLai Jiangshan int nr_workers; /* L: total number of workers */ 2045826cc8fSLai Jiangshan int nr_idle; /* L: currently idle workers */ 205bd7bdd43STejun Heo 2062c1f1a91SLai Jiangshan struct list_head idle_list; /* L: list of idle workers */ 207bd7bdd43STejun Heo struct timer_list idle_timer; /* L: worker idle timeout */ 2083f959aa3SValentin Schneider struct work_struct idle_cull_work; /* L: worker idle cleanup */ 2093f959aa3SValentin Schneider 210bd7bdd43STejun Heo struct timer_list mayday_timer; /* L: SOS timer for workers */ 211bd7bdd43STejun Heo 212c5aa87bbSTejun Heo /* a workers is either on busy_hash or idle_list, or the manager */ 213c9e7cf27STejun Heo DECLARE_HASHTABLE(busy_hash, BUSY_WORKER_HASH_ORDER); 214c9e7cf27STejun Heo /* L: hash of busy workers */ 215c9e7cf27STejun Heo 2162607d7a6STejun Heo struct worker *manager; /* L: purely informational */ 21792f9c5c4SLai Jiangshan struct list_head workers; /* A: attached workers */ 218e19e397aSTejun Heo 2197cda9aaeSLai Jiangshan struct ida worker_ida; /* worker IDs for task name */ 220e19e397aSTejun Heo 2217a4e344cSTejun Heo struct workqueue_attrs *attrs; /* I: worker attributes */ 22268e13a67SLai Jiangshan struct hlist_node hash_node; /* PL: unbound_pool_hash node */ 22368e13a67SLai Jiangshan int refcnt; /* PL: refcnt for unbound pools */ 2247a4e344cSTejun Heo 225e19e397aSTejun Heo /* 22624acfb71SThomas Gleixner * Destruction of pool is RCU protected to allow dereferences 22729c91e99STejun Heo * from get_work_pool(). 22829c91e99STejun Heo */ 22929c91e99STejun Heo struct rcu_head rcu; 23084f91c62SLai Jiangshan }; 2318b03ae3cSTejun Heo 2328b03ae3cSTejun Heo /* 233725e8ec5STejun Heo * Per-pool_workqueue statistics. These can be monitored using 234725e8ec5STejun Heo * tools/workqueue/wq_monitor.py. 235725e8ec5STejun Heo */ 236725e8ec5STejun Heo enum pool_workqueue_stats { 237725e8ec5STejun Heo PWQ_STAT_STARTED, /* work items started execution */ 238725e8ec5STejun Heo PWQ_STAT_COMPLETED, /* work items completed execution */ 2398a1dd1e5STejun Heo PWQ_STAT_CPU_TIME, /* total CPU time consumed */ 240616db877STejun Heo PWQ_STAT_CPU_INTENSIVE, /* wq_cpu_intensive_thresh_us violations */ 241725e8ec5STejun Heo PWQ_STAT_CM_WAKEUP, /* concurrency-management worker wakeups */ 2428639ecebSTejun Heo PWQ_STAT_REPATRIATED, /* unbound workers brought back into scope */ 243725e8ec5STejun Heo PWQ_STAT_MAYDAY, /* maydays to rescuer */ 244725e8ec5STejun Heo PWQ_STAT_RESCUED, /* linked work items executed by rescuer */ 245725e8ec5STejun Heo 246725e8ec5STejun Heo PWQ_NR_STATS, 247725e8ec5STejun Heo }; 248725e8ec5STejun Heo 249725e8ec5STejun Heo /* 250e9a8e01fSTejun Heo * The per-pool workqueue. While queued, bits below WORK_PWQ_SHIFT 251112202d9STejun Heo * of work_struct->data are used for flags and the remaining high bits 252112202d9STejun Heo * point to the pwq; thus, pwqs need to be aligned at two's power of the 253112202d9STejun Heo * number of flag bits. 2541da177e4SLinus Torvalds */ 255112202d9STejun Heo struct pool_workqueue { 256bd7bdd43STejun Heo struct worker_pool *pool; /* I: the associated pool */ 2574690c4abSTejun Heo struct workqueue_struct *wq; /* I: the owning workqueue */ 25873f53c4aSTejun Heo int work_color; /* L: current color */ 25973f53c4aSTejun Heo int flush_color; /* L: flushing color */ 2608864b4e5STejun Heo int refcnt; /* L: reference count */ 26173f53c4aSTejun Heo int nr_in_flight[WORK_NR_COLORS]; 26273f53c4aSTejun Heo /* L: nr of in_flight works */ 2634c065dbcSWaiman Long bool plugged; /* L: execution suspended */ 264018f3a13SLai Jiangshan 265018f3a13SLai Jiangshan /* 266018f3a13SLai Jiangshan * nr_active management and WORK_STRUCT_INACTIVE: 267018f3a13SLai Jiangshan * 268018f3a13SLai Jiangshan * When pwq->nr_active >= max_active, new work item is queued to 269018f3a13SLai Jiangshan * pwq->inactive_works instead of pool->worklist and marked with 270018f3a13SLai Jiangshan * WORK_STRUCT_INACTIVE. 271018f3a13SLai Jiangshan * 2725797b1c1STejun Heo * All work items marked with WORK_STRUCT_INACTIVE do not participate in 2735797b1c1STejun Heo * nr_active and all work items in pwq->inactive_works are marked with 2745797b1c1STejun Heo * WORK_STRUCT_INACTIVE. But not all WORK_STRUCT_INACTIVE work items are 2755797b1c1STejun Heo * in pwq->inactive_works. Some of them are ready to run in 2765797b1c1STejun Heo * pool->worklist or worker->scheduled. Those work itmes are only struct 2775797b1c1STejun Heo * wq_barrier which is used for flush_work() and should not participate 2785797b1c1STejun Heo * in nr_active. For non-barrier work item, it is marked with 2795797b1c1STejun Heo * WORK_STRUCT_INACTIVE iff it is in pwq->inactive_works. 280018f3a13SLai Jiangshan */ 2811e19ffc6STejun Heo int nr_active; /* L: nr of active works */ 282f97a4a1aSLai Jiangshan struct list_head inactive_works; /* L: inactive works */ 2835797b1c1STejun Heo struct list_head pending_node; /* LN: node on wq_node_nr_active->pending_pwqs */ 2843c25a55dSLai Jiangshan struct list_head pwqs_node; /* WR: node on wq->pwqs */ 2852e109a28STejun Heo struct list_head mayday_node; /* MD: node on wq->maydays */ 2868864b4e5STejun Heo 287725e8ec5STejun Heo u64 stats[PWQ_NR_STATS]; 288725e8ec5STejun Heo 2898864b4e5STejun Heo /* 290967b494eSTejun Heo * Release of unbound pwq is punted to a kthread_worker. See put_pwq() 291687a9aa5STejun Heo * and pwq_release_workfn() for details. pool_workqueue itself is also 292687a9aa5STejun Heo * RCU protected so that the first pwq can be determined without 293967b494eSTejun Heo * grabbing wq->mutex. 2948864b4e5STejun Heo */ 295687a9aa5STejun Heo struct kthread_work release_work; 2968864b4e5STejun Heo struct rcu_head rcu; 297e9a8e01fSTejun Heo } __aligned(1 << WORK_STRUCT_PWQ_SHIFT); 2981da177e4SLinus Torvalds 2991da177e4SLinus Torvalds /* 30073f53c4aSTejun Heo * Structure used to wait for workqueue flush. 30173f53c4aSTejun Heo */ 30273f53c4aSTejun Heo struct wq_flusher { 3033c25a55dSLai Jiangshan struct list_head list; /* WQ: list of flushers */ 3043c25a55dSLai Jiangshan int flush_color; /* WQ: flush color waiting for */ 30573f53c4aSTejun Heo struct completion done; /* flush completion */ 30673f53c4aSTejun Heo }; 3071da177e4SLinus Torvalds 308226223abSTejun Heo struct wq_device; 309226223abSTejun Heo 31073f53c4aSTejun Heo /* 31191ccc6e7STejun Heo * Unlike in a per-cpu workqueue where max_active limits its concurrency level 31291ccc6e7STejun Heo * on each CPU, in an unbound workqueue, max_active applies to the whole system. 31391ccc6e7STejun Heo * As sharing a single nr_active across multiple sockets can be very expensive, 31491ccc6e7STejun Heo * the counting and enforcement is per NUMA node. 3155797b1c1STejun Heo * 3165797b1c1STejun Heo * The following struct is used to enforce per-node max_active. When a pwq wants 3175797b1c1STejun Heo * to start executing a work item, it should increment ->nr using 3185797b1c1STejun Heo * tryinc_node_nr_active(). If acquisition fails due to ->nr already being over 3195797b1c1STejun Heo * ->max, the pwq is queued on ->pending_pwqs. As in-flight work items finish 3205797b1c1STejun Heo * and decrement ->nr, node_activate_pending_pwq() activates the pending pwqs in 3215797b1c1STejun Heo * round-robin order. 32291ccc6e7STejun Heo */ 32391ccc6e7STejun Heo struct wq_node_nr_active { 3245797b1c1STejun Heo int max; /* per-node max_active */ 3255797b1c1STejun Heo atomic_t nr; /* per-node nr_active */ 3265797b1c1STejun Heo raw_spinlock_t lock; /* nests inside pool locks */ 3275797b1c1STejun Heo struct list_head pending_pwqs; /* LN: pwqs with inactive works */ 32891ccc6e7STejun Heo }; 32991ccc6e7STejun Heo 33091ccc6e7STejun Heo /* 331c5aa87bbSTejun Heo * The externally visible workqueue. It relays the issued work items to 332c5aa87bbSTejun Heo * the appropriate worker_pool through its pool_workqueues. 3331da177e4SLinus Torvalds */ 3341da177e4SLinus Torvalds struct workqueue_struct { 3353c25a55dSLai Jiangshan struct list_head pwqs; /* WR: all pwqs of this wq */ 336e2dca7adSTejun Heo struct list_head list; /* PR: list of all workqueues */ 33773f53c4aSTejun Heo 3383c25a55dSLai Jiangshan struct mutex mutex; /* protects this wq */ 3393c25a55dSLai Jiangshan int work_color; /* WQ: current work color */ 3403c25a55dSLai Jiangshan int flush_color; /* WQ: current flush color */ 341112202d9STejun Heo atomic_t nr_pwqs_to_flush; /* flush in progress */ 3423c25a55dSLai Jiangshan struct wq_flusher *first_flusher; /* WQ: first flusher */ 3433c25a55dSLai Jiangshan struct list_head flusher_queue; /* WQ: flush waiters */ 3443c25a55dSLai Jiangshan struct list_head flusher_overflow; /* WQ: flush overflow list */ 34573f53c4aSTejun Heo 3462e109a28STejun Heo struct list_head maydays; /* MD: pwqs requesting rescue */ 34730ae2fc0STejun Heo struct worker *rescuer; /* MD: rescue worker */ 348e22bee78STejun Heo 34987fc741eSLai Jiangshan int nr_drainers; /* WQ: drain in progress */ 3505797b1c1STejun Heo 3515797b1c1STejun Heo /* See alloc_workqueue() function comment for info on min/max_active */ 352a045a272STejun Heo int max_active; /* WO: max active works */ 3535797b1c1STejun Heo int min_active; /* WO: min active works */ 354a045a272STejun Heo int saved_max_active; /* WQ: saved max_active */ 3555797b1c1STejun Heo int saved_min_active; /* WQ: saved min_active */ 356226223abSTejun Heo 3575b95e1afSLai Jiangshan struct workqueue_attrs *unbound_attrs; /* PW: only for unbound wqs */ 3589f66cff2STejun Heo struct pool_workqueue __rcu *dfl_pwq; /* PW: only for unbound wqs */ 3596029a918STejun Heo 360226223abSTejun Heo #ifdef CONFIG_SYSFS 361226223abSTejun Heo struct wq_device *wq_dev; /* I: for sysfs interface */ 362226223abSTejun Heo #endif 3634e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 364669de8bdSBart Van Assche char *lock_name; 365669de8bdSBart Van Assche struct lock_class_key key; 3664e6045f1SJohannes Berg struct lockdep_map lockdep_map; 3674e6045f1SJohannes Berg #endif 368ecf6881fSTejun Heo char name[WQ_NAME_LEN]; /* I: workqueue name */ 3692728fd2fSTejun Heo 370e2dca7adSTejun Heo /* 37124acfb71SThomas Gleixner * Destruction of workqueue_struct is RCU protected to allow walking 37224acfb71SThomas Gleixner * the workqueues list without grabbing wq_pool_mutex. 373e2dca7adSTejun Heo * This is used to dump all workqueues from sysrq. 374e2dca7adSTejun Heo */ 375e2dca7adSTejun Heo struct rcu_head rcu; 376e2dca7adSTejun Heo 3772728fd2fSTejun Heo /* hot fields used during command issue, aligned to cacheline */ 3782728fd2fSTejun Heo unsigned int flags ____cacheline_aligned; /* WQ: WQ_* flags */ 379636b927eSTejun Heo struct pool_workqueue __percpu __rcu **cpu_pwq; /* I: per-cpu pwqs */ 38091ccc6e7STejun Heo struct wq_node_nr_active *node_nr_active[]; /* I: per-node nr_active */ 3811da177e4SLinus Torvalds }; 3821da177e4SLinus Torvalds 38384193c07STejun Heo /* 38484193c07STejun Heo * Each pod type describes how CPUs should be grouped for unbound workqueues. 38584193c07STejun Heo * See the comment above workqueue_attrs->affn_scope. 38684193c07STejun Heo */ 38784193c07STejun Heo struct wq_pod_type { 38884193c07STejun Heo int nr_pods; /* number of pods */ 38984193c07STejun Heo cpumask_var_t *pod_cpus; /* pod -> cpus */ 39084193c07STejun Heo int *pod_node; /* pod -> node */ 39184193c07STejun Heo int *cpu_pod; /* cpu -> pod */ 39284193c07STejun Heo }; 39384193c07STejun Heo 3941211f3b2STejun Heo struct work_offq_data { 3951211f3b2STejun Heo u32 pool_id; 39686898fa6STejun Heo u32 disable; 3971211f3b2STejun Heo u32 flags; 3981211f3b2STejun Heo }; 3991211f3b2STejun Heo 40063c5484eSTejun Heo static const char *wq_affn_names[WQ_AFFN_NR_TYPES] = { 401523a301eSTejun Heo [WQ_AFFN_DFL] = "default", 40263c5484eSTejun Heo [WQ_AFFN_CPU] = "cpu", 40363c5484eSTejun Heo [WQ_AFFN_SMT] = "smt", 40463c5484eSTejun Heo [WQ_AFFN_CACHE] = "cache", 40563c5484eSTejun Heo [WQ_AFFN_NUMA] = "numa", 40663c5484eSTejun Heo [WQ_AFFN_SYSTEM] = "system", 40763c5484eSTejun Heo }; 408bce90380STejun Heo 409616db877STejun Heo /* 410616db877STejun Heo * Per-cpu work items which run for longer than the following threshold are 411616db877STejun Heo * automatically considered CPU intensive and excluded from concurrency 412616db877STejun Heo * management to prevent them from noticeably delaying other per-cpu work items. 413aa6fde93STejun Heo * ULONG_MAX indicates that the user hasn't overridden it with a boot parameter. 414aa6fde93STejun Heo * The actual value is initialized in wq_cpu_intensive_thresh_init(). 415616db877STejun Heo */ 416aa6fde93STejun Heo static unsigned long wq_cpu_intensive_thresh_us = ULONG_MAX; 417616db877STejun Heo module_param_named(cpu_intensive_thresh_us, wq_cpu_intensive_thresh_us, ulong, 0644); 418ccdec921SXuewen Yan #ifdef CONFIG_WQ_CPU_INTENSIVE_REPORT 419ccdec921SXuewen Yan static unsigned int wq_cpu_intensive_warning_thresh = 4; 420ccdec921SXuewen Yan module_param_named(cpu_intensive_warning_thresh, wq_cpu_intensive_warning_thresh, uint, 0644); 421ccdec921SXuewen Yan #endif 422616db877STejun Heo 423cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */ 424552f530cSLuis R. Rodriguez static bool wq_power_efficient = IS_ENABLED(CONFIG_WQ_POWER_EFFICIENT_DEFAULT); 425cee22a15SViresh Kumar module_param_named(power_efficient, wq_power_efficient, bool, 0444); 426cee22a15SViresh Kumar 427863b710bSTejun Heo static bool wq_online; /* can kworkers be created yet? */ 428c7a40c49STejun Heo static bool wq_topo_initialized __read_mostly = false; 429c7a40c49STejun Heo 430c7a40c49STejun Heo static struct kmem_cache *pwq_cache; 431c7a40c49STejun Heo 432c7a40c49STejun Heo static struct wq_pod_type wq_pod_types[WQ_AFFN_NR_TYPES]; 433c7a40c49STejun Heo static enum wq_affn_scope wq_affn_dfl = WQ_AFFN_CACHE; 4343347fa09STejun Heo 435fef59c9cSTejun Heo /* buf for wq_update_unbound_pod_attrs(), protected by CPU hotplug exclusion */ 436b2b1f933SLai Jiangshan static struct workqueue_attrs *unbound_wq_update_pwq_attrs_buf; 4374c16bd32STejun Heo 43868e13a67SLai Jiangshan static DEFINE_MUTEX(wq_pool_mutex); /* protects pools and workqueues list */ 4391258fae7STejun Heo static DEFINE_MUTEX(wq_pool_attach_mutex); /* protects worker attach/detach */ 440a9b8a985SSebastian Andrzej Siewior static DEFINE_RAW_SPINLOCK(wq_mayday_lock); /* protects wq->maydays list */ 441d8bb65abSSebastian Andrzej Siewior /* wait for manager to go away */ 442d8bb65abSSebastian Andrzej Siewior static struct rcuwait manager_wait = __RCUWAIT_INITIALIZER(manager_wait); 4435bcab335STejun Heo 444e2dca7adSTejun Heo static LIST_HEAD(workqueues); /* PR: list of all workqueues */ 44568e13a67SLai Jiangshan static bool workqueue_freezing; /* PL: have wqs started freezing? */ 4467d19c5ceSTejun Heo 4478d84baf7SLai Jiangshan /* PL: mirror the cpu_online_mask excluding the CPU in the midst of hotplugging */ 4488d84baf7SLai Jiangshan static cpumask_var_t wq_online_cpumask; 4498d84baf7SLai Jiangshan 45099c621efSLai Jiangshan /* PL&A: allowable cpus for unbound wqs and work items */ 451ef557180SMike Galbraith static cpumask_var_t wq_unbound_cpumask; 452ef557180SMike Galbraith 453fe28f631SWaiman Long /* PL: user requested unbound cpumask via sysfs */ 454fe28f631SWaiman Long static cpumask_var_t wq_requested_unbound_cpumask; 455fe28f631SWaiman Long 456fe28f631SWaiman Long /* PL: isolated cpumask to be excluded from unbound cpumask */ 457fe28f631SWaiman Long static cpumask_var_t wq_isolated_cpumask; 458fe28f631SWaiman Long 459ace3c549Stiozhang /* for further constrain wq_unbound_cpumask by cmdline parameter*/ 460ace3c549Stiozhang static struct cpumask wq_cmdline_cpumask __initdata; 461ace3c549Stiozhang 462ef557180SMike Galbraith /* CPU where unbound work was last round robin scheduled from this CPU */ 463ef557180SMike Galbraith static DEFINE_PER_CPU(int, wq_rr_cpu_last); 464b05a7928SFrederic Weisbecker 465f303fccbSTejun Heo /* 466f303fccbSTejun Heo * Local execution of unbound work items is no longer guaranteed. The 467f303fccbSTejun Heo * following always forces round-robin CPU selection on unbound work items 468f303fccbSTejun Heo * to uncover usages which depend on it. 469f303fccbSTejun Heo */ 470f303fccbSTejun Heo #ifdef CONFIG_DEBUG_WQ_FORCE_RR_CPU 471f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = true; 472f303fccbSTejun Heo #else 473f303fccbSTejun Heo static bool wq_debug_force_rr_cpu = false; 474f303fccbSTejun Heo #endif 475f303fccbSTejun Heo module_param_named(debug_force_rr_cpu, wq_debug_force_rr_cpu, bool, 0644); 476f303fccbSTejun Heo 4772f34d733STejun Heo /* to raise softirq for the BH worker pools on other CPUs */ 4782f34d733STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct irq_work [NR_STD_WORKER_POOLS], 4792f34d733STejun Heo bh_pool_irq_works); 4802f34d733STejun Heo 4814cb1ef64STejun Heo /* the BH worker pools */ 4824cb1ef64STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], 4834cb1ef64STejun Heo bh_worker_pools); 4844cb1ef64STejun Heo 4857d19c5ceSTejun Heo /* the per-cpu worker pools */ 4864cb1ef64STejun Heo static DEFINE_PER_CPU_SHARED_ALIGNED(struct worker_pool [NR_STD_WORKER_POOLS], 4874cb1ef64STejun Heo cpu_worker_pools); 4887d19c5ceSTejun Heo 48968e13a67SLai Jiangshan static DEFINE_IDR(worker_pool_idr); /* PR: idr of all pools */ 4907d19c5ceSTejun Heo 49168e13a67SLai Jiangshan /* PL: hash of all unbound pools keyed by pool->attrs */ 49229c91e99STejun Heo static DEFINE_HASHTABLE(unbound_pool_hash, UNBOUND_POOL_HASH_ORDER); 49329c91e99STejun Heo 494c5aa87bbSTejun Heo /* I: attributes used when instantiating standard unbound pools on demand */ 49529c91e99STejun Heo static struct workqueue_attrs *unbound_std_wq_attrs[NR_STD_WORKER_POOLS]; 49629c91e99STejun Heo 4978a2b7538STejun Heo /* I: attributes used when instantiating ordered pools on demand */ 4988a2b7538STejun Heo static struct workqueue_attrs *ordered_wq_attrs[NR_STD_WORKER_POOLS]; 4998a2b7538STejun Heo 500967b494eSTejun Heo /* 501967b494eSTejun Heo * I: kthread_worker to release pwq's. pwq release needs to be bounced to a 502967b494eSTejun Heo * process context while holding a pool lock. Bounce to a dedicated kthread 503967b494eSTejun Heo * worker to avoid A-A deadlocks. 504967b494eSTejun Heo */ 50568279f9cSAlexey Dobriyan static struct kthread_worker *pwq_release_worker __ro_after_init; 506967b494eSTejun Heo 50768279f9cSAlexey Dobriyan struct workqueue_struct *system_wq __ro_after_init; 508ad7b1f84SMarc Dionne EXPORT_SYMBOL(system_wq); 50968279f9cSAlexey Dobriyan struct workqueue_struct *system_highpri_wq __ro_after_init; 5101aabe902SJoonsoo Kim EXPORT_SYMBOL_GPL(system_highpri_wq); 51168279f9cSAlexey Dobriyan struct workqueue_struct *system_long_wq __ro_after_init; 512d320c038STejun Heo EXPORT_SYMBOL_GPL(system_long_wq); 51368279f9cSAlexey Dobriyan struct workqueue_struct *system_unbound_wq __ro_after_init; 514f3421797STejun Heo EXPORT_SYMBOL_GPL(system_unbound_wq); 51568279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_wq __ro_after_init; 51624d51addSTejun Heo EXPORT_SYMBOL_GPL(system_freezable_wq); 51768279f9cSAlexey Dobriyan struct workqueue_struct *system_power_efficient_wq __ro_after_init; 5180668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_power_efficient_wq); 51968279f9cSAlexey Dobriyan struct workqueue_struct *system_freezable_power_efficient_wq __ro_after_init; 5200668106cSViresh Kumar EXPORT_SYMBOL_GPL(system_freezable_power_efficient_wq); 5214cb1ef64STejun Heo struct workqueue_struct *system_bh_wq; 5224cb1ef64STejun Heo EXPORT_SYMBOL_GPL(system_bh_wq); 5234cb1ef64STejun Heo struct workqueue_struct *system_bh_highpri_wq; 5244cb1ef64STejun Heo EXPORT_SYMBOL_GPL(system_bh_highpri_wq); 525d320c038STejun Heo 5267d19c5ceSTejun Heo static int worker_thread(void *__worker); 5276ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq); 528c29eb853STejun Heo static void show_pwq(struct pool_workqueue *pwq); 52955df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool); 5307d19c5ceSTejun Heo 53197bd2347STejun Heo #define CREATE_TRACE_POINTS 53297bd2347STejun Heo #include <trace/events/workqueue.h> 53397bd2347STejun Heo 53468e13a67SLai Jiangshan #define assert_rcu_or_pool_mutex() \ 535d355001fSTejun Heo RCU_LOCKDEP_WARN(!rcu_read_lock_any_held() && \ 536f78f5b90SPaul E. McKenney !lockdep_is_held(&wq_pool_mutex), \ 53724acfb71SThomas Gleixner "RCU or wq_pool_mutex should be held") 5385bcab335STejun Heo 5395b95e1afSLai Jiangshan #define assert_rcu_or_wq_mutex_or_pool_mutex(wq) \ 540d355001fSTejun Heo RCU_LOCKDEP_WARN(!rcu_read_lock_any_held() && \ 541f78f5b90SPaul E. McKenney !lockdep_is_held(&wq->mutex) && \ 542f78f5b90SPaul E. McKenney !lockdep_is_held(&wq_pool_mutex), \ 54324acfb71SThomas Gleixner "RCU, wq->mutex or wq_pool_mutex should be held") 5445b95e1afSLai Jiangshan 5454cb1ef64STejun Heo #define for_each_bh_worker_pool(pool, cpu) \ 5464cb1ef64STejun Heo for ((pool) = &per_cpu(bh_worker_pools, cpu)[0]; \ 5474cb1ef64STejun Heo (pool) < &per_cpu(bh_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \ 5484cb1ef64STejun Heo (pool)++) 5494cb1ef64STejun Heo 550f02ae73aSTejun Heo #define for_each_cpu_worker_pool(pool, cpu) \ 551f02ae73aSTejun Heo for ((pool) = &per_cpu(cpu_worker_pools, cpu)[0]; \ 552f02ae73aSTejun Heo (pool) < &per_cpu(cpu_worker_pools, cpu)[NR_STD_WORKER_POOLS]; \ 5537a62c2c8STejun Heo (pool)++) 5544ce62e9eSTejun Heo 55549e3cf44STejun Heo /** 55617116969STejun Heo * for_each_pool - iterate through all worker_pools in the system 55717116969STejun Heo * @pool: iteration cursor 558611c92a0STejun Heo * @pi: integer used for iteration 559fa1b54e6STejun Heo * 56024acfb71SThomas Gleixner * This must be called either with wq_pool_mutex held or RCU read 56168e13a67SLai Jiangshan * locked. If the pool needs to be used beyond the locking in effect, the 56268e13a67SLai Jiangshan * caller is responsible for guaranteeing that the pool stays online. 563fa1b54e6STejun Heo * 564fa1b54e6STejun Heo * The if/else clause exists only for the lockdep assertion and can be 565fa1b54e6STejun Heo * ignored. 56617116969STejun Heo */ 567611c92a0STejun Heo #define for_each_pool(pool, pi) \ 568611c92a0STejun Heo idr_for_each_entry(&worker_pool_idr, pool, pi) \ 56968e13a67SLai Jiangshan if (({ assert_rcu_or_pool_mutex(); false; })) { } \ 570fa1b54e6STejun Heo else 57117116969STejun Heo 57217116969STejun Heo /** 573822d8405STejun Heo * for_each_pool_worker - iterate through all workers of a worker_pool 574822d8405STejun Heo * @worker: iteration cursor 575822d8405STejun Heo * @pool: worker_pool to iterate workers of 576822d8405STejun Heo * 5771258fae7STejun Heo * This must be called with wq_pool_attach_mutex. 578822d8405STejun Heo * 579822d8405STejun Heo * The if/else clause exists only for the lockdep assertion and can be 580822d8405STejun Heo * ignored. 581822d8405STejun Heo */ 582da028469SLai Jiangshan #define for_each_pool_worker(worker, pool) \ 583da028469SLai Jiangshan list_for_each_entry((worker), &(pool)->workers, node) \ 5841258fae7STejun Heo if (({ lockdep_assert_held(&wq_pool_attach_mutex); false; })) { } \ 585822d8405STejun Heo else 586822d8405STejun Heo 587822d8405STejun Heo /** 58849e3cf44STejun Heo * for_each_pwq - iterate through all pool_workqueues of the specified workqueue 58949e3cf44STejun Heo * @pwq: iteration cursor 59049e3cf44STejun Heo * @wq: the target workqueue 59176af4d93STejun Heo * 59224acfb71SThomas Gleixner * This must be called either with wq->mutex held or RCU read locked. 593794b18bcSTejun Heo * If the pwq needs to be used beyond the locking in effect, the caller is 594794b18bcSTejun Heo * responsible for guaranteeing that the pwq stays online. 59576af4d93STejun Heo * 59676af4d93STejun Heo * The if/else clause exists only for the lockdep assertion and can be 59776af4d93STejun Heo * ignored. 59849e3cf44STejun Heo */ 59949e3cf44STejun Heo #define for_each_pwq(pwq, wq) \ 60049e9d1a9SSebastian Andrzej Siewior list_for_each_entry_rcu((pwq), &(wq)->pwqs, pwqs_node, \ 6015a644662SJoel Fernandes (Google) lockdep_is_held(&(wq->mutex))) 602f3421797STejun Heo 603dc186ad7SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_WORK 604dc186ad7SThomas Gleixner 605f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr; 606dc186ad7SThomas Gleixner 60799777288SStanislaw Gruszka static void *work_debug_hint(void *addr) 60899777288SStanislaw Gruszka { 60999777288SStanislaw Gruszka return ((struct work_struct *) addr)->func; 61099777288SStanislaw Gruszka } 61199777288SStanislaw Gruszka 612b9fdac7fSDu, Changbin static bool work_is_static_object(void *addr) 613b9fdac7fSDu, Changbin { 614b9fdac7fSDu, Changbin struct work_struct *work = addr; 615b9fdac7fSDu, Changbin 616b9fdac7fSDu, Changbin return test_bit(WORK_STRUCT_STATIC_BIT, work_data_bits(work)); 617b9fdac7fSDu, Changbin } 618b9fdac7fSDu, Changbin 619dc186ad7SThomas Gleixner /* 620dc186ad7SThomas Gleixner * fixup_init is called when: 621dc186ad7SThomas Gleixner * - an active object is initialized 622dc186ad7SThomas Gleixner */ 62302a982a6SDu, Changbin static bool work_fixup_init(void *addr, enum debug_obj_state state) 624dc186ad7SThomas Gleixner { 625dc186ad7SThomas Gleixner struct work_struct *work = addr; 626dc186ad7SThomas Gleixner 627dc186ad7SThomas Gleixner switch (state) { 628dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 629dc186ad7SThomas Gleixner cancel_work_sync(work); 630dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 63102a982a6SDu, Changbin return true; 632dc186ad7SThomas Gleixner default: 63302a982a6SDu, Changbin return false; 634dc186ad7SThomas Gleixner } 635dc186ad7SThomas Gleixner } 636dc186ad7SThomas Gleixner 637dc186ad7SThomas Gleixner /* 638dc186ad7SThomas Gleixner * fixup_free is called when: 639dc186ad7SThomas Gleixner * - an active object is freed 640dc186ad7SThomas Gleixner */ 64102a982a6SDu, Changbin static bool work_fixup_free(void *addr, enum debug_obj_state state) 642dc186ad7SThomas Gleixner { 643dc186ad7SThomas Gleixner struct work_struct *work = addr; 644dc186ad7SThomas Gleixner 645dc186ad7SThomas Gleixner switch (state) { 646dc186ad7SThomas Gleixner case ODEBUG_STATE_ACTIVE: 647dc186ad7SThomas Gleixner cancel_work_sync(work); 648dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 64902a982a6SDu, Changbin return true; 650dc186ad7SThomas Gleixner default: 65102a982a6SDu, Changbin return false; 652dc186ad7SThomas Gleixner } 653dc186ad7SThomas Gleixner } 654dc186ad7SThomas Gleixner 655f9e62f31SStephen Boyd static const struct debug_obj_descr work_debug_descr = { 656dc186ad7SThomas Gleixner .name = "work_struct", 65799777288SStanislaw Gruszka .debug_hint = work_debug_hint, 658b9fdac7fSDu, Changbin .is_static_object = work_is_static_object, 659dc186ad7SThomas Gleixner .fixup_init = work_fixup_init, 660dc186ad7SThomas Gleixner .fixup_free = work_fixup_free, 661dc186ad7SThomas Gleixner }; 662dc186ad7SThomas Gleixner 663dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) 664dc186ad7SThomas Gleixner { 665dc186ad7SThomas Gleixner debug_object_activate(work, &work_debug_descr); 666dc186ad7SThomas Gleixner } 667dc186ad7SThomas Gleixner 668dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) 669dc186ad7SThomas Gleixner { 670dc186ad7SThomas Gleixner debug_object_deactivate(work, &work_debug_descr); 671dc186ad7SThomas Gleixner } 672dc186ad7SThomas Gleixner 673dc186ad7SThomas Gleixner void __init_work(struct work_struct *work, int onstack) 674dc186ad7SThomas Gleixner { 675dc186ad7SThomas Gleixner if (onstack) 676dc186ad7SThomas Gleixner debug_object_init_on_stack(work, &work_debug_descr); 677dc186ad7SThomas Gleixner else 678dc186ad7SThomas Gleixner debug_object_init(work, &work_debug_descr); 679dc186ad7SThomas Gleixner } 680dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(__init_work); 681dc186ad7SThomas Gleixner 682dc186ad7SThomas Gleixner void destroy_work_on_stack(struct work_struct *work) 683dc186ad7SThomas Gleixner { 684dc186ad7SThomas Gleixner debug_object_free(work, &work_debug_descr); 685dc186ad7SThomas Gleixner } 686dc186ad7SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_work_on_stack); 687dc186ad7SThomas Gleixner 688ea2e64f2SThomas Gleixner void destroy_delayed_work_on_stack(struct delayed_work *work) 689ea2e64f2SThomas Gleixner { 690ea2e64f2SThomas Gleixner destroy_timer_on_stack(&work->timer); 691ea2e64f2SThomas Gleixner debug_object_free(&work->work, &work_debug_descr); 692ea2e64f2SThomas Gleixner } 693ea2e64f2SThomas Gleixner EXPORT_SYMBOL_GPL(destroy_delayed_work_on_stack); 694ea2e64f2SThomas Gleixner 695dc186ad7SThomas Gleixner #else 696dc186ad7SThomas Gleixner static inline void debug_work_activate(struct work_struct *work) { } 697dc186ad7SThomas Gleixner static inline void debug_work_deactivate(struct work_struct *work) { } 698dc186ad7SThomas Gleixner #endif 699dc186ad7SThomas Gleixner 7004e8b22bdSLi Bin /** 70167dc8325SCai Huoqing * worker_pool_assign_id - allocate ID and assign it to @pool 7024e8b22bdSLi Bin * @pool: the pool pointer of interest 7034e8b22bdSLi Bin * 7044e8b22bdSLi Bin * Returns 0 if ID in [0, WORK_OFFQ_POOL_NONE) is allocated and assigned 7054e8b22bdSLi Bin * successfully, -errno on failure. 7064e8b22bdSLi Bin */ 7079daf9e67STejun Heo static int worker_pool_assign_id(struct worker_pool *pool) 7089daf9e67STejun Heo { 7099daf9e67STejun Heo int ret; 7109daf9e67STejun Heo 71168e13a67SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 7125bcab335STejun Heo 7134e8b22bdSLi Bin ret = idr_alloc(&worker_pool_idr, pool, 0, WORK_OFFQ_POOL_NONE, 7144e8b22bdSLi Bin GFP_KERNEL); 715229641a6STejun Heo if (ret >= 0) { 716e68035fbSTejun Heo pool->id = ret; 717229641a6STejun Heo return 0; 718229641a6STejun Heo } 7199daf9e67STejun Heo return ret; 7209daf9e67STejun Heo } 7219daf9e67STejun Heo 7229f66cff2STejun Heo static struct pool_workqueue __rcu ** 7239f66cff2STejun Heo unbound_pwq_slot(struct workqueue_struct *wq, int cpu) 7249f66cff2STejun Heo { 7259f66cff2STejun Heo if (cpu >= 0) 7269f66cff2STejun Heo return per_cpu_ptr(wq->cpu_pwq, cpu); 7279f66cff2STejun Heo else 7289f66cff2STejun Heo return &wq->dfl_pwq; 7299f66cff2STejun Heo } 7309f66cff2STejun Heo 7319f66cff2STejun Heo /* @cpu < 0 for dfl_pwq */ 7329f66cff2STejun Heo static struct pool_workqueue *unbound_pwq(struct workqueue_struct *wq, int cpu) 7339f66cff2STejun Heo { 7349f66cff2STejun Heo return rcu_dereference_check(*unbound_pwq_slot(wq, cpu), 7359f66cff2STejun Heo lockdep_is_held(&wq_pool_mutex) || 7369f66cff2STejun Heo lockdep_is_held(&wq->mutex)); 7379f66cff2STejun Heo } 7389f66cff2STejun Heo 7395797b1c1STejun Heo /** 7405797b1c1STejun Heo * unbound_effective_cpumask - effective cpumask of an unbound workqueue 7415797b1c1STejun Heo * @wq: workqueue of interest 7425797b1c1STejun Heo * 7435797b1c1STejun Heo * @wq->unbound_attrs->cpumask contains the cpumask requested by the user which 7445797b1c1STejun Heo * is masked with wq_unbound_cpumask to determine the effective cpumask. The 7455797b1c1STejun Heo * default pwq is always mapped to the pool with the current effective cpumask. 7465797b1c1STejun Heo */ 7475797b1c1STejun Heo static struct cpumask *unbound_effective_cpumask(struct workqueue_struct *wq) 7485797b1c1STejun Heo { 7495797b1c1STejun Heo return unbound_pwq(wq, -1)->pool->attrs->__pod_cpumask; 7505797b1c1STejun Heo } 7515797b1c1STejun Heo 75273f53c4aSTejun Heo static unsigned int work_color_to_flags(int color) 75373f53c4aSTejun Heo { 75473f53c4aSTejun Heo return color << WORK_STRUCT_COLOR_SHIFT; 75573f53c4aSTejun Heo } 75673f53c4aSTejun Heo 757c4560c2cSLai Jiangshan static int get_work_color(unsigned long work_data) 75873f53c4aSTejun Heo { 759c4560c2cSLai Jiangshan return (work_data >> WORK_STRUCT_COLOR_SHIFT) & 76073f53c4aSTejun Heo ((1 << WORK_STRUCT_COLOR_BITS) - 1); 76173f53c4aSTejun Heo } 76273f53c4aSTejun Heo 76373f53c4aSTejun Heo static int work_next_color(int color) 76473f53c4aSTejun Heo { 76573f53c4aSTejun Heo return (color + 1) % WORK_NR_COLORS; 766a848e3b6SOleg Nesterov } 767a848e3b6SOleg Nesterov 768456a78eeSTejun Heo static unsigned long pool_offq_flags(struct worker_pool *pool) 769456a78eeSTejun Heo { 770456a78eeSTejun Heo return (pool->flags & POOL_BH) ? WORK_OFFQ_BH : 0; 771456a78eeSTejun Heo } 772456a78eeSTejun Heo 7734594bf15SDavid Howells /* 774112202d9STejun Heo * While queued, %WORK_STRUCT_PWQ is set and non flag bits of a work's data 775112202d9STejun Heo * contain the pointer to the queued pwq. Once execution starts, the flag 7767c3eed5cSTejun Heo * is cleared and the high bits contain OFFQ flags and pool ID. 7777a22ad75STejun Heo * 778afe928c1STejun Heo * set_work_pwq(), set_work_pool_and_clear_pending() and mark_work_canceling() 779afe928c1STejun Heo * can be used to set the pwq, pool or clear work->data. These functions should 780afe928c1STejun Heo * only be called while the work is owned - ie. while the PENDING bit is set. 7817a22ad75STejun Heo * 782112202d9STejun Heo * get_work_pool() and get_work_pwq() can be used to obtain the pool or pwq 7837c3eed5cSTejun Heo * corresponding to a work. Pool is available once the work has been 784112202d9STejun Heo * queued anywhere after initialization until it is sync canceled. pwq is 7857c3eed5cSTejun Heo * available only while the work item is queued. 7864594bf15SDavid Howells */ 787bccdc1faSTejun Heo static inline void set_work_data(struct work_struct *work, unsigned long data) 7887a22ad75STejun Heo { 7896183c009STejun Heo WARN_ON_ONCE(!work_pending(work)); 790bccdc1faSTejun Heo atomic_long_set(&work->data, data | work_static(work)); 7917a22ad75STejun Heo } 7927a22ad75STejun Heo 793112202d9STejun Heo static void set_work_pwq(struct work_struct *work, struct pool_workqueue *pwq, 794bccdc1faSTejun Heo unsigned long flags) 795365970a1SDavid Howells { 796bccdc1faSTejun Heo set_work_data(work, (unsigned long)pwq | WORK_STRUCT_PENDING | 797bccdc1faSTejun Heo WORK_STRUCT_PWQ | flags); 798365970a1SDavid Howells } 799365970a1SDavid Howells 8004468a00fSLai Jiangshan static void set_work_pool_and_keep_pending(struct work_struct *work, 801bccdc1faSTejun Heo int pool_id, unsigned long flags) 8024468a00fSLai Jiangshan { 803bccdc1faSTejun Heo set_work_data(work, ((unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT) | 804bccdc1faSTejun Heo WORK_STRUCT_PENDING | flags); 8054468a00fSLai Jiangshan } 8064468a00fSLai Jiangshan 8077c3eed5cSTejun Heo static void set_work_pool_and_clear_pending(struct work_struct *work, 808bccdc1faSTejun Heo int pool_id, unsigned long flags) 8094d707b9fSOleg Nesterov { 81023657bb1STejun Heo /* 81123657bb1STejun Heo * The following wmb is paired with the implied mb in 81223657bb1STejun Heo * test_and_set_bit(PENDING) and ensures all updates to @work made 81323657bb1STejun Heo * here are visible to and precede any updates by the next PENDING 81423657bb1STejun Heo * owner. 81523657bb1STejun Heo */ 81623657bb1STejun Heo smp_wmb(); 817bccdc1faSTejun Heo set_work_data(work, ((unsigned long)pool_id << WORK_OFFQ_POOL_SHIFT) | 818bccdc1faSTejun Heo flags); 819346c09f8SRoman Pen /* 820346c09f8SRoman Pen * The following mb guarantees that previous clear of a PENDING bit 821346c09f8SRoman Pen * will not be reordered with any speculative LOADS or STORES from 822346c09f8SRoman Pen * work->current_func, which is executed afterwards. This possible 8238bdc6201SLiu Song * reordering can lead to a missed execution on attempt to queue 824346c09f8SRoman Pen * the same @work. E.g. consider this case: 825346c09f8SRoman Pen * 826346c09f8SRoman Pen * CPU#0 CPU#1 827346c09f8SRoman Pen * ---------------------------- -------------------------------- 828346c09f8SRoman Pen * 829346c09f8SRoman Pen * 1 STORE event_indicated 830346c09f8SRoman Pen * 2 queue_work_on() { 831346c09f8SRoman Pen * 3 test_and_set_bit(PENDING) 832346c09f8SRoman Pen * 4 } set_..._and_clear_pending() { 833346c09f8SRoman Pen * 5 set_work_data() # clear bit 834346c09f8SRoman Pen * 6 smp_mb() 835346c09f8SRoman Pen * 7 work->current_func() { 836346c09f8SRoman Pen * 8 LOAD event_indicated 837346c09f8SRoman Pen * } 838346c09f8SRoman Pen * 839346c09f8SRoman Pen * Without an explicit full barrier speculative LOAD on line 8 can 840346c09f8SRoman Pen * be executed before CPU#0 does STORE on line 1. If that happens, 841346c09f8SRoman Pen * CPU#0 observes the PENDING bit is still set and new execution of 842346c09f8SRoman Pen * a @work is not queued in a hope, that CPU#1 will eventually 843346c09f8SRoman Pen * finish the queued @work. Meanwhile CPU#1 does not see 844346c09f8SRoman Pen * event_indicated is set, because speculative LOAD was executed 845346c09f8SRoman Pen * before actual STORE. 846346c09f8SRoman Pen */ 847346c09f8SRoman Pen smp_mb(); 8484d707b9fSOleg Nesterov } 8494d707b9fSOleg Nesterov 850afa4bb77SLinus Torvalds static inline struct pool_workqueue *work_struct_pwq(unsigned long data) 851afa4bb77SLinus Torvalds { 852e9a8e01fSTejun Heo return (struct pool_workqueue *)(data & WORK_STRUCT_PWQ_MASK); 853afa4bb77SLinus Torvalds } 854afa4bb77SLinus Torvalds 855112202d9STejun Heo static struct pool_workqueue *get_work_pwq(struct work_struct *work) 8567a22ad75STejun Heo { 857e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 8587a22ad75STejun Heo 859112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 860afa4bb77SLinus Torvalds return work_struct_pwq(data); 861e120153dSTejun Heo else 862e120153dSTejun Heo return NULL; 8637a22ad75STejun Heo } 8647a22ad75STejun Heo 8657c3eed5cSTejun Heo /** 8667c3eed5cSTejun Heo * get_work_pool - return the worker_pool a given work was associated with 8677c3eed5cSTejun Heo * @work: the work item of interest 8687c3eed5cSTejun Heo * 86968e13a67SLai Jiangshan * Pools are created and destroyed under wq_pool_mutex, and allows read 87024acfb71SThomas Gleixner * access under RCU read lock. As such, this function should be 87124acfb71SThomas Gleixner * called under wq_pool_mutex or inside of a rcu_read_lock() region. 872fa1b54e6STejun Heo * 873fa1b54e6STejun Heo * All fields of the returned pool are accessible as long as the above 874fa1b54e6STejun Heo * mentioned locking is in effect. If the returned pool needs to be used 875fa1b54e6STejun Heo * beyond the critical section, the caller is responsible for ensuring the 876fa1b54e6STejun Heo * returned pool is and stays online. 877d185af30SYacine Belkadi * 878d185af30SYacine Belkadi * Return: The worker_pool @work was last associated with. %NULL if none. 8797c3eed5cSTejun Heo */ 8807c3eed5cSTejun Heo static struct worker_pool *get_work_pool(struct work_struct *work) 8817a22ad75STejun Heo { 882e120153dSTejun Heo unsigned long data = atomic_long_read(&work->data); 8837c3eed5cSTejun Heo int pool_id; 8847a22ad75STejun Heo 88568e13a67SLai Jiangshan assert_rcu_or_pool_mutex(); 886fa1b54e6STejun Heo 887112202d9STejun Heo if (data & WORK_STRUCT_PWQ) 888afa4bb77SLinus Torvalds return work_struct_pwq(data)->pool; 8897a22ad75STejun Heo 8907c3eed5cSTejun Heo pool_id = data >> WORK_OFFQ_POOL_SHIFT; 8917c3eed5cSTejun Heo if (pool_id == WORK_OFFQ_POOL_NONE) 8927a22ad75STejun Heo return NULL; 8937a22ad75STejun Heo 894fa1b54e6STejun Heo return idr_find(&worker_pool_idr, pool_id); 8957c3eed5cSTejun Heo } 8967c3eed5cSTejun Heo 8971211f3b2STejun Heo static unsigned long shift_and_mask(unsigned long v, u32 shift, u32 bits) 8987c3eed5cSTejun Heo { 8991211f3b2STejun Heo return (v >> shift) & ((1 << bits) - 1); 9007c3eed5cSTejun Heo } 9017c3eed5cSTejun Heo 9021211f3b2STejun Heo static void work_offqd_unpack(struct work_offq_data *offqd, unsigned long data) 903bbb68dfaSTejun Heo { 9041211f3b2STejun Heo WARN_ON_ONCE(data & WORK_STRUCT_PWQ); 905bbb68dfaSTejun Heo 9061211f3b2STejun Heo offqd->pool_id = shift_and_mask(data, WORK_OFFQ_POOL_SHIFT, 9071211f3b2STejun Heo WORK_OFFQ_POOL_BITS); 90886898fa6STejun Heo offqd->disable = shift_and_mask(data, WORK_OFFQ_DISABLE_SHIFT, 90986898fa6STejun Heo WORK_OFFQ_DISABLE_BITS); 9101211f3b2STejun Heo offqd->flags = data & WORK_OFFQ_FLAG_MASK; 911bbb68dfaSTejun Heo } 912bbb68dfaSTejun Heo 9131211f3b2STejun Heo static unsigned long work_offqd_pack_flags(struct work_offq_data *offqd) 914bbb68dfaSTejun Heo { 91586898fa6STejun Heo return ((unsigned long)offqd->disable << WORK_OFFQ_DISABLE_SHIFT) | 91686898fa6STejun Heo ((unsigned long)offqd->flags); 917bbb68dfaSTejun Heo } 918bbb68dfaSTejun Heo 919e22bee78STejun Heo /* 9203270476aSTejun Heo * Policy functions. These define the policies on how the global worker 9213270476aSTejun Heo * pools are managed. Unless noted otherwise, these functions assume that 922d565ed63STejun Heo * they're being called with pool->lock held. 923e22bee78STejun Heo */ 924e22bee78STejun Heo 925e22bee78STejun Heo /* 926e22bee78STejun Heo * Need to wake up a worker? Called from anything but currently 927e22bee78STejun Heo * running workers. 928974271c4STejun Heo * 929974271c4STejun Heo * Note that, because unbound workers never contribute to nr_running, this 930706026c2STejun Heo * function will always return %true for unbound pools as long as the 931974271c4STejun Heo * worklist isn't empty. 932e22bee78STejun Heo */ 93363d95a91STejun Heo static bool need_more_worker(struct worker_pool *pool) 934e22bee78STejun Heo { 9350219a352STejun Heo return !list_empty(&pool->worklist) && !pool->nr_running; 936e22bee78STejun Heo } 937e22bee78STejun Heo 938e22bee78STejun Heo /* Can I start working? Called from busy but !running workers. */ 93963d95a91STejun Heo static bool may_start_working(struct worker_pool *pool) 940e22bee78STejun Heo { 94163d95a91STejun Heo return pool->nr_idle; 942e22bee78STejun Heo } 943e22bee78STejun Heo 944e22bee78STejun Heo /* Do I need to keep working? Called from currently running workers. */ 94563d95a91STejun Heo static bool keep_working(struct worker_pool *pool) 946e22bee78STejun Heo { 947bc35f7efSLai Jiangshan return !list_empty(&pool->worklist) && (pool->nr_running <= 1); 948e22bee78STejun Heo } 949e22bee78STejun Heo 950e22bee78STejun Heo /* Do we need a new worker? Called from manager. */ 95163d95a91STejun Heo static bool need_to_create_worker(struct worker_pool *pool) 952e22bee78STejun Heo { 95363d95a91STejun Heo return need_more_worker(pool) && !may_start_working(pool); 954e22bee78STejun Heo } 955e22bee78STejun Heo 956e22bee78STejun Heo /* Do we have too many workers and should some go away? */ 95763d95a91STejun Heo static bool too_many_workers(struct worker_pool *pool) 958e22bee78STejun Heo { 959692b4825STejun Heo bool managing = pool->flags & POOL_MANAGER_ACTIVE; 96063d95a91STejun Heo int nr_idle = pool->nr_idle + managing; /* manager is considered idle */ 96163d95a91STejun Heo int nr_busy = pool->nr_workers - nr_idle; 962e22bee78STejun Heo 963e22bee78STejun Heo return nr_idle > 2 && (nr_idle - 2) * MAX_IDLE_WORKERS_RATIO >= nr_busy; 964e22bee78STejun Heo } 965e22bee78STejun Heo 9664690c4abSTejun Heo /** 967e22bee78STejun Heo * worker_set_flags - set worker flags and adjust nr_running accordingly 968cb444766STejun Heo * @worker: self 969d302f017STejun Heo * @flags: flags to set 970d302f017STejun Heo * 971228f1d00SLai Jiangshan * Set @flags in @worker->flags and adjust nr_running accordingly. 972d302f017STejun Heo */ 973228f1d00SLai Jiangshan static inline void worker_set_flags(struct worker *worker, unsigned int flags) 974d302f017STejun Heo { 975bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 976e22bee78STejun Heo 977bc8b50c2STejun Heo lockdep_assert_held(&pool->lock); 978cb444766STejun Heo 979228f1d00SLai Jiangshan /* If transitioning into NOT_RUNNING, adjust nr_running. */ 980e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && 981e22bee78STejun Heo !(worker->flags & WORKER_NOT_RUNNING)) { 982bc35f7efSLai Jiangshan pool->nr_running--; 983e22bee78STejun Heo } 984e22bee78STejun Heo 985d302f017STejun Heo worker->flags |= flags; 986d302f017STejun Heo } 987d302f017STejun Heo 988d302f017STejun Heo /** 989e22bee78STejun Heo * worker_clr_flags - clear worker flags and adjust nr_running accordingly 990cb444766STejun Heo * @worker: self 991d302f017STejun Heo * @flags: flags to clear 992d302f017STejun Heo * 993e22bee78STejun Heo * Clear @flags in @worker->flags and adjust nr_running accordingly. 994d302f017STejun Heo */ 995d302f017STejun Heo static inline void worker_clr_flags(struct worker *worker, unsigned int flags) 996d302f017STejun Heo { 99763d95a91STejun Heo struct worker_pool *pool = worker->pool; 998e22bee78STejun Heo unsigned int oflags = worker->flags; 999e22bee78STejun Heo 1000bc8b50c2STejun Heo lockdep_assert_held(&pool->lock); 1001cb444766STejun Heo 1002d302f017STejun Heo worker->flags &= ~flags; 1003e22bee78STejun Heo 100442c025f3STejun Heo /* 100542c025f3STejun Heo * If transitioning out of NOT_RUNNING, increment nr_running. Note 100642c025f3STejun Heo * that the nested NOT_RUNNING is not a noop. NOT_RUNNING is mask 100742c025f3STejun Heo * of multiple flags, not a single flag. 100842c025f3STejun Heo */ 1009e22bee78STejun Heo if ((flags & WORKER_NOT_RUNNING) && (oflags & WORKER_NOT_RUNNING)) 1010e22bee78STejun Heo if (!(worker->flags & WORKER_NOT_RUNNING)) 1011bc35f7efSLai Jiangshan pool->nr_running++; 1012d302f017STejun Heo } 1013d302f017STejun Heo 1014797e8345STejun Heo /* Return the first idle worker. Called with pool->lock held. */ 1015797e8345STejun Heo static struct worker *first_idle_worker(struct worker_pool *pool) 1016797e8345STejun Heo { 1017797e8345STejun Heo if (unlikely(list_empty(&pool->idle_list))) 1018797e8345STejun Heo return NULL; 1019797e8345STejun Heo 1020797e8345STejun Heo return list_first_entry(&pool->idle_list, struct worker, entry); 1021797e8345STejun Heo } 1022797e8345STejun Heo 1023797e8345STejun Heo /** 1024797e8345STejun Heo * worker_enter_idle - enter idle state 1025797e8345STejun Heo * @worker: worker which is entering idle state 1026797e8345STejun Heo * 1027797e8345STejun Heo * @worker is entering idle state. Update stats and idle timer if 1028797e8345STejun Heo * necessary. 1029797e8345STejun Heo * 1030797e8345STejun Heo * LOCKING: 1031797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 1032797e8345STejun Heo */ 1033797e8345STejun Heo static void worker_enter_idle(struct worker *worker) 1034797e8345STejun Heo { 1035797e8345STejun Heo struct worker_pool *pool = worker->pool; 1036797e8345STejun Heo 1037797e8345STejun Heo if (WARN_ON_ONCE(worker->flags & WORKER_IDLE) || 1038797e8345STejun Heo WARN_ON_ONCE(!list_empty(&worker->entry) && 1039797e8345STejun Heo (worker->hentry.next || worker->hentry.pprev))) 1040797e8345STejun Heo return; 1041797e8345STejun Heo 1042797e8345STejun Heo /* can't use worker_set_flags(), also called from create_worker() */ 1043797e8345STejun Heo worker->flags |= WORKER_IDLE; 1044797e8345STejun Heo pool->nr_idle++; 1045797e8345STejun Heo worker->last_active = jiffies; 1046797e8345STejun Heo 1047797e8345STejun Heo /* idle_list is LIFO */ 1048797e8345STejun Heo list_add(&worker->entry, &pool->idle_list); 1049797e8345STejun Heo 1050797e8345STejun Heo if (too_many_workers(pool) && !timer_pending(&pool->idle_timer)) 1051797e8345STejun Heo mod_timer(&pool->idle_timer, jiffies + IDLE_WORKER_TIMEOUT); 1052797e8345STejun Heo 1053797e8345STejun Heo /* Sanity check nr_running. */ 1054797e8345STejun Heo WARN_ON_ONCE(pool->nr_workers == pool->nr_idle && pool->nr_running); 1055797e8345STejun Heo } 1056797e8345STejun Heo 1057797e8345STejun Heo /** 1058797e8345STejun Heo * worker_leave_idle - leave idle state 1059797e8345STejun Heo * @worker: worker which is leaving idle state 1060797e8345STejun Heo * 1061797e8345STejun Heo * @worker is leaving idle state. Update stats. 1062797e8345STejun Heo * 1063797e8345STejun Heo * LOCKING: 1064797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 1065797e8345STejun Heo */ 1066797e8345STejun Heo static void worker_leave_idle(struct worker *worker) 1067797e8345STejun Heo { 1068797e8345STejun Heo struct worker_pool *pool = worker->pool; 1069797e8345STejun Heo 1070797e8345STejun Heo if (WARN_ON_ONCE(!(worker->flags & WORKER_IDLE))) 1071797e8345STejun Heo return; 1072797e8345STejun Heo worker_clr_flags(worker, WORKER_IDLE); 1073797e8345STejun Heo pool->nr_idle--; 1074797e8345STejun Heo list_del_init(&worker->entry); 1075797e8345STejun Heo } 1076797e8345STejun Heo 1077797e8345STejun Heo /** 1078797e8345STejun Heo * find_worker_executing_work - find worker which is executing a work 1079797e8345STejun Heo * @pool: pool of interest 1080797e8345STejun Heo * @work: work to find worker for 1081797e8345STejun Heo * 1082797e8345STejun Heo * Find a worker which is executing @work on @pool by searching 1083797e8345STejun Heo * @pool->busy_hash which is keyed by the address of @work. For a worker 1084797e8345STejun Heo * to match, its current execution should match the address of @work and 1085797e8345STejun Heo * its work function. This is to avoid unwanted dependency between 1086797e8345STejun Heo * unrelated work executions through a work item being recycled while still 1087797e8345STejun Heo * being executed. 1088797e8345STejun Heo * 1089797e8345STejun Heo * This is a bit tricky. A work item may be freed once its execution 1090797e8345STejun Heo * starts and nothing prevents the freed area from being recycled for 1091797e8345STejun Heo * another work item. If the same work item address ends up being reused 1092797e8345STejun Heo * before the original execution finishes, workqueue will identify the 1093797e8345STejun Heo * recycled work item as currently executing and make it wait until the 1094797e8345STejun Heo * current execution finishes, introducing an unwanted dependency. 1095797e8345STejun Heo * 1096797e8345STejun Heo * This function checks the work item address and work function to avoid 1097797e8345STejun Heo * false positives. Note that this isn't complete as one may construct a 1098797e8345STejun Heo * work function which can introduce dependency onto itself through a 1099797e8345STejun Heo * recycled work item. Well, if somebody wants to shoot oneself in the 1100797e8345STejun Heo * foot that badly, there's only so much we can do, and if such deadlock 1101797e8345STejun Heo * actually occurs, it should be easy to locate the culprit work function. 1102797e8345STejun Heo * 1103797e8345STejun Heo * CONTEXT: 1104797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 1105797e8345STejun Heo * 1106797e8345STejun Heo * Return: 1107797e8345STejun Heo * Pointer to worker which is executing @work if found, %NULL 1108797e8345STejun Heo * otherwise. 1109797e8345STejun Heo */ 1110797e8345STejun Heo static struct worker *find_worker_executing_work(struct worker_pool *pool, 1111797e8345STejun Heo struct work_struct *work) 1112797e8345STejun Heo { 1113797e8345STejun Heo struct worker *worker; 1114797e8345STejun Heo 1115797e8345STejun Heo hash_for_each_possible(pool->busy_hash, worker, hentry, 1116797e8345STejun Heo (unsigned long)work) 1117797e8345STejun Heo if (worker->current_work == work && 1118797e8345STejun Heo worker->current_func == work->func) 1119797e8345STejun Heo return worker; 1120797e8345STejun Heo 1121797e8345STejun Heo return NULL; 1122797e8345STejun Heo } 1123797e8345STejun Heo 1124797e8345STejun Heo /** 1125797e8345STejun Heo * move_linked_works - move linked works to a list 1126797e8345STejun Heo * @work: start of series of works to be scheduled 1127797e8345STejun Heo * @head: target list to append @work to 1128797e8345STejun Heo * @nextp: out parameter for nested worklist walking 1129797e8345STejun Heo * 1130873eaca6STejun Heo * Schedule linked works starting from @work to @head. Work series to be 1131873eaca6STejun Heo * scheduled starts at @work and includes any consecutive work with 1132873eaca6STejun Heo * WORK_STRUCT_LINKED set in its predecessor. See assign_work() for details on 1133873eaca6STejun Heo * @nextp. 1134797e8345STejun Heo * 1135797e8345STejun Heo * CONTEXT: 1136797e8345STejun Heo * raw_spin_lock_irq(pool->lock). 1137797e8345STejun Heo */ 1138797e8345STejun Heo static void move_linked_works(struct work_struct *work, struct list_head *head, 1139797e8345STejun Heo struct work_struct **nextp) 1140797e8345STejun Heo { 1141797e8345STejun Heo struct work_struct *n; 1142797e8345STejun Heo 1143797e8345STejun Heo /* 1144797e8345STejun Heo * Linked worklist will always end before the end of the list, 1145797e8345STejun Heo * use NULL for list head. 1146797e8345STejun Heo */ 1147797e8345STejun Heo list_for_each_entry_safe_from(work, n, NULL, entry) { 1148797e8345STejun Heo list_move_tail(&work->entry, head); 1149797e8345STejun Heo if (!(*work_data_bits(work) & WORK_STRUCT_LINKED)) 1150797e8345STejun Heo break; 1151797e8345STejun Heo } 1152797e8345STejun Heo 1153797e8345STejun Heo /* 1154797e8345STejun Heo * If we're already inside safe list traversal and have moved 1155797e8345STejun Heo * multiple works to the scheduled queue, the next position 1156797e8345STejun Heo * needs to be updated. 1157797e8345STejun Heo */ 1158797e8345STejun Heo if (nextp) 1159797e8345STejun Heo *nextp = n; 1160797e8345STejun Heo } 1161797e8345STejun Heo 1162797e8345STejun Heo /** 1163873eaca6STejun Heo * assign_work - assign a work item and its linked work items to a worker 1164873eaca6STejun Heo * @work: work to assign 1165873eaca6STejun Heo * @worker: worker to assign to 1166873eaca6STejun Heo * @nextp: out parameter for nested worklist walking 1167873eaca6STejun Heo * 1168873eaca6STejun Heo * Assign @work and its linked work items to @worker. If @work is already being 1169873eaca6STejun Heo * executed by another worker in the same pool, it'll be punted there. 1170873eaca6STejun Heo * 1171873eaca6STejun Heo * If @nextp is not NULL, it's updated to point to the next work of the last 1172873eaca6STejun Heo * scheduled work. This allows assign_work() to be nested inside 1173873eaca6STejun Heo * list_for_each_entry_safe(). 1174873eaca6STejun Heo * 1175873eaca6STejun Heo * Returns %true if @work was successfully assigned to @worker. %false if @work 1176873eaca6STejun Heo * was punted to another worker already executing it. 1177873eaca6STejun Heo */ 1178873eaca6STejun Heo static bool assign_work(struct work_struct *work, struct worker *worker, 1179873eaca6STejun Heo struct work_struct **nextp) 1180873eaca6STejun Heo { 1181873eaca6STejun Heo struct worker_pool *pool = worker->pool; 1182873eaca6STejun Heo struct worker *collision; 1183873eaca6STejun Heo 1184873eaca6STejun Heo lockdep_assert_held(&pool->lock); 1185873eaca6STejun Heo 1186873eaca6STejun Heo /* 1187873eaca6STejun Heo * A single work shouldn't be executed concurrently by multiple workers. 1188873eaca6STejun Heo * __queue_work() ensures that @work doesn't jump to a different pool 1189873eaca6STejun Heo * while still running in the previous pool. Here, we should ensure that 1190873eaca6STejun Heo * @work is not executed concurrently by multiple workers from the same 1191873eaca6STejun Heo * pool. Check whether anyone is already processing the work. If so, 1192873eaca6STejun Heo * defer the work to the currently executing one. 1193873eaca6STejun Heo */ 1194873eaca6STejun Heo collision = find_worker_executing_work(pool, work); 1195873eaca6STejun Heo if (unlikely(collision)) { 1196873eaca6STejun Heo move_linked_works(work, &collision->scheduled, nextp); 1197873eaca6STejun Heo return false; 1198873eaca6STejun Heo } 1199873eaca6STejun Heo 1200873eaca6STejun Heo move_linked_works(work, &worker->scheduled, nextp); 1201873eaca6STejun Heo return true; 1202873eaca6STejun Heo } 1203873eaca6STejun Heo 12042f34d733STejun Heo static struct irq_work *bh_pool_irq_work(struct worker_pool *pool) 12052f34d733STejun Heo { 12062f34d733STejun Heo int high = pool->attrs->nice == HIGHPRI_NICE_LEVEL ? 1 : 0; 12072f34d733STejun Heo 12082f34d733STejun Heo return &per_cpu(bh_pool_irq_works, pool->cpu)[high]; 12092f34d733STejun Heo } 12102f34d733STejun Heo 1211fd0a68a2STejun Heo static void kick_bh_pool(struct worker_pool *pool) 1212fd0a68a2STejun Heo { 1213fd0a68a2STejun Heo #ifdef CONFIG_SMP 12141acd92d9STejun Heo /* see drain_dead_softirq_workfn() for BH_DRAINING */ 12151acd92d9STejun Heo if (unlikely(pool->cpu != smp_processor_id() && 12161acd92d9STejun Heo !(pool->flags & POOL_BH_DRAINING))) { 1217fd0a68a2STejun Heo irq_work_queue_on(bh_pool_irq_work(pool), pool->cpu); 1218fd0a68a2STejun Heo return; 1219fd0a68a2STejun Heo } 1220fd0a68a2STejun Heo #endif 1221fd0a68a2STejun Heo if (pool->attrs->nice == HIGHPRI_NICE_LEVEL) 1222fd0a68a2STejun Heo raise_softirq_irqoff(HI_SOFTIRQ); 1223fd0a68a2STejun Heo else 1224fd0a68a2STejun Heo raise_softirq_irqoff(TASKLET_SOFTIRQ); 1225fd0a68a2STejun Heo } 1226fd0a68a2STejun Heo 1227873eaca6STejun Heo /** 12280219a352STejun Heo * kick_pool - wake up an idle worker if necessary 12290219a352STejun Heo * @pool: pool to kick 1230797e8345STejun Heo * 12310219a352STejun Heo * @pool may have pending work items. Wake up worker if necessary. Returns 12320219a352STejun Heo * whether a worker was woken up. 1233797e8345STejun Heo */ 12340219a352STejun Heo static bool kick_pool(struct worker_pool *pool) 1235797e8345STejun Heo { 1236797e8345STejun Heo struct worker *worker = first_idle_worker(pool); 12378639ecebSTejun Heo struct task_struct *p; 1238797e8345STejun Heo 12390219a352STejun Heo lockdep_assert_held(&pool->lock); 12400219a352STejun Heo 12410219a352STejun Heo if (!need_more_worker(pool) || !worker) 12420219a352STejun Heo return false; 12430219a352STejun Heo 12444cb1ef64STejun Heo if (pool->flags & POOL_BH) { 1245fd0a68a2STejun Heo kick_bh_pool(pool); 12464cb1ef64STejun Heo return true; 12474cb1ef64STejun Heo } 12484cb1ef64STejun Heo 12498639ecebSTejun Heo p = worker->task; 12508639ecebSTejun Heo 12518639ecebSTejun Heo #ifdef CONFIG_SMP 12528639ecebSTejun Heo /* 12538639ecebSTejun Heo * Idle @worker is about to execute @work and waking up provides an 12548639ecebSTejun Heo * opportunity to migrate @worker at a lower cost by setting the task's 12558639ecebSTejun Heo * wake_cpu field. Let's see if we want to move @worker to improve 12568639ecebSTejun Heo * execution locality. 12578639ecebSTejun Heo * 12588639ecebSTejun Heo * We're waking the worker that went idle the latest and there's some 12598639ecebSTejun Heo * chance that @worker is marked idle but hasn't gone off CPU yet. If 12608639ecebSTejun Heo * so, setting the wake_cpu won't do anything. As this is a best-effort 12618639ecebSTejun Heo * optimization and the race window is narrow, let's leave as-is for 12628639ecebSTejun Heo * now. If this becomes pronounced, we can skip over workers which are 12638639ecebSTejun Heo * still on cpu when picking an idle worker. 12648639ecebSTejun Heo * 12658639ecebSTejun Heo * If @pool has non-strict affinity, @worker might have ended up outside 12668639ecebSTejun Heo * its affinity scope. Repatriate. 12678639ecebSTejun Heo */ 12688639ecebSTejun Heo if (!pool->attrs->affn_strict && 12698639ecebSTejun Heo !cpumask_test_cpu(p->wake_cpu, pool->attrs->__pod_cpumask)) { 12708639ecebSTejun Heo struct work_struct *work = list_first_entry(&pool->worklist, 12718639ecebSTejun Heo struct work_struct, entry); 127257a01eafSSven Schnelle int wake_cpu = cpumask_any_and_distribute(pool->attrs->__pod_cpumask, 127357a01eafSSven Schnelle cpu_online_mask); 127457a01eafSSven Schnelle if (wake_cpu < nr_cpu_ids) { 127557a01eafSSven Schnelle p->wake_cpu = wake_cpu; 12768639ecebSTejun Heo get_work_pwq(work)->stats[PWQ_STAT_REPATRIATED]++; 12778639ecebSTejun Heo } 127857a01eafSSven Schnelle } 12798639ecebSTejun Heo #endif 12808639ecebSTejun Heo wake_up_process(p); 12810219a352STejun Heo return true; 1282797e8345STejun Heo } 1283797e8345STejun Heo 128463638450STejun Heo #ifdef CONFIG_WQ_CPU_INTENSIVE_REPORT 128563638450STejun Heo 128663638450STejun Heo /* 128763638450STejun Heo * Concurrency-managed per-cpu work items that hog CPU for longer than 128863638450STejun Heo * wq_cpu_intensive_thresh_us trigger the automatic CPU_INTENSIVE mechanism, 128963638450STejun Heo * which prevents them from stalling other concurrency-managed work items. If a 129063638450STejun Heo * work function keeps triggering this mechanism, it's likely that the work item 129163638450STejun Heo * should be using an unbound workqueue instead. 129263638450STejun Heo * 129363638450STejun Heo * wq_cpu_intensive_report() tracks work functions which trigger such conditions 129463638450STejun Heo * and report them so that they can be examined and converted to use unbound 129563638450STejun Heo * workqueues as appropriate. To avoid flooding the console, each violating work 129663638450STejun Heo * function is tracked and reported with exponential backoff. 129763638450STejun Heo */ 129863638450STejun Heo #define WCI_MAX_ENTS 128 129963638450STejun Heo 130063638450STejun Heo struct wci_ent { 130163638450STejun Heo work_func_t func; 130263638450STejun Heo atomic64_t cnt; 130363638450STejun Heo struct hlist_node hash_node; 130463638450STejun Heo }; 130563638450STejun Heo 130663638450STejun Heo static struct wci_ent wci_ents[WCI_MAX_ENTS]; 130763638450STejun Heo static int wci_nr_ents; 130863638450STejun Heo static DEFINE_RAW_SPINLOCK(wci_lock); 130963638450STejun Heo static DEFINE_HASHTABLE(wci_hash, ilog2(WCI_MAX_ENTS)); 131063638450STejun Heo 131163638450STejun Heo static struct wci_ent *wci_find_ent(work_func_t func) 131263638450STejun Heo { 131363638450STejun Heo struct wci_ent *ent; 131463638450STejun Heo 131563638450STejun Heo hash_for_each_possible_rcu(wci_hash, ent, hash_node, 131663638450STejun Heo (unsigned long)func) { 131763638450STejun Heo if (ent->func == func) 131863638450STejun Heo return ent; 131963638450STejun Heo } 132063638450STejun Heo return NULL; 132163638450STejun Heo } 132263638450STejun Heo 132363638450STejun Heo static void wq_cpu_intensive_report(work_func_t func) 132463638450STejun Heo { 132563638450STejun Heo struct wci_ent *ent; 132663638450STejun Heo 132763638450STejun Heo restart: 132863638450STejun Heo ent = wci_find_ent(func); 132963638450STejun Heo if (ent) { 133063638450STejun Heo u64 cnt; 133163638450STejun Heo 133263638450STejun Heo /* 1333ccdec921SXuewen Yan * Start reporting from the warning_thresh and back off 133463638450STejun Heo * exponentially. 133563638450STejun Heo */ 133663638450STejun Heo cnt = atomic64_inc_return_relaxed(&ent->cnt); 1337ccdec921SXuewen Yan if (wq_cpu_intensive_warning_thresh && 1338ccdec921SXuewen Yan cnt >= wq_cpu_intensive_warning_thresh && 1339ccdec921SXuewen Yan is_power_of_2(cnt + 1 - wq_cpu_intensive_warning_thresh)) 134063638450STejun Heo printk_deferred(KERN_WARNING "workqueue: %ps hogged CPU for >%luus %llu times, consider switching to WQ_UNBOUND\n", 134163638450STejun Heo ent->func, wq_cpu_intensive_thresh_us, 134263638450STejun Heo atomic64_read(&ent->cnt)); 134363638450STejun Heo return; 134463638450STejun Heo } 134563638450STejun Heo 134663638450STejun Heo /* 134763638450STejun Heo * @func is a new violation. Allocate a new entry for it. If wcn_ents[] 134863638450STejun Heo * is exhausted, something went really wrong and we probably made enough 134963638450STejun Heo * noise already. 135063638450STejun Heo */ 135163638450STejun Heo if (wci_nr_ents >= WCI_MAX_ENTS) 135263638450STejun Heo return; 135363638450STejun Heo 135463638450STejun Heo raw_spin_lock(&wci_lock); 135563638450STejun Heo 135663638450STejun Heo if (wci_nr_ents >= WCI_MAX_ENTS) { 135763638450STejun Heo raw_spin_unlock(&wci_lock); 135863638450STejun Heo return; 135963638450STejun Heo } 136063638450STejun Heo 136163638450STejun Heo if (wci_find_ent(func)) { 136263638450STejun Heo raw_spin_unlock(&wci_lock); 136363638450STejun Heo goto restart; 136463638450STejun Heo } 136563638450STejun Heo 136663638450STejun Heo ent = &wci_ents[wci_nr_ents++]; 136763638450STejun Heo ent->func = func; 1368ccdec921SXuewen Yan atomic64_set(&ent->cnt, 0); 136963638450STejun Heo hash_add_rcu(wci_hash, &ent->hash_node, (unsigned long)func); 137063638450STejun Heo 137163638450STejun Heo raw_spin_unlock(&wci_lock); 1372ccdec921SXuewen Yan 1373ccdec921SXuewen Yan goto restart; 137463638450STejun Heo } 137563638450STejun Heo 137663638450STejun Heo #else /* CONFIG_WQ_CPU_INTENSIVE_REPORT */ 137763638450STejun Heo static void wq_cpu_intensive_report(work_func_t func) {} 137863638450STejun Heo #endif /* CONFIG_WQ_CPU_INTENSIVE_REPORT */ 137963638450STejun Heo 1380c54d5046STejun Heo /** 13811da177e4SLinus Torvalds * wq_worker_running - a worker is running again 13821da177e4SLinus Torvalds * @task: task waking up 13831da177e4SLinus Torvalds * 13841da177e4SLinus Torvalds * This function is called when a worker returns from schedule() 13851da177e4SLinus Torvalds */ 13861da177e4SLinus Torvalds void wq_worker_running(struct task_struct *task) 13871da177e4SLinus Torvalds { 13881da177e4SLinus Torvalds struct worker *worker = kthread_data(task); 13891da177e4SLinus Torvalds 1390c8f6219bSZqiang if (!READ_ONCE(worker->sleeping)) 13911da177e4SLinus Torvalds return; 13921da177e4SLinus Torvalds 13931da177e4SLinus Torvalds /* 13941da177e4SLinus Torvalds * If preempted by unbind_workers() between the WORKER_NOT_RUNNING check 13951da177e4SLinus Torvalds * and the nr_running increment below, we may ruin the nr_running reset 13961da177e4SLinus Torvalds * and leave with an unexpected pool->nr_running == 1 on the newly unbound 13971da177e4SLinus Torvalds * pool. Protect against such race. 13981da177e4SLinus Torvalds */ 13991da177e4SLinus Torvalds preempt_disable(); 14001da177e4SLinus Torvalds if (!(worker->flags & WORKER_NOT_RUNNING)) 14011da177e4SLinus Torvalds worker->pool->nr_running++; 14021da177e4SLinus Torvalds preempt_enable(); 1403616db877STejun Heo 1404616db877STejun Heo /* 1405616db877STejun Heo * CPU intensive auto-detection cares about how long a work item hogged 1406616db877STejun Heo * CPU without sleeping. Reset the starting timestamp on wakeup. 1407616db877STejun Heo */ 1408616db877STejun Heo worker->current_at = worker->task->se.sum_exec_runtime; 1409616db877STejun Heo 1410c8f6219bSZqiang WRITE_ONCE(worker->sleeping, 0); 14111da177e4SLinus Torvalds } 14121da177e4SLinus Torvalds 14131da177e4SLinus Torvalds /** 14141da177e4SLinus Torvalds * wq_worker_sleeping - a worker is going to sleep 14151da177e4SLinus Torvalds * @task: task going to sleep 14161da177e4SLinus Torvalds * 14171da177e4SLinus Torvalds * This function is called from schedule() when a busy worker is 14181da177e4SLinus Torvalds * going to sleep. 14191da177e4SLinus Torvalds */ 14201da177e4SLinus Torvalds void wq_worker_sleeping(struct task_struct *task) 14211da177e4SLinus Torvalds { 14221da177e4SLinus Torvalds struct worker *worker = kthread_data(task); 14231da177e4SLinus Torvalds struct worker_pool *pool; 14241da177e4SLinus Torvalds 14251da177e4SLinus Torvalds /* 14261da177e4SLinus Torvalds * Rescuers, which may not have all the fields set up like normal 14271da177e4SLinus Torvalds * workers, also reach here, let's not access anything before 14281da177e4SLinus Torvalds * checking NOT_RUNNING. 14291da177e4SLinus Torvalds */ 14301da177e4SLinus Torvalds if (worker->flags & WORKER_NOT_RUNNING) 14311da177e4SLinus Torvalds return; 14321da177e4SLinus Torvalds 14331da177e4SLinus Torvalds pool = worker->pool; 14341da177e4SLinus Torvalds 14351da177e4SLinus Torvalds /* Return if preempted before wq_worker_running() was reached */ 1436c8f6219bSZqiang if (READ_ONCE(worker->sleeping)) 14371da177e4SLinus Torvalds return; 14381da177e4SLinus Torvalds 1439c8f6219bSZqiang WRITE_ONCE(worker->sleeping, 1); 14401da177e4SLinus Torvalds raw_spin_lock_irq(&pool->lock); 14411da177e4SLinus Torvalds 14421da177e4SLinus Torvalds /* 14431da177e4SLinus Torvalds * Recheck in case unbind_workers() preempted us. We don't 14441da177e4SLinus Torvalds * want to decrement nr_running after the worker is unbound 14451da177e4SLinus Torvalds * and nr_running has been reset. 14461da177e4SLinus Torvalds */ 14471da177e4SLinus Torvalds if (worker->flags & WORKER_NOT_RUNNING) { 14481da177e4SLinus Torvalds raw_spin_unlock_irq(&pool->lock); 14491da177e4SLinus Torvalds return; 14501da177e4SLinus Torvalds } 14511da177e4SLinus Torvalds 14521da177e4SLinus Torvalds pool->nr_running--; 14530219a352STejun Heo if (kick_pool(pool)) 1454725e8ec5STejun Heo worker->current_pwq->stats[PWQ_STAT_CM_WAKEUP]++; 14550219a352STejun Heo 14561da177e4SLinus Torvalds raw_spin_unlock_irq(&pool->lock); 14571da177e4SLinus Torvalds } 14581da177e4SLinus Torvalds 14591da177e4SLinus Torvalds /** 1460616db877STejun Heo * wq_worker_tick - a scheduler tick occurred while a kworker is running 1461616db877STejun Heo * @task: task currently running 1462616db877STejun Heo * 146386dd6c04SIngo Molnar * Called from sched_tick(). We're in the IRQ context and the current 1464616db877STejun Heo * worker's fields which follow the 'K' locking rule can be accessed safely. 1465616db877STejun Heo */ 1466616db877STejun Heo void wq_worker_tick(struct task_struct *task) 1467616db877STejun Heo { 1468616db877STejun Heo struct worker *worker = kthread_data(task); 1469616db877STejun Heo struct pool_workqueue *pwq = worker->current_pwq; 1470616db877STejun Heo struct worker_pool *pool = worker->pool; 1471616db877STejun Heo 1472616db877STejun Heo if (!pwq) 1473616db877STejun Heo return; 1474616db877STejun Heo 14758a1dd1e5STejun Heo pwq->stats[PWQ_STAT_CPU_TIME] += TICK_USEC; 14768a1dd1e5STejun Heo 147718c8ae81SZqiang if (!wq_cpu_intensive_thresh_us) 147818c8ae81SZqiang return; 147918c8ae81SZqiang 1480616db877STejun Heo /* 1481616db877STejun Heo * If the current worker is concurrency managed and hogged the CPU for 1482616db877STejun Heo * longer than wq_cpu_intensive_thresh_us, it's automatically marked 1483616db877STejun Heo * CPU_INTENSIVE to avoid stalling other concurrency-managed work items. 1484c8f6219bSZqiang * 1485c8f6219bSZqiang * Set @worker->sleeping means that @worker is in the process of 1486c8f6219bSZqiang * switching out voluntarily and won't be contributing to 1487c8f6219bSZqiang * @pool->nr_running until it wakes up. As wq_worker_sleeping() also 1488c8f6219bSZqiang * decrements ->nr_running, setting CPU_INTENSIVE here can lead to 1489c8f6219bSZqiang * double decrements. The task is releasing the CPU anyway. Let's skip. 1490c8f6219bSZqiang * We probably want to make this prettier in the future. 1491616db877STejun Heo */ 1492c8f6219bSZqiang if ((worker->flags & WORKER_NOT_RUNNING) || READ_ONCE(worker->sleeping) || 1493616db877STejun Heo worker->task->se.sum_exec_runtime - worker->current_at < 1494616db877STejun Heo wq_cpu_intensive_thresh_us * NSEC_PER_USEC) 1495616db877STejun Heo return; 1496616db877STejun Heo 1497616db877STejun Heo raw_spin_lock(&pool->lock); 1498616db877STejun Heo 1499616db877STejun Heo worker_set_flags(worker, WORKER_CPU_INTENSIVE); 150063638450STejun Heo wq_cpu_intensive_report(worker->current_func); 1501616db877STejun Heo pwq->stats[PWQ_STAT_CPU_INTENSIVE]++; 1502616db877STejun Heo 15030219a352STejun Heo if (kick_pool(pool)) 1504616db877STejun Heo pwq->stats[PWQ_STAT_CM_WAKEUP]++; 1505616db877STejun Heo 1506616db877STejun Heo raw_spin_unlock(&pool->lock); 1507616db877STejun Heo } 1508616db877STejun Heo 1509616db877STejun Heo /** 15101da177e4SLinus Torvalds * wq_worker_last_func - retrieve worker's last work function 15111da177e4SLinus Torvalds * @task: Task to retrieve last work function of. 15121da177e4SLinus Torvalds * 15131da177e4SLinus Torvalds * Determine the last function a worker executed. This is called from 15141da177e4SLinus Torvalds * the scheduler to get a worker's last known identity. 15151da177e4SLinus Torvalds * 15169b41ea72SAndrew Morton * CONTEXT: 15171da177e4SLinus Torvalds * raw_spin_lock_irq(rq->lock) 15181da177e4SLinus Torvalds * 1519f756d5e2SNathan Lynch * This function is called during schedule() when a kworker is going 1520f756d5e2SNathan Lynch * to sleep. It's used by psi to identify aggregation workers during 15211da177e4SLinus Torvalds * dequeuing, to allow periodic aggregation to shut-off when that 15221da177e4SLinus Torvalds * worker is the last task in the system or cgroup to go to sleep. 15231da177e4SLinus Torvalds * 15241da177e4SLinus Torvalds * As this function doesn't involve any workqueue-related locking, it 15251da177e4SLinus Torvalds * only returns stable values when called from inside the scheduler's 15261da177e4SLinus Torvalds * queuing and dequeuing paths, when @task, which must be a kworker, 1527365970a1SDavid Howells * is guaranteed to not be processing any works. 1528365970a1SDavid Howells * 1529365970a1SDavid Howells * Return: 1530365970a1SDavid Howells * The last work function %current executed as a worker, NULL if it 1531365970a1SDavid Howells * hasn't executed any work yet. 1532365970a1SDavid Howells */ 1533365970a1SDavid Howells work_func_t wq_worker_last_func(struct task_struct *task) 1534365970a1SDavid Howells { 1535365970a1SDavid Howells struct worker *worker = kthread_data(task); 1536365970a1SDavid Howells 1537365970a1SDavid Howells return worker->last_func; 1538365970a1SDavid Howells } 1539365970a1SDavid Howells 1540d302f017STejun Heo /** 154191ccc6e7STejun Heo * wq_node_nr_active - Determine wq_node_nr_active to use 154291ccc6e7STejun Heo * @wq: workqueue of interest 154391ccc6e7STejun Heo * @node: NUMA node, can be %NUMA_NO_NODE 154491ccc6e7STejun Heo * 154591ccc6e7STejun Heo * Determine wq_node_nr_active to use for @wq on @node. Returns: 154691ccc6e7STejun Heo * 154791ccc6e7STejun Heo * - %NULL for per-cpu workqueues as they don't need to use shared nr_active. 154891ccc6e7STejun Heo * 154991ccc6e7STejun Heo * - node_nr_active[nr_node_ids] if @node is %NUMA_NO_NODE. 155091ccc6e7STejun Heo * 155191ccc6e7STejun Heo * - Otherwise, node_nr_active[@node]. 155291ccc6e7STejun Heo */ 155391ccc6e7STejun Heo static struct wq_node_nr_active *wq_node_nr_active(struct workqueue_struct *wq, 155491ccc6e7STejun Heo int node) 155591ccc6e7STejun Heo { 155691ccc6e7STejun Heo if (!(wq->flags & WQ_UNBOUND)) 155791ccc6e7STejun Heo return NULL; 155891ccc6e7STejun Heo 155991ccc6e7STejun Heo if (node == NUMA_NO_NODE) 156091ccc6e7STejun Heo node = nr_node_ids; 156191ccc6e7STejun Heo 156291ccc6e7STejun Heo return wq->node_nr_active[node]; 156391ccc6e7STejun Heo } 156491ccc6e7STejun Heo 156591ccc6e7STejun Heo /** 15665797b1c1STejun Heo * wq_update_node_max_active - Update per-node max_actives to use 15675797b1c1STejun Heo * @wq: workqueue to update 15685797b1c1STejun Heo * @off_cpu: CPU that's going down, -1 if a CPU is not going down 15695797b1c1STejun Heo * 15705797b1c1STejun Heo * Update @wq->node_nr_active[]->max. @wq must be unbound. max_active is 15715797b1c1STejun Heo * distributed among nodes according to the proportions of numbers of online 15725797b1c1STejun Heo * cpus. The result is always between @wq->min_active and max_active. 15735797b1c1STejun Heo */ 15745797b1c1STejun Heo static void wq_update_node_max_active(struct workqueue_struct *wq, int off_cpu) 15755797b1c1STejun Heo { 15765797b1c1STejun Heo struct cpumask *effective = unbound_effective_cpumask(wq); 15775797b1c1STejun Heo int min_active = READ_ONCE(wq->min_active); 15785797b1c1STejun Heo int max_active = READ_ONCE(wq->max_active); 15795797b1c1STejun Heo int total_cpus, node; 15805797b1c1STejun Heo 15815797b1c1STejun Heo lockdep_assert_held(&wq->mutex); 15825797b1c1STejun Heo 1583c5f8cd6cSTejun Heo if (!wq_topo_initialized) 1584c5f8cd6cSTejun Heo return; 1585c5f8cd6cSTejun Heo 158615930da4STejun Heo if (off_cpu >= 0 && !cpumask_test_cpu(off_cpu, effective)) 15875797b1c1STejun Heo off_cpu = -1; 15885797b1c1STejun Heo 15895797b1c1STejun Heo total_cpus = cpumask_weight_and(effective, cpu_online_mask); 15905797b1c1STejun Heo if (off_cpu >= 0) 15915797b1c1STejun Heo total_cpus--; 15925797b1c1STejun Heo 159391f09870SLai Jiangshan /* If all CPUs of the wq get offline, use the default values */ 159491f09870SLai Jiangshan if (unlikely(!total_cpus)) { 159591f09870SLai Jiangshan for_each_node(node) 159691f09870SLai Jiangshan wq_node_nr_active(wq, node)->max = min_active; 159791f09870SLai Jiangshan 159891f09870SLai Jiangshan wq_node_nr_active(wq, NUMA_NO_NODE)->max = max_active; 159991f09870SLai Jiangshan return; 160091f09870SLai Jiangshan } 160191f09870SLai Jiangshan 16025797b1c1STejun Heo for_each_node(node) { 16035797b1c1STejun Heo int node_cpus; 16045797b1c1STejun Heo 16055797b1c1STejun Heo node_cpus = cpumask_weight_and(effective, cpumask_of_node(node)); 16065797b1c1STejun Heo if (off_cpu >= 0 && cpu_to_node(off_cpu) == node) 16075797b1c1STejun Heo node_cpus--; 16085797b1c1STejun Heo 16095797b1c1STejun Heo wq_node_nr_active(wq, node)->max = 16105797b1c1STejun Heo clamp(DIV_ROUND_UP(max_active * node_cpus, total_cpus), 16115797b1c1STejun Heo min_active, max_active); 16125797b1c1STejun Heo } 16135797b1c1STejun Heo 1614d40f9202STejun Heo wq_node_nr_active(wq, NUMA_NO_NODE)->max = max_active; 16155797b1c1STejun Heo } 16165797b1c1STejun Heo 16175797b1c1STejun Heo /** 16188864b4e5STejun Heo * get_pwq - get an extra reference on the specified pool_workqueue 16198864b4e5STejun Heo * @pwq: pool_workqueue to get 16208864b4e5STejun Heo * 16218864b4e5STejun Heo * Obtain an extra reference on @pwq. The caller should guarantee that 16228864b4e5STejun Heo * @pwq has positive refcnt and be holding the matching pool->lock. 16238864b4e5STejun Heo */ 16248864b4e5STejun Heo static void get_pwq(struct pool_workqueue *pwq) 16258864b4e5STejun Heo { 16268864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 16278864b4e5STejun Heo WARN_ON_ONCE(pwq->refcnt <= 0); 16288864b4e5STejun Heo pwq->refcnt++; 16298864b4e5STejun Heo } 16308864b4e5STejun Heo 16318864b4e5STejun Heo /** 16328864b4e5STejun Heo * put_pwq - put a pool_workqueue reference 16338864b4e5STejun Heo * @pwq: pool_workqueue to put 16348864b4e5STejun Heo * 16358864b4e5STejun Heo * Drop a reference of @pwq. If its refcnt reaches zero, schedule its 16368864b4e5STejun Heo * destruction. The caller should be holding the matching pool->lock. 16378864b4e5STejun Heo */ 16388864b4e5STejun Heo static void put_pwq(struct pool_workqueue *pwq) 16398864b4e5STejun Heo { 16408864b4e5STejun Heo lockdep_assert_held(&pwq->pool->lock); 16418864b4e5STejun Heo if (likely(--pwq->refcnt)) 16428864b4e5STejun Heo return; 16438864b4e5STejun Heo /* 1644967b494eSTejun Heo * @pwq can't be released under pool->lock, bounce to a dedicated 1645967b494eSTejun Heo * kthread_worker to avoid A-A deadlocks. 16468864b4e5STejun Heo */ 1647687a9aa5STejun Heo kthread_queue_work(pwq_release_worker, &pwq->release_work); 16488864b4e5STejun Heo } 16498864b4e5STejun Heo 1650dce90d47STejun Heo /** 1651dce90d47STejun Heo * put_pwq_unlocked - put_pwq() with surrounding pool lock/unlock 1652dce90d47STejun Heo * @pwq: pool_workqueue to put (can be %NULL) 1653dce90d47STejun Heo * 1654dce90d47STejun Heo * put_pwq() with locking. This function also allows %NULL @pwq. 1655dce90d47STejun Heo */ 1656dce90d47STejun Heo static void put_pwq_unlocked(struct pool_workqueue *pwq) 1657dce90d47STejun Heo { 1658dce90d47STejun Heo if (pwq) { 1659dce90d47STejun Heo /* 166024acfb71SThomas Gleixner * As both pwqs and pools are RCU protected, the 1661dce90d47STejun Heo * following lock operations are safe. 1662dce90d47STejun Heo */ 1663a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 1664dce90d47STejun Heo put_pwq(pwq); 1665a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 1666dce90d47STejun Heo } 1667dce90d47STejun Heo } 1668dce90d47STejun Heo 1669afa87ce8STejun Heo static bool pwq_is_empty(struct pool_workqueue *pwq) 1670afa87ce8STejun Heo { 1671afa87ce8STejun Heo return !pwq->nr_active && list_empty(&pwq->inactive_works); 1672afa87ce8STejun Heo } 1673afa87ce8STejun Heo 16744c638030STejun Heo static void __pwq_activate_work(struct pool_workqueue *pwq, 16754c638030STejun Heo struct work_struct *work) 1676bf4ede01STejun Heo { 16771c270b79STejun Heo unsigned long *wdb = work_data_bits(work); 16781c270b79STejun Heo 16791c270b79STejun Heo WARN_ON_ONCE(!(*wdb & WORK_STRUCT_INACTIVE)); 1680bf4ede01STejun Heo trace_workqueue_activate_work(work); 168182607adcSTejun Heo if (list_empty(&pwq->pool->worklist)) 168282607adcSTejun Heo pwq->pool->watchdog_ts = jiffies; 1683112202d9STejun Heo move_linked_works(work, &pwq->pool->worklist, NULL); 16841c270b79STejun Heo __clear_bit(WORK_STRUCT_INACTIVE_BIT, wdb); 16854c638030STejun Heo } 16864c638030STejun Heo 16875797b1c1STejun Heo static bool tryinc_node_nr_active(struct wq_node_nr_active *nna) 16885797b1c1STejun Heo { 16895797b1c1STejun Heo int max = READ_ONCE(nna->max); 16905797b1c1STejun Heo 16915797b1c1STejun Heo while (true) { 16925797b1c1STejun Heo int old, tmp; 16935797b1c1STejun Heo 16945797b1c1STejun Heo old = atomic_read(&nna->nr); 16955797b1c1STejun Heo if (old >= max) 16965797b1c1STejun Heo return false; 16975797b1c1STejun Heo tmp = atomic_cmpxchg_relaxed(&nna->nr, old, old + 1); 16985797b1c1STejun Heo if (tmp == old) 16995797b1c1STejun Heo return true; 17005797b1c1STejun Heo } 17015797b1c1STejun Heo } 17025797b1c1STejun Heo 17031c270b79STejun Heo /** 17041c270b79STejun Heo * pwq_tryinc_nr_active - Try to increment nr_active for a pwq 17051c270b79STejun Heo * @pwq: pool_workqueue of interest 17065797b1c1STejun Heo * @fill: max_active may have increased, try to increase concurrency level 17071c270b79STejun Heo * 17081c270b79STejun Heo * Try to increment nr_active for @pwq. Returns %true if an nr_active count is 17091c270b79STejun Heo * successfully obtained. %false otherwise. 17101c270b79STejun Heo */ 17115797b1c1STejun Heo static bool pwq_tryinc_nr_active(struct pool_workqueue *pwq, bool fill) 17123aa62497SLai Jiangshan { 17131c270b79STejun Heo struct workqueue_struct *wq = pwq->wq; 17141c270b79STejun Heo struct worker_pool *pool = pwq->pool; 171591ccc6e7STejun Heo struct wq_node_nr_active *nna = wq_node_nr_active(wq, pool->node); 17165797b1c1STejun Heo bool obtained = false; 17171c270b79STejun Heo 17181c270b79STejun Heo lockdep_assert_held(&pool->lock); 17191c270b79STejun Heo 17205797b1c1STejun Heo if (!nna) { 17214cb1ef64STejun Heo /* BH or per-cpu workqueue, pwq->nr_active is sufficient */ 17221c270b79STejun Heo obtained = pwq->nr_active < READ_ONCE(wq->max_active); 17235797b1c1STejun Heo goto out; 172491ccc6e7STejun Heo } 17255797b1c1STejun Heo 17264c065dbcSWaiman Long if (unlikely(pwq->plugged)) 17274c065dbcSWaiman Long return false; 17284c065dbcSWaiman Long 17295797b1c1STejun Heo /* 17305797b1c1STejun Heo * Unbound workqueue uses per-node shared nr_active $nna. If @pwq is 17315797b1c1STejun Heo * already waiting on $nna, pwq_dec_nr_active() will maintain the 17325797b1c1STejun Heo * concurrency level. Don't jump the line. 17335797b1c1STejun Heo * 17345797b1c1STejun Heo * We need to ignore the pending test after max_active has increased as 17355797b1c1STejun Heo * pwq_dec_nr_active() can only maintain the concurrency level but not 17365797b1c1STejun Heo * increase it. This is indicated by @fill. 17375797b1c1STejun Heo */ 17385797b1c1STejun Heo if (!list_empty(&pwq->pending_node) && likely(!fill)) 17395797b1c1STejun Heo goto out; 17405797b1c1STejun Heo 17415797b1c1STejun Heo obtained = tryinc_node_nr_active(nna); 17425797b1c1STejun Heo if (obtained) 17435797b1c1STejun Heo goto out; 17445797b1c1STejun Heo 17455797b1c1STejun Heo /* 17465797b1c1STejun Heo * Lockless acquisition failed. Lock, add ourself to $nna->pending_pwqs 17475797b1c1STejun Heo * and try again. The smp_mb() is paired with the implied memory barrier 17485797b1c1STejun Heo * of atomic_dec_return() in pwq_dec_nr_active() to ensure that either 17495797b1c1STejun Heo * we see the decremented $nna->nr or they see non-empty 17505797b1c1STejun Heo * $nna->pending_pwqs. 17515797b1c1STejun Heo */ 17525797b1c1STejun Heo raw_spin_lock(&nna->lock); 17535797b1c1STejun Heo 17545797b1c1STejun Heo if (list_empty(&pwq->pending_node)) 17555797b1c1STejun Heo list_add_tail(&pwq->pending_node, &nna->pending_pwqs); 17565797b1c1STejun Heo else if (likely(!fill)) 17575797b1c1STejun Heo goto out_unlock; 17585797b1c1STejun Heo 17595797b1c1STejun Heo smp_mb(); 17605797b1c1STejun Heo 17615797b1c1STejun Heo obtained = tryinc_node_nr_active(nna); 17625797b1c1STejun Heo 17635797b1c1STejun Heo /* 17645797b1c1STejun Heo * If @fill, @pwq might have already been pending. Being spuriously 17655797b1c1STejun Heo * pending in cold paths doesn't affect anything. Let's leave it be. 17665797b1c1STejun Heo */ 17675797b1c1STejun Heo if (obtained && likely(!fill)) 17685797b1c1STejun Heo list_del_init(&pwq->pending_node); 17695797b1c1STejun Heo 17705797b1c1STejun Heo out_unlock: 17715797b1c1STejun Heo raw_spin_unlock(&nna->lock); 17725797b1c1STejun Heo out: 17735797b1c1STejun Heo if (obtained) 17745797b1c1STejun Heo pwq->nr_active++; 17751c270b79STejun Heo return obtained; 17761c270b79STejun Heo } 17771c270b79STejun Heo 17781c270b79STejun Heo /** 17791c270b79STejun Heo * pwq_activate_first_inactive - Activate the first inactive work item on a pwq 17801c270b79STejun Heo * @pwq: pool_workqueue of interest 17815797b1c1STejun Heo * @fill: max_active may have increased, try to increase concurrency level 17821c270b79STejun Heo * 17831c270b79STejun Heo * Activate the first inactive work item of @pwq if available and allowed by 17841c270b79STejun Heo * max_active limit. 17851c270b79STejun Heo * 17861c270b79STejun Heo * Returns %true if an inactive work item has been activated. %false if no 17871c270b79STejun Heo * inactive work item is found or max_active limit is reached. 17881c270b79STejun Heo */ 17895797b1c1STejun Heo static bool pwq_activate_first_inactive(struct pool_workqueue *pwq, bool fill) 17901c270b79STejun Heo { 17911c270b79STejun Heo struct work_struct *work = 17921c270b79STejun Heo list_first_entry_or_null(&pwq->inactive_works, 17933aa62497SLai Jiangshan struct work_struct, entry); 17943aa62497SLai Jiangshan 17955797b1c1STejun Heo if (work && pwq_tryinc_nr_active(pwq, fill)) { 17961c270b79STejun Heo __pwq_activate_work(pwq, work); 17971c270b79STejun Heo return true; 17981c270b79STejun Heo } else { 17991c270b79STejun Heo return false; 18001c270b79STejun Heo } 18011c270b79STejun Heo } 18021c270b79STejun Heo 18031c270b79STejun Heo /** 1804516d3dc9SWaiman Long * unplug_oldest_pwq - unplug the oldest pool_workqueue 1805516d3dc9SWaiman Long * @wq: workqueue_struct where its oldest pwq is to be unplugged 18064c065dbcSWaiman Long * 1807516d3dc9SWaiman Long * This function should only be called for ordered workqueues where only the 1808516d3dc9SWaiman Long * oldest pwq is unplugged, the others are plugged to suspend execution to 1809516d3dc9SWaiman Long * ensure proper work item ordering:: 18104c065dbcSWaiman Long * 18114c065dbcSWaiman Long * dfl_pwq --------------+ [P] - plugged 18124c065dbcSWaiman Long * | 18134c065dbcSWaiman Long * v 18144c065dbcSWaiman Long * pwqs -> A -> B [P] -> C [P] (newest) 18154c065dbcSWaiman Long * | | | 18164c065dbcSWaiman Long * 1 3 5 18174c065dbcSWaiman Long * | | | 18184c065dbcSWaiman Long * 2 4 6 1819516d3dc9SWaiman Long * 1820516d3dc9SWaiman Long * When the oldest pwq is drained and removed, this function should be called 1821516d3dc9SWaiman Long * to unplug the next oldest one to start its work item execution. Note that 1822516d3dc9SWaiman Long * pwq's are linked into wq->pwqs with the oldest first, so the first one in 1823516d3dc9SWaiman Long * the list is the oldest. 18244c065dbcSWaiman Long */ 18254c065dbcSWaiman Long static void unplug_oldest_pwq(struct workqueue_struct *wq) 18264c065dbcSWaiman Long { 18274c065dbcSWaiman Long struct pool_workqueue *pwq; 18284c065dbcSWaiman Long 18294c065dbcSWaiman Long lockdep_assert_held(&wq->mutex); 18304c065dbcSWaiman Long 18314c065dbcSWaiman Long /* Caller should make sure that pwqs isn't empty before calling */ 18324c065dbcSWaiman Long pwq = list_first_entry_or_null(&wq->pwqs, struct pool_workqueue, 18334c065dbcSWaiman Long pwqs_node); 18344c065dbcSWaiman Long raw_spin_lock_irq(&pwq->pool->lock); 18354c065dbcSWaiman Long if (pwq->plugged) { 18364c065dbcSWaiman Long pwq->plugged = false; 18374c065dbcSWaiman Long if (pwq_activate_first_inactive(pwq, true)) 18384c065dbcSWaiman Long kick_pool(pwq->pool); 18394c065dbcSWaiman Long } 18404c065dbcSWaiman Long raw_spin_unlock_irq(&pwq->pool->lock); 18414c065dbcSWaiman Long } 18424c065dbcSWaiman Long 18434c065dbcSWaiman Long /** 18445797b1c1STejun Heo * node_activate_pending_pwq - Activate a pending pwq on a wq_node_nr_active 18455797b1c1STejun Heo * @nna: wq_node_nr_active to activate a pending pwq for 18465797b1c1STejun Heo * @caller_pool: worker_pool the caller is locking 18475797b1c1STejun Heo * 18485797b1c1STejun Heo * Activate a pwq in @nna->pending_pwqs. Called with @caller_pool locked. 18495797b1c1STejun Heo * @caller_pool may be unlocked and relocked to lock other worker_pools. 18505797b1c1STejun Heo */ 18515797b1c1STejun Heo static void node_activate_pending_pwq(struct wq_node_nr_active *nna, 18525797b1c1STejun Heo struct worker_pool *caller_pool) 18535797b1c1STejun Heo { 18545797b1c1STejun Heo struct worker_pool *locked_pool = caller_pool; 18555797b1c1STejun Heo struct pool_workqueue *pwq; 18565797b1c1STejun Heo struct work_struct *work; 18575797b1c1STejun Heo 18585797b1c1STejun Heo lockdep_assert_held(&caller_pool->lock); 18595797b1c1STejun Heo 18605797b1c1STejun Heo raw_spin_lock(&nna->lock); 18615797b1c1STejun Heo retry: 18625797b1c1STejun Heo pwq = list_first_entry_or_null(&nna->pending_pwqs, 18635797b1c1STejun Heo struct pool_workqueue, pending_node); 18645797b1c1STejun Heo if (!pwq) 18655797b1c1STejun Heo goto out_unlock; 18665797b1c1STejun Heo 18675797b1c1STejun Heo /* 18685797b1c1STejun Heo * If @pwq is for a different pool than @locked_pool, we need to lock 18695797b1c1STejun Heo * @pwq->pool->lock. Let's trylock first. If unsuccessful, do the unlock 18705797b1c1STejun Heo * / lock dance. For that, we also need to release @nna->lock as it's 18715797b1c1STejun Heo * nested inside pool locks. 18725797b1c1STejun Heo */ 18735797b1c1STejun Heo if (pwq->pool != locked_pool) { 18745797b1c1STejun Heo raw_spin_unlock(&locked_pool->lock); 18755797b1c1STejun Heo locked_pool = pwq->pool; 18765797b1c1STejun Heo if (!raw_spin_trylock(&locked_pool->lock)) { 18775797b1c1STejun Heo raw_spin_unlock(&nna->lock); 18785797b1c1STejun Heo raw_spin_lock(&locked_pool->lock); 18795797b1c1STejun Heo raw_spin_lock(&nna->lock); 18805797b1c1STejun Heo goto retry; 18815797b1c1STejun Heo } 18825797b1c1STejun Heo } 18835797b1c1STejun Heo 18845797b1c1STejun Heo /* 18855797b1c1STejun Heo * $pwq may not have any inactive work items due to e.g. cancellations. 18865797b1c1STejun Heo * Drop it from pending_pwqs and see if there's another one. 18875797b1c1STejun Heo */ 18885797b1c1STejun Heo work = list_first_entry_or_null(&pwq->inactive_works, 18895797b1c1STejun Heo struct work_struct, entry); 18905797b1c1STejun Heo if (!work) { 18915797b1c1STejun Heo list_del_init(&pwq->pending_node); 18925797b1c1STejun Heo goto retry; 18935797b1c1STejun Heo } 18945797b1c1STejun Heo 18955797b1c1STejun Heo /* 18965797b1c1STejun Heo * Acquire an nr_active count and activate the inactive work item. If 18975797b1c1STejun Heo * $pwq still has inactive work items, rotate it to the end of the 18985797b1c1STejun Heo * pending_pwqs so that we round-robin through them. This means that 18995797b1c1STejun Heo * inactive work items are not activated in queueing order which is fine 19005797b1c1STejun Heo * given that there has never been any ordering across different pwqs. 19015797b1c1STejun Heo */ 19025797b1c1STejun Heo if (likely(tryinc_node_nr_active(nna))) { 19035797b1c1STejun Heo pwq->nr_active++; 19045797b1c1STejun Heo __pwq_activate_work(pwq, work); 19055797b1c1STejun Heo 19065797b1c1STejun Heo if (list_empty(&pwq->inactive_works)) 19075797b1c1STejun Heo list_del_init(&pwq->pending_node); 19085797b1c1STejun Heo else 19095797b1c1STejun Heo list_move_tail(&pwq->pending_node, &nna->pending_pwqs); 19105797b1c1STejun Heo 19115797b1c1STejun Heo /* if activating a foreign pool, make sure it's running */ 19125797b1c1STejun Heo if (pwq->pool != caller_pool) 19135797b1c1STejun Heo kick_pool(pwq->pool); 19145797b1c1STejun Heo } 19155797b1c1STejun Heo 19165797b1c1STejun Heo out_unlock: 19175797b1c1STejun Heo raw_spin_unlock(&nna->lock); 19185797b1c1STejun Heo if (locked_pool != caller_pool) { 19195797b1c1STejun Heo raw_spin_unlock(&locked_pool->lock); 19205797b1c1STejun Heo raw_spin_lock(&caller_pool->lock); 19215797b1c1STejun Heo } 19225797b1c1STejun Heo } 19235797b1c1STejun Heo 19245797b1c1STejun Heo /** 19251c270b79STejun Heo * pwq_dec_nr_active - Retire an active count 19261c270b79STejun Heo * @pwq: pool_workqueue of interest 19271c270b79STejun Heo * 19281c270b79STejun Heo * Decrement @pwq's nr_active and try to activate the first inactive work item. 19295797b1c1STejun Heo * For unbound workqueues, this function may temporarily drop @pwq->pool->lock. 19301c270b79STejun Heo */ 19311c270b79STejun Heo static void pwq_dec_nr_active(struct pool_workqueue *pwq) 19321c270b79STejun Heo { 19331c270b79STejun Heo struct worker_pool *pool = pwq->pool; 193491ccc6e7STejun Heo struct wq_node_nr_active *nna = wq_node_nr_active(pwq->wq, pool->node); 19351c270b79STejun Heo 19361c270b79STejun Heo lockdep_assert_held(&pool->lock); 19371c270b79STejun Heo 193891ccc6e7STejun Heo /* 193991ccc6e7STejun Heo * @pwq->nr_active should be decremented for both percpu and unbound 194091ccc6e7STejun Heo * workqueues. 194191ccc6e7STejun Heo */ 19421c270b79STejun Heo pwq->nr_active--; 194391ccc6e7STejun Heo 194491ccc6e7STejun Heo /* 194591ccc6e7STejun Heo * For a percpu workqueue, it's simple. Just need to kick the first 194691ccc6e7STejun Heo * inactive work item on @pwq itself. 194791ccc6e7STejun Heo */ 194891ccc6e7STejun Heo if (!nna) { 19495797b1c1STejun Heo pwq_activate_first_inactive(pwq, false); 195091ccc6e7STejun Heo return; 195191ccc6e7STejun Heo } 195291ccc6e7STejun Heo 19535797b1c1STejun Heo /* 19545797b1c1STejun Heo * If @pwq is for an unbound workqueue, it's more complicated because 19555797b1c1STejun Heo * multiple pwqs and pools may be sharing the nr_active count. When a 19565797b1c1STejun Heo * pwq needs to wait for an nr_active count, it puts itself on 19575797b1c1STejun Heo * $nna->pending_pwqs. The following atomic_dec_return()'s implied 19585797b1c1STejun Heo * memory barrier is paired with smp_mb() in pwq_tryinc_nr_active() to 19595797b1c1STejun Heo * guarantee that either we see non-empty pending_pwqs or they see 19605797b1c1STejun Heo * decremented $nna->nr. 19615797b1c1STejun Heo * 19625797b1c1STejun Heo * $nna->max may change as CPUs come online/offline and @pwq->wq's 19635797b1c1STejun Heo * max_active gets updated. However, it is guaranteed to be equal to or 19645797b1c1STejun Heo * larger than @pwq->wq->min_active which is above zero unless freezing. 19655797b1c1STejun Heo * This maintains the forward progress guarantee. 19665797b1c1STejun Heo */ 19675797b1c1STejun Heo if (atomic_dec_return(&nna->nr) >= READ_ONCE(nna->max)) 19685797b1c1STejun Heo return; 19695797b1c1STejun Heo 19705797b1c1STejun Heo if (!list_empty(&nna->pending_pwqs)) 19715797b1c1STejun Heo node_activate_pending_pwq(nna, pool); 19723aa62497SLai Jiangshan } 19733aa62497SLai Jiangshan 1974bf4ede01STejun Heo /** 1975112202d9STejun Heo * pwq_dec_nr_in_flight - decrement pwq's nr_in_flight 1976112202d9STejun Heo * @pwq: pwq of interest 1977c4560c2cSLai Jiangshan * @work_data: work_data of work which left the queue 1978bf4ede01STejun Heo * 1979bf4ede01STejun Heo * A work either has completed or is removed from pending queue, 1980112202d9STejun Heo * decrement nr_in_flight of its pwq and handle workqueue flushing. 1981bf4ede01STejun Heo * 1982dd6c3c54STejun Heo * NOTE: 1983dd6c3c54STejun Heo * For unbound workqueues, this function may temporarily drop @pwq->pool->lock 1984dd6c3c54STejun Heo * and thus should be called after all other state updates for the in-flight 1985dd6c3c54STejun Heo * work item is complete. 1986dd6c3c54STejun Heo * 1987bf4ede01STejun Heo * CONTEXT: 1988a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 1989bf4ede01STejun Heo */ 1990c4560c2cSLai Jiangshan static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, unsigned long work_data) 1991bf4ede01STejun Heo { 1992c4560c2cSLai Jiangshan int color = get_work_color(work_data); 1993c4560c2cSLai Jiangshan 19941c270b79STejun Heo if (!(work_data & WORK_STRUCT_INACTIVE)) 19951c270b79STejun Heo pwq_dec_nr_active(pwq); 1996018f3a13SLai Jiangshan 1997018f3a13SLai Jiangshan pwq->nr_in_flight[color]--; 1998bf4ede01STejun Heo 1999bf4ede01STejun Heo /* is flush in progress and are we at the flushing tip? */ 2000112202d9STejun Heo if (likely(pwq->flush_color != color)) 20018864b4e5STejun Heo goto out_put; 2002bf4ede01STejun Heo 2003bf4ede01STejun Heo /* are there still in-flight works? */ 2004112202d9STejun Heo if (pwq->nr_in_flight[color]) 20058864b4e5STejun Heo goto out_put; 2006bf4ede01STejun Heo 2007112202d9STejun Heo /* this pwq is done, clear flush_color */ 2008112202d9STejun Heo pwq->flush_color = -1; 2009bf4ede01STejun Heo 2010bf4ede01STejun Heo /* 2011112202d9STejun Heo * If this was the last pwq, wake up the first flusher. It 2012bf4ede01STejun Heo * will handle the rest. 2013bf4ede01STejun Heo */ 2014112202d9STejun Heo if (atomic_dec_and_test(&pwq->wq->nr_pwqs_to_flush)) 2015112202d9STejun Heo complete(&pwq->wq->first_flusher->done); 20168864b4e5STejun Heo out_put: 20178864b4e5STejun Heo put_pwq(pwq); 2018bf4ede01STejun Heo } 2019bf4ede01STejun Heo 202036e227d2STejun Heo /** 2021bbb68dfaSTejun Heo * try_to_grab_pending - steal work item from worklist and disable irq 202236e227d2STejun Heo * @work: work item to steal 2023c5f5b942STejun Heo * @cflags: %WORK_CANCEL_ flags 2024c26e2f2eSTejun Heo * @irq_flags: place to store irq state 202536e227d2STejun Heo * 202636e227d2STejun Heo * Try to grab PENDING bit of @work. This function can handle @work in any 2027d185af30SYacine Belkadi * stable state - idle, on timer or on worklist. 202836e227d2STejun Heo * 2029d185af30SYacine Belkadi * Return: 20303eb6b31bSMauro Carvalho Chehab * 20313eb6b31bSMauro Carvalho Chehab * ======== ================================================================ 203236e227d2STejun Heo * 1 if @work was pending and we successfully stole PENDING 203336e227d2STejun Heo * 0 if @work was idle and we claimed PENDING 203436e227d2STejun Heo * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry 20353eb6b31bSMauro Carvalho Chehab * ======== ================================================================ 203636e227d2STejun Heo * 2037d185af30SYacine Belkadi * Note: 2038bbb68dfaSTejun Heo * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting 2039e0aecdd8STejun Heo * interrupted while holding PENDING and @work off queue, irq must be 2040e0aecdd8STejun Heo * disabled on entry. This, combined with delayed_work->timer being 2041e0aecdd8STejun Heo * irqsafe, ensures that we return -EAGAIN for finite short period of time. 2042bbb68dfaSTejun Heo * 2043bbb68dfaSTejun Heo * On successful return, >= 0, irq is disabled and the caller is 2044c26e2f2eSTejun Heo * responsible for releasing it using local_irq_restore(*@irq_flags). 2045bbb68dfaSTejun Heo * 2046e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 2047bf4ede01STejun Heo */ 2048c5f5b942STejun Heo static int try_to_grab_pending(struct work_struct *work, u32 cflags, 2049c26e2f2eSTejun Heo unsigned long *irq_flags) 2050bf4ede01STejun Heo { 2051d565ed63STejun Heo struct worker_pool *pool; 2052112202d9STejun Heo struct pool_workqueue *pwq; 2053bf4ede01STejun Heo 2054c26e2f2eSTejun Heo local_irq_save(*irq_flags); 2055bbb68dfaSTejun Heo 205636e227d2STejun Heo /* try to steal the timer if it exists */ 2057c5f5b942STejun Heo if (cflags & WORK_CANCEL_DELAYED) { 205836e227d2STejun Heo struct delayed_work *dwork = to_delayed_work(work); 205936e227d2STejun Heo 2060e0aecdd8STejun Heo /* 2061e0aecdd8STejun Heo * dwork->timer is irqsafe. If del_timer() fails, it's 2062e0aecdd8STejun Heo * guaranteed that the timer is not queued anywhere and not 2063e0aecdd8STejun Heo * running on the local CPU. 2064e0aecdd8STejun Heo */ 206536e227d2STejun Heo if (likely(del_timer(&dwork->timer))) 206636e227d2STejun Heo return 1; 206736e227d2STejun Heo } 206836e227d2STejun Heo 206936e227d2STejun Heo /* try to claim PENDING the normal way */ 2070bf4ede01STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))) 2071bf4ede01STejun Heo return 0; 2072bf4ede01STejun Heo 207324acfb71SThomas Gleixner rcu_read_lock(); 2074bf4ede01STejun Heo /* 2075bf4ede01STejun Heo * The queueing is in progress, or it is already queued. Try to 2076bf4ede01STejun Heo * steal it from ->worklist without clearing WORK_STRUCT_PENDING. 2077bf4ede01STejun Heo */ 2078d565ed63STejun Heo pool = get_work_pool(work); 2079d565ed63STejun Heo if (!pool) 2080bbb68dfaSTejun Heo goto fail; 2081bf4ede01STejun Heo 2082a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&pool->lock); 2083bf4ede01STejun Heo /* 2084112202d9STejun Heo * work->data is guaranteed to point to pwq only while the work 2085112202d9STejun Heo * item is queued on pwq->wq, and both updating work->data to point 2086112202d9STejun Heo * to pwq on queueing and to pool on dequeueing are done under 2087112202d9STejun Heo * pwq->pool->lock. This in turn guarantees that, if work->data 2088112202d9STejun Heo * points to pwq which is associated with a locked pool, the work 20890b3dae68SLai Jiangshan * item is currently queued on that pool. 2090bf4ede01STejun Heo */ 2091112202d9STejun Heo pwq = get_work_pwq(work); 2092112202d9STejun Heo if (pwq && pwq->pool == pool) { 2093b56c7207SLai Jiangshan unsigned long work_data = *work_data_bits(work); 2094c70e1779STejun Heo 2095bf4ede01STejun Heo debug_work_deactivate(work); 20963aa62497SLai Jiangshan 20973aa62497SLai Jiangshan /* 2098018f3a13SLai Jiangshan * A cancelable inactive work item must be in the 2099018f3a13SLai Jiangshan * pwq->inactive_works since a queued barrier can't be 2100018f3a13SLai Jiangshan * canceled (see the comments in insert_wq_barrier()). 2101018f3a13SLai Jiangshan * 2102b56c7207SLai Jiangshan * An inactive work item cannot be deleted directly because 2103d812796eSLai Jiangshan * it might have linked barrier work items which, if left 2104f97a4a1aSLai Jiangshan * on the inactive_works list, will confuse pwq->nr_active 2105b56c7207SLai Jiangshan * management later on and cause stall. Move the linked 2106b56c7207SLai Jiangshan * barrier work items to the worklist when deleting the grabbed 2107b56c7207SLai Jiangshan * item. Also keep WORK_STRUCT_INACTIVE in work_data, so that 2108b56c7207SLai Jiangshan * it doesn't participate in nr_active management in later 2109b56c7207SLai Jiangshan * pwq_dec_nr_in_flight(). 21103aa62497SLai Jiangshan */ 2111b56c7207SLai Jiangshan if (work_data & WORK_STRUCT_INACTIVE) 2112b56c7207SLai Jiangshan move_linked_works(work, &pwq->pool->worklist, NULL); 21133aa62497SLai Jiangshan 2114bf4ede01STejun Heo list_del_init(&work->entry); 211536e227d2STejun Heo 2116c70e1779STejun Heo /* 2117c70e1779STejun Heo * work->data points to pwq iff queued. Let's point to pool. As 2118c70e1779STejun Heo * this destroys work->data needed by the next step, stash it. 2119c70e1779STejun Heo */ 2120456a78eeSTejun Heo set_work_pool_and_keep_pending(work, pool->id, 2121456a78eeSTejun Heo pool_offq_flags(pool)); 21224468a00fSLai Jiangshan 2123dd6c3c54STejun Heo /* must be the last step, see the function comment */ 2124c70e1779STejun Heo pwq_dec_nr_in_flight(pwq, work_data); 2125dd6c3c54STejun Heo 2126a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&pool->lock); 212724acfb71SThomas Gleixner rcu_read_unlock(); 212836e227d2STejun Heo return 1; 2129bf4ede01STejun Heo } 2130a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&pool->lock); 2131bbb68dfaSTejun Heo fail: 213224acfb71SThomas Gleixner rcu_read_unlock(); 2133c26e2f2eSTejun Heo local_irq_restore(*irq_flags); 213436e227d2STejun Heo return -EAGAIN; 2135bf4ede01STejun Heo } 2136bf4ede01STejun Heo 2137978b8409STejun Heo /** 2138978b8409STejun Heo * work_grab_pending - steal work item from worklist and disable irq 2139978b8409STejun Heo * @work: work item to steal 2140978b8409STejun Heo * @cflags: %WORK_CANCEL_ flags 2141978b8409STejun Heo * @irq_flags: place to store IRQ state 2142978b8409STejun Heo * 2143978b8409STejun Heo * Grab PENDING bit of @work. @work can be in any stable state - idle, on timer 2144978b8409STejun Heo * or on worklist. 2145978b8409STejun Heo * 2146f09b10b6STejun Heo * Can be called from any context. IRQ is disabled on return with IRQ state 2147978b8409STejun Heo * stored in *@irq_flags. The caller is responsible for re-enabling it using 2148978b8409STejun Heo * local_irq_restore(). 2149978b8409STejun Heo * 2150978b8409STejun Heo * Returns %true if @work was pending. %false if idle. 2151978b8409STejun Heo */ 2152978b8409STejun Heo static bool work_grab_pending(struct work_struct *work, u32 cflags, 2153978b8409STejun Heo unsigned long *irq_flags) 2154978b8409STejun Heo { 2155978b8409STejun Heo int ret; 2156978b8409STejun Heo 2157f09b10b6STejun Heo while (true) { 2158978b8409STejun Heo ret = try_to_grab_pending(work, cflags, irq_flags); 2159f09b10b6STejun Heo if (ret >= 0) 2160978b8409STejun Heo return ret; 2161f09b10b6STejun Heo cpu_relax(); 2162f09b10b6STejun Heo } 2163978b8409STejun Heo } 2164978b8409STejun Heo 2165bf4ede01STejun Heo /** 2166706026c2STejun Heo * insert_work - insert a work into a pool 2167112202d9STejun Heo * @pwq: pwq @work belongs to 21684690c4abSTejun Heo * @work: work to insert 21694690c4abSTejun Heo * @head: insertion point 21704690c4abSTejun Heo * @extra_flags: extra WORK_STRUCT_* flags to set 21714690c4abSTejun Heo * 2172112202d9STejun Heo * Insert @work which belongs to @pwq after @head. @extra_flags is or'd to 2173706026c2STejun Heo * work_struct flags. 21744690c4abSTejun Heo * 21754690c4abSTejun Heo * CONTEXT: 2176a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 2177365970a1SDavid Howells */ 2178112202d9STejun Heo static void insert_work(struct pool_workqueue *pwq, struct work_struct *work, 2179112202d9STejun Heo struct list_head *head, unsigned int extra_flags) 2180b89deed3SOleg Nesterov { 2181fe089f87STejun Heo debug_work_activate(work); 2182e1d8aa9fSFrederic Weisbecker 2183e89a85d6SWalter Wu /* record the work call stack in order to print it in KASAN reports */ 2184f70da745SMarco Elver kasan_record_aux_stack_noalloc(work); 2185e89a85d6SWalter Wu 21864690c4abSTejun Heo /* we own @work, set data and link */ 2187112202d9STejun Heo set_work_pwq(work, pwq, extra_flags); 21881a4d9b0aSOleg Nesterov list_add_tail(&work->entry, head); 21898864b4e5STejun Heo get_pwq(pwq); 2190b89deed3SOleg Nesterov } 2191b89deed3SOleg Nesterov 2192c8efcc25STejun Heo /* 2193c8efcc25STejun Heo * Test whether @work is being queued from another work executing on the 21948d03ecfeSTejun Heo * same workqueue. 2195c8efcc25STejun Heo */ 2196c8efcc25STejun Heo static bool is_chained_work(struct workqueue_struct *wq) 2197c8efcc25STejun Heo { 2198c8efcc25STejun Heo struct worker *worker; 2199c8efcc25STejun Heo 22008d03ecfeSTejun Heo worker = current_wq_worker(); 2201c8efcc25STejun Heo /* 2202bf393fd4SBart Van Assche * Return %true iff I'm a worker executing a work item on @wq. If 22038d03ecfeSTejun Heo * I'm @worker, it's safe to dereference it without locking. 2204c8efcc25STejun Heo */ 2205112202d9STejun Heo return worker && worker->current_pwq->wq == wq; 2206c8efcc25STejun Heo } 2207c8efcc25STejun Heo 2208ef557180SMike Galbraith /* 2209ef557180SMike Galbraith * When queueing an unbound work item to a wq, prefer local CPU if allowed 2210ef557180SMike Galbraith * by wq_unbound_cpumask. Otherwise, round robin among the allowed ones to 2211ef557180SMike Galbraith * avoid perturbing sensitive tasks. 2212ef557180SMike Galbraith */ 2213ef557180SMike Galbraith static int wq_select_unbound_cpu(int cpu) 2214ef557180SMike Galbraith { 2215ef557180SMike Galbraith int new_cpu; 2216ef557180SMike Galbraith 2217f303fccbSTejun Heo if (likely(!wq_debug_force_rr_cpu)) { 2218ef557180SMike Galbraith if (cpumask_test_cpu(cpu, wq_unbound_cpumask)) 2219ef557180SMike Galbraith return cpu; 2220a8ec5880SAmmar Faizi } else { 2221a8ec5880SAmmar Faizi pr_warn_once("workqueue: round-robin CPU selection forced, expect performance impact\n"); 2222f303fccbSTejun Heo } 2223f303fccbSTejun Heo 2224ef557180SMike Galbraith new_cpu = __this_cpu_read(wq_rr_cpu_last); 2225ef557180SMike Galbraith new_cpu = cpumask_next_and(new_cpu, wq_unbound_cpumask, cpu_online_mask); 2226ef557180SMike Galbraith if (unlikely(new_cpu >= nr_cpu_ids)) { 2227ef557180SMike Galbraith new_cpu = cpumask_first_and(wq_unbound_cpumask, cpu_online_mask); 2228ef557180SMike Galbraith if (unlikely(new_cpu >= nr_cpu_ids)) 2229ef557180SMike Galbraith return cpu; 2230ef557180SMike Galbraith } 2231ef557180SMike Galbraith __this_cpu_write(wq_rr_cpu_last, new_cpu); 2232ef557180SMike Galbraith 2233ef557180SMike Galbraith return new_cpu; 2234ef557180SMike Galbraith } 2235ef557180SMike Galbraith 2236d84ff051STejun Heo static void __queue_work(int cpu, struct workqueue_struct *wq, 22371da177e4SLinus Torvalds struct work_struct *work) 22381da177e4SLinus Torvalds { 2239112202d9STejun Heo struct pool_workqueue *pwq; 2240fe089f87STejun Heo struct worker_pool *last_pool, *pool; 22418a2e8e5dSTejun Heo unsigned int work_flags; 2242b75cac93SJoonsoo Kim unsigned int req_cpu = cpu; 22438930cabaSTejun Heo 22448930cabaSTejun Heo /* 22458930cabaSTejun Heo * While a work item is PENDING && off queue, a task trying to 22468930cabaSTejun Heo * steal the PENDING will busy-loop waiting for it to either get 22478930cabaSTejun Heo * queued or lose PENDING. Grabbing PENDING and queueing should 22488930cabaSTejun Heo * happen with IRQ disabled. 22498930cabaSTejun Heo */ 22508e8eb730SFrederic Weisbecker lockdep_assert_irqs_disabled(); 22511da177e4SLinus Torvalds 225233e3f0a3SRichard Clark /* 225333e3f0a3SRichard Clark * For a draining wq, only works from the same workqueue are 225433e3f0a3SRichard Clark * allowed. The __WQ_DESTROYING helps to spot the issue that 225533e3f0a3SRichard Clark * queues a new work item to a wq after destroy_workqueue(wq). 225633e3f0a3SRichard Clark */ 225733e3f0a3SRichard Clark if (unlikely(wq->flags & (__WQ_DESTROYING | __WQ_DRAINING) && 225833e3f0a3SRichard Clark WARN_ON_ONCE(!is_chained_work(wq)))) 2259e41e704bSTejun Heo return; 226024acfb71SThomas Gleixner rcu_read_lock(); 22619e8cd2f5STejun Heo retry: 2262aa202f1fSHillf Danton /* pwq which will be used unless @work is executing elsewhere */ 2263636b927eSTejun Heo if (req_cpu == WORK_CPU_UNBOUND) { 2264636b927eSTejun Heo if (wq->flags & WQ_UNBOUND) 2265ef557180SMike Galbraith cpu = wq_select_unbound_cpu(raw_smp_processor_id()); 2266636b927eSTejun Heo else 2267aa202f1fSHillf Danton cpu = raw_smp_processor_id(); 2268aa202f1fSHillf Danton } 2269f3421797STejun Heo 2270636b927eSTejun Heo pwq = rcu_dereference(*per_cpu_ptr(wq->cpu_pwq, cpu)); 2271fe089f87STejun Heo pool = pwq->pool; 2272fe089f87STejun Heo 227318aa9effSTejun Heo /* 2274c9178087STejun Heo * If @work was previously on a different pool, it might still be 2275c9178087STejun Heo * running there, in which case the work needs to be queued on that 2276c9178087STejun Heo * pool to guarantee non-reentrancy. 2277*58629d48SLai Jiangshan * 2278*58629d48SLai Jiangshan * For ordered workqueue, work items must be queued on the newest pwq 2279*58629d48SLai Jiangshan * for accurate order management. Guaranteed order also guarantees 2280*58629d48SLai Jiangshan * non-reentrancy. See the comments above unplug_oldest_pwq(). 228118aa9effSTejun Heo */ 2282c9e7cf27STejun Heo last_pool = get_work_pool(work); 2283*58629d48SLai Jiangshan if (last_pool && last_pool != pool && !(wq->flags & __WQ_ORDERED)) { 228418aa9effSTejun Heo struct worker *worker; 228518aa9effSTejun Heo 2286a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&last_pool->lock); 228718aa9effSTejun Heo 2288c9e7cf27STejun Heo worker = find_worker_executing_work(last_pool, work); 228918aa9effSTejun Heo 2290112202d9STejun Heo if (worker && worker->current_pwq->wq == wq) { 2291c9178087STejun Heo pwq = worker->current_pwq; 2292fe089f87STejun Heo pool = pwq->pool; 2293fe089f87STejun Heo WARN_ON_ONCE(pool != last_pool); 22948594fadeSLai Jiangshan } else { 229518aa9effSTejun Heo /* meh... not running there, queue here */ 2296a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&last_pool->lock); 2297fe089f87STejun Heo raw_spin_lock(&pool->lock); 229818aa9effSTejun Heo } 22998930cabaSTejun Heo } else { 2300fe089f87STejun Heo raw_spin_lock(&pool->lock); 23018930cabaSTejun Heo } 2302502ca9d8STejun Heo 23039e8cd2f5STejun Heo /* 2304636b927eSTejun Heo * pwq is determined and locked. For unbound pools, we could have raced 2305636b927eSTejun Heo * with pwq release and it could already be dead. If its refcnt is zero, 2306636b927eSTejun Heo * repeat pwq selection. Note that unbound pwqs never die without 2307636b927eSTejun Heo * another pwq replacing it in cpu_pwq or while work items are executing 2308636b927eSTejun Heo * on it, so the retrying is guaranteed to make forward-progress. 23099e8cd2f5STejun Heo */ 23109e8cd2f5STejun Heo if (unlikely(!pwq->refcnt)) { 23119e8cd2f5STejun Heo if (wq->flags & WQ_UNBOUND) { 2312fe089f87STejun Heo raw_spin_unlock(&pool->lock); 23139e8cd2f5STejun Heo cpu_relax(); 23149e8cd2f5STejun Heo goto retry; 23159e8cd2f5STejun Heo } 23169e8cd2f5STejun Heo /* oops */ 23179e8cd2f5STejun Heo WARN_ONCE(true, "workqueue: per-cpu pwq for %s on cpu%d has 0 refcnt", 23189e8cd2f5STejun Heo wq->name, cpu); 23199e8cd2f5STejun Heo } 23209e8cd2f5STejun Heo 2321112202d9STejun Heo /* pwq determined, queue */ 2322112202d9STejun Heo trace_workqueue_queue_work(req_cpu, pwq, work); 2323502ca9d8STejun Heo 232424acfb71SThomas Gleixner if (WARN_ON(!list_empty(&work->entry))) 232524acfb71SThomas Gleixner goto out; 23261e19ffc6STejun Heo 2327112202d9STejun Heo pwq->nr_in_flight[pwq->work_color]++; 2328112202d9STejun Heo work_flags = work_color_to_flags(pwq->work_color); 23291e19ffc6STejun Heo 2330a045a272STejun Heo /* 2331a045a272STejun Heo * Limit the number of concurrently active work items to max_active. 2332a045a272STejun Heo * @work must also queue behind existing inactive work items to maintain 2333a045a272STejun Heo * ordering when max_active changes. See wq_adjust_max_active(). 2334a045a272STejun Heo */ 23355797b1c1STejun Heo if (list_empty(&pwq->inactive_works) && pwq_tryinc_nr_active(pwq, false)) { 2336fe089f87STejun Heo if (list_empty(&pool->worklist)) 2337fe089f87STejun Heo pool->watchdog_ts = jiffies; 2338fe089f87STejun Heo 2339cdadf009STejun Heo trace_workqueue_activate_work(work); 2340fe089f87STejun Heo insert_work(pwq, work, &pool->worklist, work_flags); 23410219a352STejun Heo kick_pool(pool); 23428a2e8e5dSTejun Heo } else { 2343f97a4a1aSLai Jiangshan work_flags |= WORK_STRUCT_INACTIVE; 2344fe089f87STejun Heo insert_work(pwq, work, &pwq->inactive_works, work_flags); 23458a2e8e5dSTejun Heo } 23461e19ffc6STejun Heo 234724acfb71SThomas Gleixner out: 2348fe089f87STejun Heo raw_spin_unlock(&pool->lock); 234924acfb71SThomas Gleixner rcu_read_unlock(); 23501da177e4SLinus Torvalds } 23511da177e4SLinus Torvalds 235286898fa6STejun Heo static bool clear_pending_if_disabled(struct work_struct *work) 235386898fa6STejun Heo { 235486898fa6STejun Heo unsigned long data = *work_data_bits(work); 235586898fa6STejun Heo struct work_offq_data offqd; 235686898fa6STejun Heo 235786898fa6STejun Heo if (likely((data & WORK_STRUCT_PWQ) || 235886898fa6STejun Heo !(data & WORK_OFFQ_DISABLE_MASK))) 235986898fa6STejun Heo return false; 236086898fa6STejun Heo 236186898fa6STejun Heo work_offqd_unpack(&offqd, data); 236286898fa6STejun Heo set_work_pool_and_clear_pending(work, offqd.pool_id, 236386898fa6STejun Heo work_offqd_pack_flags(&offqd)); 236486898fa6STejun Heo return true; 236586898fa6STejun Heo } 236686898fa6STejun Heo 23670fcb78c2SRolf Eike Beer /** 2368c1a220e7SZhang Rui * queue_work_on - queue work on specific cpu 2369c1a220e7SZhang Rui * @cpu: CPU number to execute work on 2370c1a220e7SZhang Rui * @wq: workqueue to use 2371c1a220e7SZhang Rui * @work: work to queue 2372c1a220e7SZhang Rui * 2373c1a220e7SZhang Rui * We queue the work to a specific CPU, the caller must ensure it 2374443378f0SPaul E. McKenney * can't go away. Callers that fail to ensure that the specified 2375443378f0SPaul E. McKenney * CPU cannot go away will execute on a randomly chosen CPU. 2376854f5cc5SPaul E. McKenney * But note well that callers specifying a CPU that never has been 2377854f5cc5SPaul E. McKenney * online will get a splat. 2378d185af30SYacine Belkadi * 2379d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. 2380c1a220e7SZhang Rui */ 2381d4283e93STejun Heo bool queue_work_on(int cpu, struct workqueue_struct *wq, 2382d4283e93STejun Heo struct work_struct *work) 2383c1a220e7SZhang Rui { 2384d4283e93STejun Heo bool ret = false; 2385c26e2f2eSTejun Heo unsigned long irq_flags; 23868930cabaSTejun Heo 2387c26e2f2eSTejun Heo local_irq_save(irq_flags); 2388c1a220e7SZhang Rui 238986898fa6STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) && 239086898fa6STejun Heo !clear_pending_if_disabled(work)) { 23914690c4abSTejun Heo __queue_work(cpu, wq, work); 2392d4283e93STejun Heo ret = true; 2393c1a220e7SZhang Rui } 23948930cabaSTejun Heo 2395c26e2f2eSTejun Heo local_irq_restore(irq_flags); 2396c1a220e7SZhang Rui return ret; 2397c1a220e7SZhang Rui } 2398ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_work_on); 2399c1a220e7SZhang Rui 24008204e0c1SAlexander Duyck /** 2401fef59c9cSTejun Heo * select_numa_node_cpu - Select a CPU based on NUMA node 24028204e0c1SAlexander Duyck * @node: NUMA node ID that we want to select a CPU from 24038204e0c1SAlexander Duyck * 24048204e0c1SAlexander Duyck * This function will attempt to find a "random" cpu available on a given 24058204e0c1SAlexander Duyck * node. If there are no CPUs available on the given node it will return 24068204e0c1SAlexander Duyck * WORK_CPU_UNBOUND indicating that we should just schedule to any 24078204e0c1SAlexander Duyck * available CPU if we need to schedule this work. 24088204e0c1SAlexander Duyck */ 2409fef59c9cSTejun Heo static int select_numa_node_cpu(int node) 24108204e0c1SAlexander Duyck { 24118204e0c1SAlexander Duyck int cpu; 24128204e0c1SAlexander Duyck 24138204e0c1SAlexander Duyck /* Delay binding to CPU if node is not valid or online */ 24148204e0c1SAlexander Duyck if (node < 0 || node >= MAX_NUMNODES || !node_online(node)) 24158204e0c1SAlexander Duyck return WORK_CPU_UNBOUND; 24168204e0c1SAlexander Duyck 24178204e0c1SAlexander Duyck /* Use local node/cpu if we are already there */ 24188204e0c1SAlexander Duyck cpu = raw_smp_processor_id(); 24198204e0c1SAlexander Duyck if (node == cpu_to_node(cpu)) 24208204e0c1SAlexander Duyck return cpu; 24218204e0c1SAlexander Duyck 24228204e0c1SAlexander Duyck /* Use "random" otherwise know as "first" online CPU of node */ 24238204e0c1SAlexander Duyck cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask); 24248204e0c1SAlexander Duyck 24258204e0c1SAlexander Duyck /* If CPU is valid return that, otherwise just defer */ 24268204e0c1SAlexander Duyck return cpu < nr_cpu_ids ? cpu : WORK_CPU_UNBOUND; 24278204e0c1SAlexander Duyck } 24288204e0c1SAlexander Duyck 24298204e0c1SAlexander Duyck /** 24308204e0c1SAlexander Duyck * queue_work_node - queue work on a "random" cpu for a given NUMA node 24318204e0c1SAlexander Duyck * @node: NUMA node that we are targeting the work for 24328204e0c1SAlexander Duyck * @wq: workqueue to use 24338204e0c1SAlexander Duyck * @work: work to queue 24348204e0c1SAlexander Duyck * 24358204e0c1SAlexander Duyck * We queue the work to a "random" CPU within a given NUMA node. The basic 24368204e0c1SAlexander Duyck * idea here is to provide a way to somehow associate work with a given 24378204e0c1SAlexander Duyck * NUMA node. 24388204e0c1SAlexander Duyck * 24398204e0c1SAlexander Duyck * This function will only make a best effort attempt at getting this onto 24408204e0c1SAlexander Duyck * the right NUMA node. If no node is requested or the requested node is 24418204e0c1SAlexander Duyck * offline then we just fall back to standard queue_work behavior. 24428204e0c1SAlexander Duyck * 24438204e0c1SAlexander Duyck * Currently the "random" CPU ends up being the first available CPU in the 24448204e0c1SAlexander Duyck * intersection of cpu_online_mask and the cpumask of the node, unless we 24458204e0c1SAlexander Duyck * are running on the node. In that case we just use the current CPU. 24468204e0c1SAlexander Duyck * 24478204e0c1SAlexander Duyck * Return: %false if @work was already on a queue, %true otherwise. 24488204e0c1SAlexander Duyck */ 24498204e0c1SAlexander Duyck bool queue_work_node(int node, struct workqueue_struct *wq, 24508204e0c1SAlexander Duyck struct work_struct *work) 24518204e0c1SAlexander Duyck { 2452c26e2f2eSTejun Heo unsigned long irq_flags; 24538204e0c1SAlexander Duyck bool ret = false; 24548204e0c1SAlexander Duyck 24558204e0c1SAlexander Duyck /* 24568204e0c1SAlexander Duyck * This current implementation is specific to unbound workqueues. 24578204e0c1SAlexander Duyck * Specifically we only return the first available CPU for a given 24588204e0c1SAlexander Duyck * node instead of cycling through individual CPUs within the node. 24598204e0c1SAlexander Duyck * 24608204e0c1SAlexander Duyck * If this is used with a per-cpu workqueue then the logic in 24618204e0c1SAlexander Duyck * workqueue_select_cpu_near would need to be updated to allow for 24628204e0c1SAlexander Duyck * some round robin type logic. 24638204e0c1SAlexander Duyck */ 24648204e0c1SAlexander Duyck WARN_ON_ONCE(!(wq->flags & WQ_UNBOUND)); 24658204e0c1SAlexander Duyck 2466c26e2f2eSTejun Heo local_irq_save(irq_flags); 24678204e0c1SAlexander Duyck 246886898fa6STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) && 246986898fa6STejun Heo !clear_pending_if_disabled(work)) { 2470fef59c9cSTejun Heo int cpu = select_numa_node_cpu(node); 24718204e0c1SAlexander Duyck 24728204e0c1SAlexander Duyck __queue_work(cpu, wq, work); 24738204e0c1SAlexander Duyck ret = true; 24748204e0c1SAlexander Duyck } 24758204e0c1SAlexander Duyck 2476c26e2f2eSTejun Heo local_irq_restore(irq_flags); 24778204e0c1SAlexander Duyck return ret; 24788204e0c1SAlexander Duyck } 24798204e0c1SAlexander Duyck EXPORT_SYMBOL_GPL(queue_work_node); 24808204e0c1SAlexander Duyck 24818c20feb6SKees Cook void delayed_work_timer_fn(struct timer_list *t) 24821da177e4SLinus Torvalds { 24838c20feb6SKees Cook struct delayed_work *dwork = from_timer(dwork, t, timer); 24841da177e4SLinus Torvalds 2485e0aecdd8STejun Heo /* should have been called from irqsafe timer with irq already off */ 248660c057bcSLai Jiangshan __queue_work(dwork->cpu, dwork->wq, &dwork->work); 24871da177e4SLinus Torvalds } 24881438ade5SKonstantin Khlebnikov EXPORT_SYMBOL(delayed_work_timer_fn); 24891da177e4SLinus Torvalds 24907beb2edfSTejun Heo static void __queue_delayed_work(int cpu, struct workqueue_struct *wq, 249152bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 24921da177e4SLinus Torvalds { 24937beb2edfSTejun Heo struct timer_list *timer = &dwork->timer; 24947beb2edfSTejun Heo struct work_struct *work = &dwork->work; 24951da177e4SLinus Torvalds 2496637fdbaeSTejun Heo WARN_ON_ONCE(!wq); 24974b243563SSami Tolvanen WARN_ON_ONCE(timer->function != delayed_work_timer_fn); 2498fc4b514fSTejun Heo WARN_ON_ONCE(timer_pending(timer)); 2499fc4b514fSTejun Heo WARN_ON_ONCE(!list_empty(&work->entry)); 25007beb2edfSTejun Heo 25018852aac2STejun Heo /* 25028852aac2STejun Heo * If @delay is 0, queue @dwork->work immediately. This is for 25038852aac2STejun Heo * both optimization and correctness. The earliest @timer can 25048852aac2STejun Heo * expire is on the closest next tick and delayed_work users depend 25058852aac2STejun Heo * on that there's no such delay when @delay is 0. 25068852aac2STejun Heo */ 25078852aac2STejun Heo if (!delay) { 25088852aac2STejun Heo __queue_work(cpu, wq, &dwork->work); 25098852aac2STejun Heo return; 25108852aac2STejun Heo } 25118852aac2STejun Heo 251260c057bcSLai Jiangshan dwork->wq = wq; 25131265057fSTejun Heo dwork->cpu = cpu; 25147beb2edfSTejun Heo timer->expires = jiffies + delay; 25157beb2edfSTejun Heo 2516aae17ebbSLeonardo Bras if (housekeeping_enabled(HK_TYPE_TIMER)) { 2517aae17ebbSLeonardo Bras /* If the current cpu is a housekeeping cpu, use it. */ 2518aae17ebbSLeonardo Bras cpu = smp_processor_id(); 2519aae17ebbSLeonardo Bras if (!housekeeping_test_cpu(cpu, HK_TYPE_TIMER)) 2520aae17ebbSLeonardo Bras cpu = housekeeping_any_cpu(HK_TYPE_TIMER); 25217beb2edfSTejun Heo add_timer_on(timer, cpu); 2522aae17ebbSLeonardo Bras } else { 2523aae17ebbSLeonardo Bras if (likely(cpu == WORK_CPU_UNBOUND)) 2524c0e8c5b5SAnna-Maria Behnsen add_timer_global(timer); 2525aae17ebbSLeonardo Bras else 2526aae17ebbSLeonardo Bras add_timer_on(timer, cpu); 2527aae17ebbSLeonardo Bras } 25287beb2edfSTejun Heo } 25291da177e4SLinus Torvalds 25300fcb78c2SRolf Eike Beer /** 25310fcb78c2SRolf Eike Beer * queue_delayed_work_on - queue work on specific CPU after delay 25320fcb78c2SRolf Eike Beer * @cpu: CPU number to execute work on 25330fcb78c2SRolf Eike Beer * @wq: workqueue to use 2534af9997e4SRandy Dunlap * @dwork: work to queue 25350fcb78c2SRolf Eike Beer * @delay: number of jiffies to wait before queueing 25360fcb78c2SRolf Eike Beer * 2537d185af30SYacine Belkadi * Return: %false if @work was already on a queue, %true otherwise. If 2538715f1300STejun Heo * @delay is zero and @dwork is idle, it will be scheduled for immediate 2539715f1300STejun Heo * execution. 25400fcb78c2SRolf Eike Beer */ 2541d4283e93STejun Heo bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq, 254252bad64dSDavid Howells struct delayed_work *dwork, unsigned long delay) 25437a6bc1cdSVenkatesh Pallipadi { 254452bad64dSDavid Howells struct work_struct *work = &dwork->work; 2545d4283e93STejun Heo bool ret = false; 2546c26e2f2eSTejun Heo unsigned long irq_flags; 25478930cabaSTejun Heo 25488930cabaSTejun Heo /* read the comment in __queue_work() */ 2549c26e2f2eSTejun Heo local_irq_save(irq_flags); 25507a6bc1cdSVenkatesh Pallipadi 255186898fa6STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) && 255286898fa6STejun Heo !clear_pending_if_disabled(work)) { 25537beb2edfSTejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 2554d4283e93STejun Heo ret = true; 25557a6bc1cdSVenkatesh Pallipadi } 25568930cabaSTejun Heo 2557c26e2f2eSTejun Heo local_irq_restore(irq_flags); 25587a6bc1cdSVenkatesh Pallipadi return ret; 25597a6bc1cdSVenkatesh Pallipadi } 2560ad7b1f84SMarc Dionne EXPORT_SYMBOL(queue_delayed_work_on); 25611da177e4SLinus Torvalds 2562c8e55f36STejun Heo /** 25638376fe22STejun Heo * mod_delayed_work_on - modify delay of or queue a delayed work on specific CPU 25648376fe22STejun Heo * @cpu: CPU number to execute work on 25658376fe22STejun Heo * @wq: workqueue to use 25668376fe22STejun Heo * @dwork: work to queue 25678376fe22STejun Heo * @delay: number of jiffies to wait before queueing 25688376fe22STejun Heo * 25698376fe22STejun Heo * If @dwork is idle, equivalent to queue_delayed_work_on(); otherwise, 25708376fe22STejun Heo * modify @dwork's timer so that it expires after @delay. If @delay is 25718376fe22STejun Heo * zero, @work is guaranteed to be scheduled immediately regardless of its 25728376fe22STejun Heo * current state. 25738376fe22STejun Heo * 2574d185af30SYacine Belkadi * Return: %false if @dwork was idle and queued, %true if @dwork was 25758376fe22STejun Heo * pending and its timer was modified. 25768376fe22STejun Heo * 2577e0aecdd8STejun Heo * This function is safe to call from any context including IRQ handler. 25788376fe22STejun Heo * See try_to_grab_pending() for details. 25798376fe22STejun Heo */ 25808376fe22STejun Heo bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq, 25818376fe22STejun Heo struct delayed_work *dwork, unsigned long delay) 25828376fe22STejun Heo { 2583c26e2f2eSTejun Heo unsigned long irq_flags; 2584f09b10b6STejun Heo bool ret; 25858376fe22STejun Heo 2586f09b10b6STejun Heo ret = work_grab_pending(&dwork->work, WORK_CANCEL_DELAYED, &irq_flags); 25878376fe22STejun Heo 2588f09b10b6STejun Heo if (!clear_pending_if_disabled(&dwork->work)) 25898376fe22STejun Heo __queue_delayed_work(cpu, wq, dwork, delay); 25908376fe22STejun Heo 2591f09b10b6STejun Heo local_irq_restore(irq_flags); 25928376fe22STejun Heo return ret; 25938376fe22STejun Heo } 25948376fe22STejun Heo EXPORT_SYMBOL_GPL(mod_delayed_work_on); 25958376fe22STejun Heo 259605f0fe6bSTejun Heo static void rcu_work_rcufn(struct rcu_head *rcu) 259705f0fe6bSTejun Heo { 259805f0fe6bSTejun Heo struct rcu_work *rwork = container_of(rcu, struct rcu_work, rcu); 259905f0fe6bSTejun Heo 260005f0fe6bSTejun Heo /* read the comment in __queue_work() */ 260105f0fe6bSTejun Heo local_irq_disable(); 260205f0fe6bSTejun Heo __queue_work(WORK_CPU_UNBOUND, rwork->wq, &rwork->work); 260305f0fe6bSTejun Heo local_irq_enable(); 260405f0fe6bSTejun Heo } 260505f0fe6bSTejun Heo 260605f0fe6bSTejun Heo /** 260705f0fe6bSTejun Heo * queue_rcu_work - queue work after a RCU grace period 260805f0fe6bSTejun Heo * @wq: workqueue to use 260905f0fe6bSTejun Heo * @rwork: work to queue 261005f0fe6bSTejun Heo * 261105f0fe6bSTejun Heo * Return: %false if @rwork was already pending, %true otherwise. Note 261205f0fe6bSTejun Heo * that a full RCU grace period is guaranteed only after a %true return. 2613bf393fd4SBart Van Assche * While @rwork is guaranteed to be executed after a %false return, the 261405f0fe6bSTejun Heo * execution may happen before a full RCU grace period has passed. 261505f0fe6bSTejun Heo */ 261605f0fe6bSTejun Heo bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork) 261705f0fe6bSTejun Heo { 261805f0fe6bSTejun Heo struct work_struct *work = &rwork->work; 261905f0fe6bSTejun Heo 262086898fa6STejun Heo /* 262186898fa6STejun Heo * rcu_work can't be canceled or disabled. Warn if the user reached 262286898fa6STejun Heo * inside @rwork and disabled the inner work. 262386898fa6STejun Heo */ 262486898fa6STejun Heo if (!test_and_set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work)) && 262586898fa6STejun Heo !WARN_ON_ONCE(clear_pending_if_disabled(work))) { 262605f0fe6bSTejun Heo rwork->wq = wq; 2627a7e30c0eSUladzislau Rezki call_rcu_hurry(&rwork->rcu, rcu_work_rcufn); 262805f0fe6bSTejun Heo return true; 262905f0fe6bSTejun Heo } 263005f0fe6bSTejun Heo 263105f0fe6bSTejun Heo return false; 263205f0fe6bSTejun Heo } 263305f0fe6bSTejun Heo EXPORT_SYMBOL(queue_rcu_work); 263405f0fe6bSTejun Heo 2635f7537df5SLai Jiangshan static struct worker *alloc_worker(int node) 2636c34056a3STejun Heo { 2637c34056a3STejun Heo struct worker *worker; 2638c34056a3STejun Heo 2639f7537df5SLai Jiangshan worker = kzalloc_node(sizeof(*worker), GFP_KERNEL, node); 2640c8e55f36STejun Heo if (worker) { 2641c8e55f36STejun Heo INIT_LIST_HEAD(&worker->entry); 2642affee4b2STejun Heo INIT_LIST_HEAD(&worker->scheduled); 2643da028469SLai Jiangshan INIT_LIST_HEAD(&worker->node); 2644e22bee78STejun Heo /* on creation a worker is in !idle && prep state */ 2645e22bee78STejun Heo worker->flags = WORKER_PREP; 2646c8e55f36STejun Heo } 2647c34056a3STejun Heo return worker; 2648c34056a3STejun Heo } 2649c34056a3STejun Heo 26509546b29eSTejun Heo static cpumask_t *pool_allowed_cpus(struct worker_pool *pool) 26519546b29eSTejun Heo { 26528639ecebSTejun Heo if (pool->cpu < 0 && pool->attrs->affn_strict) 26539546b29eSTejun Heo return pool->attrs->__pod_cpumask; 26548639ecebSTejun Heo else 26558639ecebSTejun Heo return pool->attrs->cpumask; 26569546b29eSTejun Heo } 26579546b29eSTejun Heo 2658c34056a3STejun Heo /** 26594736cbf7SLai Jiangshan * worker_attach_to_pool() - attach a worker to a pool 26604736cbf7SLai Jiangshan * @worker: worker to be attached 26614736cbf7SLai Jiangshan * @pool: the target pool 26624736cbf7SLai Jiangshan * 26634736cbf7SLai Jiangshan * Attach @worker to @pool. Once attached, the %WORKER_UNBOUND flag and 26644736cbf7SLai Jiangshan * cpu-binding of @worker are kept coordinated with the pool across 26654736cbf7SLai Jiangshan * cpu-[un]hotplugs. 26664736cbf7SLai Jiangshan */ 26674736cbf7SLai Jiangshan static void worker_attach_to_pool(struct worker *worker, 26684736cbf7SLai Jiangshan struct worker_pool *pool) 26694736cbf7SLai Jiangshan { 26701258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 26714736cbf7SLai Jiangshan 26724736cbf7SLai Jiangshan /* 26734cb1ef64STejun Heo * The wq_pool_attach_mutex ensures %POOL_DISASSOCIATED remains stable 26744cb1ef64STejun Heo * across this function. See the comments above the flag definition for 26754cb1ef64STejun Heo * details. BH workers are, while per-CPU, always DISASSOCIATED. 26764736cbf7SLai Jiangshan */ 26774cb1ef64STejun Heo if (pool->flags & POOL_DISASSOCIATED) { 26784736cbf7SLai Jiangshan worker->flags |= WORKER_UNBOUND; 26794cb1ef64STejun Heo } else { 26804cb1ef64STejun Heo WARN_ON_ONCE(pool->flags & POOL_BH); 26815c25b5ffSPeter Zijlstra kthread_set_per_cpu(worker->task, pool->cpu); 26824cb1ef64STejun Heo } 26834736cbf7SLai Jiangshan 2684640f17c8SPeter Zijlstra if (worker->rescue_wq) 26859546b29eSTejun Heo set_cpus_allowed_ptr(worker->task, pool_allowed_cpus(pool)); 2686640f17c8SPeter Zijlstra 26874736cbf7SLai Jiangshan list_add_tail(&worker->node, &pool->workers); 2688a2d812a2STejun Heo worker->pool = pool; 26894736cbf7SLai Jiangshan 26901258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 26914736cbf7SLai Jiangshan } 26924736cbf7SLai Jiangshan 2693f45b1c3cSLai Jiangshan static void unbind_worker(struct worker *worker) 2694f45b1c3cSLai Jiangshan { 2695f45b1c3cSLai Jiangshan lockdep_assert_held(&wq_pool_attach_mutex); 2696f45b1c3cSLai Jiangshan 2697f45b1c3cSLai Jiangshan kthread_set_per_cpu(worker->task, -1); 2698f45b1c3cSLai Jiangshan if (cpumask_intersects(wq_unbound_cpumask, cpu_active_mask)) 2699f45b1c3cSLai Jiangshan WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, wq_unbound_cpumask) < 0); 2700f45b1c3cSLai Jiangshan else 2701f45b1c3cSLai Jiangshan WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, cpu_possible_mask) < 0); 2702f45b1c3cSLai Jiangshan } 2703f45b1c3cSLai Jiangshan 2704f4b7b53cSLai Jiangshan 2705f4b7b53cSLai Jiangshan static void detach_worker(struct worker *worker) 2706f4b7b53cSLai Jiangshan { 2707f4b7b53cSLai Jiangshan lockdep_assert_held(&wq_pool_attach_mutex); 2708f4b7b53cSLai Jiangshan 2709f4b7b53cSLai Jiangshan unbind_worker(worker); 2710f4b7b53cSLai Jiangshan list_del(&worker->node); 2711f4b7b53cSLai Jiangshan worker->pool = NULL; 2712f4b7b53cSLai Jiangshan } 2713f4b7b53cSLai Jiangshan 27144736cbf7SLai Jiangshan /** 271560f5a4bcSLai Jiangshan * worker_detach_from_pool() - detach a worker from its pool 271660f5a4bcSLai Jiangshan * @worker: worker which is attached to its pool 271760f5a4bcSLai Jiangshan * 27184736cbf7SLai Jiangshan * Undo the attaching which had been done in worker_attach_to_pool(). The 27194736cbf7SLai Jiangshan * caller worker shouldn't access to the pool after detached except it has 27204736cbf7SLai Jiangshan * other reference to the pool. 272160f5a4bcSLai Jiangshan */ 2722a2d812a2STejun Heo static void worker_detach_from_pool(struct worker *worker) 272360f5a4bcSLai Jiangshan { 2724a2d812a2STejun Heo struct worker_pool *pool = worker->pool; 272560f5a4bcSLai Jiangshan 27264cb1ef64STejun Heo /* there is one permanent BH worker per CPU which should never detach */ 27274cb1ef64STejun Heo WARN_ON_ONCE(pool->flags & POOL_BH); 27284cb1ef64STejun Heo 27291258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 2730f4b7b53cSLai Jiangshan detach_worker(worker); 27311258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 273260f5a4bcSLai Jiangshan 2733b62c0751SLai Jiangshan /* clear leftover flags without pool->lock after it is detached */ 2734b62c0751SLai Jiangshan worker->flags &= ~(WORKER_UNBOUND | WORKER_REBOUND); 273560f5a4bcSLai Jiangshan } 273660f5a4bcSLai Jiangshan 273760f5a4bcSLai Jiangshan /** 2738c34056a3STejun Heo * create_worker - create a new workqueue worker 273963d95a91STejun Heo * @pool: pool the new worker will belong to 2740c34056a3STejun Heo * 2741051e1850SLai Jiangshan * Create and start a new worker which is attached to @pool. 2742c34056a3STejun Heo * 2743c34056a3STejun Heo * CONTEXT: 2744c34056a3STejun Heo * Might sleep. Does GFP_KERNEL allocations. 2745c34056a3STejun Heo * 2746d185af30SYacine Belkadi * Return: 2747c34056a3STejun Heo * Pointer to the newly created worker. 2748c34056a3STejun Heo */ 2749bc2ae0f5STejun Heo static struct worker *create_worker(struct worker_pool *pool) 2750c34056a3STejun Heo { 2751e441b56fSZhen Lei struct worker *worker; 2752e441b56fSZhen Lei int id; 27535d9c7a1eSLucy Mielke char id_buf[23]; 2754c34056a3STejun Heo 27557cda9aaeSLai Jiangshan /* ID is needed to determine kthread name */ 2756e441b56fSZhen Lei id = ida_alloc(&pool->worker_ida, GFP_KERNEL); 27573f0ea0b8SPetr Mladek if (id < 0) { 27583f0ea0b8SPetr Mladek pr_err_once("workqueue: Failed to allocate a worker ID: %pe\n", 27593f0ea0b8SPetr Mladek ERR_PTR(id)); 2760e441b56fSZhen Lei return NULL; 27613f0ea0b8SPetr Mladek } 2762c34056a3STejun Heo 2763f7537df5SLai Jiangshan worker = alloc_worker(pool->node); 27643f0ea0b8SPetr Mladek if (!worker) { 27653f0ea0b8SPetr Mladek pr_err_once("workqueue: Failed to allocate a worker\n"); 2766c34056a3STejun Heo goto fail; 27673f0ea0b8SPetr Mladek } 2768c34056a3STejun Heo 2769c34056a3STejun Heo worker->id = id; 2770c34056a3STejun Heo 27714cb1ef64STejun Heo if (!(pool->flags & POOL_BH)) { 277229c91e99STejun Heo if (pool->cpu >= 0) 2773e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "%d:%d%s", pool->cpu, id, 2774e3c916a4STejun Heo pool->attrs->nice < 0 ? "H" : ""); 2775f3421797STejun Heo else 2776e3c916a4STejun Heo snprintf(id_buf, sizeof(id_buf), "u%d:%d", pool->id, id); 2777e3c916a4STejun Heo 27784cb1ef64STejun Heo worker->task = kthread_create_on_node(worker_thread, worker, 27794cb1ef64STejun Heo pool->node, "kworker/%s", id_buf); 27803f0ea0b8SPetr Mladek if (IS_ERR(worker->task)) { 278160f54038SPetr Mladek if (PTR_ERR(worker->task) == -EINTR) { 278260f54038SPetr Mladek pr_err("workqueue: Interrupted when creating a worker thread \"kworker/%s\"\n", 278360f54038SPetr Mladek id_buf); 278460f54038SPetr Mladek } else { 27853f0ea0b8SPetr Mladek pr_err_once("workqueue: Failed to create a worker thread: %pe", 27863f0ea0b8SPetr Mladek worker->task); 278760f54038SPetr Mladek } 2788c34056a3STejun Heo goto fail; 27893f0ea0b8SPetr Mladek } 2790c34056a3STejun Heo 279191151228SOleg Nesterov set_user_nice(worker->task, pool->attrs->nice); 27929546b29eSTejun Heo kthread_bind_mask(worker->task, pool_allowed_cpus(pool)); 27934cb1ef64STejun Heo } 279491151228SOleg Nesterov 2795da028469SLai Jiangshan /* successful, attach the worker to the pool */ 27964736cbf7SLai Jiangshan worker_attach_to_pool(worker, pool); 2797822d8405STejun Heo 2798051e1850SLai Jiangshan /* start the newly created worker */ 2799a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 28000219a352STejun Heo 2801051e1850SLai Jiangshan worker->pool->nr_workers++; 2802051e1850SLai Jiangshan worker_enter_idle(worker); 28030219a352STejun Heo 28040219a352STejun Heo /* 28050219a352STejun Heo * @worker is waiting on a completion in kthread() and will trigger hung 28066a229b0eSTejun Heo * check if not woken up soon. As kick_pool() is noop if @pool is empty, 28076a229b0eSTejun Heo * wake it up explicitly. 28080219a352STejun Heo */ 28094cb1ef64STejun Heo if (worker->task) 2810051e1850SLai Jiangshan wake_up_process(worker->task); 28110219a352STejun Heo 2812a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2813051e1850SLai Jiangshan 2814c34056a3STejun Heo return worker; 2815822d8405STejun Heo 2816c34056a3STejun Heo fail: 2817e441b56fSZhen Lei ida_free(&pool->worker_ida, id); 2818c34056a3STejun Heo kfree(worker); 2819c34056a3STejun Heo return NULL; 2820c34056a3STejun Heo } 2821c34056a3STejun Heo 2822f4b7b53cSLai Jiangshan static void detach_dying_workers(struct list_head *cull_list) 2823e02b9312SValentin Schneider { 282468f83057SLai Jiangshan struct worker *worker; 2825e02b9312SValentin Schneider 2826f4b7b53cSLai Jiangshan list_for_each_entry(worker, cull_list, entry) 2827f4b7b53cSLai Jiangshan detach_worker(worker); 2828e02b9312SValentin Schneider } 2829e02b9312SValentin Schneider 283068f83057SLai Jiangshan static void reap_dying_workers(struct list_head *cull_list) 283168f83057SLai Jiangshan { 283268f83057SLai Jiangshan struct worker *worker, *tmp; 283368f83057SLai Jiangshan 283468f83057SLai Jiangshan list_for_each_entry_safe(worker, tmp, cull_list, entry) { 283568f83057SLai Jiangshan list_del_init(&worker->entry); 283668f83057SLai Jiangshan kthread_stop_put(worker->task); 283768f83057SLai Jiangshan kfree(worker); 283868f83057SLai Jiangshan } 283968f83057SLai Jiangshan } 284068f83057SLai Jiangshan 2841e02b9312SValentin Schneider /** 2842e02b9312SValentin Schneider * set_worker_dying - Tag a worker for destruction 2843e02b9312SValentin Schneider * @worker: worker to be destroyed 2844e02b9312SValentin Schneider * @list: transfer worker away from its pool->idle_list and into list 2845e02b9312SValentin Schneider * 2846e02b9312SValentin Schneider * Tag @worker for destruction and adjust @pool stats accordingly. The worker 2847e02b9312SValentin Schneider * should be idle. 2848c8e55f36STejun Heo * 2849c8e55f36STejun Heo * CONTEXT: 2850a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 2851c34056a3STejun Heo */ 2852e02b9312SValentin Schneider static void set_worker_dying(struct worker *worker, struct list_head *list) 2853c34056a3STejun Heo { 2854bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 2855c34056a3STejun Heo 2856cd549687STejun Heo lockdep_assert_held(&pool->lock); 2857e02b9312SValentin Schneider lockdep_assert_held(&wq_pool_attach_mutex); 2858cd549687STejun Heo 2859c34056a3STejun Heo /* sanity check frenzy */ 28606183c009STejun Heo if (WARN_ON(worker->current_work) || 286173eb7fe7SLai Jiangshan WARN_ON(!list_empty(&worker->scheduled)) || 286273eb7fe7SLai Jiangshan WARN_ON(!(worker->flags & WORKER_IDLE))) 28636183c009STejun Heo return; 2864c34056a3STejun Heo 2865bd7bdd43STejun Heo pool->nr_workers--; 2866bd7bdd43STejun Heo pool->nr_idle--; 2867c8e55f36STejun Heo 2868cb444766STejun Heo worker->flags |= WORKER_DIE; 2869e02b9312SValentin Schneider 2870e02b9312SValentin Schneider list_move(&worker->entry, list); 287168f83057SLai Jiangshan 287268f83057SLai Jiangshan /* get an extra task struct reference for later kthread_stop_put() */ 287368f83057SLai Jiangshan get_task_struct(worker->task); 2874c34056a3STejun Heo } 2875c34056a3STejun Heo 28763f959aa3SValentin Schneider /** 28773f959aa3SValentin Schneider * idle_worker_timeout - check if some idle workers can now be deleted. 28783f959aa3SValentin Schneider * @t: The pool's idle_timer that just expired 28793f959aa3SValentin Schneider * 28803f959aa3SValentin Schneider * The timer is armed in worker_enter_idle(). Note that it isn't disarmed in 28813f959aa3SValentin Schneider * worker_leave_idle(), as a worker flicking between idle and active while its 28823f959aa3SValentin Schneider * pool is at the too_many_workers() tipping point would cause too much timer 28833f959aa3SValentin Schneider * housekeeping overhead. Since IDLE_WORKER_TIMEOUT is long enough, we just let 28843f959aa3SValentin Schneider * it expire and re-evaluate things from there. 28853f959aa3SValentin Schneider */ 288632a6c723SKees Cook static void idle_worker_timeout(struct timer_list *t) 2887e22bee78STejun Heo { 288832a6c723SKees Cook struct worker_pool *pool = from_timer(pool, t, idle_timer); 28893f959aa3SValentin Schneider bool do_cull = false; 28903f959aa3SValentin Schneider 28913f959aa3SValentin Schneider if (work_pending(&pool->idle_cull_work)) 28923f959aa3SValentin Schneider return; 28933f959aa3SValentin Schneider 28943f959aa3SValentin Schneider raw_spin_lock_irq(&pool->lock); 28953f959aa3SValentin Schneider 28963f959aa3SValentin Schneider if (too_many_workers(pool)) { 28973f959aa3SValentin Schneider struct worker *worker; 28983f959aa3SValentin Schneider unsigned long expires; 28993f959aa3SValentin Schneider 29003f959aa3SValentin Schneider /* idle_list is kept in LIFO order, check the last one */ 2901d70f5d57SLai Jiangshan worker = list_last_entry(&pool->idle_list, struct worker, entry); 29023f959aa3SValentin Schneider expires = worker->last_active + IDLE_WORKER_TIMEOUT; 29033f959aa3SValentin Schneider do_cull = !time_before(jiffies, expires); 29043f959aa3SValentin Schneider 29053f959aa3SValentin Schneider if (!do_cull) 29063f959aa3SValentin Schneider mod_timer(&pool->idle_timer, expires); 29073f959aa3SValentin Schneider } 29083f959aa3SValentin Schneider raw_spin_unlock_irq(&pool->lock); 29093f959aa3SValentin Schneider 29103f959aa3SValentin Schneider if (do_cull) 29113f959aa3SValentin Schneider queue_work(system_unbound_wq, &pool->idle_cull_work); 29123f959aa3SValentin Schneider } 29133f959aa3SValentin Schneider 29143f959aa3SValentin Schneider /** 29153f959aa3SValentin Schneider * idle_cull_fn - cull workers that have been idle for too long. 29163f959aa3SValentin Schneider * @work: the pool's work for handling these idle workers 29173f959aa3SValentin Schneider * 29183f959aa3SValentin Schneider * This goes through a pool's idle workers and gets rid of those that have been 29193f959aa3SValentin Schneider * idle for at least IDLE_WORKER_TIMEOUT seconds. 2920e02b9312SValentin Schneider * 2921e02b9312SValentin Schneider * We don't want to disturb isolated CPUs because of a pcpu kworker being 2922e02b9312SValentin Schneider * culled, so this also resets worker affinity. This requires a sleepable 2923e02b9312SValentin Schneider * context, hence the split between timer callback and work item. 29243f959aa3SValentin Schneider */ 29253f959aa3SValentin Schneider static void idle_cull_fn(struct work_struct *work) 29263f959aa3SValentin Schneider { 29273f959aa3SValentin Schneider struct worker_pool *pool = container_of(work, struct worker_pool, idle_cull_work); 29289680540cSYang Yingliang LIST_HEAD(cull_list); 2929e22bee78STejun Heo 2930e02b9312SValentin Schneider /* 2931e02b9312SValentin Schneider * Grabbing wq_pool_attach_mutex here ensures an already-running worker 2932f4b7b53cSLai Jiangshan * cannot proceed beyong set_pf_worker() in its self-destruct path. 2933f4b7b53cSLai Jiangshan * This is required as a previously-preempted worker could run after 2934f4b7b53cSLai Jiangshan * set_worker_dying() has happened but before detach_dying_workers() did. 2935e02b9312SValentin Schneider */ 2936e02b9312SValentin Schneider mutex_lock(&wq_pool_attach_mutex); 2937a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2938e22bee78STejun Heo 29393347fc9fSLai Jiangshan while (too_many_workers(pool)) { 2940e22bee78STejun Heo struct worker *worker; 2941e22bee78STejun Heo unsigned long expires; 2942e22bee78STejun Heo 2943d70f5d57SLai Jiangshan worker = list_last_entry(&pool->idle_list, struct worker, entry); 2944e22bee78STejun Heo expires = worker->last_active + IDLE_WORKER_TIMEOUT; 2945e22bee78STejun Heo 29463347fc9fSLai Jiangshan if (time_before(jiffies, expires)) { 294763d95a91STejun Heo mod_timer(&pool->idle_timer, expires); 29483347fc9fSLai Jiangshan break; 2949e22bee78STejun Heo } 29503347fc9fSLai Jiangshan 2951e02b9312SValentin Schneider set_worker_dying(worker, &cull_list); 2952e22bee78STejun Heo } 2953e22bee78STejun Heo 2954a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 2955f4b7b53cSLai Jiangshan detach_dying_workers(&cull_list); 2956e02b9312SValentin Schneider mutex_unlock(&wq_pool_attach_mutex); 295768f83057SLai Jiangshan 295868f83057SLai Jiangshan reap_dying_workers(&cull_list); 2959e22bee78STejun Heo } 2960e22bee78STejun Heo 2961493a1724STejun Heo static void send_mayday(struct work_struct *work) 2962e22bee78STejun Heo { 2963112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 2964112202d9STejun Heo struct workqueue_struct *wq = pwq->wq; 2965493a1724STejun Heo 29662e109a28STejun Heo lockdep_assert_held(&wq_mayday_lock); 2967e22bee78STejun Heo 2968493008a8STejun Heo if (!wq->rescuer) 2969493a1724STejun Heo return; 2970e22bee78STejun Heo 2971e22bee78STejun Heo /* mayday mayday mayday */ 2972493a1724STejun Heo if (list_empty(&pwq->mayday_node)) { 297377668c8bSLai Jiangshan /* 297477668c8bSLai Jiangshan * If @pwq is for an unbound wq, its base ref may be put at 297577668c8bSLai Jiangshan * any time due to an attribute change. Pin @pwq until the 297677668c8bSLai Jiangshan * rescuer is done with it. 297777668c8bSLai Jiangshan */ 297877668c8bSLai Jiangshan get_pwq(pwq); 2979493a1724STejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 2980e22bee78STejun Heo wake_up_process(wq->rescuer->task); 2981725e8ec5STejun Heo pwq->stats[PWQ_STAT_MAYDAY]++; 2982493a1724STejun Heo } 2983e22bee78STejun Heo } 2984e22bee78STejun Heo 298532a6c723SKees Cook static void pool_mayday_timeout(struct timer_list *t) 2986e22bee78STejun Heo { 298732a6c723SKees Cook struct worker_pool *pool = from_timer(pool, t, mayday_timer); 2988e22bee78STejun Heo struct work_struct *work; 2989e22bee78STejun Heo 2990a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 2991a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&wq_mayday_lock); /* for wq->maydays */ 2992e22bee78STejun Heo 299363d95a91STejun Heo if (need_to_create_worker(pool)) { 2994e22bee78STejun Heo /* 2995e22bee78STejun Heo * We've been trying to create a new worker but 2996e22bee78STejun Heo * haven't been successful. We might be hitting an 2997e22bee78STejun Heo * allocation deadlock. Send distress signals to 2998e22bee78STejun Heo * rescuers. 2999e22bee78STejun Heo */ 300063d95a91STejun Heo list_for_each_entry(work, &pool->worklist, entry) 3001e22bee78STejun Heo send_mayday(work); 3002e22bee78STejun Heo } 3003e22bee78STejun Heo 3004a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&wq_mayday_lock); 3005a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 3006e22bee78STejun Heo 300763d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INTERVAL); 3008e22bee78STejun Heo } 3009e22bee78STejun Heo 3010e22bee78STejun Heo /** 3011e22bee78STejun Heo * maybe_create_worker - create a new worker if necessary 301263d95a91STejun Heo * @pool: pool to create a new worker for 3013e22bee78STejun Heo * 301463d95a91STejun Heo * Create a new worker for @pool if necessary. @pool is guaranteed to 3015e22bee78STejun Heo * have at least one idle worker on return from this function. If 3016e22bee78STejun Heo * creating a new worker takes longer than MAYDAY_INTERVAL, mayday is 301763d95a91STejun Heo * sent to all rescuers with works scheduled on @pool to resolve 3018e22bee78STejun Heo * possible allocation deadlock. 3019e22bee78STejun Heo * 3020c5aa87bbSTejun Heo * On return, need_to_create_worker() is guaranteed to be %false and 3021c5aa87bbSTejun Heo * may_start_working() %true. 3022e22bee78STejun Heo * 3023e22bee78STejun Heo * LOCKING: 3024a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 3025e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. Called only from 3026e22bee78STejun Heo * manager. 3027e22bee78STejun Heo */ 302829187a9eSTejun Heo static void maybe_create_worker(struct worker_pool *pool) 3029d565ed63STejun Heo __releases(&pool->lock) 3030d565ed63STejun Heo __acquires(&pool->lock) 3031e22bee78STejun Heo { 3032e22bee78STejun Heo restart: 3033a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 30349f9c2364STejun Heo 3035e22bee78STejun Heo /* if we don't make progress in MAYDAY_INITIAL_TIMEOUT, call for help */ 303663d95a91STejun Heo mod_timer(&pool->mayday_timer, jiffies + MAYDAY_INITIAL_TIMEOUT); 3037e22bee78STejun Heo 3038e22bee78STejun Heo while (true) { 3039051e1850SLai Jiangshan if (create_worker(pool) || !need_to_create_worker(pool)) 3040e22bee78STejun Heo break; 3041e22bee78STejun Heo 3042e212f361SLai Jiangshan schedule_timeout_interruptible(CREATE_COOLDOWN); 30439f9c2364STejun Heo 304463d95a91STejun Heo if (!need_to_create_worker(pool)) 3045e22bee78STejun Heo break; 3046e22bee78STejun Heo } 3047e22bee78STejun Heo 304863d95a91STejun Heo del_timer_sync(&pool->mayday_timer); 3049a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 3050051e1850SLai Jiangshan /* 3051051e1850SLai Jiangshan * This is necessary even after a new worker was just successfully 3052051e1850SLai Jiangshan * created as @pool->lock was dropped and the new worker might have 3053051e1850SLai Jiangshan * already become busy. 3054051e1850SLai Jiangshan */ 305563d95a91STejun Heo if (need_to_create_worker(pool)) 3056e22bee78STejun Heo goto restart; 3057e22bee78STejun Heo } 3058e22bee78STejun Heo 3059e22bee78STejun Heo /** 3060e22bee78STejun Heo * manage_workers - manage worker pool 3061e22bee78STejun Heo * @worker: self 3062e22bee78STejun Heo * 3063706026c2STejun Heo * Assume the manager role and manage the worker pool @worker belongs 3064e22bee78STejun Heo * to. At any given time, there can be only zero or one manager per 3065706026c2STejun Heo * pool. The exclusion is handled automatically by this function. 3066e22bee78STejun Heo * 3067e22bee78STejun Heo * The caller can safely start processing works on false return. On 3068e22bee78STejun Heo * true return, it's guaranteed that need_to_create_worker() is false 3069e22bee78STejun Heo * and may_start_working() is true. 3070e22bee78STejun Heo * 3071e22bee78STejun Heo * CONTEXT: 3072a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 3073e22bee78STejun Heo * multiple times. Does GFP_KERNEL allocations. 3074e22bee78STejun Heo * 3075d185af30SYacine Belkadi * Return: 307629187a9eSTejun Heo * %false if the pool doesn't need management and the caller can safely 307729187a9eSTejun Heo * start processing works, %true if management function was performed and 307829187a9eSTejun Heo * the conditions that the caller verified before calling the function may 307929187a9eSTejun Heo * no longer be true. 3080e22bee78STejun Heo */ 3081e22bee78STejun Heo static bool manage_workers(struct worker *worker) 3082e22bee78STejun Heo { 308363d95a91STejun Heo struct worker_pool *pool = worker->pool; 3084e22bee78STejun Heo 3085692b4825STejun Heo if (pool->flags & POOL_MANAGER_ACTIVE) 308629187a9eSTejun Heo return false; 3087692b4825STejun Heo 3088692b4825STejun Heo pool->flags |= POOL_MANAGER_ACTIVE; 30892607d7a6STejun Heo pool->manager = worker; 3090e22bee78STejun Heo 309129187a9eSTejun Heo maybe_create_worker(pool); 3092e22bee78STejun Heo 30932607d7a6STejun Heo pool->manager = NULL; 3094692b4825STejun Heo pool->flags &= ~POOL_MANAGER_ACTIVE; 3095d8bb65abSSebastian Andrzej Siewior rcuwait_wake_up(&manager_wait); 309629187a9eSTejun Heo return true; 3097e22bee78STejun Heo } 3098e22bee78STejun Heo 3099a62428c0STejun Heo /** 3100a62428c0STejun Heo * process_one_work - process single work 3101c34056a3STejun Heo * @worker: self 3102a62428c0STejun Heo * @work: work to process 3103a62428c0STejun Heo * 3104a62428c0STejun Heo * Process @work. This function contains all the logics necessary to 3105a62428c0STejun Heo * process a single work including synchronization against and 3106a62428c0STejun Heo * interaction with other workers on the same cpu, queueing and 3107a62428c0STejun Heo * flushing. As long as context requirement is met, any worker can 3108a62428c0STejun Heo * call this function to process a work. 3109a62428c0STejun Heo * 3110a62428c0STejun Heo * CONTEXT: 3111a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which is released and regrabbed. 3112a62428c0STejun Heo */ 3113c34056a3STejun Heo static void process_one_work(struct worker *worker, struct work_struct *work) 3114d565ed63STejun Heo __releases(&pool->lock) 3115d565ed63STejun Heo __acquires(&pool->lock) 31161da177e4SLinus Torvalds { 3117112202d9STejun Heo struct pool_workqueue *pwq = get_work_pwq(work); 3118bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 3119c4560c2cSLai Jiangshan unsigned long work_data; 3120c35aea39STejun Heo int lockdep_start_depth, rcu_start_depth; 31211acd92d9STejun Heo bool bh_draining = pool->flags & POOL_BH_DRAINING; 31224e6045f1SJohannes Berg #ifdef CONFIG_LOCKDEP 31234e6045f1SJohannes Berg /* 3124a62428c0STejun Heo * It is permissible to free the struct work_struct from 3125a62428c0STejun Heo * inside the function that is called from it, this we need to 3126a62428c0STejun Heo * take into account for lockdep too. To avoid bogus "held 3127a62428c0STejun Heo * lock freed" warnings as well as problems when looking into 3128a62428c0STejun Heo * work->lockdep_map, make a copy and use that here. 31294e6045f1SJohannes Berg */ 31304d82a1deSPeter Zijlstra struct lockdep_map lockdep_map; 31314d82a1deSPeter Zijlstra 31324d82a1deSPeter Zijlstra lockdep_copy_map(&lockdep_map, &work->lockdep_map); 31334e6045f1SJohannes Berg #endif 3134807407c0SLai Jiangshan /* ensure we're on the correct CPU */ 313585327af6SLai Jiangshan WARN_ON_ONCE(!(pool->flags & POOL_DISASSOCIATED) && 3136ec22ca5eSTejun Heo raw_smp_processor_id() != pool->cpu); 313725511a47STejun Heo 31388930cabaSTejun Heo /* claim and dequeue */ 3139dc186ad7SThomas Gleixner debug_work_deactivate(work); 3140c9e7cf27STejun Heo hash_add(pool->busy_hash, &worker->hentry, (unsigned long)work); 3141c34056a3STejun Heo worker->current_work = work; 3142a2c1c57bSTejun Heo worker->current_func = work->func; 3143112202d9STejun Heo worker->current_pwq = pwq; 31444cb1ef64STejun Heo if (worker->task) 3145616db877STejun Heo worker->current_at = worker->task->se.sum_exec_runtime; 3146c4560c2cSLai Jiangshan work_data = *work_data_bits(work); 3147d812796eSLai Jiangshan worker->current_color = get_work_color(work_data); 31487a22ad75STejun Heo 31498bf89593STejun Heo /* 31508bf89593STejun Heo * Record wq name for cmdline and debug reporting, may get 31518bf89593STejun Heo * overridden through set_worker_desc(). 31528bf89593STejun Heo */ 31538bf89593STejun Heo strscpy(worker->desc, pwq->wq->name, WORKER_DESC_LEN); 31548bf89593STejun Heo 3155a62428c0STejun Heo list_del_init(&work->entry); 3156a62428c0STejun Heo 3157649027d7STejun Heo /* 3158228f1d00SLai Jiangshan * CPU intensive works don't participate in concurrency management. 3159228f1d00SLai Jiangshan * They're the scheduler's responsibility. This takes @worker out 3160228f1d00SLai Jiangshan * of concurrency management and the next code block will chain 3161228f1d00SLai Jiangshan * execution of the pending work items. 3162fb0e7bebSTejun Heo */ 3163616db877STejun Heo if (unlikely(pwq->wq->flags & WQ_CPU_INTENSIVE)) 3164228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_CPU_INTENSIVE); 3165fb0e7bebSTejun Heo 3166974271c4STejun Heo /* 31670219a352STejun Heo * Kick @pool if necessary. It's always noop for per-cpu worker pools 31680219a352STejun Heo * since nr_running would always be >= 1 at this point. This is used to 31690219a352STejun Heo * chain execution of the pending work items for WORKER_NOT_RUNNING 31700219a352STejun Heo * workers such as the UNBOUND and CPU_INTENSIVE ones. 3171974271c4STejun Heo */ 31720219a352STejun Heo kick_pool(pool); 3173974271c4STejun Heo 31748930cabaSTejun Heo /* 31757c3eed5cSTejun Heo * Record the last pool and clear PENDING which should be the last 3176d565ed63STejun Heo * update to @work. Also, do this inside @pool->lock so that 317723657bb1STejun Heo * PENDING and queued state changes happen together while IRQ is 317823657bb1STejun Heo * disabled. 31798930cabaSTejun Heo */ 3180456a78eeSTejun Heo set_work_pool_and_clear_pending(work, pool->id, pool_offq_flags(pool)); 31811da177e4SLinus Torvalds 3182fe48ba7dSMirsad Goran Todorovac pwq->stats[PWQ_STAT_STARTED]++; 3183a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 3184365970a1SDavid Howells 3185c35aea39STejun Heo rcu_start_depth = rcu_preempt_depth(); 3186c35aea39STejun Heo lockdep_start_depth = lockdep_depth(current); 31871acd92d9STejun Heo /* see drain_dead_softirq_workfn() */ 31881acd92d9STejun Heo if (!bh_draining) 3189a1d14934SPeter Zijlstra lock_map_acquire(&pwq->wq->lockdep_map); 31903295f0efSIngo Molnar lock_map_acquire(&lockdep_map); 3191e6f3faa7SPeter Zijlstra /* 3192f52be570SPeter Zijlstra * Strictly speaking we should mark the invariant state without holding 3193f52be570SPeter Zijlstra * any locks, that is, before these two lock_map_acquire()'s. 3194e6f3faa7SPeter Zijlstra * 3195e6f3faa7SPeter Zijlstra * However, that would result in: 3196e6f3faa7SPeter Zijlstra * 3197e6f3faa7SPeter Zijlstra * A(W1) 3198e6f3faa7SPeter Zijlstra * WFC(C) 3199e6f3faa7SPeter Zijlstra * A(W1) 3200e6f3faa7SPeter Zijlstra * C(C) 3201e6f3faa7SPeter Zijlstra * 3202e6f3faa7SPeter Zijlstra * Which would create W1->C->W1 dependencies, even though there is no 3203e6f3faa7SPeter Zijlstra * actual deadlock possible. There are two solutions, using a 3204e6f3faa7SPeter Zijlstra * read-recursive acquire on the work(queue) 'locks', but this will then 3205f52be570SPeter Zijlstra * hit the lockdep limitation on recursive locks, or simply discard 3206e6f3faa7SPeter Zijlstra * these locks. 3207e6f3faa7SPeter Zijlstra * 3208e6f3faa7SPeter Zijlstra * AFAICT there is no possible deadlock scenario between the 3209e6f3faa7SPeter Zijlstra * flush_work() and complete() primitives (except for single-threaded 3210e6f3faa7SPeter Zijlstra * workqueues), so hiding them isn't a problem. 3211e6f3faa7SPeter Zijlstra */ 3212f52be570SPeter Zijlstra lockdep_invariant_state(true); 3213e36c886aSArjan van de Ven trace_workqueue_execute_start(work); 3214a2c1c57bSTejun Heo worker->current_func(work); 3215e36c886aSArjan van de Ven /* 3216e36c886aSArjan van de Ven * While we must be careful to not use "work" after this, the trace 3217e36c886aSArjan van de Ven * point will only record its address. 3218e36c886aSArjan van de Ven */ 32191c5da0ecSDaniel Jordan trace_workqueue_execute_end(work, worker->current_func); 3220725e8ec5STejun Heo pwq->stats[PWQ_STAT_COMPLETED]++; 32213295f0efSIngo Molnar lock_map_release(&lockdep_map); 32221acd92d9STejun Heo if (!bh_draining) 3223112202d9STejun Heo lock_map_release(&pwq->wq->lockdep_map); 32241da177e4SLinus Torvalds 3225c35aea39STejun Heo if (unlikely((worker->task && in_atomic()) || 3226c35aea39STejun Heo lockdep_depth(current) != lockdep_start_depth || 3227c35aea39STejun Heo rcu_preempt_depth() != rcu_start_depth)) { 3228c35aea39STejun Heo pr_err("BUG: workqueue leaked atomic, lock or RCU: %s[%d]\n" 3229c35aea39STejun Heo " preempt=0x%08x lock=%d->%d RCU=%d->%d workfn=%ps\n", 3230c35aea39STejun Heo current->comm, task_pid_nr(current), preempt_count(), 3231c35aea39STejun Heo lockdep_start_depth, lockdep_depth(current), 3232c35aea39STejun Heo rcu_start_depth, rcu_preempt_depth(), 3233c35aea39STejun Heo worker->current_func); 3234d5abe669SPeter Zijlstra debug_show_held_locks(current); 3235d5abe669SPeter Zijlstra dump_stack(); 3236d5abe669SPeter Zijlstra } 3237d5abe669SPeter Zijlstra 3238b22ce278STejun Heo /* 3239025f50f3SSebastian Andrzej Siewior * The following prevents a kworker from hogging CPU on !PREEMPTION 3240b22ce278STejun Heo * kernels, where a requeueing work item waiting for something to 3241b22ce278STejun Heo * happen could deadlock with stop_machine as such work item could 3242b22ce278STejun Heo * indefinitely requeue itself while all other CPUs are trapped in 3243789cbbecSJoe Lawrence * stop_machine. At the same time, report a quiescent RCU state so 3244789cbbecSJoe Lawrence * the same condition doesn't freeze RCU. 3245b22ce278STejun Heo */ 32464cb1ef64STejun Heo if (worker->task) 3247a7e6425eSPaul E. McKenney cond_resched(); 3248b22ce278STejun Heo 3249a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 3250a62428c0STejun Heo 3251616db877STejun Heo /* 3252616db877STejun Heo * In addition to %WQ_CPU_INTENSIVE, @worker may also have been marked 3253616db877STejun Heo * CPU intensive by wq_worker_tick() if @work hogged CPU longer than 3254616db877STejun Heo * wq_cpu_intensive_thresh_us. Clear it. 3255616db877STejun Heo */ 3256fb0e7bebSTejun Heo worker_clr_flags(worker, WORKER_CPU_INTENSIVE); 3257fb0e7bebSTejun Heo 32581b69ac6bSJohannes Weiner /* tag the worker for identification in schedule() */ 32591b69ac6bSJohannes Weiner worker->last_func = worker->current_func; 32601b69ac6bSJohannes Weiner 3261a62428c0STejun Heo /* we're done with it, release */ 326242f8570fSSasha Levin hash_del(&worker->hentry); 3263c34056a3STejun Heo worker->current_work = NULL; 3264a2c1c57bSTejun Heo worker->current_func = NULL; 3265112202d9STejun Heo worker->current_pwq = NULL; 3266d812796eSLai Jiangshan worker->current_color = INT_MAX; 3267dd6c3c54STejun Heo 3268dd6c3c54STejun Heo /* must be the last step, see the function comment */ 3269c4560c2cSLai Jiangshan pwq_dec_nr_in_flight(pwq, work_data); 32701da177e4SLinus Torvalds } 32711da177e4SLinus Torvalds 3272affee4b2STejun Heo /** 3273affee4b2STejun Heo * process_scheduled_works - process scheduled works 3274affee4b2STejun Heo * @worker: self 3275affee4b2STejun Heo * 3276affee4b2STejun Heo * Process all scheduled works. Please note that the scheduled list 3277affee4b2STejun Heo * may change while processing a work, so this function repeatedly 3278affee4b2STejun Heo * fetches a work from the top and executes it. 3279affee4b2STejun Heo * 3280affee4b2STejun Heo * CONTEXT: 3281a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock) which may be released and regrabbed 3282affee4b2STejun Heo * multiple times. 3283affee4b2STejun Heo */ 3284affee4b2STejun Heo static void process_scheduled_works(struct worker *worker) 32851da177e4SLinus Torvalds { 3286c0ab017dSTejun Heo struct work_struct *work; 3287c0ab017dSTejun Heo bool first = true; 3288c0ab017dSTejun Heo 3289c0ab017dSTejun Heo while ((work = list_first_entry_or_null(&worker->scheduled, 3290c0ab017dSTejun Heo struct work_struct, entry))) { 3291c0ab017dSTejun Heo if (first) { 3292c0ab017dSTejun Heo worker->pool->watchdog_ts = jiffies; 3293c0ab017dSTejun Heo first = false; 3294c0ab017dSTejun Heo } 3295c34056a3STejun Heo process_one_work(worker, work); 3296a62428c0STejun Heo } 32971da177e4SLinus Torvalds } 32981da177e4SLinus Torvalds 3299197f6accSTejun Heo static void set_pf_worker(bool val) 3300197f6accSTejun Heo { 3301197f6accSTejun Heo mutex_lock(&wq_pool_attach_mutex); 3302197f6accSTejun Heo if (val) 3303197f6accSTejun Heo current->flags |= PF_WQ_WORKER; 3304197f6accSTejun Heo else 3305197f6accSTejun Heo current->flags &= ~PF_WQ_WORKER; 3306197f6accSTejun Heo mutex_unlock(&wq_pool_attach_mutex); 3307197f6accSTejun Heo } 3308197f6accSTejun Heo 33094690c4abSTejun Heo /** 33104690c4abSTejun Heo * worker_thread - the worker thread function 3311c34056a3STejun Heo * @__worker: self 33124690c4abSTejun Heo * 3313c5aa87bbSTejun Heo * The worker thread function. All workers belong to a worker_pool - 3314c5aa87bbSTejun Heo * either a per-cpu one or dynamic unbound one. These workers process all 3315c5aa87bbSTejun Heo * work items regardless of their specific target workqueue. The only 3316c5aa87bbSTejun Heo * exception is work items which belong to workqueues with a rescuer which 3317c5aa87bbSTejun Heo * will be explained in rescuer_thread(). 3318d185af30SYacine Belkadi * 3319d185af30SYacine Belkadi * Return: 0 33204690c4abSTejun Heo */ 3321c34056a3STejun Heo static int worker_thread(void *__worker) 33221da177e4SLinus Torvalds { 3323c34056a3STejun Heo struct worker *worker = __worker; 3324bd7bdd43STejun Heo struct worker_pool *pool = worker->pool; 33251da177e4SLinus Torvalds 3326e22bee78STejun Heo /* tell the scheduler that this is a workqueue worker */ 3327197f6accSTejun Heo set_pf_worker(true); 3328c8e55f36STejun Heo woke_up: 3329a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 3330affee4b2STejun Heo 3331a9ab775bSTejun Heo /* am I supposed to die? */ 3332a9ab775bSTejun Heo if (unlikely(worker->flags & WORKER_DIE)) { 3333a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 3334197f6accSTejun Heo set_pf_worker(false); 333560f5a4bcSLai Jiangshan 333660f5a4bcSLai Jiangshan set_task_comm(worker->task, "kworker/dying"); 3337e441b56fSZhen Lei ida_free(&pool->worker_ida, worker->id); 3338e02b9312SValentin Schneider WARN_ON_ONCE(!list_empty(&worker->entry)); 3339c8e55f36STejun Heo return 0; 3340c8e55f36STejun Heo } 3341c8e55f36STejun Heo 3342c8e55f36STejun Heo worker_leave_idle(worker); 3343db7bccf4STejun Heo recheck: 3344e22bee78STejun Heo /* no more worker necessary? */ 334563d95a91STejun Heo if (!need_more_worker(pool)) 3346e22bee78STejun Heo goto sleep; 3347e22bee78STejun Heo 3348e22bee78STejun Heo /* do we need to manage? */ 334963d95a91STejun Heo if (unlikely(!may_start_working(pool)) && manage_workers(worker)) 3350e22bee78STejun Heo goto recheck; 3351e22bee78STejun Heo 3352c8e55f36STejun Heo /* 3353c8e55f36STejun Heo * ->scheduled list can only be filled while a worker is 3354c8e55f36STejun Heo * preparing to process a work or actually processing it. 3355c8e55f36STejun Heo * Make sure nobody diddled with it while I was sleeping. 3356c8e55f36STejun Heo */ 33576183c009STejun Heo WARN_ON_ONCE(!list_empty(&worker->scheduled)); 3358c8e55f36STejun Heo 3359e22bee78STejun Heo /* 3360a9ab775bSTejun Heo * Finish PREP stage. We're guaranteed to have at least one idle 3361a9ab775bSTejun Heo * worker or that someone else has already assumed the manager 3362a9ab775bSTejun Heo * role. This is where @worker starts participating in concurrency 3363a9ab775bSTejun Heo * management if applicable and concurrency management is restored 3364a9ab775bSTejun Heo * after being rebound. See rebind_workers() for details. 3365e22bee78STejun Heo */ 3366a9ab775bSTejun Heo worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND); 3367e22bee78STejun Heo 3368e22bee78STejun Heo do { 3369affee4b2STejun Heo struct work_struct *work = 3370bd7bdd43STejun Heo list_first_entry(&pool->worklist, 3371affee4b2STejun Heo struct work_struct, entry); 3372affee4b2STejun Heo 3373873eaca6STejun Heo if (assign_work(work, worker, NULL)) 3374affee4b2STejun Heo process_scheduled_works(worker); 337563d95a91STejun Heo } while (keep_working(pool)); 3376affee4b2STejun Heo 3377228f1d00SLai Jiangshan worker_set_flags(worker, WORKER_PREP); 3378d313dd85STejun Heo sleep: 3379c8e55f36STejun Heo /* 3380d565ed63STejun Heo * pool->lock is held and there's no work to process and no need to 3381d565ed63STejun Heo * manage, sleep. Workers are woken up only while holding 3382d565ed63STejun Heo * pool->lock or from local cpu, so setting the current state 3383d565ed63STejun Heo * before releasing pool->lock is enough to prevent losing any 3384d565ed63STejun Heo * event. 3385c8e55f36STejun Heo */ 3386c8e55f36STejun Heo worker_enter_idle(worker); 3387c5a94a61SPeter Zijlstra __set_current_state(TASK_IDLE); 3388a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 33891da177e4SLinus Torvalds schedule(); 3390c8e55f36STejun Heo goto woke_up; 33911da177e4SLinus Torvalds } 33921da177e4SLinus Torvalds 3393e22bee78STejun Heo /** 3394e22bee78STejun Heo * rescuer_thread - the rescuer thread function 3395111c225aSTejun Heo * @__rescuer: self 3396e22bee78STejun Heo * 3397e22bee78STejun Heo * Workqueue rescuer thread function. There's one rescuer for each 3398493008a8STejun Heo * workqueue which has WQ_MEM_RECLAIM set. 3399e22bee78STejun Heo * 3400706026c2STejun Heo * Regular work processing on a pool may block trying to create a new 3401e22bee78STejun Heo * worker which uses GFP_KERNEL allocation which has slight chance of 3402e22bee78STejun Heo * developing into deadlock if some works currently on the same queue 3403e22bee78STejun Heo * need to be processed to satisfy the GFP_KERNEL allocation. This is 3404e22bee78STejun Heo * the problem rescuer solves. 3405e22bee78STejun Heo * 3406706026c2STejun Heo * When such condition is possible, the pool summons rescuers of all 3407706026c2STejun Heo * workqueues which have works queued on the pool and let them process 3408e22bee78STejun Heo * those works so that forward progress can be guaranteed. 3409e22bee78STejun Heo * 3410e22bee78STejun Heo * This should happen rarely. 3411d185af30SYacine Belkadi * 3412d185af30SYacine Belkadi * Return: 0 3413e22bee78STejun Heo */ 3414111c225aSTejun Heo static int rescuer_thread(void *__rescuer) 3415e22bee78STejun Heo { 3416111c225aSTejun Heo struct worker *rescuer = __rescuer; 3417111c225aSTejun Heo struct workqueue_struct *wq = rescuer->rescue_wq; 34184d595b86SLai Jiangshan bool should_stop; 3419e22bee78STejun Heo 3420e22bee78STejun Heo set_user_nice(current, RESCUER_NICE_LEVEL); 3421111c225aSTejun Heo 3422111c225aSTejun Heo /* 3423111c225aSTejun Heo * Mark rescuer as worker too. As WORKER_PREP is never cleared, it 3424111c225aSTejun Heo * doesn't participate in concurrency management. 3425111c225aSTejun Heo */ 3426197f6accSTejun Heo set_pf_worker(true); 3427e22bee78STejun Heo repeat: 3428c5a94a61SPeter Zijlstra set_current_state(TASK_IDLE); 34291da177e4SLinus Torvalds 34304d595b86SLai Jiangshan /* 34314d595b86SLai Jiangshan * By the time the rescuer is requested to stop, the workqueue 34324d595b86SLai Jiangshan * shouldn't have any work pending, but @wq->maydays may still have 34334d595b86SLai Jiangshan * pwq(s) queued. This can happen by non-rescuer workers consuming 34344d595b86SLai Jiangshan * all the work items before the rescuer got to them. Go through 34354d595b86SLai Jiangshan * @wq->maydays processing before acting on should_stop so that the 34364d595b86SLai Jiangshan * list is always empty on exit. 34374d595b86SLai Jiangshan */ 34384d595b86SLai Jiangshan should_stop = kthread_should_stop(); 34391da177e4SLinus Torvalds 3440493a1724STejun Heo /* see whether any pwq is asking for help */ 3441a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 3442493a1724STejun Heo 3443493a1724STejun Heo while (!list_empty(&wq->maydays)) { 3444493a1724STejun Heo struct pool_workqueue *pwq = list_first_entry(&wq->maydays, 3445493a1724STejun Heo struct pool_workqueue, mayday_node); 3446112202d9STejun Heo struct worker_pool *pool = pwq->pool; 3447e22bee78STejun Heo struct work_struct *work, *n; 3448e22bee78STejun Heo 3449e22bee78STejun Heo __set_current_state(TASK_RUNNING); 3450493a1724STejun Heo list_del_init(&pwq->mayday_node); 3451493a1724STejun Heo 3452a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 3453e22bee78STejun Heo 345451697d39SLai Jiangshan worker_attach_to_pool(rescuer, pool); 345551697d39SLai Jiangshan 3456a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 3457e22bee78STejun Heo 3458e22bee78STejun Heo /* 3459e22bee78STejun Heo * Slurp in all works issued via this workqueue and 3460e22bee78STejun Heo * process'em. 3461e22bee78STejun Heo */ 3462873eaca6STejun Heo WARN_ON_ONCE(!list_empty(&rescuer->scheduled)); 346382607adcSTejun Heo list_for_each_entry_safe(work, n, &pool->worklist, entry) { 3464873eaca6STejun Heo if (get_work_pwq(work) == pwq && 3465873eaca6STejun Heo assign_work(work, rescuer, &n)) 3466725e8ec5STejun Heo pwq->stats[PWQ_STAT_RESCUED]++; 346782607adcSTejun Heo } 3468e22bee78STejun Heo 3469873eaca6STejun Heo if (!list_empty(&rescuer->scheduled)) { 3470e22bee78STejun Heo process_scheduled_works(rescuer); 34717576958aSTejun Heo 34727576958aSTejun Heo /* 3473008847f6SNeilBrown * The above execution of rescued work items could 3474008847f6SNeilBrown * have created more to rescue through 3475f97a4a1aSLai Jiangshan * pwq_activate_first_inactive() or chained 3476008847f6SNeilBrown * queueing. Let's put @pwq back on mayday list so 3477008847f6SNeilBrown * that such back-to-back work items, which may be 3478008847f6SNeilBrown * being used to relieve memory pressure, don't 3479008847f6SNeilBrown * incur MAYDAY_INTERVAL delay inbetween. 3480008847f6SNeilBrown */ 34814f3f4cf3SLai Jiangshan if (pwq->nr_active && need_to_create_worker(pool)) { 3482a9b8a985SSebastian Andrzej Siewior raw_spin_lock(&wq_mayday_lock); 3483e66b39afSTejun Heo /* 3484e66b39afSTejun Heo * Queue iff we aren't racing destruction 3485e66b39afSTejun Heo * and somebody else hasn't queued it already. 3486e66b39afSTejun Heo */ 3487e66b39afSTejun Heo if (wq->rescuer && list_empty(&pwq->mayday_node)) { 3488008847f6SNeilBrown get_pwq(pwq); 3489e66b39afSTejun Heo list_add_tail(&pwq->mayday_node, &wq->maydays); 3490e66b39afSTejun Heo } 3491a9b8a985SSebastian Andrzej Siewior raw_spin_unlock(&wq_mayday_lock); 3492008847f6SNeilBrown } 3493008847f6SNeilBrown } 3494008847f6SNeilBrown 3495008847f6SNeilBrown /* 349677668c8bSLai Jiangshan * Put the reference grabbed by send_mayday(). @pool won't 349713b1d625SLai Jiangshan * go away while we're still attached to it. 349877668c8bSLai Jiangshan */ 349977668c8bSLai Jiangshan put_pwq(pwq); 350077668c8bSLai Jiangshan 350177668c8bSLai Jiangshan /* 35020219a352STejun Heo * Leave this pool. Notify regular workers; otherwise, we end up 35030219a352STejun Heo * with 0 concurrency and stalling the execution. 35047576958aSTejun Heo */ 35050219a352STejun Heo kick_pool(pool); 35067576958aSTejun Heo 3507a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 350813b1d625SLai Jiangshan 3509a2d812a2STejun Heo worker_detach_from_pool(rescuer); 351013b1d625SLai Jiangshan 3511a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 35121da177e4SLinus Torvalds } 35131da177e4SLinus Torvalds 3514a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 3515493a1724STejun Heo 35164d595b86SLai Jiangshan if (should_stop) { 35174d595b86SLai Jiangshan __set_current_state(TASK_RUNNING); 3518197f6accSTejun Heo set_pf_worker(false); 35194d595b86SLai Jiangshan return 0; 35204d595b86SLai Jiangshan } 35214d595b86SLai Jiangshan 3522111c225aSTejun Heo /* rescuers should never participate in concurrency management */ 3523111c225aSTejun Heo WARN_ON_ONCE(!(rescuer->flags & WORKER_NOT_RUNNING)); 3524e22bee78STejun Heo schedule(); 3525e22bee78STejun Heo goto repeat; 35261da177e4SLinus Torvalds } 35271da177e4SLinus Torvalds 35284cb1ef64STejun Heo static void bh_worker(struct worker *worker) 35294cb1ef64STejun Heo { 35304cb1ef64STejun Heo struct worker_pool *pool = worker->pool; 35314cb1ef64STejun Heo int nr_restarts = BH_WORKER_RESTARTS; 35324cb1ef64STejun Heo unsigned long end = jiffies + BH_WORKER_JIFFIES; 35334cb1ef64STejun Heo 35344cb1ef64STejun Heo raw_spin_lock_irq(&pool->lock); 35354cb1ef64STejun Heo worker_leave_idle(worker); 35364cb1ef64STejun Heo 35374cb1ef64STejun Heo /* 35384cb1ef64STejun Heo * This function follows the structure of worker_thread(). See there for 35394cb1ef64STejun Heo * explanations on each step. 35404cb1ef64STejun Heo */ 35414cb1ef64STejun Heo if (!need_more_worker(pool)) 35424cb1ef64STejun Heo goto done; 35434cb1ef64STejun Heo 35444cb1ef64STejun Heo WARN_ON_ONCE(!list_empty(&worker->scheduled)); 35454cb1ef64STejun Heo worker_clr_flags(worker, WORKER_PREP | WORKER_REBOUND); 35464cb1ef64STejun Heo 35474cb1ef64STejun Heo do { 35484cb1ef64STejun Heo struct work_struct *work = 35494cb1ef64STejun Heo list_first_entry(&pool->worklist, 35504cb1ef64STejun Heo struct work_struct, entry); 35514cb1ef64STejun Heo 35524cb1ef64STejun Heo if (assign_work(work, worker, NULL)) 35534cb1ef64STejun Heo process_scheduled_works(worker); 35544cb1ef64STejun Heo } while (keep_working(pool) && 35554cb1ef64STejun Heo --nr_restarts && time_before(jiffies, end)); 35564cb1ef64STejun Heo 35574cb1ef64STejun Heo worker_set_flags(worker, WORKER_PREP); 35584cb1ef64STejun Heo done: 35594cb1ef64STejun Heo worker_enter_idle(worker); 35604cb1ef64STejun Heo kick_pool(pool); 35614cb1ef64STejun Heo raw_spin_unlock_irq(&pool->lock); 35624cb1ef64STejun Heo } 35634cb1ef64STejun Heo 35644cb1ef64STejun Heo /* 35654cb1ef64STejun Heo * TODO: Convert all tasklet users to workqueue and use softirq directly. 35664cb1ef64STejun Heo * 35674cb1ef64STejun Heo * This is currently called from tasklet[_hi]action() and thus is also called 35684cb1ef64STejun Heo * whenever there are tasklets to run. Let's do an early exit if there's nothing 35694cb1ef64STejun Heo * queued. Once conversion from tasklet is complete, the need_more_worker() test 35704cb1ef64STejun Heo * can be dropped. 35714cb1ef64STejun Heo * 35724cb1ef64STejun Heo * After full conversion, we'll add worker->softirq_action, directly use the 35734cb1ef64STejun Heo * softirq action and obtain the worker pointer from the softirq_action pointer. 35744cb1ef64STejun Heo */ 35754cb1ef64STejun Heo void workqueue_softirq_action(bool highpri) 35764cb1ef64STejun Heo { 35774cb1ef64STejun Heo struct worker_pool *pool = 35784cb1ef64STejun Heo &per_cpu(bh_worker_pools, smp_processor_id())[highpri]; 35794cb1ef64STejun Heo if (need_more_worker(pool)) 35804cb1ef64STejun Heo bh_worker(list_first_entry(&pool->workers, struct worker, node)); 35814cb1ef64STejun Heo } 35824cb1ef64STejun Heo 35831acd92d9STejun Heo struct wq_drain_dead_softirq_work { 35841acd92d9STejun Heo struct work_struct work; 35851acd92d9STejun Heo struct worker_pool *pool; 35861acd92d9STejun Heo struct completion done; 35871acd92d9STejun Heo }; 35881acd92d9STejun Heo 35891acd92d9STejun Heo static void drain_dead_softirq_workfn(struct work_struct *work) 35901acd92d9STejun Heo { 35911acd92d9STejun Heo struct wq_drain_dead_softirq_work *dead_work = 35921acd92d9STejun Heo container_of(work, struct wq_drain_dead_softirq_work, work); 35931acd92d9STejun Heo struct worker_pool *pool = dead_work->pool; 35941acd92d9STejun Heo bool repeat; 35951acd92d9STejun Heo 35961acd92d9STejun Heo /* 35971acd92d9STejun Heo * @pool's CPU is dead and we want to execute its still pending work 35981acd92d9STejun Heo * items from this BH work item which is running on a different CPU. As 35991acd92d9STejun Heo * its CPU is dead, @pool can't be kicked and, as work execution path 36001acd92d9STejun Heo * will be nested, a lockdep annotation needs to be suppressed. Mark 36011acd92d9STejun Heo * @pool with %POOL_BH_DRAINING for the special treatments. 36021acd92d9STejun Heo */ 36031acd92d9STejun Heo raw_spin_lock_irq(&pool->lock); 36041acd92d9STejun Heo pool->flags |= POOL_BH_DRAINING; 36051acd92d9STejun Heo raw_spin_unlock_irq(&pool->lock); 36061acd92d9STejun Heo 36071acd92d9STejun Heo bh_worker(list_first_entry(&pool->workers, struct worker, node)); 36081acd92d9STejun Heo 36091acd92d9STejun Heo raw_spin_lock_irq(&pool->lock); 36101acd92d9STejun Heo pool->flags &= ~POOL_BH_DRAINING; 36111acd92d9STejun Heo repeat = need_more_worker(pool); 36121acd92d9STejun Heo raw_spin_unlock_irq(&pool->lock); 36131acd92d9STejun Heo 36141acd92d9STejun Heo /* 36151acd92d9STejun Heo * bh_worker() might hit consecutive execution limit and bail. If there 36161acd92d9STejun Heo * still are pending work items, reschedule self and return so that we 36171acd92d9STejun Heo * don't hog this CPU's BH. 36181acd92d9STejun Heo */ 36191acd92d9STejun Heo if (repeat) { 36201acd92d9STejun Heo if (pool->attrs->nice == HIGHPRI_NICE_LEVEL) 36211acd92d9STejun Heo queue_work(system_bh_highpri_wq, work); 36221acd92d9STejun Heo else 36231acd92d9STejun Heo queue_work(system_bh_wq, work); 36241acd92d9STejun Heo } else { 36251acd92d9STejun Heo complete(&dead_work->done); 36261acd92d9STejun Heo } 36271acd92d9STejun Heo } 36281acd92d9STejun Heo 36291acd92d9STejun Heo /* 36301acd92d9STejun Heo * @cpu is dead. Drain the remaining BH work items on the current CPU. It's 36311acd92d9STejun Heo * possible to allocate dead_work per CPU and avoid flushing. However, then we 36321acd92d9STejun Heo * have to worry about draining overlapping with CPU coming back online or 36331acd92d9STejun Heo * nesting (one CPU's dead_work queued on another CPU which is also dead and so 36341acd92d9STejun Heo * on). Let's keep it simple and drain them synchronously. These are BH work 36351acd92d9STejun Heo * items which shouldn't be requeued on the same pool. Shouldn't take long. 36361acd92d9STejun Heo */ 36371acd92d9STejun Heo void workqueue_softirq_dead(unsigned int cpu) 36381acd92d9STejun Heo { 36391acd92d9STejun Heo int i; 36401acd92d9STejun Heo 36411acd92d9STejun Heo for (i = 0; i < NR_STD_WORKER_POOLS; i++) { 36421acd92d9STejun Heo struct worker_pool *pool = &per_cpu(bh_worker_pools, cpu)[i]; 36431acd92d9STejun Heo struct wq_drain_dead_softirq_work dead_work; 36441acd92d9STejun Heo 36451acd92d9STejun Heo if (!need_more_worker(pool)) 36461acd92d9STejun Heo continue; 36471acd92d9STejun Heo 3648e7cc3be6SLai Jiangshan INIT_WORK_ONSTACK(&dead_work.work, drain_dead_softirq_workfn); 36491acd92d9STejun Heo dead_work.pool = pool; 36501acd92d9STejun Heo init_completion(&dead_work.done); 36511acd92d9STejun Heo 36521acd92d9STejun Heo if (pool->attrs->nice == HIGHPRI_NICE_LEVEL) 36531acd92d9STejun Heo queue_work(system_bh_highpri_wq, &dead_work.work); 36541acd92d9STejun Heo else 36551acd92d9STejun Heo queue_work(system_bh_wq, &dead_work.work); 36561acd92d9STejun Heo 36571acd92d9STejun Heo wait_for_completion(&dead_work.done); 365831103f40SZqiang destroy_work_on_stack(&dead_work.work); 36591acd92d9STejun Heo } 36601acd92d9STejun Heo } 36611acd92d9STejun Heo 3662fca839c0STejun Heo /** 3663fca839c0STejun Heo * check_flush_dependency - check for flush dependency sanity 3664fca839c0STejun Heo * @target_wq: workqueue being flushed 3665fca839c0STejun Heo * @target_work: work item being flushed (NULL for workqueue flushes) 3666fca839c0STejun Heo * 3667fca839c0STejun Heo * %current is trying to flush the whole @target_wq or @target_work on it. 3668fca839c0STejun Heo * If @target_wq doesn't have %WQ_MEM_RECLAIM, verify that %current is not 3669fca839c0STejun Heo * reclaiming memory or running on a workqueue which doesn't have 3670fca839c0STejun Heo * %WQ_MEM_RECLAIM as that can break forward-progress guarantee leading to 3671fca839c0STejun Heo * a deadlock. 3672fca839c0STejun Heo */ 3673fca839c0STejun Heo static void check_flush_dependency(struct workqueue_struct *target_wq, 3674fca839c0STejun Heo struct work_struct *target_work) 3675fca839c0STejun Heo { 3676fca839c0STejun Heo work_func_t target_func = target_work ? target_work->func : NULL; 3677fca839c0STejun Heo struct worker *worker; 3678fca839c0STejun Heo 3679fca839c0STejun Heo if (target_wq->flags & WQ_MEM_RECLAIM) 3680fca839c0STejun Heo return; 3681fca839c0STejun Heo 3682fca839c0STejun Heo worker = current_wq_worker(); 3683fca839c0STejun Heo 3684fca839c0STejun Heo WARN_ONCE(current->flags & PF_MEMALLOC, 3685d75f773cSSakari Ailus "workqueue: PF_MEMALLOC task %d(%s) is flushing !WQ_MEM_RECLAIM %s:%ps", 3686fca839c0STejun Heo current->pid, current->comm, target_wq->name, target_func); 368723d11a58STejun Heo WARN_ONCE(worker && ((worker->current_pwq->wq->flags & 368823d11a58STejun Heo (WQ_MEM_RECLAIM | __WQ_LEGACY)) == WQ_MEM_RECLAIM), 3689d75f773cSSakari Ailus "workqueue: WQ_MEM_RECLAIM %s:%ps is flushing !WQ_MEM_RECLAIM %s:%ps", 3690fca839c0STejun Heo worker->current_pwq->wq->name, worker->current_func, 3691fca839c0STejun Heo target_wq->name, target_func); 3692fca839c0STejun Heo } 3693fca839c0STejun Heo 3694fc2e4d70SOleg Nesterov struct wq_barrier { 3695fc2e4d70SOleg Nesterov struct work_struct work; 3696fc2e4d70SOleg Nesterov struct completion done; 36972607d7a6STejun Heo struct task_struct *task; /* purely informational */ 3698fc2e4d70SOleg Nesterov }; 3699fc2e4d70SOleg Nesterov 3700fc2e4d70SOleg Nesterov static void wq_barrier_func(struct work_struct *work) 3701fc2e4d70SOleg Nesterov { 3702fc2e4d70SOleg Nesterov struct wq_barrier *barr = container_of(work, struct wq_barrier, work); 3703fc2e4d70SOleg Nesterov complete(&barr->done); 3704fc2e4d70SOleg Nesterov } 3705fc2e4d70SOleg Nesterov 37064690c4abSTejun Heo /** 37074690c4abSTejun Heo * insert_wq_barrier - insert a barrier work 3708112202d9STejun Heo * @pwq: pwq to insert barrier into 37094690c4abSTejun Heo * @barr: wq_barrier to insert 3710affee4b2STejun Heo * @target: target work to attach @barr to 3711affee4b2STejun Heo * @worker: worker currently executing @target, NULL if @target is not executing 37124690c4abSTejun Heo * 3713affee4b2STejun Heo * @barr is linked to @target such that @barr is completed only after 3714affee4b2STejun Heo * @target finishes execution. Please note that the ordering 3715affee4b2STejun Heo * guarantee is observed only with respect to @target and on the local 3716affee4b2STejun Heo * cpu. 3717affee4b2STejun Heo * 3718affee4b2STejun Heo * Currently, a queued barrier can't be canceled. This is because 3719affee4b2STejun Heo * try_to_grab_pending() can't determine whether the work to be 3720affee4b2STejun Heo * grabbed is at the head of the queue and thus can't clear LINKED 3721affee4b2STejun Heo * flag of the previous work while there must be a valid next work 3722affee4b2STejun Heo * after a work with LINKED flag set. 3723affee4b2STejun Heo * 3724affee4b2STejun Heo * Note that when @worker is non-NULL, @target may be modified 3725112202d9STejun Heo * underneath us, so we can't reliably determine pwq from @target. 37264690c4abSTejun Heo * 37274690c4abSTejun Heo * CONTEXT: 3728a9b8a985SSebastian Andrzej Siewior * raw_spin_lock_irq(pool->lock). 37294690c4abSTejun Heo */ 3730112202d9STejun Heo static void insert_wq_barrier(struct pool_workqueue *pwq, 3731affee4b2STejun Heo struct wq_barrier *barr, 3732affee4b2STejun Heo struct work_struct *target, struct worker *worker) 3733fc2e4d70SOleg Nesterov { 37344cb1ef64STejun Heo static __maybe_unused struct lock_class_key bh_key, thr_key; 3735d812796eSLai Jiangshan unsigned int work_flags = 0; 3736d812796eSLai Jiangshan unsigned int work_color; 3737affee4b2STejun Heo struct list_head *head; 3738affee4b2STejun Heo 3739dc186ad7SThomas Gleixner /* 3740d565ed63STejun Heo * debugobject calls are safe here even with pool->lock locked 3741dc186ad7SThomas Gleixner * as we know for sure that this will not trigger any of the 3742dc186ad7SThomas Gleixner * checks and call back into the fixup functions where we 3743dc186ad7SThomas Gleixner * might deadlock. 37444cb1ef64STejun Heo * 37454cb1ef64STejun Heo * BH and threaded workqueues need separate lockdep keys to avoid 37464cb1ef64STejun Heo * spuriously triggering "inconsistent {SOFTIRQ-ON-W} -> {IN-SOFTIRQ-W} 37474cb1ef64STejun Heo * usage". 3748dc186ad7SThomas Gleixner */ 37494cb1ef64STejun Heo INIT_WORK_ONSTACK_KEY(&barr->work, wq_barrier_func, 37504cb1ef64STejun Heo (pwq->wq->flags & WQ_BH) ? &bh_key : &thr_key); 375122df02bbSTejun Heo __set_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&barr->work)); 375252fa5bc5SBoqun Feng 3753fd1a5b04SByungchul Park init_completion_map(&barr->done, &target->lockdep_map); 3754fd1a5b04SByungchul Park 37552607d7a6STejun Heo barr->task = current; 375683c22520SOleg Nesterov 37575797b1c1STejun Heo /* The barrier work item does not participate in nr_active. */ 3758018f3a13SLai Jiangshan work_flags |= WORK_STRUCT_INACTIVE; 3759018f3a13SLai Jiangshan 3760affee4b2STejun Heo /* 3761affee4b2STejun Heo * If @target is currently being executed, schedule the 3762affee4b2STejun Heo * barrier to the worker; otherwise, put it after @target. 3763affee4b2STejun Heo */ 3764d812796eSLai Jiangshan if (worker) { 3765affee4b2STejun Heo head = worker->scheduled.next; 3766d812796eSLai Jiangshan work_color = worker->current_color; 3767d812796eSLai Jiangshan } else { 3768affee4b2STejun Heo unsigned long *bits = work_data_bits(target); 3769affee4b2STejun Heo 3770affee4b2STejun Heo head = target->entry.next; 3771affee4b2STejun Heo /* there can already be other linked works, inherit and set */ 3772d21cece0SLai Jiangshan work_flags |= *bits & WORK_STRUCT_LINKED; 3773d812796eSLai Jiangshan work_color = get_work_color(*bits); 3774affee4b2STejun Heo __set_bit(WORK_STRUCT_LINKED_BIT, bits); 3775affee4b2STejun Heo } 3776affee4b2STejun Heo 3777d812796eSLai Jiangshan pwq->nr_in_flight[work_color]++; 3778d812796eSLai Jiangshan work_flags |= work_color_to_flags(work_color); 3779d812796eSLai Jiangshan 3780d21cece0SLai Jiangshan insert_work(pwq, &barr->work, head, work_flags); 3781fc2e4d70SOleg Nesterov } 3782fc2e4d70SOleg Nesterov 378373f53c4aSTejun Heo /** 3784112202d9STejun Heo * flush_workqueue_prep_pwqs - prepare pwqs for workqueue flushing 378573f53c4aSTejun Heo * @wq: workqueue being flushed 378673f53c4aSTejun Heo * @flush_color: new flush color, < 0 for no-op 378773f53c4aSTejun Heo * @work_color: new work color, < 0 for no-op 378873f53c4aSTejun Heo * 3789112202d9STejun Heo * Prepare pwqs for workqueue flushing. 379073f53c4aSTejun Heo * 3791112202d9STejun Heo * If @flush_color is non-negative, flush_color on all pwqs should be 3792112202d9STejun Heo * -1. If no pwq has in-flight commands at the specified color, all 3793112202d9STejun Heo * pwq->flush_color's stay at -1 and %false is returned. If any pwq 3794112202d9STejun Heo * has in flight commands, its pwq->flush_color is set to 3795112202d9STejun Heo * @flush_color, @wq->nr_pwqs_to_flush is updated accordingly, pwq 379673f53c4aSTejun Heo * wakeup logic is armed and %true is returned. 379773f53c4aSTejun Heo * 379873f53c4aSTejun Heo * The caller should have initialized @wq->first_flusher prior to 379973f53c4aSTejun Heo * calling this function with non-negative @flush_color. If 380073f53c4aSTejun Heo * @flush_color is negative, no flush color update is done and %false 380173f53c4aSTejun Heo * is returned. 380273f53c4aSTejun Heo * 3803112202d9STejun Heo * If @work_color is non-negative, all pwqs should have the same 380473f53c4aSTejun Heo * work_color which is previous to @work_color and all will be 380573f53c4aSTejun Heo * advanced to @work_color. 380673f53c4aSTejun Heo * 380773f53c4aSTejun Heo * CONTEXT: 38083c25a55dSLai Jiangshan * mutex_lock(wq->mutex). 380973f53c4aSTejun Heo * 3810d185af30SYacine Belkadi * Return: 381173f53c4aSTejun Heo * %true if @flush_color >= 0 and there's something to flush. %false 381273f53c4aSTejun Heo * otherwise. 381373f53c4aSTejun Heo */ 3814112202d9STejun Heo static bool flush_workqueue_prep_pwqs(struct workqueue_struct *wq, 381573f53c4aSTejun Heo int flush_color, int work_color) 38161da177e4SLinus Torvalds { 381773f53c4aSTejun Heo bool wait = false; 381849e3cf44STejun Heo struct pool_workqueue *pwq; 38191da177e4SLinus Torvalds 382073f53c4aSTejun Heo if (flush_color >= 0) { 38216183c009STejun Heo WARN_ON_ONCE(atomic_read(&wq->nr_pwqs_to_flush)); 3822112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 1); 3823dc186ad7SThomas Gleixner } 382414441960SOleg Nesterov 382549e3cf44STejun Heo for_each_pwq(pwq, wq) { 3826112202d9STejun Heo struct worker_pool *pool = pwq->pool; 38271da177e4SLinus Torvalds 3828a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 382973f53c4aSTejun Heo 383073f53c4aSTejun Heo if (flush_color >= 0) { 38316183c009STejun Heo WARN_ON_ONCE(pwq->flush_color != -1); 383273f53c4aSTejun Heo 3833112202d9STejun Heo if (pwq->nr_in_flight[flush_color]) { 3834112202d9STejun Heo pwq->flush_color = flush_color; 3835112202d9STejun Heo atomic_inc(&wq->nr_pwqs_to_flush); 383673f53c4aSTejun Heo wait = true; 38371da177e4SLinus Torvalds } 383873f53c4aSTejun Heo } 383973f53c4aSTejun Heo 384073f53c4aSTejun Heo if (work_color >= 0) { 38416183c009STejun Heo WARN_ON_ONCE(work_color != work_next_color(pwq->work_color)); 3842112202d9STejun Heo pwq->work_color = work_color; 384373f53c4aSTejun Heo } 384473f53c4aSTejun Heo 3845a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 38461da177e4SLinus Torvalds } 38471da177e4SLinus Torvalds 3848112202d9STejun Heo if (flush_color >= 0 && atomic_dec_and_test(&wq->nr_pwqs_to_flush)) 384973f53c4aSTejun Heo complete(&wq->first_flusher->done); 385073f53c4aSTejun Heo 385173f53c4aSTejun Heo return wait; 385283c22520SOleg Nesterov } 38531da177e4SLinus Torvalds 3854c35aea39STejun Heo static void touch_wq_lockdep_map(struct workqueue_struct *wq) 3855c35aea39STejun Heo { 38564cb1ef64STejun Heo #ifdef CONFIG_LOCKDEP 38574cb1ef64STejun Heo if (wq->flags & WQ_BH) 38584cb1ef64STejun Heo local_bh_disable(); 38594cb1ef64STejun Heo 3860c35aea39STejun Heo lock_map_acquire(&wq->lockdep_map); 3861c35aea39STejun Heo lock_map_release(&wq->lockdep_map); 38624cb1ef64STejun Heo 38634cb1ef64STejun Heo if (wq->flags & WQ_BH) 38644cb1ef64STejun Heo local_bh_enable(); 38654cb1ef64STejun Heo #endif 3866c35aea39STejun Heo } 3867c35aea39STejun Heo 3868c35aea39STejun Heo static void touch_work_lockdep_map(struct work_struct *work, 3869c35aea39STejun Heo struct workqueue_struct *wq) 3870c35aea39STejun Heo { 38714cb1ef64STejun Heo #ifdef CONFIG_LOCKDEP 38724cb1ef64STejun Heo if (wq->flags & WQ_BH) 38734cb1ef64STejun Heo local_bh_disable(); 38744cb1ef64STejun Heo 3875c35aea39STejun Heo lock_map_acquire(&work->lockdep_map); 3876c35aea39STejun Heo lock_map_release(&work->lockdep_map); 38774cb1ef64STejun Heo 38784cb1ef64STejun Heo if (wq->flags & WQ_BH) 38794cb1ef64STejun Heo local_bh_enable(); 38804cb1ef64STejun Heo #endif 3881c35aea39STejun Heo } 3882c35aea39STejun Heo 38830fcb78c2SRolf Eike Beer /** 3884c4f135d6STetsuo Handa * __flush_workqueue - ensure that any scheduled work has run to completion. 38850fcb78c2SRolf Eike Beer * @wq: workqueue to flush 38861da177e4SLinus Torvalds * 3887c5aa87bbSTejun Heo * This function sleeps until all work items which were queued on entry 3888c5aa87bbSTejun Heo * have finished execution, but it is not livelocked by new incoming ones. 38891da177e4SLinus Torvalds */ 3890c4f135d6STetsuo Handa void __flush_workqueue(struct workqueue_struct *wq) 38911da177e4SLinus Torvalds { 389273f53c4aSTejun Heo struct wq_flusher this_flusher = { 389373f53c4aSTejun Heo .list = LIST_HEAD_INIT(this_flusher.list), 389473f53c4aSTejun Heo .flush_color = -1, 3895fd1a5b04SByungchul Park .done = COMPLETION_INITIALIZER_ONSTACK_MAP(this_flusher.done, wq->lockdep_map), 389673f53c4aSTejun Heo }; 389773f53c4aSTejun Heo int next_color; 3898b1f4ec17SOleg Nesterov 38993347fa09STejun Heo if (WARN_ON(!wq_online)) 39003347fa09STejun Heo return; 39013347fa09STejun Heo 3902c35aea39STejun Heo touch_wq_lockdep_map(wq); 390387915adcSJohannes Berg 39043c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 390573f53c4aSTejun Heo 390673f53c4aSTejun Heo /* 390773f53c4aSTejun Heo * Start-to-wait phase 390873f53c4aSTejun Heo */ 390973f53c4aSTejun Heo next_color = work_next_color(wq->work_color); 391073f53c4aSTejun Heo 391173f53c4aSTejun Heo if (next_color != wq->flush_color) { 391273f53c4aSTejun Heo /* 391373f53c4aSTejun Heo * Color space is not full. The current work_color 391473f53c4aSTejun Heo * becomes our flush_color and work_color is advanced 391573f53c4aSTejun Heo * by one. 391673f53c4aSTejun Heo */ 39176183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow)); 391873f53c4aSTejun Heo this_flusher.flush_color = wq->work_color; 391973f53c4aSTejun Heo wq->work_color = next_color; 392073f53c4aSTejun Heo 392173f53c4aSTejun Heo if (!wq->first_flusher) { 392273f53c4aSTejun Heo /* no flush in progress, become the first flusher */ 39236183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 392473f53c4aSTejun Heo 392573f53c4aSTejun Heo wq->first_flusher = &this_flusher; 392673f53c4aSTejun Heo 3927112202d9STejun Heo if (!flush_workqueue_prep_pwqs(wq, wq->flush_color, 392873f53c4aSTejun Heo wq->work_color)) { 392973f53c4aSTejun Heo /* nothing to flush, done */ 393073f53c4aSTejun Heo wq->flush_color = next_color; 393173f53c4aSTejun Heo wq->first_flusher = NULL; 393273f53c4aSTejun Heo goto out_unlock; 393373f53c4aSTejun Heo } 393473f53c4aSTejun Heo } else { 393573f53c4aSTejun Heo /* wait in queue */ 39366183c009STejun Heo WARN_ON_ONCE(wq->flush_color == this_flusher.flush_color); 393773f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_queue); 3938112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 393973f53c4aSTejun Heo } 394073f53c4aSTejun Heo } else { 394173f53c4aSTejun Heo /* 394273f53c4aSTejun Heo * Oops, color space is full, wait on overflow queue. 394373f53c4aSTejun Heo * The next flush completion will assign us 394473f53c4aSTejun Heo * flush_color and transfer to flusher_queue. 394573f53c4aSTejun Heo */ 394673f53c4aSTejun Heo list_add_tail(&this_flusher.list, &wq->flusher_overflow); 394773f53c4aSTejun Heo } 394873f53c4aSTejun Heo 3949fca839c0STejun Heo check_flush_dependency(wq, NULL); 3950fca839c0STejun Heo 39513c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 395273f53c4aSTejun Heo 395373f53c4aSTejun Heo wait_for_completion(&this_flusher.done); 395473f53c4aSTejun Heo 395573f53c4aSTejun Heo /* 395673f53c4aSTejun Heo * Wake-up-and-cascade phase 395773f53c4aSTejun Heo * 395873f53c4aSTejun Heo * First flushers are responsible for cascading flushes and 395973f53c4aSTejun Heo * handling overflow. Non-first flushers can simply return. 396073f53c4aSTejun Heo */ 396100d5d15bSChris Wilson if (READ_ONCE(wq->first_flusher) != &this_flusher) 396273f53c4aSTejun Heo return; 396373f53c4aSTejun Heo 39643c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 396573f53c4aSTejun Heo 39664ce48b37STejun Heo /* we might have raced, check again with mutex held */ 39674ce48b37STejun Heo if (wq->first_flusher != &this_flusher) 39684ce48b37STejun Heo goto out_unlock; 39694ce48b37STejun Heo 397000d5d15bSChris Wilson WRITE_ONCE(wq->first_flusher, NULL); 397173f53c4aSTejun Heo 39726183c009STejun Heo WARN_ON_ONCE(!list_empty(&this_flusher.list)); 39736183c009STejun Heo WARN_ON_ONCE(wq->flush_color != this_flusher.flush_color); 397473f53c4aSTejun Heo 397573f53c4aSTejun Heo while (true) { 397673f53c4aSTejun Heo struct wq_flusher *next, *tmp; 397773f53c4aSTejun Heo 397873f53c4aSTejun Heo /* complete all the flushers sharing the current flush color */ 397973f53c4aSTejun Heo list_for_each_entry_safe(next, tmp, &wq->flusher_queue, list) { 398073f53c4aSTejun Heo if (next->flush_color != wq->flush_color) 398173f53c4aSTejun Heo break; 398273f53c4aSTejun Heo list_del_init(&next->list); 398373f53c4aSTejun Heo complete(&next->done); 398473f53c4aSTejun Heo } 398573f53c4aSTejun Heo 39866183c009STejun Heo WARN_ON_ONCE(!list_empty(&wq->flusher_overflow) && 398773f53c4aSTejun Heo wq->flush_color != work_next_color(wq->work_color)); 398873f53c4aSTejun Heo 398973f53c4aSTejun Heo /* this flush_color is finished, advance by one */ 399073f53c4aSTejun Heo wq->flush_color = work_next_color(wq->flush_color); 399173f53c4aSTejun Heo 399273f53c4aSTejun Heo /* one color has been freed, handle overflow queue */ 399373f53c4aSTejun Heo if (!list_empty(&wq->flusher_overflow)) { 399473f53c4aSTejun Heo /* 399573f53c4aSTejun Heo * Assign the same color to all overflowed 399673f53c4aSTejun Heo * flushers, advance work_color and append to 399773f53c4aSTejun Heo * flusher_queue. This is the start-to-wait 399873f53c4aSTejun Heo * phase for these overflowed flushers. 399973f53c4aSTejun Heo */ 400073f53c4aSTejun Heo list_for_each_entry(tmp, &wq->flusher_overflow, list) 400173f53c4aSTejun Heo tmp->flush_color = wq->work_color; 400273f53c4aSTejun Heo 400373f53c4aSTejun Heo wq->work_color = work_next_color(wq->work_color); 400473f53c4aSTejun Heo 400573f53c4aSTejun Heo list_splice_tail_init(&wq->flusher_overflow, 400673f53c4aSTejun Heo &wq->flusher_queue); 4007112202d9STejun Heo flush_workqueue_prep_pwqs(wq, -1, wq->work_color); 400873f53c4aSTejun Heo } 400973f53c4aSTejun Heo 401073f53c4aSTejun Heo if (list_empty(&wq->flusher_queue)) { 40116183c009STejun Heo WARN_ON_ONCE(wq->flush_color != wq->work_color); 401273f53c4aSTejun Heo break; 401373f53c4aSTejun Heo } 401473f53c4aSTejun Heo 401573f53c4aSTejun Heo /* 401673f53c4aSTejun Heo * Need to flush more colors. Make the next flusher 4017112202d9STejun Heo * the new first flusher and arm pwqs. 401873f53c4aSTejun Heo */ 40196183c009STejun Heo WARN_ON_ONCE(wq->flush_color == wq->work_color); 40206183c009STejun Heo WARN_ON_ONCE(wq->flush_color != next->flush_color); 402173f53c4aSTejun Heo 402273f53c4aSTejun Heo list_del_init(&next->list); 402373f53c4aSTejun Heo wq->first_flusher = next; 402473f53c4aSTejun Heo 4025112202d9STejun Heo if (flush_workqueue_prep_pwqs(wq, wq->flush_color, -1)) 402673f53c4aSTejun Heo break; 402773f53c4aSTejun Heo 402873f53c4aSTejun Heo /* 402973f53c4aSTejun Heo * Meh... this color is already done, clear first 403073f53c4aSTejun Heo * flusher and repeat cascading. 403173f53c4aSTejun Heo */ 403273f53c4aSTejun Heo wq->first_flusher = NULL; 403373f53c4aSTejun Heo } 403473f53c4aSTejun Heo 403573f53c4aSTejun Heo out_unlock: 40363c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 40371da177e4SLinus Torvalds } 4038c4f135d6STetsuo Handa EXPORT_SYMBOL(__flush_workqueue); 40391da177e4SLinus Torvalds 40409c5a2ba7STejun Heo /** 40419c5a2ba7STejun Heo * drain_workqueue - drain a workqueue 40429c5a2ba7STejun Heo * @wq: workqueue to drain 40439c5a2ba7STejun Heo * 40449c5a2ba7STejun Heo * Wait until the workqueue becomes empty. While draining is in progress, 40459c5a2ba7STejun Heo * only chain queueing is allowed. IOW, only currently pending or running 40469c5a2ba7STejun Heo * work items on @wq can queue further work items on it. @wq is flushed 4047b749b1b6SChen Hanxiao * repeatedly until it becomes empty. The number of flushing is determined 40489c5a2ba7STejun Heo * by the depth of chaining and should be relatively short. Whine if it 40499c5a2ba7STejun Heo * takes too long. 40509c5a2ba7STejun Heo */ 40519c5a2ba7STejun Heo void drain_workqueue(struct workqueue_struct *wq) 40529c5a2ba7STejun Heo { 40539c5a2ba7STejun Heo unsigned int flush_cnt = 0; 405449e3cf44STejun Heo struct pool_workqueue *pwq; 40559c5a2ba7STejun Heo 40569c5a2ba7STejun Heo /* 40579c5a2ba7STejun Heo * __queue_work() needs to test whether there are drainers, is much 40589c5a2ba7STejun Heo * hotter than drain_workqueue() and already looks at @wq->flags. 4059618b01ebSTejun Heo * Use __WQ_DRAINING so that queue doesn't have to check nr_drainers. 40609c5a2ba7STejun Heo */ 406187fc741eSLai Jiangshan mutex_lock(&wq->mutex); 40629c5a2ba7STejun Heo if (!wq->nr_drainers++) 4063618b01ebSTejun Heo wq->flags |= __WQ_DRAINING; 406487fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 40659c5a2ba7STejun Heo reflush: 4066c4f135d6STetsuo Handa __flush_workqueue(wq); 40679c5a2ba7STejun Heo 4068b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 406976af4d93STejun Heo 407049e3cf44STejun Heo for_each_pwq(pwq, wq) { 4071fa2563e4SThomas Tuttle bool drained; 40729c5a2ba7STejun Heo 4073a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 4074afa87ce8STejun Heo drained = pwq_is_empty(pwq); 4075a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 4076fa2563e4SThomas Tuttle 4077fa2563e4SThomas Tuttle if (drained) 40789c5a2ba7STejun Heo continue; 40799c5a2ba7STejun Heo 40809c5a2ba7STejun Heo if (++flush_cnt == 10 || 40819c5a2ba7STejun Heo (flush_cnt % 100 == 0 && flush_cnt <= 1000)) 4082e9ad2eb3SStephen Zhang pr_warn("workqueue %s: %s() isn't complete after %u tries\n", 4083e9ad2eb3SStephen Zhang wq->name, __func__, flush_cnt); 408476af4d93STejun Heo 4085b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 40869c5a2ba7STejun Heo goto reflush; 40879c5a2ba7STejun Heo } 40889c5a2ba7STejun Heo 40899c5a2ba7STejun Heo if (!--wq->nr_drainers) 4090618b01ebSTejun Heo wq->flags &= ~__WQ_DRAINING; 409187fc741eSLai Jiangshan mutex_unlock(&wq->mutex); 40929c5a2ba7STejun Heo } 40939c5a2ba7STejun Heo EXPORT_SYMBOL_GPL(drain_workqueue); 40949c5a2ba7STejun Heo 4095d6e89786SJohannes Berg static bool start_flush_work(struct work_struct *work, struct wq_barrier *barr, 4096d6e89786SJohannes Berg bool from_cancel) 4097baf59022STejun Heo { 4098baf59022STejun Heo struct worker *worker = NULL; 4099c9e7cf27STejun Heo struct worker_pool *pool; 4100112202d9STejun Heo struct pool_workqueue *pwq; 4101c35aea39STejun Heo struct workqueue_struct *wq; 4102baf59022STejun Heo 410324acfb71SThomas Gleixner rcu_read_lock(); 4104fa1b54e6STejun Heo pool = get_work_pool(work); 4105fa1b54e6STejun Heo if (!pool) { 410624acfb71SThomas Gleixner rcu_read_unlock(); 4107fa1b54e6STejun Heo return false; 4108fa1b54e6STejun Heo } 4109fa1b54e6STejun Heo 4110a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 41110b3dae68SLai Jiangshan /* see the comment in try_to_grab_pending() with the same code */ 4112112202d9STejun Heo pwq = get_work_pwq(work); 4113112202d9STejun Heo if (pwq) { 4114112202d9STejun Heo if (unlikely(pwq->pool != pool)) 4115baf59022STejun Heo goto already_gone; 4116606a5020STejun Heo } else { 4117c9e7cf27STejun Heo worker = find_worker_executing_work(pool, work); 4118baf59022STejun Heo if (!worker) 4119baf59022STejun Heo goto already_gone; 4120112202d9STejun Heo pwq = worker->current_pwq; 4121606a5020STejun Heo } 4122baf59022STejun Heo 4123c35aea39STejun Heo wq = pwq->wq; 4124c35aea39STejun Heo check_flush_dependency(wq, work); 4125fca839c0STejun Heo 4126112202d9STejun Heo insert_wq_barrier(pwq, barr, work, worker); 4127a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 4128baf59022STejun Heo 4129c35aea39STejun Heo touch_work_lockdep_map(work, wq); 4130c35aea39STejun Heo 4131e159489bSTejun Heo /* 4132a1d14934SPeter Zijlstra * Force a lock recursion deadlock when using flush_work() inside a 4133a1d14934SPeter Zijlstra * single-threaded or rescuer equipped workqueue. 4134a1d14934SPeter Zijlstra * 4135a1d14934SPeter Zijlstra * For single threaded workqueues the deadlock happens when the work 4136a1d14934SPeter Zijlstra * is after the work issuing the flush_work(). For rescuer equipped 4137a1d14934SPeter Zijlstra * workqueues the deadlock happens when the rescuer stalls, blocking 4138a1d14934SPeter Zijlstra * forward progress. 4139e159489bSTejun Heo */ 4140c35aea39STejun Heo if (!from_cancel && (wq->saved_max_active == 1 || wq->rescuer)) 4141c35aea39STejun Heo touch_wq_lockdep_map(wq); 4142c35aea39STejun Heo 414324acfb71SThomas Gleixner rcu_read_unlock(); 4144baf59022STejun Heo return true; 4145baf59022STejun Heo already_gone: 4146a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 414724acfb71SThomas Gleixner rcu_read_unlock(); 4148baf59022STejun Heo return false; 4149baf59022STejun Heo } 4150baf59022STejun Heo 4151d6e89786SJohannes Berg static bool __flush_work(struct work_struct *work, bool from_cancel) 4152d6e89786SJohannes Berg { 4153d6e89786SJohannes Berg struct wq_barrier barr; 4154134874e2STejun Heo unsigned long data; 4155d6e89786SJohannes Berg 4156d6e89786SJohannes Berg if (WARN_ON(!wq_online)) 4157d6e89786SJohannes Berg return false; 4158d6e89786SJohannes Berg 41594d43d395STetsuo Handa if (WARN_ON(!work->func)) 41604d43d395STetsuo Handa return false; 41614d43d395STetsuo Handa 4162134874e2STejun Heo if (!start_flush_work(work, &barr, from_cancel)) 4163134874e2STejun Heo return false; 4164134874e2STejun Heo 4165134874e2STejun Heo /* 4166134874e2STejun Heo * start_flush_work() returned %true. If @from_cancel is set, we know 4167134874e2STejun Heo * that @work must have been executing during start_flush_work() and 4168134874e2STejun Heo * can't currently be queued. Its data must contain OFFQ bits. If @work 4169134874e2STejun Heo * was queued on a BH workqueue, we also know that it was running in the 4170134874e2STejun Heo * BH context and thus can be busy-waited. 4171134874e2STejun Heo */ 4172134874e2STejun Heo data = *work_data_bits(work); 4173134874e2STejun Heo if (from_cancel && 4174134874e2STejun Heo !WARN_ON_ONCE(data & WORK_STRUCT_PWQ) && (data & WORK_OFFQ_BH)) { 4175134874e2STejun Heo /* 4176134874e2STejun Heo * On RT, prevent a live lock when %current preempted soft 4177134874e2STejun Heo * interrupt processing or prevents ksoftirqd from running by 4178134874e2STejun Heo * keeping flipping BH. If the BH work item runs on a different 4179134874e2STejun Heo * CPU then this has no effect other than doing the BH 4180134874e2STejun Heo * disable/enable dance for nothing. This is copied from 4181134874e2STejun Heo * kernel/softirq.c::tasklet_unlock_spin_wait(). 4182134874e2STejun Heo */ 4183134874e2STejun Heo while (!try_wait_for_completion(&barr.done)) { 4184134874e2STejun Heo if (IS_ENABLED(CONFIG_PREEMPT_RT)) { 4185134874e2STejun Heo local_bh_disable(); 4186134874e2STejun Heo local_bh_enable(); 4187134874e2STejun Heo } else { 4188134874e2STejun Heo cpu_relax(); 4189134874e2STejun Heo } 4190134874e2STejun Heo } 4191134874e2STejun Heo } else { 4192d6e89786SJohannes Berg wait_for_completion(&barr.done); 4193134874e2STejun Heo } 4194134874e2STejun Heo 4195d6e89786SJohannes Berg destroy_work_on_stack(&barr.work); 4196d6e89786SJohannes Berg return true; 4197d6e89786SJohannes Berg } 4198d6e89786SJohannes Berg 4199db700897SOleg Nesterov /** 4200401a8d04STejun Heo * flush_work - wait for a work to finish executing the last queueing instance 4201401a8d04STejun Heo * @work: the work to flush 4202db700897SOleg Nesterov * 4203606a5020STejun Heo * Wait until @work has finished execution. @work is guaranteed to be idle 4204606a5020STejun Heo * on return if it hasn't been requeued since flush started. 4205401a8d04STejun Heo * 4206d185af30SYacine Belkadi * Return: 4207401a8d04STejun Heo * %true if flush_work() waited for the work to finish execution, 4208401a8d04STejun Heo * %false if it was already idle. 4209db700897SOleg Nesterov */ 4210401a8d04STejun Heo bool flush_work(struct work_struct *work) 4211db700897SOleg Nesterov { 4212134874e2STejun Heo might_sleep(); 4213d6e89786SJohannes Berg return __flush_work(work, false); 4214606a5020STejun Heo } 4215db700897SOleg Nesterov EXPORT_SYMBOL_GPL(flush_work); 4216db700897SOleg Nesterov 4217cdc6e4b3STejun Heo /** 4218cdc6e4b3STejun Heo * flush_delayed_work - wait for a dwork to finish executing the last queueing 4219cdc6e4b3STejun Heo * @dwork: the delayed work to flush 4220cdc6e4b3STejun Heo * 4221cdc6e4b3STejun Heo * Delayed timer is cancelled and the pending work is queued for 4222cdc6e4b3STejun Heo * immediate execution. Like flush_work(), this function only 4223cdc6e4b3STejun Heo * considers the last queueing instance of @dwork. 4224cdc6e4b3STejun Heo * 4225cdc6e4b3STejun Heo * Return: 4226cdc6e4b3STejun Heo * %true if flush_work() waited for the work to finish execution, 4227cdc6e4b3STejun Heo * %false if it was already idle. 4228cdc6e4b3STejun Heo */ 4229cdc6e4b3STejun Heo bool flush_delayed_work(struct delayed_work *dwork) 4230cdc6e4b3STejun Heo { 4231cdc6e4b3STejun Heo local_irq_disable(); 4232cdc6e4b3STejun Heo if (del_timer_sync(&dwork->timer)) 4233cdc6e4b3STejun Heo __queue_work(dwork->cpu, dwork->wq, &dwork->work); 4234cdc6e4b3STejun Heo local_irq_enable(); 4235cdc6e4b3STejun Heo return flush_work(&dwork->work); 4236cdc6e4b3STejun Heo } 4237cdc6e4b3STejun Heo EXPORT_SYMBOL(flush_delayed_work); 4238cdc6e4b3STejun Heo 4239cdc6e4b3STejun Heo /** 4240cdc6e4b3STejun Heo * flush_rcu_work - wait for a rwork to finish executing the last queueing 4241cdc6e4b3STejun Heo * @rwork: the rcu work to flush 4242cdc6e4b3STejun Heo * 4243cdc6e4b3STejun Heo * Return: 4244cdc6e4b3STejun Heo * %true if flush_rcu_work() waited for the work to finish execution, 4245cdc6e4b3STejun Heo * %false if it was already idle. 4246cdc6e4b3STejun Heo */ 4247cdc6e4b3STejun Heo bool flush_rcu_work(struct rcu_work *rwork) 4248cdc6e4b3STejun Heo { 4249cdc6e4b3STejun Heo if (test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(&rwork->work))) { 4250cdc6e4b3STejun Heo rcu_barrier(); 4251cdc6e4b3STejun Heo flush_work(&rwork->work); 4252cdc6e4b3STejun Heo return true; 4253cdc6e4b3STejun Heo } else { 4254cdc6e4b3STejun Heo return flush_work(&rwork->work); 4255cdc6e4b3STejun Heo } 4256cdc6e4b3STejun Heo } 4257cdc6e4b3STejun Heo EXPORT_SYMBOL(flush_rcu_work); 4258cdc6e4b3STejun Heo 425986898fa6STejun Heo static void work_offqd_disable(struct work_offq_data *offqd) 426086898fa6STejun Heo { 426186898fa6STejun Heo const unsigned long max = (1lu << WORK_OFFQ_DISABLE_BITS) - 1; 426286898fa6STejun Heo 426386898fa6STejun Heo if (likely(offqd->disable < max)) 426486898fa6STejun Heo offqd->disable++; 426586898fa6STejun Heo else 426686898fa6STejun Heo WARN_ONCE(true, "workqueue: work disable count overflowed\n"); 426786898fa6STejun Heo } 426886898fa6STejun Heo 426986898fa6STejun Heo static void work_offqd_enable(struct work_offq_data *offqd) 427086898fa6STejun Heo { 427186898fa6STejun Heo if (likely(offqd->disable > 0)) 427286898fa6STejun Heo offqd->disable--; 427386898fa6STejun Heo else 427486898fa6STejun Heo WARN_ONCE(true, "workqueue: work disable count underflowed\n"); 427586898fa6STejun Heo } 427686898fa6STejun Heo 4277c5f5b942STejun Heo static bool __cancel_work(struct work_struct *work, u32 cflags) 4278cdc6e4b3STejun Heo { 42791211f3b2STejun Heo struct work_offq_data offqd; 4280c26e2f2eSTejun Heo unsigned long irq_flags; 4281cdc6e4b3STejun Heo int ret; 4282cdc6e4b3STejun Heo 428386898fa6STejun Heo ret = work_grab_pending(work, cflags, &irq_flags); 4284cdc6e4b3STejun Heo 42851211f3b2STejun Heo work_offqd_unpack(&offqd, *work_data_bits(work)); 4286cdc6e4b3STejun Heo 428786898fa6STejun Heo if (cflags & WORK_CANCEL_DISABLE) 428886898fa6STejun Heo work_offqd_disable(&offqd); 428986898fa6STejun Heo 42901211f3b2STejun Heo set_work_pool_and_clear_pending(work, offqd.pool_id, 42911211f3b2STejun Heo work_offqd_pack_flags(&offqd)); 4292c26e2f2eSTejun Heo local_irq_restore(irq_flags); 4293cdc6e4b3STejun Heo return ret; 4294cdc6e4b3STejun Heo } 4295cdc6e4b3STejun Heo 4296c5f5b942STejun Heo static bool __cancel_work_sync(struct work_struct *work, u32 cflags) 4297401a8d04STejun Heo { 4298978b8409STejun Heo bool ret; 42991f1f642eSOleg Nesterov 4300f09b10b6STejun Heo ret = __cancel_work(work, cflags | WORK_CANCEL_DISABLE); 4301bbb68dfaSTejun Heo 4302134874e2STejun Heo if (*work_data_bits(work) & WORK_OFFQ_BH) 4303134874e2STejun Heo WARN_ON_ONCE(in_hardirq()); 4304134874e2STejun Heo else 4305134874e2STejun Heo might_sleep(); 4306bbb68dfaSTejun Heo 43073347fa09STejun Heo /* 4308c7a40c49STejun Heo * Skip __flush_work() during early boot when we know that @work isn't 4309c7a40c49STejun Heo * executing. This allows canceling during early boot. 43103347fa09STejun Heo */ 43113347fa09STejun Heo if (wq_online) 4312d6e89786SJohannes Berg __flush_work(work, true); 43133347fa09STejun Heo 4314f09b10b6STejun Heo if (!(cflags & WORK_CANCEL_DISABLE)) 4315f09b10b6STejun Heo enable_work(work); 43168603e1b3STejun Heo 43171f1f642eSOleg Nesterov return ret; 43181f1f642eSOleg Nesterov } 43191f1f642eSOleg Nesterov 4320cdc6e4b3STejun Heo /* 4321cdc6e4b3STejun Heo * See cancel_delayed_work() 4322cdc6e4b3STejun Heo */ 4323cdc6e4b3STejun Heo bool cancel_work(struct work_struct *work) 4324cdc6e4b3STejun Heo { 4325c5f5b942STejun Heo return __cancel_work(work, 0); 4326cdc6e4b3STejun Heo } 4327cdc6e4b3STejun Heo EXPORT_SYMBOL(cancel_work); 4328cdc6e4b3STejun Heo 43296e84d644SOleg Nesterov /** 4330401a8d04STejun Heo * cancel_work_sync - cancel a work and wait for it to finish 4331401a8d04STejun Heo * @work: the work to cancel 43326e84d644SOleg Nesterov * 4333134874e2STejun Heo * Cancel @work and wait for its execution to finish. This function can be used 4334134874e2STejun Heo * even if the work re-queues itself or migrates to another workqueue. On return 4335134874e2STejun Heo * from this function, @work is guaranteed to be not pending or executing on any 4336134874e2STejun Heo * CPU as long as there aren't racing enqueues. 43371f1f642eSOleg Nesterov * 4338134874e2STejun Heo * cancel_work_sync(&delayed_work->work) must not be used for delayed_work's. 4339134874e2STejun Heo * Use cancel_delayed_work_sync() instead. 43406e84d644SOleg Nesterov * 4341134874e2STejun Heo * Must be called from a sleepable context if @work was last queued on a non-BH 4342134874e2STejun Heo * workqueue. Can also be called from non-hardirq atomic contexts including BH 4343134874e2STejun Heo * if @work was last queued on a BH workqueue. 4344401a8d04STejun Heo * 4345134874e2STejun Heo * Returns %true if @work was pending, %false otherwise. 43466e84d644SOleg Nesterov */ 4347401a8d04STejun Heo bool cancel_work_sync(struct work_struct *work) 43486e84d644SOleg Nesterov { 4349c5f5b942STejun Heo return __cancel_work_sync(work, 0); 4350b89deed3SOleg Nesterov } 435128e53bddSOleg Nesterov EXPORT_SYMBOL_GPL(cancel_work_sync); 4352b89deed3SOleg Nesterov 43536e84d644SOleg Nesterov /** 435457b30ae7STejun Heo * cancel_delayed_work - cancel a delayed work 435557b30ae7STejun Heo * @dwork: delayed_work to cancel 435609383498STejun Heo * 4357d185af30SYacine Belkadi * Kill off a pending delayed_work. 4358d185af30SYacine Belkadi * 4359d185af30SYacine Belkadi * Return: %true if @dwork was pending and canceled; %false if it wasn't 4360d185af30SYacine Belkadi * pending. 4361d185af30SYacine Belkadi * 4362d185af30SYacine Belkadi * Note: 4363d185af30SYacine Belkadi * The work callback function may still be running on return, unless 4364d185af30SYacine Belkadi * it returns %true and the work doesn't re-arm itself. Explicitly flush or 4365d185af30SYacine Belkadi * use cancel_delayed_work_sync() to wait on it. 436609383498STejun Heo * 436757b30ae7STejun Heo * This function is safe to call from any context including IRQ handler. 436809383498STejun Heo */ 436957b30ae7STejun Heo bool cancel_delayed_work(struct delayed_work *dwork) 437009383498STejun Heo { 4371c5f5b942STejun Heo return __cancel_work(&dwork->work, WORK_CANCEL_DELAYED); 437209383498STejun Heo } 437357b30ae7STejun Heo EXPORT_SYMBOL(cancel_delayed_work); 437409383498STejun Heo 437509383498STejun Heo /** 4376401a8d04STejun Heo * cancel_delayed_work_sync - cancel a delayed work and wait for it to finish 4377401a8d04STejun Heo * @dwork: the delayed work cancel 4378401a8d04STejun Heo * 4379401a8d04STejun Heo * This is cancel_work_sync() for delayed works. 4380401a8d04STejun Heo * 4381d185af30SYacine Belkadi * Return: 4382401a8d04STejun Heo * %true if @dwork was pending, %false otherwise. 4383401a8d04STejun Heo */ 4384401a8d04STejun Heo bool cancel_delayed_work_sync(struct delayed_work *dwork) 43856e84d644SOleg Nesterov { 4386c5f5b942STejun Heo return __cancel_work_sync(&dwork->work, WORK_CANCEL_DELAYED); 43876e84d644SOleg Nesterov } 4388f5a421a4SOleg Nesterov EXPORT_SYMBOL(cancel_delayed_work_sync); 43891da177e4SLinus Torvalds 43900fcb78c2SRolf Eike Beer /** 439186898fa6STejun Heo * disable_work - Disable and cancel a work item 439286898fa6STejun Heo * @work: work item to disable 439386898fa6STejun Heo * 439486898fa6STejun Heo * Disable @work by incrementing its disable count and cancel it if currently 439586898fa6STejun Heo * pending. As long as the disable count is non-zero, any attempt to queue @work 439686898fa6STejun Heo * will fail and return %false. The maximum supported disable depth is 2 to the 439786898fa6STejun Heo * power of %WORK_OFFQ_DISABLE_BITS, currently 65536. 439886898fa6STejun Heo * 4399f09b10b6STejun Heo * Can be called from any context. Returns %true if @work was pending, %false 4400f09b10b6STejun Heo * otherwise. 440186898fa6STejun Heo */ 440286898fa6STejun Heo bool disable_work(struct work_struct *work) 440386898fa6STejun Heo { 440486898fa6STejun Heo return __cancel_work(work, WORK_CANCEL_DISABLE); 440586898fa6STejun Heo } 440686898fa6STejun Heo EXPORT_SYMBOL_GPL(disable_work); 440786898fa6STejun Heo 440886898fa6STejun Heo /** 440986898fa6STejun Heo * disable_work_sync - Disable, cancel and drain a work item 441086898fa6STejun Heo * @work: work item to disable 441186898fa6STejun Heo * 441286898fa6STejun Heo * Similar to disable_work() but also wait for @work to finish if currently 441386898fa6STejun Heo * executing. 441486898fa6STejun Heo * 4415134874e2STejun Heo * Must be called from a sleepable context if @work was last queued on a non-BH 4416134874e2STejun Heo * workqueue. Can also be called from non-hardirq atomic contexts including BH 4417134874e2STejun Heo * if @work was last queued on a BH workqueue. 4418134874e2STejun Heo * 4419134874e2STejun Heo * Returns %true if @work was pending, %false otherwise. 442086898fa6STejun Heo */ 442186898fa6STejun Heo bool disable_work_sync(struct work_struct *work) 442286898fa6STejun Heo { 442386898fa6STejun Heo return __cancel_work_sync(work, WORK_CANCEL_DISABLE); 442486898fa6STejun Heo } 442586898fa6STejun Heo EXPORT_SYMBOL_GPL(disable_work_sync); 442686898fa6STejun Heo 442786898fa6STejun Heo /** 442886898fa6STejun Heo * enable_work - Enable a work item 442986898fa6STejun Heo * @work: work item to enable 443086898fa6STejun Heo * 443186898fa6STejun Heo * Undo disable_work[_sync]() by decrementing @work's disable count. @work can 443286898fa6STejun Heo * only be queued if its disable count is 0. 443386898fa6STejun Heo * 4434f09b10b6STejun Heo * Can be called from any context. Returns %true if the disable count reached 0. 4435f09b10b6STejun Heo * Otherwise, %false. 443686898fa6STejun Heo */ 443786898fa6STejun Heo bool enable_work(struct work_struct *work) 443886898fa6STejun Heo { 443986898fa6STejun Heo struct work_offq_data offqd; 444086898fa6STejun Heo unsigned long irq_flags; 444186898fa6STejun Heo 444286898fa6STejun Heo work_grab_pending(work, 0, &irq_flags); 444386898fa6STejun Heo 444486898fa6STejun Heo work_offqd_unpack(&offqd, *work_data_bits(work)); 444586898fa6STejun Heo work_offqd_enable(&offqd); 444686898fa6STejun Heo set_work_pool_and_clear_pending(work, offqd.pool_id, 444786898fa6STejun Heo work_offqd_pack_flags(&offqd)); 444886898fa6STejun Heo local_irq_restore(irq_flags); 444986898fa6STejun Heo 445086898fa6STejun Heo return !offqd.disable; 445186898fa6STejun Heo } 445286898fa6STejun Heo EXPORT_SYMBOL_GPL(enable_work); 445386898fa6STejun Heo 445486898fa6STejun Heo /** 445586898fa6STejun Heo * disable_delayed_work - Disable and cancel a delayed work item 445686898fa6STejun Heo * @dwork: delayed work item to disable 445786898fa6STejun Heo * 445886898fa6STejun Heo * disable_work() for delayed work items. 445986898fa6STejun Heo */ 446086898fa6STejun Heo bool disable_delayed_work(struct delayed_work *dwork) 446186898fa6STejun Heo { 446286898fa6STejun Heo return __cancel_work(&dwork->work, 446386898fa6STejun Heo WORK_CANCEL_DELAYED | WORK_CANCEL_DISABLE); 446486898fa6STejun Heo } 446586898fa6STejun Heo EXPORT_SYMBOL_GPL(disable_delayed_work); 446686898fa6STejun Heo 446786898fa6STejun Heo /** 446886898fa6STejun Heo * disable_delayed_work_sync - Disable, cancel and drain a delayed work item 446986898fa6STejun Heo * @dwork: delayed work item to disable 447086898fa6STejun Heo * 447186898fa6STejun Heo * disable_work_sync() for delayed work items. 447286898fa6STejun Heo */ 447386898fa6STejun Heo bool disable_delayed_work_sync(struct delayed_work *dwork) 447486898fa6STejun Heo { 447586898fa6STejun Heo return __cancel_work_sync(&dwork->work, 447686898fa6STejun Heo WORK_CANCEL_DELAYED | WORK_CANCEL_DISABLE); 447786898fa6STejun Heo } 447886898fa6STejun Heo EXPORT_SYMBOL_GPL(disable_delayed_work_sync); 447986898fa6STejun Heo 448086898fa6STejun Heo /** 448186898fa6STejun Heo * enable_delayed_work - Enable a delayed work item 448286898fa6STejun Heo * @dwork: delayed work item to enable 448386898fa6STejun Heo * 448486898fa6STejun Heo * enable_work() for delayed work items. 448586898fa6STejun Heo */ 448686898fa6STejun Heo bool enable_delayed_work(struct delayed_work *dwork) 448786898fa6STejun Heo { 448886898fa6STejun Heo return enable_work(&dwork->work); 448986898fa6STejun Heo } 449086898fa6STejun Heo EXPORT_SYMBOL_GPL(enable_delayed_work); 449186898fa6STejun Heo 449286898fa6STejun Heo /** 449331ddd871STejun Heo * schedule_on_each_cpu - execute a function synchronously on each online CPU 4494b6136773SAndrew Morton * @func: the function to call 4495b6136773SAndrew Morton * 449631ddd871STejun Heo * schedule_on_each_cpu() executes @func on each online CPU using the 449731ddd871STejun Heo * system workqueue and blocks until all CPUs have completed. 4498b6136773SAndrew Morton * schedule_on_each_cpu() is very slow. 449931ddd871STejun Heo * 4500d185af30SYacine Belkadi * Return: 450131ddd871STejun Heo * 0 on success, -errno on failure. 4502b6136773SAndrew Morton */ 450365f27f38SDavid Howells int schedule_on_each_cpu(work_func_t func) 450415316ba8SChristoph Lameter { 450515316ba8SChristoph Lameter int cpu; 450638f51568SNamhyung Kim struct work_struct __percpu *works; 450715316ba8SChristoph Lameter 4508b6136773SAndrew Morton works = alloc_percpu(struct work_struct); 4509b6136773SAndrew Morton if (!works) 451015316ba8SChristoph Lameter return -ENOMEM; 4511b6136773SAndrew Morton 4512ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 451393981800STejun Heo 451415316ba8SChristoph Lameter for_each_online_cpu(cpu) { 45159bfb1839SIngo Molnar struct work_struct *work = per_cpu_ptr(works, cpu); 45169bfb1839SIngo Molnar 45179bfb1839SIngo Molnar INIT_WORK(work, func); 45188de6d308SOleg Nesterov schedule_work_on(cpu, work); 451915316ba8SChristoph Lameter } 452093981800STejun Heo 452193981800STejun Heo for_each_online_cpu(cpu) 45228616a89aSOleg Nesterov flush_work(per_cpu_ptr(works, cpu)); 452393981800STejun Heo 4524ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 4525b6136773SAndrew Morton free_percpu(works); 452615316ba8SChristoph Lameter return 0; 452715316ba8SChristoph Lameter } 452815316ba8SChristoph Lameter 4529eef6a7d5SAlan Stern /** 45301fa44ecaSJames Bottomley * execute_in_process_context - reliably execute the routine with user context 45311fa44ecaSJames Bottomley * @fn: the function to execute 45321fa44ecaSJames Bottomley * @ew: guaranteed storage for the execute work structure (must 45331fa44ecaSJames Bottomley * be available when the work executes) 45341fa44ecaSJames Bottomley * 45351fa44ecaSJames Bottomley * Executes the function immediately if process context is available, 45361fa44ecaSJames Bottomley * otherwise schedules the function for delayed execution. 45371fa44ecaSJames Bottomley * 4538d185af30SYacine Belkadi * Return: 0 - function was executed 45391fa44ecaSJames Bottomley * 1 - function was scheduled for execution 45401fa44ecaSJames Bottomley */ 454165f27f38SDavid Howells int execute_in_process_context(work_func_t fn, struct execute_work *ew) 45421fa44ecaSJames Bottomley { 45431fa44ecaSJames Bottomley if (!in_interrupt()) { 454465f27f38SDavid Howells fn(&ew->work); 45451fa44ecaSJames Bottomley return 0; 45461fa44ecaSJames Bottomley } 45471fa44ecaSJames Bottomley 454865f27f38SDavid Howells INIT_WORK(&ew->work, fn); 45491fa44ecaSJames Bottomley schedule_work(&ew->work); 45501fa44ecaSJames Bottomley 45511fa44ecaSJames Bottomley return 1; 45521fa44ecaSJames Bottomley } 45531fa44ecaSJames Bottomley EXPORT_SYMBOL_GPL(execute_in_process_context); 45541fa44ecaSJames Bottomley 45557a4e344cSTejun Heo /** 45567a4e344cSTejun Heo * free_workqueue_attrs - free a workqueue_attrs 45577a4e344cSTejun Heo * @attrs: workqueue_attrs to free 45587a4e344cSTejun Heo * 45597a4e344cSTejun Heo * Undo alloc_workqueue_attrs(). 45607a4e344cSTejun Heo */ 4561513c98d0SDaniel Jordan void free_workqueue_attrs(struct workqueue_attrs *attrs) 45627a4e344cSTejun Heo { 45637a4e344cSTejun Heo if (attrs) { 45647a4e344cSTejun Heo free_cpumask_var(attrs->cpumask); 45659546b29eSTejun Heo free_cpumask_var(attrs->__pod_cpumask); 45667a4e344cSTejun Heo kfree(attrs); 45677a4e344cSTejun Heo } 45687a4e344cSTejun Heo } 45697a4e344cSTejun Heo 45707a4e344cSTejun Heo /** 45717a4e344cSTejun Heo * alloc_workqueue_attrs - allocate a workqueue_attrs 45727a4e344cSTejun Heo * 45737a4e344cSTejun Heo * Allocate a new workqueue_attrs, initialize with default settings and 4574d185af30SYacine Belkadi * return it. 4575d185af30SYacine Belkadi * 4576d185af30SYacine Belkadi * Return: The allocated new workqueue_attr on success. %NULL on failure. 45777a4e344cSTejun Heo */ 4578513c98d0SDaniel Jordan struct workqueue_attrs *alloc_workqueue_attrs(void) 45797a4e344cSTejun Heo { 45807a4e344cSTejun Heo struct workqueue_attrs *attrs; 45817a4e344cSTejun Heo 4582be69d00dSThomas Gleixner attrs = kzalloc(sizeof(*attrs), GFP_KERNEL); 45837a4e344cSTejun Heo if (!attrs) 45847a4e344cSTejun Heo goto fail; 4585be69d00dSThomas Gleixner if (!alloc_cpumask_var(&attrs->cpumask, GFP_KERNEL)) 45867a4e344cSTejun Heo goto fail; 45879546b29eSTejun Heo if (!alloc_cpumask_var(&attrs->__pod_cpumask, GFP_KERNEL)) 45889546b29eSTejun Heo goto fail; 45897a4e344cSTejun Heo 459013e2e556STejun Heo cpumask_copy(attrs->cpumask, cpu_possible_mask); 4591523a301eSTejun Heo attrs->affn_scope = WQ_AFFN_DFL; 45927a4e344cSTejun Heo return attrs; 45937a4e344cSTejun Heo fail: 45947a4e344cSTejun Heo free_workqueue_attrs(attrs); 45957a4e344cSTejun Heo return NULL; 45967a4e344cSTejun Heo } 45977a4e344cSTejun Heo 459829c91e99STejun Heo static void copy_workqueue_attrs(struct workqueue_attrs *to, 459929c91e99STejun Heo const struct workqueue_attrs *from) 460029c91e99STejun Heo { 460129c91e99STejun Heo to->nice = from->nice; 460229c91e99STejun Heo cpumask_copy(to->cpumask, from->cpumask); 46039546b29eSTejun Heo cpumask_copy(to->__pod_cpumask, from->__pod_cpumask); 46048639ecebSTejun Heo to->affn_strict = from->affn_strict; 460584193c07STejun Heo 46062865a8fbSShaohua Li /* 460784193c07STejun Heo * Unlike hash and equality test, copying shouldn't ignore wq-only 460884193c07STejun Heo * fields as copying is used for both pool and wq attrs. Instead, 460984193c07STejun Heo * get_unbound_pool() explicitly clears the fields. 46102865a8fbSShaohua Li */ 461184193c07STejun Heo to->affn_scope = from->affn_scope; 4612af73f5c9STejun Heo to->ordered = from->ordered; 461329c91e99STejun Heo } 461429c91e99STejun Heo 46155de7a03cSTejun Heo /* 46165de7a03cSTejun Heo * Some attrs fields are workqueue-only. Clear them for worker_pool's. See the 46175de7a03cSTejun Heo * comments in 'struct workqueue_attrs' definition. 46185de7a03cSTejun Heo */ 46195de7a03cSTejun Heo static void wqattrs_clear_for_pool(struct workqueue_attrs *attrs) 46205de7a03cSTejun Heo { 462184193c07STejun Heo attrs->affn_scope = WQ_AFFN_NR_TYPES; 46225de7a03cSTejun Heo attrs->ordered = false; 4623ae1296a7SLai Jiangshan if (attrs->affn_strict) 4624ae1296a7SLai Jiangshan cpumask_copy(attrs->cpumask, cpu_possible_mask); 46255de7a03cSTejun Heo } 46265de7a03cSTejun Heo 462729c91e99STejun Heo /* hash value of the content of @attr */ 462829c91e99STejun Heo static u32 wqattrs_hash(const struct workqueue_attrs *attrs) 462929c91e99STejun Heo { 463029c91e99STejun Heo u32 hash = 0; 463129c91e99STejun Heo 463229c91e99STejun Heo hash = jhash_1word(attrs->nice, hash); 4633ae1296a7SLai Jiangshan hash = jhash_1word(attrs->affn_strict, hash); 46349546b29eSTejun Heo hash = jhash(cpumask_bits(attrs->__pod_cpumask), 46359546b29eSTejun Heo BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); 4636ae1296a7SLai Jiangshan if (!attrs->affn_strict) 4637ae1296a7SLai Jiangshan hash = jhash(cpumask_bits(attrs->cpumask), 4638ae1296a7SLai Jiangshan BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long), hash); 463929c91e99STejun Heo return hash; 464029c91e99STejun Heo } 464129c91e99STejun Heo 464229c91e99STejun Heo /* content equality test */ 464329c91e99STejun Heo static bool wqattrs_equal(const struct workqueue_attrs *a, 464429c91e99STejun Heo const struct workqueue_attrs *b) 464529c91e99STejun Heo { 464629c91e99STejun Heo if (a->nice != b->nice) 464729c91e99STejun Heo return false; 4648ae1296a7SLai Jiangshan if (a->affn_strict != b->affn_strict) 464929c91e99STejun Heo return false; 46509546b29eSTejun Heo if (!cpumask_equal(a->__pod_cpumask, b->__pod_cpumask)) 46519546b29eSTejun Heo return false; 4652ae1296a7SLai Jiangshan if (!a->affn_strict && !cpumask_equal(a->cpumask, b->cpumask)) 46538639ecebSTejun Heo return false; 465429c91e99STejun Heo return true; 465529c91e99STejun Heo } 465629c91e99STejun Heo 46570f36ee24STejun Heo /* Update @attrs with actually available CPUs */ 46580f36ee24STejun Heo static void wqattrs_actualize_cpumask(struct workqueue_attrs *attrs, 46590f36ee24STejun Heo const cpumask_t *unbound_cpumask) 46600f36ee24STejun Heo { 46610f36ee24STejun Heo /* 46620f36ee24STejun Heo * Calculate the effective CPU mask of @attrs given @unbound_cpumask. If 46630f36ee24STejun Heo * @attrs->cpumask doesn't overlap with @unbound_cpumask, we fallback to 46640f36ee24STejun Heo * @unbound_cpumask. 46650f36ee24STejun Heo */ 46660f36ee24STejun Heo cpumask_and(attrs->cpumask, attrs->cpumask, unbound_cpumask); 46670f36ee24STejun Heo if (unlikely(cpumask_empty(attrs->cpumask))) 46680f36ee24STejun Heo cpumask_copy(attrs->cpumask, unbound_cpumask); 46690f36ee24STejun Heo } 46700f36ee24STejun Heo 467184193c07STejun Heo /* find wq_pod_type to use for @attrs */ 467284193c07STejun Heo static const struct wq_pod_type * 467384193c07STejun Heo wqattrs_pod_type(const struct workqueue_attrs *attrs) 467484193c07STejun Heo { 4675523a301eSTejun Heo enum wq_affn_scope scope; 4676523a301eSTejun Heo struct wq_pod_type *pt; 4677523a301eSTejun Heo 4678523a301eSTejun Heo /* to synchronize access to wq_affn_dfl */ 4679523a301eSTejun Heo lockdep_assert_held(&wq_pool_mutex); 4680523a301eSTejun Heo 4681523a301eSTejun Heo if (attrs->affn_scope == WQ_AFFN_DFL) 4682523a301eSTejun Heo scope = wq_affn_dfl; 4683523a301eSTejun Heo else 4684523a301eSTejun Heo scope = attrs->affn_scope; 4685523a301eSTejun Heo 4686523a301eSTejun Heo pt = &wq_pod_types[scope]; 468784193c07STejun Heo 468884193c07STejun Heo if (!WARN_ON_ONCE(attrs->affn_scope == WQ_AFFN_NR_TYPES) && 468984193c07STejun Heo likely(pt->nr_pods)) 469084193c07STejun Heo return pt; 469184193c07STejun Heo 469284193c07STejun Heo /* 469384193c07STejun Heo * Before workqueue_init_topology(), only SYSTEM is available which is 469484193c07STejun Heo * initialized in workqueue_init_early(). 469584193c07STejun Heo */ 469684193c07STejun Heo pt = &wq_pod_types[WQ_AFFN_SYSTEM]; 469784193c07STejun Heo BUG_ON(!pt->nr_pods); 469884193c07STejun Heo return pt; 469984193c07STejun Heo } 470084193c07STejun Heo 47017a4e344cSTejun Heo /** 47027a4e344cSTejun Heo * init_worker_pool - initialize a newly zalloc'd worker_pool 47037a4e344cSTejun Heo * @pool: worker_pool to initialize 47047a4e344cSTejun Heo * 4705402dd89dSShailendra Verma * Initialize a newly zalloc'd @pool. It also allocates @pool->attrs. 4706d185af30SYacine Belkadi * 4707d185af30SYacine Belkadi * Return: 0 on success, -errno on failure. Even on failure, all fields 470829c91e99STejun Heo * inside @pool proper are initialized and put_unbound_pool() can be called 470929c91e99STejun Heo * on @pool safely to release it. 47107a4e344cSTejun Heo */ 47117a4e344cSTejun Heo static int init_worker_pool(struct worker_pool *pool) 47124e1a1f9aSTejun Heo { 4713a9b8a985SSebastian Andrzej Siewior raw_spin_lock_init(&pool->lock); 471429c91e99STejun Heo pool->id = -1; 471529c91e99STejun Heo pool->cpu = -1; 4716f3f90ad4STejun Heo pool->node = NUMA_NO_NODE; 47174e1a1f9aSTejun Heo pool->flags |= POOL_DISASSOCIATED; 471882607adcSTejun Heo pool->watchdog_ts = jiffies; 47194e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->worklist); 47204e1a1f9aSTejun Heo INIT_LIST_HEAD(&pool->idle_list); 47214e1a1f9aSTejun Heo hash_init(pool->busy_hash); 47224e1a1f9aSTejun Heo 472332a6c723SKees Cook timer_setup(&pool->idle_timer, idle_worker_timeout, TIMER_DEFERRABLE); 47243f959aa3SValentin Schneider INIT_WORK(&pool->idle_cull_work, idle_cull_fn); 47254e1a1f9aSTejun Heo 472632a6c723SKees Cook timer_setup(&pool->mayday_timer, pool_mayday_timeout, 0); 47274e1a1f9aSTejun Heo 4728da028469SLai Jiangshan INIT_LIST_HEAD(&pool->workers); 47297a4e344cSTejun Heo 47307cda9aaeSLai Jiangshan ida_init(&pool->worker_ida); 473129c91e99STejun Heo INIT_HLIST_NODE(&pool->hash_node); 473229c91e99STejun Heo pool->refcnt = 1; 473329c91e99STejun Heo 473429c91e99STejun Heo /* shouldn't fail above this point */ 4735be69d00dSThomas Gleixner pool->attrs = alloc_workqueue_attrs(); 47367a4e344cSTejun Heo if (!pool->attrs) 47377a4e344cSTejun Heo return -ENOMEM; 47385de7a03cSTejun Heo 47395de7a03cSTejun Heo wqattrs_clear_for_pool(pool->attrs); 47405de7a03cSTejun Heo 47417a4e344cSTejun Heo return 0; 47424e1a1f9aSTejun Heo } 47434e1a1f9aSTejun Heo 4744669de8bdSBart Van Assche #ifdef CONFIG_LOCKDEP 4745669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq) 4746669de8bdSBart Van Assche { 4747669de8bdSBart Van Assche char *lock_name; 4748669de8bdSBart Van Assche 4749669de8bdSBart Van Assche lockdep_register_key(&wq->key); 4750669de8bdSBart Van Assche lock_name = kasprintf(GFP_KERNEL, "%s%s", "(wq_completion)", wq->name); 4751669de8bdSBart Van Assche if (!lock_name) 4752669de8bdSBart Van Assche lock_name = wq->name; 475369a106c0SQian Cai 475469a106c0SQian Cai wq->lock_name = lock_name; 4755669de8bdSBart Van Assche lockdep_init_map(&wq->lockdep_map, lock_name, &wq->key, 0); 4756669de8bdSBart Van Assche } 4757669de8bdSBart Van Assche 4758669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq) 4759669de8bdSBart Van Assche { 4760669de8bdSBart Van Assche lockdep_unregister_key(&wq->key); 4761669de8bdSBart Van Assche } 4762669de8bdSBart Van Assche 4763669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq) 4764669de8bdSBart Van Assche { 4765669de8bdSBart Van Assche if (wq->lock_name != wq->name) 4766669de8bdSBart Van Assche kfree(wq->lock_name); 4767669de8bdSBart Van Assche } 4768669de8bdSBart Van Assche #else 4769669de8bdSBart Van Assche static void wq_init_lockdep(struct workqueue_struct *wq) 4770669de8bdSBart Van Assche { 4771669de8bdSBart Van Assche } 4772669de8bdSBart Van Assche 4773669de8bdSBart Van Assche static void wq_unregister_lockdep(struct workqueue_struct *wq) 4774669de8bdSBart Van Assche { 4775669de8bdSBart Van Assche } 4776669de8bdSBart Van Assche 4777669de8bdSBart Van Assche static void wq_free_lockdep(struct workqueue_struct *wq) 4778669de8bdSBart Van Assche { 4779669de8bdSBart Van Assche } 4780669de8bdSBart Van Assche #endif 4781669de8bdSBart Van Assche 478291ccc6e7STejun Heo static void free_node_nr_active(struct wq_node_nr_active **nna_ar) 478391ccc6e7STejun Heo { 478491ccc6e7STejun Heo int node; 478591ccc6e7STejun Heo 478691ccc6e7STejun Heo for_each_node(node) { 478791ccc6e7STejun Heo kfree(nna_ar[node]); 478891ccc6e7STejun Heo nna_ar[node] = NULL; 478991ccc6e7STejun Heo } 479091ccc6e7STejun Heo 479191ccc6e7STejun Heo kfree(nna_ar[nr_node_ids]); 479291ccc6e7STejun Heo nna_ar[nr_node_ids] = NULL; 479391ccc6e7STejun Heo } 479491ccc6e7STejun Heo 479591ccc6e7STejun Heo static void init_node_nr_active(struct wq_node_nr_active *nna) 479691ccc6e7STejun Heo { 4797c5f8cd6cSTejun Heo nna->max = WQ_DFL_MIN_ACTIVE; 479891ccc6e7STejun Heo atomic_set(&nna->nr, 0); 47995797b1c1STejun Heo raw_spin_lock_init(&nna->lock); 48005797b1c1STejun Heo INIT_LIST_HEAD(&nna->pending_pwqs); 480191ccc6e7STejun Heo } 480291ccc6e7STejun Heo 480391ccc6e7STejun Heo /* 480491ccc6e7STejun Heo * Each node's nr_active counter will be accessed mostly from its own node and 480591ccc6e7STejun Heo * should be allocated in the node. 480691ccc6e7STejun Heo */ 480791ccc6e7STejun Heo static int alloc_node_nr_active(struct wq_node_nr_active **nna_ar) 480891ccc6e7STejun Heo { 480991ccc6e7STejun Heo struct wq_node_nr_active *nna; 481091ccc6e7STejun Heo int node; 481191ccc6e7STejun Heo 481291ccc6e7STejun Heo for_each_node(node) { 481391ccc6e7STejun Heo nna = kzalloc_node(sizeof(*nna), GFP_KERNEL, node); 481491ccc6e7STejun Heo if (!nna) 481591ccc6e7STejun Heo goto err_free; 481691ccc6e7STejun Heo init_node_nr_active(nna); 481791ccc6e7STejun Heo nna_ar[node] = nna; 481891ccc6e7STejun Heo } 481991ccc6e7STejun Heo 482091ccc6e7STejun Heo /* [nr_node_ids] is used as the fallback */ 482191ccc6e7STejun Heo nna = kzalloc_node(sizeof(*nna), GFP_KERNEL, NUMA_NO_NODE); 482291ccc6e7STejun Heo if (!nna) 482391ccc6e7STejun Heo goto err_free; 482491ccc6e7STejun Heo init_node_nr_active(nna); 482591ccc6e7STejun Heo nna_ar[nr_node_ids] = nna; 482691ccc6e7STejun Heo 482791ccc6e7STejun Heo return 0; 482891ccc6e7STejun Heo 482991ccc6e7STejun Heo err_free: 483091ccc6e7STejun Heo free_node_nr_active(nna_ar); 483191ccc6e7STejun Heo return -ENOMEM; 483291ccc6e7STejun Heo } 483391ccc6e7STejun Heo 4834e2dca7adSTejun Heo static void rcu_free_wq(struct rcu_head *rcu) 4835e2dca7adSTejun Heo { 4836e2dca7adSTejun Heo struct workqueue_struct *wq = 4837e2dca7adSTejun Heo container_of(rcu, struct workqueue_struct, rcu); 4838e2dca7adSTejun Heo 483991ccc6e7STejun Heo if (wq->flags & WQ_UNBOUND) 484091ccc6e7STejun Heo free_node_nr_active(wq->node_nr_active); 484191ccc6e7STejun Heo 4842669de8bdSBart Van Assche wq_free_lockdep(wq); 4843ee1ceef7STejun Heo free_percpu(wq->cpu_pwq); 4844e2dca7adSTejun Heo free_workqueue_attrs(wq->unbound_attrs); 4845e2dca7adSTejun Heo kfree(wq); 4846e2dca7adSTejun Heo } 4847e2dca7adSTejun Heo 484829c91e99STejun Heo static void rcu_free_pool(struct rcu_head *rcu) 484929c91e99STejun Heo { 485029c91e99STejun Heo struct worker_pool *pool = container_of(rcu, struct worker_pool, rcu); 485129c91e99STejun Heo 48527cda9aaeSLai Jiangshan ida_destroy(&pool->worker_ida); 485329c91e99STejun Heo free_workqueue_attrs(pool->attrs); 485429c91e99STejun Heo kfree(pool); 485529c91e99STejun Heo } 485629c91e99STejun Heo 485729c91e99STejun Heo /** 485829c91e99STejun Heo * put_unbound_pool - put a worker_pool 485929c91e99STejun Heo * @pool: worker_pool to put 486029c91e99STejun Heo * 486124acfb71SThomas Gleixner * Put @pool. If its refcnt reaches zero, it gets destroyed in RCU 4862c5aa87bbSTejun Heo * safe manner. get_unbound_pool() calls this function on its failure path 4863c5aa87bbSTejun Heo * and this function should be able to release pools which went through, 4864c5aa87bbSTejun Heo * successfully or not, init_worker_pool(). 4865a892caccSTejun Heo * 4866a892caccSTejun Heo * Should be called with wq_pool_mutex held. 486729c91e99STejun Heo */ 486829c91e99STejun Heo static void put_unbound_pool(struct worker_pool *pool) 486929c91e99STejun Heo { 487029c91e99STejun Heo struct worker *worker; 48719680540cSYang Yingliang LIST_HEAD(cull_list); 4872e02b9312SValentin Schneider 4873a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 4874a892caccSTejun Heo 4875a892caccSTejun Heo if (--pool->refcnt) 487629c91e99STejun Heo return; 487729c91e99STejun Heo 487829c91e99STejun Heo /* sanity checks */ 487961d0fbb4SLai Jiangshan if (WARN_ON(!(pool->cpu < 0)) || 4880a892caccSTejun Heo WARN_ON(!list_empty(&pool->worklist))) 488129c91e99STejun Heo return; 488229c91e99STejun Heo 488329c91e99STejun Heo /* release id and unhash */ 488429c91e99STejun Heo if (pool->id >= 0) 488529c91e99STejun Heo idr_remove(&worker_pool_idr, pool->id); 488629c91e99STejun Heo hash_del(&pool->hash_node); 488729c91e99STejun Heo 4888c5aa87bbSTejun Heo /* 4889692b4825STejun Heo * Become the manager and destroy all workers. This prevents 4890692b4825STejun Heo * @pool's workers from blocking on attach_mutex. We're the last 4891692b4825STejun Heo * manager and @pool gets freed with the flag set. 48929ab03be4SValentin Schneider * 48939ab03be4SValentin Schneider * Having a concurrent manager is quite unlikely to happen as we can 48949ab03be4SValentin Schneider * only get here with 48959ab03be4SValentin Schneider * pwq->refcnt == pool->refcnt == 0 48969ab03be4SValentin Schneider * which implies no work queued to the pool, which implies no worker can 48979ab03be4SValentin Schneider * become the manager. However a worker could have taken the role of 48989ab03be4SValentin Schneider * manager before the refcnts dropped to 0, since maybe_create_worker() 48999ab03be4SValentin Schneider * drops pool->lock 4900c5aa87bbSTejun Heo */ 49019ab03be4SValentin Schneider while (true) { 49029ab03be4SValentin Schneider rcuwait_wait_event(&manager_wait, 49039ab03be4SValentin Schneider !(pool->flags & POOL_MANAGER_ACTIVE), 4904d8bb65abSSebastian Andrzej Siewior TASK_UNINTERRUPTIBLE); 4905e02b9312SValentin Schneider 4906e02b9312SValentin Schneider mutex_lock(&wq_pool_attach_mutex); 49079ab03be4SValentin Schneider raw_spin_lock_irq(&pool->lock); 49089ab03be4SValentin Schneider if (!(pool->flags & POOL_MANAGER_ACTIVE)) { 4909692b4825STejun Heo pool->flags |= POOL_MANAGER_ACTIVE; 49109ab03be4SValentin Schneider break; 49119ab03be4SValentin Schneider } 49129ab03be4SValentin Schneider raw_spin_unlock_irq(&pool->lock); 4913e02b9312SValentin Schneider mutex_unlock(&wq_pool_attach_mutex); 49149ab03be4SValentin Schneider } 4915692b4825STejun Heo 49161037de36SLai Jiangshan while ((worker = first_idle_worker(pool))) 4917e02b9312SValentin Schneider set_worker_dying(worker, &cull_list); 491829c91e99STejun Heo WARN_ON(pool->nr_workers || pool->nr_idle); 4919a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 492060f5a4bcSLai Jiangshan 4921f4b7b53cSLai Jiangshan detach_dying_workers(&cull_list); 4922e02b9312SValentin Schneider 49231258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 492460f5a4bcSLai Jiangshan 492568f83057SLai Jiangshan reap_dying_workers(&cull_list); 492660f5a4bcSLai Jiangshan 492729c91e99STejun Heo /* shut down the timers */ 492829c91e99STejun Heo del_timer_sync(&pool->idle_timer); 49293f959aa3SValentin Schneider cancel_work_sync(&pool->idle_cull_work); 493029c91e99STejun Heo del_timer_sync(&pool->mayday_timer); 493129c91e99STejun Heo 493224acfb71SThomas Gleixner /* RCU protected to allow dereferences from get_work_pool() */ 493325b00775SPaul E. McKenney call_rcu(&pool->rcu, rcu_free_pool); 493429c91e99STejun Heo } 493529c91e99STejun Heo 493629c91e99STejun Heo /** 493729c91e99STejun Heo * get_unbound_pool - get a worker_pool with the specified attributes 493829c91e99STejun Heo * @attrs: the attributes of the worker_pool to get 493929c91e99STejun Heo * 494029c91e99STejun Heo * Obtain a worker_pool which has the same attributes as @attrs, bump the 494129c91e99STejun Heo * reference count and return it. If there already is a matching 494229c91e99STejun Heo * worker_pool, it will be used; otherwise, this function attempts to 4943d185af30SYacine Belkadi * create a new one. 4944a892caccSTejun Heo * 4945a892caccSTejun Heo * Should be called with wq_pool_mutex held. 4946d185af30SYacine Belkadi * 4947d185af30SYacine Belkadi * Return: On success, a worker_pool with the same attributes as @attrs. 4948d185af30SYacine Belkadi * On failure, %NULL. 494929c91e99STejun Heo */ 495029c91e99STejun Heo static struct worker_pool *get_unbound_pool(const struct workqueue_attrs *attrs) 495129c91e99STejun Heo { 495284193c07STejun Heo struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_NUMA]; 495329c91e99STejun Heo u32 hash = wqattrs_hash(attrs); 495429c91e99STejun Heo struct worker_pool *pool; 495584193c07STejun Heo int pod, node = NUMA_NO_NODE; 495629c91e99STejun Heo 4957a892caccSTejun Heo lockdep_assert_held(&wq_pool_mutex); 495829c91e99STejun Heo 495929c91e99STejun Heo /* do we already have a matching pool? */ 496029c91e99STejun Heo hash_for_each_possible(unbound_pool_hash, pool, hash_node, hash) { 496129c91e99STejun Heo if (wqattrs_equal(pool->attrs, attrs)) { 496229c91e99STejun Heo pool->refcnt++; 49633fb1823cSLai Jiangshan return pool; 496429c91e99STejun Heo } 496529c91e99STejun Heo } 496629c91e99STejun Heo 49679546b29eSTejun Heo /* If __pod_cpumask is contained inside a NUMA pod, that's our node */ 496884193c07STejun Heo for (pod = 0; pod < pt->nr_pods; pod++) { 49699546b29eSTejun Heo if (cpumask_subset(attrs->__pod_cpumask, pt->pod_cpus[pod])) { 497084193c07STejun Heo node = pt->pod_node[pod]; 4971e2273584SXunlei Pang break; 4972e2273584SXunlei Pang } 4973e2273584SXunlei Pang } 4974e2273584SXunlei Pang 497529c91e99STejun Heo /* nope, create a new one */ 497684193c07STejun Heo pool = kzalloc_node(sizeof(*pool), GFP_KERNEL, node); 497729c91e99STejun Heo if (!pool || init_worker_pool(pool) < 0) 497829c91e99STejun Heo goto fail; 497929c91e99STejun Heo 498084193c07STejun Heo pool->node = node; 49815de7a03cSTejun Heo copy_workqueue_attrs(pool->attrs, attrs); 49825de7a03cSTejun Heo wqattrs_clear_for_pool(pool->attrs); 49832865a8fbSShaohua Li 498429c91e99STejun Heo if (worker_pool_assign_id(pool) < 0) 498529c91e99STejun Heo goto fail; 498629c91e99STejun Heo 498729c91e99STejun Heo /* create and start the initial worker */ 49883347fa09STejun Heo if (wq_online && !create_worker(pool)) 498929c91e99STejun Heo goto fail; 499029c91e99STejun Heo 499129c91e99STejun Heo /* install */ 499229c91e99STejun Heo hash_add(unbound_pool_hash, &pool->hash_node, hash); 49933fb1823cSLai Jiangshan 499429c91e99STejun Heo return pool; 499529c91e99STejun Heo fail: 499629c91e99STejun Heo if (pool) 499729c91e99STejun Heo put_unbound_pool(pool); 499829c91e99STejun Heo return NULL; 499929c91e99STejun Heo } 500029c91e99STejun Heo 50018864b4e5STejun Heo /* 5002967b494eSTejun Heo * Scheduled on pwq_release_worker by put_pwq() when an unbound pwq hits zero 5003967b494eSTejun Heo * refcnt and needs to be destroyed. 50048864b4e5STejun Heo */ 5005687a9aa5STejun Heo static void pwq_release_workfn(struct kthread_work *work) 50068864b4e5STejun Heo { 50078864b4e5STejun Heo struct pool_workqueue *pwq = container_of(work, struct pool_workqueue, 5008687a9aa5STejun Heo release_work); 50098864b4e5STejun Heo struct workqueue_struct *wq = pwq->wq; 50108864b4e5STejun Heo struct worker_pool *pool = pwq->pool; 5011b42b0bddSYang Yingliang bool is_last = false; 50128864b4e5STejun Heo 5013b42b0bddSYang Yingliang /* 5014687a9aa5STejun Heo * When @pwq is not linked, it doesn't hold any reference to the 5015b42b0bddSYang Yingliang * @wq, and @wq is invalid to access. 5016b42b0bddSYang Yingliang */ 5017b42b0bddSYang Yingliang if (!list_empty(&pwq->pwqs_node)) { 50183c25a55dSLai Jiangshan mutex_lock(&wq->mutex); 50198864b4e5STejun Heo list_del_rcu(&pwq->pwqs_node); 5020bc0caf09STejun Heo is_last = list_empty(&wq->pwqs); 50214c065dbcSWaiman Long 50224c065dbcSWaiman Long /* 50234c065dbcSWaiman Long * For ordered workqueue with a plugged dfl_pwq, restart it now. 50244c065dbcSWaiman Long */ 50254c065dbcSWaiman Long if (!is_last && (wq->flags & __WQ_ORDERED)) 50264c065dbcSWaiman Long unplug_oldest_pwq(wq); 50274c065dbcSWaiman Long 50283c25a55dSLai Jiangshan mutex_unlock(&wq->mutex); 5029b42b0bddSYang Yingliang } 50308864b4e5STejun Heo 5031687a9aa5STejun Heo if (wq->flags & WQ_UNBOUND) { 5032a892caccSTejun Heo mutex_lock(&wq_pool_mutex); 50338864b4e5STejun Heo put_unbound_pool(pool); 5034a892caccSTejun Heo mutex_unlock(&wq_pool_mutex); 5035687a9aa5STejun Heo } 5036a892caccSTejun Heo 50375797b1c1STejun Heo if (!list_empty(&pwq->pending_node)) { 50385797b1c1STejun Heo struct wq_node_nr_active *nna = 50395797b1c1STejun Heo wq_node_nr_active(pwq->wq, pwq->pool->node); 50405797b1c1STejun Heo 50415797b1c1STejun Heo raw_spin_lock_irq(&nna->lock); 50425797b1c1STejun Heo list_del_init(&pwq->pending_node); 50435797b1c1STejun Heo raw_spin_unlock_irq(&nna->lock); 50445797b1c1STejun Heo } 50455797b1c1STejun Heo 504637c2277fSJulia Lawall kfree_rcu(pwq, rcu); 50478864b4e5STejun Heo 50488864b4e5STejun Heo /* 50498864b4e5STejun Heo * If we're the last pwq going away, @wq is already dead and no one 5050e2dca7adSTejun Heo * is gonna access it anymore. Schedule RCU free. 50518864b4e5STejun Heo */ 5052669de8bdSBart Van Assche if (is_last) { 5053669de8bdSBart Van Assche wq_unregister_lockdep(wq); 505425b00775SPaul E. McKenney call_rcu(&wq->rcu, rcu_free_wq); 50556029a918STejun Heo } 5056669de8bdSBart Van Assche } 50578864b4e5STejun Heo 505867dc8325SCai Huoqing /* initialize newly allocated @pwq which is associated with @wq and @pool */ 5059f147f29eSTejun Heo static void init_pwq(struct pool_workqueue *pwq, struct workqueue_struct *wq, 5060f147f29eSTejun Heo struct worker_pool *pool) 5061d2c1d404STejun Heo { 5062e9a8e01fSTejun Heo BUG_ON((unsigned long)pwq & ~WORK_STRUCT_PWQ_MASK); 5063d2c1d404STejun Heo 5064e50aba9aSTejun Heo memset(pwq, 0, sizeof(*pwq)); 5065e50aba9aSTejun Heo 5066d2c1d404STejun Heo pwq->pool = pool; 5067d2c1d404STejun Heo pwq->wq = wq; 5068d2c1d404STejun Heo pwq->flush_color = -1; 50698864b4e5STejun Heo pwq->refcnt = 1; 5070f97a4a1aSLai Jiangshan INIT_LIST_HEAD(&pwq->inactive_works); 50715797b1c1STejun Heo INIT_LIST_HEAD(&pwq->pending_node); 50721befcf30STejun Heo INIT_LIST_HEAD(&pwq->pwqs_node); 5073d2c1d404STejun Heo INIT_LIST_HEAD(&pwq->mayday_node); 5074687a9aa5STejun Heo kthread_init_work(&pwq->release_work, pwq_release_workfn); 5075f147f29eSTejun Heo } 5076d2c1d404STejun Heo 5077f147f29eSTejun Heo /* sync @pwq with the current state of its associated wq and link it */ 50781befcf30STejun Heo static void link_pwq(struct pool_workqueue *pwq) 5079f147f29eSTejun Heo { 5080f147f29eSTejun Heo struct workqueue_struct *wq = pwq->wq; 5081f147f29eSTejun Heo 5082f147f29eSTejun Heo lockdep_assert_held(&wq->mutex); 508375ccf595STejun Heo 50841befcf30STejun Heo /* may be called multiple times, ignore if already linked */ 50851befcf30STejun Heo if (!list_empty(&pwq->pwqs_node)) 50861befcf30STejun Heo return; 50871befcf30STejun Heo 508829b1cb41SLai Jiangshan /* set the matching work_color */ 508975ccf595STejun Heo pwq->work_color = wq->work_color; 5090983ca25eSTejun Heo 5091983ca25eSTejun Heo /* link in @pwq */ 509226fb7e3dSWaiman Long list_add_tail_rcu(&pwq->pwqs_node, &wq->pwqs); 5093df2d5ae4STejun Heo } 50946029a918STejun Heo 5095f147f29eSTejun Heo /* obtain a pool matching @attr and create a pwq associating the pool and @wq */ 5096f147f29eSTejun Heo static struct pool_workqueue *alloc_unbound_pwq(struct workqueue_struct *wq, 5097f147f29eSTejun Heo const struct workqueue_attrs *attrs) 5098f147f29eSTejun Heo { 5099f147f29eSTejun Heo struct worker_pool *pool; 5100f147f29eSTejun Heo struct pool_workqueue *pwq; 5101f147f29eSTejun Heo 5102f147f29eSTejun Heo lockdep_assert_held(&wq_pool_mutex); 5103f147f29eSTejun Heo 5104f147f29eSTejun Heo pool = get_unbound_pool(attrs); 5105f147f29eSTejun Heo if (!pool) 5106f147f29eSTejun Heo return NULL; 5107f147f29eSTejun Heo 5108e50aba9aSTejun Heo pwq = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, pool->node); 5109f147f29eSTejun Heo if (!pwq) { 5110f147f29eSTejun Heo put_unbound_pool(pool); 5111f147f29eSTejun Heo return NULL; 5112f147f29eSTejun Heo } 5113f147f29eSTejun Heo 5114f147f29eSTejun Heo init_pwq(pwq, wq, pool); 5115f147f29eSTejun Heo return pwq; 5116d2c1d404STejun Heo } 5117d2c1d404STejun Heo 51181726a171SLai Jiangshan static void apply_wqattrs_lock(void) 51191726a171SLai Jiangshan { 51201726a171SLai Jiangshan mutex_lock(&wq_pool_mutex); 51211726a171SLai Jiangshan } 51221726a171SLai Jiangshan 51231726a171SLai Jiangshan static void apply_wqattrs_unlock(void) 51241726a171SLai Jiangshan { 51251726a171SLai Jiangshan mutex_unlock(&wq_pool_mutex); 51261726a171SLai Jiangshan } 51271726a171SLai Jiangshan 51284c16bd32STejun Heo /** 5129fef59c9cSTejun Heo * wq_calc_pod_cpumask - calculate a wq_attrs' cpumask for a pod 5130042f7df1SLai Jiangshan * @attrs: the wq_attrs of the default pwq of the target workqueue 513184193c07STejun Heo * @cpu: the target CPU 51324c16bd32STejun Heo * 513388a41b18SLai Jiangshan * Calculate the cpumask a workqueue with @attrs should use on @pod. 51349546b29eSTejun Heo * The result is stored in @attrs->__pod_cpumask. 51354c16bd32STejun Heo * 5136fef59c9cSTejun Heo * If pod affinity is not enabled, @attrs->cpumask is always used. If enabled 5137fef59c9cSTejun Heo * and @pod has online CPUs requested by @attrs, the returned cpumask is the 5138fef59c9cSTejun Heo * intersection of the possible CPUs of @pod and @attrs->cpumask. 51394c16bd32STejun Heo * 5140fef59c9cSTejun Heo * The caller is responsible for ensuring that the cpumask of @pod stays stable. 51414c16bd32STejun Heo */ 514288a41b18SLai Jiangshan static void wq_calc_pod_cpumask(struct workqueue_attrs *attrs, int cpu) 51434c16bd32STejun Heo { 514484193c07STejun Heo const struct wq_pod_type *pt = wqattrs_pod_type(attrs); 514584193c07STejun Heo int pod = pt->cpu_pod[cpu]; 51464c16bd32STejun Heo 5147fbb3d4c1SLai Jiangshan /* calculate possible CPUs in @pod that @attrs wants */ 51489546b29eSTejun Heo cpumask_and(attrs->__pod_cpumask, pt->pod_cpus[pod], attrs->cpumask); 5149fbb3d4c1SLai Jiangshan /* does @pod have any online CPUs @attrs wants? */ 5150fbb3d4c1SLai Jiangshan if (!cpumask_intersects(attrs->__pod_cpumask, wq_online_cpumask)) { 51519546b29eSTejun Heo cpumask_copy(attrs->__pod_cpumask, attrs->cpumask); 515284193c07STejun Heo return; 515384193c07STejun Heo } 51544c16bd32STejun Heo } 51554c16bd32STejun Heo 51569f66cff2STejun Heo /* install @pwq into @wq and return the old pwq, @cpu < 0 for dfl_pwq */ 5157636b927eSTejun Heo static struct pool_workqueue *install_unbound_pwq(struct workqueue_struct *wq, 5158636b927eSTejun Heo int cpu, struct pool_workqueue *pwq) 51591befcf30STejun Heo { 51609f66cff2STejun Heo struct pool_workqueue __rcu **slot = unbound_pwq_slot(wq, cpu); 51611befcf30STejun Heo struct pool_workqueue *old_pwq; 51621befcf30STejun Heo 51635b95e1afSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 51641befcf30STejun Heo lockdep_assert_held(&wq->mutex); 51651befcf30STejun Heo 51661befcf30STejun Heo /* link_pwq() can handle duplicate calls */ 51671befcf30STejun Heo link_pwq(pwq); 51681befcf30STejun Heo 51699f66cff2STejun Heo old_pwq = rcu_access_pointer(*slot); 51709f66cff2STejun Heo rcu_assign_pointer(*slot, pwq); 51711befcf30STejun Heo return old_pwq; 51721befcf30STejun Heo } 51731befcf30STejun Heo 51742d5f0764SLai Jiangshan /* context to store the prepared attrs & pwqs before applying */ 51752d5f0764SLai Jiangshan struct apply_wqattrs_ctx { 51762d5f0764SLai Jiangshan struct workqueue_struct *wq; /* target workqueue */ 51772d5f0764SLai Jiangshan struct workqueue_attrs *attrs; /* attrs to apply */ 5178042f7df1SLai Jiangshan struct list_head list; /* queued for batching commit */ 51792d5f0764SLai Jiangshan struct pool_workqueue *dfl_pwq; 51802d5f0764SLai Jiangshan struct pool_workqueue *pwq_tbl[]; 51812d5f0764SLai Jiangshan }; 51822d5f0764SLai Jiangshan 51832d5f0764SLai Jiangshan /* free the resources after success or abort */ 51842d5f0764SLai Jiangshan static void apply_wqattrs_cleanup(struct apply_wqattrs_ctx *ctx) 51852d5f0764SLai Jiangshan { 51862d5f0764SLai Jiangshan if (ctx) { 5187636b927eSTejun Heo int cpu; 51882d5f0764SLai Jiangshan 5189636b927eSTejun Heo for_each_possible_cpu(cpu) 5190636b927eSTejun Heo put_pwq_unlocked(ctx->pwq_tbl[cpu]); 51912d5f0764SLai Jiangshan put_pwq_unlocked(ctx->dfl_pwq); 51922d5f0764SLai Jiangshan 51932d5f0764SLai Jiangshan free_workqueue_attrs(ctx->attrs); 51942d5f0764SLai Jiangshan 51952d5f0764SLai Jiangshan kfree(ctx); 51962d5f0764SLai Jiangshan } 51972d5f0764SLai Jiangshan } 51982d5f0764SLai Jiangshan 51992d5f0764SLai Jiangshan /* allocate the attrs and pwqs for later installation */ 52002d5f0764SLai Jiangshan static struct apply_wqattrs_ctx * 52012d5f0764SLai Jiangshan apply_wqattrs_prepare(struct workqueue_struct *wq, 520299c621efSLai Jiangshan const struct workqueue_attrs *attrs, 520399c621efSLai Jiangshan const cpumask_var_t unbound_cpumask) 52042d5f0764SLai Jiangshan { 52052d5f0764SLai Jiangshan struct apply_wqattrs_ctx *ctx; 52069546b29eSTejun Heo struct workqueue_attrs *new_attrs; 5207636b927eSTejun Heo int cpu; 52082d5f0764SLai Jiangshan 52092d5f0764SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 52102d5f0764SLai Jiangshan 521184193c07STejun Heo if (WARN_ON(attrs->affn_scope < 0 || 521284193c07STejun Heo attrs->affn_scope >= WQ_AFFN_NR_TYPES)) 521384193c07STejun Heo return ERR_PTR(-EINVAL); 521484193c07STejun Heo 5215636b927eSTejun Heo ctx = kzalloc(struct_size(ctx, pwq_tbl, nr_cpu_ids), GFP_KERNEL); 52162d5f0764SLai Jiangshan 5217be69d00dSThomas Gleixner new_attrs = alloc_workqueue_attrs(); 52189546b29eSTejun Heo if (!ctx || !new_attrs) 52192d5f0764SLai Jiangshan goto out_free; 52202d5f0764SLai Jiangshan 5221042f7df1SLai Jiangshan /* 52222d5f0764SLai Jiangshan * If something goes wrong during CPU up/down, we'll fall back to 52232d5f0764SLai Jiangshan * the default pwq covering whole @attrs->cpumask. Always create 52242d5f0764SLai Jiangshan * it even if we don't use it immediately. 52252d5f0764SLai Jiangshan */ 52260f36ee24STejun Heo copy_workqueue_attrs(new_attrs, attrs); 52270f36ee24STejun Heo wqattrs_actualize_cpumask(new_attrs, unbound_cpumask); 52289546b29eSTejun Heo cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask); 52292d5f0764SLai Jiangshan ctx->dfl_pwq = alloc_unbound_pwq(wq, new_attrs); 52302d5f0764SLai Jiangshan if (!ctx->dfl_pwq) 52312d5f0764SLai Jiangshan goto out_free; 52322d5f0764SLai Jiangshan 5233636b927eSTejun Heo for_each_possible_cpu(cpu) { 5234af73f5c9STejun Heo if (new_attrs->ordered) { 52352d5f0764SLai Jiangshan ctx->dfl_pwq->refcnt++; 5236636b927eSTejun Heo ctx->pwq_tbl[cpu] = ctx->dfl_pwq; 5237636b927eSTejun Heo } else { 523888a41b18SLai Jiangshan wq_calc_pod_cpumask(new_attrs, cpu); 52399546b29eSTejun Heo ctx->pwq_tbl[cpu] = alloc_unbound_pwq(wq, new_attrs); 5240636b927eSTejun Heo if (!ctx->pwq_tbl[cpu]) 5241636b927eSTejun Heo goto out_free; 52422d5f0764SLai Jiangshan } 52432d5f0764SLai Jiangshan } 52442d5f0764SLai Jiangshan 5245042f7df1SLai Jiangshan /* save the user configured attrs and sanitize it. */ 5246042f7df1SLai Jiangshan copy_workqueue_attrs(new_attrs, attrs); 5247042f7df1SLai Jiangshan cpumask_and(new_attrs->cpumask, new_attrs->cpumask, cpu_possible_mask); 52489546b29eSTejun Heo cpumask_copy(new_attrs->__pod_cpumask, new_attrs->cpumask); 52492d5f0764SLai Jiangshan ctx->attrs = new_attrs; 5250042f7df1SLai Jiangshan 52514c065dbcSWaiman Long /* 52524c065dbcSWaiman Long * For initialized ordered workqueues, there should only be one pwq 52534c065dbcSWaiman Long * (dfl_pwq). Set the plugged flag of ctx->dfl_pwq to suspend execution 52544c065dbcSWaiman Long * of newly queued work items until execution of older work items in 52554c065dbcSWaiman Long * the old pwq's have completed. 52564c065dbcSWaiman Long */ 52574c065dbcSWaiman Long if ((wq->flags & __WQ_ORDERED) && !list_empty(&wq->pwqs)) 52584c065dbcSWaiman Long ctx->dfl_pwq->plugged = true; 52594c065dbcSWaiman Long 52602d5f0764SLai Jiangshan ctx->wq = wq; 52612d5f0764SLai Jiangshan return ctx; 52622d5f0764SLai Jiangshan 52632d5f0764SLai Jiangshan out_free: 52642d5f0764SLai Jiangshan free_workqueue_attrs(new_attrs); 52652d5f0764SLai Jiangshan apply_wqattrs_cleanup(ctx); 526684193c07STejun Heo return ERR_PTR(-ENOMEM); 52672d5f0764SLai Jiangshan } 52682d5f0764SLai Jiangshan 52692d5f0764SLai Jiangshan /* set attrs and install prepared pwqs, @ctx points to old pwqs on return */ 52702d5f0764SLai Jiangshan static void apply_wqattrs_commit(struct apply_wqattrs_ctx *ctx) 52712d5f0764SLai Jiangshan { 5272636b927eSTejun Heo int cpu; 52732d5f0764SLai Jiangshan 52742d5f0764SLai Jiangshan /* all pwqs have been created successfully, let's install'em */ 52752d5f0764SLai Jiangshan mutex_lock(&ctx->wq->mutex); 52762d5f0764SLai Jiangshan 52772d5f0764SLai Jiangshan copy_workqueue_attrs(ctx->wq->unbound_attrs, ctx->attrs); 52782d5f0764SLai Jiangshan 52799f66cff2STejun Heo /* save the previous pwqs and install the new ones */ 5280636b927eSTejun Heo for_each_possible_cpu(cpu) 5281636b927eSTejun Heo ctx->pwq_tbl[cpu] = install_unbound_pwq(ctx->wq, cpu, 5282636b927eSTejun Heo ctx->pwq_tbl[cpu]); 52839f66cff2STejun Heo ctx->dfl_pwq = install_unbound_pwq(ctx->wq, -1, ctx->dfl_pwq); 52842d5f0764SLai Jiangshan 52855797b1c1STejun Heo /* update node_nr_active->max */ 52865797b1c1STejun Heo wq_update_node_max_active(ctx->wq, -1); 52875797b1c1STejun Heo 5288d64f2fa0SJuri Lelli /* rescuer needs to respect wq cpumask changes */ 5289d64f2fa0SJuri Lelli if (ctx->wq->rescuer) 5290d64f2fa0SJuri Lelli set_cpus_allowed_ptr(ctx->wq->rescuer->task, 5291d64f2fa0SJuri Lelli unbound_effective_cpumask(ctx->wq)); 5292d64f2fa0SJuri Lelli 52932d5f0764SLai Jiangshan mutex_unlock(&ctx->wq->mutex); 52942d5f0764SLai Jiangshan } 52952d5f0764SLai Jiangshan 5296a0111cf6SLai Jiangshan static int apply_workqueue_attrs_locked(struct workqueue_struct *wq, 5297a0111cf6SLai Jiangshan const struct workqueue_attrs *attrs) 5298a0111cf6SLai Jiangshan { 5299a0111cf6SLai Jiangshan struct apply_wqattrs_ctx *ctx; 5300a0111cf6SLai Jiangshan 5301a0111cf6SLai Jiangshan /* only unbound workqueues can change attributes */ 5302a0111cf6SLai Jiangshan if (WARN_ON(!(wq->flags & WQ_UNBOUND))) 5303a0111cf6SLai Jiangshan return -EINVAL; 5304a0111cf6SLai Jiangshan 530599c621efSLai Jiangshan ctx = apply_wqattrs_prepare(wq, attrs, wq_unbound_cpumask); 530684193c07STejun Heo if (IS_ERR(ctx)) 530784193c07STejun Heo return PTR_ERR(ctx); 5308a0111cf6SLai Jiangshan 5309a0111cf6SLai Jiangshan /* the ctx has been prepared successfully, let's commit it */ 5310a0111cf6SLai Jiangshan apply_wqattrs_commit(ctx); 5311a0111cf6SLai Jiangshan apply_wqattrs_cleanup(ctx); 5312a0111cf6SLai Jiangshan 53136201171eSwanghaibin return 0; 5314a0111cf6SLai Jiangshan } 5315a0111cf6SLai Jiangshan 53169e8cd2f5STejun Heo /** 53179e8cd2f5STejun Heo * apply_workqueue_attrs - apply new workqueue_attrs to an unbound workqueue 53189e8cd2f5STejun Heo * @wq: the target workqueue 53199e8cd2f5STejun Heo * @attrs: the workqueue_attrs to apply, allocated with alloc_workqueue_attrs() 53209e8cd2f5STejun Heo * 5321fef59c9cSTejun Heo * Apply @attrs to an unbound workqueue @wq. Unless disabled, this function maps 5322fef59c9cSTejun Heo * a separate pwq to each CPU pod with possibles CPUs in @attrs->cpumask so that 5323fef59c9cSTejun Heo * work items are affine to the pod it was issued on. Older pwqs are released as 5324fef59c9cSTejun Heo * in-flight work items finish. Note that a work item which repeatedly requeues 5325fef59c9cSTejun Heo * itself back-to-back will stay on its current pwq. 53269e8cd2f5STejun Heo * 5327d185af30SYacine Belkadi * Performs GFP_KERNEL allocations. 5328d185af30SYacine Belkadi * 5329ffd8bea8SSebastian Andrzej Siewior * Assumes caller has CPU hotplug read exclusion, i.e. cpus_read_lock(). 5330509b3204SDaniel Jordan * 5331d185af30SYacine Belkadi * Return: 0 on success and -errno on failure. 53329e8cd2f5STejun Heo */ 5333513c98d0SDaniel Jordan int apply_workqueue_attrs(struct workqueue_struct *wq, 53349e8cd2f5STejun Heo const struct workqueue_attrs *attrs) 53359e8cd2f5STejun Heo { 5336a0111cf6SLai Jiangshan int ret; 53379e8cd2f5STejun Heo 5338509b3204SDaniel Jordan lockdep_assert_cpus_held(); 5339509b3204SDaniel Jordan 5340509b3204SDaniel Jordan mutex_lock(&wq_pool_mutex); 5341a0111cf6SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 5342509b3204SDaniel Jordan mutex_unlock(&wq_pool_mutex); 53432d5f0764SLai Jiangshan 53442d5f0764SLai Jiangshan return ret; 53459e8cd2f5STejun Heo } 53469e8cd2f5STejun Heo 53474c16bd32STejun Heo /** 5348b2b1f933SLai Jiangshan * unbound_wq_update_pwq - update a pwq slot for CPU hot[un]plug 53494c16bd32STejun Heo * @wq: the target workqueue 5350b2b1f933SLai Jiangshan * @cpu: the CPU to update the pwq slot for 53514c16bd32STejun Heo * 53524c16bd32STejun Heo * This function is to be called from %CPU_DOWN_PREPARE, %CPU_ONLINE and 5353b2b1f933SLai Jiangshan * %CPU_DOWN_FAILED. @cpu is in the same pod of the CPU being hot[un]plugged. 53544c16bd32STejun Heo * 53554c16bd32STejun Heo * 5356fef59c9cSTejun Heo * If pod affinity can't be adjusted due to memory allocation failure, it falls 5357fef59c9cSTejun Heo * back to @wq->dfl_pwq which may not be optimal but is always correct. 5358fef59c9cSTejun Heo * 5359fef59c9cSTejun Heo * Note that when the last allowed CPU of a pod goes offline for a workqueue 5360fef59c9cSTejun Heo * with a cpumask spanning multiple pods, the workers which were already 5361fef59c9cSTejun Heo * executing the work items for the workqueue will lose their CPU affinity and 5362fef59c9cSTejun Heo * may execute on any CPU. This is similar to how per-cpu workqueues behave on 5363fef59c9cSTejun Heo * CPU_DOWN. If a workqueue user wants strict affinity, it's the user's 5364fef59c9cSTejun Heo * responsibility to flush the work item from CPU_DOWN_PREPARE. 53654c16bd32STejun Heo */ 5366b2b1f933SLai Jiangshan static void unbound_wq_update_pwq(struct workqueue_struct *wq, int cpu) 53674c16bd32STejun Heo { 53684c16bd32STejun Heo struct pool_workqueue *old_pwq = NULL, *pwq; 53694c16bd32STejun Heo struct workqueue_attrs *target_attrs; 53704c16bd32STejun Heo 53714c16bd32STejun Heo lockdep_assert_held(&wq_pool_mutex); 53724c16bd32STejun Heo 537384193c07STejun Heo if (!(wq->flags & WQ_UNBOUND) || wq->unbound_attrs->ordered) 53744c16bd32STejun Heo return; 53754c16bd32STejun Heo 53764c16bd32STejun Heo /* 53774c16bd32STejun Heo * We don't wanna alloc/free wq_attrs for each wq for each CPU. 53784c16bd32STejun Heo * Let's use a preallocated one. The following buf is protected by 53794c16bd32STejun Heo * CPU hotplug exclusion. 53804c16bd32STejun Heo */ 5381b2b1f933SLai Jiangshan target_attrs = unbound_wq_update_pwq_attrs_buf; 53824c16bd32STejun Heo 53834c16bd32STejun Heo copy_workqueue_attrs(target_attrs, wq->unbound_attrs); 53840f36ee24STejun Heo wqattrs_actualize_cpumask(target_attrs, wq_unbound_cpumask); 53854c16bd32STejun Heo 5386636b927eSTejun Heo /* nothing to do if the target cpumask matches the current pwq */ 538788a41b18SLai Jiangshan wq_calc_pod_cpumask(target_attrs, cpu); 53889f66cff2STejun Heo if (wqattrs_equal(target_attrs, unbound_pwq(wq, cpu)->pool->attrs)) 5389f7142ed4SLai Jiangshan return; 53904c16bd32STejun Heo 53914c16bd32STejun Heo /* create a new pwq */ 53924c16bd32STejun Heo pwq = alloc_unbound_pwq(wq, target_attrs); 53934c16bd32STejun Heo if (!pwq) { 5394fef59c9cSTejun Heo pr_warn("workqueue: allocation failed while updating CPU pod affinity of \"%s\"\n", 53954c16bd32STejun Heo wq->name); 539677f300b1SDaeseok Youn goto use_dfl_pwq; 53974c16bd32STejun Heo } 53984c16bd32STejun Heo 5399f7142ed4SLai Jiangshan /* Install the new pwq. */ 54004c16bd32STejun Heo mutex_lock(&wq->mutex); 5401636b927eSTejun Heo old_pwq = install_unbound_pwq(wq, cpu, pwq); 54024c16bd32STejun Heo goto out_unlock; 54034c16bd32STejun Heo 54044c16bd32STejun Heo use_dfl_pwq: 5405f7142ed4SLai Jiangshan mutex_lock(&wq->mutex); 54069f66cff2STejun Heo pwq = unbound_pwq(wq, -1); 54079f66cff2STejun Heo raw_spin_lock_irq(&pwq->pool->lock); 54089f66cff2STejun Heo get_pwq(pwq); 54099f66cff2STejun Heo raw_spin_unlock_irq(&pwq->pool->lock); 54109f66cff2STejun Heo old_pwq = install_unbound_pwq(wq, cpu, pwq); 54114c16bd32STejun Heo out_unlock: 54124c16bd32STejun Heo mutex_unlock(&wq->mutex); 54134c16bd32STejun Heo put_pwq_unlocked(old_pwq); 54144c16bd32STejun Heo } 54154c16bd32STejun Heo 541630cdf249STejun Heo static int alloc_and_link_pwqs(struct workqueue_struct *wq) 54171da177e4SLinus Torvalds { 541849e3cf44STejun Heo bool highpri = wq->flags & WQ_HIGHPRI; 54198a2b7538STejun Heo int cpu, ret; 5420e1d8aa9fSFrederic Weisbecker 54211726a171SLai Jiangshan lockdep_assert_cpus_held(); 54221726a171SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 54231726a171SLai Jiangshan 5424687a9aa5STejun Heo wq->cpu_pwq = alloc_percpu(struct pool_workqueue *); 5425ee1ceef7STejun Heo if (!wq->cpu_pwq) 5426687a9aa5STejun Heo goto enomem; 542730cdf249STejun Heo 5428636b927eSTejun Heo if (!(wq->flags & WQ_UNBOUND)) { 54294cb1ef64STejun Heo struct worker_pool __percpu *pools; 54304cb1ef64STejun Heo 54314cb1ef64STejun Heo if (wq->flags & WQ_BH) 54324cb1ef64STejun Heo pools = bh_worker_pools; 54334cb1ef64STejun Heo else 54344cb1ef64STejun Heo pools = cpu_worker_pools; 54354cb1ef64STejun Heo 54367ccc2151SWenchao Hao for_each_possible_cpu(cpu) { 54377ccc2151SWenchao Hao struct pool_workqueue **pwq_p; 54387ccc2151SWenchao Hao struct worker_pool *pool; 54397ccc2151SWenchao Hao 54404cb1ef64STejun Heo pool = &(per_cpu_ptr(pools, cpu)[highpri]); 54414cb1ef64STejun Heo pwq_p = per_cpu_ptr(wq->cpu_pwq, cpu); 544230cdf249STejun Heo 5443687a9aa5STejun Heo *pwq_p = kmem_cache_alloc_node(pwq_cache, GFP_KERNEL, 5444687a9aa5STejun Heo pool->node); 5445687a9aa5STejun Heo if (!*pwq_p) 5446687a9aa5STejun Heo goto enomem; 5447687a9aa5STejun Heo 5448687a9aa5STejun Heo init_pwq(*pwq_p, wq, pool); 5449f147f29eSTejun Heo 5450f147f29eSTejun Heo mutex_lock(&wq->mutex); 5451687a9aa5STejun Heo link_pwq(*pwq_p); 5452f147f29eSTejun Heo mutex_unlock(&wq->mutex); 545330cdf249STejun Heo } 545430cdf249STejun Heo return 0; 5455509b3204SDaniel Jordan } 5456509b3204SDaniel Jordan 5457509b3204SDaniel Jordan if (wq->flags & __WQ_ORDERED) { 54589f66cff2STejun Heo struct pool_workqueue *dfl_pwq; 54599f66cff2STejun Heo 54601726a171SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, ordered_wq_attrs[highpri]); 54618a2b7538STejun Heo /* there should only be single pwq for ordering guarantee */ 54629f66cff2STejun Heo dfl_pwq = rcu_access_pointer(wq->dfl_pwq); 54639f66cff2STejun Heo WARN(!ret && (wq->pwqs.next != &dfl_pwq->pwqs_node || 54649f66cff2STejun Heo wq->pwqs.prev != &dfl_pwq->pwqs_node), 54658a2b7538STejun Heo "ordering guarantee broken for workqueue %s\n", wq->name); 54669e8cd2f5STejun Heo } else { 54671726a171SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, unbound_std_wq_attrs[highpri]); 54689e8cd2f5STejun Heo } 5469509b3204SDaniel Jordan 5470509b3204SDaniel Jordan return ret; 5471687a9aa5STejun Heo 5472687a9aa5STejun Heo enomem: 5473687a9aa5STejun Heo if (wq->cpu_pwq) { 54747b42f401SZqiang for_each_possible_cpu(cpu) { 54757b42f401SZqiang struct pool_workqueue *pwq = *per_cpu_ptr(wq->cpu_pwq, cpu); 54767b42f401SZqiang 54777b42f401SZqiang if (pwq) 54787b42f401SZqiang kmem_cache_free(pwq_cache, pwq); 54797b42f401SZqiang } 5480687a9aa5STejun Heo free_percpu(wq->cpu_pwq); 5481687a9aa5STejun Heo wq->cpu_pwq = NULL; 5482687a9aa5STejun Heo } 5483687a9aa5STejun Heo return -ENOMEM; 54840f900049STejun Heo } 54850f900049STejun Heo 5486f3421797STejun Heo static int wq_clamp_max_active(int max_active, unsigned int flags, 5487f3421797STejun Heo const char *name) 5488b71ab8c2STejun Heo { 5489636b927eSTejun Heo if (max_active < 1 || max_active > WQ_MAX_ACTIVE) 5490044c782cSValentin Ilie pr_warn("workqueue: max_active %d requested for %s is out of range, clamping between %d and %d\n", 5491636b927eSTejun Heo max_active, name, 1, WQ_MAX_ACTIVE); 5492b71ab8c2STejun Heo 5493636b927eSTejun Heo return clamp_val(max_active, 1, WQ_MAX_ACTIVE); 5494b71ab8c2STejun Heo } 5495b71ab8c2STejun Heo 5496983c7515STejun Heo /* 5497983c7515STejun Heo * Workqueues which may be used during memory reclaim should have a rescuer 5498983c7515STejun Heo * to guarantee forward progress. 5499983c7515STejun Heo */ 5500983c7515STejun Heo static int init_rescuer(struct workqueue_struct *wq) 5501983c7515STejun Heo { 5502983c7515STejun Heo struct worker *rescuer; 5503b92b36eaSDan Carpenter int ret; 5504983c7515STejun Heo 5505449b31adSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 5506449b31adSLai Jiangshan 5507983c7515STejun Heo if (!(wq->flags & WQ_MEM_RECLAIM)) 5508983c7515STejun Heo return 0; 5509983c7515STejun Heo 5510983c7515STejun Heo rescuer = alloc_worker(NUMA_NO_NODE); 55114c0736a7SPetr Mladek if (!rescuer) { 55124c0736a7SPetr Mladek pr_err("workqueue: Failed to allocate a rescuer for wq \"%s\"\n", 55134c0736a7SPetr Mladek wq->name); 5514983c7515STejun Heo return -ENOMEM; 55154c0736a7SPetr Mladek } 5516983c7515STejun Heo 5517983c7515STejun Heo rescuer->rescue_wq = wq; 5518b6a46f72SAaron Tomlin rescuer->task = kthread_create(rescuer_thread, rescuer, "kworker/R-%s", wq->name); 5519f187b697SSean Fu if (IS_ERR(rescuer->task)) { 5520b92b36eaSDan Carpenter ret = PTR_ERR(rescuer->task); 55214c0736a7SPetr Mladek pr_err("workqueue: Failed to create a rescuer kthread for wq \"%s\": %pe", 55224c0736a7SPetr Mladek wq->name, ERR_PTR(ret)); 5523983c7515STejun Heo kfree(rescuer); 5524b92b36eaSDan Carpenter return ret; 5525983c7515STejun Heo } 5526983c7515STejun Heo 5527983c7515STejun Heo wq->rescuer = rescuer; 552885f0ab43SJuri Lelli if (wq->flags & WQ_UNBOUND) 5529449b31adSLai Jiangshan kthread_bind_mask(rescuer->task, unbound_effective_cpumask(wq)); 553085f0ab43SJuri Lelli else 5531983c7515STejun Heo kthread_bind_mask(rescuer->task, cpu_possible_mask); 5532983c7515STejun Heo wake_up_process(rescuer->task); 5533983c7515STejun Heo 5534983c7515STejun Heo return 0; 5535983c7515STejun Heo } 5536983c7515STejun Heo 5537a045a272STejun Heo /** 5538a045a272STejun Heo * wq_adjust_max_active - update a wq's max_active to the current setting 5539a045a272STejun Heo * @wq: target workqueue 5540a045a272STejun Heo * 5541a045a272STejun Heo * If @wq isn't freezing, set @wq->max_active to the saved_max_active and 5542a045a272STejun Heo * activate inactive work items accordingly. If @wq is freezing, clear 5543a045a272STejun Heo * @wq->max_active to zero. 5544a045a272STejun Heo */ 5545a045a272STejun Heo static void wq_adjust_max_active(struct workqueue_struct *wq) 5546a045a272STejun Heo { 5547c5404d4eSTejun Heo bool activated; 55485797b1c1STejun Heo int new_max, new_min; 5549a045a272STejun Heo 5550a045a272STejun Heo lockdep_assert_held(&wq->mutex); 5551a045a272STejun Heo 5552a045a272STejun Heo if ((wq->flags & WQ_FREEZABLE) && workqueue_freezing) { 55535797b1c1STejun Heo new_max = 0; 55545797b1c1STejun Heo new_min = 0; 55555797b1c1STejun Heo } else { 55565797b1c1STejun Heo new_max = wq->saved_max_active; 55575797b1c1STejun Heo new_min = wq->saved_min_active; 5558a045a272STejun Heo } 5559a045a272STejun Heo 55605797b1c1STejun Heo if (wq->max_active == new_max && wq->min_active == new_min) 5561a045a272STejun Heo return; 5562a045a272STejun Heo 5563a045a272STejun Heo /* 55645797b1c1STejun Heo * Update @wq->max/min_active and then kick inactive work items if more 5565a045a272STejun Heo * active work items are allowed. This doesn't break work item ordering 5566a045a272STejun Heo * because new work items are always queued behind existing inactive 5567a045a272STejun Heo * work items if there are any. 5568a045a272STejun Heo */ 55695797b1c1STejun Heo WRITE_ONCE(wq->max_active, new_max); 55705797b1c1STejun Heo WRITE_ONCE(wq->min_active, new_min); 55715797b1c1STejun Heo 55725797b1c1STejun Heo if (wq->flags & WQ_UNBOUND) 55735797b1c1STejun Heo wq_update_node_max_active(wq, -1); 55745797b1c1STejun Heo 55755797b1c1STejun Heo if (new_max == 0) 55765797b1c1STejun Heo return; 5577a045a272STejun Heo 5578c5404d4eSTejun Heo /* 5579c5404d4eSTejun Heo * Round-robin through pwq's activating the first inactive work item 5580c5404d4eSTejun Heo * until max_active is filled. 5581c5404d4eSTejun Heo */ 5582c5404d4eSTejun Heo do { 5583c5404d4eSTejun Heo struct pool_workqueue *pwq; 5584c5404d4eSTejun Heo 5585c5404d4eSTejun Heo activated = false; 5586a045a272STejun Heo for_each_pwq(pwq, wq) { 5587c26e2f2eSTejun Heo unsigned long irq_flags; 5588a045a272STejun Heo 5589c5404d4eSTejun Heo /* can be called during early boot w/ irq disabled */ 5590c26e2f2eSTejun Heo raw_spin_lock_irqsave(&pwq->pool->lock, irq_flags); 55915797b1c1STejun Heo if (pwq_activate_first_inactive(pwq, true)) { 5592c5404d4eSTejun Heo activated = true; 5593a045a272STejun Heo kick_pool(pwq->pool); 5594c5404d4eSTejun Heo } 5595c26e2f2eSTejun Heo raw_spin_unlock_irqrestore(&pwq->pool->lock, irq_flags); 5596a045a272STejun Heo } 5597c5404d4eSTejun Heo } while (activated); 5598a045a272STejun Heo } 5599a045a272STejun Heo 5600a2775bbcSMathieu Malaterre __printf(1, 4) 5601669de8bdSBart Van Assche struct workqueue_struct *alloc_workqueue(const char *fmt, 560297e37d7bSTejun Heo unsigned int flags, 5603669de8bdSBart Van Assche int max_active, ...) 56043af24433SOleg Nesterov { 5605ecf6881fSTejun Heo va_list args; 56063af24433SOleg Nesterov struct workqueue_struct *wq; 560791ccc6e7STejun Heo size_t wq_size; 560891ccc6e7STejun Heo int name_len; 5609b196be89STejun Heo 56104cb1ef64STejun Heo if (flags & WQ_BH) { 56114cb1ef64STejun Heo if (WARN_ON_ONCE(flags & ~__WQ_BH_ALLOWS)) 56124cb1ef64STejun Heo return NULL; 56134cb1ef64STejun Heo if (WARN_ON_ONCE(max_active)) 56144cb1ef64STejun Heo return NULL; 56154cb1ef64STejun Heo } 56164cb1ef64STejun Heo 5617cee22a15SViresh Kumar /* see the comment above the definition of WQ_POWER_EFFICIENT */ 5618cee22a15SViresh Kumar if ((flags & WQ_POWER_EFFICIENT) && wq_power_efficient) 5619cee22a15SViresh Kumar flags |= WQ_UNBOUND; 5620cee22a15SViresh Kumar 5621ecf6881fSTejun Heo /* allocate wq and format name */ 562291ccc6e7STejun Heo if (flags & WQ_UNBOUND) 562391ccc6e7STejun Heo wq_size = struct_size(wq, node_nr_active, nr_node_ids + 1); 562491ccc6e7STejun Heo else 562591ccc6e7STejun Heo wq_size = sizeof(*wq); 562691ccc6e7STejun Heo 562791ccc6e7STejun Heo wq = kzalloc(wq_size, GFP_KERNEL); 5628b196be89STejun Heo if (!wq) 5629d2c1d404STejun Heo return NULL; 5630b196be89STejun Heo 56316029a918STejun Heo if (flags & WQ_UNBOUND) { 5632be69d00dSThomas Gleixner wq->unbound_attrs = alloc_workqueue_attrs(); 56336029a918STejun Heo if (!wq->unbound_attrs) 56346029a918STejun Heo goto err_free_wq; 56356029a918STejun Heo } 56366029a918STejun Heo 5637669de8bdSBart Van Assche va_start(args, max_active); 563891ccc6e7STejun Heo name_len = vsnprintf(wq->name, sizeof(wq->name), fmt, args); 5639b196be89STejun Heo va_end(args); 56403af24433SOleg Nesterov 564191ccc6e7STejun Heo if (name_len >= WQ_NAME_LEN) 564291ccc6e7STejun Heo pr_warn_once("workqueue: name exceeds WQ_NAME_LEN. Truncating to: %s\n", 564391ccc6e7STejun Heo wq->name); 564431c89007SAudra Mitchell 56454cb1ef64STejun Heo if (flags & WQ_BH) { 56464cb1ef64STejun Heo /* 56474cb1ef64STejun Heo * BH workqueues always share a single execution context per CPU 56484cb1ef64STejun Heo * and don't impose any max_active limit. 56494cb1ef64STejun Heo */ 56504cb1ef64STejun Heo max_active = INT_MAX; 56514cb1ef64STejun Heo } else { 5652d320c038STejun Heo max_active = max_active ?: WQ_DFL_ACTIVE; 5653b196be89STejun Heo max_active = wq_clamp_max_active(max_active, flags, wq->name); 56544cb1ef64STejun Heo } 56553af24433SOleg Nesterov 5656b196be89STejun Heo /* init wq */ 565797e37d7bSTejun Heo wq->flags = flags; 5658a045a272STejun Heo wq->max_active = max_active; 56595797b1c1STejun Heo wq->min_active = min(max_active, WQ_DFL_MIN_ACTIVE); 56605797b1c1STejun Heo wq->saved_max_active = wq->max_active; 56615797b1c1STejun Heo wq->saved_min_active = wq->min_active; 56623c25a55dSLai Jiangshan mutex_init(&wq->mutex); 5663112202d9STejun Heo atomic_set(&wq->nr_pwqs_to_flush, 0); 566430cdf249STejun Heo INIT_LIST_HEAD(&wq->pwqs); 566573f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_queue); 566673f53c4aSTejun Heo INIT_LIST_HEAD(&wq->flusher_overflow); 5667493a1724STejun Heo INIT_LIST_HEAD(&wq->maydays); 56683af24433SOleg Nesterov 5669669de8bdSBart Van Assche wq_init_lockdep(wq); 5670cce1a165SOleg Nesterov INIT_LIST_HEAD(&wq->list); 56713af24433SOleg Nesterov 567291ccc6e7STejun Heo if (flags & WQ_UNBOUND) { 567391ccc6e7STejun Heo if (alloc_node_nr_active(wq->node_nr_active) < 0) 567482efcab3SBart Van Assche goto err_unreg_lockdep; 567591ccc6e7STejun Heo } 567691ccc6e7STejun Heo 56776af8bf3dSOleg Nesterov /* 56781726a171SLai Jiangshan * wq_pool_mutex protects the workqueues list, allocations of PWQs, 56791726a171SLai Jiangshan * and the global freeze state. alloc_and_link_pwqs() also requires 56801726a171SLai Jiangshan * cpus_read_lock() for PWQs' affinities. 56816af8bf3dSOleg Nesterov */ 56821726a171SLai Jiangshan apply_wqattrs_lock(); 56831726a171SLai Jiangshan 56841726a171SLai Jiangshan if (alloc_and_link_pwqs(wq) < 0) 56851726a171SLai Jiangshan goto err_unlock_free_node_nr_active; 5686a0a1a5fdSTejun Heo 5687a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 5688a045a272STejun Heo wq_adjust_max_active(wq); 5689a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 5690a0a1a5fdSTejun Heo 5691e2dca7adSTejun Heo list_add_tail_rcu(&wq->list, &workqueues); 5692a0a1a5fdSTejun Heo 5693c5178e6cSLai Jiangshan if (wq_online && init_rescuer(wq) < 0) 5694449b31adSLai Jiangshan goto err_unlock_destroy; 5695449b31adSLai Jiangshan 5696449b31adSLai Jiangshan apply_wqattrs_unlock(); 5697c5178e6cSLai Jiangshan 5698c3138f38SLai Jiangshan if ((wq->flags & WQ_SYSFS) && workqueue_sysfs_register(wq)) 5699c3138f38SLai Jiangshan goto err_destroy; 5700c3138f38SLai Jiangshan 57013af24433SOleg Nesterov return wq; 5702d2c1d404STejun Heo 57031726a171SLai Jiangshan err_unlock_free_node_nr_active: 57041726a171SLai Jiangshan apply_wqattrs_unlock(); 57054e9a3738SLai Jiangshan /* 57064e9a3738SLai Jiangshan * Failed alloc_and_link_pwqs() may leave pending pwq->release_work, 57074e9a3738SLai Jiangshan * flushing the pwq_release_worker ensures that the pwq_release_workfn() 57084e9a3738SLai Jiangshan * completes before calling kfree(wq). 57094e9a3738SLai Jiangshan */ 57104e9a3738SLai Jiangshan if (wq->flags & WQ_UNBOUND) { 57114e9a3738SLai Jiangshan kthread_flush_worker(pwq_release_worker); 571291ccc6e7STejun Heo free_node_nr_active(wq->node_nr_active); 57134e9a3738SLai Jiangshan } 571482efcab3SBart Van Assche err_unreg_lockdep: 5715009bb421SBart Van Assche wq_unregister_lockdep(wq); 5716009bb421SBart Van Assche wq_free_lockdep(wq); 571782efcab3SBart Van Assche err_free_wq: 57186029a918STejun Heo free_workqueue_attrs(wq->unbound_attrs); 57194690c4abSTejun Heo kfree(wq); 5720d2c1d404STejun Heo return NULL; 5721449b31adSLai Jiangshan err_unlock_destroy: 5722449b31adSLai Jiangshan apply_wqattrs_unlock(); 5723d2c1d404STejun Heo err_destroy: 5724d2c1d404STejun Heo destroy_workqueue(wq); 57254690c4abSTejun Heo return NULL; 57261da177e4SLinus Torvalds } 5727669de8bdSBart Van Assche EXPORT_SYMBOL_GPL(alloc_workqueue); 57281da177e4SLinus Torvalds 5729c29eb853STejun Heo static bool pwq_busy(struct pool_workqueue *pwq) 5730c29eb853STejun Heo { 5731c29eb853STejun Heo int i; 5732c29eb853STejun Heo 5733c29eb853STejun Heo for (i = 0; i < WORK_NR_COLORS; i++) 5734c29eb853STejun Heo if (pwq->nr_in_flight[i]) 5735c29eb853STejun Heo return true; 5736c29eb853STejun Heo 57379f66cff2STejun Heo if ((pwq != rcu_access_pointer(pwq->wq->dfl_pwq)) && (pwq->refcnt > 1)) 5738c29eb853STejun Heo return true; 5739afa87ce8STejun Heo if (!pwq_is_empty(pwq)) 5740c29eb853STejun Heo return true; 5741c29eb853STejun Heo 5742c29eb853STejun Heo return false; 5743c29eb853STejun Heo } 5744c29eb853STejun Heo 57453af24433SOleg Nesterov /** 57463af24433SOleg Nesterov * destroy_workqueue - safely terminate a workqueue 57473af24433SOleg Nesterov * @wq: target workqueue 57483af24433SOleg Nesterov * 57493af24433SOleg Nesterov * Safely destroy a workqueue. All work currently pending will be done first. 57503af24433SOleg Nesterov */ 57513af24433SOleg Nesterov void destroy_workqueue(struct workqueue_struct *wq) 57523af24433SOleg Nesterov { 575349e3cf44STejun Heo struct pool_workqueue *pwq; 5754636b927eSTejun Heo int cpu; 57553af24433SOleg Nesterov 5756def98c84STejun Heo /* 5757def98c84STejun Heo * Remove it from sysfs first so that sanity check failure doesn't 5758def98c84STejun Heo * lead to sysfs name conflicts. 5759def98c84STejun Heo */ 5760def98c84STejun Heo workqueue_sysfs_unregister(wq); 5761def98c84STejun Heo 576233e3f0a3SRichard Clark /* mark the workqueue destruction is in progress */ 576333e3f0a3SRichard Clark mutex_lock(&wq->mutex); 576433e3f0a3SRichard Clark wq->flags |= __WQ_DESTROYING; 576533e3f0a3SRichard Clark mutex_unlock(&wq->mutex); 576633e3f0a3SRichard Clark 57679c5a2ba7STejun Heo /* drain it before proceeding with destruction */ 57689c5a2ba7STejun Heo drain_workqueue(wq); 5769c8efcc25STejun Heo 5770def98c84STejun Heo /* kill rescuer, if sanity checks fail, leave it w/o rescuer */ 5771def98c84STejun Heo if (wq->rescuer) { 5772def98c84STejun Heo struct worker *rescuer = wq->rescuer; 5773def98c84STejun Heo 5774def98c84STejun Heo /* this prevents new queueing */ 5775a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&wq_mayday_lock); 5776def98c84STejun Heo wq->rescuer = NULL; 5777a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&wq_mayday_lock); 5778def98c84STejun Heo 5779def98c84STejun Heo /* rescuer will empty maydays list before exiting */ 5780def98c84STejun Heo kthread_stop(rescuer->task); 57818efe1223STejun Heo kfree(rescuer); 5782def98c84STejun Heo } 5783def98c84STejun Heo 5784c29eb853STejun Heo /* 5785c29eb853STejun Heo * Sanity checks - grab all the locks so that we wait for all 5786c29eb853STejun Heo * in-flight operations which may do put_pwq(). 5787c29eb853STejun Heo */ 5788c29eb853STejun Heo mutex_lock(&wq_pool_mutex); 5789b09f4fd3SLai Jiangshan mutex_lock(&wq->mutex); 579049e3cf44STejun Heo for_each_pwq(pwq, wq) { 5791a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pwq->pool->lock); 5792c29eb853STejun Heo if (WARN_ON(pwq_busy(pwq))) { 57931d9a6159SKefeng Wang pr_warn("%s: %s has the following busy pwq\n", 5794e66b39afSTejun Heo __func__, wq->name); 5795c29eb853STejun Heo show_pwq(pwq); 5796a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 5797b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 5798c29eb853STejun Heo mutex_unlock(&wq_pool_mutex); 579955df0933SImran Khan show_one_workqueue(wq); 58006183c009STejun Heo return; 580176af4d93STejun Heo } 5802a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pwq->pool->lock); 580376af4d93STejun Heo } 5804b09f4fd3SLai Jiangshan mutex_unlock(&wq->mutex); 58056183c009STejun Heo 5806a0a1a5fdSTejun Heo /* 5807a0a1a5fdSTejun Heo * wq list is used to freeze wq, remove from list after 5808a0a1a5fdSTejun Heo * flushing is complete in case freeze races us. 5809a0a1a5fdSTejun Heo */ 5810e2dca7adSTejun Heo list_del_rcu(&wq->list); 581168e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 58123af24433SOleg Nesterov 58138864b4e5STejun Heo /* 5814636b927eSTejun Heo * We're the sole accessor of @wq. Directly access cpu_pwq and dfl_pwq 5815636b927eSTejun Heo * to put the base refs. @wq will be auto-destroyed from the last 5816636b927eSTejun Heo * pwq_put. RCU read lock prevents @wq from going away from under us. 58178864b4e5STejun Heo */ 5818636b927eSTejun Heo rcu_read_lock(); 5819636b927eSTejun Heo 5820636b927eSTejun Heo for_each_possible_cpu(cpu) { 58219f66cff2STejun Heo put_pwq_unlocked(unbound_pwq(wq, cpu)); 58229f66cff2STejun Heo RCU_INIT_POINTER(*unbound_pwq_slot(wq, cpu), NULL); 58234c16bd32STejun Heo } 58244c16bd32STejun Heo 58259f66cff2STejun Heo put_pwq_unlocked(unbound_pwq(wq, -1)); 58269f66cff2STejun Heo RCU_INIT_POINTER(*unbound_pwq_slot(wq, -1), NULL); 5827636b927eSTejun Heo 5828636b927eSTejun Heo rcu_read_unlock(); 58293af24433SOleg Nesterov } 58303af24433SOleg Nesterov EXPORT_SYMBOL_GPL(destroy_workqueue); 58313af24433SOleg Nesterov 5832dcd989cbSTejun Heo /** 5833dcd989cbSTejun Heo * workqueue_set_max_active - adjust max_active of a workqueue 5834dcd989cbSTejun Heo * @wq: target workqueue 5835dcd989cbSTejun Heo * @max_active: new max_active value. 5836dcd989cbSTejun Heo * 58375797b1c1STejun Heo * Set max_active of @wq to @max_active. See the alloc_workqueue() function 58385797b1c1STejun Heo * comment. 5839dcd989cbSTejun Heo * 5840dcd989cbSTejun Heo * CONTEXT: 5841dcd989cbSTejun Heo * Don't call from IRQ context. 5842dcd989cbSTejun Heo */ 5843dcd989cbSTejun Heo void workqueue_set_max_active(struct workqueue_struct *wq, int max_active) 5844dcd989cbSTejun Heo { 58454cb1ef64STejun Heo /* max_active doesn't mean anything for BH workqueues */ 58464cb1ef64STejun Heo if (WARN_ON(wq->flags & WQ_BH)) 58474cb1ef64STejun Heo return; 58488719dceaSTejun Heo /* disallow meddling with max_active for ordered workqueues */ 58493bc1e711STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED)) 58508719dceaSTejun Heo return; 58518719dceaSTejun Heo 5852f3421797STejun Heo max_active = wq_clamp_max_active(max_active, wq->flags, wq->name); 5853dcd989cbSTejun Heo 5854a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 5855dcd989cbSTejun Heo 5856dcd989cbSTejun Heo wq->saved_max_active = max_active; 58575797b1c1STejun Heo if (wq->flags & WQ_UNBOUND) 58585797b1c1STejun Heo wq->saved_min_active = min(wq->saved_min_active, max_active); 58595797b1c1STejun Heo 5860a045a272STejun Heo wq_adjust_max_active(wq); 5861dcd989cbSTejun Heo 5862a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 5863dcd989cbSTejun Heo } 5864dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_set_max_active); 5865dcd989cbSTejun Heo 5866dcd989cbSTejun Heo /** 58678f172181STejun Heo * workqueue_set_min_active - adjust min_active of an unbound workqueue 58688f172181STejun Heo * @wq: target unbound workqueue 58698f172181STejun Heo * @min_active: new min_active value 58708f172181STejun Heo * 58718f172181STejun Heo * Set min_active of an unbound workqueue. Unlike other types of workqueues, an 58728f172181STejun Heo * unbound workqueue is not guaranteed to be able to process max_active 58738f172181STejun Heo * interdependent work items. Instead, an unbound workqueue is guaranteed to be 58748f172181STejun Heo * able to process min_active number of interdependent work items which is 58758f172181STejun Heo * %WQ_DFL_MIN_ACTIVE by default. 58768f172181STejun Heo * 58778f172181STejun Heo * Use this function to adjust the min_active value between 0 and the current 58788f172181STejun Heo * max_active. 58798f172181STejun Heo */ 58808f172181STejun Heo void workqueue_set_min_active(struct workqueue_struct *wq, int min_active) 58818f172181STejun Heo { 58828f172181STejun Heo /* min_active is only meaningful for non-ordered unbound workqueues */ 58838f172181STejun Heo if (WARN_ON((wq->flags & (WQ_BH | WQ_UNBOUND | __WQ_ORDERED)) != 58848f172181STejun Heo WQ_UNBOUND)) 58858f172181STejun Heo return; 58868f172181STejun Heo 58878f172181STejun Heo mutex_lock(&wq->mutex); 58888f172181STejun Heo wq->saved_min_active = clamp(min_active, 0, wq->saved_max_active); 58898f172181STejun Heo wq_adjust_max_active(wq); 58908f172181STejun Heo mutex_unlock(&wq->mutex); 58918f172181STejun Heo } 58928f172181STejun Heo 58938f172181STejun Heo /** 589427d4ee03SLukas Wunner * current_work - retrieve %current task's work struct 589527d4ee03SLukas Wunner * 589627d4ee03SLukas Wunner * Determine if %current task is a workqueue worker and what it's working on. 589727d4ee03SLukas Wunner * Useful to find out the context that the %current task is running in. 589827d4ee03SLukas Wunner * 589927d4ee03SLukas Wunner * Return: work struct if %current task is a workqueue worker, %NULL otherwise. 590027d4ee03SLukas Wunner */ 590127d4ee03SLukas Wunner struct work_struct *current_work(void) 590227d4ee03SLukas Wunner { 590327d4ee03SLukas Wunner struct worker *worker = current_wq_worker(); 590427d4ee03SLukas Wunner 590527d4ee03SLukas Wunner return worker ? worker->current_work : NULL; 590627d4ee03SLukas Wunner } 590727d4ee03SLukas Wunner EXPORT_SYMBOL(current_work); 590827d4ee03SLukas Wunner 590927d4ee03SLukas Wunner /** 5910e6267616STejun Heo * current_is_workqueue_rescuer - is %current workqueue rescuer? 5911e6267616STejun Heo * 5912e6267616STejun Heo * Determine whether %current is a workqueue rescuer. Can be used from 5913e6267616STejun Heo * work functions to determine whether it's being run off the rescuer task. 5914d185af30SYacine Belkadi * 5915d185af30SYacine Belkadi * Return: %true if %current is a workqueue rescuer. %false otherwise. 5916e6267616STejun Heo */ 5917e6267616STejun Heo bool current_is_workqueue_rescuer(void) 5918e6267616STejun Heo { 5919e6267616STejun Heo struct worker *worker = current_wq_worker(); 5920e6267616STejun Heo 59216a092dfdSLai Jiangshan return worker && worker->rescue_wq; 5922e6267616STejun Heo } 5923e6267616STejun Heo 5924e6267616STejun Heo /** 5925dcd989cbSTejun Heo * workqueue_congested - test whether a workqueue is congested 5926dcd989cbSTejun Heo * @cpu: CPU in question 5927dcd989cbSTejun Heo * @wq: target workqueue 5928dcd989cbSTejun Heo * 5929dcd989cbSTejun Heo * Test whether @wq's cpu workqueue for @cpu is congested. There is 5930dcd989cbSTejun Heo * no synchronization around this function and the test result is 5931dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 5932dcd989cbSTejun Heo * 5933d3251859STejun Heo * If @cpu is WORK_CPU_UNBOUND, the test is performed on the local CPU. 5934636b927eSTejun Heo * 5935636b927eSTejun Heo * With the exception of ordered workqueues, all workqueues have per-cpu 5936636b927eSTejun Heo * pool_workqueues, each with its own congested state. A workqueue being 5937636b927eSTejun Heo * congested on one CPU doesn't mean that the workqueue is contested on any 5938636b927eSTejun Heo * other CPUs. 5939d3251859STejun Heo * 5940d185af30SYacine Belkadi * Return: 5941dcd989cbSTejun Heo * %true if congested, %false otherwise. 5942dcd989cbSTejun Heo */ 5943d84ff051STejun Heo bool workqueue_congested(int cpu, struct workqueue_struct *wq) 5944dcd989cbSTejun Heo { 59457fb98ea7STejun Heo struct pool_workqueue *pwq; 594676af4d93STejun Heo bool ret; 594776af4d93STejun Heo 594824acfb71SThomas Gleixner rcu_read_lock(); 594924acfb71SThomas Gleixner preempt_disable(); 59507fb98ea7STejun Heo 5951d3251859STejun Heo if (cpu == WORK_CPU_UNBOUND) 5952d3251859STejun Heo cpu = smp_processor_id(); 5953d3251859STejun Heo 5954687a9aa5STejun Heo pwq = *per_cpu_ptr(wq->cpu_pwq, cpu); 5955f97a4a1aSLai Jiangshan ret = !list_empty(&pwq->inactive_works); 5956636b927eSTejun Heo 595724acfb71SThomas Gleixner preempt_enable(); 595824acfb71SThomas Gleixner rcu_read_unlock(); 595976af4d93STejun Heo 596076af4d93STejun Heo return ret; 5961dcd989cbSTejun Heo } 5962dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(workqueue_congested); 5963dcd989cbSTejun Heo 5964dcd989cbSTejun Heo /** 5965dcd989cbSTejun Heo * work_busy - test whether a work is currently pending or running 5966dcd989cbSTejun Heo * @work: the work to be tested 5967dcd989cbSTejun Heo * 5968dcd989cbSTejun Heo * Test whether @work is currently pending or running. There is no 5969dcd989cbSTejun Heo * synchronization around this function and the test result is 5970dcd989cbSTejun Heo * unreliable and only useful as advisory hints or for debugging. 5971dcd989cbSTejun Heo * 5972d185af30SYacine Belkadi * Return: 5973dcd989cbSTejun Heo * OR'd bitmask of WORK_BUSY_* bits. 5974dcd989cbSTejun Heo */ 5975dcd989cbSTejun Heo unsigned int work_busy(struct work_struct *work) 5976dcd989cbSTejun Heo { 5977fa1b54e6STejun Heo struct worker_pool *pool; 5978c26e2f2eSTejun Heo unsigned long irq_flags; 5979dcd989cbSTejun Heo unsigned int ret = 0; 5980dcd989cbSTejun Heo 5981dcd989cbSTejun Heo if (work_pending(work)) 5982dcd989cbSTejun Heo ret |= WORK_BUSY_PENDING; 5983038366c5SLai Jiangshan 598424acfb71SThomas Gleixner rcu_read_lock(); 5985fa1b54e6STejun Heo pool = get_work_pool(work); 5986038366c5SLai Jiangshan if (pool) { 5987c26e2f2eSTejun Heo raw_spin_lock_irqsave(&pool->lock, irq_flags); 5988c9e7cf27STejun Heo if (find_worker_executing_work(pool, work)) 5989dcd989cbSTejun Heo ret |= WORK_BUSY_RUNNING; 5990c26e2f2eSTejun Heo raw_spin_unlock_irqrestore(&pool->lock, irq_flags); 5991038366c5SLai Jiangshan } 599224acfb71SThomas Gleixner rcu_read_unlock(); 5993dcd989cbSTejun Heo 5994dcd989cbSTejun Heo return ret; 5995dcd989cbSTejun Heo } 5996dcd989cbSTejun Heo EXPORT_SYMBOL_GPL(work_busy); 5997dcd989cbSTejun Heo 59983d1cb205STejun Heo /** 59993d1cb205STejun Heo * set_worker_desc - set description for the current work item 60003d1cb205STejun Heo * @fmt: printf-style format string 60013d1cb205STejun Heo * @...: arguments for the format string 60023d1cb205STejun Heo * 60033d1cb205STejun Heo * This function can be called by a running work function to describe what 60043d1cb205STejun Heo * the work item is about. If the worker task gets dumped, this 60053d1cb205STejun Heo * information will be printed out together to help debugging. The 60063d1cb205STejun Heo * description can be at most WORKER_DESC_LEN including the trailing '\0'. 60073d1cb205STejun Heo */ 60083d1cb205STejun Heo void set_worker_desc(const char *fmt, ...) 60093d1cb205STejun Heo { 60103d1cb205STejun Heo struct worker *worker = current_wq_worker(); 60113d1cb205STejun Heo va_list args; 60123d1cb205STejun Heo 60133d1cb205STejun Heo if (worker) { 60143d1cb205STejun Heo va_start(args, fmt); 60153d1cb205STejun Heo vsnprintf(worker->desc, sizeof(worker->desc), fmt, args); 60163d1cb205STejun Heo va_end(args); 60173d1cb205STejun Heo } 60183d1cb205STejun Heo } 60195c750d58SSteffen Maier EXPORT_SYMBOL_GPL(set_worker_desc); 60203d1cb205STejun Heo 60213d1cb205STejun Heo /** 60223d1cb205STejun Heo * print_worker_info - print out worker information and description 60233d1cb205STejun Heo * @log_lvl: the log level to use when printing 60243d1cb205STejun Heo * @task: target task 60253d1cb205STejun Heo * 60263d1cb205STejun Heo * If @task is a worker and currently executing a work item, print out the 60273d1cb205STejun Heo * name of the workqueue being serviced and worker description set with 60283d1cb205STejun Heo * set_worker_desc() by the currently executing work item. 60293d1cb205STejun Heo * 60303d1cb205STejun Heo * This function can be safely called on any task as long as the 60313d1cb205STejun Heo * task_struct itself is accessible. While safe, this function isn't 60323d1cb205STejun Heo * synchronized and may print out mixups or garbages of limited length. 60333d1cb205STejun Heo */ 60343d1cb205STejun Heo void print_worker_info(const char *log_lvl, struct task_struct *task) 60353d1cb205STejun Heo { 60363d1cb205STejun Heo work_func_t *fn = NULL; 60373d1cb205STejun Heo char name[WQ_NAME_LEN] = { }; 60383d1cb205STejun Heo char desc[WORKER_DESC_LEN] = { }; 60393d1cb205STejun Heo struct pool_workqueue *pwq = NULL; 60403d1cb205STejun Heo struct workqueue_struct *wq = NULL; 60413d1cb205STejun Heo struct worker *worker; 60423d1cb205STejun Heo 60433d1cb205STejun Heo if (!(task->flags & PF_WQ_WORKER)) 60443d1cb205STejun Heo return; 60453d1cb205STejun Heo 60463d1cb205STejun Heo /* 60473d1cb205STejun Heo * This function is called without any synchronization and @task 60483d1cb205STejun Heo * could be in any state. Be careful with dereferences. 60493d1cb205STejun Heo */ 6050e700591aSPetr Mladek worker = kthread_probe_data(task); 60513d1cb205STejun Heo 60523d1cb205STejun Heo /* 60538bf89593STejun Heo * Carefully copy the associated workqueue's workfn, name and desc. 60548bf89593STejun Heo * Keep the original last '\0' in case the original is garbage. 60553d1cb205STejun Heo */ 6056fe557319SChristoph Hellwig copy_from_kernel_nofault(&fn, &worker->current_func, sizeof(fn)); 6057fe557319SChristoph Hellwig copy_from_kernel_nofault(&pwq, &worker->current_pwq, sizeof(pwq)); 6058fe557319SChristoph Hellwig copy_from_kernel_nofault(&wq, &pwq->wq, sizeof(wq)); 6059fe557319SChristoph Hellwig copy_from_kernel_nofault(name, wq->name, sizeof(name) - 1); 6060fe557319SChristoph Hellwig copy_from_kernel_nofault(desc, worker->desc, sizeof(desc) - 1); 60613d1cb205STejun Heo 60623d1cb205STejun Heo if (fn || name[0] || desc[0]) { 6063d75f773cSSakari Ailus printk("%sWorkqueue: %s %ps", log_lvl, name, fn); 60648bf89593STejun Heo if (strcmp(name, desc)) 60653d1cb205STejun Heo pr_cont(" (%s)", desc); 60663d1cb205STejun Heo pr_cont("\n"); 60673d1cb205STejun Heo } 60683d1cb205STejun Heo } 60693d1cb205STejun Heo 60703494fc30STejun Heo static void pr_cont_pool_info(struct worker_pool *pool) 60713494fc30STejun Heo { 60723494fc30STejun Heo pr_cont(" cpus=%*pbl", nr_cpumask_bits, pool->attrs->cpumask); 60733494fc30STejun Heo if (pool->node != NUMA_NO_NODE) 60743494fc30STejun Heo pr_cont(" node=%d", pool->node); 60754cb1ef64STejun Heo pr_cont(" flags=0x%x", pool->flags); 60764cb1ef64STejun Heo if (pool->flags & POOL_BH) 60774cb1ef64STejun Heo pr_cont(" bh%s", 60784cb1ef64STejun Heo pool->attrs->nice == HIGHPRI_NICE_LEVEL ? "-hi" : ""); 60794cb1ef64STejun Heo else 60804cb1ef64STejun Heo pr_cont(" nice=%d", pool->attrs->nice); 60814cb1ef64STejun Heo } 60824cb1ef64STejun Heo 60834cb1ef64STejun Heo static void pr_cont_worker_id(struct worker *worker) 60844cb1ef64STejun Heo { 60854cb1ef64STejun Heo struct worker_pool *pool = worker->pool; 60864cb1ef64STejun Heo 60874cb1ef64STejun Heo if (pool->flags & WQ_BH) 60884cb1ef64STejun Heo pr_cont("bh%s", 60894cb1ef64STejun Heo pool->attrs->nice == HIGHPRI_NICE_LEVEL ? "-hi" : ""); 60904cb1ef64STejun Heo else 60914cb1ef64STejun Heo pr_cont("%d%s", task_pid_nr(worker->task), 60924cb1ef64STejun Heo worker->rescue_wq ? "(RESCUER)" : ""); 60933494fc30STejun Heo } 60943494fc30STejun Heo 6095c76feb0dSPaul E. McKenney struct pr_cont_work_struct { 6096c76feb0dSPaul E. McKenney bool comma; 6097c76feb0dSPaul E. McKenney work_func_t func; 6098c76feb0dSPaul E. McKenney long ctr; 6099c76feb0dSPaul E. McKenney }; 6100c76feb0dSPaul E. McKenney 6101c76feb0dSPaul E. McKenney static void pr_cont_work_flush(bool comma, work_func_t func, struct pr_cont_work_struct *pcwsp) 6102c76feb0dSPaul E. McKenney { 6103c76feb0dSPaul E. McKenney if (!pcwsp->ctr) 6104c76feb0dSPaul E. McKenney goto out_record; 6105c76feb0dSPaul E. McKenney if (func == pcwsp->func) { 6106c76feb0dSPaul E. McKenney pcwsp->ctr++; 6107c76feb0dSPaul E. McKenney return; 6108c76feb0dSPaul E. McKenney } 6109c76feb0dSPaul E. McKenney if (pcwsp->ctr == 1) 6110c76feb0dSPaul E. McKenney pr_cont("%s %ps", pcwsp->comma ? "," : "", pcwsp->func); 6111c76feb0dSPaul E. McKenney else 6112c76feb0dSPaul E. McKenney pr_cont("%s %ld*%ps", pcwsp->comma ? "," : "", pcwsp->ctr, pcwsp->func); 6113c76feb0dSPaul E. McKenney pcwsp->ctr = 0; 6114c76feb0dSPaul E. McKenney out_record: 6115c76feb0dSPaul E. McKenney if ((long)func == -1L) 6116c76feb0dSPaul E. McKenney return; 6117c76feb0dSPaul E. McKenney pcwsp->comma = comma; 6118c76feb0dSPaul E. McKenney pcwsp->func = func; 6119c76feb0dSPaul E. McKenney pcwsp->ctr = 1; 6120c76feb0dSPaul E. McKenney } 6121c76feb0dSPaul E. McKenney 6122c76feb0dSPaul E. McKenney static void pr_cont_work(bool comma, struct work_struct *work, struct pr_cont_work_struct *pcwsp) 61233494fc30STejun Heo { 61243494fc30STejun Heo if (work->func == wq_barrier_func) { 61253494fc30STejun Heo struct wq_barrier *barr; 61263494fc30STejun Heo 61273494fc30STejun Heo barr = container_of(work, struct wq_barrier, work); 61283494fc30STejun Heo 6129c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1, pcwsp); 61303494fc30STejun Heo pr_cont("%s BAR(%d)", comma ? "," : "", 61313494fc30STejun Heo task_pid_nr(barr->task)); 61323494fc30STejun Heo } else { 6133c76feb0dSPaul E. McKenney if (!comma) 6134c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1, pcwsp); 6135c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, work->func, pcwsp); 61363494fc30STejun Heo } 61373494fc30STejun Heo } 61383494fc30STejun Heo 61393494fc30STejun Heo static void show_pwq(struct pool_workqueue *pwq) 61403494fc30STejun Heo { 6141c76feb0dSPaul E. McKenney struct pr_cont_work_struct pcws = { .ctr = 0, }; 61423494fc30STejun Heo struct worker_pool *pool = pwq->pool; 61433494fc30STejun Heo struct work_struct *work; 61443494fc30STejun Heo struct worker *worker; 61453494fc30STejun Heo bool has_in_flight = false, has_pending = false; 61463494fc30STejun Heo int bkt; 61473494fc30STejun Heo 61483494fc30STejun Heo pr_info(" pwq %d:", pool->id); 61493494fc30STejun Heo pr_cont_pool_info(pool); 61503494fc30STejun Heo 6151a045a272STejun Heo pr_cont(" active=%d refcnt=%d%s\n", 6152a045a272STejun Heo pwq->nr_active, pwq->refcnt, 61533494fc30STejun Heo !list_empty(&pwq->mayday_node) ? " MAYDAY" : ""); 61543494fc30STejun Heo 61553494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 61563494fc30STejun Heo if (worker->current_pwq == pwq) { 61573494fc30STejun Heo has_in_flight = true; 61583494fc30STejun Heo break; 61593494fc30STejun Heo } 61603494fc30STejun Heo } 61613494fc30STejun Heo if (has_in_flight) { 61623494fc30STejun Heo bool comma = false; 61633494fc30STejun Heo 61643494fc30STejun Heo pr_info(" in-flight:"); 61653494fc30STejun Heo hash_for_each(pool->busy_hash, bkt, worker, hentry) { 61663494fc30STejun Heo if (worker->current_pwq != pwq) 61673494fc30STejun Heo continue; 61683494fc30STejun Heo 61694cb1ef64STejun Heo pr_cont(" %s", comma ? "," : ""); 61704cb1ef64STejun Heo pr_cont_worker_id(worker); 61714cb1ef64STejun Heo pr_cont(":%ps", worker->current_func); 61723494fc30STejun Heo list_for_each_entry(work, &worker->scheduled, entry) 6173c76feb0dSPaul E. McKenney pr_cont_work(false, work, &pcws); 6174c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1L, &pcws); 61753494fc30STejun Heo comma = true; 61763494fc30STejun Heo } 61773494fc30STejun Heo pr_cont("\n"); 61783494fc30STejun Heo } 61793494fc30STejun Heo 61803494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 61813494fc30STejun Heo if (get_work_pwq(work) == pwq) { 61823494fc30STejun Heo has_pending = true; 61833494fc30STejun Heo break; 61843494fc30STejun Heo } 61853494fc30STejun Heo } 61863494fc30STejun Heo if (has_pending) { 61873494fc30STejun Heo bool comma = false; 61883494fc30STejun Heo 61893494fc30STejun Heo pr_info(" pending:"); 61903494fc30STejun Heo list_for_each_entry(work, &pool->worklist, entry) { 61913494fc30STejun Heo if (get_work_pwq(work) != pwq) 61923494fc30STejun Heo continue; 61933494fc30STejun Heo 6194c76feb0dSPaul E. McKenney pr_cont_work(comma, work, &pcws); 61953494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 61963494fc30STejun Heo } 6197c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1L, &pcws); 61983494fc30STejun Heo pr_cont("\n"); 61993494fc30STejun Heo } 62003494fc30STejun Heo 6201f97a4a1aSLai Jiangshan if (!list_empty(&pwq->inactive_works)) { 62023494fc30STejun Heo bool comma = false; 62033494fc30STejun Heo 6204f97a4a1aSLai Jiangshan pr_info(" inactive:"); 6205f97a4a1aSLai Jiangshan list_for_each_entry(work, &pwq->inactive_works, entry) { 6206c76feb0dSPaul E. McKenney pr_cont_work(comma, work, &pcws); 62073494fc30STejun Heo comma = !(*work_data_bits(work) & WORK_STRUCT_LINKED); 62083494fc30STejun Heo } 6209c76feb0dSPaul E. McKenney pr_cont_work_flush(comma, (work_func_t)-1L, &pcws); 62103494fc30STejun Heo pr_cont("\n"); 62113494fc30STejun Heo } 62123494fc30STejun Heo } 62133494fc30STejun Heo 62143494fc30STejun Heo /** 621555df0933SImran Khan * show_one_workqueue - dump state of specified workqueue 621655df0933SImran Khan * @wq: workqueue whose state will be printed 62173494fc30STejun Heo */ 621855df0933SImran Khan void show_one_workqueue(struct workqueue_struct *wq) 62193494fc30STejun Heo { 62203494fc30STejun Heo struct pool_workqueue *pwq; 62213494fc30STejun Heo bool idle = true; 6222c26e2f2eSTejun Heo unsigned long irq_flags; 62233494fc30STejun Heo 62243494fc30STejun Heo for_each_pwq(pwq, wq) { 6225afa87ce8STejun Heo if (!pwq_is_empty(pwq)) { 62263494fc30STejun Heo idle = false; 62273494fc30STejun Heo break; 62283494fc30STejun Heo } 62293494fc30STejun Heo } 623055df0933SImran Khan if (idle) /* Nothing to print for idle workqueue */ 623155df0933SImran Khan return; 62323494fc30STejun Heo 62333494fc30STejun Heo pr_info("workqueue %s: flags=0x%x\n", wq->name, wq->flags); 62343494fc30STejun Heo 62353494fc30STejun Heo for_each_pwq(pwq, wq) { 6236c26e2f2eSTejun Heo raw_spin_lock_irqsave(&pwq->pool->lock, irq_flags); 6237afa87ce8STejun Heo if (!pwq_is_empty(pwq)) { 623857116ce1SJohan Hovold /* 623957116ce1SJohan Hovold * Defer printing to avoid deadlocks in console 624057116ce1SJohan Hovold * drivers that queue work while holding locks 624157116ce1SJohan Hovold * also taken in their write paths. 624257116ce1SJohan Hovold */ 624357116ce1SJohan Hovold printk_deferred_enter(); 62443494fc30STejun Heo show_pwq(pwq); 624557116ce1SJohan Hovold printk_deferred_exit(); 624657116ce1SJohan Hovold } 6247c26e2f2eSTejun Heo raw_spin_unlock_irqrestore(&pwq->pool->lock, irq_flags); 624862635ea8SSergey Senozhatsky /* 624962635ea8SSergey Senozhatsky * We could be printing a lot from atomic context, e.g. 625055df0933SImran Khan * sysrq-t -> show_all_workqueues(). Avoid triggering 625162635ea8SSergey Senozhatsky * hard lockup. 625262635ea8SSergey Senozhatsky */ 625362635ea8SSergey Senozhatsky touch_nmi_watchdog(); 62543494fc30STejun Heo } 625555df0933SImran Khan 62563494fc30STejun Heo } 62573494fc30STejun Heo 625855df0933SImran Khan /** 625955df0933SImran Khan * show_one_worker_pool - dump state of specified worker pool 626055df0933SImran Khan * @pool: worker pool whose state will be printed 626155df0933SImran Khan */ 626255df0933SImran Khan static void show_one_worker_pool(struct worker_pool *pool) 626355df0933SImran Khan { 62643494fc30STejun Heo struct worker *worker; 62653494fc30STejun Heo bool first = true; 6266c26e2f2eSTejun Heo unsigned long irq_flags; 6267335a42ebSPetr Mladek unsigned long hung = 0; 62683494fc30STejun Heo 6269c26e2f2eSTejun Heo raw_spin_lock_irqsave(&pool->lock, irq_flags); 62703494fc30STejun Heo if (pool->nr_workers == pool->nr_idle) 62713494fc30STejun Heo goto next_pool; 6272335a42ebSPetr Mladek 6273335a42ebSPetr Mladek /* How long the first pending work is waiting for a worker. */ 6274335a42ebSPetr Mladek if (!list_empty(&pool->worklist)) 6275335a42ebSPetr Mladek hung = jiffies_to_msecs(jiffies - pool->watchdog_ts) / 1000; 6276335a42ebSPetr Mladek 627757116ce1SJohan Hovold /* 627857116ce1SJohan Hovold * Defer printing to avoid deadlocks in console drivers that 627957116ce1SJohan Hovold * queue work while holding locks also taken in their write 628057116ce1SJohan Hovold * paths. 628157116ce1SJohan Hovold */ 628257116ce1SJohan Hovold printk_deferred_enter(); 62833494fc30STejun Heo pr_info("pool %d:", pool->id); 62843494fc30STejun Heo pr_cont_pool_info(pool); 6285335a42ebSPetr Mladek pr_cont(" hung=%lus workers=%d", hung, pool->nr_workers); 62863494fc30STejun Heo if (pool->manager) 62873494fc30STejun Heo pr_cont(" manager: %d", 62883494fc30STejun Heo task_pid_nr(pool->manager->task)); 62893494fc30STejun Heo list_for_each_entry(worker, &pool->idle_list, entry) { 62904cb1ef64STejun Heo pr_cont(" %s", first ? "idle: " : ""); 62914cb1ef64STejun Heo pr_cont_worker_id(worker); 62923494fc30STejun Heo first = false; 62933494fc30STejun Heo } 62943494fc30STejun Heo pr_cont("\n"); 629557116ce1SJohan Hovold printk_deferred_exit(); 62963494fc30STejun Heo next_pool: 6297c26e2f2eSTejun Heo raw_spin_unlock_irqrestore(&pool->lock, irq_flags); 629862635ea8SSergey Senozhatsky /* 629962635ea8SSergey Senozhatsky * We could be printing a lot from atomic context, e.g. 630055df0933SImran Khan * sysrq-t -> show_all_workqueues(). Avoid triggering 630162635ea8SSergey Senozhatsky * hard lockup. 630262635ea8SSergey Senozhatsky */ 630362635ea8SSergey Senozhatsky touch_nmi_watchdog(); 630455df0933SImran Khan 63053494fc30STejun Heo } 63063494fc30STejun Heo 630755df0933SImran Khan /** 630855df0933SImran Khan * show_all_workqueues - dump workqueue state 630955df0933SImran Khan * 6310704bc669SJungseung Lee * Called from a sysrq handler and prints out all busy workqueues and pools. 631155df0933SImran Khan */ 631255df0933SImran Khan void show_all_workqueues(void) 631355df0933SImran Khan { 631455df0933SImran Khan struct workqueue_struct *wq; 631555df0933SImran Khan struct worker_pool *pool; 631655df0933SImran Khan int pi; 631755df0933SImran Khan 631855df0933SImran Khan rcu_read_lock(); 631955df0933SImran Khan 632055df0933SImran Khan pr_info("Showing busy workqueues and worker pools:\n"); 632155df0933SImran Khan 632255df0933SImran Khan list_for_each_entry_rcu(wq, &workqueues, list) 632355df0933SImran Khan show_one_workqueue(wq); 632455df0933SImran Khan 632555df0933SImran Khan for_each_pool(pool, pi) 632655df0933SImran Khan show_one_worker_pool(pool); 632755df0933SImran Khan 632824acfb71SThomas Gleixner rcu_read_unlock(); 63293494fc30STejun Heo } 63303494fc30STejun Heo 6331704bc669SJungseung Lee /** 6332704bc669SJungseung Lee * show_freezable_workqueues - dump freezable workqueue state 6333704bc669SJungseung Lee * 6334704bc669SJungseung Lee * Called from try_to_freeze_tasks() and prints out all freezable workqueues 6335704bc669SJungseung Lee * still busy. 6336704bc669SJungseung Lee */ 6337704bc669SJungseung Lee void show_freezable_workqueues(void) 6338704bc669SJungseung Lee { 6339704bc669SJungseung Lee struct workqueue_struct *wq; 6340704bc669SJungseung Lee 6341704bc669SJungseung Lee rcu_read_lock(); 6342704bc669SJungseung Lee 6343704bc669SJungseung Lee pr_info("Showing freezable workqueues that are still busy:\n"); 6344704bc669SJungseung Lee 6345704bc669SJungseung Lee list_for_each_entry_rcu(wq, &workqueues, list) { 6346704bc669SJungseung Lee if (!(wq->flags & WQ_FREEZABLE)) 6347704bc669SJungseung Lee continue; 6348704bc669SJungseung Lee show_one_workqueue(wq); 6349704bc669SJungseung Lee } 6350704bc669SJungseung Lee 6351704bc669SJungseung Lee rcu_read_unlock(); 6352704bc669SJungseung Lee } 6353704bc669SJungseung Lee 63546b59808bSTejun Heo /* used to show worker information through /proc/PID/{comm,stat,status} */ 63556b59808bSTejun Heo void wq_worker_comm(char *buf, size_t size, struct task_struct *task) 63566b59808bSTejun Heo { 63576b59808bSTejun Heo int off; 63586b59808bSTejun Heo 63596b59808bSTejun Heo /* always show the actual comm */ 63606b59808bSTejun Heo off = strscpy(buf, task->comm, size); 63616b59808bSTejun Heo if (off < 0) 63626b59808bSTejun Heo return; 63636b59808bSTejun Heo 6364197f6accSTejun Heo /* stabilize PF_WQ_WORKER and worker pool association */ 63656b59808bSTejun Heo mutex_lock(&wq_pool_attach_mutex); 63666b59808bSTejun Heo 6367197f6accSTejun Heo if (task->flags & PF_WQ_WORKER) { 6368197f6accSTejun Heo struct worker *worker = kthread_data(task); 6369197f6accSTejun Heo struct worker_pool *pool = worker->pool; 63706b59808bSTejun Heo 63716b59808bSTejun Heo if (pool) { 6372a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 63736b59808bSTejun Heo /* 6374197f6accSTejun Heo * ->desc tracks information (wq name or 6375197f6accSTejun Heo * set_worker_desc()) for the latest execution. If 6376197f6accSTejun Heo * current, prepend '+', otherwise '-'. 63776b59808bSTejun Heo */ 63786b59808bSTejun Heo if (worker->desc[0] != '\0') { 63796b59808bSTejun Heo if (worker->current_work) 63806b59808bSTejun Heo scnprintf(buf + off, size - off, "+%s", 63816b59808bSTejun Heo worker->desc); 63826b59808bSTejun Heo else 63836b59808bSTejun Heo scnprintf(buf + off, size - off, "-%s", 63846b59808bSTejun Heo worker->desc); 63856b59808bSTejun Heo } 6386a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 63876b59808bSTejun Heo } 6388197f6accSTejun Heo } 63896b59808bSTejun Heo 63906b59808bSTejun Heo mutex_unlock(&wq_pool_attach_mutex); 63916b59808bSTejun Heo } 63926b59808bSTejun Heo 639366448bc2SMathieu Malaterre #ifdef CONFIG_SMP 639466448bc2SMathieu Malaterre 6395db7bccf4STejun Heo /* 6396db7bccf4STejun Heo * CPU hotplug. 6397db7bccf4STejun Heo * 6398e22bee78STejun Heo * There are two challenges in supporting CPU hotplug. Firstly, there 6399112202d9STejun Heo * are a lot of assumptions on strong associations among work, pwq and 6400706026c2STejun Heo * pool which make migrating pending and scheduled works very 6401e22bee78STejun Heo * difficult to implement without impacting hot paths. Secondly, 640294cf58bbSTejun Heo * worker pools serve mix of short, long and very long running works making 6403e22bee78STejun Heo * blocked draining impractical. 6404e22bee78STejun Heo * 640524647570STejun Heo * This is solved by allowing the pools to be disassociated from the CPU 6406628c78e7STejun Heo * running as an unbound one and allowing it to be reattached later if the 6407628c78e7STejun Heo * cpu comes back online. 6408db7bccf4STejun Heo */ 6409db7bccf4STejun Heo 6410e8b3f8dbSLai Jiangshan static void unbind_workers(int cpu) 6411db7bccf4STejun Heo { 64124ce62e9eSTejun Heo struct worker_pool *pool; 6413db7bccf4STejun Heo struct worker *worker; 6414db7bccf4STejun Heo 6415f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 64161258fae7STejun Heo mutex_lock(&wq_pool_attach_mutex); 6417a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 6418e22bee78STejun Heo 6419f2d5a0eeSTejun Heo /* 642092f9c5c4SLai Jiangshan * We've blocked all attach/detach operations. Make all workers 642194cf58bbSTejun Heo * unbound and set DISASSOCIATED. Before this, all workers 642211b45b0bSLai Jiangshan * must be on the cpu. After this, they may become diasporas. 6423b4ac9384SLai Jiangshan * And the preemption disabled section in their sched callbacks 6424b4ac9384SLai Jiangshan * are guaranteed to see WORKER_UNBOUND since the code here 6425b4ac9384SLai Jiangshan * is on the same cpu. 6426f2d5a0eeSTejun Heo */ 6427da028469SLai Jiangshan for_each_pool_worker(worker, pool) 6428403c821dSTejun Heo worker->flags |= WORKER_UNBOUND; 6429db7bccf4STejun Heo 643024647570STejun Heo pool->flags |= POOL_DISASSOCIATED; 6431f2d5a0eeSTejun Heo 6432e22bee78STejun Heo /* 6433989442d7SLai Jiangshan * The handling of nr_running in sched callbacks are disabled 6434989442d7SLai Jiangshan * now. Zap nr_running. After this, nr_running stays zero and 6435989442d7SLai Jiangshan * need_more_worker() and keep_working() are always true as 6436989442d7SLai Jiangshan * long as the worklist is not empty. This pool now behaves as 6437989442d7SLai Jiangshan * an unbound (in terms of concurrency management) pool which 6438eb283428SLai Jiangshan * are served by workers tied to the pool. 6439e22bee78STejun Heo */ 6440bc35f7efSLai Jiangshan pool->nr_running = 0; 6441eb283428SLai Jiangshan 6442eb283428SLai Jiangshan /* 6443eb283428SLai Jiangshan * With concurrency management just turned off, a busy 6444eb283428SLai Jiangshan * worker blocking could lead to lengthy stalls. Kick off 6445eb283428SLai Jiangshan * unbound chain execution of currently pending work items. 6446eb283428SLai Jiangshan */ 64470219a352STejun Heo kick_pool(pool); 6448989442d7SLai Jiangshan 6449a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 6450989442d7SLai Jiangshan 6451793777bcSValentin Schneider for_each_pool_worker(worker, pool) 6452793777bcSValentin Schneider unbind_worker(worker); 6453989442d7SLai Jiangshan 6454989442d7SLai Jiangshan mutex_unlock(&wq_pool_attach_mutex); 6455eb283428SLai Jiangshan } 6456db7bccf4STejun Heo } 6457db7bccf4STejun Heo 6458bd7c089eSTejun Heo /** 6459bd7c089eSTejun Heo * rebind_workers - rebind all workers of a pool to the associated CPU 6460bd7c089eSTejun Heo * @pool: pool of interest 6461bd7c089eSTejun Heo * 6462a9ab775bSTejun Heo * @pool->cpu is coming online. Rebind all workers to the CPU. 6463bd7c089eSTejun Heo */ 6464bd7c089eSTejun Heo static void rebind_workers(struct worker_pool *pool) 6465bd7c089eSTejun Heo { 6466a9ab775bSTejun Heo struct worker *worker; 6467bd7c089eSTejun Heo 64681258fae7STejun Heo lockdep_assert_held(&wq_pool_attach_mutex); 6469bd7c089eSTejun Heo 6470bd7c089eSTejun Heo /* 6471a9ab775bSTejun Heo * Restore CPU affinity of all workers. As all idle workers should 6472a9ab775bSTejun Heo * be on the run-queue of the associated CPU before any local 6473402dd89dSShailendra Verma * wake-ups for concurrency management happen, restore CPU affinity 6474a9ab775bSTejun Heo * of all workers first and then clear UNBOUND. As we're called 6475a9ab775bSTejun Heo * from CPU_ONLINE, the following shouldn't fail. 6476bd7c089eSTejun Heo */ 6477c63a2e52SValentin Schneider for_each_pool_worker(worker, pool) { 6478c63a2e52SValentin Schneider kthread_set_per_cpu(worker->task, pool->cpu); 6479c63a2e52SValentin Schneider WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, 64809546b29eSTejun Heo pool_allowed_cpus(pool)) < 0); 6481c63a2e52SValentin Schneider } 6482a9ab775bSTejun Heo 6483a9b8a985SSebastian Andrzej Siewior raw_spin_lock_irq(&pool->lock); 6484f7c17d26SWanpeng Li 64853de5e884SLai Jiangshan pool->flags &= ~POOL_DISASSOCIATED; 6486a9ab775bSTejun Heo 6487da028469SLai Jiangshan for_each_pool_worker(worker, pool) { 6488a9ab775bSTejun Heo unsigned int worker_flags = worker->flags; 6489a9ab775bSTejun Heo 6490a9ab775bSTejun Heo /* 6491a9ab775bSTejun Heo * We want to clear UNBOUND but can't directly call 6492a9ab775bSTejun Heo * worker_clr_flags() or adjust nr_running. Atomically 6493a9ab775bSTejun Heo * replace UNBOUND with another NOT_RUNNING flag REBOUND. 6494a9ab775bSTejun Heo * @worker will clear REBOUND using worker_clr_flags() when 6495a9ab775bSTejun Heo * it initiates the next execution cycle thus restoring 6496a9ab775bSTejun Heo * concurrency management. Note that when or whether 6497a9ab775bSTejun Heo * @worker clears REBOUND doesn't affect correctness. 6498a9ab775bSTejun Heo * 6499c95491edSMark Rutland * WRITE_ONCE() is necessary because @worker->flags may be 6500a9ab775bSTejun Heo * tested without holding any lock in 65016d25be57SThomas Gleixner * wq_worker_running(). Without it, NOT_RUNNING test may 6502a9ab775bSTejun Heo * fail incorrectly leading to premature concurrency 6503a9ab775bSTejun Heo * management operations. 6504bd7c089eSTejun Heo */ 6505a9ab775bSTejun Heo WARN_ON_ONCE(!(worker_flags & WORKER_UNBOUND)); 6506a9ab775bSTejun Heo worker_flags |= WORKER_REBOUND; 6507a9ab775bSTejun Heo worker_flags &= ~WORKER_UNBOUND; 6508c95491edSMark Rutland WRITE_ONCE(worker->flags, worker_flags); 6509bd7c089eSTejun Heo } 6510a9ab775bSTejun Heo 6511a9b8a985SSebastian Andrzej Siewior raw_spin_unlock_irq(&pool->lock); 6512bd7c089eSTejun Heo } 6513bd7c089eSTejun Heo 65147dbc725eSTejun Heo /** 65157dbc725eSTejun Heo * restore_unbound_workers_cpumask - restore cpumask of unbound workers 65167dbc725eSTejun Heo * @pool: unbound pool of interest 65177dbc725eSTejun Heo * @cpu: the CPU which is coming up 65187dbc725eSTejun Heo * 65197dbc725eSTejun Heo * An unbound pool may end up with a cpumask which doesn't have any online 65207dbc725eSTejun Heo * CPUs. When a worker of such pool get scheduled, the scheduler resets 65217dbc725eSTejun Heo * its cpus_allowed. If @cpu is in @pool's cpumask which didn't have any 65227dbc725eSTejun Heo * online CPU before, cpus_allowed of all its workers should be restored. 65237dbc725eSTejun Heo */ 65247dbc725eSTejun Heo static void restore_unbound_workers_cpumask(struct worker_pool *pool, int cpu) 65257dbc725eSTejun Heo { 65267dbc725eSTejun Heo static cpumask_t cpumask; 65277dbc725eSTejun Heo struct worker *worker; 65287dbc725eSTejun Heo 65291258fae7STejun Heo lockdep_assert_held(&wq_pool_attach_mutex); 65307dbc725eSTejun Heo 65317dbc725eSTejun Heo /* is @cpu allowed for @pool? */ 65327dbc725eSTejun Heo if (!cpumask_test_cpu(cpu, pool->attrs->cpumask)) 65337dbc725eSTejun Heo return; 65347dbc725eSTejun Heo 65357dbc725eSTejun Heo cpumask_and(&cpumask, pool->attrs->cpumask, cpu_online_mask); 65367dbc725eSTejun Heo 65377dbc725eSTejun Heo /* as we're called from CPU_ONLINE, the following shouldn't fail */ 6538da028469SLai Jiangshan for_each_pool_worker(worker, pool) 6539d945b5e9SPeter Zijlstra WARN_ON_ONCE(set_cpus_allowed_ptr(worker->task, &cpumask) < 0); 65407dbc725eSTejun Heo } 65417dbc725eSTejun Heo 65427ee681b2SThomas Gleixner int workqueue_prepare_cpu(unsigned int cpu) 65431da177e4SLinus Torvalds { 65444ce62e9eSTejun Heo struct worker_pool *pool; 65451da177e4SLinus Torvalds 6546f02ae73aSTejun Heo for_each_cpu_worker_pool(pool, cpu) { 65473ce63377STejun Heo if (pool->nr_workers) 65483ce63377STejun Heo continue; 6549051e1850SLai Jiangshan if (!create_worker(pool)) 65507ee681b2SThomas Gleixner return -ENOMEM; 65513af24433SOleg Nesterov } 65527ee681b2SThomas Gleixner return 0; 65537ee681b2SThomas Gleixner } 65541da177e4SLinus Torvalds 65557ee681b2SThomas Gleixner int workqueue_online_cpu(unsigned int cpu) 65567ee681b2SThomas Gleixner { 65577ee681b2SThomas Gleixner struct worker_pool *pool; 65587ee681b2SThomas Gleixner struct workqueue_struct *wq; 65597ee681b2SThomas Gleixner int pi; 65607ee681b2SThomas Gleixner 656168e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 65627dbc725eSTejun Heo 65638d84baf7SLai Jiangshan cpumask_set_cpu(cpu, wq_online_cpumask); 65648d84baf7SLai Jiangshan 65657dbc725eSTejun Heo for_each_pool(pool, pi) { 65664cb1ef64STejun Heo /* BH pools aren't affected by hotplug */ 65674cb1ef64STejun Heo if (pool->flags & POOL_BH) 65684cb1ef64STejun Heo continue; 656994cf58bbSTejun Heo 65704cb1ef64STejun Heo mutex_lock(&wq_pool_attach_mutex); 6571f05b558dSLai Jiangshan if (pool->cpu == cpu) 657294cf58bbSTejun Heo rebind_workers(pool); 6573f05b558dSLai Jiangshan else if (pool->cpu < 0) 65747dbc725eSTejun Heo restore_unbound_workers_cpumask(pool, cpu); 65751258fae7STejun Heo mutex_unlock(&wq_pool_attach_mutex); 657694cf58bbSTejun Heo } 65777dbc725eSTejun Heo 6578fef59c9cSTejun Heo /* update pod affinity of unbound workqueues */ 65794cbfd3deSTejun Heo list_for_each_entry(wq, &workqueues, list) { 658084193c07STejun Heo struct workqueue_attrs *attrs = wq->unbound_attrs; 658184193c07STejun Heo 658284193c07STejun Heo if (attrs) { 658384193c07STejun Heo const struct wq_pod_type *pt = wqattrs_pod_type(attrs); 65844cbfd3deSTejun Heo int tcpu; 65854cbfd3deSTejun Heo 658684193c07STejun Heo for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]]) 6587b2b1f933SLai Jiangshan unbound_wq_update_pwq(wq, tcpu); 65885797b1c1STejun Heo 65895797b1c1STejun Heo mutex_lock(&wq->mutex); 65905797b1c1STejun Heo wq_update_node_max_active(wq, -1); 65915797b1c1STejun Heo mutex_unlock(&wq->mutex); 65924cbfd3deSTejun Heo } 65934cbfd3deSTejun Heo } 65944c16bd32STejun Heo 659568e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 65967ee681b2SThomas Gleixner return 0; 659765758202STejun Heo } 659865758202STejun Heo 65997ee681b2SThomas Gleixner int workqueue_offline_cpu(unsigned int cpu) 660065758202STejun Heo { 66014c16bd32STejun Heo struct workqueue_struct *wq; 66028db25e78STejun Heo 66034c16bd32STejun Heo /* unbinding per-cpu workers should happen on the local CPU */ 6604e8b3f8dbSLai Jiangshan if (WARN_ON(cpu != smp_processor_id())) 6605e8b3f8dbSLai Jiangshan return -1; 6606e8b3f8dbSLai Jiangshan 6607e8b3f8dbSLai Jiangshan unbind_workers(cpu); 66084c16bd32STejun Heo 6609fef59c9cSTejun Heo /* update pod affinity of unbound workqueues */ 66104c16bd32STejun Heo mutex_lock(&wq_pool_mutex); 66118d84baf7SLai Jiangshan 66128d84baf7SLai Jiangshan cpumask_clear_cpu(cpu, wq_online_cpumask); 66138d84baf7SLai Jiangshan 66144cbfd3deSTejun Heo list_for_each_entry(wq, &workqueues, list) { 661584193c07STejun Heo struct workqueue_attrs *attrs = wq->unbound_attrs; 661684193c07STejun Heo 661784193c07STejun Heo if (attrs) { 661884193c07STejun Heo const struct wq_pod_type *pt = wqattrs_pod_type(attrs); 66194cbfd3deSTejun Heo int tcpu; 66204cbfd3deSTejun Heo 662184193c07STejun Heo for_each_cpu(tcpu, pt->pod_cpus[pt->cpu_pod[cpu]]) 6622b2b1f933SLai Jiangshan unbound_wq_update_pwq(wq, tcpu); 66235797b1c1STejun Heo 66245797b1c1STejun Heo mutex_lock(&wq->mutex); 66255797b1c1STejun Heo wq_update_node_max_active(wq, cpu); 66265797b1c1STejun Heo mutex_unlock(&wq->mutex); 66274cbfd3deSTejun Heo } 66284cbfd3deSTejun Heo } 66294c16bd32STejun Heo mutex_unlock(&wq_pool_mutex); 66304c16bd32STejun Heo 66317ee681b2SThomas Gleixner return 0; 663265758202STejun Heo } 663365758202STejun Heo 66342d3854a3SRusty Russell struct work_for_cpu { 6635ed48ece2STejun Heo struct work_struct work; 66362d3854a3SRusty Russell long (*fn)(void *); 66372d3854a3SRusty Russell void *arg; 66382d3854a3SRusty Russell long ret; 66392d3854a3SRusty Russell }; 66402d3854a3SRusty Russell 6641ed48ece2STejun Heo static void work_for_cpu_fn(struct work_struct *work) 66422d3854a3SRusty Russell { 6643ed48ece2STejun Heo struct work_for_cpu *wfc = container_of(work, struct work_for_cpu, work); 6644ed48ece2STejun Heo 66452d3854a3SRusty Russell wfc->ret = wfc->fn(wfc->arg); 66462d3854a3SRusty Russell } 66472d3854a3SRusty Russell 66482d3854a3SRusty Russell /** 6649265f3ed0SFrederic Weisbecker * work_on_cpu_key - run a function in thread context on a particular cpu 66502d3854a3SRusty Russell * @cpu: the cpu to run on 66512d3854a3SRusty Russell * @fn: the function to run 66522d3854a3SRusty Russell * @arg: the function arg 6653265f3ed0SFrederic Weisbecker * @key: The lock class key for lock debugging purposes 66542d3854a3SRusty Russell * 665531ad9081SRusty Russell * It is up to the caller to ensure that the cpu doesn't go offline. 66566b44003eSAndrew Morton * The caller must not hold any locks which would prevent @fn from completing. 6657d185af30SYacine Belkadi * 6658d185af30SYacine Belkadi * Return: The value @fn returns. 66592d3854a3SRusty Russell */ 6660265f3ed0SFrederic Weisbecker long work_on_cpu_key(int cpu, long (*fn)(void *), 6661265f3ed0SFrederic Weisbecker void *arg, struct lock_class_key *key) 66622d3854a3SRusty Russell { 6663ed48ece2STejun Heo struct work_for_cpu wfc = { .fn = fn, .arg = arg }; 66642d3854a3SRusty Russell 6665265f3ed0SFrederic Weisbecker INIT_WORK_ONSTACK_KEY(&wfc.work, work_for_cpu_fn, key); 6666ed48ece2STejun Heo schedule_work_on(cpu, &wfc.work); 666712997d1aSBjorn Helgaas flush_work(&wfc.work); 6668440a1136SChuansheng Liu destroy_work_on_stack(&wfc.work); 66692d3854a3SRusty Russell return wfc.ret; 66702d3854a3SRusty Russell } 6671265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_key); 66720e8d6a93SThomas Gleixner 66730e8d6a93SThomas Gleixner /** 6674265f3ed0SFrederic Weisbecker * work_on_cpu_safe_key - run a function in thread context on a particular cpu 66750e8d6a93SThomas Gleixner * @cpu: the cpu to run on 66760e8d6a93SThomas Gleixner * @fn: the function to run 66770e8d6a93SThomas Gleixner * @arg: the function argument 6678265f3ed0SFrederic Weisbecker * @key: The lock class key for lock debugging purposes 66790e8d6a93SThomas Gleixner * 66800e8d6a93SThomas Gleixner * Disables CPU hotplug and calls work_on_cpu(). The caller must not hold 66810e8d6a93SThomas Gleixner * any locks which would prevent @fn from completing. 66820e8d6a93SThomas Gleixner * 66830e8d6a93SThomas Gleixner * Return: The value @fn returns. 66840e8d6a93SThomas Gleixner */ 6685265f3ed0SFrederic Weisbecker long work_on_cpu_safe_key(int cpu, long (*fn)(void *), 6686265f3ed0SFrederic Weisbecker void *arg, struct lock_class_key *key) 66870e8d6a93SThomas Gleixner { 66880e8d6a93SThomas Gleixner long ret = -ENODEV; 66890e8d6a93SThomas Gleixner 6690ffd8bea8SSebastian Andrzej Siewior cpus_read_lock(); 66910e8d6a93SThomas Gleixner if (cpu_online(cpu)) 6692265f3ed0SFrederic Weisbecker ret = work_on_cpu_key(cpu, fn, arg, key); 6693ffd8bea8SSebastian Andrzej Siewior cpus_read_unlock(); 66940e8d6a93SThomas Gleixner return ret; 66950e8d6a93SThomas Gleixner } 6696265f3ed0SFrederic Weisbecker EXPORT_SYMBOL_GPL(work_on_cpu_safe_key); 66972d3854a3SRusty Russell #endif /* CONFIG_SMP */ 66982d3854a3SRusty Russell 6699a0a1a5fdSTejun Heo #ifdef CONFIG_FREEZER 6700e7577c50SRusty Russell 6701a0a1a5fdSTejun Heo /** 6702a0a1a5fdSTejun Heo * freeze_workqueues_begin - begin freezing workqueues 6703a0a1a5fdSTejun Heo * 670458a69cb4STejun Heo * Start freezing workqueues. After this function returns, all freezable 6705f97a4a1aSLai Jiangshan * workqueues will queue new works to their inactive_works list instead of 6706706026c2STejun Heo * pool->worklist. 6707a0a1a5fdSTejun Heo * 6708a0a1a5fdSTejun Heo * CONTEXT: 6709a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 6710a0a1a5fdSTejun Heo */ 6711a0a1a5fdSTejun Heo void freeze_workqueues_begin(void) 6712a0a1a5fdSTejun Heo { 671324b8a847STejun Heo struct workqueue_struct *wq; 6714a0a1a5fdSTejun Heo 671568e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 6716a0a1a5fdSTejun Heo 67176183c009STejun Heo WARN_ON_ONCE(workqueue_freezing); 6718a0a1a5fdSTejun Heo workqueue_freezing = true; 6719a0a1a5fdSTejun Heo 672024b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 6721a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 6722a045a272STejun Heo wq_adjust_max_active(wq); 6723a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 6724a1056305STejun Heo } 67255bcab335STejun Heo 672668e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 6727a0a1a5fdSTejun Heo } 6728a0a1a5fdSTejun Heo 6729a0a1a5fdSTejun Heo /** 673058a69cb4STejun Heo * freeze_workqueues_busy - are freezable workqueues still busy? 6731a0a1a5fdSTejun Heo * 6732a0a1a5fdSTejun Heo * Check whether freezing is complete. This function must be called 6733a0a1a5fdSTejun Heo * between freeze_workqueues_begin() and thaw_workqueues(). 6734a0a1a5fdSTejun Heo * 6735a0a1a5fdSTejun Heo * CONTEXT: 673668e13a67SLai Jiangshan * Grabs and releases wq_pool_mutex. 6737a0a1a5fdSTejun Heo * 6738d185af30SYacine Belkadi * Return: 673958a69cb4STejun Heo * %true if some freezable workqueues are still busy. %false if freezing 674058a69cb4STejun Heo * is complete. 6741a0a1a5fdSTejun Heo */ 6742a0a1a5fdSTejun Heo bool freeze_workqueues_busy(void) 6743a0a1a5fdSTejun Heo { 6744a0a1a5fdSTejun Heo bool busy = false; 674524b8a847STejun Heo struct workqueue_struct *wq; 674624b8a847STejun Heo struct pool_workqueue *pwq; 6747a0a1a5fdSTejun Heo 674868e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 6749a0a1a5fdSTejun Heo 67506183c009STejun Heo WARN_ON_ONCE(!workqueue_freezing); 6751a0a1a5fdSTejun Heo 675224b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 675324b8a847STejun Heo if (!(wq->flags & WQ_FREEZABLE)) 675424b8a847STejun Heo continue; 6755a0a1a5fdSTejun Heo /* 6756a0a1a5fdSTejun Heo * nr_active is monotonically decreasing. It's safe 6757a0a1a5fdSTejun Heo * to peek without lock. 6758a0a1a5fdSTejun Heo */ 675924acfb71SThomas Gleixner rcu_read_lock(); 676024b8a847STejun Heo for_each_pwq(pwq, wq) { 67616183c009STejun Heo WARN_ON_ONCE(pwq->nr_active < 0); 6762112202d9STejun Heo if (pwq->nr_active) { 6763a0a1a5fdSTejun Heo busy = true; 676424acfb71SThomas Gleixner rcu_read_unlock(); 6765a0a1a5fdSTejun Heo goto out_unlock; 6766a0a1a5fdSTejun Heo } 6767a0a1a5fdSTejun Heo } 676824acfb71SThomas Gleixner rcu_read_unlock(); 6769a0a1a5fdSTejun Heo } 6770a0a1a5fdSTejun Heo out_unlock: 677168e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 6772a0a1a5fdSTejun Heo return busy; 6773a0a1a5fdSTejun Heo } 6774a0a1a5fdSTejun Heo 6775a0a1a5fdSTejun Heo /** 6776a0a1a5fdSTejun Heo * thaw_workqueues - thaw workqueues 6777a0a1a5fdSTejun Heo * 6778a0a1a5fdSTejun Heo * Thaw workqueues. Normal queueing is restored and all collected 6779706026c2STejun Heo * frozen works are transferred to their respective pool worklists. 6780a0a1a5fdSTejun Heo * 6781a0a1a5fdSTejun Heo * CONTEXT: 6782a357fc03SLai Jiangshan * Grabs and releases wq_pool_mutex, wq->mutex and pool->lock's. 6783a0a1a5fdSTejun Heo */ 6784a0a1a5fdSTejun Heo void thaw_workqueues(void) 6785a0a1a5fdSTejun Heo { 678624b8a847STejun Heo struct workqueue_struct *wq; 6787a0a1a5fdSTejun Heo 678868e13a67SLai Jiangshan mutex_lock(&wq_pool_mutex); 6789a0a1a5fdSTejun Heo 6790a0a1a5fdSTejun Heo if (!workqueue_freezing) 6791a0a1a5fdSTejun Heo goto out_unlock; 6792a0a1a5fdSTejun Heo 679374b414eaSLai Jiangshan workqueue_freezing = false; 679424b8a847STejun Heo 679524b8a847STejun Heo /* restore max_active and repopulate worklist */ 679624b8a847STejun Heo list_for_each_entry(wq, &workqueues, list) { 6797a357fc03SLai Jiangshan mutex_lock(&wq->mutex); 6798a045a272STejun Heo wq_adjust_max_active(wq); 6799a357fc03SLai Jiangshan mutex_unlock(&wq->mutex); 680024b8a847STejun Heo } 680124b8a847STejun Heo 6802a0a1a5fdSTejun Heo out_unlock: 680368e13a67SLai Jiangshan mutex_unlock(&wq_pool_mutex); 6804a0a1a5fdSTejun Heo } 6805a0a1a5fdSTejun Heo #endif /* CONFIG_FREEZER */ 6806a0a1a5fdSTejun Heo 680799c621efSLai Jiangshan static int workqueue_apply_unbound_cpumask(const cpumask_var_t unbound_cpumask) 6808042f7df1SLai Jiangshan { 6809042f7df1SLai Jiangshan LIST_HEAD(ctxs); 6810042f7df1SLai Jiangshan int ret = 0; 6811042f7df1SLai Jiangshan struct workqueue_struct *wq; 6812042f7df1SLai Jiangshan struct apply_wqattrs_ctx *ctx, *n; 6813042f7df1SLai Jiangshan 6814042f7df1SLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 6815042f7df1SLai Jiangshan 6816042f7df1SLai Jiangshan list_for_each_entry(wq, &workqueues, list) { 68178eb17dc1SWaiman Long if (!(wq->flags & WQ_UNBOUND) || (wq->flags & __WQ_DESTROYING)) 6818042f7df1SLai Jiangshan continue; 6819042f7df1SLai Jiangshan 682099c621efSLai Jiangshan ctx = apply_wqattrs_prepare(wq, wq->unbound_attrs, unbound_cpumask); 682184193c07STejun Heo if (IS_ERR(ctx)) { 682284193c07STejun Heo ret = PTR_ERR(ctx); 6823042f7df1SLai Jiangshan break; 6824042f7df1SLai Jiangshan } 6825042f7df1SLai Jiangshan 6826042f7df1SLai Jiangshan list_add_tail(&ctx->list, &ctxs); 6827042f7df1SLai Jiangshan } 6828042f7df1SLai Jiangshan 6829042f7df1SLai Jiangshan list_for_each_entry_safe(ctx, n, &ctxs, list) { 6830042f7df1SLai Jiangshan if (!ret) 6831042f7df1SLai Jiangshan apply_wqattrs_commit(ctx); 6832042f7df1SLai Jiangshan apply_wqattrs_cleanup(ctx); 6833042f7df1SLai Jiangshan } 6834042f7df1SLai Jiangshan 683599c621efSLai Jiangshan if (!ret) { 683699c621efSLai Jiangshan mutex_lock(&wq_pool_attach_mutex); 683799c621efSLai Jiangshan cpumask_copy(wq_unbound_cpumask, unbound_cpumask); 683899c621efSLai Jiangshan mutex_unlock(&wq_pool_attach_mutex); 683999c621efSLai Jiangshan } 6840042f7df1SLai Jiangshan return ret; 6841042f7df1SLai Jiangshan } 6842042f7df1SLai Jiangshan 6843042f7df1SLai Jiangshan /** 6844fe28f631SWaiman Long * workqueue_unbound_exclude_cpumask - Exclude given CPUs from unbound cpumask 6845fe28f631SWaiman Long * @exclude_cpumask: the cpumask to be excluded from wq_unbound_cpumask 6846fe28f631SWaiman Long * 6847fe28f631SWaiman Long * This function can be called from cpuset code to provide a set of isolated 6848fe28f631SWaiman Long * CPUs that should be excluded from wq_unbound_cpumask. The caller must hold 6849fe28f631SWaiman Long * either cpus_read_lock or cpus_write_lock. 6850fe28f631SWaiman Long */ 6851fe28f631SWaiman Long int workqueue_unbound_exclude_cpumask(cpumask_var_t exclude_cpumask) 6852fe28f631SWaiman Long { 6853fe28f631SWaiman Long cpumask_var_t cpumask; 6854fe28f631SWaiman Long int ret = 0; 6855fe28f631SWaiman Long 6856fe28f631SWaiman Long if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL)) 6857fe28f631SWaiman Long return -ENOMEM; 6858fe28f631SWaiman Long 6859fe28f631SWaiman Long lockdep_assert_cpus_held(); 6860fe28f631SWaiman Long mutex_lock(&wq_pool_mutex); 6861fe28f631SWaiman Long 6862fe28f631SWaiman Long /* 6863fe28f631SWaiman Long * If the operation fails, it will fall back to 6864fe28f631SWaiman Long * wq_requested_unbound_cpumask which is initially set to 6865fe28f631SWaiman Long * (HK_TYPE_WQ ∩ HK_TYPE_DOMAIN) house keeping mask and rewritten 6866fe28f631SWaiman Long * by any subsequent write to workqueue/cpumask sysfs file. 6867fe28f631SWaiman Long */ 6868fe28f631SWaiman Long if (!cpumask_andnot(cpumask, wq_requested_unbound_cpumask, exclude_cpumask)) 6869fe28f631SWaiman Long cpumask_copy(cpumask, wq_requested_unbound_cpumask); 6870fe28f631SWaiman Long if (!cpumask_equal(cpumask, wq_unbound_cpumask)) 6871fe28f631SWaiman Long ret = workqueue_apply_unbound_cpumask(cpumask); 6872fe28f631SWaiman Long 687384165883SLai Jiangshan /* Save the current isolated cpumask & export it via sysfs */ 687484165883SLai Jiangshan if (!ret) 687584165883SLai Jiangshan cpumask_copy(wq_isolated_cpumask, exclude_cpumask); 687684165883SLai Jiangshan 6877fe28f631SWaiman Long mutex_unlock(&wq_pool_mutex); 6878fe28f631SWaiman Long free_cpumask_var(cpumask); 6879fe28f631SWaiman Long return ret; 6880fe28f631SWaiman Long } 6881fe28f631SWaiman Long 688263c5484eSTejun Heo static int parse_affn_scope(const char *val) 688363c5484eSTejun Heo { 688463c5484eSTejun Heo int i; 688563c5484eSTejun Heo 688663c5484eSTejun Heo for (i = 0; i < ARRAY_SIZE(wq_affn_names); i++) { 688763c5484eSTejun Heo if (!strncasecmp(val, wq_affn_names[i], strlen(wq_affn_names[i]))) 688863c5484eSTejun Heo return i; 688963c5484eSTejun Heo } 689063c5484eSTejun Heo return -EINVAL; 689163c5484eSTejun Heo } 689263c5484eSTejun Heo 689363c5484eSTejun Heo static int wq_affn_dfl_set(const char *val, const struct kernel_param *kp) 689463c5484eSTejun Heo { 6895523a301eSTejun Heo struct workqueue_struct *wq; 6896523a301eSTejun Heo int affn, cpu; 689763c5484eSTejun Heo 689863c5484eSTejun Heo affn = parse_affn_scope(val); 689963c5484eSTejun Heo if (affn < 0) 690063c5484eSTejun Heo return affn; 6901523a301eSTejun Heo if (affn == WQ_AFFN_DFL) 6902523a301eSTejun Heo return -EINVAL; 6903523a301eSTejun Heo 6904523a301eSTejun Heo cpus_read_lock(); 6905523a301eSTejun Heo mutex_lock(&wq_pool_mutex); 690663c5484eSTejun Heo 690763c5484eSTejun Heo wq_affn_dfl = affn; 6908523a301eSTejun Heo 6909523a301eSTejun Heo list_for_each_entry(wq, &workqueues, list) { 6910b2b1f933SLai Jiangshan for_each_online_cpu(cpu) 6911b2b1f933SLai Jiangshan unbound_wq_update_pwq(wq, cpu); 6912523a301eSTejun Heo } 6913523a301eSTejun Heo 6914523a301eSTejun Heo mutex_unlock(&wq_pool_mutex); 6915523a301eSTejun Heo cpus_read_unlock(); 6916523a301eSTejun Heo 691763c5484eSTejun Heo return 0; 691863c5484eSTejun Heo } 691963c5484eSTejun Heo 692063c5484eSTejun Heo static int wq_affn_dfl_get(char *buffer, const struct kernel_param *kp) 692163c5484eSTejun Heo { 692263c5484eSTejun Heo return scnprintf(buffer, PAGE_SIZE, "%s\n", wq_affn_names[wq_affn_dfl]); 692363c5484eSTejun Heo } 692463c5484eSTejun Heo 692563c5484eSTejun Heo static const struct kernel_param_ops wq_affn_dfl_ops = { 692663c5484eSTejun Heo .set = wq_affn_dfl_set, 692763c5484eSTejun Heo .get = wq_affn_dfl_get, 692863c5484eSTejun Heo }; 692963c5484eSTejun Heo 693063c5484eSTejun Heo module_param_cb(default_affinity_scope, &wq_affn_dfl_ops, NULL, 0644); 693163c5484eSTejun Heo 69326ba94429SFrederic Weisbecker #ifdef CONFIG_SYSFS 69336ba94429SFrederic Weisbecker /* 69346ba94429SFrederic Weisbecker * Workqueues with WQ_SYSFS flag set is visible to userland via 69356ba94429SFrederic Weisbecker * /sys/bus/workqueue/devices/WQ_NAME. All visible workqueues have the 69366ba94429SFrederic Weisbecker * following attributes. 69376ba94429SFrederic Weisbecker * 69386ba94429SFrederic Weisbecker * per_cpu RO bool : whether the workqueue is per-cpu or unbound 69396ba94429SFrederic Weisbecker * max_active RW int : maximum number of in-flight work items 69406ba94429SFrederic Weisbecker * 69416ba94429SFrederic Weisbecker * Unbound workqueues have the following extra attributes. 69426ba94429SFrederic Weisbecker * 69436ba94429SFrederic Weisbecker * nice RW int : nice value of the workers 69446ba94429SFrederic Weisbecker * cpumask RW mask : bitmask of allowed CPUs for the workers 694563c5484eSTejun Heo * affinity_scope RW str : worker CPU affinity scope (cache, numa, none) 69468639ecebSTejun Heo * affinity_strict RW bool : worker CPU affinity is strict 69476ba94429SFrederic Weisbecker */ 69486ba94429SFrederic Weisbecker struct wq_device { 69496ba94429SFrederic Weisbecker struct workqueue_struct *wq; 69506ba94429SFrederic Weisbecker struct device dev; 69516ba94429SFrederic Weisbecker }; 69526ba94429SFrederic Weisbecker 69536ba94429SFrederic Weisbecker static struct workqueue_struct *dev_to_wq(struct device *dev) 69546ba94429SFrederic Weisbecker { 69556ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 69566ba94429SFrederic Weisbecker 69576ba94429SFrederic Weisbecker return wq_dev->wq; 69586ba94429SFrederic Weisbecker } 69596ba94429SFrederic Weisbecker 69606ba94429SFrederic Weisbecker static ssize_t per_cpu_show(struct device *dev, struct device_attribute *attr, 69616ba94429SFrederic Weisbecker char *buf) 69626ba94429SFrederic Weisbecker { 69636ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 69646ba94429SFrederic Weisbecker 69656ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)!(wq->flags & WQ_UNBOUND)); 69666ba94429SFrederic Weisbecker } 69676ba94429SFrederic Weisbecker static DEVICE_ATTR_RO(per_cpu); 69686ba94429SFrederic Weisbecker 69696ba94429SFrederic Weisbecker static ssize_t max_active_show(struct device *dev, 69706ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 69716ba94429SFrederic Weisbecker { 69726ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 69736ba94429SFrederic Weisbecker 69746ba94429SFrederic Weisbecker return scnprintf(buf, PAGE_SIZE, "%d\n", wq->saved_max_active); 69756ba94429SFrederic Weisbecker } 69766ba94429SFrederic Weisbecker 69776ba94429SFrederic Weisbecker static ssize_t max_active_store(struct device *dev, 69786ba94429SFrederic Weisbecker struct device_attribute *attr, const char *buf, 69796ba94429SFrederic Weisbecker size_t count) 69806ba94429SFrederic Weisbecker { 69816ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 69826ba94429SFrederic Weisbecker int val; 69836ba94429SFrederic Weisbecker 69846ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &val) != 1 || val <= 0) 69856ba94429SFrederic Weisbecker return -EINVAL; 69866ba94429SFrederic Weisbecker 69876ba94429SFrederic Weisbecker workqueue_set_max_active(wq, val); 69886ba94429SFrederic Weisbecker return count; 69896ba94429SFrederic Weisbecker } 69906ba94429SFrederic Weisbecker static DEVICE_ATTR_RW(max_active); 69916ba94429SFrederic Weisbecker 69926ba94429SFrederic Weisbecker static struct attribute *wq_sysfs_attrs[] = { 69936ba94429SFrederic Weisbecker &dev_attr_per_cpu.attr, 69946ba94429SFrederic Weisbecker &dev_attr_max_active.attr, 69956ba94429SFrederic Weisbecker NULL, 69966ba94429SFrederic Weisbecker }; 69976ba94429SFrederic Weisbecker ATTRIBUTE_GROUPS(wq_sysfs); 69986ba94429SFrederic Weisbecker 69996ba94429SFrederic Weisbecker static ssize_t wq_nice_show(struct device *dev, struct device_attribute *attr, 70006ba94429SFrederic Weisbecker char *buf) 70016ba94429SFrederic Weisbecker { 70026ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 70036ba94429SFrederic Weisbecker int written; 70046ba94429SFrederic Weisbecker 70056ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 70066ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%d\n", wq->unbound_attrs->nice); 70076ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 70086ba94429SFrederic Weisbecker 70096ba94429SFrederic Weisbecker return written; 70106ba94429SFrederic Weisbecker } 70116ba94429SFrederic Weisbecker 70126ba94429SFrederic Weisbecker /* prepare workqueue_attrs for sysfs store operations */ 70136ba94429SFrederic Weisbecker static struct workqueue_attrs *wq_sysfs_prep_attrs(struct workqueue_struct *wq) 70146ba94429SFrederic Weisbecker { 70156ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 70166ba94429SFrederic Weisbecker 7017899a94feSLai Jiangshan lockdep_assert_held(&wq_pool_mutex); 7018899a94feSLai Jiangshan 7019be69d00dSThomas Gleixner attrs = alloc_workqueue_attrs(); 70206ba94429SFrederic Weisbecker if (!attrs) 70216ba94429SFrederic Weisbecker return NULL; 70226ba94429SFrederic Weisbecker 70236ba94429SFrederic Weisbecker copy_workqueue_attrs(attrs, wq->unbound_attrs); 70246ba94429SFrederic Weisbecker return attrs; 70256ba94429SFrederic Weisbecker } 70266ba94429SFrederic Weisbecker 70276ba94429SFrederic Weisbecker static ssize_t wq_nice_store(struct device *dev, struct device_attribute *attr, 70286ba94429SFrederic Weisbecker const char *buf, size_t count) 70296ba94429SFrederic Weisbecker { 70306ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 70316ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 7032d4d3e257SLai Jiangshan int ret = -ENOMEM; 7033d4d3e257SLai Jiangshan 7034d4d3e257SLai Jiangshan apply_wqattrs_lock(); 70356ba94429SFrederic Weisbecker 70366ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 70376ba94429SFrederic Weisbecker if (!attrs) 7038d4d3e257SLai Jiangshan goto out_unlock; 70396ba94429SFrederic Weisbecker 70406ba94429SFrederic Weisbecker if (sscanf(buf, "%d", &attrs->nice) == 1 && 70416ba94429SFrederic Weisbecker attrs->nice >= MIN_NICE && attrs->nice <= MAX_NICE) 7042d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 70436ba94429SFrederic Weisbecker else 70446ba94429SFrederic Weisbecker ret = -EINVAL; 70456ba94429SFrederic Weisbecker 7046d4d3e257SLai Jiangshan out_unlock: 7047d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 70486ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 70496ba94429SFrederic Weisbecker return ret ?: count; 70506ba94429SFrederic Weisbecker } 70516ba94429SFrederic Weisbecker 70526ba94429SFrederic Weisbecker static ssize_t wq_cpumask_show(struct device *dev, 70536ba94429SFrederic Weisbecker struct device_attribute *attr, char *buf) 70546ba94429SFrederic Weisbecker { 70556ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 70566ba94429SFrederic Weisbecker int written; 70576ba94429SFrederic Weisbecker 70586ba94429SFrederic Weisbecker mutex_lock(&wq->mutex); 70596ba94429SFrederic Weisbecker written = scnprintf(buf, PAGE_SIZE, "%*pb\n", 70606ba94429SFrederic Weisbecker cpumask_pr_args(wq->unbound_attrs->cpumask)); 70616ba94429SFrederic Weisbecker mutex_unlock(&wq->mutex); 70626ba94429SFrederic Weisbecker return written; 70636ba94429SFrederic Weisbecker } 70646ba94429SFrederic Weisbecker 70656ba94429SFrederic Weisbecker static ssize_t wq_cpumask_store(struct device *dev, 70666ba94429SFrederic Weisbecker struct device_attribute *attr, 70676ba94429SFrederic Weisbecker const char *buf, size_t count) 70686ba94429SFrederic Weisbecker { 70696ba94429SFrederic Weisbecker struct workqueue_struct *wq = dev_to_wq(dev); 70706ba94429SFrederic Weisbecker struct workqueue_attrs *attrs; 7071d4d3e257SLai Jiangshan int ret = -ENOMEM; 7072d4d3e257SLai Jiangshan 7073d4d3e257SLai Jiangshan apply_wqattrs_lock(); 70746ba94429SFrederic Weisbecker 70756ba94429SFrederic Weisbecker attrs = wq_sysfs_prep_attrs(wq); 70766ba94429SFrederic Weisbecker if (!attrs) 7077d4d3e257SLai Jiangshan goto out_unlock; 70786ba94429SFrederic Weisbecker 70796ba94429SFrederic Weisbecker ret = cpumask_parse(buf, attrs->cpumask); 70806ba94429SFrederic Weisbecker if (!ret) 7081d4d3e257SLai Jiangshan ret = apply_workqueue_attrs_locked(wq, attrs); 70826ba94429SFrederic Weisbecker 7083d4d3e257SLai Jiangshan out_unlock: 7084d4d3e257SLai Jiangshan apply_wqattrs_unlock(); 70856ba94429SFrederic Weisbecker free_workqueue_attrs(attrs); 70866ba94429SFrederic Weisbecker return ret ?: count; 70876ba94429SFrederic Weisbecker } 70886ba94429SFrederic Weisbecker 708963c5484eSTejun Heo static ssize_t wq_affn_scope_show(struct device *dev, 709063c5484eSTejun Heo struct device_attribute *attr, char *buf) 709163c5484eSTejun Heo { 709263c5484eSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 709363c5484eSTejun Heo int written; 709463c5484eSTejun Heo 709563c5484eSTejun Heo mutex_lock(&wq->mutex); 7096523a301eSTejun Heo if (wq->unbound_attrs->affn_scope == WQ_AFFN_DFL) 7097523a301eSTejun Heo written = scnprintf(buf, PAGE_SIZE, "%s (%s)\n", 7098523a301eSTejun Heo wq_affn_names[WQ_AFFN_DFL], 7099523a301eSTejun Heo wq_affn_names[wq_affn_dfl]); 7100523a301eSTejun Heo else 710163c5484eSTejun Heo written = scnprintf(buf, PAGE_SIZE, "%s\n", 710263c5484eSTejun Heo wq_affn_names[wq->unbound_attrs->affn_scope]); 710363c5484eSTejun Heo mutex_unlock(&wq->mutex); 710463c5484eSTejun Heo 710563c5484eSTejun Heo return written; 710663c5484eSTejun Heo } 710763c5484eSTejun Heo 710863c5484eSTejun Heo static ssize_t wq_affn_scope_store(struct device *dev, 710963c5484eSTejun Heo struct device_attribute *attr, 711063c5484eSTejun Heo const char *buf, size_t count) 711163c5484eSTejun Heo { 711263c5484eSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 711363c5484eSTejun Heo struct workqueue_attrs *attrs; 711463c5484eSTejun Heo int affn, ret = -ENOMEM; 711563c5484eSTejun Heo 711663c5484eSTejun Heo affn = parse_affn_scope(buf); 711763c5484eSTejun Heo if (affn < 0) 711863c5484eSTejun Heo return affn; 711963c5484eSTejun Heo 712063c5484eSTejun Heo apply_wqattrs_lock(); 712163c5484eSTejun Heo attrs = wq_sysfs_prep_attrs(wq); 712263c5484eSTejun Heo if (attrs) { 712363c5484eSTejun Heo attrs->affn_scope = affn; 712463c5484eSTejun Heo ret = apply_workqueue_attrs_locked(wq, attrs); 712563c5484eSTejun Heo } 712663c5484eSTejun Heo apply_wqattrs_unlock(); 712763c5484eSTejun Heo free_workqueue_attrs(attrs); 712863c5484eSTejun Heo return ret ?: count; 712963c5484eSTejun Heo } 713063c5484eSTejun Heo 71318639ecebSTejun Heo static ssize_t wq_affinity_strict_show(struct device *dev, 71328639ecebSTejun Heo struct device_attribute *attr, char *buf) 71338639ecebSTejun Heo { 71348639ecebSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 71358639ecebSTejun Heo 71368639ecebSTejun Heo return scnprintf(buf, PAGE_SIZE, "%d\n", 71378639ecebSTejun Heo wq->unbound_attrs->affn_strict); 71388639ecebSTejun Heo } 71398639ecebSTejun Heo 71408639ecebSTejun Heo static ssize_t wq_affinity_strict_store(struct device *dev, 71418639ecebSTejun Heo struct device_attribute *attr, 71428639ecebSTejun Heo const char *buf, size_t count) 71438639ecebSTejun Heo { 71448639ecebSTejun Heo struct workqueue_struct *wq = dev_to_wq(dev); 71458639ecebSTejun Heo struct workqueue_attrs *attrs; 71468639ecebSTejun Heo int v, ret = -ENOMEM; 71478639ecebSTejun Heo 71488639ecebSTejun Heo if (sscanf(buf, "%d", &v) != 1) 71498639ecebSTejun Heo return -EINVAL; 71508639ecebSTejun Heo 71518639ecebSTejun Heo apply_wqattrs_lock(); 71528639ecebSTejun Heo attrs = wq_sysfs_prep_attrs(wq); 71538639ecebSTejun Heo if (attrs) { 71548639ecebSTejun Heo attrs->affn_strict = (bool)v; 71558639ecebSTejun Heo ret = apply_workqueue_attrs_locked(wq, attrs); 71568639ecebSTejun Heo } 71578639ecebSTejun Heo apply_wqattrs_unlock(); 71588639ecebSTejun Heo free_workqueue_attrs(attrs); 71598639ecebSTejun Heo return ret ?: count; 71608639ecebSTejun Heo } 71618639ecebSTejun Heo 71626ba94429SFrederic Weisbecker static struct device_attribute wq_sysfs_unbound_attrs[] = { 71636ba94429SFrederic Weisbecker __ATTR(nice, 0644, wq_nice_show, wq_nice_store), 71646ba94429SFrederic Weisbecker __ATTR(cpumask, 0644, wq_cpumask_show, wq_cpumask_store), 716563c5484eSTejun Heo __ATTR(affinity_scope, 0644, wq_affn_scope_show, wq_affn_scope_store), 71668639ecebSTejun Heo __ATTR(affinity_strict, 0644, wq_affinity_strict_show, wq_affinity_strict_store), 71676ba94429SFrederic Weisbecker __ATTR_NULL, 71686ba94429SFrederic Weisbecker }; 71696ba94429SFrederic Weisbecker 71705df9197eSRicardo B. Marliere static const struct bus_type wq_subsys = { 71716ba94429SFrederic Weisbecker .name = "workqueue", 71726ba94429SFrederic Weisbecker .dev_groups = wq_sysfs_groups, 71736ba94429SFrederic Weisbecker }; 71746ba94429SFrederic Weisbecker 717549277a5bSWaiman Long /** 717649277a5bSWaiman Long * workqueue_set_unbound_cpumask - Set the low-level unbound cpumask 717749277a5bSWaiman Long * @cpumask: the cpumask to set 717849277a5bSWaiman Long * 717949277a5bSWaiman Long * The low-level workqueues cpumask is a global cpumask that limits 718049277a5bSWaiman Long * the affinity of all unbound workqueues. This function check the @cpumask 718149277a5bSWaiman Long * and apply it to all unbound workqueues and updates all pwqs of them. 718249277a5bSWaiman Long * 718349277a5bSWaiman Long * Return: 0 - Success 718449277a5bSWaiman Long * -EINVAL - Invalid @cpumask 718549277a5bSWaiman Long * -ENOMEM - Failed to allocate memory for attrs or pwqs. 718649277a5bSWaiman Long */ 718749277a5bSWaiman Long static int workqueue_set_unbound_cpumask(cpumask_var_t cpumask) 718849277a5bSWaiman Long { 718949277a5bSWaiman Long int ret = -EINVAL; 719049277a5bSWaiman Long 719149277a5bSWaiman Long /* 719249277a5bSWaiman Long * Not excluding isolated cpus on purpose. 719349277a5bSWaiman Long * If the user wishes to include them, we allow that. 719449277a5bSWaiman Long */ 719549277a5bSWaiman Long cpumask_and(cpumask, cpumask, cpu_possible_mask); 719649277a5bSWaiman Long if (!cpumask_empty(cpumask)) { 719749277a5bSWaiman Long ret = 0; 7198b3d20916SLai Jiangshan apply_wqattrs_lock(); 7199b3d20916SLai Jiangshan if (!cpumask_equal(cpumask, wq_unbound_cpumask)) 720049277a5bSWaiman Long ret = workqueue_apply_unbound_cpumask(cpumask); 720184165883SLai Jiangshan if (!ret) 720284165883SLai Jiangshan cpumask_copy(wq_requested_unbound_cpumask, cpumask); 720349277a5bSWaiman Long apply_wqattrs_unlock(); 720449277a5bSWaiman Long } 720549277a5bSWaiman Long 720649277a5bSWaiman Long return ret; 720749277a5bSWaiman Long } 720849277a5bSWaiman Long 7209fe28f631SWaiman Long static ssize_t __wq_cpumask_show(struct device *dev, 7210fe28f631SWaiman Long struct device_attribute *attr, char *buf, cpumask_var_t mask) 7211b05a7928SFrederic Weisbecker { 7212b05a7928SFrederic Weisbecker int written; 7213b05a7928SFrederic Weisbecker 7214042f7df1SLai Jiangshan mutex_lock(&wq_pool_mutex); 7215fe28f631SWaiman Long written = scnprintf(buf, PAGE_SIZE, "%*pb\n", cpumask_pr_args(mask)); 7216042f7df1SLai Jiangshan mutex_unlock(&wq_pool_mutex); 7217b05a7928SFrederic Weisbecker 7218b05a7928SFrederic Weisbecker return written; 7219b05a7928SFrederic Weisbecker } 7220b05a7928SFrederic Weisbecker 722179202591SDan Williams static ssize_t cpumask_requested_show(struct device *dev, 722279202591SDan Williams struct device_attribute *attr, char *buf) 722379202591SDan Williams { 722479202591SDan Williams return __wq_cpumask_show(dev, attr, buf, wq_requested_unbound_cpumask); 722579202591SDan Williams } 722679202591SDan Williams static DEVICE_ATTR_RO(cpumask_requested); 722779202591SDan Williams 722879202591SDan Williams static ssize_t cpumask_isolated_show(struct device *dev, 722979202591SDan Williams struct device_attribute *attr, char *buf) 723079202591SDan Williams { 723179202591SDan Williams return __wq_cpumask_show(dev, attr, buf, wq_isolated_cpumask); 723279202591SDan Williams } 723379202591SDan Williams static DEVICE_ATTR_RO(cpumask_isolated); 723479202591SDan Williams 723579202591SDan Williams static ssize_t cpumask_show(struct device *dev, 7236fe28f631SWaiman Long struct device_attribute *attr, char *buf) 7237fe28f631SWaiman Long { 7238fe28f631SWaiman Long return __wq_cpumask_show(dev, attr, buf, wq_unbound_cpumask); 7239fe28f631SWaiman Long } 7240fe28f631SWaiman Long 724179202591SDan Williams static ssize_t cpumask_store(struct device *dev, 7242042f7df1SLai Jiangshan struct device_attribute *attr, const char *buf, size_t count) 7243042f7df1SLai Jiangshan { 7244042f7df1SLai Jiangshan cpumask_var_t cpumask; 7245042f7df1SLai Jiangshan int ret; 7246042f7df1SLai Jiangshan 7247042f7df1SLai Jiangshan if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL)) 7248042f7df1SLai Jiangshan return -ENOMEM; 7249042f7df1SLai Jiangshan 7250042f7df1SLai Jiangshan ret = cpumask_parse(buf, cpumask); 7251042f7df1SLai Jiangshan if (!ret) 7252042f7df1SLai Jiangshan ret = workqueue_set_unbound_cpumask(cpumask); 7253042f7df1SLai Jiangshan 7254042f7df1SLai Jiangshan free_cpumask_var(cpumask); 7255042f7df1SLai Jiangshan return ret ? ret : count; 7256042f7df1SLai Jiangshan } 725779202591SDan Williams static DEVICE_ATTR_RW(cpumask); 7258042f7df1SLai Jiangshan 725979202591SDan Williams static struct attribute *wq_sysfs_cpumask_attrs[] = { 726079202591SDan Williams &dev_attr_cpumask.attr, 726179202591SDan Williams &dev_attr_cpumask_requested.attr, 726279202591SDan Williams &dev_attr_cpumask_isolated.attr, 726379202591SDan Williams NULL, 7264fe28f631SWaiman Long }; 726579202591SDan Williams ATTRIBUTE_GROUPS(wq_sysfs_cpumask); 7266b05a7928SFrederic Weisbecker 72676ba94429SFrederic Weisbecker static int __init wq_sysfs_init(void) 72686ba94429SFrederic Weisbecker { 726979202591SDan Williams return subsys_virtual_register(&wq_subsys, wq_sysfs_cpumask_groups); 72706ba94429SFrederic Weisbecker } 72716ba94429SFrederic Weisbecker core_initcall(wq_sysfs_init); 72726ba94429SFrederic Weisbecker 72736ba94429SFrederic Weisbecker static void wq_device_release(struct device *dev) 72746ba94429SFrederic Weisbecker { 72756ba94429SFrederic Weisbecker struct wq_device *wq_dev = container_of(dev, struct wq_device, dev); 72766ba94429SFrederic Weisbecker 72776ba94429SFrederic Weisbecker kfree(wq_dev); 72786ba94429SFrederic Weisbecker } 72796ba94429SFrederic Weisbecker 72806ba94429SFrederic Weisbecker /** 72816ba94429SFrederic Weisbecker * workqueue_sysfs_register - make a workqueue visible in sysfs 72826ba94429SFrederic Weisbecker * @wq: the workqueue to register 72836ba94429SFrederic Weisbecker * 72846ba94429SFrederic Weisbecker * Expose @wq in sysfs under /sys/bus/workqueue/devices. 72856ba94429SFrederic Weisbecker * alloc_workqueue*() automatically calls this function if WQ_SYSFS is set 72866ba94429SFrederic Weisbecker * which is the preferred method. 72876ba94429SFrederic Weisbecker * 72886ba94429SFrederic Weisbecker * Workqueue user should use this function directly iff it wants to apply 72896ba94429SFrederic Weisbecker * workqueue_attrs before making the workqueue visible in sysfs; otherwise, 72906ba94429SFrederic Weisbecker * apply_workqueue_attrs() may race against userland updating the 72916ba94429SFrederic Weisbecker * attributes. 72926ba94429SFrederic Weisbecker * 72936ba94429SFrederic Weisbecker * Return: 0 on success, -errno on failure. 72946ba94429SFrederic Weisbecker */ 72956ba94429SFrederic Weisbecker int workqueue_sysfs_register(struct workqueue_struct *wq) 72966ba94429SFrederic Weisbecker { 72976ba94429SFrederic Weisbecker struct wq_device *wq_dev; 72986ba94429SFrederic Weisbecker int ret; 72996ba94429SFrederic Weisbecker 73006ba94429SFrederic Weisbecker /* 73014c065dbcSWaiman Long * Adjusting max_active breaks ordering guarantee. Disallow exposing 73024c065dbcSWaiman Long * ordered workqueues. 73036ba94429SFrederic Weisbecker */ 73043bc1e711STejun Heo if (WARN_ON(wq->flags & __WQ_ORDERED)) 73056ba94429SFrederic Weisbecker return -EINVAL; 73066ba94429SFrederic Weisbecker 73076ba94429SFrederic Weisbecker wq->wq_dev = wq_dev = kzalloc(sizeof(*wq_dev), GFP_KERNEL); 73086ba94429SFrederic Weisbecker if (!wq_dev) 73096ba94429SFrederic Weisbecker return -ENOMEM; 73106ba94429SFrederic Weisbecker 73116ba94429SFrederic Weisbecker wq_dev->wq = wq; 73126ba94429SFrederic Weisbecker wq_dev->dev.bus = &wq_subsys; 73136ba94429SFrederic Weisbecker wq_dev->dev.release = wq_device_release; 731423217b44SLars-Peter Clausen dev_set_name(&wq_dev->dev, "%s", wq->name); 73156ba94429SFrederic Weisbecker 73166ba94429SFrederic Weisbecker /* 73176ba94429SFrederic Weisbecker * unbound_attrs are created separately. Suppress uevent until 73186ba94429SFrederic Weisbecker * everything is ready. 73196ba94429SFrederic Weisbecker */ 73206ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, true); 73216ba94429SFrederic Weisbecker 73226ba94429SFrederic Weisbecker ret = device_register(&wq_dev->dev); 73236ba94429SFrederic Weisbecker if (ret) { 7324537f4146SArvind Yadav put_device(&wq_dev->dev); 73256ba94429SFrederic Weisbecker wq->wq_dev = NULL; 73266ba94429SFrederic Weisbecker return ret; 73276ba94429SFrederic Weisbecker } 73286ba94429SFrederic Weisbecker 73296ba94429SFrederic Weisbecker if (wq->flags & WQ_UNBOUND) { 73306ba94429SFrederic Weisbecker struct device_attribute *attr; 73316ba94429SFrederic Weisbecker 73326ba94429SFrederic Weisbecker for (attr = wq_sysfs_unbound_attrs; attr->attr.name; attr++) { 73336ba94429SFrederic Weisbecker ret = device_create_file(&wq_dev->dev, attr); 73346ba94429SFrederic Weisbecker if (ret) { 73356ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 73366ba94429SFrederic Weisbecker wq->wq_dev = NULL; 73376ba94429SFrederic Weisbecker return ret; 73386ba94429SFrederic Weisbecker } 73396ba94429SFrederic Weisbecker } 73406ba94429SFrederic Weisbecker } 73416ba94429SFrederic Weisbecker 73426ba94429SFrederic Weisbecker dev_set_uevent_suppress(&wq_dev->dev, false); 73436ba94429SFrederic Weisbecker kobject_uevent(&wq_dev->dev.kobj, KOBJ_ADD); 73446ba94429SFrederic Weisbecker return 0; 73456ba94429SFrederic Weisbecker } 73466ba94429SFrederic Weisbecker 73476ba94429SFrederic Weisbecker /** 73486ba94429SFrederic Weisbecker * workqueue_sysfs_unregister - undo workqueue_sysfs_register() 73496ba94429SFrederic Weisbecker * @wq: the workqueue to unregister 73506ba94429SFrederic Weisbecker * 73516ba94429SFrederic Weisbecker * If @wq is registered to sysfs by workqueue_sysfs_register(), unregister. 73526ba94429SFrederic Weisbecker */ 73536ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) 73546ba94429SFrederic Weisbecker { 73556ba94429SFrederic Weisbecker struct wq_device *wq_dev = wq->wq_dev; 73566ba94429SFrederic Weisbecker 73576ba94429SFrederic Weisbecker if (!wq->wq_dev) 73586ba94429SFrederic Weisbecker return; 73596ba94429SFrederic Weisbecker 73606ba94429SFrederic Weisbecker wq->wq_dev = NULL; 73616ba94429SFrederic Weisbecker device_unregister(&wq_dev->dev); 73626ba94429SFrederic Weisbecker } 73636ba94429SFrederic Weisbecker #else /* CONFIG_SYSFS */ 73646ba94429SFrederic Weisbecker static void workqueue_sysfs_unregister(struct workqueue_struct *wq) { } 73656ba94429SFrederic Weisbecker #endif /* CONFIG_SYSFS */ 73666ba94429SFrederic Weisbecker 736782607adcSTejun Heo /* 736882607adcSTejun Heo * Workqueue watchdog. 736982607adcSTejun Heo * 737082607adcSTejun Heo * Stall may be caused by various bugs - missing WQ_MEM_RECLAIM, illegal 737182607adcSTejun Heo * flush dependency, a concurrency managed work item which stays RUNNING 737282607adcSTejun Heo * indefinitely. Workqueue stalls can be very difficult to debug as the 737382607adcSTejun Heo * usual warning mechanisms don't trigger and internal workqueue state is 737482607adcSTejun Heo * largely opaque. 737582607adcSTejun Heo * 737682607adcSTejun Heo * Workqueue watchdog monitors all worker pools periodically and dumps 737782607adcSTejun Heo * state if some pools failed to make forward progress for a while where 737882607adcSTejun Heo * forward progress is defined as the first item on ->worklist changing. 737982607adcSTejun Heo * 738082607adcSTejun Heo * This mechanism is controlled through the kernel parameter 738182607adcSTejun Heo * "workqueue.watchdog_thresh" which can be updated at runtime through the 738282607adcSTejun Heo * corresponding sysfs parameter file. 738382607adcSTejun Heo */ 738482607adcSTejun Heo #ifdef CONFIG_WQ_WATCHDOG 738582607adcSTejun Heo 738682607adcSTejun Heo static unsigned long wq_watchdog_thresh = 30; 73875cd79d6aSKees Cook static struct timer_list wq_watchdog_timer; 738882607adcSTejun Heo 738982607adcSTejun Heo static unsigned long wq_watchdog_touched = INITIAL_JIFFIES; 739082607adcSTejun Heo static DEFINE_PER_CPU(unsigned long, wq_watchdog_touched_cpu) = INITIAL_JIFFIES; 739182607adcSTejun Heo 7392cd2440d6SPetr Mladek /* 7393cd2440d6SPetr Mladek * Show workers that might prevent the processing of pending work items. 7394cd2440d6SPetr Mladek * The only candidates are CPU-bound workers in the running state. 7395cd2440d6SPetr Mladek * Pending work items should be handled by another idle worker 7396cd2440d6SPetr Mladek * in all other situations. 7397cd2440d6SPetr Mladek */ 7398cd2440d6SPetr Mladek static void show_cpu_pool_hog(struct worker_pool *pool) 7399cd2440d6SPetr Mladek { 7400cd2440d6SPetr Mladek struct worker *worker; 7401c26e2f2eSTejun Heo unsigned long irq_flags; 7402cd2440d6SPetr Mladek int bkt; 7403cd2440d6SPetr Mladek 7404c26e2f2eSTejun Heo raw_spin_lock_irqsave(&pool->lock, irq_flags); 7405cd2440d6SPetr Mladek 7406cd2440d6SPetr Mladek hash_for_each(pool->busy_hash, bkt, worker, hentry) { 7407cd2440d6SPetr Mladek if (task_is_running(worker->task)) { 7408cd2440d6SPetr Mladek /* 7409cd2440d6SPetr Mladek * Defer printing to avoid deadlocks in console 7410cd2440d6SPetr Mladek * drivers that queue work while holding locks 7411cd2440d6SPetr Mladek * also taken in their write paths. 7412cd2440d6SPetr Mladek */ 7413cd2440d6SPetr Mladek printk_deferred_enter(); 7414cd2440d6SPetr Mladek 7415cd2440d6SPetr Mladek pr_info("pool %d:\n", pool->id); 7416cd2440d6SPetr Mladek sched_show_task(worker->task); 7417cd2440d6SPetr Mladek 7418cd2440d6SPetr Mladek printk_deferred_exit(); 7419cd2440d6SPetr Mladek } 7420cd2440d6SPetr Mladek } 7421cd2440d6SPetr Mladek 7422c26e2f2eSTejun Heo raw_spin_unlock_irqrestore(&pool->lock, irq_flags); 7423cd2440d6SPetr Mladek } 7424cd2440d6SPetr Mladek 7425cd2440d6SPetr Mladek static void show_cpu_pools_hogs(void) 7426cd2440d6SPetr Mladek { 7427cd2440d6SPetr Mladek struct worker_pool *pool; 7428cd2440d6SPetr Mladek int pi; 7429cd2440d6SPetr Mladek 7430cd2440d6SPetr Mladek pr_info("Showing backtraces of running workers in stalled CPU-bound worker pools:\n"); 7431cd2440d6SPetr Mladek 7432cd2440d6SPetr Mladek rcu_read_lock(); 7433cd2440d6SPetr Mladek 7434cd2440d6SPetr Mladek for_each_pool(pool, pi) { 7435cd2440d6SPetr Mladek if (pool->cpu_stall) 7436cd2440d6SPetr Mladek show_cpu_pool_hog(pool); 7437cd2440d6SPetr Mladek 7438cd2440d6SPetr Mladek } 7439cd2440d6SPetr Mladek 7440cd2440d6SPetr Mladek rcu_read_unlock(); 7441cd2440d6SPetr Mladek } 7442cd2440d6SPetr Mladek 744382607adcSTejun Heo static void wq_watchdog_reset_touched(void) 744482607adcSTejun Heo { 744582607adcSTejun Heo int cpu; 744682607adcSTejun Heo 744782607adcSTejun Heo wq_watchdog_touched = jiffies; 744882607adcSTejun Heo for_each_possible_cpu(cpu) 744982607adcSTejun Heo per_cpu(wq_watchdog_touched_cpu, cpu) = jiffies; 745082607adcSTejun Heo } 745182607adcSTejun Heo 74525cd79d6aSKees Cook static void wq_watchdog_timer_fn(struct timer_list *unused) 745382607adcSTejun Heo { 745482607adcSTejun Heo unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ; 745582607adcSTejun Heo bool lockup_detected = false; 7456cd2440d6SPetr Mladek bool cpu_pool_stall = false; 7457940d71c6SSergey Senozhatsky unsigned long now = jiffies; 745882607adcSTejun Heo struct worker_pool *pool; 745982607adcSTejun Heo int pi; 746082607adcSTejun Heo 746182607adcSTejun Heo if (!thresh) 746282607adcSTejun Heo return; 746382607adcSTejun Heo 746482607adcSTejun Heo rcu_read_lock(); 746582607adcSTejun Heo 746682607adcSTejun Heo for_each_pool(pool, pi) { 746782607adcSTejun Heo unsigned long pool_ts, touched, ts; 746882607adcSTejun Heo 7469cd2440d6SPetr Mladek pool->cpu_stall = false; 747082607adcSTejun Heo if (list_empty(&pool->worklist)) 747182607adcSTejun Heo continue; 747282607adcSTejun Heo 7473940d71c6SSergey Senozhatsky /* 7474940d71c6SSergey Senozhatsky * If a virtual machine is stopped by the host it can look to 7475940d71c6SSergey Senozhatsky * the watchdog like a stall. 7476940d71c6SSergey Senozhatsky */ 7477940d71c6SSergey Senozhatsky kvm_check_and_clear_guest_paused(); 7478940d71c6SSergey Senozhatsky 747982607adcSTejun Heo /* get the latest of pool and touched timestamps */ 748089e28ce6SWang Qing if (pool->cpu >= 0) 748189e28ce6SWang Qing touched = READ_ONCE(per_cpu(wq_watchdog_touched_cpu, pool->cpu)); 748289e28ce6SWang Qing else 748382607adcSTejun Heo touched = READ_ONCE(wq_watchdog_touched); 748489e28ce6SWang Qing pool_ts = READ_ONCE(pool->watchdog_ts); 748582607adcSTejun Heo 748682607adcSTejun Heo if (time_after(pool_ts, touched)) 748782607adcSTejun Heo ts = pool_ts; 748882607adcSTejun Heo else 748982607adcSTejun Heo ts = touched; 749082607adcSTejun Heo 749182607adcSTejun Heo /* did we stall? */ 7492940d71c6SSergey Senozhatsky if (time_after(now, ts + thresh)) { 749382607adcSTejun Heo lockup_detected = true; 74944cb1ef64STejun Heo if (pool->cpu >= 0 && !(pool->flags & POOL_BH)) { 7495cd2440d6SPetr Mladek pool->cpu_stall = true; 7496cd2440d6SPetr Mladek cpu_pool_stall = true; 7497cd2440d6SPetr Mladek } 749882607adcSTejun Heo pr_emerg("BUG: workqueue lockup - pool"); 749982607adcSTejun Heo pr_cont_pool_info(pool); 750082607adcSTejun Heo pr_cont(" stuck for %us!\n", 7501940d71c6SSergey Senozhatsky jiffies_to_msecs(now - pool_ts) / 1000); 750282607adcSTejun Heo } 7503cd2440d6SPetr Mladek 7504cd2440d6SPetr Mladek 750582607adcSTejun Heo } 750682607adcSTejun Heo 750782607adcSTejun Heo rcu_read_unlock(); 750882607adcSTejun Heo 750982607adcSTejun Heo if (lockup_detected) 751055df0933SImran Khan show_all_workqueues(); 751182607adcSTejun Heo 7512cd2440d6SPetr Mladek if (cpu_pool_stall) 7513cd2440d6SPetr Mladek show_cpu_pools_hogs(); 7514cd2440d6SPetr Mladek 751582607adcSTejun Heo wq_watchdog_reset_touched(); 751682607adcSTejun Heo mod_timer(&wq_watchdog_timer, jiffies + thresh); 751782607adcSTejun Heo } 751882607adcSTejun Heo 7519cb9d7fd5SVincent Whitchurch notrace void wq_watchdog_touch(int cpu) 752082607adcSTejun Heo { 752198f887f8SNicholas Piggin unsigned long thresh = READ_ONCE(wq_watchdog_thresh) * HZ; 752298f887f8SNicholas Piggin unsigned long touch_ts = READ_ONCE(wq_watchdog_touched); 752398f887f8SNicholas Piggin unsigned long now = jiffies; 752498f887f8SNicholas Piggin 752582607adcSTejun Heo if (cpu >= 0) 752698f887f8SNicholas Piggin per_cpu(wq_watchdog_touched_cpu, cpu) = now; 752718e24debSNicholas Piggin else 752818e24debSNicholas Piggin WARN_ONCE(1, "%s should be called with valid CPU", __func__); 752989e28ce6SWang Qing 753098f887f8SNicholas Piggin /* Don't unnecessarily store to global cacheline */ 753198f887f8SNicholas Piggin if (time_after(now, touch_ts + thresh / 4)) 753298f887f8SNicholas Piggin WRITE_ONCE(wq_watchdog_touched, jiffies); 753382607adcSTejun Heo } 753482607adcSTejun Heo 753582607adcSTejun Heo static void wq_watchdog_set_thresh(unsigned long thresh) 753682607adcSTejun Heo { 753782607adcSTejun Heo wq_watchdog_thresh = 0; 753882607adcSTejun Heo del_timer_sync(&wq_watchdog_timer); 753982607adcSTejun Heo 754082607adcSTejun Heo if (thresh) { 754182607adcSTejun Heo wq_watchdog_thresh = thresh; 754282607adcSTejun Heo wq_watchdog_reset_touched(); 754382607adcSTejun Heo mod_timer(&wq_watchdog_timer, jiffies + thresh * HZ); 754482607adcSTejun Heo } 754582607adcSTejun Heo } 754682607adcSTejun Heo 754782607adcSTejun Heo static int wq_watchdog_param_set_thresh(const char *val, 754882607adcSTejun Heo const struct kernel_param *kp) 754982607adcSTejun Heo { 755082607adcSTejun Heo unsigned long thresh; 755182607adcSTejun Heo int ret; 755282607adcSTejun Heo 755382607adcSTejun Heo ret = kstrtoul(val, 0, &thresh); 755482607adcSTejun Heo if (ret) 755582607adcSTejun Heo return ret; 755682607adcSTejun Heo 755782607adcSTejun Heo if (system_wq) 755882607adcSTejun Heo wq_watchdog_set_thresh(thresh); 755982607adcSTejun Heo else 756082607adcSTejun Heo wq_watchdog_thresh = thresh; 756182607adcSTejun Heo 756282607adcSTejun Heo return 0; 756382607adcSTejun Heo } 756482607adcSTejun Heo 756582607adcSTejun Heo static const struct kernel_param_ops wq_watchdog_thresh_ops = { 756682607adcSTejun Heo .set = wq_watchdog_param_set_thresh, 756782607adcSTejun Heo .get = param_get_ulong, 756882607adcSTejun Heo }; 756982607adcSTejun Heo 757082607adcSTejun Heo module_param_cb(watchdog_thresh, &wq_watchdog_thresh_ops, &wq_watchdog_thresh, 757182607adcSTejun Heo 0644); 757282607adcSTejun Heo 757382607adcSTejun Heo static void wq_watchdog_init(void) 757482607adcSTejun Heo { 75755cd79d6aSKees Cook timer_setup(&wq_watchdog_timer, wq_watchdog_timer_fn, TIMER_DEFERRABLE); 757682607adcSTejun Heo wq_watchdog_set_thresh(wq_watchdog_thresh); 757782607adcSTejun Heo } 757882607adcSTejun Heo 757982607adcSTejun Heo #else /* CONFIG_WQ_WATCHDOG */ 758082607adcSTejun Heo 758182607adcSTejun Heo static inline void wq_watchdog_init(void) { } 758282607adcSTejun Heo 758382607adcSTejun Heo #endif /* CONFIG_WQ_WATCHDOG */ 758482607adcSTejun Heo 75852f34d733STejun Heo static void bh_pool_kick_normal(struct irq_work *irq_work) 75862f34d733STejun Heo { 75872f34d733STejun Heo raise_softirq_irqoff(TASKLET_SOFTIRQ); 75882f34d733STejun Heo } 75892f34d733STejun Heo 75902f34d733STejun Heo static void bh_pool_kick_highpri(struct irq_work *irq_work) 75912f34d733STejun Heo { 75922f34d733STejun Heo raise_softirq_irqoff(HI_SOFTIRQ); 75932f34d733STejun Heo } 75942f34d733STejun Heo 75954a6c5607STejun Heo static void __init restrict_unbound_cpumask(const char *name, const struct cpumask *mask) 75964a6c5607STejun Heo { 75974a6c5607STejun Heo if (!cpumask_intersects(wq_unbound_cpumask, mask)) { 75984a6c5607STejun Heo pr_warn("workqueue: Restricting unbound_cpumask (%*pb) with %s (%*pb) leaves no CPU, ignoring\n", 75994a6c5607STejun Heo cpumask_pr_args(wq_unbound_cpumask), name, cpumask_pr_args(mask)); 76004a6c5607STejun Heo return; 76014a6c5607STejun Heo } 76024a6c5607STejun Heo 76034a6c5607STejun Heo cpumask_and(wq_unbound_cpumask, wq_unbound_cpumask, mask); 76044a6c5607STejun Heo } 76054a6c5607STejun Heo 76062fcdb1b4STejun Heo static void __init init_cpu_worker_pool(struct worker_pool *pool, int cpu, int nice) 76072fcdb1b4STejun Heo { 76082fcdb1b4STejun Heo BUG_ON(init_worker_pool(pool)); 76092fcdb1b4STejun Heo pool->cpu = cpu; 76102fcdb1b4STejun Heo cpumask_copy(pool->attrs->cpumask, cpumask_of(cpu)); 76112fcdb1b4STejun Heo cpumask_copy(pool->attrs->__pod_cpumask, cpumask_of(cpu)); 76122fcdb1b4STejun Heo pool->attrs->nice = nice; 76132fcdb1b4STejun Heo pool->attrs->affn_strict = true; 76142fcdb1b4STejun Heo pool->node = cpu_to_node(cpu); 76152fcdb1b4STejun Heo 76162fcdb1b4STejun Heo /* alloc pool ID */ 76172fcdb1b4STejun Heo mutex_lock(&wq_pool_mutex); 76182fcdb1b4STejun Heo BUG_ON(worker_pool_assign_id(pool)); 76192fcdb1b4STejun Heo mutex_unlock(&wq_pool_mutex); 76202fcdb1b4STejun Heo } 76212fcdb1b4STejun Heo 76223347fa09STejun Heo /** 76233347fa09STejun Heo * workqueue_init_early - early init for workqueue subsystem 76243347fa09STejun Heo * 76252930155bSTejun Heo * This is the first step of three-staged workqueue subsystem initialization and 76262930155bSTejun Heo * invoked as soon as the bare basics - memory allocation, cpumasks and idr are 76272930155bSTejun Heo * up. It sets up all the data structures and system workqueues and allows early 76282930155bSTejun Heo * boot code to create workqueues and queue/cancel work items. Actual work item 76292930155bSTejun Heo * execution starts only after kthreads can be created and scheduled right 76302930155bSTejun Heo * before early initcalls. 76313347fa09STejun Heo */ 76322333e829SYu Chen void __init workqueue_init_early(void) 76331da177e4SLinus Torvalds { 763484193c07STejun Heo struct wq_pod_type *pt = &wq_pod_types[WQ_AFFN_SYSTEM]; 76357a4e344cSTejun Heo int std_nice[NR_STD_WORKER_POOLS] = { 0, HIGHPRI_NICE_LEVEL }; 76362f34d733STejun Heo void (*irq_work_fns[2])(struct irq_work *) = { bh_pool_kick_normal, 76372f34d733STejun Heo bh_pool_kick_highpri }; 76387a4e344cSTejun Heo int i, cpu; 7639c34056a3STejun Heo 764010cdb157SLai Jiangshan BUILD_BUG_ON(__alignof__(struct pool_workqueue) < __alignof__(long long)); 7641e904e6c2STejun Heo 76428d84baf7SLai Jiangshan BUG_ON(!alloc_cpumask_var(&wq_online_cpumask, GFP_KERNEL)); 7643b05a7928SFrederic Weisbecker BUG_ON(!alloc_cpumask_var(&wq_unbound_cpumask, GFP_KERNEL)); 7644fe28f631SWaiman Long BUG_ON(!alloc_cpumask_var(&wq_requested_unbound_cpumask, GFP_KERNEL)); 7645fe28f631SWaiman Long BUG_ON(!zalloc_cpumask_var(&wq_isolated_cpumask, GFP_KERNEL)); 7646b05a7928SFrederic Weisbecker 76478d84baf7SLai Jiangshan cpumask_copy(wq_online_cpumask, cpu_online_mask); 76484a6c5607STejun Heo cpumask_copy(wq_unbound_cpumask, cpu_possible_mask); 76494a6c5607STejun Heo restrict_unbound_cpumask("HK_TYPE_WQ", housekeeping_cpumask(HK_TYPE_WQ)); 76504a6c5607STejun Heo restrict_unbound_cpumask("HK_TYPE_DOMAIN", housekeeping_cpumask(HK_TYPE_DOMAIN)); 7651ace3c549Stiozhang if (!cpumask_empty(&wq_cmdline_cpumask)) 76524a6c5607STejun Heo restrict_unbound_cpumask("workqueue.unbound_cpus", &wq_cmdline_cpumask); 7653ace3c549Stiozhang 7654fe28f631SWaiman Long cpumask_copy(wq_requested_unbound_cpumask, wq_unbound_cpumask); 76558b03ae3cSTejun Heo 76568b03ae3cSTejun Heo pwq_cache = KMEM_CACHE(pool_workqueue, SLAB_PANIC); 7657e22bee78STejun Heo 7658b2b1f933SLai Jiangshan unbound_wq_update_pwq_attrs_buf = alloc_workqueue_attrs(); 7659b2b1f933SLai Jiangshan BUG_ON(!unbound_wq_update_pwq_attrs_buf); 76602930155bSTejun Heo 76617bd20b6bSMarcelo Tosatti /* 76627bd20b6bSMarcelo Tosatti * If nohz_full is enabled, set power efficient workqueue as unbound. 76637bd20b6bSMarcelo Tosatti * This allows workqueue items to be moved to HK CPUs. 76647bd20b6bSMarcelo Tosatti */ 76657bd20b6bSMarcelo Tosatti if (housekeeping_enabled(HK_TYPE_TICK)) 76667bd20b6bSMarcelo Tosatti wq_power_efficient = true; 76677bd20b6bSMarcelo Tosatti 766884193c07STejun Heo /* initialize WQ_AFFN_SYSTEM pods */ 766984193c07STejun Heo pt->pod_cpus = kcalloc(1, sizeof(pt->pod_cpus[0]), GFP_KERNEL); 767084193c07STejun Heo pt->pod_node = kcalloc(1, sizeof(pt->pod_node[0]), GFP_KERNEL); 767184193c07STejun Heo pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL); 767284193c07STejun Heo BUG_ON(!pt->pod_cpus || !pt->pod_node || !pt->cpu_pod); 767384193c07STejun Heo 767484193c07STejun Heo BUG_ON(!zalloc_cpumask_var_node(&pt->pod_cpus[0], GFP_KERNEL, NUMA_NO_NODE)); 767584193c07STejun Heo 767684193c07STejun Heo pt->nr_pods = 1; 767784193c07STejun Heo cpumask_copy(pt->pod_cpus[0], cpu_possible_mask); 767884193c07STejun Heo pt->pod_node[0] = NUMA_NO_NODE; 767984193c07STejun Heo pt->cpu_pod[0] = 0; 768084193c07STejun Heo 76814cb1ef64STejun Heo /* initialize BH and CPU pools */ 76821da177e4SLinus Torvalds for_each_possible_cpu(cpu) { 76831da177e4SLinus Torvalds struct worker_pool *pool; 76841da177e4SLinus Torvalds 76851da177e4SLinus Torvalds i = 0; 76864cb1ef64STejun Heo for_each_bh_worker_pool(pool, cpu) { 76872f34d733STejun Heo init_cpu_worker_pool(pool, cpu, std_nice[i]); 76884cb1ef64STejun Heo pool->flags |= POOL_BH; 76892f34d733STejun Heo init_irq_work(bh_pool_irq_work(pool), irq_work_fns[i]); 76902f34d733STejun Heo i++; 76914cb1ef64STejun Heo } 76924cb1ef64STejun Heo 76934cb1ef64STejun Heo i = 0; 76942fcdb1b4STejun Heo for_each_cpu_worker_pool(pool, cpu) 76952fcdb1b4STejun Heo init_cpu_worker_pool(pool, cpu, std_nice[i++]); 76961da177e4SLinus Torvalds } 76971da177e4SLinus Torvalds 76988a2b7538STejun Heo /* create default unbound and ordered wq attrs */ 769929c91e99STejun Heo for (i = 0; i < NR_STD_WORKER_POOLS; i++) { 770029c91e99STejun Heo struct workqueue_attrs *attrs; 770129c91e99STejun Heo 7702be69d00dSThomas Gleixner BUG_ON(!(attrs = alloc_workqueue_attrs())); 770329c91e99STejun Heo attrs->nice = std_nice[i]; 770429c91e99STejun Heo unbound_std_wq_attrs[i] = attrs; 77058a2b7538STejun Heo 77068a2b7538STejun Heo /* 77078a2b7538STejun Heo * An ordered wq should have only one pwq as ordering is 77088a2b7538STejun Heo * guaranteed by max_active which is enforced by pwqs. 77098a2b7538STejun Heo */ 7710be69d00dSThomas Gleixner BUG_ON(!(attrs = alloc_workqueue_attrs())); 77118a2b7538STejun Heo attrs->nice = std_nice[i]; 7712af73f5c9STejun Heo attrs->ordered = true; 77138a2b7538STejun Heo ordered_wq_attrs[i] = attrs; 771429c91e99STejun Heo } 771529c91e99STejun Heo 7716d320c038STejun Heo system_wq = alloc_workqueue("events", 0, 0); 77171aabe902SJoonsoo Kim system_highpri_wq = alloc_workqueue("events_highpri", WQ_HIGHPRI, 0); 7718d320c038STejun Heo system_long_wq = alloc_workqueue("events_long", 0, 0); 7719f3421797STejun Heo system_unbound_wq = alloc_workqueue("events_unbound", WQ_UNBOUND, 7720636b927eSTejun Heo WQ_MAX_ACTIVE); 772124d51addSTejun Heo system_freezable_wq = alloc_workqueue("events_freezable", 772224d51addSTejun Heo WQ_FREEZABLE, 0); 77230668106cSViresh Kumar system_power_efficient_wq = alloc_workqueue("events_power_efficient", 77240668106cSViresh Kumar WQ_POWER_EFFICIENT, 0); 77258318d6a6SAudra Mitchell system_freezable_power_efficient_wq = alloc_workqueue("events_freezable_pwr_efficient", 77260668106cSViresh Kumar WQ_FREEZABLE | WQ_POWER_EFFICIENT, 77270668106cSViresh Kumar 0); 77284cb1ef64STejun Heo system_bh_wq = alloc_workqueue("events_bh", WQ_BH, 0); 77294cb1ef64STejun Heo system_bh_highpri_wq = alloc_workqueue("events_bh_highpri", 77304cb1ef64STejun Heo WQ_BH | WQ_HIGHPRI, 0); 77311aabe902SJoonsoo Kim BUG_ON(!system_wq || !system_highpri_wq || !system_long_wq || 77320668106cSViresh Kumar !system_unbound_wq || !system_freezable_wq || 77330668106cSViresh Kumar !system_power_efficient_wq || 77344cb1ef64STejun Heo !system_freezable_power_efficient_wq || 77354cb1ef64STejun Heo !system_bh_wq || !system_bh_highpri_wq); 77363347fa09STejun Heo } 77373347fa09STejun Heo 7738aa6fde93STejun Heo static void __init wq_cpu_intensive_thresh_init(void) 7739aa6fde93STejun Heo { 7740aa6fde93STejun Heo unsigned long thresh; 7741aa6fde93STejun Heo unsigned long bogo; 7742aa6fde93STejun Heo 7743dd64c873SZqiang pwq_release_worker = kthread_create_worker(0, "pool_workqueue_release"); 7744dd64c873SZqiang BUG_ON(IS_ERR(pwq_release_worker)); 7745dd64c873SZqiang 7746aa6fde93STejun Heo /* if the user set it to a specific value, keep it */ 7747aa6fde93STejun Heo if (wq_cpu_intensive_thresh_us != ULONG_MAX) 7748aa6fde93STejun Heo return; 7749aa6fde93STejun Heo 7750aa6fde93STejun Heo /* 7751aa6fde93STejun Heo * The default of 10ms is derived from the fact that most modern (as of 7752aa6fde93STejun Heo * 2023) processors can do a lot in 10ms and that it's just below what 7753aa6fde93STejun Heo * most consider human-perceivable. However, the kernel also runs on a 7754aa6fde93STejun Heo * lot slower CPUs including microcontrollers where the threshold is way 7755aa6fde93STejun Heo * too low. 7756aa6fde93STejun Heo * 7757aa6fde93STejun Heo * Let's scale up the threshold upto 1 second if BogoMips is below 4000. 7758aa6fde93STejun Heo * This is by no means accurate but it doesn't have to be. The mechanism 7759aa6fde93STejun Heo * is still useful even when the threshold is fully scaled up. Also, as 7760aa6fde93STejun Heo * the reports would usually be applicable to everyone, some machines 7761aa6fde93STejun Heo * operating on longer thresholds won't significantly diminish their 7762aa6fde93STejun Heo * usefulness. 7763aa6fde93STejun Heo */ 7764aa6fde93STejun Heo thresh = 10 * USEC_PER_MSEC; 7765aa6fde93STejun Heo 7766aa6fde93STejun Heo /* see init/calibrate.c for lpj -> BogoMIPS calculation */ 7767aa6fde93STejun Heo bogo = max_t(unsigned long, loops_per_jiffy / 500000 * HZ, 1); 7768aa6fde93STejun Heo if (bogo < 4000) 7769aa6fde93STejun Heo thresh = min_t(unsigned long, thresh * 4000 / bogo, USEC_PER_SEC); 7770aa6fde93STejun Heo 7771aa6fde93STejun Heo pr_debug("wq_cpu_intensive_thresh: lpj=%lu BogoMIPS=%lu thresh_us=%lu\n", 7772aa6fde93STejun Heo loops_per_jiffy, bogo, thresh); 7773aa6fde93STejun Heo 7774aa6fde93STejun Heo wq_cpu_intensive_thresh_us = thresh; 7775aa6fde93STejun Heo } 7776aa6fde93STejun Heo 77773347fa09STejun Heo /** 77783347fa09STejun Heo * workqueue_init - bring workqueue subsystem fully online 77793347fa09STejun Heo * 77802930155bSTejun Heo * This is the second step of three-staged workqueue subsystem initialization 77812930155bSTejun Heo * and invoked as soon as kthreads can be created and scheduled. Workqueues have 77822930155bSTejun Heo * been created and work items queued on them, but there are no kworkers 77832930155bSTejun Heo * executing the work items yet. Populate the worker pools with the initial 77842930155bSTejun Heo * workers and enable future kworker creations. 77853347fa09STejun Heo */ 77862333e829SYu Chen void __init workqueue_init(void) 77873347fa09STejun Heo { 77882186d9f9STejun Heo struct workqueue_struct *wq; 77893347fa09STejun Heo struct worker_pool *pool; 77903347fa09STejun Heo int cpu, bkt; 77913347fa09STejun Heo 7792aa6fde93STejun Heo wq_cpu_intensive_thresh_init(); 7793aa6fde93STejun Heo 77942186d9f9STejun Heo mutex_lock(&wq_pool_mutex); 77952186d9f9STejun Heo 77962930155bSTejun Heo /* 77972930155bSTejun Heo * Per-cpu pools created earlier could be missing node hint. Fix them 77982930155bSTejun Heo * up. Also, create a rescuer for workqueues that requested it. 77992930155bSTejun Heo */ 78002186d9f9STejun Heo for_each_possible_cpu(cpu) { 78014cb1ef64STejun Heo for_each_bh_worker_pool(pool, cpu) 78022186d9f9STejun Heo pool->node = cpu_to_node(cpu); 78034cb1ef64STejun Heo for_each_cpu_worker_pool(pool, cpu) 78044cb1ef64STejun Heo pool->node = cpu_to_node(cpu); 78052186d9f9STejun Heo } 78062186d9f9STejun Heo 780740c17f75STejun Heo list_for_each_entry(wq, &workqueues, list) { 780840c17f75STejun Heo WARN(init_rescuer(wq), 780940c17f75STejun Heo "workqueue: failed to create early rescuer for %s", 781040c17f75STejun Heo wq->name); 781140c17f75STejun Heo } 78122186d9f9STejun Heo 78132186d9f9STejun Heo mutex_unlock(&wq_pool_mutex); 78142186d9f9STejun Heo 78154cb1ef64STejun Heo /* 78164cb1ef64STejun Heo * Create the initial workers. A BH pool has one pseudo worker that 78174cb1ef64STejun Heo * represents the shared BH execution context and thus doesn't get 78184cb1ef64STejun Heo * affected by hotplug events. Create the BH pseudo workers for all 78194cb1ef64STejun Heo * possible CPUs here. 78204cb1ef64STejun Heo */ 78214cb1ef64STejun Heo for_each_possible_cpu(cpu) 78224cb1ef64STejun Heo for_each_bh_worker_pool(pool, cpu) 78234cb1ef64STejun Heo BUG_ON(!create_worker(pool)); 78244cb1ef64STejun Heo 78253347fa09STejun Heo for_each_online_cpu(cpu) { 78263347fa09STejun Heo for_each_cpu_worker_pool(pool, cpu) { 78273347fa09STejun Heo pool->flags &= ~POOL_DISASSOCIATED; 78283347fa09STejun Heo BUG_ON(!create_worker(pool)); 78293347fa09STejun Heo } 78303347fa09STejun Heo } 78313347fa09STejun Heo 78323347fa09STejun Heo hash_for_each(unbound_pool_hash, bkt, pool, hash_node) 78333347fa09STejun Heo BUG_ON(!create_worker(pool)); 78343347fa09STejun Heo 78353347fa09STejun Heo wq_online = true; 783682607adcSTejun Heo wq_watchdog_init(); 78371da177e4SLinus Torvalds } 7838c4f135d6STetsuo Handa 7839025e1684STejun Heo /* 7840025e1684STejun Heo * Initialize @pt by first initializing @pt->cpu_pod[] with pod IDs according to 7841025e1684STejun Heo * @cpu_shares_pod(). Each subset of CPUs that share a pod is assigned a unique 7842025e1684STejun Heo * and consecutive pod ID. The rest of @pt is initialized accordingly. 7843025e1684STejun Heo */ 7844025e1684STejun Heo static void __init init_pod_type(struct wq_pod_type *pt, 7845025e1684STejun Heo bool (*cpus_share_pod)(int, int)) 7846025e1684STejun Heo { 7847025e1684STejun Heo int cur, pre, cpu, pod; 7848025e1684STejun Heo 7849025e1684STejun Heo pt->nr_pods = 0; 7850025e1684STejun Heo 7851025e1684STejun Heo /* init @pt->cpu_pod[] according to @cpus_share_pod() */ 7852025e1684STejun Heo pt->cpu_pod = kcalloc(nr_cpu_ids, sizeof(pt->cpu_pod[0]), GFP_KERNEL); 7853025e1684STejun Heo BUG_ON(!pt->cpu_pod); 7854025e1684STejun Heo 7855025e1684STejun Heo for_each_possible_cpu(cur) { 7856025e1684STejun Heo for_each_possible_cpu(pre) { 7857025e1684STejun Heo if (pre >= cur) { 7858025e1684STejun Heo pt->cpu_pod[cur] = pt->nr_pods++; 7859025e1684STejun Heo break; 7860025e1684STejun Heo } 7861025e1684STejun Heo if (cpus_share_pod(cur, pre)) { 7862025e1684STejun Heo pt->cpu_pod[cur] = pt->cpu_pod[pre]; 7863025e1684STejun Heo break; 7864025e1684STejun Heo } 7865025e1684STejun Heo } 7866025e1684STejun Heo } 7867025e1684STejun Heo 7868025e1684STejun Heo /* init the rest to match @pt->cpu_pod[] */ 7869025e1684STejun Heo pt->pod_cpus = kcalloc(pt->nr_pods, sizeof(pt->pod_cpus[0]), GFP_KERNEL); 7870025e1684STejun Heo pt->pod_node = kcalloc(pt->nr_pods, sizeof(pt->pod_node[0]), GFP_KERNEL); 7871025e1684STejun Heo BUG_ON(!pt->pod_cpus || !pt->pod_node); 7872025e1684STejun Heo 7873025e1684STejun Heo for (pod = 0; pod < pt->nr_pods; pod++) 7874025e1684STejun Heo BUG_ON(!zalloc_cpumask_var(&pt->pod_cpus[pod], GFP_KERNEL)); 7875025e1684STejun Heo 7876025e1684STejun Heo for_each_possible_cpu(cpu) { 7877025e1684STejun Heo cpumask_set_cpu(cpu, pt->pod_cpus[pt->cpu_pod[cpu]]); 7878025e1684STejun Heo pt->pod_node[pt->cpu_pod[cpu]] = cpu_to_node(cpu); 7879025e1684STejun Heo } 7880025e1684STejun Heo } 7881025e1684STejun Heo 788263c5484eSTejun Heo static bool __init cpus_dont_share(int cpu0, int cpu1) 788363c5484eSTejun Heo { 788463c5484eSTejun Heo return false; 788563c5484eSTejun Heo } 788663c5484eSTejun Heo 788763c5484eSTejun Heo static bool __init cpus_share_smt(int cpu0, int cpu1) 788863c5484eSTejun Heo { 788963c5484eSTejun Heo #ifdef CONFIG_SCHED_SMT 789063c5484eSTejun Heo return cpumask_test_cpu(cpu0, cpu_smt_mask(cpu1)); 789163c5484eSTejun Heo #else 789263c5484eSTejun Heo return false; 789363c5484eSTejun Heo #endif 789463c5484eSTejun Heo } 789563c5484eSTejun Heo 7896025e1684STejun Heo static bool __init cpus_share_numa(int cpu0, int cpu1) 7897025e1684STejun Heo { 7898025e1684STejun Heo return cpu_to_node(cpu0) == cpu_to_node(cpu1); 7899025e1684STejun Heo } 7900025e1684STejun Heo 79012930155bSTejun Heo /** 79022930155bSTejun Heo * workqueue_init_topology - initialize CPU pods for unbound workqueues 79032930155bSTejun Heo * 790496068b60SWang Jinchao * This is the third step of three-staged workqueue subsystem initialization and 79052930155bSTejun Heo * invoked after SMP and topology information are fully initialized. It 79062930155bSTejun Heo * initializes the unbound CPU pods accordingly. 79072930155bSTejun Heo */ 79082930155bSTejun Heo void __init workqueue_init_topology(void) 7909a86feae6STejun Heo { 79102930155bSTejun Heo struct workqueue_struct *wq; 7911025e1684STejun Heo int cpu; 7912a86feae6STejun Heo 791363c5484eSTejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_CPU], cpus_dont_share); 791463c5484eSTejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_SMT], cpus_share_smt); 791563c5484eSTejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_CACHE], cpus_share_cache); 7916025e1684STejun Heo init_pod_type(&wq_pod_types[WQ_AFFN_NUMA], cpus_share_numa); 7917a86feae6STejun Heo 7918c5f8cd6cSTejun Heo wq_topo_initialized = true; 7919c5f8cd6cSTejun Heo 79202930155bSTejun Heo mutex_lock(&wq_pool_mutex); 7921a86feae6STejun Heo 7922a86feae6STejun Heo /* 79232930155bSTejun Heo * Workqueues allocated earlier would have all CPUs sharing the default 7924b2b1f933SLai Jiangshan * worker pool. Explicitly call unbound_wq_update_pwq() on all workqueue 7925b2b1f933SLai Jiangshan * and CPU combinations to apply per-pod sharing. 79262930155bSTejun Heo */ 79272930155bSTejun Heo list_for_each_entry(wq, &workqueues, list) { 79285797b1c1STejun Heo for_each_online_cpu(cpu) 7929b2b1f933SLai Jiangshan unbound_wq_update_pwq(wq, cpu); 79305797b1c1STejun Heo if (wq->flags & WQ_UNBOUND) { 79315797b1c1STejun Heo mutex_lock(&wq->mutex); 79325797b1c1STejun Heo wq_update_node_max_active(wq, -1); 79335797b1c1STejun Heo mutex_unlock(&wq->mutex); 79342930155bSTejun Heo } 79352930155bSTejun Heo } 79362930155bSTejun Heo 79372930155bSTejun Heo mutex_unlock(&wq_pool_mutex); 7938a86feae6STejun Heo } 7939a86feae6STejun Heo 794020bdedafSTetsuo Handa void __warn_flushing_systemwide_wq(void) 794120bdedafSTetsuo Handa { 794220bdedafSTetsuo Handa pr_warn("WARNING: Flushing system-wide workqueues will be prohibited in near future.\n"); 794320bdedafSTetsuo Handa dump_stack(); 794420bdedafSTetsuo Handa } 7945c4f135d6STetsuo Handa EXPORT_SYMBOL(__warn_flushing_systemwide_wq); 7946ace3c549Stiozhang 7947ace3c549Stiozhang static int __init workqueue_unbound_cpus_setup(char *str) 7948ace3c549Stiozhang { 7949ace3c549Stiozhang if (cpulist_parse(str, &wq_cmdline_cpumask) < 0) { 7950ace3c549Stiozhang cpumask_clear(&wq_cmdline_cpumask); 7951ace3c549Stiozhang pr_warn("workqueue.unbound_cpus: incorrect CPU range, using default\n"); 7952ace3c549Stiozhang } 7953ace3c549Stiozhang 7954ace3c549Stiozhang return 1; 7955ace3c549Stiozhang } 7956ace3c549Stiozhang __setup("workqueue.unbound_cpus=", workqueue_unbound_cpus_setup); 7957